aboutsummaryrefslogtreecommitdiffstats
path: root/Documentation/git-send-email.txt
diff options
context:
space:
mode:
authorDragan Simic <dsimic@manjaro.org>2024-02-20 23:22:51 +0100
committerJunio C Hamano <gitster@pobox.com>2024-02-20 14:37:44 -0800
commit82d75402d549353e26152062b93711bb47ffc1cf (patch)
treec4430bc9aca991c8d41dd25b96990642eb926fe4 /Documentation/git-send-email.txt
parent564d0252ca632e0264ed670534a51d18a689ef5d (diff)
downloadgit-82d75402d549353e26152062b93711bb47ffc1cf.tar.gz
documentation: send-email: use camel case consistently
Correct a few random "sendemail.*" configuration parameter names in the documentation that, for some unknown reason and contrary to the expected, didn't use camel case format. The majority of the corrections are straightforward, by using camel case to denote boundaries of the individual words that, stringed together, make up configuration parameter names. A couple of abbreviations found in some of the corrected configuration parameter names present some exceptions, which are described in detail below. First, there's "SSL" as the abbreviation for "Secure Sockets Layer". [1] As such, it's written using all uppercase letters, which is pretty much the general rule for making abbreviations, although with certain exceptions. Second, there's "Cc" as the abbreviation for "carbon copy", which is another exception. As the acronym for "carbon copy", "cc" (mind the all lowercase letters) stems from the rather old times when, literally, carbon copies were made. [2] Therefore, using "CC" (mind the all uppercase letters) or "cc" (mind the all lowercase letters) would be technically correct in the email domain, as the abbreviation or as mentioned in RFC2076, [3] respectively, but the age of email has established "Cc" (mind the mixed uppercase and lowercase letters) as some kind of de facto standard. [1][4][5] Moreover, some of the git utilities, primarily git-send-email(1), already refer to making email carbon copies as specifying "Cc:" email headers. As a result, "Cc" becomes one of the exceptions to the general rule for making abbreviations. [1] https://en.wikipedia.org/wiki/Transport_Layer_Security [2] https://en.wikipedia.org/wiki/Carbon_copy [3] https://datatracker.ietf.org/doc/html/rfc2076 [4] https://bugzilla.mozilla.org/show_bug.cgi?id=212059 [5] https://bugzilla.mozilla.org/show_bug.cgi?id=50826 Signed-off-by: Dragan Simic <dsimic@manjaro.org> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Documentation/git-send-email.txt')
-rw-r--r--Documentation/git-send-email.txt18
1 files changed, 9 insertions, 9 deletions
diff --git a/Documentation/git-send-email.txt b/Documentation/git-send-email.txt
index 465011bad5..21907ecf19 100644
--- a/Documentation/git-send-email.txt
+++ b/Documentation/git-send-email.txt
@@ -138,7 +138,7 @@ Note that no attempts whatsoever are made to validate the encoding.
--compose-encoding=<encoding>::
Specify encoding of compose message. Default is the value of the
- 'sendemail.composeencoding'; if that is unspecified, UTF-8 is assumed.
+ 'sendemail.composeEncoding'; if that is unspecified, UTF-8 is assumed.
--transfer-encoding=(7bit|8bit|quoted-printable|base64|auto)::
Specify the transfer encoding to be used to send the message over SMTP.
@@ -174,7 +174,7 @@ Sending
Specify a command to run to send the email. The command should
be sendmail-like; specifically, it must support the `-i` option.
The command will be executed in the shell if necessary. Default
- is the value of `sendemail.sendmailcmd`. If unspecified, and if
+ is the value of `sendemail.sendmailCmd`. If unspecified, and if
--smtp-server is also unspecified, git-send-email will search
for `sendmail` in `/usr/sbin`, `/usr/lib` and $PATH.
@@ -269,7 +269,7 @@ must be used for each option.
certificates concatenated together: see verify(1) -CAfile and
-CApath for more information on these). Set it to an empty string
to disable certificate verification. Defaults to the value of the
- `sendemail.smtpsslcertpath` configuration variable, if set, or the
+ `sendemail.smtpSSLCertPath` configuration variable, if set, or the
backing SSL library's compiled-in default otherwise (which should
be the best choice on most platforms).
@@ -313,7 +313,7 @@ Automating
Specify a command to execute once per patch file which
should generate patch file specific "To:" entries.
Output of this command must be single email address per line.
- Default is the value of 'sendemail.tocmd' configuration value.
+ Default is the value of 'sendemail.toCmd' configuration value.
--cc-cmd=<command>::
Specify a command to execute once per patch file which
@@ -348,19 +348,19 @@ Automating
--[no-]signed-off-by-cc::
If this is set, add emails found in the `Signed-off-by` trailer or Cc: lines to the
- cc list. Default is the value of `sendemail.signedoffbycc` configuration
+ cc list. Default is the value of `sendemail.signedOffByCc` configuration
value; if that is unspecified, default to --signed-off-by-cc.
--[no-]cc-cover::
If this is set, emails found in Cc: headers in the first patch of
the series (typically the cover letter) are added to the cc list
- for each email set. Default is the value of 'sendemail.cccover'
+ for each email set. Default is the value of 'sendemail.ccCover'
configuration value; if that is unspecified, default to --no-cc-cover.
--[no-]to-cover::
If this is set, emails found in To: headers in the first patch of
the series (typically the cover letter) are added to the to list
- for each email set. Default is the value of 'sendemail.tocover'
+ for each email set. Default is the value of 'sendemail.toCover'
configuration value; if that is unspecified, default to --no-to-cover.
--suppress-cc=<category>::
@@ -384,7 +384,7 @@ Automating
- 'all' will suppress all auto cc values.
--
+
-Default is the value of `sendemail.suppresscc` configuration value; if
+Default is the value of `sendemail.suppressCc` configuration value; if
that is unspecified, default to 'self' if --suppress-from is
specified, as well as 'body' if --no-signed-off-cc is specified.
@@ -471,7 +471,7 @@ Information
Instead of the normal operation, dump the shorthand alias names from
the configured alias file(s), one per line in alphabetical order. Note
that this only includes the alias name and not its expanded email addresses.
- See 'sendemail.aliasesfile' for more information about aliases.
+ See 'sendemail.aliasesFile' for more information about aliases.
CONFIGURATION