mv: rename check_dir_in_index() to empty_dir_has_sparse_contents()

Method check_dir_in_index() introduced in b91a2b6594 (mv: add check_dir_in_index() and solve general dir check issue, 2022-06-30) does not describe its intent and behavior well. Change its name to empty_dir_has_sparse_contents(), which more precisely describes its purpose. Reverse the return values, check_dir_in_index() return 0 for success and 1 for failure; reverse the values so empty_dir_has_sparse_contents() return 1 for success and 0 for failure. These values are more intuitive because 1 usually means "has" and 0 means "not found". Also modify the documentation to better align with the method's intent and behavior. Helped-by: Derrick Stolee <derrickstolee@github.com> Helped-by: Victoria Dye <vdye@github.com> Signed-off-by: Shaoxuan Yuan <shaoxuan.yuan02@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>

Shaoxuan Yuan committed Aug 9, 2022 at 20:09 UTC 72e59ba19e776abbff7dccbf093c73e43527a339
1 file changed +11 -13
builtin/mv.c
+11 -13
@@ -125,15 +125,13 @@ static int index_range_of_same_dir(const char *src, int length,
125 }
126
127 /*
128 - * Check if an out-of-cone directory should be in the index. Imagine this case
129 - * that all the files under a directory are marked with 'CE_SKIP_WORKTREE' bit
130 - * and thus the directory is sparsified.
131 - *
132 - * Return 0 if such directory exist (i.e. with any of its contained files not
133 - * marked with CE_SKIP_WORKTREE, the directory would be present in working tree).
134 - * Return 1 otherwise.
128 + * Given the path of a directory that does not exist on-disk, check whether the
129 + * directory contains any entries in the index with the SKIP_WORKTREE flag
130 + * enabled.
131 + * Return 1 if such index entries exist.
132 + * Return 0 otherwise.
133 */
136 -static int check_dir_in_index(const char *name)
134 +static int empty_dir_has_sparse_contents(const char *name)
135 {
136 const char *with_slash = add_slash(name);
137 int length = strlen(with_slash);
@@ -144,14 +142,14 @@ static int check_dir_in_index(const char *name)
142 if (pos < 0) {
143 pos = -pos - 1;
144 if (pos >= the_index.cache_nr)
147 - return 1;
145 + return 0;
146 ce = active_cache[pos];
147 if (strncmp(with_slash, ce->name, length))
150 - return 1;
151 - if (ce_skip_worktree(ce))
148 return 0;
149 + if (ce_skip_worktree(ce))
150 + return 1;
151 }
154 - return 1;
152 + return 0;
153 }
154
155 int cmd_mv(int argc, const char **argv, const char *prefix)
@@ -231,7 +229,7 @@ int cmd_mv(int argc, const char **argv, const char *prefix)
229 if (pos < 0) {
230 const char *src_w_slash = add_slash(src);
231 if (!path_in_sparse_checkout(src_w_slash, &the_index) &&
234 - !check_dir_in_index(src)) {
232 + empty_dir_has_sparse_contents(src)) {
233 modes[i] |= SKIP_WORKTREE_DIR;
234 goto dir_check;
235 }