Commit e27f0f16 authored by Quentin Monnet's avatar Quentin Monnet Committed by Alexei Starovoitov
Browse files

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: default avatarQuentin Monnet <quentin@isovalent.com>
Link: https://lore.kernel.org/r/20230405132120.59886-2-quentin@isovalent.com


Signed-off-by: default avatarAlexei Starovoitov <ast@kernel.org>
parent 5af607a8

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

+4 −6
Original line number Diff line number Diff line
@@ -106,9 +106,8 @@ DESCRIPTION 
		  CFG in DOT format, on standard output.



		  If the programs have line_info available, the source line will

		  be displayed by default.  If **linum** is specified,

		  the filename, line number and line column will also be

		  displayed on top of the source line.

		  be displayed.  If **linum** is specified, the filename, line

		  number and line column will also be displayed.



	**bpftool prog dump jited**  *PROG* [{ **file** *FILE* | **opcodes** | **linum** }]

		  Dump jited image (host machine code) of the program.
@@ -120,9 +119,8 @@ DESCRIPTION 
		  **opcodes** controls if raw opcodes will be printed.



		  If the prog has line_info available, the source line will

		  be displayed by default.  If **linum** is specified,

		  the filename, line number and line column will also be

		  displayed on top of the source line.

		  be displayed.  If **linum** is specified, the filename, line

		  number and line column will also be displayed.



	**bpftool prog pin** *PROG* *FILE*

		  Pin program *PROG* as *FILE*.