Git development
 help / color / mirror / Atom feed
* [PATCH] ls-tree: do not quote %(path) with -z
@ 2026-11-18 23:04 Noam Cohen via B4 Relay
  2026-11-18 23:20 ` Junio C Hamano
  0 siblings, 1 reply; 3+ messages in thread
From: Noam Cohen via B4 Relay @ 2026-11-18 23:04 UTC (permalink / raw)
  To: git
  Cc: Junio C Hamano, Teng Long, Ævar Arnfjörð Bjarmason,
	René Scharfe, Noam Cohen

From: Noam Cohen <noam@noam.me>

With -z, "git ls-tree" is documented to output the filename verbatim,
but since 455923e0a1 (ls-tree: introduce "--format" option,
2022-03-23) the %(path) placeholder of a custom --format is always
C-quoted.

Output it verbatim when -z is given, like "git ls-files --format"
already does.

Signed-off-by: Noam Cohen <noam@noam.me>
---
This makes "ls-tree -z --format" match "ls-files -z --format", which
already outputs %(path) verbatim.
---
 builtin/ls-tree.c         | 5 ++++-
 t/t3104-ls-tree-format.sh | 9 ++++++++-
 2 files changed, 12 insertions(+), 2 deletions(-)

diff --git a/builtin/ls-tree.c b/builtin/ls-tree.c
index 46edaffc2e..d25bbffcdd 100644
--- a/builtin/ls-tree.c
+++ b/builtin/ls-tree.c
@@ -130,7 +130,10 @@ static int show_tree_fmt(const struct object_id *oid, struct strbuf *base,
 
 			strbuf_addstr(base, pathname);
 			name = relative_path(base->buf, prefix, &sbuf);
-			quote_c_style(name, &sb, NULL, 0);
+			if (options->null_termination)
+				strbuf_addstr(&sb, name);
+			else
+				quote_c_style(name, &sb, NULL, 0);
 			strbuf_setlen(base, baselen);
 			strbuf_release(&sbuf);
 		} else
diff --git a/t/t3104-ls-tree-format.sh b/t/t3104-ls-tree-format.sh
index a1b2069a25..016c0fd0ff 100755
--- a/t/t3104-ls-tree-format.sh
+++ b/t/t3104-ls-tree-format.sh
@@ -12,7 +12,8 @@ test_expect_success 'ls-tree --format usage' '
 '
 
 test_expect_success 'setup' '
-	setup_basic_ls_tree_data
+	setup_basic_ls_tree_data &&
+	test_commit נעם
 '
 
 test_ls_tree_format () {
@@ -76,4 +77,10 @@ test_ls_tree_format \
 	"--full-tree" \
 	"--full-tree"
 
+test_expect_success 'ls-tree --format with -z does not quote paths' '
+	printf "blob נעם.t\0" >expect &&
+	git ls-tree -z --format="%(objecttype) %(path)" HEAD נעם.t >actual &&
+	test_cmp expect actual
+'
+
 test_done

---
base-commit: 03b41523c576f26ad34085378717a0c1b287470f
change-id: 20261118-ls-tree-format-z-verbatim-path-f5783b61ff8f



^ permalink raw reply related	[flat|nested] 3+ messages in thread

* Re: [PATCH] ls-tree: do not quote %(path) with -z
  2026-11-18 23:04 [PATCH] ls-tree: do not quote %(path) with -z Noam Cohen via B4 Relay
@ 2026-11-18 23:20 ` Junio C Hamano
  2026-11-18 23:45   ` Noam Cohen
  0 siblings, 1 reply; 3+ messages in thread
From: Junio C Hamano @ 2026-11-18 23:20 UTC (permalink / raw)
  To: Noam Cohen via B4 Relay
  Cc: git, Teng Long, Ævar Arnfjörð Bjarmason,
	René Scharfe, Noam Cohen

Noam Cohen via B4 Relay <devnull+noam.noam.me@kernel.org> writes:

> From: Noam Cohen <noam@noam.me>
>
> With -z, "git ls-tree" is documented to output the filename verbatim,
> but since 455923e0a1 (ls-tree: introduce "--format" option,
> 2022-03-23) the %(path) placeholder of a custom --format is always
> C-quoted.
>
> Output it verbatim when -z is given, like "git ls-files --format"
> already does.

ce74de931d (ls-files: introduce "--format" option, 2022-07-23) was
the one that added --format, and the documentation added by the
commit does talk about -z.  But curiously, it does not add any test
that exercises --format="%(path)" combined with -z.

The code change is trivially correct.

>  test_expect_success 'setup' '
> -	setup_basic_ls_tree_data
> +	setup_basic_ls_tree_data &&
> +	test_commit נעם
>  '

Do we have to really use characters outside US-ASCII?

> @@ -76,4 +77,10 @@ test_ls_tree_format \
>  	"--full-tree" \
>  	"--full-tree"
>  
> +test_expect_success 'ls-tree --format with -z does not quote paths' '
> +	printf "blob נעם.t\0" >expect &&
> +	git ls-tree -z --format="%(objecttype) %(path)" HEAD נעם.t >actual &&

OK, perhaps.

^ permalink raw reply	[flat|nested] 3+ messages in thread

* Re: [PATCH] ls-tree: do not quote %(path) with -z
  2026-11-18 23:20 ` Junio C Hamano
@ 2026-11-18 23:45   ` Noam Cohen
  0 siblings, 0 replies; 3+ messages in thread
From: Noam Cohen @ 2026-11-18 23:45 UTC (permalink / raw)
  To: Junio C Hamano
  Cc: git, Teng Long, Ævar Arnfjörð Bjarmason,
	René Scharfe

Junio C Hamano <gitster@pobox.com> writes:

>>  test_expect_success 'setup' '
>> -    setup_basic_ls_tree_data
>> +    setup_basic_ls_tree_data &&
>> +    test_commit נעם
>>  '
>
> Do we have to really use characters outside US-ASCII?

The only US-ASCII bytes that quote_c_style() quotes are control
characters, DEL, '"' and '\', and Windows does not allow them in
filenames, except for DEL, which felt too obscure to rely on.

We could avoid the filesystem and synthesize the tree with "git
mktree" instead, which is what I had at first, but that made the
test noticeably more complicated than a test_commit in the setup.

We already have tests that use non-ASCII paths, like t3902,
t4012, and others.

Do you think the test should set core.quotePath explicitly, rather
than relying on its default?

Also, should I just drop the test, or add a similar one for ls-files
--format?

^ permalink raw reply	[flat|nested] 3+ messages in thread

end of thread, other threads:[~2026-11-18 23:46 UTC | newest]

Thread overview: 3+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2026-11-18 23:04 [PATCH] ls-tree: do not quote %(path) with -z Noam Cohen via B4 Relay
2026-11-18 23:20 ` Junio C Hamano
2026-11-18 23:45   ` Noam Cohen

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox