diff options
author | Jonathan Nieder <jrnieder@gmail.com> | 2020-05-20 17:36:10 +0000 |
---|---|---|
committer | Junio C Hamano <gitster@pobox.com> | 2020-06-09 13:48:17 -0700 |
commit | 35e6c47404852e9c529d55a3bd374305fb08b743 (patch) | |
tree | 8232984d440a236b01f067332f748215928e10f5 /t/helper/test-dump-untracked-cache.c | |
parent | refs: improve documentation for ref iterator (diff) | |
download | tgif-35e6c47404852e9c529d55a3bd374305fb08b743.tar.xz |
reftable: file format documentation
Shawn Pearce explains:
Some repositories contain a lot of references (e.g. android at 866k,
rails at 31k). The reftable format provides:
- Near constant time lookup for any single reference, even when the
repository is cold and not in process or kernel cache.
- Near constant time verification if a SHA-1 is referred to by at least
one reference (for allow-tip-sha1-in-want).
- Efficient lookup of an entire namespace, such as `refs/tags/`.
- Support atomic push `O(size_of_update)` operations.
- Combine reflog storage with ref storage.
This file format spec was originally written in July, 2017 by Shawn
Pearce. Some refinements since then were made by Shawn and by Han-Wen
Nienhuys based on experiences implementing and experimenting with the
format. (All of this was in the context of our work at Google and
Google is happy to contribute the result to the Git project.)
Imported from JGit[1]'s current version (c217d33ff,
"Documentation/technical/reftable: improve repo layout", 2020-02-04)
of Documentation/technical/reftable.md and converted to asciidoc by
running
pandoc -t asciidoc -f markdown reftable.md >reftable.txt
using pandoc 2.2.1. The result required the following additional
minor changes:
- removed the [TOC] directive to add a table of contents, since
asciidoc does not support it
- replaced git-scm.com/docs links with linkgit: directives that link
to other pages within Git's documentation
[1] https://eclipse.googlesource.com/jgit/jgit
Signed-off-by: Jonathan Nieder <jrnieder@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 't/helper/test-dump-untracked-cache.c')
0 files changed, 0 insertions, 0 deletions