Go to file

Patrick Steinhardt d9ecf268ef odb: embed base source in the "files" backend The "files" backend is implemented as a pointer in the `struct odb_source`. This contradicts our typical pattern for pluggable backends like we use it for example in the ref store or for object database streams, where we typically embed the generic base structure in the specialized implementation. This pattern has a couple of small benefits: - We avoid an extra allocation. - We hide implementation details in the generic structure. - We can easily downcast from a generic backend to the specialized structure and vice versa because the offsets are known at compile time. - It becomes trivial to identify locations where we depend on backend specific logic because the cast needs to be explicit. Refactor our "files" object database source to do the same and embed the `struct odb_source` in the `struct odb_source_files`. There are still a bunch of sites in our code base where we do have to access internals of the "files" backend. The intent is that those will go away over time, but this will certainly take a while. Meanwhile, provide a `odb_source_files_downcast()` function that can convert a generic source into a "files" source. As we only have a single source the downcast succeeds unconditionally for now. Eventually though the intent is to make the cast `BUG()` in case the caller requests to downcast a non-"files" backend to a "files" backend. Signed-off-by: Patrick Steinhardt <ps@pks.im> Signed-off-by: Junio C Hamano <gitster@pobox.com>		2026-03-05 11:45:15 -08:00
.github	Merge branch 'am/doc-github-contributiong-link-to-submittingpatches'	2026-02-11 12:29:07 -08:00
Documentation	The 6th batch	2026-02-20 11:36:18 -08:00
bin-wrappers	…
block-sha1	…
builtin	odb: embed base source in the "files" backend	2026-03-05 11:45:15 -08:00
ci	ci: ubuntu: use GNU coreutils for dirname	2026-02-06 20:58:44 -08:00
compat	Merge branch 'pc/lockfile-pid'	2026-02-17 13:30:41 -08:00
compiler-tricks	…
contrib	Merge branch 'jc/ci-test-contrib-too'	2026-02-13 13:39:26 -08:00
ewah	cocci: extend MEMZERO_ARRAY() rules	2026-02-03 09:41:52 -08:00
git-gui	Merge branch 'master' of https://github.com/j6t/git-gui	2026-01-25 09:08:06 -08:00
gitk-git	Merge branch 'master' of https://github.com/j6t/gitk	2026-02-11 14:49:53 -08:00
gitweb	…
mergetools	…
negotiator	…
odb	odb: embed base source in the "files" backend	2026-03-05 11:45:15 -08:00
oss-fuzz	…
perl	…
po	Merge branch 'jx/zh_CN' of github.com:jiangxin/git	2026-01-31 21:32:54 +08:00
refs	Merge branch 'kn/ref-batch-output-error-reporting-fix'	2026-02-09 12:09:10 -08:00
reftable	…
sha1	…
sha1collisiondetection@855827c583	…
sha1dc	…
sha256	…
src	…
subprojects	…
t	Merge branch 'ak/t9812-test-path-is-helpers'	2026-02-20 11:36:18 -08:00
templates	…
trace2	…
xdiff	Merge branch 'pw/diff-anchored-optim'	2026-02-20 11:36:18 -08:00
.cirrus.yml	…
.clang-format	…
.editorconfig	…
.gitattributes	git-gui: mark *.po files at any directory level as UTF-8	2026-01-25 10:53:08 +01:00
.gitignore	…
.gitlab-ci.yml	…
.gitmodules	…
.mailmap	.mailmap: fix email for Phil Hord	2026-02-03 10:29:00 -08:00
.tsan-suppressions	…
CODE_OF_CONDUCT.md	…
COPYING	…
Cargo.toml	…
GIT-BUILD-OPTIONS.in	…
GIT-VERSION-FILE.in	…
GIT-VERSION-GEN	Start 2.54 cycle	2026-02-05 15:42:01 -08:00
INSTALL	…
LGPL-2.1	…
Makefile	odb: introduce "files" source	2026-03-05 11:45:14 -08:00
README.md	…
RelNotes	Start 2.54 cycle	2026-02-05 15:42:01 -08:00
SECURITY.md	…
abspath.c	…
abspath.h	…
aclocal.m4	…
add-interactive.c	…
add-interactive.h	…
add-patch.c	Merge branch 'cf/c23-const-preserving-strchr-updates-0'	2026-02-13 13:39:25 -08:00
advice.c	…
advice.h	…
alias.c	…
alias.h	…
alloc.c	…
alloc.h	…
apply.c	Merge branch 'rs/xdiff-wo-the-repository'	2026-02-17 13:30:42 -08:00
apply.h	…
archive-tar.c	…
archive-zip.c	…
archive.c	…
archive.h	…
attr.c	…
attr.h	…
banned.h	…
base85.c	…
base85.h	…
bisect.c	…
bisect.h	…
blame.c	…
blame.h	…
blob.c	…
blob.h	…
bloom.c	…
bloom.h	…
branch.c	…
branch.h	…
builtin.h	Merge branch 'ps/history'	2026-02-09 12:09:09 -08:00
bundle-uri.c	…
bundle-uri.h	…
bundle.c	…
bundle.h	…
cache-tree.c	…
cache-tree.h	…
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	odb: embed base source in the "files" backend	2026-03-05 11:45:15 -08:00
commit-graph.h	…
commit-reach.c	…
commit-reach.h	…
commit-slab-decl.h	…
commit-slab-impl.h	…
commit-slab.h	…
commit.c	Merge branch 'rs/commit-commit-stack'	2026-02-17 13:30:42 -08:00
commit.h	…
common-exit.c	…
common-init.c	…
common-init.h	…
common-main.c	…
config.c	global: constify some pointers that are not written to	2026-02-05 17:52:49 -08:00
config.h	…
config.mak.dev	…
config.mak.in	…
config.mak.uname	…
configure.ac	…
connect.c	…
connect.h	…
connected.c	…
connected.h	…
convert.c	global: constify some pointers that are not written to	2026-02-05 17:52:49 -08:00
convert.h	…
copy.c	…
copy.h	…
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	…
delta-islands.h	…
delta.h	…
detect-compiler	…
diagnose.c	…
diagnose.h	…
diff-delta.c	…
diff-lib.c	Merge branch 'ps/commit-list-functions-renamed'	2026-02-13 13:39:25 -08:00
diff-merges.c	…
diff-merges.h	…
diff-no-index.c	…
diff.c	Merge branch 'cf/c23-const-preserving-strchr-updates-0'	2026-02-13 13:39:25 -08:00
diff.h	…
diffcore-break.c	…
diffcore-delta.c	cocci: extend MEMZERO_ARRAY() rules	2026-02-03 09:41:52 -08:00
diffcore-order.c	…
diffcore-pickaxe.c	…
diffcore-rename.c	global: constify some pointers that are not written to	2026-02-05 17:52:49 -08:00
diffcore-rotate.c	…
diffcore.h	…
dir-iterator.c	…
dir-iterator.h	…
dir.c	…
dir.h	…
editor.c	…
editor.h	…
entry.c	…
entry.h	…
environment.c	Merge branch 'pc/lockfile-pid'	2026-02-17 13:30:41 -08:00
environment.h	Merge branch 'rs/tree-wo-the-repository'	2026-01-21 16:16:28 -08:00
exec-cmd.c	…
exec-cmd.h	…
fetch-negotiator.c	…
fetch-negotiator.h	…
fetch-pack.c	…
fetch-pack.h	…
fmt-merge-msg.c	Merge branch 'ps/commit-list-functions-renamed'	2026-02-13 13:39:25 -08:00
fmt-merge-msg.h	…
for-each-ref.h	…
fsck.c	global: constify some pointers that are not written to	2026-02-05 17:52:49 -08:00
fsck.h	…
fsmonitor--daemon.h	…
fsmonitor-ipc.c	…
fsmonitor-ipc.h	…
fsmonitor-ll.h	…
fsmonitor-path-utils.h	…
fsmonitor-settings.c	…
fsmonitor-settings.h	…
fsmonitor.c	…
fsmonitor.h	…
generate-cmdlist.sh	…
generate-configlist.sh	…
generate-hooklist.sh	…
generate-perl.sh	…
generate-python.sh	…
generate-script.sh	…
gettext.c	…
gettext.h	…
git-archimport.perl	…
git-compat-util.h	…
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	…
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-zlib.c	…
git-zlib.h	…
git.c	…
git.rc.in	…
gpg-interface.c	gpg-interface: remove an unnecessary NULL initialization	2026-02-05 17:59:19 -08:00
gpg-interface.h	…
graph.c	…
graph.h	…
grep.c	…
grep.h	…
hash-lookup.c	…
hash-lookup.h	…
hash.c	…
hash.h	…
hashmap.c	…
hashmap.h	…
help.c	Merge branch 'cf/c23-const-preserving-strchr-updates-0'	2026-02-13 13:39:25 -08:00
help.h	…
hex-ll.c	…
hex-ll.h	…
hex.c	…
hex.h	…
hook.c	…
hook.h	…
http-backend.c	Merge branch 'kt/http-backend-errors'	2026-01-21 08:28:58 -08:00
http-fetch.c	…
http-push.c	global: constify some pointers that are not written to	2026-02-05 17:52:49 -08:00
http-walker.c	…
http.c	odb: embed base source in the "files" backend	2026-03-05 11:45:15 -08:00
http.h	…
ident.c	…
ident.h	…
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-options.h	…
list-objects-filter.c	…
list-objects-filter.h	…
list-objects.c	…
list-objects.h	…
list.h	…
lockfile.c	Merge branch 'pc/lockfile-pid'	2026-02-17 13:30:41 -08:00
lockfile.h	lockfile: add PID file for debugging stale locks	2026-01-22 12:15:46 -08:00
log-tree.c	…
log-tree.h	…
loose.c	odb: embed base source in the "files" backend	2026-03-05 11:45:15 -08:00
loose.h	…
ls-refs.c	…
ls-refs.h	…
mailinfo.c	global: constify some pointers that are not written to	2026-02-05 17:52:49 -08:00
mailinfo.h	…
mailmap.c	…
mailmap.h	…
match-trees.c	…
match-trees.h	…
mem-pool.c	global: constify some pointers that are not written to	2026-02-05 17:52:49 -08:00
mem-pool.h	…
merge-blobs.c	…
merge-blobs.h	…
merge-ll.c	…
merge-ll.h	…
merge-ort-wrappers.c	…
merge-ort-wrappers.h	…
merge-ort.c	Merge branch 'rs/xdiff-wo-the-repository'	2026-02-17 13:30:42 -08:00
merge-ort.h	…
merge.c	…
merge.h	…
mergesort.h	…
meson.build	odb: introduce "files" source	2026-03-05 11:45:14 -08:00
meson_options.txt	…
midx-write.c	Merge branch 'tb/midx-write-corrupt-checksum-fix'	2026-01-21 16:16:27 -08:00
midx.c	odb: embed base source in the "files" backend	2026-03-05 11:45:15 -08:00
midx.h	…
name-hash.c	…
name-hash.h	…
notes-cache.c	…
notes-cache.h	…
notes-merge.c	Merge branch 'rs/xdiff-wo-the-repository'	2026-02-17 13:30:42 -08:00
notes-merge.h	…
notes-utils.c	…
notes-utils.h	…
notes.c	string-list: add string_list_sort_u() that mimics "sort -u"	2026-01-29 09:32:50 -08:00
notes.h	…
object-file-convert.c	remove duplicate includes	2026-02-08 15:03:06 -08:00
object-file-convert.h	…
object-file.c	odb: embed base source in the "files" backend	2026-03-05 11:45:15 -08:00
object-file.h	Merge branch 'ps/object-info-bits-cleanup' into ps/odb-sources	2026-02-23 13:48:48 -08:00
object-name.c	Merge branch 'ps/commit-list-functions-renamed'	2026-02-13 13:39:25 -08:00
object-name.h	…
object.c	…
object.h	…
odb.c	odb: embed base source in the "files" backend	2026-03-05 11:45:15 -08:00
odb.h	odb: split `struct odb_source` into separate header	2026-03-05 11:45:14 -08:00
oid-array.c	…
oid-array.h	…
oidmap.c	…
oidmap.h	…
oidset.c	…
oidset.h	…
oidtree.c	…
oidtree.h	…
pack-bitmap-write.c	Merge branch 'ps/commit-list-functions-renamed'	2026-02-13 13:39:25 -08:00
pack-bitmap.c	…
pack-bitmap.h	…
pack-check.c	…
pack-mtimes.c	…
pack-mtimes.h	…
pack-objects.c	…
pack-objects.h	…
pack-refs.c	…
pack-refs.h	…
pack-revindex.c	global: constify some pointers that are not written to	2026-02-05 17:52:49 -08:00
pack-revindex.h	…
pack-write.c	…
pack.h	…
packfile.c	odb: embed base source in the "files" backend	2026-03-05 11:45:15 -08:00
packfile.h	odb: embed base source in the "files" backend	2026-03-05 11:45:15 -08:00
pager.c	…
pager.h	…
parallel-checkout.c	…
parallel-checkout.h	…
parse-options-cb.c	…
parse-options.c	…
parse-options.h	…
parse.c	…
parse.h	…
patch-delta.c	…
patch-ids.c	…
patch-ids.h	…
path-walk.c	…
path-walk.h	…
path.c	…
path.h	…
pathspec.c	…
pathspec.h	…
pkt-line.c	global: constify some pointers that are not written to	2026-02-05 17:52:49 -08:00
pkt-line.h	…
preload-index.c	…
preload-index.h	…
pretty.c	…
pretty.h	…
prio-queue.c	…
prio-queue.h	…
progress.c	…
progress.h	…
promisor-remote.c	…
promisor-remote.h	…
prompt.c	…
prompt.h	…
protocol-caps.c	remove duplicate includes	2026-02-08 15:03:06 -08:00
protocol-caps.h	…
protocol.c	…
protocol.h	…
prune-packed.c	…
prune-packed.h	…
pseudo-merge.c	…
pseudo-merge.h	…
quote.c	…
quote.h	…
range-diff.c	…
range-diff.h	…
reachable.c	reachable: convert to use `odb_for_each_object()`	2026-01-26 08:26:08 -08:00
reachable.h	…
read-cache-ll.h	…
read-cache.c	Merge branch 'js/symlink-windows'	2026-01-23 13:34:37 -08:00
read-cache.h	…
rebase-interactive.c	…
rebase-interactive.h	…
rebase.c	…
rebase.h	…
ref-filter.c	…
ref-filter.h	…
reflog-walk.c	global: constify some pointers that are not written to	2026-02-05 17:52:49 -08:00
reflog-walk.h	…
reflog.c	…
reflog.h	…
refs.c	Merge branch 'kn/ref-batch-output-error-reporting-fix'	2026-02-09 12:09:10 -08:00
refs.h	Merge branch 'kn/ref-batch-output-error-reporting-fix'	2026-02-09 12:09:10 -08:00
refspec.c	…
refspec.h	…
remote-curl.c	…
remote.c	Merge branch 'ps/commit-list-functions-renamed'	2026-02-13 13:39:25 -08:00
remote.h	…
repack-cruft.c	…
repack-filtered.c	…
repack-geometry.c	…
repack-midx.c	…
repack-promisor.c	Merge branch 'ps/odb-for-each-object' into ps/odb-sources	2026-02-23 13:48:00 -08:00
repack.c	…
repack.h	…
replace-object.c	…
replace-object.h	…
replay.c	…
replay.h	…
repo-settings.c	…
repo-settings.h	…
repository.c	Merge branch 'ar/submodule-gitdir-tweak'	2026-02-05 15:41:58 -08:00
repository.h	Merge branch 'ar/submodule-gitdir-tweak'	2026-02-05 15:41:58 -08:00
rerere.c	…
rerere.h	…
reset.c	…
reset.h	…
resolve-undo.c	…
resolve-undo.h	…
revision.c	Merge branch 'ps/odb-for-each-object' into ps/odb-sources	2026-02-23 13:48:00 -08:00
revision.h	…
run-command.c	…
run-command.h	…
sane-ctype.h	…
scalar.c	global: constify some pointers that are not written to	2026-02-05 17:52:49 -08:00
send-pack.c	…
send-pack.h	…
sequencer.c	Merge branch 'ps/commit-list-functions-renamed'	2026-02-13 13:39:25 -08:00
sequencer.h	…
serve.c	…
serve.h	…
server-info.c	…
server-info.h	…
setup.c	Merge branch 'rs/clean-includes'	2026-02-17 13:30:42 -08:00
setup.h	Merge branch 'ar/submodule-gitdir-tweak'	2026-02-05 15:41:58 -08:00
sh-i18n--envsubst.c	…
sha1dc_git.c	…
sha1dc_git.h	…
shallow.c	…
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	…
statinfo.c	…
statinfo.h	…
strbuf.c	global: constify some pointers that are not written to	2026-02-05 17:52:49 -08:00
strbuf.h	…
string-list.c	Merge branch 'cf/c23-const-preserving-strchr-updates-0'	2026-02-13 13:39:25 -08:00
string-list.h	string-list: add string_list_sort_u() that mimics "sort -u"	2026-01-29 09:32:50 -08:00
strmap.c	…
strmap.h	…
strvec.c	…
strvec.h	…
sub-process.c	…
sub-process.h	…
submodule-config.c	…
submodule-config.h	…
submodule.c	Merge branch 'ps/commit-list-functions-renamed'	2026-02-13 13:39:25 -08:00
submodule.h	…
symlinks.c	…
symlinks.h	…
tag.c	…
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	…
trailer.h	…
transport-helper.c	…
transport-internal.h	…
transport.c	global: constify some pointers that are not written to	2026-02-05 17:52:49 -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	…
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	…
userdiff.c	…
userdiff.h	…
utf8.c	…
utf8.h	…
varint.c	…
varint.h	…
version-def.h.in	…
version.c	version: stop using the_repository	2026-02-08 15:16:49 -08:00
version.h	version: stop using the_repository	2026-02-08 15:16:49 -08:00
versioncmp.c	…
versioncmp.h	…
walker.c	…
walker.h	…
wildmatch.c	…
wildmatch.h	…
worktree.c	…
worktree.h	…
wrapper.c	global: constify some pointers that are not written to	2026-02-05 17:52:49 -08:00
wrapper.h	…
write-or-die.c	…
write-or-die.h	…
ws.c	…
ws.h	…
wt-status.c	…
wt-status.h	…
xdiff-interface.c	xdiff-interface: stop using the_repository	2026-02-10 08:16:14 -08:00
xdiff-interface.h	xdiff-interface: stop using the_repository	2026-02-10 08:16:14 -08:00

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.adoc to get started, then see Documentation/giteveryday.adoc for a useful minimum set of commands, and Documentation/git-<commandname>.adoc 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.adoc (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 to git+subscribe@vger.kernel.org (see https://subspace.kernel.org/subscribing.html for details). The mailing list archives are available at https://lore.kernel.org/git/, https://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