Go to file
Junio C Hamano be26d2b29b describe: do not use cmd_*() as a subroutine
The cmd_foo() function is a moral equivalent of 'main' for a Git
subcommand 'git foo', and as such, it is allowed to do many things
that make it unsuitable to be called as a subroutine, including

 - call exit(3) to terminate the process;

 - allocate resource held and used throughout its lifetime, without
   releasing it upon return/exit;

 - rely on global variables being initialized at program startup,
   and update them as needed, making another clean invocation of the
   function impossible.

The call to cmd_diff_index() "git describe" makes has been working
by accident that the function did not call exit(3); it sets a bad
precedent for people to cut and paste.

We could invoke it via the run_command() interface, but the diff
family of commands have helper functions in diff-lib.c that are
meant to be usable as subroutines, and using the latter does not
make the resulting code all that longer.  Use it.

Note that there is also an invocation of cmd_name_rev() at the end;
"git describe --contains" massages its command line arguments to be
suitable for "git name-rev" invocation and jumps to it, never to
regain control.  This call is left as-is as an exception to the
rule.  When we start to allow calling name-rev repeatedly as a
helper function, we would be able to remove this call as well.

Signed-off-by: Junio C Hamano <gitster@pobox.com>
2017-10-11 15:01:37 +09:00
.github
Documentation Git 2.14.2 2017-09-22 14:51:37 +09:00
block-sha1
builtin describe: do not use cmd_*() as a subroutine 2017-10-11 15:01:37 +09:00
ci
compat Merge branch 'rs/win32-syslog-leakfix' into maint 2017-09-10 17:02:54 +09:00
contrib add MOVE_ARRAY 2017-07-17 14:54:53 -07:00
ewah use DIV_ROUND_UP 2017-07-10 14:24:36 -07:00
git-gui Merge branch 'js/msgfmt-on-windows' of ../git-gui into js/git-gui-msgfmt-on-windows 2017-07-25 13:42:41 -07:00
gitk-git
gitweb Merge branch 'hb/gitweb-project-list' into maint 2017-08-23 14:33:44 -07:00
mergetools
perl Merge branch 'jc/perl-git-comment-typofix' into maint 2017-09-10 17:02:57 +09:00
po l10n: zh_CN: review for git v2.14.0 l10n 2017-08-02 08:02:37 +08:00
ppc
refs
sha1collisiondetection@19d97bf5af
sha1dc
t Sync with 2.13.6 2017-09-22 14:50:02 +09:00
templates pre-rebase hook: capture documentation in a <<here document 2017-07-11 08:56:33 -07:00
vcs-svn Merge branch 'jn/vcs-svn-cleanup' into maint 2017-09-10 17:03:09 +09:00
xdiff
.gitattributes
.gitignore
.gitmodules
.mailmap
.travis.yml
COPYING
GIT-VERSION-GEN Git 2.13.6 2017-09-22 14:49:24 +09:00
INSTALL
LGPL-2.1
Makefile Merge branch 'jn/vcs-svn-cleanup' into maint 2017-09-10 17:03:09 +09:00
README.md
RelNotes Git 2.13.6 2017-09-22 14:49:24 +09:00
abspath.c
aclocal.m4
advice.c
advice.h
alias.c Merge branch 'js/alias-case-sensitivity' 2017-07-20 16:29:59 -07:00
alloc.c
apply.c Merge branch 'rs/apply-lose-prefix-length' into maint 2017-09-10 17:03:01 +09:00
apply.h apply: remove prefix_length member from apply_state 2017-08-09 10:21:45 -07:00
archive-tar.c
archive-zip.c
archive.c archive: don't queue excluded directories 2017-08-19 00:40:25 -07:00
archive.h
argv-array.c
argv-array.h
attr.c
attr.h
base85.c
bisect.c
bisect.h
blame.c Merge branch 'js/blame-lib' 2017-07-31 13:05:15 -07:00
blame.h
blob.c
blob.h
branch.c
branch.h
builtin.h git.c: provide setup_auto_pager() 2017-08-03 11:08:10 -07:00
bulk-checkin.c
bulk-checkin.h
bundle.c
bundle.h
cache-tree.c use MOVE_ARRAY 2017-07-17 14:54:56 -07:00
cache-tree.h
cache.h Merge branch 'sb/sha1-file-cleanup' into maint 2017-09-10 17:03:04 +09:00
check-builtins.sh
check-racy.c
check_bindir
color.c color: check color.ui in git_default_config() 2017-07-13 12:42:51 -07:00
color.h
column.c
column.h
combine-diff.c
command-list.txt
commit-slab.h
commit.c use MOVE_ARRAY 2017-07-17 14:54:56 -07:00
commit.h commit: remove unused inline function single_parent() 2017-08-19 09:24:05 -07:00
common-main.c
config.c Merge branch 'jk/ref-filter-colors' into maint 2017-08-23 14:33:42 -07:00
config.h
config.mak.in
config.mak.uname config.mak.uname: set FREAD_READS_DIRECTORIES for cygwin 2017-07-21 11:58:06 -07:00
configure.ac
connect.c Git 2.13.5 2017-08-04 12:40:37 -07:00
connect.h
connected.c
connected.h
convert.c Merge branch 'tb/apply-with-crlf' into maint 2017-09-10 17:02:55 +09:00
convert.h Merge branch 'tb/apply-with-crlf' into maint 2017-09-10 17:02:55 +09:00
copy.c
credential-cache--daemon.c
credential-cache.c Merge branch 'dl/credential-cache-socket-in-xdg-cache' into maint 2017-08-23 14:33:45 -07:00
credential-store.c
credential.c
credential.h
csum-file.c
csum-file.h
ctype.c
daemon.c
date.c
decorate.c
decorate.h
delta.h
diff-delta.c
diff-lib.c
diff-no-index.c
diff.c color: check color.ui in git_default_config() 2017-07-13 12:42:51 -07:00
diff.h
diffcore-break.c
diffcore-delta.c
diffcore-order.c
diffcore-pickaxe.c
diffcore-rename.c
diffcore.h
dir-iterator.c
dir-iterator.h
dir.c Merge branch 'rs/stat-data-unaligned-reads-fix' into maint 2017-08-23 14:33:48 -07:00
dir.h
editor.c
entry.c
environment.c
exec_cmd.c
exec_cmd.h
fast-import.c
fetch-pack.c
fetch-pack.h
fmt-merge-msg.h
fsck.c
fsck.h
generate-cmdlist.sh
gettext.c
gettext.h
git-add--interactive.perl Merge branch 'pw/unquote-path-in-git-pm' into maint 2017-07-31 13:51:05 -07:00
git-archimport.perl archimport: use safe_pipe_capture for user input 2017-09-12 11:08:15 +09:00
git-bisect.sh
git-compat-util.h Merge branch 'rs/move-array' into maint 2017-08-23 14:33:46 -07:00
git-cvsexportcommit.perl
git-cvsimport.perl cvsimport: shell-quote variable used in backticks 2017-09-12 11:10:22 +09:00
git-cvsserver.perl cvsserver: use safe_pipe_capture for `constant commands` as well 2017-09-11 14:52:29 +09:00
git-difftool--helper.sh
git-filter-branch.sh
git-instaweb.sh
git-merge-octopus.sh scripts: use "git foo" not "git-foo" 2017-08-07 12:04:45 -07:00
git-merge-one-file.sh scripts: use "git foo" not "git-foo" 2017-08-07 12:04:45 -07:00
git-merge-resolve.sh scripts: use "git foo" not "git-foo" 2017-08-07 12:04:45 -07:00
git-mergetool--lib.sh
git-mergetool.sh
git-p4.py git-p4: filter for {'code':'info'} in p4CmdList 2017-07-13 10:52:42 -07:00
git-parse-remote.sh
git-quiltimport.sh
git-rebase--am.sh rebase: honor --rerere-autoupdate 2017-08-02 15:16:09 -07:00
git-rebase--interactive.sh rebase -i: honor --rerere-autoupdate 2017-08-02 15:16:09 -07:00
git-rebase--merge.sh
git-rebase.sh Merge branch 'pw/rebase-i-regression-fix-tests' into maint 2017-07-10 13:59:00 -07:00
git-remote-testgit.sh
git-request-pull.sh
git-send-email.perl
git-sh-i18n.sh
git-sh-setup.sh
git-stash.sh Merge branch 'mf/no-dashed-subcommands' into maint 2017-09-10 17:02:56 +09:00
git-submodule.sh Merge branch 'sb/submodule-parallel-update' into maint 2017-09-10 17:03:06 +09:00
git-svn.perl
git-web--browse.sh
git.c git.c: ignore pager.* when launching builtin as dashed external 2017-08-03 11:08:11 -07:00
git.rc
gpg-interface.c
gpg-interface.h
graph.c
graph.h
grep.c Merge branch 'as/grep-quiet-no-match-exit-code-fix' into maint 2017-09-10 17:02:55 +09:00
grep.h
hash.h
hashmap.c
hashmap.h
help.c Merge branch 'mb/reword-autocomplete-message' into maint 2017-07-10 13:59:04 -07:00
help.h
hex.c
http-backend.c
http-fetch.c
http-push.c
http-walker.c
http.c Merge branch 'jc/http-sslkey-and-ssl-cert-are-paths' into maint 2017-08-23 14:33:43 -07:00
http.h
ident.c
imap-send.c Merge branch 'rs/use-div-round-up' 2017-07-12 15:18:23 -07:00
iterator.h
khash.h
kwset.c
kwset.h
levenshtein.c
levenshtein.h
line-log.c
line-log.h
line-range.c
line-range.h
list-objects.c
list-objects.h
list.h
ll-merge.c
ll-merge.h
lockfile.c
lockfile.h
log-tree.c
log-tree.h
mailinfo.c
mailinfo.h
mailmap.c
mailmap.h
match-trees.c
merge-blobs.c
merge-blobs.h
merge-recursive.c
merge-recursive.h
merge.c
mergesort.c
mergesort.h
mru.c
mru.h
name-hash.c
notes-cache.c
notes-cache.h
notes-merge.c use MOVE_ARRAY 2017-07-17 14:54:56 -07:00
notes-merge.h
notes-utils.c
notes-utils.h
notes.c
notes.h
object.c object: remove "used" field from struct object 2017-07-20 14:54:08 -07:00
object.h object: remove "used" field from struct object 2017-07-20 14:54:08 -07:00
oidset.c
oidset.h
pack-bitmap-write.c
pack-bitmap.c Merge branch 'jc/pack-bitmap-unaligned' into maint 2017-07-10 13:59:00 -07:00
pack-bitmap.h
pack-check.c
pack-objects.c
pack-objects.h
pack-revindex.c
pack-revindex.h
pack-write.c
pack.h
pager.c
parse-options-cb.c
parse-options.c
parse-options.h
patch-delta.c
patch-ids.c
patch-ids.h
path.c Git 2.13.5 2017-08-04 12:40:37 -07:00
path.h
pathspec.c
pathspec.h
pkt-line.c sub-process: refactor handshake to common function 2017-07-26 13:00:40 -07:00
pkt-line.h sub-process: refactor handshake to common function 2017-07-26 13:00:40 -07:00
preload-index.c
pretty.c pretty: respect color settings for %C placeholders 2017-07-13 12:42:51 -07:00
prio-queue.c
prio-queue.h
progress.c
progress.h
prompt.c
prompt.h
quote.c
quote.h
reachable.c
reachable.h
read-cache.c use MOVE_ARRAY 2017-07-17 14:54:56 -07:00
ref-filter.c ref-filter: consult want_color() before emitting colors 2017-07-13 12:42:51 -07:00
ref-filter.h ref-filter: consult want_color() before emitting colors 2017-07-13 12:42:51 -07:00
reflog-walk.c use MOVE_ARRAY 2017-07-17 14:54:56 -07:00
reflog-walk.h
refs.c Merge branch 'cc/ref-is-hidden-microcleanup' into maint 2017-08-23 14:33:50 -07:00
refs.h
remote-curl.c
remote-testsvn.c
remote.c
remote.h
replace_object.c
repository.c
repository.h
rerere.c
rerere.h
resolve-undo.c
resolve-undo.h
revision.c Merge branch 'jk/rev-list-empty-input' into maint 2017-09-10 17:02:48 +09:00
revision.h revision: add rev_input_given flag 2017-08-02 15:45:20 -07:00
run-command.c Merge branch 'js/run-process-parallel-api-fix' into maint 2017-08-23 14:33:49 -07:00
run-command.h
send-pack.c
send-pack.h
sequencer.c cherry-pick/revert: remember --rerere-autoupdate 2017-08-02 15:16:09 -07:00
sequencer.h
server-info.c
setup.c Merge branch 'js/alias-early-config' into maint 2017-07-10 13:58:58 -07:00
sh-i18n--envsubst.c
sha1-array.c
sha1-array.h
sha1-lookup.c
sha1-lookup.h
sha1_file.c Merge branch 'sb/sha1-file-cleanup' into maint 2017-09-10 17:03:04 +09:00
sha1_name.c Merge branch 'rs/use-div-round-up' 2017-07-12 15:18:23 -07:00
sha1dc_git.c
sha1dc_git.h
shallow.c Merge branch 'rs/use-div-round-up' 2017-07-12 15:18:23 -07:00
shell.c shell: drop git-cvsserver support by default 2017-09-12 11:05:58 +09:00
shortlog.h
show-index.c
sideband.c
sideband.h
sigchain.c
sigchain.h
split-index.c
split-index.h
strbuf.c Merge branch 'rs/pretty-add-again' into maint 2017-07-10 13:58:57 -07:00
strbuf.h Merge branch 'rs/pretty-add-again' into maint 2017-07-10 13:58:57 -07:00
streaming.c
streaming.h
string-list.c use MOVE_ARRAY 2017-07-17 14:54:56 -07:00
string-list.h
sub-process.c sub-process: print the cmd when a capability is unsupported 2017-08-16 09:40:33 -07:00
sub-process.h sub-process: refactor handshake to common function 2017-07-26 13:00:40 -07:00
submodule-config.c Merge branch 'sb/pull-rebase-submodule' 2017-07-13 16:14:54 -07:00
submodule-config.h Merge branch 'sb/pull-rebase-submodule' 2017-07-13 16:14:54 -07:00
submodule.c Merge branch 'bw/push-options-recursively-to-submodules' into maint 2017-09-10 17:02:49 +09:00
submodule.h Merge branch 'sb/pull-rebase-submodule' 2017-07-13 16:14:54 -07:00
symlinks.c
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
trailer.c
trailer.h
transport-helper.c
transport.c
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
unpack-trees.c Merge branch 'ls/filter-process-delayed' into jt/subprocess-handshake 2017-07-26 12:56:19 -07:00
unpack-trees.h
upload-pack.c
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
wildmatch.h
worktree.c
worktree.h
wrap-for-bin.sh
wrapper.c
write_or_die.c
ws.c
wt-status.c Merge branch 'rs/wt-status-cleanup' 2017-07-12 15:18:23 -07:00
wt-status.h
xdiff-interface.c
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-.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). To subscribe to the list, send an email with just "subscribe git" in the body to majordomo@vger.kernel.org. The mailing list archives are available at https://public-inbox.org/git/, http://marc.info/?l=git and other archival sites.

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