diff options
| author | Eric Sunshine <sunshine@sunshineco.com> | 2018-07-22 09:57:13 (GMT) |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2018-08-14 21:27:04 (GMT) |
| commit | 31e2617a5f8fe1c114e72f058d1c035bbf77cffe (patch) | |
| tree | 83ffca7f0e55973f14e05d48160dd83f5dc448cd /Documentation/git-format-patch.txt | |
| parent | 73a834e9e27906a76940f1ced5c132bce205d3f8 (diff) | |
| download | git-31e2617a5f8fe1c114e72f058d1c035bbf77cffe.zip git-31e2617a5f8fe1c114e72f058d1c035bbf77cffe.tar.gz git-31e2617a5f8fe1c114e72f058d1c035bbf77cffe.tar.bz2 | |
format-patch: add --range-diff option to embed diff in cover letter
When submitting a revised version of a patch series, it can be helpful
(to reviewers) to include a summary of changes since the previous
attempt in the form of a range-diff, however, doing so involves manually
copy/pasting the diff into the cover letter.
Add a --range-diff option to automate this process. The argument to
--range-diff specifies the tip of the previous attempt against which to
generate the range-diff. For example:
git format-patch --cover-letter --range-diff=v1 -3 v2
(At this stage, the previous attempt and the patch series being
formatted must share a common base, however, a subsequent enhancement
will make it possible to specify an explicit revision range for the
previous attempt.)
Signed-off-by: Eric Sunshine <sunshine@sunshineco.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Documentation/git-format-patch.txt')
| -rw-r--r-- | Documentation/git-format-patch.txt | 10 |
1 files changed, 10 insertions, 0 deletions
diff --git a/Documentation/git-format-patch.txt b/Documentation/git-format-patch.txt index f8a0617..e7f404b 100644 --- a/Documentation/git-format-patch.txt +++ b/Documentation/git-format-patch.txt @@ -24,6 +24,7 @@ SYNOPSIS [--to=<email>] [--cc=<email>] [--[no-]cover-letter] [--quiet] [--notes[=<ref>]] [--interdiff=<previous>] + [--range-diff=<previous>] [--progress] [<common diff options>] [ <since> | <revision range> ] @@ -238,6 +239,15 @@ feeding the result to `git send-email`. the series being formatted (for example `git format-patch --cover-letter --interdiff=feature/v1 -3 feature/v2`). +--range-diff=<previous>:: + As a reviewer aid, insert a range-diff (see linkgit:git-range-diff[1]) + into the cover letter 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 the series being formatted (for + example `git format-patch --cover-letter --range-diff=feature/v1 -3 + feature/v2`). + --notes[=<ref>]:: Append the notes (see linkgit:git-notes[1]) for the commit after the three-dash line. |