diff options
| author | Andy Shevchenko <andriy.shevchenko@linux.intel.com> | 2023-12-15 17:03:41 +0200 |
|---|---|---|
| committer | Jonathan Corbet <corbet@lwn.net> | 2023-12-19 14:17:00 -0700 |
| commit | dcd39fa2be95efd5cbce74661151f68510cb67fe (patch) | |
| tree | 0ceb9f5cbbf14d979aaf65759fa4d915978cc52f /scripts/kernel-doc | |
| parent | cfecf5d7ffbad4f053b79d78091bd2af78c1ea79 (diff) | |
| download | lwn-dcd39fa2be95efd5cbce74661151f68510cb67fe.tar.gz lwn-dcd39fa2be95efd5cbce74661151f68510cb67fe.zip | |
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: 56b0f453db74 ("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
Diffstat (limited to 'scripts/kernel-doc')
| -rwxr-xr-x | scripts/kernel-doc | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/scripts/kernel-doc b/scripts/kernel-doc index 6acc39c56ac3..3cdc7dba37e3 100755 --- a/scripts/kernel-doc +++ b/scripts/kernel-doc @@ -23,7 +23,7 @@ kernel-doc - Print formatted kernel documentation to stdout =head1 SYNOPSIS - kernel-doc [-h] [-v] [-Werror] [-Wall] [-Wreturn] [-Wshort-description] [-Wcontents-before-sections] + kernel-doc [-h] [-v] [-Werror] [-Wall] [-Wreturn] [-Wshort-desc[ription]] [-Wcontents-before-sections] [ -man | -rst [-sphinx-version VERSION] [-enable-lineno] | -none @@ -328,7 +328,7 @@ while ($ARGV[0] =~ m/^--?(.*)/) { $Werror = 1; } elsif ($cmd eq "Wreturn") { $Wreturn = 1; - } elsif ($cmd eq "Wshort-desc") { + } elsif ($cmd eq "Wshort-desc" or $cmd eq "Wshort-description") { $Wshort_desc = 1; } elsif ($cmd eq "Wcontents-before-sections") { $Wcontents_before_sections = 1; |