[PATCH] lib/string: fix kernel-doc warnings

From: Randy Dunlap
Date: Wed Dec 16 2009 - 22:16:21 EST


From: Randy Dunlap <randy.dunlap@xxxxxxxxxx>

Fix kernel-doc warnings (@arg name) in string.c::skip_spaces().

Warning(lib/string.c:347): No description found for parameter 'str'
Warning(lib/string.c:347): Excess function parameter 's' description in 'skip_spaces'

Signed-off-by: Randy Dunlap <randy.dunlap@xxxxxxxxxx>
---
lib/string.c | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)

--- linux-2.6.32-git12.orig/lib/string.c
+++ linux-2.6.32-git12/lib/string.c
@@ -338,10 +338,10 @@ EXPORT_SYMBOL(strnchr);
#endif

/**
- * skip_spaces - Removes leading whitespace from @s.
- * @s: The string to be stripped.
+ * skip_spaces - Removes leading whitespace from @str.
+ * @str: The string to be stripped.
*
- * Returns a pointer to the first non-whitespace character in @s.
+ * Returns a pointer to the first non-whitespace character in @str.
*/
char *skip_spaces(const char *str)
{
--
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/