Go to file
Jameson Miller eec0f7f2b7 status: add option to show ignored files differently
Teach the status command more flexibility in how ignored files are
reported. Currently, the reporting of ignored files and untracked
files are linked. You cannot control how ignored files are reported
independently of how untracked files are reported (i.e. `all` vs
`normal`). This makes it impossible to show untracked files with the
`all` option, but show ignored files with the `normal` option.

This work 1) adds the ability to control the reporting of ignored
files independently of untracked files and 2) introduces the concept
of status reporting ignored paths that explicitly match an ignored
pattern. There are 2 benefits to these changes: 1) if a consumer needs
all untracked files but not all ignored files, there is a performance
benefit to not scanning all contents of an ignored directory and 2)
returning ignored files that explicitly match a path allow a consumer
to make more informed decisions about when a status result might be
stale.

This commit implements --ignored=matching with --untracked-files=all.
The following commit will implement --ignored=matching with
--untracked=files=normal.

As an example of where this flexibility could be useful is that our
application (Visual Studio) runs the status command and presents the
output. It shows all untracked files individually (e.g. using the
'--untracked-files==all' option), and would like to know about which
paths are ignored. It uses information about ignored paths to make
decisions about when the status result might have changed.
Additionally, many projects place build output into directories inside
a repository's working directory (e.g. in "bin/" and "obj/"
directories). Normal usage is to explicitly ignore these 2 directory
names in the .gitignore file (rather than or in addition to the *.obj
pattern).If an application could know that these directories are
explicitly ignored, it could infer that all contents are ignored as
well and make better informed decisions about files in these
directories. It could infer that any changes under these paths would
not affect the output of status. Additionally, there can be a
significant performance benefit by avoiding scanning through ignored
directories.

When status is set to report matching ignored files, it has the
following behavior. Ignored files and directories that explicitly
match an exclude pattern are reported. If an ignored directory matches
an exclude pattern, then the path of the directory is returned. If a
directory does not match an exclude pattern, but all of its contents
are ignored, then the contained files are reported instead of the
directory.

Signed-off-by: Jameson Miller <jamill@microsoft.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2017-10-31 11:54:21 +09:00
.github
Documentation Git 2.15-rc2 2017-10-19 14:49:17 +09:00
block-sha1
builtin status: add option to show ignored files differently 2017-10-31 11:54:21 +09:00
ci travis-ci: fix "skip_branch_tip_with_tag()" string comparison 2017-09-22 10:58:29 +09:00
compat Merge branch 'rb/compat-poll-fix' into maint 2017-10-18 14:19:05 +09:00
contrib Merge branch 'tb/complete-describe' into maint 2017-10-18 14:19:14 +09:00
ewah
git-gui Merge branch 'ma/up-to-date' 2017-09-10 17:08:22 +09:00
gitk-git
gitweb
mergetools
perl Merge branch 'jc/perl-git-comment-typofix' into maint 2017-09-10 17:02:57 +09:00
po
ppc
refs Merge branch 'rs/cleanup-strbuf-users' 2017-10-05 13:48:19 +09:00
sha1collisiondetection@19d97bf5af
sha1dc
t Merge branch 'jk/ref-filter-colors-fix' into maint 2017-10-18 14:20:43 +09:00
templates Merge branch 'ma/up-to-date' 2017-09-10 17:08:22 +09:00
vcs-svn Merge branch 'jn/vcs-svn-cleanup' into maint 2017-09-10 17:03:09 +09:00
xdiff cleanup: fix possible overflow errors in binary search 2017-10-10 08:57:24 +09:00
.clang-format clang-format: add a comment about the meaning/status of the 2017-10-02 13:17:48 +09:00
.gitattributes
.gitignore
.gitmodules
.mailmap .mailmap: normalize name for René Scharfe 2017-10-06 11:31:41 +09:00
.travis.yml travis-ci: move Travis CI code into dedicated scripts 2017-09-11 09:54:08 +09:00
.tsan-suppressions
COPYING
GIT-VERSION-GEN Git 2.15-rc2 2017-10-19 14:49:17 +09:00
INSTALL
LGPL-2.1
Makefile Merge branch 'jt/oidmap' 2017-10-11 14:52:22 +09:00
README.md
RelNotes Prepare for 2.14.3 2017-10-18 14:24:09 +09:00
abspath.c real_path: clarify return value ownership 2017-09-27 09:13:47 +09:00
aclocal.m4
advice.c
advice.h
alias.c
alloc.c
apply.c consistently use "fallthrough" comments in switches 2017-09-22 12:49:57 +09:00
apply.h
archive-tar.c
archive-zip.c
archive.c Merge branch 'rs/archive-excluded-directory' 2017-09-25 15:24:07 +09:00
archive.h
argv-array.c
argv-array.h
attr.c
attr.h
base85.c
bisect.c Merge branch 'ma/leakplugs' 2017-09-29 11:23:43 +09:00
bisect.h
blame.c
blame.h
blob.c
blob.h
branch.c refs: pass NULL to resolve_ref_unsafe() if hash is not needed 2017-09-24 10:18:21 +09:00
branch.h
builtin.h
bulk-checkin.c distinguish error versus short read from read_in_full() 2017-09-27 15:45:24 +09:00
bulk-checkin.h
bundle.c leak_pending: use `object_array_clear()`, not `free()` 2017-09-24 10:05:57 +09:00
bundle.h
cache-tree.c cleanup: fix possible overflow errors in binary search 2017-10-10 08:57:24 +09:00
cache-tree.h
cache.h Merge branch 'jk/no-optional-locks' 2017-10-03 15:42:49 +09:00
check-builtins.sh
check-racy.c
check_bindir
color.c Merge branch 'jk/ref-filter-colors-fix' 2017-10-18 10:19:08 +09:00
color.h
column.c
column.h
combine-diff.c
command-list.txt
commit-slab.h commit-slab.h: avoid -Wsign-compare warnings 2017-09-22 13:00:36 +09:00
commit.c Merge branch 'ma/leakplugs' 2017-09-29 11:23:43 +09:00
commit.h
common-main.c
config.c Merge branch 'jk/ref-filter-colors-fix' into maint 2017-10-18 14:20:43 +09:00
config.h Merge branch 'sd/branch-copy' 2017-10-03 15:42:48 +09:00
config.mak.in
config.mak.uname packed_ref_cache: keep the `packed-refs` file mmapped if possible 2017-09-25 18:02:45 +09:00
configure.ac
connect.c
connect.h
connected.c
connected.h
convert.c consistently use "fallthrough" comments in switches 2017-09-22 12:49:57 +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
credential-store.c
credential.c
credential.h
csum-file.c prefer "!=" when checking read_in_full() result 2017-09-27 15:45:24 +09:00
csum-file.h
ctype.c
daemon.c
date.c
decorate.c
decorate.h
delta.h
diff-delta.c Merge branch 'mk/diff-delta-avoid-large-offset' 2017-09-28 14:47:56 +09:00
diff-lib.c object_array: use `object_array_clear()`, not `free()` 2017-09-24 10:06:01 +09:00
diff-no-index.c
diff.c Merge branch 'jk/ref-filter-colors-fix' 2017-10-18 10:19:08 +09: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 status: add option to show ignored files differently 2017-10-31 11:54:21 +09:00
dir.h status: add option to show ignored files differently 2017-10-31 11:54:21 +09:00
editor.c
entry.c Merge branch 'ls/filter-process-delayed' 2017-10-11 14:52:24 +09:00
environment.c Merge branch 'jk/no-optional-locks' 2017-10-03 15:42:49 +09:00
exec_cmd.c
exec_cmd.h
fast-import.c Merge branch 'er/fast-import-dump-refs-on-checkpoint' 2017-10-05 13:48:19 +09:00
fetch-pack.c oidmap: map with OID as key 2017-10-01 17:18:03 +09:00
fetch-pack.h
fmt-merge-msg.h
fsck.c Merge branch 'rs/fsck-null-return-from-lookup' 2017-10-11 14:52:23 +09:00
fsck.h
generate-cmdlist.sh
gettext.c
gettext.h
git-add--interactive.perl
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 'rj/no-sign-compare' 2017-09-29 11:23:42 +09: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 Merge branch 'dg/filter-branch-filter-order-doc' 2017-10-19 14:45:45 +09:00
git-instaweb.sh
git-merge-octopus.sh Merge branch 'ma/up-to-date' 2017-09-10 17:08:22 +09:00
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 Merge branch 'js/rebase-i-final' 2017-10-03 15:42:47 +09:00
git-rebase--merge.sh
git-rebase.sh Merge branch 'bc/rev-parse-parseopt-fix' 2017-10-03 15:42:47 +09:00
git-remote-testgit.sh
git-request-pull.sh request-pull: capitalise "Git" to make it a proper noun 2017-10-03 13:11:57 +09:00
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 Merge branch 'jk/no-optional-locks' 2017-10-03 15:42:49 +09:00
git.rc
gpg-interface.c
gpg-interface.h
graph.c graph: use strbuf_addchars() to add spaces 2017-10-02 13:14:07 +09:00
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
help.h
hex.c
http-backend.c Merge branch 'rs/resolve-ref-optional-result' 2017-09-28 14:47:56 +09:00
http-fetch.c
http-push.c Merge branch 'tg/memfixes' 2017-10-07 16:27:54 +09:00
http-walker.c
http.c curl_trace(): eliminate switch fallthrough 2017-09-22 12:49:55 +09:00
http.h
ident.c
imap-send.c imap-send: use curl by default when possible 2017-09-15 13:46:19 +09:00
iterator.h
khash.h
kwset.c
kwset.h
levenshtein.c
levenshtein.h
line-log.c ALLOC_GROW: avoid -Wsign-compare warnings 2017-09-22 13:21:11 +09:00
line-log.h ALLOC_GROW: avoid -Wsign-compare warnings 2017-09-22 13:21:11 +09:00
line-range.c
line-range.h
list-objects.c
list-objects.h
list.h
ll-merge.c avoid "write_in_full(fd, buf, len) != len" pattern 2017-09-14 15:17:59 +09:00
ll-merge.h
lockfile.c
lockfile.h
log-tree.c refs: pass NULL to resolve_ref_unsafe() if hash is not needed 2017-09-24 10:18:21 +09:00
log-tree.h
mailinfo.c Merge branch 'rs/mailinfo-qp-decode-fix' into maint 2017-10-18 14:19:03 +09:00
mailinfo.h
mailmap.c
mailmap.h
match-trees.c
merge-blobs.c
merge-blobs.h
merge-recursive.c Merge branch 'kw/merge-recursive-cleanup' 2017-09-19 10:47:56 +09:00
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: drop dead zero-write code 2017-09-26 12:55:59 +09:00
notes-merge.h
notes-utils.c
notes-utils.h
notes.c Merge branch 'mh/notes-cleanup' 2017-09-19 10:47:52 +09:00
notes.h
object.c object_array: add and use `object_array_pop()` 2017-09-24 10:06:04 +09:00
object.h object_array: add and use `object_array_pop()` 2017-09-24 10:06:04 +09:00
oidmap.c oidmap: map with OID as key 2017-10-01 17:18:03 +09:00
oidmap.h oidmap: map with OID as key 2017-10-01 17:18:03 +09:00
oidset.c oidmap: map with OID as key 2017-10-01 17:18:03 +09:00
oidset.h oidmap: map with OID as key 2017-10-01 17:18:03 +09:00
pack-bitmap-write.c pack-bitmap[-write]: use `object_array_clear()`, don't leak 2017-09-24 10:06:08 +09:00
pack-bitmap.c Merge branch 'ma/leakplugs' 2017-09-29 11:23:43 +09:00
pack-bitmap.h
pack-check.c
pack-objects.c
pack-objects.h
pack-revindex.c
pack-revindex.h
pack-write.c avoid looking at errno for short read_in_full() returns 2017-09-27 15:45:24 +09:00
pack.h
packfile.c cleanup: fix possible overflow errors in binary search 2017-10-10 08:57:24 +09:00
packfile.h
pager.c
parse-options-cb.c
parse-options.c parse-options: only insert newline in help text if needed 2017-09-25 14:35:53 +09:00
parse-options.h
patch-delta.c
patch-ids.c
patch-ids.h
path.c Merge branch 'jk/validate-headref-fix' into maint 2017-10-18 14:19:12 +09:00
path.h
pathspec.c pathspec doc: parse_pathspec does not maintain references to args 2017-09-21 14:05:00 +09:00
pathspec.h pathspec doc: parse_pathspec does not maintain references to args 2017-09-21 14:05:00 +09:00
pkt-line.c Merge branch 'ma/pkt-line-leakfix' into maint 2017-10-18 14:19:08 +09:00
pkt-line.h
preload-index.c
pretty.c pretty.c: delimit "%(trailers)" arguments with "," 2017-10-02 09:22:52 +09:00
prio-queue.c
prio-queue.h
progress.c
progress.h
prompt.c
prompt.h
quote.c consistently use "fallthrough" comments in switches 2017-09-22 12:49:57 +09:00
quote.h
reachable.c Merge branch 'nd/prune-in-worktree' 2017-09-19 10:47:53 +09:00
reachable.h
read-cache.c Merge branch 'jk/fallthrough' 2017-09-28 14:47:53 +09:00
ref-filter.c Merge branch 'tb/show-trailers-in-ref-filter' 2017-10-11 14:52:22 +09:00
ref-filter.h
reflog-walk.c refs: pass NULL to resolve_refdup() if hash is not needed 2017-10-01 17:27:14 +09:00
reflog-walk.h
refs.c refs_resolve_ref_unsafe: handle d/f conflicts for writes 2017-10-07 10:32:13 +09:00
refs.h Merge branch 'sd/branch-copy' 2017-10-03 15:42:48 +09:00
remote-curl.c
remote-testsvn.c
remote.c refs: pass NULL to resolve_ref_unsafe() if hash is not needed 2017-09-24 10:18:21 +09:00
remote.h
replace_object.c
repository.c repository: use FREE_AND_NULL 2017-10-02 13:15:59 +09:00
repository.h
rerere.c Merge branch 'jk/write-in-full-fix' 2017-09-25 15:24:06 +09:00
rerere.h
resolve-undo.c
resolve-undo.h
revision.c Merge branch 'rj/no-sign-compare' 2017-09-29 11:23:42 +09:00
revision.h Merge branch 'ma/leakplugs' 2017-09-29 11:23:43 +09:00
run-command.c run-command: use ALLOC_ARRAY 2017-10-03 08:42:57 +09:00
run-command.h
send-pack.c consistently use "fallthrough" comments in switches 2017-09-22 12:49:57 +09:00
send-pack.h
sequencer.c Merge branch 'js/rebase-i-final' 2017-10-18 10:19:07 +09:00
sequencer.h
server-info.c
setup.c Merge branch 'ks/verify-filename-non-option-error-message-tweak' 2017-10-07 16:27:56 +09:00
sh-i18n--envsubst.c
sha1-array.c
sha1-array.h
sha1-lookup.c cleanup: fix possible overflow errors in binary search 2017-10-10 08:57:24 +09:00
sha1-lookup.h
sha1_file.c Merge branch 'jk/sha1-loose-object-info-fix' into maint 2017-10-18 14:19:14 +09:00
sha1_name.c cleanup: fix possible overflow errors in binary search 2017-10-10 08:57:24 +09:00
sha1dc_git.c
sha1dc_git.h
shallow.c Merge branch 'ma/leakplugs' 2017-09-29 11:23:43 +09: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/strbuf-getwholeline-fix' into maint 2017-10-18 14:18:58 +09:00
strbuf.h Merge branch 'jn/strbuf-doc-re-reuse' 2017-10-07 16:27:53 +09:00
streaming.c Merge branch 'jk/write-in-full-fix' 2017-09-25 15:24:06 +09:00
streaming.h
string-list.c cleanup: fix possible overflow errors in binary search 2017-10-10 08:57:24 +09:00
string-list.h string-list.h: move documentation from Documentation/api/ into header 2017-09-27 09:14:34 +09:00
sub-process.c Merge branch 'cc/subprocess-handshake-missing-capabilities' into maint 2017-10-18 14:19:10 +09:00
sub-process.h
submodule-config.c
submodule-config.h
submodule.c Merge branch 'sb/submodule-diff-header-fix' 2017-10-03 15:42:49 +09:00
submodule.h Merge branch 'hn/typofix' 2017-09-28 14:47:52 +09:00
symlinks.c
tag.c Merge branch 'rs/tag-null-pointer-arith-fix' 2017-10-05 13:48:20 +09:00
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 Merge branch 'jk/write-in-full-fix' 2017-09-25 15:24:06 +09:00
transport.c refs: pass NULL to resolve_refdup() if hash is not needed 2017-10-01 17:27:14 +09:00
transport.h
tree-diff.c
tree-walk.c Merge branch 'rj/no-sign-compare' 2017-09-29 11:23:42 +09:00
tree-walk.h
tree.c
tree.h
unicode_width.h
unimplemented.sh
unix-socket.c
unix-socket.h
unpack-trees.c Merge branch 'ls/convert-filter-progress' 2017-09-10 17:08:22 +09:00
unpack-trees.h
upload-pack.c Merge branch 'ma/leakplugs' 2017-09-29 11:23:43 +09:00
url.c
url.h
urlmatch.c
urlmatch.h
usage.c
userdiff.c Merge branch 'ik/userdiff-html-h-element-fix' into maint 2017-10-18 14:19:02 +09:00
userdiff.h
utf8.c cleanup: fix possible overflow errors in binary search 2017-10-10 08:57:24 +09:00
utf8.h
varint.c
varint.h
version.c
version.h
versioncmp.c
walker.c
walker.h
wildmatch.c
wildmatch.h
worktree.c refs: pass NULL to refs_resolve_ref_unsafe() if hash is not needed 2017-09-24 10:18:18 +09:00
worktree.h
wrap-for-bin.sh
wrapper.c avoid "write_in_full(fd, buf, len) != len" pattern 2017-09-14 15:17:59 +09:00
write_or_die.c
ws.c
wt-status.c status: add option to show ignored files differently 2017-10-31 11:54:21 +09:00
wt-status.h status: add option to show ignored files differently 2017-10-31 11:54:21 +09:00
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