Skip to contentSkip to conversation

Docs/mm/damon/design: fix broken :ref: usage and a typo

PATCH Applied SJ Park 2 participants 2 messages Sep 8

Subsystems (4)
Memory management Documentation MM misc DAMON
lore
Share & tools
lore

SJ Park

author maintainer
#0 lore raw

PATCH v2 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.

Signed-off-by Zenghui Yu (Huawei) <[email protected]>
Reviewed-by SJ Park <[email protected]>
Signed-off-by SJ Park <[email protected]>

---
Changes from v1
- v1: https://lore.kernel.org/[email protected]
- Collec R-b: from SJ.
- Rebase to latest mm-new.

 Documentation/mm/damon/design.rst | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)
Documentation/mm/damon/design.rst +2 -2
index d036340dae8af..aac84de261aa8 100644
@@ -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

@@ -889,7 +889,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

base-commit: 6ec15610f2de4a64c8cada08cb3dda0b6388b3ed

Signature · 1 line
2.47.3
AI review
#1 lore raw
Sashiko 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 6 lines

Also fix a typo, 'frequenceis' -> 'frequencies', in the Adaptive Regions Adjustment section.

Signed-off-by Zenghui Yu (Huawei) <[email protected]>
Reviewed-by SJ Park <[email protected]>
Signed-off-by SJ Park <[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