From: Jari Aalto <jari.aalto@cante•net>
To: Michael J Gruber <git@drmicha•warpmail.net>
Cc: git@vger•kernel.org
Subject: Re: [PATCH] git-send-email.txt: Add EXAMPLES section. Write 1st level sections in uppercase
Date: Fri, 16 Apr 2010 14:46:16 +0300 [thread overview]
Message-ID: <8739yvsjqv.fsf@jondo.cante.net> (raw)
In-Reply-To: <4BC81975.9000907@drmicha.warpmail.net> (Michael J. Gruber's message of "Fri, 16 Apr 2010 10:01:57 +0200")
Michael J Gruber <git@drmicha•warpmail.net> writes:
> jari.aalto@cante•net venit, vidit, dixit 15.04.2010 17:37:
>
>> From: Jari Aalto <jari.aalto@cante•net>
>>
>>
>> Signed-off-by: Jari Aalto <jari.aalto@cante•net>
>> ---
>> Documentation/git-send-email.txt | 36 ++++++++++++++++++++++++++++++++++--
>> 1 files changed, 34 insertions(+), 2 deletions(-)
>>
>> diff --git a/Documentation/git-send-email.txt b/Documentation/git-send-email.txt
>> index ced35b2..8b33eb0 100644
>> --- a/Documentation/git-send-email.txt
>> +++ b/Documentation/git-send-email.txt
>> @@ -299,8 +299,40 @@ sendemail.confirm::
>> one of 'always', 'never', 'cc', 'compose', or 'auto'. See '--confirm'
>> in the previous section for the meaning of these values.
>>
>> +EXAMPLES
>> +--------
>>
>> -Author
>> +To batch send all patches to a mailig list, no copies to oneself,
>> +messages in a relaxed single thread format (no nesting) and don't ask
>> +any confirmations:
>
> That sentence is linguistically screwed, but...
Please improve. How would you explain the options and their explanations
one-by-one as presented below?
>> +
>> + git send-email \
>> + --from $EMAIL \
>> + --to address@list•example.com \
>> + --suppress-cc=author \
>> + --suppress-from \
>> + --no-chain-reply-to \
>> + --confirm=never \
>> + outgoing/
>> +
>
> ... I don't think this is a good example at all. All options are
> explained in the man page, so what is the point in listing and
> explaining some of them here?
Right, all the 31 options.
> If we really want an introductory example,
> we want one with few options, where the default behaviour is explained.
I don't agree.
We need examples that use most of the options in combination so that the
examples can practically "copy pasted / sliced off". The user can eaily
reduce options he may not find useful from the examples.
With too few options presented, he needs to skim through the whole
of 31 option explanations above and pray he finds what he needs.
Please suggest another example to be accompanied with this one. How do
you use the git-send-email? What options? What you have configured in
~/.gitconfig?
Jari
next prev parent reply other threads:[~2010-04-16 11:46 UTC|newest]
Thread overview: 6+ messages / expand[flat|nested] mbox.gz Atom feed top
2010-04-15 15:37 [PATCH] git-send-email.txt: Add EXAMPLES section. Write 1st level sections in uppercase jari.aalto
2010-04-16 8:01 ` Michael J Gruber
2010-04-16 11:46 ` Jari Aalto [this message]
2010-04-16 13:04 ` Michael J Gruber
2010-04-16 17:05 ` Jari Aalto
2010-04-17 18:46 ` Junio C Hamano
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=8739yvsjqv.fsf@jondo.cante.net \
--to=jari.aalto@cante$(echo .)net \
--cc=git@drmicha$(echo .)warpmail.net \
--cc=git@vger$(echo .)kernel.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
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