diff options
| author |  Elijah Newren <newren@gmail.com> | 2020-06-11 06:59:31 +0000 |
|---|---|---|
| committer |  Junio C Hamano <gitster@pobox.com> | 2020-06-12 17:27:16 -0700 |
| commit | 351ea1c3cbf416b40cb999ea7426da633fa64918 (patch) | |
| tree | dea4c3b1cd726f6b8fcf84a154a1e4d88bbb3ed0 | |
| parent | dir: fix a few confusing comments (diff) | |
| download | tgif-351ea1c3cbf416b40cb999ea7426da633fa64918.tar.xz | |
dir, clean: avoid disallowed behavior
dir.h documented quite clearly that DIR_SHOW_IGNORED and
DIR_SHOW_IGNORED_TOO are mutually exclusive, with a big comment to this
effect by the definition of both enum values. However, a command like
git clean -fx $DIR
would set both values for dir.flags. I _think_ it happened to work
because:
* As dir.h points out, DIR_KEEP_UNTRACKED_CONTENTS only takes effect
if DIR_SHOW_IGNORED_TOO is set.
* As coded, I believe DIR_SHOW_IGNORED would just happen to take
precedence over DIR_SHOW_IGNORED_TOO in the code as currently
constructed.
Which is a long way of saying "we just got lucky".
Fix clean.c to avoid setting these mutually exclusive values at the same
time, and add a check to dir.c that will throw a BUG() to prevent anyone
else from making this mistake.
Signed-off-by: Elijah Newren <newren@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
| -rw-r--r-- | builtin/clean.c | 2 | ||||
| -rw-r--r-- | dir.c | 4 |
2 files changed, 5 insertions, 1 deletions
diff --git a/builtin/clean.c b/builtin/clean.c index 4ca12bc0c0..3ca940f83a 100644 --- a/builtin/clean.c +++ b/builtin/clean.c @@ -954,7 +954,7 @@ int cmd_clean(int argc, const char **argv, const char *prefix) remove_directories = 1; } - if (remove_directories) + if (remove_directories && !ignored_only) dir.flags |= DIR_SHOW_IGNORED_TOO | DIR_KEEP_UNTRACKED_CONTENTS; if (read_cache() < 0) @@ -193,6 +193,10 @@ int fill_directory(struct dir_struct *dir, const char *prefix; size_t prefix_len; + unsigned exclusive_flags = DIR_SHOW_IGNORED | DIR_SHOW_IGNORED_TOO; + if ((dir->flags & exclusive_flags) == exclusive_flags) + BUG("DIR_SHOW_IGNORED and DIR_SHOW_IGNORED_TOO are exclusive"); + /* * Calculate common prefix for the pathspec, and * use that to optimize the directory walk |