commit-graph: fix documentation inconsistencies
authorDerrick Stolee <dstolee@microsoft.com>
Thu, 28 Jun 2018 12:52:45 +0000 (12:52 +0000)
committerJunio C Hamano <gitster@pobox.com>
Thu, 28 Jun 2018 16:45:03 +0000 (09:45 -0700)
commita9aa3c09270698ef3c15ec20013bd5a1abae0dea
tree58ed4f00b0a8326687c276fdeb107ea2f0438c95
parent7547b95b4fbb8591726b1d9381c176cc27fc6aea
commit-graph: fix documentation inconsistencies

The commit-graph feature shipped in Git 2.18 has some inconsistencies in
the constants used by the implementation and specified by the format
document.

The commit data chunk uses the key "CDAT" in the file format, but was
previously documented to say "CGET".

The commit data chunk stores commit parents using two 32-bit fields that
typically store the integer position of the parent in the list of commit
ids within the commit-graph file. When a parent does not exist, we had
documented the value 0xffffffff, but implemented the value 0x70000000.
This swap is easy to correct in the documentation, but unfortunately
reduces the number of commits that we can store in the commit-graph.
Update that estimate, too.

Reported-by: Grant Welch <gwelch925@gmail.com>
Signed-off-by: Derrick Stolee <dstolee@microsoft.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Documentation/technical/commit-graph-format.txt