Docs/mm/damon/design: fix broken :ref: usage and a typo
Subsystems (4)
PATCH 1/1 Docs/mm/damon/design: fix broken :ref: usage and a typo
From: "Zenghui Yu (Huawei)" <[email protected]>
The Statistics section refers readers to the DAMON sysfs interface documentation for how to read the statistics, using a ':ref:' role. However, the role name has a superfluous 's' appended (':ref:s' instead of ':ref:'). Moreover, its target label 'sysfs_stats' does not exist; the correct label is 'sysfs_schemes_stats'. Fix both.
Also fix a typo, 'frequenceis' -> 'frequencies', in the Adaptive Regions Adjustment section.
--- Documentation/mm/damon/design.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-)
Documentation/mm/damon/design.rst +2 -2
@@ -249,7 +249,7 @@ For each ``aggregation interval``, it compares the access frequencies sum of the two regions' sizes is smaller than the size of total regions divided by the ``minimum number of regions``, DAMON merges the two regions. If the resulting number of total regions is still higher than ``maximum number of -regions``, it repeats the merging with increasing access frequenceis difference +regions``, it repeats the merging with increasing access frequencies difference threshold until the upper-limit of the number of regions is met, or the threshold becomes higher than possible maximum value (``aggregation interval`` divided by ``sampling interval``). Then, after it reports and clears the
@@ -875,7 +875,7 @@ the scheme is deactivated. Note that, unlike watermarks, even if a scheme's ``nr_snapshots`` reaches ``max_nr_snapshots``, monitoring will not stop. To know how user-space can read the stats via :ref:`DAMON sysfs interface -<sysfs_interface>`, refer to :ref:s`stats <sysfs_stats>` part of the +<sysfs_interface>`, refer to :ref:`stats <sysfs_schemes_stats>` part of the documentation. Regions Walking
Signature · 1 line
2.53.0
[email protected]
AI reviewSashiko has reviewed this patch and found no issues. It looks great!
Quoted 8 lines
From: "Zenghui Yu (Huawei)" <[email protected]>
The Statistics section refers readers to the DAMON sysfs interface documentation for how to read the statistics, using a ':ref:' role. However, the role name has a superfluous 's' appended (':ref:s' instead of ':ref:'). Moreover, its target label '
sysfs_stats' does not exist; the correct label is 'sysfs_schemes_stats'. Fix both.
Quoted 4 lines
Also fix a typo, 'frequenceis' -> 'frequencies', in the Adaptive Regions Adjustment section.
Signed-off-by Zenghui Yu (Huawei) <[email protected]>
Sashiko has reviewed this patch and found no issues. It looks great!
Signature · 1 line
Sashiko AI review · https://sashiko.dev/#/patchset/[email protected]?part=1
'get_maintainer.pl --nogit --nogit-fallback' suggests adding below recipients. I added them. Please consier using get_maintainer.pl from the next time.
- David Hildenbrand <[email protected]>
- Lorenzo Stoakes <[email protected]>
- "Liam R. Howlett" <[email protected]>
- Vlastimil Babka <[email protected]>
- Mike Rapoport <[email protected]>
- Suren Baghdasaryan <[email protected]>
- Michal Hocko <[email protected]>
- Jonathan Corbet <[email protected]>
- Shuah Khan <[email protected]>
- Randy Dunlap <[email protected]>
- [email protected]
Hello Zenghui,
Quoted 10 lines · On Wed, 2 Sep 2026 20:45:50 +0800 Zenghui Yu <[email protected]> wrote:
From: "Zenghui Yu (Huawei)" <[email protected]>
The Statistics section refers readers to the DAMON sysfs interface documentation for how to read the statistics, using a ':ref:' role. However, the role name has a superfluous 's' appended (':ref:s' instead of ':ref:'). Moreover, its target label '
sysfs_stats' does not exist; the correct label is 'sysfs_schemes_stats'. Fix both.Also fix a typo, 'frequenceis' -> 'frequencies', in the Adaptive Regions Adjustment section.
Good eyes, thank you for finding and fixing these!
Quoted 2 lines
Signed-off-by Zenghui Yu (Huawei) <[email protected]>
This patch is applied to damon/next [1] tree. If this patch is not added to mm.git in short term (~1 week?), I will ask mm.git maintainer (Andrew Morton) to pick this. So, no action from your side is needed for now. If it seems I also forgot doing that or you cannot wait for my action, please feel free to directly ask that to Andrew.
[1] https://origin.kernel.org/doc/html/latest/mm/damon/maintainer-profile.html#scm-trees
Thanks,
SJ
[...]