Go to file

Ævar Arnfjörð Bjarmason 3c3ca0b0c1 core doc: modernize core.bigFileThreshold documentation The core.bigFileThreshold documentation has been largely unchanged since `5eef828bc0` (fast-import: Stream very large blobs directly to pack, 2010-02-01). But since then this setting has been expanded to affect a lot more than that description indicated. Most notably in how "git diff" treats them, see `6bf3b81348` (diff --stat: mark any file larger than core.bigfilethreshold binary, 2014-08-16). In addition to that, numerous commands and APIs make use of a streaming mode for files above this threshold. So let's attempt to summarize 12 years of changes in behavior, which can be seen with: git log --oneline -Gbig_file_thre 5eef828bc03.. -- '*.c' To do that turn this into a bullet-point list. The summary Han Xin produced in [1] helped a lot, but is a bit too detailed for documentation aimed at users. Let's instead summarize how user-observable behavior differs, and generally describe how we tend to stream these files in various commands. 1. https://lore.kernel.org/git/20220120112114.47618-5-chiyutianyi@gmail.com/ Helped-by: Han Xin <chiyutianyi@gmail.com> Signed-off-by: Ævar Arnfjörð Bjarmason <avarab@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>		2022-06-13 10:22:35 -07:00
.github	…
Documentation	core doc: modernize core.bigFileThreshold documentation	2022-06-13 10:22:35 -07:00
block-sha1	…
builtin	unpack-objects: low memory footprint for get_data() in dry_run mode	2022-06-13 10:22:35 -07:00
ci	Merge branch 'jx/l10n-workflow-change'	2022-06-03 14:30:36 -07:00
compat	Merge branch 'ds/bundle-uri'	2022-06-03 14:30:34 -07:00
contrib	Merge branch 'ep/maint-equals-null-cocci'	2022-05-20 15:26:59 -07:00
ewah	Merge branch 'ep/maint-equals-null-cocci'	2022-05-20 15:26:59 -07:00
git-gui	…
gitk-git	Merge branch 'master' of git://git.ozlabs.org/~paulus/gitk	2022-05-11 08:25:02 -07:00
gitweb	…
mergetools	…
negotiator	…
perl	…
po	l10n: Document the new l10n workflow	2022-05-26 10:32:58 -07:00
ppc	…
refs	Merge branch 'ep/maint-equals-null-cocci'	2022-05-20 15:26:59 -07:00
reftable	Merge branch 'ep/maint-equals-null-cocci'	2022-05-20 15:26:59 -07:00
sha1collisiondetection@855827c583	…
sha1dc	…
sha256	…
t	unpack-objects: low memory footprint for get_data() in dry_run mode	2022-06-13 10:22:35 -07:00
templates	…
trace2	…
xdiff	Merge branch 'ep/maint-equals-null-cocci'	2022-05-20 15:26:59 -07:00
.cirrus.yml	ci: update Cirrus-CI image to FreeBSD 12.3	2022-05-25 08:47:11 -07:00
.clang-format	…
.editorconfig	…
.gitattributes	…
.gitignore	Makefile: have "make pot" not "reset --hard"	2022-05-26 10:30:27 -07:00
.gitmodules	…
.mailmap	…
.tsan-suppressions	…
CODE_OF_CONDUCT.md	…
COPYING	…
GIT-VERSION-GEN	Git 2.36.1	2022-05-05 14:36:37 -07:00
INSTALL	…
LGPL-2.1	…
Makefile	Merge branch 'tb/cruft-packs'	2022-06-03 14:30:37 -07:00
README.md	…
RelNotes	Git 2.36.1	2022-05-05 14:36:37 -07:00
SECURITY.md	…
abspath.c	…
aclocal.m4	…
add-interactive.c	…
add-interactive.h	…
add-patch.c	…
advice.c	…
advice.h	…
alias.c	…
alias.h	…
alloc.c	…
alloc.h	…
apply.c	Merge branch 'ep/maint-equals-null-cocci'	2022-05-20 15:26:59 -07:00
apply.h	…
archive-tar.c	…
archive-zip.c	…
archive.c	Merge branch 'jc/archive-add-file-normalize-mode'	2022-05-23 14:39:55 -07:00
archive.h	…
attr.c	…
attr.h	…
banned.h	…
base85.c	…
bisect.c	…
bisect.h	bisect: output state before we are ready to compute bisection	2022-05-11 12:35:11 -07:00
blame.c	Merge branch 'ep/maint-equals-null-cocci'	2022-05-20 15:26:59 -07:00
blame.h	…
blob.c	…
blob.h	…
bloom.c	…
bloom.h	…
branch.c	Merge branch 'tk/simple-autosetupmerge'	2022-05-26 14:51:30 -07:00
branch.h	branch: new autosetupmerge option 'simple' for matching branches	2022-04-29 11:20:55 -07:00
builtin.h	…
bulk-checkin.c	Merge branch 'tb/cruft-packs'	2022-06-03 14:30:37 -07:00
bulk-checkin.h	…
bundle.c	bundle.h: make "fd" version of read_bundle_header() public	2022-05-16 15:02:10 -07:00
bundle.h	bundle.h: make "fd" version of read_bundle_header() public	2022-05-16 15:02:10 -07:00
cache-tree.c	Merge branch 'ds/sparse-sparse-checkout'	2022-06-03 14:30:35 -07:00
cache-tree.h	cache-tree: implement cache_tree_find_path()	2022-05-23 11:08:21 -07:00
cache.h	Merge branch 'ds/sparse-sparse-checkout'	2022-06-03 14:30:35 -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: extract oid_version()	2022-05-26 15:48:26 -07:00
chunk-format.h	chunk-format.h: extract oid_version()	2022-05-26 15:48:26 -07:00
color.c	…
color.h	…
column.c	…
column.h	…
combine-diff.c	tree-wide: apply equals-null.cocci	2022-05-02 09:50:37 -07:00
command-list.txt	…
commit-graph.c	Merge branch 'tb/cruft-packs'	2022-06-03 14:30:37 -07:00
commit-graph.h	…
commit-reach.c	…
commit-reach.h	…
commit-slab-decl.h	…
commit-slab-impl.h	…
commit-slab.h	…
commit.c	…
commit.h	…
common-main.c	…
config.c	Merge branch 'ns/batch-fsync'	2022-06-03 14:30:34 -07:00
config.h	…
config.mak.dev	config.mak.dev: alternative workaround to gcc 12 warning in http.c	2022-04-15 16:27:04 -07:00
config.mak.in	…
config.mak.uname	…
configure.ac	Merge branch 'ab/misc-cleanup'	2022-05-10 17:41:10 -07:00
connect.c	connect.c: refactor sending of agent & object-format	2022-05-16 15:02:09 -07:00
connect.h	…
connected.c	…
connected.h	…
convert.c	…
convert.h	…
copy.c	…
credential.c	…
credential.h	…
csum-file.c	…
csum-file.h	…
ctype.c	…
daemon.c	Merge branch 'ep/maint-equals-null-cocci' for maint-2.35	2022-05-02 10:06:04 -07:00
date.c	…
date.h	…
decorate.c	…
decorate.h	…
delta-islands.c	…
delta-islands.h	…
delta.h	…
detect-compiler	detect-compiler: make detection independent of locale	2022-05-09 08:52:26 -07:00
diff-delta.c	…
diff-lib.c	…
diff-merges.c	…
diff-merges.h	…
diff-no-index.c	…
diff.c	diff: use mks_tempfile_dt()	2022-04-20 16:17:35 -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 'ds/bundle-uri'	2022-06-03 14:30:34 -07:00
dir.h	dir API: add a generalized path_match_flags() function	2022-05-16 15:02:09 -07:00
editor.c	…
entry.c	…
entry.h	…
environment.c	Merge branch 'ds/midx-normalize-pathname-before-comparison'	2022-05-04 09:51:29 -07:00
environment.h	…
exec-cmd.c	…
exec-cmd.h	…
fetch-negotiator.c	…
fetch-negotiator.h	…
fetch-pack.c	Merge branch 'ds/bundle-uri'	2022-06-03 14:30:34 -07:00
fetch-pack.h	…
fmt-merge-msg.c	…
fmt-merge-msg.h	…
fsck.c	dir API: add a generalized path_match_flags() function	2022-05-16 15:02:09 -07:00
fsck.h	…
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 'ds/bundle-uri'	2022-06-03 14:30:34 -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 'tk/p4-metadata-coding-strategies'	2022-05-20 15:27:00 -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 'gf/shorthand-version-and-help'	2022-05-20 15:26:53 -07:00
git.rc	…
gpg-interface.c	…
gpg-interface.h	…
graph.c	…
graph.h	…
grep.c	…
grep.h	…
hash-lookup.c	…
hash-lookup.h	…
hash.h	…
hashmap.c	…
hashmap.h	…
help.c	…
help.h	…
hex.c	…
hook.c	…
hook.h	…
http-backend.c	…
http-fetch.c	Merge branch 'ep/maint-equals-null-cocci' for maint-2.35	2022-05-02 10:06:04 -07:00
http-push.c	Merge branch 'ep/maint-equals-null-cocci'	2022-05-20 15:26:59 -07:00
http-walker.c	tree-wide: apply equals-null.cocci	2022-05-02 09:50:37 -07:00
http.c	Merge branch 'ds/bundle-uri'	2022-06-03 14:30:34 -07:00
http.h	http: make http_get_file() external	2022-05-16 15:02:09 -07:00
ident.c	…
imap-send.c	…
iterator.h	…
json-writer.c	…
json-writer.h	…
khash.h	…
kwset.c	tree-wide: apply equals-null.cocci	2022-05-02 09:50:37 -07:00
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	Merge branch 'ep/maint-equals-null-cocci'	2022-05-20 15:26:59 -07:00
ll-merge.h	…
lockfile.c	…
lockfile.h	…
log-tree.c	Merge branch 'ep/maint-equals-null-cocci'	2022-05-20 15:26:59 -07:00
log-tree.h	…
ls-refs.c	…
ls-refs.h	…
mailinfo.c	tree-wide: apply equals-null.cocci	2022-05-02 09:50:37 -07:00
mailinfo.h	…
mailmap.c	Merge branch 'ep/maint-equals-null-cocci'	2022-05-20 15:26:59 -07:00
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 'ep/maint-equals-null-cocci'	2022-05-20 15:26:59 -07:00
merge-ort.h	…
merge-recursive.c	Merge branch 'ep/maint-equals-null-cocci'	2022-05-20 15:26:59 -07:00
merge-recursive.h	…
merge.c	…
mergesort.c	…
mergesort.h	…
midx.c	Merge branch 'tb/cruft-packs'	2022-06-03 14:30:37 -07:00
midx.h	…
name-hash.c	…
notes-cache.c	…
notes-cache.h	…
notes-merge.c	…
notes-merge.h	…
notes-utils.c	…
notes-utils.h	…
notes.c	…
notes.h	…
object-file.c	object-file.c: add "stream_loose_object()" to handle large object	2022-06-13 10:22:35 -07:00
object-name.c	object-name: diagnose trees in index properly	2022-04-26 13:56:39 -07:00
object-store.h	object-file.c: add "stream_loose_object()" to handle large object	2022-06-13 10:22:35 -07:00
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	…
pack-bitmap.c	Merge branch 'tb/midx-race-in-pack-objects'	2022-06-03 14:30:35 -07:00
pack-bitmap.h	…
pack-check.c	…
pack-mtimes.c	pack-mtimes: support reading .mtimes files	2022-05-26 15:48:26 -07:00
pack-mtimes.h	pack-mtimes: support reading .mtimes files	2022-05-26 15:48:26 -07:00
pack-objects.c	pack-mtimes: support writing pack .mtimes files	2022-05-26 15:48:26 -07:00
pack-objects.h	pack-mtimes: support writing pack .mtimes files	2022-05-26 15:48:26 -07:00
pack-revindex.c	…
pack-revindex.h	…
pack-write.c	pack-mtimes: support writing pack .mtimes files	2022-05-26 15:48:26 -07:00
pack.h	pack-mtimes: support writing pack .mtimes files	2022-05-26 15:48:26 -07:00
packfile.c	Merge branch 'tb/cruft-packs'	2022-06-03 14:30:37 -07:00
packfile.h	…
pager.c	…
parallel-checkout.c	…
parallel-checkout.h	…
parse-options-cb.c	…
parse-options.c	…
parse-options.h	…
patch-delta.c	…
patch-ids.c	…
patch-ids.h	…
path.c	Merge branch 'ds/bundle-uri'	2022-06-03 14:30:34 -07:00
path.h	…
pathspec.c	…
pathspec.h	…
pkt-line.c	…
pkt-line.h	…
preload-index.c	…
pretty.c	…
pretty.h	…
prio-queue.c	tree-wide: apply equals-null.cocci	2022-05-02 09:50:37 -07:00
prio-queue.h	…
progress.c	…
progress.h	…
promisor-remote.c	tree-wide: apply equals-null.cocci	2022-05-02 09:50:37 -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: report precise timestamps from objects in cruft packs	2022-05-26 15:48:26 -07:00
reachable.h	builtin/pack-objects.c: --cruft with expiration	2022-05-26 15:48:26 -07:00
read-cache.c	Merge branch 'ds/sparse-sparse-checkout'	2022-06-03 14:30:35 -07:00
rebase-interactive.c	…
rebase-interactive.h	…
rebase.c	…
rebase.h	…
ref-filter.c	Merge branch 'ep/maint-equals-null-cocci'	2022-05-20 15:26:59 -07:00
ref-filter.h	…
reflog-walk.c	…
reflog-walk.h	…
reflog.c	…
reflog.h	…
refs.c	clone: die() instead of BUG() on bad refs	2022-04-25 11:05:28 -07:00
refs.h	Revert "Merge branch 'ps/avoid-unnecessary-hook-invocation-with-packed-refs'"	2022-04-13 15:51:33 -07:00
refspec.c	…
refspec.h	…
remote-curl.c	…
remote.c	Merge branch 'ds/bundle-uri'	2022-06-03 14:30:34 -07:00
remote.h	remote: allow relative_url() to return an absolute url	2022-05-16 15:02:10 -07:00
replace-object.c	…
replace-object.h	…
repo-settings.c	…
repository.c	…
repository.h	…
rerere.c	Merge branch 'ep/maint-equals-null-cocci'	2022-05-20 15:26:59 -07:00
rerere.h	…
reset.c	…
reset.h	…
resolve-undo.c	…
resolve-undo.h	…
revision.c	Merge branch 'ep/maint-equals-null-cocci'	2022-05-20 15:26:59 -07:00
revision.h	log: "--since-as-filter" option is a non-terminating "--since" variant	2022-04-23 09:36:07 -07:00
run-command.c	…
run-command.h	…
send-pack.c	…
send-pack.h	…
sequencer.c	Merge branch 'rs/commit-summary-wo-break-rewrite'	2022-05-11 13:56:23 -07:00
sequencer.h	…
serve.c	…
serve.h	…
server-info.c	…
setup.c	setup: don't die if realpath(3) fails on getcwd(3)	2022-05-24 22:08:31 -07:00
sh-i18n--envsubst.c	tree-wide: apply equals-null.cocci	2022-05-02 09:50:37 -07:00
sha1dc_git.c	…
sha1dc_git.h	…
shallow.c	Merge branch 'ep/maint-equals-null-cocci'	2022-05-20 15:26:59 -07:00
shallow.h	…
shared.mak	Makefile: add "po-init" rule to initialize po/XX.po	2022-05-26 10:32:57 -07:00
shell.c	…
shortlog.h	…
sideband.c	…
sideband.h	…
sigchain.c	…
sigchain.h	…
simple-ipc.h	…
sparse-index.c	Merge branch 'ds/sparse-sparse-checkout'	2022-06-03 14:30:35 -07:00
sparse-index.h	Merge branch 'ds/sparse-sparse-checkout'	2022-06-03 14:30:35 -07:00
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	dir API: add a generalized path_match_flags() function	2022-05-16 15:02:09 -07:00
submodule-config.h	Merge branch 'pb/submodule-recurse-mode-enum'	2022-05-20 15:26:53 -07:00
submodule.c	…
submodule.h	Merge branch 'pb/submodule-recurse-mode-enum'	2022-05-20 15:26:53 -07:00
symlinks.c	…
tag.c	…
tag.h	…
tar.h	…
tempfile.c	tempfile: add mks_tempfile_dt()	2022-04-20 16:17:33 -07:00
tempfile.h	tempfile: add mks_tempfile_dt()	2022-04-20 16:17:33 -07:00
thread-utils.c	…
thread-utils.h	…
tmp-objdir.c	…
tmp-objdir.h	…
trace.c	…
trace.h	…
trace2.c	…
trace2.h	…
trailer.c	Merge branch 'ep/maint-equals-null-cocci' for maint-2.35	2022-05-02 10:06:04 -07:00
trailer.h	…
transport-helper.c	…
transport-internal.h	…
transport.c	Merge branch 'ep/maint-equals-null-cocci'	2022-05-20 15:26:59 -07:00
transport.h	push: new config option "push.autoSetupRemote" supports "simple" push	2022-04-29 11:20:55 -07: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	Merge branch 'ds/sparse-sparse-checkout'	2022-06-03 14:30:35 -07:00
unpack-trees.h	…
upload-pack.c	…
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	…
walker.h	…
wildmatch.c	tree-wide: apply equals-null.cocci	2022-05-02 09:50:37 -07:00
wildmatch.h	…
worktree.c	Merge branch 'ep/maint-equals-null-cocci'	2022-05-20 15:26:59 -07:00
worktree.h	…
wrap-for-bin.sh	…
wrapper.c	Merge branch 'ep/maint-equals-null-cocci'	2022-05-20 15:26:59 -07:00
write-or-die.c	…
ws.c	…
wt-status.c	…
wt-status.h	…
xdiff-interface.c	Merge branch 'ep/maint-equals-null-cocci' for maint-2.35	2022-05-02 10:06:04 -07:00
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