Skip to contentSkip to conversation

Silence two kerneldoc warnings in kernel/audit.c

PATCH Dave Jones 2 participants 2 messages Mar 25, 2008 Audit

lore
Share & tools
lore

Dave Jones

author
#0 lore raw

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]

kernel/audit.c renamed from kernel/audit.c~ +3 -3
@@ -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
#1 lore raw
Quoted 8 lines · 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]

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

Good luck.

Quoted 14 lines
kernel/audit.c renamed from kernel/audit.c~ +2 -2
@@ -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)
 {

kernel/audit.c int audit_string_contains_control(const

Quoted 10 lines
kernel/audit.c renamed from kernel/audit.c~ +1 -2
@@ -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