Re: [PATCH v4 0/9] docs: Convert VFS doc to RST

From: Tobin C. Harding
Date: Thu May 30 2019 - 02:05:14 EST


On Wed, May 29, 2019 at 04:30:52PM -0600, Jonathan Corbet wrote:
> On Wed, 15 May 2019 10:29:04 +1000
> "Tobin C. Harding" <tobin@xxxxxxxxxx> wrote:
>
> > Here is an updated version of the VFS doc conversion. This series in no
> > way represents a final point for the VFS documentation rather it is a
> > small step towards getting VFS docs updated. This series does not
> > update the content of vfs.txt, only does formatting.
>
> I've finally gotten to this, sorry for taking so long. Applying it to
> docs-next turned out to be a bit of a chore; there have been intervening
> changes to vfs.txt that we didn't want to lose. But I did it.
>
> Unfortunately, there's still a remaining issue. You did a lot of list
> conversions like this:
>
> > - struct file_system_type *fs_type: describes the filesystem, partly initialized
> > +``struct file_system_type *fs_type``: describes the filesystem, partly initialized
> > by the specific filesystem code
>
> but that does not render the way you would like, trust me. You really
> want to use the list format, something like:
>
> ``struct file_system_type *fs_type``
> describes the filesystem, partly initialized by the specific
> filesystem code

Ouch! Yes I knew this was sub-optimal, I thought the HTML looked ok.
I'll fix them up as suggested.

> There are, unfortunately, a lot of these to fix... I bet it could be done
> with an elisp function, but I don't have time to beat my head against that
> wall right now.

oh really? That would actually make doing this much more enticing, I've
already done all these multiple times manually - learning nothing, some
elisp games would actually teach me something. Cheers.

> Any chance you would have time to send me a followup patch fixing these
> up? I'll keep my branch with this set for now so there's no need to
> rebase those.

Sure thing, patches to come.

Cheers,
Tobin.