[PATCH] mm: fix filemap.c pagecache_get_page() kernel-doc warnings

[PATCH] mm: fix filemap.c pagecache_get_page() kernel-doc warnings

[Randy Dunlap]

From: Randy Dunlap <rdunlap@infradead.org>

Fix kernel-doc warnings in mm/filemap.c: pagecache_get_page():

Warning(..//mm/filemap.c:1054): No description found for parameter 'cache_gfp_mask'
Warning(..//mm/filemap.c:1054): No description found for parameter 'radix_gfp_mask'
Warning(..//mm/filemap.c:1054): Excess function parameter 'gfp_mask' description in 'pagecache_get_page'

Fixes: 2457aec63745 "mm: non-atomically mark page accessed during
	page cache allocation where possible"

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Cc: Mel Gorman <mgorman@suse.de>
---
 mm/filemap.c |    7 ++++---
 1 file changed, 4 insertions(+), 3 deletions(-)

Index: lnx-316-rc7/mm/filemap.c
===================================================================
--- lnx-316-rc7.orig/mm/filemap.c
+++ lnx-316-rc7/mm/filemap.c
@@ -1031,16 +1031,17 @@ EXPORT_SYMBOL(find_lock_entry);
  * @mapping: the address_space to search
  * @offset: the page index
  * @fgp_flags: PCG flags
- * @gfp_mask: gfp mask to use if a page is to be allocated
+ * @cache_gfp_mask: gfp mask to use if a page is to be allocated
+ * @radix_gfp_mask: gfp mask to use for page cache LRU allocation
  *
  * Looks up the page cache slot at @mapping & @offset.
  *
- * PCG flags modify how the page is returned
+ * PCG flags modify how the page is returned.
  *
  * FGP_ACCESSED: the page will be marked accessed
  * FGP_LOCK: Page is return locked
  * FGP_CREAT: If page is not present then a new page is allocated using
- *		@gfp_mask and added to the page cache and the VM's LRU
+ *		@cache_gfp_mask and added to the page cache and the VM's LRU
  *		list. The page is returned locked and with an increased
  *		refcount. Otherwise, %NULL is returned.
  *

--
To unsubscribe, send a message with 'unsubscribe linux-mm' in
the body to majordomo@kvack.org.  For more info on Linux MM,
see: http://www.linux-mm.org/ .
Don't email: <a href=mailto:"dont@kvack.org"> email@kvack.org </a>

Re: [PATCH] mm: fix filemap.c pagecache_get_page() kernel-doc warnings

[Mel Gorman]

On Sun, Jul 27, 2014 at 01:45:33PM -0700, Randy Dunlap wrote:
> From: Randy Dunlap <rdunlap@infradead.org>
> 
> Fix kernel-doc warnings in mm/filemap.c: pagecache_get_page():
> 
> Warning(..//mm/filemap.c:1054): No description found for parameter 'cache_gfp_mask'
> Warning(..//mm/filemap.c:1054): No description found for parameter 'radix_gfp_mask'
> Warning(..//mm/filemap.c:1054): Excess function parameter 'gfp_mask' description in 'pagecache_get_page'
> 
> Fixes: 2457aec63745 "mm: non-atomically mark page accessed during
> 	page cache allocation where possible"
> 
> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
> Cc: Mel Gorman <mgorman@suse.de>

Use this diff instead?

---8<---
diff --git a/mm/filemap.c b/mm/filemap.c
index dafb06f..a1021fa 100644
--- a/mm/filemap.c
+++ b/mm/filemap.c
@@ -1031,18 +1031,21 @@ EXPORT_SYMBOL(find_lock_entry);
  * @mapping: the address_space to search
  * @offset: the page index
  * @fgp_flags: PCG flags
- * @gfp_mask: gfp mask to use if a page is to be allocated
+ * @cache_gfp_mask: gfp mask to use for the page cache data page allocation
+ * @radix_gfp_mask: gfp mask to use for radix tree node allocation
  *
  * Looks up the page cache slot at @mapping & @offset.
  *
- * PCG flags modify how the page is returned
+ * PCG flags modify how the page is returned.
  *
  * FGP_ACCESSED: the page will be marked accessed
  * FGP_LOCK: Page is return locked
  * FGP_CREAT: If page is not present then a new page is allocated using
- *		@gfp_mask and added to the page cache and the VM's LRU
- *		list. The page is returned locked and with an increased
- *		refcount. Otherwise, %NULL is returned.
+ *		@cache_gfp_mask and added to the page cache and the VM's LRU
+ *		list. If radix tree nodes are allocated during page cache
+ *		insertion then @radix_gfp_mask is used. The page is returned
+ * 		locked and with an increased refcount. Otherwise, %NULL is
+ * 		returned.
  *
  * If FGP_LOCK or FGP_CREAT are specified then the function may sleep even
  * if the GFP flags specified for FGP_CREAT are atomic.

-- 
Mel Gorman
SUSE Labs

--
To unsubscribe, send a message with 'unsubscribe linux-mm' in
the body to majordomo@kvack.org.  For more info on Linux MM,
see: http://www.linux-mm.org/ .
Don't email: <a href=mailto:"dont@kvack.org"> email@kvack.org </a>

Re: [PATCH] mm: fix filemap.c pagecache_get_page() kernel-doc warnings

[Randy Dunlap]

On 07/28/14 02:36, Mel Gorman wrote:
> On Sun, Jul 27, 2014 at 01:45:33PM -0700, Randy Dunlap wrote:
>> From: Randy Dunlap <rdunlap@infradead.org>
>>
>> Fix kernel-doc warnings in mm/filemap.c: pagecache_get_page():
>>
>> Warning(..//mm/filemap.c:1054): No description found for parameter 'cache_gfp_mask'
>> Warning(..//mm/filemap.c:1054): No description found for parameter 'radix_gfp_mask'
>> Warning(..//mm/filemap.c:1054): Excess function parameter 'gfp_mask' description in 'pagecache_get_page'
>>
>> Fixes: 2457aec63745 "mm: non-atomically mark page accessed during
>> 	page cache allocation where possible"
>>
>> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
>> Cc: Mel Gorman <mgorman@suse.de>
> 
> Use this diff instead?

Sure.  Acked-by: Randy Dunlap <rdunlap@infradead.org>

Thanks.

Andrew?

> 
> ---8<---
> diff --git a/mm/filemap.c b/mm/filemap.c
> index dafb06f..a1021fa 100644
> --- a/mm/filemap.c
> +++ b/mm/filemap.c
> @@ -1031,18 +1031,21 @@ EXPORT_SYMBOL(find_lock_entry);
>   * @mapping: the address_space to search
>   * @offset: the page index
>   * @fgp_flags: PCG flags
> - * @gfp_mask: gfp mask to use if a page is to be allocated
> + * @cache_gfp_mask: gfp mask to use for the page cache data page allocation
> + * @radix_gfp_mask: gfp mask to use for radix tree node allocation
>   *
>   * Looks up the page cache slot at @mapping & @offset.
>   *
> - * PCG flags modify how the page is returned
> + * PCG flags modify how the page is returned.
>   *
>   * FGP_ACCESSED: the page will be marked accessed
>   * FGP_LOCK: Page is return locked
>   * FGP_CREAT: If page is not present then a new page is allocated using
> - *		@gfp_mask and added to the page cache and the VM's LRU
> - *		list. The page is returned locked and with an increased
> - *		refcount. Otherwise, %NULL is returned.
> + *		@cache_gfp_mask and added to the page cache and the VM's LRU
> + *		list. If radix tree nodes are allocated during page cache
> + *		insertion then @radix_gfp_mask is used. The page is returned
> + * 		locked and with an increased refcount. Otherwise, %NULL is
> + * 		returned.
>   *
>   * If FGP_LOCK or FGP_CREAT are specified then the function may sleep even
>   * if the GFP flags specified for FGP_CREAT are atomic.
> 


-- 
~Randy

--
To unsubscribe, send a message with 'unsubscribe linux-mm' in
the body to majordomo@kvack.org.  For more info on Linux MM,
see: http://www.linux-mm.org/ .
Don't email: <a href=mailto:"dont@kvack.org"> email@kvack.org </a>