Skip to content

Commit 716d905

Browse files
bk2204gitster
authored andcommitted
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>
1 parent 47243ee commit 716d905

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

Documentation/config/extensions.adoc

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,10 @@ compatObjectFormat::
1414
compatObjectFormat. As well as being able to use oids encoded in
1515
compatObjectFormat in addition to oids encoded with objectFormat to
1616
locally specify objects.
17+
+
18+
Note that the functionality enabled by this extension is incomplete and subject
19+
to change. It currently exists only to allow development and testing of
20+
the underlying feature and is not designed to be enabled by end users.
1721
1822
noop::
1923
This extension does not change git's behavior at all. It is useful only

0 commit comments

Comments
 (0)