summaryrefslogtreecommitdiff
path: root/tools/bpf
diff options
context:
space:
mode:
authorAndrii Nakryiko <andriin@fb.com>2019-12-18 14:17:07 -0800
committerAlexei Starovoitov <ast@kernel.org>2019-12-18 17:03:52 -0800
commitdacce6412e09b5dce19514e2c4e2a8aab0eb217f (patch)
treefb10d14d7a49877e5518b923f579405abe7fd960 /tools/bpf
parent7c43e0d6a526e7734eb854fe242886f52ccd06ac (diff)
bpftool: Work-around rst2man conversion bug
Work-around what appears to be a bug in rst2man convertion tool, used to create man pages out of reStructureText-formatted documents. If text line starts with dot, rst2man will put it in resulting man file verbatim. This seems to cause man tool to interpret it as a directive/command (e.g., `.bs`), and subsequently not render entire line because it's unrecognized one. Enclose '.xxx' words in extra formatting to work around. Fixes: cb21ac588546 ("bpftool: Add gen subcommand manpage") Reported-by: Alexei Starovoitov <ast@kernel.org> Signed-off-by: Andrii Nakryiko <andriin@fb.com> Signed-off-by: Alexei Starovoitov <ast@kernel.org> Acked-by: Yonghong Song <yhs@fb.com Link: https://lore.kernel.org/bpf/20191218221707.2552199-1-andriin@fb.com
Diffstat (limited to 'tools/bpf')
-rw-r--r--tools/bpf/bpftool/Documentation/bpftool-gen.rst15
1 files changed, 8 insertions, 7 deletions
diff --git a/tools/bpf/bpftool/Documentation/bpftool-gen.rst b/tools/bpf/bpftool/Documentation/bpftool-gen.rst
index b6a114bf908d..86a87da97d0b 100644
--- a/tools/bpf/bpftool/Documentation/bpftool-gen.rst
+++ b/tools/bpf/bpftool/Documentation/bpftool-gen.rst
@@ -112,13 +112,14 @@ DESCRIPTION
If BPF object has global variables, corresponding structs
with memory layout corresponding to global data data section
- layout will be created. Currently supported ones are: .data,
- .bss, .rodata, and .extern structs/data sections. These
- data sections/structs can be used to set up initial values of
- variables, if set before **example__load**. Afterwards, if
- target kernel supports memory-mapped BPF arrays, same
- structs can be used to fetch and update (non-read-only)
- data from userspace, with same simplicity as for BPF side.
+ layout will be created. Currently supported ones are: *.data*,
+ *.bss*, *.rodata*, and *.kconfig* structs/data sections.
+ These data sections/structs can be used to set up initial
+ values of variables, if set before **example__load**.
+ Afterwards, if target kernel supports memory-mapped BPF
+ arrays, same structs can be used to fetch and update
+ (non-read-only) data from userspace, with same simplicity
+ as for BPF side.
**bpftool gen help**
Print short help message.