diff options
| author | Daniel Borkmann <[email protected]> | 2018-07-27 07:23:49 +0200 |
|---|---|---|
| committer | Daniel Borkmann <[email protected]> | 2018-07-27 07:23:50 +0200 |
| commit | 2e96187b6967227f5b58a2ae599014274e21935e (patch) | |
| tree | 1813e401f7f545ccb9012f7c3c6538e84ae4113e | |
| parent | 54b757592fdf310c9b8b3a8ea6cc0ce7cf9af983 (diff) | |
| parent | 6919bcc8aa2755be934d38bb7d8d7aee14b27e1d (diff) | |
Merge branch 'bpf-docs-rst-improvements'
Tobin C. Harding says:
====================
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/).
====================
Signed-off-by: Daniel Borkmann <[email protected]>
| -rw-r--r-- | Documentation/bpf/index.rst (renamed from Documentation/bpf/README.rst) | 10 | ||||
| -rw-r--r-- | Documentation/index.rst | 1 |
2 files changed, 6 insertions, 5 deletions
diff --git a/Documentation/bpf/README.rst b/Documentation/bpf/index.rst index b9a80c9e9392..00a8450a602f 100644 --- a/Documentation/bpf/README.rst +++ b/Documentation/bpf/index.rst @@ -1,5 +1,5 @@ ================= -BPF documentation +BPF Documentation ================= This directory contains documentation for the BPF (Berkeley Packet @@ -22,14 +22,14 @@ Frequently asked questions (FAQ) Two sets of Questions and Answers (Q&A) are maintained. -* QA for common questions about BPF see: bpf_design_QA_ +.. toctree:: + :maxdepth: 1 -* QA for developers interacting with BPF subsystem: bpf_devel_QA_ + bpf_design_QA + bpf_devel_QA .. Links: -.. _bpf_design_QA: bpf_design_QA.rst -.. _bpf_devel_QA: bpf_devel_QA.rst .. _Documentation/networking/filter.txt: ../networking/filter.txt .. _man-pages: https://www.kernel.org/doc/man-pages/ .. _bpf(2): http://man7.org/linux/man-pages/man2/bpf.2.html diff --git a/Documentation/index.rst b/Documentation/index.rst index fdc585703498..086710b054db 100644 --- a/Documentation/index.rst +++ b/Documentation/index.rst @@ -90,6 +90,7 @@ needed). crypto/index filesystems/index vm/index + bpf/index Architecture-specific documentation ----------------------------------- |