Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:18 as permitted sender) client-ip=2620:137:e000::1:18;
Message-ID: <7852b505-a65a-6cdd-29a8-3bc966dfc750@infradead.org>
Date:   Mon, 21 Feb 2022 22:10:22 -0800
MIME-Version: 1.0
User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:91.0) Gecko/20100101
 Thunderbird/91.6.1
Subject: Re: [PATCH v4 01/11] scripts: kernel-doc: Add the basic POD sections
Content-Language: en-US
To:     =?UTF-8?B?VG9tYXN6IFdhcm5pZcWCxYJv?= <tomasz.warniello@gmail.com>,
        corbet@lwn.net
Cc:     linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org
References: <20220218181628.1411551-1-tomasz.warniello@gmail.com>
 <20220218181628.1411551-2-tomasz.warniello@gmail.com>
From:   Randy Dunlap <rdunlap@infradead.org>
In-Reply-To: <20220218181628.1411551-2-tomasz.warniello@gmail.com>
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
Precedence: bulk


On 2/18/22 10:16, Tomasz Warniełło wrote:
> The NAME section provides the doc title, while SYNOPSIS contains
> the basic syntax and usage description, which will be printed
> in the help document and in the error output produced on wrong script
> usage.
> 
> The rationale is to give users simple and succinct enlightment,
> at the same time structuring the script internally for the maintainers.
> 
> In the synopsis, Rst-only options are grouped around rst, and the rest is
> arranged as in the OPTIONS subsections (yet to be translated into POD,
> check at the end of the series).
> 
> The third of the basic sections, DESCRIPTION, is added separately.
> 
> Signed-off-by: Tomasz Warniełło <tomasz.warniello@gmail.com>
> ---
>  scripts/kernel-doc | 25 +++++++++++++++++++++++++
>  1 file changed, 25 insertions(+)
> 
> diff --git a/scripts/kernel-doc b/scripts/kernel-doc
> index 3106b7536b89..c8fbf1d3d5aa 100755
> --- a/scripts/kernel-doc
> +++ b/scripts/kernel-doc
> @@ -16,6 +16,31 @@ use strict;
>  ## This software falls under the GNU General Public License.     ##
>  ## Please read the COPYING file for more information             ##
>  
> +=head1 NAME
> +
> +kernel-doc - Print formatted kernel documentation to stdout
> +
> +=head1 SYNOPSIS
> +
> + kernel-doc [-h] [-v] [-Werror]
> +   [ -man |
> +     -rst [-sphinx-version VERSION] [-enable-lineno] |
> +     -none
> +   ]
> +   [
> +     -export |
> +     -internal |
> +     [-function NAME] ... |
> +     [-nosymbol NAME] ...
> +   ]
> +   [-no-doc-sections]
> +   [-export-file FILE] ...
> +   FILE ...
> +
> +Run `kernel-doc -h` for details.

Nit:
$ ./scripts/kernel-doc -h
says:
    Run `kernel-doc -h` for details.

> +
> +=cut
> +
>  # 18/01/2001 - 	Cleanups
>  # 		Functions prototyped as foo(void) same as foo()
>  # 		Stop eval'ing where we don't need to.

-- 
~Randy