diff options
| author |  Eric Sunshine <sunshine@sunshineco.com> | 2018-07-22 05:57:09 -0400 |
|---|---|---|
| committer |  Junio C Hamano <gitster@pobox.com> | 2018-07-23 12:50:06 -0700 |
| commit | ee6cbf712edcbd1dc14993ab2452fbe882dc524a (patch) | |
| tree | c339d324037e1a3de90b91385b4c8a7fad1cfde7 /Documentation | |
| parent | log-tree: show_log: make commentary block delimiting reusable (diff) | |
| download | tgif-ee6cbf712edcbd1dc14993ab2452fbe882dc524a.tar.xz | |
format-patch: allow --interdiff 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 an interdiff, typically in the cover
letter. However, it is occasionally useful, despite making for a noisy
read, to insert an interdiff into the commentary section of the lone
patch of a 1-patch series.
Therefore, extend "git format-patch --interdiff=<prev>" to insert an
interdiff into the commentary section of a lone patch rather than
requiring a cover letter. The interdiff is indented to avoid confusing
git-am and human readers into considering it part of the patch proper.
Implementation note: Generating an interdiff 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 interdiff, and restore it
after.
Signed-off-by: Eric Sunshine <sunshine@sunshineco.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Documentation')
| -rw-r--r-- | Documentation/git-format-patch.txt | 3 |
1 files changed, 2 insertions, 1 deletions
diff --git a/Documentation/git-format-patch.txt b/Documentation/git-format-patch.txt index a1b1bafee7..f8a061794d 100644 --- a/Documentation/git-format-patch.txt +++ b/Documentation/git-format-patch.txt @@ -230,7 +230,8 @@ feeding the result to `git send-email`. fill in a description in the file before sending it out. --interdiff=<previous>:: - As a reviewer aid, insert an interdiff into the cover letter showing + As a reviewer aid, insert an interdiff 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` is a single revision naming the tip of the previous series which shares a common base with |