linux-doc.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: "Tobin C. Harding" <me@tobin.cc>
To: Daniel Borkmann <daniel@iogearbox.net>,
	Alexei Starovoitov <ast@kernel.org>
Cc: "Tobin C. Harding" <me@tobin.cc>,
	Jonathan Corbet <corbet@lwn.net>,
	"David S. Miller" <davem@davemloft.net>,
	linux-doc@vger.kernel.org, netdev@vger.kernel.org,
	linux-kernel@vger.kernel.org
Subject: [RFC bpf-next v2 0/3] docs: Convert filter.txt to RST
Date: Fri,  3 Aug 2018 08:30:57 +1000	[thread overview]
Message-ID: <20180802223100.26236-1-me@tobin.cc> (raw)

Hi,

v2 new and improved (with the actual files committed).

This is a documentation RFC for two reasons

1. The content is heavy and I don't fully understand it all, original
   authors are you ok with the document being split up like this?

2. I'm only the conversion monkey, I'd like someone with a bigger view
   of kernel docs in general to ok this please.

This RFC came out of this patch set

	[PATCH bpf-next 00/13] docs: Convert BPF filter.txt to RST

As such the first two patches are the only ones I could salvage from
that set.  Stating the obvious the mappings are:

Patch 1 was [PATCH bpf-next 12/13] docs: net: Fix various minor typos
Patch 2 was [PATCH bpf-next 09/13] docs: net: Use lowercase 'k' for kernel

Patch 3 is the splitting of filter.txt into bpf/eBPF.rst and
core-api/bpf.rst 

Again, stating the obvious, if this RFC is ok I'll redo all the other
patches from the original set on top of this.


thanks,
Tobin.

v2:
 - Actually add the files to the commit
 - Check the _whole_ patch before sending
 - Use checkpatch like we are supposed to
 - Add licences

Tobin C. Harding (3):
  docs: net: Fix various minor typos
  docs: net: Use lowercase 'k' for kernel
  docs: Split filter.txt into separate documents.

 .../{networking/filter.txt => bpf/eBPF.rst}   | 648 ++----------------
 Documentation/core-api/bpf.rst                | 599 ++++++++++++++++
 2 files changed, 643 insertions(+), 604 deletions(-)
 rename Documentation/{networking/filter.txt => bpf/eBPF.rst} (60%)
 create mode 100644 Documentation/core-api/bpf.rst

-- 
2.17.1

--
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

             reply	other threads:[~2018-08-02 22:31 UTC|newest]

Thread overview: 8+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2018-08-02 22:30 Tobin C. Harding [this message]
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
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=20180802223100.26236-1-me@tobin.cc \
    --to=me@tobin.cc \
    --cc=ast@kernel.org \
    --cc=corbet@lwn.net \
    --cc=daniel@iogearbox.net \
    --cc=davem@davemloft.net \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --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).