[libvirt] [PATCH] docs: point out git send-email location, be more stern about make check

Laine Stump laine at laine.org
Mon Sep 10 15:11:11 UTC 2012


On 09/06/2012 03:07 PM, Jiri Denemark wrote:
> On Thu, Sep 06, 2012 at 13:24:24 -0400, Laine Stump wrote:
>> An email came to libvir-list wondering why the git send-email command
>> was missing in spite of having git installed; this is due to the
>> send-email command being in a sub-package of the main git package.
>>
>> While touching the hacking file, I thought it would be useful to 1)
>> indicate the location of the source (docs/hacking.html.in) in the
>> message at the top of HACKING, and also to make the note about running
>> "make check" and "make syntax-check" a bit more stern.
>> ---
> ...
>> diff --git a/docs/hacking.html.in b/docs/hacking.html.in
>> index ca02669..1917b78 100644
>> --- a/docs/hacking.html.in
>> +++ b/docs/hacking.html.in
>> @@ -31,11 +31,15 @@
>>  <pre>
>>    git pull --rebase
>>    (fix any conflicts)
>> -  git send-email --cover-letter --no-chain-reply-to --annotate --to=libvir-list at redhat.com master
>> -</pre>
>> -        <p>For a single patch you can omit <code>--cover-letter</code>, but
>> -        series of a two or more patches needs a cover letter. If you get tired
>> -        of typing <code>--to=libvir-list at redhat.com</code> designation you can
>> +  git send-email --cover-letter --no-chain-reply-to --annotate \
>> +                 --to=libvir-list at redhat.com master
>> +</pre>
>> +        <p>(Note that the "git send-email" subcommand is usually not
>> +        in the main git package, but part of a sub-package called
>> +        "git-email".) For a single patch you can omit
> IMHO this sounds too Fedora-centric. How about the following (with possible
> stylistic and grammatical changes to make it sound better to native speakers)
> :-)
>
>     (Note that the "git send-email" subcommand may not be in the main git
>     package and using it may require installing of a separate package. This
>     package is called "git-email" in Fedora.) ...
>
>> +        <code>--cover-letter</code>, but series of a two or more
>> +        patches needs a cover letter. If you get tired of typing
>> +        <code>--to=libvir-list at redhat.com</code> designation you can
>>          set it in git config:</p>
>>  <pre>
>>    git config sendemail.to libvir-list at redhat.com
> ACK with the nit addressed.

I pushed with something similar to your wording.




More information about the libvir-list mailing list