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

Docs/admin-guide/mm/damon/usage: use a list for 'state' sysfs file input commands 

There are eight command inputs for 'state' DAMON sysfs file, and those are
verbosely explained in multiple paragraphs.  It is not easy to find
explanation of specific command, and getting whole picture of supported
commands.  Replace the paragraphs with a list.

Link: https://lkml.kernel.org/r/20231213190338.54146-7-sj@kernel.org


Signed-off-by: default avatarSeongJae Park <sj@kernel.org>
Cc: Jonathan Corbet <corbet@lwn.net>
Signed-off-by: default avatarAndrew Morton <akpm@linux-foundation.org>
parent 9c8c315d

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

+23 −24
Original line number Diff line number Diff line
@@ -130,30 +130,29 @@ In each kdamond directory, two files (``state`` and ``pid``) and one directory 
(``contexts``) exist.



Reading ``state`` returns ``on`` if the kdamond is currently running, or

``off`` if it is not running.  Writing ``on`` or ``off`` makes the kdamond be

in the state.



Writing ``commit`` to the ``state`` file makes kdamond reads the

user inputs in the sysfs files except ``state`` file again.  Writing

``commit_schemes_quota_goals`` to the ``state`` file makes kdamond reads the

DAMON-based operation schemes' :ref:`quota goals <sysfs_schemes_quota_goals>`

of the kdamond.



Writing ``update_schemes_stats`` to ``state`` file updates the

contents of stats files for each DAMON-based operation scheme of the kdamond.

For details of the stats, please refer to :ref:`stats section

<sysfs_schemes_stats>`.



Writing ``update_schemes_tried_regions`` to ``state`` file updates the

DAMON-based operation scheme action tried regions directory for each

DAMON-based operation scheme of the kdamond.  Writing

``update_schemes_tried_bytes`` to ``state`` file updates only

``.../tried_regions/total_bytes`` files.  Writing

``clear_schemes_tried_regions`` to ``state`` file clears the DAMON-based

operating scheme action tried regions directory for each DAMON-based operation

scheme of the kdamond.  For details of the DAMON-based operation scheme action

tried regions directory, please refer to :ref:`tried_regions section

<sysfs_schemes_tried_regions>`.

``off`` if it is not running.



Users can write below commands for the kdamond to the ``state`` file.



- ``on``: Start running.

- ``off``: Stop running.

- ``commit``: Read the user inputs in the sysfs files except ``state`` file

  again.

- ``commit_schemes_quota_goals``: Read the DAMON-based operation schemes'

  :ref:`quota goals <sysfs_schemes_quota_goals>`.

- ``update_schemes_stats``: Update the contents of stats files for each

  DAMON-based operation scheme of the kdamond.  For details of the stats,

  please refer to :ref:`stats section <sysfs_schemes_stats>`.

- ``update_schemes_tried_regions``: Update the DAMON-based operation scheme

  action tried regions directory for each DAMON-based operation scheme of the

  kdamond.  For details of the DAMON-based operation scheme action tried

  regions directory, please refer to

  :ref:`tried_regions section <sysfs_schemes_tried_regions>`.

- ``update_schemes_tried_bytes``: Update only ``.../tried_regions/total_bytes``

  files.

- ``clear_schemes_tried_regions``: Clear the DAMON-based operating scheme

  action tried regions directory for each DAMON-based operation scheme of the

  kdamond.



If the state is ``on``, reading ``pid`` shows the pid of the kdamond thread.