Skip to content

Commit

Permalink
Docs: send-email's usage text and man page mention same options
Browse files Browse the repository at this point in the history
Specifically, boolean options are now listed in the form

    --[no-]option

and both forms of documentation now consistently use

    --[no-]signed-off-by-cc

Signed-off-by: Michael Witten <mfwitten@mit.edu>
Acked-by: Jeff King <peff@peff.net>
Signed-off-by: Shawn O. Pearce <spearce@spearce.org>
  • Loading branch information
Michael Witten authored and Shawn O. Pearce committed Oct 1, 2008
1 parent 5e22e21 commit 7ecbad9
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 12 deletions.
21 changes: 13 additions & 8 deletions Documentation/git-send-email.txt
Original file line number Diff line number Diff line change
Expand Up @@ -40,8 +40,7 @@ The --cc option must be repeated for each user you want on the cc list.
Output of this command must be single email address per line.
Default is the value of 'sendemail.cccmd' configuration value.

--chain-reply-to::
--no-chain-reply-to::
--[no-]chain-reply-to::
If this is set, each email will be sent as a reply to the previous
email sent. If disabled with "--no-chain-reply-to", all emails after
the first will be sent as replies to the first email sent. When using
Expand All @@ -66,8 +65,7 @@ The --cc option must be repeated for each user you want on the cc list.
Only necessary if --compose is also set. If --compose
is not set, this will be prompted for.

--signed-off-by-cc::
--no-signed-off-by-cc::
--[no-]signed-off-by-cc::
If this is set, add emails found in Signed-off-by: or Cc: lines to the
cc list.
Default is the value of 'sendemail.signedoffcc' configuration value;
Expand Down Expand Up @@ -146,8 +144,7 @@ user is prompted for a password while the input is masked for privacy.
Only necessary if --compose is also set. If --compose
is not set, this will be prompted for.

--suppress-from::
--no-suppress-from::
--[no-]suppress-from::
If this is set, do not add the From: address to the cc: list.
Default is the value of 'sendemail.suppressfrom' configuration value;
if that is unspecified, default to --no-suppress-from.
Expand All @@ -163,8 +160,7 @@ user is prompted for a password while the input is masked for privacy.
if that is unspecified, default to 'self' if --suppress-from is
specified, as well as 'sob' if --no-signed-off-cc is specified.

--thread::
--no-thread::
--[no-]thread::
If this is set, the In-Reply-To header will be set on each email sent.
If disabled with "--no-thread", no emails will have the In-Reply-To
header set.
Expand All @@ -183,6 +179,15 @@ user is prompted for a password while the input is masked for privacy.
variable; if that is unspecified, choosing the envelope sender is left
to your MTA.

--no-validate::
Don't perform any sanity checks on patches.
Currently, validation means the following:
+
--
* Warn of patches that contain lines longer than 998 characters; this
is due to SMTP limits as described by http://www.ietf.org/rfc/rfc2821.txt.
--

--to::
Specify the primary recipient of the emails generated.
Generally, this will be the upstream maintainer of the
Expand Down
8 changes: 4 additions & 4 deletions git-send-email.perl
Original file line number Diff line number Diff line change
Expand Up @@ -64,11 +64,11 @@ sub usage {
Only used if --compose is also set. If --compose is not
set, this will be prompted for.
--chain-reply-to If set, the replies will all be to the previous
--[no-]chain-reply-to If set, the replies will all be to the previous
email sent, rather than to the first email sent.
Defaults to on.
--signed-off-cc Automatically add email addresses that appear in
--[no-]signed-off-by-cc Automatically add email addresses that appear in
Signed-off-by: or Cc: lines to the cc: list. Defaults to on.
--identity The configuration identity, a subsection to prioritise over
Expand All @@ -95,9 +95,9 @@ sub usage {
'cccmd' for the output of the cccmd, or 'all' to suppress
all of these.
--suppress-from Suppress sending emails to yourself. Defaults to off.
--[no-]suppress-from Suppress sending emails to yourself. Defaults to off.
--thread Specify that the "In-Reply-To:" header should be set on all
--[no-]thread Specify that the "In-Reply-To:" header should be set on all
emails. Defaults to on.
--quiet Make git-send-email less verbose. One line per email
Expand Down

0 comments on commit 7ecbad9

Please sign in to comment.