While working with the worktree based git workflow, I realised that setting
up a new git repository required switching between the traditional and
worktree based workflows. Searching online I found a SO answer [1] which
seemed to support this and which indicated that adding support for this should
not be technically difficult.
This patchset has four parts:
* adding `-B` to the usage docs (noticed during dev and it seemed too small
to justify a separate submission)
* adding a helper fn to simplify testing for mutual exclusion of options
in `t/t2400-worktree-add.sh`
* adding orphan branch functionality (as is present in `git-switch`)
to `git-worktree-add`
* adding an advise for using --orphan when `git worktree add` fails due to
a bad ref.
Changes from v5:
* Touched up commit title and message for 1/4 [2].
* Changed `[-b | -B]` to `(-b | -B)` in 1/4 [2].
* Add whitespace to both sides of () for test_wt_add_excl() in t2400 (2/4) [3].
* Changed test_wt_add_excl() to use `$*` and `$@` instead of `$opts` (2/4) [3].
* Added save_param_arr() to preserve "$@" from being reset by
test_expect_success() in test_wt_add_excl() (2/4).
* Reordered Signed-off-by lines in 3/4 [4].
* Cleaned up commit message in 3/4 to better illustrate the change [4].
* Cleaned up commit message in 4/4 to better illustrate the change.
* Cleaned up commit title in 4/4 [5].
* Changed test_wt_add_empty_repo_orphan_hint() to use `$@` instead
of `$opts` (4/4) [5].
1. https://stackoverflow.com/a/68717229/15064705/
2. https://lore.kernel.org/git/xmqqo7ryyc4f.fsf@gitster.g/
3. https://lore.kernel.org/git/xmqqsfhawwqf.fsf@gitster.g/
4. https://lore.kernel.org/git/xmqqlen2wvtn.fsf@gitster.g/
5. https://lore.kernel.org/git/xmqqfsdawqbw.fsf@gitster.g/
Jacob Abel (4):
worktree add: include -B in usage docs
worktree add: refactor opt exclusion tests
worktree add: add --orphan flag
worktree add: add hint to direct users towards --orphan
Documentation/config/advice.txt | 4 ++
Documentation/git-worktree.txt | 17 ++++-
advice.c | 1 +
advice.h | 1 +
builtin/worktree.c | 65 +++++++++++++++++--
t/t2400-worktree-add.sh | 110 +++++++++++++++++++++++++++++---
6 files changed, 181 insertions(+), 17 deletions(-)
Range-diff against v5:
1: 05371640ad ! 1: a9ef3eca7b worktree add: Include -B in usage docs
@@ Metadata
Author: Jacob Abel <jacobabel@xxxxxxxxxx>
## Commit message ##
- worktree add: Include -B in usage docs
+ worktree add: include -B in usage docs
- While -B behavior is already documented, it was not included in the
- usage docs for either the man page or the help text. This change fixes
- that and brings the usage docs in line with how the flags are documented
- in other commands such as git checkout.
+ Document `-B` next to where `-b` is already documented to bring the
+ usage docs in line with other commands such as git checkout.
Signed-off-by: Jacob Abel <jacobabel@xxxxxxxxxx>
@@ Documentation/git-worktree.txt: SYNOPSIS
[verse]
'git worktree add' [-f] [--detach] [--checkout] [--lock [--reason <string>]]
- [-b <new-branch>] <path> [<commit-ish>]
-+ [[-b | -B] <new-branch>] <path> [<commit-ish>]
++ [(-b | -B) <new-branch>] <path> [<commit-ish>]
'git worktree list' [-v | --porcelain [-z]]
'git worktree lock' [--reason <string>] <worktree>
'git worktree move' <worktree> <new-path>
@@ builtin/worktree.c
#define BUILTIN_WORKTREE_ADD_USAGE \
N_("git worktree add [-f] [--detach] [--checkout] [--lock [--reason <string>]]\n" \
- " [-b <new-branch>] <path> [<commit-ish>]")
-+ " [[-b | -B] <new-branch>] <path> [<commit-ish>]")
++ " [(-b | -B) <new-branch>] <path> [<commit-ish>]")
#define BUILTIN_WORKTREE_LIST_USAGE \
N_("git worktree list [-v | --porcelain [-z]]")
#define BUILTIN_WORKTREE_LOCK_USAGE \
2: 3d8b26f9d6 ! 2: c03c112f79 worktree add: refactor opt exclusion tests
@@ t/t2400-worktree-add.sh: test_expect_success '"add" no auto-vivify with --detach
-test_expect_success '"add" -b/-B mutually exclusive' '
- test_must_fail git worktree add -b poodle -B poodle bamboo main
-'
--
++# Saves parameter sequence/array as a string so they can be safely stored in a
++# variable and restored with `eval "set -- $arr"`. Sourced from
++# https://stackoverflow.com/a/27503158/15064705
++save_param_arr () {
++ local i
++ for i;
++ do
++ # For each argument:
++ # 1. Append "\n" after each entry
++ # 2. Convert "'" into "'\''"
++ # 3. Prepend "'" before each entry
++ # 4. Append " \" after each entry
++ printf "%s\\n" "$i" | sed "
++ s/'/'\\\\''/g
++ 1s/^/'/
++ \$s/\$/' \\\\/
++ "
++ done
++ echo " "
++}
+
-test_expect_success '"add" -b/--detach mutually exclusive' '
- test_must_fail git worktree add -b poodle --detach bamboo main
-'
+# Helper function to test mutually exclusive options.
-+test_wt_add_excl() {
-+ local opts="$@" &&
-+ test_expect_success "'worktree add' with '$opts' has mutually exclusive options" '
-+ test_must_fail git worktree add $opts
++test_wt_add_excl () {
++ local arr=$(save_param_arr "$@")
++ test_expect_success "'worktree add' with $* has mutually exclusive options" '
++ eval "set -- $arr" &&
++ test_must_fail git worktree add "$@"
+ '
+}
3: ccae9cec2e ! 3: 9b93e2493a worktree add: add --orphan flag
@@ Commit message
workflow.
Current Behavior:
-
- % git init --bare foo.git
- Initialized empty Git repository in /path/to/foo.git/
+ % git -C foo.git --no-pager branch -l
+ + main
% git -C foo.git worktree add main/
Preparing worktree (new branch 'main')
+ HEAD is now at 6c93a75 a commit
+ %
+
+ % git init bar.git
+ Initialized empty Git repository in /path/to/bar.git/
+ % git -C bar.git --no-pager branch -l
+
+ % git -C bar.git worktree add main/
+ Preparing worktree (new branch 'main')
fatal: not a valid object name: 'HEAD'
%
New Behavior:
- % git init --bare foo.git
- Initialized empty Git repository in /path/to/foo.git/
- % git -C foo.git worktree add --orphan main main/
+ % git -C foo.git --no-pager branch -l
+ + main
+ % git -C foo.git worktree add main/
+ Preparing worktree (new branch 'main')
+ HEAD is now at 6c93a75 a commit
+ %
+
+ % git init --bare bar.git
+ Initialized empty Git repository in /path/to/bar.git/
+ % git -C bar.git --no-pager branch -l
+
+ % git -C bar.git worktree add main/
+ Preparing worktree (new branch 'main')
+ fatal: invalid reference: HEAD
+ % git -C bar.git worktree add --orphan main main/
Preparing worktree (new branch 'main')
%
- Signed-off-by: Jacob Abel <jacobabel@xxxxxxxxxx>
Signed-off-by: Ævar Arnfjörð Bjarmason <avarab@xxxxxxxxx>
+ Signed-off-by: Jacob Abel <jacobabel@xxxxxxxxxx>
## Documentation/git-worktree.txt ##
@@ Documentation/git-worktree.txt: SYNOPSIS
[verse]
'git worktree add' [-f] [--detach] [--checkout] [--lock [--reason <string>]]
- [[-b | -B] <new-branch>] <path> [<commit-ish>]
+ [(-b | -B) <new-branch>] <path> [<commit-ish>]
+'git worktree add' [-f] [--lock [--reason <string>]]
+ --orphan <new-branch> <path>
'git worktree list' [-v | --porcelain [-z]]
@@ builtin/worktree.c
#define BUILTIN_WORKTREE_ADD_USAGE \
N_("git worktree add [-f] [--detach] [--checkout] [--lock [--reason <string>]]\n" \
-- " [[-b | -B] <new-branch>] <path> [<commit-ish>]")
-+ " [[-b | -B] <new-branch>] <path> [<commit-ish>]"), \
+- " [(-b | -B) <new-branch>] <path> [<commit-ish>]")
++ " [(-b | -B) <new-branch>] <path> [<commit-ish>]"), \
+ N_("git worktree add [-f] [--lock [--reason <string>]]\n" \
+ " --orphan <new-branch> <path>")
+
@@ builtin/worktree.c: static int add(int ac, const char **av, const char *prefix)
strvec_push(&cp.args, "branch");
## t/t2400-worktree-add.sh ##
-@@ t/t2400-worktree-add.sh: test_wt_add_excl() {
+@@ t/t2400-worktree-add.sh: test_wt_add_excl () {
test_wt_add_excl -b poodle -B poodle bamboo main
test_wt_add_excl -b poodle --detach bamboo main
test_wt_add_excl -B poodle --detach bamboo main
4: df4c1fa469 ! 4: 737fca6986 worktree add: Add hint to use --orphan when bad ref
@@ Metadata
Author: Jacob Abel <jacobabel@xxxxxxxxxx>
## Commit message ##
- worktree add: Add hint to use --orphan when bad ref
+ worktree add: add hint to direct users towards --orphan
Adds a new advice/hint in `git worktree add` for when the user
tries to create a new worktree from a reference that doesn't exist.
+ Current Behavior:
+
+ % git init --bare foo.git
+ Initialized empty Git repository in /path/to/foo.git/
+ % git -C foo.git worktree add main/
+ Preparing worktree (new branch 'main')
+ fatal: invalid reference: HEAD
+ %
+
+ New Behavior:
+
+ % git init --bare foo.git
+ Initialized empty Git repository in /path/to/foo.git/
+ % git -C foo.git worktree add main/
+ Preparing worktree (new branch 'main')
+ hint: If you meant to create a worktree containing a new orphan branch
+ hint: (branch with no commits) for this repository, you can do so
+ hint: using the --orphan option:
+ hint:
+ hint: git worktree add --orphan main ./main
+ hint:
+ hint: Disable this message with "git config advice.worktreeAddOrphan false"
+ fatal: invalid reference: HEAD
+ %
+
Signed-off-by: Jacob Abel <jacobabel@xxxxxxxxxx>
## Documentation/config/advice.txt ##
@@ t/t2400-worktree-add.sh: test_expect_success '"add" worktree with orphan branch,
test_cmp expect .git/worktrees/orphan-with-lock-reason/locked
'
-+test_wt_add_empty_repo_orphan_hint() {
++test_wt_add_empty_repo_orphan_hint () {
+ local context="$1"
+ shift
-+ local opts="$@"
++ local arr=$(save_param_arr "$@")
+ test_expect_success "'worktree add' show orphan hint in empty repo w/ $context" '
++ eval "set -- $arr" &&
+ test_when_finished "rm -rf empty_repo" &&
+ GIT_DIR="empty_repo" git init --bare &&
-+ test_must_fail git -C empty_repo worktree add $opts foobar/ 2> actual &&
++ test_must_fail git -C empty_repo worktree add "$@" foobar/ 2> actual &&
+ grep "hint: If you meant to create a worktree containing a new orphan branch" actual
+ '
+}
--
2.38.2
