Go to file

Elijah Newren 0d86f59a3c git-sparse-checkout.txt: shuffle some sections and mark as internal With cone mode as the default, it makes sense to discuss it before non-cone mode. Also, the new default means we can just use directories in most cases and users do not need to understand patterns or their meanings. Let's take advantage of this to mark several sections as "INTERNALS", notifying the user that they do not need to know all those details in order to make use of the sparse-checkout command. Signed-off-by: Elijah Newren <newren@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>		2022-04-21 23:12:38 -07:00
.github	…
Documentation	git-sparse-checkout.txt: shuffle some sections and mark as internal	2022-04-21 23:12:38 -07:00
block-sha1	…
builtin	sparse-checkout: make --cone the default	2022-04-21 23:12:38 -07:00
ci	…
compat	Merge branch 'ab/auto-detect-zlib-compress2'	2022-02-16 15:14:30 -08:00
contrib	Merge branch 'jc/rerere-train-modernise'	2022-03-06 21:25:30 -08:00
ewah	…
git-gui	…
gitk-git	…
gitweb	…
mergetools	…
negotiator	…
perl	perl Git.pm: don't ignore signalled failure in _cmd_close()	2022-02-01 15:21:19 -08:00
po	…
ppc	…
refs	Merge branch 'ps/avoid-unnecessary-hook-invocation-with-packed-refs'	2022-02-18 13:53:27 -08:00
reftable	reftable: rename writer_stats to reftable_writer_stats	2022-02-23 13:36:26 -08:00
sha1collisiondetection@855827c583	…
sha1dc	…
sha256	…
t	tests: stop assuming --no-cone is the default mode for sparse-checkout	2022-04-21 23:12:38 -07:00
templates	…
trace2	trace2: use designated initializers for "struct tr2_dst"	2022-02-24 15:58:55 -08:00
xdiff	xdiff: handle allocation failure when merging	2022-02-16 10:58:16 -08:00
.cirrus.yml	…
.clang-format	…
.editorconfig	…
.gitattributes	…
.gitignore	…
.gitmodules	…
.mailmap	mailmap: change primary address for Derrick Stolee	2022-02-14 13:27:31 -08:00
.tsan-suppressions	…
CODE_OF_CONDUCT.md	CODE_OF_CONDUCT.md: update PLC members list	2022-02-18 12:36:29 -08:00
COPYING	…
GIT-VERSION-GEN	Git 2.35.1	2022-01-28 16:48:42 -08:00
INSTALL	…
LGPL-2.1	…
Makefile	Merge branch 'ab/auto-detect-zlib-compress2'	2022-02-16 15:14:30 -08:00
README.md	Merge branch 'po/readme-mention-contributor-hints'	2022-02-09 14:20:59 -08:00
RelNotes	Name the next one 2.36 to prepare for 2.35.1	2022-01-28 16:57:10 -08:00
SECURITY.md	…
abspath.c	…
aclocal.m4	…
add-interactive.c	diff.[ch]: have diff_free() call clear_pathspec(opts.pathspec)	2022-02-16 13:50:13 -08:00
add-interactive.h	…
add-patch.c	Merge branch 'pw/add-p-hunk-split-fix'	2022-02-09 14:20:59 -08:00
advice.c	switch: mention the --detach option when dying due to lack of a branch	2022-02-25 22:21:48 -08:00
advice.h	switch: mention the --detach option when dying due to lack of a branch	2022-02-25 22:21:48 -08:00
alias.c	…
alias.h	…
alloc.c	…
alloc.h	…
apply.c	Merge branch 'en/remerge-diff'	2022-02-16 15:14:29 -08:00
apply.h	Merge branch 'rs/apply-symlinks-use-strset'	2022-02-05 09:42:30 -08:00
archive-tar.c	archive-*.c: use designated initializers for "struct archiver"	2022-02-24 15:59:20 -08:00
archive-zip.c	Merge branch 'ab/c99-designated-initializers'	2022-03-06 21:25:32 -08:00
archive.c	i18n: remove from i18n strings that do not hold translatable parts	2022-02-04 13:58:28 -08:00
archive.h	…
attr.c	…
attr.h	…
banned.h	C99: remove hardcoded-out !HAVE_VARIADIC_MACROS code	2022-02-21 19:14:19 -08:00
base85.c	…
bisect.c	…
bisect.h	…
blame.c	Merge branch 'ab/diff-free-more'	2022-02-25 15:47:36 -08:00
blame.h	…
blob.c	…
blob.h	…
bloom.c	…
bloom.h	…
branch.c	Merge branch 'gc/branch-recurse-submodules'	2022-02-18 13:53:29 -08:00
branch.h	branch: add --recurse-submodules option for branch creation	2022-02-04 08:16:39 -08:00
builtin.h	…
bulk-checkin.c	…
bulk-checkin.h	…
bundle.c	…
bundle.h	…
cache-tree.c	…
cache-tree.h	…
cache.h	Merge branch 'en/present-despite-skipped'	2022-03-09 13:38:23 -08: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	…
color.h	…
column.c	…
column.h	…
combine-diff.c	…
command-list.txt	…
commit-graph.c	…
commit-graph.h	…
commit-reach.c	…
commit-reach.h	…
commit-slab-decl.h	…
commit-slab-impl.h	…
commit-slab.h	…
commit.c	Merge branch 'ab/config-based-hooks-2'	2022-02-09 14:21:00 -08:00
commit.h	…
common-main.c	…
config.c	Merge branch 'en/present-despite-skipped'	2022-03-09 13:38:23 -08:00
config.h	Merge branch 'ds/sparse-checkout-requires-per-worktree-config'	2022-02-25 15:47:33 -08:00
config.mak.dev	…
config.mak.in	…
config.mak.uname	Merge branch 'ab/auto-detect-zlib-compress2'	2022-02-16 15:14:30 -08:00
configure.ac	…
connect.c	ls-remote & transport API: release "struct transport_ls_refs_options"	2022-02-06 18:02:34 -08:00
connect.h	…
connected.c	…
connected.h	…
convert.c	convert.c: use designated initializers for "struct stream_filter*"	2022-02-24 15:59:43 -08:00
convert.h	…
copy.c	…
credential.c	…
credential.h	…
csum-file.c	…
csum-file.h	…
ctype.c	…
daemon.c	…
date.c	date API: add and use a date_mode_release()	2022-02-16 09:40:00 -08:00
date.h	date API: add and use a date_mode_release()	2022-02-16 09:40:00 -08:00
decorate.c	…
decorate.h	…
delta-islands.c	…
delta-islands.h	…
delta.h	…
detect-compiler	…
diff-delta.c	…
diff-lib.c	…
diff-merges.c	Merge branch 'ja/i18n-common-messages'	2022-02-25 15:47:35 -08:00
diff-merges.h	…
diff-no-index.c	…
diff.c	Merge branch 'ac/usage-string-fixups'	2022-03-06 21:25:32 -08:00
diff.h	Merge branch 'js/diff-filter-negation-fix'	2022-02-16 15:14:30 -08:00
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	dir: force untracked cache with core.untrackedCache	2022-02-17 14:47:13 -08:00
dir.h	…
editor.c	…
entry.c	…
entry.h	…
environment.c	repo_read_index: add config to expect files outside sparse patterns	2022-03-01 23:37:48 -08:00
environment.h	…
exec-cmd.c	…
exec-cmd.h	…
fetch-negotiator.c	repo-settings: rename the traditional default fetch.negotiationAlgorithm	2022-02-02 09:36:17 -08:00
fetch-negotiator.h	…
fetch-pack.c	Merge branch 'ps/fetch-optim-with-commit-graph'	2022-02-23 16:58:03 -08:00
fetch-pack.h	…
fmt-merge-msg.c	…
fmt-merge-msg.h	…
fsck.c	…
fsck.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	C99: remove hardcoded-out !HAVE_VARIADIC_MACROS code	2022-02-21 19:14:19 -08: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 'ab/config-based-hooks-2'	2022-02-09 14:21:00 -08:00
git-quiltimport.sh	…
git-request-pull.sh	…
git-send-email.perl	…
git-sh-i18n.sh	…
git-sh-setup.sh	…
git-submodule.sh	clone, submodule: pass partial clone filters to submodules	2022-02-09 15:38:36 -08:00
git-svn.perl	…
git-web--browse.sh	…
git.c	Merge branch 'ab/grep-patterntype'	2022-02-25 15:47:36 -08:00
git.rc	…
gpg-interface.c	Merge branch 'ja/i18n-common-messages'	2022-02-25 15:47:35 -08:00
gpg-interface.h	…
graph.c	log: fix memory leak if --graph is passed multiple times	2022-02-11 10:06:40 -08:00
graph.h	log: fix memory leak if --graph is passed multiple times	2022-02-11 10:06:40 -08:00
grep.c	Merge branch 'rs/pcre-invalid-utf8-fix-fix'	2022-02-25 15:47:38 -08:00
grep.h	grep: simplify config parsing and option parsing	2022-02-15 18:00:50 -08:00
hash-lookup.c	…
hash-lookup.h	…
hash.h	…
hashmap.c	…
hashmap.h	…
help.c	help: don't print "\n" before single-section output	2022-02-23 13:41:37 -08:00
help.h	help: add --no-[external-commands\|aliases] for use with --all	2022-02-23 13:41:37 -08:00
hex.c	…
hook.c	…
hook.h	…
http-backend.c	date API: create a date.h, split from cache.h	2022-02-16 09:40:00 -08:00
http-fetch.c	…
http-push.c	…
http-walker.c	…
http.c	…
http.h	…
ident.c	date API: create a date.h, split from cache.h	2022-02-16 09:40:00 -08:00
imap-send.c	imap-send.c: use designated initializers for "struct imap_server_conf"	2022-02-24 15:57:56 -08:00
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-options.h	…
list-objects-filter.c	…
list-objects-filter.h	…
list-objects.c	…
list-objects.h	…
list.h	…
ll-merge.c	ll-merge: make callers responsible for showing warnings	2022-02-02 10:02:27 -08:00
ll-merge.h	ll-merge: make callers responsible for showing warnings	2022-02-02 10:02:27 -08:00
lockfile.c	…
lockfile.h	…
log-tree.c	show, log: include conflict/warning messages in --remerge-diff headers	2022-02-02 10:02:28 -08:00
log-tree.h	…
ls-refs.c	i18n: factorize "invalid value" messages	2022-02-04 13:58:28 -08:00
ls-refs.h	…
mailinfo.c	…
mailinfo.h	…
mailmap.c	…
mailmap.h	…
match-trees.c	…
mem-pool.c	…
mem-pool.h	…
merge-blobs.c	ll-merge: make callers responsible for showing warnings	2022-02-02 10:02:27 -08:00
merge-blobs.h	…
merge-ort-wrappers.c	…
merge-ort-wrappers.h	…
merge-ort.c	Merge branch 'en/merge-ort-plug-leaks'	2022-03-06 21:25:31 -08:00
merge-ort.h	show, log: include conflict/warning messages in --remerge-diff headers	2022-02-02 10:02:28 -08:00
merge-recursive.c	merge-ort: format messages slightly different for use in headers	2022-02-02 10:02:27 -08:00
merge-recursive.h	merge-ort: format messages slightly different for use in headers	2022-02-02 10:02:27 -08:00
merge.c	…
mergesort.c	…
mergesort.h	…
midx.c	Merge branch 'tb/midx-no-bitmap-for-no-objects'	2022-02-18 13:53:30 -08:00
midx.h	…
name-hash.c	…
notes-cache.c	…
notes-cache.h	…
notes-merge.c	Merge branch 'ab/diff-free-more'	2022-02-25 15:47:36 -08:00
notes-merge.h	…
notes-utils.c	…
notes-utils.h	…
notes.c	…
notes.h	…
object-file.c	object-file: use designated initializers for "struct git_hash_algo"	2022-02-24 15:59:14 -08:00
object-name.c	Merge branch 'ab/date-mode-release'	2022-02-25 15:47:36 -08:00
object-store.h	…
object.c	…
object.h	…
oid-array.c	…
oid-array.h	…
oidmap.c	…
oidmap.h	…
oidset.c	…
oidset.h	…
oidtree.c	…
oidtree.h	…
pack-bitmap-write.c	Merge branch 'ab/only-single-progress-at-once'	2022-02-25 15:47:35 -08:00
pack-bitmap.c	…
pack-bitmap.h	…
pack-check.c	…
pack-objects.c	…
pack-objects.h	…
pack-revindex.c	…
pack-revindex.h	…
pack-write.c	…
pack.h	…
packfile.c	…
packfile.h	…
pager.c	…
parallel-checkout.c	i18n: factorize "invalid value" messages	2022-02-04 13:58:28 -08:00
parallel-checkout.h	…
parse-options-cb.c	…
parse-options.c	Merge branch 'ja/i18n-common-messages'	2022-02-25 15:47:35 -08:00
parse-options.h	Merge branch 'ja/i18n-common-messages'	2022-02-25 15:47:35 -08:00
patch-delta.c	…
patch-ids.c	…
patch-ids.h	…
path.c	…
path.h	…
pathspec.c	…
pathspec.h	…
pkt-line.c	…
pkt-line.h	…
preload-index.c	…
pretty.c	…
pretty.h	date API: create a date.h, split from cache.h	2022-02-16 09:40:00 -08:00
prio-queue.c	…
prio-queue.h	…
progress.c	progress API: unify stop_progress{,_msg}(), fix trace2 bug	2022-02-03 15:39:59 -08:00
progress.h	progress API: unify stop_progress{,_msg}(), fix trace2 bug	2022-02-03 15:39:59 -08:00
promisor-remote.c	…
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-clean-etc'	2022-02-17 16:25:05 -08:00
rebase-interactive.c	…
rebase-interactive.h	…
rebase.c	…
rebase.h	…
ref-filter.c	date API: add and use a date_mode_release()	2022-02-16 09:40:00 -08:00
ref-filter.h	…
reflog-walk.c	…
reflog-walk.h	date API: create a date.h, split from cache.h	2022-02-16 09:40:00 -08:00
refs.c	Merge branch 'ab/date-mode-release'	2022-02-25 15:47:36 -08:00
refs.h	Merge branch 'ps/avoid-unnecessary-hook-invocation-with-packed-refs'	2022-02-18 13:53:27 -08:00
refspec.c	refspec.c: use designated initializers for "struct refspec_item"	2022-02-24 15:59:53 -08:00
refspec.h	…
remote-curl.c	…
remote.c	…
remote.h	…
replace-object.c	…
replace-object.h	…
repo-settings.c	Merge branch 'en/fetch-negotiation-default-fix'	2022-02-16 15:14:30 -08:00
repository.c	…
repository.h	Merge branch 'en/fetch-negotiation-default-fix'	2022-02-16 15:14:30 -08:00
rerere.c	ll-merge: make callers responsible for showing warnings	2022-02-02 10:02:27 -08:00
rerere.h	…
reset.c	Merge branch 'pw/use-in-process-checkout-in-rebase'	2022-02-18 13:53:27 -08:00
reset.h	…
resolve-undo.c	…
resolve-undo.h	…
revision.c	Merge branch 'ab/grep-patterntype'	2022-02-25 15:47:36 -08:00
revision.h	Merge branch 'ah/log-no-graph'	2022-02-23 16:58:03 -08:00
run-command.c	Merge branch 'ab/config-based-hooks-2'	2022-02-09 14:21:00 -08:00
run-command.h	…
send-pack.c	…
send-pack.h	…
sequencer.c	Merge branch 'ja/i18n-common-messages'	2022-02-25 15:47:35 -08:00
sequencer.h	…
serve.c	…
serve.h	…
server-info.c	…
setup.c	i18n: factorize "invalid value" messages	2022-02-04 13:58:28 -08:00
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	…
simple-ipc.h	…
sparse-index.c	Merge branch 'en/present-despite-skipped'	2022-03-09 13:38:23 -08:00
sparse-index.h	…
split-index.c	…
split-index.h	…
stable-qsort.c	…
strbuf.c	date API: create a date.h, split from cache.h	2022-02-16 09:40:00 -08:00
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	Merge branch 'ja/i18n-common-messages'	2022-02-25 15:47:35 -08:00
submodule-config.h	branch: add --recurse-submodules option for branch creation	2022-02-04 08:16:39 -08:00
submodule.c	branch: add --recurse-submodules option for branch creation	2022-02-04 08:16:39 -08:00
submodule.h	branch: add --recurse-submodules option for branch creation	2022-02-04 08:16:39 -08:00
symlinks.c	…
tag.c	…
tag.h	…
tar.h	…
tempfile.c	…
tempfile.h	…
thread-utils.c	…
thread-utils.h	…
tmp-objdir.c	log: clean unneeded objects during `log --remerge-diff`	2022-02-02 10:02:27 -08:00
tmp-objdir.h	log: clean unneeded objects during `log --remerge-diff`	2022-02-02 10:02:27 -08:00
trace.c	C99: remove hardcoded-out !HAVE_VARIADIC_MACROS code	2022-02-21 19:14:19 -08:00
trace.h	C99: remove hardcoded-out !HAVE_VARIADIC_MACROS code	2022-02-21 19:14:19 -08:00
trace2.c	C99: remove hardcoded-out !HAVE_VARIADIC_MACROS code	2022-02-21 19:14:19 -08:00
trace2.h	C99: remove hardcoded-out !HAVE_VARIADIC_MACROS code	2022-02-21 19:14:19 -08:00
trailer.c	…
trailer.h	…
transport-helper.c	…
transport-internal.h	…
transport.c	ls-remote & transport API: release "struct transport_ls_refs_options"	2022-02-06 18:02:34 -08:00
transport.h	ls-remote & transport API: release "struct transport_ls_refs_options"	2022-02-06 18:02:34 -08:00
tree-diff.c	…
tree-walk.c	…
tree-walk.h	…
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	…
unpack-trees.h	…
upload-pack.c	…
upload-pack.h	…
url.c	…
url.h	…
urlmatch.c	…
urlmatch.h	…
usage.c	C99: remove hardcoded-out !HAVE_VARIADIC_MACROS code	2022-02-21 19:14:19 -08:00
userdiff.c	userdiff.c: use designated initializers for "struct userdiff_driver"	2022-02-24 15:59:27 -08:00
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	Merge branch 'ds/sparse-checkout-requires-per-worktree-config'	2022-02-25 15:47:33 -08:00
worktree.h	worktree: create init_worktree_config()	2022-02-08 09:49:20 -08:00
wrap-for-bin.sh	…
wrapper.c	…
write-or-die.c	…
ws.c	…
wt-status.c	…
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