From: Aveline Noir <jm5905938@gmail.com>
To: SJ Park <sj@kernel.org>
Cc: Jonathan Corbet <corbet@lwn.net>,
Shuah Khan <skhan@linuxfoundation.org>,
Randy Dunlap <rdunlap@infradead.org>,
Manuel Ebner <manuelebnerli@mailbox.org>,
damon@lists.linux.dev, linux-mm@kvack.org,
linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org
Subject: [PATCH 3/8] Docs/admin-guide/mm/damon/usage: fix grammar
Date: Mon, 26 Oct 2026 22:14:35 +1100 [thread overview]
Message-ID: <179301327249.2.6830202812762243627.damon-docs-grammar-3@gmail.com> (raw)
In-Reply-To: <179301327249.2.4690198998605536207.damon-docs-grammar-0@gmail.com>
Fix a handful of grammar mistakes in the usage doc, mostly
subject-verb agreement and a missing or extra "be". Also turn "Below
commands applies" into "The commands below apply", which I think reads
better. Rewrap where the lines got too long.
Signed-off-by: Aveline Noir <jm5905938@gmail.com>
---
Documentation/admin-guide/mm/damon/usage.rst | 31 ++++++++++----------
1 file changed, 16 insertions(+), 15 deletions(-)
diff --git a/Documentation/admin-guide/mm/damon/usage.rst b/Documentation/admin-guide/mm/damon/usage.rst
index 3c4f3651a244..ffb487defa22 100644
--- a/Documentation/admin-guide/mm/damon/usage.rst
+++ b/Documentation/admin-guide/mm/damon/usage.rst
@@ -23,7 +23,7 @@ DAMON provides below interfaces for different users.
want more optimized use of DAMON. Using this, users can use DAMON’s major
features by reading from and writing to special sysfs files. Therefore,
you can write and use your personalized DAMON sysfs wrapper programs that
- reads/writes the sysfs files instead of you. The `DAMON user space tool
+ read/write the sysfs files instead of you. The `DAMON user space tool
<https://github.com/damonitor/damo>`_ is one example of such programs.
- *Kernel Space Programming Interface.*
:doc:`This </mm/damon/api>` is for kernel space programmers. Using this,
@@ -163,7 +163,7 @@ 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. Monitoring :ref:`target region <sysfs_regions>` inputs are also be
+ again. Monitoring :ref:`target region <sysfs_regions>` inputs are also
ignored if no target region is specified.
- ``update_tuned_intervals``: Update the contents of ``sample_us`` and
``aggr_us`` files of the kdamond with the auto-tuning applied ``sampling
@@ -258,7 +258,7 @@ writing to and reading from the files.
Under ``nr_regions`` directory, two files for the lower-bound and upper-bound
of DAMON's monitoring regions (``min`` and ``max``, respectively), which
-controls the monitoring overhead, exist. You can set and get the values by
+control the monitoring overhead, exist. You can set and get the values by
writing to and reading from the files.
For more details about the intervals and monitoring regions range, please refer
@@ -310,7 +310,7 @@ Under the directory, four files for the auto-tuning control, namely
Please refer to the :ref:`design document of the feature
<damon_design_monitoring_intervals_autotuning>` for the internal of the tuning
mechanism. Reading and writing the four files under ``intervals_goal``
-directory shows and updates the tuning parameters that described in the
+directory shows and updates the tuning parameters that are described in the
:ref:`design doc <damon_design_monitoring_intervals_autotuning>` with the same
names. The tuning starts with the user-set ``sample_us`` and ``aggr_us``. The
tuning-applied current values of the two intervals can be read from the
@@ -538,8 +538,8 @@ Among the multiple feedback, the best one is used.
Each goal directory contains six files, namely ``target_metric``,
``complement``, ``target_value``, ``current_value``, ``nid``, and ``path``.
Users can set and get the six parameters for the quota auto-tuning goals that
-specified on the :ref:`design doc <damon_design_damos_quotas_auto_tuning>` by
-writing to and reading from each of the files. Because the kernel does not
+are specified on the :ref:`design doc <damon_design_damos_quotas_auto_tuning>`
+by writing to and reading from each of the files. Because the kernel does not
update ``current_value``, reading it only makes sense when ``target_metric`` is
``user_input``. Note that users should further write
``commit_schemes_quota_goals`` to the ``state`` file of the :ref:`kdamond
@@ -577,8 +577,9 @@ DAMON-based operation scheme.
``core_filters`` and ``ops_filters`` directories are for the filters handled by
the DAMON core layer and operations set layer, respectively. ``filters``
directory can be used for installing filters regardless of their handled
-layers. Filters that requested by ``core_filters`` and ``ops_filters`` will be
-installed before those of ``filters``. All three directories have same files.
+layers. Filters that are requested by ``core_filters`` and ``ops_filters`` will
+be installed before those of ``filters``. All three directories have same
+files.
Use of ``filters`` directory can make filters evaluation orders confusing to
expect. For this reason, ``filters`` directory is deprecated. It is still
@@ -654,16 +655,16 @@ Users can write and read the identifier of the destination to ``id`` file.
For ``DAMOS_MIGRATE_{HOT,COLD}`` actions, the migrate destination node's node
id should be written to ``id`` file. Users can write and read the weight of
the destination among the given destinations to the ``weight`` file. The
-weight can be an arbitrary integer. When DAMOS apply the action to each entity
-of the memory region, it will select the destination of the action based on the
-relative weights of the destinations.
+weight can be an arbitrary integer. When DAMOS applies the action to each
+entity of the memory region, it will select the destination of the action based
+on the relative weights of the destinations.
.. _sysfs_schemes_stats:
schemes/<N>/stats/
------------------
-DAMON counts statistics for each scheme. This statistics can be used for
+DAMON counts statistics for each scheme. These statistics can be used for
online analysis or tuning of the schemes. Refer to :ref:`design doc
<damon_design_damos_stat>` for more details about the stats.
@@ -722,15 +723,15 @@ tried_regions/<N>/probes/
-------------------------
In each region directory, one directory (``probes``) also exists. In the
-directory, subdirectories named ``0`` to ``N-1`` exists. ``N`` is the number
-of installed probes. In each number-named directory, a file (``hits``) exist.
+directory, subdirectories named ``0`` to ``N-1`` exist. ``N`` is the number
+of installed probes. In each number-named directory, a file (``hits``) exists.
Reading the file shows the number of data attributes monitoring probe-hit
positive samples of the region.
Example
~~~~~~~
-Below commands applies a scheme saying "If a memory region of size in [4KiB,
+The commands below apply a scheme saying "If a memory region of size in [4KiB,
8KiB] is showing accesses per aggregate interval in [0, 5] for aggregate
interval in [10, 20], page out the region. For the paging out, use only up to
10ms per second, and also don't page out more than 1GiB per second. Under the
next prev parent reply other threads:[~2026-10-26 11:18 UTC|newest]
Thread overview: 28+ messages / expand[flat|nested] mbox.gz Atom feed top
2026-10-26 11:14 [PATCH 0/8] Docs: damon: fix grammar and typos Aveline Noir
2026-10-26 11:14 ` [PATCH 1/8] Docs/admin-guide/mm/damon/start: fix grammar Aveline Noir
2026-10-26 12:41 ` Manuel Ebner
2026-10-26 14:29 ` SJ Park
2026-10-26 15:50 ` Aveline Noir
2026-10-26 14:10 ` SJ Park
2026-10-26 11:14 ` [PATCH 2/8] Docs/admin-guide/mm/damon/stat: fix pronoun agreement Aveline Noir
2026-10-26 12:44 ` Manuel Ebner
2026-10-26 14:31 ` SJ Park
2026-10-26 15:50 ` Aveline Noir
2026-10-26 14:24 ` SJ Park
2026-10-26 11:14 ` Aveline Noir [this message]
2026-10-26 14:37 ` [PATCH 3/8] Docs/admin-guide/mm/damon/usage: fix grammar SJ Park
2026-10-26 11:14 ` [PATCH 4/8] Docs/admin-guide/mm/damon/lru_sort: fix remaining grammar Aveline Noir
2026-10-26 12:57 ` Manuel Ebner
2026-10-26 14:44 ` SJ Park
2026-10-26 15:50 ` Aveline Noir
2026-10-26 14:42 ` SJ Park
2026-10-26 11:14 ` [PATCH 5/8] Docs/mm/damon/design: fix grammar and typos Aveline Noir
2026-10-26 14:54 ` SJ Park
2026-10-26 11:14 ` [PATCH 6/8] Docs/mm/damon/api: fix verb form Aveline Noir
2026-10-26 14:55 ` SJ Park
2026-10-26 11:14 ` [PATCH 7/8] Docs/mm/damon/maintainer-profile: fix subject-verb agreement Aveline Noir
2026-10-26 14:56 ` SJ Park
2026-10-26 11:14 ` [PATCH 8/8] Docs/mm/damon/monitoring_intervals_tuning_example: fix grammar and typos Aveline Noir
2026-10-26 14:59 ` SJ Park
2026-10-27 0:49 ` [PATCH 0/8] Docs: damon: " SJ Park
2026-10-27 2:46 ` Aveline Noir
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=179301327249.2.6830202812762243627.damon-docs-grammar-3@gmail.com \
--to=jm5905938@gmail.com \
--cc=corbet@lwn.net \
--cc=damon@lists.linux.dev \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-mm@kvack.org \
--cc=manuelebnerli@mailbox.org \
--cc=rdunlap@infradead.org \
--cc=sj@kernel.org \
--cc=skhan@linuxfoundation.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox
all inboxes | Powered by JetHome®