1
0
mirror of https://github.com/git/git.git synced 2024-09-29 07:22:56 +02:00
Git Source Code Mirror. Please follow Documentation/SubmittingPatches procedure for any of your improvements.
Go to file
Jeff King 5d2fc9135a docs: put listed example commands in backticks
Many examples of git command invocation are given in asciidoc listing
blocks, which makes them monospaced and avoids further interpretation of
special characters.  Some manpages make a list of examples, like:

  git foo::
    Run git foo.

  git foo -q::
    Use the "-q" option.

to quickly show many variants. However, they can sometimes be hard to
read, because they are shown in a proportional-width font (so, for
example, seeing the difference between "-- foo" and "--foo" can be
difficult).

This patch puts all such examples into backticks, which gives the
equivalent formatting to a listing block (i.e., monospaced and without
character interpretation).

As a bonus, this also fixes an example in the git-push manpage, in which
"git push origin :::" was accidentally considered a newly-indented list,
and not a list item with "git push origin :" in it.

Signed-off-by: Jeff King <peff@peff.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2011-08-04 15:49:13 -07:00
block-sha1
builtin Merge branch 'jk/clone-detached' 2011-08-01 15:00:35 -07:00
compat Merge branch 'jc/maint-cygwin-trust-executable-bit-default' into maint 2011-08-01 14:44:13 -07:00
contrib Add option hooks.diffopts to customize change summary in post-receive-email 2011-08-04 12:06:49 -07:00
Documentation docs: put listed example commands in backticks 2011-08-04 15:49:13 -07:00
git_remote_helpers transport-helper: update ref status after push with export 2011-07-19 11:17:48 -07:00
git-gui
gitk-git Merge git://git.kernel.org/pub/scm/gitk/gitk 2011-04-11 09:33:06 -07:00
gitweb gitweb: pass string after encoding in utf-8 to syntax highlighter 2011-08-04 12:13:38 -07:00
perl
po
ppc
t Skip archive --remote tests on Windows 2011-08-03 10:16:20 -07:00
templates
vcs-svn Merge branch 'rj/sparse' 2011-04-27 11:36:42 -07:00
xdiff
.gitattributes
.gitignore Revert clock-skew based attempt to optimize tag --contains traversal 2011-07-14 11:02:06 -07:00
.mailmap
abspath.c Merge branch 'js/maint-add-path-stat-pwd' 2011-07-22 14:43:36 -07:00
aclocal.m4
advice.c
advice.h
alias.c
alloc.c
archive-tar.c upload-archive: allow user to turn off filters 2011-06-22 11:12:35 -07:00
archive-zip.c Merge branch 'jk/archive-tar-filter' 2011-07-19 09:45:32 -07:00
archive.c upload-archive: allow user to turn off filters 2011-06-22 11:12:35 -07:00
archive.h upload-archive: allow user to turn off filters 2011-06-22 11:12:35 -07:00
attr.c sparse: Fix some "symbol not declared" warnings 2011-04-22 10:04:27 -07:00
attr.h
base85.c
bisect.c bisect: refactor sha1_array into a generic sha1 list 2011-05-19 20:02:10 -07:00
bisect.h
blob.c
blob.h
branch.c
branch.h
builtin.h Revert clock-skew based attempt to optimize tag --contains traversal 2011-07-14 11:02:06 -07:00
bundle.c
bundle.h
cache-tree.c
cache-tree.h
cache.h Merge branch 'jc/index-pack' 2011-07-19 09:54:51 -07:00
check_bindir
check-builtins.sh
check-racy.c
color.c
color.h
combine-diff.c combine-diff: respect textconv attributes 2011-05-24 09:08:17 -07:00
command-list.txt
commit.c
commit.h Merge branch 'jk/format-patch-am' 2011-05-31 12:19:11 -07:00
config.c Merge branch 'maint' 2011-07-22 13:58:46 -07:00
config.mak.in Merge branch 'kk/maint-prefix-in-config-mak' into maint 2011-06-01 14:02:39 -07:00
configure.ac configure: Check for libpcre 2011-05-09 16:29:46 -07:00
connect.c Merge branch 'maint' 2011-08-01 14:45:02 -07:00
convert.c streaming: filter cascading 2011-05-26 16:47:15 -07:00
convert.h stream filter: add "no more input" to the filters 2011-05-26 16:47:15 -07:00
copy.c
COPYING
csum-file.c Merge branch 'jc/index-pack' 2011-07-19 09:54:51 -07:00
csum-file.h
ctype.c magic pathspec: futureproof shorthand form 2011-04-08 16:19:48 -07:00
daemon.c
date.c date: avoid "X years, 12 months" in relative dates 2011-04-20 19:23:16 -07:00
decorate.c
decorate.h
delta.h
diff-delta.c
diff-lib.c Merge branch 'jc/maint-reset-unmerged-path' 2011-08-01 15:00:08 -07:00
diff-no-index.c
diff.c Merge branch 'jc/zlib-wrap' 2011-07-19 09:33:04 -07:00
diff.h Merge branch 'mg/diff-stat-count' 2011-06-29 17:03:10 -07:00
diffcore-break.c
diffcore-delta.c
diffcore-order.c
diffcore-pickaxe.c
diffcore-rename.c diffcore-rename.c: avoid set-but-not-used warning 2011-06-01 13:54:17 -07:00
diffcore.h
dir.c Merge branch 'nd/struct-pathspec' 2011-05-06 10:50:06 -07:00
dir.h Merge branch 'nd/maint-setup' 2011-05-02 15:58:30 -07:00
editor.c
entry.c Add streaming filter API 2011-05-26 16:47:15 -07:00
environment.c Merge branch 'jc/replacing' 2011-05-19 20:37:21 -07:00
exec_cmd.c
exec_cmd.h
fast-import.c Merge branch 'sr/transport-helper-fix' 2011-08-01 15:00:14 -07:00
fetch-pack.h
fixup-builtins
fsck.c Merge branch 'jm/maint-misc-fix' into maint 2011-05-30 00:09:41 -07:00
fsck.h
generate-cmdlist.sh
gettext.c
gettext.h i18n: avoid parenthesized string as array initializer 2011-04-11 10:33:51 -07:00
git-add--interactive.perl add -i: ignore terminal escape sequences 2011-05-17 20:44:17 -07:00
git-am.sh i18n: git-am printf(1) message to eval_gettext 2011-05-21 11:57:15 -07:00
git-archimport.perl
git-bisect.sh i18n: git-bisect bisect_next_check "You need to" message 2011-05-21 11:57:19 -07:00
git-compat-util.h Merge branch 'ak/gcc46-profile-feedback' 2011-07-19 09:32:52 -07:00
git-cvsexportcommit.perl
git-cvsimport.perl Merge branch 'gr/cvsimport-alternative-cvspass-location' into maint 2011-05-13 10:44:54 -07:00
git-cvsserver.perl
git-difftool--helper.sh
git-difftool.perl
git-filter-branch.sh
git-instaweb.sh git-instaweb: Check that correct config file exists for (re)start 2011-06-27 09:11:41 +00:00
git-lost-found.sh
git-merge-octopus.sh
git-merge-one-file.sh Merge branch 'jk/merge-one-file-working-tree' into maint 2011-05-13 10:44:19 -07:00
git-merge-resolve.sh
git-mergetool--lib.sh Merge branch 'da/git-prefix-everywhere' into next 2011-06-29 17:09:27 -07:00
git-mergetool.sh mergetool: check return value from read 2011-07-01 16:17:29 -07:00
git-parse-remote.sh Merge branch 'mz/rebase' 2011-04-28 14:11:39 -07:00
git-pull.sh i18n: git-pull eval_gettext + warning message 2011-05-21 11:57:15 -07:00
git-quiltimport.sh
git-rebase--am.sh
git-rebase--interactive.sh rebase -i -p: include non-first-parent commits in todo list 2011-06-19 14:37:23 -07:00
git-rebase--merge.sh
git-rebase.sh Merge branch 'mz/doc-rebase-abort' 2011-07-22 14:44:08 -07:00
git-relink.perl
git-remote-testgit.py transport-helper: implement marks location as capability 2011-07-19 11:17:48 -07:00
git-repack.sh
git-request-pull.sh
git-send-email.perl git-send-email: fix missing space in error message 2011-04-29 11:34:32 -07:00
git-sh-i18n.sh git-sh-i18n.sh: add GIT_GETTEXT_POISON support 2011-05-14 20:29:11 -07:00
git-sh-setup.sh git-sh-setup: add die_with_status 2011-06-13 11:23:28 -07:00
git-stash.sh Merge branch 'dc/stash-con-untracked' 2011-07-22 14:46:28 -07:00
git-submodule.sh Merge branch 'jl/submodule-add-relurl-wo-upstream' 2011-07-22 14:24:35 -07:00
git-svn.perl git-svn: Correctly handle root commits in mergeinfo ranges 2011-06-28 03:26:11 +00:00
GIT-VERSION-GEN Start 1.7.7 cycle 2011-07-06 17:00:46 -07:00
git-web--browse.sh
git.c Revert clock-skew based attempt to optimize tag --contains traversal 2011-07-14 11:02:06 -07:00
git.spec.in
graph.c
graph.h
grep.c grep: add --heading 2011-06-05 18:15:27 -07:00
grep.h grep: add --heading 2011-06-05 18:15:27 -07:00
hash.c
hash.h
help.c Merge branch 'ms/help-unknown' 2011-07-22 14:43:21 -07:00
help.h
hex.c
http-backend.c zlib: zlib can only process 4GB at a time 2011-06-10 11:52:15 -07:00
http-fetch.c
http-push.c Merge branch 'jc/zlib-wrap' 2011-07-19 09:33:04 -07:00
http-walker.c http: make curl callbacks match contracts from curl header 2011-05-04 13:30:28 -07:00
http.c http: pass http.cookiefile using CURLOPT_COOKIEFILE 2011-06-03 09:29:19 -07:00
http.h Merge branch 'jc/zlib-wrap' 2011-07-19 09:33:04 -07:00
ident.c Merge branch 'rg/no-gecos-in-pwent' 2011-05-26 10:32:19 -07:00
imap-send.c sparse: Fix some "Using plain integer as NULL pointer" warnings 2011-04-11 10:35:25 -07:00
INSTALL Add explanation of the profile feedback build to the README 2011-06-20 16:31:44 -07:00
levenshtein.c
levenshtein.h
LGPL-2.1 provide a copy of the LGPLv2.1 2011-05-19 18:23:17 -07:00
list-objects.c Merge branch 'nd/struct-pathspec' 2011-05-06 10:50:06 -07:00
list-objects.h
ll-merge.c
ll-merge.h
lockfile.c
log-tree.c Merge branch 'jk/format-patch-am' 2011-05-31 12:19:11 -07:00
log-tree.h
mailmap.c
mailmap.h
Makefile Merge branch 'ak/gcc46-profile-feedback' 2011-07-19 09:32:52 -07:00
match-trees.c
merge-file.c sparse: Fix an "symbol 'merge_file' not decared" warning 2011-04-11 10:35:25 -07:00
merge-file.h sparse: Fix an "symbol 'merge_file' not decared" warning 2011-04-11 10:35:25 -07:00
merge-recursive.c Merge branch 'jc/rename-degrade-cc-to-c' into maint 2011-05-31 12:00:02 -07:00
merge-recursive.h
name-hash.c
notes-cache.c
notes-cache.h
notes-merge.c index_fd(): turn write_object and format_check arguments into one flag 2011-05-09 11:58:19 -07:00
notes-merge.h
notes.c
notes.h
object.c read_sha1_file(): get rid of read_sha1_file_repl() madness 2011-05-15 15:23:33 -07:00
object.h
pack-check.c zlib: zlib can only process 4GB at a time 2011-06-10 11:52:15 -07:00
pack-refs.c
pack-refs.h
pack-revindex.c
pack-revindex.h
pack-write.c
pack.h
pager.c
parse-options.c parse-options: add OPT_STRING_LIST helper 2011-06-22 11:25:20 -07:00
parse-options.h parse-options: add OPT_STRING_LIST helper 2011-06-22 11:25:20 -07:00
patch-delta.c
patch-ids.c
patch-ids.h
path.c
pkt-line.c
pkt-line.h
preload-index.c
pretty.c Merge branch 'jk/format-patch-am' 2011-05-31 12:19:11 -07:00
progress.c
progress.h
quote.c
quote.h
reachable.c
reachable.h
read-cache.c Merge branch 'ef/maint-win-verify-path' 2011-06-29 17:09:17 -07:00
README
reflog-walk.c
reflog-walk.h
refs.c Merge branch 'jc/maint-1.7.3-checkout-describe' into maint 2011-08-01 14:43:18 -07:00
refs.h Merge branch 'jc/maint-1.7.3-checkout-describe' into maint 2011-08-01 14:43:18 -07:00
RelNotes Start 1.7.7 cycle 2011-07-06 17:00:46 -07:00
remote-curl.c Merge branch 'sr/transport-helper-fix' 2011-08-01 15:00:14 -07:00
remote.c make copy_ref globally available 2011-06-07 16:07:07 -07:00
remote.h make copy_ref globally available 2011-06-07 16:07:07 -07:00
replace_object.c inline lookup_replace_object() calls 2011-05-15 15:23:33 -07:00
rerere.c Merge branch 'maint' 2011-05-30 00:09:55 -07:00
rerere.h rerere: libify rerere_clear() and rerere_gc() 2011-05-08 12:55:34 -07:00
resolve-undo.c
resolve-undo.h
revision.c Merge branch 'jc/notes-batch-removal' 2011-05-29 23:51:26 -07:00
revision.h Merge branch 'jk/format-patch-am' 2011-05-31 12:19:11 -07:00
run-command.c run-command: handle short writes and EINTR in die_child 2011-04-20 10:09:26 -07:00
run-command.h
send-pack.h
server-info.c
setup.c Merge branch 'da/git-prefix-everywhere' into next 2011-06-29 17:09:27 -07:00
sh-i18n--envsubst.c Merge branch 'js/i18n-windows' 2011-06-29 17:03:13 -07:00
sha1_file.c Merge branch 'jc/legacy-loose-object' into maint 2011-08-01 14:43:58 -07:00
sha1_name.c Merge branch 'jc/magic-pathspec' 2011-05-23 09:58:35 -07:00
sha1-array.c receive-pack: eliminate duplicate .have refs 2011-05-19 20:02:31 -07:00
sha1-array.h receive-pack: eliminate duplicate .have refs 2011-05-19 20:02:31 -07:00
sha1-lookup.c
sha1-lookup.h
shallow.c
shell.c shell: add missing initialization of argv0_path 2011-05-05 09:32:28 -07:00
shortlog.h
show-index.c
sideband.c
sideband.h
sigchain.c
sigchain.h
strbuf.c Merge branch 'jk/maint-config-param' 2011-07-19 09:45:21 -07:00
strbuf.h Merge branch 'jk/maint-config-param' 2011-07-19 09:45:21 -07:00
streaming.c Merge branch 'jc/streaming-filter' 2011-08-01 15:00:29 -07:00
streaming.h Add streaming filter API 2011-05-26 16:47:15 -07:00
string-list.c
string-list.h
submodule.c Merge branch 'jl/maint-fetch-recursive-fix' into maint 2011-08-01 14:44:17 -07:00
submodule.h
symlinks.c
tag.c
tag.h
tar.h
test-chmtime.c
test-ctype.c
test-date.c
test-delta.c
test-dump-cache-tree.c
test-genrandom.c
test-index-version.c
test-line-buffer.c
test-match-trees.c
test-mktemp.c
test-obj-pool.c
test-parse-options.c parse-options: add OPT_STRING_LIST helper 2011-06-22 11:25:20 -07:00
test-path-utils.c
test-run-command.c tests: check error message from run_command 2011-04-20 10:08:54 -07:00
test-sha1.c
test-sha1.sh
test-sigchain.c
test-string-pool.c
test-subprocess.c
test-svn-fe.c
test-treap.c
thread-utils.c
thread-utils.h
trace.c
transport-helper.c transport-helper: die early on encountering deleted refs 2011-07-19 11:17:48 -07:00
transport.c Merge branch 'maint' 2011-05-30 00:09:55 -07:00
transport.h refactor refs_from_alternate_cb to allow passing extra data 2011-05-19 20:01:10 -07:00
tree-diff.c Merge branch 'jk/diff-not-so-quick' 2011-06-06 11:40:14 -07:00
tree-walk.c
tree-walk.h
tree.c
tree.h
unimplemented.sh
unpack-trees.c Merge branch 'maint' 2011-07-31 18:57:32 -07:00
unpack-trees.h Merge branch 'jc/diff-index-quick-exit-early' 2011-06-29 17:03:11 -07:00
upload-pack.c Merge branch 'jk/maint-upload-pack-shallow' into maint 2011-05-04 14:58:13 -07:00
url.c
url.h
usage.c
userdiff.c Merge branch 'jk/combine-diff-binary-etc' 2011-06-29 17:03:10 -07:00
userdiff.h refactor get_textconv to not require diff_filespec 2011-05-23 15:46:02 -07:00
utf8.c
utf8.h
walker.c
walker.h
wrap-for-bin.sh
wrapper.c read_in_full: always report errors 2011-05-26 13:54:18 -07:00
write_or_die.c
ws.c
wt-status.c Merge branch 'jk/maint-1.7.2-status-ignored' 2011-06-29 17:03:12 -07:00
wt-status.h
xdiff-interface.c add, merge, diff: do not use strcasecmp to compare config variable names 2011-05-14 18:53:39 -07:00
xdiff-interface.h
zlib.c zlib: allow feeding more than 4GB in one go 2011-06-10 16:17:19 -07:00

////////////////////////////////////////////////////////////////

	GIT - the stupid content tracker

////////////////////////////////////////////////////////////////

"git" can mean anything, 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

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.
It was originally written by Linus Torvalds with help of a group of
hackers around the net. It is currently maintained by Junio C Hamano.

Please read the file INSTALL for installation instructions.

See Documentation/gittutorial.txt to get started, then see
Documentation/everyday.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).

Many Git online resources are accessible from http://git-scm.com/
including full documentation and Git related tools.

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. 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
http://marc.theaimsgroup.com/?l=git and other archival sites.

The messages titled "A note from the maintainer", "What's in
git.git (stable)" and "What's cooking in git.git (topics)" and
the discussion following them on the mailing list give a good
reference for project status, development direction and
remaining tasks.