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

Re: [GSoC Patch v7 1/3] path: extract append_formatted_path() and use in rev-parse

From
Junio C Hamano <gitster@pobox.com>
Date
Jun 22, 2026, 16:03 UTC
Message-ID
<xmqq1pdy36me.fsf@gitster.g>
In-Reply-To
<xmqqtsqv6204.fsf@gitster.g>
Junio C Hamano <gitster@pobox.com> writes:
Show 23 quoted lines
> K Jayatheerth <jayatheerthkulkarni2005@gmail.com> writes:
> ...
> It is a minor point, but wouldn't it make it simpler to handle
> format_default first?  I.e.,
>
> 	if (format == FORMAT_DEFAULT)
> 		switch (def) {
> 		case DEFAULT_RELATIVE:
> 			format = DEFAULT_RELATIVE;
> 			break;
> 		...
> 		case DEFAULT_UNMODIFIED:
> 		default:
> 			format = DEFAULT_UNMODIFIED; 
> 			break;
> 	}
> 	switch (format) {
>         case FORMAT_RELATIVE: fmt = PATH_FORMAT_RELATIVE; break;
> 	case FORMAT_CANONICAL: fmt = PATH_FORMAT_CANONICAL; break;
> 	...
> 	}
>
> Perhaps yes, perhaps not.  I dunno.

I do not consider the above an blocker, but it might make a difference if we are going to acquire more modes and formats, so once somebody tries to rewrite the logic and finds the resulting code harder to follow (or not easier to follow), I would be happy to see the above discarded ;-)

Show 27 quoted lines
>> +/**
>> + * Format a path according to the specified formatting strategy and append
>> + * the result to the given strbuf.
>> + *
>> + * `dest`   : The string buffer to append the formatted path to.
>> + * `path`   : The path string that needs to be formatted.
>> + * `prefix` : The directory prefix to calculate relative offsets against.
>> + * Pass NULL to default to the current working directory where applicable.
>> + * `format` : The formatting behavior rule to execute.
>> + */
>> +void append_formatted_path(struct strbuf *dest, const char *path,
>> +			   const char *prefix, enum path_format format);
>> +
>
> It is slightly unsatisfying that this function is defined to
> "append" to any existing value in the dest strbuf, rather than
> storing the result in the dest strbuf.  The original caller
> print_path() passes an empty strbuf to this helper, so it can let
> strbuf_realpath_*() functions to strbuf_reset() it (e.g.,
> abspath.c:get_root_part() called by strbuf_realpath_1(), wihch in
> turn is called by strbuf_realpath() and strbuf_realpath_forgiving())
> it freely, which means that use of temporary strbuf like
> canonical_buf only to copy it out to dest is wasteful and unneeded.
> But other callers we will have for this helper later may want to
> append to what they already have, so perhaps it is OK (on the other
> hand, we could say that preserving and appending is what these
> callers can do themselves).

This one we may want to consider a bit more seriously, but it is entirely up to the future callers of the helper. If it would make the callers much easier to write for this helper to have "append" semantics, I'd be happy to accept the semantics of the above as-is, but otherwise, I suspect it would be simpler to use if the helper is defined to replase dest with the result, instead of appending the result to dest.

> Otherwise, looking good as a no-op bug-to-bug compatible rewrite,
> with a slight optimization (to skip xgetcwd()).

This part of the review does not change in any case. The refactoring looks good.

Thanks.
Previous: Junio C HamanoNext: K Jayatheerth
Message 72 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.