Commit 136dfc99 authored by Matthew Wilcox (Oracle)'s avatar Matthew Wilcox (Oracle) Committed by Linus Torvalds
Browse files

mm/doc: fix page_maybe_dma_pinned kerneldoc 

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.

Link: https://lkml.kernel.org/r/20210322195022.2143603-2-willy@infradead.org


Signed-off-by: default avatarMatthew Wilcox (Oracle) <willy@infradead.org>
Acked-by: default avatarMike Rapoport <rppt@linux.ibm.com>
Reviewed-by: default avatarJohn Hubbard <jhubbard@nvidia.com>
Cc: Jonathan Corbet <corbet@lwn.net>
Signed-off-by: default avatarAndrew Morton <akpm@linux-foundation.org>
Signed-off-by: default avatarLinus Torvalds <torvalds@linux-foundation.org>
parent 78f4841e

include/linux/mm.h

+5 −5
Original line number Diff line number Diff line
@@ -1271,10 +1271,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
@@ -1292,8 +1293,7 @@ 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".

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