From: Matthieu Moy <Matthieu.Moy@imag.fr>
To: Baz <brian.ewins@gmail.com>
Cc: gitster@pobox.com, git@vger.kernel.org
Subject: Re: [RFC PATCH] git-send-email.txt: clarify which options take an argument.
Date: Tue, 07 Apr 2009 18:59:26 +0200 [thread overview]
Message-ID: <vpqvdpg8knl.fsf@bauges.imag.fr> (raw)
In-Reply-To: <2faad3050904070806o55ba937cy1e5cd4fd156a4352@mail.gmail.com> (Baz's message of "Tue\, 7 Apr 2009 16\:06\:11 +0100")
Baz <brian.ewins@gmail.com> writes:
> 2009/4/7 Matthieu Moy <Matthieu.Moy@imag.fr>:
>> ---
>>
>> 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=<address>".
Almost all ;-). A quick grep showed me git-rev-list.txt and I did the
same. I'll send another patch to make it consistant.
>> +--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 <encryption-mode> here. You use <mode> for other options below
> to mean something else. However, I doubt the use is all that
> confusing.
Changed to just "encryption", since this is the word used just below
in the sentence.
>> ---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 <command>? The option is short to save typing, doesn't mean
> its documentation has to be.
Done.
>> ---[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?
Fixed too.
Thanks, new patch follows.
--
Matthieu
next prev parent reply other threads:[~2009-04-07 17:26 UTC|newest]
Thread overview: 6+ messages / expand[flat|nested] mbox.gz Atom feed top
2009-04-07 13:39 [RFC PATCH] git-send-email.txt: clarify which options take an argument Matthieu Moy
2009-04-07 15:06 ` Baz
2009-04-07 15:48 ` Baz
2009-04-07 16:59 ` Matthieu Moy [this message]
2009-04-07 17:24 ` [PATCH 1/2] " Matthieu Moy
2009-04-07 17:24 ` [PATCH 2/2] git-rev-list.txt: make ascii markup uniform with other pages Matthieu Moy
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=vpqvdpg8knl.fsf@bauges.imag.fr \
--to=matthieu.moy@imag.fr \
--cc=brian.ewins@gmail.com \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.com \
/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).