git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Michael Witten <mfwitten@MIT.EDU>
To: git@vger.kernel.org
Subject: [RFC 6/9] Docs: send-email: Remove unnecessary config variable description
Date: Mon, 29 Sep 2008 00:08:09 -0500	[thread overview]
Message-ID: <1222664892-55810-1-git-send-email-mfwitten@mit.edu> (raw)
In-Reply-To: <20080929003636.GA18552@coredump.intra.peff.net>

The config variables are mentioned within the descriptions of the
command line options with which they are associated.

Signed-off-by: Michael Witten <mfwitten@mit.edu>
---
 Documentation/git-send-email.txt |   91 +++++++-------------------------------
 1 files changed, 16 insertions(+), 75 deletions(-)

diff --git a/Documentation/git-send-email.txt b/Documentation/git-send-email.txt
index 6b62032..0d6ac4a 100644
--- a/Documentation/git-send-email.txt
+++ b/Documentation/git-send-email.txt
@@ -24,7 +24,8 @@ OPTIONS
 The options available are:
 
 --bcc::
-	Specify a "Bcc:" value for each email.
+	Specify a "Bcc:" value for each email. Default is the value of
+	'sendemail.bcc'.
 +
 The --bcc option must be repeated for each user you want on the bcc list.
 
@@ -85,9 +86,9 @@ The --cc option must be repeated for each user you want on the cc list.
 	all that is output.
 
 --[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.
+	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.
 
 --smtp-encryption::
 	Specify the encryption to use, either 'ssl' or 'tls'.  Any other
@@ -97,22 +98,13 @@ The --cc option must be repeated for each user you want on the cc list.
 --smtp-pass::
 	Password for SMTP-AUTH. The argument is optional: If no
 	argument is specified, then the empty string is used as
-	the password.
-+
-In place of this option, the following configuration variables
-can be specified:
-+
---
-		* sendemail.smtppass
-		* sendemail.<identity>.smtppass (see sendemail.identity).
---
-+
-However, --smtp-pass always overrides these variables.
+	the password. Default is the value of 'sendemail.smtppass',
+	however '--smtp-pass' always overrides this value.
 +
 Furthermore, passwords need not be specified in configuration files
 or on the command line. If a username has been specified (with
---smtp-user or a configuration variable), but no password has been
-specified (with --smtp-pass or a configuration variable), then the
+'--smtp-user' or a 'sendemail.smtpuser'), but no password has been
+specified (with '--smtp-pass' or 'sendemail.smtppass'), then the
 user is prompted for a password while the input is masked for privacy.
 
 --smtp-server::
@@ -128,24 +120,15 @@ user is prompted for a password while the input is masked for privacy.
 --smtp-server-port::
 	Specifies a port different from the default port (SMTP
 	servers typically listen to smtp port 25 and ssmtp port
-	465).
+	465). This can be set with 'sendemail.smtpserverport'.
 
 --smtp-ssl::
-	Legacy alias for '--smtp-encryption=ssl'.
+	Legacy alias for '--smtp-encryption ssl'.
 
 --smtp-user::
-	Username for SMTP-AUTH. In place of this option, the following
-	configuration variables can be specified:
-+
---
-		* sendemail.smtpuser
-		* sendemail.<identity>.smtpuser (see sendemail.identity).
---
-+
-However, --smtp-user always overrides these variables.
-+
-If a username is not specified (with --smtp-user or a
-configuration variable), then authentication is not attempted.
+	Username for SMTP-AUTH. Default is the value of 'sendemail.smtpuser';
+	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.
@@ -191,18 +174,12 @@ The --to option must be repeated for each user you want on the to list.
 			is due to SMTP limits as described by http://www.ietf.org/rfc/rfc2821.txt.
 --
 +
-This option can be set with sendemail[.<identity>].validate; default to --validate
+Default is the value of 'sendemail.validate'; if this is not set,
+default to '--validate'.
 
 
 CONFIGURATION
 -------------
-sendemail.identity::
-	The default configuration identity. When specified,
-	'sendemail.<identity>.<item>' will have higher precedence than
-	'sendemail.<item>'. This is useful to declare multiple SMTP
-	identities and to hoist sensitive authentication information
-	out of the repository and into the global configuration file.
-
 sendemail.aliasesfile::
 	To avoid typing long email addresses, point this to one or more
 	email aliases files.  You must also supply 'sendemail.aliasfiletype'.
@@ -211,42 +188,6 @@ sendemail.aliasfiletype::
 	Format of the file(s) specified in sendemail.aliasesfile. Must be
 	one of 'mutt', 'mailrc', 'pine', or 'gnus'.
 
-sendemail.to::
-	Email address (or alias) to always send to.
-
-sendemail.cccmd::
-	Command to execute to generate per patch file specific "Cc:"s.
-
-sendemail.bcc::
-	Email address (or alias) to always bcc.
-
-sendemail.chainreplyto::
-	Boolean value specifying the default to the '--[no-]chain-reply-to'
-	parameter.
-
-sendemail.smtpserver::
-	Default SMTP server to use.
-
-sendemail.smtpserverport::
-	Default SMTP server port to use.
-
-sendemail.smtpuser::
-	Default SMTP-AUTH username.
-
-sendemail.smtppass::
-	Default SMTP-AUTH password.
-
-sendemail.smtpencryption::
-	Default encryption method.  Use 'ssl' for SSL (and specify an
-	appropriate port), or 'tls' for TLS.  Takes precedence over
-	'smtpssl' if both are specified.
-
-sendemail.smtpssl::
-	Legacy boolean that sets 'smtpencryption=ssl' if enabled.
-
-sendemail.validate::
-    Boolean override for --[no-]validate.
-
 Author
 ------
 Written by Ryan Anderson <ryan@michonline.com>
-- 
1.6.0.2.304.gdcf23.dirty

  reply	other threads:[~2008-09-29  5:10 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             ` Michael Witten [this message]
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                           ` [PATCH 2/9] Docs: send-email usage text much sexier Michael Witten
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

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

  git send-email \
    --in-reply-to=1222664892-55810-1-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.
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 NNTP newsgroup(s).