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

From: Jaswinder Singh Rajput
Date: Sun Nov 22 2009 - 03:19:46 EST



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@xxxxxxxxx>
Cc: Rusty Russell <rusty@xxxxxxxxxxxxxxx>
Cc: Randy Dunlap <randy.dunlap@xxxxxxxxxx>
---
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


--
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at http://vger.kernel.org/majordomo-info.html
Please read the FAQ at http://www.tux.org/lkml/