Re: RFC [patch] adding docstrings

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



On Thu, Dec 18, 2014, at 10:20, Adam Sampson wrote:
> Benno Schulenberg <bensberg@xxxxxxxxxxxxx> writes:
> > This patch adds a docstring (a one-line description) to each of the
> > utilities.
> 
> Is it worth synchronising these descriptions with the one-liners in the
> "NAME" sections of the man pages (i.e. what apropos shows)?

I think so.  In a later, different patch we can do that.

> I think the
> one you've come up with for addpart is clearer than the existing one in
> the man page, for example...

Thanks.  At first, like Steven, I just yanked (by script) the description
from the man page into the usage text, and then tried to improve those
descriptions.  But I soon ran out of ideas and therefore asked for help.

Benno

-- 
http://www.fastmail.com - Access your email from home and the web

--
To unsubscribe from this list: send the line "unsubscribe util-linux" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at  http://vger.kernel.org/majordomo-info.html




[Index of Archives]     [Netdev]     [Ethernet Bridging]     [Linux Wireless]     [Kernel Newbies]     [Security]     [Linux for Hams]     [Netfilter]     [Bugtraq]     [Yosemite News]     [MIPS Linux]     [ARM Linux]     [Linux RAID]     [Linux Admin]     [Samba]

  Powered by Linux