Skip to content

Commit 4c1f287

Browse files
sjp38torvalds
authored andcommitted
Docs/damon: update outdated term 'regions update interval'
Before DAMON is merged in the mainline, the concept of 'regions update interval' has generalized to be used as the time interval for update of any monitoring operations related data structure, but the document has not updated properly. This commit updates the document for better consistency. Link: https://lkml.kernel.org/r/[email protected] Signed-off-by: SeongJae Park <[email protected]> Cc: Jonathan Corbet <[email protected]> Signed-off-by: Andrew Morton <[email protected]> Signed-off-by: Linus Torvalds <[email protected]>
1 parent 742cc2b commit 4c1f287

File tree

2 files changed

+10
-8
lines changed

2 files changed

+10
-8
lines changed

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ Attributes
4747
----------
4848

4949
Users can get and set the ``sampling interval``, ``aggregation interval``,
50-
``regions update interval``, and min/max number of monitoring target regions by
50+
``update interval``, and min/max number of monitoring target regions by
5151
reading from and writing to the ``attrs`` file. To know about the monitoring
5252
attributes in detail, please refer to the :doc:`/vm/damon/design`. For
5353
example, below commands set those values to 5 ms, 100 ms, 1,000 ms, 10 and
@@ -128,8 +128,8 @@ ranges, ``20-40`` and ``50-100`` as that of pid 4242, which is the second one
128128

129129
Note that this sets the initial monitoring target regions only. In case of
130130
virtual memory monitoring, DAMON will automatically updates the boundary of the
131-
regions after one ``regions update interval``. Therefore, users should set the
132-
``regions update interval`` large enough in this case, if they don't want the
131+
regions after one ``update interval``. Therefore, users should set the
132+
``update interval`` large enough in this case, if they don't want the
133133
update.
134134

135135

Documentation/vm/damon/design.rst

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -95,8 +95,8 @@ Address Space Independent Core Mechanisms
9595

9696
Below four sections describe each of the DAMON core mechanisms and the five
9797
monitoring attributes, ``sampling interval``, ``aggregation interval``,
98-
``regions update interval``, ``minimum number of regions``, and ``maximum
99-
number of regions``.
98+
``update interval``, ``minimum number of regions``, and ``maximum number of
99+
regions``.
100100

101101

102102
Access Frequency Monitoring
@@ -169,6 +169,8 @@ The monitoring target address range could dynamically changed. For example,
169169
virtual memory could be dynamically mapped and unmapped. Physical memory could
170170
be hot-plugged.
171171

172-
As the changes could be quite frequent in some cases, DAMON checks the dynamic
173-
memory mapping changes and applies it to the abstracted target area only for
174-
each of a user-specified time interval (``regions update interval``).
172+
As the changes could be quite frequent in some cases, DAMON allows the
173+
monitoring operations to check dynamic changes including memory mapping changes
174+
and applies it to monitoring operations-related data structures such as the
175+
abstracted monitoring target memory area only for each of a user-specified time
176+
interval (``update interval``).

0 commit comments

Comments
 (0)