From mboxrd@z Thu Jan 1 00:00:00 1970 Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.remote-ip=74.125.227.131 ARC-Seal: i=1; d=subspace.kernel.org; s=arc20261015; a=rsa-sha256; cv=none; t=1793013535; b=YSaV4FRhy/gMFVn+yl5agAFctLCMYTxi9NUQhJsqsHrJUd8dyqJ0CpqkORR/DKXKVY3w NMGbzZWoD4YXuInDahf4ziQ1T1Hhi0i+X7mzHNnAHIMnP1YfaEKQb8dovPveL6slur696 QGH4+9DuvAw+L7X2KcmGWN2mnzYYkFSU56lrLEcww9GCXzFQY3SbdG+dvPBTZReAzePu5 oDAIUtZGyIPbcFq3wzMOxgXabdQ4S3caoHHb6yZ1ao7zcOd67Z0QVo6Uejsxl1hKP1Mlp C2BX1uANLXNUsZnRr2GgvdbNcAjy4zQp5zSzdkqRQfLuC+T58hhcHMRYNRCGINiyliA== ARC-Message-Signature: i=1; d=subspace.kernel.org; s=arc20261015; a=rsa-sha256; c=relaxed/relaxed; t=1793013535; h=DMARC-Filter:Received:DKIM-Signature:X-Google-DKIM-Signature: X-Forwarded-Encrypted:X-Gm-Message-State:X-Gm-Gg:X-Received:Received: From:To:Cc:Subject:MIME-Version:Content-Type: Content-Transfer-Encoding:Date:Message-ID:In-Reply-To:References; bh=D6FqnEFeAupUPbtnZ9Y7i7Ho9zVceUZfQGwi96SCg9I=; b=DMuLCcJ8krNogcW1pKhGF3trUEODqihPWxNmcTCi7N2aR+Ws+pnOG0CNzWt45m3r/PTb /KejHeqly0GHugIvIH7C+xiVB0YchXjYyQV8QFYz1/xOV/eCLBQQS5MjDuDfS2n5YzTPh 76xA8HlpSVTsXqsoD70KVY6Z7rpIE+cJPL/0Ad11cYjBbPUwco+Jq7Tc+OeFl6dqJqmep oQFyj2YzcpfYcbGj+Rq7c+KorFaqDIj7BqYex+ixK0vf6hgN6hB5mSiTUHDgYNEHykQky 4ix0KAS9N9NexUKH2tGsmbdtdYNE30514EvHOmcu2cAAPB8K/ePX6kiUdDc8ZBceR0A== ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=pass header.from=gmail.com; spf=pass smtp.mailfrom=gmail.com; dkim=pass header.d=gmail.com header.i=@gmail.com header.a=rsa-sha256 header.s=20251104 header.b=NRmH1kvP; arc=none smtp.remote-ip=74.125.227.131 Received: from mail-pj2-f3.google.com (mail-pj2-f3.google.com [74.125.227.131]) (using TLSv1.3 with cipher TLS_AES_128_GCM_SHA256 (128/128 bits) key-exchange X25519 server-signature ECDSA (prime256v1) server-digest SHA256) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id 3AAB9606A330 for ; Mon, 26 Oct 2026 11:18:55 +0000 (UTC) DMARC-Filter: OpenDMARC Filter v1.4.2 smtp.subspace.kernel.org 3AAB9606A330 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=gmail.com Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=gmail.com Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key, unprotected) header.d=gmail.com header.i=@gmail.com header.a=rsa-sha256 header.s=20251104 header.b=NRmH1kvP Received: by mail-pj2-f3.google.com with SMTP id 98e67ed59e1d1-3ada2f39f30so759640a91.0 for ; Mon, 26 Oct 2026 04:18:55 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20251104; t=1793013534; x=1793618334; darn=vger.kernel.org; h=references:in-reply-to:message-id:date:content-transfer-encoding :content-type:mime-version:subject:cc:to:from:from:to:cc:subject :date:message-id:reply-to:content-type; bh=D6FqnEFeAupUPbtnZ9Y7i7Ho9zVceUZfQGwi96SCg9I=; b=NRmH1kvPz7qFtAWbVZFsvnOZ6/+0t8JUGJicS3bi0yLDwYe2AKhAhvLHi5uSQF1xCc jHMNCkxomN5acQ5KixulLsc8w8SUdfDMewod+jzUqspz1c8Hddpf9SJeScx8TQhraftF wmTOhAmSi+tIq9gkvDu47HNAtCl0fwi43SUbqeOBmWy3l+pmaD0rzROTCx+id9x7dutY 4iULjgRLJfTVcJiVfYxgkc0nXjRwW2yNFCFmGVbrwsltb7fl8jY7nJoZJRXUspPHwc6r YhOK7ZaiOAKz0M0oifjsgJkz5PO+7EIH52SjWJ3vqL0IX9AAdzVfogdZfkslLrlQOpSw BOAA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20260707; t=1793013534; x=1793618334; h=references:in-reply-to:message-id:date:content-transfer-encoding :content-type:mime-version:subject:cc:to:from:x-gm-gg :x-gm-message-state:from:to:cc:subject:date:message-id:reply-to :content-type; bh=D6FqnEFeAupUPbtnZ9Y7i7Ho9zVceUZfQGwi96SCg9I=; b=IaWM9Kr/tjb2kutZdIEY/7wTWRHWvGr2QaYSGTFpGV1m8XTeaDCKsJyfhj0L+WFk2w b8VPGWJw6sdQeWslT1JqlhELnOkNe1nUzsMrp+qdcPS/TxosVObCpNR7iMXY4MYF4Ckb uyE74rCQzRxg5gqjw/j/Yd2BcOGLyvJxzAq5/FqtLnFPCM8u547z6BMuTXVWWxvS1Xcd CX2dYB3J+BFGz4D/Pl2EnGF7zodaQSnld/RPiC2z0mpAYHp4sqmjD4ACV1pmmql8pldU H7SXJen0rINHjrixfv3jO9XkTvZM467oFuvdbE5WeuXr5aTl5s/k0WAZ9uXB/sO8+lHv WSKg== X-Forwarded-Encrypted: i=1; AKwUvBxjXAzDOSPm7YFpC4O4lfN2aFAdUXZmxOE0QZorXb3Pm3ChC0hEUPa6LYGb9dnm6/FxveB4iDcZ7Kp+Rik=@vger.kernel.org X-Gm-Message-State: AFq9FYLALxoevZviXpcnx5PUR0YGWEtce06yYVtzENhSeVZ7qDJrYvbn OEZn+6YhUuB0yqFzPASZST7ilYJBU5qwuW+KYRk71ySGzG+trmErO2AL X-Gm-Gg: AYBFou0dKV2OFK1W6WkOWzhoGvR100M0kA9gAYjERsGZ2f3jD/JaqTDxtuFS+Y2a2O/ QSJQbdDksof8UnIDcpdmUgrU13/mvCrfftbitxG82po7N7vPMsnwR1xAo4RdSsY0rg55GHrDWGW cGFO/3Pnz7Crj2I1zVxEdwE/iF4fGK5zHtZkKJq8R7O+XIeZcttPDr3H0PXtCD4pez7DpTi8s/v gVlGqhunWrUyFfyHmAOrBQtLqs6By4QH01vDmc6g+yL7vLDnBwUMHprwvjZZ3T6AI5c1cAu8yU2 CpVkBMA1lS/5hmariSbNykJDVsVE1KoW/i+IEjBwZf5YbbCg8GQ5mH3Ysi47kn5ho0PwAO/jbjd 3+TwCzq0bPz6Ayqn/HwlpeMCE1FYgnprWNfQXagm2i1F+9bCq37EkLJgVdXVu5YsF88dCnPxGxF SHmQn/My7GYukCHJDIGVnzhMEhTCM0xk4DCazc+aI7Di477S8JX21bF1MrugKoJ1AdhOnRnRDM6 +Gm1WIbhUjBX0+ARnAWyhw0mIIt1RkqcGUQM9rzDfw+Du5DXT61LtFEB27pYb0AcjkWwtMv6QJg BOxJcZiZaYRSMKp90diOMjgWwPumliPO+akAmBom2R4CXy5jd9v9uGA= X-Received: by 2002:a17:90b:2742:b0:3ac:8527:3fc5 with SMTP id 98e67ed59e1d1-3ade9b2f909mr4872984a91.3.1793013534409; Mon, 26 Oct 2026 04:18:54 -0700 (PDT) Received: from localhost (n106-71-19-159.sun21.vic.optusnet.com.au. [106.71.19.159]) by smtp.gmail.com with ESMTPSA id 98e67ed59e1d1-3adebb75254sm4783820a91.4.2026.10.26.04.18.43 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 26 Oct 2026 04:18:54 -0700 (PDT) From: Aveline Noir To: SJ Park Cc: Jonathan Corbet , Shuah Khan , Randy Dunlap , Manuel Ebner , 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 X-Mailing-List: linux-kernel@vger.kernel.org List-Id: List-Post: List-Help: List-Subscribe: List-Unsubscribe: List-Owner: Precedence: list MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Date: Mon, 26 Oct 2026 22:14:35 +1100 Message-ID: <179301327249.2.6830202812762243627.damon-docs-grammar-3@gmail.com> In-Reply-To: <179301327249.2.4690198998605536207.damon-docs-grammar-0@gmail.com> References: <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 --- 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 `_ is one example of such programs. - *Kernel Space Programming Interface.* :doc:`This ` 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 ` inputs are also be + again. Monitoring :ref:`target region ` 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 ` 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 ` 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 ` by -writing to and reading from each of the files. Because the kernel does not +are specified on the :ref:`design doc ` +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//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 ` for more details about the stats. @@ -722,15 +723,15 @@ tried_regions//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