kernel
/
git
mirror of https://git.kernel.org/pub/scm/git/git.git
1
0
Fork 0
Code Releases Activity

docs: correct information about reftable 

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>
maint
brian m. carlson 2026-04-02 22:42:41 +00:00 committed by Junio C Hamano
parent 7c4e9e957a
commit e2f25d202e
1 changed files with 8 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
Documentation/ref-storage-format.adoc
View 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[]