From: Jonathan Corbet <corbet@lwn.net>
To: "Daniel W. S. Almeida" <dwlsalmeida@gmail.com>
Cc: mchehab+samsung@kernel.org, linux-doc@vger.kernel.org,
linux-kernel@vger.kernel.org, skhan@linuxfoundation.org,
linux-kernel-mentees@lists.linuxfoundation.org
Subject: Re: [PATCH 0/5] Documentation: nfs: convert remaining files to ReST.
Date: Fri, 17 Jan 2020 10:32:19 -0700 [thread overview]
Message-ID: <20200117103219.75de4b99@lwn.net> (raw)
In-Reply-To: <cover.1577681894.git.dwlsalmeida@gmail.com>
On Mon, 30 Dec 2019 02:04:42 -0300
"Daniel W. S. Almeida" <dwlsalmeida@gmail.com> wrote:
> This series completes the conversion of Documentation/filesystems/nfs to ReST.
OK, I've made a quick pass through these. They are mostly OK, with a
couple of exceptions. One is that it has the "#." problem in enumerated
lists, which needs to be fixed as was done with the previous set.
And then there is:
> Note that I chose csv-table over list-table because csv files are easier
> to export from other software.
That leads to results that look like this:
> +Operations
> +==========
> +
> +.. csv-table::
> + :header: "Implementation status", "Operation", "REQ, REC, OPT or NMI", "Feature (REQ, REC or OPT)", "Definition"
> + :widths: auto
> + :delim: ;
> +
> + ;"ACCESS";"REQ";;"Section 18.1"
> + "I";"BACKCHANNEL_CTL";"REQ";;"Section 18.33"
> + "I";"BIND_CONN_TO_SESSION";"REQ";;"Section 18.34"
> + ;"CLOSE";"REQ";;"Section 18.2"
> + ;"COMMIT";"REQ";;"Section 18.3"
> + ;"CREATE";"REQ";;"Section 18.4"
...and that is essentially unreadable. Remember that the plain-text
format matters too, so we can't do it this way.
The original is in something fairly close to the RST multicell table
format already; it shouldn't be too hard to add the tweaks needed to make
sphinx happy...?
Thanks,
jon
prev parent reply other threads:[~2020-01-17 17:32 UTC|newest]
Thread overview: 7+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-12-30 5:04 [PATCH 0/5] Documentation: nfs: convert remaining files to ReST Daniel W. S. Almeida
2019-12-30 5:04 ` [PATCH 1/5] Documentation: nfs: convert pnfs.txt " Daniel W. S. Almeida
2019-12-30 5:04 ` [PATCH 2/5] Documentation: nfs: rpc-cache: convert " Daniel W. S. Almeida
2019-12-30 5:04 ` [PATCH 3/5] Documentation: nfs: rpc-server-gss: " Daniel W. S. Almeida
2019-12-30 5:04 ` [PATCH 4/5] Documentation: nfs: nfs41-server: " Daniel W. S. Almeida
2019-12-30 5:04 ` [PATCH 5/5] Documentation: nfs: knfsd-stats: " Daniel W. S. Almeida
2020-01-17 17:32 ` Jonathan Corbet [this message]
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=20200117103219.75de4b99@lwn.net \
--to=corbet@lwn.net \
--cc=dwlsalmeida@gmail.com \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel-mentees@lists.linuxfoundation.org \
--cc=linux-kernel@vger.kernel.org \
--cc=mchehab+samsung@kernel.org \
--cc=skhan@linuxfoundation.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).