From mboxrd@z Thu Jan  1 00:00:00 1970
From: Jonathan Corbet <corbet@lwn.net>
Subject: Re: [RFC bpf-next v2 3/3] docs: Split filter.txt into separate
 documents.
Date: Tue, 7 Aug 2018 07:14:05 -0600
Message-ID: <20180807071405.58d38277@lwn.net>
References: <20180802223100.26236-1-me@tobin.cc>
        <20180802223100.26236-4-me@tobin.cc>
        <20180803070818.3d3e52e4@lwn.net>
        <20180807024844.GW3088@eros>
Mime-Version: 1.0
Content-Type: text/plain; charset=US-ASCII
Content-Transfer-Encoding: 8bit
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
To: "Tobin C. Harding" <me@tobin.cc>
Return-path: <linux-kernel-owner@vger.kernel.org>
In-Reply-To: <20180807024844.GW3088@eros>
Sender: linux-kernel-owner@vger.kernel.org
List-Id: netdev.vger.kernel.org

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