Commit dacce641 authored by Andrii Nakryiko's avatar Andrii Nakryiko Committed by Alexei Starovoitov

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: cb21ac58 ("bpftool: Add gen subcommand manpage")
Reported-by: default avatarAlexei Starovoitov <ast@kernel.org>
Signed-off-by: default avatarAndrii Nakryiko <andriin@fb.com>
Signed-off-by: default avatarAlexei Starovoitov <ast@kernel.org>
Acked-by: Yonghong Song <yhs@fb.com
Link: https://lore.kernel.org/bpf/20191218221707.2552199-1-andriin@fb.com
parent 7c43e0d6
...@@ -112,13 +112,14 @@ DESCRIPTION ...@@ -112,13 +112,14 @@ DESCRIPTION
If BPF object has global variables, corresponding structs If BPF object has global variables, corresponding structs
with memory layout corresponding to global data data section with memory layout corresponding to global data data section
layout will be created. Currently supported ones are: .data, layout will be created. Currently supported ones are: *.data*,
.bss, .rodata, and .extern structs/data sections. These *.bss*, *.rodata*, and *.kconfig* structs/data sections.
data sections/structs can be used to set up initial values of These data sections/structs can be used to set up initial
variables, if set before **example__load**. Afterwards, if values of variables, if set before **example__load**.
target kernel supports memory-mapped BPF arrays, same Afterwards, if target kernel supports memory-mapped BPF
structs can be used to fetch and update (non-read-only) arrays, same structs can be used to fetch and update
data from userspace, with same simplicity as for BPF side. (non-read-only) data from userspace, with same simplicity
as for BPF side.
**bpftool gen help** **bpftool gen help**
Print short help message. Print short help message.
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment