[PATCH] kernel.h: Fix kernel-doc notation

[PATCH] kernel.h: Fix kernel-doc notation

[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'

Signed-off-by: Jaswinder Singh Rajput <jaswinderrajput@gmail.com>
Cc: Rusty Russell <rusty@rustcorp.com.au>
Cc: Randy Dunlap <randy.dunlap@oracle.com>
---
 include/linux/kernel.h |    2 +-
 1 files changed, 1 insertions(+), 1 deletions(-)

diff --git a/include/linux/kernel.h b/include/linux/kernel.h
index 14bcd38..e1e81ed 100644
--- a/include/linux/kernel.h
+++ b/include/linux/kernel.h
@@ -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
-- 
1.6.5.3

Re: [PATCH] kernel.h: Fix kernel-doc notation

[Rusty Russell]

On Sun, 22 Nov 2009 06:42:09 pm Jaswinder Singh Rajput wrote:
> 
> 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 trivial@kernel.org or akpm?

For the pedants: Acked-by: Rusty Russell <rusty@rustcorp.com.au>

Thanks!
Rusty.

Re: [PATCH] kernel.h: Fix kernel-doc notation

[Randy Dunlap]

On Mon, 23 Nov 2009 12:20:26 +1030 Rusty Russell wrote:

> On Sun, 22 Nov 2009 06:42:09 pm Jaswinder Singh Rajput wrote:
> > 
> > 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 trivial@kernel.org or akpm?

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

> For the pedants: Acked-by: Rusty Russell <rusty@rustcorp.com.au>
> 
> Thanks!
> Rusty.

Thanks.
---
~Randy

Re: [PATCH] kernel.h: Fix kernel-doc notation

[Jiri Kosina]

On Mon, 23 Nov 2009, Rusty Russell wrote:

> On Sun, 22 Nov 2009 06:42:09 pm Jaswinder Singh Rajput wrote:
> > 
> > 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 trivial@kernel.org or akpm?
> 
> For the pedants: Acked-by: Rusty Russell <rusty@rustcorp.com.au>

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

-- 
Jiri Kosina
SUSE Labs, Novell Inc.