Commit c8caa0bb authored by Quentin Monnet's avatar Quentin Monnet Committed by Daniel Borkmann
Browse files

tools, bpftool: Minor fixes for documentation 



Bring minor improvements to bpftool documentation. Fix or harmonise
formatting, update map types (including in interactive help), improve
description for "map create", fix a build warning due to a missing line
after the double-colon for the "bpftool prog profile" example,
complete/harmonise/sort the list of related bpftool man pages in
footers.

v2:
- Remove (instead of changing) mark-up on "value" in bpftool-map.rst,
  when it does not refer to something passed on the command line.
- Fix an additional typo ("hexadeximal") in the same file.

Signed-off-by: default avatarQuentin Monnet <quentin@isovalent.com>
Signed-off-by: default avatarDaniel Borkmann <daniel@iogearbox.net>
Link: https://lore.kernel.org/bpf/20200511161536.29853-3-quentin@isovalent.com
parent 6e7e034e

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

+8 −3
Original line number Diff line number Diff line
@@ -230,9 +230,14 @@ SEE ALSO 
	**bpf**\ (2),

	**bpf-helpers**\ (7),

	**bpftool**\ (8),

	**bpftool-map**\ (8),

	**bpftool-prog**\ (8),

	**bpftool-btf**\ (8),

	**bpftool-cgroup**\ (8),

	**bpftool-feature**\ (8),

	**bpftool-gen**\ (8),

	**bpftool-iter**\ (8),

	**bpftool-link**\ (8),

	**bpftool-map**\ (8),

	**bpftool-net**\ (8),

	**bpftool-perf**\ (8)
 
	**bpftool-perf**\ (8),

	**bpftool-prog**\ (8),

	**bpftool-struct_ops**\ (8)

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

+8 −4
Original line number Diff line number Diff line
@@ -20,7 +20,7 @@ SYNOPSIS 
CGROUP COMMANDS

===============



|	**bpftool** **cgroup { show | list }** *CGROUP* [**effective**]

|	**bpftool** **cgroup** { **show** | **list** } *CGROUP* [**effective**]

|	**bpftool** **cgroup tree** [*CGROUP_ROOT*] [**effective**]

|	**bpftool** **cgroup attach** *CGROUP* *ATTACH_TYPE* *PROG* [*ATTACH_FLAGS*]

|	**bpftool** **cgroup detach** *CGROUP* *ATTACH_TYPE* *PROG*
@@ -160,9 +160,13 @@ SEE ALSO 
	**bpf**\ (2),

	**bpf-helpers**\ (7),

	**bpftool**\ (8),

	**bpftool-prog**\ (8),

	**bpftool-map**\ (8),

	**bpftool-btf**\ (8),

	**bpftool-feature**\ (8),

	**bpftool-gen**\ (8),

	**bpftool-iter**\ (8),

	**bpftool-link**\ (8),

	**bpftool-map**\ (8),

	**bpftool-net**\ (8),

	**bpftool-perf**\ (8),

	**bpftool-btf**\ (8)
 
	**bpftool-prog**\ (8),

	**bpftool-struct_ops**\ (8)

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

+8 −4
Original line number Diff line number Diff line
@@ -28,7 +28,7 @@ DESCRIPTION 
===========

	**bpftool feature probe** [**kernel**] [**full**] [**macros** [**prefix** *PREFIX*]]

		  Probe the running kernel and dump a number of eBPF-related

		  parameters, such as availability of the **bpf()** system call,

		  parameters, such as availability of the **bpf**\ () system call,

		  JIT status, eBPF program types availability, eBPF helper

		  functions availability, and more.
@@ -93,9 +93,13 @@ SEE ALSO 
	**bpf**\ (2),

	**bpf-helpers**\ (7),

	**bpftool**\ (8),

	**bpftool-prog**\ (8),

	**bpftool-map**\ (8),

	**bpftool-btf**\ (8),

	**bpftool-cgroup**\ (8),

	**bpftool-gen**\ (8),

	**bpftool-iter**\ (8),

	**bpftool-link**\ (8),

	**bpftool-map**\ (8),

	**bpftool-net**\ (8),

	**bpftool-perf**\ (8),

	**bpftool-btf**\ (8)
 
	**bpftool-prog**\ (8),

	**bpftool-struct_ops**\ (8)

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

+12 −9
Original line number Diff line number Diff line
@@ -14,7 +14,7 @@ SYNOPSIS 


	*OPTIONS* := { { **-j** | **--json** } [{ **-p** | **--pretty** }] }



	*COMMAND* := { **skeleton | **help** }

	*COMMAND* := { **skeleton** | **help** }



GEN COMMANDS

=============
@@ -36,12 +36,12 @@ DESCRIPTION 
		  etc. Skeleton eliminates the need to lookup mentioned

		  components by name. Instead, if skeleton instantiation

		  succeeds, they are populated in skeleton structure as valid

		  libbpf types (e.g., struct bpf_map pointer) and can be

		  libbpf types (e.g., **struct bpf_map** pointer) and can be

		  passed to existing generic libbpf APIs.



		  In addition to simple and reliable access to maps and

		  programs, skeleton provides a storage for BPF links (struct

		  bpf_link) for each BPF program within BPF object. When

		  programs, skeleton provides a storage for BPF links (**struct

		  bpf_link**) for each BPF program within BPF object. When

		  requested, supported BPF programs will be automatically

		  attached and resulting BPF links stored for further use by

		  user in pre-allocated fields in skeleton struct. For BPF
@@ -82,14 +82,14 @@ DESCRIPTION 


		  - **example__open** and **example__open_opts**.

		    These functions are used to instantiate skeleton. It

		    corresponds to libbpf's **bpf_object__open()** API.

		    corresponds to libbpf's **bpf_object__open**\ () API.

		    **_opts** variants accepts extra **bpf_object_open_opts**

		    options.



		  - **example__load**.

		    This function creates maps, loads and verifies BPF

		    programs, initializes global data maps. It corresponds to

		    libppf's **bpf_object__load** API.

		    libppf's **bpf_object__load**\ () API.



		  - **example__open_and_load** combines **example__open** and

		    **example__load** invocations in one commonly used
@@ -296,10 +296,13 @@ SEE ALSO 
	**bpf**\ (2),

	**bpf-helpers**\ (7),

	**bpftool**\ (8),

	**bpftool-map**\ (8),

	**bpftool-prog**\ (8),

	**bpftool-btf**\ (8),

	**bpftool-cgroup**\ (8),

	**bpftool-feature**\ (8),

	**bpftool-iter**\ (8),

	**bpftool-link**\ (8),

	**bpftool-map**\ (8),

	**bpftool-net**\ (8),

	**bpftool-perf**\ (8),

	**bpftool-btf**\ (8)
 
	**bpftool-prog**\ (8),

	**bpftool-struct_ops**\ (8)

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

+5 −7
Original line number Diff line number Diff line
@@ -22,7 +22,6 @@ ITER COMMANDS 
|

|	*OBJ* := /a/file/of/bpf_iter_target.o





DESCRIPTION

===========

	**bpftool iter pin** *OBJ* *PATH*
@@ -65,19 +64,18 @@ EXAMPLES 
   Create a file-based bpf iterator from bpf_iter_netlink.o and pin it

   to /sys/fs/bpf/my_netlink





SEE ALSO

========

	**bpf**\ (2),

	**bpf-helpers**\ (7),

	**bpftool**\ (8),

	**bpftool-prog**\ (8),

	**bpftool-map**\ (8),

	**bpftool-link**\ (8),

	**bpftool-btf**\ (8),

	**bpftool-cgroup**\ (8),

	**bpftool-feature**\ (8),

	**bpftool-gen**\ (8),

	**bpftool-link**\ (8),

	**bpftool-map**\ (8),

	**bpftool-net**\ (8),

	**bpftool-perf**\ (8),

	**bpftool-btf**\ (8)

	**bpftool-gen**\ (8)

	**bpftool-prog**\ (8),

	**bpftool-struct_ops**\ (8)

CRA Git | Maintained and supported by SUSTech CRA and CCSE