]> git.baikalelectronics.ru Git - kernel.git/commit
bpf, doc: convert bpf_design_QA.rst to use RST formatting
authorJesper Dangaard Brouer <brouer@redhat.com>
Mon, 14 May 2018 13:42:22 +0000 (15:42 +0200)
committerAlexei Starovoitov <ast@kernel.org>
Tue, 15 May 2018 06:02:58 +0000 (23:02 -0700)
commit498d14c3a41d9addebb79264afa46e32cfc0299b
tree8e554e07b6e3877b8984f62485e7abe834692613
parentd15faba1199bb7e39a3f12abbc04a6500e97926d
bpf, doc: convert bpf_design_QA.rst to use RST formatting

The RST formatting is done such that that when rendered or converted
to different formats, an automatic index with links are created to the
subsections.

Thus, the questions are created as sections (or subsections), in-order
to get the wanted auto-generated FAQ/QA index.

Special thanks to Quentin Monnet <quentin.monnet@netronome.com> who
have reviewed and corrected both RST formatting and GitHub rendering
issues in this file.  Those commits have been squashed.

I've manually tested that this also renders nicely if included as part
of the kernel 'make htmldocs'.  As the end-goal is for this to become
more integrated with kernel-doc project/movement.

Signed-off-by: Jesper Dangaard Brouer <brouer@redhat.com>
Signed-off-by: Alexei Starovoitov <ast@kernel.org>
Documentation/bpf/bpf_design_QA.rst