Re: [PATCH RFC3 03/13] Docs: send-email: Remove superfluous information in CONFIGURATION
- From
Michael Witten <mfwitten@gmail.com>
- Date
- Apr 13, 2009, 22:30 UTC
- Message-ID
- <b4087cc50904131530p75cdc59cu57b6c0d697409d86@mail.gmail.com>
- In-Reply-To
- <7vljq4e10q.fsf@gitster.siamese.dyndns.org>
On Mon, Apr 13, 2009 at 15:45, Junio C Hamano <gitster@pobox.com> 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?
Show 5 quoted lines
> 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.