The man page seems to have listed the options in alphabetical order,
while the usage text used what I would consider an `intuitive' order
that groups related items and presents them in the order peopl think
when writing an email.
The manual page has been updated to mirror this order.
Signed-off-by: Michael Witten <mfwitten@xxxxxxx>
---
Documentation/git-send-email.txt | 77 +++++++++++++++++++-------------------
1 files changed, 39 insertions(+), 38 deletions(-)
diff --git a/Documentation/git-send-email.txt b/Documentation/git-send-email.txt
index 9b31626..6031eb7 100644
--- a/Documentation/git-send-email.txt
+++ b/Documentation/git-send-email.txt
@@ -24,10 +24,19 @@ OPTIONS
-------
The options available are:
---bcc::
- Specify a "Bcc:" value for each email.
+--from::
+ Specify the sender of the emails. This will default to
+ the value GIT_COMMITTER_IDENT, as returned by "git var -l".
+ The user will still be prompted to confirm this entry.
+
+--to::
+ Specify the primary recipient of the emails generated.
+ Generally, this will be the upstream maintainer of the
+ project involved.
+ Default is the value of the 'sendemail.to' configuration value;
+ if that is unspecified, this will be prompted for.
+
-The --bcc option must be repeated for each user you want on the bcc list.
+The --to option must be repeated for each user you want on the to list.
--cc::
Specify a starting "Cc:" value for each email.
@@ -40,23 +49,19 @@ 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.
---[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
- this, it is recommended that the first file given be an overview of the
- entire patch series.
- Default is the value of the 'sendemail.chainreplyto' configuration
- value; if that is unspecified, default to --chain-reply-to.
+--bcc::
+ Specify a "Bcc:" value for each email.
++
+The --bcc option must be repeated for each user you want on the bcc list.
--compose::
Use $GIT_EDITOR, core.editor, $VISUAL, or $EDITOR to edit an
introductory message for the patch series.
---from::
- Specify the sender of the emails. This will default to
- the value GIT_COMMITTER_IDENT, as returned by "git var -l".
- The user will still be prompted to confirm this entry.
+--subject::
+ Specify the initial subject of the email thread.
+ Only necessary if --compose is also set. If --compose
+ is not set, this will be prompted for.
--in-reply-to::
Specify the contents of the first In-Reply-To header.
@@ -65,16 +70,21 @@ 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.
+--[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
+ this, it is recommended that the first file given be an overview of the
+ entire patch series.
+ Default is the value of the 'sendemail.chainreplyto' configuration
+ value; if that is unspecified, default to --chain-reply-to.
+
--[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;
if that is unspecified, default to --signed-off-by-cc.
---quiet::
- Make git-send-email less verbose. One line per email should be
- all that is output.
-
--identity::
A configuration identity. When given, causes values in the
'sendemail.<identity>' subsection to take precedence over
@@ -139,16 +149,6 @@ user is prompted for a password while the input is masked for privacy.
--smtp-ssl::
Legacy alias for '--smtp-encryption=ssl'.
---subject::
- Specify the initial subject of the email thread.
- Only necessary if --compose is also set. If --compose
- is not set, this will be prompted for.
-
---[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.
-
--suppress-cc::
Specify an additional category of recipients to suppress the
auto-cc of. 'self' will avoid including the sender, 'author' will
@@ -159,6 +159,12 @@ user is prompted for a password while the input is masked for privacy.
Default is the value of 'sendemail.suppresscc' configuration value;
if that is unspecified, default to 'self' if --suppress-from is
specified, as well as 'sob' if --no-signed-off-cc is specified.
+ (Note: Linus uses 'self' and 'sob' interchangeably).
+
+--[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.
--[no-]thread::
If this is set, the In-Reply-To header will be set on each email sent.
@@ -167,6 +173,10 @@ user is prompted for a password while the input is masked for privacy.
Default is the value of the 'sendemail.thread' configuration value;
if that is unspecified, default to --thread.
+--quiet::
+ Make git-send-email less verbose. One line per email should be
+ all that is output.
+
--dry-run::
Do everything except actually send the emails.
@@ -188,15 +198,6 @@ user is prompted for a password while the input is masked for privacy.
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
- project involved.
- Default is the value of the 'sendemail.to' configuration value;
- if that is unspecified, this will be prompted for.
-+
-The --to option must be repeated for each user you want on the to list.
-
CONFIGURATION
-------------
--
1.6.0.2.302.ge6cbd1
--
To unsubscribe from this list: send the line "unsubscribe git" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at http://vger.kernel.org/majordomo-info.html
