Manuel's recent grammar fix for this file, now in damon/next, covered a good part of it. This should take care of the few mistakes that are left, like "should automatically activated" and "Make DAMON_LRU_SORT reads". Rewrap where the lines got too long. Signed-off-by: Aveline Noir --- .../admin-guide/mm/damon/lru_sort.rst | 45 ++++++++++--------- 1 file changed, 23 insertions(+), 22 deletions(-) diff --git a/Documentation/admin-guide/mm/damon/lru_sort.rst b/Documentation/admin-guide/mm/damon/lru_sort.rst index aa4cc90ca57c..c628e3f6e587 100644 --- a/Documentation/admin-guide/mm/damon/lru_sort.rst +++ b/Documentation/admin-guide/mm/damon/lru_sort.rst @@ -35,7 +35,7 @@ deprioritizing cold pages on their LRU-lists. To avoid it consuming too much CPU for the prioritizations, a CPU time usage limit can be configured. Under the limit, it prioritizes and deprioritizes more hot and cold pages first, respectively. System administrators can also configure under what situation -this scheme should automatically activated and deactivated with three memory +this scheme should be automatically activated and deactivated with three memory pressure watermarks. Its default parameters for hotness/coldness thresholds and CPU quota limit are @@ -55,7 +55,7 @@ DAMON_LRU_SORT utilizes module parameters. That is, you can put ``damon_lru_sort.=`` on the kernel boot command line or write proper values to ``/sys/module/damon_lru_sort/parameters/`` files. -Below are the description of each parameter. +Below is the description of each parameter. enabled ------- @@ -70,12 +70,12 @@ condition. Refer to below descriptions of the watermarks parameter for this. commit_inputs ------------- -Make DAMON_LRU_SORT reads the input parameters again, except ``enabled``. +Make DAMON_LRU_SORT read the input parameters again, except ``enabled``. -Input parameters that updated while DAMON_LRU_SORT is running are not applied -by default. Once this parameter is set to ``Y``, DAMON_LRU_SORT reads values -of parameters except ``enabled`` again. Once the re-reading is done, this -parameter is set to ``N``. If invalid parameters are found while the +Input parameters that are updated while DAMON_LRU_SORT is running are not +applied by default. Once this parameter is set to ``Y``, DAMON_LRU_SORT reads +values of parameters except ``enabled`` again. Once the re-reading is done, +this parameter is set to ``N``. If invalid parameters are found while the re-reading, DAMON_LRU_SORT will be disabled. Once ``Y`` is written to this parameter, the user must not write to any @@ -87,10 +87,11 @@ active_mem_bp Desired active to (in)active memory ratio in bp (1/10,000). -While keeping the caps that set by other quotas, DAMON_LRU_SORT automatically -increases and decreases the effective level of the quota aiming the LRU -(de)prioritizations of the hot and cold memory resulting in this active to -(in)active memory ratio. Value zero means disabling this auto-tuning feature. +While keeping the caps that are set by other quotas, DAMON_LRU_SORT +automatically increases and decreases the effective level of the quota aiming +the LRU (de)prioritizations of the hot and cold memory resulting in this active +to (in)active memory ratio. Value zero means disabling this auto-tuning +feature. Disabled by default. @@ -112,8 +113,8 @@ Filter (non-)young pages accordingly for LRU (de)prioritizations. If this is set, check page level access (youngness) once again before each LRU (de)prioritization operation. LRU prioritization operation is skipped -if the page has not accessed since the last check (not young). LRU -deprioritization operation is skipped if the page has accessed since the +if the page has not been accessed since the last check (not young). LRU +deprioritization operation is skipped if the page has been accessed since the last check (young). The feature is enabled or disabled if this parameter is set to ``Y`` or ``N``, respectively. @@ -125,7 +126,7 @@ hot_thres_access_freq Access frequency threshold for hot memory regions identification in permil. If a memory region is accessed in frequency of this or higher, DAMON_LRU_SORT -identifies the region as hot, and mark it as accessed on the LRU list, so that +identifies the region as hot, and marks it as accessed on the LRU list, so that it could not be reclaimed under memory pressure. 50% by default. cold_min_age @@ -134,7 +135,7 @@ cold_min_age Time threshold for cold memory regions identification in microseconds. If a memory region is not accessed for this or longer time, DAMON_LRU_SORT -identifies the region as cold, and mark it as unaccessed on the LRU list, so +identifies the region as cold, and marks it as unaccessed on the LRU list, so that it could be reclaimed first under memory pressure. 120 seconds by default. @@ -237,7 +238,7 @@ The maximum number of monitoring regions of DAMON for the cold memory monitoring. This can be used to set the upper-bound of the monitoring overhead. However, setting this too low could result in bad monitoring quality. Please refer to the DAMON documentation (:doc:`usage`) for more detail. 1000 by -defaults. +default. monitor_region_start -------------------- @@ -310,7 +311,7 @@ Total bytes of hot memory regions that were successfully LRU-sorted. nr_hot_quota_exceeds -------------------- -Number of times that the time quota limit for hot regions have exceeded. +Number of times that the time quota limit for hot regions has been exceeded. nr_lru_sort_tried_cold_regions ------------------------------ @@ -325,24 +326,24 @@ Total bytes of cold memory regions that tried to be LRU-sorted. nr_lru_sorted_cold_regions -------------------------- -Number of cold memory regions that successfully be LRU-sorted. +Number of cold memory regions that were successfully LRU-sorted. bytes_lru_sorted_cold_regions ----------------------------- -Total bytes of cold memory regions that successfully be LRU-sorted. +Total bytes of cold memory regions that were successfully LRU-sorted. nr_cold_quota_exceeds --------------------- -Number of times that the time quota limit for cold regions have exceeded. +Number of times that the time quota limit for cold regions has been exceeded. Example ======= -Below runtime example commands make DAMON_LRU_SORT to find memory regions +Below runtime example commands make DAMON_LRU_SORT find memory regions having >=50% access frequency and LRU-prioritize while LRU-deprioritizing -memory regions that not accessed for 120 seconds. The prioritization and +memory regions that are not accessed for 120 seconds. The prioritization and deprioritization is limited to be done using only up to 1% CPU time to avoid DAMON_LRU_SORT consuming too much CPU time for the (de)prioritization. It also asks DAMON_LRU_SORT to do nothing if the system's free memory rate is more than