Bug#1006216: [Pkg-shadow-devel] Bug#1006216: shadow: suggestions for man 8 groupadd

2022-03-06 Thread Serge E. Hallyn
Thank you, applied (with tiny changes) at github.com/shadow-maint/shadow.

On Mon, Feb 21, 2022 at 02:24:01PM +0100, Markus Hiereth wrote:
> Source: shadow
> Version: 4.8.1
> Severity: minor
> 
> Hi Serge,
> 
> I withdrew the changes you did not appreciate, kept the ones you did no 
> comment on and used the suggustions you made.
> 
> Attached the respective xml and diff files.
> 
> Best regards
> Markus
> 
> 
> 
> "Serge E. Hallyn"  schrieb am 20. Februar 2022 um 10:33
> > On Thu, Feb 17, 2022 at 09:43:59PM +0100, Markus Hiereth wrote:
> > > Hi Serge,
> > > 
> > > today I worked on the message catalogue for groupadd.8
> > > 
> > > I have no problems with understanding or translating this manual
> > > page. Nevertheless there are paragraphs for which I would suggest
> > > alternatives explanations. They are alreay in an attached xml-file.
> > > 
> > > Below, there is a diff with commments that allows you to jugde the
> > > suggestions.
> > > 
> > > Feel free to tell me what changes are welcome.
> > > 
> > > Best regards
> > > Markus
> > > 
> > > 
> > > --- shadow-4.8.1/man/groupadd.8.xml   2019-07-23 17:26:08.0 
> > > +0200
> > > +++ shadow-4.8.1_mh/man/groupadd.8.xml2022-02-17 16:30:14.284465573 
> > > +0100
> > > 
> 
> > > Elsewhere, capital letters are used for such arguments 
> > > 
> > > @@ -72,10 +72,10 @@
> > >  
> > >groupadd
> > >
> > > - options
> > > + OPTIONS
> > >
> > >
> > > - group
> > > + NEWGROUP
> > >
> > >  
> > >
> > > 
> 
> > > These two paragraphs come from section CAVEATS, but I think the are
> > > necessary parts of the section DESCRIPTION
> > > @@ -87,6 +87,15 @@
> > >values from the system. The new group will be entered into the 
> > > system
> > >files as needed.
> > >  
> > > + 
> > > +   Groupnames must start with a lower case letter or an underscore,
> > > +   followed by lower case letters, digits, underscores, or dashes.
> > > +   They can end with a dollar sign.
> > > +   In regular expression terms: [a-z_][a-z0-9_-]*[$]?
> > > + 
> > > + 
> > > +   Groupnames may only be up to _NAME_MAX_LENGTH; characters 
> > > long.
> > > + 
> > >
> > > 
> > > 
> 
> > > Changed due to my different view on the attribute "unique". For me, an
> > > ID that appears only once is an unique but in our context, it always
> > > deals with the relation between names and IDs.
> > > @@ -103,10 +112,11 @@
> > >   
> > > 
> > >   This option causes the command to simply exit with success
> > > - status if the specified group already exists. When used with
> > > - -g, and the specified GID already exists,
> > > - another (unique) GID is chosen (i.e. -g is
> > > - turned off).
> > > + status if the specified group already exists. When used
> > > + with -g and the specified GID already
> > > + exists, another one is chosen. As result, option
> > > + -g is turned off and the GID points in a
> > > + unique way to NEWGROUP.
> > 
> > Sorry, the new language is confusing to me.
> > 
> > Would simply doing 's/another (unique)/a different, unused, /' be
> > clearer to you?
> 
> Yes it would.
> 
>  
> > > I just replaced "this value" with "GID" which is used in the line above
> > > 
> > > @@ -115,8 +125,8 @@
> > > -g, 
> > > --gidGID
> > >   
> > >   
> > > -   The numerical value of the group's ID. This value must be
> > > - unique, unless the -o option is used. The value
> > > +   The numerical value of the group's ID. 
> > > GID 
> > > + must be unique, unless the -o option is used. The 
> > > value
> > >   must be non-negative. The default is to use the smallest ID
> > >   value greater than or equal to GID_MIN and
> > >   greater than every other group.
> > 
> > Ok.
> 
> > > Again, "unique-and-non-unique" stuff 
> > > 
> > > @@ -159,7 +169,10 @@
> > >   
> > >   
> > > 
> > > - This option permits to add a group with a non-unique GID.
> > > + permits the creation of a group with an already used
> > > + numerical ID. In turn, for this
> > > + GID, the mapping towards group
> > > + NEWGROUP will not be unique.
> > 
> > The more I see the substitutions, the more I think we should stick to
> > using the term "unique" everywhere.
> 
> OK
> 
> > > Explanation similar to the one in useradd.8 and usermod.8. Provides more 
> > > information about the implications.
> > > 
> > > @@ -169,11 +182,17 @@
> > >   
> > >   
> > > 
> > > - The encrypted password, as returned by 
> > > - crypt3
> > > - . The default is to disable the password.
> > > + defines an initial password for the group account. PASSWORD is 
> > > expected to
> > > +be encrypted, as returned by 
> > > crypt
> > > +3. 
> > 
> > Good.
> 
> > 
> > > 
> > > 
> > > +Without this option, the group account 

Bug#1006216: shadow: suggestions for man 8 groupadd

2022-02-21 Thread Markus Hiereth
Source: shadow
Version: 4.8.1
Severity: minor

Hi Serge,

I withdrew the changes you did not appreciate, kept the ones you did no 
comment on and used the suggustions you made.

Attached the respective xml and diff files.

Best regards
Markus



"Serge E. Hallyn"  schrieb am 20. Februar 2022 um 10:33
> On Thu, Feb 17, 2022 at 09:43:59PM +0100, Markus Hiereth wrote:
> > Hi Serge,
> > 
> > today I worked on the message catalogue for groupadd.8
> > 
> > I have no problems with understanding or translating this manual
> > page. Nevertheless there are paragraphs for which I would suggest
> > alternatives explanations. They are alreay in an attached xml-file.
> > 
> > Below, there is a diff with commments that allows you to jugde the
> > suggestions.
> > 
> > Feel free to tell me what changes are welcome.
> > 
> > Best regards
> > Markus
> > 
> > 
> > --- shadow-4.8.1/man/groupadd.8.xml 2019-07-23 17:26:08.0 +0200
> > +++ shadow-4.8.1_mh/man/groupadd.8.xml  2022-02-17 16:30:14.284465573 
> > +0100
> > 

> > Elsewhere, capital letters are used for such arguments 
> > 
> > @@ -72,10 +72,10 @@
> >  
> >groupadd
> >
> > -   options
> > +   OPTIONS
> >
> >
> > -   group
> > +   NEWGROUP
> >
> >  
> >
> > 

> > These two paragraphs come from section CAVEATS, but I think the are
> > necessary parts of the section DESCRIPTION
> > @@ -87,6 +87,15 @@
> >values from the system. The new group will be entered into the system
> >files as needed.
> >  
> > + 
> > +   Groupnames must start with a lower case letter or an underscore,
> > +   followed by lower case letters, digits, underscores, or dashes.
> > +   They can end with a dollar sign.
> > +   In regular expression terms: [a-z_][a-z0-9_-]*[$]?
> > + 
> > + 
> > +   Groupnames may only be up to _NAME_MAX_LENGTH; characters 
> > long.
> > + 
> >
> > 
> > 

> > Changed due to my different view on the attribute "unique". For me, an
> > ID that appears only once is an unique but in our context, it always
> > deals with the relation between names and IDs.
> > @@ -103,10 +112,11 @@
> > 
> >   
> > This option causes the command to simply exit with success
> > -   status if the specified group already exists. When used with
> > -   -g, and the specified GID already exists,
> > -   another (unique) GID is chosen (i.e. -g is
> > -   turned off).
> > +   status if the specified group already exists. When used
> > +   with -g and the specified GID already
> > +   exists, another one is chosen. As result, option
> > +   -g is turned off and the GID points in a
> > +   unique way to NEWGROUP.
> 
> Sorry, the new language is confusing to me.
> 
> Would simply doing 's/another (unique)/a different, unused, /' be
> clearer to you?

Yes it would.

 
> > I just replaced "this value" with "GID" which is used in the line above
> > 
> > @@ -115,8 +125,8 @@
> >   -g, 
> > --gidGID
> > 
> > 
> > - The numerical value of the group's ID. This value must be
> > -   unique, unless the -o option is used. The value
> > + The numerical value of the group's ID. 
> > GID 
> > +   must be unique, unless the -o option is used. The 
> > value
> > must be non-negative. The default is to use the smallest ID
> > value greater than or equal to GID_MIN and
> > greater than every other group.
> 
> Ok.

> > Again, "unique-and-non-unique" stuff 
> > 
> > @@ -159,7 +169,10 @@
> > 
> > 
> >   
> > -   This option permits to add a group with a non-unique GID.
> > +   permits the creation of a group with an already used
> > +   numerical ID. In turn, for this
> > +   GID, the mapping towards group
> > +   NEWGROUP will not be unique.
> 
> The more I see the substitutions, the more I think we should stick to
> using the term "unique" everywhere.

OK

> > Explanation similar to the one in useradd.8 and usermod.8. Provides more 
> > information about the implications.
> > 
> > @@ -169,11 +182,17 @@
> > 
> > 
> >   
> > -   The encrypted password, as returned by 
> > -   crypt3
> > -   . The default is to disable the password.
> > +   defines an initial password for the group account. PASSWORD is 
> > expected to
> > +be encrypted, as returned by crypt
> > +3. 
> 
> Good.

> 
> >   
> >   
> > +Without this option, the group account will be locked and
> > +with no password defined, i.e. a single exclamation mark
> > +in the respective field of ths system account file 
> > +/etc/group or 
> > /etc/gshadow.
> > +  
> > + 
> > Note: This option is not
> > recommended because the password (or encrypted password) will
> > be visible by users listing the