diff options
| author | Quentin Monnet <quentin.monnet@netronome.com> | 2017-10-23 19:24:15 +0300 |
|---|---|---|
| committer | David S. Miller <davem@davemloft.net> | 2017-10-24 03:25:09 +0300 |
| commit | 47ff7ac6d706c6f08153294c87287aeec183b211 (patch) | |
| tree | 4f606ec99e1c23e8f8373fd0bd90cad6dcc0ed95 /tools | |
| parent | 004b45c0e51a8b6f20320181a946ba2d1bd3548b (diff) | |
| download | linux-47ff7ac6d706c6f08153294c87287aeec183b211.tar.xz | |
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>
Diffstat (limited to 'tools')
| -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 **bpftool** **map** *COMMAND* *COMMANDS* := - { show | dump | update | lookup | getnext | delete | pin | help } + { **show** | **dump** | **update** | **lookup** | **getnext** | **delete** + | **pin** | **help** } MAP COMMANDS ============= -| **bpftool** map show [*MAP*] -| **bpftool** map dump *MAP* -| **bpftool** map update *MAP* key *BYTES* value *VALUE* [*UPDATE_FLAGS*] -| **bpftool** map lookup *MAP* key *BYTES* -| **bpftool** map getnext *MAP* [key *BYTES*] -| **bpftool** map delete *MAP* key *BYTES* -| **bpftool** map pin *MAP* *FILE* -| **bpftool** map help +| **bpftool** **map show** [*MAP*] +| **bpftool** **map dump** *MAP* +| **bpftool** **map update** *MAP* **key** *BYTES* **value** *VALUE* [*UPDATE_FLAGS*] +| **bpftool** **map lookup** *MAP* **key** *BYTES* +| **bpftool** **map getnext** *MAP* [**key** *BYTES*] +| **bpftool** **map delete** *MAP* **key** *BYTES* +| **bpftool** **map pin** *MAP* *FILE* +| **bpftool** **map help** | -| *MAP* := { id MAP_ID | pinned FILE } -| *VALUE* := { BYTES | MAP | PROGRAM } -| *UPDATE_FLAGS* := { any | exist | noexist } +| *MAP* := { **id** *MAP_ID* | **pinned** *FILE* } +| *VALUE* := { *BYTES* | *MAP* | *PROGRAM* } +| *UPDATE_FLAGS* := { **any** | **exist** | **noexist** } DESCRIPTION =========== 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 SYNOPSIS ======== -| **bpftool** prog show [*PROG*] -| **bpftool** prog dump xlated *PROG* [{file *FILE* | opcodes }] -| **bpftool** prog dump jited *PROG* [{file *FILE* | opcodes }] -| **bpftool** prog pin *PROG* *FILE* -| **bpftool** prog help +| **bpftool** **prog show** [*PROG*] +| **bpftool** **prog dump xlated** *PROG* [{**file** *FILE* | **opcodes**}] +| **bpftool** **prog dump jited** *PROG* [{**file** *FILE* | **opcodes**}] +| **bpftool** **prog pin** *PROG* *FILE* +| **bpftool** **prog help** | -| *PROG* := { id *PROG_ID* | pinned *FILE* | tag *PROG_TAG* } +| *PROG* := { **id** *PROG_ID* | **pinned** *FILE* | **tag** *PROG_TAG* } DESCRIPTION =========== 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 SYNOPSIS ======== - **bpftool** *OBJECT* { *COMMAND* | help } + **bpftool** *OBJECT* { *COMMAND* | **help** } - **bpftool** batch file *FILE* + **bpftool** **batch file** *FILE* - **bpftool** version + **bpftool** **version** *OBJECT* := { **map** | **program** } *MAP-COMMANDS* := - { show | dump | update | lookup | getnext | delete | pin | help } + { **show** | **dump** | **update** | **lookup** | **getnext** | **delete** + | **pin** | **help** } - *PROG-COMMANDS* := { show | dump jited | dump xlated | pin | help } + *PROG-COMMANDS* := { **show** | **dump jited** | **dump xlated** | **pin** + | **help** } DESCRIPTION =========== |