Go to file

Junio C Hamano 1782abd773 parse-options: add show_usage_with_options_if_asked() Many commands call usage_with_options() when they are asked to give the help message, but it sends the help text to the standard error stream. When the user asked for it with "git cmd -h", the help message is the primary output from the command, hence we should send it to the standard output stream, instead. Introduce a helper function that captures the common pattern if (argc == 2 && !strcmp(argv[1], "-h")) usage_with_options(usage, options); and replaces it with show_usage_with_options_if_asked(argc, argv, usage, options); to help correct code paths. Note that this helper function still exits with status 129, and t0012 insists on it. After converting all the mistaken callers of usage_with_options() to call this new helper, we may want to address it---the end user is asking us to give the help text, and we are doing exactly as asked, so there is no reason to exit with non-zero status. Suggested-by: Jeff King <peff@peff.net> Signed-off-by: Junio C Hamano <gitster@pobox.com>		2025-01-17 13:30:02 -08:00
.github	Merge branch 'ps/ci-meson'	2024-12-23 09:32:25 -08:00
Documentation	RelNotes/2.48.0: fix typos etc.	2025-01-07 10:46:18 -08:00
bin-wrappers	…
block-sha1	…
builtin	Merge branch 'ps/build-sign-compare'	2025-01-10 09:19:34 -08:00
ci	Merge branch 'jk/lsan-race-ignore-false-positive'	2025-01-02 13:37:08 -08:00
compat	Merge branch 'js/mingw-rename-fix'	2024-12-23 09:32:16 -08:00
contrib	GIT-BUILD-OPTIONS: wire up NO_GITWEB option	2024-12-27 08:17:19 -08:00
ewah	…
git-gui	Merge branch 'master' of https://github.com/j6t/git-gui	2025-01-06 06:51:37 -08:00
gitk-git	Merge branch 'master' of https://github.com/j6t/gitk	2025-01-06 06:52:05 -08:00
gitweb	Merge branch 'ps/build'	2024-12-15 17:54:33 -08:00
mergetools	…
negotiator	prio-queue: use size_t rather than int for size	2024-12-20 07:21:45 -08:00
oss-fuzz	Merge branch 'ps/build-sign-compare'	2024-12-23 09:32:11 -08:00
perl	meson: fix perl dependencies	2025-01-08 08:05:39 -08:00
po	Merge branch '2.48-uk-update' of github.com:arkid15r/git-ukrainian-l10n	2025-01-07 15:45:43 +08:00
refs	Merge branch 'kn/reflog-migration'	2024-12-23 09:32:29 -08:00
reftable	reftable: handle realloc error in parse_names()	2024-12-28 08:00:44 -08:00
sha1	…
sha1collisiondetection@855827c583	…
sha1dc	…
sha256	…
subprojects	…
t	t0012: optionally check that "-h" output goes to stdout	2025-01-17 13:30:02 -08:00
templates	…
trace2	…
xdiff	…
.cirrus.yml	…
.clang-format	…
.editorconfig	…
.gitattributes	…
.gitignore	…
.gitlab-ci.yml	Merge branch 'ps/ci-meson'	2024-12-23 09:32:25 -08:00
.gitmodules	…
.mailmap	…
.tsan-suppressions	…
CODE_OF_CONDUCT.md	…
COPYING	…
GIT-BUILD-OPTIONS.in	GIT-BUILD-OPTIONS: wire up NO_GITWEB option	2024-12-27 08:17:19 -08:00
GIT-VERSION-FILE.in	…
GIT-VERSION-GEN	Git 2.48	2025-01-10 09:20:20 -08:00
INSTALL	…
LGPL-2.1	…
Makefile	Revert barrier-based LSan threading race workaround	2025-01-01 14:13:01 -08:00
README.md	…
RelNotes	…
SECURITY.md	…
abspath.c	…
abspath.h	…
aclocal.m4	…
add-interactive.c	…
add-interactive.h	…
add-patch.c	…
advice.c	Merge branch 'ps/build-sign-compare'	2024-12-23 09:32:11 -08:00
advice.h	…
alias.c	…
alias.h	…
alloc.c	…
alloc.h	…
apply.c	…
apply.h	…
archive-tar.c	…
archive-zip.c	…
archive.c	…
archive.h	…
attr.c	Merge branch 'ps/build-sign-compare'	2024-12-23 09:32:11 -08:00
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	Merge branch 'jc/forbid-head-as-tagname'	2024-12-15 17:54:26 -08:00
branch.h	…
builtin.h	…
bulk-checkin.c	Merge branch 'ps/weak-sha1-for-tail-sum-fix'	2025-01-01 09:21:14 -08:00
bulk-checkin.h	…
bundle-uri.c	Merge branch 'ps/build-sign-compare'	2024-12-23 09:32:11 -08:00
bundle-uri.h	…
bundle.c	Merge branch 'ps/build-sign-compare'	2024-12-23 09:32:11 -08:00
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	Merge branch 'ps/build-sign-compare'	2024-12-23 09:32:11 -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 'ps/build-sign-compare'	2024-12-23 09:32:11 -08:00
commit.h	…
common-main.c	…
config.c	Merge branch 'ps/build-sign-compare'	2024-12-23 09:32:11 -08:00
config.h	…
config.mak.dev	…
config.mak.in	…
config.mak.uname	cmake/vcxproj: stop special-casing `remote-ext`	2024-12-17 12:48:54 -08:00
configure.ac	…
connect.c	…
connect.h	…
connected.c	…
connected.h	…
convert.c	…
convert.h	…
copy.c	…
copy.h	…
credential.c	…
credential.h	…
csum-file.c	…
csum-file.h	…
ctype.c	…
daemon.c	Merge branch 'ps/build-sign-compare'	2024-12-23 09:32:11 -08: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	Merge branch 'ps/build-sign-compare'	2024-12-23 09:32:11 -08: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	…
dir.h	…
editor.c	…
editor.h	…
entry.c	…
entry.h	…
environment.c	…
environment.h	…
exec-cmd.c	…
exec-cmd.h	…
fetch-negotiator.c	…
fetch-negotiator.h	…
fetch-pack.c	Merge branch 'ps/build-sign-compare'	2024-12-23 09:32:11 -08:00
fetch-pack.h	…
fmt-merge-msg.c	…
fmt-merge-msg.h	…
fsck.c	…
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.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-ll.c	…
hex-ll.h	…
hex.c	…
hex.h	…
hook.c	Merge branch 'bf/explicit-config-set-in-advice-messages'	2024-12-15 17:54:28 -08:00
hook.h	…
http-backend.c	…
http-fetch.c	…
http-push.c	…
http-walker.c	…
http.c	Merge branch 'ps/build-sign-compare'	2024-12-23 09:32:11 -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	Merge branch 'ps/build-sign-compare'	2024-12-23 09:32:11 -08:00
list-objects.h	…
list.h	…
lockfile.c	…
lockfile.h	…
log-tree.c	…
log-tree.h	…
loose.c	…
loose.h	…
ls-refs.c	…
ls-refs.h	…
mailinfo.c	…
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	…
merge-ll.h	…
merge-ort-wrappers.c	…
merge-ort-wrappers.h	…
merge-ort.c	…
merge-ort.h	…
merge-recursive.c	…
merge-recursive.h	…
merge.c	…
merge.h	…
mergesort.h	…
meson.build	meson: enable auto-discovered "gitweb"	2024-12-27 08:17:19 -08:00
meson_options.txt	meson: wire up support for AsciiDoctor	2024-12-27 08:28:09 -08:00
midx-write.c	Merge branch 'ps/build-sign-compare'	2024-12-23 09:32:11 -08:00
midx.c	Merge branch 'ps/build-sign-compare'	2024-12-23 09:32:11 -08:00
midx.h	…
name-hash.c	…
name-hash.h	…
notes-cache.c	…
notes-cache.h	…
notes-merge.c	…
notes-merge.h	…
notes-utils.c	…
notes-utils.h	…
notes.c	…
notes.h	…
object-file-convert.c	…
object-file-convert.h	…
object-file.c	…
object-file.h	…
object-name.c	Merge branch 'ps/build-sign-compare'	2024-12-23 09:32:11 -08:00
object-name.h	…
object-store-ll.h	…
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	…
pack-bitmap.c	Merge branch 'tb/bitmap-fix-pack-reuse'	2024-12-23 09:32:22 -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	Merge branch 'ps/build-sign-compare'	2024-12-23 09:32:11 -08:00
packfile.h	…
pager.c	…
pager.h	…
parallel-checkout.c	…
parallel-checkout.h	…
parse-options-cb.c	…
parse-options.c	parse-options: add show_usage_with_options_if_asked()	2025-01-17 13:30:02 -08:00
parse-options.h	parse-options: add show_usage_with_options_if_asked()	2025-01-17 13:30:02 -08:00
parse.c	…
parse.h	…
patch-delta.c	…
patch-ids.c	…
patch-ids.h	…
path.c	Merge branch 'ps/build-sign-compare'	2024-12-23 09:32:11 -08:00
path.h	Merge branch 'bc/allow-upload-pack-from-other-people'	2024-12-10 10:04:55 +09:00
pathspec.c	…
pathspec.h	…
pkt-line.c	…
pkt-line.h	…
preload-index.c	…
preload-index.h	…
pretty.c	…
pretty.h	…
prio-queue.c	prio-queue: use size_t rather than int for size	2024-12-20 07:21:45 -08:00
prio-queue.h	prio-queue: use size_t rather than int for size	2024-12-20 07:21:45 -08:00
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	…
pseudo-merge.c	…
pseudo-merge.h	…
quote.c	…
quote.h	…
range-diff.c	Merge branch 'js/range-diff-diff-merges'	2024-12-23 09:32:17 -08:00
range-diff.h	range-diff: optionally include merge commits' diffs in the analysis	2024-12-16 08:45:48 -08:00
reachable.c	…
reachable.h	…
read-cache-ll.h	…
read-cache.c	…
read-cache.h	…
rebase-interactive.c	…
rebase-interactive.h	…
rebase.c	…
rebase.h	…
ref-filter.c	…
ref-filter.h	…
reflog-walk.c	…
reflog-walk.h	…
reflog.c	…
reflog.h	…
refs.c	Merge branch 'kn/reflog-migration'	2024-12-23 09:32:29 -08:00
refs.h	Merge branch 'kn/reflog-migration'	2024-12-23 09:32:29 -08:00
refspec.c	…
refspec.h	…
remote-curl.c	…
remote.c	Merge branch 'sk/calloc-not-malloc-plus-memset'	2024-12-23 09:32:18 -08:00
remote.h	…
replace-object.c	…
replace-object.h	…
repo-settings.c	…
repo-settings.h	…
repository.c	…
repository.h	…
rerere.c	…
rerere.h	…
reset.c	…
reset.h	…
resolve-undo.c	…
resolve-undo.h	…
revision.c	Merge branch 'ps/build-sign-compare'	2024-12-23 09:32:11 -08:00
revision.h	…
run-command.c	…
run-command.h	…
sane-ctype.h	…
scalar.c	…
send-pack.c	…
send-pack.h	…
sequencer.c	…
sequencer.h	…
serve.c	…
serve.h	…
server-info.c	…
server-info.h	…
setup.c	Merge branch 'ps/build-sign-compare'	2024-12-23 09:32:11 -08:00
setup.h	…
sh-i18n--envsubst.c	…
sha1dc_git.c	…
sha1dc_git.h	…
shallow.c	…
shallow.h	…
shared.mak	GIT-VERSION-GEN: fix overriding GIT_BUILT_FROM_COMMIT and GIT_DATE	2024-12-20 12:36:45 -08:00
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	…
strbuf.h	…
streaming.c	…
streaming.h	…
string-list.c	…
string-list.h	…
strmap.c	…
strmap.h	…
strvec.c	Merge branch 'ps/build-sign-compare'	2024-12-23 09:32:11 -08:00
strvec.h	…
sub-process.c	…
sub-process.h	…
submodule-config.c	…
submodule-config.h	…
submodule.c	Merge branch 'sk/calloc-not-malloc-plus-memset'	2024-12-23 09:32:18 -08:00
submodule.h	…
symlinks.c	…
symlinks.h	…
tag.c	Merge branch 'ps/build-sign-compare'	2024-12-23 09:32:11 -08:00
tag.h	…
tar.h	…
tempfile.c	…
tempfile.h	…
thread-utils.c	…
thread-utils.h	Revert barrier-based LSan threading race workaround	2025-01-01 14:13:01 -08:00
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	Merge branch 'ps/build-sign-compare'	2024-12-23 09:32:11 -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	Merge branch 'ps/build-sign-compare'	2024-12-23 09:32:11 -08:00
version.h	…
versioncmp.c	…
versioncmp.h	…
walker.c	…
walker.h	…
wildmatch.c	…
wildmatch.h	…
worktree.c	Merge branch 'ps/build-sign-compare'	2024-12-23 09:32:11 -08: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	…
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.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