Thread (8 messages) read the whole thread 8 messages, 2 authors, 2018-08-07

Re: [RFC bpf-next v2 3/3] docs: Split filter.txt into separate documents.

From: Jonathan Corbet <corbet@lwn.net>
Date: 2018-08-07 13:14:09
Also in: lkml, netdev

On Tue, 7 Aug 2018 12:48:44 +1000
"Tobin C. Harding" [off-list ref] wrote:
How about these steps:

	1. start with foo.txt
	2. do typo and grammar fixes (any number of patches).
	3. rename to foo.rst, do whitespace changes, code snippet
	   indentation, heading adornments, update references to this file.
	   (single patch).
	4. Fix up references in the file text to use RST (i.e :ref: blah)
	5. Fix up RST markers (backticks etc). (any number of patches)
That can certainly work; just don't call it foo.rst until it actually is a
valid RST file.

And, of course, go easy with the later steps and try to avoid the
temptation to mark up everything; we really want to preserve the
readability of the plain-text files.

Thanks for doing this work!

jon
--
To unsubscribe from this list: send the line "unsubscribe linux-doc" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Keyboard shortcuts
hback out one level
jnext message in thread
kprevious message in thread
ldrill in
Escclose help / fold thread tree
?toggle this help