Re: aggr.4 and trunk.4: omit common ifconfig options

2020-08-23 Thread Jason McIntyre
On Mon, Aug 24, 2020 at 01:26:06AM +0200, Klemens Nanni wrote:
> ifconfig(8)'s TRUNK (LINK AGGREGATION) nicely combines the two drivers
> and I'd like to further omit common stuff from the drive specific
> manuals.
> 
> This aids in the overall design of having options documented in
> ifconfig(8) alone unless they're inherently driver specific, e.g.
> `trunkproto' which stays in trunk(4).
> 
> sys/net/if_trunk.c and sys/net/trunklacp.h confirm that trunk(4) has
> indeed the same defaults as aggr(4) when it comes to LACP mode and
> timeout:
> 
>   #define>LACP_DEFAULT_MODE>  >   1 /* Active Mode */
>   #define>LACP_DEFAULT_TIMEOUT>   >   0 /* Slow Timeout */
> 
> Feedback? OK?
> 

ok.
jmc

> 
> Index: share/man/man4/aggr.4
> ===
> RCS file: /cvs/src/share/man/man4/aggr.4,v
> retrieving revision 1.2
> diff -u -p -r1.2 aggr.4
> --- share/man/man4/aggr.4 5 Jul 2019 05:22:57 -   1.2
> +++ share/man/man4/aggr.4 23 Aug 2020 23:10:46 -
> @@ -63,30 +63,11 @@ and
>  .Xr netstart 8
>  using the following options:
>  .Bl -tag -width Ds
> -.It Cm lacpmode Cm active Ns | Ns Cm passive
> -Set the LACP mode to either
> -.Cm active
> -or
> -.Cm passive .
> -The default is active mode.
> -.It Cm lacptimeout Cm fast Ns | Ns Cm slow
> -Set the LACP timeout speed to either
> -.Cm fast
> -or
> -.Cm slow .
> -The default is slow timeouts.
>  .It Cm lladdr Ar etheraddr Ns | Ns Cm random
>  Change the link layer address (MAC address) of the interface.
>  This should be specified as six colon-separated hex values, or can
>  be chosen randomly.
>  By default a random MAC address is generated when an interface is created.
> -.It Cm trunkport Ar child-iface
> -Add
> -.Ar child-iface
> -as a port.
> -.It Cm -trunkport Ar child-iface
> -Remove the port
> -.Ar child-iface .
>  .El
>  .\" document the ioctls?
>  .Pp
> Index: share/man/man4/trunk.4
> ===
> RCS file: /cvs/src/share/man/man4/trunk.4,v
> retrieving revision 1.30
> diff -u -p -r1.30 trunk.4
> --- share/man/man4/trunk.412 Aug 2018 23:50:31 -  1.30
> +++ share/man/man4/trunk.423 Aug 2020 23:12:53 -
> @@ -34,15 +34,6 @@ A
>  interface can be created using the
>  .Ic ifconfig trunk Ns Ar N Ic create
>  command.
> -It can use different link aggregation protocols specified
> -using the
> -.Ic trunkproto Ar proto
> -option.
> -Child interfaces can be added using the
> -.Ic trunkport Ar child-iface
> -option and removed using the
> -.Ic -trunkport Ar child-iface
> -option.
>  .Pp
>  The driver currently supports the trunk protocols
>  .Ic broadcast ,
> Index: sbin/ifconfig/ifconfig.8
> ===
> RCS file: /cvs/src/sbin/ifconfig/ifconfig.8,v
> retrieving revision 1.356
> diff -u -p -r1.356 ifconfig.8
> --- sbin/ifconfig/ifconfig.8  8 Aug 2020 06:06:24 -   1.356
> +++ sbin/ifconfig/ifconfig.8  23 Aug 2020 23:21:28 -
> @@ -1824,13 +1824,14 @@ interfaces:
>  .It Cm lacpmode Cm active Ns | Ns Cm passive
>  Set the LACP trunk mode to either
>  .Cm active
> -or
> +(default) or
>  .Cm passive .
>  .It Cm lacptimeout Cm fast Ns | Ns Cm slow
>  Set the LACP timeout speed to either
>  .Cm fast
>  or
> -.Cm slow .
> +.Cm slow
> +(default).
>  .It Cm trunkport Ar child-iface
>  Add
>  .Ar child-iface
> 



aggr.4 and trunk.4: omit common ifconfig options

2020-08-23 Thread Klemens Nanni
ifconfig(8)'s TRUNK (LINK AGGREGATION) nicely combines the two drivers
and I'd like to further omit common stuff from the drive specific
manuals.

This aids in the overall design of having options documented in
ifconfig(8) alone unless they're inherently driver specific, e.g.
`trunkproto' which stays in trunk(4).

sys/net/if_trunk.c and sys/net/trunklacp.h confirm that trunk(4) has
indeed the same defaults as aggr(4) when it comes to LACP mode and
timeout:

#define>LACP_DEFAULT_MODE>  >   1 /* Active Mode */
#define>LACP_DEFAULT_TIMEOUT>   >   0 /* Slow Timeout */

Feedback? OK?


Index: share/man/man4/aggr.4
===
RCS file: /cvs/src/share/man/man4/aggr.4,v
retrieving revision 1.2
diff -u -p -r1.2 aggr.4
--- share/man/man4/aggr.4   5 Jul 2019 05:22:57 -   1.2
+++ share/man/man4/aggr.4   23 Aug 2020 23:10:46 -
@@ -63,30 +63,11 @@ and
 .Xr netstart 8
 using the following options:
 .Bl -tag -width Ds
-.It Cm lacpmode Cm active Ns | Ns Cm passive
-Set the LACP mode to either
-.Cm active
-or
-.Cm passive .
-The default is active mode.
-.It Cm lacptimeout Cm fast Ns | Ns Cm slow
-Set the LACP timeout speed to either
-.Cm fast
-or
-.Cm slow .
-The default is slow timeouts.
 .It Cm lladdr Ar etheraddr Ns | Ns Cm random
 Change the link layer address (MAC address) of the interface.
 This should be specified as six colon-separated hex values, or can
 be chosen randomly.
 By default a random MAC address is generated when an interface is created.
-.It Cm trunkport Ar child-iface
-Add
-.Ar child-iface
-as a port.
-.It Cm -trunkport Ar child-iface
-Remove the port
-.Ar child-iface .
 .El
 .\" document the ioctls?
 .Pp
Index: share/man/man4/trunk.4
===
RCS file: /cvs/src/share/man/man4/trunk.4,v
retrieving revision 1.30
diff -u -p -r1.30 trunk.4
--- share/man/man4/trunk.4  12 Aug 2018 23:50:31 -  1.30
+++ share/man/man4/trunk.4  23 Aug 2020 23:12:53 -
@@ -34,15 +34,6 @@ A
 interface can be created using the
 .Ic ifconfig trunk Ns Ar N Ic create
 command.
-It can use different link aggregation protocols specified
-using the
-.Ic trunkproto Ar proto
-option.
-Child interfaces can be added using the
-.Ic trunkport Ar child-iface
-option and removed using the
-.Ic -trunkport Ar child-iface
-option.
 .Pp
 The driver currently supports the trunk protocols
 .Ic broadcast ,
Index: sbin/ifconfig/ifconfig.8
===
RCS file: /cvs/src/sbin/ifconfig/ifconfig.8,v
retrieving revision 1.356
diff -u -p -r1.356 ifconfig.8
--- sbin/ifconfig/ifconfig.88 Aug 2020 06:06:24 -   1.356
+++ sbin/ifconfig/ifconfig.823 Aug 2020 23:21:28 -
@@ -1824,13 +1824,14 @@ interfaces:
 .It Cm lacpmode Cm active Ns | Ns Cm passive
 Set the LACP trunk mode to either
 .Cm active
-or
+(default) or
 .Cm passive .
 .It Cm lacptimeout Cm fast Ns | Ns Cm slow
 Set the LACP timeout speed to either
 .Cm fast
 or
-.Cm slow .
+.Cm slow
+(default).
 .It Cm trunkport Ar child-iface
 Add
 .Ar child-iface