Re: [PATCH] mm/damon/reclaim: improve grammar and style

[SJ Park <sj@kernel.org>]

On Sat, 17 Oct 2026 11:18:34 +0200 Manuel Ebner <manuelebnerli@mailbox.org> wrote:

> Hi SJ,
> 
> On Thu, 2026-10-15 at 07:01 -0700, SJ Park wrote:
> > On Thu, 15 Oct 2026 10:06:23 +0200 Manuel Ebner <manuelebnerli@mailbox.org> wrote:
> > 
> > > Fix tenses. Replace 'set as' with 'set to'.
> > > Rewrite complex sentences.
> > 
> > Let's put two sentences in one line, while breaking it for the 75 column limit.
> 
> Will do.
> > 
> > [...]
> > > @@ -113,8 +113,8 @@ quota_sz
> > >  
> > >  Limit of size of memory for the reclamation in bytes.
> > >  
> > > -DAMON_RECLAIM charges amount of memory which it tried to reclaim within a time
> > > -window (quota_reset_interval_ms) and makes no more than this limit is tried.
> > > +DAMON_RECLAIM recordes the amount of memory which it tried to reclaim within a time
> > 
> > s/recordes/charges/  or s/recordes/records/ ?
> 
> For me charge is such a weird word exepct in 'charge a battery' or 'charge a fee'. And
> 'recordes' is a typo. Does this work:

'charge' in this sentence is somewhat like 'charge a fee'.  I personally don't
feel it is weird.  But 'record' also work for me.

> 
> DAMON_RECLAIM records the amount of memory which it tried to reclaim within a time

So this looks good to me, too.

> 
> I could do this in a second patch aswell.
> 
> > 
> > I'd prefer charges, but my English is definitely bad, so looking for your
> > suggestion.
> > 
> > > +window (quota_reset_interval_ms) and stops when this memory limit is reached.
> > 
> > I feel like readers might wonder what is stopped.  How about "stops trying
> > reclaiming memory when ..." ?
> 
> window (quota_reset_interval_ms) and stops trying to reclaim memory when this limit is reached.

Looks good.

> 
> > 
> > >  This can be used for limiting consumption of CPU and IO.  If this value is
> > >  zero, the limit is disabled.
> > >  
> > > @@ -125,19 +125,19 @@ quota_reset_interval_ms
> > >  
> > >  The time/size quota charge reset interval in milliseconds.
> > >  
> > > -The charge reset interval for the quota of time (quota_ms) and size
> > > -(quota_sz).  That is, DAMON_RECLAIM does not try reclamation for more than
> > > +The quota reset interval of time is quota_ms and of size is
> > > +quota_sz.  That is, DAMON_RECLAIM does not try reclamation for more than
> > 
> > I think this change is just wrong?  quota_ms is not quota reset interval of
> > time.  Which part of the original sentence was difficult to read?
> 
> 'charge' again, and I think there is the verb is missing.

If use of the term 'charge' is really making reading difficult, we could add a
short definition of 'charge' as a separate patch.

E.g., 

'''
--- a/Documentation/mm/damon/design.rst
+++ b/Documentation/mm/damon/design.rst
@@ -695,7 +695,9 @@ dynamic.
 To mitigate that situation, DAMOS provides an upper-bound overhead control
 feature called quotas.  It lets users specify an upper limit of time that DAMOS
 can use for applying the action, and/or a maximum bytes of memory regions that
-the action can be applied within a user-specified time duration.
+the action can be applied within a user-specified time duration.  DAMOS tracks
+(charge) the amount of memory that the action is applied, and stops applying
+the action once the limit is reached.

 To know how user-space can set the basic quotas via :ref:`DAMON sysfs interface
 <sysfs_interface>`, refer to :ref:`quotas <sysfs_quotas>` part of the
'''

Please let me know if you'd like to send such a patch.

> 
> > 
> > >  quota_ms milliseconds or quota_sz bytes within quota_reset_interval_ms
> > >  milliseconds.
> > >  
> > > -1 second by default.
> > > +1000 (1 second) by default.
> > 
> > Isn't this (1 second in milliseconds is 1,000) easy enough to infer for
> > readers?
> 
> Ok.
> 
> > >  
> > >  quota_mem_pressure_us
> > >  ---------------------
> > >  
> > >  Desired level of memory pressure-stall time in microseconds.
> > >  
> > > -While keeping the caps that set by other quotas, DAMON_RECLAIM automatically
> > > +While keeping the caps set by other quotas, DAMON_RECLAIM automatically
> > 
> > How about "caps that are set by ..." ?
> 
> Yes, this was my second choice.
> 
> > 
> > >  increases and decreases the effective level of the quota aiming this level of
> > >  memory pressure is incurred.  System-wide ``some`` memory PSI in microseconds
> > >  per quota reset interval (``quota_reset_interval_ms``) is collected and
> > 
> > 
> > Thanks,
> > SJ
> 
> I messed up the subject line, should be:
> Docs/admin-guide/mm/damon/reclaim: improve grammar and style
> 
> I'll follow up with a [v2], including Aveline suggestions.

Sounds good.  But let's finish the discussion about use of the term, 'charge'
before posting v2.


Thanks,
SJ

[...]