Re: [PATCH] [src] share/man/man5/hostname.if.5 - nwid -> join

2021-11-11 Thread Jason McIntyre
On Thu, Nov 11, 2021 at 08:30:45PM +, Klemens Nanni wrote:
> On Thu, Nov 11, 2021 at 08:13:13PM +, Jason McIntyre wrote:
> > i don;t think this bit of text works well now because you say it runs
> > ifconfig 3 times then ... respectively. but you only list two things
> > (even though i understand dynamic config is two). since your text is
> > already clear, i'd omit ", respectively". or maybe say "inet4 and inet6
> > dynamic ..." to balance out the three times would be better.
> 
> Thanks, is this better?
> 
> 
> Index: hostname.if.5
> ===
> RCS file: /cvs/src/share/man/man5/hostname.if.5,v
> retrieving revision 1.77
> diff -u -p -r1.77 hostname.if.5
> --- hostname.if.5 17 Jul 2021 15:28:31 -  1.77
> +++ hostname.if.5 11 Nov 2021 20:30:05 -
> @@ -67,21 +67,13 @@ inet 10.0.0.1 255.255.255.0 10.0.0.255 d
>  Each line is processed separately and in order.
>  For example:
>  .Bd -literal -offset indent
> -nwid mynwid wpakey mywpakey
> +join mynwid wpakey mywpakey
>  inet6 autoconf
>  inet autoconf
>  .Ed
>  .Pp
> -would run ifconfig three times to set the
> -.Cm nwid
> -and
> -.Cm wpakey
> -of the interface,
> -the
> -.Sy AUTOCONF6
> -flag and the
> -.Sy AUTOCONF4
> -flag, respectively.
> +would run ifconfig three times to add a wireless network using WPA to the
> +join list and enable dynamic address configuration for IPv6 and IPv4.
>  .Sh STATIC ADDRESS CONFIGURATION
>  The following packed formats are valid for configuring network
>  interfaces with static addresses.
> 

bingo!

jmc



Re: [PATCH] [src] share/man/man5/hostname.if.5 - nwid -> join

2021-11-11 Thread Klemens Nanni
On Thu, Nov 11, 2021 at 08:13:13PM +, Jason McIntyre wrote:
> i don;t think this bit of text works well now because you say it runs
> ifconfig 3 times then ... respectively. but you only list two things
> (even though i understand dynamic config is two). since your text is
> already clear, i'd omit ", respectively". or maybe say "inet4 and inet6
> dynamic ..." to balance out the three times would be better.

Thanks, is this better?


Index: hostname.if.5
===
RCS file: /cvs/src/share/man/man5/hostname.if.5,v
retrieving revision 1.77
diff -u -p -r1.77 hostname.if.5
--- hostname.if.5   17 Jul 2021 15:28:31 -  1.77
+++ hostname.if.5   11 Nov 2021 20:30:05 -
@@ -67,21 +67,13 @@ inet 10.0.0.1 255.255.255.0 10.0.0.255 d
 Each line is processed separately and in order.
 For example:
 .Bd -literal -offset indent
-nwid mynwid wpakey mywpakey
+join mynwid wpakey mywpakey
 inet6 autoconf
 inet autoconf
 .Ed
 .Pp
-would run ifconfig three times to set the
-.Cm nwid
-and
-.Cm wpakey
-of the interface,
-the
-.Sy AUTOCONF6
-flag and the
-.Sy AUTOCONF4
-flag, respectively.
+would run ifconfig three times to add a wireless network using WPA to the
+join list and enable dynamic address configuration for IPv6 and IPv4.
 .Sh STATIC ADDRESS CONFIGURATION
 The following packed formats are valid for configuring network
 interfaces with static addresses.



Re: [PATCH] [src] share/man/man5/hostname.if.5 - nwid -> join

2021-11-11 Thread Jason McIntyre
On Thu, Nov 11, 2021 at 08:01:37PM +, Klemens Nanni wrote:
> On Thu, Nov 11, 2021 at 05:48:24PM +, Stuart Henderson wrote:
> > On 2021/11/11 16:30, Klemens Nanni wrote:
> > > On Thu, Nov 11, 2021 at 04:11:10PM +, Raf Czlonka wrote:
> > > > Hello,
> > > > 
> > > > It seems like this has been missed in recent thread[0].
> > > > 
> > > > Not entirely sure whether the sentence "flows" any longer but here
> > > > it goes anyway.
> > > > 
> > > > [0] https://marc.info/?l=openbsd-tech=163507448118443=2
> > > 
> > > Thanks, I missed that!
> > > 
> > > > Index: share/man/man5/hostname.if.5
> > > > ===
> > > > RCS file: /cvs/src/share/man/man5/hostname.if.5,v
> > > > retrieving revision 1.77
> > > > diff -u -p -r1.77 hostname.if.5
> > > > --- share/man/man5/hostname.if.517 Jul 2021 15:28:31 -  
> > > > 1.77
> > > > +++ share/man/man5/hostname.if.511 Nov 2021 16:09:33 -
> > > > @@ -67,13 +67,13 @@ inet 10.0.0.1 255.255.255.0 10.0.0.255 d
> > > >  Each line is processed separately and in order.
> > > >  For example:
> > > >  .Bd -literal -offset indent
> > > > -nwid mynwid wpakey mywpakey
> > > > +join mynwid wpakey mywpakey
> > > >  inet6 autoconf
> > > >  inet autoconf
> > > >  .Ed
> > > >  .Pp
> > > >  would run ifconfig three times to set the
> > > > -.Cm nwid
> > > > +.Cm join
> > > >  and
> > > >  .Cm wpakey
> > > >  of the interface,
> > > 
> > > Maybe this reads better in general?
> > > 
> > > would run ifconfig three times to join a wireless network using WPA 
> > > and
> > > to set the AUTOCONF6 and AUTOCONF4 flags, respectively.
> > 
> > It is more "add a network to the join list", join implies that it's
> > connecting directly to that ssid (i.e. what "nwid" did).
> 
> Good point.
> Also no markup as per jmc.
> 
> OK?
> 
> 
> Index: hostname.if.5
> ===
> RCS file: /cvs/src/share/man/man5/hostname.if.5,v
> retrieving revision 1.77
> diff -u -p -r1.77 hostname.if.5
> --- hostname.if.5 17 Jul 2021 15:28:31 -  1.77
> +++ hostname.if.5 11 Nov 2021 20:00:45 -
> @@ -67,21 +67,13 @@ inet 10.0.0.1 255.255.255.0 10.0.0.255 d
>  Each line is processed separately and in order.
>  For example:
>  .Bd -literal -offset indent
> -nwid mynwid wpakey mywpakey
> +join mynwid wpakey mywpakey
>  inet6 autoconf
>  inet autoconf
>  .Ed
>  .Pp
> -would run ifconfig three times to set the
> -.Cm nwid
> -and
> -.Cm wpakey
> -of the interface,
> -the
> -.Sy AUTOCONF6
> -flag and the
> -.Sy AUTOCONF4
> -flag, respectively.
> +would run ifconfig three times to add a wireless network using WPA to the
> +join list and enable dynamic address configuration, respectively.
>  .Sh STATIC ADDRESS CONFIGURATION
>  The following packed formats are valid for configuring network
>  interfaces with static addresses.
> 

i don;t think this bit of text works well now because you say it runs
ifconfig 3 times then ... respectively. but you only list two things
(even though i understand dynamic config is two). since your text is
already clear, i'd omit ", respectively". or maybe say "inet4 and inet6
dynamic ..." to balance out the three times would be better.

jmc



Re: [PATCH] [src] share/man/man5/hostname.if.5 - nwid -> join

2021-11-11 Thread Klemens Nanni
On Thu, Nov 11, 2021 at 05:48:24PM +, Stuart Henderson wrote:
> On 2021/11/11 16:30, Klemens Nanni wrote:
> > On Thu, Nov 11, 2021 at 04:11:10PM +, Raf Czlonka wrote:
> > > Hello,
> > > 
> > > It seems like this has been missed in recent thread[0].
> > > 
> > > Not entirely sure whether the sentence "flows" any longer but here
> > > it goes anyway.
> > > 
> > > [0] https://marc.info/?l=openbsd-tech=163507448118443=2
> > 
> > Thanks, I missed that!
> > 
> > > Index: share/man/man5/hostname.if.5
> > > ===
> > > RCS file: /cvs/src/share/man/man5/hostname.if.5,v
> > > retrieving revision 1.77
> > > diff -u -p -r1.77 hostname.if.5
> > > --- share/man/man5/hostname.if.5  17 Jul 2021 15:28:31 -  1.77
> > > +++ share/man/man5/hostname.if.5  11 Nov 2021 16:09:33 -
> > > @@ -67,13 +67,13 @@ inet 10.0.0.1 255.255.255.0 10.0.0.255 d
> > >  Each line is processed separately and in order.
> > >  For example:
> > >  .Bd -literal -offset indent
> > > -nwid mynwid wpakey mywpakey
> > > +join mynwid wpakey mywpakey
> > >  inet6 autoconf
> > >  inet autoconf
> > >  .Ed
> > >  .Pp
> > >  would run ifconfig three times to set the
> > > -.Cm nwid
> > > +.Cm join
> > >  and
> > >  .Cm wpakey
> > >  of the interface,
> > 
> > Maybe this reads better in general?
> > 
> > would run ifconfig three times to join a wireless network using WPA and
> > to set the AUTOCONF6 and AUTOCONF4 flags, respectively.
> 
> It is more "add a network to the join list", join implies that it's
> connecting directly to that ssid (i.e. what "nwid" did).

Good point.
Also no markup as per jmc.

OK?


Index: hostname.if.5
===
RCS file: /cvs/src/share/man/man5/hostname.if.5,v
retrieving revision 1.77
diff -u -p -r1.77 hostname.if.5
--- hostname.if.5   17 Jul 2021 15:28:31 -  1.77
+++ hostname.if.5   11 Nov 2021 20:00:45 -
@@ -67,21 +67,13 @@ inet 10.0.0.1 255.255.255.0 10.0.0.255 d
 Each line is processed separately and in order.
 For example:
 .Bd -literal -offset indent
-nwid mynwid wpakey mywpakey
+join mynwid wpakey mywpakey
 inet6 autoconf
 inet autoconf
 .Ed
 .Pp
-would run ifconfig three times to set the
-.Cm nwid
-and
-.Cm wpakey
-of the interface,
-the
-.Sy AUTOCONF6
-flag and the
-.Sy AUTOCONF4
-flag, respectively.
+would run ifconfig three times to add a wireless network using WPA to the
+join list and enable dynamic address configuration, respectively.
 .Sh STATIC ADDRESS CONFIGURATION
 The following packed formats are valid for configuring network
 interfaces with static addresses.



Re: [PATCH] [src] share/man/man5/hostname.if.5 - nwid -> join

2021-11-11 Thread Stuart Henderson
On 2021/11/11 16:30, Klemens Nanni wrote:
> On Thu, Nov 11, 2021 at 04:11:10PM +, Raf Czlonka wrote:
> > Hello,
> > 
> > It seems like this has been missed in recent thread[0].
> > 
> > Not entirely sure whether the sentence "flows" any longer but here
> > it goes anyway.
> > 
> > [0] https://marc.info/?l=openbsd-tech=163507448118443=2
> 
> Thanks, I missed that!
> 
> > Index: share/man/man5/hostname.if.5
> > ===
> > RCS file: /cvs/src/share/man/man5/hostname.if.5,v
> > retrieving revision 1.77
> > diff -u -p -r1.77 hostname.if.5
> > --- share/man/man5/hostname.if.517 Jul 2021 15:28:31 -  1.77
> > +++ share/man/man5/hostname.if.511 Nov 2021 16:09:33 -
> > @@ -67,13 +67,13 @@ inet 10.0.0.1 255.255.255.0 10.0.0.255 d
> >  Each line is processed separately and in order.
> >  For example:
> >  .Bd -literal -offset indent
> > -nwid mynwid wpakey mywpakey
> > +join mynwid wpakey mywpakey
> >  inet6 autoconf
> >  inet autoconf
> >  .Ed
> >  .Pp
> >  would run ifconfig three times to set the
> > -.Cm nwid
> > +.Cm join
> >  and
> >  .Cm wpakey
> >  of the interface,
> 
> Maybe this reads better in general?
> 
> would run ifconfig three times to join a wireless network using WPA and
> to set the AUTOCONF6 and AUTOCONF4 flags, respectively.

It is more "add a network to the join list", join implies that it's
connecting directly to that ssid (i.e. what "nwid" did).

> No need to explain lines command by command.  Keep it simple;  users
> must read ifconfig(8) anyway.
> 
> One might as well say to
> 
> ... and
> to enable automatic address configuration for IPv6 and IPv4, respectively.
> 
> Then we don't have the weird mix of conceptual words and technical bits,
> i.e. "connect to wifi" vs. "set if flags [they're picked up by network
> daemons, but we don't say which ones]".
> 
> DYNAMIC ADDRESS CONFIGURATION down below repeats all this, anyway.
> 
> Feedback? OK?
> 
> 
> Index: hostname.if.5
> ===
> RCS file: /cvs/src/share/man/man5/hostname.if.5,v
> retrieving revision 1.77
> diff -u -p -r1.77 hostname.if.5
> --- hostname.if.5 17 Jul 2021 15:28:31 -  1.77
> +++ hostname.if.5 11 Nov 2021 16:30:00 -
> @@ -67,21 +67,15 @@ inet 10.0.0.1 255.255.255.0 10.0.0.255 d
>  Each line is processed separately and in order.
>  For example:
>  .Bd -literal -offset indent
> -nwid mynwid wpakey mywpakey
> +join mynwid wpakey mywpakey
>  inet6 autoconf
>  inet autoconf
>  .Ed
>  .Pp
> -would run ifconfig three times to set the
> -.Cm nwid
> -and
> -.Cm wpakey
> -of the interface,
> -the
> -.Sy AUTOCONF6
> -flag and the
> -.Sy AUTOCONF4
> -flag, respectively.
> +would run ifconfig three times to
> +.Cm join
> +a wireless network using WPA
> +and enable dynamic address configuration, respectively.
>  .Sh STATIC ADDRESS CONFIGURATION
>  The following packed formats are valid for configuring network
>  interfaces with static addresses.
> 



Re: [PATCH] [src] share/man/man5/hostname.if.5 - nwid -> join

2021-11-11 Thread Jason McIntyre
On Thu, Nov 11, 2021 at 04:30:15PM +, Klemens Nanni wrote:
> On Thu, Nov 11, 2021 at 04:11:10PM +, Raf Czlonka wrote:
> > Hello,
> > 
> > It seems like this has been missed in recent thread[0].
> > 
> > Not entirely sure whether the sentence "flows" any longer but here
> > it goes anyway.
> > 
> > [0] https://marc.info/?l=openbsd-tech=163507448118443=2
> 
> Thanks, I missed that!
> 
> > Index: share/man/man5/hostname.if.5
> > ===
> > RCS file: /cvs/src/share/man/man5/hostname.if.5,v
> > retrieving revision 1.77
> > diff -u -p -r1.77 hostname.if.5
> > --- share/man/man5/hostname.if.517 Jul 2021 15:28:31 -  1.77
> > +++ share/man/man5/hostname.if.511 Nov 2021 16:09:33 -
> > @@ -67,13 +67,13 @@ inet 10.0.0.1 255.255.255.0 10.0.0.255 d
> >  Each line is processed separately and in order.
> >  For example:
> >  .Bd -literal -offset indent
> > -nwid mynwid wpakey mywpakey
> > +join mynwid wpakey mywpakey
> >  inet6 autoconf
> >  inet autoconf
> >  .Ed
> >  .Pp
> >  would run ifconfig three times to set the
> > -.Cm nwid
> > +.Cm join
> >  and
> >  .Cm wpakey
> >  of the interface,
> 
> Maybe this reads better in general?
> 
> would run ifconfig three times to join a wireless network using WPA and
> to set the AUTOCONF6 and AUTOCONF4 flags, respectively.
> 
> No need to explain lines command by command.  Keep it simple;  users
> must read ifconfig(8) anyway.
> 
> One might as well say to
> 
> ... and
> to enable automatic address configuration for IPv6 and IPv4, respectively.
> 
> Then we don't have the weird mix of conceptual words and technical bits,
> i.e. "connect to wifi" vs. "set if flags [they're picked up by network
> daemons, but we don't say which ones]".
> 
> DYNAMIC ADDRESS CONFIGURATION down below repeats all this, anyway.
> 
> Feedback? OK?
> 
> 
> Index: hostname.if.5
> ===
> RCS file: /cvs/src/share/man/man5/hostname.if.5,v
> retrieving revision 1.77
> diff -u -p -r1.77 hostname.if.5
> --- hostname.if.5 17 Jul 2021 15:28:31 -  1.77
> +++ hostname.if.5 11 Nov 2021 16:30:00 -
> @@ -67,21 +67,15 @@ inet 10.0.0.1 255.255.255.0 10.0.0.255 d
>  Each line is processed separately and in order.
>  For example:
>  .Bd -literal -offset indent
> -nwid mynwid wpakey mywpakey
> +join mynwid wpakey mywpakey
>  inet6 autoconf
>  inet autoconf
>  .Ed
>  .Pp
> -would run ifconfig three times to set the
> -.Cm nwid
> -and
> -.Cm wpakey
> -of the interface,
> -the
> -.Sy AUTOCONF6
> -flag and the
> -.Sy AUTOCONF4
> -flag, respectively.
> +would run ifconfig three times to
> +.Cm join
> +a wireless network using WPA
> +and enable dynamic address configuration, respectively.
>  .Sh STATIC ADDRESS CONFIGURATION
>  The following packed formats are valid for configuring network
>  interfaces with static addresses.
> 

hi.

i think this reads fine. i would not mark up "join" myself, but
whatever.

jmc



Re: [PATCH] [src] share/man/man5/hostname.if.5 - nwid -> join

2021-11-11 Thread Raf Czlonka
On Thu, Nov 11, 2021 at 04:30:15PM GMT, Klemens Nanni wrote:
> 
> Maybe this reads better in general?
> 
> would run ifconfig three times to join a wireless network using WPA and
> to set the AUTOCONF6 and AUTOCONF4 flags, respectively.
> 
> [...]
> 
> Feedback? OK?

FWIW, this looks much better to me.

Raf

> 
> Index: hostname.if.5
> ===
> RCS file: /cvs/src/share/man/man5/hostname.if.5,v
> retrieving revision 1.77
> diff -u -p -r1.77 hostname.if.5
> --- hostname.if.5 17 Jul 2021 15:28:31 -  1.77
> +++ hostname.if.5 11 Nov 2021 16:30:00 -
> @@ -67,21 +67,15 @@ inet 10.0.0.1 255.255.255.0 10.0.0.255 d
>  Each line is processed separately and in order.
>  For example:
>  .Bd -literal -offset indent
> -nwid mynwid wpakey mywpakey
> +join mynwid wpakey mywpakey
>  inet6 autoconf
>  inet autoconf
>  .Ed
>  .Pp
> -would run ifconfig three times to set the
> -.Cm nwid
> -and
> -.Cm wpakey
> -of the interface,
> -the
> -.Sy AUTOCONF6
> -flag and the
> -.Sy AUTOCONF4
> -flag, respectively.
> +would run ifconfig three times to
> +.Cm join
> +a wireless network using WPA
> +and enable dynamic address configuration, respectively.
>  .Sh STATIC ADDRESS CONFIGURATION
>  The following packed formats are valid for configuring network
>  interfaces with static addresses.



Re: [PATCH] [src] share/man/man5/hostname.if.5 - nwid -> join

2021-11-11 Thread Klemens Nanni
On Thu, Nov 11, 2021 at 04:11:10PM +, Raf Czlonka wrote:
> Hello,
> 
> It seems like this has been missed in recent thread[0].
> 
> Not entirely sure whether the sentence "flows" any longer but here
> it goes anyway.
> 
> [0] https://marc.info/?l=openbsd-tech=163507448118443=2

Thanks, I missed that!

> Index: share/man/man5/hostname.if.5
> ===
> RCS file: /cvs/src/share/man/man5/hostname.if.5,v
> retrieving revision 1.77
> diff -u -p -r1.77 hostname.if.5
> --- share/man/man5/hostname.if.5  17 Jul 2021 15:28:31 -  1.77
> +++ share/man/man5/hostname.if.5  11 Nov 2021 16:09:33 -
> @@ -67,13 +67,13 @@ inet 10.0.0.1 255.255.255.0 10.0.0.255 d
>  Each line is processed separately and in order.
>  For example:
>  .Bd -literal -offset indent
> -nwid mynwid wpakey mywpakey
> +join mynwid wpakey mywpakey
>  inet6 autoconf
>  inet autoconf
>  .Ed
>  .Pp
>  would run ifconfig three times to set the
> -.Cm nwid
> +.Cm join
>  and
>  .Cm wpakey
>  of the interface,

Maybe this reads better in general?

would run ifconfig three times to join a wireless network using WPA and
to set the AUTOCONF6 and AUTOCONF4 flags, respectively.

No need to explain lines command by command.  Keep it simple;  users
must read ifconfig(8) anyway.

One might as well say to

... and
to enable automatic address configuration for IPv6 and IPv4, respectively.

Then we don't have the weird mix of conceptual words and technical bits,
i.e. "connect to wifi" vs. "set if flags [they're picked up by network
daemons, but we don't say which ones]".

DYNAMIC ADDRESS CONFIGURATION down below repeats all this, anyway.

Feedback? OK?


Index: hostname.if.5
===
RCS file: /cvs/src/share/man/man5/hostname.if.5,v
retrieving revision 1.77
diff -u -p -r1.77 hostname.if.5
--- hostname.if.5   17 Jul 2021 15:28:31 -  1.77
+++ hostname.if.5   11 Nov 2021 16:30:00 -
@@ -67,21 +67,15 @@ inet 10.0.0.1 255.255.255.0 10.0.0.255 d
 Each line is processed separately and in order.
 For example:
 .Bd -literal -offset indent
-nwid mynwid wpakey mywpakey
+join mynwid wpakey mywpakey
 inet6 autoconf
 inet autoconf
 .Ed
 .Pp
-would run ifconfig three times to set the
-.Cm nwid
-and
-.Cm wpakey
-of the interface,
-the
-.Sy AUTOCONF6
-flag and the
-.Sy AUTOCONF4
-flag, respectively.
+would run ifconfig three times to
+.Cm join
+a wireless network using WPA
+and enable dynamic address configuration, respectively.
 .Sh STATIC ADDRESS CONFIGURATION
 The following packed formats are valid for configuring network
 interfaces with static addresses.



[PATCH] [src] share/man/man5/hostname.if.5 - nwid -> join

2021-11-11 Thread Raf Czlonka
Hello,

It seems like this has been missed in recent thread[0].

Not entirely sure whether the sentence "flows" any longer but here
it goes anyway.

[0] https://marc.info/?l=openbsd-tech=163507448118443=2

Cheers,

Raf

Index: share/man/man5/hostname.if.5
===
RCS file: /cvs/src/share/man/man5/hostname.if.5,v
retrieving revision 1.77
diff -u -p -r1.77 hostname.if.5
--- share/man/man5/hostname.if.517 Jul 2021 15:28:31 -  1.77
+++ share/man/man5/hostname.if.511 Nov 2021 16:09:33 -
@@ -67,13 +67,13 @@ inet 10.0.0.1 255.255.255.0 10.0.0.255 d
 Each line is processed separately and in order.
 For example:
 .Bd -literal -offset indent
-nwid mynwid wpakey mywpakey
+join mynwid wpakey mywpakey
 inet6 autoconf
 inet autoconf
 .Ed
 .Pp
 would run ifconfig three times to set the
-.Cm nwid
+.Cm join
 and
 .Cm wpakey
 of the interface,