| Message ID | 20220211163627.598166-2-alexhenrie24@gmail.com (mailing list archive) |
|---|---|
| State | Accepted |
| Commit | 087c745833be1edd3b3e4d8ea5d8b1a09fc6c245 |
| Headers | show |
| Series | [v3,1/4] log: fix memory leak if --graph is passed multiple times | expand |
Alex Henrie <alexhenrie24@gmail.com> writes: > It's useful to be able to countermand a previous --graph option, for > example if `git log --graph` is run via an alias. > > Signed-off-by: Alex Henrie <alexhenrie24@gmail.com> > --- > v3: don't pass a regular expression with parentheses to grep, so that > the tests pass in all configurations on GitHub > --- > builtin/blame.c | 1 + > builtin/shortlog.c | 1 + > revision.c | 19 ++++++++++--- > revision.h | 1 + > t/t4202-log.sh | 69 ++++++++++++++++++++++++++++++++++++++++++++++ > 5 files changed, 87 insertions(+), 4 deletions(-) > > diff --git a/builtin/blame.c b/builtin/blame.c > index 7fafeac408..ef831de5ac 100644 > --- a/builtin/blame.c > +++ b/builtin/blame.c > @@ -934,6 +934,7 @@ int cmd_blame(int argc, const char **argv, const char *prefix) > parse_revision_opt(&revs, &ctx, options, blame_opt_usage); > } > parse_done: > + revision_opts_finish(&revs); This ... > diff --git a/builtin/shortlog.c b/builtin/shortlog.c > index e7f7af5de3..228d782754 100644 > --- a/builtin/shortlog.c > +++ b/builtin/shortlog.c > @@ -388,6 +388,7 @@ int cmd_shortlog(int argc, const char **argv, const char *prefix) > parse_revision_opt(&rev, &ctx, options, shortlog_usage); > } > parse_done: > + revision_opts_finish(&rev); > argc = parse_options_end(&ctx); > > if (nongit && argc > 1) { ... and this. It is a bit scary that we have to make sure all the users of parse_revision_opt() users need to call this new helper. Didn't we recently gain new documentation to help novices write their first revision-traversal-API-using program? Does it need to be updated for this change (I didn't check)? > diff --git a/revision.c b/revision.c > index 816061f3d9..a39fd1c278 100644 > --- a/revision.c > +++ b/revision.c > @@ -2424,10 +2424,11 @@ static int handle_revision_opt(struct rev_info *revs, int argc, const char **arg > revs->pretty_given = 1; > revs->abbrev_commit = 1; > } else if (!strcmp(arg, "--graph")) { > - revs->topo_order = 1; > - revs->rewrite_parents = 1; > graph_clear(revs->graph); > revs->graph = graph_init(revs); > + } else if (!strcmp(arg, "--no-graph")) { > + graph_clear(revs->graph); > + revs->graph = NULL; > } else if (!strcmp(arg, "--encode-email-headers")) { > revs->encode_email_headers = 1; > } else if (!strcmp(arg, "--no-encode-email-headers")) { > @@ -2524,8 +2525,6 @@ static int handle_revision_opt(struct rev_info *revs, int argc, const char **arg > unkv[(*unkc)++] = arg; > return opts; > } > - if (revs->graph && revs->track_linear) > - die(_("options '%s' and '%s' cannot be used together"), "--show-linear-break", "--graph"); > > return 1; > } As a later "--no" can clear an earlier "--graph", we cannot incrementally check if options are compatible, until the end, at which time we can be sure that "--graph" is being asked. > +void revision_opts_finish(struct rev_info *revs) > +{ > + if (revs->graph && revs->track_linear) > + die(_("options '%s' and '%s' cannot be used together"), "--show-linear-break", "--graph"); Inherited from the original, but we may want to wrap this line. > + if (revs->graph) { > + revs->topo_order = 1; > + revs->rewrite_parents = 1; > + } > +} > + OK. > @@ -2786,6 +2796,7 @@ int setup_revisions(int argc, const char **argv, struct rev_info *revs, struct s > break; > } > } > + revision_opts_finish(revs); OK. Will queue. Thanks.
On Fri, Feb 11, 2022 at 12:02 PM Junio C Hamano <gitster@pobox.com> wrote: > > Alex Henrie <alexhenrie24@gmail.com> writes: > > > --- a/builtin/blame.c > > +++ b/builtin/blame.c > > @@ -934,6 +934,7 @@ int cmd_blame(int argc, const char **argv, const char *prefix) > > parse_revision_opt(&revs, &ctx, options, blame_opt_usage); > > } > > parse_done: > > + revision_opts_finish(&revs); > > This ... > > > diff --git a/builtin/shortlog.c b/builtin/shortlog.c > > index e7f7af5de3..228d782754 100644 > > --- a/builtin/shortlog.c > > +++ b/builtin/shortlog.c > > @@ -388,6 +388,7 @@ int cmd_shortlog(int argc, const char **argv, const char *prefix) > > parse_revision_opt(&rev, &ctx, options, shortlog_usage); > > } > > parse_done: > > + revision_opts_finish(&rev); > > argc = parse_options_end(&ctx); > > > > if (nongit && argc > 1) { > > ... and this. It is a bit scary that we have to make sure all the > users of parse_revision_opt() users need to call this new helper. > Didn't we recently gain new documentation to help novices write > their first revision-traversal-API-using program? Does it need to > be updated for this change (I didn't check)? I don't see any documentation on how to use parse_revision_opt directly; I only see documentation on how to use setup_revisions, whose interface did not change. Another approach would be to make a parse_rev_options_step function that wraps parse_options_step and does the final steps when parse_options_step returns PARSE_OPT_DONE. Would that be better? > > diff --git a/revision.c b/revision.c > > index 816061f3d9..a39fd1c278 100644 > > --- a/revision.c > > +++ b/revision.c > > @@ -2424,10 +2424,11 @@ static int handle_revision_opt(struct rev_info *revs, int argc, const char **arg > > revs->pretty_given = 1; > > revs->abbrev_commit = 1; > > } else if (!strcmp(arg, "--graph")) { > > - revs->topo_order = 1; > > - revs->rewrite_parents = 1; > > graph_clear(revs->graph); > > revs->graph = graph_init(revs); > > + } else if (!strcmp(arg, "--no-graph")) { > > + graph_clear(revs->graph); > > + revs->graph = NULL; > > } else if (!strcmp(arg, "--encode-email-headers")) { > > revs->encode_email_headers = 1; > > } else if (!strcmp(arg, "--no-encode-email-headers")) { > > @@ -2524,8 +2525,6 @@ static int handle_revision_opt(struct rev_info *revs, int argc, const char **arg > > unkv[(*unkc)++] = arg; > > return opts; > > } > > - if (revs->graph && revs->track_linear) > > - die(_("options '%s' and '%s' cannot be used together"), "--show-linear-break", "--graph"); > > > > return 1; > > } > > As a later "--no" can clear an earlier "--graph", we cannot > incrementally check if options are compatible, until the end, at > which time we can be sure that "--graph" is being asked. Exactly. This is intentional, to avoid erroring out unnecessarily. -Alex
diff --git a/builtin/blame.c b/builtin/blame.c index 7fafeac408..ef831de5ac 100644 --- a/builtin/blame.c +++ b/builtin/blame.c @@ -934,6 +934,7 @@ int cmd_blame(int argc, const char **argv, const char *prefix) parse_revision_opt(&revs, &ctx, options, blame_opt_usage); } parse_done: + revision_opts_finish(&revs); no_whole_file_rename = !revs.diffopt.flags.follow_renames; xdl_opts |= revs.diffopt.xdl_opts & XDF_INDENT_HEURISTIC; revs.diffopt.flags.follow_renames = 0; diff --git a/builtin/shortlog.c b/builtin/shortlog.c index e7f7af5de3..228d782754 100644 --- a/builtin/shortlog.c +++ b/builtin/shortlog.c @@ -388,6 +388,7 @@ int cmd_shortlog(int argc, const char **argv, const char *prefix) parse_revision_opt(&rev, &ctx, options, shortlog_usage); } parse_done: + revision_opts_finish(&rev); argc = parse_options_end(&ctx); if (nongit && argc > 1) { diff --git a/revision.c b/revision.c index 816061f3d9..a39fd1c278 100644 --- a/revision.c +++ b/revision.c @@ -2424,10 +2424,11 @@ static int handle_revision_opt(struct rev_info *revs, int argc, const char **arg revs->pretty_given = 1; revs->abbrev_commit = 1; } else if (!strcmp(arg, "--graph")) { - revs->topo_order = 1; - revs->rewrite_parents = 1; graph_clear(revs->graph); revs->graph = graph_init(revs); + } else if (!strcmp(arg, "--no-graph")) { + graph_clear(revs->graph); + revs->graph = NULL; } else if (!strcmp(arg, "--encode-email-headers")) { revs->encode_email_headers = 1; } else if (!strcmp(arg, "--no-encode-email-headers")) { @@ -2524,8 +2525,6 @@ static int handle_revision_opt(struct rev_info *revs, int argc, const char **arg unkv[(*unkc)++] = arg; return opts; } - if (revs->graph && revs->track_linear) - die(_("options '%s' and '%s' cannot be used together"), "--show-linear-break", "--graph"); return 1; } @@ -2544,6 +2543,17 @@ void parse_revision_opt(struct rev_info *revs, struct parse_opt_ctx_t *ctx, ctx->argc -= n; } +void revision_opts_finish(struct rev_info *revs) +{ + if (revs->graph && revs->track_linear) + die(_("options '%s' and '%s' cannot be used together"), "--show-linear-break", "--graph"); + + if (revs->graph) { + revs->topo_order = 1; + revs->rewrite_parents = 1; + } +} + static int for_each_bisect_ref(struct ref_store *refs, each_ref_fn fn, void *cb_data, const char *term) { @@ -2786,6 +2796,7 @@ int setup_revisions(int argc, const char **argv, struct rev_info *revs, struct s break; } } + revision_opts_finish(revs); if (prune_data.nr) { /* diff --git a/revision.h b/revision.h index 3f66147bfd..5a507db202 100644 --- a/revision.h +++ b/revision.h @@ -372,6 +372,7 @@ void parse_revision_opt(struct rev_info *revs, struct parse_opt_ctx_t *ctx, #define REVARG_COMMITTISH 02 int handle_revision_arg(const char *arg, struct rev_info *revs, int flags, unsigned revarg_opt); +void revision_opts_finish(struct rev_info *revs); /** * Reset the flags used by the revision walking api. You can use this to do diff --git a/t/t4202-log.sh b/t/t4202-log.sh index dc884107de..a7d5edf720 100755 --- a/t/t4202-log.sh +++ b/t/t4202-log.sh @@ -1671,6 +1671,75 @@ test_expect_success 'log --graph with --name-only' ' test_cmp_graph --name-only tangle..reach ' +test_expect_success '--no-graph countermands --graph' ' + git log >expect && + git log --graph --no-graph >actual && + test_cmp expect actual +' + +test_expect_success '--graph countermands --no-graph' ' + git log --graph >expect && + git log --no-graph --graph >actual && + test_cmp expect actual +' + +test_expect_success '--no-graph does not unset --topo-order' ' + git log --topo-order >expect && + git log --topo-order --no-graph >actual && + test_cmp expect actual +' + +test_expect_success '--no-graph does not unset --parents' ' + git log --parents >expect && + git log --parents --no-graph >actual && + test_cmp expect actual +' + +test_expect_success '--reverse and --graph conflict' ' + test_must_fail git log --reverse --graph 2>stderr && + test_i18ngrep "cannot be used together" stderr +' + +test_expect_success '--reverse --graph --no-graph works' ' + git log --reverse >expect && + git log --reverse --graph --no-graph >actual && + test_cmp expect actual +' + +test_expect_success '--show-linear-break and --graph conflict' ' + test_must_fail git log --show-linear-break --graph 2>stderr && + test_i18ngrep "cannot be used together" stderr +' + +test_expect_success '--show-linear-break --graph --no-graph works' ' + git log --show-linear-break >expect && + git log --show-linear-break --graph --no-graph >actual && + test_cmp expect actual +' + +test_expect_success '--no-walk and --graph conflict' ' + test_must_fail git log --no-walk --graph 2>stderr && + test_i18ngrep "cannot be used together" stderr +' + +test_expect_success '--no-walk --graph --no-graph works' ' + git log --no-walk >expect && + git log --no-walk --graph --no-graph >actual && + test_cmp expect actual +' + +test_expect_success '--walk-reflogs and --graph conflict' ' + test_must_fail git log --walk-reflogs --graph 2>stderr && + (test_i18ngrep "cannot combine" stderr || + test_i18ngrep "cannot be used together" stderr) +' + +test_expect_success '--walk-reflogs --graph --no-graph works' ' + git log --walk-reflogs >expect && + git log --walk-reflogs --graph --no-graph >actual && + test_cmp expect actual +' + test_expect_success 'dotdot is a parent directory' ' mkdir -p a/b && ( echo sixth && echo fifth ) >expect &&
It's useful to be able to countermand a previous --graph option, for example if `git log --graph` is run via an alias. Signed-off-by: Alex Henrie <alexhenrie24@gmail.com> --- v3: don't pass a regular expression with parentheses to grep, so that the tests pass in all configurations on GitHub --- builtin/blame.c | 1 + builtin/shortlog.c | 1 + revision.c | 19 ++++++++++--- revision.h | 1 + t/t4202-log.sh | 69 ++++++++++++++++++++++++++++++++++++++++++++++ 5 files changed, 87 insertions(+), 4 deletions(-)