From patchwork Mon Oct 23 16:24:15 2017 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Jakub Kicinski X-Patchwork-Id: 829398 X-Patchwork-Delegate: davem@davemloft.net Return-Path: X-Original-To: patchwork-incoming@ozlabs.org Delivered-To: patchwork-incoming@ozlabs.org Authentication-Results: ozlabs.org; spf=none (mailfrom) smtp.mailfrom=vger.kernel.org (client-ip=209.132.180.67; helo=vger.kernel.org; envelope-from=netdev-owner@vger.kernel.org; receiver=) Authentication-Results: ozlabs.org; dkim=pass (2048-bit key; unprotected) header.d=netronome-com.20150623.gappssmtp.com header.i=@netronome-com.20150623.gappssmtp.com header.b="Qit4gXLW"; dkim-atps=neutral Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by ozlabs.org (Postfix) with ESMTP id 3yLMFK4WS5z9t5s for ; Tue, 24 Oct 2017 03:25:09 +1100 (AEDT) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1751658AbdJWQZH (ORCPT ); Mon, 23 Oct 2017 12:25:07 -0400 Received: from mail-pg0-f68.google.com ([74.125.83.68]:46811 "EHLO mail-pg0-f68.google.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1751587AbdJWQZF (ORCPT ); Mon, 23 Oct 2017 12:25:05 -0400 Received: by mail-pg0-f68.google.com with SMTP id k7so12171591pga.3 for ; Mon, 23 Oct 2017 09:25:05 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=netronome-com.20150623.gappssmtp.com; s=20150623; h=from:to:cc:subject:date:message-id:in-reply-to:references; bh=tb3ikPMV8JHpXc7n3/iC76uA3HgmviKSSSyAowL+HAE=; b=Qit4gXLW1lS6iFtdsEvdLlZXrC9O8C9KnhGIsVevEllO6aDHCfK8UZa93gY9A12wgo F9ZdydVZyWiXFGqcwVRqq5rXPxWUklceLztPDNIYsQh0cw3NYiYNyr6Axb4Sm2aF2nMo +NuGsmYn1pjSMgSwjEA+aSQOt7H9hs63K4QhIxQNDtRhDkPaHvIFS4RnPOe4w8zwCV6c zGbh3dWAaSYIxdV7DvmyqWS9ih4BNfL68v1pftqGhBwhKiD/sk3ikGEyio/egqX17XHN d+Q7FtQJbaqxs9kiD6EfqLAKKAPszJIfy3U1oF0WId93A9rz84DcgZaDyYbXd2KgWoIG 9TVw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references; bh=tb3ikPMV8JHpXc7n3/iC76uA3HgmviKSSSyAowL+HAE=; b=eTf6Bnyw8BG8inqW9JwHchyk/umWdDLLNgKUyEZT32vMuuYwQNZahH8wN7Pxz3UMxn 5tgoPFWfbA8+9CZ4BzRAa6WFiXw6Nt4kJrsPgwfaFPEI1zXbJWFLRYrDo5oiZhL9Ci/2 Bv8Ou8br3RzmHfWDfjmAsVq2jpn8f5M/ZoqQjUZDrNmfuk0Sihzl9WaJ5i3U6aktWgHM /tz5L3ilXCOsMuCxuu3l33UHWadNdcvT3G7gQzCB3n98nT/7LmfnOYVLtA7OdzU+pV5G p7fvHHYJ1TmHxqa1ka9PSCBAtBdodiIHmz/vstIEufIHdx4j5NBQaSUWySocJz6hyUOP sXbw== X-Gm-Message-State: AMCzsaVSFtCsAfyuRliC/1M5FcTO3CAkpArL/dxsxDjgcIvMHEtIhXDx 4UgKQB9+HOXX1kRXV7xRLegJHgmg X-Google-Smtp-Source: ABhQp+Q63cPXa49KXV5848ePYgvtz7xws/aylxgdvRQeZYdGc42sqMzCSIZFlZcy/58by0+i40NWug== X-Received: by 10.84.238.1 with SMTP id u1mr2401428plk.396.1508775904819; Mon, 23 Oct 2017 09:25:04 -0700 (PDT) Received: from jkicinski-Precision-T1700.netronome.com ([75.53.12.129]) by smtp.gmail.com with ESMTPSA id a19sm13586540pfh.30.2017.10.23.09.25.03 (version=TLS1_2 cipher=ECDHE-RSA-AES128-SHA bits=128/128); Mon, 23 Oct 2017 09:25:04 -0700 (PDT) From: Jakub Kicinski To: netdev@vger.kernel.org Cc: oss-drivers@netronome.com, alexei.starovoitov@gmail.com, daniel@iogearbox.net, Quentin Monnet Subject: [PATCH net-next 11/12] tools: bpftool: add cosmetic changes for the manual pages Date: Mon, 23 Oct 2017 09:24:15 -0700 Message-Id: <20171023162416.32753-12-jakub.kicinski@netronome.com> X-Mailer: git-send-email 2.14.1 In-Reply-To: <20171023162416.32753-1-jakub.kicinski@netronome.com> References: <20171023162416.32753-1-jakub.kicinski@netronome.com> Sender: netdev-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: netdev@vger.kernel.org From: Quentin Monnet 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 Acked-by: Jakub Kicinski Acked-by: Daniel Borkmann --- tools/bpf/bpftool/Documentation/bpftool-map.rst | 25 ++++++++++++------------ tools/bpf/bpftool/Documentation/bpftool-prog.rst | 12 ++++++------ 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 ===========