Skip to content

Commit 0411d6e

Browse files
sjp38akpm00
authored andcommitted
include/linux/mm: fix release_pages_arg kernel doc comment
Commit 449c796 ("mm: teach release_pages() to take an array of encoded page pointers too") added the kernel doc comment for release_pages() on top of 'union release_pages_arg', so making 'make htmldocs' complains as below: ./include/linux/mm.h:1268: warning: cannot understand function prototype: 'typedef union ' The kernel doc comment for the function is already on top of the function's definition in mm/swap.c, and the new comment is actually not for the function but indeed release_pages_arg. Fixing the comment to reflect the intent would be one option. But, kernel doc cannot parse the union as below due to the attribute. ./include/linux/mm.h:1272: error: Cannot parse struct or union! Modify the comment to reflect the intent but do not mark it as a kernel doc comment. Link: https://lkml.kernel.org/r/[email protected] Fixes: 449c796 ("mm: teach release_pages() to take an array of encoded page pointers too") Signed-off-by: SeongJae Park <[email protected]> Acked-by: Randy Dunlap <[email protected]> Signed-off-by: Andrew Morton <[email protected]>
1 parent d09dce1 commit 0411d6e

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

include/linux/mm.h

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1270,10 +1270,10 @@ static inline void folio_put_refs(struct folio *folio, int refs)
12701270
__folio_put(folio);
12711271
}
12721272

1273-
/**
1274-
* release_pages - release an array of pages or folios
1273+
/*
1274+
* union release_pages_arg - an array of pages or folios
12751275
*
1276-
* This just releases a simple array of multiple pages, and
1276+
* release_pages() releases a simple array of multiple pages, and
12771277
* accepts various different forms of said page array: either
12781278
* a regular old boring array of pages, an array of folios, or
12791279
* an array of encoded page pointers.

0 commit comments

Comments
 (0)