* [PATCH] switch: add --ensure option
@ 2026-06-09 9:23 Lei Zhu via GitGitGadget
2026-06-09 12:59 ` Junio C Hamano
2026-06-17 10:57 ` [PATCH v2] checkout/switch: add --create-if-missing option Lei Zhu via GitGitGadget
0 siblings, 2 replies; 3+ messages in thread
From: Lei Zhu via GitGitGadget @ 2026-06-09 9:23 UTC (permalink / raw)
To: git; +Cc: Lei Zhu, Korov
From: Korov <korov9.c@gmail.com>
Add a new `git switch --ensure` (`-e`) option that behaves like an
idempotent form of branch switching.
Users who often switch between topic branches may not know whether the
local branch already exists. Without this option, they need to check
for the branch first and then choose between `git switch <branch>` and
`git switch -c <branch>`. The new option folds that workflow into a
single command.
When the target branch does not exist, `git switch -e <branch>`
behaves like `git switch -c <branch>`, including existing `--track`
and `--no-track` handling.
When the target branch already exists, `git switch -e <branch>`
switches to it without resetting the branch tip. If `--track` is
given, update the branch's upstream configuration using the explicit
start-point, or the current branch when no start-point is provided.
Fail in detached HEAD state when no start-point is available for
tracking setup.
Document the new option and add tests covering create-branch tracking,
existing-branch tracking updates, and detached-HEAD failure cases.
Signed-off-by: Korov <korov9.c@gmail.com>
---
switch: add --ensure option
Add a new git switch --ensure (-e) option that behaves like an
idempotent form of branch switching.
Users who often switch between topic branches may not know whether the
local branch already exists. Without this option, they need to check for
the branch first and then choose between git switch <branch> and git
switch -c <branch>. The new option folds that workflow into a single
command.
When the target branch does not exist, git switch -e <branch> behaves
like git switch -c <branch>, including existing --track and --no-track
handling.
When the target branch already exists, git switch -e <branch> switches
to it without resetting the branch tip. If --track is given, update the
branch's upstream configuration using the explicit start-point, or the
current branch when no start-point is provided. Fail in detached HEAD
state when no start-point is available for tracking setup.
Document the new option and add tests covering create-branch tracking,
existing-branch tracking updates, and detached-HEAD failure cases.
Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-git-2324%2FKorov%2Fdev3-v1
Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-git-2324/Korov/dev3-v1
Pull-Request: https://github.com/git/git/pull/2324
Documentation/git-switch.adoc | 16 +++++++
builtin/checkout.c | 86 ++++++++++++++++++++++++++++++++++-
t/t2060-switch.sh | 46 +++++++++++++++++++
3 files changed, 146 insertions(+), 2 deletions(-)
diff --git a/Documentation/git-switch.adoc b/Documentation/git-switch.adoc
index d6c4f229a5..a0ac31fa23 100644
--- a/Documentation/git-switch.adoc
+++ b/Documentation/git-switch.adoc
@@ -11,6 +11,7 @@ SYNOPSIS
git switch [<options>] [--no-guess] <branch>
git switch [<options>] --detach [<start-point>]
git switch [<options>] (-c|-C) <new-branch> [<start-point>]
+git switch [<options>] -e <branch> [<start-point>]
git switch [<options>] --orphan <new-branch>
DESCRIPTION
@@ -81,6 +82,21 @@ $ git branch -f _<new-branch>_
$ git switch _<new-branch>_
------------
+`-e <branch>`::
+`--ensure <branch>`::
+ Switch to _<branch>_ if it already exists, or create it from
+ _<start-point>_ before switching to it if it does not.
++
+When _<branch>_ does not already exist, this behaves like
+`git switch -c <branch> [<start-point>]`, including any `--track`
+or `--no-track` options.
++
+When _<branch>_ already exists, the branch tip is not changed. If
+`--track[=(direct|inherit)]` is given, the existing branch's upstream
+configuration is updated using _<start-point>_ when one is provided,
+or the current branch when _<start-point>_ is omitted. This form fails
+when `HEAD` is detached and no _<start-point>_ is given.
+
`-d`::
`--detach`::
Switch to a commit for inspection and discardable
diff --git a/builtin/checkout.c b/builtin/checkout.c
index b78b3a1d16..f56935bfe2 100644
--- a/builtin/checkout.c
+++ b/builtin/checkout.c
@@ -81,6 +81,8 @@ struct checkout_opts {
const char *new_branch;
const char *new_branch_force;
const char *new_orphan_branch;
+ const char *ensure_branch;
+ const char *ensure_branch_start;
int new_branch_log;
enum branch_track track;
struct diff_options diff_options;
@@ -988,6 +990,15 @@ static void update_refs_for_switch(const struct checkout_opts *opts,
free(new_branch_info->refname);
new_branch_info->name = xstrdup(opts->new_branch);
setup_branch_path(new_branch_info);
+ } else if (opts->ensure_branch && opts->branch_exists &&
+ opts->track != BRANCH_TRACK_UNSPECIFIED) {
+ const char *tracking_source = opts->ensure_branch_start ?
+ opts->ensure_branch_start :
+ old_branch_info->name;
+ dwim_and_setup_tracking(the_repository, opts->ensure_branch,
+ tracking_source, opts->track,
+ opts->quiet);
+ remote_state_clear(the_repository->remote_state);
}
old_desc = old_branch_info->name;
@@ -1927,6 +1938,52 @@ static int checkout_main(int argc, const char **argv, const char *prefix,
die(_("options '-%c', '-%c', and '%s' cannot be used together"),
cb_option, toupper(cb_option), "--orphan");
+ if (opts->ensure_branch) {
+ struct strbuf ref = STRBUF_INIT;
+ int exists;
+
+ if (opts->new_branch || opts->new_branch_force || opts->new_orphan_branch)
+ die(_("'%s' cannot be used with '%s'"), "-e", "-c/-C/--orphan");
+ if (opts->force_detach)
+ die(_("'%s' cannot be used with '%s'"), "-e", "--detach");
+
+ exists = validate_branchname(opts->ensure_branch, &ref);
+ strbuf_release(&ref);
+
+ /* Save an explicit start point for tracking setup. */
+ if (argc > 0 && opts->track != BRANCH_TRACK_UNSPECIFIED)
+ opts->ensure_branch_start = argv[0];
+
+ if (exists) {
+ /*
+ * Branch exists: just switch to it, don't reset.
+ * We'll set up tracking after the switch if --track was given.
+ */
+ opts->branch_exists = 1;
+ } else {
+ /* Branch doesn't exist: create it like -c */
+ opts->new_branch = opts->ensure_branch;
+ }
+ }
+
+ if (opts->ensure_branch && opts->branch_exists &&
+ opts->track != BRANCH_TRACK_UNSPECIFIED &&
+ !opts->ensure_branch_start) {
+ struct object_id head_oid;
+ char *head = refs_resolve_refdup(get_main_ref_store(the_repository),
+ "HEAD", 0, &head_oid, NULL);
+ const char *branch;
+
+ if (!head)
+ die(_("failed to resolve HEAD as a valid ref"));
+ if (!strcmp(head, "HEAD"))
+ die(_("cannot set up tracking information; starting point '%s' is not a branch"),
+ "HEAD");
+ if (!skip_prefix(head, "refs/heads/", &branch))
+ die(_("HEAD not found below refs/heads!"));
+ free(head);
+ }
+
if (opts->overlay_mode == 1 && opts->patch_mode)
die(_("options '%s' and '%s' cannot be used together"), "-p", "--overlay");
@@ -1961,8 +2018,9 @@ static int checkout_main(int argc, const char **argv, const char *prefix,
if (opts->new_orphan_branch)
opts->new_branch = opts->new_orphan_branch;
- /* --track without -c/-C/-b/-B/--orphan should DWIM */
- if (opts->track != BRANCH_TRACK_UNSPECIFIED && !opts->new_branch) {
+ /* --track without -c/-C/-b/-B/--orphan/-e should DWIM */
+ if (opts->track != BRANCH_TRACK_UNSPECIFIED && !opts->new_branch &&
+ !(opts->ensure_branch && opts->branch_exists)) {
const char *argv0 = argv[0];
if (!argc || !strcmp(argv0, "--"))
die(_("--track needs a branch name"));
@@ -2012,6 +2070,28 @@ static int checkout_main(int argc, const char **argv, const char *prefix,
die(_("reference is not a tree: %s"), opts->from_treeish);
}
+ /*
+ * Handle -e with existing branch: set up new_branch_info to switch
+ * to the existing branch.
+ */
+ if (opts->ensure_branch && opts->branch_exists) {
+ struct object_id rev;
+
+ branch_info_release(&new_branch_info);
+ memset(&new_branch_info, 0, sizeof(new_branch_info));
+ new_branch_info.name = xstrdup(opts->ensure_branch);
+ setup_branch_path(&new_branch_info);
+
+ if (new_branch_info.path &&
+ !refs_read_ref(get_main_ref_store(the_repository),
+ new_branch_info.path, &rev)) {
+ new_branch_info.commit = lookup_commit_reference_gently(
+ the_repository, &rev, 1);
+ if (new_branch_info.commit)
+ parse_commit_or_die(new_branch_info.commit);
+ }
+ }
+
if (argc) {
parse_pathspec(&opts->pathspec, 0,
opts->patch_mode ? PATHSPEC_PREFIX_ORIGIN : 0,
@@ -2150,6 +2230,8 @@ int cmd_switch(int argc,
N_("create and switch to a new branch")),
OPT_STRING('C', "force-create", &opts.new_branch_force, N_("branch"),
N_("create/reset and switch to a branch")),
+ OPT_STRING('e', "ensure", &opts.ensure_branch, N_("branch"),
+ N_("create if needed and switch to branch")),
OPT_BOOL(0, "guess", &opts.dwim_new_local_branch,
N_("second guess 'git switch <no-such-branch>'")),
OPT_BOOL(0, "discard-changes", &opts.discard_changes,
diff --git a/t/t2060-switch.sh b/t/t2060-switch.sh
index c91c4db936..c0bff7caab 100755
--- a/t/t2060-switch.sh
+++ b/t/t2060-switch.sh
@@ -146,6 +146,52 @@ test_expect_success 'tracking info copied with autoSetupMerge=inherit' '
test_cmp_config "" --default "" branch.main2.merge
'
+test_expect_success 'switch -e --track creates branch from current branch' '
+ test_when_finished "
+ git switch main || :
+ git branch -D ensure-new-current || :
+ " &&
+ git switch main &&
+ git switch -e ensure-new-current --track &&
+ test_cmp_rev refs/heads/main refs/heads/ensure-new-current &&
+ test_cmp_config . branch.ensure-new-current.remote &&
+ test_cmp_config refs/heads/main branch.ensure-new-current.merge
+'
+
+test_expect_success 'switch -e --track creates branch from remote-tracking branch' '
+ test_when_finished "
+ git switch main || :
+ git branch -D ensure-new || :
+ " &&
+ git switch -e ensure-new --track origin/foo &&
+ test_cmp_rev refs/remotes/origin/foo refs/heads/ensure-new &&
+ test_cmp_config origin branch.ensure-new.remote &&
+ test_cmp_config refs/heads/foo branch.ensure-new.merge
+'
+
+test_expect_success 'switch -e --track uses current branch for existing branch' '
+ test_when_finished "
+ git switch main || :
+ git branch -D ensure-existing source-for-track || :
+ " &&
+ git switch -c source-for-track main &&
+ git branch ensure-existing main &&
+ git switch -e ensure-existing --track &&
+ test_cmp_config . branch.ensure-existing.remote &&
+ test_cmp_config refs/heads/source-for-track branch.ensure-existing.merge
+'
+
+test_expect_success 'switch -e --track fails from detached HEAD without start-point' '
+ test_when_finished "
+ git switch main || :
+ git branch -D detached-target || :
+ " &&
+ git branch detached-target main &&
+ git switch --detach main &&
+ test_must_fail git switch -e detached-target --track 2>stderr &&
+ test_grep "cannot set up tracking information; starting point '\''HEAD'\'' is not a branch" stderr
+'
+
test_expect_success 'switch back when temporarily detached and checked out elsewhere ' '
test_when_finished "
git worktree remove wt1 ||:
base-commit: 600fe743028cbfb640855f659e9851522214bc0b
--
gitgitgadget
^ permalink raw reply related [flat|nested] 3+ messages in thread
* Re: [PATCH] switch: add --ensure option
2026-06-09 9:23 [PATCH] switch: add --ensure option Lei Zhu via GitGitGadget
@ 2026-06-09 12:59 ` Junio C Hamano
2026-06-17 10:57 ` [PATCH v2] checkout/switch: add --create-if-missing option Lei Zhu via GitGitGadget
1 sibling, 0 replies; 3+ messages in thread
From: Junio C Hamano @ 2026-06-09 12:59 UTC (permalink / raw)
To: Lei Zhu via GitGitGadget; +Cc: git, Lei Zhu
"Lei Zhu via GitGitGadget" <gitgitgadget@gmail.com> writes:
> Users who often switch between topic branches may not know whether the
> local branch already exists. Without this option, they need to check
> for the branch first and then choose between `git switch <branch>` and
> `git switch -c <branch>`. The new option folds that workflow into a
> single command.
Quite honestly, I am not sure if the use case should be supported
with a new option, or we should actively discourage it by rejecting
any patch that takes us in this direction, as the actions the user
would take after seeing the result of "git checkout -b" or "git
switch -c" are quite different among (just off the top of my head):
(1) Ah we already had the branch created exactly to work on this;
instead of forking a new effort, switch to the existing branch
and build on the effort we made previously, as it forks from an
acceptable base, which might have been different from where we
wanted to start at when we said "git switch -c <branch> <base>".
(2) Ah we already had the branch created exactly to work on this.
Unfortunately, it was forked from way too new base before we
realized that this is also an important bugfix that needs to be
mergeable to the maintenance track. Let's create a new branch
that is a copy of the existing one with "-maint" in its name,
rebase it on the maintenance track, and work there.
(3) Ah we already had a branch that happened to have the same name,
but created for totally different reasons. We do want to fork
a new branch but need to give it a different name.
(4) There wasn't a branch with the given name, so we created a new
branch at the right starting point we just picked when we ran
"git checkout -b"/"git switch -c". Let's start working on the
topic.
You cover *only* case (4) perfectly. When your "-c <branch>" picks
an existing branch, the user still needs to figure out which among
situations (1)-(3) (of course, there may be others) they are in, and
act accordingly. "git checkout -b" and "git switch -c" that fails,
reminding that there is an existing branch with the same name, gives
users a stronger form of reminder than switching blindly to the
existing branch, which may (in case (1)) or may not (in cases (2)
and (3)) be where the user wants to be when taking the next action.
Having said that.
* The option name "-e" would make all users expect that this has
something to do with "--editor". Start with a longer name,
perhaps "--create-if-missing" or something, and then see if
others can come up with a better short-hand. Obviously whoever
chooses "-e" is not equipped well to do so (yet), and the
reviewer who pointed out "-e" is not a good idea without being
able to offer a better alternative is not, either ;-).
* Adding a new flag only to "switch" without "checkout" will
unnecessary confuse users. This is because, even though
"switch/restore" started as an experiment to _supersede_
"checkout", they were not successful, not in the sense that
"switch/restore" were harder to use than the original, but in the
sense that the userbase and teaching materials are already used
to the original and removing it is practically infeasible.
^ permalink raw reply [flat|nested] 3+ messages in thread
* [PATCH v2] checkout/switch: add --create-if-missing option
2026-06-09 9:23 [PATCH] switch: add --ensure option Lei Zhu via GitGitGadget
2026-06-09 12:59 ` Junio C Hamano
@ 2026-06-17 10:57 ` Lei Zhu via GitGitGadget
1 sibling, 0 replies; 3+ messages in thread
From: Lei Zhu via GitGitGadget @ 2026-06-17 10:57 UTC (permalink / raw)
To: git; +Cc: Lei Zhu, Korov
From: Korov <korov9.c@gmail.com>
Add a new `--create-if-missing` option to `git switch` and `git
checkout` that behaves like an idempotent form of branch switching.
Users who often switch between topic branches may not know whether the
local branch already exists. Without this option, they need to check for
the branch first and then choose between switching to it or creating it.
The new option folds that workflow into a single command.
When the target branch does not exist, `--create-if-missing <branch>`
behaves like `git switch -c <branch>` or `git checkout -b <branch>`,
including existing `--track` and `--no-track` handling.
When the target branch already exists, `--create-if-missing <branch>`
switches to it without resetting the branch tip. If `--track` is given,
update the branch's upstream configuration using the explicit
start-point, or the current branch when no start-point is provided. Fail
in detached HEAD state when no start-point is available for tracking
setup.
For `git checkout`, keep this as a branch operation and reject pathspec
usage with `--create-if-missing` to avoid mixing branch switching with
path checkout semantics.
Document the new option and add tests covering branch creation,
existing-branch switching, tracking updates, pathspec rejection, and
detached-HEAD failure cases.
Signed-off-by: Korov <korov9.c@gmail.com>
---
checkout/switch: add --create-if-missing option
Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-git-2324%2FKorov%2Fdev3-v2
Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-git-2324/Korov/dev3-v2
Pull-Request: https://github.com/git/git/pull/2324
Range-diff vs v1:
1: 64a6947ad1 ! 1: 0070592d49 switch: add --ensure option
@@ Metadata
Author: Korov <korov9.c@gmail.com>
## Commit message ##
- switch: add --ensure option
+ checkout/switch: add --create-if-missing option
- Add a new `git switch --ensure` (`-e`) option that behaves like an
- idempotent form of branch switching.
+ Add a new `--create-if-missing` option to `git switch` and `git
+ checkout` that behaves like an idempotent form of branch switching.
Users who often switch between topic branches may not know whether the
- local branch already exists. Without this option, they need to check
- for the branch first and then choose between `git switch <branch>` and
- `git switch -c <branch>`. The new option folds that workflow into a
- single command.
+ local branch already exists. Without this option, they need to check for
+ the branch first and then choose between switching to it or creating it.
+ The new option folds that workflow into a single command.
- When the target branch does not exist, `git switch -e <branch>`
- behaves like `git switch -c <branch>`, including existing `--track`
- and `--no-track` handling.
+ When the target branch does not exist, `--create-if-missing <branch>`
+ behaves like `git switch -c <branch>` or `git checkout -b <branch>`,
+ including existing `--track` and `--no-track` handling.
- When the target branch already exists, `git switch -e <branch>`
- switches to it without resetting the branch tip. If `--track` is
- given, update the branch's upstream configuration using the explicit
- start-point, or the current branch when no start-point is provided.
- Fail in detached HEAD state when no start-point is available for
- tracking setup.
+ When the target branch already exists, `--create-if-missing <branch>`
+ switches to it without resetting the branch tip. If `--track` is given,
+ update the branch's upstream configuration using the explicit
+ start-point, or the current branch when no start-point is provided. Fail
+ in detached HEAD state when no start-point is available for tracking
+ setup.
- Document the new option and add tests covering create-branch tracking,
- existing-branch tracking updates, and detached-HEAD failure cases.
+ For `git checkout`, keep this as a branch operation and reject pathspec
+ usage with `--create-if-missing` to avoid mixing branch switching with
+ path checkout semantics.
+
+ Document the new option and add tests covering branch creation,
+ existing-branch switching, tracking updates, pathspec rejection, and
+ detached-HEAD failure cases.
Signed-off-by: Korov <korov9.c@gmail.com>
+ ## Documentation/git-checkout.adoc ##
+@@ Documentation/git-checkout.adoc: git checkout [-q] [-f] [-m] [<branch>]
+ git checkout [-q] [-f] [-m] --detach [<branch>]
+ git checkout [-q] [-f] [-m] [--detach] <commit>
+ git checkout [-q] [-f] [-m] [[-b|-B|--orphan] <new-branch>] [<start-point>]
++git checkout [-q] [-f] [-m] --create-if-missing <branch> [<start-point>]
+ git checkout <tree-ish> [--] <pathspec>...
+ git checkout <tree-ish> --pathspec-from-file=<file> [--pathspec-file-nul]
+ git checkout [-f|--ours|--theirs|-m|--conflict=<style>] [--] <pathspec>...
+@@ Documentation/git-checkout.adoc: This will fail if there's an error checking out _<new-branch>_, for
+ example if checking out the `<start-point>` commit would overwrite your
+ uncommitted changes.
+
++`git checkout --create-if-missing <branch> [<start-point>]`::
++
++ Check out _<branch>_ if it already exists, or create it from
++ _<start-point>_ before checking it out if it does not.
+++
++When _<branch>_ does not already exist, this behaves like
++`git checkout -b <branch> [<start-point>]`, including any `--track`
++or `--no-track` options.
+++
++When _<branch>_ already exists, the branch tip is not changed. If
++`--track[=(direct|inherit)]` is given, the existing branch's upstream
++configuration is updated using _<start-point>_ when one is provided,
++or the current branch when _<start-point>_ is omitted. This form fails
++when `HEAD` is detached and no _<start-point>_ is given.
++
+ `git checkout -B <branch> [<start-point>]`::
+
+ The same as `-b`, except that if the branch already exists it
+@@ Documentation/git-checkout.adoc: of it").
+ The same as `-b`, except that if the branch already exists it
+ resets _<branch>_ to the start point instead of failing.
+
++`--create-if-missing <branch>`::
++ Check out _<branch>_ if it already exists, or create it from
++ _<start-point>_ before checking it out if it does not.
+++
++When _<branch>_ does not already exist, this behaves like
++`git checkout -b <branch> [<start-point>]`, including any `--track`
++or `--no-track` options.
+++
++When _<branch>_ already exists, the branch tip is not changed. If
++`--track[=(direct|inherit)]` is given, the existing branch's upstream
++configuration is updated using _<start-point>_ when one is provided,
++or the current branch when _<start-point>_ is omitted. This form fails
++when `HEAD` is detached and no _<start-point>_ is given.
+++
++This option cannot be used when checking out paths.
++
+ `-t`::
+ `--track[=(direct|inherit)]`::
+ When creating a new branch, set up "upstream" configuration. See
+
## Documentation/git-switch.adoc ##
@@ Documentation/git-switch.adoc: SYNOPSIS
git switch [<options>] [--no-guess] <branch>
git switch [<options>] --detach [<start-point>]
git switch [<options>] (-c|-C) <new-branch> [<start-point>]
-+git switch [<options>] -e <branch> [<start-point>]
++git switch [<options>] --create-if-missing <branch> [<start-point>]
git switch [<options>] --orphan <new-branch>
DESCRIPTION
@@ Documentation/git-switch.adoc: $ git branch -f _<new-branch>_
$ git switch _<new-branch>_
------------
-+`-e <branch>`::
-+`--ensure <branch>`::
++`--create-if-missing <branch>`::
+ Switch to _<branch>_ if it already exists, or create it from
+ _<start-point>_ before switching to it if it does not.
++
@@ builtin/checkout.c: struct checkout_opts {
const char *new_branch;
const char *new_branch_force;
const char *new_orphan_branch;
-+ const char *ensure_branch;
-+ const char *ensure_branch_start;
++ const char *create_if_missing_branch;
++ const char *create_if_missing_start;
int new_branch_log;
enum branch_track track;
struct diff_options diff_options;
+@@ builtin/checkout.c: static int checkout_paths(const struct checkout_opts *opts,
+ die(_("Cannot update paths and switch to branch '%s' at the same time."),
+ opts->new_branch);
+
++ if (opts->create_if_missing_branch)
++ die(_("Cannot update paths and switch to branch '%s' at the same time."),
++ opts->create_if_missing_branch);
++
+ if (!opts->checkout_worktree && !opts->checkout_index)
+ die(_("neither '%s' or '%s' is specified"),
+ "--staged", "--worktree");
@@ builtin/checkout.c: static void update_refs_for_switch(const struct checkout_opts *opts,
free(new_branch_info->refname);
new_branch_info->name = xstrdup(opts->new_branch);
setup_branch_path(new_branch_info);
-+ } else if (opts->ensure_branch && opts->branch_exists &&
++ } else if (opts->create_if_missing_branch && opts->branch_exists &&
+ opts->track != BRANCH_TRACK_UNSPECIFIED) {
-+ const char *tracking_source = opts->ensure_branch_start ?
-+ opts->ensure_branch_start :
++ const char *tracking_source = opts->create_if_missing_start ?
++ opts->create_if_missing_start :
+ old_branch_info->name;
-+ dwim_and_setup_tracking(the_repository, opts->ensure_branch,
++ dwim_and_setup_tracking(the_repository, opts->create_if_missing_branch,
+ tracking_source, opts->track,
+ opts->quiet);
-+ remote_state_clear(the_repository->remote_state);
}
old_desc = old_branch_info->name;
+@@ builtin/checkout.c: static void update_refs_for_switch(const struct checkout_opts *opts,
+ fprintf(stderr, _("Switched to and reset branch '%s'\n"), new_branch_info->name);
+ else
+ fprintf(stderr, _("Switched to a new branch '%s'\n"), new_branch_info->name);
++ } else if (opts->create_if_missing_branch &&
++ opts->branch_exists) {
++ fprintf(stderr, _("Switched to existing branch '%s'\n"),
++ new_branch_info->name);
+ } else {
+ fprintf(stderr, _("Switched to branch '%s'\n"),
+ new_branch_info->name);
@@ builtin/checkout.c: static int checkout_main(int argc, const char **argv, const char *prefix,
die(_("options '-%c', '-%c', and '%s' cannot be used together"),
cb_option, toupper(cb_option), "--orphan");
-+ if (opts->ensure_branch) {
++ if (opts->create_if_missing_branch) {
+ struct strbuf ref = STRBUF_INIT;
+ int exists;
+
+ if (opts->new_branch || opts->new_branch_force || opts->new_orphan_branch)
-+ die(_("'%s' cannot be used with '%s'"), "-e", "-c/-C/--orphan");
++ die(_("'%s' cannot be used with '%s'"), "--create-if-missing", "-c/-C/--orphan");
+ if (opts->force_detach)
-+ die(_("'%s' cannot be used with '%s'"), "-e", "--detach");
++ die(_("'%s' cannot be used with '%s'"), "--create-if-missing", "--detach");
+
-+ exists = validate_branchname(opts->ensure_branch, &ref);
++ exists = validate_branchname(opts->create_if_missing_branch, &ref);
+ strbuf_release(&ref);
+
+ /* Save an explicit start point for tracking setup. */
+ if (argc > 0 && opts->track != BRANCH_TRACK_UNSPECIFIED)
-+ opts->ensure_branch_start = argv[0];
++ opts->create_if_missing_start = argv[0];
+
+ if (exists) {
+ /*
@@ builtin/checkout.c: static int checkout_main(int argc, const char **argv, const
+ opts->branch_exists = 1;
+ } else {
+ /* Branch doesn't exist: create it like -c */
-+ opts->new_branch = opts->ensure_branch;
++ opts->new_branch = opts->create_if_missing_branch;
+ }
+ }
+
-+ if (opts->ensure_branch && opts->branch_exists &&
++ if (opts->create_if_missing_branch && opts->branch_exists &&
+ opts->track != BRANCH_TRACK_UNSPECIFIED &&
-+ !opts->ensure_branch_start) {
++ !opts->create_if_missing_start) {
+ struct object_id head_oid;
+ char *head = refs_resolve_refdup(get_main_ref_store(the_repository),
+ "HEAD", 0, &head_oid, NULL);
@@ builtin/checkout.c: static int checkout_main(int argc, const char **argv, const
- /* --track without -c/-C/-b/-B/--orphan should DWIM */
- if (opts->track != BRANCH_TRACK_UNSPECIFIED && !opts->new_branch) {
-+ /* --track without -c/-C/-b/-B/--orphan/-e should DWIM */
++ /* --track without -c/-C/-b/-B/--orphan/--create-if-missing should DWIM */
+ if (opts->track != BRANCH_TRACK_UNSPECIFIED && !opts->new_branch &&
-+ !(opts->ensure_branch && opts->branch_exists)) {
++ !(opts->create_if_missing_branch && opts->branch_exists)) {
const char *argv0 = argv[0];
if (!argc || !strcmp(argv0, "--"))
die(_("--track needs a branch name"));
@@ builtin/checkout.c: static int checkout_main(int argc, const char **argv, const
}
+ /*
-+ * Handle -e with existing branch: set up new_branch_info to switch
-+ * to the existing branch.
++ * Handle --create-if-missing with existing branch: set up
++ * new_branch_info to switch to the existing branch.
+ */
-+ if (opts->ensure_branch && opts->branch_exists) {
++ if (opts->create_if_missing_branch && opts->branch_exists) {
+ struct object_id rev;
+
++ if (repo_get_oid_mb(the_repository, opts->create_if_missing_branch,
++ &rev))
++ die(_("could not resolve '%s'"),
++ opts->create_if_missing_branch);
++
+ branch_info_release(&new_branch_info);
+ memset(&new_branch_info, 0, sizeof(new_branch_info));
-+ new_branch_info.name = xstrdup(opts->ensure_branch);
-+ setup_branch_path(&new_branch_info);
-+
-+ if (new_branch_info.path &&
-+ !refs_read_ref(get_main_ref_store(the_repository),
-+ new_branch_info.path, &rev)) {
-+ new_branch_info.commit = lookup_commit_reference_gently(
-+ the_repository, &rev, 1);
-+ if (new_branch_info.commit)
-+ parse_commit_or_die(new_branch_info.commit);
-+ }
++ setup_new_branch_info_and_source_tree(&new_branch_info, opts, &rev,
++ opts->create_if_missing_branch);
+ }
+
if (argc) {
parse_pathspec(&opts->pathspec, 0,
opts->patch_mode ? PATHSPEC_PREFIX_ORIGIN : 0,
+@@ builtin/checkout.c: int cmd_checkout(int argc,
+ N_("create and checkout a new branch")),
+ OPT_STRING('B', NULL, &opts.new_branch_force, N_("branch"),
+ N_("create/reset and checkout a branch")),
++ OPT_STRING_F(0, "create-if-missing", &opts.create_if_missing_branch, N_("branch"),
++ N_("create if needed and checkout branch"),
++ PARSE_OPT_NONEG),
+ OPT_BOOL('l', NULL, &opts.new_branch_log, N_("create reflog for new branch")),
+ OPT_BOOL(0, "guess", &opts.dwim_new_local_branch,
+ N_("second guess 'git checkout <no-such-branch>' (default)")),
@@ builtin/checkout.c: int cmd_switch(int argc,
N_("create and switch to a new branch")),
OPT_STRING('C', "force-create", &opts.new_branch_force, N_("branch"),
N_("create/reset and switch to a branch")),
-+ OPT_STRING('e', "ensure", &opts.ensure_branch, N_("branch"),
-+ N_("create if needed and switch to branch")),
++ OPT_STRING_F(0, "create-if-missing", &opts.create_if_missing_branch, N_("branch"),
++ N_("create if needed and switch to branch"),
++ PARSE_OPT_NONEG),
OPT_BOOL(0, "guess", &opts.dwim_new_local_branch,
N_("second guess 'git switch <no-such-branch>'")),
OPT_BOOL(0, "discard-changes", &opts.discard_changes,
+ ## contrib/completion/git-completion.bash ##
+@@ contrib/completion/git-completion.bash: _git_checkout ()
+ local dwim_opt="$(__git_checkout_default_dwim_mode)"
+
+ case "$prev" in
+- -b|-B|--orphan)
++ -b|-B|--orphan|--create-if-missing)
+ # Complete local branches (and DWIM branch
+ # remote branch names) for an option argument
+ # specifying a new branch name. This is for
+@@ contrib/completion/git-completion.bash: _git_checkout ()
+ ;;
+ *)
+ # At this point, we've already handled special completion for
+- # the arguments to -b/-B, and --orphan. There are 3 main
+- # things left we can possibly complete:
+- # 1) a start-point for -b/-B, -d/--detach, or --orphan
++ # the arguments to -b/-B, --orphan, and
++ # --create-if-missing. There are 3 main things left
++ # we can possibly complete:
++ # 1) a start-point for -b/-B, -d/--detach, --orphan,
++ # or --create-if-missing
+ # 2) a remote head, for --track
+ # 3) an arbitrary reference, possibly including DWIM names
+ #
+
+- if [ -n "$(__git_find_on_cmdline "-b -B -d --detach --orphan")" ]; then
++ if [ -n "$(__git_find_on_cmdline "-b -B -d --detach --orphan --create-if-missing")" ]; then
+ __git_complete_refs --mode="refs"
+ elif [ -n "$(__git_find_on_cmdline "-t --track")" ]; then
+ __git_complete_refs --mode="remote-heads"
+@@ contrib/completion/git-completion.bash: _git_switch ()
+ local dwim_opt="$(__git_checkout_default_dwim_mode)"
+
+ case "$prev" in
+- -c|-C|--orphan)
++ -c|-C|--orphan|--create-if-missing)
+ # Complete local branches (and DWIM branch
+ # remote branch names) for an option argument
+ # specifying a new branch name. This is for
+@@ contrib/completion/git-completion.bash: _git_switch ()
+ fi
+
+ # At this point, we've already handled special completion for
+- # -c/-C, and --orphan. There are 3 main things left to
+- # complete:
+- # 1) a start-point for -c/-C or -d/--detach
++ # -c/-C, --orphan, and --create-if-missing. There
++ # are 3 main things left to complete:
++ # 1) a start-point for -c/-C, -d/--detach, or --create-if-missing
+ # 2) a remote head, for --track
+ # 3) a branch name, possibly including DWIM remote branches
+
+- if [ -n "$(__git_find_on_cmdline "-c -C -d --detach")" ]; then
++ if [ -n "$(__git_find_on_cmdline "-c -C -d --detach --create-if-missing")" ]; then
+ __git_complete_refs --mode="refs"
+ elif [ -n "$(__git_find_on_cmdline "-t --track")" ]; then
+ __git_complete_refs --mode="remote-heads"
+
+ ## t/t2018-checkout-branch.sh ##
+@@ t/t2018-checkout-branch.sh: test_expect_success 'checkout -B to the current branch works' '
+ test_dirty_mergeable
+ '
+
++test_expect_success 'checkout --create-if-missing creates a branch' '
++ test_when_finished "
++ git checkout branch1 &&
++ test_might_fail git branch -D create-if-missing-new
++ " &&
++ git checkout --create-if-missing create-if-missing-new $HEAD1 &&
++ echo refs/heads/create-if-missing-new >expect &&
++ git symbolic-ref HEAD >actual &&
++ test_cmp expect actual &&
++ test_cmp_rev $HEAD1 HEAD
++'
++
++test_expect_success 'checkout --create-if-missing switches to existing branch' '
++ test_when_finished "
++ git checkout branch1 &&
++ test_might_fail git branch -D create-if-missing-existing
++ " &&
++ git branch create-if-missing-existing $HEAD1 &&
++ git checkout branch1 &&
++ git checkout --create-if-missing create-if-missing-existing 2>err &&
++ test_grep "Switched to existing branch '\''create-if-missing-existing'\''" err &&
++ echo refs/heads/create-if-missing-existing >expect &&
++ git symbolic-ref HEAD >actual &&
++ test_cmp expect actual &&
++ test_cmp_rev $HEAD1 HEAD
++'
++
+ test_expect_success 'checkout -b after clone --no-checkout does a checkout of HEAD' '
+ git init src &&
+ test_commit -C src a &&
+@@ t/t2018-checkout-branch.sh: test_expect_success 'checkout -b rejects an extra path argument' '
+ test_grep "Cannot update paths and switch to branch" err
+ '
+
++test_expect_success 'checkout --create-if-missing rejects a path argument' '
++ test_when_finished "
++ git checkout branch1 &&
++ test_might_fail git branch -D create-if-missing-path
++ " &&
++ git branch create-if-missing-path branch1 &&
++ test_must_fail git checkout --create-if-missing create-if-missing-path -- file1 2>err &&
++ test_grep "Cannot update paths and switch to branch '\''create-if-missing-path'\''" err
++'
++
+ test_done
+
+ ## t/t2027-checkout-track.sh ##
+@@ t/t2027-checkout-track.sh: test_expect_success 'checkout --track -b creates a new tracking branch' '
+ test $(git config --get branch.branch1.merge) = refs/heads/main
+ '
+
++test_expect_success 'checkout --create-if-missing --track creates branch from current branch' '
++ test_when_finished "
++ git checkout main &&
++ git branch -D branch2
++ " &&
++ git checkout main &&
++ git checkout --create-if-missing branch2 --track &&
++ test $(git rev-parse --abbrev-ref HEAD) = branch2 &&
++ test_cmp_config . branch.branch2.remote &&
++ test_cmp_config refs/heads/main branch.branch2.merge
++'
++
++test_expect_success 'checkout --create-if-missing --track uses current branch for existing branch' '
++ test_when_finished "
++ git checkout main &&
++ git branch -D branch3 branch3-source
++ " &&
++ git checkout -b branch3-source main &&
++ git branch branch3 main &&
++ git checkout --create-if-missing branch3 --track >out 2>err &&
++ test_grep "branch '\''branch3'\'' set up to track '\''branch3-source'\''." out &&
++ test_grep "Switched to existing branch '\''branch3'\''" err &&
++ test_cmp_config . branch.branch3.remote &&
++ test_cmp_config refs/heads/branch3-source branch.branch3.merge
++'
++
++test_expect_success 'checkout --create-if-missing --track fails from detached HEAD without start-point' '
++ test_when_finished "
++ git checkout main &&
++ git branch -D branch4
++ " &&
++ git branch branch4 main &&
++ git checkout --detach main &&
++ test_must_fail git checkout --create-if-missing branch4 --track 2>err &&
++ test_grep "cannot set up tracking information; starting point '\''HEAD'\'' is not a branch" err
++'
++
+ test_expect_success 'checkout --track -b rejects an extra path argument' '
+ test_must_fail git checkout --track -b branch2 main one.t 2>err &&
+ test_grep "cannot be used with updating paths" err
+
## t/t2060-switch.sh ##
@@ t/t2060-switch.sh: test_expect_success 'tracking info copied with autoSetupMerge=inherit' '
test_cmp_config "" --default "" branch.main2.merge
'
-+test_expect_success 'switch -e --track creates branch from current branch' '
++test_expect_success 'switch --create-if-missing --track creates branch from current branch' '
+ test_when_finished "
+ git switch main || :
+ git branch -D ensure-new-current || :
+ " &&
+ git switch main &&
-+ git switch -e ensure-new-current --track &&
++ git switch --create-if-missing ensure-new-current --track &&
+ test_cmp_rev refs/heads/main refs/heads/ensure-new-current &&
+ test_cmp_config . branch.ensure-new-current.remote &&
+ test_cmp_config refs/heads/main branch.ensure-new-current.merge
+'
+
-+test_expect_success 'switch -e --track creates branch from remote-tracking branch' '
++test_expect_success 'switch --create-if-missing --track creates branch from remote-tracking branch' '
+ test_when_finished "
+ git switch main || :
+ git branch -D ensure-new || :
+ " &&
-+ git switch -e ensure-new --track origin/foo &&
++ git switch --create-if-missing ensure-new --track origin/foo &&
+ test_cmp_rev refs/remotes/origin/foo refs/heads/ensure-new &&
+ test_cmp_config origin branch.ensure-new.remote &&
+ test_cmp_config refs/heads/foo branch.ensure-new.merge
+'
+
-+test_expect_success 'switch -e --track uses current branch for existing branch' '
++test_expect_success 'switch --create-if-missing switches to existing branch' '
++ test_when_finished "
++ git switch main || :
++ git branch -D ensure-existing-plain || :
++ " &&
++ git branch ensure-existing-plain main &&
++ git switch --create-if-missing ensure-existing-plain 2>err &&
++ test_grep "Switched to existing branch '\''ensure-existing-plain'\''" err
++'
++
++test_expect_success 'switch --create-if-missing reports tracking for existing branch' '
++ test_when_finished "
++ git switch main || :
++ git branch -D ensure-existing-report || :
++ git update-ref refs/remotes/origin/foo first-branch || :
++ " &&
++ git branch ensure-existing-report first-branch &&
++ git config branch.ensure-existing-report.remote origin &&
++ git config branch.ensure-existing-report.merge refs/heads/foo &&
++ git update-ref refs/remotes/origin/foo main &&
++ git switch --create-if-missing ensure-existing-report >out 2>err &&
++ test_grep "Switched to existing branch '\''ensure-existing-report'\''" err &&
++ test_grep "Your branch is behind '\''origin/foo'\''" out
++'
++
++test_expect_success 'switch --create-if-missing --track uses current branch for existing branch' '
+ test_when_finished "
+ git switch main || :
+ git branch -D ensure-existing source-for-track || :
+ " &&
+ git switch -c source-for-track main &&
+ git branch ensure-existing main &&
-+ git switch -e ensure-existing --track &&
++ git switch --create-if-missing ensure-existing --track >out 2>err &&
++ test_grep "branch '\''ensure-existing'\'' set up to track '\''source-for-track'\''." out &&
++ test_grep "Switched to existing branch '\''ensure-existing'\''" err &&
+ test_cmp_config . branch.ensure-existing.remote &&
+ test_cmp_config refs/heads/source-for-track branch.ensure-existing.merge
+'
+
-+test_expect_success 'switch -e --track fails from detached HEAD without start-point' '
++test_expect_success 'switch --create-if-missing --track fails from detached HEAD without start-point' '
+ test_when_finished "
+ git switch main || :
+ git branch -D detached-target || :
+ " &&
+ git branch detached-target main &&
+ git switch --detach main &&
-+ test_must_fail git switch -e detached-target --track 2>stderr &&
++ test_must_fail git switch --create-if-missing detached-target --track 2>stderr &&
+ test_grep "cannot set up tracking information; starting point '\''HEAD'\'' is not a branch" stderr
+'
+
test_expect_success 'switch back when temporarily detached and checked out elsewhere ' '
test_when_finished "
git worktree remove wt1 ||:
+
+ ## t/t9902-completion.sh ##
+@@ t/t9902-completion.sh: test_expect_success 'double dash "git checkout"' '
+ --quiet Z
+ --detach Z
+ --track Z
++ --create-if-missing=Z
+ --orphan=Z
+ --ours Z
+ --theirs Z
Documentation/git-checkout.adoc | 32 +++++++++
Documentation/git-switch.adoc | 15 +++++
builtin/checkout.c | 93 +++++++++++++++++++++++++-
contrib/completion/git-completion.bash | 22 +++---
t/t2018-checkout-branch.sh | 37 ++++++++++
t/t2027-checkout-track.sh | 37 ++++++++++
t/t2060-switch.sh | 73 ++++++++++++++++++++
t/t9902-completion.sh | 1 +
8 files changed, 298 insertions(+), 12 deletions(-)
diff --git a/Documentation/git-checkout.adoc b/Documentation/git-checkout.adoc
index a8b3b8c2e2..a80f6fe6f6 100644
--- a/Documentation/git-checkout.adoc
+++ b/Documentation/git-checkout.adoc
@@ -12,6 +12,7 @@ git checkout [-q] [-f] [-m] [<branch>]
git checkout [-q] [-f] [-m] --detach [<branch>]
git checkout [-q] [-f] [-m] [--detach] <commit>
git checkout [-q] [-f] [-m] [[-b|-B|--orphan] <new-branch>] [<start-point>]
+git checkout [-q] [-f] [-m] --create-if-missing <branch> [<start-point>]
git checkout <tree-ish> [--] <pathspec>...
git checkout <tree-ish> --pathspec-from-file=<file> [--pathspec-file-nul]
git checkout [-f|--ours|--theirs|-m|--conflict=<style>] [--] <pathspec>...
@@ -58,6 +59,21 @@ This will fail if there's an error checking out _<new-branch>_, for
example if checking out the `<start-point>` commit would overwrite your
uncommitted changes.
+`git checkout --create-if-missing <branch> [<start-point>]`::
+
+ Check out _<branch>_ if it already exists, or create it from
+ _<start-point>_ before checking it out if it does not.
++
+When _<branch>_ does not already exist, this behaves like
+`git checkout -b <branch> [<start-point>]`, including any `--track`
+or `--no-track` options.
++
+When _<branch>_ already exists, the branch tip is not changed. If
+`--track[=(direct|inherit)]` is given, the existing branch's upstream
+configuration is updated using _<start-point>_ when one is provided,
+or the current branch when _<start-point>_ is omitted. This form fails
+when `HEAD` is detached and no _<start-point>_ is given.
+
`git checkout -B <branch> [<start-point>]`::
The same as `-b`, except that if the branch already exists it
@@ -157,6 +173,22 @@ of it").
The same as `-b`, except that if the branch already exists it
resets _<branch>_ to the start point instead of failing.
+`--create-if-missing <branch>`::
+ Check out _<branch>_ if it already exists, or create it from
+ _<start-point>_ before checking it out if it does not.
++
+When _<branch>_ does not already exist, this behaves like
+`git checkout -b <branch> [<start-point>]`, including any `--track`
+or `--no-track` options.
++
+When _<branch>_ already exists, the branch tip is not changed. If
+`--track[=(direct|inherit)]` is given, the existing branch's upstream
+configuration is updated using _<start-point>_ when one is provided,
+or the current branch when _<start-point>_ is omitted. This form fails
+when `HEAD` is detached and no _<start-point>_ is given.
++
+This option cannot be used when checking out paths.
+
`-t`::
`--track[=(direct|inherit)]`::
When creating a new branch, set up "upstream" configuration. See
diff --git a/Documentation/git-switch.adoc b/Documentation/git-switch.adoc
index d6c4f229a5..461a6f0b96 100644
--- a/Documentation/git-switch.adoc
+++ b/Documentation/git-switch.adoc
@@ -11,6 +11,7 @@ SYNOPSIS
git switch [<options>] [--no-guess] <branch>
git switch [<options>] --detach [<start-point>]
git switch [<options>] (-c|-C) <new-branch> [<start-point>]
+git switch [<options>] --create-if-missing <branch> [<start-point>]
git switch [<options>] --orphan <new-branch>
DESCRIPTION
@@ -81,6 +82,20 @@ $ git branch -f _<new-branch>_
$ git switch _<new-branch>_
------------
+`--create-if-missing <branch>`::
+ Switch to _<branch>_ if it already exists, or create it from
+ _<start-point>_ before switching to it if it does not.
++
+When _<branch>_ does not already exist, this behaves like
+`git switch -c <branch> [<start-point>]`, including any `--track`
+or `--no-track` options.
++
+When _<branch>_ already exists, the branch tip is not changed. If
+`--track[=(direct|inherit)]` is given, the existing branch's upstream
+configuration is updated using _<start-point>_ when one is provided,
+or the current branch when _<start-point>_ is omitted. This form fails
+when `HEAD` is detached and no _<start-point>_ is given.
+
`-d`::
`--detach`::
Switch to a commit for inspection and discardable
diff --git a/builtin/checkout.c b/builtin/checkout.c
index b78b3a1d16..f5bc882f2e 100644
--- a/builtin/checkout.c
+++ b/builtin/checkout.c
@@ -81,6 +81,8 @@ struct checkout_opts {
const char *new_branch;
const char *new_branch_force;
const char *new_orphan_branch;
+ const char *create_if_missing_branch;
+ const char *create_if_missing_start;
int new_branch_log;
enum branch_track track;
struct diff_options diff_options;
@@ -551,6 +553,10 @@ static int checkout_paths(const struct checkout_opts *opts,
die(_("Cannot update paths and switch to branch '%s' at the same time."),
opts->new_branch);
+ if (opts->create_if_missing_branch)
+ die(_("Cannot update paths and switch to branch '%s' at the same time."),
+ opts->create_if_missing_branch);
+
if (!opts->checkout_worktree && !opts->checkout_index)
die(_("neither '%s' or '%s' is specified"),
"--staged", "--worktree");
@@ -988,6 +994,14 @@ static void update_refs_for_switch(const struct checkout_opts *opts,
free(new_branch_info->refname);
new_branch_info->name = xstrdup(opts->new_branch);
setup_branch_path(new_branch_info);
+ } else if (opts->create_if_missing_branch && opts->branch_exists &&
+ opts->track != BRANCH_TRACK_UNSPECIFIED) {
+ const char *tracking_source = opts->create_if_missing_start ?
+ opts->create_if_missing_start :
+ old_branch_info->name;
+ dwim_and_setup_tracking(the_repository, opts->create_if_missing_branch,
+ tracking_source, opts->track,
+ opts->quiet);
}
old_desc = old_branch_info->name;
@@ -1030,6 +1044,10 @@ static void update_refs_for_switch(const struct checkout_opts *opts,
fprintf(stderr, _("Switched to and reset branch '%s'\n"), new_branch_info->name);
else
fprintf(stderr, _("Switched to a new branch '%s'\n"), new_branch_info->name);
+ } else if (opts->create_if_missing_branch &&
+ opts->branch_exists) {
+ fprintf(stderr, _("Switched to existing branch '%s'\n"),
+ new_branch_info->name);
} else {
fprintf(stderr, _("Switched to branch '%s'\n"),
new_branch_info->name);
@@ -1927,6 +1945,52 @@ static int checkout_main(int argc, const char **argv, const char *prefix,
die(_("options '-%c', '-%c', and '%s' cannot be used together"),
cb_option, toupper(cb_option), "--orphan");
+ if (opts->create_if_missing_branch) {
+ struct strbuf ref = STRBUF_INIT;
+ int exists;
+
+ if (opts->new_branch || opts->new_branch_force || opts->new_orphan_branch)
+ die(_("'%s' cannot be used with '%s'"), "--create-if-missing", "-c/-C/--orphan");
+ if (opts->force_detach)
+ die(_("'%s' cannot be used with '%s'"), "--create-if-missing", "--detach");
+
+ exists = validate_branchname(opts->create_if_missing_branch, &ref);
+ strbuf_release(&ref);
+
+ /* Save an explicit start point for tracking setup. */
+ if (argc > 0 && opts->track != BRANCH_TRACK_UNSPECIFIED)
+ opts->create_if_missing_start = argv[0];
+
+ if (exists) {
+ /*
+ * Branch exists: just switch to it, don't reset.
+ * We'll set up tracking after the switch if --track was given.
+ */
+ opts->branch_exists = 1;
+ } else {
+ /* Branch doesn't exist: create it like -c */
+ opts->new_branch = opts->create_if_missing_branch;
+ }
+ }
+
+ if (opts->create_if_missing_branch && opts->branch_exists &&
+ opts->track != BRANCH_TRACK_UNSPECIFIED &&
+ !opts->create_if_missing_start) {
+ struct object_id head_oid;
+ char *head = refs_resolve_refdup(get_main_ref_store(the_repository),
+ "HEAD", 0, &head_oid, NULL);
+ const char *branch;
+
+ if (!head)
+ die(_("failed to resolve HEAD as a valid ref"));
+ if (!strcmp(head, "HEAD"))
+ die(_("cannot set up tracking information; starting point '%s' is not a branch"),
+ "HEAD");
+ if (!skip_prefix(head, "refs/heads/", &branch))
+ die(_("HEAD not found below refs/heads!"));
+ free(head);
+ }
+
if (opts->overlay_mode == 1 && opts->patch_mode)
die(_("options '%s' and '%s' cannot be used together"), "-p", "--overlay");
@@ -1961,8 +2025,9 @@ static int checkout_main(int argc, const char **argv, const char *prefix,
if (opts->new_orphan_branch)
opts->new_branch = opts->new_orphan_branch;
- /* --track without -c/-C/-b/-B/--orphan should DWIM */
- if (opts->track != BRANCH_TRACK_UNSPECIFIED && !opts->new_branch) {
+ /* --track without -c/-C/-b/-B/--orphan/--create-if-missing should DWIM */
+ if (opts->track != BRANCH_TRACK_UNSPECIFIED && !opts->new_branch &&
+ !(opts->create_if_missing_branch && opts->branch_exists)) {
const char *argv0 = argv[0];
if (!argc || !strcmp(argv0, "--"))
die(_("--track needs a branch name"));
@@ -2012,6 +2077,24 @@ static int checkout_main(int argc, const char **argv, const char *prefix,
die(_("reference is not a tree: %s"), opts->from_treeish);
}
+ /*
+ * Handle --create-if-missing with existing branch: set up
+ * new_branch_info to switch to the existing branch.
+ */
+ if (opts->create_if_missing_branch && opts->branch_exists) {
+ struct object_id rev;
+
+ if (repo_get_oid_mb(the_repository, opts->create_if_missing_branch,
+ &rev))
+ die(_("could not resolve '%s'"),
+ opts->create_if_missing_branch);
+
+ branch_info_release(&new_branch_info);
+ memset(&new_branch_info, 0, sizeof(new_branch_info));
+ setup_new_branch_info_and_source_tree(&new_branch_info, opts, &rev,
+ opts->create_if_missing_branch);
+ }
+
if (argc) {
parse_pathspec(&opts->pathspec, 0,
opts->patch_mode ? PATHSPEC_PREFIX_ORIGIN : 0,
@@ -2098,6 +2181,9 @@ int cmd_checkout(int argc,
N_("create and checkout a new branch")),
OPT_STRING('B', NULL, &opts.new_branch_force, N_("branch"),
N_("create/reset and checkout a branch")),
+ OPT_STRING_F(0, "create-if-missing", &opts.create_if_missing_branch, N_("branch"),
+ N_("create if needed and checkout branch"),
+ PARSE_OPT_NONEG),
OPT_BOOL('l', NULL, &opts.new_branch_log, N_("create reflog for new branch")),
OPT_BOOL(0, "guess", &opts.dwim_new_local_branch,
N_("second guess 'git checkout <no-such-branch>' (default)")),
@@ -2150,6 +2236,9 @@ int cmd_switch(int argc,
N_("create and switch to a new branch")),
OPT_STRING('C', "force-create", &opts.new_branch_force, N_("branch"),
N_("create/reset and switch to a branch")),
+ OPT_STRING_F(0, "create-if-missing", &opts.create_if_missing_branch, N_("branch"),
+ N_("create if needed and switch to branch"),
+ PARSE_OPT_NONEG),
OPT_BOOL(0, "guess", &opts.dwim_new_local_branch,
N_("second guess 'git switch <no-such-branch>'")),
OPT_BOOL(0, "discard-changes", &opts.discard_changes,
diff --git a/contrib/completion/git-completion.bash b/contrib/completion/git-completion.bash
index e875787710..1c72b4c853 100644
--- a/contrib/completion/git-completion.bash
+++ b/contrib/completion/git-completion.bash
@@ -1740,7 +1740,7 @@ _git_checkout ()
local dwim_opt="$(__git_checkout_default_dwim_mode)"
case "$prev" in
- -b|-B|--orphan)
+ -b|-B|--orphan|--create-if-missing)
# Complete local branches (and DWIM branch
# remote branch names) for an option argument
# specifying a new branch name. This is for
@@ -1762,14 +1762,16 @@ _git_checkout ()
;;
*)
# At this point, we've already handled special completion for
- # the arguments to -b/-B, and --orphan. There are 3 main
- # things left we can possibly complete:
- # 1) a start-point for -b/-B, -d/--detach, or --orphan
+ # the arguments to -b/-B, --orphan, and
+ # --create-if-missing. There are 3 main things left
+ # we can possibly complete:
+ # 1) a start-point for -b/-B, -d/--detach, --orphan,
+ # or --create-if-missing
# 2) a remote head, for --track
# 3) an arbitrary reference, possibly including DWIM names
#
- if [ -n "$(__git_find_on_cmdline "-b -B -d --detach --orphan")" ]; then
+ if [ -n "$(__git_find_on_cmdline "-b -B -d --detach --orphan --create-if-missing")" ]; then
__git_complete_refs --mode="refs"
elif [ -n "$(__git_find_on_cmdline "-t --track")" ]; then
__git_complete_refs --mode="remote-heads"
@@ -2692,7 +2694,7 @@ _git_switch ()
local dwim_opt="$(__git_checkout_default_dwim_mode)"
case "$prev" in
- -c|-C|--orphan)
+ -c|-C|--orphan|--create-if-missing)
# Complete local branches (and DWIM branch
# remote branch names) for an option argument
# specifying a new branch name. This is for
@@ -2721,13 +2723,13 @@ _git_switch ()
fi
# At this point, we've already handled special completion for
- # -c/-C, and --orphan. There are 3 main things left to
- # complete:
- # 1) a start-point for -c/-C or -d/--detach
+ # -c/-C, --orphan, and --create-if-missing. There
+ # are 3 main things left to complete:
+ # 1) a start-point for -c/-C, -d/--detach, or --create-if-missing
# 2) a remote head, for --track
# 3) a branch name, possibly including DWIM remote branches
- if [ -n "$(__git_find_on_cmdline "-c -C -d --detach")" ]; then
+ if [ -n "$(__git_find_on_cmdline "-c -C -d --detach --create-if-missing")" ]; then
__git_complete_refs --mode="refs"
elif [ -n "$(__git_find_on_cmdline "-t --track")" ]; then
__git_complete_refs --mode="remote-heads"
diff --git a/t/t2018-checkout-branch.sh b/t/t2018-checkout-branch.sh
index a48ebdbf4d..f910563170 100755
--- a/t/t2018-checkout-branch.sh
+++ b/t/t2018-checkout-branch.sh
@@ -243,6 +243,33 @@ test_expect_success 'checkout -B to the current branch works' '
test_dirty_mergeable
'
+test_expect_success 'checkout --create-if-missing creates a branch' '
+ test_when_finished "
+ git checkout branch1 &&
+ test_might_fail git branch -D create-if-missing-new
+ " &&
+ git checkout --create-if-missing create-if-missing-new $HEAD1 &&
+ echo refs/heads/create-if-missing-new >expect &&
+ git symbolic-ref HEAD >actual &&
+ test_cmp expect actual &&
+ test_cmp_rev $HEAD1 HEAD
+'
+
+test_expect_success 'checkout --create-if-missing switches to existing branch' '
+ test_when_finished "
+ git checkout branch1 &&
+ test_might_fail git branch -D create-if-missing-existing
+ " &&
+ git branch create-if-missing-existing $HEAD1 &&
+ git checkout branch1 &&
+ git checkout --create-if-missing create-if-missing-existing 2>err &&
+ test_grep "Switched to existing branch '\''create-if-missing-existing'\''" err &&
+ echo refs/heads/create-if-missing-existing >expect &&
+ git symbolic-ref HEAD >actual &&
+ test_cmp expect actual &&
+ test_cmp_rev $HEAD1 HEAD
+'
+
test_expect_success 'checkout -b after clone --no-checkout does a checkout of HEAD' '
git init src &&
test_commit -C src a &&
@@ -285,4 +312,14 @@ test_expect_success 'checkout -b rejects an extra path argument' '
test_grep "Cannot update paths and switch to branch" err
'
+test_expect_success 'checkout --create-if-missing rejects a path argument' '
+ test_when_finished "
+ git checkout branch1 &&
+ test_might_fail git branch -D create-if-missing-path
+ " &&
+ git branch create-if-missing-path branch1 &&
+ test_must_fail git checkout --create-if-missing create-if-missing-path -- file1 2>err &&
+ test_grep "Cannot update paths and switch to branch '\''create-if-missing-path'\''" err
+'
+
test_done
diff --git a/t/t2027-checkout-track.sh b/t/t2027-checkout-track.sh
index c01f1cd617..67f073ddf0 100755
--- a/t/t2027-checkout-track.sh
+++ b/t/t2027-checkout-track.sh
@@ -19,6 +19,43 @@ test_expect_success 'checkout --track -b creates a new tracking branch' '
test $(git config --get branch.branch1.merge) = refs/heads/main
'
+test_expect_success 'checkout --create-if-missing --track creates branch from current branch' '
+ test_when_finished "
+ git checkout main &&
+ git branch -D branch2
+ " &&
+ git checkout main &&
+ git checkout --create-if-missing branch2 --track &&
+ test $(git rev-parse --abbrev-ref HEAD) = branch2 &&
+ test_cmp_config . branch.branch2.remote &&
+ test_cmp_config refs/heads/main branch.branch2.merge
+'
+
+test_expect_success 'checkout --create-if-missing --track uses current branch for existing branch' '
+ test_when_finished "
+ git checkout main &&
+ git branch -D branch3 branch3-source
+ " &&
+ git checkout -b branch3-source main &&
+ git branch branch3 main &&
+ git checkout --create-if-missing branch3 --track >out 2>err &&
+ test_grep "branch '\''branch3'\'' set up to track '\''branch3-source'\''." out &&
+ test_grep "Switched to existing branch '\''branch3'\''" err &&
+ test_cmp_config . branch.branch3.remote &&
+ test_cmp_config refs/heads/branch3-source branch.branch3.merge
+'
+
+test_expect_success 'checkout --create-if-missing --track fails from detached HEAD without start-point' '
+ test_when_finished "
+ git checkout main &&
+ git branch -D branch4
+ " &&
+ git branch branch4 main &&
+ git checkout --detach main &&
+ test_must_fail git checkout --create-if-missing branch4 --track 2>err &&
+ test_grep "cannot set up tracking information; starting point '\''HEAD'\'' is not a branch" err
+'
+
test_expect_success 'checkout --track -b rejects an extra path argument' '
test_must_fail git checkout --track -b branch2 main one.t 2>err &&
test_grep "cannot be used with updating paths" err
diff --git a/t/t2060-switch.sh b/t/t2060-switch.sh
index c91c4db936..f17afda28e 100755
--- a/t/t2060-switch.sh
+++ b/t/t2060-switch.sh
@@ -146,6 +146,79 @@ test_expect_success 'tracking info copied with autoSetupMerge=inherit' '
test_cmp_config "" --default "" branch.main2.merge
'
+test_expect_success 'switch --create-if-missing --track creates branch from current branch' '
+ test_when_finished "
+ git switch main || :
+ git branch -D ensure-new-current || :
+ " &&
+ git switch main &&
+ git switch --create-if-missing ensure-new-current --track &&
+ test_cmp_rev refs/heads/main refs/heads/ensure-new-current &&
+ test_cmp_config . branch.ensure-new-current.remote &&
+ test_cmp_config refs/heads/main branch.ensure-new-current.merge
+'
+
+test_expect_success 'switch --create-if-missing --track creates branch from remote-tracking branch' '
+ test_when_finished "
+ git switch main || :
+ git branch -D ensure-new || :
+ " &&
+ git switch --create-if-missing ensure-new --track origin/foo &&
+ test_cmp_rev refs/remotes/origin/foo refs/heads/ensure-new &&
+ test_cmp_config origin branch.ensure-new.remote &&
+ test_cmp_config refs/heads/foo branch.ensure-new.merge
+'
+
+test_expect_success 'switch --create-if-missing switches to existing branch' '
+ test_when_finished "
+ git switch main || :
+ git branch -D ensure-existing-plain || :
+ " &&
+ git branch ensure-existing-plain main &&
+ git switch --create-if-missing ensure-existing-plain 2>err &&
+ test_grep "Switched to existing branch '\''ensure-existing-plain'\''" err
+'
+
+test_expect_success 'switch --create-if-missing reports tracking for existing branch' '
+ test_when_finished "
+ git switch main || :
+ git branch -D ensure-existing-report || :
+ git update-ref refs/remotes/origin/foo first-branch || :
+ " &&
+ git branch ensure-existing-report first-branch &&
+ git config branch.ensure-existing-report.remote origin &&
+ git config branch.ensure-existing-report.merge refs/heads/foo &&
+ git update-ref refs/remotes/origin/foo main &&
+ git switch --create-if-missing ensure-existing-report >out 2>err &&
+ test_grep "Switched to existing branch '\''ensure-existing-report'\''" err &&
+ test_grep "Your branch is behind '\''origin/foo'\''" out
+'
+
+test_expect_success 'switch --create-if-missing --track uses current branch for existing branch' '
+ test_when_finished "
+ git switch main || :
+ git branch -D ensure-existing source-for-track || :
+ " &&
+ git switch -c source-for-track main &&
+ git branch ensure-existing main &&
+ git switch --create-if-missing ensure-existing --track >out 2>err &&
+ test_grep "branch '\''ensure-existing'\'' set up to track '\''source-for-track'\''." out &&
+ test_grep "Switched to existing branch '\''ensure-existing'\''" err &&
+ test_cmp_config . branch.ensure-existing.remote &&
+ test_cmp_config refs/heads/source-for-track branch.ensure-existing.merge
+'
+
+test_expect_success 'switch --create-if-missing --track fails from detached HEAD without start-point' '
+ test_when_finished "
+ git switch main || :
+ git branch -D detached-target || :
+ " &&
+ git branch detached-target main &&
+ git switch --detach main &&
+ test_must_fail git switch --create-if-missing detached-target --track 2>stderr &&
+ test_grep "cannot set up tracking information; starting point '\''HEAD'\'' is not a branch" stderr
+'
+
test_expect_success 'switch back when temporarily detached and checked out elsewhere ' '
test_when_finished "
git worktree remove wt1 ||:
diff --git a/t/t9902-completion.sh b/t/t9902-completion.sh
index 55dc9eabfc..e782c39c5e 100755
--- a/t/t9902-completion.sh
+++ b/t/t9902-completion.sh
@@ -2588,6 +2588,7 @@ test_expect_success 'double dash "git checkout"' '
--quiet Z
--detach Z
--track Z
+ --create-if-missing=Z
--orphan=Z
--ours Z
--theirs Z
base-commit: 0fae78c9d55efe705877ea537fe42c59164ccd94
--
gitgitgadget
^ permalink raw reply related [flat|nested] 3+ messages in thread
end of thread, other threads:[~2026-06-17 10:57 UTC | newest]
Thread overview: 3+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2026-06-09 9:23 [PATCH] switch: add --ensure option Lei Zhu via GitGitGadget
2026-06-09 12:59 ` Junio C Hamano
2026-06-17 10:57 ` [PATCH v2] checkout/switch: add --create-if-missing option Lei Zhu via GitGitGadget
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.