From: Jonathan Corbet <corbet@lwn.net>
To: "Tobin C. Harding" <me@tobin.cc>
Cc: Daniel Borkmann <daniel@iogearbox.net>,
Alexei Starovoitov <ast@kernel.org>,
"David S. Miller" <davem@davemloft.net>,
linux-doc@vger.kernel.org, netdev@vger.kernel.org,
linux-kernel@vger.kernel.org
Subject: Re: [RFC bpf-next v2 3/3] docs: Split filter.txt into separate documents.
Date: Tue, 7 Aug 2018 07:14:05 -0600 [thread overview]
Message-ID: <20180807071405.58d38277@lwn.net> (raw)
In-Reply-To: <20180807024844.GW3088@eros>
On Tue, 7 Aug 2018 12:48:44 +1000
"Tobin C. Harding" <me@tobin.cc> 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
next prev parent reply other threads:[~2018-08-07 13:14 UTC|newest]
Thread overview: 8+ messages / expand[flat|nested] mbox.gz Atom feed top
2018-08-02 22:30 [RFC bpf-next v2 0/3] docs: Convert filter.txt to RST Tobin C. Harding
2018-08-02 22:30 ` [RFC bpf-next v2 1/3] docs: net: Fix various minor typos Tobin C. Harding
2018-08-02 22:30 ` [RFC bpf-next v2 2/3] docs: net: Use lowercase 'k' for kernel Tobin C. Harding
2018-08-02 22:31 ` [RFC bpf-next v2 3/3] docs: Split filter.txt into separate documents Tobin C. Harding
2018-08-03 13:08 ` Jonathan Corbet
2018-08-07 2:48 ` Tobin C. Harding
2018-08-07 13:14 ` Jonathan Corbet [this message]
2018-08-07 23:19 ` Tobin C. Harding
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=20180807071405.58d38277@lwn.net \
--to=corbet@lwn.net \
--cc=ast@kernel.org \
--cc=daniel@iogearbox.net \
--cc=davem@davemloft.net \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=me@tobin.cc \
--cc=netdev@vger.kernel.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).