FM / git

/usr/share/doc/git

Name	Size	Mode	Actions
contrib/	-	0755	rm
howto/	-	0755	rm
RelNotes/	-	0755	rm
technical/	-	0755	rm
blame-options.txt	6001	0644	edit dl rm
cmds-ancillaryinterrogators.txt	1294	0644	edit dl rm
cmds-ancillarymanipulators.txt	746	0644	edit dl rm
cmds-developerinterfaces.txt	678	0644	edit dl rm
cmds-foreignscminterface.txt	399	0644	edit dl rm
cmds-guide.txt	833	0644	edit dl rm
cmds-mainporcelain.txt	3033	0644	edit dl rm
cmds-plumbinginterrogators.txt	1539	0644	edit dl rm
cmds-plumbingmanipulators.txt	1410	0644	edit dl rm
cmds-purehelpers.txt	1268	0644	edit dl rm
cmds-synchelpers.txt	449	0644	edit dl rm
cmds-synchingrepositories.txt	397	0644	edit dl rm
cmds-userinterfaces.txt	507	0644	edit dl rm
CODE_OF_CONDUCT.md	5989	0644	edit dl rm
config.txt	18001	0644	edit dl rm
date-formats.txt	1172	0644	edit dl rm
diff-format.txt	6573	0644	edit dl rm
diff-generate-patch.txt	7253	0644	edit dl rm
diff-options.txt	32436	0644	edit dl rm
docbook-xsl.css	4557	0644	edit dl rm
everyday.html	16996	0644	edit dl rm
fetch-options.txt	12281	0644	edit dl rm
fsck-msgids.txt	4197	0644	edit dl rm
git-add.html	40369	0644	edit dl rm
git-add.txt	16164	0644	edit dl rm
git-am.html	33161	0644	edit dl rm
git-am.txt	9317	0644	edit dl rm
git-annotate.html	28391	0644	edit dl rm
git-annotate.txt	771	0644	edit dl rm
git-apply.html	33407	0644	edit dl rm
git-apply.txt	10950	0644	edit dl rm
git-archive.html	29856	0644	edit dl rm
git-archive.txt	8491	0644	edit dl rm
git-bisect-lk2009.html	81243	0644	edit dl rm
git-bisect-lk2009.txt	49694	0644	edit dl rm
git-bisect.html	40572	0644	edit dl rm
git-bisect.txt	17905	0644	edit dl rm
git-blame.html	42501	0644	edit dl rm
git-blame.txt	8732	0644	edit dl rm
git-branch.html	48253	0644	edit dl rm
git-branch.txt	15748	0644	edit dl rm
git-bugreport.html	20509	0644	edit dl rm
git-bugreport.txt	2421	0644	edit dl rm
git-bundle.html	33269	0644	edit dl rm
git-bundle.txt	11703	0644	edit dl rm
git-cat-file.html	38661	0644	edit dl rm
git-cat-file.txt	13615	0644	edit dl rm
git-check-attr.html	22633	0644	edit dl rm
git-check-attr.txt	3390	0644	edit dl rm
git-check-ignore.html	23135	0644	edit dl rm
git-check-ignore.txt	4156	0644	edit dl rm
git-check-mailmap.html	18816	0644	edit dl rm
git-check-mailmap.txt	1108	0644	edit dl rm
git-check-ref-format.html	24040	0644	edit dl rm
git-check-ref-format.txt	5034	0644	edit dl rm
git-checkout-index.html	25362	0644	edit dl rm
git-checkout-index.txt	5669	0644	edit dl rm
git-checkout.html	52719	0644	edit dl rm
git-checkout.txt	22362	0644	edit dl rm
git-cherry-pick.html	31065	0644	edit dl rm
git-cherry-pick.txt	8764	0644	edit dl rm
git-cherry.html	22423	0644	edit dl rm
git-cherry.txt	3615	0644	edit dl rm
git-clean.html	23981	0644	edit dl rm
git-clean.txt	4523	0644	edit dl rm
git-clone.html	44328	0644	edit dl rm
git-clone.txt	14772	0644	edit dl rm
git-column.html	23317	0644	edit dl rm
git-column.txt	2201	0644	edit dl rm
git-commit-graph.html	26147	0644	edit dl rm
git-commit-graph.txt	5949	0644	edit dl rm
git-commit-tree.html	26683	0644	edit dl rm
git-commit-tree.txt	2710	0644	edit dl rm
git-commit.html	57154	0644	edit dl rm
git-commit.txt	21575	0644	edit dl rm
git-config.html	415540	0644	edit dl rm
git-config.txt	19755	0644	edit dl rm
git-contacts.html	20718	0644	edit dl rm
git-contacts.txt	2584	0644	edit dl rm
git-count-objects.html	18946	0644	edit dl rm
git-count-objects.txt	1350	0644	edit dl rm
git-credential-cache--daemon.html	18182	0644	edit dl rm
git-credential-cache--daemon.txt	891	0644	edit dl rm
git-credential-cache.html	20180	0644	edit dl rm
git-credential-cache.txt	2484	0644	edit dl rm
git-credential-store.html	22043	0644	edit dl rm
git-credential-store.txt	3637	0644	edit dl rm
git-credential.html	26676	0644	edit dl rm
git-credential.txt	7327	0644	edit dl rm
git-describe.html	28268	0644	edit dl rm
git-describe.txt	8319	0644	edit dl rm
git-diagnose.html	20157	0644	edit dl rm
git-diagnose.txt	2208	0644	edit dl rm
git-diff-files.html	79130	0644	edit dl rm
git-diff-files.txt	1225	0644	edit dl rm
git-diff-index.html	84351	0644	edit dl rm
git-diff-index.txt	4811	0644	edit dl rm
git-diff-tree.html	116052	0644	edit dl rm
git-diff-tree.txt	4184	0644	edit dl rm
git-diff.html	107093	0644	edit dl rm
git-diff.txt	8039	0644	edit dl rm
git-difftool.html	27048	0644	edit dl rm
git-difftool.txt	4624	0644	edit dl rm
git-fast-export.html	31650	0644	edit dl rm
git-fast-export.txt	11282	0644	edit dl rm
git-fast-import.html	103283	0644	edit dl rm
git-fast-import.txt	59963	0644	edit dl rm
git-fetch-pack.html	23255	0644	edit dl rm
git-fetch-pack.txt	4248	0644	edit dl rm
git-fetch.html	75456	0644	edit dl rm
git-fetch.txt	11812	0644	edit dl rm
git-filter-branch.html	54648	0644	edit dl rm
git-filter-branch.txt	31031	0644	edit dl rm
git-fmt-merge-msg.html	21435	0644	edit dl rm
git-fmt-merge-msg.txt	1931	0644	edit dl rm
git-for-each-ref.html	43438	0644	edit dl rm
git-for-each-ref.txt	17073	0644	edit dl rm
git-for-each-repo.html	19296	0644	edit dl rm
git-for-each-repo.txt	1543	0644	edit dl rm
git-format-patch.html	81842	0644	edit dl rm
git-format-patch.txt	28876	0644	edit dl rm
git-fsck-objects.html	17392	0644	edit dl rm
git-fsck-objects.txt	354	0644	edit dl rm
git-fsck.html	39162	0644	edit dl rm
git-fsck.txt	5882	0644	edit dl rm
git-fsmonitor--daemon.html	22875	0644	edit dl rm
git-fsmonitor--daemon.txt	3610	0644	edit dl rm
git-gc.html	36697	0644	edit dl rm
git-gc.txt	6292	0644	edit dl rm
git-get-tar-commit-id.html	17835	0644	edit dl rm
git-get-tar-commit-id.txt	753	0644	edit dl rm
git-grep.html	36030	0644	edit dl rm
git-grep.txt	10763	0644	edit dl rm
git-hash-object.html	19939	0644	edit dl rm
git-hash-object.txt	2142	0644	edit dl rm
git-help.html	28141	0644	edit dl rm
git-help.txt	7527	0644	edit dl rm
git-hook.html	18807	0644	edit dl rm
git-hook.txt	1028	0644	edit dl rm
git-http-backend.html	30974	0644	edit dl rm
git-http-backend.txt	11472	0644	edit dl rm
git-http-fetch.html	19679	0644	edit dl rm
git-http-fetch.txt	1775	0644	edit dl rm
git-http-push.html	21391	0644	edit dl rm
git-http-push.txt	2995	0644	edit dl rm
git-imap-send.html	25472	0644	edit dl rm
git-imap-send.txt	3567	0644	edit dl rm
git-index-pack.html	24735	0644	edit dl rm
git-index-pack.txt	5205	0644	edit dl rm
git-init-db.html	17460	0644	edit dl rm
git-init-db.txt	409	0644	edit dl rm
git-init.html	26604	0644	edit dl rm
git-init.txt	5869	0644	edit dl rm
git-interpret-trailers.html	42006	0644	edit dl rm
git-interpret-trailers.txt	18579	0644	edit dl rm
git-log.html	182485	0644	edit dl rm
git-log.txt	6864	0644	edit dl rm
git-ls-files.html	35053	0644	edit dl rm
git-ls-files.txt	11622	0644	edit dl rm
git-ls-remote.html	24349	0644	edit dl rm
git-ls-remote.txt	4841	0644	edit dl rm
git-ls-tree.html	25628	0644	edit dl rm
git-ls-tree.txt	5515	0644	edit dl rm
git-mailinfo.html	23402	0644	edit dl rm
git-mailinfo.txt	3866	0644	edit dl rm
git-mailsplit.html	19264	0644	edit dl rm
git-mailsplit.txt	1342	0644	edit dl rm
git-maintenance.html	46000	0644	edit dl rm
git-maintenance.txt	18901	0644	edit dl rm
git-merge-base.html	28380	0644	edit dl rm
git-merge-base.txt	7759	0644	edit dl rm
git-merge-file.html	22656	0644	edit dl rm
git-merge-file.txt	3718	0644	edit dl rm
git-merge-index.html	20450	0644	edit dl rm
git-merge-index.txt	2445	0644	edit dl rm
git-merge-one-file.html	17416	0644	edit dl rm
git-merge-one-file.txt	387	0644	edit dl rm
git-merge-tree.html	33496	0644	edit dl rm
git-merge-tree.txt	11923	0644	edit dl rm
git-merge.html	71005	0644	edit dl rm
git-merge.txt	15068	0644	edit dl rm
git-mergetool--lib.html	19127	0644	edit dl rm
git-mergetool--lib.txt	1467	0644	edit dl rm
git-mergetool.html	39795	0644	edit dl rm
git-mergetool.txt	4473	0644	edit dl rm
git-mktag.html	19819	0644	edit dl rm
git-mktag.txt	1782	0644	edit dl rm
git-mktree.html	18474	0644	edit dl rm
git-mktree.txt	1075	0644	edit dl rm
git-multi-pack-index.html	23595	0644	edit dl rm
git-multi-pack-index.txt	4632	0644	edit dl rm
git-mv.html	20092	0644	edit dl rm
git-mv.txt	2103	0644	edit dl rm
git-name-rev.html	21670	0644	edit dl rm
git-name-rev.txt	3352	0644	edit dl rm
git-notes.html	41046	0644	edit dl rm
git-notes.txt	13866	0644	edit dl rm
git-pack-objects.html	42391	0644	edit dl rm
git-pack-objects.txt	19297	0644	edit dl rm
git-pack-redundant.html	19799	0644	edit dl rm
git-pack-redundant.txt	1876	0644	edit dl rm
git-pack-refs.html	21120	0644	edit dl rm
git-pack-refs.txt	3136	0644	edit dl rm
git-patch-id.html	20354	0644	edit dl rm
git-patch-id.txt	2430	0644	edit dl rm
git-prune-packed.html	18539	0644	edit dl rm
git-prune-packed.txt	946	0644	edit dl rm
git-prune.html	20327	0644	edit dl rm
git-prune.txt	1919	0644	edit dl rm
git-pull.html	77070	0644	edit dl rm
git-pull.txt	8354	0644	edit dl rm
git-push.html	74993	0644	edit dl rm
git-push.txt	28061	0644	edit dl rm
git-quiltimport.html	19466	0644	edit dl rm
git-quiltimport.txt	1693	0644	edit dl rm
git-range-diff.html	31673	0644	edit dl rm
git-range-diff.txt	10337	0644	edit dl rm
git-read-tree.html	39078	0644	edit dl rm
git-read-tree.txt	16897	0644	edit dl rm
git-rebase.html	98945	0644	edit dl rm
git-rebase.txt	47228	0644	edit dl rm
git-receive-pack.html	30448	0644	edit dl rm
git-receive-pack.txt	9526	0644	edit dl rm
git-reflog.html	23514	0644	edit dl rm
git-reflog.txt	4575	0644	edit dl rm
git-remote-ext.html	23012	0644	edit dl rm
git-remote-ext.txt	3977	0644	edit dl rm
git-remote-fd.html	19501	0644	edit dl rm
git-remote-fd.txt	1628	0644	edit dl rm
git-remote-helpers.html	16974	0644	edit dl rm
git-remote.html	29903	0644	edit dl rm
git-remote.txt	8768	0644	edit dl rm
git-repack.html	32819	0644	edit dl rm
git-repack.txt	11020	0644	edit dl rm
git-replace.html	24858	0644	edit dl rm
git-replace.txt	5211	0644	edit dl rm
git-request-pull.html	20295	0644	edit dl rm
git-request-pull.txt	2035	0644	edit dl rm
git-rerere.html	27040	0644	edit dl rm
git-rerere.txt	7781	0644	edit dl rm
git-reset.html	44520	0644	edit dl rm
git-reset.txt	19125	0644	edit dl rm
git-restore.html	28166	0644	edit dl rm
git-restore.txt	7082	0644	edit dl rm
git-rev-list.html	118128	0644	edit dl rm
git-rev-list.txt	3220	0644	edit dl rm
git-rev-parse.html	64641	0644	edit dl rm
git-rev-parse.txt	15840	0644	edit dl rm
git-revert.html	26792	0644	edit dl rm
git-revert.txt	5421	0644	edit dl rm
git-rm.html	27584	0644	edit dl rm
git-rm.txt	7236	0644	edit dl rm
git-send-pack.html	24576	0644	edit dl rm
git-send-pack.txt	5160	0644	edit dl rm
git-sh-i18n--envsubst.html	18166	0644	edit dl rm
git-sh-i18n--envsubst.txt	928	0644	edit dl rm
git-sh-i18n.html	18595	0644	edit dl rm
git-sh-i18n.txt	1147	0644	edit dl rm
git-sh-setup.html	21277	0644	edit dl rm
git-sh-setup.txt	2976	0644	edit dl rm
git-shell.html	21414	0644	edit dl rm
git-shell.txt	2981	0644	edit dl rm
git-shortlog.html	64618	0644	edit dl rm
git-shortlog.txt	4409	0644	edit dl rm
git-show-branch.html	26813	0644	edit dl rm
git-show-branch.txt	6589	0644	edit dl rm
git-show-index.html	19521	0644	edit dl rm
git-show-index.txt	1473	0644	edit dl rm
git-show-ref.html	26075	0644	edit dl rm
git-show-ref.txt	6648	0644	edit dl rm
git-show.html	111644	0644	edit dl rm
git-show.txt	1929	0644	edit dl rm
git-sparse-checkout.html	43949	0644	edit dl rm
git-sparse-checkout.txt	21258	0644	edit dl rm
git-stage.html	17341	0644	edit dl rm
git-stage.txt	299	0644	edit dl rm
git-stash.html	38594	0644	edit dl rm
git-stash.txt	14999	0644	edit dl rm
git-status.html	45718	0644	edit dl rm
git-status.txt	20295	0644	edit dl rm
git-stripspace.html	20016	0644	edit dl rm
git-stripspace.txt	1946	0644	edit dl rm
git-submodule.html	45581	0644	edit dl rm
git-submodule.txt	20819	0644	edit dl rm
git-subtree.html	36823	0644	edit dl rm
git-subtree.txt	13687	0644	edit dl rm
git-switch.html	33314	0644	edit dl rm
git-switch.txt	8607	0644	edit dl rm
git-symbolic-ref.html	20452	0644	edit dl rm
git-symbolic-ref.txt	2327	0644	edit dl rm
git-tag.html	38958	0644	edit dl rm
git-tag.txt	13469	0644	edit dl rm
git-tools.html	17207	0644	edit dl rm
git-tools.txt	422	0644	edit dl rm
git-unpack-file.html	17645	0644	edit dl rm
git-unpack-file.txt	434	0644	edit dl rm
git-unpack-objects.html	18811	0644	edit dl rm
git-unpack-objects.txt	1220	0644	edit dl rm
git-update-index.html	49723	0644	edit dl rm
git-update-index.txt	23928	0644	edit dl rm
git-update-ref.html	25909	0644	edit dl rm
git-update-ref.txt	6298	0644	edit dl rm
git-update-server-info.html	18255	0644	edit dl rm
git-update-server-info.txt	801	0644	edit dl rm
git-upload-archive.html	19776	0644	edit dl rm
git-upload-archive.txt	2087	0644	edit dl rm
git-upload-pack.html	21671	0644	edit dl rm
git-upload-pack.txt	2998	0644	edit dl rm
git-var.html	21537	0644	edit dl rm
git-var.txt	3176	0644	edit dl rm
git-verify-commit.html	17948	0644	edit dl rm
git-verify-commit.txt	575	0644	edit dl rm
git-verify-pack.html	18953	0644	edit dl rm
git-verify-pack.txt	1111	0644	edit dl rm
git-verify-tag.html	17941	0644	edit dl rm
git-verify-tag.txt	562	0644	edit dl rm
git-version.html	17798	0644	edit dl rm
git-version.txt	532	0644	edit dl rm
git-web--browse.html	22405	0644	edit dl rm
git-web--browse.txt	3576	0644	edit dl rm
git-whatchanged.html	18572	0644	edit dl rm
git-whatchanged.txt	1098	0644	edit dl rm
git-worktree.html	46341	0644	edit dl rm
git-worktree.txt	20985	0644	edit dl rm
git-write-tree.html	18441	0644	edit dl rm
git-write-tree.txt	1026	0644	edit dl rm
git.html	107237	0644	edit dl rm
git.txt	43254	0644	edit dl rm
gitattributes.html	82845	0644	edit dl rm
gitattributes.txt	49511	0644	edit dl rm
gitcli.html	29584	0644	edit dl rm
gitcli.txt	9697	0644	edit dl rm
gitcore-tutorial.html	100139	0644	edit dl rm
gitcore-tutorial.txt	62240	0644	edit dl rm
gitcredentials.html	31980	0644	edit dl rm
gitcredentials.txt	11317	0644	edit dl rm
gitdiffcore.html	33745	0644	edit dl rm
gitdiffcore.txt	14082	0644	edit dl rm
giteveryday.html	38092	0644	edit dl rm
giteveryday.txt	14422	0644	edit dl rm
gitfaq.html	44081	0644	edit dl rm
gitfaq.txt	21069	0644	edit dl rm
gitformat-bundle.html	21446	0644	edit dl rm
gitformat-bundle.txt	3256	0644	edit dl rm
gitformat-chunk.html	24329	0644	edit dl rm
gitformat-chunk.txt	5560	0644	edit dl rm
gitformat-commit-graph.html	28630	0644	edit dl rm
gitformat-commit-graph.txt	7857	0644	edit dl rm
gitformat-index.html	40269	0644	edit dl rm
gitformat-index.txt	15180	0644	edit dl rm
gitformat-pack.html	49811	0644	edit dl rm
gitformat-pack.txt	23509	0644	edit dl rm
gitformat-signature.html	27362	0644	edit dl rm
gitformat-signature.txt	8093	0644	edit dl rm
gitglossary.html	64201	0644	edit dl rm
gitglossary.txt	358	0644	edit dl rm
githooks.html	56500	0644	edit dl rm
githooks.txt	29331	0644	edit dl rm
gitignore.html	28399	0644	edit dl rm
gitignore.txt	8918	0644	edit dl rm
gitmailmap.html	22819	0644	edit dl rm
gitmailmap.txt	3551	0644	edit dl rm
gitmodules.html	24057	0644	edit dl rm
gitmodules.txt	4800	0644	edit dl rm
gitnamespaces.html	22148	0644	edit dl rm
gitnamespaces.txt	2509	0644	edit dl rm
gitprotocol-capabilities.html	37425	0644	edit dl rm
gitprotocol-capabilities.txt	15311	0644	edit dl rm
gitprotocol-common.html	21565	0644	edit dl rm
gitprotocol-common.txt	3177	0644	edit dl rm
gitprotocol-http.html	43234	0644	edit dl rm
gitprotocol-http.txt	17994	0644	edit dl rm
gitprotocol-pack.html	53023	0644	edit dl rm
gitprotocol-pack.txt	27678	0644	edit dl rm
gitprotocol-v2.html	59690	0644	edit dl rm
gitprotocol-v2.txt	31434	0644	edit dl rm
gitremote-helpers.html	48215	0644	edit dl rm
gitremote-helpers.txt	21785	0644	edit dl rm
gitrepository-layout.html	39352	0644	edit dl rm
gitrepository-layout.txt	11622	0644	edit dl rm
gitrevisions.html	41621	0644	edit dl rm
gitrevisions.txt	823	0644	edit dl rm
gitsubmodules.html	31699	0644	edit dl rm
gitsubmodules.txt	10366	0644	edit dl rm
gittutorial-2.html	34547	0644	edit dl rm
gittutorial-2.txt	14750	0644	edit dl rm
gittutorial.html	46263	0644	edit dl rm
gittutorial.txt	22972	0644	edit dl rm
gitworkflows.html	39869	0644	edit dl rm
gitworkflows.txt	17414	0644	edit dl rm
glossary-content.txt	32609	0644	edit dl rm
howto-index.html	22991	0644	edit dl rm
howto-index.txt	4001	0644	edit dl rm
i18n.txt	2940	0644	edit dl rm
line-range-format.txt	1162	0644	edit dl rm
line-range-options.txt	761	0644	edit dl rm
merge-options.txt	7236	0644	edit dl rm
merge-strategies.txt	6610	0644	edit dl rm
mergetools-diff.txt	1507	0644	edit dl rm
mergetools-merge.txt	2586	0644	edit dl rm
MyFirstContribution.html	90572	0644	edit dl rm
MyFirstContribution.txt	54596	0644	edit dl rm
MyFirstObjectWalk.html	60554	0644	edit dl rm
MyFirstObjectWalk.txt	28979	0644	edit dl rm
object-format-disclaimer.txt	470	0644	edit dl rm
pretty-formats.txt	15669	0644	edit dl rm
pretty-options.txt	4201	0644	edit dl rm
pull-fetch-param.txt	5476	0644	edit dl rm
README.md	3652	0644	edit dl rm
ref-reachability-filters.txt	391	0644	edit dl rm
rerere-options.txt	414	0644	edit dl rm
rev-list-description.txt	2531	0644	edit dl rm
rev-list-options.txt	46906	0644	edit dl rm
ReviewingGuidelines.html	26831	0644	edit dl rm
ReviewingGuidelines.txt	8100	0644	edit dl rm
revisions.txt	17109	0644	edit dl rm
scalar.html	26055	0644	edit dl rm
scalar.txt	6056	0644	edit dl rm
sequencer.txt	472	0644	edit dl rm
signoff-option.txt	781	0644	edit dl rm
SubmittingPatches.html	55660	0644	edit dl rm
SubmittingPatches.txt	30147	0644	edit dl rm
ToolsForGit.html	19020	0644	edit dl rm
ToolsForGit.txt	1348	0644	edit dl rm
trace2-target-values.txt	529	0644	edit dl rm
transfer-data-leaks.txt	1712	0644	edit dl rm
urls-remotes.txt	2642	0644	edit dl rm
urls.txt	3634	0644	edit dl rm
user-manual.html	275731	0644	edit dl rm
user-manual.txt	173518	0644	edit dl rm

Edit: /usr/share/doc/git/gitformat-chunk.txt (5560B)

gitformat-chunk(5)
==================

NAME
----
gitformat-chunk - Chunk-based file formats

SYNOPSIS
--------

Used by linkgit:gitformat-commit-graph[5] and the "MIDX" format (see
the pack format documentation in linkgit:gitformat-pack[5]).

DESCRIPTION
-----------

Some file formats in Git use a common concept of "chunks" to describe
sections of the file. This allows structured access to a large file by
scanning a small "table of contents" for the remaining data. This common
format is used by the `commit-graph` and `multi-pack-index` files. See
the `multi-pack-index` format in linkgit:gitformat-pack[5] and
the `commit-graph` format in linkgit:gitformat-commit-graph[5] for
how they use the chunks to describe structured data.

A chunk-based file format begins with some header information custom to
that format. That header should include enough information to identify
the file type, format version, and number of chunks in the file. From this
information, that file can determine the start of the chunk-based region.

The chunk-based region starts with a table of contents describing where
each chunk starts and ends. This consists of (C+1) rows of 12 bytes each,
where C is the number of chunks. Consider the following table:

| Chunk ID (4 bytes) | Chunk Offset (8 bytes) |
  |--------------------|------------------------|
  | ID[0]              | OFFSET[0]              |
  | ...                | ...                    |
  | ID[C]              | OFFSET[C]              |
  | 0x0000             | OFFSET[C+1]            |

Each row consists of a 4-byte chunk identifier (ID) and an 8-byte offset.
Each integer is stored in network-byte order.

The chunk identifier `ID[i]` is a label for the data stored within this
file from `OFFSET[i]` (inclusive) to `OFFSET[i+1]` (exclusive). Thus, the
size of the `i`th chunk is equal to the difference between `OFFSET[i+1]`
and `OFFSET[i]`. This requires that the chunk data appears contiguously
in the same order as the table of contents.

The final entry in the table of contents must be four zero bytes. This
confirms that the table of contents is ending and provides the offset for
the end of the chunk-based data.

Note: The chunk-based format expects that the file contains _at least_ a
trailing hash after `OFFSET[C+1]`.

Functions for working with chunk-based file formats are declared in
`chunk-format.h`. Using these methods provide extra checks that assist
developers when creating new file formats.

Writing chunk-based file formats
--------------------------------

To write a chunk-based file format, create a `struct chunkfile` by
calling `init_chunkfile()` and pass a `struct hashfile` pointer. The
caller is responsible for opening the `hashfile` and writing header
information so the file format is identifiable before the chunk-based
format begins.

Then, call `add_chunk()` for each chunk that is intended for writing. This
populates the `chunkfile` with information about the order and size of
each chunk to write. Provide a `chunk_write_fn` function pointer to
perform the write of the chunk data upon request.

Call `write_chunkfile()` to write the table of contents to the `hashfile`
followed by each of the chunks. This will verify that each chunk wrote
the expected amount of data so the table of contents is correct.

Finally, call `free_chunkfile()` to clear the `struct chunkfile` data. The
caller is responsible for finalizing the `hashfile` by writing the trailing
hash and closing the file.

Reading chunk-based file formats
--------------------------------

To read a chunk-based file format, the file must be opened as a
memory-mapped region. The chunk-format API expects that the entire file
is mapped as a contiguous memory region.

Initialize a `struct chunkfile` pointer with `init_chunkfile(NULL)`.

After reading the header information from the beginning of the file,
including the chunk count, call `read_table_of_contents()` to populate
the `struct chunkfile` with the list of chunks, their offsets, and their
sizes.

Extract the data information for each chunk using `pair_chunk()` or
`read_chunk()`:

* `pair_chunk()` assigns a given pointer with the location inside the
  memory-mapped file corresponding to that chunk's offset. If the chunk
  does not exist, then the pointer is not modified.

* `read_chunk()` takes a `chunk_read_fn` function pointer and calls it
  with the appropriate initial pointer and size information. The function
  is not called if the chunk does not exist. Use this method to read chunks
  if you need to perform immediate parsing or if you need to execute logic
  based on the size of the chunk.

After calling these methods, call `free_chunkfile()` to clear the
`struct chunkfile` data. This will not close the memory-mapped region.
Callers are expected to own that data for the timeframe the pointers into
the region are needed.

Examples
--------

These file formats use the chunk-format API, and can be used as examples
for future formats:

* *commit-graph:* see `write_commit_graph_file()` and `parse_commit_graph()`
  in `commit-graph.c` for how the chunk-format API is used to write and
  parse the commit-graph file format documented in
  the commit-graph file format in linkgit:gitformat-commit-graph[5].

* *multi-pack-index:* see `write_midx_internal()` and `load_multi_pack_index()`
  in `midx.c` for how the chunk-format API is used to write and
  parse the multi-pack-index file format documented in
  the multi-pack-index file format section of linkgit:gitformat-pack[5].

GIT
---
Part of the linkgit:git[1] suite

cmd: