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

2 messages, 2 authors, 2016-06-15 · open the first message on its own page

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

From: Junio C Hamano <hidden>
Date: 2016-06-15 22:46:36

I
Michael Witten [off-list ref] writes:
quoted hunk
n particular, sendemail.confirm was removed, because it's already
described along with its corresponding option.

Signed-off-by: Michael Witten <redacted>
---
 Documentation/git-send-email.txt |    6 ------
 1 files changed, 0 insertions(+), 6 deletions(-)
diff --git a/Documentation/git-send-email.txt b/Documentation/git-send-email.txt
index 7b87d6e..b58b433 100644
--- a/Documentation/git-send-email.txt
+++ b/Documentation/git-send-email.txt
@@ -271,12 +271,6 @@ sendemail.multiedit::
 	summary when '--compose' is used). If false, files will be edited one
 	after the other, spawning a new editor each time.
 
-sendemail.confirm::
-	Sets the default for whether to confirm before sending. Must be
-	one of 'always', 'never', 'cc', 'compose', or 'auto'. See '--confirm'
-	in the previous section for the meaning of these values.
I am not sure if this is a good idea.  It may look "superfluous" for
people who read the manual cover-to-cover.  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.

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

From: Michael Witten <hidden>
Date: 2016-06-15 22:46:36

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.
Keyboard shortcuts
hback out one level
jnext message in thread
kprevious message in thread
ldrill in
Escclose help / fold thread tree
?toggle this help