Go to file

Nguyễn Thái Ngọc Duy 80f537f79c doc: promote "git restore" The new command "git restore" (together with "git switch") are added to avoid the confusion of one-command-do-all "git checkout" for new users. They are also helpful to avoid ambiguous context. For these reasons, promote it everywhere possible. This includes documentation, suggestions/advice from other commands. One nice thing about git-restore is the ability to restore "everything", so it can be used in "git status" advice instead of both "git checkout" and "git reset". The three commands suggested by "git status" are add, rm and restore. "git checkout" is also removed from "git help" (i.e. it's no longer considered a commonly used command) Signed-off-by: Nguyễn Thái Ngọc Duy <pclouds@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>		2019-05-07 13:04:48 +09:00
.github	…
Documentation	doc: promote "git restore"	2019-05-07 13:04:48 +09:00
block-sha1	…
builtin	doc: promote "git restore"	2019-05-07 13:04:48 +09:00
ci	travis: remove the hack to build the Windows job on Azure Pipelines	2019-03-01 08:21:26 +09:00
compat	Merge branch 'jk/guard-bswap-header'	2019-03-11 16:16:25 +09:00
contrib	completion: support restore	2019-05-07 13:04:48 +09:00
ewah	…
git-gui	…
gitk-git	…
gitweb	…
mergetools	…
negotiator	…
perl	…
po	l10n: Fixes to Catalan translation	2019-03-02 19:12:58 +01:00
ppc	…
refs	files-backend: drop refs parameter from split_symref_update()	2019-02-14 15:26:15 -08:00
sha1collisiondetection@232357eb2e	…
sha1dc	…
sha256	…
t	doc: promote "git restore"	2019-05-07 13:04:48 +09:00
templates	…
trace2	trace2: create new combined trace facility	2019-02-22 15:27:59 -08:00
vcs-svn	…
xdiff	…
.clang-format	trace2: add for_each macros to clang-format	2019-02-22 15:28:22 -08:00
.editorconfig	…
.gitattributes	…
.gitignore	checkout: split part of it to new command 'restore'	2019-05-07 13:04:47 +09:00
.gitmodules	…
.mailmap	.mailmap: map Clemens Buchacher's mail addresses	2019-02-08 11:14:15 -08:00
.travis.yml	travis: remove the hack to build the Windows job on Azure Pipelines	2019-03-01 08:21:26 +09:00
.tsan-suppressions	…
COPYING	…
GIT-VERSION-GEN	Start 2.22 cycle	2019-03-07 11:59:54 +09:00
INSTALL	…
LGPL-2.1	…
Makefile	checkout: split part of it to new command 'restore'	2019-05-07 13:04:47 +09:00
README.md	README: adjust for final Azure Pipeline ID	2019-02-23 21:27:04 -08:00
RelNotes	Start 2.22 cycle	2019-03-07 11:59:54 +09:00
abspath.c	…
aclocal.m4	…
advice.c	doc: promote "git switch"	2019-04-02 13:57:00 +09:00
advice.h	…
alias.c	…
alias.h	…
alloc.c	object_as_type: initialize commit-graph-related fields of 'struct commit'	2019-01-27 16:55:57 -08:00
alloc.h	object_as_type: initialize commit-graph-related fields of 'struct commit'	2019-01-27 16:55:57 -08:00
apply.c	completion: add more parameter value completion	2019-02-20 12:31:56 -08:00
apply.h	…
archive-tar.c	…
archive-zip.c	…
archive.c	…
archive.h	…
argv-array.c	…
argv-array.h	…
attr.c	Merge branch 'rd/attr.c-comment-typofix'	2019-03-11 16:16:24 +09:00
attr.h	…
azure-pipelines.yml	ci: parallelize testing on Windows	2019-01-29 09:26:47 -08:00
banned.h	…
base85.c	…
bisect.c	Merge branch 'ds/push-sparse-tree-walk'	2019-02-06 22:05:25 -08:00
bisect.h	…
blame.c	Merge branch 'wh/author-committer-ident-config'	2019-03-07 09:59:53 +09:00
blame.h	…
blob.c	…
blob.h	…
branch.c	checkout: inform the user when removing branch state	2019-04-02 13:56:59 +09:00
branch.h	checkout: inform the user when removing branch state	2019-04-02 13:56:59 +09:00
builtin.h	checkout: split part of it to new command 'restore'	2019-05-07 13:04:47 +09:00
bulk-checkin.c	…
bulk-checkin.h	…
bundle.c	create_bundle(): drop unused "header" parameter	2019-01-24 12:35:44 -08:00
bundle.h	create_bundle(): drop unused "header" parameter	2019-01-24 12:35:44 -08:00
cache-tree.c	Merge branch 'jk/loose-object-cache-oid'	2019-02-06 22:05:27 -08:00
cache-tree.h	cache.h: flip NO_THE_INDEX_COMPATIBILITY_MACROS switch	2019-01-24 11:55:06 -08:00
cache.h	Merge branch 'jh/trace2'	2019-03-07 09:59:56 +09:00
chdir-notify.c	…
chdir-notify.h	…
check-builtins.sh	…
check_bindir	…
checkout.c	…
checkout.h	…
color.c	…
color.h	…
column.c	column: drop unused "opts" parameter in item_length()	2019-01-24 12:35:44 -08:00
column.h	…
combine-diff.c	Merge branch 'en/combined-all-paths'	2019-03-07 09:59:54 +09:00
command-list.txt	doc: promote "git restore"	2019-05-07 13:04:48 +09:00
commit-graph.c	Merge branch 'ab/commit-graph-write-progress'	2019-02-05 14:26:14 -08:00
commit-graph.h	Merge branch 'ab/commit-graph-write-progress'	2019-02-05 14:26:14 -08:00
commit-reach.c	Merge branch 'sb/more-repo-in-api'	2019-02-05 14:26:09 -08:00
commit-reach.h	Merge branch 'sb/more-repo-in-api'	2019-02-05 14:26:09 -08:00
commit-slab-decl.h	…
commit-slab-impl.h	…
commit-slab.h	…
commit.c	Merge branch 'sb/more-repo-in-api'	2019-02-05 14:26:09 -08:00
commit.h	Merge branch 'sb/more-repo-in-api'	2019-02-05 14:26:09 -08:00
common-main.c	trace2: collect Windows-specific process information	2019-02-22 15:27:59 -08:00
config.c	Merge branch 'jh/trace2'	2019-03-07 09:59:56 +09:00
config.h	…
config.mak.dev	Merge branch 'jk/dev-build-format-security'	2019-01-18 13:49:55 -08:00
config.mak.in	…
config.mak.uname	Sync with maint	2019-03-11 16:16:34 +09:00
configure.ac	…
connect.c	trace2:data: add trace2 transport child classification	2019-02-22 15:28:14 -08:00
connect.h	…
connected.c	…
connected.h	…
convert.c	Merge branch 'jk/unused-parameter-cleanup'	2019-02-06 22:05:23 -08:00
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	completion: add more parameter value completion	2019-02-20 12:31:56 -08:00
decorate.c	…
decorate.h	…
delta-islands.c	…
delta-islands.h	…
delta.h	…
detect-compiler	…
diff-delta.c	…
diff-lib.c	diff: drop options parameter from diffcore_fix_diff_index()	2019-02-14 15:26:14 -08:00
diff-no-index.c	diff: reuse diff setup for --no-index case	2019-02-24 07:08:34 -08:00
diff.c	Merge branch 'nd/diff-parseopt-2'	2019-03-07 09:59:58 +09:00
diff.h	Merge branch 'jk/diff-no-index-initialize'	2019-03-07 09:59:59 +09:00
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 'nd/the-index-final'	2019-02-06 22:05:23 -08:00
dir.h	…
editor.c	trace2:data: add editor/pager child classification	2019-02-22 15:27:59 -08:00
entry.c	Merge branch 'tg/checkout-no-overlay'	2019-03-07 09:59:51 +09:00
environment.c	Merge branch 'jk/save-getenv-result'	2019-01-29 12:47:54 -08:00
exec-cmd.c	trace2: create new combined trace facility	2019-02-22 15:27:59 -08:00
exec-cmd.h	…
fast-import.c	…
fetch-negotiator.c	…
fetch-negotiator.h	…
fetch-object.c	…
fetch-object.h	…
fetch-pack.c	Merge branch 'bc/fetch-pack-clear-alternate-shallow'	2019-02-06 22:05:30 -08:00
fetch-pack.h	…
fmt-merge-msg.h	…
fsck.c	…
fsck.h	…
fsmonitor.c	…
fsmonitor.h	…
fuzz-commit-graph.c	fuzz-commit-graph: initialize repo object	2019-02-07 13:02:26 -08:00
fuzz-pack-headers.c	…
fuzz-pack-idx.c	…
generate-cmdlist.sh	…
gettext.c	…
gettext.h	…
git-add--interactive.perl	restore: support --patch	2019-05-07 13:04:47 +09:00
git-archimport.perl	…
git-bisect.sh	…
git-compat-util.h	trace2: create new combined trace facility	2019-02-22 15:27:59 -08:00
git-cvsexportcommit.perl	…
git-cvsimport.perl	…
git-cvsserver.perl	…
git-difftool--helper.sh	…
git-filter-branch.sh	…
git-instaweb.sh	git-instaweb: add Python builtin http.server support	2019-01-28 10:57:44 -08:00
git-legacy-rebase.sh	Merge branch 'js/rebase-i-redo-exec-fix'	2019-02-08 20:44:52 -08:00
git-merge-octopus.sh	…
git-merge-one-file.sh	…
git-merge-resolve.sh	…
git-mergetool--lib.sh	…
git-mergetool.sh	…
git-p4.py	Merge branch 'ld/git-p4-shelve-update-fix'	2019-02-05 14:26:10 -08:00
git-parse-remote.sh	…
git-quiltimport.sh	…
git-rebase--am.sh	…
git-rebase--common.sh	Merge branch 'en/rebase-merge-on-sequencer'	2019-02-06 22:05:20 -08:00
git-rebase--preserve-merges.sh	…
git-remote-testgit.sh	…
git-request-pull.sh	…
git-send-email.perl	completion: add more parameter value completion	2019-02-20 12:31:56 -08:00
git-sh-i18n.sh	…
git-sh-setup.sh	…
git-stash.sh	…
git-submodule.sh	submodule: document default behavior	2019-02-15 09:55:27 -08:00
git-svn.perl	…
git-web--browse.sh	…
git.c	checkout: split part of it to new command 'restore'	2019-05-07 13:04:47 +09:00
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: align the longest command in the command listing	2019-01-31 15:27:35 -08:00
help.h	…
hex.c	…
http-backend.c	…
http-fetch.c	…
http-push.c	Merge branch 'jk/loose-object-cache-oid'	2019-02-06 22:05:27 -08:00
http-walker.c	…
http.c	Merge branch 'jk/loose-object-cache-oid'	2019-02-06 22:05:27 -08:00
http.h	Merge branch 'jk/loose-object-cache-oid'	2019-02-06 22:05:27 -08:00
ident.c	config: allow giving separate author and committer idents	2019-02-04 12:18:13 -08:00
imap-send.c	Merge branch 'nd/imap-send-typofix'	2019-02-12 09:00:25 -08:00
interdiff.c	…
interdiff.h	…
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	completion: add more parameter value completion	2019-02-20 12:31:56 -08:00
list-objects-filter-options.h	…
list-objects-filter.c	…
list-objects-filter.h	…
list-objects.c	Merge branch 'ds/push-sparse-tree-walk'	2019-02-06 22:05:25 -08:00
list-objects.h	…
list.h	…
ll-merge.c	…
ll-merge.h	…
lockfile.c	…
lockfile.h	…
log-tree.c	Merge branch 'wh/author-committer-ident-config'	2019-03-07 09:59:53 +09:00
log-tree.h	…
ls-refs.c	Merge branch 'jt/namespaced-ls-refs-fix'	2019-02-05 14:26:15 -08:00
ls-refs.h	…
mailinfo.c	…
mailinfo.h	…
mailmap.c	…
mailmap.h	…
match-trees.c	Merge branch 'jk/unused-parameter-cleanup'	2019-02-06 22:05:23 -08:00
mem-pool.c	…
mem-pool.h	…
merge-blobs.c	…
merge-blobs.h	…
merge-recursive.c	Merge branch 'nd/completion-more-parameters'	2019-03-07 09:59:58 +09:00
merge-recursive.h	…
merge.c	…
mergesort.c	…
mergesort.h	…
midx.c	…
midx.h	…
name-hash.c	cache.h: flip NO_THE_INDEX_COMPATIBILITY_MACROS switch	2019-01-24 11:55:06 -08:00
notes-cache.c	…
notes-cache.h	…
notes-merge.c	…
notes-merge.h	…
notes-utils.c	…
notes-utils.h	…
notes.c	…
notes.h	…
object-store.h	Merge branch 'jk/loose-object-cache-oid'	2019-02-06 22:05:27 -08:00
object.c	object: fix leak of shallow_stat	2019-02-07 13:02:28 -08:00
object.h	…
oidmap.c	…
oidmap.h	…
oidset.c	…
oidset.h	…
pack-bitmap-write.c	…
pack-bitmap.c	…
pack-bitmap.h	…
pack-check.c	…
pack-objects.c	pack-objects: drop unused parameter from oe_map_new_pack()	2019-02-14 15:26:15 -08:00
pack-objects.h	pack-objects: drop unused parameter from oe_map_new_pack()	2019-02-14 15:26:15 -08:00
pack-revindex.c	various: tighten constness of some local variables	2019-02-04 09:57:10 -08:00
pack-revindex.h	…
pack-write.c	…
pack.h	…
packfile.c	Merge branch 'sb/more-repo-in-api'	2019-02-05 14:26:09 -08:00
packfile.h	Merge branch 'sb/more-repo-in-api'	2019-02-05 14:26:09 -08:00
pager.c	trace2:data: add editor/pager child classification	2019-02-22 15:27:59 -08:00
parse-options-cb.c	checkout: split options[] array in three pieces	2019-04-02 13:56:59 +09:00
parse-options.c	parse-options: allow ll_callback with OPTION_CALLBACK	2019-01-27 16:28:18 -08:00
parse-options.h	checkout: split options[] array in three pieces	2019-04-02 13:56:59 +09:00
patch-delta.c	…
patch-ids.c	…
patch-ids.h	…
path.c	…
path.h	…
pathspec.c	Merge branch 'nd/the-index-final'	2019-02-06 22:05:23 -08:00
pathspec.h	…
pkt-line.c	remote-curl: use post_rpc() for protocol v2 also	2019-03-03 19:00:42 +09:00
pkt-line.h	remote-curl: use post_rpc() for protocol v2 also	2019-03-03 19:00:42 +09:00
preload-index.c	…
pretty.c	Merge branch 'nd/completion-more-parameters'	2019-03-07 09:59:58 +09:00
pretty.h	Merge branch 'sb/more-repo-in-api'	2019-02-05 14:26:09 -08:00
prio-queue.c	…
prio-queue.h	…
progress.c	…
progress.h	…
prompt.c	…
prompt.h	…
protocol.c	…
protocol.h	…
quote.c	…
quote.h	…
range-diff.c	…
range-diff.h	…
reachable.c	prune: use bitmaps for reachability traversal	2019-02-14 15:25:33 -08:00
reachable.h	…
read-cache.c	Merge branch 'jh/trace2'	2019-03-07 09:59:56 +09:00
rebase-interactive.c	…
rebase-interactive.h	…
ref-filter.c	Merge branch 'nd/completion-more-parameters'	2019-03-07 09:59:58 +09:00
ref-filter.h	…
reflog-walk.c	…
reflog-walk.h	…
refs.c	…
refs.h	…
refspec.c	…
refspec.h	…
remote-curl.c	Merge branch 'jt/http-auth-proto-v2-fix'	2019-03-07 10:00:00 +09:00
remote-testsvn.c	…
remote.c	Merge branch 'jk/remote-insteadof-cleanup'	2019-01-29 12:47:55 -08:00
remote.h	…
replace-object.c	…
replace-object.h	…
repository.c	trace2: create new combined trace facility	2019-02-22 15:27:59 -08:00
repository.h	trace2: create new combined trace facility	2019-02-22 15:27:59 -08:00
rerere.c	…
rerere.h	…
resolve-undo.c	…
resolve-undo.h	…
revision.c	Merge branch 'en/combined-all-paths'	2019-03-07 09:59:54 +09:00
revision.h	Merge branch 'en/combined-all-paths'	2019-03-07 09:59:54 +09:00
run-command.c	trace2: create new combined trace facility	2019-02-22 15:27:59 -08:00
run-command.h	trace2: create new combined trace facility	2019-02-22 15:27:59 -08:00
send-pack.c	Merge branch 'jk/loose-object-cache-oid'	2019-02-06 22:05:27 -08:00
send-pack.h	…
sequencer.c	Merge branch 'jh/trace2'	2019-03-07 09:59:56 +09:00
sequencer.h	Merge branch 'rj/sequencer-sign-off-header-static'	2019-02-13 18:18:41 -08:00
serve.c	…
serve.h	…
server-info.c	…
setup.c	Merge branch 'js/abspath-part-inside-repo'	2019-02-05 14:26:15 -08:00
sh-i18n--envsubst.c	trace2: create new combined trace facility	2019-02-22 15:27:59 -08:00
sha1-array.c	…
sha1-array.h	…
sha1-file.c	Merge branch 'jk/loose-object-cache-oid'	2019-02-06 22:05:27 -08:00
sha1-lookup.c	…
sha1-lookup.h	…
sha1-name.c	doc: promote "git switch"	2019-04-02 13:57:00 +09:00
sha1dc_git.c	…
sha1dc_git.h	…
shallow.c	…
shell.c	…
shortlog.h	…
sideband.c	Merge branch 'jt/fetch-v2-sideband'	2019-02-05 14:26:11 -08:00
sideband.h	…
sigchain.c	…
sigchain.h	…
split-index.c	Merge branch 'nd/split-index-null-base-fix'	2019-03-07 09:59:56 +09:00
split-index.h	…
strbuf.c	strbuf: separate callback for strbuf_expand:ing literals	2019-01-29 10:03:32 -08:00
strbuf.h	strbuf: separate callback for strbuf_expand:ing literals	2019-01-29 10:03:32 -08:00
streaming.c	Merge branch 'jk/loose-object-cache-oid'	2019-02-06 22:05:27 -08:00
streaming.h	…
string-list.c	…
string-list.h	…
sub-process.c	trace2:data: add trace2 sub-process classification	2019-02-22 15:28:12 -08:00
sub-process.h	…
submodule-config.c	completion: add more parameter value completion	2019-02-20 12:31:56 -08:00
submodule-config.h	…
submodule.c	Merge branch 'nd/completion-more-parameters'	2019-03-07 09:59:58 +09:00
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	…
trace2.c	trace2: create new combined trace facility	2019-02-22 15:27:59 -08:00
trace2.h	trace2: collect Windows-specific process information	2019-02-22 15:27:59 -08:00
trailer.c	pretty: add support for separator option in %(trailers)	2019-01-29 10:03:32 -08:00
trailer.h	pretty: add support for separator option in %(trailers)	2019-01-29 10:03:32 -08:00
transport-helper.c	trace2:data: add trace2 transport child classification	2019-02-22 15:28:14 -08:00
transport-internal.h	…
transport.c	trace2:data: add trace2 hook classification	2019-02-22 15:28:21 -08:00
transport.h	…
tree-diff.c	Merge branch 'bc/tree-walk-oid'	2019-01-29 12:47:56 -08:00
tree-walk.c	Merge branch 'dt/cat-file-batch-ambiguous'	2019-02-06 22:05:21 -08:00
tree-walk.h	Merge branch 'dt/cat-file-batch-ambiguous'	2019-02-06 22:05:21 -08:00
tree.c	Merge branch 'nd/the-index-final'	2019-02-06 22:05:23 -08:00
tree.h	…
unicode-width.h	…
unimplemented.sh	…
unix-socket.c	…
unix-socket.h	…
unpack-trees.c	doc: promote "git switch"	2019-04-02 13:57:00 +09:00
unpack-trees.h	…
upload-pack.c	Merge branch 'jt/fetch-v2-sideband'	2019-02-05 14:26:11 -08:00
upload-pack.h	…
url.c	…
url.h	…
urlmatch.c	…
urlmatch.h	…
usage.c	trace2: create new combined trace facility	2019-02-22 15:27:59 -08:00
userdiff.c	…
userdiff.h	…
utf8.c	utf8: handle systems that don't write BOM for UTF-16	2019-02-11 18:20:07 -08:00
utf8.h	Support working-tree-encoding "UTF-16LE-BOM"	2019-01-31 10:27:52 -08:00
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	doc: promote "git restore"	2019-05-07 13:04:48 +09:00
wt-status.h	…
xdiff-interface.c	completion: add more parameter value completion	2019-02-20 12:31:56 -08:00
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.

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