Go to file
Elijah Newren 09487f2cba clean: avoid removing untracked files in a nested git repository
Users expect files in a nested git repository to be left alone unless
sufficiently forced (with two -f's).  Unfortunately, in certain
circumstances, git would delete both tracked (and possibly dirty) files
and untracked files within a nested repository.  To explain how this
happens, let's contrast a couple cases.  First, take the following
example setup (which assumes we are already within a git repo):

   git init nested
   cd nested
   >tracked
   git add tracked
   git commit -m init
   >untracked
   cd ..

In this setup, everything works as expected; running 'git clean -fd'
will result in fill_directory() returning the following paths:
   nested/
   nested/tracked
   nested/untracked
and then correct_untracked_entries() would notice this can be compressed
to
   nested/
and then since "nested/" is a directory, we would call
remove_dirs("nested/", ...), which would
check is_nonbare_repository_dir() and then decide to skip it.

However, if someone also creates an ignored file:
   >nested/ignored
then running 'git clean -fd' would result in fill_directory() returning
the same paths:
   nested/
   nested/tracked
   nested/untracked
but correct_untracked_entries() will notice that we had ignored entries
under nested/ and thus simplify this list to
   nested/tracked
   nested/untracked
Since these are not directories, we do not call remove_dirs() which was
the only place that had the is_nonbare_repository_dir() safety check --
resulting in us deleting both the untracked file and the tracked (and
possibly dirty) file.

One possible fix for this issue would be walking the parent directories
of each path and checking if they represent nonbare repositories, but
that would be wasteful.  Even if we added caching of some sort, it's
still a waste because we should have been able to check that "nested/"
represented a nonbare repository before even descending into it in the
first place.  Add a DIR_SKIP_NESTED_GIT flag to dir_struct.flags and use
it to prevent fill_directory() and friends from descending into nested
git repos.

With this change, we also modify two regression tests added in commit
91479b9c72 ("t7300: add tests to document behavior of clean and nested
git", 2015-06-15).  That commit, nor its series, nor the six previous
iterations of that series on the mailing list discussed why those tests
coded the expectation they did.  In fact, it appears their purpose was
simply to test _existing_ behavior to make sure that the performance
changes didn't change the behavior.  However, these two tests directly
contradicted the manpage's claims that two -f's were required to delete
files/directories under a nested git repository.  While one could argue
that the user gave an explicit path which matched files/directories that
were within a nested repository, there's a slippery slope that becomes
very difficult for users to understand once you go down that route (e.g.
what if they specified "git clean -f -d '*.c'"?)  It would also be hard
to explain what the exact behavior was; avoid such problems by making it
really simple.

Also, clean up some grammar errors describing this functionality in the
git-clean manpage.

Finally, there are still a couple bugs with -ffd not cleaning out enough
(e.g.  missing the nested .git) and with -ffdX possibly cleaning out the
wrong files (paying attention to outer .gitignore instead of inner).
This patch does not address these cases at all (and does not change the
behavior relative to those flags), it only fixes the handling when given
a single -f.  See
https://public-inbox.org/git/20190905212043.GC32087@szeder.dev/ for more
discussion of the -ffd[X?] bugs.

Signed-off-by: Elijah Newren <newren@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2019-09-17 12:20:35 -07:00
.github
Documentation clean: avoid removing untracked files in a nested git repository 2019-09-17 12:20:35 -07:00
block-sha1
builtin clean: avoid removing untracked files in a nested git repository 2019-09-17 12:20:35 -07:00
ci ci/lib.sh: update a comment about installed P4 and Git-LFS versions 2019-07-08 11:01:48 -07:00
compat Merge branch 'js/mingw-spawn-with-spaces-in-path' into maint 2019-07-29 12:38:17 -07:00
contrib Merge branch 'nd/completion-no-cache-failure' into maint 2019-07-29 12:38:20 -07:00
ewah
git-gui
gitk-git
gitweb
mergetools
negotiator
perl
po Merge branch 'fr_review' of git://github.com/jnavila/git 2019-06-07 16:51:09 +08:00
ppc
refs
sha1collisiondetection@855827c583 sha1dc: update from upstream 2019-05-14 16:45:01 +09:00
sha1dc sha1dc: update from upstream 2019-05-14 16:45:01 +09:00
sha256
t clean: avoid removing untracked files in a nested git repository 2019-09-17 12:20:35 -07:00
templates
trace2 Merge branch 'sg/trace2-rename' 2019-05-30 10:50:45 -07:00
vcs-svn
xdiff Merge branch 'cb/xdiff-no-system-includes-in-dot-c' into maint 2019-08-09 15:18:19 -07:00
.clang-format clang-format: use git grep to generate the ForEachMacros list 2019-06-04 14:50:40 -07:00
.editorconfig
.gitattributes
.gitignore Merge branch 'js/misc-doc-fixes' 2019-05-09 00:37:27 +09:00
.gitmodules
.mailmap .mailmap: update email address of Philip Oakley 2019-08-11 15:07:51 -07:00
.travis.yml
.tsan-suppressions
COPYING
GIT-VERSION-GEN Git 2.22.1 2019-08-11 15:07:51 -07:00
INSTALL
LGPL-2.1
Makefile Merge branch 'jk/cocci-batch' 2019-05-19 16:45:28 +09:00
README.md README: fix rendering of text in angle brackets 2019-07-18 14:47:46 -07:00
RelNotes Flush fixes up to the third batch post 2.22.0 2019-07-25 14:32:36 -07:00
abspath.c
aclocal.m4
advice.c
advice.h Merge branch 'dl/no-extern-in-func-decl' 2019-05-13 23:50:32 +09:00
alias.c
alias.h
alloc.c
alloc.h
apply.c fill_stat_cache_info(): prepare for an fsmonitor fix 2019-05-28 12:43:42 -07:00
apply.h
archive-tar.c
archive-zip.c
archive.c Merge branch 'en/merge-directory-renames' 2019-05-09 00:37:22 +09:00
archive.h Merge branch 'dl/no-extern-in-func-decl' 2019-05-13 23:50:32 +09:00
argv-array.c
argv-array.h
attr.c
attr.h
azure-pipelines.yml
banned.h
base85.c
bisect.c
bisect.h
blame.c Merge branch 'en/merge-directory-renames' 2019-05-09 00:37:22 +09:00
blame.h Merge branch 'dl/no-extern-in-func-decl' 2019-05-13 23:50:32 +09:00
blob.c
blob.h
branch.c Merge branch 'dl/branch-from-3dot-merge-base' 2019-05-19 16:45:28 +09:00
branch.h
builtin.h Merge branch 'dl/no-extern-in-func-decl' 2019-05-13 23:50:32 +09:00
bulk-checkin.c
bulk-checkin.h
bundle.c bundle verify: error out if called without an object database 2019-05-28 13:04:14 -07:00
bundle.h
cache-tree.c
cache-tree.h
cache.h Merge branch 'sg/rebase-progress' into maint 2019-07-29 12:38:19 -07:00
chdir-notify.c
chdir-notify.h
check-builtins.sh
check_bindir
checkout.c
checkout.h
color.c
color.h
column.c
column.h
combine-diff.c
command-list.txt
commit-graph.c Merge branch 'ds/close-object-store' into maint 2019-07-29 12:38:22 -07:00
commit-graph.h commit-graph: use raw_object_store when closing 2019-06-12 11:33:54 -07:00
commit-reach.c
commit-reach.h
commit-slab-decl.h
commit-slab-impl.h
commit-slab.h
commit.c Merge branch 'ds/close-object-store' into maint 2019-07-29 12:38:22 -07:00
commit.h Merge branch 'dl/no-extern-in-func-decl' 2019-05-13 23:50:32 +09:00
common-main.c
config.c config: simplify parsing of unit factors 2019-06-24 12:34:20 -07:00
config.h Merge branch 'dl/no-extern-in-func-decl' 2019-05-13 23:50:32 +09:00
config.mak.dev
config.mak.in
config.mak.uname Merge branch 'id/windows-dep-aslr' 2019-05-19 16:45:27 +09:00
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-islands.c delta-islands: respect progress flag 2019-06-20 13:29:49 -07:00
delta-islands.h delta-islands: respect progress flag 2019-06-20 13:29:49 -07:00
delta.h
detect-compiler
diff-delta.c
diff-lib.c mark_fsmonitor_valid(): mark the index as changed if needed 2019-05-28 12:43:43 -07:00
diff-no-index.c
diff.c Merge branch 'js/unmap-before-ext-diff' into maint 2019-07-29 12:38:11 -07:00
diff.h Merge branch 'nd/diff-parseopt' 2019-05-30 10:50:44 -07:00
diffcore-break.c
diffcore-delta.c
diffcore-order.c
diffcore-pickaxe.c
diffcore-rename.c cleanup: fix possible overflow errors in binary search, part 2 2019-06-13 11:28:53 -07:00
diffcore.h
dir-iterator.c
dir-iterator.h
dir.c clean: avoid removing untracked files in a nested git repository 2019-09-17 12:20:35 -07:00
dir.h clean: avoid removing untracked files in a nested git repository 2019-09-17 12:20:35 -07:00
editor.c pager: add a helper function to clear the last line in the terminal 2019-06-24 13:38:46 -07:00
entry.c fill_stat_cache_info(): prepare for an fsmonitor fix 2019-05-28 12:43:42 -07:00
environment.c
exec-cmd.c
exec-cmd.h
fast-import.c use COPY_ARRAY for copying arrays 2019-06-17 18:15:04 -07:00
fetch-negotiator.c
fetch-negotiator.h
fetch-object.c
fetch-object.h
fetch-pack.c Merge branch 'jt/clone-server-option' 2019-05-30 10:50:46 -07:00
fetch-pack.h
fmt-merge-msg.h
fsck.c
fsck.h
fsmonitor.c Merge branch 'cb/fsmonitor-intfix' into maint 2019-07-29 12:38:15 -07:00
fsmonitor.h mark_fsmonitor_valid(): mark the index as changed if needed 2019-05-28 12:43:43 -07:00
fuzz-commit-graph.c
fuzz-pack-headers.c
fuzz-pack-idx.c
generate-cmdlist.sh
gettext.c
gettext.h
git-add--interactive.perl Merge branch 'pw/add-p-recount' into maint 2019-07-29 12:38:22 -07:00
git-archimport.perl
git-bisect.sh
git-compat-util.h Merge branch 'cc/access-on-aix-workaround' 2019-05-13 23:50:35 +09:00
git-cvsexportcommit.perl
git-cvsimport.perl
git-cvsserver.perl
git-difftool--helper.sh mergetool: use get_merge_tool function 2019-05-13 23:11:59 +09:00
git-filter-branch.sh
git-instaweb.sh
git-legacy-stash.sh
git-merge-octopus.sh
git-merge-one-file.sh
git-merge-resolve.sh
git-mergetool--lib.sh Merge branch 'dl/difftool-mergetool' 2019-05-19 16:45:30 +09:00
git-mergetool.sh mergetool: use get_merge_tool function 2019-05-13 23:11:59 +09:00
git-p4.py Merge branch 'sw/git-p4-unshelve-branched-files' into maint 2019-07-25 14:27:15 -07:00
git-parse-remote.sh
git-quiltimport.sh
git-rebase--am.sh
git-rebase--common.sh
git-rebase--preserve-merges.sh
git-request-pull.sh request-pull: warn if the remote object is not the same as the local one 2019-05-28 13:06:25 -07:00
git-send-email.perl
git-sh-i18n.sh
git-sh-setup.sh
git-submodule.sh Merge branch 'km/empty-repo-is-still-a-repo' 2019-05-09 00:37:23 +09:00
git-svn.perl
git-web--browse.sh
git.c Merge branch 'js/misc-doc-fixes' 2019-05-09 00:37:27 +09:00
git.rc
gpg-interface.c gpg-interface: do not scan past the end of buffer 2019-07-16 12:15:12 -07:00
gpg-interface.h
graph.c
graph.h
grep.c grep: fail if call could output and name is null 2019-05-28 10:57:07 -07:00
grep.h
hash.h
hashmap.c
hashmap.h
help.c
help.h
hex.c
http-backend.c
http-fetch.c
http-push.c Merge branch 'cb/http-push-null-in-message-fix' 2019-05-19 16:45:35 +09:00
http-walker.c
http.c Make fread/fwrite-like functions in http.c more like fread/fwrite. 2019-05-08 12:15:25 +09:00
http.h Merge branch 'dl/no-extern-in-func-decl' 2019-05-13 23:50:32 +09:00
ident.c
imap-send.c
interdiff.c
interdiff.h
iterator.h
json-writer.c
json-writer.h
khash.h Merge branch 'dl/no-extern-in-func-decl' 2019-05-13 23:50:32 +09:00
kwset.c Merge branch 'rs/copy-array' into maint 2019-07-29 12:38:15 -07:00
kwset.h
levenshtein.c
levenshtein.h
line-log.c Merge branch 'en/merge-directory-renames' 2019-05-09 00:37:22 +09:00
line-log.h
line-range.c
line-range.h
linear-assignment.c
linear-assignment.h
list-objects-filter-options.c list-objects-filter: disable 'sparse:path' filters 2019-05-29 11:05:34 -07:00
list-objects-filter-options.h list-objects-filter: disable 'sparse:path' filters 2019-05-29 11:05:34 -07:00
list-objects-filter.c Merge branch 'md/list-objects-filter-memfix' into maint 2019-07-25 14:27:12 -07:00
list-objects-filter.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
ls-refs.c upload-pack: strip namespace from symref data 2019-05-28 10:02:00 -07:00
ls-refs.h
mailinfo.c
mailinfo.h
mailmap.c
mailmap.h
match-trees.c
mem-pool.c
mem-pool.h
merge-blobs.c
merge-blobs.h
merge-recursive.c Merge branch 'en/merge-directory-renames-fix' 2019-06-06 14:03:36 -07:00
merge-recursive.h
merge.c
mergesort.c
mergesort.h
midx.c
midx.h
name-hash.c cleanup: fix possible overflow errors in binary search, part 2 2019-06-13 11:28:53 -07:00
notes-cache.c
notes-cache.h
notes-merge.c
notes-merge.h
notes-utils.c
notes-utils.h
notes.c Merge branch 'en/merge-directory-renames' 2019-05-09 00:37:22 +09:00
notes.h
object-store.h Merge branch 'ds/object-info-for-prefetch-fix' into maint 2019-07-25 14:27:08 -07:00
object.c packfile: rename close_all_packs to close_object_store 2019-06-12 11:33:54 -07: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.h
pack-revindex.c
pack-revindex.h
pack-write.c
pack.h
packfile.c Merge branch 'ds/close-object-store' into maint 2019-07-29 12:38:22 -07:00
packfile.h Merge branch 'ds/close-object-store' into maint 2019-07-29 12:38:22 -07:00
pager.c pager: add a helper function to clear the last line in the terminal 2019-06-24 13:38:46 -07:00
parse-options-cb.c Merge branch 'nd/diff-parseopt' 2019-05-30 10:50:44 -07:00
parse-options.c Merge branch 'nd/diff-parseopt' 2019-05-30 10:50:44 -07:00
parse-options.h Merge branch 'js/parseopt-unknown-cb-returns-an-enum' 2019-05-19 16:45:34 +09:00
patch-delta.c
patch-ids.c
patch-ids.h
path.c
path.h
pathspec.c
pathspec.h
pkt-line.c pkt-line: drop 'const'-ness of a param to set_packet_header() 2019-05-16 13:29:06 +09:00
pkt-line.h
preload-index.c mark_fsmonitor_valid(): mark the index as changed if needed 2019-05-28 12:43:43 -07:00
pretty.c use COPY_ARRAY for copying arrays 2019-06-17 18:15:04 -07:00
pretty.h
prio-queue.c
prio-queue.h
progress.c progress: use term_clear_line() 2019-06-27 12:58:41 -07:00
progress.h
prompt.c
prompt.h
protocol.c
protocol.h
quote.c
quote.h
range-diff.c
range-diff.h
reachable.c
reachable.h
read-cache.c Merge branch 'rs/avoid-overflow-in-midpoint-computation' into maint 2019-07-29 12:38:21 -07:00
rebase-interactive.c
rebase-interactive.h
ref-filter.c Merge branch 'dr/ref-filter-push-track-fix' 2019-05-09 00:37:26 +09:00
ref-filter.h
reflog-walk.c
reflog-walk.h
refs.c
refs.h Merge branch 'dl/no-extern-in-func-decl' 2019-05-13 23:50:32 +09:00
refspec.c
refspec.h
remote-curl.c i18n: fix typos found during l10n for git 2.22.0 2019-06-03 11:10:53 -07:00
remote-testsvn.c
remote.c Merge branch 'dr/ref-filter-push-track-fix' 2019-05-09 00:37:26 +09:00
remote.h Merge branch 'dl/no-extern-in-func-decl' 2019-05-13 23:50:32 +09:00
replace-object.c
replace-object.h
repository.c
repository.h
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 'pw/rebase-abort-clean-rewritten' into maint 2019-07-29 12:38:20 -07:00
sequencer.h Merge branch 'pw/clean-sequencer-state-upon-final-commit' 2019-05-13 23:50:35 +09:00
serve.c
serve.h
server-info.c server-info: do not list unlinked packs 2019-05-28 11:02:52 -07:00
setup.c
sh-i18n--envsubst.c cleanup: fix possible overflow errors in binary search, part 2 2019-06-13 11:28:53 -07:00
sha1-array.c
sha1-array.h
sha1-file.c Merge branch 'ds/object-info-for-prefetch-fix' into maint 2019-07-25 14:27:08 -07:00
sha1-lookup.c
sha1-lookup.h
sha1-name.c Merge branch 'jk/get-oid-indexed-object-name' 2019-05-19 16:45:35 +09:00
sha1dc_git.c
sha1dc_git.h
shallow.c
shell.c
shortlog.h
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
sub-process.c
sub-process.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
trace2.c Merge branch 'jh/trace2' 2019-05-13 23:50:35 +09:00
trace2.h trace2: rename environment variables to GIT_TRACE2* 2019-05-28 10:20:34 -07:00
trailer.c
trailer.h
transport-helper.c Merge branch 'es/local-atomic-push-failure-with-http' into maint 2019-07-29 12:38:16 -07:00
transport-internal.h
transport.c transport-helper: avoid var decl in for () loop control 2019-07-16 13:30:33 -07:00
transport.h
tree-diff.c
tree-walk.c
tree-walk.h Merge branch 'dl/no-extern-in-func-decl' 2019-05-13 23:50:32 +09:00
tree.c
tree.h
unicode-width.h Merge branch 'bb/unicode-12.1-reiwa' into maint 2019-07-25 14:27:11 -07:00
unimplemented.sh
unix-socket.c
unix-socket.h
unpack-trees.c
unpack-trees.h
upload-pack.c Merge branch 'ds/close-object-store' into maint 2019-07-29 12:38:22 -07:00
upload-pack.h
url.c url: do not allow %00 to represent NUL in URLs 2019-06-04 14:48:25 -07:00
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 Merge branch 'nd/corrupt-worktrees' into maint 2019-07-25 14:27:07 -07:00
worktree.h
wrap-for-bin.sh
wrapper.c wrapper: avoid undefined behaviour in macOS 2019-06-19 07:41:31 -07:00
write-or-die.c
ws.c
wt-status.c Merge branch 'js/rebase-i-label-shown-in-status-fix' 2019-05-19 16:45:33 +09:00
wt-status.h wt-status.h: drop stdio.h include 2019-06-19 08:19:22 -07:00
xdiff-interface.c
xdiff-interface.h
zlib.c

README.md

Build Status

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-<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).

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