Re: [PATCH v2 08/29] docs: filesystems: convert configfs.txt to ReST

From: Christoph Hellwig
Date: Mon Apr 27 2020 - 08:53:15 EST


On Tue, Apr 21, 2020 at 04:53:17PM -0600, Jonathan Corbet wrote:
> > It wasn't entirely uncommon, but that's not really the point. The
> > Problem is all the weird ".." or "::" annotations that really kill
> > the flow, or things like "|copy|" that have no reason to exist.
>
> This sounds sort of like "my markup is good, yours is bad", honestly. If
> somebody were trying to add bracketed headings to a new document, I
> suspect we'd get similar complaints.

Not really. It is a "less markup is better".

> The markup can certainly be toned down. If you don't like |copy|, it can
> just as easily remain "(c)" or become ©, or just go away entirely. That
> would get rid of the ".. include:: <isonum.txt>" line too. I would
> happily make a rule that we don't bother with markup like |copy|
> anywhere in the kernel docs.

That is a good start.

> The SPDX line is supposed to exist in all files, of course.

No problem with that. I'll happily take a SPDX patch any time.

> If Mauro does that, can you live with "::" to mark a literal block? It
> doesn't seem like a whole lot of noise...?

That is in fact one of my favourite pet pevees with the whole RST
thing.