From: Jonathan Corbet <corbet@lwn.net>
To: "Tomasz Warniełło" <tomasz.warniello@gmail.com>
Cc: "Tomasz Warniełło" <tomasz.warniello@gmail.com>,
linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org
Subject: Re: [PATCH v3 03/15] scripts: kernel-doc: Relink argument parsing error handling to pod2usage
Date: Wed, 16 Feb 2022 16:21:16 -0700 [thread overview]
Message-ID: <87o8362yab.fsf@meer.lwn.net> (raw)
In-Reply-To: <20220104015946.529524-4-tomasz.warniello@gmail.com>
Tomasz Warniełło <tomasz.warniello@gmail.com> writes:
> The former usage function is substituted, although not as the -h and -help
> parameter handler yet.
>
> * Transform documentation into POD (3/15)
> See step 1 for the series details.
Again, this doesn't belong here; I'll not mention it for the following
patches.
> Signed-off-by: Tomasz Warniełło <tomasz.warniello@gmail.com>
> ---
> scripts/kernel-doc | 20 +++++++++++++++++---
> 1 file changed, 17 insertions(+), 3 deletions(-)
>
> diff --git a/scripts/kernel-doc b/scripts/kernel-doc
> index c8fbf1d3d5aa..c37fd36860f3 100755
> --- a/scripts/kernel-doc
> +++ b/scripts/kernel-doc
> @@ -16,6 +16,8 @@ use strict;
> ## This software falls under the GNU General Public License. ##
> ## Please read the COPYING file for more information ##
>
> +use Pod::Usage qw/pod2usage/;
> +
> =head1 NAME
>
> kernel-doc - Print formatted kernel documentation to stdout
> @@ -298,7 +300,13 @@ my $blankline_rst = "\n";
>
> # read arguments
> if ($#ARGV == -1) {
> - usage();
> + pod2usage(
> + -message => "No arguments!\n",
> + -exitval => 1,
> + -verbose => 99,
> + -sections => 'SYNOPSIS',
> + -output => \*STDERR,
> + );
> }
>
> my $kernelversion;
> @@ -518,8 +526,14 @@ while ($ARGV[0] =~ m/^--?(.*)/) {
> die "Sphinx version should either major.minor or major.minor.patch format\n";
> }
> } else {
> - # Unknown argument
> - usage();
> + # Unknown argument
> + pod2usage(
> + -message => "Argument unknown!\n",
> + -exitval => 1,
> + -verbose => 99,
> + -sections => 'SYNOPSIS',
> + -output => \*STDERR,
> + );
So you were asked before to retain the existing style, including
indentations.
Thanks,
jon
next prev parent reply other threads:[~2022-02-16 23:21 UTC|newest]
Thread overview: 26+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-01-04 1:59 [PATCH v3 00/15] Transform documentation into POD Tomasz Warniełło
2022-01-04 1:59 ` [PATCH v3 01/15] scripts: kernel-doc: Add the NAME section Tomasz Warniełło
2022-02-16 23:18 ` Jonathan Corbet
2022-01-04 1:59 ` [PATCH v3 02/15] scripts: kernel-doc: Add the SYNOPSIS section Tomasz Warniełło
2022-02-16 23:19 ` Jonathan Corbet
2022-01-04 1:59 ` [PATCH v3 03/15] scripts: kernel-doc: Relink argument parsing error handling to pod2usage Tomasz Warniełło
2022-02-16 23:21 ` Jonathan Corbet [this message]
2022-01-04 1:59 ` [PATCH v3 04/15] scripts: kernel-doc: Translate the DESCRIPTION section Tomasz Warniełło
2022-01-04 1:59 ` [PATCH v3 05/15] scripts: kernel-doc: Translate the "Output format selection" subsection of OPTIONS Tomasz Warniełło
2022-01-04 1:59 ` [PATCH v3 06/15] scripts: kernel-doc: Translate the "Output format selection modifier" " Tomasz Warniełło
2022-01-04 1:59 ` [PATCH v3 07/15] scripts: kernel-doc: Translate the "Output selection" " Tomasz Warniełło
2022-01-04 1:59 ` [PATCH v3 08/15] scripts: kernel-doc: Translate the "Output selection modifiers" " Tomasz Warniełło
2022-01-04 1:59 ` [PATCH v3 09/15] scripts: kernel-doc: Translate the "Other parameters" " Tomasz Warniełło
2022-01-04 1:59 ` [PATCH v3 10/15] scripts: kernel-doc: Replace the usage function Tomasz Warniełło
2022-01-04 1:59 ` [PATCH v3 11/15] scripts: kernel-doc: Remove the "format of comments" comment block Tomasz Warniełło
2022-02-16 23:26 ` Jonathan Corbet
2022-01-04 1:59 ` [PATCH v3 12/15] scripts: kernel-doc: Archive the pre-git museum Tomasz Warniełło
2022-02-16 23:29 ` Jonathan Corbet
2022-01-04 1:59 ` [PATCH v3 13/15] scripts: kernel-doc: License cleanup Tomasz Warniełło
2022-01-04 1:59 ` [PATCH v3 14/15] scripts: kernel-doc: Refresh the copyright lines Tomasz Warniełło
2022-02-16 23:34 ` Jonathan Corbet
2022-01-04 1:59 ` [PATCH v3 15/15] scripts: kernel-doc: Move the TODOs Tomasz Warniełło
2022-02-16 23:34 ` Jonathan Corbet
2022-01-13 6:41 ` [PATCH v3 00/15] Transform documentation into POD Tomasz Warniełło
2022-01-13 16:19 ` Jonathan Corbet
2022-02-16 23:14 ` Jonathan Corbet
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=87o8362yab.fsf@meer.lwn.net \
--to=corbet@lwn.net \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=tomasz.warniello@gmail.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).