[PATCH] builtin/repo: rename "references.format" to "references.storageFormat"

[PATCH] builtin/repo: rename "references.format" to "references.storageFormat"

[Patrick Steinhardt]

As part of 2f28db44d5 (Merge branch 'ps/ref-storage-format', 2026-10-01)
we have adapt all sites that used to say "reference format" to instead
say "reference storage format".

One missed spot though was in git-repo(1), where we still print the
"references.format" key. Fix that oversight by renaming the key to
"references.storageFormat".

Signed-off-by: Patrick Steinhardt <ps@pks.im>
---
Hi,

this is a follow-up on 2f28db44d5 (Merge branch 'ps/ref-storage-format',
2026-10-01), where I missed this one place. I noticed that only today
while working on the object storage format extension.

Thanks!

Patrick
---
 Documentation/git-repo.adoc |  6 +++---
 builtin/repo.c              |  2 +-
 t/t1900-repo-info.sh        | 12 ++++++------
 3 files changed, 10 insertions(+), 10 deletions(-)

diff --git a/Documentation/git-repo.adoc b/Documentation/git-repo.adoc
index ed7d80c690..5af454e8ca 100644
--- a/Documentation/git-repo.adoc
+++ b/Documentation/git-repo.adoc
@@ -119,7 +119,7 @@ values that they return:
 `path.gitdir.relative`::
 	The path to the Git repository directory relative to the current working directory.
 
-`references.format`::
+`references.storageFormat`::
 	The reference storage format. The valid values are:
 +
 include::ref-storage-format.adoc[]
@@ -127,10 +127,10 @@ include::ref-storage-format.adoc[]
 EXAMPLES
 --------
 
-* Retrieves the reference format of the current repository:
+* Retrieves the reference storage format of the current repository:
 +
 ------------
-git repo info references.format
+git repo info references.storageFormat
 ------------
 +
 
diff --git a/builtin/repo.c b/builtin/repo.c
index 84e012f83f..15267e8d54 100644
--- a/builtin/repo.c
+++ b/builtin/repo.c
@@ -137,7 +137,7 @@ static const struct repo_info_field repo_info_field[] = {
 	{ "path.commondir.relative", get_path_commondir_relative },
 	{ "path.gitdir.absolute", get_path_gitdir_absolute },
 	{ "path.gitdir.relative", get_path_gitdir_relative },
-	{ "references.format", get_references_format },
+	{ "references.storageFormat", get_references_format },
 };
 
 static int repo_info_field_cmp(const void *va, const void *vb)
diff --git a/t/t1900-repo-info.sh b/t/t1900-repo-info.sh
index d115d2d9f9..ee84f33229 100755
--- a/t/t1900-repo-info.sh
+++ b/t/t1900-repo-info.sh
@@ -39,10 +39,10 @@ test_repo_info () {
 }
 
 test_repo_info 'ref format files is retrieved correctly' \
-	'git init --ref-storage-format=files' 'format-files' 'references.format' 'files'
+	'git init --ref-storage-format=files' 'format-files' 'references.storageFormat' 'files'
 
 test_repo_info 'ref format reftable is retrieved correctly' \
-	'git init --ref-storage-format=reftable' 'format-reftable' 'references.format' 'reftable'
+	'git init --ref-storage-format=reftable' 'format-reftable' 'references.storageFormat' 'reftable'
 
 test_repo_info 'bare repository = false is retrieved correctly' \
 	'git init' 'nonbare' 'layout.bare' 'false'
@@ -72,11 +72,11 @@ test_repo_info 'object.format = sha256 is retrieved correctly' \
 test_expect_success 'values returned in order requested' '
 	cat >expect <<-\EOF &&
 	layout.bare=false
-	references.format=files
+	references.storageFormat=files
 	layout.bare=false
 	EOF
 	git init --ref-storage-format=files ordered &&
-	git -C ordered repo info layout.bare references.format layout.bare >actual &&
+	git -C ordered repo info layout.bare references.storageFormat layout.bare >actual &&
 	test_cmp expect actual
 '
 
@@ -87,8 +87,8 @@ test_expect_success 'git-repo-info fails if an invalid key is requested' '
 '
 
 test_expect_success 'git-repo-info outputs data even if there is an invalid field' '
-	echo "references.format=$(test_detect_ref_format)" >expect &&
-	test_must_fail git repo info foo references.format bar >actual &&
+	echo "references.storageFormat=$(test_detect_ref_format)" >expect &&
+	test_must_fail git repo info foo references.storageFormat bar >actual &&
 	test_cmp expect actual
 '
 

---
base-commit: 8103b446517e0c44e67561b9d0ccce56efa60a71
change-id: 20261005-pks-repo-ref-storage-format-9ea2c5528970

Re: [PATCH] builtin/repo: rename "references.format" to "references.storageFormat"

[Karthik Nayak]

[-- Attachment #1: Type: text/plain, Size: 538 bytes --]

Patrick Steinhardt <ps@pks.im> writes:

> As part of 2f28db44d5 (Merge branch 'ps/ref-storage-format', 2026-10-01)
> we have adapt all sites that used to say "reference format" to instead
> say "reference storage format".
>
> One missed spot though was in git-repo(1), where we still print the
> "references.format" key. Fix that oversight by renaming the key to
> "references.storageFormat".

The patch looks good, but this does break backward compatibility. But
since the command it marked as experimental, this should be okay.

[snip]

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 690 bytes --]

Re: [PATCH] builtin/repo: rename "references.format" to "references.storageFormat"

[Patrick Steinhardt]

On Mon, Oct 05, 2026 at 03:11:19PM +0000, Karthik Nayak wrote:
> Patrick Steinhardt <ps@pks.im> writes:
> 
> > As part of 2f28db44d5 (Merge branch 'ps/ref-storage-format', 2026-10-01)
> > we have adapt all sites that used to say "reference format" to instead
> > say "reference storage format".
> >
> > One missed spot though was in git-repo(1), where we still print the
> > "references.format" key. Fix that oversight by renaming the key to
> > "references.storageFormat".
> 
> The patch looks good, but this does break backward compatibility. But
> since the command it marked as experimental, this should be okay.

Right, I should've probably mentioned this as part of the commit
message. We could for a while carry both keys of course. But given that
it's marked as experimental I think it's okay to break the format and
drop the old key.

Thanks!

Patrick

Re: [PATCH] builtin/repo: rename "references.format" to "references.storageFormat"

[Karthik Nayak]

[-- Attachment #1: Type: text/plain, Size: 987 bytes --]

Patrick Steinhardt <ps@pks.im> writes:

> On Mon, Oct 05, 2026 at 03:11:19PM +0000, Karthik Nayak wrote:
>> Patrick Steinhardt <ps@pks.im> writes:
>>
>> > As part of 2f28db44d5 (Merge branch 'ps/ref-storage-format', 2026-10-01)
>> > we have adapt all sites that used to say "reference format" to instead
>> > say "reference storage format".
>> >
>> > One missed spot though was in git-repo(1), where we still print the
>> > "references.format" key. Fix that oversight by renaming the key to
>> > "references.storageFormat".
>>
>> The patch looks good, but this does break backward compatibility. But
>> since the command it marked as experimental, this should be okay.
>
> Right, I should've probably mentioned this as part of the commit
> message. We could for a while carry both keys of course. But given that
> it's marked as experimental I think it's okay to break the format and
> drop the old key.
>
> Thanks!
>
> Patrick

Yeah, all good, no need to iterate just for that I think.

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 690 bytes --]