Commit 1b016638 authored by SeongJae Park's avatar SeongJae Park Committed by Andrew Morton
Browse files

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.

Link: https://lkml.kernel.org/r/20221024174619.15600-3-sj@kernel.org


Signed-off-by: default avatarSeongJae Park <sj@kernel.org>
Cc: Jonathan Corbet <corbet@lwn.net>
Cc: Vinicius Petrucci <vpetrucci@gmail.com>
Signed-off-by: default avatarAndrew Morton <akpm@linux-foundation.org>
parent bd414929

Documentation/admin-guide/mm/damon/usage.rst

+6 −5
Original line number Diff line number Diff line
@@ -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