Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20;
From:   Jonathan Corbet <corbet@lwn.net>
To:     Tomasz =?utf-8?B?V2FybmllxYLFgm8=?= <tomasz.warniello@gmail.com>
Cc:     Tomasz =?utf-8?B?V2FybmllxYLFgm8=?= <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
In-Reply-To: <20220104015946.529524-4-tomasz.warniello@gmail.com>
References: <20220104015946.529524-1-tomasz.warniello@gmail.com>
 <20220104015946.529524-4-tomasz.warniello@gmail.com>
Date:   Wed, 16 Feb 2022 16:21:16 -0700
Message-ID: <87o8362yab.fsf@meer.lwn.net>
MIME-Version: 1.0
Content-Type: text/plain; charset=utf-8
Content-Transfer-Encoding: quoted-printable
Precedence: bulk

Tomasz Warnie=C5=82=C5=82o <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.=20

> Signed-off-by: Tomasz Warnie=C5=82=C5=82o <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             ##
>=20=20
> +use Pod::Usage qw/pod2usage/;
> +
>  =3Dhead1 NAME
>=20=20
>  kernel-doc - Print formatted kernel documentation to stdout
> @@ -298,7 +300,13 @@ my $blankline_rst =3D "\n";
>=20=20
>  # read arguments
>  if ($#ARGV =3D=3D -1) {
> -    usage();
> +	pod2usage(
> +		-message =3D> "No arguments!\n",
> +		-exitval =3D> 1,
> +		-verbose =3D> 99,
> +		-sections =3D> 'SYNOPSIS',
> +		-output =3D> \*STDERR,
> +	);
>  }
>=20=20
>  my $kernelversion;
> @@ -518,8 +526,14 @@ while ($ARGV[0] =3D~ m/^--?(.*)/) {
>  	    die "Sphinx version should either major.minor or major.minor.patch =
format\n";
>  	}
>      } else {
> -	# Unknown argument
> -        usage();
> +			# Unknown argument
> +		pod2usage(
> +			-message =3D> "Argument unknown!\n",
> +			-exitval =3D> 1,
> +			-verbose =3D> 99,
> +			-sections =3D> 'SYNOPSIS',
> +			-output =3D> \*STDERR,
> +		);

So you were asked before to retain the existing style, including
indentations.

Thanks,

jon