OSDN Git Service

tools: bpftool: add cosmetic changes for the manual pages
authorQuentin Monnet <quentin.monnet@netronome.com>
Mon, 23 Oct 2017 16:24:15 +0000 (09:24 -0700)
committerDavid S. Miller <davem@davemloft.net>
Tue, 24 Oct 2017 00:25:09 +0000 (01:25 +0100)
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>
tools/bpf/bpftool/Documentation/bpftool-map.rst
tools/bpf/bpftool/Documentation/bpftool-prog.rst
tools/bpf/bpftool/Documentation/bpftool.rst

index 5210c4f..3954b3e 100644 (file)
@@ -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
 ===========
index 6620a81..685a19e 100644 (file)
@@ -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
 ===========
index 9c04cd6..44e0779 100644 (file)
@@ -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
 ===========