Re: RFC [patch] adding docstrings

[Benno Schulenberg <bensberg@justemail.net>]

On Fri, Dec 19, 2014, at 10:09, Karel Zak wrote:
> On Wed, Dec 17, 2014 at 09:20:31PM +0100, Benno Schulenberg wrote:
> > For mkfs.cramfs, mkfs.minix, blkid and chrt I've had to
> > improvise -- putting the docstring before the synopis -- in order to
> > avoid making extensive changes to the usage text; those changes will
> > come later.)
> 
> hmm.. it would be better to be consistent and add the docstring to the
> same position in all utils.

Certainly.  These improvisations were meant as temporary measures.
A later patch would slice up and standardize the usage texts of the
mentioned utils and put the docstring into its proper place -- I just
wanted to avoid burdening this patch with such extensive and fairly
unrelated changes.

Probably it is better not to make temporary changes, so I will drop
the docstrings for the mentioned tools from the next version of the
patch.

By the way, there was some talk of obsoleting / scrapping / deleting
some of the utils.  Are there still such plans?  If so, it is maybe
better not to add docstrings for the tools that are going to be zapped
in the next cycle or so?

> you forgot _() NLS macro:
> 
> > +	fputs("Tell the kernel about the existence of a specified partition.\n", out);

Thanks.

Benno

-- 
http://www.fastmail.com - Or how I learned to stop worrying and
                          love email again