Find a file
Jeff King 0bc2557951 upload-pack: skip parse-object re-hashing of "want" objects
Imagine we have a history with commit C pointing to a large blob B.
If a client asks us for C, we can generally serve both objects to them
without accessing the uncompressed contents of B. In upload-pack, we
figure out which commits we have and what the client has, and feed those
tips to pack-objects. In pack-objects, we traverse the commits and trees
(or use bitmaps!) to find the set of objects needed, but we never open
up B. When we serve it to the client, we can often pass the compressed
bytes directly from the on-disk packfile over the wire.

But if a client asks us directly for B, perhaps because they are doing
an on-demand fetch to fill in the missing blob of a partial clone, we
end up much slower. Upload-pack calls parse_object() on the oid we
receive, which opens up the object and re-checks its hash (even though
if it were a commit, we might skip this parse entirely in favor of the
commit graph!). And then we feed the oid directly to pack-objects, which
again calls parse_object() and opens the object. And then finally, when
we write out the result, we may send bytes straight from disk, but only
after having unnecessarily uncompressed and computed the sha1 of the
object twice!

This patch teaches both code paths to use the new SKIP_HASH_CHECK flag
for parse_object(). You can see the speed-up in p5600, which does a
blob:none clone followed by a checkout. The savings for git.git are
modest:

  Test                          HEAD^             HEAD
  ----------------------------------------------------------------------
  5600.3: checkout of result    2.23(4.19+0.24)   1.72(3.79+0.18) -22.9%

But the savings scale with the number of bytes. So on a repository like
linux.git with more files, we see more improvement (in both absolute and
relative numbers):

  Test                          HEAD^                HEAD
  ----------------------------------------------------------------------------
  5600.3: checkout of result    51.62(77.26+2.76)    34.86(61.41+2.63) -32.5%

And here's an even more extreme case. This is the android gradle-plugin
repository, whose tip checkout has ~3.7GB of files:

  Test                          HEAD^               HEAD
  --------------------------------------------------------------------------
  5600.3: checkout of result    79.51(90.84+5.55)   40.28(51.88+5.67) -49.3%

Keep in mind that these timings are of the whole checkout operation. So
they count the client indexing the pack and actually writing out the
files. If we want to see just the server's view, we can hack up the
GIT_TRACE_PACKET output from those operations and replay it via
upload-pack. For the gradle example, that gives me:

  Benchmark 1: GIT_PROTOCOL=version=2 git.old upload-pack ../gradle-plugin <input
    Time (mean ± σ):     50.884 s ±  0.239 s    [User: 51.450 s, System: 1.726 s]
    Range (min … max):   50.608 s … 51.025 s    3 runs

  Benchmark 2: GIT_PROTOCOL=version=2 git.new upload-pack ../gradle-plugin <input
    Time (mean ± σ):      9.728 s ±  0.112 s    [User: 10.466 s, System: 1.535 s]
    Range (min … max):    9.618 s …  9.842 s    3 runs

  Summary
    'GIT_PROTOCOL=version=2 git.new upload-pack ../gradle-plugin <input' ran
      5.23 ± 0.07 times faster than 'GIT_PROTOCOL=version=2 git.old upload-pack ../gradle-plugin <input'

So a server would see an 80% reduction in CPU serving the initial
checkout of a partial clone for this repository. Or possibly even more
depending on the packing; most of the time spent in the faster one were
objects we had to open during the write phase.

In both cases skipping the extra hashing on the server should be pretty
safe. The client doesn't trust the server anyway, so it will re-hash all
of the objects via index-pack. There is one thing to note, though: the
change in get_reference() affects not just pack-objects, but rev-list,
git-log, etc. We could use a flag to limit to index-pack here, but we
may already skip hash checks in this instance. For commits, we'd skip
anything we load via the commit-graph. And while before this commit we
would check a blob fed directly to rev-list on the command-line, we'd
skip checking that same blob if we found it by traversing a tree.

The exception for both is if --verify-objects is used. In that case,
we'll skip this optimization, and the new test makes sure we do this
correctly.

Signed-off-by: Jeff King <peff@peff.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2022-09-07 12:20:02 -07:00
.github ci: update 'static-analysis' to Ubuntu 22.04 2022-08-24 13:02:12 -07:00
block-sha1
builtin Merge branch 'bc/gc-crontab-fix' 2022-09-05 18:33:41 -07:00
ci CI: use "GIT_TEST_SANITIZE_LEAK_LOG=true" in linux-leaks 2022-07-27 16:35:40 -07:00
compat Merge branch 'js/safe-directory-plus' into maint 2022-08-26 11:13:12 -07:00
contrib Merge branch 'jd/prompt-show-conflict' 2022-08-29 14:55:12 -07:00
Documentation The eighteenth batch 2022-09-05 18:33:41 -07:00
ewah
git-gui
gitk-git
gitweb Merge branch 'jr/gitweb-title-shortening' 2022-08-05 15:52:14 -07:00
mergetools mergetools: vimdiff: simplify tabfirst 2022-08-10 12:39:39 -07:00
negotiator
perl
po l10n: sv.po: Update Swedish translation (5367t0f0u) 2022-06-26 20:38:46 +08:00
ppc
refs
reftable reftable: drop unused parameter from reader_seek_linear() 2022-08-20 14:14:55 -07:00
sha1collisiondetection@855827c583
sha1dc
sha256 sha256: add support for Nettle 2022-07-10 14:43:34 -07:00
t upload-pack: skip parse-object re-hashing of "want" objects 2022-09-07 12:20:02 -07:00
templates
trace2 tr2: shows scope unconditionally in addition to key-value pair 2022-08-11 21:05:00 -07:00
xdiff xdiff: drop unused mmfile parameters from xdl_do_patience_diff() 2022-08-20 14:14:55 -07:00
.cirrus.yml
.clang-format
.editorconfig
.gitattributes
.gitignore builtin/diagnose.c: create 'git diagnose' builtin 2022-08-12 13:20:02 -07:00
.gitmodules
.mailmap
.tsan-suppressions
abspath.c
aclocal.m4
add-interactive.c Merge 'js/add-i-delete' into maint-2.37 2022-07-04 13:40:59 -07:00
add-interactive.h
add-patch.c
advice.c
advice.h
alias.c
alias.h
alloc.c
alloc.h
apply.c
apply.h
archive-tar.c
archive-zip.c
archive.c
archive.h
attr.c match_pathname(): drop unused "flags" parameter 2022-08-19 12:20:56 -07:00
attr.h
banned.h
base85.c
bisect.c revisions API: don't leak memory on argv elements that need free()-ing 2022-08-03 11:12:36 -07:00
bisect.h
blame.c Merge branch 'rs/mergesort' 2022-08-03 13:36:09 -07:00
blame.h
blob.c
blob.h
bloom.c commit-graph: fix corrupt upgrade from generation v1 to v2 2022-07-15 16:51:39 -07:00
bloom.h
branch.c branch: consider refs under 'update-refs' 2022-07-19 12:49:03 -07:00
branch.h Merge branch 'ds/branch-checked-out' into ds/rebase-update-ref 2022-07-12 08:38:42 -07:00
builtin.h builtin/diagnose.c: create 'git diagnose' builtin 2022-08-12 13:20:02 -07:00
bulk-checkin.c t5351: avoid relying on core.fsyncMethod = batch to be supported 2022-07-29 09:08:57 -07:00
bulk-checkin.h
bundle-uri.c bundle-uri: add support for http(s):// and file:// 2022-08-10 14:07:37 -07:00
bundle-uri.h bundle-uri: create basic file-copy logic 2022-08-10 14:07:37 -07:00
bundle.c
bundle.h
cache-tree.c verify_one_sparse(): drop unused parameters 2022-08-20 14:14:17 -07:00
cache-tree.h
cache.h Merge branch 'ds/decorate-filter-tweak' 2022-08-29 14:55:11 -07:00
cbtree.c
cbtree.h
chdir-notify.c
chdir-notify.h
check-builtins.sh
checkout.c
checkout.h
chunk-format.c
chunk-format.h
CODE_OF_CONDUCT.md
color.c
color.h
column.c
column.h
combine-diff.c Merge branch 'rs/combine-diff-with-incompatible-options' into maint 2022-07-27 13:00:32 -07:00
command-list.txt docs: move http-protocol docs to man section 5 2022-08-04 14:12:24 -07:00
commit-graph.c Merge branch 'tb/commit-graph-genv2-upgrade-fix' into maint 2022-08-10 21:52:35 -07:00
commit-graph.h Merge branch 'tb/commit-graph-genv2-upgrade-fix' 2022-08-03 13:36:08 -07:00
commit-reach.c
commit-reach.h
commit-slab-decl.h
commit-slab-impl.h
commit-slab.h
commit.c Merge branch 'rs/mergesort' 2022-08-03 13:36:09 -07:00
commit.h
common-main.c
config.c config.c: NULL check when reading protected config 2022-07-26 23:46:01 -07:00
config.h config: learn git_protected_config() 2022-07-14 15:08:29 -07:00
config.mak.dev config.mak.dev: squelch -Wno-missing-braces for older gcc 2022-07-31 11:50:07 -07:00
config.mak.in
config.mak.uname mingw: remove unneeded NO_CURL directive 2022-07-29 09:48:17 -07:00
configure.ac
connect.c
connect.h
connected.c
connected.h
convert.c
convert.h checkout: fix two bugs on the final count of updated entries 2022-07-14 10:19:28 -07:00
copy.c
COPYING
credential.c
credential.h
csum-file.c
csum-file.h
ctype.c
daemon.c daemon: clarify directory arguments 2022-07-19 12:45:31 -07:00
date.c
date.h
decorate.c
decorate.h
delta-islands.c
delta-islands.h
delta.h
detect-compiler
diagnose.c builtin/diagnose.c: add '--mode' option 2022-08-12 13:20:02 -07:00
diagnose.h builtin/diagnose.c: add '--mode' option 2022-08-12 13:20:02 -07:00
diff-delta.c
diff-lib.c oneway_diff: handle removed sparse directories 2022-08-08 13:21:49 -07:00
diff-merges.c
diff-merges.h
diff-no-index.c
diff.c parse-options: PARSE_OPT_KEEP_UNKNOWN only applies to --options 2022-08-19 11:13:14 -07:00
diff.h
diffcore-break.c
diffcore-delta.c
diffcore-order.c
diffcore-pickaxe.c
diffcore-rename.c
diffcore-rotate.c
diffcore.h
dir-iterator.c
dir-iterator.h
dir.c match_pathname(): drop unused "flags" parameter 2022-08-19 12:20:56 -07:00
dir.h match_pathname(): drop unused "flags" parameter 2022-08-19 12:20:56 -07:00
editor.c
entry.c checkout: fix two bugs on the final count of updated entries 2022-07-14 10:19:28 -07:00
entry.h checkout: fix two bugs on the final count of updated entries 2022-07-14 10:19:28 -07:00
environment.c refs: use ref_namespaces for replace refs base 2022-08-05 14:13:12 -07:00
environment.h
exec-cmd.c
exec-cmd.h
fetch-negotiator.c
fetch-negotiator.h
fetch-pack.c fetch-pack: add tracing for negotiation rounds 2022-08-15 09:17:03 -07:00
fetch-pack.h
fmt-merge-msg.c
fmt-merge-msg.h
fsck.c fsck: actually detect bad file modes in trees 2022-08-10 14:26:27 -07:00
fsck.h fsck: downgrade tree badFilemode to "info" 2022-08-10 14:26:29 -07:00
fsmonitor--daemon.h
fsmonitor-ipc.c
fsmonitor-ipc.h
fsmonitor-settings.c
fsmonitor-settings.h
fsmonitor.c
fsmonitor.h
fuzz-commit-graph.c commit-graph: pass repo_settings instead of repository 2022-07-14 15:42:17 -07:00
fuzz-pack-headers.c
fuzz-pack-idx.c
generate-cmdlist.sh
generate-configlist.sh
generate-hooklist.sh
gettext.c
gettext.h
git-add--interactive.perl
git-archimport.perl
git-bisect.sh
git-compat-util.h Merge branch 'vd/scalar-generalize-diagnose' 2022-08-25 14:42:32 -07:00
git-curl-compat.h
git-cvsexportcommit.perl
git-cvsimport.perl
git-cvsserver.perl git-cvsserver: clarify directory list 2022-07-19 12:45:31 -07:00
git-difftool--helper.sh
git-filter-branch.sh
git-instaweb.sh git-sh-setup.sh: remove "say" function, change last users 2022-06-28 13:13:18 -07:00
git-merge-octopus.sh
git-merge-one-file.sh
git-merge-resolve.sh merge-resolve: abort if index does not match HEAD 2022-07-22 21:45:22 -07:00
git-mergetool--lib.sh
git-mergetool.sh
git-p4.py Merge branch 'kk/p4-client-name-encoding-fix' into maint 2022-08-10 21:52:33 -07:00
git-quiltimport.sh
git-request-pull.sh
git-send-email.perl
git-sh-i18n.sh
git-sh-setup.sh git-sh-setup.sh: remove "say" function, change last users 2022-06-28 13:13:18 -07:00
git-submodule.sh git-submodule.sh: use "$quiet", not "$GIT_QUIET" 2022-06-28 13:13:18 -07:00
git-svn.perl
GIT-VERSION-GEN Git 2.37.3 2022-08-30 10:22:10 -07:00
git-web--browse.sh
git.c Merge branch 'sg/parse-options-subcommand' 2022-09-01 13:40:18 -07:00
git.rc
gpg-interface.c gpg-interface: add function for converting trust level to string 2022-07-10 22:10:23 -07:00
gpg-interface.h gpg-interface: add function for converting trust level to string 2022-07-10 22:10:23 -07:00
graph.c
graph.h
grep.c grep: add --max-count command line option 2022-06-22 13:23:29 -07:00
grep.h grep: add --max-count command line option 2022-06-22 13:23:29 -07:00
hash-lookup.c
hash-lookup.h
hash.h sha256: add support for Nettle 2022-07-10 14:43:34 -07:00
hashmap.c
hashmap.h
help.c git docs: add a category for file formats, protocols and interfaces 2022-08-04 14:12:23 -07:00
help.h git docs: add a category for file formats, protocols and interfaces 2022-08-04 14:12:23 -07:00
hex.c
hook.c Merge branch 'ab/hooks-regression-fix' into maint 2022-08-26 11:13:12 -07:00
hook.h
http-backend.c
http-fetch.c
http-push.c
http-walker.c
http.c Merge branch 'll/curl-accept-language' 2022-07-19 16:40:19 -07:00
http.h remote-curl: send Accept-Language header to server 2022-07-11 12:24:28 -07:00
ident.c ident: rename commit_rewrite_person() to apply_mailmap_to_header() 2022-07-18 12:55:53 -07:00
imap-send.c
INSTALL
iterator.h
json-writer.c
json-writer.h
khash.h
kwset.c
kwset.h
levenshtein.c
levenshtein.h
LGPL-2.1
line-log.c
line-log.h
line-range.c
line-range.h
linear-assignment.c
linear-assignment.h
list-objects-filter-options.c
list-objects-filter-options.h
list-objects-filter.c
list-objects-filter.h
list-objects.c
list-objects.h
list.h
ll-merge.c
ll-merge.h
lockfile.c
lockfile.h
log-tree.c Merge branch 'jk/unused-fixes' 2022-08-29 14:55:12 -07:00
log-tree.h
ls-refs.c
ls-refs.h
mailinfo.c
mailinfo.h
mailmap.c
mailmap.h
Makefile Merge branch 'ds/bundle-uri-clone' 2022-09-01 13:40:17 -07:00
match-trees.c
mem-pool.c
mem-pool.h
merge-blobs.c
merge-blobs.h
merge-ort-wrappers.c merge-ort-wrappers: make printed message match the one from recursive 2022-07-22 21:45:22 -07:00
merge-ort-wrappers.h
merge-ort.c Merge branch 'en/ort-unused-code-removal' 2022-08-29 14:55:14 -07:00
merge-ort.h merge-ort: optionally produce machine-readable output 2022-06-22 16:10:06 -07:00
merge-recursive.c
merge-recursive.h
merge.c
mergesort.h mergesort: remove llist_mergesort() 2022-07-17 15:20:39 -07:00
midx.c Merge branch 'ac/bitmap-lookup-table' 2022-09-05 18:33:39 -07:00
midx.h pack-bitmap-write: learn pack.writeBitmapLookupTable and add tests 2022-08-26 10:13:54 -07:00
name-hash.c
notes-cache.c
notes-cache.h
notes-merge.c
notes-merge.h
notes-utils.c
notes-utils.h
notes.c refs: add array of ref namespaces 2022-08-05 14:13:12 -07:00
notes.h
object-file.c Merge branch 'hx/unpack-streaming' 2022-07-14 15:03:59 -07:00
object-name.c
object-store.h
object.c parse_object(): allow skipping hash check 2022-09-07 12:18:57 -07:00
object.h parse_object(): allow skipping hash check 2022-09-07 12:18:57 -07:00
oid-array.c oid_pos(): access table through const pointers 2021-01-28 12:03:26 -08:00
oid-array.h
oidmap.c
oidmap.h
oidset.c
oidset.h
oidtree.c
oidtree.h
pack-bitmap-write.c pack-bitmap-write: drop unused pack_idx_entry parameters 2022-08-28 13:23:37 -07:00
pack-bitmap.c pack-bitmap: prepare to read lookup table extension 2022-08-26 10:13:58 -07:00
pack-bitmap.h pack-bitmap: prepare to read lookup table extension 2022-08-26 10:13:58 -07:00
pack-check.c
pack-mtimes.c
pack-mtimes.h
pack-objects.c
pack-objects.h pack-objects.h: remove outdated pahole results 2022-06-28 15:39:03 -07:00
pack-revindex.c
pack-revindex.h docs: move pack format docs to man section 5 2022-08-04 14:12:24 -07:00
pack-write.c
pack.h
packfile.c Merge branch 'jk/is-promisor-object-keep-tree-in-use' 2022-08-25 14:42:31 -07:00
packfile.h
pager.c
parallel-checkout.c checkout: fix two bugs on the final count of updated entries 2022-07-14 10:19:28 -07:00
parallel-checkout.h checkout: fix two bugs on the final count of updated entries 2022-07-14 10:19:28 -07:00
parse-options-cb.c
parse-options.c parse-options: add support for parsing subcommands 2022-08-19 11:13:14 -07:00
parse-options.h parse-options: add support for parsing subcommands 2022-08-19 11:13:14 -07:00
patch-delta.c
patch-ids.c
patch-ids.h
path.c
path.h
pathspec.c pathspec.h: move pathspec_needs_expanded_index() from reset.c to here 2022-08-08 13:23:26 -07:00
pathspec.h pathspec.h: move pathspec_needs_expanded_index() from reset.c to here 2022-08-08 13:23:26 -07:00
pkt-line.c t0021: implementation the rot13-filter.pl script in C 2022-08-14 22:57:12 -07:00
pkt-line.h Merge branch 'mt/rot13-in-c' 2022-08-29 14:55:11 -07:00
preload-index.c preload-index: fix memleak 2022-08-22 15:08:30 -07:00
pretty.c gpg-interface: add function for converting trust level to string 2022-07-10 22:10:23 -07:00
pretty.h
prio-queue.c
prio-queue.h
progress.c
progress.h
promisor-remote.c Merge branch 'sg/xcalloc-cocci-fix' 2022-08-29 14:55:14 -07:00
promisor-remote.h
prompt.c
prompt.h
protocol-caps.c
protocol-caps.h
protocol.c
protocol.h
prune-packed.c
prune-packed.h
quote.c
quote.h
range-diff.c
range-diff.h
reachable.c
reachable.h
read-cache.c Merge branch 'vd/sparse-reset-checkout-fixes' into maint 2022-08-26 11:13:13 -07:00
README.md
rebase-interactive.c sequencer: rewrite update-refs as user edits todo list 2022-07-19 12:49:04 -07:00
rebase-interactive.h
rebase.c
rebase.h
ref-filter.c ref-filter: disable save_commit_buffer while traversing 2022-07-11 14:27:31 -07:00
ref-filter.h
reflog-walk.c
reflog-walk.h
reflog.c
reflog.h
refs.c refs: use ref_namespaces for replace refs base 2022-08-05 14:13:12 -07:00
refs.h refs: add array of ref namespaces 2022-08-05 14:13:12 -07:00
refspec.c
refspec.h docs: move protocol-related docs to man section 5 2022-08-04 14:12:23 -07:00
RelNotes A handful more topics from the 'master' front for 2.37.3 2022-08-26 11:13:13 -07:00
remote-curl.c remote-curl: add 'get' capability 2022-08-10 14:07:37 -07:00
remote.c Merge branch 'ab/plug-revisions-leak' 2022-08-12 13:19:08 -07:00
remote.h Merge branch 'rs/mergesort' 2022-08-03 13:36:09 -07:00
replace-object.c
replace-object.h
repo-settings.c commit-graph: pass repo_settings instead of repository 2022-07-14 15:42:17 -07:00
repository.c
repository.h commit-graph: pass repo_settings instead of repository 2022-07-14 15:42:17 -07:00
rerere.c
rerere.h
reset.c
reset.h
resolve-undo.c
resolve-undo.h
revision.c upload-pack: skip parse-object re-hashing of "want" objects 2022-09-07 12:20:02 -07:00
revision.h revision: allow --ancestry-path to take an argument 2022-08-19 10:45:08 -07:00
run-command.c pipe_command(): mark stdin descriptor as non-blocking 2022-08-17 09:21:41 -07:00
run-command.h
SECURITY.md
send-pack.c send-pack.c: add config push.useBitmaps 2022-06-17 14:31:01 -07:00
send-pack.h send-pack.c: add config push.useBitmaps 2022-06-17 14:31:01 -07:00
sequencer.c sequencer: do not translate command names 2022-08-19 13:46:37 -07:00
sequencer.h sequencer: rewrite update-refs as user edits todo list 2022-07-19 12:49:04 -07:00
serve.c
serve.h
server-info.c
setup.c Merge branch 'js/safe-directory-plus' into maint 2022-08-26 11:13:12 -07:00
sh-i18n--envsubst.c
sha1dc_git.c
sha1dc_git.h
shallow.c
shallow.h
shared.mak cocci: add a "coccicheck-test" target and test *.cocci rules 2022-07-06 12:24:43 -07:00
shell.c
shortlog.h
sideband.c
sideband.h
sigchain.c
sigchain.h
simple-ipc.h
sparse-index.c
sparse-index.h
split-index.c
split-index.h
stable-qsort.c
strbuf.c
strbuf.h
streaming.c
streaming.h
string-list.c
string-list.h
strmap.c
strmap.h
strvec.c
strvec.h
sub-process.c
sub-process.h
submodule-config.c i18n: fix mismatched camelCase config variables 2022-06-17 10:38:26 -07:00
submodule-config.h
submodule.c Merge branch 'ab/leakfix' 2022-07-18 13:31:54 -07:00
submodule.h
symlinks.c
tag.c
tag.h
tar.h
tempfile.c tempfile: avoid directory cleanup race 2022-08-27 10:17:46 -07:00
tempfile.h tempfile: avoid directory cleanup race 2022-08-27 10:17:46 -07:00
thread-utils.c
thread-utils.h
tmp-objdir.c
tmp-objdir.h
trace.c
trace.h
trace2.c
trace2.h
trailer.c
trailer.h
transport-helper.c
transport-internal.h
transport.c transport.c: avoid "whitelist" 2022-07-19 12:45:31 -07:00
transport.h
tree-diff.c
tree-walk.c tree-walk: add a mechanism for getting non-canonicalized modes 2022-08-10 14:26:25 -07:00
tree-walk.h tree-walk: add a mechanism for getting non-canonicalized modes 2022-08-10 14:26:25 -07:00
tree.c
tree.h
unicode-width.h
unimplemented.sh
unix-socket.c
unix-socket.h
unix-stream-server.c
unix-stream-server.h
unpack-trees.c Merge branch 'vd/sparse-reset-checkout-fixes' into maint 2022-08-26 11:13:13 -07:00
unpack-trees.h
upload-pack.c upload-pack: skip parse-object re-hashing of "want" objects 2022-09-07 12:20:02 -07:00
upload-pack.h
url.c
url.h
urlmatch.c
urlmatch.h
usage.c i18n: mark message helpers prefix for translation 2022-06-21 10:06:54 -07:00
userdiff.c
userdiff.h
utf8.c
utf8.h
varint.c
varint.h
version.c
version.h
versioncmp.c
walker.c
walker.h
wildmatch.c
wildmatch.h
worktree.c
worktree.h
wrap-for-bin.sh
wrapper.c Merge branch 'jk/pipe-command-nonblock' 2022-08-25 14:42:32 -07:00
write-or-die.c
ws.c
wt-status.c
wt-status.h
xdiff-interface.c
xdiff-interface.h
zlib.c

Build status

Git - fast, scalable, distributed revision control system

Git is a fast, scalable, distributed revision control system with an unusually rich command set that provides both high-level operations and full access to internals.

Git is an Open Source project covered by the GNU General Public License version 2 (some parts of it are under different licenses, compatible with the GPLv2). It was originally written by Linus Torvalds with help of a group of hackers around the net.

Please read the file INSTALL for installation instructions.

Many Git online resources are accessible from https://git-scm.com/ including full documentation and Git related tools.

See Documentation/gittutorial.txt to get started, then see Documentation/giteveryday.txt for a useful minimum set of commands, and Documentation/git-<commandname>.txt for documentation of each command. If git has been correctly installed, then the tutorial can also be read with man gittutorial or git help tutorial, and the documentation of each command with man git-<commandname> or git help <commandname>.

CVS users may also want to read Documentation/gitcvs-migration.txt (man gitcvs-migration or git help cvs-migration if git is installed).

The user discussion and development of Git take place on the Git mailing list -- everyone is welcome to post bug reports, feature requests, comments and patches to git@vger.kernel.org (read Documentation/SubmittingPatches for instructions on patch submission and Documentation/CodingGuidelines).

Those wishing to help with error message, usage and informational message string translations (localization l10) should see po/README.md (a po file is a Portable Object file that holds the translations).

To subscribe to the list, send an email with just "subscribe git" in the body to majordomo@vger.kernel.org (not the Git list). The mailing list archives are available at https://lore.kernel.org/git/, http://marc.info/?l=git and other archival sites.

Issues which are security relevant should be disclosed privately to the Git Security mailing list git-security@googlegroups.com.

The maintainer frequently sends the "What's cooking" reports that list the current status of various development topics to the mailing list. The discussion following them give a good reference for project status, development direction and remaining tasks.

The name "git" was given by Linus Torvalds when he wrote the very first version. He described the tool as "the stupid content tracker" and the name as (depending on your mood):

  • random three-letter combination that is pronounceable, and not actually used by any common UNIX command. The fact that it is a mispronunciation of "get" may or may not be relevant.
  • stupid. contemptible and despicable. simple. Take your pick from the dictionary of slang.
  • "global information tracker": you're in a good mood, and it actually works for you. Angels sing, and a light suddenly fills the room.
  • "goddamn idiotic truckload of sh*t": when it breaks