git/list[1] front-page[2] threads[3] people[4] search[5] about
 

[GSoC][PATCH 2/4] rev-parse: use strbuf_add_path for path formatting

From
K Jayatheerth <jayatheerthkulkarni2005@gmail.com>
Date
Jun 1, 2026, 15:19 UTC
Message-ID
<20260601151950.30686-3-jayatheerthkulkarni2005@gmail.com>
In-Reply-To
<20260601151950.30686-1-jayatheerthkulkarni2005@gmail.com>

Now that the core path-formatting logic has been abstracted into strbuf_add_path() inside path.c, remove the duplicate localized implementation from builtin/rev-parse.c.

Drop the local format_type and default_type enums from the builtin, and update print_path() to act as a light wrapper around the new shared strbuf engine. Update cmd_rev_parse() to use the new path_ format and default enum types exposed via path.h.

Signed-off-by: K Jayatheerth <jayatheerthkulkarni2005@gmail.com>
Mentored-by: Justin Tobler <jltobler@gmail.com>
Mentored-by: Lucas Seiki Oshiro <lucasseikioshiro@gmail.com>
---
 builtin/rev-parse.c | 100 ++++++++++----------------------------------
 1 file changed, 21 insertions(+), 79 deletions(-)
diff --git a/builtin/rev-parse.c b/builtin/rev-parse.c
index 218b5f34d6..812cfd55ad 100644
--- a/builtin/rev-parse.c
+++ b/builtin/rev-parse.c
@@ -632,73 +632,15 @@ static void handle_ref_opt(const char *pattern, const char *prefix)
 	clear_ref_exclusions(&ref_excludes);
 }
 
-enum format_type {
-	/* We would like a relative path. */
-	FORMAT_RELATIVE,
-	/* We would like a canonical absolute path. */
-	FORMAT_CANONICAL,
-	/* We would like the default behavior. */
-	FORMAT_DEFAULT,
-};
-
-enum default_type {
-	/* Our default is a relative path. */
-	DEFAULT_RELATIVE,
-	/* Our default is a relative path if there's a shared root. */
-	DEFAULT_RELATIVE_IF_SHARED,
-	/* Our default is a canonical absolute path. */
-	DEFAULT_CANONICAL,
-	/* Our default is not to modify the item. */
-	DEFAULT_UNMODIFIED,
-};
-
-static void print_path(const char *path, const char *prefix, enum format_type format, enum default_type def)
+static void print_path(const char *path, const char *prefix,
+		       enum path_format_type format, enum path_default_type def)
 {
-	char *cwd = NULL;
-	/*
-	 * We don't ever produce a relative path if prefix is NULL, so set the
-	 * prefix to the current directory so that we can produce a relative
-	 * path whenever possible.  If we're using RELATIVE_IF_SHARED mode, then
-	 * we want an absolute path unless the two share a common prefix, so don't
-	 * set it in that case, since doing so causes a relative path to always
-	 * be produced if possible.
-	 */
-	if (!prefix && (format != FORMAT_DEFAULT || def != DEFAULT_RELATIVE_IF_SHARED))
-		prefix = cwd = xgetcwd();
-	if (format == FORMAT_DEFAULT && def == DEFAULT_UNMODIFIED) {
-		puts(path);
-	} else if (format == FORMAT_RELATIVE ||
-		  (format == FORMAT_DEFAULT && def == DEFAULT_RELATIVE)) {
-		/*
-		 * In order for relative_path to work as expected, we need to
-		 * make sure that both paths are absolute paths.  If we don't,
-		 * we can end up with an unexpected absolute path that the user
-		 * didn't want.
-		 */
-		struct strbuf buf = STRBUF_INIT, realbuf = STRBUF_INIT, prefixbuf = STRBUF_INIT;
-		if (!is_absolute_path(path)) {
-			strbuf_realpath_forgiving(&realbuf, path,  1);
-			path = realbuf.buf;
-		}
-		if (!is_absolute_path(prefix)) {
-			strbuf_realpath_forgiving(&prefixbuf, prefix, 1);
-			prefix = prefixbuf.buf;
-		}
-		puts(relative_path(path, prefix, &buf));
-		strbuf_release(&buf);
-		strbuf_release(&realbuf);
-		strbuf_release(&prefixbuf);
-	} else if (format == FORMAT_DEFAULT && def == DEFAULT_RELATIVE_IF_SHARED) {
-		struct strbuf buf = STRBUF_INIT;
-		puts(relative_path(path, prefix, &buf));
-		strbuf_release(&buf);
-	} else {
-		struct strbuf buf = STRBUF_INIT;
-		strbuf_realpath_forgiving(&buf, path, 1);
-		puts(buf.buf);
-		strbuf_release(&buf);
-	}
-	free(cwd);
+	struct strbuf sb = STRBUF_INIT;
+
+	strbuf_add_path(&sb, path, prefix, format, def);
+	puts(sb.buf);
+
+	strbuf_release(&sb);
 }
 
 int cmd_rev_parse(int argc,
@@ -717,7 +659,7 @@ int cmd_rev_parse(int argc,
 	const char *name = NULL;
 	struct strbuf buf = STRBUF_INIT;
 	int seen_end_of_options = 0;
-	enum format_type format = FORMAT_DEFAULT;
+	enum path_format_type format = PATH_FORMAT_DEFAULT;
 
 	show_usage_if_asked(argc, argv, builtin_rev_parse_usage);
 
@@ -798,7 +740,7 @@ int cmd_rev_parse(int argc,
 				print_path(repo_git_path_replace(the_repository, &buf,
 								 "%s", argv[i + 1]), prefix,
 						format,
-						DEFAULT_RELATIVE_IF_SHARED);
+						PATH_DEFAULT_RELATIVE_IF_SHARED);
 				i++;
 				continue;
 			}
@@ -820,9 +762,9 @@ int cmd_rev_parse(int argc,
 				if (!arg)
 					die(_("--path-format requires an argument"));
 				if (!strcmp(arg, "absolute")) {
-					format = FORMAT_CANONICAL;
+					format = PATH_FORMAT_CANONICAL;
 				} else if (!strcmp(arg, "relative")) {
-					format = FORMAT_RELATIVE;
+					format = PATH_FORMAT_RELATIVE;
 				} else {
 					die(_("unknown argument to --path-format: %s"), arg);
 				}
@@ -985,7 +927,7 @@ int cmd_rev_parse(int argc,
 			if (!strcmp(arg, "--show-toplevel")) {
 				const char *work_tree = repo_get_work_tree(the_repository);
 				if (work_tree)
-					print_path(work_tree, prefix, format, DEFAULT_UNMODIFIED);
+					print_path(work_tree, prefix, format, PATH_DEFAULT_UNMODIFIED);
 				else
 					die(_("this operation must be run in a work tree"));
 				continue;
@@ -993,7 +935,7 @@ int cmd_rev_parse(int argc,
 			if (!strcmp(arg, "--show-superproject-working-tree")) {
 				struct strbuf superproject = STRBUF_INIT;
 				if (get_superproject_working_tree(&superproject))
-					print_path(superproject.buf, prefix, format, DEFAULT_UNMODIFIED);
+					print_path(superproject.buf, prefix, format, PATH_DEFAULT_UNMODIFIED);
 				strbuf_release(&superproject);
 				continue;
 			}
@@ -1028,18 +970,18 @@ int cmd_rev_parse(int argc,
 				const char *gitdir = getenv(GIT_DIR_ENVIRONMENT);
 				char *cwd;
 				int len;
-				enum format_type wanted = format;
+				enum path_format_type wanted = format;
 				if (arg[2] == 'g') {	/* --git-dir */
 					if (gitdir) {
-						print_path(gitdir, prefix, format, DEFAULT_UNMODIFIED);
+						print_path(gitdir, prefix, format, PATH_DEFAULT_UNMODIFIED);
 						continue;
 					}
 					if (!prefix) {
-						print_path(".git", prefix, format, DEFAULT_UNMODIFIED);
+						print_path(".git", prefix, format, PATH_DEFAULT_UNMODIFIED);
 						continue;
 					}
 				} else {		/* --absolute-git-dir */
-					wanted = FORMAT_CANONICAL;
+					wanted = PATH_FORMAT_CANONICAL;
 					if (!gitdir && !prefix)
 						gitdir = ".git";
 					if (gitdir) {
@@ -1055,11 +997,11 @@ int cmd_rev_parse(int argc,
 				strbuf_reset(&buf);
 				strbuf_addf(&buf, "%s%s.git", cwd, len && cwd[len-1] != '/' ? "/" : "");
 				free(cwd);
-				print_path(buf.buf, prefix, wanted, DEFAULT_CANONICAL);
+				print_path(buf.buf, prefix, wanted, PATH_DEFAULT_CANONICAL);
 				continue;
 			}
 			if (!strcmp(arg, "--git-common-dir")) {
-				print_path(repo_get_common_dir(the_repository), prefix, format, DEFAULT_RELATIVE_IF_SHARED);
+				print_path(repo_get_common_dir(the_repository), prefix, format, PATH_DEFAULT_RELATIVE_IF_SHARED);
 				continue;
 			}
 			if (!strcmp(arg, "--is-inside-git-dir")) {
@@ -1089,7 +1031,7 @@ int cmd_rev_parse(int argc,
 				if (the_repository->index->split_index) {
 					const struct object_id *oid = &the_repository->index->split_index->base_oid;
 					const char *path = repo_git_path_replace(the_repository, &buf, "sharedindex.%s", oid_to_hex(oid));
-					print_path(path, prefix, format, DEFAULT_RELATIVE);
+					print_path(path, prefix, format, PATH_DEFAULT_RELATIVE);
 				}
 				continue;
 			}
-- 
2.54.0
Previous: Phillip WoodNext: K Jayatheerth
Message 4 of 82 in “teach git repo info to handle path keys”
  1. K JayatheerthJun 1, 2026
  2. [GSoC][PATCH 1/4] path: add strbuf_add_path for formatting pathsK Jayatheerth, Jun 1, 2026
  3. Phillip WoodJun 2, 2026
  4. [GSoC][PATCH 2/4] rev-parse: use strbuf_add_path for path formattingK Jayatheerth, Jun 1, 2026
  5. [GSoC][PATCH 3/4] repo: add path.gitdir with absolute and relative suffix formattingK Jayatheerth, Jun 1, 2026
  6. Lucas Seiki OshiroJun 1, 2026
  7. Junio C HamanoJun 1, 2026
  8. [GSoC][PATCH 4/4] repo: add path.commondir with absolute and relative suffix formattingK Jayatheerth, Jun 1, 2026
  9. Lucas Seiki OshiroJun 1, 2026
  10. Lucas Seiki OshiroJun 1, 2026
  11. Lucas Seiki OshiroJun 1, 2026
  12. Lucas Seiki OshiroJun 1, 2026
  13. Junio C HamanoJun 1, 2026
  14. Phillip WoodJun 2, 2026
  15. 0/4 teach git repo info to handle path keysK Jayatheerth, Jun 5, 2026
  16. 1/4 path: introduce format_path() for centralized path formattingK Jayatheerth, Jun 5, 2026
  17. Kristoffer HaugsbakkJun 5, 2026
  18. K JayatheerthJun 9, 2026
  19. Lucas Seiki OshiroJun 8, 2026
  20. K JayatheerthJun 9, 2026
  21. Justin ToblerJun 8, 2026
  22. 2/4 rev-parse: use format_path for path formattingK Jayatheerth, Jun 5, 2026
  23. Justin ToblerJun 8, 2026
  24. 3/4 repo: add path.gitdir with absolute and relative suffix formattingK Jayatheerth, Jun 5, 2026
  25. Justin ToblerJun 8, 2026
  26. K JayatheerthJun 9, 2026
  27. Justin ToblerJun 9, 2026
  28. K JayatheerthJun 10, 2026
  29. Lucas Seiki OshiroJun 8, 2026
  30. 4/4 repo: add path.commondir with absolute and relative suffix formattingK Jayatheerth, Jun 5, 2026
  31. Lucas Seiki OshiroJun 8, 2026
  32. Lucas Seiki OshiroJun 5, 2026
  33. K JayatheerthJun 9, 2026
  34. Junio C HamanoJun 8, 2026
  35. K JayatheerthJun 9, 2026
  36. Lucas Seiki OshiroJun 10, 2026
  37. 0/4 teach git repo info to handle path keysK Jayatheerth, Jun 12, 2026
  38. 1/4 path: introduce append_formatted_path() for shared path formattingK Jayatheerth, Jun 12, 2026
  39. 2/4 rev-parse: use append_formatted_path() for path formattingK Jayatheerth, Jun 12, 2026
  40. 3/4 repo: add path.commondir with absolute and relative suffix formattingK Jayatheerth, Jun 12, 2026
  41. Lucas Seiki OshiroJun 15, 2026
  42. 4/4 repo: add path.gitdir with absolute and relative suffix formattingK Jayatheerth, Jun 12, 2026
  43. Lucas Seiki OshiroJun 15, 2026
  44. Lucas Seiki OshiroJun 15, 2026
  45. 0/4 teach git repo info to handle path keysK Jayatheerth, Jun 15, 2026
  46. 1/4 path: introduce append_formatted_path() for shared path formattingK Jayatheerth, Jun 15, 2026
  47. 2/4 rev-parse: use append_formatted_path() for path formattingK Jayatheerth, Jun 15, 2026
  48. Justin ToblerJun 15, 2026
  49. K JayatheerthJun 16, 2026
  50. 3/4 repo: add path.commondir with absolute and relative suffix formattingK Jayatheerth, Jun 15, 2026
  51. Justin ToblerJun 15, 2026
  52. 4/4 repo: add path.gitdir with absolute and relative suffix formattingK Jayatheerth, Jun 15, 2026
  53. 0/4 teach git repo info to handle path keysK Jayatheerth, Jun 16, 2026
  54. 1/4 path: introduce append_formatted_path() for shared path formattingK Jayatheerth, Jun 16, 2026
  55. Phillip WoodJun 16, 2026
  56. 2/4 rev-parse: use append_formatted_path() for path formattingK Jayatheerth, Jun 16, 2026
  57. Phillip WoodJun 16, 2026
  58. K JayatheerthJun 16, 2026
  59. Phillip WoodJun 16, 2026
  60. 3/4 repo: add path.commondir with absolute and relative suffix formattingK Jayatheerth, Jun 16, 2026
  61. 4/4 repo: add path.gitdir with absolute and relative suffix formattingK Jayatheerth, Jun 16, 2026
  62. 0/4 teach git repo info to handle path keysK Jayatheerth, Jun 20, 2026
  63. 1/4 path: introduce append_formatted_path() for shared path formattingK Jayatheerth, Jun 20, 2026
  64. Junio C HamanoJun 20, 2026
  65. K JayatheerthJun 20, 2026
  66. 2/4 rev-parse: use append_formatted_path() for path formattingK Jayatheerth, Jun 20, 2026
  67. 3/4 repo: add path.commondir with absolute and relative suffix formattingK Jayatheerth, Jun 20, 2026
  68. 4/4 repo: add path.gitdir with absolute and relative suffix formattingK Jayatheerth, Jun 20, 2026
  69. 0/3 teach git repo info to handle path keysK Jayatheerth, Jun 21, 2026
  70. 1/3 path: extract append_formatted_path() and use in rev-parseK Jayatheerth, Jun 21, 2026
  71. Junio C HamanoJun 21, 2026
  72. Junio C HamanoJun 22, 2026
  73. K JayatheerthJun 22, 2026
  74. Phillip WoodJun 23, 2026
  75. K JayatheerthJun 24, 2026
  76. 2/3 repo: add path.commondir with absolute and relative suffix formattingK Jayatheerth, Jun 21, 2026
  77. 3/3 repo: add path.gitdir with absolute and relative suffix formattingK Jayatheerth, Jun 21, 2026
  78. 0/3 teach git repo info to handle path keysK Jayatheerth, Jun 24, 2026
  79. 1/3 path: extract format_path() and use in rev-parseK Jayatheerth, Jun 24, 2026
  80. Junio C HamanoJun 24, 2026
  81. 2/3 repo: add path.commondir with absolute and relative suffix formattingK Jayatheerth, Jun 24, 2026
  82. 3/3 repo: add path.gitdir with absolute and relative suffix formattingK Jayatheerth, Jun 24, 2026

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.