mm/highmem: Fix kernel-doc warnings in highmem*.h
PATCH 1/1 mm/highmem: Fix kernel-doc warnings in highmem*.h
scripts/kernel-doc -none include/linux/highmem* reports the following warnings:
include/linux/highmem.h:160: warning: expecting prototype for kunmap_atomic(). Prototype was for nr_free_highpages() instead include/linux/highmem-internal.h:256: warning: Function parameter or member '__addr' not described in 'kunmap_atomic' include/linux/highmem-internal.h:256: warning: Excess function parameter 'addr' description in 'kunmap_atomic'
Fix these warnings by (1) move the kernel-doc comments from highmem.h to highmem-internal.h (which is the file were the kunmap_atomic() macro is actually defined), merge it with the comment which already was in highmem-internal.h, and (3) replace "@addr" with "@__addr".
--- include/linux/highmem-internal.h | 14 +++++++++++--- include/linux/highmem.h | 13 +------------ 2 files changed, 12 insertions(+), 15 deletions(-)
include/linux/highmem-internal.h +11 -3
@@ -236,9 +236,17 @@ static inline unsigned long totalhigh_pages(void) { return 0UL; }#endif /* CONFIG_HIGHMEM */ -/* -* Prevent people trying to call kunmap_atomic() as if it were kunmap() -* kunmap_atomic() should get the return value of kmap_atomic, not the page. +/** +* kunmap_atomic - Unmap the virtual address mapped by kmap_atomic() +* @__addr: Virtual address to be unmapped +* +* Counterpart to kmap_atomic(). +* +* Effectively a wrapper around kunmap_local() which additionally undoes +* the side effects of kmap_atomic(), i.e. reenabling pagefaults and +* preemption. Prevent people trying to call kunmap_atomic() as if it +* were kunmap() because kunmap_atomic() should get the return value of +* kmap_atomic(), not its argument which is a pointer to struct page. */ #define kunmap_atomic (__addr) \ do { \
include/linux/highmem.h +1 -12
@@ -37,7 +37,7 @@ static inline void *kmap(struct page *page);/** * kunmap - Unmap the virtual address mapped by kmap() -* @addr: Virtual address to be unmapped +* @page: Virtual address to be unmapped * * Counterpart to kmap(). A NOOP for CONFIG_HIGHMEM=n and for mappings of * pages in the low memory area.
@@ -145,17 +145,6 @@ static inline void *kmap_local_folio(struct folio *folio, size_t offset);*/ static inline void *kmap_atomic (struct page *page); -/** -* kunmap_atomic - Unmap the virtual address mapped by kmap_atomic() -* @addr: Virtual address to be unmapped -* -* Counterpart to kmap_atomic(). -* -* Effectively a wrapper around kunmap_local() which additionally undoes -* the side effects of kmap_atomic(), i.e. reenabling pagefaults and -* preemption. -*/ -/* Highmem related interfaces for management code */ static inline unsigned int nr_free_highpages (void );static inline unsigned long totalhigh_pages (void );
Signature · 1 line
2.34.1
Hi,
Quoted 10 lines · Fabio M. De Francesco
scripts/kernel-doc -none include/linux/highmem*reports the following warnings:
include/linux/highmem.h:160: warning: expecting prototype forkunmap_atomic(). Prototype was fornr_free_highpages()insteadinclude/linux/highmem-internal.h:256: warning: Function parameter or member '__addr' not described in 'kunmap_atomic'include/linux/highmem-internal.h:256: warning: Excess function parameter 'addr' description in 'kunmap_atomic'Fix these warnings by (1) move the kernel-doc comments from
highmem.htohighmem-internal.h(which is the file were thekunmap_atomic()macro is actually defined), merge it with the comment which already was in
^ (2) ?
Quoted 1 line
highmem-internal.h, and (3) replace "@addr" with "@__addr".
There is also replacement of "addr" with "page", so I'd phrase (3) as "use correct parameter names"
Quoted 1 line
Signed-off-by Fabio M. De Francesco <[email protected]>
Other than that
Quoted 65 lines
--- include/linux/highmem-internal.h | 14 +++++++++++--- include/linux/highmem.h | 13 +------------ 2 files changed, 12 insertions(+), 15 deletions(-)include/linux/highmem-internal.h +11
-3@@ -236,9 +236,17 @@ static inline unsigned long totalhigh_pages(void) { return 0UL; }#endif /* CONFIG_HIGHMEM */ -/* -* Prevent people trying to call kunmap_atomic() as if it were kunmap() -* kunmap_atomic() should get the return value of kmap_atomic, not the page. +/** +* kunmap_atomic - Unmap the virtual address mapped by kmap_atomic() +* @__addr: Virtual address to be unmapped +* +* Counterpart to kmap_atomic(). +* +* Effectively a wrapper around kunmap_local() which additionally undoes +* the side effects of kmap_atomic(), i.e. reenabling pagefaults and +* preemption. Prevent people trying to call kunmap_atomic() as if it +* were kunmap() because kunmap_atomic() should get the return value of +* kmap_atomic(), not its argument which is a pointer to struct page. */ #define kunmap_atomic (__addr) \ do { \include/linux/highmem.h +1
-12@@ -37,7 +37,7 @@ static inline void *kmap(struct page *page);/** * kunmap - Unmap the virtual address mapped by kmap() -* @addr: Virtual address to be unmapped +* @page: Virtual address to be unmapped * * Counterpart to kmap(). A NOOP for CONFIG_HIGHMEM=n and for mappings of * pages in the low memory area. @@ -145,17 +145,6 @@ static inline void *kmap_local_folio(struct folio *folio, size_t offset);*/ static inline void *kmap_atomic (struct page *page); -/** -* kunmap_atomic - Unmap the virtual address mapped by kmap_atomic() -* @addr: Virtual address to be unmapped -* -* Counterpart to kmap_atomic(). -* -* Effectively a wrapper around kunmap_local() which additionally undoes -* the side effects of kmap_atomic(), i.e. reenabling pagefaults and -* preemption. -*/ -/* Highmem related interfaces for management code */ static inline unsigned int nr_free_highpages (void );static inline unsigned long totalhigh_pages (void );Signature · 1 line
2.34.1
Signature · 2 lines
Sincerely yours, Mike.
Quoted 7 lines · On lunedì 18 aprile 2022 16:43:05 CEST Mike Rapoport wrote:
Hi,
Quoted 4 lines · Fabio M. De Francesco
scripts/kernel-doc -none include/linux/highmem*reports the following warnings:
include/linux/highmem.h:160: warning: expecting prototype for
kunmap_atomic(). Prototype was for nr_free_highpages() instead
Quoted 1 line
Quoted 1 line
include/linux/highmem-internal.h:256: warning: Function parameter or
member '__addr' not described in 'kunmap_atomic'
Quoted 1 line
Quoted 1 line
include/linux/highmem-internal.h:256: warning: Excess function
parameter 'addr' description in 'kunmap_atomic'
Quoted 2 lines
Quoted 2 lines
Fix these warnings by (1) move the kernel-doc comments from
highmem.h
to
Quoted 6 lines
Quoted 2 lines
highmem-internal.h(which is the file were thekunmap_atomic()macro is actually defined), merge it with the comment which already was in^ (2) ?Quoted 1 line
highmem-internal.h, and (3) replace "@addr" with "@__addr".
Hi Mike,
It looks like these days I'm a bit distracted...
I'm about to send a v2 patch.
Quoted 3 lines
There is also replacement of "addr" with "page", so I'd phrase (3) as "use correct parameter names"
Yes, correct, I missed this too :(
Quoted 6 lines
Quoted 2 lines
Signed-off-by Fabio M. De Francesco <[email protected]>Other than that
Acked-by Mike Rapoport <[email protected]>
Thanks for your "Acked-by:" tag.
Regards,
Fabio
Quoted 6 lines
Quoted 6 lines
--- include/linux/highmem-internal.h | 14 +++++++++++--- include/linux/highmem.h | 13 +------------ 2 files changed, 12 insertions(+), 15 deletions(-)[snip]