bpftool: Work-around rst2man conversion bug
authorAndrii Nakryiko <andriin@fb.com>
Wed, 18 Dec 2019 22:17:07 +0000 (14:17 -0800)
committerAlexei Starovoitov <ast@kernel.org>
Thu, 19 Dec 2019 01:03:52 +0000 (17:03 -0800)
commitdacce6412e09b5dce19514e2c4e2a8aab0eb217f
treefb10d14d7a49877e5518b923f579405abe7fd960
parent7c43e0d6a526e7734eb854fe242886f52ccd06ac
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
tools/bpf/bpftool/Documentation/bpftool-gen.rst