On Mon, Mar 22, 2021 at 07:50:20PM +0000, Matthew Wilcox (Oracle) wrote:
> make htmldocs reports:
>
> ./include/linux/mm.h:1341: warning: Excess function parameter 'Return' description in 'page_maybe_dma_pinned'
>
> Fix a few other formatting nits while I'm editing this description.
>
> Signed-off-by: Matthew Wilcox (Oracle) <willy@xxxxxxxxxxxxx>
Acked-by: Mike Rapoport <rppt@xxxxxxxxxxxxx>
> ---
> include/linux/mm.h | 10 +++++-----
> 1 file changed, 5 insertions(+), 5 deletions(-)
>
> diff --git a/include/linux/mm.h b/include/linux/mm.h
> index 9c149e945bf9..96e5ceffce09 100644
> --- a/include/linux/mm.h
> +++ b/include/linux/mm.h
> @@ -1273,10 +1273,11 @@ void unpin_user_page_range_dirty_lock(struct page *page, unsigned long npages,
> void unpin_user_pages(struct page **pages, unsigned long npages);
>
> /**
> - * page_maybe_dma_pinned() - report if a page is pinned for DMA.
> + * page_maybe_dma_pinned - Report if a page is pinned for DMA.
> + * @page: The page.
> *
> * This function checks if a page has been pinned via a call to
> - * pin_user_pages*().
> + * a function in the pin_user_pages() family.
> *
> * For non-huge pages, the return value is partially fuzzy: false is not fuzzy,
> * because it means "definitely not pinned for DMA", but true means "probably
> @@ -1294,9 +1295,8 @@ void unpin_user_pages(struct page **pages, unsigned long npages);
> *
> * For more information, please see Documentation/core-api/pin_user_pages.rst.
> *
> - * @page: pointer to page to be queried.
> - * @Return: True, if it is likely that the page has been "dma-pinned".
> - * False, if the page is definitely not dma-pinned.
> + * Return: True, if it is likely that the page has been "dma-pinned".
> + * False, if the page is definitely not dma-pinned.
> */
> static inline bool page_maybe_dma_pinned(struct page *page)
> {
> --
> 2.30.2
>
--
Sincerely yours,
Mike.
