Skip to contentSkip to conversation

clone: rename static function `dir_exists()`.

PATCH In review Miriam Rubio 2 participants 3 messages Oct 28, 2019 – Oct 29, 2019

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 clone: rename static function `dir_exists()`.

builtin/clone.c has a static function dir_exists() that checks if a given path exists on the filesystem. It returns true (and it is correct for it to return true) when the given path exists as a non-directory (e.g. a regular file).

This is confusing. What the caller wants to check, and what this function wants to return, is if the path exists, so rename it to path_exists().

---
 builtin/clone.c | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)
builtin/clone.c +4 -4
index c46ee29f0a..b24f04cf33 100644
@@ -899,7 +899,7 @@ static void dissociate_from_references(void)
 	free(alternates);
 }
 
-static int dir_exists(const char *path)
+static int path_exists(const char *path)
 {
 	struct stat sb;
 	return !stat(path, &sb);
@@ -981,7 +981,7 @@ int cmd_clone(int argc, const char **argv, const char *prefix)
 		dir = guess_dir_name(repo_name, is_bundle, option_bare);
 	strip_trailing_slashes(dir);
 
-	dest_exists = dir_exists(dir);
+	dest_exists = path_exists(dir);
 	if (dest_exists && !is_empty_dir(dir))
 		die(_("destination path '%s' already exists and is not "
 			"an empty directory."), dir);
@@ -992,7 +992,7 @@ int cmd_clone(int argc, const char **argv, const char *prefix)
 		work_tree = NULL;
 	else {
 		work_tree = getenv("GIT_WORK_TREE");
-		if (work_tree && dir_exists(work_tree))
+		if (work_tree && path_exists(work_tree))
 			die(_("working tree '%s' already exists."), work_tree);
 	}
 
@@ -1020,7 +1020,7 @@ int cmd_clone(int argc, const char **argv, const char *prefix)
 	}
 
 	if (real_git_dir) {
-		if (dir_exists(real_git_dir))
+		if (path_exists(real_git_dir))
 			junk_git_dir_flags |= REMOVE_DIR_KEEP_TOPLEVEL;
 		junk_git_dir = real_git_dir;
 	} else {
Signature · 1 line
2.21.0 (Apple Git-122)
#1 lore raw
Quoted 5 lines · Miriam Rubio

builtin/clone.c has a static function dir_exists() that checks if a given path exists on the filesystem. It returns true (and it is correct for it to return true) when the given path exists as a non-directory (e.g. a regular file).

Quoted 8 lines

This is confusing. What the caller wants to check, and what this function wants to return, is if the path exists, so rename it to path_exists().

---
 builtin/clone.c | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

With a narrowed scope, the patch and its explanation are both perfect ;-)

Now, with this localized change behind us, we may want to consider what to do with file_exists(path) that does not ensure the path is a file. It would be a separate topic, and it is OK for the result after such consideration to be "let's not go further for now". It also is OK for it to be "I am interested in digging further", too.

Thanks. Will queue.

author
#2 lore raw

Great! Thank you, Junio!

Quoted 27 lines · Junio C Hamano
Quoted 5 lines · Miriam Rubio

builtin/clone.c has a static function dir_exists() that checks if a given path exists on the filesystem. It returns true (and it is correct for it to return true) when the given path exists as a non-directory (e.g. a regular file).

Quoted 8 lines

This is confusing. What the caller wants to check, and what this function wants to return, is if the path exists, so rename it to path_exists().

---
 builtin/clone.c | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

With a narrowed scope, the patch and its explanation are both perfect ;-)

Now, with this localized change behind us, we may want to consider what to do with file_exists(path) that does not ensure the path is a file. It would be a separate topic, and it is OK for the result after such consideration to be "let's not go further for now". It also is OK for it to be "I am interested in digging further", too.

Thanks. Will queue.