* [PATCH] mm/highmem: Fix kernel-doc warnings in highmem*.h
@ 2022-04-18 7:53 Fabio M. De Francesco
2022-04-18 14:43 ` Mike Rapoport
0 siblings, 1 reply; 3+ messages in thread
From: Fabio M. De Francesco @ 2022-04-18 7:53 UTC (permalink / raw)
To: Ira Weiny, Andrew Morton, Catalin Marinas,
Matthew Wilcox (Oracle),
Will Deacon, Peter Collingbourne, Vlastimil Babka,
Sebastian Andrzej Siewior, linux-kernel, outreachy
Cc: 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
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".
Signed-off-by: Fabio M. De Francesco <fmdefrancesco@gmail.com>
---
include/linux/highmem-internal.h | 14 +++++++++++---
include/linux/highmem.h | 13 +------------
2 files changed, 12 insertions(+), 15 deletions(-)
diff --git a/include/linux/highmem-internal.h b/include/linux/highmem-internal.h
index a77be5630209..7307de391288 100644
--- a/include/linux/highmem-internal.h
+++ b/include/linux/highmem-internal.h
@@ -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 { \
diff --git a/include/linux/highmem.h b/include/linux/highmem.h
index 39bb9b47fa9c..0a7a89721e5d 100644
--- a/include/linux/highmem.h
+++ b/include/linux/highmem.h
@@ -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);
--
2.34.1
^ permalink raw reply related [flat|nested] 3+ messages in thread
* Re: [PATCH] mm/highmem: Fix kernel-doc warnings in highmem*.h
2022-04-18 7:53 [PATCH] mm/highmem: Fix kernel-doc warnings in highmem*.h Fabio M. De Francesco
@ 2022-04-18 14:43 ` Mike Rapoport
2022-04-18 17:22 ` Fabio M. De Francesco
0 siblings, 1 reply; 3+ messages in thread
From: Mike Rapoport @ 2022-04-18 14:43 UTC (permalink / raw)
To: Fabio M. De Francesco
Cc: Ira Weiny, Andrew Morton, Catalin Marinas,
Matthew Wilcox (Oracle),
Will Deacon, Peter Collingbourne, Vlastimil Babka,
Sebastian Andrzej Siewior, linux-kernel, outreachy
Hi,
On Mon, Apr 18, 2022 at 09:53:04AM +0200, Fabio M. De Francesco wrote:
> `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
^ (2) ?
> 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"
> Signed-off-by: Fabio M. De Francesco <fmdefrancesco@gmail.com>
Other than that
Acked-by: Mike Rapoport <rppt@linux.ibm.com>
> ---
> include/linux/highmem-internal.h | 14 +++++++++++---
> include/linux/highmem.h | 13 +------------
> 2 files changed, 12 insertions(+), 15 deletions(-)
>
> diff --git a/include/linux/highmem-internal.h b/include/linux/highmem-internal.h
> index a77be5630209..7307de391288 100644
> --- a/include/linux/highmem-internal.h
> +++ b/include/linux/highmem-internal.h
> @@ -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 { \
> diff --git a/include/linux/highmem.h b/include/linux/highmem.h
> index 39bb9b47fa9c..0a7a89721e5d 100644
> --- a/include/linux/highmem.h
> +++ b/include/linux/highmem.h
> @@ -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);
> --
> 2.34.1
>
>
--
Sincerely yours,
Mike.
^ permalink raw reply [flat|nested] 3+ messages in thread
* Re: [PATCH] mm/highmem: Fix kernel-doc warnings in highmem*.h
2022-04-18 14:43 ` Mike Rapoport
@ 2022-04-18 17:22 ` Fabio M. De Francesco
0 siblings, 0 replies; 3+ messages in thread
From: Fabio M. De Francesco @ 2022-04-18 17:22 UTC (permalink / raw)
To: Mike Rapoport
Cc: Ira Weiny, Andrew Morton, Catalin Marinas,
Matthew Wilcox (Oracle),
Will Deacon, Peter Collingbourne, Vlastimil Babka,
Sebastian Andrzej Siewior, linux-kernel, outreachy
On lunedì 18 aprile 2022 16:43:05 CEST Mike Rapoport wrote:
> Hi,
>
> On Mon, Apr 18, 2022 at 09:53:04AM +0200, Fabio M. De Francesco wrote:
> > `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
>
> ^ (2) ?
>
> > 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.
>
> There is also replacement of "addr" with "page", so I'd phrase (3) as
> "use correct parameter names"
Yes, correct, I missed this too :(
>
> > Signed-off-by: Fabio M. De Francesco <fmdefrancesco@gmail.com>
>
> Other than that
>
> Acked-by: Mike Rapoport <rppt@linux.ibm.com>
Thanks for your "Acked-by:" tag.
Regards,
Fabio
> > ---
> > include/linux/highmem-internal.h | 14 +++++++++++---
> > include/linux/highmem.h | 13 +------------
> > 2 files changed, 12 insertions(+), 15 deletions(-)
> >
> > [snip]
^ permalink raw reply [flat|nested] 3+ messages in thread
end of thread, other threads:[~2022-04-18 17:22 UTC | newest]
Thread overview: 3+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2022-04-18 7:53 [PATCH] mm/highmem: Fix kernel-doc warnings in highmem*.h Fabio M. De Francesco
2022-04-18 14:43 ` Mike Rapoport
2022-04-18 17:22 ` Fabio M. De Francesco
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).