From: Junio C Hamano <gitster@pobox.com>
Date: Wed, 25 Apr 2018 04:28:57 +0000 (+0900)
Subject: Merge branch 'mn/send-email-credential-doc'
X-Git-Tag: v2.18.0-rc0~121
X-Git-Url: https://git.lorimer.id.au/gitweb.git/diff_plain/f8fbcd6e01d8e31fb1c7093679538df79b79d90e?hp=-c

Merge branch 'mn/send-email-credential-doc'

Doc update.

* mn/send-email-credential-doc:
send-email: simplify Gmail example in the documentation
---

f8fbcd6e01d8e31fb1c7093679538df79b79d90e
diff --combined Documentation/git-send-email.txt
index 71ef97ba9b,f087d0be49..af07840b4f
--- a/Documentation/git-send-email.txt
+++ b/Documentation/git-send-email.txt
@@@ -47,18 -47,18 +47,18 @@@ Composin
  
  --annotate::
  	Review and edit each patch you're about to send. Default is the value
 -	of 'sendemail.annotate'. See the CONFIGURATION section for
 -	'sendemail.multiEdit'.
 +	of `sendemail.annotate`. See the CONFIGURATION section for
 +	`sendemail.multiEdit`.
  
  --bcc=<address>,...::
  	Specify a "Bcc:" value for each email. Default is the value of
 -	'sendemail.bcc'.
 +	`sendemail.bcc`.
  +
  This option may be specified multiple times.
  
  --cc=<address>,...::
  	Specify a starting "Cc:" value for each email.
 -	Default is the value of 'sendemail.cc'.
 +	Default is the value of `sendemail.cc`.
  +
  This option may be specified multiple times.
  
@@@ -66,7 -66,7 +66,7 @@@
  	Invoke a text editor (see GIT_EDITOR in linkgit:git-var[1])
  	to edit an introductory message for the patch series.
  +
 -When '--compose' is used, git send-email will use the From, Subject, and
 +When `--compose` is used, git send-email will use the From, Subject, and
  In-Reply-To headers specified in the message. If the body of the message
  (what you type after the headers and a blank line) only contains blank
  (or Git: prefixed) lines, the summary won't be sent, but From, Subject,
@@@ -74,27 -74,22 +74,27 @@@ and In-Reply-To headers will be used un
  +
  Missing From or In-Reply-To headers will be prompted for.
  +
 -See the CONFIGURATION section for 'sendemail.multiEdit'.
 +See the CONFIGURATION section for `sendemail.multiEdit`.
  
  --from=<address>::
  	Specify the sender of the emails.  If not specified on the command line,
 -	the value of the 'sendemail.from' configuration option is used.  If
 -	neither the command-line option nor 'sendemail.from' are set, then the
 +	the value of the `sendemail.from` configuration option is used.  If
 +	neither the command-line option nor `sendemail.from` are set, then the
  	user will be prompted for the value.  The default for the prompt will be
  	the value of GIT_AUTHOR_IDENT, or GIT_COMMITTER_IDENT if that is not
  	set, as returned by "git var -l".
  
 +--reply-to=<address>::
 +	Specify the address where replies from recipients should go to.
 +	Use this if replies to messages should go to another address than what
 +	is specified with the --from parameter.
 +
  --in-reply-to=<identifier>::
  	Make the first mail (or all the mails with `--no-thread`) appear as a
  	reply to the given Message-Id, which avoids breaking threads to
  	provide a new patch series.
  	The second and subsequent emails will be sent as replies according to
 -	the `--[no]-chain-reply-to` setting.
 +	the `--[no-]chain-reply-to` setting.
  +
  So for example when `--thread` and `--no-chain-reply-to` are specified, the
  second and subsequent patches will be replies to the first one like in the
@@@ -119,7 -114,7 +119,7 @@@ is not set, this will be prompted for
  --to=<address>,...::
  	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,
 +	value of the `sendemail.to` configuration value; if that is unspecified,
  	and --to-cmd is not specified, this will be prompted for.
  +
  This option may be specified multiple times.
@@@ -143,7 -138,7 +143,7 @@@ Note that no attempts whatsoever are ma
  	can be useful when the repository contains files that contain carriage
  	returns, but makes the raw patch email file (as saved from a MUA) much
  	harder to inspect manually.  base64 is even more fool proof, but also
 -	even more opaque.  Default is the value of the 'sendemail.transferEncoding'
 +	even more opaque.  Default is the value of the `sendemail.transferEncoding`
  	configuration value; if that is unspecified, git will use 8bit and not
  	add a Content-Transfer-Encoding header.
  
@@@ -162,20 -157,20 +162,20 @@@ Sendin
  	subscribed to a list. In order to use the 'From' address, set the
  	value to "auto". 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
 +	`sendemail.envelopeSender` configuration variable; if that is
  	unspecified, choosing the envelope sender is left to your MTA.
  
  --smtp-encryption=<encryption>::
  	Specify the encryption to use, either 'ssl' or 'tls'.  Any other
  	value reverts to plain SMTP.  Default is the value of
 -	'sendemail.smtpEncryption'.
 +	`sendemail.smtpEncryption`.
  
  --smtp-domain=<FQDN>::
  	Specifies the Fully Qualified Domain Name (FQDN) used in the
  	HELO/EHLO command to the SMTP server.  Some servers require the
  	FQDN to match your IP address.  If not set, git send-email attempts
  	to determine your FQDN automatically.  Default is the value of
 -	'sendemail.smtpDomain'.
 +	`sendemail.smtpDomain`.
  
  --smtp-auth=<mechanisms>::
  	Whitespace-separated list of allowed SMTP-AUTH mechanisms. This setting
@@@ -187,19 -182,19 +187,19 @@@ $ git send-email --smtp-auth="PLAIN LOG
  +
  If at least one of the specified mechanisms matches the ones advertised by the
  SMTP server and if it is supported by the utilized SASL library, the mechanism
 -is used for authentication. If neither 'sendemail.smtpAuth' nor '--smtp-auth'
 +is used for authentication. If neither 'sendemail.smtpAuth' nor `--smtp-auth`
  is specified, all mechanisms supported by the SASL library can be used.
  
  --smtp-pass[=<password>]::
  	Password for SMTP-AUTH. The argument is optional: If no
  	argument is specified, then the empty string is used as
 -	the password. Default is the value of 'sendemail.smtpPass',
 -	however '--smtp-pass' always overrides this value.
 +	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 'sendemail.smtpUser'), but no password has been
 -specified (with '--smtp-pass' or 'sendemail.smtpPass'), then
 +`--smtp-user` or a `sendemail.smtpUser`), but no password has been
 +specified (with `--smtp-pass` or `sendemail.smtpPass`), then
  a password is obtained using 'git-credential'.
  
  --smtp-server=<host>::
@@@ -207,10 -202,10 +207,10 @@@
  	`smtp.example.com` or a raw IP address).  Alternatively it can
  	specify a full pathname of a sendmail-like program instead;
  	the program must support the `-i` option.  Default value can
 -	be specified by the 'sendemail.smtpServer' configuration
 -	option; the built-in default is `/usr/sbin/sendmail` or
 -	`/usr/lib/sendmail` if such program is available, or
 -	`localhost` otherwise.
 +	be specified by the `sendemail.smtpServer` configuration
 +	option; the built-in default is to search for `sendmail` in
 +	`/usr/sbin`, `/usr/lib` and $PATH if such program is
 +	available, falling back to `localhost` otherwise.
  
  --smtp-server-port=<port>::
  	Specifies a port different from the default port (SMTP
@@@ -218,11 -213,11 +218,11 @@@
  	submission port 587, or the common SSL smtp port 465);
  	symbolic port names (e.g. "submission" instead of 587)
  	are also accepted. The port can also be set with the
 -	'sendemail.smtpServerPort' configuration variable.
 +	`sendemail.smtpServerPort` configuration variable.
  
  --smtp-server-option=<option>::
  	If set, specifies the outgoing SMTP server option to use.
 -	Default value can be specified by the 'sendemail.smtpServerOption'
 +	Default value can be specified by the `sendemail.smtpServerOption`
  	configuration option.
  +
  The --smtp-server-option option must be repeated for each option you want
@@@ -239,13 -234,13 +239,13 @@@ must be used for each option
  	certificates concatenated together: see verify(1) -CAfile and
  	-CApath for more information on these). Set it to an empty string
  	to disable certificate verification. Defaults to the value of the
 -	'sendemail.smtpsslcertpath' configuration variable, if set, or the
 +	`sendemail.smtpsslcertpath` configuration variable, if set, or the
  	backing SSL library's compiled-in default otherwise (which should
  	be the best choice on most platforms).
  
  --smtp-user=<user>::
 -	Username for SMTP-AUTH. Default is the value of 'sendemail.smtpUser';
 -	if a username is not specified (with '--smtp-user' or 'sendemail.smtpUser'),
 +	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.
  
  --smtp-debug=0|1::
@@@ -253,21 -248,6 +253,21 @@@
  	commands and replies will be printed. Useful to debug TLS
  	connection and authentication problems.
  
 +--batch-size=<num>::
 +	Some email servers (e.g. smtp.163.com) limit the number emails to be
 +	sent per session (connection) and this will lead to a faliure when
 +	sending many messages.  With this option, send-email will disconnect after
 +	sending $<num> messages and wait for a few seconds (see --relogin-delay)
 +	and reconnect, to work around such a limit.  You may want to
 +	use some form of credential helper to avoid having to retype
 +	your password every time this happens.  Defaults to the
 +	`sendemail.smtpBatchSize` configuration variable.
 +
 +--relogin-delay=<int>::
 +	Waiting $<int> seconds before reconnecting to SMTP server. Used together
 +	with --batch-size option.  Defaults to the `sendemail.smtpReloginDelay`
 +	configuration variable.
 +
  Automating
  ~~~~~~~~~~
  
@@@ -281,25 -261,25 +281,25 @@@
  	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.
 +	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. Disabled by default, but the 'sendemail.chainReplyTo'
 +	entire patch series. Disabled by default, but the `sendemail.chainReplyTo`
  	configuration variable can be used to enable it.
  
  --identity=<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'.
 +	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.signedoffbycc' configuration
 +	cc list. Default is the value of `sendemail.signedoffbycc` configuration
  	value; if that is unspecified, default to --signed-off-by-cc.
  
  --[no-]cc-cover::
@@@ -332,13 -312,13 +332,13 @@@
  - 'all' will suppress all auto cc values.
  --
  +
 -Default is the value of 'sendemail.suppresscc' configuration value; if
 +Default is the value of `sendemail.suppresscc` configuration value; if
  that is unspecified, default to 'self' if --suppress-from is
  specified, as well as 'body' if --no-signed-off-cc is specified.
  
  --[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
 +	Default is the value of `sendemail.suppressFrom` configuration
  	value; if that is unspecified, default to --no-suppress-from.
  
  --[no-]thread::
@@@ -350,7 -330,7 +350,7 @@@
  +
  If disabled with "--no-thread", those headers will not be added
  (unless specified with --in-reply-to).  Default is the value of the
 -'sendemail.thread' configuration value; if that is unspecified,
 +`sendemail.thread` configuration value; if that is unspecified,
  default to --thread.
  +
  It is up to the user to ensure that no In-Reply-To header already
@@@ -375,7 -355,7 +375,7 @@@ Administerin
  - 'auto' is equivalent to 'cc' + 'compose'
  --
  +
 -Default is the value of 'sendemail.confirm' configuration value; if that
 +Default is the value of `sendemail.confirm` configuration value; if that
  is unspecified, default to 'auto' unless any of the suppress options
  have been specified, in which case default to 'compose'.
  
@@@ -384,8 -364,8 +384,8 @@@
  
  --[no-]format-patch::
  	When an argument may be understood either as a reference or as a file name,
 -	choose to understand it as a format-patch argument ('--format-patch')
 -	or as a file name ('--no-format-patch'). By default, when such a conflict
 +	choose to understand it as a format-patch argument (`--format-patch`)
 +	or as a file name (`--no-format-patch`). By default, when such a conflict
  	occurs, git send-email will fail.
  
  --quiet::
@@@ -397,13 -377,12 +397,13 @@@
  	Currently, validation means the following:
  +
  --
 +		*	Invoke the sendemail-validate hook if present (see linkgit:githooks[5]).
  		*	Warn of patches that contain lines longer than 998 characters; this
  			is due to SMTP limits as described by http://www.ietf.org/rfc/rfc2821.txt.
  --
  +
 -Default is the value of 'sendemail.validate'; if this is not set,
 -default to '--validate'.
 +Default is the value of `sendemail.validate`; if this is not set,
 +default to `--validate`.
  
  --force::
  	Send emails even if safety checks would prevent it.
@@@ -424,7 -403,7 +424,7 @@@ CONFIGURATIO
  
  sendemail.aliasesFile::
  	To avoid typing long email addresses, point this to one or more
 -	email aliases files.  You must also supply 'sendemail.aliasFileType'.
 +	email aliases files.  You must also supply `sendemail.aliasFileType`.
  
  sendemail.aliasFileType::
  	Format of the file(s) specified in sendemail.aliasesFile. Must be
@@@ -449,13 -428,13 +449,13 @@@ sendmail;
  
  sendemail.multiEdit::
  	If true (default), a single editor instance will be spawned to edit
 -	files you have to edit (patches when '--annotate' is used, and the
 -	summary when '--compose' is used). If false, files will be edited one
 +	files you have to edit (patches when `--annotate` is used, and the
 +	summary when `--compose` is used). If false, files will be edited one
  	after the other, spawning a new editor each time.
  
  sendemail.confirm::
  	Sets the default for whether to confirm before sending. Must be
 -	one of 'always', 'never', 'cc', 'compose', or 'auto'. See '--confirm'
 +	one of 'always', 'never', 'cc', 'compose', or 'auto'. See `--confirm`
  	in the previous section for the meaning of these values.
  
  EXAMPLE
@@@ -471,18 -450,9 +471,9 @@@ edit ~/.gitconfig to specify your accou
  		smtpUser = yourname@gmail.com
  		smtpServerPort = 587
  
 -If you have multifactor authentication setup on your gmail acocunt, you will
 +If you have multifactor authentication setup on your gmail account, you will
  need to generate an app-specific password for use with 'git send-email'. Visit
- https://security.google.com/settings/security/apppasswords to setup an
- app-specific password.  Once setup, you can store it with the credentials
- helper:
- 
- 	$ git credential fill
- 	protocol=smtp
- 	host=smtp.gmail.com
- 	username=youname@gmail.com
- 	password=app-password
- 
+ https://security.google.com/settings/security/apppasswords to create it.
  
  Once your commits are ready to be sent to the mailing list, run the
  following commands:
@@@ -491,6 -461,11 +482,11 @@@
  	$ edit outgoing/0000-*
  	$ git send-email outgoing/*
  
+ The first time you run it, you will be prompted for your credentials.  Enter the
+ app-specific or your regular password as appropriate.  If you have credential
+ helper configured (see linkgit:git-credential[1]), the password will be saved in
+ the credential store so you won't have to type it the next time.
+ 
  Note: the following perl modules are required
        Net::SMTP::SSL, MIME::Base64 and Authen::SASL