moonjuice/kernel_arpi
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

mm/doc: fix page_maybe_dma_pinned kerneldoc

Browse Source 
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: Matthew Wilcox (Oracle) <willy@infradead.org>
Acked-by: Mike Rapoport <rppt@linux.ibm.com>
Reviewed-by: John Hubbard <jhubbard@nvidia.com>
Cc: Jonathan Corbet <corbet@lwn.net>
Signed-off-by: Andrew Morton <akpm@linux-foundation.org>
Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>
This commit is contained in:
Matthew Wilcox (Oracle)
2021-04-29 22:59:28 -07:00
committed by Linus Torvalds
parent 78f4841e34
commit 136dfc9949
1 changed files with 5 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
include/linux/mm.h
View File

@@ -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); 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 * 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, * 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 * because it means "definitely not pinned for DMA", but true means "probably
@@ -1292,9 +1293,8 @@ void unpin_user_pages(struct page **pages, unsigned long npages);
* *
* For more information, please see Documentation/core-api/pin_user_pages.rst. * 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.
* False, if the page is definitely not dma-pinned.
*/ */
static inline bool page_maybe_dma_pinned(struct page *page) static inline bool page_maybe_dma_pinned(struct page *page)
{ {