Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

genalloc: Fix a set of docs build warnings

Commit 795ee30648c7 ("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: 795ee30648c7 ("lib/genalloc: introduce chunk owners")
Acked-by: Dan Williams <dan.j.williams@intel.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>

+5 -5
+4 -4
Documentation/core-api/genalloc.rst
··· 53 53 :functions: gen_pool_add 54 54 55 55 .. kernel-doc:: lib/genalloc.c 56 - :functions: gen_pool_add_virt 56 + :functions: gen_pool_add_owner 57 57 58 58 A call to :c:func:`gen_pool_add` will place the size bytes of memory 59 59 starting at addr (in the kernel's virtual address space) into the given ··· 65 65 The functions for allocating memory from the pool (and putting it back) 66 66 are: 67 67 68 - .. kernel-doc:: lib/genalloc.c 68 + .. kernel-doc:: include/linux/genalloc.h 69 69 :functions: gen_pool_alloc 70 70 71 71 .. kernel-doc:: lib/genalloc.c 72 72 :functions: gen_pool_dma_alloc 73 73 74 74 .. kernel-doc:: lib/genalloc.c 75 - :functions: gen_pool_free 75 + :functions: gen_pool_free_owner 76 76 77 77 As one would expect, :c:func:`gen_pool_alloc` will allocate size< bytes 78 78 from the given pool. The :c:func:`gen_pool_dma_alloc` variant allocates ··· 89 89 of interest: 90 90 91 91 .. kernel-doc:: lib/genalloc.c 92 - :functions: gen_pool_alloc_algo 92 + :functions: gen_pool_alloc_algo_owner 93 93 94 94 .. kernel-doc:: lib/genalloc.c 95 95 :functions: gen_pool_set_algo
+1 -1
lib/genalloc.c
··· 472 472 EXPORT_SYMBOL(gen_pool_dma_zalloc_align); 473 473 474 474 /** 475 - * gen_pool_free - free allocated special memory back to the pool 475 + * gen_pool_free_owner - free allocated special memory back to the pool 476 476 * @pool: pool to free to 477 477 * @addr: starting address of memory to free back to pool 478 478 * @size: size in bytes of memory to free