{"thread":{"id":"18765","subject":"[RFC PATCH] git-send-email.txt: clarify which options take an argument.","startedAt":"2009-04-07T13:39:47Z","lastAt":"2009-04-07T17:24:33Z","messageCount":6,"participants":["Matthieu Moy","Baz"],"isPatch":true,"patchVersion":1,"patchTotal":null},"messages":[{"id":"110705","messageId":"1239111587-23452-1-git-send-email-Matthieu.Moy@imag.fr","threadId":"18765","inReplyTo":null,"subject":"[RFC PATCH] git-send-email.txt: clarify which options take an argument.","fromName":"Matthieu Moy","fromEmail":"matthieu.moy@imag.fr","sentAt":"2009-04-07T13:39:47Z","receivedAt":"2009-04-07T13:39:47Z","isPatch":true,"sender":{"key":"git@matthieu-moy.fr","avatar":"https://avatars.githubusercontent.com/u/14709?v=4"},"body":"---\n\nCan someone more knowledgeable than me proof-read this? I tried to use\nintuitive names for the arguments (like 'address' where an email\naddress is expected), but since there are options I never used, I may\nhave mis-understood some of them.\n\nThanks,\n\n Documentation/git-send-email.txt | 36 ++++++++++++++++++------------------\n 1 files changed, 18 insertions(+), 18 deletions(-)\n\ndiff --git a/Documentation/git-send-email.txt b/Documentation/git-send-email.txt\nindex 10dfd66..e25da71 100644\n--- a/Documentation/git-send-email.txt\n+++ b/Documentation/git-send-email.txt\n@@ -39,13 +39,13 @@ OPTIONS\n Composing\n ~~~~~~~~~\n \n---bcc::\n+--bcc='address'::\n \tSpecify a \"Bcc:\" value for each email. Default is the value of\n \t'sendemail.bcc'.\n +\n The --bcc option must be repeated for each user you want on the bcc list.\n \n---cc::\n+--cc='address'::\n \tSpecify a starting \"Cc:\" value for each email.\n \tDefault is the value of 'sendemail.cc'.\n +\n@@ -68,24 +68,24 @@ and In-Reply-To headers will be used unless they are removed.\n +\n Missing From or In-Reply-To headers will be prompted for.\n \n---from::\n+--from='address'::\n \tSpecify the sender of the emails. This will default to\n \tthe value GIT_COMMITTER_IDENT, as returned by \"git var -l\".\n \tThe user will still be prompted to confirm this entry.\n \n---in-reply-to::\n+--in-reply-to='identifier'::\n \tSpecify the contents of the first In-Reply-To header.\n \tSubsequent emails will refer to the previous email\n \tinstead of this if --chain-reply-to is set (the default)\n \tOnly necessary if --compose is also set. If --compose\n \tis not set, this will be prompted for.\n \n---subject::\n+--subject='string'::\n \tSpecify the initial subject of the email thread.\n \tOnly necessary if --compose is also set. If --compose\n \tis not set, this will be prompted for.\n \n---to::\n+--to='address'::\n \tSpecify the primary recipient of the emails generated. Generally, this\n \twill be the upstream maintainer of the project involved. Default is the\n \tvalue of the 'sendemail.to' configuration value; if that is unspecified,\n@@ -97,7 +97,7 @@ The --to option must be repeated for each user you want on the to list.\n Sending\n ~~~~~~~\n \n---envelope-sender::\n+--envelope-sender='address'::\n \tSpecify the envelope sender used to send the emails.\n \tThis is useful if your default address is not the address that is\n \tsubscribed to a list. If you use the sendmail binary, you must have\n@@ -105,12 +105,12 @@ Sending\n \tthe 'sendemail.envelopesender' configuration variable; if that is\n \tunspecified, choosing the envelope sender is left to your MTA.\n \n---smtp-encryption::\n+--smtp-encryption='mode'::\n \tSpecify the encryption to use, either 'ssl' or 'tls'. Any other\n \tvalue reverts to plain SMTP. Default is the value of\n \t'sendemail.smtpencryption'.\n \n---smtp-pass::\n+--smtp-pass[='password']::\n \tPassword for SMTP-AUTH. The argument is optional: If no\n \targument is specified, then the empty string is used as\n \tthe password. Default is the value of 'sendemail.smtppass',\n@@ -122,7 +122,7 @@ or on the command line. If a username has been specified (with\n specified (with '--smtp-pass' or 'sendemail.smtppass'), then the\n user is prompted for a password while the input is masked for privacy.\n \n---smtp-server::\n+--smtp-server='host'::\n \tIf set, specifies the outgoing SMTP server to use (e.g.\n \t`smtp.example.com` or a raw IP address). Alternatively it can\n \tspecify a full pathname of a sendmail-like program instead;\n@@ -132,7 +132,7 @@ user is prompted for a password while the input is masked for privacy.\n \t`/usr/lib/sendmail` if such program is available, or\n \t`localhost` otherwise.\n \n---smtp-server-port::\n+--smtp-server-port='port'::\n \tSpecifies a port different from the default port (SMTP\n \tservers typically listen to smtp port 25 and ssmtp port\n \t465). This can be set with 'sendemail.smtpserverport'.\n@@ -140,7 +140,7 @@ user is prompted for a password while the input is masked for privacy.\n --smtp-ssl::\n \tLegacy alias for '--smtp-encryption ssl'.\n \n---smtp-user::\n+--smtp-user='user'::\n \tUsername for SMTP-AUTH. Default is the value of 'sendemail.smtpuser';\n \tif a username is not specified (with '--smtp-user' or 'sendemail.smtpuser'),\n \tthen authentication is not attempted.\n@@ -149,13 +149,13 @@ user is prompted for a password while the input is masked for privacy.\n Automating\n ~~~~~~~~~~\n \n---cc-cmd::\n+--cc-cmd='cmd'::\n \tSpecify a command to execute once per patch file which\n \tshould generate patch file specific \"Cc:\" entries.\n \tOutput of this command must be single email address per line.\n \tDefault is the value of 'sendemail.cccmd' configuration value.\n \n---[no-]chain-reply-to::\n+--[no-]chain-reply-to='identifier'::\n \tIf this is set, each email will be sent as a reply to the previous\n \temail sent. If disabled with \"--no-chain-reply-to\", all emails after\n \tthe first will be sent as replies to the first email sent. When using\n@@ -163,7 +163,7 @@ Automating\n \tentire patch series. Default is the value of the 'sendemail.chainreplyto'\n \tconfiguration value; if that is unspecified, default to --chain-reply-to.\n \n---identity::\n+--identity='identity'::\n \tA configuration identity. When given, causes values in the\n \t'sendemail.' subsection to take precedence over\n \tvalues in the 'sendemail' section. The default identity is\n@@ -174,7 +174,7 @@ Automating\n \tcc list. Default is the value of 'sendemail.signedoffbycc' configuration\n \tvalue; if that is unspecified, default to --signed-off-by-cc.\n \n---suppress-cc::\n+--suppress-cc='category'::\n \tSpecify an additional category of recipients to suppress the\n \tauto-cc of:\n +\n@@ -211,7 +211,7 @@ specified, as well as 'body' if --no-signed-off-cc is specified.\n Administering\n ~~~~~~~~~~~~~\n \n---confirm::\n+--confirm='mode'::\n \tConfirm just before sending:\n +\n --\n@@ -234,7 +234,7 @@ have been specified, in which case default to 'compose'.\n \tMake git-send-email less verbose. One line per email should be\n \tall that is output.\n \n---[no-]validate::\n+--[no-]validate='mode'::\n \tPerform sanity checks on patches.\n \tCurrently, validation means the following:\n +\n-- \n1.6.2.2.449.g92961.dirty\n"},{"id":"110711","messageId":"2faad3050904070806o55ba937cy1e5cd4fd156a4352@mail.gmail.com","threadId":"18765","inReplyTo":"1239111587-23452-1-git-send-email-Matthieu.Moy@imag.fr","subject":"Re: [RFC PATCH] git-send-email.txt: clarify which options take an argument.","fromName":"Baz","fromEmail":"brian.ewins@gmail.com","sentAt":"2009-04-07T15:06:11Z","receivedAt":"2009-04-07T15:06:11Z","isPatch":true,"sender":{"key":"brian.ewins@gmail.com","avatar":"https://gravatar.com/avatar/9ac03d89105e50a7151e695a1b4b1228151064ec3ac380a73b74ab397796baf7?d=mp&s=160"},"body":"2009/4/7 Matthieu Moy :\n> ---\n>\n> Can someone more knowledgeable than me proof-read this? I tried to use\n> intuitive names for the arguments (like 'address' where an email\n> address is expected), but since there are options I never used, I may\n> have mis-understood some of them.\n>\n> Thanks,\n>\n>  Documentation/git-send-email.txt |   36 ++++++++++++++++++------------------\n>  1 files changed, 18 insertions(+), 18 deletions(-)\n>\n> diff --git a/Documentation/git-send-email.txt b/Documentation/git-send-email.txt\n> index 10dfd66..e25da71 100644\n> --- a/Documentation/git-send-email.txt\n> +++ b/Documentation/git-send-email.txt\n> @@ -39,13 +39,13 @@ OPTIONS\n>  Composing\n>  ~~~~~~~~~\n>\n> ---bcc::\n> +--bcc='address'::\n>        Specify a \"Bcc:\" value for each email. Default is the value of\n>        'sendemail.bcc'.\n\nA general comment: the other man pages use a style like \"--bcc=
\".\n\n>  +\n>  The --bcc option must be repeated for each user you want on the bcc list.\n>\n> ---cc::\n> +--cc='address'::\n>        Specify a starting \"Cc:\" value for each email.\n>        Default is the value of 'sendemail.cc'.\n>  +\n> @@ -68,24 +68,24 @@ and In-Reply-To headers will be used unless they are removed.\n>  +\n>  Missing From or In-Reply-To headers will be prompted for.\n>\n> ---from::\n> +--from='address'::\n>        Specify the sender of the emails.  This will default to\n>        the value GIT_COMMITTER_IDENT, as returned by \"git var -l\".\n>        The user will still be prompted to confirm this entry.\n>\n> ---in-reply-to::\n> +--in-reply-to='identifier'::\n>        Specify the contents of the first In-Reply-To header.\n>        Subsequent emails will refer to the previous email\n>        instead of this if --chain-reply-to is set (the default)\n>        Only necessary if --compose is also set.  If --compose\n>        is not set, this will be prompted for.\n>\n> ---subject::\n> +--subject='string'::\n>        Specify the initial subject of the email thread.\n>        Only necessary if --compose is also set.  If --compose\n>        is not set, this will be prompted for.\n>\n> ---to::\n> +--to='address'::\n>        Specify the primary recipient of the emails generated. Generally, this\n>        will be the upstream maintainer of the project involved. Default is the\n>        value of the 'sendemail.to' configuration value; if that is unspecified,\n> @@ -97,7 +97,7 @@ The --to option must be repeated for each user you want on the to list.\n>  Sending\n>  ~~~~~~~\n>\n> ---envelope-sender::\n> +--envelope-sender='address'::\n>        Specify the envelope sender used to send the emails.\n>        This is useful if your default address is not the address that is\n>        subscribed to a list. If you use the sendmail binary, you must have\n> @@ -105,12 +105,12 @@ Sending\n>        the 'sendemail.envelopesender' configuration variable; if that is\n>        unspecified, choosing the envelope sender is left to your MTA.\n>\n> ---smtp-encryption::\n> +--smtp-encryption='mode'::\n>        Specify the encryption to use, either 'ssl' or 'tls'.  Any other\n>        value reverts to plain SMTP.  Default is the value of\n>        'sendemail.smtpencryption'.\n\nMaybe here. You use for other options below\nto mean something else. However, I doubt the use is all that\nconfusing.\n\n> ---smtp-pass::\n> +--smtp-pass[='password']::\n>        Password for SMTP-AUTH. The argument is optional: If no\n>        argument is specified, then the empty string is used as\n>        the password. Default is the value of 'sendemail.smtppass',\n> @@ -122,7 +122,7 @@ or on the command line. If a username has been specified (with\n>  specified (with '--smtp-pass' or 'sendemail.smtppass'), then the\n>  user is prompted for a password while the input is masked for privacy.\n>\n> ---smtp-server::\n> +--smtp-server='host'::\n>        If set, specifies the outgoing SMTP server to use (e.g.\n>        `smtp.example.com` or a raw IP address).  Alternatively it can\n>        specify a full pathname of a sendmail-like program instead;\n> @@ -132,7 +132,7 @@ user is prompted for a password while the input is masked for privacy.\n>        `/usr/lib/sendmail` if such program is available, or\n>        `localhost` otherwise.\n>\n> ---smtp-server-port::\n> +--smtp-server-port='port'::\n>        Specifies a port different from the default port (SMTP\n>        servers typically listen to smtp port 25 and ssmtp port\n>        465). This can be set with 'sendemail.smtpserverport'.\n> @@ -140,7 +140,7 @@ user is prompted for a password while the input is masked for privacy.\n>  --smtp-ssl::\n>        Legacy alias for '--smtp-encryption ssl'.\n>\n> ---smtp-user::\n> +--smtp-user='user'::\n>        Username for SMTP-AUTH. Default is the value of 'sendemail.smtpuser';\n>        if a username is not specified (with '--smtp-user' or 'sendemail.smtpuser'),\n>        then authentication is not attempted.\n> @@ -149,13 +149,13 @@ user is prompted for a password while the input is masked for privacy.\n>  Automating\n>  ~~~~~~~~~~\n>\n> ---cc-cmd::\n> +--cc-cmd='cmd'::\n>        Specify a command to execute once per patch file which\n>        should generate patch file specific \"Cc:\" entries.\n>        Output of this command must be single email address per line.\n>        Default is the value of 'sendemail.cccmd' configuration value.\n\nWhy not ? The option is short to save typing, doesn't mean\nits documentation has to be.\n\n> ---[no-]chain-reply-to::\n> +--[no-]chain-reply-to='identifier'::\n>        If this is set, each email will be sent as a reply to the previous\n>        email sent.  If disabled with \"--no-chain-reply-to\", all emails after\n>        the first will be sent as replies to the first email sent.  When using\n> @@ -163,7 +163,7 @@ Automating\n>        entire patch series. Default is the value of the 'sendemail.chainreplyto'\n>        configuration value; if that is unspecified, default to --chain-reply-to.\n>\n> ---identity::\n> +--identity='identity'::\n>        A configuration identity. When given, causes values in the\n>        'sendemail.' subsection to take precedence over\n>        values in the 'sendemail' section. The default identity is\n> @@ -174,7 +174,7 @@ Automating\n>        cc list. Default is the value of 'sendemail.signedoffbycc' configuration\n>        value; if that is unspecified, default to --signed-off-by-cc.\n>\n> ---suppress-cc::\n> +--suppress-cc='category'::\n>        Specify an additional category of recipients to suppress the\n>        auto-cc of:\n>  +\n> @@ -211,7 +211,7 @@ specified, as well as 'body' if --no-signed-off-cc is specified.\n>  Administering\n>  ~~~~~~~~~~~~~\n>\n> ---confirm::\n> +--confirm='mode'::\n>        Confirm just before sending:\n>  +\n>  --\n> @@ -234,7 +234,7 @@ have been specified, in which case default to 'compose'.\n>        Make git-send-email less verbose.  One line per email should be\n>        all that is output.\n>\n> ---[no-]validate::\n> +--[no-]validate='mode'::\n>        Perform sanity checks on patches.\n>        Currently, validation means the following:\n\nIs this one correct? Don't you just type --validate, or --no-validate,\nwithout a value?\n\n>  +\n> --\n> 1.6.2.2.449.g92961.dirty\n>\n> --\n> To unsubscribe from this list: send the line \"unsubscribe git\" in\n> the body of a message to majordomo@vger.kernel.org\n> More majordomo info at  http://vger.kernel.org/majordomo-info.html\n>\n"},{"id":"110714","messageId":"2faad3050904070848k3c0d7018n4cacf8cf1aadd9ab@mail.gmail.com","threadId":"18765","inReplyTo":"2faad3050904070806o55ba937cy1e5cd4fd156a4352@mail.gmail.com","subject":"Re: [RFC PATCH] git-send-email.txt: clarify which options take an argument.","fromName":"Baz","fromEmail":"brian.ewins@gmail.com","sentAt":"2009-04-07T15:48:45Z","receivedAt":"2009-04-07T15:48:45Z","isPatch":true,"sender":{"key":"brian.ewins@gmail.com","avatar":"https://gravatar.com/avatar/9ac03d89105e50a7151e695a1b4b1228151064ec3ac380a73b74ab397796baf7?d=mp&s=160"},"body":"2009/4/7 Baz :\n> 2009/4/7 Matthieu Moy :\n>> ---\n>>\n>> Can someone more knowledgeable than me proof-read this? I tried to use\n>> intuitive names for the arguments (like 'address' where an email\n>> address is expected), but since there are options I never used, I may\n>> have mis-understood some of them.\n>>\n>> Thanks,\n>>\n>>  Documentation/git-send-email.txt |   36 ++++++++++++++++++------------------\n>>  1 files changed, 18 insertions(+), 18 deletions(-)\n>>\n>> diff --git a/Documentation/git-send-email.txt b/Documentation/git-send-email.txt\n>> index 10dfd66..e25da71 100644\n>> --- a/Documentation/git-send-email.txt\n>> +++ b/Documentation/git-send-email.txt\n>> @@ -39,13 +39,13 @@ OPTIONS\n>>  Composing\n>>  ~~~~~~~~~\n>>\n>> ---bcc::\n>> +--bcc='address'::\n>>        Specify a \"Bcc:\" value for each email. Default is the value of\n>>        'sendemail.bcc'.\n>\n> A general comment: the other man pages use a style like \"--bcc=
\".\n>\n>>  +\n>>  The --bcc option must be repeated for each user you want on the bcc list.\n>>\n>> ---cc::\n>> +--cc='address'::\n>>        Specify a starting \"Cc:\" value for each email.\n>>        Default is the value of 'sendemail.cc'.\n>>  +\n>> @@ -68,24 +68,24 @@ and In-Reply-To headers will be used unless they are removed.\n>>  +\n>>  Missing From or In-Reply-To headers will be prompted for.\n>>\n>> ---from::\n>> +--from='address'::\n>>        Specify the sender of the emails.  This will default to\n>>        the value GIT_COMMITTER_IDENT, as returned by \"git var -l\".\n>>        The user will still be prompted to confirm this entry.\n>>\n>> ---in-reply-to::\n>> +--in-reply-to='identifier'::\n>>        Specify the contents of the first In-Reply-To header.\n>>        Subsequent emails will refer to the previous email\n>>        instead of this if --chain-reply-to is set (the default)\n>>        Only necessary if --compose is also set.  If --compose\n>>        is not set, this will be prompted for.\n>>\n>> ---subject::\n>> +--subject='string'::\n>>        Specify the initial subject of the email thread.\n>>        Only necessary if --compose is also set.  If --compose\n>>        is not set, this will be prompted for.\n>>\n>> ---to::\n>> +--to='address'::\n>>        Specify the primary recipient of the emails generated. Generally, this\n>>        will be the upstream maintainer of the project involved. Default is the\n>>        value of the 'sendemail.to' configuration value; if that is unspecified,\n>> @@ -97,7 +97,7 @@ The --to option must be repeated for each user you want on the to list.\n>>  Sending\n>>  ~~~~~~~\n>>\n>> ---envelope-sender::\n>> +--envelope-sender='address'::\n>>        Specify the envelope sender used to send the emails.\n>>        This is useful if your default address is not the address that is\n>>        subscribed to a list. If you use the sendmail binary, you must have\n>> @@ -105,12 +105,12 @@ Sending\n>>        the 'sendemail.envelopesender' configuration variable; if that is\n>>        unspecified, choosing the envelope sender is left to your MTA.\n>>\n>> ---smtp-encryption::\n>> +--smtp-encryption='mode'::\n>>        Specify the encryption to use, either 'ssl' or 'tls'.  Any other\n>>        value reverts to plain SMTP.  Default is the value of\n>>        'sendemail.smtpencryption'.\n>\n> Maybe here. You use for other options below\n> to mean something else. However, I doubt the use is all that\n> confusing.\n>\n>> ---smtp-pass::\n>> +--smtp-pass[='password']::\n>>        Password for SMTP-AUTH. The argument is optional: If no\n>>        argument is specified, then the empty string is used as\n>>        the password. Default is the value of 'sendemail.smtppass',\n>> @@ -122,7 +122,7 @@ or on the command line. If a username has been specified (with\n>>  specified (with '--smtp-pass' or 'sendemail.smtppass'), then the\n>>  user is prompted for a password while the input is masked for privacy.\n>>\n>> ---smtp-server::\n>> +--smtp-server='host'::\n>>        If set, specifies the outgoing SMTP server to use (e.g.\n>>        `smtp.example.com` or a raw IP address).  Alternatively it can\n>>        specify a full pathname of a sendmail-like program instead;\n>> @@ -132,7 +132,7 @@ user is prompted for a password while the input is masked for privacy.\n>>        `/usr/lib/sendmail` if such program is available, or\n>>        `localhost` otherwise.\n>>\n>> ---smtp-server-port::\n>> +--smtp-server-port='port'::\n>>        Specifies a port different from the default port (SMTP\n>>        servers typically listen to smtp port 25 and ssmtp port\n>>        465). This can be set with 'sendemail.smtpserverport'.\n>> @@ -140,7 +140,7 @@ user is prompted for a password while the input is masked for privacy.\n>>  --smtp-ssl::\n>>        Legacy alias for '--smtp-encryption ssl'.\n>>\n>> ---smtp-user::\n>> +--smtp-user='user'::\n>>        Username for SMTP-AUTH. Default is the value of 'sendemail.smtpuser';\n>>        if a username is not specified (with '--smtp-user' or 'sendemail.smtpuser'),\n>>        then authentication is not attempted.\n>> @@ -149,13 +149,13 @@ user is prompted for a password while the input is masked for privacy.\n>>  Automating\n>>  ~~~~~~~~~~\n>>\n>> ---cc-cmd::\n>> +--cc-cmd='cmd'::\n>>        Specify a command to execute once per patch file which\n>>        should generate patch file specific \"Cc:\" entries.\n>>        Output of this command must be single email address per line.\n>>        Default is the value of 'sendemail.cccmd' configuration value.\n>\n> Why not ? The option is short to save typing, doesn't mean\n> its documentation has to be.\n>\n>> ---[no-]chain-reply-to::\n>> +--[no-]chain-reply-to='identifier'::\n>>        If this is set, each email will be sent as a reply to the previous\n>>        email sent.  If disabled with \"--no-chain-reply-to\", all emails after\n>>        the first will be sent as replies to the first email sent.  When using\n>> @@ -163,7 +163,7 @@ Automating\n>>        entire patch series. Default is the value of the 'sendemail.chainreplyto'\n>>        configuration value; if that is unspecified, default to --chain-reply-to.\n>>\n>> ---identity::\n>> +--identity='identity'::\n>>        A configuration identity. When given, causes values in the\n>>        'sendemail.' subsection to take precedence over\n>>        values in the 'sendemail' section. The default identity is\n>> @@ -174,7 +174,7 @@ Automating\n>>        cc list. Default is the value of 'sendemail.signedoffbycc' configuration\n>>        value; if that is unspecified, default to --signed-off-by-cc.\n>>\n>> ---suppress-cc::\n>> +--suppress-cc='category'::\n>>        Specify an additional category of recipients to suppress the\n>>        auto-cc of:\n>>  +\n>> @@ -211,7 +211,7 @@ specified, as well as 'body' if --no-signed-off-cc is specified.\n>>  Administering\n>>  ~~~~~~~~~~~~~\n>>\n>> ---confirm::\n>> +--confirm='mode'::\n>>        Confirm just before sending:\n>>  +\n>>  --\n>> @@ -234,7 +234,7 @@ have been specified, in which case default to 'compose'.\n>>        Make git-send-email less verbose.  One line per email should be\n>>        all that is output.\n>>\n>> ---[no-]validate::\n>> +--[no-]validate='mode'::\n>>        Perform sanity checks on patches.\n>>        Currently, validation means the following:\n>\n> Is this one correct? Don't you just type --validate, or --no-validate,\n> without a value?\n\nSorry, I should have stated that more clearly, since you said you're\nunfamiliar with some of the options. This one is incorrect - you don't\npass an argument to --validate. The default value referred to is a\nboolean, but its unclear from the text, I guess thats what misled you.\nFollowing the examples in git-format-patch, the line below might be\nbetter rewritten as:\n\nIf this is set, sanity checks will be performed on patches, overriding\nthe configuration setting of sendemail.validate. The configuration\nsetting defaults to true. Currently, validation means the following:\n(etc)\n\n>\n>>  +\n>> --\n>> 1.6.2.2.449.g92961.dirty\n>>\n>> --\n>> To unsubscribe from this list: send the line \"unsubscribe git\" in\n>> the body of a message to majordomo@vger.kernel.org\n>> More majordomo info at  http://vger.kernel.org/majordomo-info.html\n>>\n>\n"},{"id":"110715","messageId":"vpqvdpg8knl.fsf@bauges.imag.fr","threadId":"18765","inReplyTo":"2faad3050904070806o55ba937cy1e5cd4fd156a4352@mail.gmail.com","subject":"Re: [RFC PATCH] git-send-email.txt: clarify which options take an argument.","fromName":"Matthieu Moy","fromEmail":"matthieu.moy@imag.fr","sentAt":"2009-04-07T16:59:26Z","receivedAt":"2009-04-07T16:59:26Z","isPatch":true,"sender":{"key":"git@matthieu-moy.fr","avatar":"https://avatars.githubusercontent.com/u/14709?v=4"},"body":"Baz writes:\n\n> 2009/4/7 Matthieu Moy :\n>> ---\n>>\n>> Can someone more knowledgeable than me proof-read this? I tried to use\n>> intuitive names for the arguments (like 'address' where an email\n>> address is expected), but since there are options I never used, I may\n>> have mis-understood some of them.\n>>\n>> Thanks,\n>>\n>>  Documentation/git-send-email.txt |   36 ++++++++++++++++++------------------\n>>  1 files changed, 18 insertions(+), 18 deletions(-)\n>>\n>> diff --git a/Documentation/git-send-email.txt b/Documentation/git-send-email.txt\n>> index 10dfd66..e25da71 100644\n>> --- a/Documentation/git-send-email.txt\n>> +++ b/Documentation/git-send-email.txt\n>> @@ -39,13 +39,13 @@ OPTIONS\n>>  Composing\n>>  ~~~~~~~~~\n>>\n>> ---bcc::\n>> +--bcc='address'::\n>>        Specify a \"Bcc:\" value for each email. Default is the value of\n>>        'sendemail.bcc'.\n>\n> A general comment: the other man pages use a style like \"--bcc=
\".\n\nAlmost all ;-). A quick grep showed me git-rev-list.txt and I did the\nsame. I'll send another patch to make it consistant.\n\n>> +--smtp-encryption='mode'::\n>>        Specify the encryption to use, either 'ssl' or 'tls'.  Any other\n>>        value reverts to plain SMTP.  Default is the value of\n>>        'sendemail.smtpencryption'.\n>\n> Maybe here. You use for other options below\n> to mean something else. However, I doubt the use is all that\n> confusing.\n\nChanged to just \"encryption\", since this is the word used just below\nin the sentence.\n\n>> ---cc-cmd::\n>> +--cc-cmd='cmd'::\n>>        Specify a command to execute once per patch file which\n>>        should generate patch file specific \"Cc:\" entries.\n>>        Output of this command must be single email address per line.\n>>        Default is the value of 'sendemail.cccmd' configuration value.\n>\n> Why not ? The option is short to save typing, doesn't mean\n> its documentation has to be.\n\nDone.\n\n>> ---[no-]validate::\n>> +--[no-]validate='mode'::\n>>        Perform sanity checks on patches.\n>>        Currently, validation means the following:\n>\n> Is this one correct? Don't you just type --validate, or --no-validate,\n> without a value?\n\nFixed too.\n\nThanks, new patch follows.\n\n-- \nMatthieu\n"},{"id":"110716","messageId":"1239125073-4422-1-git-send-email-Matthieu.Moy@imag.fr","threadId":"18765","inReplyTo":"vpqvdpg8knl.fsf@bauges.imag.fr","subject":"[PATCH 1/2] git-send-email.txt: clarify which options take an argument.","fromName":"Matthieu Moy","fromEmail":"matthieu.moy@imag.fr","sentAt":"2009-04-07T17:24:32Z","receivedAt":"2009-04-07T17:24:32Z","isPatch":true,"sender":{"key":"git@matthieu-moy.fr","avatar":"https://avatars.githubusercontent.com/u/14709?v=4"},"body":"Signed-off-by: Matthieu Moy \n---\n Documentation/git-send-email.txt | 34 +++++++++++++++++-----------------\n 1 files changed, 17 insertions(+), 17 deletions(-)\n\ndiff --git a/Documentation/git-send-email.txt b/Documentation/git-send-email.txt\nindex 10dfd66..0b1f183 100644\n--- a/Documentation/git-send-email.txt\n+++ b/Documentation/git-send-email.txt\n@@ -39,13 +39,13 @@ OPTIONS\n Composing\n ~~~~~~~~~\n \n---bcc::\n+--bcc=
::\n \tSpecify a \"Bcc:\" value for each email. Default is the value of\n \t'sendemail.bcc'.\n +\n The --bcc option must be repeated for each user you want on the bcc list.\n \n---cc::\n+--cc=
::\n \tSpecify a starting \"Cc:\" value for each email.\n \tDefault is the value of 'sendemail.cc'.\n +\n@@ -68,24 +68,24 @@ and In-Reply-To headers will be used unless they are removed.\n +\n Missing From or In-Reply-To headers will be prompted for.\n \n---from::\n+--from=
::\n \tSpecify the sender of the emails. This will default to\n \tthe value GIT_COMMITTER_IDENT, as returned by \"git var -l\".\n \tThe user will still be prompted to confirm this entry.\n \n---in-reply-to::\n+--in-reply-to=::\n \tSpecify the contents of the first In-Reply-To header.\n \tSubsequent emails will refer to the previous email\n \tinstead of this if --chain-reply-to is set (the default)\n \tOnly necessary if --compose is also set. If --compose\n \tis not set, this will be prompted for.\n \n---subject::\n+--subject=::\n \tSpecify the initial subject of the email thread.\n \tOnly necessary if --compose is also set. If --compose\n \tis not set, this will be prompted for.\n \n---to::\n+--to=
::\n \tSpecify the primary recipient of the emails generated. Generally, this\n \twill be the upstream maintainer of the project involved. Default is the\n \tvalue of the 'sendemail.to' configuration value; if that is unspecified,\n@@ -97,7 +97,7 @@ The --to option must be repeated for each user you want on the to list.\n Sending\n ~~~~~~~\n \n---envelope-sender::\n+--envelope-sender=
::\n \tSpecify the envelope sender used to send the emails.\n \tThis is useful if your default address is not the address that is\n \tsubscribed to a list. If you use the sendmail binary, you must have\n@@ -105,12 +105,12 @@ Sending\n \tthe 'sendemail.envelopesender' configuration variable; if that is\n \tunspecified, choosing the envelope sender is left to your MTA.\n \n---smtp-encryption::\n+--smtp-encryption=::\n \tSpecify the encryption to use, either 'ssl' or 'tls'. Any other\n \tvalue reverts to plain SMTP. Default is the value of\n \t'sendemail.smtpencryption'.\n \n---smtp-pass::\n+--smtp-pass[=]::\n \tPassword for SMTP-AUTH. The argument is optional: If no\n \targument is specified, then the empty string is used as\n \tthe password. Default is the value of 'sendemail.smtppass',\n@@ -122,7 +122,7 @@ or on the command line. If a username has been specified (with\n specified (with '--smtp-pass' or 'sendemail.smtppass'), then the\n user is prompted for a password while the input is masked for privacy.\n \n---smtp-server::\n+--smtp-server=::\n \tIf set, specifies the outgoing SMTP server to use (e.g.\n \t`smtp.example.com` or a raw IP address). Alternatively it can\n \tspecify a full pathname of a sendmail-like program instead;\n@@ -132,7 +132,7 @@ user is prompted for a password while the input is masked for privacy.\n \t`/usr/lib/sendmail` if such program is available, or\n \t`localhost` otherwise.\n \n---smtp-server-port::\n+--smtp-server-port=::\n \tSpecifies a port different from the default port (SMTP\n \tservers typically listen to smtp port 25 and ssmtp port\n \t465). This can be set with 'sendemail.smtpserverport'.\n@@ -140,7 +140,7 @@ user is prompted for a password while the input is masked for privacy.\n --smtp-ssl::\n \tLegacy alias for '--smtp-encryption ssl'.\n \n---smtp-user::\n+--smtp-user=::\n \tUsername for SMTP-AUTH. Default is the value of 'sendemail.smtpuser';\n \tif a username is not specified (with '--smtp-user' or 'sendemail.smtpuser'),\n \tthen authentication is not attempted.\n@@ -149,13 +149,13 @@ user is prompted for a password while the input is masked for privacy.\n Automating\n ~~~~~~~~~~\n \n---cc-cmd::\n+--cc-cmd=::\n \tSpecify a command to execute once per patch file which\n \tshould generate patch file specific \"Cc:\" entries.\n \tOutput of this command must be single email address per line.\n \tDefault is the value of 'sendemail.cccmd' configuration value.\n \n---[no-]chain-reply-to::\n+--[no-]chain-reply-to=::\n \tIf this is set, each email will be sent as a reply to the previous\n \temail sent. If disabled with \"--no-chain-reply-to\", all emails after\n \tthe first will be sent as replies to the first email sent. When using\n@@ -163,7 +163,7 @@ Automating\n \tentire patch series. Default is the value of the 'sendemail.chainreplyto'\n \tconfiguration value; if that is unspecified, default to --chain-reply-to.\n \n---identity::\n+--identity=::\n \tA configuration identity. When given, causes values in the\n \t'sendemail.' subsection to take precedence over\n \tvalues in the 'sendemail' section. The default identity is\n@@ -174,7 +174,7 @@ Automating\n \tcc list. Default is the value of 'sendemail.signedoffbycc' configuration\n \tvalue; if that is unspecified, default to --signed-off-by-cc.\n \n---suppress-cc::\n+--suppress-cc=::\n \tSpecify an additional category of recipients to suppress the\n \tauto-cc of:\n +\n@@ -211,7 +211,7 @@ specified, as well as 'body' if --no-signed-off-cc is specified.\n Administering\n ~~~~~~~~~~~~~\n \n---confirm::\n+--confirm=::\n \tConfirm just before sending:\n +\n --\n-- \n1.6.2.2.449.g92961.dirty\n"},{"id":"110717","messageId":"1239125073-4422-2-git-send-email-Matthieu.Moy@imag.fr","threadId":"18765","inReplyTo":"1239125073-4422-1-git-send-email-Matthieu.Moy@imag.fr","subject":"[PATCH 2/2] git-rev-list.txt: make ascii markup uniform with other pages.","fromName":"Matthieu Moy","fromEmail":"matthieu.moy@imag.fr","sentAt":"2009-04-07T17:24:33Z","receivedAt":"2009-04-07T17:24:33Z","isPatch":true,"sender":{"key":"git@matthieu-moy.fr","avatar":"https://avatars.githubusercontent.com/u/14709?v=4"},"body":"Other pages use --option=, not --option='argument', do the\nsame here.\n\nSigned-off-by: Matthieu Moy \n---\n Documentation/rev-list-options.txt | 22 +++++++++++-----------\n 1 files changed, 11 insertions(+), 11 deletions(-)\n\ndiff --git a/Documentation/rev-list-options.txt b/Documentation/rev-list-options.txt\nindex 7dd237c..11eec94 100644\n--- a/Documentation/rev-list-options.txt\n+++ b/Documentation/rev-list-options.txt\n@@ -140,38 +140,38 @@ limiting may be applied.\n --\n \n -n 'number'::\n---max-count='number'::\n+--max-count=::\n \n \tLimit the number of commits output.\n \n---skip='number'::\n+--skip=::\n \n \tSkip 'number' commits before starting to show the commit output.\n \n---since='date'::\n---after='date'::\n+--since=::\n+--after=::\n \n \tShow commits more recent than a specific date.\n \n---until='date'::\n---before='date'::\n+--until=::\n+--before=::\n \n \tShow commits older than a specific date.\n \n ifdef::git-rev-list[]\n---max-age='timestamp'::\n---min-age='timestamp'::\n+--max-age=::\n+--min-age=::\n \n \tLimit the commits output to specified time range.\n endif::git-rev-list[]\n \n---author='pattern'::\n---committer='pattern'::\n+--author=::\n+--committer=::\n \n \tLimit the commits output to ones with author/committer\n \theader lines that match the specified pattern (regular expression).\n \n---grep='pattern'::\n+--grep=::\n \n \tLimit the commits output to ones with log message that\n \tmatches the specified pattern (regular expression).\n-- \n1.6.2.2.449.g92961.dirty\n"}]}