Re: [PATCH RFC3 03/13] Docs: send-email: Remove superfluous information in CONFIGURATION

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

 



On Mon, Apr 13, 2009 at 15:45, Junio C Hamano <gitster@xxxxxxxxx> wrote:
> I am not sure if this is a good idea.  It may look "superfluous" for
> people who read the manual cover-to-cover.

People don't do this? How else are you supposed to know what's going on?

> However, a new person whose
> mentor allowed her to peek into his configuration to learn tricks from may
> find sendemail.confirm and would try to find an entry in the manual.  The
> change in this patch will make it inconvenient to go from variable to
> description.

Well, couldn't she search? I doubt she'd try to look in the CONFIGURATION
section anyway. I certainly wouldn't know about it without more experience.

Anyway, it's actually how this man page has been organized for a while; you'll
notice that the CONFIGURATION section is pretty empty.

Perhaps the CONFIGURATION section should at least reference the associated
command line argument, where a description can be found.
--
To unsubscribe from this list: send the line "unsubscribe git" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at  http://vger.kernel.org/majordomo-info.html

[Index of Archives]     [Linux Kernel Development]     [Gcc Help]     [IETF Annouce]     [DCCP]     [Netdev]     [Networking]     [Security]     [V4L]     [Bugtraq]     [Yosemite]     [MIPS Linux]     [ARM Linux]     [Linux Security]     [Linux RAID]     [Linux SCSI]     [Fedora Users]