diff mbox series

[1/2] Docs/admin-guide/mm/damon/usage: describe the rules of sysfs region directories

Message ID 20221024174619.15600-2-sj@kernel.org
State New
Headers
Series Docs/admin-buide/mm/damon/usage: minor fixes |

Commit Message

SeongJae Park Oct. 24, 2022, 5:46 p.m. UTC 
  Target region directories of DAMON sysfs interface should contain no
overlap and sorted by the address, but not clearly documented.
Actually, a user had an issue[1] due to the poor documentation.  Add
clear description of it on the usage document.

[1] https://lore.kernel.org/damon/CAEZ6=UNUcH2BvJj++OrT=XQLdkidU79wmCO=tantSOB36pPNTg@mail.gmail.com/

Reported-by: Vinicius Petrucci <vpetrucci@gmail.com>
Signed-off-by: SeongJae Park <sj@kernel.org>
---
 Documentation/admin-guide/mm/damon/usage.rst | 3 +++
 1 file changed, 3 insertions(+)
diff mbox series

Patch

diff --git a/Documentation/admin-guide/mm/damon/usage.rst b/Documentation/admin-guide/mm/damon/usage.rst
index b47b0cbbd491..89d9a4f75a29 100644
--- a/Documentation/admin-guide/mm/damon/usage.rst
+++ b/Documentation/admin-guide/mm/damon/usage.rst
@@ -235,6 +235,9 @@  In each region directory, you will find two files (``start`` and ``end``).  You
 can set and get the start and end addresses of the initial monitoring target
 region by writing to and reading from the files, respectively.
 
+Each region should not overlap with others.  ``end`` of directory ``N`` should
+be equal or smaller than ``start`` of directory ``N+1``.
+
 contexts/<N>/schemes/
 ---------------------