public inbox for linux-kernel@vger.kernel.org
 help / color / mirror / Atom feed
From: Akira Yokosawa <akiyks@gmail.com>
To: "Tomasz Warniełło" <tomasz.warniello@gmail.com>
Cc: Randy Dunlap <rdunlap@infradead.org>,
	corbet@lwn.net, linux-doc@vger.kernel.org,
	linux-kernel@vger.kernel.org, Akira Yokosawa <akiyks@gmail.com>
Subject: Re: [PATCH v4 00/11] Transform documentation into POD
Date: Wed, 23 Feb 2022 22:16:30 +0900	[thread overview]
Message-ID: <1abcb226-dbfd-b3d2-5453-208af7faa0c2@gmail.com> (raw)
In-Reply-To: <20220223135548.27babd85@fuji.fritz.box>

On Wed, 23 Feb 2022 13:55:48 +0100,
Tomasz Warniełło wrote:
> Hi Akira,
> 
> Take a look at `man perl` and you will find a synopsis also.

When I do "man perl", I want to see a detailed explanation, and
somewhat hard-to-parse synopsis is ok.

I'm saying that I don't like to see such a thing when I type
"./scripts/kerneldoc -h".  I expect a hint to recall which option I
should use.  I don't want to scroll back the terminal.

It would be nice if the verbose man page can be shown by
"./scripts/kerneldoc -v -h" or "perldoc -F ./scripts/kerneldoc".

>                                                              It's simply
> better in depicting grammar relations than a flat switch list. Especially
> when the grammar gets complex. I dislike it also. And I don't think it
> looks good. Rather creepy and overwhelming.
> 
>>> I don't see much point for such a non-user-facing script having nice-looking
>>> well-structured documentation in the first place.
> 
> You're touching the very essence of kernel-doc here. What and who is it for?
> Not just the script - all of it.

Sorry, I have no idea what I am being asked.
Could you rephrase above for a non-native speaker of English, please?

        Thanks, Akira

> 
> Regards,
> 
> Tomasz

  reply	other threads:[~2022-02-23 13:16 UTC|newest]

Thread overview: 23+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-02-18 18:16 [PATCH v4 00/11] Transform documentation into POD Tomasz Warniełło
2022-02-18 18:16 ` [PATCH v4 01/11] scripts: kernel-doc: Add the basic POD sections Tomasz Warniełło
2022-02-22  6:10   ` Randy Dunlap
2022-02-22 21:27     ` Tomasz Warniełło
2022-02-18 18:16 ` [PATCH v4 02/11] scripts: kernel-doc: Relink argument parsing error handling to pod2usage Tomasz Warniełło
2022-02-18 18:16 ` [PATCH v4 03/11] scripts: kernel-doc: Translate the DESCRIPTION section Tomasz Warniełło
2022-02-18 18:16 ` [PATCH v4 04/11] scripts: kernel-doc: Translate the "Output format selection" subsection of OPTIONS Tomasz Warniełło
2022-02-18 18:16 ` [PATCH v4 05/11] scripts: kernel-doc: Translate the "Output format selection modifier" " Tomasz Warniełło
2022-02-18 18:16 ` [PATCH v4 06/11] scripts: kernel-doc: Translate the "Output selection" " Tomasz Warniełło
2022-02-18 18:16 ` [PATCH v4 07/11] scripts: kernel-doc: Translate the "Output selection modifiers" " Tomasz Warniełło
2022-02-18 18:16 ` [PATCH v4 08/11] scripts: kernel-doc: Translate the "Other parameters" " Tomasz Warniełło
2022-02-18 18:16 ` [PATCH v4 09/11] scripts: kernel-doc: Replace the usage function Tomasz Warniełło
2022-02-18 18:16 ` [PATCH v4 10/11] scripts: kernel-doc: Drop obsolete comments Tomasz Warniełło
2022-02-18 18:16 ` [PATCH v4 11/11] scripts: kernel-doc: Refresh the copyright lines Tomasz Warniełło
2022-02-22  5:39 ` [PATCH v4 00/11] Transform documentation into POD Randy Dunlap
2022-02-22 21:31   ` Randy Dunlap
2022-02-23  3:08     ` Akira Yokosawa
2022-02-23  3:17       ` Akira Yokosawa
2022-02-23 12:55         ` Tomasz Warniełło
2022-02-23 13:16           ` Akira Yokosawa [this message]
2022-02-23 14:04             ` Tomasz Warniełło
2022-02-24 18:42 ` Jonathan Corbet
2022-02-24 22:04   ` Tomasz Warniełło

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=1abcb226-dbfd-b3d2-5453-208af7faa0c2@gmail.com \
    --to=akiyks@gmail.com \
    --cc=corbet@lwn.net \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=rdunlap@infradead.org \
    --cc=tomasz.warniello@gmail.com \
    /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