Jeff King d8193743e0 usage.c: add BUG() function There's a convention in Git's code base to write assertions as: if (...some_bad_thing...) die("BUG: the terrible thing happened"); with the idea that users should never see a "BUG:" message (but if they, it at least gives a clue what happened). We use die() here because it's convenient, but there are a few draw-backs: 1. Without parsing the messages, it's hard for callers to distinguish BUG assertions from regular errors. For instance, it would be nice if the test suite could check that we don't hit any assertions, but test_must_fail will pass BUG deaths as OK. 2. It would be useful to add more debugging features to BUG assertions, like file/line numbers or dumping core. 3. The die() handler can be replaced, and might not actually exit the whole program (e.g., it may just pthread_exit()). This is convenient for normal errors, but for an assertion failure (which is supposed to never happen), we're probably better off taking down the whole process as quickly and cleanly as possible. We could address these by checking in die() whether the error message starts with "BUG", and behaving appropriately. But there's little advantage at that point to sharing the die() code, and only downsides (e.g., we can't change the BUG() interface independently). Moreover, converting all of the existing BUG calls reveals that the test suite does indeed trigger a few of them. Instead, this patch introduces a new BUG() function, which prints an error before dying via SIGABRT. This gives us test suite checking and core dumps. The function is actually a macro (when supported) so that we can show the file/line number. We can convert die("BUG") invocations to BUG() in further patches, dealing with any test fallouts individually. Signed-off-by: Jeff King <peff@peff.net> Signed-off-by: Junio C Hamano <gitster@pobox.com>		8 years ago
Documentation	Git 2.13	8 years ago
block-sha1	…
builtin	Merge branch 'ja/i18n-cleanup'	8 years ago
ci	Merge branch 'rg/a-the-typo'	8 years ago
compat	…
contrib	Merge branch 'jk/complete-checkout-sans-dwim-remote'	8 years ago
ewah	…
git-gui	…
gitk-git	…
gitweb	…
mergetools	…
perl	…
po	Merge branch 'master' of git://github.com/nafmo/git-l10n-sv	8 years ago
ppc	…
refs	…
sha1dc	…
t	Merge branch 'jh/verify-index-checksum-only-in-fsck'	8 years ago
templates	…
vcs-svn	…
xdiff	…
.gitattributes	…
.gitignore	…
.mailmap	…
.travis.yml	Merge branch 'ls/travis-stricter-linux32-builds'	8 years ago
COPYING	…
GIT-VERSION-GEN	Git 2.13	8 years ago
INSTALL	…
LGPL-2.1	…
Makefile	…
README.md	…
RelNotes	Git 2.11.2	8 years ago
abspath.c	…
aclocal.m4	…
advice.c	…
advice.h	…
alias.c	…
alloc.c	…
apply.c	…
apply.h	…
archive-tar.c	…
archive-zip.c	…
archive.c	…
archive.h	…
argv-array.c	…
argv-array.h	…
attr.c	…
attr.h	…
base85.c	…
bisect.c	…
bisect.h	…
blob.c	…
blob.h	…
branch.c	…
branch.h	…
builtin.h	…
bulk-checkin.c	…
bulk-checkin.h	…
bundle.c	…
bundle.h	…
cache-tree.c	…
cache-tree.h	…
cache.h	…
check-builtins.sh	…
check-racy.c	…
check_bindir	…
color.c	…
color.h	…
column.c	…
column.h	…
combine-diff.c	…
command-list.txt	…
commit-slab.h	…
commit.c	…
commit.h	…
common-main.c	…
config.c	…
config.mak.in	…
config.mak.uname	…
configure.ac	…
connect.c	…
connect.h	…
connected.c	…
connected.h	…
convert.c	…
convert.h	…
copy.c	…
credential-cache--daemon.c	…
credential-cache.c	…
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	fix minor typos	8 years ago
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	…
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	…
git-archimport.perl	…
git-bisect.sh	…
git-compat-util.h	usage.c: add BUG() function	8 years ago
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-parse-remote.sh	…
git-quiltimport.sh	…
git-rebase--am.sh	…
git-rebase--interactive.sh	…
git-rebase--merge.sh	…
git-rebase.sh	…
git-remote-testgit.sh	…
git-request-pull.sh	…
git-send-email.perl	…
git-sh-i18n.sh	…
git-sh-setup.sh	…
git-stash.sh	…
git-submodule.sh	…
git-svn.perl	…
git-web--browse.sh	…
git.c	…
git.rc	…
gpg-interface.c	…
gpg-interface.h	…
graph.c	…
graph.h	…
grep.c	…
grep.h	…
hash.h	…
hashmap.c	…
hashmap.h	…
help.c	…
help.h	…
hex.c	…
http-backend.c	…
http-fetch.c	…
http-push.c	…
http-walker.c	…
http.c	…
http.h	…
ident.c	…
imap-send.c	…
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	…
notes-merge.h	…
notes-utils.c	…
notes-utils.h	…
notes.c	…
notes.h	…
object.c	…
object.h	…
oidset.c	…
oidset.h	…
pack-bitmap-write.c	…
pack-bitmap.c	…
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	…
pathspec.c	…
pathspec.h	…
pkt-line.c	…
pkt-line.h	…
preload-index.c	…
pretty.c	…
prio-queue.c	Merge branch 'jk/prio-queue-avoid-swap-with-self'	8 years ago
prio-queue.h	…
progress.c	…
progress.h	…
prompt.c	…
prompt.h	…
quote.c	…
quote.h	…
reachable.c	…
reachable.h	…
read-cache.c	i18n: read-cache: typofix	8 years ago
ref-filter.c	…
ref-filter.h	…
reflog-walk.c	…
reflog-walk.h	…
refs.c	…
refs.h	…
remote-curl.c	…
remote-testsvn.c	…
remote.c	…
remote.h	…
replace_object.c	…
rerere.c	…
rerere.h	…
resolve-undo.c	…
resolve-undo.h	…
revision.c	…
revision.h	…
run-command.c	…
run-command.h	…
send-pack.c	…
send-pack.h	…
sequencer.c	Merge branch 'sh/rebase-i-reread-todo-after-exec'	8 years ago
sequencer.h	…
server-info.c	…
setup.c	…
sh-i18n--envsubst.c	…
sha1-array.c	…
sha1-array.h	…
sha1-lookup.c	…
sha1-lookup.h	…
sha1_file.c	…
sha1_name.c	…
shallow.c	…
shell.c	Merge branch 'maint-2.8' into maint-2.9	8 years ago
shortlog.h	…
show-index.c	…
sideband.c	…
sideband.h	…
sigchain.c	…
sigchain.h	…
split-index.c	…
split-index.h	…
strbuf.c	…
strbuf.h	…
streaming.c	…
streaming.h	…
string-list.c	…
string-list.h	…
submodule-config.c	…
submodule-config.h	…
submodule.c	…
submodule.h	…
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	…
unpack-trees.h	…
upload-pack.c	…
url.c	…
url.h	…
urlmatch.c	…
urlmatch.h	…
usage.c	usage.c: add BUG() function	8 years ago
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	…
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