Re: [bpf-next v4 2/3] bpftool: Update doc (add auto_attach to prog load)

[wangyufen]

在 2022/9/20 23:12, Quentin Monnet 写道:
> Tue Sep 13 2022 03:54:46 GMT+0100 (British Summer Time) ~ Wang Yufen
> <wangyufen@xxxxxxxxxx>
> > Add auto_attach optional to prog load|loadall for supporting
> > one-step load-attach-pin_link.
> >
> > Signed-off-by: Wang Yufen <wangyufen@xxxxxxxxxx>
> > ---
> >   tools/bpf/bpftool/Documentation/bpftool-prog.rst | 12 ++++++++++--
> >   1 file changed, 10 insertions(+), 2 deletions(-)
> >
> > diff --git a/tools/bpf/bpftool/Documentation/bpftool-prog.rst b/tools/bpf/bpftool/Documentation/bpftool-prog.rst
> > index eb1b2a2..463f895 100644
> > --- a/tools/bpf/bpftool/Documentation/bpftool-prog.rst
> > +++ b/tools/bpf/bpftool/Documentation/bpftool-prog.rst
> > @@ -31,7 +31,7 @@ PROG COMMANDS
> >   |	**bpftool** **prog dump xlated** *PROG* [{**file** *FILE* | **opcodes** | **visual** | **linum**}]
> >   |	**bpftool** **prog dump jited**  *PROG* [{**file** *FILE* | **opcodes** | **linum**}]
> >   |	**bpftool** **prog pin** *PROG* *FILE*
> > -|	**bpftool** **prog** { **load** | **loadall** } *OBJ* *PATH* [**type** *TYPE*] [**map** {**idx** *IDX* | **name** *NAME*} *MAP*] [**dev** *NAME*] [**pinmaps** *MAP_DIR*]
> > +|	**bpftool** **prog** { **load** | **loadall** } *OBJ* *PATH* [**type** *TYPE*] [**map** {**idx** *IDX* | **name** *NAME*} *MAP*] [**dev** *NAME*] [**pinmaps** *MAP_DIR*] [**auto_attach**]
> >   |	**bpftool** **prog attach** *PROG* *ATTACH_TYPE* [*MAP*]
> >   |	**bpftool** **prog detach** *PROG* *ATTACH_TYPE* [*MAP*]
> >   |	**bpftool** **prog tracelog**
> > @@ -131,7 +131,7 @@ DESCRIPTION
> >   		  contain a dot character ('.'), which is reserved for future
> >   		  extensions of *bpffs*.
> >   
> > -	**bpftool prog { load | loadall }** *OBJ* *PATH* [**type** *TYPE*] [**map** {**idx** *IDX* | **name** *NAME*} *MAP*] [**dev** *NAME*] [**pinmaps** *MAP_DIR*]
> > +	**bpftool prog { load | loadall }** *OBJ* *PATH* [**type** *TYPE*] [**map** {**idx** *IDX* | **name** *NAME*} *MAP*] [**dev** *NAME*] [**pinmaps** *MAP_DIR*] [**auto_attach**]
> >   		  Load bpf program(s) from binary *OBJ* and pin as *PATH*.
> >   		  **bpftool prog load** pins only the first program from the
> >   		  *OBJ* as *PATH*. **bpftool prog loadall** pins all programs
> > @@ -150,6 +150,14 @@ DESCRIPTION
> >   		  Optional **pinmaps** argument can be provided to pin all
> >   		  maps under *MAP_DIR* directory.
> >   
> > +		  If **auto_attach** is specified program will be attached
> > +		  before pin. 1)in that case, only the link (representing the program
> "1)in" -> "In"
>
> > +		  attached to its hook) is pinned, not the program as such, so the
> > +		  path won't show in "bpftool prog show -f", only show in
> Let's use markup instead of quotes around the commands please, **bpftool
> prog show -f** and **bpftool link show -f** (below).
>
> > +		  "bpftool link show -f", and 2)this only works when bpftool (libbpf)
> ", and 2)this..." -> ". Also, this..."
>
> > +		  is able to infer all necessary information from the object file,
> > +		  in particular, it's not supported for all program types.
> > +
> >   		  Note: *PATH* must be located in *bpffs* mount. It must not
> >   		  contain a dot character ('.'), which is reserved for future
> >   		  extensions of *bpffs*.
> Apart from the formatting nits above, looks good, thank you.
Thanks， will send v5