lkml.org 
[lkml]   [2018]   [Jul]   [26]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
/
From
Subject[PATCH v2 0/4] docs: bpf: Fix RST conversion
Date
Hi Dave,

I'm sending v2 of this to you instead of to Jon. Rationale: BPF is to
do with networking anyways and there is a broken link that requires
conversion of Documentation/networking/filter.txt to fix and that will
go to you. FTR there are no merge conflicts between this set and the
other set I just sent (either can be applied on top of the other)

[PATCH v2 net-next 0/3] docs: net: Convert netdev-FAQ to RST


Recently BPF docs were converted to RST format. A couple of things were
missed.

- Use 'index.rst' instead of 'README.rst'. Although README.rst will
work just fine it is more typical to keep the subdirectory indices
in a file called 'index.rst'.

- Integrate files Documentation/bpf/*.rst into build system using
toctree in Documentation/bpf/index.rst

- Include bpf/index in top level toctree so bpf is indexed in the main
kernel docs.

- Make anal change to heading format (inline with rest of Documentation/).


thanks,
Tobin.

v2:
- Fix typo in commit log s/us/use (thanks Sergei)


Tobin C. Harding (4):
docs: bpf: Rename README.rst to index.rst
docs: bpf: Add toctree to index
docs: Add bpf/index to top level index
docs: bpf: Capitalise document heading

Documentation/bpf/{README.rst => index.rst} | 10 +++++-----
Documentation/index.rst | 1 +
2 files changed, 6 insertions(+), 5 deletions(-)
rename Documentation/bpf/{README.rst => index.rst} (82%)

--
2.17.1

\
 
 \ /
  Last update: 2018-07-26 07:04    [W:0.076 / U:0.180 seconds]
©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site