Commit dcd39fa2 authored by Andy Shevchenko's avatar Andy Shevchenko Committed by Jonathan Corbet
Browse files

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: 56b0f453 ("kernel-doc: don't let V=1 change outcome")
Signed-off-by: default avatarAndy Shevchenko <andriy.shevchenko@linux.intel.com>
Reviewed-by: default avatarRandy Dunlap <rdunlap@infradead.org>
Signed-off-by: default avatarJonathan Corbet <corbet@lwn.net>
Link: https://lore.kernel.org/r/20231215150341.1996720-1-andriy.shevchenko@linux.intel.com
parent cfecf5d7

scripts/kernel-doc

+2 −2
Original line number Diff line number Diff line
@@ -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;