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 <daniel@iogearbox.net>
This commit is contained in:
commit
2e96187b69
|
@ -1,5 +1,5 @@
|
||||||
=================
|
=================
|
||||||
BPF documentation
|
BPF Documentation
|
||||||
=================
|
=================
|
||||||
|
|
||||||
This directory contains documentation for the BPF (Berkeley Packet
|
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.
|
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:
|
.. Links:
|
||||||
.. _bpf_design_QA: bpf_design_QA.rst
|
|
||||||
.. _bpf_devel_QA: bpf_devel_QA.rst
|
|
||||||
.. _Documentation/networking/filter.txt: ../networking/filter.txt
|
.. _Documentation/networking/filter.txt: ../networking/filter.txt
|
||||||
.. _man-pages: https://www.kernel.org/doc/man-pages/
|
.. _man-pages: https://www.kernel.org/doc/man-pages/
|
||||||
.. _bpf(2): http://man7.org/linux/man-pages/man2/bpf.2.html
|
.. _bpf(2): http://man7.org/linux/man-pages/man2/bpf.2.html
|
|
@ -90,6 +90,7 @@ needed).
|
||||||
crypto/index
|
crypto/index
|
||||||
filesystems/index
|
filesystems/index
|
||||||
vm/index
|
vm/index
|
||||||
|
bpf/index
|
||||||
|
|
||||||
Architecture-specific documentation
|
Architecture-specific documentation
|
||||||
-----------------------------------
|
-----------------------------------
|
||||||
|
|
Loading…
Reference in New Issue