[iproute2,v2] man: bridge: update bridge link show

[iproute2,v2] man: bridge: update bridge link show

[Nicolas Escande]

Add missing man page documentation for bridge link show features added in
13a5d8fcb41b (bridge: link: allow filtering on bridge name) and
64108901b737 (bridge: Add support for setting bridge port attributes)

Signed-off-by: Nicolas Escande <nico.escande@gmail.com>
---
 man/man8/bridge.8 | 14 +++++++++++---
 1 file changed, 11 insertions(+), 3 deletions(-)

diff --git a/man/man8/bridge.8 b/man/man8/bridge.8
index e0552819..5bf14bab 100644
--- a/man/man8/bridge.8
+++ b/man/man8/bridge.8
@@ -66,7 +66,9 @@ bridge \- show / manipulate bridge addresses and devices
 .ti -8
 .BR "bridge link" " [ " show " ] [ "
 .B dev
-.IR DEV " ]"
+.IR DEV " ] ["
+.B master
+.IR DEVICE " ]"
 
 .ti -8
 .BR "bridge fdb" " { " add " | " append " | " del " | " replace " } "
@@ -661,9 +663,15 @@ display current time when using monitor option.
 
 .SS bridge link show - list ports configuration for all bridges.
 
-This command displays port configuration and flags for all bridges.
+This command displays ports configuration and flags for all bridges by default.
+
+.TP
+.BI dev " DEV"
+only display the specific bridge port named DEV.
 
-To display port configuration and flags for a specific bridge, use the
+.TP
+.BI master " DEVICE"
+only display ports of the bridge named DEVICE. This is similar to
 "ip link show master <bridge_device>" command.
 
 .SH bridge fdb - forwarding database management
-- 
2.41.0

Re: [iproute2,v2] man: bridge: update bridge link show

[Ido Schimmel]

On Fri, Aug 04, 2023 at 06:49:52PM +0200, Nicolas Escande wrote:
> Add missing man page documentation for bridge link show features added in
> 13a5d8fcb41b (bridge: link: allow filtering on bridge name) and
> 64108901b737 (bridge: Add support for setting bridge port attributes)

FYI, the convention is to refer to a commit in the following format:

13a5d8fcb41b ("bridge: link: allow filtering on bridge name")

See [1], near the end of the section.

[1] https://www.kernel.org/doc/html/latest/process/submitting-patches.html#describe-your-changes

> Signed-off-by: Nicolas Escande <nico.escande@gmail.com>

Reviewed-by: Ido Schimmel <idosch@nvidia.com>

Thanks

Re: [iproute2,v2] man: bridge: update bridge link show

[Nicolas Escande]

On Tue Aug 8, 2023 at 1:36 PM CEST, Ido Schimmel wrote:
> On Fri, Aug 04, 2023 at 06:49:52PM +0200, Nicolas Escande wrote:
> > Add missing man page documentation for bridge link show features added in
> > 13a5d8fcb41b (bridge: link: allow filtering on bridge name) and
> > 64108901b737 (bridge: Add support for setting bridge port attributes)
>
> FYI, the convention is to refer to a commit in the following format:
>
> 13a5d8fcb41b ("bridge: link: allow filtering on bridge name")
>
> See [1], near the end of the section.
>
> [1] https://www.kernel.org/doc/html/latest/process/submitting-patches.html#describe-your-changes
>
> > Signed-off-by: Nicolas Escande <nico.escande@gmail.com>
>
> Reviewed-by: Ido Schimmel <idosch@nvidia.com>
>
> Thanks

Damn, I did read it but I missed the double quotes indeed.
If needed I can respin it.

Re: [iproute2,v2] man: bridge: update bridge link show

[Stephen Hemminger]

On Tue, 8 Aug 2023 14:36:34 +0300
Ido Schimmel <idosch@idosch.org> wrote:

> On Fri, Aug 04, 2023 at 06:49:52PM +0200, Nicolas Escande wrote:
> > Add missing man page documentation for bridge link show features added in
> > 13a5d8fcb41b (bridge: link: allow filtering on bridge name) and
> > 64108901b737 (bridge: Add support for setting bridge port attributes)  
> 
> FYI, the convention is to refer to a commit in the following format:
> 
> 13a5d8fcb41b ("bridge: link: allow filtering on bridge name")
> 

If you use checkpatch it will tell you that correct format is:
commit 13a5d8fcb41b ("bridge: link: allow filtering on bridge name")

Fixed it during merge

Re: [iproute2,v2] man: bridge: update bridge link show

[patchwork-bot+netdevbpf]

Hello:

This patch was applied to iproute2/iproute2.git (main)
by Stephen Hemminger <stephen@networkplumber.org>:

On Fri,  4 Aug 2023 18:49:52 +0200 you wrote:
> Add missing man page documentation for bridge link show features added in
> 13a5d8fcb41b (bridge: link: allow filtering on bridge name) and
> 64108901b737 (bridge: Add support for setting bridge port attributes)
> 
> Signed-off-by: Nicolas Escande <nico.escande@gmail.com>
> ---
>  man/man8/bridge.8 | 14 +++++++++++---
>  1 file changed, 11 insertions(+), 3 deletions(-)

Here is the summary with links:
  - [iproute2,v2] man: bridge: update bridge link show
    https://git.kernel.org/pub/scm/network/iproute2/iproute2.git/commit/?id=cb93753e1042

You are awesome, thank you!
-- 
Deet-doot-dot, I am a bot.
https://korg.docs.kernel.org/patchwork/pwbot.html