]> git.ipfire.org Git - thirdparty/git.git/commitdiff
docs: correct information about reftable
authorbrian m. carlson <sandals@crustytoothpaste.net>
Thu, 2 Apr 2026 22:42:41 +0000 (22:42 +0000)
committerJunio C Hamano <gitster@pobox.com>
Wed, 8 Apr 2026 14:18:56 +0000 (07:18 -0700)
Our description of the reftable format is that it is experimental and
subject to change, but that is no longer true.  Remove this statement so
as not to mislead users.

In addition, the documentation says that the files format is the
default, but that is not true if breaking changes mode is on.  Correct
this information with a conditional.

Signed-off-by: brian m. carlson <sandals@crustytoothpaste.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Documentation/ref-storage-format.adoc

index 6a8db4712bd3f60e11dc566f2acbf8b7c29e2d16..c5e29ec831e0c5628ff06d02db7cae114fe3c57d 100644 (file)
@@ -1,3 +1,8 @@
-`files`;; for loose files with packed-refs. This is the default.
-`reftable`;; for the reftable format. This format is experimental and its
-  internals are subject to change.
+`files`;; for loose files with packed-refs.
+ifndef::with-breaking-changes[]
+       This is the default.
+endif::with-breaking-changes[]
+`reftable`;; for the reftable format.
+ifdef::with-breaking-changes[]
+       This is the default.
+endif::with-breaking-changes[]