git@vger.kernel.org mailing list mirror (one of many)
 help / color / mirror / code / Atom feed
From: Michael Witten <mfwitten@MIT.EDU>
To: spearce@spearce.org
Cc: git@vger.kernel.org
Subject: [PATCH 2/9] Docs: send-email usage text much sexier
Date: Tue, 30 Sep 2008 07:58:25 -0500	[thread overview]
Message-ID: <1222779512-58936-2-git-send-email-mfwitten@mit.edu> (raw)
In-Reply-To: <1222779512-58936-1-git-send-email-mfwitten@mit.edu>

All of the descriptions are aligned, shorter,
better arranged, and no line is greater than
78 columns.

Signed-off-by: Michael Witten <mfwitten@mit.edu>
---
 git-send-email.perl |   94 ++++++++++++++-------------------------------------
 1 files changed, 26 insertions(+), 68 deletions(-)

diff --git a/git-send-email.perl b/git-send-email.perl
index 9f56162..2c31a25 100755
--- a/git-send-email.perl
+++ b/git-send-email.perl
@@ -40,74 +40,32 @@ sub usage {
 	print <<EOT;
 git send-email [options] <file | directory>...
 Options:
-   --from         Specify the "From:" line of the email to be sent.
-
-   --to           Specify the primary "To:" line of the email.
-
-   --cc           Specify an initial "Cc:" list for the entire series
-                  of emails.
-
-   --cc-cmd       Specify a command to execute per file which adds
-                  per file specific cc address entries
-
-   --bcc          Specify a list of email addresses that should be Bcc:
-		  on all the emails.
-
-   --compose      Use \$GIT_EDITOR, core.editor, \$EDITOR, or \$VISUAL to edit
-		  an introductory message for the patch series.
-
-   --subject      Specify the initial "Subject:" line.
-                  Only necessary if --compose is also set.  If --compose
-		  is not set, this will be prompted for.
-
-   --in-reply-to  Specify the first "In-Reply-To:" header line.
-                  Only used if --compose is also set.  If --compose is not
-		  set, this will be prompted for.
-
-   --[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.
-
-   --[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
-                  the default section.
-
-   --smtp-server  If set, specifies the outgoing SMTP server to use.
-                  Defaults to localhost.  Port number can be specified here with
-                  hostname:port format or by using --smtp-server-port option.
-
-   --smtp-server-port Specify a port on the outgoing SMTP server to connect to.
-
-   --smtp-user    The username for SMTP-AUTH.
-
-   --smtp-pass    The password for SMTP-AUTH.
-
-   --smtp-encryption Specify 'tls' for STARTTLS encryption, or 'ssl' for SSL.
-                  Any other value disables the feature.
-
-   --smtp-ssl     Synonym for '--smtp-encryption=ssl'.  Deprecated.
-
-   --suppress-cc  Suppress the specified category of auto-CC.  The category
-		  can be one of 'author' for the patch author, 'self' to
-		  avoid copying yourself, 'sob' for Signed-off-by lines,
-		  'cccmd' for the output of the cccmd, or 'all' to suppress
-		  all of these.
-
-   --[no-]suppress-from Suppress sending emails to yourself. Defaults to off.
-
-   --[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
-                  should be all that is output.
-
-   --dry-run	  Do everything except actually send the emails.
-
-   --envelope-sender	Specify the envelope sender used to send the emails.
-
-   --no-validate	Don't perform any sanity checks on patches.
+   --identity              <str>  * Use the sendemail.<id> options.
+   --from                  <str>  * Email From:
+   --envelope-sender       <str>  * Email envelope sender.
+   --to                    <str>  * Email To:
+   --cc                    <str>  * Email Cc:
+   --cc-cmd                <str>  * Email Cc: via `<str> \$patch_path`
+   --bcc                   <str>  * Email Bcc:
+   --subject               <str>  * Email "Subject:" (only if --compose).
+   --compose                      * Open an editor for introduction.
+   --in-reply-to           <str>  * First "In-Reply-To:" (only if --compose).
+   --[no-]chain-reply-to          * Chain In-Reply-To: fields. Default on.
+   --[no-]thread                  * Use In-Reply-To: field. Default on.
+   --[no-]signed-off-by-cc        * Actually send to Cc: and Signed-off-by:
+                                    addresses. Default on.
+   --suppress-cc           <str>  * author, self, sob, cccmd, all.
+   --[no-]suppress-from           * Don't send email to self. Default off.
+   --smtp-server       <str:int>  * Outgoing SMTP server to use. The port
+                                    is optional. Default 'localhost'.
+   --smtp-server-port      <int>  * Outgoing SMTP server port.
+   --smtp-user             <str>  * The username for SMTP-AUTH.
+   --smtp-pass             <str>  * The password for SMTP-AUTH; not necessary.
+   --smtp-encryption       <str>  * tls or ssl; anything else disables.
+   --smtp-ssl                     * Deprecated. Use '--smtp-encryption ssl'.
+   --quiet                        * Output one line of info per email.
+   --dry-run                      * Don't actually send the emails.
+   --no-validate                  * Don't perform sanity checks on patches.
 
 EOT
 	exit(1);
-- 
1.6.0.2.304.gdcf23.dirty

  reply	other threads:[~2008-09-30 12:59 UTC|newest]

Thread overview: 45+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2008-09-28  1:09 [PATCH 1/8] Docs: send-email's usage text and man page mention same options Michael Witten
2008-09-28  1:09 ` [PATCH 2/8] Docs: send-email usage text much sexier Michael Witten
2008-09-28  1:09   ` [PATCH 3/8] Docs: send-email: Man page option ordering Michael Witten
2008-09-28  1:09     ` [PATCH 4/8] send-email: change --no-validate to boolean --[no-]validate Michael Witten
2008-09-28  1:09       ` [PATCH 5/8] Docs: send-email: --chain_reply_to -> --[no-]chain-reply-to Michael Witten
2008-09-28  1:09         ` [PATCH 6/8] Docs: Arranged config options in man page Michael Witten
2008-09-28  1:09           ` [PATCH 7/8] Docs: send-email: Added all config variables to man end Michael Witten
2008-09-28  1:09             ` [PATCH 8/8] Docs: config: send-email config options included Michael Witten
2008-09-28  3:24               ` Jeff King
2008-09-28 19:03                 ` Michael Witten
2008-09-28 19:06                   ` Jeff King
2008-09-28  3:18             ` [PATCH 7/8] Docs: send-email: Added all config variables to man end Jeff King
2008-09-28 19:03               ` Michael Witten
2008-09-28 19:08                 ` Jeff King
2008-09-28  3:15           ` [PATCH 6/8] Docs: Arranged config options in man page Jeff King
2008-09-28 19:03             ` Michael Witten
2008-09-28  4:51       ` [PATCH] bash completion: Add --[no-]-validate to "git send-email" Teemu Likonen
2008-09-28 12:55         ` Teemu Likonen
2008-09-28  8:08     ` [PATCH 3/8] Docs: send-email: Man page option ordering Jakub Narebski
2008-09-28 19:04       ` Michael Witten
2008-09-29  0:10         ` Jakub Narebski
2008-09-29  0:36           ` Jeff King
2008-09-29  5:08             ` [RFC 6/9] Docs: send-email: Remove unnecessary config variable description Michael Witten
2008-09-29  5:08               ` [RFC 7/9] send-email: Completely replace --signed-off-cc with --signed-off-by-cc Michael Witten
2008-09-29  5:08                 ` [RFC 8/9] Docs: send-email: Create logical groupings for --help text Michael Witten
2008-09-29  5:08                   ` [RFC 9/9] Docs: send-email: Create logical groupings for man text Michael Witten
2008-09-29 16:25                   ` [RFC 8/9] Docs: send-email: Create logical groupings for --help text Jeff King
     [not found]             ` <1222664781-55763-1-git-send-email-mfwitten@mit.edu>
     [not found]               ` <1222664781-55763-2-git-send-email-mfwitten@mit.edu>
2008-09-29 16:29                 ` [RFC 7/9] send-email: Completely replace --signed-off-cc with --signed-off-by-cc Jeff King
2008-09-29 17:41                   ` [RFC2 8/9] Docs: send-email: Create logical groupings for man text Michael Witten
2008-09-29 17:41                     ` [RFC2 9/9] send-email: signedoffcc -> signedoffbycc, but handle both Michael Witten
2008-09-29 17:44                       ` Jeff King
2008-09-30 12:58                         ` [PATCH 1/9] Docs: send-email's usage text and man page mention same options Michael Witten
2008-09-30 12:58                           ` Michael Witten [this message]
2008-09-30 12:58                             ` [PATCH 3/9] Docs: send-email: Man page option ordering Michael Witten
2008-09-30 12:58                               ` [PATCH 4/9] send-email: change --no-validate to boolean --[no-]validate Michael Witten
2008-09-30 12:58                                 ` [PATCH 5/9] Docs: send-email: --chain_reply_to -> --[no-]chain-reply-to Michael Witten
2008-09-30 12:58                                   ` [PATCH 6/9] Docs: send-email: Remove unnecessary config variable description Michael Witten
2008-09-30 12:58                                     ` [PATCH 7/9] Docs: send-email: Create logical groupings for --help text Michael Witten
2008-09-30 12:58                                       ` [PATCH 8/9] Docs: send-email: Create logical groupings for man text Michael Witten
2008-09-30 12:58                                         ` [PATCH 9/9] send-email: signedoffcc -> signedoffbycc, but handle both Michael Witten
2008-10-01  3:27                               ` [PATCH 3/9] Docs: send-email: Man page option ordering Jeff King
2008-10-01 20:34                                 ` Michael Witten
2008-10-01 20:36                                   ` Shawn O. Pearce
2008-09-28  5:08 ` [PATCH 1/8] Docs: send-email's usage text and man page mention same options Miklos Vajna
2008-09-28 19:04   ` Michael Witten

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: http://vger.kernel.org/majordomo-info.html

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=1222779512-58936-2-git-send-email-mfwitten@mit.edu \
    --to=mfwitten@mit.edu \
    --cc=git@vger.kernel.org \
    --cc=spearce@spearce.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this public inbox

	https://80x24.org/mirrors/git.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).