git@vger.kernel.org mailing list mirror (one of many)
 help / color / mirror / code / Atom feed
From: Michael Witten <mfwitten@MIT.EDU>
To: git@vger.kernel.org
Subject: [PATCH RFC 3/6] Docs: send-email usage text much sexier
Date: Mon, 22 Sep 2008 10:58:12 -0500	[thread overview]
Message-ID: <1222099095-50360-3-git-send-email-mfwitten@mit.edu> (raw)
In-Reply-To: <1222099095-50360-2-git-send-email-mfwitten@mit.edu>

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

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

diff --git a/git-send-email.perl b/git-send-email.perl
index d390364..b86a3f3 100755
--- a/git-send-email.perl
+++ b/git-send-email.perl
@@ -40,74 +40,80 @@ sub usage {
 	print <<EOT;
 git send-email [options] <file | directory>...
 Options:
-   --from         Specify the "From:" line of the email to be sent.
+   --from                  Specify the "From:" line of the email to be sent.
 
-   --to           Specify the primary "To:" line of the email.
+   --to                    Specify the primary "To:" line of the email.
 
-   --cc           Specify an initial "Cc:" list for the entire series
-                  of emails.
+   --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
+   --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.
+   --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.
+   --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.
+   --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.
+   --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-]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.
+                           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.
+   --identity              The configuration identity to use.
 
-   --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           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-server-port      Specify a port on the outgoing SMTP server to
+                           connect to.
 
-   --smtp-user    The username for SMTP-AUTH.
+   --smtp-user             The username for SMTP-AUTH.
 
-   --smtp-pass    The password 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-encryption       Specify 'tls' for STARTTLS encryption, or 'ssl' for
+                           SSL. Any other value disables the feature.
 
-   --smtp-ssl     Synonym for '--smtp-encryption=ssl'.  Deprecated.
+   --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.
+   --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.
+                           (Note: Linus uses 'self' and 'sob' interchangeably)
 
-   --[no-]suppress-from Suppress sending emails to yourself. Defaults to off.
+   --[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.
+   --[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.
+   --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.
+   --dry-run               Do everything except actually send the emails.
 
-   --envelope-sender Specify the envelope sender used to send the emails.
+   --envelope-sender       Specify the envelope sender used to send the
+                           emails.
 
-   --no-validate Don't perform any sanity checks on patches.
+   --no-validate           Don't perform any sanity checks on patches.
 
 EOT
 	exit(1);
-- 
1.6.0.2.302.ge6cbd1

  reply	other threads:[~2008-09-22 15:59 UTC|newest]

Thread overview: 14+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2008-09-22 15:58 [PATCH RFC 1/6] Docs: send-email's usage text and man page mention same options Michael Witten
2008-09-22 15:58 ` [PATCH RFC 2/6] Docs: send-email usage cleanup 1 Michael Witten
2008-09-22 15:58   ` Michael Witten [this message]
2008-09-22 15:58     ` [PATCH RFC 4/6] Docs: send-email: Option order the same in man page and usage text Michael Witten
2008-09-22 15:58       ` [PATCH RFC 5/6] Docs: send-email: change --no-validate to boolean --[no-]validate Michael Witten
2008-09-22 15:58         ` [PATCH RFC 6/6] Docs: send-email: --chain_reply_to -> --[no-]chain-reply-to Michael Witten
2008-09-25 20:44 ` [PATCH RFC 1/6] Docs: send-email's usage text and man page mention same options Michael Witten
2008-09-25 20:44   ` [PATCH RFC 2/6] Docs: send-email usage cleanup 1 Michael Witten
2008-09-25 20:44     ` [PATCH RFC 3/6] Docs: send-email usage text much sexier Michael Witten
2008-09-25 20:44       ` [PATCH RFC 4/6] Docs: send-email: Option order the same in man page and usage text Michael Witten
2008-09-25 20:44         ` [PATCH RFC 5/6] Docs: send-email: change --no-validate to boolean --[no-]validate Michael Witten
2008-09-25 20:44           ` [PATCH RFC 6/6] Docs: send-email: --chain_reply_to -> --[no-]chain-reply-to Michael Witten
2008-09-26 22:40         ` [PATCH RFC 4/6] Docs: send-email: Option order the same in man page and usage text Jeff King
2008-09-27  1:13           ` 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=1222099095-50360-3-git-send-email-mfwitten@mit.edu \
    --to=mfwitten@mit.edu \
    --cc=git@vger.kernel.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).