Skip to contentSkip to conversation

mm/damon: fix typos on reference links

PATCH New SeongJae Park 1 participant 3 messages Feb 21, 2024

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

SeongJae Park

author maintainer
#0 lore raw

cover mm/damon: fix typos on reference links

Some patches that merged in mm-unstable have typos that cause document build warning. Fix those.

SeongJae Park (2):
Docs/admin-guide/mm/damon/usage: fix a typo on a reference link Docs/admin-guide/mm/damon/usage: fix a typo on the auto-tuning design
reference link

 Documentation/admin-guide/mm/damon/usage.rst | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)
Signature · 1 line
2.25.1
author maintainer
#1 lore raw

PATCH 1/2 Docs/admin-guide/mm/damon/usage: fix a typo on a reference link

There was a typo cuasing a document build warning below. Fix it.

WARNING: undefined label: 'damon_design_confiurable_operations_set'

Fixes afc858f0e6db ("Docs/mm/damon: move DAMON operation sets list from the usage to the design document")
Signed-off-by SeongJae Park <[email protected]>
---
 Documentation/admin-guide/mm/damon/usage.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
Documentation/admin-guide/mm/damon/usage.rst +1 -1
index b33eecfd0e901..952528f0739ba 100644
@@ -184,7 +184,7 @@ and three directories (``monitoring_attrs``, ``targets``, and ``schemes``)
 exist.
 
 DAMON supports multiple types of :ref:`monitoring operations
-<damon_design_confiurable_operations_set>`, including those for virtual address
+<damon_design_configurable_operations_set>`, including those for virtual address
 space and the physical address space.  You can get the list of available
 monitoring operations set on the currently running kernel by reading
 ``avail_operations`` file.  Based on the kernel configuration, the file will
Signature · 1 line
2.25.1
author maintainer
#2 lore raw

PATCH 2/2 Docs/admin-guide/mm/damon/usage: fix a typo on the auto-tuning design reference link

In reply to SeongJae Park

There was a typo on the quota auto-tuning design reference link that caused below document build warning. Fix it.

WARNING: undefined label: 'damon_design_damos_quota_auto_tuning'

Fixes d50e871bd78b ("Docs/admin-guide/mm/damon/usage: document quota goal metric file")
Reported-by Stephen Rothwell <[email protected]>
Closes https://lkml.kernel.org/r/[email protected] open here
Signed-off-by SeongJae Park <[email protected]>
---
 Documentation/admin-guide/mm/damon/usage.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
Documentation/admin-guide/mm/damon/usage.rst +1 -1
index 952528f0739ba..6fce035fdbf5c 100644
@@ -369,7 +369,7 @@ Among the multiple feedback, the best one is used.
 Each goal directory contains three files, namely ``target_metric``,
 ``target_value`` and ``current_value``.  Users can set and get the three
 parameters for the quota auto-tuning goals that specified on the :ref:`design
-doc <damon_design_damos_quota_auto_tuning>` by writing to and reading from each
+doc <damon_design_damos_quotas_auto_tuning>` by writing to and reading from each
 of the files.  Note that users should further write
 ``commit_schemes_quota_goals`` to the ``state`` file of the :ref:`kdamond
 directory <sysfs_kdamond>` to pass the feedback to DAMON.
Signature · 1 line
2.25.1