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

From: Jonathan Corbet
Date: Tue Aug 07 2018 - 09:14:09 EST

On Tue, 7 Aug 2018 12:48:44 +1000
"Tobin C. Harding" <me@xxxxxxxx> 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!