2023-12-15 15:12:39

by Andy Shevchenko

Subject: [PATCH v1 1/1] kernel-doc: Aling 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 <[email protected]>
---
scripts/kernel-doc | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/scripts/kernel-doc b/scripts/kernel-doc
index 0a890fe4d22b..7d7ed3e43946 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;
--
2.43.0.rc1.1.gbec44491f096

2023-12-15 16:49:48

by Randy Dunlap

Subject: Re: [PATCH v1 1/1] kernel-doc: Aling quick help and the code

On 12/15/23 07:03, Andy Shevchenko wrote:
> 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 <[email protected]>

Reviewed-by: Randy Dunlap <[email protected]>

Thanks.

(Note: in Subject, s/Aling/Align/)

> ---
> scripts/kernel-doc | 4 ++--
> 1 file changed, 2 insertions(+), 2 deletions(-)
>
> diff --git a/scripts/kernel-doc b/scripts/kernel-doc
> index 0a890fe4d22b..7d7ed3e43946 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;

--
#Randy
https://people.kernel.org/tglx/notes-about-netiquette
https://subspace.kernel.org/etiquette.html

2023-12-19 21:17:32

by Jonathan Corbet

Subject: Re: [PATCH v1 1/1] kernel-doc: Aling quick help and the code

Andy Shevchenko <[email protected]> writes:

> On Fri, Dec 15, 2023 at 08:49:37AM -0800, Randy Dunlap wrote:
>> On 12/15/23 07:03, Andy Shevchenko wrote:
>> > 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 <[email protected]>
>>
>> Reviewed-by: Randy Dunlap <[email protected]>
>
> Thank you!
>
>> (Note: in Subject, s/Aling/Align/)
>
> Indeed, Jonathan, can you fix when applying?

Done.

Thanks,

jon