doc: Give more details about generating patches with base commit information.

* doc/contributing.texi (Submitting Patches): Talk more about '--base'.
This commit is contained in:
Leo Famulari 2021-12-02 14:27:14 -05:00
parent 1f5c1bc024
commit f697fc267c
No known key found for this signature in database
GPG Key ID: 2646FA30BACA7F08
1 changed files with 5 additions and 2 deletions

View File

@ -1017,8 +1017,11 @@ please run through this check list:
@cindex @code{git format-patch}
@cindex @code{git-format-patch}
@item
We recommend to use the command @code{git format-patch --base} to
include the commit where your patch applies.
When generating your patches with @code{git format-patch} or @code{git
send-email}, we recommend using the option @code{--base=}, perhaps with
the value @code{auto}. This option adds a note to the patch stating
which commit the patch is based on. This helps reviewers understand how
to apply and review your patches.
@item
If the authors of the packaged software provide a cryptographic