All of lore.kernel.org
 help / color / mirror / Atom feed
From: John Hubbard <jhubbard@nvidia.com>
To: "Matthew Wilcox (Oracle)" <willy@infradead.org>,
	<linux-mm@kvack.org>, Andrew Morton <akpm@linux-foundation.org>
Cc: <linux-doc@vger.kernel.org>, Mike Rapoport <rppt@linux.ibm.com>
Subject: Re: [PATCH 2/4] mm/doc: Fix page_maybe_dma_pinned kerneldoc
Date: Tue, 23 Mar 2021 19:50:38 -0700	[thread overview]
Message-ID: <7c05f837-9703-001f-47d1-d07c0c700cd6@nvidia.com> (raw)
In-Reply-To: <20210322195022.2143603-2-willy@infradead.org>

On 3/22/21 12:50 PM, 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@infradead.org>
> ---
>   include/linux/mm.h | 10 +++++-----
>   1 file changed, 5 insertions(+), 5 deletions(-)

Looks nice, thanks for fixing this up.

There was a slight delay, during which I re-learned that Sphinx 3 still causes
a "nearly indefinite" delay in "make htmldocs". But eventually I got this to
build and verified that the output made it through intact. I guess I'm grateful
that Sphinx 3 works at all, though.

Reviewed-by: John Hubbard <jhubbard@nvidia.com>

thanks,
-- 
John Hubbard
NVIDIA

> 
> 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)
>   {
> 



  parent reply	other threads:[~2021-03-24  2:51 UTC|newest]

Thread overview: 9+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-03-22 19:50 [PATCH 1/4] mm/doc: Fix fault_flag_allow_retry_first kerneldoc Matthew Wilcox (Oracle)
2021-03-22 19:50 ` [PATCH 2/4] mm/doc: Fix page_maybe_dma_pinned kerneldoc Matthew Wilcox (Oracle)
2021-03-23  7:27   ` Mike Rapoport
2021-03-24  2:50   ` John Hubbard [this message]
2021-03-22 19:50 ` [PATCH 3/4] mm/doc: Turn fault flags into an enum Matthew Wilcox (Oracle)
2021-03-23  7:28   ` Mike Rapoport
2021-03-22 19:50 ` [PATCH 4/4] mm/doc: Add mm.h and mm_types.h to the mm-api document Matthew Wilcox (Oracle)
2021-03-23  7:28   ` Mike Rapoport
2021-03-23  7:27 ` [PATCH 1/4] mm/doc: Fix fault_flag_allow_retry_first kerneldoc Mike Rapoport

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=7c05f837-9703-001f-47d1-d07c0c700cd6@nvidia.com \
    --to=jhubbard@nvidia.com \
    --cc=akpm@linux-foundation.org \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-mm@kvack.org \
    --cc=rppt@linux.ibm.com \
    --cc=willy@infradead.org \
    --subject='Re: [PATCH 2/4] mm/doc: Fix page_maybe_dma_pinned kerneldoc' \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link

This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.