diff options
author | Quentin Monnet <quentin.monnet@netronome.com> | 2017-10-23 12:24:15 -0400 |
---|---|---|
committer | David S. Miller <davem@davemloft.net> | 2017-10-23 20:25:09 -0400 |
commit | 47ff7ac6d706c6f08153294c87287aeec183b211 (patch) | |
tree | 4f606ec99e1c23e8f8373fd0bd90cad6dcc0ed95 | |
parent | 004b45c0e51a8b6f20320181a946ba2d1bd3548b (diff) |
tools: bpftool: add cosmetic changes for the manual pages
Make the look-and-feel of the manual pages somewhat closer to other
manual pages, such as the ones from the utilities from iproute2, by
highlighting more keywords.
Signed-off-by: Quentin Monnet <quentin.monnet@netronome.com>
Acked-by: Jakub Kicinski <jakub.kicinski@netronome.com>
Acked-by: Daniel Borkmann <daniel@iogearbox.net>
Signed-off-by: David S. Miller <davem@davemloft.net>
-rw-r--r-- | tools/bpf/bpftool/Documentation/bpftool-map.rst | 25 | ||||
-rw-r--r-- | tools/bpf/bpftool/Documentation/bpftool-prog.rst | 12 | ||||
-rw-r--r-- | tools/bpf/bpftool/Documentation/bpftool.rst | 12 |
3 files changed, 26 insertions, 23 deletions
diff --git a/tools/bpf/bpftool/Documentation/bpftool-map.rst b/tools/bpf/bpftool/Documentation/bpftool-map.rst index 5210c4fab356..3954b3ea4f26 100644 --- a/tools/bpf/bpftool/Documentation/bpftool-map.rst +++ b/tools/bpf/bpftool/Documentation/bpftool-map.rst | |||
@@ -13,23 +13,24 @@ SYNOPSIS | |||
13 | **bpftool** **map** *COMMAND* | 13 | **bpftool** **map** *COMMAND* |
14 | 14 | ||
15 | *COMMANDS* := | 15 | *COMMANDS* := |
16 | { show | dump | update | lookup | getnext | delete | pin | help } | 16 | { **show** | **dump** | **update** | **lookup** | **getnext** | **delete** |
17 | | **pin** | **help** } | ||
17 | 18 | ||
18 | MAP COMMANDS | 19 | MAP COMMANDS |
19 | ============= | 20 | ============= |
20 | 21 | ||
21 | | **bpftool** map show [*MAP*] | 22 | | **bpftool** **map show** [*MAP*] |
22 | | **bpftool** map dump *MAP* | 23 | | **bpftool** **map dump** *MAP* |
23 | | **bpftool** map update *MAP* key *BYTES* value *VALUE* [*UPDATE_FLAGS*] | 24 | | **bpftool** **map update** *MAP* **key** *BYTES* **value** *VALUE* [*UPDATE_FLAGS*] |
24 | | **bpftool** map lookup *MAP* key *BYTES* | 25 | | **bpftool** **map lookup** *MAP* **key** *BYTES* |
25 | | **bpftool** map getnext *MAP* [key *BYTES*] | 26 | | **bpftool** **map getnext** *MAP* [**key** *BYTES*] |
26 | | **bpftool** map delete *MAP* key *BYTES* | 27 | | **bpftool** **map delete** *MAP* **key** *BYTES* |
27 | | **bpftool** map pin *MAP* *FILE* | 28 | | **bpftool** **map pin** *MAP* *FILE* |
28 | | **bpftool** map help | 29 | | **bpftool** **map help** |
29 | | | 30 | | |
30 | | *MAP* := { id MAP_ID | pinned FILE } | 31 | | *MAP* := { **id** *MAP_ID* | **pinned** *FILE* } |
31 | | *VALUE* := { BYTES | MAP | PROGRAM } | 32 | | *VALUE* := { *BYTES* | *MAP* | *PROGRAM* } |
32 | | *UPDATE_FLAGS* := { any | exist | noexist } | 33 | | *UPDATE_FLAGS* := { **any** | **exist** | **noexist** } |
33 | 34 | ||
34 | DESCRIPTION | 35 | DESCRIPTION |
35 | =========== | 36 | =========== |
diff --git a/tools/bpf/bpftool/Documentation/bpftool-prog.rst b/tools/bpf/bpftool/Documentation/bpftool-prog.rst index 6620a81d9dc9..685a19e71fec 100644 --- a/tools/bpf/bpftool/Documentation/bpftool-prog.rst +++ b/tools/bpf/bpftool/Documentation/bpftool-prog.rst | |||
@@ -10,13 +10,13 @@ tool for inspection and simple manipulation of eBPF progs | |||
10 | SYNOPSIS | 10 | SYNOPSIS |
11 | ======== | 11 | ======== |
12 | 12 | ||
13 | | **bpftool** prog show [*PROG*] | 13 | | **bpftool** **prog show** [*PROG*] |
14 | | **bpftool** prog dump xlated *PROG* [{file *FILE* | opcodes }] | 14 | | **bpftool** **prog dump xlated** *PROG* [{**file** *FILE* | **opcodes**}] |
15 | | **bpftool** prog dump jited *PROG* [{file *FILE* | opcodes }] | 15 | | **bpftool** **prog dump jited** *PROG* [{**file** *FILE* | **opcodes**}] |
16 | | **bpftool** prog pin *PROG* *FILE* | 16 | | **bpftool** **prog pin** *PROG* *FILE* |
17 | | **bpftool** prog help | 17 | | **bpftool** **prog help** |
18 | | | 18 | | |
19 | | *PROG* := { id *PROG_ID* | pinned *FILE* | tag *PROG_TAG* } | 19 | | *PROG* := { **id** *PROG_ID* | **pinned** *FILE* | **tag** *PROG_TAG* } |
20 | 20 | ||
21 | DESCRIPTION | 21 | DESCRIPTION |
22 | =========== | 22 | =========== |
diff --git a/tools/bpf/bpftool/Documentation/bpftool.rst b/tools/bpf/bpftool/Documentation/bpftool.rst index 9c04cd6677bd..44e07799d54d 100644 --- a/tools/bpf/bpftool/Documentation/bpftool.rst +++ b/tools/bpf/bpftool/Documentation/bpftool.rst | |||
@@ -10,18 +10,20 @@ tool for inspection and simple manipulation of eBPF programs and maps | |||
10 | SYNOPSIS | 10 | SYNOPSIS |
11 | ======== | 11 | ======== |
12 | 12 | ||
13 | **bpftool** *OBJECT* { *COMMAND* | help } | 13 | **bpftool** *OBJECT* { *COMMAND* | **help** } |
14 | 14 | ||
15 | **bpftool** batch file *FILE* | 15 | **bpftool** **batch file** *FILE* |
16 | 16 | ||
17 | **bpftool** version | 17 | **bpftool** **version** |
18 | 18 | ||
19 | *OBJECT* := { **map** | **program** } | 19 | *OBJECT* := { **map** | **program** } |
20 | 20 | ||
21 | *MAP-COMMANDS* := | 21 | *MAP-COMMANDS* := |
22 | { show | dump | update | lookup | getnext | delete | pin | help } | 22 | { **show** | **dump** | **update** | **lookup** | **getnext** | **delete** |
23 | | **pin** | **help** } | ||
23 | 24 | ||
24 | *PROG-COMMANDS* := { show | dump jited | dump xlated | pin | help } | 25 | *PROG-COMMANDS* := { **show** | **dump jited** | **dump xlated** | **pin** |
26 | | **help** } | ||
25 | 27 | ||
26 | DESCRIPTION | 28 | DESCRIPTION |
27 | =========== | 29 | =========== |