On Mon, Apr 13, 2009 at 15:45, Junio C Hamano [off-list ref] 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.