range-diff: rename other_arg to log_arg

Rename `other_arg` to `log_arg` in `range_diff_options` and
related places.

“Other argument” comes from bd361918 (range-diff: pass through --notes
to `git log`, 2019-11-20) which introduced Git notes handling to
git-range-diff(1) by passing that option on to git-log(1). And that kind
of name might be fine in a local context. However, it was initially
spread among multiple files, and is now[1] part of the
`range_diff_options` struct. It is, prima facie, difficult to guess what
“other” means, especially when just looking at the struct.

But with a little reading we find out that it is used for `--[no-]notes`
and `--diff-merges`, which are both passed on to git-log(1). We should
just rename it to reflect this role; `log_arg` suggests, along with the
`strvec` type, that it is used to pass extra arguments to git-log(1).

† 1: since f1ce6c19 (range-diff: combine all options in a single data
     structure, 2021-02-05)

Suggested-by: Junio C Hamano <gitster@pobox.com>
Signed-off-by: Kristoffer Haugsbakk <code@khaugsbakk.name>
Signed-off-by: Junio C Hamano <gitster@pobox.com>

diff --git a/builtin/log.c b/builtin/log.c
index 5f552d14c0fe83c82f684a0a0e505a5879d65803..131512ac1af0f17d64ee54cdff0d2c8dac859aa2 100644 (file)
--- a/builtin/log.c
+++ b/builtin/log.c
@@ -1400,13 +1400,13 @@ static void make_cover_letter(struct rev_info *rev, int use_separate_file,
                 * can be added later if deemed desirable.
                 */
                struct diff_options opts;
-               struct strvec other_arg = STRVEC_INIT;
+               struct strvec log_arg = STRVEC_INIT;
                struct range_diff_options range_diff_opts = {
                        .creation_factor = rev->creation_factor,
                        .dual_color = 1,
                        .max_memory = RANGE_DIFF_MAX_MEMORY_DEFAULT,
                        .diffopt = &opts,
-                       .other_arg = &other_arg
+                       .log_arg = &log_arg
                };
 
                repo_diff_setup(the_repository, &opts);
@@ -1414,9 +1414,9 @@ static void make_cover_letter(struct rev_info *rev, int use_separate_file,
                opts.use_color = rev->diffopt.use_color;
                diff_setup_done(&opts);
                fprintf_ln(rev->diffopt.file, "%s", rev->rdiff_title);
-               get_notes_args(&other_arg, rev);
+               get_notes_args(&log_arg, rev);
                show_range_diff(rev->rdiff1, rev->rdiff2, &range_diff_opts);
-               strvec_clear(&other_arg);
+               strvec_clear(&log_arg);
        }
 }
 

diff --git a/builtin/range-diff.c b/builtin/range-diff.c
index aafcc99b96240f6a25cb18b5ebe378f26132e414..f88b40e3607a0f292fcd33c6ea37cfb406157d7a 100644 (file)
--- a/builtin/range-diff.c
+++ b/builtin/range-diff.c
@@ -37,13 +37,13 @@ int cmd_range_diff(int argc,
                   struct repository *repo UNUSED)
 {
        struct diff_options diffopt = { NULL };
-       struct strvec other_arg = STRVEC_INIT;
+       struct strvec log_arg = STRVEC_INIT;
        struct strvec diff_merges_arg = STRVEC_INIT;
        struct range_diff_options range_diff_opts = {
                .creation_factor = RANGE_DIFF_CREATION_FACTOR_DEFAULT,
                .max_memory = RANGE_DIFF_MAX_MEMORY_DEFAULT,
                .diffopt = &diffopt,
-               .other_arg = &other_arg
+               .log_arg = &log_arg
        };
        int simple_color = -1, left_only = 0, right_only = 0;
        struct option range_diff_options[] = {
@@ -52,7 +52,7 @@ int cmd_range_diff(int argc,
                            N_("percentage by which creation is weighted")),
                OPT_BOOL(0, "no-dual-color", &simple_color,
                            N_("use simple diff colors")),
-               OPT_PASSTHRU_ARGV(0, "notes", &other_arg,
+               OPT_PASSTHRU_ARGV(0, "notes", &log_arg,
                                  N_("notes"), N_("passed to 'git log'"),
                                  PARSE_OPT_OPTARG),
                OPT_PASSTHRU_ARGV(0, "diff-merges", &diff_merges_arg,
@@ -92,7 +92,7 @@ int cmd_range_diff(int argc,
        /* If `--diff-merges` was specified, imply `--merges` */
        if (diff_merges_arg.nr) {
                range_diff_opts.include_merges = 1;
-               strvec_pushv(&other_arg, diff_merges_arg.v);
+               strvec_pushv(&log_arg, diff_merges_arg.v);
        }
 
        for (i = 0; i < argc; i++)
@@ -124,7 +124,7 @@ int cmd_range_diff(int argc,
                strbuf_addf(&range1, "%s..%s", argv[0], argv[1]);
                strbuf_addf(&range2, "%s..%s", argv[0], argv[2]);
 
-               strvec_pushv(&other_arg, argv +
+               strvec_pushv(&log_arg, argv +
                             (dash_dash < 0 ? 3 : dash_dash));
        } else if (dash_dash == 2 ||
                   (dash_dash < 0 && argc > 1 &&
@@ -144,7 +144,7 @@ int cmd_range_diff(int argc,
                strbuf_addstr(&range1, argv[0]);
                strbuf_addstr(&range2, argv[1]);
 
-               strvec_pushv(&other_arg, argv +
+               strvec_pushv(&log_arg, argv +
                             (dash_dash < 0 ? 2 : dash_dash));
        } else if (dash_dash == 1 ||
                   (dash_dash < 0 && argc > 0 &&
@@ -175,7 +175,7 @@ int cmd_range_diff(int argc,
                strbuf_addf(&range1, "%s..%.*s", b, a_len, a);
                strbuf_addf(&range2, "%.*s..%s", a_len, a, b);
 
-               strvec_pushv(&other_arg, argv +
+               strvec_pushv(&log_arg, argv +
                             (dash_dash < 0 ? 1 : dash_dash));
        } else
                usage_msg_opt(_("need two commit ranges"),
@@ -187,7 +187,7 @@ int cmd_range_diff(int argc,
        range_diff_opts.right_only = right_only;
        res = show_range_diff(range1.buf, range2.buf, &range_diff_opts);
 
-       strvec_clear(&other_arg);
+       strvec_clear(&log_arg);
        strvec_clear(&diff_merges_arg);
        strbuf_release(&range1);
        strbuf_release(&range2);

diff --git a/range-diff.c b/range-diff.c
index ca449a07693e85412b4881cdbfe6376a2a5bd440..57edff40a85f24506214c57d8f2fcef521f2506f 100644 (file)
--- a/range-diff.c
+++ b/range-diff.c
@@ -39,7 +39,7 @@ struct patch_util {
  * as struct object_id (will need to be free()d).
  */
 static int read_patches(const char *range, struct string_list *list,
-                       const struct strvec *other_arg,
+                       const struct strvec *log_arg,
                        unsigned int include_merges)
 {
        struct child_process cp = CHILD_PROCESS_INIT;
@@ -69,8 +69,8 @@ static int read_patches(const char *range, struct string_list *list,
        if (!include_merges)
                strvec_push(&cp.args, "--no-merges");
        strvec_push(&cp.args, range);
-       if (other_arg)
-               strvec_pushv(&cp.args, other_arg->v);
+       if (log_arg)
+               strvec_pushv(&cp.args, log_arg->v);
        cp.out = -1;
        cp.no_stdin = 1;
        cp.git_cmd = 1;
@@ -594,9 +594,9 @@ int show_range_diff(const char *range1, const char *range2,
        if (range_diff_opts->left_only && range_diff_opts->right_only)
                res = error(_("options '%s' and '%s' cannot be used together"), "--left-only", "--right-only");
 
-       if (!res && read_patches(range1, &branch1, range_diff_opts->other_arg, include_merges))
+       if (!res && read_patches(range1, &branch1, range_diff_opts->log_arg, include_merges))
                res = error(_("could not parse log for '%s'"), range1);
-       if (!res && read_patches(range2, &branch2, range_diff_opts->other_arg, include_merges))
+       if (!res && read_patches(range2, &branch2, range_diff_opts->log_arg, include_merges))
                res = error(_("could not parse log for '%s'"), range2);
 
        if (!res) {

diff --git a/range-diff.h b/range-diff.h
index 9d39818e349c91aca8c05dde15fd9309b4de4424..9b70a80009e257ec3b8c6f7ce37b974de55e63b1 100644 (file)
--- a/range-diff.h
+++ b/range-diff.h
@@ -23,7 +23,7 @@ struct range_diff_options {
        unsigned include_merges:1;
        size_t max_memory;
        const struct diff_options *diffopt; /* may be NULL */
-       const struct strvec *other_arg; /* may be NULL */
+       const struct strvec *log_arg; /* may be NULL */
 };
 
 /*