Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 78179556 authored by Mike Rapoport's avatar Mike Rapoport Committed by Linus Torvalds
Browse files

mm/gup.c: fix follow_page_mask() kerneldoc comment 

Commit df06b37f ("mm/gup: cache dev_pagemap while pinning pages")
modified the signature of follow_page_mask() but left the parameter
description behind.

Update the description to make the code and comments agree again.

While at it, update formatting of the return value description to match
Documentation/doc-guide/kernel-doc.rst guidelines.

Link: http://lkml.kernel.org/r/1541603316-27832-1-git-send-email-rppt@linux.ibm.com


Signed-off-by: default avatarMike Rapoport <rppt@linux.ibm.com>
Reviewed-by: default avatarAndrew Morton <akpm@linux-foundation.org>
Signed-off-by: default avatarAndrew Morton <akpm@linux-foundation.org>
Signed-off-by: default avatarLinus Torvalds <torvalds@linux-foundation.org>
parent 5040f8df

mm/gup.c

+8 −2
Original line number Diff line number Diff line
@@ -385,11 +385,17 @@ static struct page *follow_p4d_mask(struct vm_area_struct *vma, 
 * @vma: vm_area_struct mapping @address

 * @address: virtual address to look up

 * @flags: flags modifying lookup behaviour

 * @page_mask: on output, *page_mask is set according to the size of the page

 * @ctx: contains dev_pagemap for %ZONE_DEVICE memory pinning and a

 *       pointer to output page_mask

 *

 * @flags can have FOLL_ flags set, defined in <linux/mm.h>

 *

 * Returns the mapped (struct page *), %NULL if no mapping exists, or

 * When getting pages from ZONE_DEVICE memory, the @ctx->pgmap caches

 * the device's dev_pagemap metadata to avoid repeating expensive lookups.

 *

 * On output, the @ctx->page_mask is set according to the size of the page.

 *

 * Return: the mapped (struct page *), %NULL if no mapping exists, or

 * an error pointer if there is a mapping to something not represented

 * by a page descriptor (see also vm_normal_page()).

 */