From: "Ævar Arnfjörð Bjarmason" <avarab@gmail.com>
To: Jacob Abel <jacobabel@nullpo.dev>
Cc: git@vger.kernel.org, Eric Sunshine <sunshine@sunshineco.com>,
Taylor Blau <me@ttaylorr.com>
Subject: Re: [PATCH v3 2/2] worktree add: add --orphan flag
Date: Sat, 19 Nov 2022 12:50:58 +0100 [thread overview]
Message-ID: <221119.861qpzf9ey.gmgdl@evledraar.gmail.com> (raw)
In-Reply-To: <20221119025701.syuscuoqjuqhqsoz@phi>
On Sat, Nov 19 2022, Jacob Abel wrote:
> On 22/11/15 11:09PM, Ævar Arnfjörð Bjarmason wrote:
>>
>> On Thu, Nov 10 2022, Jacob Abel wrote:
>>
>> So, on a second read-through...
>>
>> > 'git worktree add' [-f] [--detach] [--checkout] [--lock [--reason <string>]]
>> > - [[-b | -B] <new-branch>] <path> [<commit-ish>]
>> > + [[-b | -B | --orphan] <new-branch>] <path> [<commit-ish>]
>>
>> This synopsis is now at least partially wrong, and ....
>>
>> > +--orphan <new-branch>::
>> > + With `add`, create a new orphan branch named `<new-branch>` in the new
>> > + worktree. See `--orphan` in linkgit:git-switch[1] for details.
>> > +
>> > --porcelain::
>> > ....
>> > #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 | --orphan] <new-branch>] <path> [<commit-ish>]")
>>
>>
>> ...here we say the same, but surely it's only:
>>
>> git worktree add --orphan new-branch /tmp/orphan
>>
>> And not e.g.:
>>
>> git worktree add --orphan new-branch /tmp/orphan origin/next
>>
>> Or whatever, but it's incompatible with <commit-ish>. I think this on
>> top should fix it up:
>>
>> diff --git a/Documentation/git-worktree.txt b/Documentation/git-worktree.txt
>> index 1310bfb564f..3afef985154 100644
>> --- a/Documentation/git-worktree.txt
>> +++ b/Documentation/git-worktree.txt
>> @@ -10,7 +10,9 @@ SYNOPSIS
>> --------
>> [verse]
>> 'git worktree add' [-f] [--detach] [--checkout] [--lock [--reason <string>]]
>> - [[-b | -B | --orphan] <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]]
>> 'git worktree lock' [--reason <string>] <worktree>
>> 'git worktree move' <worktree> <new-path>
>> diff --git a/builtin/worktree.c b/builtin/worktree.c
>> index 71786b72f6b..2b811630b3a 100644
>> --- a/builtin/worktree.c
>> +++ b/builtin/worktree.c
>> @@ -17,7 +17,10 @@
>>
>> #define BUILTIN_WORKTREE_ADD_USAGE \
>> N_("git worktree add [-f] [--detach] [--checkout] [--lock [--reason <string>]]\n" \
>> - " [[-b | -B | --orphan] <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>")
>> +
>> #define BUILTIN_WORKTREE_LIST_USAGE \
>> N_("git worktree list [-v | --porcelain [-z]]")
>> #define BUILTIN_WORKTREE_LOCK_USAGE \
>> @@ -668,6 +671,9 @@ static int add(int ac, const char **av, const char *prefix)
>> if (opts.orphan_branch && !opts.checkout)
>> die(_("'%s' and '%s' cannot be used together"), "--orphan",
>> "--no-checkout");
>> + if (opts.orphan_branch && ac == 2)
>> + die(_("'%s' and '%s' cannot be used together"), "--orphan",
>> + _("<commit-ish>"));
>> if (lock_reason && !keep_locked)
>> die(_("the option '%s' requires '%s'"), "--reason", "--lock");
>> if (lock_reason)
>> diff --git a/t/t2400-worktree-add.sh b/t/t2400-worktree-add.sh
>> index 93c340f4aff..47461d02115 100755
>> --- a/t/t2400-worktree-add.sh
>> +++ b/t/t2400-worktree-add.sh
>> @@ -326,6 +326,10 @@ test_expect_success '"add" --orphan/--no-checkout mutually exclusive' '
>> test_must_fail git worktree add --orphan poodle --no-checkout bamboo
>> '
>>
>> +test_expect_success '"add" --orphan and <commit-ish> mutually exclusive' '
>> + test_must_fail git worktree add --orphan poodle bamboo main
>> +'
>> +
>> test_expect_success '"add" -B/--detach mutually exclusive' '
>> test_must_fail git worktree add -B poodle --detach bamboo main
>> '
>
> Yep, you are right. I applied the patch as part of this 2/2 patch and will
> include it in v4. When it comes to attribution, is there a preferred way to
> handle this?
Feel free to add my:
Signed-off-by: Ævar Arnfjörð Bjarmason <avarab@gmail.com>
I'm also fine with no attribution, but we add that for copyright
reasons, and this is *probably* significant enough to qualify, but I'm
no lawyer etc. Anyway, probably better to add it when in doubt...
>>
>> > - if (ac < 2 && !new_branch && !opts.detach) {
>> > + /*
>> > + * As the orphan cannot be created until the contents of branch
>> > + * are staged, opts.orphan_branch should be treated as both a boolean
>> > + * indicating that `--orphan` was selected and as the name of the new
>> > + * orphan branch from this point on.
>> > + */
>>
>> I've re-read this a couple of times, and I honestly still don't see what
>> point is trying to drive home.
>>
>> So, "--orphan" is an OPT_STRING(), so it always has a value:
>>
>> $ ./git worktree add --orphan
>> error: option `orphan' requires a value
>>
>> But we init it to NULL, and above we just used it as a boolean *and*
>> below.
>>
>> I.e. this comment would seem to me to fit with code where the reader
>> might be surprised that we're using "opts.orphan_branch" as a string
>> from then on, but we're just copying that to "new_branch", then we
>> always use "opts.orphan_branch" as a boolean for the rest of the
>> function.
>>
>> I may be missing something, but I think this would probably be better
>> just without this comment. E.g. we use "--track", "--lock-reason"
>> etc. in similar ways, and those don't have a comment like that.
>>
>
> Originally the new orphan branch's name was passed into
> `add_worktree(path, refname, opts)` via the `orphan_branch` field in `opts` and
> the branch which was to be checked out first(to mimic `git checkout --orphan`)
> was passed in via `refname`.
>
> Now that the behavior was changed to use `git switch`, that
> "checkout then make orphan" behavior was unneeded and `refname` also contains
> the name of the orphan branch.
>
> For `make_worktree_orphan(opts, child_env)` however since I used the same
> function signature as `checkout_worktree(opts, child_env)`, `refname` wasn't
> passed in and I used `opts->orphan_branch` to access the branch name from
> that scope.
>
> I can change `make_worktree_orphan(opts, child_env)` to
> `make_worktree_orphan(ref, opts, child_env)` instead and then `orphan_branch`
> would be able to be treated as a boolean like those other flags.
I think nothing needs to be changed here on my account, just pointing
out that I found the comment a bit confusing. Do with that what you will
:)
>>
>> > + if (opts.orphan_branch) {
>> > + new_branch = opts.orphan_branch;
>> > + }
>> > +
>> > + if (ac < 2 && !new_branch && !opts.detach && !opts.orphan_branch) {
>>
>> In general we shouldn't combine random "if"'s just because a a
>> sufficiently smart compiler could discover a way to reduce work.
>>
>> But in this case these seem to be inherently connected, we always want
>> the not-DWIM behavior with "orphan", no?
>>
>> So shouldn't this just be:
>>
>> if (opts.orphan_branch) {
>> ...
>> } else if (ac < 2 && !new_branch && !opts.detach) {
>> ....
>> }
>>
>> ?
>
> Yes. I've updated that for v4.
Nice!
next prev parent reply other threads:[~2022-11-19 11:53 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 [this message]
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 ` [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=221119.861qpzf9ey.gmgdl@evledraar.gmail.com \
--to=avarab@gmail.com \
--cc=git@vger.kernel.org \
--cc=jacobabel@nullpo.dev \
--cc=me@ttaylorr.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).