[PATCH libgpg-error] doc: clarify patch submission workflow

[Todd Zullinger]

Thorsten Behrens wrote:
> +* Sending patches
> +
> +  - submitting patches, and subsequent discussions around them,
> +    happens via the gnupg-devel at gnupg.org public mailing list
> +
> +  - send your patches to that list, preferably PGP/MIME signed. Make
> +    sure to include a mention of 'libgpg-error' in the subject line,
> +    the list is used for several different projects
> +
> +  - if you're working from the git repo, here's a suggested workflow:
> +
> +    - hack hack hack
> +
> +    - commit your changes; group changes into easily-reviewable commit
> +      units, feel free to submit several patches at once
> +
> +    - e.g. if you want to submit a single patch on top of master, do:
> +      git send-email --to=gnupg-devel at gnupg.org --annotate -1
> +      (please put a mention of libgpg-error into the subjects,
> +      annotate lets you do that)
> +
> +    - e.g. if you have two commits on top of master, do:
> +      git send-email --to=gnupg-devel at gnupg.org --annotate --cover-letter -2
> +      (that prompts you for a summary mail to precede your actual
> +      patch mails)

I think it would be better to suggest setting the
format.subjectPrefix option to make this easier.  E.g.:

    $ git config format.subjectPrefix 'PATCH/libgpg-error'

It's generally better to use 'git format-patch --cover-letter ...'
to generate and edit the cover letter and be sure it looks
good, then use 'git send-email $patch_files'.  Using git
send-email to directly drive 'git format-patch' makes it far
too easy to send out the wrong patch series.

The format.subjectPrefix option applies whether you run git
format-patch or git send-email and let it call format-patch
though.

-- 
Todd
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Living your life is a task so difficult, it has never been attempted
before.

-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 543 bytes
Desc: not available
URL: <https://lists.gnupg.org/pipermail/gnupg-devel/attachments/20180201/1dd1752e/attachment.sig>