Re: [RFC PATCH] mm/damon: explain "effective quota" on kernel-doc comment

[Honggyu Kim <honggyu.kim@sk.com>]

Hi SeongJae,

Thanks very much for the quick response.  I think it looks great but I
have some minor comments so please see my inline comments below.

Thanks,
Honggyu

On Mon, 25 Nov 2024 16:29:21 -0800 SeongJae Park <sj@kernel.org> wrote:
> The kernel-doc comment for 'struct damos_quota' describes how "effective
> quota" is calculated, but does not explain what it is.  Actually there
> was an input[1] about it.  Add the explanation on the comment.
> 
> [1] https://github.com/damonitor/damo/issues/17#issuecomment-2497525043
> 
> Cc: Yunjeong Mun <yunjeong.mun@sk.com>
> Cc: Honggyu Kim <honggyu.kim@sk.com>
> Signed-off-by: SeongJae Park <sj@kernel.org>
> ---
>  include/linux/damon.h | 10 +++++++---
>  1 file changed, 7 insertions(+), 3 deletions(-)
> 
> diff --git a/include/linux/damon.h b/include/linux/damon.h
> index a67f2c4940e9..a01bfe2ff616 100644
> --- a/include/linux/damon.h
> +++ b/include/linux/damon.h
> @@ -193,9 +193,13 @@ struct damos_quota_goal {
>   * size quota is set, DAMON tries to apply the action only up to &sz bytes
>   * within &reset_interval.
>   *
> - * Internally, the time quota is transformed to a size quota using estimated
> - * throughput of the scheme's action.  DAMON then compares it against &sz and
> - * uses smaller one as the effective quota.
> + * To convince the different types of quotas and goals, DAMON internally
> + * converts those into one single size quota called "effective quota".  DAMON

Could we use "effective size quota" instead of "effective quota"?
IMHO, it will better give an idea this is related to "esz" in the code,
which means effective size.

> + * internally uses it as only one real quota.  The convert is made as follows.

(nit) "as only one" can be "as the only one".
(another nit) "The convert is made" can be "The conversion is made".

> + *
> + * The time quota is transformed to a size quota using estimated throughput of
> + * the scheme's action.  DAMON then compares it against &sz and uses smaller
> + * one as the effective quota.
>   *
>   * If @goals is not empt, DAMON calculates yet another size quota based on the

We better fix "empt" to "empty" together.

>   * goals using its internal feedback loop algorithm, for every @reset_interval.
> -- 
> 2.39.5
>