Go to file

Phillip Wood a0e6aaea7d config: warn on core.commentString=auto As support for this setting was deprecated in the last commit print a warning (or die when WITH_BREAKING_CHANGES is enabled) if it is set. Avoid bombarding the user with warnings by only printing it (a) when running commands that call "git commit" and (b) only once per command. Some scaffolding is added to repo_read_config() to allow it to detect deprecated config settings and warn about them. As both "core.commentChar" and "core.commentString" set the comment character we record which one of them is used and tailor the warning message appropriately. Note the odd combination of die_message() followed by die(NULL) is to allow the next commit to insert a call to advise() in the middle. Signed-off-by: Phillip Wood <phillip.wood@dunelm.org.uk> Signed-off-by: Junio C Hamano <gitster@pobox.com>		2025-08-26 08:52:44 -07:00
.github	ci: use Meson's new `--slice` option	2025-07-11 09:56:34 -07:00
Documentation	breaking-changes: deprecate support for core.commentString=auto	2025-08-26 08:47:37 -07:00
bin-wrappers	…
block-sha1	…
builtin	config: warn on core.commentString=auto	2025-08-26 08:52:44 -07:00
ci	…
compat	Merge branch 'ps/config-wo-the-repository' into pw/3.0-commentchar-auto-deprecation	2025-07-31 12:28:51 -07:00
compiler-tricks	…
contrib	config: drop `git_config()` wrapper	2025-07-23 08:15:18 -07:00
ewah	…
git-gui	Merge branch 'master' of https://github.com/j6t/git-gui	2025-07-22 13:30:52 -07:00
gitk-git	Merge branch 'master' of https://github.com/j6t/gitk	2025-07-22 13:30:21 -07:00
gitweb	…
mergetools	…
negotiator	…
oss-fuzz	…
perl	…
po	po/meson.build: add missing 'ga' language code	2025-07-16 07:34:33 -07:00
refs	config: drop `git_config_get_int()` wrapper	2025-07-23 08:15:20 -07:00
reftable	…
sha1	…
sha1collisiondetection@855827c583	…
sha1dc	…
sha256	…
subprojects	meson: update subproject wrappers	2025-07-11 09:56:34 -07:00
t	config: warn on core.commentString=auto	2025-08-26 08:52:44 -07:00
templates	…
trace2	…
xdiff	…
.cirrus.yml	…
.clang-format	…
.editorconfig	…
.gitattributes	…
.gitignore	…
.gitlab-ci.yml	ci: use Meson's new `--slice` option	2025-07-11 09:56:34 -07:00
.gitmodules	…
.mailmap	…
.tsan-suppressions	…
CODE_OF_CONDUCT.md	…
COPYING	…
GIT-BUILD-OPTIONS.in	…
GIT-VERSION-FILE.in	…
GIT-VERSION-GEN	…
INSTALL	…
LGPL-2.1	…
Makefile	Merge branch 'ps/object-store'	2025-07-15 15:18:18 -07:00
README.md	…
RelNotes	…
SECURITY.md	…
abspath.c	…
abspath.h	…
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	config: drop `git_config_get_string()` wrapper	2025-07-23 08:15:19 -07:00
apply.h	…
archive-tar.c	config: drop `git_config()` wrapper	2025-07-23 08:15:18 -07:00
archive-zip.c	config: drop `git_config()` wrapper	2025-07-23 08:15:18 -07:00
archive.c	config: drop `git_config_get_bool()` wrapper	2025-07-23 08:15:20 -07:00
archive.h	…
attr.c	…
attr.h	…
banned.h	…
base85.c	…
base85.h	…
bisect.c	…
bisect.h	…
blame.c	Merge branch 'ly/changed-paths-traversal'	2025-07-23 15:45:15 -07:00
blame.h	…
blob.c	…
blob.h	…
bloom.c	bloom: replace struct bloom_key * with struct bloom_keyvec	2025-07-14 10:03:03 -07:00
bloom.h	bloom: replace struct bloom_key * with struct bloom_keyvec	2025-07-14 10:03:03 -07:00
branch.c	config: drop `git_config_get_multivar_gently()` wrapper	2025-07-23 08:15:21 -07:00
branch.h	…
builtin.h	…
bulk-checkin.c	…
bulk-checkin.h	…
bundle-uri.c	Merge branch 'ps/object-store'	2025-07-15 15:18:18 -07:00
bundle-uri.h	…
bundle.c	Merge branch 'bc/use-sha256-by-default-in-3.0'	2025-07-21 09:14:25 -07:00
bundle.h	…
cache-tree.c	…
cache-tree.h	…
cbtree.c	…
cbtree.h	…
chdir-notify.c	…
chdir-notify.h	…
check-builtins.sh	…
checkout.c	config: drop `git_config_get_string()` wrapper	2025-07-23 08:15:19 -07:00
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	config: move Git config parsing into "environment.c"	2025-07-23 08:15:22 -07: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/pop-recent-commit-with-prio-queue'	2025-07-28 12:02:34 -07:00
commit.h	commit: convert pop_most_recent_commit() to prio_queue	2025-07-22 07:28:23 -07:00
common-exit.c	…
common-init.c	…
common-init.h	…
common-main.c	…
config.c	config: warn on core.commentString=auto	2025-08-26 08:52:44 -07:00
config.h	Merge branch 'ps/config-wo-the-repository' into pw/3.0-commentchar-auto-deprecation	2025-07-31 12:28:51 -07:00
config.mak.dev	…
config.mak.in	…
config.mak.uname	Merge branch 'bs/config-mak-freebsd'	2025-07-14 11:19:23 -07:00
configure.ac	Merge branch 'rj/freebsd-sysinfo-build-fix'	2025-07-14 11:19:28 -07:00
connect.c	config: drop `git_config_get_string()` wrapper	2025-07-23 08:15:19 -07:00
connect.h	…
connected.c	…
connected.h	…
convert.c	config: drop `git_config()` wrapper	2025-07-23 08:15:18 -07:00
convert.h	…
copy.c	…
copy.h	…
credential.c	…
credential.h	…
csum-file.c	…
csum-file.h	…
ctype.c	…
daemon.c	Merge branch 'ps/config-wo-the-repository' into pw/3.0-commentchar-auto-deprecation	2025-07-31 12:28:51 -07:00
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	…
diff-merges.c	…
diff-merges.h	…
diff-no-index.c	…
diff.c	…
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	config: drop `git_config_set_in_file()` wrapper	2025-07-23 08:15:20 -07:00
dir.h	…
editor.c	config: drop `git_config_get_string()` wrapper	2025-07-23 08:15:19 -07:00
editor.h	…
entry.c	…
entry.h	…
environment.c	config: warn on core.commentString=auto	2025-08-26 08:52:44 -07:00
environment.h	config: warn on core.commentString=auto	2025-08-26 08:52:44 -07:00
exec-cmd.c	…
exec-cmd.h	…
fetch-negotiator.c	…
fetch-negotiator.h	…
fetch-pack.c	Merge branch 'ps/config-wo-the-repository' into pw/3.0-commentchar-auto-deprecation	2025-07-31 12:28:51 -07:00
fetch-pack.h	…
fmt-merge-msg.c	…
fmt-merge-msg.h	…
fsck.c	config: move Git config parsing into "environment.c"	2025-07-23 08:15:22 -07:00
fsck.h	config: drop `git_config()` wrapper	2025-07-23 08:15:18 -07:00
fsmonitor--daemon.h	…
fsmonitor-ipc.c	…
fsmonitor-ipc.h	…
fsmonitor-ll.h	…
fsmonitor-path-utils.h	…
fsmonitor-settings.c	…
fsmonitor-settings.h	…
fsmonitor.c	config: drop `git_config_get_int()` wrapper	2025-07-23 08:15:20 -07:00
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	Merge branch 'pw/adopt-c99-bool-officially'	2025-07-24 16:03:55 -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	…
git-quiltimport.sh	…
git-request-pull.sh	…
git-send-email.perl	Merge branch 'mc/netrc-service-names'	2025-07-14 11:19:25 -07:00
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	Merge branch 'ps/config-wo-the-repository' into pw/3.0-commentchar-auto-deprecation	2025-07-31 12:28:51 -07:00
gpg-interface.h	fast-(import\|export): improve on commit signature output format	2025-07-09 16:08:29 -07:00
graph.c	…
graph.h	…
grep.c	…
grep.h	…
hash-lookup.c	…
hash-lookup.h	…
hash.c	…
hash.h	Merge branch 'bc/use-sha256-by-default-in-3.0'	2025-07-21 09:14:25 -07:00
hashmap.c	…
hashmap.h	…
help.c	config: drop `git_config_get_string()` wrapper	2025-07-23 08:15:19 -07:00
help.h	…
hex-ll.c	…
hex-ll.h	…
hex.c	…
hex.h	…
hook.c	…
hook.h	…
http-backend.c	config: drop `git_config_get_bool()` wrapper	2025-07-23 08:15:20 -07:00
http-fetch.c	config: move Git config parsing into "environment.c"	2025-07-23 08:15:22 -07:00
http-push.c	Merge branch 'ps/object-store'	2025-07-15 15:18:18 -07:00
http-walker.c	…
http.c	config: move Git config parsing into "environment.c"	2025-07-23 08:15:22 -07:00
http.h	…
ident.c	…
ident.h	…
imap-send.c	config: move Git config parsing into "environment.c"	2025-07-23 08:15:22 -07:00
iterator.h	…
json-writer.c	…
json-writer.h	…
khash.h	…
kwset.c	…
kwset.h	…
levenshtein.c	…
levenshtein.h	…
line-log.c	bloom: rename function operates on bloom_key	2025-07-14 10:03:02 -07:00
line-log.h	…
line-range.c	…
line-range.h	…
linear-assignment.c	…
linear-assignment.h	…
list-objects-filter-options.c	config: drop `git_config_set()` wrapper	2025-07-23 08:15:21 -07:00
list-objects-filter-options.h	…
list-objects-filter.c	…
list-objects-filter.h	…
list-objects.c	…
list-objects.h	…
list.h	…
lockfile.c	…
lockfile.h	…
log-tree.c	…
log-tree.h	…
loose.c	…
loose.h	…
ls-refs.c	config: drop `git_config()` wrapper	2025-07-23 08:15:18 -07:00
ls-refs.h	…
mailinfo.c	config: move Git config parsing into "environment.c"	2025-07-23 08:15:22 -07:00
mailinfo.h	…
mailmap.c	…
mailmap.h	…
match-trees.c	…
match-trees.h	…
mem-pool.c	…
mem-pool.h	…
merge-blobs.c	…
merge-blobs.h	…
merge-ll.c	config: drop `git_config()` wrapper	2025-07-23 08:15:18 -07:00
merge-ll.h	…
merge-ort-wrappers.c	…
merge-ort-wrappers.h	…
merge-ort.c	config: drop `git_config_get_bool()` wrapper	2025-07-23 08:15:20 -07:00
merge-ort.h	…
merge.c	…
merge.h	…
mergesort.h	…
meson.build	Merge branch 'rj/meson-libexecdir-fix'	2025-07-24 16:03:57 -07:00
meson_options.txt	…
midx-write.c	…
midx.c	…
midx.h	…
name-hash.c	…
name-hash.h	…
notes-cache.c	…
notes-cache.h	…
notes-merge.c	…
notes-merge.h	…
notes-utils.c	config: drop `git_config()` wrapper	2025-07-23 08:15:18 -07:00
notes-utils.h	…
notes.c	config: drop `git_config()` wrapper	2025-07-23 08:15:18 -07:00
notes.h	…
object-file-convert.c	…
object-file-convert.h	…
object-file.c	…
object-file.h	…
object-name.c	Merge branch 'rs/pop-recent-commit-with-prio-queue'	2025-07-28 12:02:34 -07:00
object-name.h	…
object.c	…
object.h	…
odb.c	…
odb.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 'ps/object-store'	2025-07-15 15:18:18 -07:00
pack-bitmap.c	Merge branch 'ly/load-bitmap-leakfix'	2025-07-15 15:18:18 -07:00
pack-bitmap.h	…
pack-check.c	…
pack-mtimes.c	…
pack-mtimes.h	…
pack-objects.c	…
pack-objects.h	Merge branch 'ps/object-store'	2025-07-15 15:18:18 -07:00
pack-revindex.c	…
pack-revindex.h	…
pack-write.c	…
pack.h	…
packfile.c	…
packfile.h	…
pager.c	…
pager.h	…
parallel-checkout.c	config: drop `git_config_get_int()` wrapper	2025-07-23 08:15:20 -07:00
parallel-checkout.h	…
parse-options-cb.c	…
parse-options.c	parse-options: add precision handling for OPTION_COUNTUP	2025-07-09 08:40:32 -07:00
parse-options.h	parse-options: add precision handling for OPTION_COUNTUP	2025-07-09 08:40:32 -07:00
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	…
pkt-line.h	…
preload-index.c	…
preload-index.h	…
pretty.c	config: drop `git_config()` wrapper	2025-07-23 08:15:18 -07:00
pretty.h	…
prio-queue.c	prio-queue: add prio_queue_replace()	2025-07-22 07:28:35 -07:00
prio-queue.h	prio-queue: add prio_queue_replace()	2025-07-22 07:28:35 -07:00
progress.c	…
progress.h	…
promisor-remote.c	config: drop `git_config_get_bool()` wrapper	2025-07-23 08:15:20 -07:00
promisor-remote.h	…
prompt.c	…
prompt.h	…
protocol-caps.c	…
protocol-caps.h	…
protocol.c	config: drop `git_config_get_string()` wrapper	2025-07-23 08:15:19 -07:00
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	config: drop `git_config_get_string_multi()` wrapper	2025-07-23 08:15:19 -07:00
reachable.h	…
read-cache-ll.h	…
read-cache.c	config: drop `git_config_get_bool()` wrapper	2025-07-23 08:15:20 -07:00
read-cache.h	…
rebase-interactive.c	config: drop `git_config_get_value()` wrapper	2025-07-23 08:15:18 -07:00
rebase-interactive.h	…
rebase.c	…
rebase.h	…
ref-filter.c	…
ref-filter.h	…
reflog-walk.c	…
reflog-walk.h	…
reflog.c	config: move Git config parsing into "environment.c"	2025-07-23 08:15:22 -07:00
reflog.h	…
refs.c	config: drop `git_config_get_int()` wrapper	2025-07-23 08:15:20 -07:00
refs.h	Merge branch 'ph/fetch-prune-optim'	2025-07-16 09:42:27 -07:00
refspec.c	…
refspec.h	…
remote-curl.c	…
remote.c	config: drop `git_config_get_string()` wrapper	2025-07-23 08:15:19 -07:00
remote.h	…
replace-object.c	…
replace-object.h	…
repo-settings.c	…
repo-settings.h	…
repository.c	config: warn on core.commentString=auto	2025-08-26 08:52:44 -07:00
repository.h	config: warn on core.commentString=auto	2025-08-26 08:52:44 -07:00
rerere.c	config: move Git config parsing into "environment.c"	2025-07-23 08:15:22 -07:00
rerere.h	…
reset.c	…
reset.h	…
resolve-undo.c	…
resolve-undo.h	…
revision.c	Merge branch 'ps/config-wo-the-repository' into pw/3.0-commentchar-auto-deprecation	2025-07-31 12:28:51 -07:00
revision.h	bloom: replace struct bloom_key * with struct bloom_keyvec	2025-07-14 10:03:03 -07:00
run-command.c	config: drop `git_config_get_bool()` wrapper	2025-07-23 08:15:20 -07:00
run-command.h	…
sane-ctype.h	sane-ctype: fix compiler error on Amazon Linux 2	2025-07-10 11:18:37 -07:00
scalar.c	config: drop `git_config_get_multivar_gently()` wrapper	2025-07-23 08:15:21 -07:00
send-pack.c	Merge branch 'ps/object-store'	2025-07-15 15:18:18 -07:00
send-pack.h	…
sequencer.c	config: drop `git_config_set_multivar_in_file_gently()` wrapper	2025-07-23 08:15:21 -07:00
sequencer.h	…
serve.c	…
serve.h	…
server-info.c	…
server-info.h	…
setup.c	config: drop `git_config_set()` wrapper	2025-07-23 08:15:21 -07:00
setup.h	…
sh-i18n--envsubst.c	…
sha1dc_git.c	…
sha1dc_git.h	…
shallow.c	…
shallow.h	…
shared.mak	…
shell.c	…
shortlog.h	…
sideband.c	config: drop `git_config_get_string()` wrapper	2025-07-23 08:15:19 -07:00
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	strbuf: convert predicates to return bool	2025-07-16 08:18:06 -07:00
strbuf.h	strbuf: convert predicates to return bool	2025-07-16 08:18:06 -07:00
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	config: drop `git_config_set_in_file_gently()` wrapper	2025-07-23 08:15:21 -07:00
submodule-config.h	…
submodule.c	config: drop `git_config_set_in_file_gently()` wrapper	2025-07-23 08:15:21 -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	…
trace2.h	…
trailer.c	config: drop `git_config()` wrapper	2025-07-23 08:15:18 -07:00
trailer.h	…
transport-helper.c	…
transport-internal.h	…
transport.c	config: drop `git_config_get_bool()` wrapper	2025-07-23 08:15:20 -07: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.h	…
versioncmp.c	config: drop `git_config_get_string_multi()` wrapper	2025-07-23 08:15:19 -07:00
versioncmp.h	…
walker.c	Merge branch 'rs/pop-recent-commit-with-prio-queue'	2025-07-28 12:02:34 -07:00
walker.h	…
wildmatch.c	…
wildmatch.h	…
worktree.c	config: drop `git_config_set_in_file_gently()` wrapper	2025-07-23 08:15:21 -07:00
worktree.h	…
wrapper.c	…
wrapper.h	…
write-or-die.c	…
write-or-die.h	…
ws.c	…
ws.h	…
wt-status.c	…
wt-status.h	…
xdiff-interface.c	config: move Git config parsing into "environment.c"	2025-07-23 08:15:22 -07:00
xdiff-interface.h	…

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