Re: ifconfig.8: document aggr(4) under TRUNK

2020-07-26 Thread Klemens Nanni
On Sun, Jul 26, 2020 at 06:47:14PM +0100, Jason McIntyre wrote:
> certainly ok by me. i think this commit could add aggr to the list of
> devices in "create".
Right, thanks.
 
> bridge is a bit different i think. i wouldn;t like to have those
> synopses dropped because i think they're useful. but bridge was
> basically an entire, large, manpage that got shoehorned into ifconfig.8.
Yes, it came from brconfig(8) and is somewhat on its own.

I'll do at least the TRUNK synopsis then for correctness, it reads off
otherwise.

New diff with both additions.



Index: ifconfig.8
===
RCS file: /cvs/src/sbin/ifconfig/ifconfig.8,v
retrieving revision 1.352
diff -u -p -r1.352 ifconfig.8
--- ifconfig.8  27 Jun 2020 17:46:29 -  1.352
+++ ifconfig.8  26 Jul 2020 18:02:45 -
@@ -181,6 +181,7 @@ The default broadcast address is the add
 Create the specified network pseudo-device.
 At least the following devices can be created on demand:
 .Pp
+.Xr aggr 4 ,
 .Xr bridge 4 ,
 .Xr carp 4 ,
 .Xr egre 4 ,
@@ -1759,15 +1760,19 @@ from all protected domains.
 .It Cm up
 Start the switch processing packets.
 .El
-.Sh TRUNK
+.Sh TRUNK (LINK AGGREGATION)
 .Nm ifconfig
 .Ar trunk-interface
+.Op Cm lacpmode Cm active Ns | Ns Cm passive
+.Op Cm lacptimeout Cm fast Ns | Ns Cm slow
 .Op Oo Fl Oc Ns Cm trunkport Ar child-iface
 .Op Cm trunkproto Ar proto
 .Pp
-The following options are available for a
+The following options are available for
+.Xr aggr 4
+and
 .Xr trunk 4
-interface:
+interfaces:
 .Bl -tag -width Ds
 .It Cm lacpmode Cm active Ns | Ns Cm passive
 Set the LACP trunk mode to either
@@ -1787,7 +1792,9 @@ as a trunk port.
 Remove the trunk port
 .Ar child-iface .
 .It Cm trunkproto Ar proto
-Set the trunk protocol.
+Set the link aggregation protocol on
+.Xr trunk 4
+interfaces.
 Refer to
 .Xr trunk 4
 for a complete list of the available protocols.



Re: ifconfig.8: document aggr(4) under TRUNK

2020-07-26 Thread Jason McIntyre
On Sun, Jul 26, 2020 at 07:33:55PM +0200, Klemens Nanni wrote:
> Except for `trunkproto' wich his trunk(4) specific, aggr(4) has the same
> options so I'd like to merge it into the same section just like TUNNEL
> documents mostly identical interfaces with differences mentioned in at
> specific options.
> 
> The wording "trunk" seems clear under OpenBSD, but other vendors give it
> a different meaning (e.g. Cisco), so I slightly enhanced the section
> name as well.
> 
> Feedback? Objections? OK?
> 

certainly ok by me. i think this commit could add aggr to the list of
devices in "create".

> Another thing: Note that `lacpmode' and `lacptimeout' are missing from
> the existing TRUNK synopsis - I hesitate to add them because it feels
> like too much duplication.  Would it perhaps be worthwile to drop each
> interface type section's synopsis all together?  Most options are under
> DESCRIPTION and the second biggest section is BRIDGE which does not have
> a synopsis, either.  Less seems more here.
> 
> If at all, this seems best handled in a different commit.
> 

bridge is a bit different i think. i wouldn;t like to have those
synopses dropped because i think they're useful. but bridge was
basically an entire, large, manpage that got shoehorned into ifconfig.8.

jmc

> NB: At least tpmr(4) is missing as well, which I'll handle soon as well.
> 
> 
> Index: ifconfig.8
> ===
> RCS file: /cvs/src/sbin/ifconfig/ifconfig.8,v
> retrieving revision 1.352
> diff -u -p -r1.352 ifconfig.8
> --- ifconfig.827 Jun 2020 17:46:29 -  1.352
> +++ ifconfig.826 Jul 2020 17:22:24 -
> @@ -1759,15 +1759,17 @@ from all protected domains.
>  .It Cm up
>  Start the switch processing packets.
>  .El
> -.Sh TRUNK
> +.Sh TRUNK (LINK AGGREGATION)
>  .Nm ifconfig
>  .Ar trunk-interface
>  .Op Oo Fl Oc Ns Cm trunkport Ar child-iface
>  .Op Cm trunkproto Ar proto
>  .Pp
> -The following options are available for a
> +The following options are available for
> +.Xr aggr 4
> +and
>  .Xr trunk 4
> -interface:
> +interfaces:
>  .Bl -tag -width Ds
>  .It Cm lacpmode Cm active Ns | Ns Cm passive
>  Set the LACP trunk mode to either
> @@ -1787,7 +1789,9 @@ as a trunk port.
>  Remove the trunk port
>  .Ar child-iface .
>  .It Cm trunkproto Ar proto
> -Set the trunk protocol.
> +Set the link aggregation protocol on
> +.Xr trunk 4
> +interfaces.
>  Refer to
>  .Xr trunk 4
>  for a complete list of the available protocols.
> 



ifconfig.8: document aggr(4) under TRUNK

2020-07-26 Thread Klemens Nanni
Except for `trunkproto' wich his trunk(4) specific, aggr(4) has the same
options so I'd like to merge it into the same section just like TUNNEL
documents mostly identical interfaces with differences mentioned in at
specific options.

The wording "trunk" seems clear under OpenBSD, but other vendors give it
a different meaning (e.g. Cisco), so I slightly enhanced the section
name as well.

Feedback? Objections? OK?

Another thing: Note that `lacpmode' and `lacptimeout' are missing from
the existing TRUNK synopsis - I hesitate to add them because it feels
like too much duplication.  Would it perhaps be worthwile to drop each
interface type section's synopsis all together?  Most options are under
DESCRIPTION and the second biggest section is BRIDGE which does not have
a synopsis, either.  Less seems more here.

If at all, this seems best handled in a different commit.

NB: At least tpmr(4) is missing as well, which I'll handle soon as well.


Index: ifconfig.8
===
RCS file: /cvs/src/sbin/ifconfig/ifconfig.8,v
retrieving revision 1.352
diff -u -p -r1.352 ifconfig.8
--- ifconfig.8  27 Jun 2020 17:46:29 -  1.352
+++ ifconfig.8  26 Jul 2020 17:22:24 -
@@ -1759,15 +1759,17 @@ from all protected domains.
 .It Cm up
 Start the switch processing packets.
 .El
-.Sh TRUNK
+.Sh TRUNK (LINK AGGREGATION)
 .Nm ifconfig
 .Ar trunk-interface
 .Op Oo Fl Oc Ns Cm trunkport Ar child-iface
 .Op Cm trunkproto Ar proto
 .Pp
-The following options are available for a
+The following options are available for
+.Xr aggr 4
+and
 .Xr trunk 4
-interface:
+interfaces:
 .Bl -tag -width Ds
 .It Cm lacpmode Cm active Ns | Ns Cm passive
 Set the LACP trunk mode to either
@@ -1787,7 +1789,9 @@ as a trunk port.
 Remove the trunk port
 .Ar child-iface .
 .It Cm trunkproto Ar proto
-Set the trunk protocol.
+Set the link aggregation protocol on
+.Xr trunk 4
+interfaces.
 Refer to
 .Xr trunk 4
 for a complete list of the available protocols.