leandrof/linux
1
0
Fork 0
forked from Minki/linux
Code Issues Pull Requests Packages Projects Releases Wiki Activity

lib/genalloc: add parameter description to fix doc compile warning

Browse Source 
Commit 52fbf1134d ("lib/genalloc.c: fix allocation of aligned buffer
from non-aligned chunk") added a new parameter 'start_addr' w/o
description for it. That causes some doc compile warning:

  lib/genalloc.c:649: warning: Function parameter or member 'start_addr' not described in 'gen_pool_first_fit'
  lib/genalloc.c:667: warning: Function parameter or member 'start_addr' not described in 'gen_pool_first_fit_align'
  lib/genalloc.c:694: warning: Function parameter or member 'start_addr' not described in 'gen_pool_fixed_alloc'
  lib/genalloc.c:729: warning: Function parameter or member 'start_addr' not described in 'gen_pool_first_fit_order_align'
  lib/genalloc.c:752: warning: Function parameter or member 'start_addr' not described in 'gen_pool_best_fit'

This fixes it by adding a parameter descriptions.

Link: https://lkml.kernel.org/r/20210405132021.131231-1-alexs@kernel.org
Signed-off-by: Alex Shi <alexs@kernel.org>
Cc: Alexey Skidanov <alexey.skidanov@intel.com>
Cc: Huang Shijie <sjhuang@iluvatar.ai>
Cc: Alex Shi <alexs@kernel.org>
Cc: Bhaskar Chowdhury <unixbhaskar@gmail.com>
Cc: Stephen Rothwell <sfr@canb.auug.org.au>
Signed-off-by: Andrew Morton <akpm@linux-foundation.org>
Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>
This commit is contained in:
Alex Shi 2021-05-06 18:03:46 -07:00 committed by Linus Torvalds
parent db65a867fd
commit 9d6ecac093
1 changed files with 5 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
lib/genalloc.c
View File

@ -642,6 +642,7 @@ EXPORT_SYMBOL(gen_pool_set_algo);
* @nr: The number of zeroed bits we're looking for * @nr: The number of zeroed bits we're looking for
* @data: additional data - unused * @data: additional data - unused
* @pool: pool to find the fit region memory from * @pool: pool to find the fit region memory from
* @start_addr: not used in this function
*/ */
unsigned long gen_pool_first_fit(unsigned long *map, unsigned long size, unsigned long gen_pool_first_fit(unsigned long *map, unsigned long size,
unsigned long start, unsigned int nr, void *data, unsigned long start, unsigned int nr, void *data,
@ -660,6 +661,7 @@ EXPORT_SYMBOL(gen_pool_first_fit);
* @nr: The number of zeroed bits we're looking for * @nr: The number of zeroed bits we're looking for
* @data: data for alignment * @data: data for alignment
* @pool: pool to get order from * @pool: pool to get order from
* @start_addr: start addr of alloction chunk
*/ */
unsigned long gen_pool_first_fit_align(unsigned long *map, unsigned long size, unsigned long gen_pool_first_fit_align(unsigned long *map, unsigned long size,
unsigned long start, unsigned int nr, void *data, unsigned long start, unsigned int nr, void *data,
@ -687,6 +689,7 @@ EXPORT_SYMBOL(gen_pool_first_fit_align);
* @nr: The number of zeroed bits we're looking for * @nr: The number of zeroed bits we're looking for
* @data: data for alignment * @data: data for alignment
* @pool: pool to get order from * @pool: pool to get order from
* @start_addr: not used in this function
*/ */
unsigned long gen_pool_fixed_alloc(unsigned long *map, unsigned long size, unsigned long gen_pool_fixed_alloc(unsigned long *map, unsigned long size,
unsigned long start, unsigned int nr, void *data, unsigned long start, unsigned int nr, void *data,
@ -721,6 +724,7 @@ EXPORT_SYMBOL(gen_pool_fixed_alloc);
* @nr: The number of zeroed bits we're looking for * @nr: The number of zeroed bits we're looking for
* @data: additional data - unused * @data: additional data - unused
* @pool: pool to find the fit region memory from * @pool: pool to find the fit region memory from
* @start_addr: not used in this function
*/ */
unsigned long gen_pool_first_fit_order_align(unsigned long *map, unsigned long gen_pool_first_fit_order_align(unsigned long *map,
unsigned long size, unsigned long start, unsigned long size, unsigned long start,
@ -742,6 +746,7 @@ EXPORT_SYMBOL(gen_pool_first_fit_order_align);
* @nr: The number of zeroed bits we're looking for * @nr: The number of zeroed bits we're looking for
* @data: additional data - unused * @data: additional data - unused
* @pool: pool to find the fit region memory from * @pool: pool to find the fit region memory from
* @start_addr: not used in this function
* *
* Iterate over the bitmap to find the smallest free region * Iterate over the bitmap to find the smallest free region
* which we can allocate the memory. * which we can allocate the memory.