path: root/Documentation/git-format-patch.txt
diff options
authorEric Sunshine <>2018-07-22 09:57:17 (GMT)
committerJunio C Hamano <>2018-08-14 21:27:05 (GMT)
commit40ce41604daf200cdc85abded0133d40faafc2f8 (patch)
tree39eebe33daf043ff9033a4728b5c278b86d8e54b /Documentation/git-format-patch.txt
parent8631bf1cdd7296684deebab2708761bfc8085fc2 (diff)
format-patch: allow --range-diff to apply to a lone-patch
When submitting a revised version of a patch or series, it can be helpful (to reviewers) to include a summary of changes since the previous attempt in the form of a range-diff, typically in the cover letter. However, it is occasionally useful, despite making for a noisy read, to insert a range-diff into the commentary section of the lone patch of a 1-patch series. Therefore, extend "git format-patch --range-diff=<refspec>" to insert a range-diff into the commentary section of a lone patch rather than requiring a cover letter. Implementation note: Generating a range-diff for insertion into the commentary section of a patch which itself is currently being generated requires invoking the diffing machinery recursively. However, the machinery does not (presently) support this since it uses global state. Consequently, we need to take care to stash away the state of the in-progress operation while generating the range-diff, and restore it after. Signed-off-by: Eric Sunshine <> Signed-off-by: Junio C Hamano <>
Diffstat (limited to 'Documentation/git-format-patch.txt')
1 files changed, 2 insertions, 1 deletions
diff --git a/Documentation/git-format-patch.txt b/Documentation/git-format-patch.txt
index 9b2e172..aba4c5f 100644
--- a/Documentation/git-format-patch.txt
+++ b/Documentation/git-format-patch.txt
@@ -241,7 +241,8 @@ feeding the result to `git send-email`.
As a reviewer aid, insert a range-diff (see linkgit:git-range-diff[1])
- into the cover letter showing the differences between the previous
+ into the cover letter, or as commentary of the lone patch of a
+ 1-patch series, showing the differences between the previous
version of the patch series and the series currently being formatted.
`previous` can be a single revision naming the tip of the previous
series if it shares a common base with the series being formatted (for