From: Baz Date: Tue, 07 Apr 2009 15:06:11 GMT Subject: Re: [RFC PATCH] git-send-email.txt: clarify which options take an argument. Message-ID: <2faad3050904070806o55ba937cy1e5cd4fd156a4352@mail.gmail.com> In-Reply-To: <1239111587-23452-1-git-send-email-Matthieu.Moy@imag.fr> 2009/4/7 Matthieu Moy : > --- > > Can someone more knowledgeable than me proof-read this? I tried to use > intuitive names for the arguments (like 'address' where an email > address is expected), but since there are options I never used, I may > have mis-understood some of them. > > Thanks, > >  Documentation/git-send-email.txt |   36 ++++++++++++++++++------------------ >  1 files changed, 18 insertions(+), 18 deletions(-) > > diff --git a/Documentation/git-send-email.txt b/Documentation/git-send-email.txt > index 10dfd66..e25da71 100644 > --- a/Documentation/git-send-email.txt > +++ b/Documentation/git-send-email.txt > @@ -39,13 +39,13 @@ OPTIONS >  Composing >  ~~~~~~~~~ > > ---bcc:: > +--bcc='address':: >        Specify a "Bcc:" value for each email. Default is the value of >        'sendemail.bcc'. A general comment: the other man pages use a style like "--bcc=
". >  + >  The --bcc option must be repeated for each user you want on the bcc list. > > ---cc:: > +--cc='address':: >        Specify a starting "Cc:" value for each email. >        Default is the value of 'sendemail.cc'. >  + > @@ -68,24 +68,24 @@ and In-Reply-To headers will be used unless they are removed. >  + >  Missing From or In-Reply-To headers will be prompted for. > > ---from:: > +--from='address':: >        Specify the sender of the emails.  This will default to >        the value GIT_COMMITTER_IDENT, as returned by "git var -l". >        The user will still be prompted to confirm this entry. > > ---in-reply-to:: > +--in-reply-to='identifier':: >        Specify the contents of the first In-Reply-To header. >        Subsequent emails will refer to the previous email >        instead of this if --chain-reply-to is set (the default) >        Only necessary if --compose is also set.  If --compose >        is not set, this will be prompted for. > > ---subject:: > +--subject='string':: >        Specify the initial subject of the email thread. >        Only necessary if --compose is also set.  If --compose >        is not set, this will be prompted for. > > ---to:: > +--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, > @@ -97,7 +97,7 @@ The --to option must be repeated for each user you want on the to list. >  Sending >  ~~~~~~~ > > ---envelope-sender:: > +--envelope-sender='address':: >        Specify the envelope sender used to send the emails. >        This is useful if your default address is not the address that is >        subscribed to a list. If you use the sendmail binary, you must have > @@ -105,12 +105,12 @@ Sending >        the 'sendemail.envelopesender' configuration variable; if that is >        unspecified, choosing the envelope sender is left to your MTA. > > ---smtp-encryption:: > +--smtp-encryption='mode':: >        Specify the encryption to use, either 'ssl' or 'tls'.  Any other >        value reverts to plain SMTP.  Default is the value of >        'sendemail.smtpencryption'. Maybe here. You use for other options below to mean something else. However, I doubt the use is all that confusing. > ---smtp-pass:: > +--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', > @@ -122,7 +122,7 @@ or on the command line. If a username has been specified (with >  specified (with '--smtp-pass' or 'sendemail.smtppass'), then the >  user is prompted for a password while the input is masked for privacy. > > ---smtp-server:: > +--smtp-server='host':: >        If set, specifies the outgoing SMTP server to use (e.g. >        `smtp.example.com` or a raw IP address).  Alternatively it can >        specify a full pathname of a sendmail-like program instead; > @@ -132,7 +132,7 @@ user is prompted for a password while the input is masked for privacy. >        `/usr/lib/sendmail` if such program is available, or >        `localhost` otherwise. > > ---smtp-server-port:: > +--smtp-server-port='port':: >        Specifies a port different from the default port (SMTP >        servers typically listen to smtp port 25 and ssmtp port >        465). This can be set with 'sendemail.smtpserverport'. > @@ -140,7 +140,7 @@ user is prompted for a password while the input is masked for privacy. >  --smtp-ssl:: >        Legacy alias for '--smtp-encryption ssl'. > > ---smtp-user:: > +--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'), >        then authentication is not attempted. > @@ -149,13 +149,13 @@ user is prompted for a password while the input is masked for privacy. >  Automating >  ~~~~~~~~~~ > > ---cc-cmd:: > +--cc-cmd='cmd':: >        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. Why not ? The option is short to save typing, doesn't mean its documentation has to be. > ---[no-]chain-reply-to:: > +--[no-]chain-reply-to='identifier':: >        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 > @@ -163,7 +163,7 @@ Automating >        entire patch series. Default is the value of the 'sendemail.chainreplyto' >        configuration value; if that is unspecified, default to --chain-reply-to. > > ---identity:: > +--identity='identity':: >        A configuration identity. When given, causes values in the >        'sendemail.' subsection to take precedence over >        values in the 'sendemail' section. The default identity is > @@ -174,7 +174,7 @@ Automating >        cc list. Default is the value of 'sendemail.signedoffbycc' configuration >        value; if that is unspecified, default to --signed-off-by-cc. > > ---suppress-cc:: > +--suppress-cc='category':: >        Specify an additional category of recipients to suppress the >        auto-cc of: >  + > @@ -211,7 +211,7 @@ specified, as well as 'body' if --no-signed-off-cc is specified. >  Administering >  ~~~~~~~~~~~~~ > > ---confirm:: > +--confirm='mode':: >        Confirm just before sending: >  + >  -- > @@ -234,7 +234,7 @@ have been specified, in which case default to 'compose'. >        Make git-send-email less verbose.  One line per email should be >        all that is output. > > ---[no-]validate:: > +--[no-]validate='mode':: >        Perform sanity checks on patches. >        Currently, validation means the following: Is this one correct? Don't you just type --validate, or --no-validate, without a value? >  + > -- > 1.6.2.2.449.g92961.dirty > > -- > To unsubscribe from this list: send the line "unsubscribe git" in > the body of a message to majordomo@vger.kernel.org > More majordomo info at  http://vger.kernel.org/majordomo-info.html >