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>,
"Phillip Wood" <phillip.wood123@gmail.com>,
"Rubén Justo" <rjusto@gmail.com>, "Taylor Blau" <me@ttaylorr.com>,
rsbecker@nexbridge.com
Subject: [PATCH v5 0/4] worktree: Support `--orphan` when creating new worktrees
Date: Tue, 20 Dec 2022 02:37:12 +0000 [thread overview]
Message-ID: <20221220023637.29042-1-jacobabel@nullpo.dev> (raw)
In-Reply-To: <20221212014003.20290-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 v4:
* Removed redundant var `ret` from `make_worktree_orphan()` [2].
* Separate vars and decls in `make_worktree_orphan()` [2].
* Remove accidental `if () {}` diff-noise [2].
* Remove redundant comment regarding `new_branch_force` [2].
* Remove redundant comment when `branch` is a bad ref [2].
* Simplify mutual-exclusion-of-opts testing in t2400 w/
`test_wt_add_empty_repo_orphan_hint()` helper fn [2].
* Remove duplicate `-B --detach` exclusion test [3].
* Remove redundant comment in `test_wt_add_empty_repo_orphan_hint()`
in t2400 [4].
* Move test path into `test_wt_add_empty_repo_orphan_hint()` to simplify
commands [4].
* Replace added bash-ism with shell syntax [4].
* Remove confusing `e.g. %s` from advise [4].
* Reflow advise text [5].
* Add translation macro `_()` to advise text [5].
1. https://stackoverflow.com/a/68717229/15064705/
2. https://lore.kernel.org/git/221212.86tu2158bz.gmgdl@evledraar.gmail.com/
3. https://lore.kernel.org/git/20221212145515.pohzoyllo3bgz7eb@phi/
4. https://lore.kernel.org/git/221212.86pmcp57w4.gmgdl@evledraar.gmail.com/
5. https://lore.kernel.org/git/221212.86zgbs4h9f.gmgdl@evledraar.gmail.com/
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 use --orphan when bad ref
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 | 89 +++++++++++++++++++++++++++++----
6 files changed, 159 insertions(+), 18 deletions(-)
Range-diff against v4:
1: f35d78cfb4 = 1: 05371640ad worktree add: Include -B in usage docs
-: ---------- > 2: 3d8b26f9d6 worktree add: refactor opt exclusion tests
2: 8b1cdf1322 ! 3: ccae9cec2e worktree add: add --orphan flag
@@ builtin/worktree.c: static int checkout_worktree(const struct add_opts *opts,
+static int make_worktree_orphan(const char * ref, const struct add_opts *opts,
+ struct strvec *child_env)
+{
-+ int ret;
+ struct strbuf symref = STRBUF_INIT;
+ struct child_process cp = CHILD_PROCESS_INIT;
-+ cp.git_cmd = 1;
+
+ validate_new_branchname(ref, &symref, 0);
+ strvec_pushl(&cp.args, "symbolic-ref", "HEAD", symref.buf, NULL);
+ if (opts->quiet)
+ strvec_push(&cp.args, "--quiet");
+ strvec_pushv(&cp.env, child_env->v);
-+ ret = run_command(&cp);
+ strbuf_release(&symref);
-+ return ret;
++ cp.git_cmd = 1;
++ return run_command(&cp);
+}
+
static int add_worktree(const char *path, const char *refname,
@@ builtin/worktree.c: static int add_worktree(const char *path, const char *refnam
}
commit = lookup_commit_reference_by_name(refname);
- if (!commit)
-+ if (!commit && !opts->orphan) {
++ if (!commit && !opts->orphan)
die(_("invalid reference: %s"), refname);
-+ }
name = worktree_basename(path, &len);
- strbuf_add(&sb, name, path + len - name);
@@ builtin/worktree.c: static int add_worktree(const char *path, const char *refname,
strvec_pushf(&child_env, "%s=%s", GIT_WORK_TREE_ENVIRONMENT, path);
cp.git_cmd = 1;
@@ builtin/worktree.c: static int add(int ac, const char **av, const char *prefix)
if (lock_reason && !keep_locked)
die(_("the option '%s' requires '%s'"), "--reason", "--lock");
if (lock_reason)
-@@ builtin/worktree.c: static int add(int ac, const char **av, const char *prefix)
- if (!strcmp(branch, "-"))
- branch = "@{-1}";
-
-+ /*
-+ * When creating a new branch, new_branch now contains the branch to
-+ * create.
-+ *
-+ * Past this point, new_branch_force can be treated solely as a
-+ * boolean flag to indicate whether `-B` was selected.
-+ */
- if (new_branch_force) {
- struct strbuf symref = STRBUF_INIT;
-
@@ builtin/worktree.c: static int add(int ac, const char **av, const char *prefix)
strbuf_release(&symref);
}
@@ builtin/worktree.c: static int add(int ac, const char **av, const char *prefix)
+ if (opts.orphan) {
+ branch = new_branch;
+ } else if (!lookup_commit_reference_by_name(branch)) {
-+ /*
-+ * If `branch` does not reference a valid commit, a new
-+ * worktree (and/or branch) cannot be created based off of it.
-+ */
+ die(_("invalid reference: %s"), branch);
+ } else if (new_branch) {
struct child_process cp = CHILD_PROCESS_INIT;
@@ 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_expect_success '"add" no auto-vivify with --detach and <branch> omitted' '
- test_must_fail git -C mish/mash symbolic-ref HEAD
- '
-
--test_expect_success '"add" -b/-B mutually exclusive' '
-- test_must_fail git worktree add -b poodle -B poodle bamboo main
--'
--
--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_expect_success '"add" -B/--detach mutually exclusive' '
-- test_must_fail git worktree add -B poodle --detach bamboo main
--'
-+test_wt_add_excl -b poodle -B poodle bamboo main
-+test_wt_add_excl -b poodle --orphan poodle bamboo
-+test_wt_add_excl -b poodle --detach bamboo main
-+test_wt_add_excl -B poodle --detach bamboo main
-+test_wt_add_excl -B poodle --detach bamboo main
+@@ 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
+test_wt_add_excl -B poodle --orphan poodle bamboo
++test_wt_add_excl -b poodle --orphan poodle bamboo
+test_wt_add_excl --orphan poodle --detach bamboo
+test_wt_add_excl --orphan poodle --no-checkout bamboo
+test_wt_add_excl --orphan poodle bamboo main
3: 74cb091bb3 ! 4: df4c1fa469 worktree add: Add hint to use --orphan when bad ref
@@ advice.h: struct string_list;
## builtin/worktree.c ##
@@ builtin/worktree.c: static int add(int ac, const char **av, const char *prefix)
- * If `branch` does not reference a valid commit, a new
- * worktree (and/or branch) cannot be created based off of it.
- */
+ if (opts.orphan) {
+ branch = new_branch;
+ } else if (!lookup_commit_reference_by_name(branch)) {
+ advise_if_enabled(ADVICE_WORKTREE_ADD_ORPHAN,
-+ "If you meant to create a worktree containing a new orphan branch\n"
-+ "(branch with no commits) for this repository, e.g. '%s',\n"
-+ "you can do so using the --orphan option:\n"
++ _("If you meant to create a worktree containing a new orphan branch\n"
++ "(branch with no commits) for this repository, you can do so\n"
++ "using the --orphan option:\n"
+ "\n"
-+ " git worktree add --orphan %s %s\n"
-+ "\n",
-+ new_branch, new_branch, path);
++ " git worktree add --orphan %s %s\n"), new_branch, path);
die(_("invalid reference: %s"), branch);
} else if (new_branch) {
struct child_process cp = CHILD_PROCESS_INIT;
@@ t/t2400-worktree-add.sh: test_expect_success '"add" worktree with orphan branch,
test_cmp expect .git/worktrees/orphan-with-lock-reason/locked
'
-+# Helper function to test hints for using --orphan in an empty repo.
+test_wt_add_empty_repo_orphan_hint() {
-+ local context="$1" &&
-+ local opts="${@:2}" &&
++ local context="$1"
++ shift
++ local opts="$@"
+ test_expect_success "'worktree add' show orphan hint in empty repo w/ $context" '
+ test_when_finished "rm -rf empty_repo" &&
+ GIT_DIR="empty_repo" git init --bare &&
-+ test_must_fail git -C empty_repo worktree add $opts 2> actual &&
++ test_must_fail git -C empty_repo worktree add $opts foobar/ 2> actual &&
+ grep "hint: If you meant to create a worktree containing a new orphan branch" actual
+ '
+}
+
-+test_wt_add_empty_repo_orphan_hint 'DWIM' foobar/
-+test_wt_add_empty_repo_orphan_hint '-b' -b foobar_branch foobar/
-+test_wt_add_empty_repo_orphan_hint '-B' -B foobar_branch foobar/
++test_wt_add_empty_repo_orphan_hint 'DWIM'
++test_wt_add_empty_repo_orphan_hint '-b' -b foobar_branch
++test_wt_add_empty_repo_orphan_hint '-B' -B foobar_branch
+
test_expect_success 'local clone from linked checkout' '
git clone --local here here-clone &&
--
2.38.2
next prev parent reply other threads:[~2022-12-20 2:37 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 ` Jacob Abel [this message]
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 ` [PATCH v6 0/4] worktree: Support `--orphan` when creating new worktrees Jacob Abel
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=20221220023637.29042-1-jacobabel@nullpo.dev \
--to=jacobabel@nullpo.dev \
--cc=avarab@gmail.com \
--cc=git@vger.kernel.org \
--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).