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
