Go to file
Nguyễn Thái Ngọc Duy b640313110 dir.c: fix missing dir invalidation in untracked code
Let's start with how create a new directory cache after the last one
becomes invalid (e.g. because its dir mtime has changed...). In
open_cached_dir():

1. We start out with valid_cached_dir() returning false, which should
   call invalidate_directory() to put a directory state back to
   initial state, no untracked entries (untracked_nr zero), no sub
   directory traversal (dirs[].recurse zero).

2. Since the cache cannot be used, we go the slow path opendir() and
   go through items one by one via readdir(). All the directories on
   disk will be added back to the cache (if not already exist in
   dirs[]) and its flag "recurse" gets changed to one to note that
   it's part of the cached dir travesal next time.

3. By the time we reach close_cached_dir() we should have a good
   subdir list in dirs[]. Those with "recurse" flag set are the ones
   present in the on-disk directory. The directory is now marked
   "valid".

Next time read_directory() is called, since the directory is marked
valid, it will skip readdir(), go fast path and traverse through
dirs[] array instead.

Steps one and two need some tight cooperation. If a subdir is removed,
readdir() will not find it and of course we cannot examine/invalidate
it. To make sure removed directories on disk are gone from the cache,
step one must make sure recurse flag of all subdirs are zero.

But that's not true. If "valid" flag is already false, there is a
chance we go straight to the end of valid_cached_dir() without calling
invalidate_directory(). Or we fail to meet the "if (untracked-valid)"
condition and skip over the invalidate_directory().

After step 3, we mark the cache valid. Any stale subdir with incorrect
recurse flag becomes a real subdir next time we traverse the directory
using dirs[] array.

We could avoid this by making sure invalidate_directory() is always
called (therefore dirs[].recurse cleared) at the beginning of
open_cached_dir(). Which is what this patch does.

As to how we get into this situation, the key in the test is this
command

    git checkout master

where "one/file" is replaced with "one" in the index. This index
update triggers untracked_cache_invalidate_path(), which clears valid
flag of the root directory while keeping "recurse" flag on the subdir
"one" on. On the next git-status, we go through steps 1-3 above and
save an incorrect cache on disk. The second git-status blindly follows
the bad cache data and shows the problem.

This is arguably because of a bad design where "recurse" flag plays
double roles: whether a directory should be saved on disk, and whether
it is part of a directory traversal.

We need to keep recurse flag set at "checkout master" because of the
first role: we need to keep subdir caches (dir "two" for example has
not been touched at all, no reason to throw its cache away).

As long as we make sure to ignore/reset "recurse" flag at the
beginning of a directory traversal, we're good. But maybe eventually
we should separate these two roles.

Signed-off-by: Nguyễn Thái Ngọc Duy <pclouds@gmail.com>
Signed-off-by: Ævar Arnfjörð Bjarmason <avarab@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2018-01-24 12:40:14 -08:00
.github
Documentation RelNotes: the tenth batch 2017-12-19 11:34:35 -08:00
block-sha1
builtin Merge branch 'ar/unconfuse-three-dots' 2017-12-19 11:33:58 -08:00
ci
compat Merge branch 'bp/fsmonitor' 2017-11-21 14:07:50 +09:00
contrib Merge branch 'ac/complete-pull-autostash' 2017-12-06 09:23:37 -08:00
ewah
git-gui Merge branch 'ls/git-gui-no-double-utf8-author-name' 2017-12-19 11:33:56 -08:00
gitk-git
gitweb
mergetools
perl Git/Packet.pm: use 'if' instead of 'unless' 2017-11-22 16:23:55 +09:00
po
ppc
refs Merge branch 'mh/avoid-rewriting-packed-refs' into maint 2017-12-06 09:08:50 -08:00
sha1collisiondetection@19d97bf5af
sha1dc
t dir.c: fix missing dir invalidation in untracked code 2018-01-24 12:40:14 -08:00
templates
vcs-svn
xdiff Merge branch 'jt/diff-anchored-patience' 2017-12-19 11:33:56 -08:00
.clang-format
.gitattributes
.gitignore
.gitmodules
.mailmap
.travis.yml
.tsan-suppressions
COPYING
GIT-VERSION-GEN
INSTALL
LGPL-2.1
Makefile Merge branch 'tg/worktree-create-tracking' 2017-12-19 11:33:57 -08:00
README.md
RelNotes Prepare for 2.15.2 2017-12-06 09:10:35 -08:00
abspath.c
aclocal.m4
advice.c Merge branch 'ls/editor-waiting-message' 2017-12-19 11:33:59 -08:00
advice.h Merge branch 'ls/editor-waiting-message' 2017-12-19 11:33:59 -08:00
alias.c
alloc.c
apply.c Merge branch 'rs/apply-inaccurate-eof-with-incomplete-line' into maint 2017-12-06 09:09:03 -08:00
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
blame.c
blame.h
blob.c
blob.h
branch.c Merge branch 'jc/branch-name-sanity' 2017-11-28 13:41:49 +09:00
branch.h
builtin.h
bulk-checkin.c
bulk-checkin.h
bundle.c
bundle.h
cache-tree.c
cache-tree.h
cache.h Merge branch 'ls/editor-waiting-message' 2017-12-19 11:33:59 -08:00
check-builtins.sh
check-racy.c
check_bindir
checkout.c checkout: factor out functions to new lib file 2017-11-27 09:48:06 +09:00
checkout.h checkout: factor out functions to new lib file 2017-11-27 09:48:06 +09:00
color.c refactor "dumb" terminal determination 2017-12-04 09:38:30 -08:00
color.h
column.c
column.h
combine-diff.c
command-list.txt
commit-slab.h
commit.c
commit.h
common-main.c
config.c Merge branch 'hm/config-parse-expiry-date' 2017-12-06 09:23:37 -08:00
config.h Merge branch 'hm/config-parse-expiry-date' 2017-12-06 09:23:37 -08:00
config.mak.in
config.mak.uname
configure.ac
connect.c connect: correct style of C-style comment 2017-11-21 14:01:03 +09:00
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 Merge branch 'bc/hash-algo' 2017-12-13 13:28:54 -08:00
diff-no-index.c
diff.c Merge branch 'ar/unconfuse-three-dots' 2017-12-19 11:33:58 -08:00
diff.h diff: support anchoring line(s) 2017-11-28 10:40:04 +09:00
diffcore-break.c
diffcore-delta.c
diffcore-order.c
diffcore-pickaxe.c
diffcore-rename.c diffcore-rename: make diff-tree -l0 mean -l<large> 2017-12-02 22:16:57 -08:00
diffcore.h
dir-iterator.c
dir-iterator.h
dir.c dir.c: fix missing dir invalidation in untracked code 2018-01-24 12:40:14 -08:00
dir.h Merge branch 'bp/fsmonitor' 2017-11-21 14:07:50 +09:00
editor.c launch_editor(): indicate that Git waits for user input 2017-12-07 10:10:19 -08:00
entry.c Merge branch 'bp/fsmonitor' 2017-11-21 14:07:50 +09:00
environment.c Merge branch 'ar/unconfuse-three-dots' 2017-12-19 11:33:58 -08:00
exec_cmd.c
exec_cmd.h
fast-import.c
fetch-pack.c Merge branch 'jk/fewer-pack-rescan' 2017-12-06 09:23:42 -08:00
fetch-pack.h
fmt-merge-msg.h
fsck.c
fsck.h
fsmonitor.c
fsmonitor.h
generate-cmdlist.sh generate-cmdlist: avoid non-deterministic output 2017-11-22 14:56:30 +09:00
gettext.c
gettext.h
git-add--interactive.perl
git-archimport.perl
git-bisect.sh Merge branch 'sb/bisect-run-empty' 2017-11-15 12:14:36 +09:00
git-compat-util.h
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 rebase: use mboxrd format to avoid split errors 2017-11-18 12:30:16 +09:00
git-rebase--interactive.sh Merge branch 'ad/rebase-i-serie-typofix' into maint 2017-11-21 14:05:32 +09:00
git-rebase--merge.sh
git-rebase.sh Merge branch 'tz/redirect-fix' into maint 2017-12-06 09:09:04 -08:00
git-remote-testgit.sh
git-request-pull.sh
git-send-email.perl git-send-email: honor $PATH for sendmail binary 2017-11-28 10:14:30 +09:00
git-sh-i18n.sh
git-sh-setup.sh
git-stash.sh Merge branch 'ph/stash-save-m-option-fix' 2017-12-06 09:23:43 -08:00
git-submodule.sh
git-svn.perl
git-web--browse.sh
git.c Merge branch 'ma/branch-list-paginate' 2017-11-28 13:41:50 +09:00
git.rc
gpg-interface.c
gpg-interface.h
graph.c
graph.h
grep.c Merge branch 'ab/pcre2-grep' 2017-12-13 13:28:54 -08:00
grep.h Merge branch 'ab/pcre-v2' into maint 2017-11-21 14:05:30 +09:00
hash.h
hashmap.c
hashmap.h hashmap: adjust documentation to reflect reality 2017-12-05 13:37:43 -08:00
help.c
help.h
hex.c
http-backend.c
http-fetch.c
http-push.c
http-walker.c
http.c Merge branch 'bw/protocol-v1' 2017-12-06 09:23:44 -08:00
http.h
ident.c
imap-send.c Merge branch 'rs/imap-send-next-arg-fix' into maint 2017-11-27 10:57:00 +09: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: add option to choose which refs to decorate 2017-11-22 13:18:59 +09:00
log-tree.h log: add option to choose which refs to decorate 2017-11-22 13:18:59 +09:00
mailinfo.c
mailinfo.h
mailmap.c
mailmap.h
match-trees.c
merge-blobs.c
merge-blobs.h
merge-recursive.c Merge branch 'en/merge-recursive-icase-removal' 2017-12-19 11:33:55 -08: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.h
notes-utils.c
notes-utils.h
notes.c
notes.h
object.c
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.h
pack-revindex.c
pack-revindex.h
pack-write.c
pack.h
packfile.c
packfile.h
pager.c
parse-options-cb.c
parse-options.c
parse-options.h
patch-delta.c
patch-ids.c
patch-ids.h
path.c
path.h
pathspec.c
pathspec.h Merge branch 'bw/pathspec-match-submodule-boundary' 2017-12-19 11:33:56 -08:00
pkt-line.c Merge branch 'bw/protocol-v1' 2017-12-06 09:23:44 -08:00
pkt-line.h
preload-index.c
pretty.c log: add option to choose which refs to decorate 2017-11-22 13:18:59 +09:00
prio-queue.c
prio-queue.h
progress.c Merge branch 'en/rename-progress' 2017-12-19 11:33:55 -08:00
progress.h progress: fix progress meters when dealing with lots of work 2017-11-15 13:11:25 +09:00
prompt.c
prompt.h
protocol.c
protocol.h
quote.c
quote.h
reachable.c
reachable.h
read-cache.c Merge branch 'tb/add-renormalize' 2017-11-27 11:06:37 +09:00
ref-filter.c Merge branch 'js/for-each-ref-remote-name-and-ref' 2017-11-15 12:14:32 +09:00
ref-filter.h
reflog-walk.c
reflog-walk.h
refs.c log: add option to choose which refs to decorate 2017-11-22 13:18:59 +09:00
refs.h log: add option to choose which refs to decorate 2017-11-22 13:18:59 +09:00
remote-curl.c
remote-testsvn.c
remote.c Merge branch 'js/for-each-ref-remote-name-and-ref' 2017-11-15 12:14:32 +09:00
remote.h
replace_object.c
repository.c repository: fix a sparse 'using integer as NULL pointer' warning 2017-11-28 12:37:37 +09:00
repository.h
rerere.c
rerere.h
resolve-undo.c
resolve-undo.h
revision.c log: add option to choose which refs to decorate 2017-11-22 13:18:59 +09:00
revision.h
run-command.c
run-command.h
send-pack.c
send-pack.h
sequencer.c Merge branch 'en/rename-progress' 2017-12-19 11:33:55 -08:00
sequencer.h
server-info.c
setup.c Merge branch 'sg/setup-doc-update' 2017-12-19 11:33:58 -08:00
sh-i18n--envsubst.c
sha1-array.c
sha1-array.h
sha1-lookup.c
sha1-lookup.h
sha1_file.c Merge branch 'ds/for-each-file-in-obj-micro-optim' 2017-12-13 13:28:57 -08:00
sha1_name.c Merge branch 'jc/branch-name-sanity' 2017-11-28 13:41:49 +09:00
sha1dc_git.c
sha1dc_git.h
shallow.c
shell.c
shortlog.h
show-index.c
sideband.c refactor "dumb" terminal determination 2017-12-04 09:38:30 -08:00
sideband.h
sigchain.c
sigchain.h
split-index.c
split-index.h
strbuf.c
strbuf.h strbuf: remove unused stripspace function alias 2017-12-05 08:50:15 -08:00
streaming.c
streaming.h
string-list.c
string-list.h
sub-process.c
sub-process.h
submodule-config.c
submodule-config.h
submodule.c Merge branch 'bc/hash-algo' 2017-12-13 13:28:54 -08: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: improve performance while category is disabled 2017-12-06 09:43:02 -08:00
trace.h trace: improve performance while category is disabled 2017-12-06 09:43:02 -08:00
trailer.c
trailer.h
transport-helper.c
transport.c
transport.h
tree-diff.c
tree-walk.c Merge branch 'bw/pathspec-match-submodule-boundary' 2017-12-19 11:33:56 -08:00
tree-walk.h
tree.c
tree.h
unicode_width.h
unimplemented.sh
unix-socket.c
unix-socket.h
unpack-trees.c Merge branch 'bp/fsmonitor' 2017-11-21 14:07:50 +09:00
unpack-trees.h
upload-pack.c Merge branch 'bw/protocol-v1' 2017-12-06 09:23:44 -08:00
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 'bw/rebase-i-ignored-submodule-fix' into maint 2017-11-21 14:05:29 +09: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