Re: man pages diff

[Rob Pierce]

> From: "Alexander Hall" <alexan...@beard.se>
> To: "Jason McIntyre" <j...@kerhand.co.uk>, "misc" <misc@openbsd.org>
> Cc: "Ingo Schwarze" <schwa...@usta.de>
> Sent: Saturday, April 9, 2016 4:15:10 AM
> Subject: Re: man pages diff

> On April 7, 2016 10:40:24 PM GMT+02:00, Jason McIntyre <j...@kerhand.co.uk>
> wrote:
> >On Thu, Apr 07, 2016 at 10:13:02PM +0200, Ingo Schwarze wrote:
> >> Hi,

> >> Jason McIntyre wrote on Thu, Apr 07, 2016 at 08:35:52PM +0100:
> >> > On Thu, Apr 07, 2016 at 03:15:01PM -0400, Rob Pierce wrote:

> >> >> Change "super user" to "superuser".

> >> > hmm. you have the weight of the man pages behind you, since they
> >> > overwhelmingly use "superuser".

> >> In that case, ...

> >> > the trouble is, i don;t think "super
> >> > user" is wrong, and i'm reluctant to do this...

I just noticed this in afterboot.1 under the "Root password" section:

"Note that throughout the documentation, the term "superuser" is a synonym for
the root user."

Rob

Re: man pages diff

[lists]

Thu, 7 Apr 2016 21:40:24 +0100 Jason McIntyre 
> On Thu, Apr 07, 2016 at 10:13:02PM +0200, Ingo Schwarze wrote:
> > Hi,
> > 
> > Jason McIntyre wrote on Thu, Apr 07, 2016 at 08:35:52PM +0100:  
> > > On Thu, Apr 07, 2016 at 03:15:01PM -0400, Rob Pierce wrote:  
> >   
> > >> Change "super user" to "superuser".  
> >   
> > > hmm. you have the weight of the man pages behind you, since they
> > > overwhelmingly use "superuser".  
> > 
> > In that case, ...
> >   
> > > the trouble is, i don;t think "super
> > > user" is wrong, and i'm reluctant to do this...
> > > 
> > > i've made changes like this before, when we have a real majority of
> > > spelling leading one way. but they always creep back in. i think we
> > > should just accept that we can spell things more than one way sometimes.
> > > 
> > > but then grep ;(
> > > 
> > > jmc, indecisive...  
> > 
> >  ... just commit it, in particular when the work was already done.
> > 
> > Sure, it's not a big deal either way, and it doesn't do much harm
> > if a few spelling variants creep back in, no need to waste a lot
> > of time paying attention that they don't, but if we can improve
> > consistency almost for free, why not?
> > 
> > It can also help developers who look for spelling help in existing
> > pages if they find consistent usage.  That tends to reduce the time
> > spent trying to figure out whether there is a preferred form.  On
> > the other hand, consistency doesn't slow down people who don't care
> > as long as we don't yell at them.
> > 
> > Yours,
> >   Ingo
> >   
> 
> hi.
> 
> as far as i'm concerned, "super user" is not wrong.

it is wrong, however, to use two words in place of one, so backing up
the single word "superuser" change suggestion, would commit it without
much thought why 'not', as more reasons exist towards why 'yes', thanks

> for me, there's not a clear enough benefit to make the change. and i
> don;t like to somehow enforce spelling in a particular way.

1 space saved
easier grep (saves mind and fingers)
consistency path forward

we can rumble 2 min longer, yet please converge towards simplicity

> > > > Index: src/share/man/man4/pty.4
> > > > ===
> > > > RCS file: /cvs/src/share/man/man4/pty.4,v
> > > > retrieving revision 1.21
> > > > diff -u -p -r1.21 pty.4
> > > > --- src/share/man/man4/pty.421 Nov 2015 08:04:20 -  1.21
> > > > +++ src/share/man/man4/pty.47 Apr 2016 19:12:07 -
> > > > @@ -298,7 +298,7 @@ device nodes following the naming conven
> > > >  .Ox .
> > > >  Since
> > > >  .Pa ptm
> > > > -impersonates the super user for some operations it needs to perform
> > > > +impersonates the superuser for some operations it needs to perform
> > > >  to complete the allocation of a pseudo terminal, the
> > > >  .Pa /dev
> > > > -directory must also be writeable by the super user.
> > > > +directory must also be writeable by the superuser.
> > > > 
> > > > Index: src/share/man/man5/login.conf.5
> > > > ===
> > > > RCS file: /cvs/src/share/man/man5/login.conf.5,v
> > > > retrieving revision 1.62
> > > > diff -u -p -r1.62 login.conf.5
> > > > --- src/share/man/man5/login.conf.5 30 Mar 2016 06:58:06 -  
> > > > 1.62
> > > > +++ src/share/man/man5/login.conf.5 7 Apr 2016 19:12:07 -
> > > > @@ -683,7 +683,7 @@ to indicate if the user is in group whee
> > > >  Some authentication types require the user to be in group wheel when 
> > > > using
> > > >  the
> > > >  .Xr su 1
> > > > -program to become super user.
> > > > +program to become superuser.
> > > >  .El
> > > >  .Pp
> > > >  When the authentication program is executed,
> > > > 
> > > > Index: src/usr.sbin/cron/crontab.1
> > > > ===
> > > > RCS file: /cvs/src/usr.sbin/cron/crontab.1,v
> > > > retrieving revision 1.33
> > > > diff -u -p -r1.33 crontab.1
> > > > --- src/usr.sbin/cron/crontab.1 26 Oct 2015 15:50:06 -  1.33
> > > > +++ src/usr.sbin/cron/crontab.1 7 Apr 2016 19:12:07 -
> > > > @@ -65,7 +65,7 @@ be listed in the
> > > >  .Pa /var/cron/cron.deny
> > > >  file in order to use
> > > >  .Nm .
> > > > -If neither of these files exists then only the super user
> > > > +If neither of these files exists then only the superuser
> > > >  will be allowed to use
> > > >  .Nm .
> > > >  .Em NOTE :  

Re: man pages diff

[Alexander Hall]

On April 7, 2016 10:40:24 PM GMT+02:00, Jason McIntyre  
wrote:
>On Thu, Apr 07, 2016 at 10:13:02PM +0200, Ingo Schwarze wrote:
>> Hi,
>> 
>> Jason McIntyre wrote on Thu, Apr 07, 2016 at 08:35:52PM +0100:
>> > On Thu, Apr 07, 2016 at 03:15:01PM -0400, Rob Pierce wrote:
>> 
>> >> Change "super user" to "superuser".
>> 
>> > hmm. you have the weight of the man pages behind you, since they
>> > overwhelmingly use "superuser".
>> 
>> In that case, ...
>> 
>> > the trouble is, i don;t think "super
>> > user" is wrong, and i'm reluctant to do this...
>> > 
>> > i've made changes like this before, when we have a real majority of
>> > spelling leading one way. but they always creep back in. i think we
>> > should just accept that we can spell things more than one way
>sometimes.
>> > 
>> > but then grep ;(
>> > 
>> > jmc, indecisive...
>> 
>>  ... just commit it, in particular when the work was already done.
>> 
>> Sure, it's not a big deal either way, and it doesn't do much harm
>> if a few spelling variants creep back in, no need to waste a lot
>> of time paying attention that they don't, but if we can improve
>> consistency almost for free, why not?
>> 
>> It can also help developers who look for spelling help in existing
>> pages if they find consistent usage.  That tends to reduce the time
>> spent trying to figure out whether there is a preferred form.  On
>> the other hand, consistency doesn't slow down people who don't care
>> as long as we don't yell at them.
>> 
>> Yours,
>>   Ingo
>> 
>
>hi.
>
>as far as i'm concerned, "super user" is not wrong. that's the rub. we
>have lots of alternate spellings in english, and i don;t see the point
>of trying to enforce one or the other. if they were spelled differently
>within the same page, then yes, fair enough.

I can't help comparing "superman" to "super man". It's a role or name which we 
seem to prefer - "the superuser" - rather than a great person with a login - "a 
super user". I'm sure the English language is flexible or ambiguous enough to 
prove me wrong, but that's my 2 cents anyway. 

/Alexander 

>
>for me, there's not a clear enough benefit to make the change. and i
>don;t like to somehow enforce spelling in a particular way.
>
>jmc
>
>> 
>> > > Index: src/share/man/man4/pty.4
>> > >
>===
>> > > RCS file: /cvs/src/share/man/man4/pty.4,v
>> > > retrieving revision 1.21
>> > > diff -u -p -r1.21 pty.4
>> > > --- src/share/man/man4/pty.4 21 Nov 2015 08:04:20 -  1.21
>> > > +++ src/share/man/man4/pty.4 7 Apr 2016 19:12:07 -
>> > > @@ -298,7 +298,7 @@ device nodes following the naming conven
>> > >  .Ox .
>> > >  Since
>> > >  .Pa ptm
>> > > -impersonates the super user for some operations it needs to
>perform
>> > > +impersonates the superuser for some operations it needs to
>perform
>> > >  to complete the allocation of a pseudo terminal, the
>> > >  .Pa /dev
>> > > -directory must also be writeable by the super user.
>> > > +directory must also be writeable by the superuser.
>> > > 
>> > > Index: src/share/man/man5/login.conf.5
>> > >
>===
>> > > RCS file: /cvs/src/share/man/man5/login.conf.5,v
>> > > retrieving revision 1.62
>> > > diff -u -p -r1.62 login.conf.5
>> > > --- src/share/man/man5/login.conf.5  30 Mar 2016 06:58:06
>-  1.62
>> > > +++ src/share/man/man5/login.conf.5  7 Apr 2016 19:12:07 -
>> > > @@ -683,7 +683,7 @@ to indicate if the user is in group whee
>> > >  Some authentication types require the user to be in group wheel
>when using
>> > >  the
>> > >  .Xr su 1
>> > > -program to become super user.
>> > > +program to become superuser.
>> > >  .El
>> > >  .Pp
>> > >  When the authentication program is executed,
>> > > 
>> > > Index: src/usr.sbin/cron/crontab.1
>> > >
>===
>> > > RCS file: /cvs/src/usr.sbin/cron/crontab.1,v
>> > > retrieving revision 1.33
>> > > diff -u -p -r1.33 crontab.1
>> > > --- src/usr.sbin/cron/crontab.1  26 Oct 2015 15:50:06 -  1.33
>> > > +++ src/usr.sbin/cron/crontab.1  7 Apr 2016 19:12:07 -
>> > > @@ -65,7 +65,7 @@ be listed in the
>> > >  .Pa /var/cron/cron.deny
>> > >  file in order to use
>> > >  .Nm .
>> > > -If neither of these files exists then only the super user
>> > > +If neither of these files exists then only the superuser
>> > >  will be allowed to use
>> > >  .Nm .
>> > >  .Em NOTE :

Re: man pages diff

[Jason McIntyre]

On Thu, Apr 07, 2016 at 10:13:02PM +0200, Ingo Schwarze wrote:
> Hi,
> 
> Jason McIntyre wrote on Thu, Apr 07, 2016 at 08:35:52PM +0100:
> > On Thu, Apr 07, 2016 at 03:15:01PM -0400, Rob Pierce wrote:
> 
> >> Change "super user" to "superuser".
> 
> > hmm. you have the weight of the man pages behind you, since they
> > overwhelmingly use "superuser".
> 
> In that case, ...
> 
> > the trouble is, i don;t think "super
> > user" is wrong, and i'm reluctant to do this...
> > 
> > i've made changes like this before, when we have a real majority of
> > spelling leading one way. but they always creep back in. i think we
> > should just accept that we can spell things more than one way sometimes.
> > 
> > but then grep ;(
> > 
> > jmc, indecisive...
> 
>  ... just commit it, in particular when the work was already done.
> 
> Sure, it's not a big deal either way, and it doesn't do much harm
> if a few spelling variants creep back in, no need to waste a lot
> of time paying attention that they don't, but if we can improve
> consistency almost for free, why not?
> 
> It can also help developers who look for spelling help in existing
> pages if they find consistent usage.  That tends to reduce the time
> spent trying to figure out whether there is a preferred form.  On
> the other hand, consistency doesn't slow down people who don't care
> as long as we don't yell at them.
> 
> Yours,
>   Ingo
> 

hi.

as far as i'm concerned, "super user" is not wrong. that's the rub. we
have lots of alternate spellings in english, and i don;t see the point
of trying to enforce one or the other. if they were spelled differently
within the same page, then yes, fair enough.

for me, there's not a clear enough benefit to make the change. and i
don;t like to somehow enforce spelling in a particular way.

jmc

> 
> > > Index: src/share/man/man4/pty.4
> > > ===
> > > RCS file: /cvs/src/share/man/man4/pty.4,v
> > > retrieving revision 1.21
> > > diff -u -p -r1.21 pty.4
> > > --- src/share/man/man4/pty.4  21 Nov 2015 08:04:20 -  1.21
> > > +++ src/share/man/man4/pty.4  7 Apr 2016 19:12:07 -
> > > @@ -298,7 +298,7 @@ device nodes following the naming conven
> > >  .Ox .
> > >  Since
> > >  .Pa ptm
> > > -impersonates the super user for some operations it needs to perform
> > > +impersonates the superuser for some operations it needs to perform
> > >  to complete the allocation of a pseudo terminal, the
> > >  .Pa /dev
> > > -directory must also be writeable by the super user.
> > > +directory must also be writeable by the superuser.
> > > 
> > > Index: src/share/man/man5/login.conf.5
> > > ===
> > > RCS file: /cvs/src/share/man/man5/login.conf.5,v
> > > retrieving revision 1.62
> > > diff -u -p -r1.62 login.conf.5
> > > --- src/share/man/man5/login.conf.5   30 Mar 2016 06:58:06 -  
> > > 1.62
> > > +++ src/share/man/man5/login.conf.5   7 Apr 2016 19:12:07 -
> > > @@ -683,7 +683,7 @@ to indicate if the user is in group whee
> > >  Some authentication types require the user to be in group wheel when 
> > > using
> > >  the
> > >  .Xr su 1
> > > -program to become super user.
> > > +program to become superuser.
> > >  .El
> > >  .Pp
> > >  When the authentication program is executed,
> > > 
> > > Index: src/usr.sbin/cron/crontab.1
> > > ===
> > > RCS file: /cvs/src/usr.sbin/cron/crontab.1,v
> > > retrieving revision 1.33
> > > diff -u -p -r1.33 crontab.1
> > > --- src/usr.sbin/cron/crontab.1   26 Oct 2015 15:50:06 -  1.33
> > > +++ src/usr.sbin/cron/crontab.1   7 Apr 2016 19:12:07 -
> > > @@ -65,7 +65,7 @@ be listed in the
> > >  .Pa /var/cron/cron.deny
> > >  file in order to use
> > >  .Nm .
> > > -If neither of these files exists then only the super user
> > > +If neither of these files exists then only the superuser
> > >  will be allowed to use
> > >  .Nm .
> > >  .Em NOTE :

Re: man pages diff

[Ingo Schwarze]

Hi,

Jason McIntyre wrote on Thu, Apr 07, 2016 at 08:35:52PM +0100:
> On Thu, Apr 07, 2016 at 03:15:01PM -0400, Rob Pierce wrote:

>> Change "super user" to "superuser".

> hmm. you have the weight of the man pages behind you, since they
> overwhelmingly use "superuser".

In that case, ...

> the trouble is, i don;t think "super
> user" is wrong, and i'm reluctant to do this...
> 
> i've made changes like this before, when we have a real majority of
> spelling leading one way. but they always creep back in. i think we
> should just accept that we can spell things more than one way sometimes.
> 
> but then grep ;(
> 
> jmc, indecisive...

 ... just commit it, in particular when the work was already done.

Sure, it's not a big deal either way, and it doesn't do much harm
if a few spelling variants creep back in, no need to waste a lot
of time paying attention that they don't, but if we can improve
consistency almost for free, why not?

It can also help developers who look for spelling help in existing
pages if they find consistent usage.  That tends to reduce the time
spent trying to figure out whether there is a preferred form.  On
the other hand, consistency doesn't slow down people who don't care
as long as we don't yell at them.

Yours,
  Ingo


> > Index: src/share/man/man4/pty.4
> > ===
> > RCS file: /cvs/src/share/man/man4/pty.4,v
> > retrieving revision 1.21
> > diff -u -p -r1.21 pty.4
> > --- src/share/man/man4/pty.421 Nov 2015 08:04:20 -  1.21
> > +++ src/share/man/man4/pty.47 Apr 2016 19:12:07 -
> > @@ -298,7 +298,7 @@ device nodes following the naming conven
> >  .Ox .
> >  Since
> >  .Pa ptm
> > -impersonates the super user for some operations it needs to perform
> > +impersonates the superuser for some operations it needs to perform
> >  to complete the allocation of a pseudo terminal, the
> >  .Pa /dev
> > -directory must also be writeable by the super user.
> > +directory must also be writeable by the superuser.
> > 
> > Index: src/share/man/man5/login.conf.5
> > ===
> > RCS file: /cvs/src/share/man/man5/login.conf.5,v
> > retrieving revision 1.62
> > diff -u -p -r1.62 login.conf.5
> > --- src/share/man/man5/login.conf.5 30 Mar 2016 06:58:06 -  1.62
> > +++ src/share/man/man5/login.conf.5 7 Apr 2016 19:12:07 -
> > @@ -683,7 +683,7 @@ to indicate if the user is in group whee
> >  Some authentication types require the user to be in group wheel when using
> >  the
> >  .Xr su 1
> > -program to become super user.
> > +program to become superuser.
> >  .El
> >  .Pp
> >  When the authentication program is executed,
> > 
> > Index: src/usr.sbin/cron/crontab.1
> > ===
> > RCS file: /cvs/src/usr.sbin/cron/crontab.1,v
> > retrieving revision 1.33
> > diff -u -p -r1.33 crontab.1
> > --- src/usr.sbin/cron/crontab.1 26 Oct 2015 15:50:06 -  1.33
> > +++ src/usr.sbin/cron/crontab.1 7 Apr 2016 19:12:07 -
> > @@ -65,7 +65,7 @@ be listed in the
> >  .Pa /var/cron/cron.deny
> >  file in order to use
> >  .Nm .
> > -If neither of these files exists then only the super user
> > +If neither of these files exists then only the superuser
> >  will be allowed to use
> >  .Nm .
> >  .Em NOTE :

Re: man pages diff

[Jason McIntyre]

On Thu, Apr 07, 2016 at 03:15:01PM -0400, Rob Pierce wrote:
> Change "super user" to "superuser".
> 
> Rob
> 

hmm. you have the weight of the man pages behind you, since they
overwhelmingly use "superuser". the trouble is, i don;t think "super
user" is wrong, and i'm reluctant to do this...

i've made changes like this before, when we have a real majority of
spelling leading one way. but they always creep back in. i think we
should just accept that we can spell things more than one way sometimes.

but then grep ;(

jmc, indecisive...

> Index: src/share/man/man4/pty.4
> ===
> RCS file: /cvs/src/share/man/man4/pty.4,v
> retrieving revision 1.21
> diff -u -p -r1.21 pty.4
> --- src/share/man/man4/pty.4  21 Nov 2015 08:04:20 -  1.21
> +++ src/share/man/man4/pty.4  7 Apr 2016 19:12:07 -
> @@ -298,7 +298,7 @@ device nodes following the naming conven
>  .Ox .
>  Since
>  .Pa ptm
> -impersonates the super user for some operations it needs to perform
> +impersonates the superuser for some operations it needs to perform
>  to complete the allocation of a pseudo terminal, the
>  .Pa /dev
> -directory must also be writeable by the super user.
> +directory must also be writeable by the superuser.
> 
> Index: src/share/man/man5/login.conf.5
> ===
> RCS file: /cvs/src/share/man/man5/login.conf.5,v
> retrieving revision 1.62
> diff -u -p -r1.62 login.conf.5
> --- src/share/man/man5/login.conf.5   30 Mar 2016 06:58:06 -  1.62
> +++ src/share/man/man5/login.conf.5   7 Apr 2016 19:12:07 -
> @@ -683,7 +683,7 @@ to indicate if the user is in group whee
>  Some authentication types require the user to be in group wheel when using
>  the
>  .Xr su 1
> -program to become super user.
> +program to become superuser.
>  .El
>  .Pp
>  When the authentication program is executed,
> 
> Index: src/usr.sbin/cron/crontab.1
> ===
> RCS file: /cvs/src/usr.sbin/cron/crontab.1,v
> retrieving revision 1.33
> diff -u -p -r1.33 crontab.1
> --- src/usr.sbin/cron/crontab.1   26 Oct 2015 15:50:06 -  1.33
> +++ src/usr.sbin/cron/crontab.1   7 Apr 2016 19:12:07 -
> @@ -65,7 +65,7 @@ be listed in the
>  .Pa /var/cron/cron.deny
>  file in order to use
>  .Nm .
> -If neither of these files exists then only the super user
> +If neither of these files exists then only the superuser
>  will be allowed to use
>  .Nm .
>  .Em NOTE :

man pages diff

[Rob Pierce]

Change "super user" to "superuser".

Rob

Index: src/share/man/man4/pty.4
===
RCS file: /cvs/src/share/man/man4/pty.4,v
retrieving revision 1.21
diff -u -p -r1.21 pty.4
--- src/share/man/man4/pty.421 Nov 2015 08:04:20 -  1.21
+++ src/share/man/man4/pty.47 Apr 2016 19:12:07 -
@@ -298,7 +298,7 @@ device nodes following the naming conven
 .Ox .
 Since
 .Pa ptm
-impersonates the super user for some operations it needs to perform
+impersonates the superuser for some operations it needs to perform
 to complete the allocation of a pseudo terminal, the
 .Pa /dev
-directory must also be writeable by the super user.
+directory must also be writeable by the superuser.

Index: src/share/man/man5/login.conf.5
===
RCS file: /cvs/src/share/man/man5/login.conf.5,v
retrieving revision 1.62
diff -u -p -r1.62 login.conf.5
--- src/share/man/man5/login.conf.5 30 Mar 2016 06:58:06 -  1.62
+++ src/share/man/man5/login.conf.5 7 Apr 2016 19:12:07 -
@@ -683,7 +683,7 @@ to indicate if the user is in group whee
 Some authentication types require the user to be in group wheel when using
 the
 .Xr su 1
-program to become super user.
+program to become superuser.
 .El
 .Pp
 When the authentication program is executed,

Index: src/usr.sbin/cron/crontab.1
===
RCS file: /cvs/src/usr.sbin/cron/crontab.1,v
retrieving revision 1.33
diff -u -p -r1.33 crontab.1
--- src/usr.sbin/cron/crontab.1 26 Oct 2015 15:50:06 -  1.33
+++ src/usr.sbin/cron/crontab.1 7 Apr 2016 19:12:07 -
@@ -65,7 +65,7 @@ be listed in the
 .Pa /var/cron/cron.deny
 file in order to use
 .Nm .
-If neither of these files exists then only the super user
+If neither of these files exists then only the superuser
 will be allowed to use
 .Nm .
 .Em NOTE :