Go to file
Jeff King 2d86a96220 t: avoid sed-based chain-linting in some expensive cases
Commit 878f988350 (t/test-lib: teach --chain-lint to detect broken
&&-chains in subshells, 2018-07-11) introduced additional chain-lint
tests which add an extra "sed" pipeline to each test we run. This has a
measurable impact on runtime. Here are timings with and without a new
environment variable (added by this patch) that lets you disable just
the additional sed-based chain-lint tests:

  Benchmark #1: GIT_TEST_CHAIN_LINT_HARDER=1 make test
    Time (mean ± σ):     64.202 s ±  1.030 s    [User: 622.469 s, System: 301.402 s]
    Range (min … max):   61.571 s … 65.662 s    10 runs

  Benchmark #2: GIT_TEST_CHAIN_LINT_HARDER=0 make test
    Time (mean ± σ):     57.591 s ±  0.333 s    [User: 529.368 s, System: 270.618 s]
    Range (min … max):   57.143 s … 58.309 s    10 runs

  Summary
    'GIT_TEST_CHAIN_LINT_HARDER=0 make test' ran
      1.11 ± 0.02 times faster than 'GIT_TEST_CHAIN_LINT_HARDER=1 make test'

Of course those extra lint checks are doing something useful, so paying
a few extra seconds (at least on Linux) isn't so bad (though note the
CPU time; we're bounded in our parallel run here by the slowest test, so
it really is ~120s of CPU improvement).

But we can observe that there are some test scripts where they produce a
much stronger effect, and provide less value. In t0027 and t3070 we run
a very large number of small tests, all driven by a series of
functions/loops which are filling in the test bodies. There we get much
less bang for our buck in terms of bug-finding versus CPU cost.

This patch introduces a mechanism for controlling when those extra
lint checks are run, at two levels:

  - a user can ask to disable or to force-enable the checks by setting
    GIT_TEST_CHAIN_LINT_HARDER

  - if the user hasn't specified a preference, individual scripts can
    disable the checks by setting GIT_TEST_CHAIN_LINT_HARDER_DEFAULT;
    scripts which don't set that get the current behavior of enabling
    them.

In addition, this patch flips the default for t0027 and t3070's
mass-generated sections to disable the extra checks. Here are the timing
results for t0027:

  Benchmark #1: GIT_TEST_CHAIN_LINT_HARDER=1 ./t0027-auto-crlf.sh
    Time (mean ± σ):     17.078 s ±  0.848 s    [User: 14.878 s, System: 7.075 s]
    Range (min … max):   15.952 s … 18.421 s    10 runs

  Benchmark #2: GIT_TEST_CHAIN_LINT_HARDER=0 ./t0027-auto-crlf.sh
    Time (mean ± σ):      9.063 s ±  0.759 s    [User: 7.890 s, System: 3.362 s]
    Range (min … max):    7.747 s … 10.619 s    10 runs

  Benchmark #3: ./t0027-auto-crlf.sh
    Time (mean ± σ):      9.186 s ±  0.881 s    [User: 7.957 s, System: 3.427 s]
    Range (min … max):    7.796 s … 10.498 s    10 runs

  Summary
    'GIT_TEST_CHAIN_LINT_HARDER=0 ./t0027-auto-crlf.sh' ran
      1.01 ± 0.13 times faster than './t0027-auto-crlf.sh'
      1.88 ± 0.18 times faster than 'GIT_TEST_CHAIN_LINT_HARDER=1 ./t0027-auto-crlf.sh'

We can see that disabling the checks for the whole script buys us an
almost 2x speedup. But the new default behavior, disabling them only for
the mass-generated part, gets us most of that speedup (but still leaves
the checks on for further manual tests people might write).

  As a side note, I'd caution about comparing runtimes and CPU seconds
  between this timing and the earlier "make test" one. In "make test",
  we're running a lot of scripts in parallel, so the CPU is throttling
  down (and thus a CPU second saved here would count for more during a
  parallel run; the same work takes more CPU seconds there).

We get similar results for t3070:

  Benchmark #1: GIT_TEST_CHAIN_LINT_HARDER=1 ./t3070-wildmatch.sh
    Time (mean ± σ):     20.054 s ±  3.967 s    [User: 16.003 s, System: 8.286 s]
    Range (min … max):   11.891 s … 23.671 s    10 runs

  Benchmark #2: GIT_TEST_CHAIN_LINT_HARDER=0 ./t3070-wildmatch.sh
    Time (mean ± σ):     12.399 s ±  2.256 s    [User: 7.542 s, System: 5.342 s]
    Range (min … max):    9.606 s … 15.727 s    10 runs

  Benchmark #3: ./t3070-wildmatch.sh
    Time (mean ± σ):     10.726 s ±  3.476 s    [User: 6.790 s, System: 4.365 s]
    Range (min … max):    5.444 s … 15.376 s    10 runs

  Summary
    './t3070-wildmatch.sh' ran
      1.16 ± 0.43 times faster than 'GIT_TEST_CHAIN_LINT_HARDER=0 ./t3070-wildmatch.sh'
      1.87 ± 0.71 times faster than 'GIT_TEST_CHAIN_LINT_HARDER=1 ./t3070-wildmatch.sh'

Again, we get almost a 2x speedup disabling these. In this case, there
are no tests not covered by the script's "default to disable" behavior,
so the second two benchmarks should be the same (and while they do
differ, you can see the variance is quite high but they're within one
standard deviation).

So it seems like for these two scripts, at least, disabling the extra
checks is a reasonable tradeoff. Sadly, the overall runtime of "make
test" on my system doesn't get much faster. But that's because we're
mostly limited by the cost of the single biggest test. Here are the
top-5 tests by wall-clock time from a parallel run, before my patch:

  57.9192368984222 t9001-send-email.sh
  45.6329638957977 t0027-auto-crlf.sh
  32.5278220176697 t3070-wildmatch.sh
  22.2701289653778 t7610-mergetool.sh
  20.8635759353638 t1701-racy-split-index.sh

And after:

  57.1476998329163 t9001-send-email.sh
  33.776211977005 t0027-auto-crlf.sh
  21.3116669654846 t7610-mergetool.sh
  20.7748689651489 t1701-racy-split-index.sh
  19.6957249641418 t7112-reset-submodule.sh

We dropped 12s from t0027, and t3070 dropped off our list entirely at
around 16s. In both cases we're bound by t9001, but its slowness is
due to the actual tests, so we'll have to deal with it in a different
way. But this reduces overall CPU, and means that dealing with t9001 (by
improving the speed of send-email or splitting it apart) will let us
reduce our overall runtime even on multi-core machines.

Signed-off-by: Jeff King <peff@peff.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2021-05-13 15:50:44 +09:00
.github Merge branch 'tb/ci-run-cocci-with-18.04' into maint 2021-02-11 13:57:36 -08:00
Documentation Git 2.31.1 2021-03-26 14:49:41 -07:00
block-sha1 block-sha1: drop trailing semicolon from macro definition 2021-03-17 10:20:01 -07:00
builtin Merge branch 'tb/git-mv-icase-fix' 2021-03-19 15:25:40 -07:00
ci Merge branch 'tb/pack-revindex-on-disk' 2021-02-12 14:21:04 -08:00
compat Sync with Git 2.30.2 for CVE-2021-21300 2021-03-08 16:09:07 -08:00
contrib Merge branch 'rs/xcalloc-takes-nelem-first' 2021-03-19 15:25:39 -07:00
ewah use CALLOC_ARRAY 2021-03-13 16:00:09 -08:00
git-gui Merge https://github.com/prati0100/git-gui 2021-03-04 12:38:50 -08:00
gitk-git
gitweb
mergetools mergetools/vimdiff: add vimdiff1 merge tool variant 2021-02-23 11:37:13 -08:00
negotiator use CALLOC_ARRAY 2021-03-13 16:00:09 -08:00
perl
po l10n: zh_CN: for git v2.31.0 l10n round 1 and 2 2021-03-15 00:05:25 +08:00
ppc
refs use CALLOC_ARRAY 2021-03-13 16:00:09 -08:00
sha1collisiondetection@855827c583
sha1dc
sha256
t t: avoid sed-based chain-linting in some expensive cases 2021-05-13 15:50:44 +09:00
templates
trace2
xdiff
.cirrus.yml
.clang-format
.editorconfig
.gitattributes
.gitignore
.gitmodules
.mailmap
.travis.yml
.tsan-suppressions
CODE_OF_CONDUCT.md
COPYING
GIT-VERSION-GEN Git 2.31.1 2021-03-26 14:49:41 -07:00
INSTALL
LGPL-2.1
Makefile Makefile: update 'make fuzz-all' docs to reflect modern clang 2021-03-08 10:26:25 -08:00
README.md
RelNotes Git 2.31.1 2021-03-26 14:49:41 -07:00
abspath.c
aclocal.m4
add-interactive.c Merge branch 'rs/xcalloc-takes-nelem-first' 2021-03-19 15:25:39 -07:00
add-interactive.h
add-patch.c
advice.c
advice.h
alias.c
alias.h
alloc.c
alloc.h
apply.c use CALLOC_ARRAY 2021-03-13 16:00:09 -08:00
apply.h
archive-tar.c use CALLOC_ARRAY 2021-03-13 16:00:09 -08:00
archive-zip.c
archive.c
archive.h
attr.c use CALLOC_ARRAY 2021-03-13 16:00:09 -08:00
attr.h
banned.h
base85.c
bisect.c use CALLOC_ARRAY 2021-03-13 16:00:09 -08:00
bisect.h
blame.c use CALLOC_ARRAY 2021-03-13 16:00:09 -08:00
blame.h
blob.c
blob.h
bloom.c use CALLOC_ARRAY 2021-03-13 16:00:09 -08:00
bloom.h
branch.c
branch.h
builtin.h
bulk-checkin.c use CALLOC_ARRAY 2021-03-13 16:00:09 -08:00
bulk-checkin.h
bundle.c
bundle.h
cache-tree.c use CALLOC_ARRAY 2021-03-13 16:00:09 -08:00
cache-tree.h
cache.h Sync with Git 2.30.2 for CVE-2021-21300 2021-03-08 16:09:07 -08:00
chdir-notify.c
chdir-notify.h
check-builtins.sh
check_bindir
checkout.c
checkout.h
chunk-format.c chunk-format: restore duplicate chunk checks 2021-02-18 13:38:16 -08:00
chunk-format.h chunk-format: create read chunk API 2021-02-18 13:38:16 -08:00
color.c
color.h
column.c
column.h
combine-diff.c use CALLOC_ARRAY 2021-03-13 16:00:09 -08:00
command-list.txt
commit-graph.c use CALLOC_ARRAY 2021-03-13 16:00:09 -08:00
commit-graph.h
commit-reach.c use CALLOC_ARRAY 2021-03-13 16:00:09 -08:00
commit-reach.h
commit-slab-decl.h
commit-slab-impl.h
commit-slab.h
commit.c use CALLOC_ARRAY 2021-03-13 16:00:09 -08:00
commit.h Merge branch 'bc/signed-objects-with-both-hashes' 2021-02-22 16:12:42 -08:00
common-main.c
config.c use CALLOC_ARRAY 2021-03-13 16:00:09 -08:00
config.h
config.mak.dev
config.mak.in
config.mak.uname Merge branch 'jk/open-returns-eintr' 2021-03-04 15:34:45 -08:00
configure.ac
connect.c Merge branch 'jt/clone-unborn-head' 2021-02-17 17:21:40 -08:00
connect.h
connected.c
connected.h
convert.c use CALLOC_ARRAY 2021-03-13 16:00:09 -08:00
convert.h
copy.c
credential.c
credential.h
csum-file.c
csum-file.h
ctype.c
daemon.c use CALLOC_ARRAY 2021-03-13 16:00:09 -08:00
date.c
decorate.c use CALLOC_ARRAY 2021-03-13 16:00:09 -08:00
decorate.h
delta-islands.c
delta-islands.h
delta.h
detect-compiler
diff-delta.c
diff-lib.c
diff-merges.c
diff-merges.h
diff-no-index.c
diff.c use CALLOC_ARRAY 2021-03-13 16:00:09 -08:00
diff.h Merge branch 'jc/diffcore-rotate' 2021-02-25 16:43:30 -08:00
diffcore-break.c
diffcore-delta.c
diffcore-order.c
diffcore-pickaxe.c
diffcore-rename.c use CALLOC_ARRAY 2021-03-13 16:00:09 -08:00
diffcore-rotate.c diff: --{rotate,skip}-to=<path> 2021-02-16 09:30:42 -08:00
diffcore.h diff: --{rotate,skip}-to=<path> 2021-02-16 09:30:42 -08:00
dir-iterator.c
dir-iterator.h
dir.c use CALLOC_ARRAY 2021-03-13 16:00:09 -08:00
dir.h
editor.c
entry.c write_entry(): fix misuses of `path` in error messages 2021-02-16 11:27:17 -08:00
environment.c
environment.h
exec-cmd.c
exec-cmd.h
fetch-negotiator.c
fetch-negotiator.h
fetch-pack.c use CALLOC_ARRAY 2021-03-13 16:00:09 -08:00
fetch-pack.h
fmt-merge-msg.c use CALLOC_ARRAY 2021-03-13 16:00:09 -08:00
fmt-merge-msg.h
fsck.c Merge branch 'jt/transfer-fsck-across-packs' 2021-03-01 14:02:57 -08:00
fsck.h Merge branch 'jt/transfer-fsck-across-packs' 2021-03-01 14:02:57 -08:00
fsmonitor.c Merge branch 'jh/fsmonitor-prework' 2021-03-19 15:25:37 -07:00
fsmonitor.h fsmonitor: log invocation of FSMonitor hook to trace2 2021-02-16 17:14:34 -08:00
fuzz-commit-graph.c
fuzz-pack-headers.c
fuzz-pack-idx.c
generate-cmdlist.sh
generate-configlist.sh
gettext.c Merge branch 'ab/detox-gettext-tests' 2021-02-10 14:48:33 -08:00
gettext.h
git-add--interactive.perl
git-archimport.perl
git-bisect.sh
git-compat-util.h git-compat-util.h: drop trailing semicolon from macro definition 2021-03-13 15:56:13 -08:00
git-cvsexportcommit.perl
git-cvsimport.perl
git-cvsserver.perl
git-difftool--helper.sh
git-filter-branch.sh
git-instaweb.sh
git-merge-octopus.sh
git-merge-one-file.sh
git-merge-resolve.sh
git-mergetool--lib.sh Merge branch 'sh/mergetool-hideresolved' 2021-02-17 17:21:41 -08:00
git-mergetool.sh mergetool: do not enable hideResolved by default 2021-03-13 15:30:29 -08:00
git-p4.py
git-quiltimport.sh
git-rebase--preserve-merges.sh
git-request-pull.sh
git-send-email.perl
git-sh-i18n.sh
git-sh-setup.sh
git-submodule.sh
git-svn.perl
git-web--browse.sh
git.c Merge branch 'tb/precompose-prefix-too' 2021-02-12 14:21:04 -08:00
git.rc
gpg-interface.c gpg-interface: remove other signature headers before verifying 2021-02-10 23:35:42 -08:00
gpg-interface.h gpg-interface: improve interface for parsing tags 2021-02-10 23:35:42 -08:00
graph.c
graph.h
grep.c use CALLOC_ARRAY 2021-03-13 16:00:09 -08:00
grep.h Merge branch 'ab/grep-pcre-invalid-utf8' 2021-02-10 14:48:33 -08:00
hash-lookup.c
hash-lookup.h
hash.h
hashmap.c use CALLOC_ARRAY 2021-03-13 16:00:09 -08:00
hashmap.h
help.c
help.h
hex.c
http-backend.c use CALLOC_ARRAY 2021-03-13 16:00:09 -08:00
http-fetch.c http-fetch: allow custom index-pack args 2021-02-22 12:07:40 -08:00
http-push.c use CALLOC_ARRAY 2021-03-13 16:00:09 -08:00
http-walker.c
http.c use CALLOC_ARRAY 2021-03-13 16:00:09 -08:00
http.h http: allow custom index-pack args 2021-02-22 12:07:40 -08:00
ident.c
imap-send.c use CALLOC_ARRAY 2021-03-13 16:00:09 -08:00
iterator.h
json-writer.c
json-writer.h
khash.h
kwset.c
kwset.h
levenshtein.c
levenshtein.h
line-log.c use CALLOC_ARRAY 2021-03-13 16:00:09 -08:00
line-log.h
line-range.c use CALLOC_ARRAY 2021-03-13 16:00:09 -08:00
line-range.h
linear-assignment.c
linear-assignment.h
list-objects-filter-options.c
list-objects-filter-options.h
list-objects-filter.c use CALLOC_ARRAY 2021-03-13 16:00:09 -08:00
list-objects-filter.h
list-objects.c
list-objects.h
list.h
ll-merge.c use CALLOC_ARRAY 2021-03-13 16:00:09 -08:00
ll-merge.h
lockfile.c
lockfile.h
log-tree.c Merge branch 'ab/diff-deferred-free' 2021-02-22 16:12:43 -08:00
log-tree.h
ls-refs.c Merge branch 'jt/clone-unborn-head' 2021-02-17 17:21:40 -08:00
ls-refs.h
mailinfo.c
mailinfo.h
mailmap.c use CALLOC_ARRAY 2021-03-13 16:00:09 -08:00
mailmap.h
match-trees.c
mem-pool.c mem-pool: drop trailing semicolon from macro definition 2021-03-17 10:20:16 -07:00
mem-pool.h
merge-blobs.c
merge-blobs.h
merge-ort-wrappers.c
merge-ort-wrappers.h
merge-ort.c use CALLOC_ARRAY 2021-03-13 16:00:09 -08:00
merge-ort.h
merge-recursive.c use CALLOC_ARRAY 2021-03-13 16:00:09 -08:00
merge-recursive.h
merge.c
mergesort.c
mergesort.h
midx.c use CALLOC_ARRAY 2021-03-13 16:00:09 -08:00
midx.h
name-hash.c use CALLOC_ARRAY 2021-03-13 16:00:09 -08:00
notes-cache.c
notes-cache.h
notes-merge.c use CALLOC_ARRAY 2021-03-13 16:00:09 -08:00
notes-merge.h
notes-utils.c use CALLOC_ARRAY 2021-03-13 16:00:09 -08:00
notes-utils.h
notes.c use CALLOC_ARRAY 2021-03-13 16:00:09 -08:00
notes.h
object-file.c use CALLOC_ARRAY 2021-03-13 16:00:09 -08:00
object-name.c
object-store.h
object.c use CALLOC_ARRAY 2021-03-13 16:00:09 -08:00
object.h
oid-array.c
oid-array.h
oidmap.c
oidmap.h
oidset.c
oidset.h
pack-bitmap-write.c
pack-bitmap.c use CALLOC_ARRAY 2021-03-13 16:00:09 -08:00
pack-bitmap.h rev-list: add --disk-usage option for calculating disk usage 2021-02-11 09:57:55 -08:00
pack-check.c
pack-objects.c use CALLOC_ARRAY 2021-03-13 16:00:09 -08:00
pack-objects.h
pack-revindex.c pack-revindex.c: don't close unopened file descriptors 2021-02-26 14:42:27 -08:00
pack-revindex.h
pack-write.c Merge branch 'jt/transfer-fsck-across-packs' 2021-03-01 14:02:57 -08:00
pack.h Merge branch 'jt/transfer-fsck-across-packs' 2021-03-01 14:02:57 -08:00
packfile.c use CALLOC_ARRAY 2021-03-13 16:00:09 -08:00
packfile.h
pager.c
parse-options-cb.c
parse-options.c
parse-options.h
patch-delta.c
patch-ids.c use CALLOC_ARRAY 2021-03-13 16:00:09 -08:00
patch-ids.h
path.c
path.h
pathspec.c use CALLOC_ARRAY 2021-03-13 16:00:09 -08:00
pathspec.h
pkt-line.c
pkt-line.h
preload-index.c preload-index: log the number of lstat calls to trace2 2021-02-16 17:14:34 -08:00
pretty.c use CALLOC_ARRAY 2021-03-13 16:00:09 -08:00
pretty.h pretty.c: capture invalid trailer argument 2021-02-15 16:48:38 -08:00
prio-queue.c
prio-queue.h
progress.c use CALLOC_ARRAY 2021-03-13 16:00:09 -08:00
progress.h
promisor-remote.c use CALLOC_ARRAY 2021-03-13 16:00:09 -08:00
promisor-remote.h
prompt.c
prompt.h
protocol.c
protocol.h
prune-packed.c
prune-packed.h
quote.c
quote.h
range-diff.c use CALLOC_ARRAY 2021-03-13 16:00:09 -08:00
range-diff.h Merge branch 'js/range-diff-one-side-only' 2021-02-17 17:21:41 -08:00
reachable.c
reachable.h
read-cache.c Merge branch 'rs/calloc-array' 2021-03-19 15:25:38 -07:00
rebase-interactive.c
rebase-interactive.h
rebase.c
rebase.h
ref-filter.c Merge branch 'rs/xcalloc-takes-nelem-first' 2021-03-19 15:25:39 -07:00
ref-filter.h
reflog-walk.c use CALLOC_ARRAY 2021-03-13 16:00:09 -08:00
reflog-walk.h
refs.c use CALLOC_ARRAY 2021-03-13 16:00:09 -08:00
refs.h
refspec.c
refspec.h
remote-curl.c
remote.c use CALLOC_ARRAY 2021-03-13 16:00:09 -08:00
remote.h Merge branch 'jt/clone-unborn-head' 2021-02-17 17:21:40 -08:00
replace-object.c
replace-object.h
repo-settings.c
repository.c use CALLOC_ARRAY 2021-03-13 16:00:09 -08:00
repository.h
rerere.c
rerere.h
reset.c
reset.h
resolve-undo.c use CALLOC_ARRAY 2021-03-13 16:00:09 -08:00
resolve-undo.h
revision.c use CALLOC_ARRAY 2021-03-13 16:00:09 -08:00
revision.h
run-command.c use CALLOC_ARRAY 2021-03-13 16:00:09 -08:00
run-command.h
send-pack.c use CALLOC_ARRAY 2021-03-13 16:00:09 -08:00
send-pack.h
sequencer.c use CALLOC_ARRAY 2021-03-13 16:00:09 -08:00
sequencer.h
serve.c
serve.h
server-info.c use CALLOC_ARRAY 2021-03-13 16:00:09 -08:00
setup.c
sh-i18n--envsubst.c
sha1dc_git.c
sha1dc_git.h
shallow.c
shallow.h
shell.c
shortlog.h
sideband.c
sideband.h
sigchain.c
sigchain.h
split-index.c use CALLOC_ARRAY 2021-03-13 16:00:09 -08:00
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
submodule-config.h
submodule.c
submodule.h
symlinks.c Sync with 2.20.5 2021-02-12 15:49:35 +01:00
tag.c gpg-interface: improve interface for parsing tags 2021-02-10 23:35:42 -08:00
tag.h
tar.h
tempfile.c
tempfile.h
thread-utils.c
thread-utils.h
tmp-objdir.c
tmp-objdir.h
trace.c
trace.h
trace2.c
trace2.h
trailer.c Merge branch 'rs/xcalloc-takes-nelem-first' 2021-03-19 15:25:39 -07:00
trailer.h
transport-helper.c use CALLOC_ARRAY 2021-03-13 16:00:09 -08:00
transport-internal.h
transport.c use CALLOC_ARRAY 2021-03-13 16:00:09 -08:00
transport.h
tree-diff.c
tree-walk.c
tree-walk.h
tree.c
tree.h
unicode-width.h
unimplemented.sh
unix-socket.c
unix-socket.h
unpack-trees.c Merge branch 'js/fsmonitor-unpack-fix' 2021-03-19 15:25:37 -07:00
unpack-trees.h
upload-pack.c Merge branch 'ak/corrected-commit-date' 2021-02-17 17:21:40 -08:00
upload-pack.h
url.c
url.h
urlmatch.c
urlmatch.h
usage.c usage: trace2 BUG() invocations 2021-02-09 14:14:34 -08: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 use CALLOC_ARRAY 2021-03-13 16:00:09 -08:00
worktree.h
wrap-for-bin.sh
wrapper.c
write-or-die.c
ws.c
wt-status.c use CALLOC_ARRAY 2021-03-13 16:00:09 -08:00
wt-status.h
xdiff-interface.c
xdiff-interface.h
zlib.c

README.md

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). To subscribe to the list, send an email with just "subscribe git" in the body to majordomo@vger.kernel.org. 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