git/list[1] front-page[2] threads[3] people[4] search[5] about
 

[RFC2 8/9] Docs: send-email: Create logical groupings for man text

From
Michael Witten <mfwitten@mit.edu>
Date
Sep 29, 2008, 17:41 UTC
Message-ID
<1222710066-57768-1-git-send-email-mfwitten@mit.edu>
In-Reply-To
<20080929162935.GA2628@coredump.intra.peff.net>

The options are partitioned into more digestible groups. Within these groups, the options are sorted alphabetically.

Signed-off-by: Michael Witten <mfwitten@mit.edu>
---
 Documentation/git-send-email.txt |  119 ++++++++++++++++++++++----------------
 1 files changed, 69 insertions(+), 50 deletions(-)
diff --git a/Documentation/git-send-email.txt b/Documentation/git-send-email.txt
index 0d6ac4a..d566c34 100644
--- a/Documentation/git-send-email.txt
+++ b/Documentation/git-send-email.txt
@@ -19,9 +19,12 @@ The header of the email is configurable by command line options.  If not
 specified on the command line, the user will be prompted with a ReadLine
 enabled interface to provide the necessary information.
 
+
 OPTIONS
 -------
-The options available are:
+
+Composing
+~~~~~~~~~
 
 --bcc::
 	Specify a "Bcc:" value for each email. Default is the value of
@@ -34,46 +37,15 @@ The --bcc option must be repeated for each user you want on the bcc list.
 +
 The --cc option must be repeated for each user you want on the cc list.
 
---cc-cmd::
-	Specify a command to execute once per patch file which
-	should generate patch file specific "Cc:" entries.
-	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.
-
 --compose::
 	Use $GIT_EDITOR, core.editor, $VISUAL, or $EDITOR to edit an
 	introductory message for the patch series.
 
---dry-run::
-	Do everything except actually send the emails.
-
---envelope-sender::
-	Specify the envelope sender used to send the emails.
-	This is useful if your default address is not the address that is
-	subscribed to a list. If you use the sendmail binary, you must have
-	suitable privileges for the -f parameter. Default is the value of
-	the 'sendemail.envelopesender' configuration variable; if that is
-	unspecified, choosing the envelope sender is left to your MTA.
-
 --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.
 
---identity::
-	A configuration identity. When given, causes values in the
-	'sendemail.<identity>' subsection to take precedence over
-	values in the 'sendemail' section. The default identity is
-	the value of 'sendemail.identity'.
-
 --in-reply-to::
 	Specify the contents of the first In-Reply-To header.
 	Subsequent emails will refer to the previous email
@@ -81,14 +53,30 @@ 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.
 
---quiet::
-	Make git-send-email less verbose.  One line per email should be
-	all that is output.
+--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-]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.
+--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.
+
+
+Sending
+~~~~~~~
+
+--envelope-sender::
+	Specify the envelope sender used to send the emails.
+	This is useful if your default address is not the address that is
+	subscribed to a list. If you use the sendmail binary, you must have
+	suitable privileges for the -f parameter. Default is the value of
+	the 'sendemail.envelopesender' configuration variable; if that is
+	unspecified, choosing the envelope sender is left to your MTA.
 
 --smtp-encryption::
 	Specify the encryption to use, either 'ssl' or 'tls'.  Any other
@@ -130,10 +118,34 @@ user is prompted for a password while the input is masked for privacy.
 	if a username is not specified (with '--smtp-user' or 'sendemail.smtpuser'),
 	then authentication is not attempted.
 
---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.
+
+Automating
+~~~~~~~~~~
+
+--cc-cmd::
+	Specify a command to execute once per patch file which
+	should generate patch file specific "Cc:" entries.
+	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.
+
+--identity::
+	A configuration identity. When given, causes values in the
+	'sendemail.<identity>' subsection to take precedence over
+	values in the 'sendemail' section. The default identity is
+	the value of 'sendemail.identity'.
+
+--[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.
 
 --suppress-cc::
 	Specify an additional category of recipients to suppress the
@@ -157,13 +169,16 @@ user is prompted for a password while the input is masked for privacy.
 	header set. Default is the value of the 'sendemail.thread' configuration
 	value; if that is unspecified, default to --thread.
 
---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.
+
+Administering
+~~~~~~~~~~~~~
+
+--dry-run::
+	Do everything except actually send the emails.
+
+--quiet::
+	Make git-send-email less verbose.  One line per email should be
+	all that is output.
 
 --[no-]validate::
 	Perform sanity checks on patches.
@@ -180,6 +195,7 @@ default to '--validate'.
 
 CONFIGURATION
 -------------
+
 sendemail.aliasesfile::
 	To avoid typing long email addresses, point this to one or more
 	email aliases files.  You must also supply 'sendemail.aliasfiletype'.
@@ -188,6 +204,7 @@ sendemail.aliasfiletype::
 	Format of the file(s) specified in sendemail.aliasesfile. Must be
 	one of 'mutt', 'mailrc', 'pine', or 'gnus'.
 
+
 Author
 ------
 Written by Ryan Anderson <ryan@michonline.com>
@@ -195,10 +212,12 @@ Written by Ryan Anderson <ryan@michonline.com>
 git-send-email is originally based upon
 send_lots_of_email.pl by Greg Kroah-Hartman.
 
+
 Documentation
 --------------
 Documentation by Ryan Anderson
 
+
 GIT
 ---
 Part of the linkgit:git[1] suite

-- 
1.6.0.2.304.gdcf23.dirty
Previous: Jeff KingNext: Michael Witten
Message 31 of 45 in “Docs: send-email's usage text and man page mention same options”
  1. 1/8 Docs: send-email's usage text and man page mention same optionsMichael Witten, Sep 28, 2008
  2. 2/8 Docs: send-email usage text much sexierMichael Witten, Sep 28, 2008
  3. 3/8 Docs: send-email: Man page option orderingMichael Witten, Sep 28, 2008
  4. 4/8 send-email: change --no-validate to boolean --[no-]validateMichael Witten, Sep 28, 2008
  5. 5/8 Docs: send-email: --chain_reply_to -> --[no-]chain-reply-toMichael Witten, Sep 28, 2008
  6. 6/8 Docs: Arranged config options in man pageMichael Witten, Sep 28, 2008
  7. 7/8 Docs: send-email: Added all config variables to man endMichael Witten, Sep 28, 2008
  8. 8/8 Docs: config: send-email config options includedMichael Witten, Sep 28, 2008
  9. Jeff KingSep 28, 2008
  10. Michael WittenSep 28, 2008
  11. Jeff KingSep 28, 2008
  12. Jeff KingSep 28, 2008
  13. Michael WittenSep 28, 2008
  14. Jeff KingSep 28, 2008
  15. Jeff KingSep 28, 2008
  16. Michael WittenSep 28, 2008
  17. bash completion: Add --[no-]-validate to "git send-email"Teemu Likonen, Sep 28, 2008
  18. Teemu LikonenSep 28, 2008
  19. Jakub NarebskiSep 28, 2008
  20. Michael WittenSep 28, 2008
  21. Jakub NarebskiSep 29, 2008
  22. Jeff KingSep 29, 2008
  23. 6/9 Docs: send-email: Remove unnecessary config variable descriptionMichael Witten, Sep 29, 2008
  24. 7/9 send-email: Completely replace --signed-off-cc with --signed-off-by-ccMichael Witten, Sep 29, 2008
  25. 8/9 Docs: send-email: Create logical groupings for --help textMichael Witten, Sep 29, 2008
  26. 9/9 Docs: send-email: Create logical groupings for man textMichael Witten, Sep 29, 2008
  27. Jeff KingSep 29, 2008
  28. Miklos VajnaSep 28, 2008
  29. Michael WittenSep 28, 2008
  30. Jeff KingSep 29, 2008
  31. 8/9 Docs: send-email: Create logical groupings for man textMichael Witten, Sep 29, 2008
  32. 9/9 send-email: signedoffcc -> signedoffbycc, but handle bothMichael Witten, Sep 29, 2008
  33. Jeff KingSep 29, 2008
  34. 1/9 Docs: send-email's usage text and man page mention same optionsMichael Witten, Sep 30, 2008
  35. 2/9 Docs: send-email usage text much sexierMichael Witten, Sep 30, 2008
  36. 3/9 Docs: send-email: Man page option orderingMichael Witten, Sep 30, 2008
  37. 4/9 send-email: change --no-validate to boolean --[no-]validateMichael Witten, Sep 30, 2008
  38. 5/9 Docs: send-email: --chain_reply_to -> --[no-]chain-reply-toMichael Witten, Sep 30, 2008
  39. 6/9 Docs: send-email: Remove unnecessary config variable descriptionMichael Witten, Sep 30, 2008
  40. 7/9 Docs: send-email: Create logical groupings for --help textMichael Witten, Sep 30, 2008
  41. 8/9 Docs: send-email: Create logical groupings for man textMichael Witten, Sep 30, 2008
  42. 9/9 send-email: signedoffcc -> signedoffbycc, but handle bothMichael Witten, Sep 30, 2008
  43. Jeff KingOct 1, 2008
  44. Michael WittenOct 1, 2008
  45. Shawn O. PearceOct 1, 2008

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.