Code

Opened 5 years ago

Closed 5 years ago

Last modified 3 years ago

#9986 closed (fixed)

CACHE_BACKEND argument name doesn't match code

Reported by: john_scott Owned by: jacob
Component: Documentation Version: 1.0
Severity: Keywords:
Cc: Triage Stage: Accepted
Has patch: yes Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: UI/UX:

Description

According to the cache docs, there is a parameter called cull_percentage but in the code, this is called cull_frequency and there is no reference in the code at all to cull_percentage. Apparently this hasn't bitten anyone as the problem was first noticed over a year ago.

From my understanding of the code, cull_percentage is a more accurate description of what happens but this would require changing code to match the docs. I have no skin in this game as I don't use any of the affected cache backends, I just noticed it while reviewing the settings relevant to memcache.

Attachments (1)

cull_frequency.diff (1.1 KB) - added by kgrandis 5 years ago.
patch that does the opposite of ticket and replaces cull_percentage with cull_frequency

Download all attachments as: .zip

Change History (7)

comment:1 Changed 5 years ago by jacob

  • milestone set to 1.1
  • Needs documentation unset
  • Needs tests unset
  • Patch needs improvement unset
  • Triage Stage changed from Unreviewed to Accepted

comment:2 Changed 5 years ago by kgrandis

The code blocks where cull_frequency actually does its magic show that it is actually doing a frequency calculations:

doomed = [os.path.join(self._dir, k) for (i, k) in enumerate(filelist) if i % self._cull_frequency == 0]

and

doomed = [k for (i, k) in enumerate(self._cache) if i % self._cull_frequency == 0]

The default cull_frequency is 3, so the above code would flag every 3rd item as doomed (1/f or 1/3). I also have no skin in the game as I have not made use of this particular parameter, but I do think the code name, cull_frequency, is the more accurate description.

Changed 5 years ago by kgrandis

patch that does the opposite of ticket and replaces cull_percentage with cull_frequency

comment:3 Changed 5 years ago by kgrandis

  • Has patch set

comment:4 Changed 5 years ago by jacob

  • Owner changed from nobody to jacob
  • Status changed from new to assigned

comment:5 Changed 5 years ago by jacob

  • Resolution set to fixed
  • Status changed from assigned to closed

(In [10371]) Fixed a whole bunch of small docs typos, errors, and ommissions.

Fixes #8358, #8396, #8724, #9043, #9128, #9247, #9267, #9267, #9375, #9409, #9414, #9416, #9446, #9454, #9464, #9503, #9518, #9533, #9657, #9658, #9683, #9733, #9771, #9835, #9836, #9837, #9897, #9906, #9912, #9945, #9986, #9992, #10055, #10084, #10091, #10145, #10245, #10257, #10309, #10358, #10359, #10424, #10426, #10508, #10531, #10551, #10635, #10637, #10656, #10658, #10690, #10699, #19528.

Thanks to all the respective authors of those tickets.

comment:18 Changed 3 years ago by jacob

  • milestone 1.1 deleted

Milestone 1.1 deleted

Add Comment

Modify Ticket

Change Properties
<Author field>
Action
as closed
as The resolution will be set. Next status will be 'closed'
The resolution will be deleted. Next status will be 'new'
Author


E-mail address and user name can be saved in the Preferences.

 
Note: See TracTickets for help on using tickets.