From: "Tomasz Warniełło" <tomasz.warniello@gmail.com>
To: corbet@lwn.net
Cc: "Tomasz Warniełło" <tomasz.warniello@gmail.com>,
linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org
Subject: [PATCH v3 00/15] Transform documentation into POD
Date: Tue, 4 Jan 2022 02:59:31 +0100 [thread overview]
Message-ID: <20220104015946.529524-1-tomasz.warniello@gmail.com> (raw)
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.
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 TODO suggestion to write POD found in the script is ancient, thus
I can't address its author with a "Suggested-by" tag.
The process consists of 15 steps.
Patches beginning with no 4 are disfunctional until no 10 has been
applied.
This version is in fact the first correction of v1. The first attempt to
send it was a failure due to my lack of experience. It was weird in other
ways too. Never mind the details.
What I'm sending now mostly follows the advice received for v1. My reply is
contained in the patches otherwise. I have also done a few bits differently
to v1, as I found better solutions, etc.
Ok, let's see how it gets through this time.
PS. Jani Nikula and Jonathan Corbet - sorry for bothering you with a copy of
emails with you tagged in them that I sent to myself. This was unexpected.
Tomasz Warniełło (15):
scripts: kernel-doc: Add the NAME section
scripts: kernel-doc: Add the SYNOPSIS section
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: Remove the "format of comments" comment block
scripts: kernel-doc: Archive the pre-git museum
scripts: kernel-doc: License cleanup
scripts: kernel-doc: Refresh the copyright lines
scripts: kernel-doc: Move the TODOs
scripts/kernel-doc | 390 ++++++++++++++++++++++-----------------------
1 file changed, 194 insertions(+), 196 deletions(-)
base-commit: 2a987e65025e2b79c6d453b78cb5985ac6e5eb26
--
2.30.2
next reply other threads:[~2022-01-04 2:00 UTC|newest]
Thread overview: 26+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-01-04 1:59 Tomasz Warniełło [this message]
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
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=20220104015946.529524-1-tomasz.warniello@gmail.com \
--to=tomasz.warniello@gmail.com \
--cc=corbet@lwn.net \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
/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).