[Pkg-shadow-devel] minor issues on manual page pwck

[Serge E. Hallyn]

On Wed, Feb 16, 2022 at 09:42:34PM +0100, Markus Hiereth wrote:
> Hi Serge and shadow-utils developers
> 
> a few remarks on this manual page. I do not know whether a bug report
> or a patch are appreciated.
> 
> Best regards
> Markus
> 
> 
> 69   <refnamediv id='name'>
> 70     <refname>pwck</refname>
> 71     <refpurpose>verify integrity of password files</refpurpose>
> 72   </refnamediv>
>  
> s/verify integrity/verify the integrity
> 
> --------
> 
> 75     <cmdsynopsis>
> 76       <command>pwck</command>
> 77       <arg choice='opt'>options</arg>
> 78       <arg choice='opt'>
> 79         <arg choice='plain'>
> 80           <replaceable>passwd</replaceable>
> 81         </arg>
> 82         <arg choice='opt'>
> 83           <arg choice='plain'>
> 84             <replaceable>shadow</replaceable>
> 85           </arg>
> 86         </arg>
> 87       </arg>
> 88     </cmdsynopsis>
> 
> Replaceables appear in capital letters elsewhere, the name of the
> argument shall indicate that the name of the two files is not
> pre-defined, thus write:
> 
> 80           <replaceable>PASSWORDFILE</replaceable>
> 84           <replaceable>SHADOWFILE</replaceable>
> 
> --------
> 
> 128       <filename>shadow</filename> checks are enabled when a second file
> 129       parameter is specified or when <filename>/etc/shadow</filename>
> 130       exists on the system.
> 
> I think "shadow" in "shadow checks" is meant in a general
> sense. Therefore, if xml is used for mark-up, it should not be the filename element, but the replaceable element. Or write:
> 
> 128     Checks for shadowed password information are enabled when a second 
> 129     file parameter is specified or when <filename>/etc/shadow</filename>

That's all fine.

> --------
> 
> 162     checks will still be made. All other errors are warning and the user
> 163     is encouraged to run the <command>usermod</command> command to correct
> 
> Is "warning" here the participe present from the verb "to warn". In
> case it is the plural of the noun "a warning", add the plural-s. Or write:
> 
> ... All other errors warn the user and encourage him to run the <command>usermod</command>

It's just meant as the plural of warning, so simplest would be to just
say 'All other errors are warnings and..." 

thanks,
-serge