From: Jonathan Corbet <corbet@lwn.net>
To: Jani Nikula <jani.nikula@linux.intel.com>
Cc: peter@bikeshed.quignogs.org.uk,
Matthew Wilcox <willy@infradead.org>,
linux-kernel@vger.kernel.org,
Greg Kroah-Hartman <gregkh@linuxfoundation.org>,
"Rafael J. Wysocki" <rafael@kernel.org>,
linux-doc@vger.kernel.org
Subject: Re: [PATCH v3 0/1] Compactly make code examples into literal blocks
Date: Fri, 27 Mar 2020 10:41:26 -0600 [thread overview]
Message-ID: <20200327104126.667b5d5b@lwn.net> (raw)
In-Reply-To: <87imiqghop.fsf@intel.com>
On Fri, 27 Mar 2020 13:28:54 +0200
Jani Nikula <jani.nikula@linux.intel.com> wrote:
> IMHO the real problem is kernel-doc doing too much preprocessing on the
> input, preventing us from doing what would be the sensible thing in
> rst. The more we try to fix the problem by adding more kernel-doc
> processing, the further we dig ourselves into this hole.
>
> If kernel-doc didn't have its own notion of section headers, such as
> "example:", we wouldn't have this problem to begin with. We could just
> use the usual rst construct; "example::" followed by an indented block.
>
> I'm not going to stand in the way of the patch, but I'm telling you,
> this is going to get harder, not easier, on this path.
I agree with you in principle. The problem, of course, is that this is a
legacy gift from before the RST days and it will be hard to change.
A quick grep shows that the pattern:
* Example:
appears nearly 100 times in current kernels. It is not inconceivable to
make a push to get rid of all of those, turning them into ordinary RST
syntax - especially since not all of those are actually kerneldoc
comments.
The same quick grep says that "returns?:" appears about 10,000 times.
*That* will be painful to change, and I can only imagine that some
resistance would have to be overcome at some point.
So what do folks think we should do? :)
I want to ponder on this for a bit. Peter, that may mean that I hold this
patch past the 5.7 merge window, which perhaps makes sense at this point
anyway, sorry. But I really would like to push things into a direction
that moves us away from gnarly perl hacks and toward something more
maintainable in the long term.
Thanks,
jon
next prev parent reply other threads:[~2020-03-27 16:41 UTC|newest]
Thread overview: 21+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-03-11 19:22 [PATCH 0/1] Format kerneldoc code snippets as literal block peter
2020-03-11 19:22 ` [PATCH 1/1] Added double colons and blank lines within kerneldoc to format code snippets as ReST literal blocks peter
2020-03-11 19:30 ` Jonathan Corbet
2020-03-26 19:16 ` [PATCH v2 0/1] Compactly make code examples into " peter
2020-03-26 19:16 ` [PATCH v2 1/1] A compact idiom to add code examples in kerneldoc comments peter
2020-03-26 19:29 ` Matthew Wilcox
2020-03-26 19:36 ` Peter Lister
2020-03-26 19:51 ` [PATCH v3 0/1] Compactly make code examples into literal blocks peter
2020-03-26 19:51 ` [PATCH v3 1/1] A compact idiom to add code examples in kerneldoc comments peter
2020-03-26 19:54 ` Matthew Wilcox
2020-03-27 6:32 ` Greg Kroah-Hartman
2020-03-27 11:28 ` [PATCH v3 0/1] Compactly make code examples into literal blocks Jani Nikula
2020-03-27 16:41 ` Jonathan Corbet [this message]
2020-03-27 16:50 ` Matthew Wilcox
2020-03-27 17:11 ` Jonathan Corbet
2020-03-27 17:35 ` Matthew Wilcox
2020-03-31 11:22 ` Jani Nikula
2020-03-31 10:50 ` Jani Nikula
2020-03-30 22:29 ` Peter Lister
2020-03-30 22:32 ` Jonathan Corbet
2020-03-31 11:54 ` Jani Nikula
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=20200327104126.667b5d5b@lwn.net \
--to=corbet@lwn.net \
--cc=gregkh@linuxfoundation.org \
--cc=jani.nikula@linux.intel.com \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=peter@bikeshed.quignogs.org.uk \
--cc=rafael@kernel.org \
--cc=willy@infradead.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).