[libvirt] [PATCHv3] docs: Improve patch submission guidelines

[Eric Blake]

On 07/12/2012 03:44 AM, Michal Privoznik wrote:
> We should really advise (new) developers to send rebased patches
> that apply cleanly and use git-send-email rather than all other
> obscure ways.
> ---
> diff to v2:
> -Eric's suggestions worked in
> 
>  HACKING              |   37 ++++++++++++++++++++++++++++++++++++-
>  docs/hacking.html.in |   49 ++++++++++++++++++++++++++++++++++++++++++++-----
>  2 files changed, 80 insertions(+), 6 deletions(-)

ACK with one spelling nit fixed.

> +++ b/docs/hacking.html.in
> @@ -11,19 +11,58 @@
>  
>        <li><p>Post patches in unified diff format.  A command similar to this
>          should work:</p>
> -<pre>
> +<del><pre>

I'm not familiar with the <del> tag, but assume it made a useful
difference.  At any rate, the toolchain didn't choke on it.

> +  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
> +        set it in git config:</p>
> +<pre>
> +  git config sendemail.to libvir-list at redhat.com

Maybe also mention that you can set aliases to cut down on typing:

git config alias.mysend \
  'send-email --cover-letter --no-chain-reply-to --annotate'

(untested, though, so I'm okay if you save it for a separate patch after
actually testing it).

> +</pre>
> +        <p>Please follow this as close as you can, especially the rebase and
> +        git send-email part, as it makes life easier for other developers to
> +        review your patch set. One should avoid sending patches as attachments,
> +        but rather send them in email body among with commit message. If a

s/among/along/

-- 
Eric Blake   eblake at redhat.com    +1-919-301-3266
Libvirt virtualization library http://libvirt.org



-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 620 bytes
Desc: OpenPGP digital signature
URL: <http://listman.redhat.com/archives/libvir-list/attachments/20120713/c1de3bfb/attachment-0001.sig>