[PATCH v2] ls-remote: add --show-object-format
- From
Adrian Ratiu <adrian.ratiu@collabora.com>
- Date
- Nov 12, 2026, 08:52 UTC
- Message-ID
- <20261112085205.452463-1-adrian.ratiu@collabora.com>
- In-Reply-To
- <20261105104541.790881-1-adrian.ratiu@collabora.com>
While working on JJ sha256 remote support (it uses Git for networking), I noticed there is no way to get the object format of a repo without cloning it. [1]
Git clone learns the remote format during the protocol handshake, but it is not shown anywhere else. For example, when creating an empty repo and running "git fetch":
1. If the remote has references, fetch can fail with a mismatch error and "git ls-remote" shows the format indirectly through the length of the object IDs. Not ideal, but then it can be figured out eventually, at least as long as no future hash algorithm has the same length as an existing one.
2. If the remote is empty, "git ls-remote" prints nothing and fetch succeeds, so the new local repo can silently get the wrong format, which only shows up later, on the first push.
To fill this gap, add a ls-remote --show-object-format option which prints the object format learned from the remote on a line of its own, before the references, as "object-format: <format>". The prefix leaves room for printing more remote properties in the future, without making parsers depend on the order of the lines.
[1]: https://github.com/jj-vcs/jj/issues/3813
Signed-off-by: Adrian Ratiu <adrian.ratiu@collabora.com> --- Changes between v1 -> v2: * Print "object-format: <format>" instead of just "<format>". (Patrick) * Reworded the --show-object-format documentation. (Patrick) * Test helper now takes the expected format as an arg. (Patrick) * Combined the sha1/sha256 tests in a single loop. (Patrick) * Minor typo fix. --- Documentation/git-ls-remote.adoc | 11 +++++++++- builtin/ls-remote.c | 9 +++++++- t/t5512-ls-remote.sh | 37 ++++++++++++++++++++++++++++++++ 3 files changed, 55 insertions(+), 2 deletions(-)
diff --git a/Documentation/git-ls-remote.adoc b/Documentation/git-ls-remote.adoc index d71c4ab3e2..5d80967df7 100644 --- a/Documentation/git-ls-remote.adoc +++ b/Documentation/git-ls-remote.adoc @@ -11,7 +11,8 @@ SYNOPSIS [verse] 'git ls-remote' [--branches] [--tags] [--refs] [--upload-pack=<exec>] [-q | --quiet] [--exit-code] [--get-url] [--sort=<key>] - [--symref] [<repository> [<patterns>...]] + [--symref] [--show-object-format] + [<repository> [<patterns>...]] DESCRIPTION ----------- @@ -64,6 +65,14 @@ OPTIONS upload-pack only shows the symref HEAD, so it will be the only one shown by ls-remote. +--show-object-format:: + Before the references, print the object format (hash algorithm) + of the remote on a line of its own, in the form + `object-format: <format>`, e.g. `object-format: sha256`. This + also works for remotes without any refs, so it can be used to + find out which object format a local repository needs before + fetching from or pushing to the remote. + --sort=<key>:: Sort based on the key given. Prefix `-` to sort in descending order of the value. Supports "version:refname" or "v:refname" (tag names diff --git a/builtin/ls-remote.c b/builtin/ls-remote.c index fe77829557..1d7bb578b3 100644 --- a/builtin/ls-remote.c +++ b/builtin/ls-remote.c @@ -12,7 +12,8 @@ static const char * const ls_remote_usage[] = { N_("git ls-remote [--branches] [--tags] [--refs] [--upload-pack=<exec>]\n" " [-q | --quiet] [--exit-code] [--get-url] [--sort=<key>]\n" - " [--symref] [<repository> [<patterns>...]]"), + " [--symref] [--show-object-format]\n" + " [<repository> [<patterns>...]]"), NULL }; @@ -49,6 +50,7 @@ int cmd_ls_remote(int argc, int quiet = 0; int status = 0; int show_symref_target = 0; + int show_object_format = 0; const char *uploadpack = NULL; struct strvec pattern = STRVEC_INIT; struct transport_ls_refs_options transport_options = @@ -89,6 +91,8 @@ int cmd_ls_remote(int argc, 2, PARSE_OPT_NOCOMPLETE), OPT_BOOL(0, "symref", &show_symref_target, N_("show underlying ref in addition to the object pointed by it")), + OPT_BOOL(0, "show-object-format", &show_object_format, + N_("show the object format used by the remote repository")), OPT_STRING_LIST('o', "server-option", &server_options, N_("server-specific"), N_("option to transmit")), OPT_END() }; @@ -150,6 +154,9 @@ int cmd_ls_remote(int argc, if (!dest && !quiet) fprintf(stderr, "From %s\n", remote->url.v[0]); + if (show_object_format) + printf("object-format: %s\n", + transport_get_hash_algo(transport)->name); for ( ; ref; ref = ref->next) { struct ref_array_item *item; if (!check_ref_type(ref, flags)) diff --git a/t/t5512-ls-remote.sh b/t/t5512-ls-remote.sh index 2e1d4f7586..1b063a586a 100755 --- a/t/t5512-ls-remote.sh +++ b/t/t5512-ls-remote.sh @@ -332,6 +332,43 @@ test_expect_success 'indicate no refs in v0 standards-compliant empty remote' ' test_expect_code 2 git ls-remote --exit-code --upload-pack=./cat-input . ' +# Run "ls-remote --show-object-format" with the given arguments over +# protocol v0 and v2, and check that it prints the object format given +# as the first argument, followed by the same refs as plain "ls-remote". +test_show_object_format () { + format=$1 && + shift && + echo "object-format: $format" >expect && + git ls-remote "$@" >>expect && + for version in 0 2 + do + git -c protocol.version=$version \ + ls-remote --show-object-format "$@" >actual && + test_cmp expect actual || return 1 + done +} + +for hash in sha1 sha256 +do + test_expect_success "ls-remote --show-object-format with empty $hash remote" ' + git init --bare --object-format=$hash empty-$hash.git && + test_show_object_format $hash empty-$hash.git + ' + + test_expect_success "ls-remote --show-object-format with $hash remote" ' + git init --object-format=$hash repo-$hash && + test_commit -C repo-$hash one && + test_show_object_format $hash repo-$hash HEAD + ' +done + +test_expect_success 'ls-remote --show-object-format outside repository' ' + nongit git init --bare --object-format=sha256 empty-nongit.git && + echo "object-format: sha256" >expect && + nongit git ls-remote --show-object-format empty-nongit.git >actual && + test_cmp expect actual +' + test_expect_success 'ls-remote works outside repository' ' # It is important for this repo to be inside the nongit # area, as we want a repo name that does not include
-- 2.56.0