From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from mout-p-103.mailbox.org (mout-p-103.mailbox.org [80.241.56.161]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id 3FC1653D9E0; Tue, 13 Oct 2026 19:14:15 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=80.241.56.161 ARC-Seal:i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1791918860; cv=none; b=trVgy1s1LuRWSo0EL2qsR5AXvoVpyIHWwXCVjXW2PGnGWu30+HPL9QO0f6RL99rNFYN5i6SiNu285797aoV/MLsOkACBz/Ct/jytbE6EOMMGPRTkSsILdSZ6yTdr7Q35KeOqx1jRtyKFGP8Ghj+jE39aSNDSP7lB23kMMA1a5GA= ARC-Message-Signature:i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1791918860; c=relaxed/simple; bh=I+91l3DjXMP+XaQxNASYoOMpF6395hRutkQhgMO0Lzc=; h=From:To:Cc:Subject:Date:Message-ID:MIME-Version; b=IvfF03Ni3JoQ+3sQf9wSManB5lN94PcnUFq2HPdeCn23/K9MU/SBO+EDFDisyIK5SkF6W3d7DmqMliHd0e8U1ZAANJ6wTPUzOq65NsUm2KRTswtF8e5v15Z1g/BWYtQxeFTcKPRseBkU1sLWn29SKbkXgOLe7Avm51etf36cq80= ARC-Authentication-Results:i=1; smtp.subspace.kernel.org; dmarc=pass (p=reject dis=none) header.from=mailbox.org; spf=pass smtp.mailfrom=mailbox.org; dkim=pass (2048-bit key) header.d=mailbox.org header.i=@mailbox.org header.b=muWw0dm7; arc=none smtp.client-ip=80.241.56.161 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=reject dis=none) header.from=mailbox.org Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=mailbox.org Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=mailbox.org header.i=@mailbox.org header.b="muWw0dm7" Received: from smtp202.mailbox.org (smtp202.mailbox.org [IPv6:2001:67c:2050:b231:465::202]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519MLKEM768 server-signature RSA-PSS (4096 bits) server-digest SHA256) (No client certificate requested) by mout-p-103.mailbox.org (Postfix) with ESMTPS id 4j43ss5DwmzKntr; Tue, 13 Oct 2026 21:14:09 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=mailbox.org; s=mail20150812; t=1791918849; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version: content-transfer-encoding:content-transfer-encoding; bh=q7NeGVGhynspdDjN8FsWdiUJ/CHXi08JbRrTumaJC90=; b=muWw0dm7aDxJ2inMBGAsKwaVUA8f0aCLXZW9dPTK+deZuMTp1v6hyfH/CtQ96NBKXjEMnU xdD3YuMMEgMRuJDExLJruslZETFpNFX2yFA/upFYWy0n3uXWNQvAxWiBkJDCHCDhBcMaB6 DBLmzqzoXrjEkSe7fMpPHtcfwm8imTid3ftA2n+dPucnvnnU2smfysRBEy1a08n2GpF6g1 PyY785UDE1ifuXsVZvt98ELgCFWgGtxscNUVaRgCrKdKy4D6CBMcqjdw7UqQbHDLQu7zva eMY44cA7wmgxM9/AOLQ6wpb9Je2+NTSZoOPt9DwXRWrj2tfRzlM7n/+4+vTUPg== From: Manuel Ebner To: SJ Park , Andrew Morton , David Hildenbrand , Lorenzo Stoakes , "Liam R. Howlett" , Vlastimil Babka , Mike Rapoport , Suren Baghdasaryan , Michal Hocko , Jonathan Corbet , Shuah Khan , Randy Dunlap Cc: Manuel Ebner , damon@lists.linux.dev, linux-mm@kvack.org, linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org Subject: [PATCH] Docs/admin-guide/mm/damon/lru_sort: fix grammar and stlye Date: Tue, 13 Oct 2026 21:13:27 +0200 Message-ID: <20261013191327.663331-2-manuelebnerli@mailbox.org> X-Mailer: git-send-email 2.55.0 Precedence: bulk X-Mailing-List: linux-kernel@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-MBO-RS-META: ec553cjhwsjo5srji38ypaakogkmy1mm X-MBO-RS-ID: 5444562cf99fdf74ba2 mention 'least-recently-used' AKA lru at the beginning set as -> set to Signed-off-by: Manuel Ebner --- .../admin-guide/mm/damon/lru_sort.rst | 51 ++++++++++--------- 1 file changed, 26 insertions(+), 25 deletions(-) diff --git a/Documentation/admin-guide/mm/damon/lru_sort.rst b/Documentation/admin-guide/mm/damon/lru_sort.rst index 0c04d238ed..3b6d122887 100644 --- a/Documentation/admin-guide/mm/damon/lru_sort.rst +++ b/Documentation/admin-guide/mm/damon/lru_sort.rst @@ -4,8 +4,9 @@ DAMON-based LRU-lists Sorting ============================= -DAMON-based LRU-lists Sorting (DAMON_LRU_SORT) is a static kernel module that -aimed to be used for proactive and lightweight data access pattern based +DAMON-based least-recently-used-lists (short LRU-lists) Sorting +(DAMON_LRU_SORT) is a static kernel module that aims to be used +for proactive and lightweight data access pattern based (de)prioritization of pages on their LRU-lists for making LRU-lists a more trustworthy data access pattern source. @@ -17,7 +18,7 @@ systems, LRU lists are normally not proactively sorted but partially and reactively sorted for special events including specific user requests, system calls and memory pressure. As a result, LRU lists are sometimes not so perfectly prepared to be used as a trustworthy access pattern source for some -situations including reclamation target pages selection under sudden memory +situations including reclamation of target pages selection under sudden memory pressure. Because DAMON can identify access patterns of best-effort accuracy while @@ -28,9 +29,9 @@ pattern source with low and controlled overhead. How It Works? ============= -DAMON_LRU_SORT finds hot pages (pages of memory regions that showing access +DAMON_LRU_SORT finds hot pages (pages of memory regions that show access rates that higher than a user-specified threshold) and cold pages (pages of -memory regions that showing no access for a time that longer than a +memory regions that show no access for a time that longer than a user-specified threshold) using DAMON, and prioritizes hot pages while 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 @@ -63,10 +64,10 @@ enabled Enable or disable DAMON_LRU_SORT. -You can enable DAMON_LRU_SORT by setting the value of this parameter as ``Y``. -Setting it as ``N`` disables DAMON_LRU_SORT. Note that DAMON_LRU_SORT could do +You can enable DAMON_LRU_SORT by setting the value of this parameter to ``Y``. +Setting it to ``N`` disables DAMON_LRU_SORT. Note that DAMON_LRU_SORT could do no real monitoring and LRU-lists sorting due to the watermarks-based activation -condition. Refer to below descriptions for the watermarks parameter for this. +condition. Refer to below descriptions of the watermarks parameter for this. commit_inputs ------------- @@ -74,9 +75,9 @@ commit_inputs Make DAMON_LRU_SORT reads 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 as ``Y``, DAMON_LRU_SORT reads values +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 as ``N``. If invalid parameters are found while the +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 @@ -86,37 +87,37 @@ violate this rule, the kernel may exhibit undefined behavior. active_mem_bp ------------- -Desired active to [in]active memory ratio in bp (1/10,000). +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. +(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. autotune_monitoring_intervals ----------------------------- -If this parameter is set as ``Y``, DAMON_LRU_SORT automatically tunes DAMON's +If this parameter is set to ``Y``, DAMON_LRU_SORT automatically tunes DAMON's sampling and aggregation intervals. The auto-tuning aims to capture meaningful amount of access events in each DAMON-snapshot, while keeping the sampling -interval 5 milliseconds in minimum, and 10 seconds in maximum. Setting this as -``N`` disables the auto-tuning. +interval to 5 milliseconds in minimum, and to 10 seconds in maximum. Setting this +to ``N`` disables the auto-tuning. Disabled by default. filter_young_pages ------------------ -Filter [non-]young pages accordingly for LRU [de]prioritizations. +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 +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 last check (young). The feature is enabled or disabled if this parameter is -set as ``Y`` or ``N``, respectively. +set to ``Y`` or ``N``, respectively. Disabled by default. @@ -235,7 +236,7 @@ max_nr_regions Maximum number of monitoring regions. The maximum number of monitoring regions of DAMON for the cold memory -monitoring. This can be used to set upper-bound of the monitoring overhead. +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. @@ -268,7 +269,7 @@ This parameter is for setting and getting the :ref:`address unit ``monitor_region_start`` and ``monitor_region_end`` should be provided in this unit. For example, let's suppose ``addr_unit``, ``monitor_region_start`` and -``monitor_region_end`` are set as ``1024``, ``0`` and ``10``, respectively. +``monitor_region_end`` are set to ``1024``, ``0`` and ``10``, respectively. Then DAMON_LRU_SORT will work for 10 KiB length of physical address range that starts from address zero (``[0 * 1024, 10 * 1024)`` in bytes). @@ -291,22 +292,22 @@ If DAMON_LRU_SORT is enabled, this becomes the PID of the worker thread. Else, nr_lru_sort_tried_hot_regions ----------------------------- -Number of hot memory regions that tried to be LRU-sorted. +Number of hot memory regions that try to be LRU-sorted. bytes_lru_sort_tried_hot_regions -------------------------------- -Total bytes of hot memory regions that tried to be LRU-sorted. +Total bytes of hot memory regions that try to be LRU-sorted. nr_lru_sorted_hot_regions ------------------------- -Number of hot memory regions that successfully be LRU-sorted. +Number of hot memory regions that are successfully LRU-sorted. bytes_lru_sorted_hot_regions ---------------------------- -Total bytes of hot memory regions that successfully be LRU-sorted. +Total bytes of hot memory regions that are successfully LRU-sorted. nr_hot_quota_exceeds -------------------- -- 2.55.0