Go to file
Linus Arver c1e4b2b18e trailer: make trailer_info struct private
In 13211ae23f (trailer: separate public from internal portion of
trailer_iterator, 2023-09-09) we moved trailer_info behind an anonymous
struct to discourage use by trailer.h API users. However it still left
open the possibility of external use of trailer_info itself. Now that
there are no external users of trailer_info, we can make this struct
private.

Make this struct private by putting its definition inside trailer.c.
This has two benefits:

  (1) it makes the surface area of the public facing
      interface (trailer.h) smaller, and

  (2) external API users are unable to peer inside this struct (because
      it is only ever exposed as an opaque pointer).

There are a few disadvantages:

  (A) every time the member of the struct is accessed an extra pointer
      dereference must be done, and

  (B) for users of trailer_info outside trailer.c, this struct can no
      longer be allocated on the stack and may only be allocated on the
      heap (because its definition is hidden away in trailer.c) and
      appropriately deallocated by the user, and

  (C) without good documentation on the API, the opaque struct is
      hostile to programmers by going opposite to the "Show me your
      data structures, and I won't usually need your code; it'll
      be obvious." mantra [2].

(The disadvantages have already been observed in the two preparatory
commits that precede this one.) This commit believes that the benefits
outweigh the disadvantages for designing APIs, as explained below.

Making trailer_info private exposes existing deficiencies in the API.
This is because users of this struct had full access to its internals,
so there wasn't much need to actually design it to be "complete" in the
sense that API users only needed to use what was provided by the API.
For example, the location of the trailer block (start/end offsets
relative to the start of the input text) was accessible by looking at
these struct members directly. Now that the struct is private, we have
to expose new API functions to allow clients to access this
information (see builtin/interpret-trailers.c).

The idea in this commit to hide implementation details behind an "opaque
pointer" is also known as the "pimpl" (pointer to implementation) idiom
in C++ and is a common pattern in that language (where, for example,
abstract classes only have pointers to concrete classes).

However, the original inspiration to use this idiom does not come from
C++, but instead the book "C Interfaces and Implementations: Techniques
for Creating Reusable Software" [1]. This book recommends opaque
pointers as a good design principle for designing C libraries, using the
term "interface" as the functions defined in *.h (header) files and
"implementation" as the corresponding *.c file which define the
interfaces.

The book says this about opaque pointers:

    ... clients can manipulate such pointers freely, but they can’t
    dereference them; that is, they can’t look at the innards of the
    structure pointed to by them. Only the implementation has that
    privilege. Opaque pointers hide representation details and help
    catch errors.

In our case, "struct trailer_info" is now hidden from clients, and the
ways in which this opaque pointer can be used is limited to the richness
of <trailer.h>. In other words, <trailer.h> exclusively controls exactly
how "trailer_info" pointers are to be used.

[1] Hanson, David R. "C Interfaces and Implementations: Techniques for
    Creating Reusable Software". Addison Wesley, 1997. p. 22

[2] Raymond, Eric S. "The Cathedral and the Bazaar: Musings on Linux and
    Open Source by an Accidental Revolutionary". O'Reilly, 1999.

Helped-by: Junio C Hamano <gitster@pobox.com>
Helped-by: Christian Couder <chriscool@tuxfamily.org>
Signed-off-by: Linus Arver <linus@ucla.edu>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2024-05-02 09:57:08 -07:00
.github Merge branch 'ps/reftable-backend' 2024-02-26 18:10:23 -08:00
Documentation The eighth batch 2024-03-15 16:06:00 -07:00
block-sha1
builtin trailer: make parse_trailers() return trailer_info pointer 2024-05-02 09:57:08 -07:00
ci Merge branch 'js/ci-discard-prove-state' into maint-2.43 2024-02-08 16:22:00 -08:00
compat Merge branch 'jc/no-include-of-compat-util-from-headers' 2024-03-05 09:44:42 -08:00
contrib Merge branch 'rj/complete-worktree-paths-fix' 2024-03-14 14:05:25 -07:00
ewah
git-gui Merge branch 'js/update-urls-in-doc-and-comment' into maint-2.43 2024-02-08 16:22:01 -08:00
gitk-git
gitweb Merge branch 'js/update-urls-in-doc-and-comment' into maint-2.43 2024-02-08 16:22:01 -08:00
mergetools mergetools: vimdiff: use correct tool's name when reading mergetool config 2024-02-19 08:45:14 -08:00
negotiator
oss-fuzz Merge branch 'js/oss-fuzz-build-in-ci' 2024-01-29 16:03:00 -08:00
perl Merge branch 'js/update-urls-in-doc-and-comment' into maint-2.43 2024-02-08 16:22:01 -08:00
po l10n: zh_TW: Git 2.44 2024-02-18 21:03:43 +08:00
refs Merge branch 'ps/reftable-iteration-perf-part2' 2024-03-14 14:05:23 -07:00
reftable reftable: allow inlining of a few functions 2024-03-04 10:19:49 -08:00
sha1
sha1collisiondetection@855827c583
sha1dc
sha256
t trailer: teach iterator about non-trailer lines 2024-05-02 09:57:08 -07:00
templates Merge branch 'jp/use-diff-index-in-pre-commit-sample' into maint-2.43 2024-02-08 16:22:02 -08:00
trace2 Merge branch 'en/header-cleanup' into maint-2.43 2024-02-08 16:22:10 -08:00
xdiff
.cirrus.yml Merge branch 'cb/use-freebsd-13-2-at-cirrus-ci' 2024-02-06 14:31:22 -08:00
.clang-format
.editorconfig
.gitattributes
.gitignore
.gitlab-ci.yml ci: add jobs to test with the reftable backend 2024-02-07 08:28:37 -08:00
.gitmodules
.mailmap
.tsan-suppressions
CODE_OF_CONDUCT.md CoC: whitespace fix 2024-01-23 10:40:10 -08:00
COPYING
GIT-VERSION-GEN The fourth batch 2024-03-05 09:44:44 -08:00
INSTALL Merge branch 'js/update-urls-in-doc-and-comment' into maint-2.43 2024-02-08 16:22:01 -08:00
LGPL-2.1
Makefile trailer: add unit tests for trailer iterator 2024-05-02 09:57:03 -07:00
README.md Merge branch 'jc/majordomo-to-subspace' into maint-2.43 2024-02-13 14:44:50 -08:00
RelNotes Start the 2.45 cycle 2024-02-26 18:10:25 -08:00
SECURITY.md
abspath.c
abspath.h
aclocal.m4
add-interactive.c
add-interactive.h
add-patch.c add-patch: classify '@' as a synonym for 'HEAD' 2024-02-13 14:12:51 -08:00
advice.c Merge branch 'kh/branch-ref-syntax-advice' 2024-03-15 16:05:59 -07:00
advice.h Merge branch 'kh/branch-ref-syntax-advice' 2024-03-15 16:05:59 -07:00
alias.c
alias.h
alloc.c
alloc.h
apply.c Merge branch 'jc/am-whitespace-doc' 2024-02-27 16:04:31 -08:00
apply.h
archive-tar.c use xstrncmpz() 2024-02-12 09:32:41 -08:00
archive-zip.c
archive.c Merge branch 'en/header-cleanup' into maint-2.43 2024-02-08 16:22:10 -08:00
archive.h
attr.c
attr.h
banned.h
base85.c
base85.h
bisect.c commit-reach(repo_get_merge_bases_many): pass on "missing commits" errors 2024-02-29 08:06:01 -08:00
bisect.h
blame.c
blame.h
blob.c
blob.h
bloom.c
bloom.h
branch.c branch: advise about ref syntax rules 2024-03-05 13:04:26 -08:00
branch.h
builtin.h
bulk-checkin.c
bulk-checkin.h
bundle-uri.c
bundle-uri.h
bundle.c
bundle.h
cache-tree.c Merge branch 'js/merge-tree-3-trees' 2024-03-07 15:59:41 -08:00
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: guard against negative padding 2024-02-13 10:18:57 -08:00
column.h
combine-diff.c Merge branch 'js/check-null-from-read-object-file' 2024-02-14 15:36:06 -08:00
command-list.txt
commit-graph.c Merge branch 'en/header-cleanup' into maint-2.43 2024-02-08 16:22:10 -08:00
commit-graph.h
commit-reach.c commit-reach(repo_get_merge_bases_many_dirty): pass on errors 2024-02-29 08:06:01 -08:00
commit-reach.h commit-reach(repo_get_merge_bases_many_dirty): pass on errors 2024-02-29 08:06:01 -08:00
commit-slab-decl.h
commit-slab-impl.h
commit-slab.h
commit.c commit-reach(repo_get_merge_bases_many): pass on "missing commits" errors 2024-02-29 08:06:01 -08:00
commit.h
common-main.c
config.c Merge branch 'en/header-cleanup' into maint-2.43 2024-02-08 16:22:10 -08:00
config.h config: factor out global config file retrieval 2024-01-18 12:17:41 -08:00
config.mak.dev
config.mak.in
config.mak.uname build: support z/OS (OS/390). 2024-03-06 08:10:58 -08:00
configure.ac
connect.c
connect.h
connected.c
connected.h
convert.c use xstrncmpz() 2024-02-12 09:32:41 -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 commit-reach(repo_get_merge_bases): pass on "missing commits" errors 2024-02-29 08:06:01 -08:00
diff-merges.c
diff-merges.h
diff-no-index.c
diff.c Merge branch 'jx/dirstat-parseopt-help' 2024-02-15 15:14:48 -08:00
diff.h
diffcore-break.c
diffcore-delta.c Merge branch 'en/diffcore-delta-final-line-fix' into maint-2.43 2024-02-13 14:44:48 -08:00
diffcore-order.c
diffcore-pickaxe.c
diffcore-rename.c
diffcore-rotate.c
diffcore.h
dir-iterator.c dir-iterator: support iteration in sorted order 2024-02-21 09:58:05 -08:00
dir-iterator.h dir-iterator: support iteration in sorted order 2024-02-21 09:58:05 -08:00
dir.c dir: create untracked_cache_invalidate_trimmed_path() 2024-02-26 15:34:02 -08:00
dir.h dir: create untracked_cache_invalidate_trimmed_path() 2024-02-26 15:34:02 -08:00
editor.c
editor.h
entry.c
entry.h
environment.c Merge branch 'jc/no-lazy-fetch' 2024-03-07 15:59:40 -08:00
environment.h git: extend --no-lazy-fetch to work across subprocesses 2024-02-27 09:53:14 -08:00
exec-cmd.c
exec-cmd.h
fetch-negotiator.c
fetch-negotiator.h
fetch-pack.c Merge branch 'sd/negotiate-trace-fix' into maint-2.43 2024-02-13 14:44:50 -08:00
fetch-pack.h
fmt-merge-msg.c
fmt-merge-msg.h
fsck.c Merge branch 'en/header-cleanup' into maint-2.43 2024-02-08 16:22:10 -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: support case-insensitive events 2024-03-06 09:10:06 -08:00
fsmonitor.h
generate-cmdlist.sh
generate-configlist.sh
generate-hooklist.sh
gettext.c
gettext.h
git-archimport.perl
git-compat-util.h Merge branch 'tb/multi-pack-verbatim-reuse' 2024-01-12 16:09:56 -08:00
git-curl-compat.h
git-cvsexportcommit.perl
git-cvsimport.perl Merge branch 'js/update-urls-in-doc-and-comment' into maint-2.43 2024-02-08 16:22:01 -08:00
git-cvsserver.perl
git-difftool--helper.sh git-difftool--helper: honor `--trust-exit-code` with `--dir-diff` 2024-02-20 09:30:32 -08:00
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 'jt/p4-spell-re-with-raw-string' 2024-02-06 14:31:20 -08:00
git-quiltimport.sh
git-request-pull.sh
git-send-email.perl Merge branch 'tz/send-email-negatable-options' into maint-2.43 2024-02-08 16:22:01 -08:00
git-sh-i18n.sh
git-sh-setup.sh
git-submodule.sh
git-svn.perl Merge branch 'tz/send-email-negatable-options' into maint-2.43 2024-02-08 16:22:01 -08:00
git-web--browse.sh
git-zlib.c
git-zlib.h
git.c Merge branch 'jc/no-lazy-fetch' 2024-03-07 15:59:40 -08:00
git.rc
gpg-interface.c Merge branch 'jc/sign-buffer-failure-propagation-fix' into maint-2.43 2024-02-13 14:44:48 -08:00
gpg-interface.h tag: fix sign_buffer() call to create a signed tag 2024-02-07 10:47:25 -08:00
graph.c
graph.h
grep.c
grep.h
hash-ll.h
hash-lookup.c
hash-lookup.h
hash.h
hashmap.c
hashmap.h
help.c
help.h
hex-ll.c
hex-ll.h
hex.c
hex.h
hook.c
hook.h
http-backend.c http-backend: new rpc-service for git-upload-archive 2024-01-22 07:54:37 -08:00
http-fetch.c
http-push.c commit-reach(repo_in_merge_bases_many): report missing commits 2024-02-28 09:47:03 -08:00
http-walker.c
http.c Merge branch 'en/header-cleanup' into maint-2.43 2024-02-08 16:22:10 -08:00
http.h
ident.c
ident.h
imap-send.c Merge branch 'pb/imap-send-wo-curl-build-fix' into maint-2.43 2024-02-12 09:57:59 -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 oidset: refactor oidset_insert_from_set() 2024-02-14 09:39:14 -08:00
list-objects-filter.h
list-objects.c
list-objects.h
list.h
lockfile.c
lockfile.h
log-tree.c commit-reach(repo_get_merge_bases): pass on "missing commits" errors 2024-02-29 08:06:01 -08:00
log-tree.h
ls-refs.c
ls-refs.h
mailinfo.c Merge branch 'jk/mailinfo-iterative-unquote-comment' into maint-2.43 2024-02-08 16:22:03 -08:00
mailinfo.h
mailmap.c
mailmap.h
match-trees.c
match-trees.h
mem-pool.c mem-pool: add mem_pool_strfmt() 2024-02-26 09:35:40 -08:00
mem-pool.h mem-pool: add mem_pool_strfmt() 2024-02-26 09:35:40 -08:00
merge-blobs.c
merge-blobs.h
merge-ll.c Merge branch 'rs/use-xstrncmpz' 2024-02-26 18:10:24 -08:00
merge-ll.h
merge-ort-wrappers.c
merge-ort-wrappers.h
merge-ort.c Merge branch 'js/merge-base-with-missing-commit' 2024-03-11 14:12:30 -07:00
merge-ort.h
merge-recursive.c Merge branch 'js/merge-base-with-missing-commit' 2024-03-11 14:12:30 -07:00
merge-recursive.h
merge.c Merge branch 'js/merge-tree-3-trees' 2024-03-07 15:59:41 -08:00
merge.h
mergesort.h
midx.c
midx.h Merge branch 'tb/multi-pack-verbatim-reuse' 2024-01-12 16:09:56 -08:00
name-hash.c name-hash: add index_dir_find() 2024-02-26 15:34:01 -08:00
name-hash.h name-hash: add index_dir_find() 2024-02-26 15:34:01 -08:00
notes-cache.c
notes-cache.h
notes-merge.c commit-reach(repo_get_merge_bases): pass on "missing commits" errors 2024-02-29 08:06:01 -08:00
notes-merge.h
notes-utils.c Merge branch 'en/header-cleanup' into maint-2.43 2024-02-08 16:22:10 -08:00
notes-utils.h
notes.c
notes.h
object-file.c
object-file.h
object-name.c Merge branch 'js/merge-base-with-missing-commit' 2024-03-11 14:12:30 -07:00
object-name.h
object-store-ll.h
object-store.h
object.c Merge branch 'jk/upload-pack-bounded-resources' 2024-03-07 15:59:42 -08:00
object.h upload-pack: free tree buffers after parsing 2024-02-28 14:42:01 -08:00
oid-array.c
oid-array.h
oidmap.c
oidmap.h
oidset.c oidset: refactor oidset_insert_from_set() 2024-02-14 09:39:14 -08:00
oidset.h oidset: refactor oidset_insert_from_set() 2024-02-14 09:39:14 -08:00
oidtree.c
oidtree.h
pack-bitmap-write.c Merge branch 'tb/multi-pack-verbatim-reuse' 2024-01-12 16:09:56 -08:00
pack-bitmap.c Merge branch 'tb/pack-bitmap-drop-unused-struct-member' 2024-02-06 14:31:20 -08:00
pack-bitmap.h
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
packfile.h
pager.c
pager.h
parallel-checkout.c
parallel-checkout.h
parse-options-cb.c
parse-options.c Merge branch 'rs/parse-options-with-keep-unknown-abbrev-fix' into maint-2.43 2024-02-13 14:44:48 -08:00
parse-options.h
parse.c
parse.h
patch-delta.c
patch-ids.c
patch-ids.h
path.c refs: introduce reftable backend 2024-02-07 08:28:37 -08:00
path.h refs: introduce reftable backend 2024-02-07 08:28:37 -08:00
pathspec.c
pathspec.h
pkt-line.c Merge branch 'jx/sideband-chomp-newline-fix' into maint-2.43 2024-02-08 16:22:11 -08:00
pkt-line.h Merge branch 'jx/sideband-chomp-newline-fix' into maint-2.43 2024-02-08 16:22:11 -08:00
preload-index.c
preload-index.h
pretty.c trailer: reorder format_trailers_from_commit() parameters 2024-03-01 10:35:42 -08:00
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
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 prune: mark rebase autostash and orig-head as reachable 2024-02-09 10:04:59 -08:00
reachable.h
read-cache-ll.h
read-cache.c Merge branch 'en/header-cleanup' 2024-01-08 14:05:15 -08:00
read-cache.h
rebase-interactive.c
rebase-interactive.h
rebase.c
rebase.h
ref-filter.c Merge branch 'la/trailer-api' 2024-03-14 14:05:24 -07:00
ref-filter.h for-each-ref: add new option to include root refs 2024-02-23 10:36:28 -08:00
reflog-walk.c
reflog-walk.h
reflog.c
reflog.h
refs.c Merge branch 'kn/for-all-refs' 2024-03-05 09:44:44 -08:00
refs.h Merge branch 'kn/for-all-refs' 2024-03-05 09:44:44 -08:00
refspec.c
refspec.h
remote-curl.c Merge branch 'jx/remote-archive-over-smart-http' 2024-01-30 13:34:12 -08:00
remote.c Merge branch 'js/merge-base-with-missing-commit' 2024-03-11 14:12:30 -07:00
remote.h Merge branch 'jc/retire-cas-opt-name-constant' into maint-2.43 2024-02-08 16:22:09 -08:00
replace-object.c
replace-object.h
repo-settings.c pack-objects: enable multi-pack reuse via `feature.experimental` 2024-02-05 15:27:01 -08:00
repository.c refs: convert MERGE_AUTOSTASH to become a normal pseudo-ref 2024-01-19 11:10:41 -08:00
repository.h Merge branch 'ps/reftable-backend' 2024-02-26 18:10:23 -08:00
rerere.c Merge branch 'js/check-null-from-read-object-file' 2024-02-14 15:36:06 -08:00
rerere.h
reset.c Merge branch 'js/merge-tree-3-trees' 2024-03-07 15:59:41 -08:00
reset.h
resolve-undo.c
resolve-undo.h
revision.c Merge branch 'as/option-names-in-messages' 2024-03-15 16:05:59 -07:00
revision.h
run-command.c
run-command.h
sane-ctype.h
scalar.c
send-pack.c
send-pack.h
sequencer.c sequencer: use the trailer iterator 2024-05-02 09:57:08 -07:00
sequencer.h sequencer: introduce functions to handle autostashes via refs 2024-01-19 11:10:41 -08:00
serve.c upload-pack: disallow object-info capability by default 2024-02-28 14:42:01 -08:00
serve.h
server-info.c
server-info.h
setup.c Merge branch 'gt/core-bare-in-templates' 2024-03-14 14:05:24 -07:00
setup.h
sh-i18n--envsubst.c
sha1dc_git.c
sha1dc_git.h
shallow.c commit-reach(repo_in_merge_bases_many): report missing commits 2024-02-28 09:47:03 -08:00
shallow.h
shared.mak Makefile: simplify output of the libpath_template 2024-01-31 14:43:00 -08:00
shell.c
shortlog.h
sideband.c sideband: avoid short write(2) 2024-03-02 11:12:16 -08:00
sideband.h
sigchain.c
sigchain.h
simple-ipc.h
sparse-index.c Merge branch 'jh/sparse-index-expand-to-path-fix' 2024-02-08 13:20:34 -08:00
sparse-index.h
split-index.c
split-index.h
stable-qsort.c
statinfo.c
statinfo.h
strbuf.c
strbuf.h
streaming.c
streaming.h
string-list.c
string-list.h
strmap.c
strmap.h
strvec.c
strvec.h strvec: use correct member name in comments 2024-01-12 13:38:07 -08:00
sub-process.c
sub-process.h
submodule-config.c Merge branch 'vd/fsck-submodule-url-test' 2024-01-26 08:54:47 -08:00
submodule-config.h Merge branch 'vd/fsck-submodule-url-test' 2024-01-26 08:54:47 -08:00
submodule.c Merge branch 'js/merge-base-with-missing-commit' 2024-03-11 14:12:30 -07: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 Merge branch 'en/header-cleanup' into maint-2.43 2024-02-08 16:22:10 -08:00
trace2.h
trailer.c trailer: make trailer_info struct private 2024-05-02 09:57:08 -07:00
trailer.h trailer: make trailer_info struct private 2024-05-02 09:57:08 -07:00
transport-helper.c Merge branch 'as/option-names-in-messages' 2024-03-15 16:05:59 -07:00
transport-internal.h
transport.c Merge branch 'es/some-up-to-date-messages-must-stay' 2024-01-26 08:54:45 -08:00
transport.h
tree-diff.c
tree-walk.c fill_tree_descriptor(): mark error message for translation 2024-02-23 10:19:40 -08:00
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 Merge branch 'jk/upload-pack-v2-capability-cleanup' 2024-03-07 15:59:42 -08:00
upload-pack.h
url.c
url.h
urlmatch.c
urlmatch.h
usage.c
userdiff.c Merge branch 'jk/textconv-cache-outside-repo-fix' 2024-03-05 09:44:42 -08:00
userdiff.h
utf8.c
utf8.h
varint.c
varint.h
version.c
version.h
versioncmp.c
versioncmp.h
walker.c
walker.h
wildmatch.c
wildmatch.h
worktree.c Merge branch 'rj/status-bisect-while-rebase' into maint-2.43 2024-02-08 16:22:04 -08:00
worktree.h
wrap-for-bin.sh
wrapper.c
wrapper.h
write-or-die.c write-or-die: fix the polarity of GIT_FLUSH environment variable 2024-02-13 11:57:28 -08:00
write-or-die.h
ws.c
ws.h
wt-status.c Merge branch 'jt/commit-redundant-scissors-fix' 2024-03-07 15:59:41 -08:00
wt-status.h commit: avoid redundant scissor line with --cleanup=scissors -v 2024-02-27 09:40:46 -08:00
xdiff-interface.c Merge branch 'en/header-cleanup' into maint-2.43 2024-02-08 16:22:10 -08:00
xdiff-interface.h

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 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