range-diff: optionally accept pathspecs

The `git range-diff` command can be quite expensive, which is not a
surprise given that the underlying algorithm to match up pairs of
commits between the provided two commit ranges has a cubic runtime.

Therefore it makes sense to restrict the commit ranges as much as
possible, to reduce the amount of input to that O(N^3) algorithm.

In chatty repositories with wide trees, this is not necessarily
possible merely by choosing commit ranges wisely.

Let's give users another option to restrict the commit ranges: by
providing a pathspec. That helps in repositories with wide trees because
it is likely that the user has a good idea which subset of the tree they
are actually interested in.

Example:

	git range-diff upstream/main upstream/seen HEAD -- range-diff.c

This shows commits that are either in the local branch or in `seen`, but
not in `main`, skipping all commits that do not touch `range-diff.c`.

Note: Since we piggy-back the pathspecs onto the `other_arg` mechanism
that was introduced to be able to pass through the `--notes` option to
the revision machinery, we must now ensure that the `other_arg` array is
appended at the end (the revision range must come before the pathspecs,
if any).

Signed-off-by: Johannes Schindelin <johannes.schindelin@gmx.de>
Signed-off-by: Junio C Hamano <gitster@pobox.com>

diff --git a/Documentation/git-range-diff.txt b/Documentation/git-range-diff.txt
index fe350d7f4056e280c9740ae9c601f0c7eb2a1119..0b393715d707015a245eb1afe26dfbe044e8fcd6 100644 (file)
--- a/Documentation/git-range-diff.txt
+++ b/Documentation/git-range-diff.txt
@@ -12,6 +12,7 @@ SYNOPSIS
        [--no-dual-color] [--creation-factor=<factor>]
        [--left-only | --right-only]
        ( <range1> <range2> | <rev1>...<rev2> | <base> <rev1> <rev2> )
+       [[--] <path>...]
 
 DESCRIPTION
 -----------
@@ -19,6 +20,9 @@ DESCRIPTION
 This command shows the differences between two versions of a patch
 series, or more generally, two commit ranges (ignoring merge commits).
 
+In the presence of `<path>` arguments, these commit ranges are limited
+accordingly.
+
 To that end, it first finds pairs of commits from both commit ranges
 that correspond with each other. Two commits are said to correspond when
 the diff between their patches (i.e. the author information, the commit

diff --git a/builtin/range-diff.c b/builtin/range-diff.c
index 71319ed1d840cfc37ac3766339bedee649136619..e2a74efb42a795a5139932bd052999d050cab420 100644 (file)
--- a/builtin/range-diff.c
+++ b/builtin/range-diff.c
@@ -38,9 +38,10 @@ int cmd_range_diff(int argc, const char **argv, const char *prefix)
                OPT_END()
        };
        struct option *options;
-       int res = 0;
+       int i, dash_dash = -1, res = 0;
        struct strbuf range1 = STRBUF_INIT, range2 = STRBUF_INIT;
        struct object_id oid;
+       const char *three_dots = NULL;
 
        git_config(git_diff_ui_config, NULL);
 
@@ -48,7 +49,7 @@ int cmd_range_diff(int argc, const char **argv, const char *prefix)
 
        options = parse_options_concat(range_diff_options, diffopt.parseopts);
        argc = parse_options(argc, argv, prefix, options,
-                            builtin_range_diff_usage, 0);
+                            builtin_range_diff_usage, PARSE_OPT_KEEP_DASHDASH);
 
        diff_setup_done(&diffopt);
 
@@ -56,8 +57,20 @@ int cmd_range_diff(int argc, const char **argv, const char *prefix)
        if (!simple_color)
                diffopt.use_color = 1;
 
-       if (argc == 3) {
-               if (get_oid_committish(argv[0], &oid))
+       for (i = 0; i < argc; i++)
+               if (!strcmp(argv[i], "--")) {
+                       dash_dash = i;
+                       break;
+               }
+
+       if (dash_dash == 3 ||
+           (dash_dash < 0 && argc > 2 &&
+            !get_oid_committish(argv[0], &oid) &&
+            !get_oid_committish(argv[1], &oid) &&
+            !get_oid_committish(argv[2], &oid))) {
+               if (dash_dash < 0)
+                       ; /* already validated arguments */
+               else if (get_oid_committish(argv[0], &oid))
                        usage_msg_optf(_("not a revision: '%s'"),
                                       builtin_range_diff_usage, options,
                                       argv[0]);
@@ -72,8 +85,16 @@ int cmd_range_diff(int argc, const char **argv, const char *prefix)
 
                strbuf_addf(&range1, "%s..%s", argv[0], argv[1]);
                strbuf_addf(&range2, "%s..%s", argv[0], argv[2]);
-       } else if (argc == 2) {
-               if (!is_range_diff_range(argv[0]))
+
+               strvec_pushv(&other_arg, argv +
+                            (dash_dash < 0 ? 3 : dash_dash));
+       } else if (dash_dash == 2 ||
+                  (dash_dash < 0 && argc > 1 &&
+                   is_range_diff_range(argv[0]) &&
+                   is_range_diff_range(argv[1]))) {
+               if (dash_dash < 0)
+                       ; /* already validated arguments */
+               else if (!is_range_diff_range(argv[0]))
                        usage_msg_optf(_("not a commit range: '%s'"),
                                       builtin_range_diff_usage, options,
                                       argv[0]);
@@ -84,25 +105,40 @@ int cmd_range_diff(int argc, const char **argv, const char *prefix)
 
                strbuf_addstr(&range1, argv[0]);
                strbuf_addstr(&range2, argv[1]);
-       } else if (argc == 1) {
-               const char *b = strstr(argv[0], "..."), *a = argv[0];
+
+               strvec_pushv(&other_arg, argv +
+                            (dash_dash < 0 ? 2 : dash_dash));
+       } else if (dash_dash == 1 ||
+                  (dash_dash < 0 && argc > 0 &&
+                   (three_dots = strstr(argv[0], "...")))) {
+               const char *a, *b;
                int a_len;
 
-               if (!b)
+               if (dash_dash < 0)
+                       ; /* already validated arguments */
+               else if (!(three_dots = strstr(argv[0], "...")))
                        usage_msg_optf(_("not a symmetric range: '%s'"),
-                                      builtin_range_diff_usage, options,
-                                      argv[0]);
+                                        builtin_range_diff_usage, options,
+                                        argv[0]);
 
-               a_len = (int)(b - a);
-               if (!a_len) {
+               if (three_dots == argv[0]) {
                        a = "HEAD";
                        a_len = strlen(a);
+               } else {
+                       a = argv[0];
+                       a_len = (int)(three_dots - a);
                }
-               b += 3;
-               if (!*b)
+
+               if (three_dots[3])
+                       b = three_dots + 3;
+               else
                        b = "HEAD";
+
                strbuf_addf(&range1, "%s..%.*s", b, a_len, a);
                strbuf_addf(&range2, "%.*s..%s", a_len, a, b);
+
+               strvec_pushv(&other_arg, argv +
+                            (dash_dash < 0 ? 1 : dash_dash));
        } else
                usage_msg_opt(_("need two commit ranges"),
                              builtin_range_diff_usage, options);

diff --git a/range-diff.c b/range-diff.c
index f63b3ffc200a8b71df3d7287322321ac70be2595..124dd678c3873528e3db091e756c2c0b828c1725 100644 (file)
--- a/range-diff.c
+++ b/range-diff.c
@@ -57,9 +57,9 @@ static int read_patches(const char *range, struct string_list *list,
                     "--pretty=medium",
                     "--notes",
                     NULL);
+       strvec_push(&cp.args, range);
        if (other_arg)
                strvec_pushv(&cp.args, other_arg->v);
-       strvec_push(&cp.args, range);
        cp.out = -1;
        cp.no_stdin = 1;
        cp.git_cmd = 1;

diff --git a/t/t3206-range-diff.sh b/t/t3206-range-diff.sh
index d12e4e4cc6c64073fcef4e71ba6a9c52ce8af1dc..459beaf7d9cec09cfbc617d6461eacd1d5917dff 100755 (executable)
--- a/t/t3206-range-diff.sh
+++ b/t/t3206-range-diff.sh
@@ -162,7 +162,7 @@ test_expect_success 'A^! and A^-<n> (unmodified)' '
 '
 
 test_expect_success 'A^{/..} is not mistaken for a range' '
-       test_must_fail git range-diff topic^.. topic^{/..} 2>error &&
+       test_must_fail git range-diff topic^.. topic^{/..} -- 2>error &&
        test_i18ngrep "not a commit range" error
 '
 
@@ -772,6 +772,17 @@ test_expect_success '--left-only/--right-only' '
        test_cmp expect actual
 '
 
+test_expect_success 'ranges with pathspecs' '
+       git range-diff topic...mode-only-change -- other-file >actual &&
+       test_line_count = 2 actual &&
+       topic_oid=$(git rev-parse --short topic) &&
+       mode_change_oid=$(git rev-parse --short mode-only-change^) &&
+       file_change_oid=$(git rev-parse --short mode-only-change) &&
+       grep "$mode_change_oid" actual &&
+       ! grep "$file_change_oid" actual &&
+       ! grep "$topic_oid" actual
+'
+
 test_expect_success 'submodule changes are shown irrespective of diff.submodule' '
        git init sub-repo &&
        test_commit -C sub-repo sub-first &&