Skip to content

docs: Convert BPF filter.txt to RST

Tobin C. Harding linux-doc lkml netdev 1 version In review

Get series with b4
b4 am [email protected]

Versions newest first

  1. v1 Latest13 patches 11 repliesIn review

Patches in v1 No applies recorded yet

#Subject and filesSizeRepliesApplied
1/13docs: net: Rename filter.txt to filter.rstDocumentation/networking/00-INDEX Documentation/networking/filter.rst MAINTAINERS+1 -30 replies
2/13docs: Update references to filter.rstDocumentation/bpf/index.rst Documentation/networking/filter.rst Documentation/networking/packet_mmap.txt +2 more+9 -80 replies
3/13docs: net: Add filter to index toctreeDocumentation/networking/index.rst+1 -02 replies
4/13docs: net: Use correct heading adornmentsDocumentation/networking/filter.rst+21 -150 replies
5/13docs: net: Fix indentation issues for code snippetsDocumentation/networking/filter.rst+398 -3482 replies
6/13docs: net: Remove non-standard identifiersDocumentation/networking/filter.rst+5 -50 replies
7/13docs: net: Use double ticks instead of single quoteDocumentation/networking/filter.rst+49 -510 replies
8/13docs: net: Use double ticks instead of single tickDocumentation/networking/filter.rst+5 -50 replies
9/13docs: net: Use lowercase 'k' for kernelDocumentation/networking/filter.rst+1 -10 replies
10/13docs: net: Embed reference to seccomp_filterDocumentation/networking/filter.rst Documentation/userspace-api/seccomp_filter.rst+8 -60 replies
11/13docs: net: Use correct RST list constructDocumentation/networking/filter.rst+17 -130 replies
12/13docs: net: Fix various minor typosDocumentation/networking/filter.rst+33 -327 replies
13/13docs: net: Fix authors list to render as a listDocumentation/networking/filter.rst+3 -30 replies

Reviews trailers per patch

No Reviewed-by, Acked-by or Tested-by trailers for v1 yet.

Read the v1 thread

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

Hi,

Sending this to BPF maintainers. Recent patch set to Documentation/bpf went through bpf tree so I'm guessing this one will too. I rekon there will be less merge conflicts through your tree. I do not know exactly the path for docs into the mainline or who fixes up merge conflicts though so if this is better done another way please say so.

Patch set applies on top of bpf-next commit: ("2e96187b6967 Merge branch 'bpf-docs-rst-improvements'")

Use of --subject-prefix='PATCH bpf-next' was a guess.

While doing the final read over of this set I realised that perhaps we should have just moved this file to Documentation/bpf?

Anyways, here is the conversion of filter.txt to filter.rst split up into a bunch of patches to ease review. I failed to fully grok the contents of this file so there may be mistakes in the 'Fix various minor tyos' patch.

Also the diff looks like it contains spurious whitespace changes in places, I think this is when spaces have been replaced by tabs. I'm guessing you guys are experienced at reading patches so can tell this already - it took me a bit of thinking :)

Some of the formatting for code snippets is subjective, if you'd like me to change it please say so. In particular I added a line of whitespace before error output in a bunch of the snippets. Also indented slightly differently to the original so it looks okay in HTML. I did not check any other rendered format.

thanks,
Tobin.

Tobin C. Harding (13):
docs: net: Rename filter.txt to filter.rst
docs: Update references to filter.rst
docs: net: Add filter to index toctree
docs: net: Use correct heading adornments
docs: net: Fix indentation issues for code snippets
docs: net: Remove non-standard identifiers
docs: net: Use double ticks instead of single quote
docs: net: Use double ticks instead of single tick
docs: net: Use lowercase 'k' for kernel
docs: net: Embed reference to seccomp_filter
docs: net: Use correct RST list construct
docs: net: Fix various minor typos
docs: net: Fix authors list to render as a list

 Documentation/bpf/index.rst                   |    9 +-
 Documentation/networking/00-INDEX             |    2 -
 .../networking/{filter.txt => filter.rst}     | 1007 +++++++++--------
 Documentation/networking/index.rst            |    1 +
 Documentation/networking/packet_mmap.txt      |    2 +-
 .../userspace-api/seccomp_filter.rst          |    2 +
 MAINTAINERS                                   |    2 +-
 tools/bpf/bpf_asm.c                           |    2 +-
 tools/bpf/bpf_dbg.c                           |    2 +-
 9 files changed, 545 insertions(+), 484 deletions(-)
 rename Documentation/networking/{filter.txt => filter.rst} (69%)
Signature · 1 line
2.17.1