From: Jacob Abel <jacobabel@nullpo.dev>
To: git@vger.kernel.org
Cc: "Jacob Abel" <jacobabel@nullpo.dev>,
"Ævar Arnfjörð Bjarmason" <avarab@gmail.com>,
"Eric Sunshine" <sunshine@sunshineco.com>,
"Junio C Hamano" <gitster@pobox.com>,
"Phillip Wood" <phillip.wood123@gmail.com>,
"Rubén Justo" <rjusto@gmail.com>, "Taylor Blau" <me@ttaylorr.com>,
rsbecker@nexbridge.com
Subject: [PATCH v6 0/4] worktree: Support `--orphan` when creating new worktrees
Date: Wed, 28 Dec 2022 06:16:33 +0000 [thread overview]
Message-ID: <20221228061539.13740-1-jacobabel@nullpo.dev> (raw)
In-Reply-To: <20221220023637.29042-1-jacobabel@nullpo.dev>
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@nullpo.dev>
## 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@nullpo.dev>
@@ 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@nullpo.dev>
Signed-off-by: Ævar Arnfjörð Bjarmason <avarab@gmail.com>
+ Signed-off-by: Jacob Abel <jacobabel@nullpo.dev>
## 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@nullpo.dev>
## 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@nullpo.dev>
## 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
next prev parent reply other threads:[~2022-12-28 6:16 UTC|newest]
Thread overview: 129+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-11-04 1:02 [PATCH 0/4] worktree: Support `--orphan` when creating new worktrees Jacob Abel
2022-11-04 1:03 ` [PATCH 1/4] worktree add: Include -B in usage docs Jacob Abel
2022-11-04 3:05 ` Eric Sunshine
2022-11-04 4:24 ` Jacob Abel
2022-11-04 1:03 ` [PATCH 2/4] builtin/worktree.c: Update checkout_worktree() to use git-worktree Jacob Abel
2022-11-04 1:32 ` Ævar Arnfjörð Bjarmason
2022-11-04 3:58 ` Jacob Abel
2022-11-04 20:45 ` Taylor Blau
2022-11-04 1:03 ` [PATCH 3/4] worktree add: add --orphan flag Jacob Abel
2022-11-04 1:33 ` Ævar Arnfjörð Bjarmason
2022-11-04 4:11 ` Jacob Abel
2022-11-04 5:03 ` Eric Sunshine
2022-11-04 16:41 ` Jacob Abel
2022-11-10 4:13 ` Eric Sunshine
2022-11-10 21:21 ` Jacob Abel
2022-11-04 1:03 ` [PATCH 4/4] worktree add: Add unit tests for --orphan Jacob Abel
2022-11-04 1:37 ` Ævar Arnfjörð Bjarmason
2022-11-04 4:17 ` Jacob Abel
2022-11-04 4:33 ` [PATCH 0/4] worktree: Support `--orphan` when creating new worktrees Eric Sunshine
2022-11-04 4:47 ` Jacob Abel
2022-11-04 4:50 ` Jacob Abel
2022-11-04 21:34 ` [PATCH v2 0/2] " Jacob Abel
2022-11-04 21:34 ` [PATCH v2 1/2] worktree add: Include -B in usage docs Jacob Abel
2022-11-04 21:34 ` [PATCH v2 2/2] worktree add: add --orphan flag Jacob Abel
2022-11-10 23:32 ` [PATCH v3 0/2] worktree: Support `--orphan` when creating new worktrees Jacob Abel
2022-11-10 23:32 ` [PATCH v3 1/2] worktree add: Include -B in usage docs Jacob Abel
2022-11-10 23:32 ` [PATCH v3 2/2] worktree add: add --orphan flag Jacob Abel
2022-11-15 21:08 ` Ævar Arnfjörð Bjarmason
2022-11-15 21:29 ` Eric Sunshine
2022-11-15 22:35 ` Ævar Arnfjörð Bjarmason
2022-11-16 0:19 ` Eric Sunshine
2022-11-19 3:13 ` Jacob Abel
2022-11-19 3:09 ` Jacob Abel
2022-11-19 11:50 ` Ævar Arnfjörð Bjarmason
2022-11-19 1:44 ` Jacob Abel
2022-11-22 6:00 ` Eric Sunshine
2022-11-22 23:09 ` Jacob Abel
2022-11-15 22:09 ` Ævar Arnfjörð Bjarmason
2022-11-19 2:57 ` Jacob Abel
2022-11-19 11:50 ` Ævar Arnfjörð Bjarmason
2022-11-16 0:39 ` [PATCH v3 0/2] worktree: Support `--orphan` when creating new worktrees Eric Sunshine
2022-11-17 10:00 ` Ævar Arnfjörð Bjarmason
2022-11-19 3:47 ` Jacob Abel
2022-11-19 11:48 ` Ævar Arnfjörð Bjarmason
2022-11-22 5:16 ` Eric Sunshine
2022-11-22 23:26 ` Jacob Abel
2022-11-22 23:55 ` Ævar Arnfjörð Bjarmason
2022-11-23 2:47 ` Jacob Abel
2022-11-23 2:43 ` Rubén Justo
2022-11-23 5:37 ` Jacob Abel
2022-11-23 7:35 ` Rubén Justo
2022-11-22 14:45 ` Phillip Wood
2022-11-23 4:21 ` Jacob Abel
2022-12-12 1:42 ` [PATCH v4 0/3] " Jacob Abel
2022-12-12 1:42 ` [PATCH v4 1/3] worktree add: Include -B in usage docs Jacob Abel
2022-12-12 1:42 ` [PATCH v4 2/3] worktree add: add --orphan flag Jacob Abel
2022-12-12 8:11 ` Ævar Arnfjörð Bjarmason
2022-12-12 14:55 ` Jacob Abel
2022-12-12 18:14 ` Ævar Arnfjörð Bjarmason
2022-12-12 22:39 ` Jacob Abel
2022-12-12 1:43 ` [PATCH v4 3/3] worktree add: Add hint to use --orphan when bad ref Jacob Abel
2022-12-12 8:35 ` Ævar Arnfjörð Bjarmason
2022-12-12 14:59 ` Jacob Abel
2022-12-12 18:16 ` Ævar Arnfjörð Bjarmason
2022-12-12 18:35 ` Eric Sunshine
2022-12-12 22:36 ` Jacob Abel
2022-12-12 22:38 ` Jacob Abel
2022-12-20 2:37 ` [PATCH v5 0/4] worktree: Support `--orphan` when creating new worktrees Jacob Abel
2022-12-20 2:37 ` [PATCH v5 1/4] worktree add: Include -B in usage docs Jacob Abel
2022-12-20 3:42 ` Junio C Hamano
2022-12-20 23:24 ` Jacob Abel
2022-12-20 2:37 ` [PATCH v5 2/4] worktree add: refactor opt exclusion tests Jacob Abel
2022-12-20 4:00 ` Junio C Hamano
2022-12-20 23:29 ` Jacob Abel
2022-12-20 2:38 ` [PATCH v5 3/4] worktree add: add --orphan flag Jacob Abel
2022-12-20 4:19 ` Junio C Hamano
2022-12-21 0:17 ` Jacob Abel
2022-12-20 2:38 ` [PATCH v5 4/4] worktree add: Add hint to use --orphan when bad ref Jacob Abel
2022-12-20 6:18 ` Junio C Hamano
2022-12-21 0:42 ` Jacob Abel
2022-12-28 6:16 ` Jacob Abel [this message]
2022-12-28 6:16 ` [PATCH v6 1/4] worktree add: include -B in usage docs Jacob Abel
2022-12-28 6:16 ` [PATCH v6 2/4] worktree add: refactor opt exclusion tests Jacob Abel
2022-12-28 12:54 ` Junio C Hamano
2022-12-29 6:51 ` Jacob Abel
2022-12-29 10:07 ` Junio C Hamano
2022-12-29 20:48 ` Jacob Abel
2023-01-06 6:31 ` Jacob Abel
2023-01-06 12:34 ` Junio C Hamano
2023-01-07 4:45 ` Jacob Abel
2022-12-28 6:17 ` [PATCH v6 3/4] worktree add: add --orphan flag Jacob Abel
2022-12-28 6:17 ` [PATCH v6 4/4] worktree add: add hint to direct users towards --orphan Jacob Abel
2023-01-06 14:19 ` Phillip Wood
2022-12-28 8:01 ` [PATCH v6 0/4] worktree: Support `--orphan` when creating new worktrees Ævar Arnfjörð Bjarmason
2022-12-29 6:38 ` Jacob Abel
2022-12-29 10:42 ` Ævar Arnfjörð Bjarmason
2022-12-29 21:22 ` Jacob Abel
2023-01-07 4:58 ` [PATCH v7 " Jacob Abel
2023-01-07 4:59 ` [PATCH v7 1/4] worktree add: include -B in usage docs Jacob Abel
2023-01-07 4:59 ` [PATCH v7 2/4] worktree add: refactor opt exclusion tests Jacob Abel
2023-01-08 7:13 ` Junio C Hamano
2023-01-08 15:08 ` Jacob Abel
2023-01-07 4:59 ` [PATCH v7 3/4] worktree add: add --orphan flag Jacob Abel
2023-01-07 4:59 ` [PATCH v7 4/4] worktree add: add hint to direct users towards --orphan Jacob Abel
2023-01-09 12:26 ` [PATCH v7 0/4] worktree: Support `--orphan` when creating new worktrees Ævar Arnfjörð Bjarmason
2023-01-09 17:11 ` Jacob Abel
2023-01-09 17:21 ` Ævar Arnfjörð Bjarmason
2023-01-09 17:26 ` Jacob Abel
2023-01-09 17:32 ` [PATCH v8 " Jacob Abel
2023-01-09 17:32 ` [PATCH v8 1/4] worktree add: include -B in usage docs Jacob Abel
2023-01-09 17:33 ` [PATCH v8 2/4] worktree add: refactor opt exclusion tests Jacob Abel
2023-01-09 17:33 ` [PATCH v8 3/4] worktree add: add --orphan flag Jacob Abel
2023-01-13 10:20 ` Phillip Wood
2023-01-13 17:32 ` Junio C Hamano
2023-01-14 22:47 ` Jacob Abel
2023-01-15 3:09 ` Junio C Hamano
2023-01-15 3:41 ` rsbecker
2023-01-15 3:49 ` Junio C Hamano
2023-01-18 22:46 ` 'Jacob Abel'
2023-01-18 22:18 ` Jacob Abel
2023-01-19 15:32 ` Ævar Arnfjörð Bjarmason
2023-01-19 16:32 ` Junio C Hamano
2023-01-16 10:47 ` Phillip Wood
2023-01-18 22:40 ` Jacob Abel
2023-01-19 16:18 ` Phillip Wood
2023-01-19 22:20 ` Jacob Abel
2023-01-09 17:33 ` [PATCH v8 4/4] worktree add: add hint to direct users towards --orphan Jacob Abel
2023-01-09 19:20 ` [PATCH v8 0/4] worktree: Support `--orphan` when creating new worktrees Ævar Arnfjörð Bjarmason
2023-01-13 17:34 ` Junio C Hamano
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20221228061539.13740-1-jacobabel@nullpo.dev \
--to=jacobabel@nullpo.dev \
--cc=avarab@gmail.com \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.com \
--cc=me@ttaylorr.com \
--cc=phillip.wood123@gmail.com \
--cc=rjusto@gmail.com \
--cc=rsbecker@nexbridge.com \
--cc=sunshine@sunshineco.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).