bpftool: Work-around rst2man conversion bug (dacce641) · Commits · 戴 / test

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: ("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

tools/bpf/bpftool/Documentation/bpftool-gen.rst

+8 −7

Original line number	Diff line number	Diff line
		@@ -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.

Admin message