mm/mlock: Fix argument list that the kdoc format and script verified.

[PATCH -next] mm/mlock: Fix argument list that the kdoc format and script verified.

Posted by Yang Li 4 years, 3 months ago

The warnings were found by running scripts/kernel-doc, which is
caused by using 'make W=1'.

mm/mlock.c:225: warning: Function parameter or member 'folio' not
described in 'mlock_folio'
mm/mlock.c:225: warning: Excess function parameter 'page' description in
'mlock_folio'

Reported-by: Abaci Robot <abaci@linux.alibaba.com>
Signed-off-by: Yang Li <yang.lee@linux.alibaba.com>
---
 mm/mlock.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/mm/mlock.c b/mm/mlock.c
index e8e4274480bf..d6294042698a 100644
--- a/mm/mlock.c
+++ b/mm/mlock.c
@@ -219,7 +219,7 @@ bool need_mlock_page_drain(int cpu)
 
 /**
  * mlock_folio - mlock a folio already on (or temporarily off) LRU
- * @page: folio to be mlocked.
+ * @folio: The folio we're currently operating on.
  */
 void mlock_folio(struct folio *folio)
 {
-- 
2.20.1.7.g153144c

Re: [PATCH -next] mm/mlock: Fix argument list that the kdoc format and script verified.

Posted by Matthew Wilcox 4 years, 3 months ago

On Thu, Feb 24, 2022 at 02:27:14PM +0800, Yang Li wrote:
> The warnings were found by running scripts/kernel-doc, which is
> caused by using 'make W=1'.
> 
> mm/mlock.c:225: warning: Function parameter or member 'folio' not
> described in 'mlock_folio'
> mm/mlock.c:225: warning: Excess function parameter 'page' description in
> 'mlock_folio'

Folded it into the patch that introduced the problem.