diff mbox series

genalloc: Fix a set of docs build warnings

Message ID 20191003124820.57a0fca8@lwn.net
State Accepted
Commit ea83df73aaa3bded80e441d05ca2873c37f84e0a
Headers show
Series genalloc: Fix a set of docs build warnings | expand

Commit Message

Jonathan Corbet Oct. 3, 2019, 6:48 p.m. UTC 
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")
Signed-off-by: Jonathan Corbet <corbet@lwn.net>

---
 Documentation/core-api/genalloc.rst | 8 ++++----
 lib/genalloc.c                      | 2 +-
 2 files changed, 5 insertions(+), 5 deletions(-)

-- 
2.21.0

Comments

Dan Williams Oct. 5, 2019, 10:12 a.m. UTC | #1 
On Thu, Oct 3, 2019 at 11:48 AM Jonathan Corbet <corbet@lwn.net> wrote:
>

> 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")

> Signed-off-by: Jonathan Corbet <corbet@lwn.net>


Thanks Jon. Apologies for the lack of due diligence on my part.
Changes look good to me.

Acked-by: Dan Williams <dan.j.williams@intel.com>
diff mbox series

Patch

diff --git a/Documentation/core-api/genalloc.rst b/Documentation/core-api/genalloc.rst
index 6b38a39fab24..2db2f79eb229 100644
--- a/Documentation/core-api/genalloc.rst
+++ b/Documentation/core-api/genalloc.rst
@@ -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
diff --git a/lib/genalloc.c b/lib/genalloc.c
index 9fc31292cfa1..24d20ca7e91b 100644
--- a/lib/genalloc.c
+++ b/lib/genalloc.c
@@ -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