[libvirt] [PATCH] hacking: Improve 'git send-email' documentation

Kashyap Chamarthy kchamart at redhat.com
Thu Jun 15 09:08:41 UTC 2017


On Thu, Jun 15, 2017 at 11:31:43AM +0800, Andrea Bolognani wrote:
> For the benefit of first time contributors, we point out that 'git
> send-email' might have to be installed separately; however, we omit
> the fact that some configuration will likely be needed before it
> can successfully deliver patches to the mailing list.
> 
> Some minor tweaks to the existing contents are included as well.
> 
> Signed-off-by: Andrea Bolognani <abologna at redhat.com>
> ---
>  docs/hacking.html.in | 36 ++++++++++++++++++++++++------------
>  1 file changed, 24 insertions(+), 12 deletions(-)

[...]

> -        <p>(Note that the "git send-email" subcommand may not be in
> -        the main git package and using it may require installation of a
> -        separate package, for example the "git-email" package in
> -        Fedora.)  For a single patch you can omit
> -        <code>--cover-letter</code>, but a series of two or more
> -        patches needs a cover letter. 

For multiple patch series, is it worthwhile to mention the "--stat"
option to include the diffstat in the cover letter?  When reading a
patch series, I find it useful to see the diffstat at a glance.

E.g. when sending the top 4 commits:

    $ git send-email -4 --cover-letter --no-chain-reply-to \
        --annotate --to=libvir at redhat.com master --stat

Maybe others here have their own preferred method to include diffstat in
cover letters.

[...]

-- 
/kashyap




More information about the libvir-list mailing list