Thread (7 messages) 7 messages, 2 authors, 2020-01-17

Re: [Linux-kernel-mentees] [PATCH 0/5] Documentation: nfs: convert remaining files to ReST.

From: Jonathan Corbet <corbet@lwn.net>
Date: 2020-01-17 17:32:22
Also in: linux-doc, lkml

On Mon, 30 Dec 2019 02:04:42 -0300
"Daniel W. S. Almeida" [off-list ref] 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
_______________________________________________
Linux-kernel-mentees mailing list
Linux-kernel-mentees@lists.linuxfoundation.org
https://lists.linuxfoundation.org/mailman/listinfo/linux-kernel-mentees
Keyboard shortcuts
hback out one level
jnext message in thread
kprevious message in thread
ldrill in
Escclose help / fold thread tree
?toggle this help