diff options
author | Leo Famulari <leo@famulari.name> | 2021-12-02 14:27:14 -0500 |
---|---|---|
committer | Leo Famulari <leo@famulari.name> | 2021-12-02 14:31:13 -0500 |
commit | f697fc267c317e98e4bba8009452b9d64e76b30a (patch) | |
tree | 6a2d6c68b7c24ff7318d713d417d8c81afa5ae9a | |
parent | 1f5c1bc024874b697e4251e1410919b705a86eb3 (diff) |
doc: Give more details about generating patches with base commit information.
* doc/contributing.texi (Submitting Patches): Talk more about '--base'.
-rw-r--r-- | doc/contributing.texi | 7 |
1 files changed, 5 insertions, 2 deletions
diff --git a/doc/contributing.texi b/doc/contributing.texi index aa6bfc2e65..db1c4c6921 100644 --- a/doc/contributing.texi +++ b/doc/contributing.texi @@ -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 |