@matheusbsbs / matheus-bagliano / commits / 76a7bc092e

cmd_{read,write}_tree: rename "unused" variable that is used

The "prefix" variable passed by git.c into the builtin cmd_read_tree() and cmd_write_tree() functions is named "unused_prefix". But we do in fact pass it to parse_options(), which may use the prefix to adjust any filename options. Let's get rid of this confusing name. However, we can't just call it "prefix". The reason these variables were renamed in the first place is that they shadowed local variables named "prefix", because these commands both take a "--prefix" option. So let's rename the parameters, but try to reduce further confusion: 1. In both cases we'll call them "cmd_prefix" to mark that they're part of the cmd_* interface. 2. In cmd_write_tree(), we'll rename the local prefix variable to "tree_prefix" to make it more clear that we're talking about the prefix to be used for the tree we're writing. 3. In cmd_read_tree(), the "prefix" local has since migrated into "struct unpack_trees_options". We'll leave that alone, as the context within the struct makes its meaning clear (we actually _could_ just call the parameter "prefix" now, but that invites confusion in the other direction). Signed-off-by: Jeff King <peff@peff.net> Signed-off-by: Junio C Hamano <gitster@pobox.com>

Jeff King committed May 9, 2019 at 17:27 UTC 76a7bc092efc2be59f1e42dc437154a9a1feed0a

2 files changed +8 -8

builtin/read-tree.c

+2 -2

@@ -111,7 +111,7 @@ static int git_read_tree_config(const char *var, const char *value, void *cb)

111 return git_default_config(var, value, cb);

112 }

113

114 -int cmd_read_tree(int argc, const char **argv, const char *unused_prefix)

114 +int cmd_read_tree(int argc, const char **argv, const char *cmd_prefix)

115 {

116 int i, stage = 0;

117 struct object_id oid;

@@ -165,7 +165,7 @@ int cmd_read_tree(int argc, const char **argv, const char *unused_prefix)

165

166 git_config(git_read_tree_config, NULL);

167

168 - argc = parse_options(argc, argv, unused_prefix, read_tree_options,

168 + argc = parse_options(argc, argv, cmd_prefix, read_tree_options,

169 read_tree_usage, 0);

170

171 hold_locked_index(&lock_file, LOCK_DIE_ON_ERROR);

builtin/write-tree.c

+6 -6

@@ -16,16 +16,16 @@ static const char * const write_tree_usage[] = {

16 NULL

17 };

19 -int cmd_write_tree(int argc, const char **argv, const char *unused_prefix)

19 +int cmd_write_tree(int argc, const char **argv, const char *cmd_prefix)

20 {

21 int flags = 0, ret;

22 - const char *prefix = NULL;

22 + const char *tree_prefix = NULL;

23 struct object_id oid;

24 const char *me = "git-write-tree";

25 struct option write_tree_options[] = {

26 OPT_BIT(0, "missing-ok", &flags, N_("allow missing objects"),

27 WRITE_TREE_MISSING_OK),

28 - OPT_STRING(0, "prefix", &prefix, N_("<prefix>/"),

28 + OPT_STRING(0, "prefix", &tree_prefix, N_("<prefix>/"),

29 N_("write tree object for a subdirectory <prefix>")),

30 { OPTION_BIT, 0, "ignore-cache-tree", &flags, NULL,

31 N_("only useful for debugging"),

@@ -35,10 +35,10 @@ int cmd_write_tree(int argc, const char **argv, const char *unused_prefix)

35 };

37 git_config(git_default_config, NULL);

38 - argc = parse_options(argc, argv, unused_prefix, write_tree_options,

38 + argc = parse_options(argc, argv, cmd_prefix, write_tree_options,

39 write_tree_usage, 0);

41 - ret = write_cache_as_tree(&oid, flags, prefix);

41 + ret = write_cache_as_tree(&oid, flags, tree_prefix);

42 switch (ret) {

43 case 0:

44 printf("%s\n", oid_to_hex(&oid));

@@ -50,7 +50,7 @@ int cmd_write_tree(int argc, const char **argv, const char *unused_prefix)

50 die("%s: error building trees", me);

51 break;

52 case WRITE_TREE_PREFIX_ERROR:

53 - die("%s: prefix %s not found", me, prefix);

53 + die("%s: prefix %s not found", me, tree_prefix);

54 break;

55 }

56 return ret;