bpf.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Quentin Monnet <qmo@kernel.org>
To: Tao Chen <chen.dylane@linux.dev>,
	ast@kernel.org, daniel@iogearbox.net, andrii@kernel.org,
	martin.lau@linux.dev, eddyz87@gmail.com, song@kernel.org,
	yonghong.song@linux.dev, john.fastabend@gmail.com,
	kpsingh@kernel.org, sdf@fomichev.me, haoluo@google.com,
	jolsa@kernel.org, davem@davemloft.net, kuba@kernel.org,
	hawk@kernel.org
Cc: linux-kernel@vger.kernel.org, bpf@vger.kernel.org,
	netdev@vger.kernel.org
Subject: Re: [PATCH bpf-next v2 2/3] bpftool: Add bpftool-token manpage
Date: Tue, 22 Jul 2025 16:01:31 +0100	[thread overview]
Message-ID: <2e3a00c0-dc18-40d4-af2a-ce8df4e54021@kernel.org> (raw)
In-Reply-To: <20250722120912.1391604-2-chen.dylane@linux.dev>

2025-07-22 20:09 UTC+0800 ~ Tao Chen <chen.dylane@linux.dev>
> Add bpftool-token manpage with information and examples of token-related
> commands.
> 
> Signed-off-by: Tao Chen <chen.dylane@linux.dev>
> ---
>  .../bpftool/Documentation/bpftool-token.rst   | 63 +++++++++++++++++++
>  1 file changed, 63 insertions(+)
>  create mode 100644 tools/bpf/bpftool/Documentation/bpftool-token.rst
> 
> diff --git a/tools/bpf/bpftool/Documentation/bpftool-token.rst b/tools/bpf/bpftool/Documentation/bpftool-token.rst
> new file mode 100644
> index 00000000000..c5fe9292258
> --- /dev/null
> +++ b/tools/bpf/bpftool/Documentation/bpftool-token.rst
> @@ -0,0 +1,63 @@
> +.. SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> +
> +================
> +bpftool-token
> +================
> +-------------------------------------------------------------------------------
> +tool for inspection and simple manipulation of eBPF tokens
> +-------------------------------------------------------------------------------
> +
> +:Manual section: 8
> +
> +.. include:: substitutions.rst
> +
> +SYNOPSIS
> +========
> +
> +**bpftool** [*OPTIONS*] **token** *COMMAND*
> +
> +*OPTIONS* := { |COMMON_OPTIONS| }
> +
> +*COMMANDS* := { **show** | **list** | **help** }
> +
> +TOKEN COMMANDS
> +===============
> +
> +| **bpftool** **token** { **show** | **list** }
> +| **bpftool** **token help**
> +|
> +
> +DESCRIPTION
> +===========
> +bpftool token { show | list }
> +    List all the speciafic allowed types for **bpf**\ () system call


Typo: "speciafic". 


> +    commands, maps, programs, and attach types, as well as the
> +    *bpffs* mount point used to set the token information.


This sentence needs to be adjusted now that you can print info for
several mountpoints.

How about:

    List BPF token information for each *bpffs* mount point containing token
    information on the system. Information include mount point path, allowed
    **bpf**\ () system call commands, maps, programs, and attach types for the
    token.


> +
> +bpftool prog help
> +    Print short help message.
> +
> +OPTIONS
> +========
> +.. include:: common_options.rst
> +
> +EXAMPLES
> +========
> +|
> +| **# mkdir -p /sys/fs/bpf/token**
> +| **# mount -t bpf bpffs /sys/fs/bpf/token** \
> +|         **-o delegate_cmds=prog_load:map_create** \
> +|         **-o delegate_progs=kprobe** \
> +|         **-o delegate_attachs=xdp**
> +| **# bpftool token list**
> +
> +::
> +
> +    token_info  /sys/fs/bpf/token
> +            allowed_cmds:
> +              map_create          prog_load
> +            allowed_maps:
> +            allowed_progs:
> +              kprobe
> +            allowed_attachs:
> +              xdp


  reply	other threads:[~2025-07-22 15:01 UTC|newest]

Thread overview: 9+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-07-22 12:09 [RESEND PATCH bpf-next v2 1/3] bpftool: Add bpf_token show Tao Chen
2025-07-22 12:09 ` [PATCH bpf-next v2 2/3] bpftool: Add bpftool-token manpage Tao Chen
2025-07-22 15:01   ` Quentin Monnet [this message]
2025-07-22 16:14     ` Tao Chen
2025-07-22 12:09 ` [PATCH bpf-next v2 3/3] bpftool: Add bash completion for token argument Tao Chen
2025-07-22 15:02   ` Quentin Monnet
2025-07-22 16:35     ` Tao Chen
2025-07-22 16:37       ` Quentin Monnet
  -- strict thread matches above, loose matches on Subject: below --
2025-07-22 11:58 [PATCH bpf-next v2 1/3] bpftool: Add bpf_token show Tao Chen
2025-07-22 11:58 ` [PATCH bpf-next v2 2/3] bpftool: Add bpftool-token manpage Tao Chen

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=2e3a00c0-dc18-40d4-af2a-ce8df4e54021@kernel.org \
    --to=qmo@kernel.org \
    --cc=andrii@kernel.org \
    --cc=ast@kernel.org \
    --cc=bpf@vger.kernel.org \
    --cc=chen.dylane@linux.dev \
    --cc=daniel@iogearbox.net \
    --cc=davem@davemloft.net \
    --cc=eddyz87@gmail.com \
    --cc=haoluo@google.com \
    --cc=hawk@kernel.org \
    --cc=john.fastabend@gmail.com \
    --cc=jolsa@kernel.org \
    --cc=kpsingh@kernel.org \
    --cc=kuba@kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=martin.lau@linux.dev \
    --cc=netdev@vger.kernel.org \
    --cc=sdf@fomichev.me \
    --cc=song@kernel.org \
    --cc=yonghong.song@linux.dev \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).