[PATCH v2 RESEND] design: fix typos in design.rst

Sakurai Shun posted 1 patch 1 week ago
Documentation/mm/damon/design.rst | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
[PATCH v2 RESEND] design: fix typos in design.rst
Posted by Sakurai Shun 1 week ago
L140: "unsinged" -> "unsigned"
L371: "sampleing" -> "sampling"
L387: "multipled" -> "multiplied"

Signed-off-by: Sakurai Shun <ssh1326@icloud.com>
---
 Documentation/mm/damon/design.rst | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/Documentation/mm/damon/design.rst b/Documentation/mm/damon/design.rst
index afc7d52bd..9cc70a296 100644
--- a/Documentation/mm/damon/design.rst
+++ b/Documentation/mm/damon/design.rst
@@ -140,7 +140,7 @@ as Idle page tracking does.
 Address Unit
 ------------
 
-DAMON core layer uses ``unsinged long`` type for monitoring target address
+DAMON core layer uses ``unsigned long`` type for monitoring target address
 ranges.  In some cases, the address space for a given operations set could be
 too large to be handled with the type.  ARM (32-bit) with large physical
 address extension is an example.  For such cases, a per-operations set
@@ -371,7 +371,7 @@ with theoretical maximum ``nr_accesses``, which can be calculated as
 ``aggregation interval / sampling interval``.
 
 The mechanism calculates the ratio of access events for ``aggrs`` aggregations,
-and increases or decrease the ``sampleing interval`` and ``aggregation
+and increases or decrease the ``sampling interval`` and ``aggregation
 interval`` in same ratio, if the observed access ratio is lower or higher than
 the target, respectively.  The ratio of the intervals change is decided in
 proportion to the distance between current samples ratio and the target ratio.
@@ -387,7 +387,7 @@ The tuning is turned off by default, and need to be set explicitly by the user.
 As a rule of thumbs and the Parreto principle, 4% access samples ratio target
 is recommended.  Note that Parreto principle (80/20 rule) has applied twice.
 That is, assumes 4% (20% of 20%) DAMON-observed access events ratio (source)
-to capture 64% (80% multipled by 80%) real access events (outcomes).
+to capture 64% (80% multiplied by 80%) real access events (outcomes).
 
 To know how user-space can use this feature via :ref:`DAMON sysfs interface
 <sysfs_interface>`, refer to :ref:`intervals_goal
-- 
2.54.0
Re: [PATCH v2 RESEND] design: fix typos in design.rst
Posted by SeongJae Park 1 week ago
Hello Sakurai,


Thank you for sending v2 of this patch!

As I commented [1] to the previous version, let's use 'Docs/mm/damon/design:'
as the prefix of the subject, e.g., "Docs/mm/damon/design: fix three typos"

On Sun, 17 May 2026 16:34:26 +0900 Sakurai Shun <ssh1326@icloud.com> wrote:

> L140: "unsinged" -> "unsigned"
> L371: "sampleing" -> "sampling"
> L387: "multipled" -> "multiplied"
> 
> Signed-off-by: Sakurai Shun <ssh1326@icloud.com>

Assuming the subject prefix suggestion is accepted,

Reviewed-by: SeongJae Park <sj@kernel.org>

If you willing to, please send v3 with the change.  But please do so after
giving time (say, one day?) for others to further comment.

Unless you object to the subject prefix change suggestion, Andrew might pick
this after making the subject line change on his own.  I will also pick this
with my subject line change suggestion on my tree (damon/next), and repost it
for mm.git inclusion if it seems Andrew will not do so.

So, assuming you are ok with my subject line change suggestion, no more work
from your side is needed (unless you willing to do some).  Thank you for your
contribution, Sakurai :)

> ---

Also, from the next time, please add patch changelog here [2].


[1] https://lore.kernel.org/20260516170847.146524-1-sj@kernel.org
[2] https://docs.kernel.org/process/submitting-patches.html#commentary


Thanks,
SJ

[...]
Re: [PATCH v2 RESEND] design: fix typos in design.rst
Posted by Mike Rapoport 1 week ago
Hi,

On Sun, May 17, 2026 at 04:34:26PM +0900, Sakurai Shun wrote:
> Subject: [PATCH v2 RESEND] design: fix typos in design.rst

Please use more descriptive prefix next time, like SJ suggested
Docs/mm/damon/design

"design" is too vague and gives zero clues about what subsystem it is.

> L140: "unsinged" -> "unsigned"
> L371: "sampleing" -> "sampling"
> L387: "multipled" -> "multiplied"
> 
> Signed-off-by: Sakurai Shun <ssh1326@icloud.com>

Acked-by: Mike Rapoport (Microsoft) <rppt@kernel.org>

> ---
>  Documentation/mm/damon/design.rst | 6 +++---
>  1 file changed, 3 insertions(+), 3 deletions(-)

-- 
Sincerely yours,
Mike.
Re: [PATCH v2 RESEND] design: fix typos in design.rst
Posted by Lorenzo Stoakes 1 week ago
On Sun, May 17, 2026 at 04:34:26PM +0900, Sakurai Shun wrote:
> L140: "unsinged" -> "unsigned"
> L371: "sampleing" -> "sampling"
> L387: "multipled" -> "multiplied"
>
> Signed-off-by: Sakurai Shun <ssh1326@icloud.com>

LGTM, so:

Reviewed-by: Lorenzo Stoakes <ljs@kernel.org>

> ---
>  Documentation/mm/damon/design.rst | 6 +++---
>  1 file changed, 3 insertions(+), 3 deletions(-)
>
> diff --git a/Documentation/mm/damon/design.rst b/Documentation/mm/damon/design.rst
> index afc7d52bd..9cc70a296 100644
> --- a/Documentation/mm/damon/design.rst
> +++ b/Documentation/mm/damon/design.rst
> @@ -140,7 +140,7 @@ as Idle page tracking does.
>  Address Unit
>  ------------
>
> -DAMON core layer uses ``unsinged long`` type for monitoring target address
> +DAMON core layer uses ``unsigned long`` type for monitoring target address
>  ranges.  In some cases, the address space for a given operations set could be
>  too large to be handled with the type.  ARM (32-bit) with large physical
>  address extension is an example.  For such cases, a per-operations set
> @@ -371,7 +371,7 @@ with theoretical maximum ``nr_accesses``, which can be calculated as
>  ``aggregation interval / sampling interval``.
>
>  The mechanism calculates the ratio of access events for ``aggrs`` aggregations,
> -and increases or decrease the ``sampleing interval`` and ``aggregation
> +and increases or decrease the ``sampling interval`` and ``aggregation
>  interval`` in same ratio, if the observed access ratio is lower or higher than
>  the target, respectively.  The ratio of the intervals change is decided in
>  proportion to the distance between current samples ratio and the target ratio.
> @@ -387,7 +387,7 @@ The tuning is turned off by default, and need to be set explicitly by the user.
>  As a rule of thumbs and the Parreto principle, 4% access samples ratio target
>  is recommended.  Note that Parreto principle (80/20 rule) has applied twice.
>  That is, assumes 4% (20% of 20%) DAMON-observed access events ratio (source)
> -to capture 64% (80% multipled by 80%) real access events (outcomes).
> +to capture 64% (80% multiplied by 80%) real access events (outcomes).
>
>  To know how user-space can use this feature via :ref:`DAMON sysfs interface
>  <sysfs_interface>`, refer to :ref:`intervals_goal
> --
> 2.54.0
>