]> git.ipfire.org Git - thirdparty/git.git/commit
docs: note that extensions.compatobjectformat is incomplete
authorbrian m. carlson <sandals@crustytoothpaste.net>
Mon, 25 Aug 2025 22:11:01 +0000 (22:11 +0000)
committerJunio C Hamano <gitster@pobox.com>
Tue, 26 Aug 2025 14:48:36 +0000 (07:48 -0700)
commit716d905792ebc6fcaf3860d9356fe4dd6ce61715
tree669286e2739b22ad3047da2dfa5f7965e2c6dd64
parent47243eeed1749662e7c62d879d451a9383a25158
docs: note that extensions.compatobjectformat is incomplete

The compatibility object format is only implemented for loose objects,
not packed objects, so anyone attempting to push or fetch data into a
repository with this option will likely not see it work as expected.  In
addition, the underlying storage of loose object mapping is likely to
change because the current format is inefficient and does not handle
important mapping information such as that of submodules.

It would have been preferable to initially document that this was not
yet ready for prime time, but we did not do so.  We hinted at the fact
that this functionality is incomplete in the description, but did not
say so explicitly.  Let's do so now: indicate that this feature is
incomplete and subject to change and that the option is not designed to
be used by end users.

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