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 <avarab@gmail.com> Reviewed-by: Matheus Tavares <matheus.bernardino@usp.br> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Ævar Arnfjörð Bjarmason committed
Sep 7, 2022 at 10:26 UTC
bac1d52cfe1f6bdc0f52df3bc32023ed17966e81
2 files changed
+39
-37
Documentation/config/sendemail.txt
+37
-3
@@ -18,17 +18,49 @@ sendemail.<identity>.*::
18
identity is selected, through either the command-line or
19
`sendemail.identity`.
20
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
+
33
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
+
37
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
+--
57
sendemail.annotate::
58
sendemail.bcc::
59
sendemail.cc::
60
sendemail.ccCmd::
61
sendemail.chainReplyTo::
28
-sendemail.confirm::
62
sendemail.envelopeSender::
63
sendemail.from::
31
-sendemail.multiEdit::
64
sendemail.signedoffbycc::
65
sendemail.smtpPass::
66
sendemail.suppresscc::
@@ -44,7 +76,9 @@ sendemail.thread::
76
sendemail.transferEncoding::
77
sendemail.validate::
78
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.
82
83
sendemail.signedoffcc (deprecated)::
84
Deprecated alias for `sendemail.signedoffbycc`.
Documentation/git-send-email.txt
+2
-34
@@ -456,41 +456,9 @@ Information
456
CONFIGURATION
457
-------------
458
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[]
460
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[]
462
463
EXAMPLES
464
--------