Silence two kerneldoc warnings in kernel/audit.c

Silence two kerneldoc warnings in kernel/audit.c

[Dave Jones]

Silence two kerneldoc warnings.

Warning(kernel/audit.c:1276): No description found for parameter 'string'
Warning(kernel/audit.c:1276): No description found for parameter 'len'

[also fix a typo for bonus points]

Signed-off-by: Dave Jones <davej@codemonkey.org.uk>

--- linux-2.6.24.noarch/kernel/audit.c~	2008-03-24 20:22:32.000000000 -0400
+++ linux-2.6.24.noarch/kernel/audit.c	2008-03-24 20:23:34.000000000 -0400
@@ -1269,8 +1269,8 @@ static void audit_log_n_string(struct au
 
 /**
  * audit_string_contains_control - does a string need to be logged in hex
- * @string - string to be checked
- * @len - max length of the string to check
+ * @string: string to be checked
+ * @len: max length of the string to check
  */
 int audit_string_contains_control(const char *string, size_t len)
 {
@@ -1285,7 +1285,7 @@ int audit_string_contains_control(const 
 /**
  * audit_log_n_untrustedstring - log a string that may contain random characters
  * @ab: audit_buffer
- * @len: lenth of string (not including trailing null)
+ * @len: length of string (not including trailing null)
  * @string: string to be logged
  *
  * This code will escape a string that is passed to it if the string

Re: Silence two kerneldoc warnings in kernel/audit.c

[Randy Dunlap]

On Mon, 24 Mar 2008 20:27:05 -0400 Dave Jones wrote:

> Silence two kerneldoc warnings.
> 
> Warning(kernel/audit.c:1276): No description found for parameter 'string'
> Warning(kernel/audit.c:1276): No description found for parameter 'len'
> 
> [also fix a typo for bonus points]
> 
> Signed-off-by: Dave Jones <davej@codemonkey.org.uk>

I've sent the same patch to the audit people... so acked-by me.

Good luck.

> --- linux-2.6.24.noarch/kernel/audit.c~	2008-03-24 20:22:32.000000000 -0400
> +++ linux-2.6.24.noarch/kernel/audit.c	2008-03-24 20:23:34.000000000 -0400
> @@ -1269,8 +1269,8 @@ static void audit_log_n_string(struct au
>  
>  /**
>   * audit_string_contains_control - does a string need to be logged in hex
> - * @string - string to be checked
> - * @len - max length of the string to check
> + * @string: string to be checked
> + * @len: max length of the string to check
>   */
>  int audit_string_contains_control(const char *string, size_t len)
>  {
> @@ -1285,7 +1285,7 @@ int audit_string_contains_control(const 
>  /**
>   * audit_log_n_untrustedstring - log a string that may contain random characters
>   * @ab: audit_buffer
> - * @len: lenth of string (not including trailing null)
> + * @len: length of string (not including trailing null)
>   * @string: string to be logged
>   *
>   * This code will escape a string that is passed to it if the string
> 
> --

---
~Randy