Skip to contentSkip to conversation

scripts: kernel-doc: Clarify missing struct member description

PATCH Applied Kees Cook 2 participants 2 messages Dec 15, 2023 Documentation

lore
Share & tools
lore

Kees Cook

author
#0 lore raw

PATCH 1/1 scripts: kernel-doc: Clarify missing struct member description

The output "or member" should be more specific, instead saying "struct member".

Cc Jonathan Corbet <[email protected]>
Cc [email protected]
Signed-off-by Kees Cook <[email protected]>
---
 scripts/kernel-doc | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
scripts/kernel-doc +1 -1
index 39e730ee1fef..41f838042364 100755
@@ -1613,7 +1613,7 @@ sub push_parameter($$$$$) {
 		$parameterdescs{$param} = $undescribed;
 
 	        if (show_warnings($type, $declaration_name) && $param !~ /\./) {
-			emit_warning("${file}:$.", "Function parameter or member '$param' not described in '$declaration_name'\n");
+			emit_warning("${file}:$.", "Function parameter or struct member '$param' not described in '$declaration_name'\n");
 		}
 	}
Signature · 1 line
2.34.1
maintainer Applied
#1 lore raw
Quoted 15 lines · Kees Cook

The output "or member" should be more specific, instead saying "struct member".

Cc Jonathan Corbet <[email protected]>
Cc [email protected]
Signed-off-by Kees Cook <[email protected]>
---
 scripts/kernel-doc | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
scripts/kernel-doc +0 -0
index 39e730ee1fef..41f838042364 100755

scripts/kernel-doc sub push_parameter($$$$$) { · line 1617

Quoted 6 lines
scripts/kernel-doc +1 -1
@@ -1613,7 +1613,7 @@ sub push_parameter($$$$$) {
 		$parameterdescs{$param} = $undescribed;
 
 	        if (show_warnings($type, $declaration_name) && $param !~ /\./) {
-			emit_warning("${file}:$.", "Function parameter or member '$param' not described in '$declaration_name'\n");
+			emit_warning("${file}:$.", "Function parameter or struct member '$param' not described in '$declaration_name'\n");
 		}

Applied, thanks.

jon