From edd6a31f46096824f792f0fad5532c8d444c4c05 Mon Sep 17 00:00:00 2001 From: Johannes Schindelin Date: Fri, 26 Aug 2022 09:39:28 +0000 Subject: [PATCH 1/3] range-diff: reorder argument handling In d9c66f0b5bf (range-diff: first rudimentary implementation, 2018-08-13), we introduced the argument handling of the `range-diff` command, special-casing three different stanzas based on the argument count. The somewhat unorthodox order (first handling the case of 2 arguments, then 3, then 1) was chosen for clarity: the natural argument number is 2 because that is how many revision ranges are used internally. The code to handle three arguments is relatively trivial, so it was added next. And finally, the code to ungarble a single symmetric range into two separate ones was added, because it was the most complicated (the most inelegant part being about interpreting empty sides of the symmetric range as `HEAD`). In preparation for allowing pathspecs in `git range-diff` invocations, where we no longer have the luxury of using the number of arguments to disambiguate between these three different ways to specify the commit ranges, we need to order these cases by argument count, in descending order. This patch is best viewed with `--color-moved`. Signed-off-by: Johannes Schindelin Signed-off-by: Junio C Hamano --- builtin/range-diff.c | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/builtin/range-diff.c b/builtin/range-diff.c index 50318849d6..f8d3869d35 100644 --- a/builtin/range-diff.c +++ b/builtin/range-diff.c @@ -55,7 +55,10 @@ int cmd_range_diff(int argc, const char **argv, const char *prefix) if (!simple_color) diffopt.use_color = 1; - if (argc == 2) { + if (argc == 3) { + 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])) die(_("not a commit range: '%s'"), argv[0]); strbuf_addstr(&range1, argv[0]); @@ -63,9 +66,6 @@ int cmd_range_diff(int argc, const char **argv, const char *prefix) if (!is_range_diff_range(argv[1])) die(_("not a commit range: '%s'"), argv[1]); strbuf_addstr(&range2, argv[1]); - } else if (argc == 3) { - strbuf_addf(&range1, "%s..%s", argv[0], argv[1]); - strbuf_addf(&range2, "%s..%s", argv[0], argv[2]); } else if (argc == 1) { const char *b = strstr(argv[0], "..."), *a = argv[0]; int a_len; From 0087d7dfbebf10f23394f32db3c283eb7ab03129 Mon Sep 17 00:00:00 2001 From: Johannes Schindelin Date: Fri, 26 Aug 2022 09:39:29 +0000 Subject: [PATCH 2/3] range-diff: consistently validate the arguments This patch lets `range-diff` validate the arguments not only when invoked with one or two arguments, but also in the code path where three arguments are handled. While at it, we now use `usage_msg_opt*()` consistently. Signed-off-by: Johannes Schindelin Signed-off-by: Junio C Hamano --- builtin/range-diff.c | 41 +++++++++++++++++++++++++++++------------ 1 file changed, 29 insertions(+), 12 deletions(-) diff --git a/builtin/range-diff.c b/builtin/range-diff.c index f8d3869d35..71319ed1d8 100644 --- a/builtin/range-diff.c +++ b/builtin/range-diff.c @@ -40,6 +40,7 @@ int cmd_range_diff(int argc, const char **argv, const char *prefix) struct option *options; int res = 0; struct strbuf range1 = STRBUF_INIT, range2 = STRBUF_INIT; + struct object_id oid; git_config(git_diff_ui_config, NULL); @@ -56,24 +57,41 @@ int cmd_range_diff(int argc, const char **argv, const char *prefix) diffopt.use_color = 1; if (argc == 3) { + if (get_oid_committish(argv[0], &oid)) + usage_msg_optf(_("not a revision: '%s'"), + builtin_range_diff_usage, options, + argv[0]); + else if (get_oid_committish(argv[1], &oid)) + usage_msg_optf(_("not a revision: '%s'"), + builtin_range_diff_usage, options, + argv[1]); + else if (get_oid_committish(argv[2], &oid)) + usage_msg_optf(_("not a revision: '%s'"), + builtin_range_diff_usage, options, + argv[2]); + 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])) - die(_("not a commit range: '%s'"), argv[0]); - strbuf_addstr(&range1, argv[0]); + usage_msg_optf(_("not a commit range: '%s'"), + builtin_range_diff_usage, options, + argv[0]); + else if (!is_range_diff_range(argv[1])) + usage_msg_optf(_("not a commit range: '%s'"), + builtin_range_diff_usage, options, + argv[1]); - if (!is_range_diff_range(argv[1])) - die(_("not a commit range: '%s'"), argv[1]); + strbuf_addstr(&range1, argv[0]); strbuf_addstr(&range2, argv[1]); } else if (argc == 1) { const char *b = strstr(argv[0], "..."), *a = argv[0]; int a_len; - if (!b) { - error(_("single arg format must be symmetric range")); - usage_with_options(builtin_range_diff_usage, options); - } + if (!b) + usage_msg_optf(_("not a symmetric range: '%s'"), + builtin_range_diff_usage, options, + argv[0]); a_len = (int)(b - a); if (!a_len) { @@ -85,10 +103,9 @@ int cmd_range_diff(int argc, const char **argv, const char *prefix) b = "HEAD"; strbuf_addf(&range1, "%s..%.*s", b, a_len, a); strbuf_addf(&range2, "%.*s..%s", a_len, a, b); - } else { - error(_("need two commit ranges")); - usage_with_options(builtin_range_diff_usage, options); - } + } else + usage_msg_opt(_("need two commit ranges"), + builtin_range_diff_usage, options); FREE_AND_NULL(options); range_diff_opts.dual_color = simple_color < 1; From b75747829f4c277323c78b1c5973ad63ea038a2d Mon Sep 17 00:00:00 2001 From: Johannes Schindelin Date: Fri, 26 Aug 2022 09:39:30 +0000 Subject: [PATCH 3/3] 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 Signed-off-by: Junio C Hamano --- Documentation/git-range-diff.txt | 4 ++ builtin/range-diff.c | 66 ++++++++++++++++++++++++-------- range-diff.c | 2 +- t/t3206-range-diff.sh | 13 ++++++- 4 files changed, 68 insertions(+), 17 deletions(-) diff --git a/Documentation/git-range-diff.txt b/Documentation/git-range-diff.txt index fe350d7f40..0b393715d7 100644 --- a/Documentation/git-range-diff.txt +++ b/Documentation/git-range-diff.txt @@ -12,6 +12,7 @@ SYNOPSIS [--no-dual-color] [--creation-factor=] [--left-only | --right-only] ( | ... | ) + [[--] ...] 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 `` 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 71319ed1d8..e2a74efb42 100644 --- 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 f63b3ffc20..124dd678c3 100644 --- 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 d12e4e4cc6..459beaf7d9 100755 --- a/t/t3206-range-diff.sh +++ b/t/t3206-range-diff.sh @@ -162,7 +162,7 @@ test_expect_success 'A^! and A^- (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 &&