Hi,
These patches update formatting of function descriptions in
mm/slab_common.c and link the comments from this file to "The Slab Cache"
section of the MM API reference.
As the changes to mm/slab_common.c only touch the comments, I think these
patches can go via the docs tree.
Mike Rapoport (2):
slab: make kmem_cache_create{_usercopy} description proper kernel-doc
docs/mm-api: link slab_common.c to "The Slab Cache" section
Documentation/core-api/mm-api.rst | 3 +++
mm/slab_common.c | 35 +++++++++++++++++++++++++++++++----
2 files changed, 34 insertions(+), 4 deletions(-)
--
2.7.4
Several functions in mm/slab_common.c have kernel-doc comments, it makes
perfect sense to link them to the MM API reference.
Signed-off-by: Mike Rapoport <[email protected]>
---
Documentation/core-api/mm-api.rst | 3 +++
1 file changed, 3 insertions(+)
diff --git a/Documentation/core-api/mm-api.rst b/Documentation/core-api/mm-api.rst
index c81e754..aa8e54b8 100644
--- a/Documentation/core-api/mm-api.rst
+++ b/Documentation/core-api/mm-api.rst
@@ -46,6 +46,9 @@ The Slab Cache
.. kernel-doc:: mm/slab.c
:export:
+.. kernel-doc:: mm/slab_common.c
+ :export:
+
.. kernel-doc:: mm/util.c
:functions: kfree_const kvmalloc_node kvfree
--
2.7.4
Add the description for kmem_cache_create, fixup the return value paragraph
and make both kmem_cache_create and add the second '*' to the comment
opening.
Signed-off-by: Mike Rapoport <[email protected]>
---
mm/slab_common.c | 35 +++++++++++++++++++++++++++++++----
1 file changed, 31 insertions(+), 4 deletions(-)
diff --git a/mm/slab_common.c b/mm/slab_common.c
index 7eb8dc1..dbf63d6 100644
--- a/mm/slab_common.c
+++ b/mm/slab_common.c
@@ -406,8 +406,9 @@ static struct kmem_cache *create_cache(const char *name,
goto out;
}
-/*
- * kmem_cache_create_usercopy - Create a cache.
+/**
+ * kmem_cache_create_usercopy - Create a cache with a region suitable
+ * for copying to userspace
* @name: A string which is used in /proc/slabinfo to identify this cache.
* @size: The size of objects to be created in this cache.
* @align: The required alignment for the objects.
@@ -416,7 +417,6 @@ static struct kmem_cache *create_cache(const char *name,
* @usersize: Usercopy region size
* @ctor: A constructor for the objects.
*
- * Returns a ptr to the cache on success, NULL on failure.
* Cannot be called within a interrupt, but can be interrupted.
* The @ctor is run when new pages are allocated by the cache.
*
@@ -425,12 +425,14 @@ static struct kmem_cache *create_cache(const char *name,
* %SLAB_POISON - Poison the slab with a known test pattern (a5a5a5a5)
* to catch references to uninitialised memory.
*
- * %SLAB_RED_ZONE - Insert `Red' zones around the allocated memory to check
+ * %SLAB_RED_ZONE - Insert `Red` zones around the allocated memory to check
* for buffer overruns.
*
* %SLAB_HWCACHE_ALIGN - Align the objects in this cache to a hardware
* cacheline. This can be beneficial if you're counting cycles as closely
* as davem.
+ *
+ * Return: a pointer to the cache on success, NULL on failure.
*/
struct kmem_cache *
kmem_cache_create_usercopy(const char *name,
@@ -514,6 +516,31 @@ kmem_cache_create_usercopy(const char *name,
}
EXPORT_SYMBOL(kmem_cache_create_usercopy);
+/**
+ * kmem_cache_create - Create a cache.
+ * @name: A string which is used in /proc/slabinfo to identify this cache.
+ * @size: The size of objects to be created in this cache.
+ * @align: The required alignment for the objects.
+ * @flags: SLAB flags
+ * @ctor: A constructor for the objects.
+ *
+ * Cannot be called within a interrupt, but can be interrupted.
+ * The @ctor is run when new pages are allocated by the cache.
+ *
+ * The flags are
+ *
+ * %SLAB_POISON - Poison the slab with a known test pattern (a5a5a5a5)
+ * to catch references to uninitialised memory.
+ *
+ * %SLAB_RED_ZONE - Insert `Red` zones around the allocated memory to check
+ * for buffer overruns.
+ *
+ * %SLAB_HWCACHE_ALIGN - Align the objects in this cache to a hardware
+ * cacheline. This can be beneficial if you're counting cycles as closely
+ * as davem.
+ *
+ * Return: a pointer to the cache on success, NULL on failure.
+ */
struct kmem_cache *
kmem_cache_create(const char *name, unsigned int size, unsigned int align,
slab_flags_t flags, void (*ctor)(void *))
--
2.7.4
On Thu, 6 Dec 2018, Mike Rapoport wrote:
> Add the description for kmem_cache_create, fixup the return value paragraph
> and make both kmem_cache_create and add the second '*' to the comment
> opening.
>
> Signed-off-by: Mike Rapoport <[email protected]>
Acked-by: David Rientjes <[email protected]>
On Thu, 6 Dec 2018, Mike Rapoport wrote:
> Several functions in mm/slab_common.c have kernel-doc comments, it makes
> perfect sense to link them to the MM API reference.
>
> Signed-off-by: Mike Rapoport <[email protected]>
Acked-by: David Rientjes <[email protected]>
ping?
On Thu, Dec 06, 2018 at 11:12:59PM +0200, Mike Rapoport wrote:
> Hi,
>
> These patches update formatting of function descriptions in
> mm/slab_common.c and link the comments from this file to "The Slab Cache"
> section of the MM API reference.
>
> As the changes to mm/slab_common.c only touch the comments, I think these
> patches can go via the docs tree.
>
> Mike Rapoport (2):
> slab: make kmem_cache_create{_usercopy} description proper kernel-doc
> docs/mm-api: link slab_common.c to "The Slab Cache" section
>
> Documentation/core-api/mm-api.rst | 3 +++
> mm/slab_common.c | 35 +++++++++++++++++++++++++++++++----
> 2 files changed, 34 insertions(+), 4 deletions(-)
>
> --
> 2.7.4
>
--
Sincerely yours,
Mike.
On Thu, 20 Dec 2018 09:59:13 +0200
Mike Rapoport <[email protected]> wrote:
> ping?
Sorry, been traveling, and I still don't really know what to do with
patches that are more mm/ than Documentation/. I've just applied these,
though.
Thanks,
jon
On December 20, 2018 5:34:23 PM GMT+02:00, Jonathan Corbet <[email protected]> wrote:
>On Thu, 20 Dec 2018 09:59:13 +0200
>Mike Rapoport <[email protected]> wrote:
>
>> ping?
>
>Sorry, been traveling,
No problem, I just wanted to make sure it didn't fall between the cracks.
> and I still don't really know what to do with
>patches that are more mm/ than Documentation/.
Well, these seem to be quite documentation, although they touch mm files ;-)
> I've just applied these, though.
Thanks!
>Thanks,
>
>jon
--
Sent from my Android device with K-9 Mail. Please excuse my brevity.