Skip to content

Commit dcd39fa

Browse files
andy-shevJonathan Corbet
authored andcommitted
kernel-doc: Align quick help and the code
The update to the quick help mentions -Wshort-description, but code never supported for that. Align that with the code by allowing both: -Wshort-description and -Wshort-desc. Fixes: 56b0f45 ("kernel-doc: don't let V=1 change outcome") Signed-off-by: Andy Shevchenko <andriy.shevchenko@linux.intel.com> Reviewed-by: Randy Dunlap <rdunlap@infradead.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Link: https://lore.kernel.org/r/20231215150341.1996720-1-andriy.shevchenko@linux.intel.com
1 parent cfecf5d commit dcd39fa

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

scripts/kernel-doc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ kernel-doc - Print formatted kernel documentation to stdout
2323
2424
=head1 SYNOPSIS
2525
26-
kernel-doc [-h] [-v] [-Werror] [-Wall] [-Wreturn] [-Wshort-description] [-Wcontents-before-sections]
26+
kernel-doc [-h] [-v] [-Werror] [-Wall] [-Wreturn] [-Wshort-desc[ription]] [-Wcontents-before-sections]
2727
[ -man |
2828
-rst [-sphinx-version VERSION] [-enable-lineno] |
2929
-none
@@ -328,7 +328,7 @@ while ($ARGV[0] =~ m/^--?(.*)/) {
328328
$Werror = 1;
329329
} elsif ($cmd eq "Wreturn") {
330330
$Wreturn = 1;
331-
} elsif ($cmd eq "Wshort-desc") {
331+
} elsif ($cmd eq "Wshort-desc" or $cmd eq "Wshort-description") {
332332
$Wshort_desc = 1;
333333
} elsif ($cmd eq "Wcontents-before-sections") {
334334
$Wcontents_before_sections = 1;

0 commit comments

Comments
 (0)