linux-kernel - [PATCH v4 00/11] Transform documentation into POD

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [thread-next>] [day] [month] [year] [list]

Message-Id: <20220218181628.1411551-1-tomasz.warniello@gmail.com>
Date:   Fri, 18 Feb 2022 19:16:17 +0100
From:   Tomasz Warniełło 
        <tomasz.warniello@...il.com>
To:     corbet@....net
Cc:     Tomasz Warniełło 
        <tomasz.warniello@...il.com>, linux-doc@...r.kernel.org,
        linux-kernel@...r.kernel.org
Subject: [PATCH v4 00/11] Transform documentation into POD

This series transforms the free-form general comments - mainly the usage
instructions and the meta information - into the standard Perl
documentation format. Some of the original text is reduced out. And some
is simply dropped.

The transformation includes language, paragraphing and editorial
corrections.

The only change in the script execution flow is the replacement of the
'usage' function with the native standard Perl 'pod2usage'.

The to-do suggestion to write POD found in the script is ancient, thus
I can't address its author with a "Suggested-by" tag.

This version follows the advice received on v3, except I'm leaving
the old copyrights untouched.

The process consists of 14 steps.

Patches beginning with no 3 are disfunctional until no 9 has been
applied.

1) Add the basic POD sections
2) Relink argument parsing error handling to pod2usage

The following subseries is disfunctional before its last part.

3) Translate the DESCRIPTION section
4) Translate the "Output format selection" subsection of OPTIONS
5) Translate the "Output format selection modifier" subsection of OPTIONS
6) Translate the "Output selection" subsection of OPTIONS
7) Translate the "Output selection modifiers" subsection of OPTIONS
8) Translate the "Other parameters" subsection of OPTIONS
9) Replace the usage function

Here the DESCRIPTION and OPTIONS subseries is finished. The -h and -help
parameters are handled by POD now.

10) Drop obsolete comments
11) Refresh the copyright lines

Let's see what's wrong this time.

Tomasz Warniełło (11):
  scripts: kernel-doc: Add the basic POD sections
  scripts: kernel-doc: Relink argument parsing error handling to
    pod2usage
  scripts: kernel-doc: Translate the DESCRIPTION section
  scripts: kernel-doc: Translate the "Output format selection"
    subsection of OPTIONS
  scripts: kernel-doc: Translate the "Output format selection modifier"
    subsection of OPTIONS
  scripts: kernel-doc: Translate the "Output selection" subsection of
    OPTIONS
  scripts: kernel-doc: Translate the "Output selection modifiers"
    subsection of OPTIONS
  scripts: kernel-doc: Translate the "Other parameters" subsection of
    OPTIONS
  scripts: kernel-doc: Replace the usage function
  scripts: kernel-doc: Drop obsolete comments
  scripts: kernel-doc: Refresh the copyright lines

 scripts/kernel-doc | 347 +++++++++++++++++++++------------------------
 1 file changed, 159 insertions(+), 188 deletions(-)

base-commit: 2a987e65025e2b79c6d453b78cb5985ac6e5eb26
-- 
2.30.2