diff options
| author | Derrick Stolee <dstolee@microsoft.com> | 2021-02-18 14:07:39 +0000 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2021-02-18 13:38:16 -0800 |
| commit | a43a2e6c2af63e5b93444c8ed8ac252927c2f0f3 (patch) | |
| tree | 178de6b6f6e9d77185bbba8fc8a0e6aa95a04d8a /Documentation/technical/commit-graph-format.txt | |
| parent | 5387fefadc121cb142e513557997415f2e75188a (diff) | |
| download | git-a43a2e6c2af63e5b93444c8ed8ac252927c2f0f3.tar.gz | |
chunk-format: add technical docs
The chunk-based file format is now an API in the code, but we should
also take time to document it as a file format. Specifically, it matches
the CHUNK LOOKUP sections of the commit-graph and multi-pack-index
files, but there are some commonalities that should be grouped in this
document.
Signed-off-by: Derrick Stolee <dstolee@microsoft.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Documentation/technical/commit-graph-format.txt')
| -rw-r--r-- | Documentation/technical/commit-graph-format.txt | 3 |
1 files changed, 3 insertions, 0 deletions
diff --git a/Documentation/technical/commit-graph-format.txt b/Documentation/technical/commit-graph-format.txt index b6658eff18..87971c27dd 100644 --- a/Documentation/technical/commit-graph-format.txt +++ b/Documentation/technical/commit-graph-format.txt @@ -61,6 +61,9 @@ CHUNK LOOKUP: the length using the next chunk position if necessary.) Each chunk ID appears at most once. + The CHUNK LOOKUP matches the table of contents from + link:technical/chunk-format.html[the chunk-based file format]. + The remaining data in the body is described one chunk at a time, and these chunks may be given in any order. Chunks are required unless otherwise specified. |