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

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite for Android: free password hash cracker in your pocket

[<prev] [next>] [thread-next>] [day] [month] [year] [list]

Message-Id: <20180801050908.29970-1-me@tobin.cc>
Date:   Wed,  1 Aug 2018 15:08:55 +1000
From:   "Tobin C. Harding" <me@...in.cc>
To:     Daniel Borkmann <daniel@...earbox.net>,
        Alexei Starovoitov <ast@...nel.org>
Cc:     "Tobin C. Harding" <me@...in.cc>, Jonathan Corbet <corbet@....net>,
        "David S. Miller" <davem@...emloft.net>, linux-doc@...r.kernel.org,
        netdev@...r.kernel.org, linux-kernel@...r.kernel.org
Subject: [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%)

-- 
2.17.1