Re: [PATCH] git-send-email.txt: Add EXAMPLES section. Write 1st level sections in uppercase

From: Jari Aalto <jari.aalto@cante.net>
Date: Apr 16, 2010, 11:46 UTC
Message-ID: <8739yvsjqv.fsf@jondo.cante.net>
In-Reply-To: <4BC81975.9000907@drmicha.warpmail.net>

Michael J Gruber <git@drmicha.warpmail.net> writes:

Show 27 quoted lines

> 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?

Show 14 quoted lines

>> +
>> +	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