Skip to contentSkip to conversation

kernel.h: Fix kernel-doc notation

PATCH In review Jaswinder Singh Rajput 4 participants 4 messages Nov 22, 2009 – Nov 23, 2009

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 kernel.h: Fix kernel-doc notation

Fix the following htmldocs warnings:

Warning(include/linux/kernel.h:708): No description found for parameter 'condition' Warning(include/linux/kernel.h:708): Excess function parameter 'cond' description in 'BUILD_BUG_ON'

---
 include/linux/kernel.h |    2 +-
 1 files changed, 1 insertions(+), 1 deletions(-)
include/linux/kernel.h +1 -1
index 14bcd38..e1e81ed 100644
@@ -691,7 +691,7 @@ struct sysinfo {
 
 /**
  * BUILD_BUG_ON - break compile if a condition is true.
- * @cond: the condition which the compiler should know is false.
+ * @condition: the condition which the compiler should know is false.
  *
  * If you have some code which relies on certain constants being equal, or
  * other compile-time-evaluated condition, you should use BUILD_BUG_ON to
Signature · 1 line
1.6.5.3
#1 lore raw
Quoted 5 lines · Jaswinder Singh Rajput

Fix the following htmldocs warnings:

Warning(include/linux/kernel.h:708): No description found for parameter 'condition' Warning(include/linux/kernel.h:708): Excess function parameter 'cond' description in 'BUILD_BUG_ON'

This look like ajob for [email protected] or akpm?

For the pedants: Acked-by: Rusty Russell <[email protected]>

Thanks!
Rusty.

#2 lore raw
Quoted 8 lines · On Mon, 23 Nov 2009 12:20:26 +1030 Rusty Russell wrote:
Quoted 5 lines · Jaswinder Singh Rajput

Fix the following htmldocs warnings:

Warning(include/linux/kernel.h:708): No description found for parameter 'condition' Warning(include/linux/kernel.h:708): Excess function parameter 'cond' description in 'BUILD_BUG_ON'

This look like ajob for [email protected] or akpm?

Yes, normally each subsystem maintainer or trivial should do this.

Quoted 4 lines

For the pedants: Acked-by: Rusty Russell <[email protected]>

Thanks!
Rusty.

Thanks.
---
~Randy

#3 lore raw
In reply to Rusty Russell
Quoted 10 lines · Rusty Russell
Quoted 5 lines · Jaswinder Singh Rajput

Fix the following htmldocs warnings:

Warning(include/linux/kernel.h:708): No description found for parameter 'condition' Warning(include/linux/kernel.h:708): Excess function parameter 'cond' description in 'BUILD_BUG_ON'

This look like ajob for [email protected] or akpm?

For the pedants: Acked-by: Rusty Russell <[email protected]>

Thanks, but ... what tree is this against? Certainly doesn't apply for current Linus' tree.

Signature · 2 lines
Jiri Kosina
SUSE Labs, Novell Inc.