From d9b9170a26536e9bfe2994d60925e10d16d411dc Mon Sep 17 00:00:00 2001 From: "Tobin C. Harding" Date: Thu, 26 Jul 2018 15:03:02 +1000 Subject: docs: bpf: Rename README.rst to index.rst Recently bpf/ docs were converted to use RST format. 'README.rst' was created but in order to fit in with the Sphinx build system this file should be named 'index.rst'. Rename file, fixes to integrate into Sphinx build system in following patches. docs: Rename Documentation/bpf/README.rst to Documentation/bpf/index.rst Signed-off-by: Tobin C. Harding Signed-off-by: Daniel Borkmann --- Documentation/bpf/README.rst | 36 ------------------------------------ Documentation/bpf/index.rst | 36 ++++++++++++++++++++++++++++++++++++ 2 files changed, 36 insertions(+), 36 deletions(-) delete mode 100644 Documentation/bpf/README.rst create mode 100644 Documentation/bpf/index.rst (limited to 'Documentation/bpf') diff --git a/Documentation/bpf/README.rst b/Documentation/bpf/README.rst deleted file mode 100644 index b9a80c9e9392..000000000000 --- a/Documentation/bpf/README.rst +++ /dev/null @@ -1,36 +0,0 @@ -================= -BPF documentation -================= - -This directory contains documentation for the BPF (Berkeley Packet -Filter) facility, with a focus on the extended BPF version (eBPF). - -This kernel side documentation is still work in progress. The main -textual documentation is (for historical reasons) described in -`Documentation/networking/filter.txt`_, which describe both classical -and extended BPF instruction-set. -The Cilium project also maintains a `BPF and XDP Reference Guide`_ -that goes into great technical depth about the BPF Architecture. - -The primary info for the bpf syscall is available in the `man-pages`_ -for `bpf(2)`_. - - - -Frequently asked questions (FAQ) -================================ - -Two sets of Questions and Answers (Q&A) are maintained. - -* QA for common questions about BPF see: bpf_design_QA_ - -* QA for developers interacting with BPF subsystem: 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 -.. _BPF and XDP Reference Guide: http://cilium.readthedocs.io/en/latest/bpf/ diff --git a/Documentation/bpf/index.rst b/Documentation/bpf/index.rst new file mode 100644 index 000000000000..b9a80c9e9392 --- /dev/null +++ b/Documentation/bpf/index.rst @@ -0,0 +1,36 @@ +================= +BPF documentation +================= + +This directory contains documentation for the BPF (Berkeley Packet +Filter) facility, with a focus on the extended BPF version (eBPF). + +This kernel side documentation is still work in progress. The main +textual documentation is (for historical reasons) described in +`Documentation/networking/filter.txt`_, which describe both classical +and extended BPF instruction-set. +The Cilium project also maintains a `BPF and XDP Reference Guide`_ +that goes into great technical depth about the BPF Architecture. + +The primary info for the bpf syscall is available in the `man-pages`_ +for `bpf(2)`_. + + + +Frequently asked questions (FAQ) +================================ + +Two sets of Questions and Answers (Q&A) are maintained. + +* QA for common questions about BPF see: bpf_design_QA_ + +* QA for developers interacting with BPF subsystem: 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 +.. _BPF and XDP Reference Guide: http://cilium.readthedocs.io/en/latest/bpf/ -- cgit v1.2.3-58-ga151 From b3d40f63d20bbaf78c6b6e9112cde604135e30e0 Mon Sep 17 00:00:00 2001 From: "Tobin C. Harding" Date: Thu, 26 Jul 2018 15:03:03 +1000 Subject: docs: bpf: Add toctree to index Recently bpf/ docs were converted to us RST format. bp/index.rst was created out of README but toctree was not added to include files within Documentation/bpf/ Add toctree to Documentation/bpf/index.rst Signed-off-by: Tobin C. Harding Signed-off-by: Daniel Borkmann --- Documentation/bpf/index.rst | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) (limited to 'Documentation/bpf') diff --git a/Documentation/bpf/index.rst b/Documentation/bpf/index.rst index b9a80c9e9392..ab2ff13a809b 100644 --- a/Documentation/bpf/index.rst +++ b/Documentation/bpf/index.rst @@ -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 -- cgit v1.2.3-58-ga151 From 6919bcc8aa2755be934d38bb7d8d7aee14b27e1d Mon Sep 17 00:00:00 2001 From: "Tobin C. Harding" Date: Thu, 26 Jul 2018 15:03:05 +1000 Subject: docs: bpf: Capitalise document heading The majority of files in the kernel documentation index use capitalisation for all words, especially the shorter ones. BPF docs better fit in with the rest of the documentation if the heading is all capitalised. Capitalise document heading. Signed-off-by: Tobin C. Harding Signed-off-by: Daniel Borkmann --- Documentation/bpf/index.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'Documentation/bpf') diff --git a/Documentation/bpf/index.rst b/Documentation/bpf/index.rst index ab2ff13a809b..00a8450a602f 100644 --- a/Documentation/bpf/index.rst +++ b/Documentation/bpf/index.rst @@ -1,5 +1,5 @@ ================= -BPF documentation +BPF Documentation ================= This directory contains documentation for the BPF (Berkeley Packet -- cgit v1.2.3-58-ga151