Skip to contentSkip to conversation

linux-next: build warning after merge of the akpm-current tree

PATCH In review Stephen Rothwell 3 participants 3 messages Nov 6, 2020

Subsystems (4)
lore
Share & tools
lore
#0 lore raw

Hi all,

After merging the akpm-current tree, today's linux-next build (htmldocs) produced this warning:

include/linux/kfence.h:138: warning: Function parameter or member 'addr' not described in 'kfence_object_start'

Introduced by patch

mm: add Kernel Electric-Fence infrastructure

Signature · 2 lines
Cheers,
Stephen Rothwell
maintainer
#1 lore raw

PATCH 1/1 kfence: Fix parameter description for kfence_object_start()

Describe parameter @addr correctly by delimiting with ':'.

---
 include/linux/kfence.h | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
include/linux/kfence.h +1 -1
index 98a97f9d43cd..76246889ecdb 100644
@@ -125,7 +125,7 @@ size_t kfence_ksize(const void *addr);
 
 /**
  * kfence_object_start() - find the beginning of a KFENCE object
- * @addr - address within a KFENCE-allocated object
+ * @addr: address within a KFENCE-allocated object
  *
  * Return: address of the beginning of the object.
  *
Signature · 1 line
2.29.2.222.g5d2a92d10f8-goog
maintainer Reviewed-by on v1 1/1
#2 lore raw

Re: [PATCH] kfence: Fix parameter description for kfence_object_start()

Quoted 5 lines · Marco Elver

Describe parameter @addr correctly by delimiting with ':'.

Quoted 20 lines
---
 include/linux/kfence.h | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
include/linux/kfence.h +1 -2
index 98a97f9d43cd..76246889ecdb 100644
@@ -125,7 +125,7 @@ size_t kfence_ksize(const void *addr);
 
 /**
  * kfence_object_start() - find the beginning of a KFENCE object
- * @addr - address within a KFENCE-allocated object
+ * @addr: address within a KFENCE-allocated object
  *
  * Return: address of the beginning of the object.
  *
--

2.29.2.222.g5d2a92d10f8-goog

Signature · 10 lines
Alexander Potapenko
Software Engineer

Google Germany GmbH
Erika-Mann-Straße, 33
80636 München

Geschäftsführer: Paul Manicle, Halimah DeLaine Prado
Registergericht und -nummer: Hamburg, HRB 86891
Sitz der Gesellschaft: Hamburg