mirror of
https://git.kernel.org/pub/scm/linux/kernel/git/stable/linux.git
synced 2025-01-01 10:45:49 +00:00
f7b6854364
The rST manual pages for bpftool would use a mix of tabs and spaces for indentation. While this is the norm in C code, this is rather unusual for rST documents, and over time we've seen many contributors use a wrong level of indentation for documentation update. Let's fix bpftool's indentation in docs once and for all: - Let's use spaces, that are more common in rST files. - Remove one level of indentation for the synopsis, the command description, and the "see also" section. As a result, all sections start with the same indentation level in the generated man page. - Rewrap the paragraphs after the changes. There is no content change in this patch, only indentation and rewrapping changes. The wrapping in the generated source files for the manual pages is changed, but the pages displayed with "man" remain the same, apart from the adjusted indentation level on relevant sections. [ Quentin: rebased on bpf-next, removed indent level for command description and options, updated synopsis, command summary, and "see also" sections. ] Signed-off-by: Rameez Rehman <rameezrehman408@hotmail.com> Signed-off-by: Quentin Monnet <qmo@kernel.org> Signed-off-by: Daniel Borkmann <daniel@iogearbox.net> Link: https://lore.kernel.org/bpf/20240331200346.29118-2-qmo@kernel.org
24 lines
962 B
ReStructuredText
24 lines
962 B
ReStructuredText
.. SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
|
|
|
|
-h, --help
|
|
Print short help message (similar to **bpftool help**).
|
|
|
|
-V, --version
|
|
Print bpftool's version number (similar to **bpftool version**), the number
|
|
of the libbpf version in use, and optional features that were included when
|
|
bpftool was compiled. Optional features include linking against LLVM or
|
|
libbfd to provide the disassembler for JIT-ted programs (**bpftool prog
|
|
dump jited**) and usage of BPF skeletons (some features like **bpftool prog
|
|
profile** or showing pids associated to BPF objects may rely on it).
|
|
|
|
-j, --json
|
|
Generate JSON output. For commands that cannot produce JSON, this option
|
|
has no effect.
|
|
|
|
-p, --pretty
|
|
Generate human-readable JSON output. Implies **-j**.
|
|
|
|
-d, --debug
|
|
Print all logs available, even debug-level information. This includes logs
|
|
from libbpf as well as from the verifier, when attempting to load programs.
|