Messages in this thread | | | From | "Tobin C. Harding" <> | Subject | [PATCH 0/4] docs: bpf: Fix RST conversion | Date | Wed, 25 Jul 2018 12:29:22 +1000 |
| |
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.
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
| |