Go to file

Elijah Newren 20d87d3291 sparse-checkout.txt: new document with sparse-checkout directions Once upon a time, Matheus wrote some patches to make git grep [--cached \| <REVISION>] ... restrict its output to the sparsity specification when working in a sparse checkout[1]. That effort got derailed by two things: (1) The --sparse-index work just beginning which we wanted to avoid creating conflicts for (2) Never deciding on flag and config names and planned high level behavior for all commands. More recently, Shaoxuan implemented a more limited form of Matheus' patches that only affected --cached, using a different flag name, but also changing the default behavior in line with what Matheus did. This again highlighted the fact that we never decided on command line flag names, config option names, and the big picture path forward. The --sparse-index work has been mostly complete (or at least released into production even if some small edges remain) for quite some time now. We have also had several discussions on flag and config names, though we never came to solid conclusions. Stolee once upon a time suggested putting all these into some document in Documentation/technical[3], which Victoria recently also requested[4]. I'm behind the times, but here's a patch attempting to finally do that. [1] https://lore.kernel.org/git/5f3f7ac77039d41d1692ceae4b0c5df3bb45b74a.1612901326.git.matheus.bernardino@usp.br/ (See his second link in that email in particular) [2] https://lore.kernel.org/git/20220908001854.206789-2-shaoxuan.yuan02@gmail.com/ [3] https://lore.kernel.org/git/CABPp-BHwNoVnooqDFPAsZxBT9aR5Dwk5D9sDRCvYSb8akxAJgA@mail.gmail.com/ (Scroll to the very end for the final few paragraphs) [4] https://lore.kernel.org/git/cafcedba-96a2-cb85-d593-ef47c8c8397c@github.com/ Signed-off-by: Elijah Newren <newren@gmail.com> Signed-off-by: Taylor Blau <me@ttaylorr.com>		2022-11-07 18:15:45 -05:00
.github	ci: update 'static-analysis' to Ubuntu 22.04	2022-08-24 13:02:12 -07:00
Documentation	sparse-checkout.txt: new document with sparse-checkout directions	2022-11-07 18:15:45 -05:00
block-sha1	Makefile + hash.h: remove PPC_SHA1 implementation	2022-08-31 14:37:31 -07:00
builtin	Merge branch 'sg/parse-options-subcommand'	2022-09-21 15:27:03 -07:00
ci	…
compat	Merge branch 'ab/unused-annotation'	2022-09-14 12:56:39 -07:00
contrib	t/Makefile: remove 'test-results' on 'make clean'	2022-09-21 11:32:13 -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	git-compat-util.h: use "UNUSED", not "UNUSED(var)"	2022-09-01 10:49:48 -07:00
perl	…
po	l10n: zh_TW.po: Git 2.38.0, round 3	2022-10-01 19:10:41 +08:00
refs	git-compat-util.h: use "UNUSED", not "UNUSED(var)"	2022-09-01 10:49:48 -07:00
reftable	reftable: use a pointer for pq_entry param	2022-09-15 11:32:37 -07:00
sha1collisiondetection@855827c583	…
sha1dc	…
sha256	…
t	Merge branch 'ds/bitmap-lookup-remove-tracing'	2022-09-26 21:46:51 -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	version: fix builtin linking & documentation	2022-09-19 17:28:25 -07:00
.gitmodules	…
.mailmap	…
.tsan-suppressions	…
CODE_OF_CONDUCT.md	…
COPYING	…
GIT-VERSION-GEN	Git 2.38	2022-10-02 08:43:56 -07:00
INSTALL	Makefile + hash.h: remove PPC_SHA1 implementation	2022-08-31 14:37:31 -07:00
LGPL-2.1	…
Makefile	version: fix builtin linking & documentation	2022-09-19 17:28:25 -07:00
README.md	…
RelNotes	Merge a handful of topics from the 'master' front	2022-09-13 12:22:59 -07:00
SECURITY.md	…
abspath.c	…
aclocal.m4	…
add-interactive.c	git-compat-util.h: use "UNUSED", not "UNUSED(var)"	2022-09-01 10:49:48 -07:00
add-interactive.h	…
add-patch.c	Merge branch 'rs/add-p-worktree-mode-prompt-fix'	2022-09-15 16:09:46 -07:00
advice.c	advice.h: add advise_on_moving_dirty_path()	2022-08-10 13:57:50 -07:00
advice.h	advice.h: add advise_on_moving_dirty_path()	2022-08-10 13:57:50 -07:00
alias.c	…
alias.h	…
alloc.c	…
alloc.h	…
apply.c	…
apply.h	…
archive-tar.c	git-compat-util.h: use "UNUSED", not "UNUSED(var)"	2022-09-01 10:49:48 -07:00
archive-zip.c	git-compat-util.h: use "UNUSED", not "UNUSED(var)"	2022-09-01 10:49:48 -07:00
archive.c	git-compat-util.h: use "UNUSED", not "UNUSED(var)"	2022-09-01 10:49:48 -07:00
archive.h	…
attr.c	Merge branch 'ab/unused-annotation'	2022-09-14 12:56:39 -07:00
attr.h	…
banned.h	…
base85.c	…
bisect.c	git-compat-util.h: use "UNUSED", not "UNUSED(var)"	2022-09-01 10:49:48 -07:00
bisect.h	…
blame.c	…
blame.h	…
blob.c	…
blob.h	…
bloom.c	git-compat-util.h: use "UNUSED", not "UNUSED(var)"	2022-09-01 10:49:48 -07:00
bloom.h	…
branch.c	…
branch.h	…
builtin.h	builtin/diagnose.c: create 'git diagnose' builtin	2022-08-12 13:20:02 -07:00
bulk-checkin.c	…
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	list-objects-filter: add and use initializers	2022-09-12 08:38:59 -07:00
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	…
color.c	git-compat-util.h: use "UNUSED", not "UNUSED(var)"	2022-09-01 10:49:48 -07:00
color.h	…
column.c	…
column.h	…
combine-diff.c	…
command-list.txt	version: fix builtin linking & documentation	2022-09-19 17:28:25 -07:00
commit-graph.c	Merge branch 'ml/commit-graph-expire-dir-leak-fix'	2022-09-21 14:23:14 -07:00
commit-graph.h	…
commit-reach.c	…
commit-reach.h	…
commit-slab-decl.h	…
commit-slab-impl.h	…
commit-slab.h	…
commit.c	git-compat-util.h: use "UNUSED", not "UNUSED(var)"	2022-09-01 10:49:48 -07:00
commit.h	…
common-main.c	…
config.c	git-compat-util.h: use "UNUSED", not "UNUSED(var)"	2022-09-01 10:49:48 -07:00
config.h	…
config.mak.dev	…
config.mak.in	…
config.mak.uname	…
configure.ac	Makefile + hash.h: remove PPC_SHA1 implementation	2022-08-31 14:37:31 -07:00
connect.c	…
connect.h	…
connected.c	…
connected.h	…
convert.c	git-compat-util.h: use "UNUSED", not "UNUSED(var)"	2022-09-01 10:49:48 -07:00
convert.h	…
copy.c	…
credential.c	…
credential.h	…
csum-file.c	…
csum-file.h	…
ctype.c	…
daemon.c	…
date.c	…
date.h	…
decorate.c	…
decorate.h	…
delta-islands.c	git-compat-util.h: use "UNUSED", not "UNUSED(var)"	2022-09-01 10:49:48 -07:00
delta-islands.h	…
delta.h	…
detect-compiler	…
diagnose.c	diagnose.c: refactor to safely use 'd_type'	2022-09-19 10:25:01 -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-no-index: simplify argv index calculation	2022-09-07 12:36:43 -07:00
diff.c	Merge branch 'en/remerge-diff-fixes'	2022-09-15 16:09:46 -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	Merge branch 'ab/unused-annotation'	2022-09-14 12:56:39 -07:00
dir.h	match_pathname(): drop unused "flags" parameter	2022-08-19 12:20:56 -07:00
editor.c	…
entry.c	…
entry.h	…
environment.c	Merge branch 'ab/unused-annotation'	2022-09-14 12:56:39 -07:00
environment.h	…
exec-cmd.c	…
exec-cmd.h	…
fetch-negotiator.c	…
fetch-negotiator.h	…
fetch-pack.c	Merge branch 'ab/unused-annotation'	2022-09-14 12:56:39 -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	…
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 'ab/unused-annotation'	2022-09-14 12:56:39 -07:00
git-curl-compat.h	…
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	…
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-submodule.sh	…
git-svn.perl	…
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	git-compat-util.h: use "UNUSED", not "UNUSED(var)"	2022-09-01 10:49:48 -07:00
gpg-interface.h	…
graph.c	…
graph.h	…
grep.c	…
grep.h	…
hash-lookup.c	…
hash-lookup.h	…
hash.h	Makefile + hash.h: remove PPC_SHA1 implementation	2022-08-31 14:37:31 -07:00
hashmap.c	git-compat-util.h: use "UNUSED", not "UNUSED(var)"	2022-09-01 10:49:48 -07:00
hashmap.h	…
help.c	help: fix doubled words in explanation for developer interfaces	2022-09-16 09:20:11 -07:00
help.h	…
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	git-compat-util.h: use "UNUSED", not "UNUSED(var)"	2022-09-01 10:49:48 -07:00
http-fetch.c	…
http-push.c	…
http-walker.c	…
http.c	…
http.h	…
ident.c	git-compat-util.h: use "UNUSED", not "UNUSED(var)"	2022-09-01 10:49:48 -07:00
imap-send.c	…
iterator.h	…
json-writer.c	…
json-writer.h	…
khash.h	…
kwset.c	…
kwset.h	…
levenshtein.c	…
levenshtein.h	…
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: initialize sub-filter structs	2022-09-22 12:43:04 -07:00
list-objects-filter-options.h	list-objects-filter: convert filter_spec to a strbuf	2022-09-12 08:38:59 -07:00
list-objects-filter.c	…
list-objects-filter.h	…
list-objects.c	…
list-objects.h	…
list.h	…
ll-merge.c	git-compat-util.h: use "UNUSED", not "UNUSED(var)"	2022-09-01 10:49:48 -07:00
ll-merge.h	…
lockfile.c	…
lockfile.h	…
log-tree.c	Merge branch 'ab/unused-annotation'	2022-09-14 12:56:39 -07:00
log-tree.h	…
ls-refs.c	git-compat-util.h: use "UNUSED", not "UNUSED(var)"	2022-09-01 10:49:48 -07:00
ls-refs.h	…
mailinfo.c	…
mailinfo.h	…
mailmap.c	…
mailmap.h	…
match-trees.c	…
mem-pool.c	…
mem-pool.h	…
merge-blobs.c	…
merge-blobs.h	…
merge-ort-wrappers.c	…
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-recursive.c	git-compat-util.h: use "UNUSED", not "UNUSED(var)"	2022-09-01 10:49:48 -07:00
merge-recursive.h	…
merge.c	…
mergesort.h	…
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	git-compat-util.h: use "UNUSED", not "UNUSED(var)"	2022-09-01 10:49:48 -07:00
notes-cache.c	…
notes-cache.h	…
notes-merge.c	…
notes-merge.h	…
notes-utils.c	…
notes-utils.h	…
notes.c	Merge branch 'ab/unused-annotation'	2022-09-14 12:56:39 -07:00
notes.h	…
object-file.c	…
object-name.c	git-compat-util.h: use "UNUSED", not "UNUSED(var)"	2022-09-01 10:49:48 -07:00
object-store.h	git-compat-util.h: use "UNUSED", not "UNUSED(var)"	2022-09-01 10:49:48 -07:00
object.c	parse_object(): check commit-graph when skip_hash set	2022-09-07 12:27:02 -07:00
object.h	parse_object(): allow skipping hash check	2022-09-07 12:18:57 -07:00
oid-array.c	…
oid-array.h	…
oidmap.c	git-compat-util.h: use "UNUSED", not "UNUSED(var)"	2022-09-01 10:49:48 -07:00
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	Merge branch 'ds/bitmap-lookup-remove-tracing'	2022-09-26 21:46:51 -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-revindex.c	…
pack-revindex.h	…
pack-write.c	…
pack.h	…
packfile.c	Merge branch 'ab/unused-annotation'	2022-09-14 12:56:39 -07:00
packfile.h	…
pager.c	git-compat-util.h: use "UNUSED", not "UNUSED(var)"	2022-09-01 10:49:48 -07:00
parallel-checkout.c	…
parallel-checkout.h	…
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	git-compat-util.h: use "UNUSED", not "UNUSED(var)"	2022-09-01 10:49:48 -07:00
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	Merge branch 'ab/unused-annotation'	2022-09-14 12:56:39 -07:00
pretty.h	…
prio-queue.c	…
prio-queue.h	…
progress.c	…
progress.h	…
promisor-remote.c	Merge branch 'sg/xcalloc-cocci-fix' into maint	2022-09-13 12:21:09 -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	Merge branch 'ab/unused-annotation'	2022-09-14 12:56:39 -07:00
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
rebase-interactive.c	…
rebase-interactive.h	…
rebase.c	…
rebase.h	…
ref-filter.c	git-compat-util.h: use "UNUSED", not "UNUSED(var)"	2022-09-01 10:49:48 -07:00
ref-filter.h	…
reflog-walk.c	…
reflog-walk.h	…
reflog.c	git-compat-util.h: use "UNUSED", not "UNUSED(var)"	2022-09-01 10:49:48 -07:00
reflog.h	…
refs.c	Merge branch 'ab/unused-annotation'	2022-09-14 12:56:39 -07:00
refs.h	refs: add array of ref namespaces	2022-08-05 14:13:12 -07:00
refspec.c	…
refspec.h	…
remote-curl.c	remote-curl: add 'get' capability	2022-08-10 14:07:37 -07:00
remote.c	git-compat-util.h: use "UNUSED", not "UNUSED(var)"	2022-09-01 10:49:48 -07:00
remote.h	…
replace-object.c	git-compat-util.h: use "UNUSED", not "UNUSED(var)"	2022-09-01 10:49:48 -07:00
replace-object.h	…
repo-settings.c	Merge branch 'jk/plug-list-object-filter-leaks'	2022-09-14 12:56:40 -07:00
repository.c	…
repository.h	Merge branch 'ab/submodule-helper-prep'	2022-09-13 11:38:23 -07:00
rerere.c	…
rerere.h	…
reset.c	…
reset.h	…
resolve-undo.c	…
resolve-undo.h	…
revision.c	Merge branch 'jk/list-objects-filter-cleanup'	2022-09-19 14:35:24 -07:00
revision.h	Merge branch 'jc/format-patch-force-in-body-from'	2022-09-09 12:02:25 -07:00
run-command.c	pipe_command(): mark stdin descriptor as non-blocking	2022-08-17 09:21:41 -07:00
run-command.h	…
scalar.c	scalar: implement the `help` subcommand	2022-09-02 10:02:56 -07:00
send-pack.c	git-compat-util.h: use "UNUSED", not "UNUSED(var)"	2022-09-01 10:49:48 -07:00
send-pack.h	…
sequencer.c	Merge branch 'ab/unused-annotation'	2022-09-14 12:56:39 -07:00
sequencer.h	…
serve.c	…
serve.h	…
server-info.c	git-compat-util.h: use "UNUSED", not "UNUSED(var)"	2022-09-01 10:49:48 -07:00
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	git-compat-util.h: use "UNUSED", not "UNUSED(var)"	2022-09-01 10:49:48 -07:00
shallow.h	…
shared.mak	…
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	git-compat-util.h: use "UNUSED", not "UNUSED(var)"	2022-09-01 10:49:48 -07:00
strbuf.h	…
streaming.c	git-compat-util.h: use "UNUSED", not "UNUSED(var)"	2022-09-01 10:49:48 -07:00
streaming.h	…
string-list.c	…
string-list.h	…
strmap.c	git-compat-util.h: use "UNUSED", not "UNUSED(var)"	2022-09-01 10:49:48 -07:00
strmap.h	…
strvec.c	…
strvec.h	…
sub-process.c	git-compat-util.h: use "UNUSED", not "UNUSED(var)"	2022-09-01 10:49:48 -07:00
sub-process.h	…
submodule-config.c	git-compat-util.h: use "UNUSED", not "UNUSED(var)"	2022-09-01 10:49:48 -07:00
submodule-config.h	…
submodule.c	Merge branch 'ab/unused-annotation'	2022-09-14 12:56:39 -07:00
submodule.h	submodule API: don't handle SM_..{UNSPECIFIED,COMMAND} in to_string()	2022-09-02 09:16:24 -07:00
symlinks.c	…
tag.c	…
tag.h	…
tar.h	…
tempfile.c	tempfile: update comment describing state transitions	2022-08-30 14:16:51 -07:00
tempfile.h	tempfile: drop active flag	2022-08-30 14:16:49 -07:00
thread-utils.c	…
thread-utils.h	…
tmp-objdir.c	…
tmp-objdir.h	…
trace.c	…
trace.h	…
trace2.c	…
trace2.h	…
trailer.c	git-compat-util.h: use "UNUSED", not "UNUSED(var)"	2022-09-01 10:49:48 -07:00
trailer.h	…
transport-helper.c	list-objects-filter: add and use initializers	2022-09-12 08:38:59 -07:00
transport-internal.h	…
transport.c	Merge branch 'jk/list-objects-filter-cleanup'	2022-09-19 14:35:24 -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'	2022-09-09 12:02:26 -07:00
unpack-trees.h	…
upload-pack.c	Merge branch 'jk/list-objects-filter-cleanup'	2022-09-19 14:35:24 -07:00
upload-pack.h	…
url.c	…
url.h	…
urlmatch.c	…
urlmatch.h	…
usage.c	…
userdiff.c	…
userdiff.h	…
utf8.c	…
utf8.h	…
varint.c	…
varint.h	…
version.c	…
version.h	…
versioncmp.c	…
walker.c	git-compat-util.h: use "UNUSED", not "UNUSED(var)"	2022-09-01 10:49:48 -07:00
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	git-compat-util.h: use "UNUSED", not "UNUSED(var)"	2022-09-01 10:49:48 -07:00
wt-status.h	…
xdiff-interface.c	…
xdiff-interface.h	…
zlib.c	…

README.md

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