18841da981
The "SEE ALSO" sections of bpftool's manual pages refer to bpf(2), bpf-helpers(7), then all existing bpftool man pages (save the current one). This leads to nearly-identical lists being duplicated in all manual pages. Ideally, when a new page is created, all lists should be updated accordingly, but this has led to omissions and inconsistencies multiple times in the past. Let's take it out of the RST files and generate the "SEE ALSO" sections automatically in the Makefile when generating the man pages. The lists are not really useful in the RST anyway because all other pages are available in the same directory. v3: - Fix conflict with a previous patchset that introduced RST2MAN_OPTS variable passed to rst2man. v2: - Use "echo -n" instead of "printf" in Makefile, to avoid any risk of passing a format string directly to the command. Signed-off-by: Quentin Monnet <quentin@isovalent.com> Signed-off-by: Alexei Starovoitov <ast@kernel.org> Acked-by: Andrii Nakryiko <andriin@fb.com> Link: https://lore.kernel.org/bpf/20200910203935.25304-1-quentin@isovalent.com
85 lines
2.3 KiB
ReStructuredText
85 lines
2.3 KiB
ReStructuredText
==================
|
|
bpftool-struct_ops
|
|
==================
|
|
-------------------------------------------------------------------------------
|
|
tool to register/unregister/introspect BPF struct_ops
|
|
-------------------------------------------------------------------------------
|
|
|
|
:Manual section: 8
|
|
|
|
SYNOPSIS
|
|
========
|
|
|
|
**bpftool** [*OPTIONS*] **struct_ops** *COMMAND*
|
|
|
|
*OPTIONS* := { { **-j** | **--json** } [{ **-p** | **--pretty** }] }
|
|
|
|
*COMMANDS* :=
|
|
{ **show** | **list** | **dump** | **register** | **unregister** | **help** }
|
|
|
|
STRUCT_OPS COMMANDS
|
|
===================
|
|
|
|
| **bpftool** **struct_ops { show | list }** [*STRUCT_OPS_MAP*]
|
|
| **bpftool** **struct_ops dump** [*STRUCT_OPS_MAP*]
|
|
| **bpftool** **struct_ops register** *OBJ*
|
|
| **bpftool** **struct_ops unregister** *STRUCT_OPS_MAP*
|
|
| **bpftool** **struct_ops help**
|
|
|
|
|
| *STRUCT_OPS_MAP* := { **id** *STRUCT_OPS_MAP_ID* | **name** *STRUCT_OPS_MAP_NAME* }
|
|
| *OBJ* := /a/file/of/bpf_struct_ops.o
|
|
|
|
|
|
DESCRIPTION
|
|
===========
|
|
**bpftool struct_ops { show | list }** [*STRUCT_OPS_MAP*]
|
|
Show brief information about the struct_ops in the system.
|
|
If *STRUCT_OPS_MAP* is specified, it shows information only
|
|
for the given struct_ops. Otherwise, it lists all struct_ops
|
|
currently existing in the system.
|
|
|
|
Output will start with struct_ops map ID, followed by its map
|
|
name and its struct_ops's kernel type.
|
|
|
|
**bpftool struct_ops dump** [*STRUCT_OPS_MAP*]
|
|
Dump details information about the struct_ops in the system.
|
|
If *STRUCT_OPS_MAP* is specified, it dumps information only
|
|
for the given struct_ops. Otherwise, it dumps all struct_ops
|
|
currently existing in the system.
|
|
|
|
**bpftool struct_ops register** *OBJ*
|
|
Register bpf struct_ops from *OBJ*. All struct_ops under
|
|
the ELF section ".struct_ops" will be registered to
|
|
its kernel subsystem.
|
|
|
|
**bpftool struct_ops unregister** *STRUCT_OPS_MAP*
|
|
Unregister the *STRUCT_OPS_MAP* from the kernel subsystem.
|
|
|
|
**bpftool struct_ops help**
|
|
Print short help message.
|
|
|
|
OPTIONS
|
|
=======
|
|
.. include:: common_options.rst
|
|
|
|
EXAMPLES
|
|
========
|
|
**# bpftool struct_ops show**
|
|
|
|
::
|
|
|
|
100: dctcp tcp_congestion_ops
|
|
105: cubic tcp_congestion_ops
|
|
|
|
**# bpftool struct_ops unregister id 105**
|
|
|
|
::
|
|
|
|
Unregistered tcp_congestion_ops cubic id 105
|
|
|
|
**# bpftool struct_ops register bpf_cubic.o**
|
|
|
|
::
|
|
|
|
Registered tcp_congestion_ops cubic id 110
|