mirror of
https://github.com/git/git
synced 2024-11-05 18:59:29 +00:00
da8fb6be55
The order in which the stdout and stderr streams are flushed is not
guaranteed to be the same across platforms or `libc` implementations.
This lack of determinism can lead to anomalous and potentially confusing
output if normal (stdout) output is flushed after error (stderr) output.
For instance, the following output which clearly indicates a failure due
to a fatal error:
% git worktree add ../foo bar
Preparing worktree (checking out 'bar')
fatal: 'bar' is already checked out at '.../wherever'
has been reported[1] on Microsoft Windows to appear as:
% git worktree add ../foo bar
fatal: 'bar' is already checked out at '.../wherever'
Preparing worktree (checking out 'bar')
which may confuse the reader into thinking that the command somehow
recovered and ran to completion despite the error.
This problem crops up because the "chatty" status message "Preparing
worktree" is sent to stdout, whereas the "fatal" error message is sent
to stderr. One way to fix this would be to flush stdout manually before
git-worktree reports any errors to stderr.
However, common practice in Git is for "chatty" messages to be sent to
stderr. Therefore, a more appropriate fix is to adjust git-worktree to
conform to that practice by sending its "chatty" messages to stderr
rather than stdout as is currently the case.
There may be concern that relocating messages from stdout to stderr
could break existing tooling, however, these messages are already
internationalized, thus are unstable. And, indeed, the "Preparing
worktree" message has already been the subject of somewhat significant
changes in 2c27002a0a (worktree: improve message when creating a new
worktree, 2018-04-24). Moreover, there is existing precedent, such as
68b939b2f0 (clone: send diagnostic messages to stderr, 2013-09-18) which
likewise relocated "chatty" messages from stdout to stderr for
git-clone.
[1]: https://lore.kernel.org/git/CA+34VNLj6VB1kCkA=MfM7TZR+6HgqNi5-UaziAoCXacSVkch4A@mail.gmail.com/T/
Reported-by: Baruch Burstein <bmburstein@gmail.com>
Signed-off-by: Eric Sunshine <sunshine@sunshineco.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
122 lines
3.5 KiB
Bash
Executable file
122 lines
3.5 KiB
Bash
Executable file
#!/bin/sh
|
|
|
|
test_description='prune $GIT_DIR/worktrees'
|
|
|
|
GIT_TEST_DEFAULT_INITIAL_BRANCH_NAME=main
|
|
export GIT_TEST_DEFAULT_INITIAL_BRANCH_NAME
|
|
|
|
. ./test-lib.sh
|
|
|
|
test_expect_success initialize '
|
|
git commit --allow-empty -m init
|
|
'
|
|
|
|
test_expect_success 'worktree prune on normal repo' '
|
|
git worktree prune &&
|
|
test_must_fail git worktree prune abc
|
|
'
|
|
|
|
test_expect_success 'prune files inside $GIT_DIR/worktrees' '
|
|
mkdir .git/worktrees &&
|
|
: >.git/worktrees/abc &&
|
|
git worktree prune --verbose 2>actual &&
|
|
cat >expect <<EOF &&
|
|
Removing worktrees/abc: not a valid directory
|
|
EOF
|
|
test_cmp expect actual &&
|
|
! test -f .git/worktrees/abc &&
|
|
! test -d .git/worktrees
|
|
'
|
|
|
|
test_expect_success 'prune directories without gitdir' '
|
|
mkdir -p .git/worktrees/def/abc &&
|
|
: >.git/worktrees/def/def &&
|
|
cat >expect <<EOF &&
|
|
Removing worktrees/def: gitdir file does not exist
|
|
EOF
|
|
git worktree prune --verbose 2>actual &&
|
|
test_cmp expect actual &&
|
|
! test -d .git/worktrees/def &&
|
|
! test -d .git/worktrees
|
|
'
|
|
|
|
test_expect_success SANITY 'prune directories with unreadable gitdir' '
|
|
mkdir -p .git/worktrees/def/abc &&
|
|
: >.git/worktrees/def/def &&
|
|
: >.git/worktrees/def/gitdir &&
|
|
chmod u-r .git/worktrees/def/gitdir &&
|
|
git worktree prune --verbose 2>actual &&
|
|
test_i18ngrep "Removing worktrees/def: unable to read gitdir file" actual &&
|
|
! test -d .git/worktrees/def &&
|
|
! test -d .git/worktrees
|
|
'
|
|
|
|
test_expect_success 'prune directories with invalid gitdir' '
|
|
mkdir -p .git/worktrees/def/abc &&
|
|
: >.git/worktrees/def/def &&
|
|
: >.git/worktrees/def/gitdir &&
|
|
git worktree prune --verbose 2>actual &&
|
|
test_i18ngrep "Removing worktrees/def: invalid gitdir file" actual &&
|
|
! test -d .git/worktrees/def &&
|
|
! test -d .git/worktrees
|
|
'
|
|
|
|
test_expect_success 'prune directories with gitdir pointing to nowhere' '
|
|
mkdir -p .git/worktrees/def/abc &&
|
|
: >.git/worktrees/def/def &&
|
|
echo "$(pwd)"/nowhere >.git/worktrees/def/gitdir &&
|
|
git worktree prune --verbose 2>actual &&
|
|
test_i18ngrep "Removing worktrees/def: gitdir file points to non-existent location" actual &&
|
|
! test -d .git/worktrees/def &&
|
|
! test -d .git/worktrees
|
|
'
|
|
|
|
test_expect_success 'not prune locked checkout' '
|
|
test_when_finished rm -r .git/worktrees &&
|
|
mkdir -p .git/worktrees/ghi &&
|
|
: >.git/worktrees/ghi/locked &&
|
|
git worktree prune &&
|
|
test -d .git/worktrees/ghi
|
|
'
|
|
|
|
test_expect_success 'not prune recent checkouts' '
|
|
test_when_finished rm -r .git/worktrees &&
|
|
git worktree add jlm HEAD &&
|
|
test -d .git/worktrees/jlm &&
|
|
rm -rf jlm &&
|
|
git worktree prune --verbose --expire=2.days.ago &&
|
|
test -d .git/worktrees/jlm
|
|
'
|
|
|
|
test_expect_success 'not prune proper checkouts' '
|
|
test_when_finished rm -r .git/worktrees &&
|
|
git worktree add --detach "$PWD/nop" main &&
|
|
git worktree prune &&
|
|
test -d .git/worktrees/nop
|
|
'
|
|
|
|
test_expect_success 'prune duplicate (linked/linked)' '
|
|
test_when_finished rm -fr .git/worktrees w1 w2 &&
|
|
git worktree add --detach w1 &&
|
|
git worktree add --detach w2 &&
|
|
sed "s/w2/w1/" .git/worktrees/w2/gitdir >.git/worktrees/w2/gitdir.new &&
|
|
mv .git/worktrees/w2/gitdir.new .git/worktrees/w2/gitdir &&
|
|
git worktree prune --verbose 2>actual &&
|
|
test_i18ngrep "duplicate entry" actual &&
|
|
test -d .git/worktrees/w1 &&
|
|
! test -d .git/worktrees/w2
|
|
'
|
|
|
|
test_expect_success 'prune duplicate (main/linked)' '
|
|
test_when_finished rm -fr repo wt &&
|
|
test_create_repo repo &&
|
|
test_commit -C repo x &&
|
|
git -C repo worktree add --detach ../wt &&
|
|
rm -fr wt &&
|
|
mv repo wt &&
|
|
git -C wt worktree prune --verbose 2>actual &&
|
|
test_i18ngrep "duplicate entry" actual &&
|
|
! test -d .git/worktrees/wt
|
|
'
|
|
|
|
test_done
|