[RFC bpf-next v2 0/3] docs: Convert filter.txt to RST
From: Tobin C. Harding
Date: Thu Aug 02 2018 - 18:31:15 EST
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