]> git.ipfire.org Git - thirdparty/kernel/stable.git/commit
bpftool: Fix documentation about line info display for prog dumps
authorQuentin Monnet <quentin@isovalent.com>
Wed, 5 Apr 2023 13:21:14 +0000 (14:21 +0100)
committerAlexei Starovoitov <ast@kernel.org>
Thu, 6 Apr 2023 04:27:27 +0000 (21:27 -0700)
commite27f0f1620b693ecf312c21ff8a52affb8a5be08
tree4195d21d01af6a6597501082e88c552bc8d912ba
parent5af607a861d43ffff830fc1890033e579ec44799
bpftool: Fix documentation about line info display for prog dumps

The documentation states that when line_info is available when dumping a
program, the source line will be displayed "by default". There is no
notion of "default" here: the line is always displayed if available,
there is no way currently to turn it off.

In the next sentence, the documentation states that if "linum" is used
on the command line, the relevant filename, line, and column will be
displayed "on top of the source line". This is incorrect, as they are
currently displayed on the right side of the source line (or on top of
the eBPF instruction, not the source).

This commit fixes the documentation to address these points.

Signed-off-by: Quentin Monnet <quentin@isovalent.com>
Link: https://lore.kernel.org/r/20230405132120.59886-2-quentin@isovalent.com
Signed-off-by: Alexei Starovoitov <ast@kernel.org>
tools/bpf/bpftool/Documentation/bpftool-prog.rst