The patch titled
Subject: lib/genalloc: fix a set of docs build warnings
has been added to the -mm tree. Its filename is
genalloc-fix-a-set-of-docs-build-warnings.patch
This patch should soon appear at
http://ozlabs.org/~akpm/mmots/broken-out/genalloc-fix-a-set-of-docs-build-warnings.patch
and later at
http://ozlabs.org/~akpm/mmotm/broken-out/genalloc-fix-a-set-of-docs-build-warnings.patch
Before you just go and hit "reply", please:
a) Consider who else should be cc'ed
b) Prefer to cc a suitable mailing list as well
c) Ideally: find the original patch on the mailing list and do a
reply-to-all to that, adding suitable additional cc's
*** Remember to use Documentation/process/submit-checklist.rst when testing your code ***
The -mm tree is included into linux-next and is updated
there every 3-4 working days
------------------------------------------------------
From: Jonathan Corbet <corbet@xxxxxxx>
Subject: lib/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.
Link: http://lkml.kernel.org/r/20191003124820.57a0fca8@xxxxxxx
Fixes: 795ee30648c7 ("lib/genalloc: introduce chunk owners")
Signed-off-by: Jonathan Corbet <corbet@xxxxxxx>
Acked-by: Dan Williams <dan.j.williams@xxxxxxxxx>
Signed-off-by: Andrew Morton <akpm@xxxxxxxxxxxxxxxxxxxx>
---
Documentation/core-api/genalloc.rst | 8 ++++----
lib/genalloc.c | 2 +-
2 files changed, 5 insertions(+), 5 deletions(-)
--- a/Documentation/core-api/genalloc.rst~genalloc-fix-a-set-of-docs-build-warnings
+++ a/Documentation/core-api/genalloc.rst
@@ -53,7 +53,7 @@ to the pool. That can be done with one
: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 need
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
--- a/lib/genalloc.c~genalloc-fix-a-set-of-docs-build-warnings
+++ a/lib/genalloc.c
@@ -472,7 +472,7 @@ void *gen_pool_dma_zalloc_align(struct g
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
_
Patches currently in -mm which might be from corbet@xxxxxxx are
genalloc-fix-a-set-of-docs-build-warnings.patch
