Commit ea83df73 authored by Jonathan Corbet's avatar Jonathan Corbet
Browse files

genalloc: Fix a set of docs build warnings 



Commit 795ee306 ("lib/genalloc: introduce chunk owners") made a number
of changes to the genalloc API and implementation but did not update the
documentation to match, leading to these docs build warnings:

  ./lib/genalloc.c:1: warning: 'gen_pool_add_virt' not found
  ./lib/genalloc.c:1: warning: 'gen_pool_alloc' not found
  ./lib/genalloc.c:1: warning: 'gen_pool_free' not found
  ./lib/genalloc.c:1: warning: 'gen_pool_alloc_algo' not found

Fix these by updating the docs to match new function locations and names,
and by completing the update of one kerneldoc comment.

Fixes: 795ee306 ("lib/genalloc: introduce chunk owners")
Acked-by: default avatarDan Williams <dan.j.williams@intel.com>
Signed-off-by: default avatarJonathan Corbet <corbet@lwn.net>
parent cc84ac35

Documentation/core-api/genalloc.rst

+4 −4
Original line number Diff line number Diff line
@@ -53,7 +53,7 @@ to the pool. That can be done with one of: 
   :functions: gen_pool_add



.. kernel-doc:: lib/genalloc.c

   :functions: gen_pool_add_virt

   :functions: gen_pool_add_owner



A call to :c:func:`gen_pool_add` will place the size bytes of memory

starting at addr (in the kernel's virtual address space) into the given
@@ -65,14 +65,14 @@ for DMA allocations. 
The functions for allocating memory from the pool (and putting it back)

are:



.. kernel-doc:: lib/genalloc.c

.. kernel-doc:: include/linux/genalloc.h

   :functions: gen_pool_alloc



.. kernel-doc:: lib/genalloc.c

   :functions: gen_pool_dma_alloc



.. kernel-doc:: lib/genalloc.c

   :functions: gen_pool_free

   :functions: gen_pool_free_owner



As one would expect, :c:func:`gen_pool_alloc` will allocate size< bytes

from the given pool.  The :c:func:`gen_pool_dma_alloc` variant allocates
@@ -89,7 +89,7 @@ return. If that sort of control is needed, the following functions will be 
of interest:



.. kernel-doc:: lib/genalloc.c

   :functions: gen_pool_alloc_algo

   :functions: gen_pool_alloc_algo_owner



.. kernel-doc:: lib/genalloc.c

   :functions: gen_pool_set_algo

lib/genalloc.c

+1 −1
Original line number Diff line number Diff line
@@ -472,7 +472,7 @@ void *gen_pool_dma_zalloc_align(struct gen_pool *pool, size_t size, 
EXPORT_SYMBOL(gen_pool_dma_zalloc_align);



/**

 * gen_pool_free - free allocated special memory back to the pool

 * gen_pool_free_owner - free allocated special memory back to the pool

 * @pool: pool to free to

 * @addr: starting address of memory to free back to pool

 * @size: size in bytes of memory to free

CRA Git | Maintained and supported by SUSTech CRA and CCSE