2022-10-24 19:31:07

by SeongJae Park

[permalink] [raw]
Subject: [PATCH 0/2] Docs/admin-buide/mm/damon/usage: minor fixes

DAMON usage document contains an unclear description and a wrong usage
example. This patchset fixes the two minor problems.

SeongJae Park (2):
Docs/admin-guide/mm/damon/usage: describe the rules of sysfs region
directories
Docs/admin-guide/mm/damon/usage: Fix wrong usage example of
init_regions file

Documentation/admin-guide/mm/damon/usage.rst | 14 +++++++++-----
1 file changed, 9 insertions(+), 5 deletions(-)

--
2.25.1


2022-10-24 19:44:24

by SeongJae Park

[permalink] [raw]
Subject: [PATCH 2/2] Docs/admin-guide/mm/damon/usage: Fix wrong usage example of init_regions file

DAMON debugfs interface assumes the users will write all inputs at once.
However, redirecting a string of multiple lines sometimes end up writing
line by line. Therefore, the example usage of 'init_regions' file,
which writes input as a string of multiple lines can fail. Fix it to
use a single line string instead. Also update the description of the
usage to not assume users will write inputs in multiple lines.

Signed-off-by: SeongJae Park <[email protected]>
---
Documentation/admin-guide/mm/damon/usage.rst | 11 ++++++-----
1 file changed, 6 insertions(+), 5 deletions(-)

diff --git a/Documentation/admin-guide/mm/damon/usage.rst b/Documentation/admin-guide/mm/damon/usage.rst
index 89d9a4f75a29..c17e02e1e426 100644
--- a/Documentation/admin-guide/mm/damon/usage.rst
+++ b/Documentation/admin-guide/mm/damon/usage.rst
@@ -468,8 +468,9 @@ regions in case of physical memory monitoring. Therefore, users should set the
monitoring target regions by themselves.

In such cases, users can explicitly set the initial monitoring target regions
-as they want, by writing proper values to the ``init_regions`` file. Each line
-of the input should represent one region in below form.::
+as they want, by writing proper values to the ``init_regions`` file. The input
+should be a sequence of three integers separated by white spaces that represent
+one region in below form.::

<target idx> <start address> <end address>

@@ -484,9 +485,9 @@ ranges, ``20-40`` and ``50-100`` as that of pid 4242, which is the second one
# cd <debugfs>/damon
# cat target_ids
42 4242
- # echo "0 1 100
- 0 100 200
- 1 20 40
+ # echo "0 1 100 \
+ 0 100 200 \
+ 1 20 40 \
1 50 100" > init_regions

Note that this sets the initial monitoring target regions only. In case of
--
2.25.1