Received-SPF: pass (google.com: domain of linux-kernel+bounces-1329-linux.lists.archive=gmail.com@vger.kernel.org designates 2604:1380:45e3:2400::1 as permitted sender) client-ip=2604:1380:45e3:2400::1;
Message-ID: <03c0b3bd-5798-4066-964e-a884485fe1d3@infradead.org>
Date: Fri, 15 Dec 2023 08:49:37 -0800
Precedence: bulk
MIME-Version: 1.0
User-Agent: Mozilla Thunderbird
Subject: Re: [PATCH v1 1/1] kernel-doc: Aling quick help and the code
Content-Language: en-US
To: Andy Shevchenko <andriy.shevchenko@linux.intel.com>,
 linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org
Cc: Jonathan Corbet <corbet@lwn.net>
References: <20231215150341.1996720-1-andriy.shevchenko@linux.intel.com>
From: Randy Dunlap <rdunlap@infradead.org>
In-Reply-To: <20231215150341.1996720-1-andriy.shevchenko@linux.intel.com>
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 7bit


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 <andriy.shevchenko@linux.intel.com>

Reviewed-by: Randy Dunlap <rdunlap@infradead.org>

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