Skip to content

Commit 82d7540

Browse files
Dragan Simicgitster
authored andcommitted
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 <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent 564d025 commit 82d7540

File tree

2 files changed

+15
-15
lines changed

2 files changed

+15
-15
lines changed

Documentation/config/sendemail.txt

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ sendemail.smtpEncryption::
88
See linkgit:git-send-email[1] for description. Note that this
99
setting is not subject to the 'identity' mechanism.
1010

11-
sendemail.smtpsslcertpath::
11+
sendemail.smtpSSLCertPath::
1212
Path to ca-certificates (either a directory or a single file).
1313
Set it to an empty string to disable certificate verification.
1414

@@ -62,12 +62,12 @@ sendemail.chainReplyTo::
6262
sendemail.envelopeSender::
6363
sendemail.from::
6464
sendemail.headerCmd::
65-
sendemail.signedoffbycc::
65+
sendemail.signedOffByCc::
6666
sendemail.smtpPass::
67-
sendemail.suppresscc::
67+
sendemail.suppressCc::
6868
sendemail.suppressFrom::
6969
sendemail.to::
70-
sendemail.tocmd::
70+
sendemail.toCmd::
7171
sendemail.smtpDomain::
7272
sendemail.smtpServer::
7373
sendemail.smtpServerPort::
@@ -81,8 +81,8 @@ sendemail.xmailer::
8181
linkgit:git-send-email[1] command-line options. See its
8282
documentation for details.
8383

84-
sendemail.signedoffcc (deprecated)::
85-
Deprecated alias for `sendemail.signedoffbycc`.
84+
sendemail.signedOffCc (deprecated)::
85+
Deprecated alias for `sendemail.signedOffByCc`.
8686

8787
sendemail.smtpBatchSize::
8888
Number of messages to be sent per connection, after that a relogin

Documentation/git-send-email.txt

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -138,7 +138,7 @@ Note that no attempts whatsoever are made to validate the encoding.
138138

139139
--compose-encoding=<encoding>::
140140
Specify encoding of compose message. Default is the value of the
141-
'sendemail.composeencoding'; if that is unspecified, UTF-8 is assumed.
141+
'sendemail.composeEncoding'; if that is unspecified, UTF-8 is assumed.
142142

143143
--transfer-encoding=(7bit|8bit|quoted-printable|base64|auto)::
144144
Specify the transfer encoding to be used to send the message over SMTP.
@@ -174,7 +174,7 @@ Sending
174174
Specify a command to run to send the email. The command should
175175
be sendmail-like; specifically, it must support the `-i` option.
176176
The command will be executed in the shell if necessary. Default
177-
is the value of `sendemail.sendmailcmd`. If unspecified, and if
177+
is the value of `sendemail.sendmailCmd`. If unspecified, and if
178178
--smtp-server is also unspecified, git-send-email will search
179179
for `sendmail` in `/usr/sbin`, `/usr/lib` and $PATH.
180180

@@ -269,7 +269,7 @@ must be used for each option.
269269
certificates concatenated together: see verify(1) -CAfile and
270270
-CApath for more information on these). Set it to an empty string
271271
to disable certificate verification. Defaults to the value of the
272-
`sendemail.smtpsslcertpath` configuration variable, if set, or the
272+
`sendemail.smtpSSLCertPath` configuration variable, if set, or the
273273
backing SSL library's compiled-in default otherwise (which should
274274
be the best choice on most platforms).
275275

@@ -313,7 +313,7 @@ Automating
313313
Specify a command to execute once per patch file which
314314
should generate patch file specific "To:" entries.
315315
Output of this command must be single email address per line.
316-
Default is the value of 'sendemail.tocmd' configuration value.
316+
Default is the value of 'sendemail.toCmd' configuration value.
317317

318318
--cc-cmd=<command>::
319319
Specify a command to execute once per patch file which
@@ -348,19 +348,19 @@ Automating
348348

349349
--[no-]signed-off-by-cc::
350350
If this is set, add emails found in the `Signed-off-by` trailer or Cc: lines to the
351-
cc list. Default is the value of `sendemail.signedoffbycc` configuration
351+
cc list. Default is the value of `sendemail.signedOffByCc` configuration
352352
value; if that is unspecified, default to --signed-off-by-cc.
353353

354354
--[no-]cc-cover::
355355
If this is set, emails found in Cc: headers in the first patch of
356356
the series (typically the cover letter) are added to the cc list
357-
for each email set. Default is the value of 'sendemail.cccover'
357+
for each email set. Default is the value of 'sendemail.ccCover'
358358
configuration value; if that is unspecified, default to --no-cc-cover.
359359

360360
--[no-]to-cover::
361361
If this is set, emails found in To: headers in the first patch of
362362
the series (typically the cover letter) are added to the to list
363-
for each email set. Default is the value of 'sendemail.tocover'
363+
for each email set. Default is the value of 'sendemail.toCover'
364364
configuration value; if that is unspecified, default to --no-to-cover.
365365

366366
--suppress-cc=<category>::
@@ -384,7 +384,7 @@ Automating
384384
- 'all' will suppress all auto cc values.
385385
--
386386
+
387-
Default is the value of `sendemail.suppresscc` configuration value; if
387+
Default is the value of `sendemail.suppressCc` configuration value; if
388388
that is unspecified, default to 'self' if --suppress-from is
389389
specified, as well as 'body' if --no-signed-off-cc is specified.
390390

@@ -471,7 +471,7 @@ Information
471471
Instead of the normal operation, dump the shorthand alias names from
472472
the configured alias file(s), one per line in alphabetical order. Note
473473
that this only includes the alias name and not its expanded email addresses.
474-
See 'sendemail.aliasesfile' for more information about aliases.
474+
See 'sendemail.aliasesFile' for more information about aliases.
475475

476476

477477
CONFIGURATION

0 commit comments

Comments
 (0)