include/linux/mm: fix release_pages_arg kernel doc comment
Subsystems (3)
PATCH 1/1 include/linux/mm: fix release_pages_arg kernel doc comment
Commit 449c796768c9 ("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.
--- include/linux/mm.h | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-)
include/linux/mm.h +3 -3
@@ -1297,10 +1297,10 @@ static inline void folio_put_refs(struct folio *folio, int refs)__folio_put (folio); } -/** -* release_pages - release an array of pages or folios +/* +* union release_pages_arg - an array of pages or folios * -* This just releases a simple array of multiple pages, and +* release_pages() releases a simple array of multiple pages, and * accepts various different forms of said page array: either * a regular old boring array of pages, an array of folios, or * an array of encoded page pointers.
Signature · 1 line
2.25.1
Quoted 13 lines · SeongJae Park
Commit
449c796768c9("mm: teachrelease_pages()to take an array of encoded page pointers too") added the kernel doc comment forrelease_pages()on top of 'unionrelease_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 indeedrelease_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.
Quoted 7 lines
./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.
Fixes 449c796768c9 ("mm: teach release_pages() to take an array of encoded page pointers too")Signed-off-by SeongJae Park <[email protected]>
Thanks.
Quoted 22 lines
--- include/linux/mm.h | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-)include/linux/mm.h +3
-3@@ -1297,10 +1297,10 @@ static inline void folio_put_refs(struct folio *folio, int refs)__folio_put (folio); } -/** -* release_pages - release an array of pages or folios +/* +* union release_pages_arg - an array of pages or folios * -* This just releases a simple array of multiple pages, and +* release_pages() releases a simple array of multiple pages, and * accepts various different forms of said page array: either * a regular old boring array of pages, an array of folios, or * an array of encoded page pointers.
Signature · 1 line
~Randy