mm/slab_common: repair kernel-doc for __ksize()
Subsystems (3)
PATCH 1/1 mm/slab_common: repair kernel-doc for __ksize()
Commit 445d41d7a7c1 ("Merge branch 'slab/for-6.1/kmalloc_size_roundup' into slab/for-next") resolved a conflict of two concurrent changes to __ksize().
However, it did not adjust the kernel-doc comment of __ksize(), while the name of the argument to __ksize() was renamed.
Hence, ./scripts/ kernel-doc -none mm/slab_common.c warns about it.
Adjust the kernel-doc comment for __ksize() for make W=1 happiness.
--- mm/slab_common.c | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-)
mm/slab_common.c +2 -2
@@ -1010,7 +1010,7 @@ EXPORT_SYMBOL(kfree);/** * __ksize -- Report full size of underlying allocation -* @objp: pointer to the object +* @object: pointer to the object * * This should only be used internally to query the true size of allocations. * It is not meant to be a way to discover the usable size of an allocation
@@ -1018,7 +1018,7 @@ EXPORT_SYMBOL(kfree);* the originally requested allocation size may trigger KASAN, UBSAN_BOUNDS, * and/or FORTIFY_SOURCE. * -* Return: size of the actual memory used by @objp in bytes +* Return: size of the actual memory used by @object in bytes */ size_t __ksize (const void *object) {
Signature · 1 line
2.17.1
Quoted 39 lines · Lukas Bulwahn
Commit
445d41d7a7c1("Merge branch 'slab/for-6.1/kmalloc_size_roundup' into slab/for-next") resolved a conflict of two concurrent changes to__ksize().However, it did not adjust the kernel-doc comment of
__ksize(), while the name of the argument to__ksize()was renamed.Hence,
./scripts/kernel-doc -nonemm/slab_common.cwarns about it.Adjust the kernel-doc comment for
__ksize()for make W=1 happiness.Signed-off-by Lukas Bulwahn <[email protected]>--- mm/slab_common.c | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-)mm/slab_common.c +2
-2@@ -1010,7 +1010,7 @@ EXPORT_SYMBOL(kfree);/** * __ksize -- Report full size of underlying allocation -* @objp: pointer to the object +* @object: pointer to the object * * This should only be used internally to query the true size of allocations. * It is not meant to be a way to discover the usable size of an allocation @@ -1018,7 +1018,7 @@ EXPORT_SYMBOL(kfree);* the originally requested allocation size may trigger KASAN, UBSAN_BOUNDS, * and/or FORTIFY_SOURCE. * -* Return: size of the actual memory used by @objp in bytes +* Return: size of the actual memory used by @object in bytes */ size_t __ksize (const void *object) {Signature · 1 line
2.17.1
Thanks!
Signature · 2 lines
Thanks, Hyeonggon
Quoted 11 lines · Lukas Bulwahn
Commit
445d41d7a7c1("Merge branch 'slab/for-6.1/kmalloc_size_roundup' into slab/for-next") resolved a conflict of two concurrent changes to__ksize().However, it did not adjust the kernel-doc comment of
__ksize(), while the name of the argument to__ksize()was renamed.Hence,
./scripts/kernel-doc -nonemm/slab_common.cwarns about it.Adjust the kernel-doc comment for
__ksize()for make W=1 happiness.Signed-off-by Lukas Bulwahn <[email protected]>
Thanks! Adding to slab/for-6.1-rc4/fixes
Vlastimil
Quoted 26 lines
--- mm/slab_common.c | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-)mm/slab_common.c +2
-2@@ -1010,7 +1010,7 @@ EXPORT_SYMBOL(kfree);/** * __ksize -- Report full size of underlying allocation -* @objp: pointer to the object +* @object: pointer to the object * * This should only be used internally to query the true size of allocations. * It is not meant to be a way to discover the usable size of an allocation @@ -1018,7 +1018,7 @@ EXPORT_SYMBOL(kfree);* the originally requested allocation size may trigger KASAN, UBSAN_BOUNDS, * and/or FORTIFY_SOURCE. * -* Return: size of the actual memory used by @objp in bytes +* Return: size of the actual memory used by @object in bytes */ size_t __ksize (const void *object) {