Date:   Mon, 10 Jan 2022 12:29:13 +0100
From:   Jan Kara <jack@suse.cz>
To:     Yang Li <yang.lee@linux.alibaba.com>
Cc:     tytso@mit.edu, jack@suse.com, linux-ext4@vger.kernel.org,
        linux-kernel@vger.kernel.org, Abaci Robot <abaci@linux.alibaba.com>
Subject: Re: [PATCH -next] ext4: Fix jbd2_journal_shrink_scan() and
 jbd2_journal_shrink_count() kernel-doc comment
Message-ID: <20220110112913.uzf3qhxf5tppc2ej@quack3.lan>
References: <20220110030229.19864-1-yang.lee@linux.alibaba.com>
MIME-Version: 1.0
Content-Type: text/plain; charset=us-ascii
Content-Disposition: inline
In-Reply-To: <20220110030229.19864-1-yang.lee@linux.alibaba.com>
Precedence: bulk

On Mon 10-01-22 11:02:29, Yang Li wrote:
> Add the description of @shrink and @sc in jbd2_journal_shrink_scan() and
> jbd2_journal_shrink_count() kernel-doc comment to remove warnings found
> by running scripts/kernel-doc, which is caused by using 'make W=1'.
> fs/jbd2/journal.c:1296: warning: Function parameter or member 'shrink'
> not described in 'jbd2_journal_shrink_scan'
> fs/jbd2/journal.c:1296: warning: Function parameter or member 'sc' not
> described in 'jbd2_journal_shrink_scan'
> fs/jbd2/journal.c:1320: warning: Function parameter or member 'shrink'
> not described in 'jbd2_journal_shrink_count'
> fs/jbd2/journal.c:1320: warning: Function parameter or member 'sc' not
> described in 'jbd2_journal_shrink_count'
> 
> Reported-by: Abaci Robot <abaci@linux.alibaba.com>
> Signed-off-by: Yang Li <yang.lee@linux.alibaba.com>

Thanks for the fix! Just one comment below:

>  /**
>   * jbd2_journal_shrink_scan()
> + * @shrink: A callback you can register to apply pressure to ageable caches.
> + * @sc: pass information from page reclaim to the shrinkers.
>   *
>   * Scan the checkpointed buffer on the checkpoint list and release the
>   * journal_head.
> @@ -1312,6 +1314,8 @@ static unsigned long jbd2_journal_shrink_scan(struct shrinker *shrink,
>  
>  /**
>   * jbd2_journal_shrink_count()
> + * @shrink: A callback you can register to apply pressure to ageable caches.
> + * @sc: pass information from page reclaim to the shrinkers.
>   *
>   * Count the number of checkpoint buffers on the checkpoint list.
>   */

I think the comments are unnecessarily verbose and not really helping much.
Maybe just something like:

 * @shrink: shrinker to work on
 * @sc: reclaim request to process

								Honza

-- 
Jan Kara <jack@suse.com>
SUSE Labs, CR