Skip to content

Commit bac1d52

Browse files
avargitster
authored andcommitted
send-email docs: de-duplicate configuration sections
De-duplicate the discussion of "send-email" configuration, such that the "git-config(1)" manual page becomes the source of truth, and "git-send-email(1)" includes the relevant part. Most commands that suffered from such duplication had diverging text discussing the same variables, but in this case some config was also only discussed in one or the other. This is mostly a move-only change, the exception is a minor rewording of changing wording like "see above" to "see linkgit:git-config[1]", as well as a clarification about the big section of command-line option tweaking config being discussed in git-send-email(1)'s main docs. Signed-off-by: Ævar Arnfjörð Bjarmason <[email protected]> Reviewed-by: Matheus Tavares <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent a2811dd commit bac1d52

File tree

2 files changed

+39
-37
lines changed

2 files changed

+39
-37
lines changed

Documentation/config/sendemail.txt

Lines changed: 37 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,17 +18,49 @@ sendemail.<identity>.*::
1818
identity is selected, through either the command-line or
1919
`sendemail.identity`.
2020

21+
sendemail.multiEdit::
22+
If true (default), a single editor instance will be spawned to edit
23+
files you have to edit (patches when `--annotate` is used, and the
24+
summary when `--compose` is used). If false, files will be edited one
25+
after the other, spawning a new editor each time.
26+
27+
sendemail.confirm::
28+
Sets the default for whether to confirm before sending. Must be
29+
one of 'always', 'never', 'cc', 'compose', or 'auto'. See `--confirm`
30+
in the linkgit:git-send-email[1] documentation for the meaning of these
31+
values.
32+
2133
sendemail.aliasesFile::
34+
To avoid typing long email addresses, point this to one or more
35+
email aliases files. You must also supply `sendemail.aliasFileType`.
36+
2237
sendemail.aliasFileType::
38+
Format of the file(s) specified in sendemail.aliasesFile. Must be
39+
one of 'mutt', 'mailrc', 'pine', 'elm', or 'gnus', or 'sendmail'.
40+
+
41+
What an alias file in each format looks like can be found in
42+
the documentation of the email program of the same name. The
43+
differences and limitations from the standard formats are
44+
described below:
45+
+
46+
--
47+
sendmail;;
48+
* Quoted aliases and quoted addresses are not supported: lines that
49+
contain a `"` symbol are ignored.
50+
* Redirection to a file (`/path/name`) or pipe (`|command`) is not
51+
supported.
52+
* File inclusion (`:include: /path/name`) is not supported.
53+
* Warnings are printed on the standard error output for any
54+
explicitly unsupported constructs, and any other lines that are not
55+
recognized by the parser.
56+
--
2357
sendemail.annotate::
2458
sendemail.bcc::
2559
sendemail.cc::
2660
sendemail.ccCmd::
2761
sendemail.chainReplyTo::
28-
sendemail.confirm::
2962
sendemail.envelopeSender::
3063
sendemail.from::
31-
sendemail.multiEdit::
3264
sendemail.signedoffbycc::
3365
sendemail.smtpPass::
3466
sendemail.suppresscc::
@@ -44,7 +76,9 @@ sendemail.thread::
4476
sendemail.transferEncoding::
4577
sendemail.validate::
4678
sendemail.xmailer::
47-
See linkgit:git-send-email[1] for description.
79+
These configuration variables all provide a default for
80+
linkgit:git-send-email[1] command-line options. See its
81+
documentation for details.
4882

4983
sendemail.signedoffcc (deprecated)::
5084
Deprecated alias for `sendemail.signedoffbycc`.

Documentation/git-send-email.txt

Lines changed: 2 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -456,41 +456,9 @@ Information
456456
CONFIGURATION
457457
-------------
458458

459-
sendemail.aliasesFile::
460-
To avoid typing long email addresses, point this to one or more
461-
email aliases files. You must also supply `sendemail.aliasFileType`.
459+
include::includes/cmd-config-section-all.txt[]
462460

463-
sendemail.aliasFileType::
464-
Format of the file(s) specified in sendemail.aliasesFile. Must be
465-
one of 'mutt', 'mailrc', 'pine', 'elm', or 'gnus', or 'sendmail'.
466-
+
467-
What an alias file in each format looks like can be found in
468-
the documentation of the email program of the same name. The
469-
differences and limitations from the standard formats are
470-
described below:
471-
+
472-
--
473-
sendmail;;
474-
* Quoted aliases and quoted addresses are not supported: lines that
475-
contain a `"` symbol are ignored.
476-
* Redirection to a file (`/path/name`) or pipe (`|command`) is not
477-
supported.
478-
* File inclusion (`:include: /path/name`) is not supported.
479-
* Warnings are printed on the standard error output for any
480-
explicitly unsupported constructs, and any other lines that are not
481-
recognized by the parser.
482-
--
483-
484-
sendemail.multiEdit::
485-
If true (default), a single editor instance will be spawned to edit
486-
files you have to edit (patches when `--annotate` is used, and the
487-
summary when `--compose` is used). If false, files will be edited one
488-
after the other, spawning a new editor each time.
489-
490-
sendemail.confirm::
491-
Sets the default for whether to confirm before sending. Must be
492-
one of 'always', 'never', 'cc', 'compose', or 'auto'. See `--confirm`
493-
in the previous section for the meaning of these values.
461+
include::config/sendemail.txt[]
494462

495463
EXAMPLES
496464
--------

0 commit comments

Comments
 (0)