2005-09-08 02:26:23 +02:00
|
|
|
git-branch(1)
|
|
|
|
|
=============
|
2005-08-23 10:49:47 +02:00
|
|
|
|
|
|
|
|
NAME
|
|
|
|
|
----
|
2007-01-19 00:53:37 +01:00
|
|
|
git-branch - List, create, or delete branches
|
2005-08-23 10:49:47 +02:00
|
|
|
|
|
|
|
|
SYNOPSIS
|
|
|
|
|
--------
|
2006-03-18 01:24:37 +01:00
|
|
|
[verse]
|
2019-07-10 00:25:34 +02:00
|
|
|
'git branch' [--color[=<when>] | --no-color] [--show-current]
|
2020-11-04 23:01:37 +01:00
|
|
|
[-v [--abbrev=<n> | --no-abbrev]]
|
2017-03-24 19:40:58 +01:00
|
|
|
[--column[=<options>] | --no-column] [--sort=<key>]
|
2020-09-16 04:08:40 +02:00
|
|
|
[--merged [<commit>]] [--no-merged [<commit>]]
|
2020-06-24 16:46:31 +02:00
|
|
|
[--contains [<commit>]] [--no-contains [<commit>]]
|
2019-05-29 01:16:05 +02:00
|
|
|
[--points-at <object>] [--format=<format>]
|
|
|
|
|
[(-r | --remotes) | (-a | --all)]
|
|
|
|
|
[--list] [<pattern>...]
|
branch: add --recurse-submodules option for branch creation
To improve the submodules UX, we would like to teach Git to handle
branches in submodules. Start this process by teaching "git branch" the
--recurse-submodules option so that "git branch --recurse-submodules
topic" will create the `topic` branch in the superproject and its
submodules.
Although this commit does not introduce breaking changes, it does not
work well with existing --recurse-submodules commands because "git
branch --recurse-submodules" writes to the submodule ref store, but most
commands only consider the superproject gitlink and ignore the submodule
ref store. For example, "git checkout --recurse-submodules" will check
out the commits in the superproject gitlinks (and put the submodules in
detached HEAD) instead of checking out the submodule branches.
Because of this, this commit introduces a new configuration value,
`submodule.propagateBranches`. The plan is for Git commands to
prioritize submodule ref store information over superproject gitlinks if
this value is true. Because "git branch --recurse-submodules" writes to
submodule ref stores, for the sake of clarity, it will not function
unless this configuration value is set.
This commit also includes changes that support working with submodules
from a superproject commit because "branch --recurse-submodules" (and
future commands) need to read .gitmodules and gitlinks from the
superproject commit, but submodules are typically read from the
filesystem's .gitmodules and the index's gitlinks. These changes are:
* add a submodules_of_tree() helper that gives the relevant
information of an in-tree submodule (e.g. path and oid) and
initializes the repository
* add is_tree_submodule_active() by adding a treeish_name parameter to
is_submodule_active()
* add the "submoduleNotUpdated" advice to advise users to update the
submodules in their trees
Incidentally, fix an incorrect usage string that combined the 'list'
usage of git branch (-l) with the 'create' usage; this string has been
incorrect since its inception, a8dfd5eac4 (Make builtin-branch.c use
parse_options., 2007-10-07).
Helped-by: Jonathan Tan <jonathantanmy@google.com>
Signed-off-by: Glen Choo <chooglen@google.com>
Reviewed-by: Jonathan Tan <jonathantanmy@google.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2022-01-29 01:04:45 +01:00
|
|
|
'git branch' [--track[=(direct|inherit)] | --no-track] [-f]
|
|
|
|
|
[--recurse-submodules] <branchname> [<start-point>]
|
2012-08-20 15:47:38 +02:00
|
|
|
'git branch' (--set-upstream-to=<upstream> | -u <upstream>) [<branchname>]
|
2012-08-30 19:23:12 +02:00
|
|
|
'git branch' --unset-upstream [<branchname>]
|
2008-06-30 08:09:04 +02:00
|
|
|
'git branch' (-m | -M) [<oldbranch>] <newbranch>
|
branch: add a --copy (-c) option to go with --move (-m)
Add the ability to --copy a branch and its reflog and configuration,
this uses the same underlying machinery as the --move (-m) option
except the reflog and configuration is copied instead of being moved.
This is useful for e.g. copying a topic branch to a new version,
e.g. work to work-2 after submitting the work topic to the list, while
preserving all the tracking info and other configuration that goes
with the branch, and unlike --move keeping the other already-submitted
branch around for reference.
Like --move, when the source branch is the currently checked out
branch the HEAD is moved to the destination branch. In the case of
--move we don't really have a choice (other than remaining on a
detached HEAD) and in order to keep the functionality consistent, we
are doing it in similar way for --copy too.
The most common usage of this feature is expected to be moving to a
new topic branch which is a copy of the current one, in that case
moving to the target branch is what the user wants, and doesn't
unexpectedly behave differently than --move would.
One outstanding caveat of this implementation is that:
git checkout maint &&
git checkout master &&
git branch -c topic &&
git checkout -
Will check out 'maint' instead of 'master'. This is because the @{-N}
feature (or its -1 shorthand "-") relies on HEAD reflogs created by
the checkout command, so in this case we'll checkout maint instead of
master, as the user might expect. What to do about that is left to a
future change.
Helped-by: Ævar Arnfjörð Bjarmason <avarab@gmail.com>
Signed-off-by: Ævar Arnfjörð Bjarmason <avarab@gmail.com>
Signed-off-by: Sahil Dua <sahildua2305@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2017-06-18 23:19:16 +02:00
|
|
|
'git branch' (-c | -C) [<oldbranch>] <newbranch>
|
2008-06-30 08:09:04 +02:00
|
|
|
'git branch' (-d | -D) [-r] <branchname>...
|
2011-09-21 00:10:08 +02:00
|
|
|
'git branch' --edit-description [<branchname>]
|
2005-08-23 10:49:47 +02:00
|
|
|
|
|
|
|
|
DESCRIPTION
|
|
|
|
|
-----------
|
2008-07-09 02:55:47 +02:00
|
|
|
|
2013-01-31 07:45:46 +01:00
|
|
|
If `--list` is given, or if there are no non-option arguments, existing
|
2019-04-29 07:19:43 +02:00
|
|
|
branches are listed; the current branch will be highlighted in green and
|
|
|
|
|
marked with an asterisk. Any branches checked out in linked worktrees will
|
|
|
|
|
be highlighted in cyan and marked with a plus sign. Option `-r` causes the
|
|
|
|
|
remote-tracking branches to be listed,
|
2019-05-29 01:16:05 +02:00
|
|
|
and option `-a` shows both local and remote branches.
|
|
|
|
|
|
|
|
|
|
If a `<pattern>`
|
2013-01-31 07:45:46 +01:00
|
|
|
is given, it is used as a shell wildcard to restrict the output to
|
|
|
|
|
matching branches. If multiple patterns are given, a branch is shown if
|
2019-05-29 01:16:05 +02:00
|
|
|
it matches any of the patterns.
|
|
|
|
|
|
|
|
|
|
Note that when providing a
|
|
|
|
|
`<pattern>`, you must use `--list`; otherwise the command may be interpreted
|
2013-01-31 07:45:46 +01:00
|
|
|
as branch creation.
|
2008-07-09 02:55:47 +02:00
|
|
|
|
2009-03-17 07:16:17 +01:00
|
|
|
With `--contains`, shows only the branches that contain the named commit
|
|
|
|
|
(in other words, the branches whose tip commits are descendants of the
|
2017-03-24 19:40:58 +01:00
|
|
|
named commit), `--no-contains` inverts it. With `--merged`, only branches
|
|
|
|
|
merged into the named commit (i.e. the branches whose tip commits are
|
|
|
|
|
reachable from the named commit) will be listed. With `--no-merged` only
|
|
|
|
|
branches not merged into the named commit will be listed. If the <commit>
|
|
|
|
|
argument is missing it defaults to `HEAD` (i.e. the tip of the current
|
|
|
|
|
branch).
|
2005-08-23 10:49:47 +02:00
|
|
|
|
2009-10-09 20:34:08 +02:00
|
|
|
The command's second form creates a new branch head named <branchname>
|
2019-04-27 14:02:22 +02:00
|
|
|
which points to the current `HEAD`, or <start-point> if given. As a
|
|
|
|
|
special case, for <start-point>, you may use `"A...B"` as a shortcut for
|
|
|
|
|
the merge base of `A` and `B` if there is exactly one merge base. You
|
|
|
|
|
can leave out at most one of `A` and `B`, in which case it defaults to
|
|
|
|
|
`HEAD`.
|
2006-04-28 15:15:04 +02:00
|
|
|
|
2007-10-03 01:34:32 +02:00
|
|
|
Note that this will create the new branch, but it will not switch the
|
2019-03-29 11:39:19 +01:00
|
|
|
working tree to it; use "git switch <newbranch>" to switch to the
|
2007-10-03 01:34:32 +02:00
|
|
|
new branch.
|
|
|
|
|
|
2013-01-21 20:17:53 +01:00
|
|
|
When a local branch is started off a remote-tracking branch, Git sets up the
|
2013-09-08 22:58:13 +02:00
|
|
|
branch (specifically the `branch.<name>.remote` and `branch.<name>.merge`
|
|
|
|
|
configuration entries) so that 'git pull' will appropriately merge from
|
2010-11-02 16:31:24 +01:00
|
|
|
the remote-tracking branch. This behavior may be changed via the global
|
2015-03-11 21:32:45 +01:00
|
|
|
`branch.autoSetupMerge` configuration flag. That setting can be
|
2010-11-02 16:31:28 +01:00
|
|
|
overridden by using the `--track` and `--no-track` options, and
|
2012-08-20 15:47:38 +02:00
|
|
|
changed later using `git branch --set-upstream-to`.
|
2007-03-08 10:58:35 +01:00
|
|
|
|
2012-03-06 10:32:43 +01:00
|
|
|
With a `-m` or `-M` option, <oldbranch> will be renamed to <newbranch>.
|
2006-11-28 15:47:40 +01:00
|
|
|
If <oldbranch> had a corresponding reflog, it is renamed to match
|
|
|
|
|
<newbranch>, and a reflog entry is created to remember the branch
|
|
|
|
|
renaming. If <newbranch> exists, -M must be used to force the rename
|
|
|
|
|
to happen.
|
|
|
|
|
|
branch: add a --copy (-c) option to go with --move (-m)
Add the ability to --copy a branch and its reflog and configuration,
this uses the same underlying machinery as the --move (-m) option
except the reflog and configuration is copied instead of being moved.
This is useful for e.g. copying a topic branch to a new version,
e.g. work to work-2 after submitting the work topic to the list, while
preserving all the tracking info and other configuration that goes
with the branch, and unlike --move keeping the other already-submitted
branch around for reference.
Like --move, when the source branch is the currently checked out
branch the HEAD is moved to the destination branch. In the case of
--move we don't really have a choice (other than remaining on a
detached HEAD) and in order to keep the functionality consistent, we
are doing it in similar way for --copy too.
The most common usage of this feature is expected to be moving to a
new topic branch which is a copy of the current one, in that case
moving to the target branch is what the user wants, and doesn't
unexpectedly behave differently than --move would.
One outstanding caveat of this implementation is that:
git checkout maint &&
git checkout master &&
git branch -c topic &&
git checkout -
Will check out 'maint' instead of 'master'. This is because the @{-N}
feature (or its -1 shorthand "-") relies on HEAD reflogs created by
the checkout command, so in this case we'll checkout maint instead of
master, as the user might expect. What to do about that is left to a
future change.
Helped-by: Ævar Arnfjörð Bjarmason <avarab@gmail.com>
Signed-off-by: Ævar Arnfjörð Bjarmason <avarab@gmail.com>
Signed-off-by: Sahil Dua <sahildua2305@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2017-06-18 23:19:16 +02:00
|
|
|
The `-c` and `-C` options have the exact same semantics as `-m` and
|
2021-02-03 22:07:32 +01:00
|
|
|
`-M`, except instead of the branch being renamed, it will be copied to a
|
|
|
|
|
new name, along with its config and reflog.
|
branch: add a --copy (-c) option to go with --move (-m)
Add the ability to --copy a branch and its reflog and configuration,
this uses the same underlying machinery as the --move (-m) option
except the reflog and configuration is copied instead of being moved.
This is useful for e.g. copying a topic branch to a new version,
e.g. work to work-2 after submitting the work topic to the list, while
preserving all the tracking info and other configuration that goes
with the branch, and unlike --move keeping the other already-submitted
branch around for reference.
Like --move, when the source branch is the currently checked out
branch the HEAD is moved to the destination branch. In the case of
--move we don't really have a choice (other than remaining on a
detached HEAD) and in order to keep the functionality consistent, we
are doing it in similar way for --copy too.
The most common usage of this feature is expected to be moving to a
new topic branch which is a copy of the current one, in that case
moving to the target branch is what the user wants, and doesn't
unexpectedly behave differently than --move would.
One outstanding caveat of this implementation is that:
git checkout maint &&
git checkout master &&
git branch -c topic &&
git checkout -
Will check out 'maint' instead of 'master'. This is because the @{-N}
feature (or its -1 shorthand "-") relies on HEAD reflogs created by
the checkout command, so in this case we'll checkout maint instead of
master, as the user might expect. What to do about that is left to a
future change.
Helped-by: Ævar Arnfjörð Bjarmason <avarab@gmail.com>
Signed-off-by: Ævar Arnfjörð Bjarmason <avarab@gmail.com>
Signed-off-by: Sahil Dua <sahildua2305@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2017-06-18 23:19:16 +02:00
|
|
|
|
2006-04-28 15:15:04 +02:00
|
|
|
With a `-d` or `-D` option, `<branchname>` will be deleted. You may
|
2006-05-19 11:16:58 +02:00
|
|
|
specify more than one branch for deletion. If the branch currently
|
2007-11-17 20:51:44 +01:00
|
|
|
has a reflog then the reflog will also be deleted.
|
|
|
|
|
|
2012-03-06 10:32:43 +01:00
|
|
|
Use `-r` together with `-d` to delete remote-tracking branches. Note, that it
|
2007-11-17 20:51:44 +01:00
|
|
|
only makes sense to delete remote-tracking branches if they no longer exist
|
2010-01-10 00:33:00 +01:00
|
|
|
in the remote repository or if 'git fetch' was configured not to fetch
|
2009-03-17 07:16:17 +01:00
|
|
|
them again. See also the 'prune' subcommand of linkgit:git-remote[1] for a
|
|
|
|
|
way to clean up all obsolete remote-tracking branches.
|
2006-03-18 01:24:37 +01:00
|
|
|
|
|
|
|
|
|
2005-08-23 10:49:47 +02:00
|
|
|
OPTIONS
|
|
|
|
|
-------
|
2005-11-14 17:53:42 +01:00
|
|
|
-d::
|
2011-08-28 16:54:30 +02:00
|
|
|
--delete::
|
2010-04-15 09:25:38 +02:00
|
|
|
Delete a branch. The branch must be fully merged in its
|
|
|
|
|
upstream branch, or in `HEAD` if no upstream was set with
|
2017-11-16 08:46:43 +01:00
|
|
|
`--track` or `--set-upstream-to`.
|
2005-11-14 17:53:42 +01:00
|
|
|
|
|
|
|
|
-D::
|
2015-07-02 16:07:21 +02:00
|
|
|
Shortcut for `--delete --force`.
|
2005-11-14 17:53:42 +01:00
|
|
|
|
2011-08-28 16:54:30 +02:00
|
|
|
--create-reflog::
|
2007-07-02 07:28:20 +02:00
|
|
|
Create the branch's reflog. This activates recording of
|
|
|
|
|
all changes made to the branch ref, enabling use of date
|
2007-07-02 07:24:59 +02:00
|
|
|
based sha1 expressions such as "<branchname>@\{yesterday}".
|
2010-04-08 21:49:08 +02:00
|
|
|
Note that in non-bare repositories, reflogs are usually
|
2017-09-23 06:56:17 +02:00
|
|
|
enabled by default by the `core.logAllRefUpdates` config option.
|
2017-02-01 23:07:27 +01:00
|
|
|
The negated form `--no-create-reflog` only overrides an earlier
|
|
|
|
|
`--create-reflog`, but currently does not negate the setting of
|
2017-09-23 06:56:17 +02:00
|
|
|
`core.logAllRefUpdates`.
|
2006-05-19 11:16:58 +02:00
|
|
|
|
2006-01-29 15:02:51 +01:00
|
|
|
-f::
|
2009-08-29 11:05:00 +02:00
|
|
|
--force::
|
2022-12-26 17:54:41 +01:00
|
|
|
Reset <branchname> to <start-point>, even if <branchname> exists
|
2017-10-18 04:34:31 +02:00
|
|
|
already. Without `-f`, 'git branch' refuses to change an existing branch.
|
2015-07-02 16:07:20 +02:00
|
|
|
In combination with `-d` (or `--delete`), allow deleting the
|
2021-08-27 20:35:35 +02:00
|
|
|
branch irrespective of its merged status, or whether it even
|
|
|
|
|
points to a valid commit. In combination with
|
2015-07-02 16:07:20 +02:00
|
|
|
`-m` (or `--move`), allow renaming the branch even if the new
|
branch: add a --copy (-c) option to go with --move (-m)
Add the ability to --copy a branch and its reflog and configuration,
this uses the same underlying machinery as the --move (-m) option
except the reflog and configuration is copied instead of being moved.
This is useful for e.g. copying a topic branch to a new version,
e.g. work to work-2 after submitting the work topic to the list, while
preserving all the tracking info and other configuration that goes
with the branch, and unlike --move keeping the other already-submitted
branch around for reference.
Like --move, when the source branch is the currently checked out
branch the HEAD is moved to the destination branch. In the case of
--move we don't really have a choice (other than remaining on a
detached HEAD) and in order to keep the functionality consistent, we
are doing it in similar way for --copy too.
The most common usage of this feature is expected to be moving to a
new topic branch which is a copy of the current one, in that case
moving to the target branch is what the user wants, and doesn't
unexpectedly behave differently than --move would.
One outstanding caveat of this implementation is that:
git checkout maint &&
git checkout master &&
git branch -c topic &&
git checkout -
Will check out 'maint' instead of 'master'. This is because the @{-N}
feature (or its -1 shorthand "-") relies on HEAD reflogs created by
the checkout command, so in this case we'll checkout maint instead of
master, as the user might expect. What to do about that is left to a
future change.
Helped-by: Ævar Arnfjörð Bjarmason <avarab@gmail.com>
Signed-off-by: Ævar Arnfjörð Bjarmason <avarab@gmail.com>
Signed-off-by: Sahil Dua <sahildua2305@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2017-06-18 23:19:16 +02:00
|
|
|
branch name already exists, the same applies for `-c` (or `--copy`).
|
2023-01-19 08:23:46 +01:00
|
|
|
+
|
|
|
|
|
Note that 'git branch -f <branchname> [<start-point>]', even with '-f',
|
|
|
|
|
refuses to change an existing branch `<branchname>` that is checked out
|
|
|
|
|
in another worktree linked to the same repository.
|
2006-04-28 15:15:04 +02:00
|
|
|
|
2006-11-28 15:47:40 +01:00
|
|
|
-m::
|
2011-08-28 16:54:30 +02:00
|
|
|
--move::
|
2021-10-24 01:57:30 +02:00
|
|
|
Move/rename a branch, together with its config and reflog.
|
2006-11-28 15:47:40 +01:00
|
|
|
|
|
|
|
|
-M::
|
2015-07-02 16:07:21 +02:00
|
|
|
Shortcut for `--move --force`.
|
2006-11-28 15:47:40 +01:00
|
|
|
|
branch: add a --copy (-c) option to go with --move (-m)
Add the ability to --copy a branch and its reflog and configuration,
this uses the same underlying machinery as the --move (-m) option
except the reflog and configuration is copied instead of being moved.
This is useful for e.g. copying a topic branch to a new version,
e.g. work to work-2 after submitting the work topic to the list, while
preserving all the tracking info and other configuration that goes
with the branch, and unlike --move keeping the other already-submitted
branch around for reference.
Like --move, when the source branch is the currently checked out
branch the HEAD is moved to the destination branch. In the case of
--move we don't really have a choice (other than remaining on a
detached HEAD) and in order to keep the functionality consistent, we
are doing it in similar way for --copy too.
The most common usage of this feature is expected to be moving to a
new topic branch which is a copy of the current one, in that case
moving to the target branch is what the user wants, and doesn't
unexpectedly behave differently than --move would.
One outstanding caveat of this implementation is that:
git checkout maint &&
git checkout master &&
git branch -c topic &&
git checkout -
Will check out 'maint' instead of 'master'. This is because the @{-N}
feature (or its -1 shorthand "-") relies on HEAD reflogs created by
the checkout command, so in this case we'll checkout maint instead of
master, as the user might expect. What to do about that is left to a
future change.
Helped-by: Ævar Arnfjörð Bjarmason <avarab@gmail.com>
Signed-off-by: Ævar Arnfjörð Bjarmason <avarab@gmail.com>
Signed-off-by: Sahil Dua <sahildua2305@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2017-06-18 23:19:16 +02:00
|
|
|
-c::
|
|
|
|
|
--copy::
|
2021-10-24 01:57:30 +02:00
|
|
|
Copy a branch, together with its config and reflog.
|
branch: add a --copy (-c) option to go with --move (-m)
Add the ability to --copy a branch and its reflog and configuration,
this uses the same underlying machinery as the --move (-m) option
except the reflog and configuration is copied instead of being moved.
This is useful for e.g. copying a topic branch to a new version,
e.g. work to work-2 after submitting the work topic to the list, while
preserving all the tracking info and other configuration that goes
with the branch, and unlike --move keeping the other already-submitted
branch around for reference.
Like --move, when the source branch is the currently checked out
branch the HEAD is moved to the destination branch. In the case of
--move we don't really have a choice (other than remaining on a
detached HEAD) and in order to keep the functionality consistent, we
are doing it in similar way for --copy too.
The most common usage of this feature is expected to be moving to a
new topic branch which is a copy of the current one, in that case
moving to the target branch is what the user wants, and doesn't
unexpectedly behave differently than --move would.
One outstanding caveat of this implementation is that:
git checkout maint &&
git checkout master &&
git branch -c topic &&
git checkout -
Will check out 'maint' instead of 'master'. This is because the @{-N}
feature (or its -1 shorthand "-") relies on HEAD reflogs created by
the checkout command, so in this case we'll checkout maint instead of
master, as the user might expect. What to do about that is left to a
future change.
Helped-by: Ævar Arnfjörð Bjarmason <avarab@gmail.com>
Signed-off-by: Ævar Arnfjörð Bjarmason <avarab@gmail.com>
Signed-off-by: Sahil Dua <sahildua2305@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2017-06-18 23:19:16 +02:00
|
|
|
|
|
|
|
|
-C::
|
|
|
|
|
Shortcut for `--copy --force`.
|
|
|
|
|
|
Add an optional argument for --color options
Make git-branch, git-show-branch, git-grep, and all the diff-based
programs accept an optional argument <when> for --color. The argument
is a colorbool: "always", "never", or "auto". If no argument is given,
"always" is used; --no-color is an alias for --color=never. This makes
the command-line interface consistent with other GNU tools, such as `ls'
and `grep', and with the git-config color options. Note that, without
an argument, --color and --no-color work exactly as before.
To implement this, two internal changes were made:
1. Allow the first argument of git_config_colorbool() to be NULL,
in which case it returns -1 if the argument isn't "always", "never",
or "auto".
2. Add OPT_COLOR_FLAG(), OPT__COLOR(), and parse_opt_color_flag_cb()
to the option parsing library. The callback uses
git_config_colorbool(), so color.h is now a dependency
of parse-options.c.
Signed-off-by: Mark Lodato <lodatom@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2010-02-17 05:55:58 +01:00
|
|
|
--color[=<when>]::
|
2010-11-02 16:31:24 +01:00
|
|
|
Color branches to highlight current, local, and
|
|
|
|
|
remote-tracking branches.
|
Add an optional argument for --color options
Make git-branch, git-show-branch, git-grep, and all the diff-based
programs accept an optional argument <when> for --color. The argument
is a colorbool: "always", "never", or "auto". If no argument is given,
"always" is used; --no-color is an alias for --color=never. This makes
the command-line interface consistent with other GNU tools, such as `ls'
and `grep', and with the git-config color options. Note that, without
an argument, --color and --no-color work exactly as before.
To implement this, two internal changes were made:
1. Allow the first argument of git_config_colorbool() to be NULL,
in which case it returns -1 if the argument isn't "always", "never",
or "auto".
2. Add OPT_COLOR_FLAG(), OPT__COLOR(), and parse_opt_color_flag_cb()
to the option parsing library. The callback uses
git_config_colorbool(), so color.h is now a dependency
of parse-options.c.
Signed-off-by: Mark Lodato <lodatom@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2010-02-17 05:55:58 +01:00
|
|
|
The value must be always (the default), never, or auto.
|
2007-01-03 16:36:29 +01:00
|
|
|
|
|
|
|
|
--no-color::
|
|
|
|
|
Turn off branch colors, even when the configuration file gives the
|
|
|
|
|
default to color output.
|
Add an optional argument for --color options
Make git-branch, git-show-branch, git-grep, and all the diff-based
programs accept an optional argument <when> for --color. The argument
is a colorbool: "always", "never", or "auto". If no argument is given,
"always" is used; --no-color is an alias for --color=never. This makes
the command-line interface consistent with other GNU tools, such as `ls'
and `grep', and with the git-config color options. Note that, without
an argument, --color and --no-color work exactly as before.
To implement this, two internal changes were made:
1. Allow the first argument of git_config_colorbool() to be NULL,
in which case it returns -1 if the argument isn't "always", "never",
or "auto".
2. Add OPT_COLOR_FLAG(), OPT__COLOR(), and parse_opt_color_flag_cb()
to the option parsing library. The callback uses
git_config_colorbool(), so color.h is now a dependency
of parse-options.c.
Signed-off-by: Mark Lodato <lodatom@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2010-02-17 05:55:58 +01:00
|
|
|
Same as `--color=never`.
|
2007-01-03 16:36:29 +01:00
|
|
|
|
2016-12-04 03:52:25 +01:00
|
|
|
-i::
|
|
|
|
|
--ignore-case::
|
|
|
|
|
Sorting and filtering branches are case insensitive.
|
|
|
|
|
|
2012-04-13 12:54:38 +02:00
|
|
|
--column[=<options>]::
|
|
|
|
|
--no-column::
|
|
|
|
|
Display branch listing in columns. See configuration variable
|
2021-02-20 03:44:05 +01:00
|
|
|
`column.branch` for option syntax. `--column` and `--no-column`
|
2012-04-13 12:54:38 +02:00
|
|
|
without options are equivalent to 'always' and 'never' respectively.
|
|
|
|
|
+
|
|
|
|
|
This option is only applicable in non-verbose mode.
|
|
|
|
|
|
2006-04-28 15:15:04 +02:00
|
|
|
-r::
|
2011-08-28 16:54:30 +02:00
|
|
|
--remotes::
|
2006-12-21 05:18:07 +01:00
|
|
|
List or delete (if used with -d) the remote-tracking branches.
|
2019-05-29 01:16:05 +02:00
|
|
|
Combine with `--list` to match the optional pattern(s).
|
2006-11-21 20:31:24 +01:00
|
|
|
|
|
|
|
|
-a::
|
2011-08-28 16:54:30 +02:00
|
|
|
--all::
|
2006-11-21 20:31:24 +01:00
|
|
|
List both remote-tracking branches and local branches.
|
2019-05-29 01:16:05 +02:00
|
|
|
Combine with `--list` to match optional pattern(s).
|
2006-01-29 15:02:51 +01:00
|
|
|
|
2018-06-22 11:24:59 +02:00
|
|
|
-l::
|
2011-08-28 16:54:31 +02:00
|
|
|
--list::
|
2017-03-24 05:17:00 +01:00
|
|
|
List branches. With optional `<pattern>...`, e.g. `git
|
|
|
|
|
branch --list 'maint-*'`, list only the branches that match
|
|
|
|
|
the pattern(s).
|
2011-08-28 16:54:31 +02:00
|
|
|
|
2018-10-25 21:04:21 +02:00
|
|
|
--show-current::
|
|
|
|
|
Print the name of the current branch. In detached HEAD state,
|
|
|
|
|
nothing is printed.
|
|
|
|
|
|
2008-06-08 03:36:09 +02:00
|
|
|
-v::
|
2012-09-19 01:25:34 +02:00
|
|
|
-vv::
|
2008-06-08 03:36:09 +02:00
|
|
|
--verbose::
|
2011-09-08 23:09:50 +02:00
|
|
|
When in list mode,
|
|
|
|
|
show sha1 and commit subject line for each head, along with
|
2009-04-07 09:16:56 +02:00
|
|
|
relationship to upstream branch (if any). If given twice, print
|
2019-04-29 07:19:44 +02:00
|
|
|
the path of the linked worktree (if any) and the name of the upstream
|
|
|
|
|
branch, as well (see also `git remote show <remote>`). Note that the
|
|
|
|
|
current worktree's HEAD will not have its path printed (it will always
|
|
|
|
|
be your current directory).
|
2006-11-24 14:45:10 +01:00
|
|
|
|
2012-03-27 01:51:06 +02:00
|
|
|
-q::
|
|
|
|
|
--quiet::
|
|
|
|
|
Be more quiet when creating or deleting a branch, suppressing
|
|
|
|
|
non-error messages.
|
|
|
|
|
|
2020-11-04 23:01:37 +01:00
|
|
|
--abbrev=<n>::
|
|
|
|
|
In the verbose listing that show the commit object name,
|
|
|
|
|
show the shortest prefix that is at least '<n>' hexdigits
|
|
|
|
|
long that uniquely refers the object.
|
2011-07-01 08:06:08 +02:00
|
|
|
The default value is 7 and can be overridden by the `core.abbrev`
|
|
|
|
|
config option.
|
2006-11-24 14:45:10 +01:00
|
|
|
|
2007-03-03 01:31:17 +01:00
|
|
|
--no-abbrev::
|
2009-03-17 07:16:17 +01:00
|
|
|
Display the full sha1s in the output listing rather than abbreviating them.
|
2007-03-03 01:31:17 +01:00
|
|
|
|
2009-04-28 17:21:20 +02:00
|
|
|
-t::
|
2022-01-20 13:35:54 +01:00
|
|
|
--track[=(direct|inherit)]::
|
2013-09-08 22:58:13 +02:00
|
|
|
When creating a new branch, set up `branch.<name>.remote` and
|
branch: add flags and config to inherit tracking
It can be helpful when creating a new branch to use the existing
tracking configuration from the branch point. However, there is
currently not a method to automatically do so.
Teach git-{branch,checkout,switch} an "inherit" argument to the
"--track" option. When this is set, creating a new branch will cause the
tracking configuration to default to the configuration of the branch
point, if set.
For example, if branch "main" tracks "origin/main", and we run
`git checkout --track=inherit -b feature main`, then branch "feature"
will track "origin/main". Thus, `git status` will show us how far
ahead/behind we are from origin, and `git pull` will pull from origin.
This is particularly useful when creating branches across many
submodules, such as with `git submodule foreach ...` (or if running with
a patch such as [1], which we use at $job), as it avoids having to
manually set tracking info for each submodule.
Since we've added an argument to "--track", also add "--track=direct" as
another way to explicitly get the original "--track" behavior ("--track"
without an argument still works as well).
Finally, teach branch.autoSetupMerge a new "inherit" option. When this
is set, "--track=inherit" becomes the default behavior.
[1]: https://lore.kernel.org/git/20180927221603.148025-1-sbeller@google.com/
Signed-off-by: Josh Steadmon <steadmon@google.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2021-12-21 04:30:23 +01:00
|
|
|
`branch.<name>.merge` configuration entries to set "upstream" tracking
|
|
|
|
|
configuration for the new branch. This
|
2009-04-13 13:11:56 +02:00
|
|
|
configuration will tell git to show the relationship between the
|
|
|
|
|
two branches in `git status` and `git branch -v`. Furthermore,
|
|
|
|
|
it directs `git pull` without arguments to pull from the
|
|
|
|
|
upstream when the new branch is checked out.
|
|
|
|
|
+
|
branch: add flags and config to inherit tracking
It can be helpful when creating a new branch to use the existing
tracking configuration from the branch point. However, there is
currently not a method to automatically do so.
Teach git-{branch,checkout,switch} an "inherit" argument to the
"--track" option. When this is set, creating a new branch will cause the
tracking configuration to default to the configuration of the branch
point, if set.
For example, if branch "main" tracks "origin/main", and we run
`git checkout --track=inherit -b feature main`, then branch "feature"
will track "origin/main". Thus, `git status` will show us how far
ahead/behind we are from origin, and `git pull` will pull from origin.
This is particularly useful when creating branches across many
submodules, such as with `git submodule foreach ...` (or if running with
a patch such as [1], which we use at $job), as it avoids having to
manually set tracking info for each submodule.
Since we've added an argument to "--track", also add "--track=direct" as
another way to explicitly get the original "--track" behavior ("--track"
without an argument still works as well).
Finally, teach branch.autoSetupMerge a new "inherit" option. When this
is set, "--track=inherit" becomes the default behavior.
[1]: https://lore.kernel.org/git/20180927221603.148025-1-sbeller@google.com/
Signed-off-by: Josh Steadmon <steadmon@google.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2021-12-21 04:30:23 +01:00
|
|
|
The exact upstream branch is chosen depending on the optional argument:
|
2022-01-20 13:35:54 +01:00
|
|
|
`-t`, `--track`, or `--track=direct` means to use the start-point branch
|
|
|
|
|
itself as the upstream; `--track=inherit` means to copy the upstream
|
|
|
|
|
configuration of the start-point branch.
|
branch: add flags and config to inherit tracking
It can be helpful when creating a new branch to use the existing
tracking configuration from the branch point. However, there is
currently not a method to automatically do so.
Teach git-{branch,checkout,switch} an "inherit" argument to the
"--track" option. When this is set, creating a new branch will cause the
tracking configuration to default to the configuration of the branch
point, if set.
For example, if branch "main" tracks "origin/main", and we run
`git checkout --track=inherit -b feature main`, then branch "feature"
will track "origin/main". Thus, `git status` will show us how far
ahead/behind we are from origin, and `git pull` will pull from origin.
This is particularly useful when creating branches across many
submodules, such as with `git submodule foreach ...` (or if running with
a patch such as [1], which we use at $job), as it avoids having to
manually set tracking info for each submodule.
Since we've added an argument to "--track", also add "--track=direct" as
another way to explicitly get the original "--track" behavior ("--track"
without an argument still works as well).
Finally, teach branch.autoSetupMerge a new "inherit" option. When this
is set, "--track=inherit" becomes the default behavior.
[1]: https://lore.kernel.org/git/20180927221603.148025-1-sbeller@google.com/
Signed-off-by: Josh Steadmon <steadmon@google.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2021-12-21 04:30:23 +01:00
|
|
|
+
|
branch: new autosetupmerge option 'simple' for matching branches
With the default push.default option, "simple", beginners are
protected from accidentally pushing to the "wrong" branch in
centralized workflows: if the remote tracking branch they would push
to does not have the same name as the local branch, and they try to do
a "default push", they get an error and explanation with options.
There is a particular centralized workflow where this often happens:
a user branches to a new local topic branch from an existing
remote branch, eg with "checkout -b feature1 origin/master". With
the default branch.autosetupmerge configuration (value "true"), git
will automatically add origin/master as the upstream tracking branch.
When the user pushes with a default "git push", with the intention of
pushing their (new) topic branch to the remote, they get an error, and
(amongst other things) a suggestion to run "git push origin HEAD".
If they follow this suggestion the push succeeds, but on subsequent
default pushes they continue to get an error - so eventually they
figure out to add "-u" to change the tracking branch, or they spelunk
the push.default config doc as proposed and set it to "current", or
some GUI tooling does one or the other of these things for them.
When one of their coworkers later works on the same topic branch,
they don't get any of that "weirdness". They just "git checkout
feature1" and everything works exactly as they expect, with the shared
remote branch set up as remote tracking branch, and push and pull
working out of the box.
The "stable state" for this way of working is that local branches have
the same-name remote tracking branch (origin/feature1 in this
example), and multiple people can work on that remote feature branch
at the same time, trusting "git pull" to merge or rebase as required
for them to be able to push their interim changes to that same feature
branch on that same remote.
(merging from the upstream "master" branch, and merging back to it,
are separate more involved processes in this flow).
There is a problem in this flow/way of working, however, which is that
the first user, when they first branched from origin/master, ended up
with the "wrong" remote tracking branch (different from the stable
state). For a while, before they pushed (and maybe longer, if they
don't use -u/--set-upstream), their "git pull" wasn't getting other
users' changes to the feature branch - it was getting any changes from
the remote "master" branch instead (a completely different class of
changes!)
An experienced git user might say "well yeah, that's what it means to
have the remote tracking branch set to origin/master!" - but the
original user above didn't *ask* to have the remote master branch
added as remote tracking branch - that just happened automatically
when they branched their feature branch. They didn't necessarily even
notice or understand the meaning of the "set up to track 'origin/master'"
message when they created the branch - especially if they are using a
GUI.
Looking at how to fix this, you might think "OK, so disable auto setup
of remote tracking - set branch.autosetupmerge to false" - but that
will inconvenience the *second* user in this story - the one who just
wanted to start working on the topic branch. The first and second
users swap roles at different points in time of course - they should
both have a sane configuration that does the right thing in both
situations.
Make this "branches have the same name locally as on the remote"
workflow less painful / more obvious by introducing a new
branch.autosetupmerge option called "simple", to match the same-name
"push.default" option that makes similar assumptions.
This new option automatically sets up tracking in a *subset* of the
current default situations: when the original ref is a remote tracking
branch *and* has the same branch name on the remote (as the new local
branch name).
Update the error displayed when the 'push.default=simple' configuration
rejects a mismatching-upstream-name default push, to offer this new
branch.autosetupmerge option that will prevent this class of error.
With this new configuration, in the example situation above, the first
user does *not* get origin/master set up as the tracking branch for
the new local branch. If they "git pull" in their new local-only
branch, they get an error explaining there is no upstream branch -
which makes sense and is helpful. If they "git push", they get an
error explaining how to push *and* suggesting they specify
--set-upstream - which is exactly the right thing to do for them.
This new option is likely not appropriate for users intentionally
implementing a "triangular workflow" with a shared upstream tracking
branch, that they "git pull" in and a "private" feature branch that
they push/force-push to just for remote safe-keeping until they are
ready to push up to the shared branch explicitly/separately. Such
users are likely to prefer keeping the current default
merge.autosetupmerge=true behavior, and change their push.default to
"current".
Also extend the existing branch tests with three new cases testing
this option - the obvious matching-name and non-matching-name cases,
and also a non-matching-ref-type case. The matching-name case needs to
temporarily create an independent repo to fetch from, as the general
strategy of using the local repo as the remote in these tests
precludes locally branching with the same name as in the "remote".
Signed-off-by: Tao Klerks <tao@klerks.biz>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2022-04-29 11:56:44 +02:00
|
|
|
The branch.autoSetupMerge configuration variable specifies how `git switch`,
|
|
|
|
|
`git checkout` and `git branch` should behave when neither `--track` nor
|
|
|
|
|
`--no-track` are specified:
|
|
|
|
|
+
|
|
|
|
|
The default option, `true`, behaves as though `--track=direct`
|
|
|
|
|
were given whenever the start-point is a remote-tracking branch.
|
|
|
|
|
`false` behaves as if `--no-track` were given. `always` behaves as though
|
|
|
|
|
`--track=direct` were given. `inherit` behaves as though `--track=inherit`
|
|
|
|
|
were given. `simple` behaves as though `--track=direct` were given only when
|
|
|
|
|
the start-point is a remote-tracking branch and the new branch has the same
|
|
|
|
|
name as the remote branch.
|
branch: add flags and config to inherit tracking
It can be helpful when creating a new branch to use the existing
tracking configuration from the branch point. However, there is
currently not a method to automatically do so.
Teach git-{branch,checkout,switch} an "inherit" argument to the
"--track" option. When this is set, creating a new branch will cause the
tracking configuration to default to the configuration of the branch
point, if set.
For example, if branch "main" tracks "origin/main", and we run
`git checkout --track=inherit -b feature main`, then branch "feature"
will track "origin/main". Thus, `git status` will show us how far
ahead/behind we are from origin, and `git pull` will pull from origin.
This is particularly useful when creating branches across many
submodules, such as with `git submodule foreach ...` (or if running with
a patch such as [1], which we use at $job), as it avoids having to
manually set tracking info for each submodule.
Since we've added an argument to "--track", also add "--track=direct" as
another way to explicitly get the original "--track" behavior ("--track"
without an argument still works as well).
Finally, teach branch.autoSetupMerge a new "inherit" option. When this
is set, "--track=inherit" becomes the default behavior.
[1]: https://lore.kernel.org/git/20180927221603.148025-1-sbeller@google.com/
Signed-off-by: Josh Steadmon <steadmon@google.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2021-12-21 04:30:23 +01:00
|
|
|
+
|
|
|
|
|
See linkgit:git-pull[1] and linkgit:git-config[1] for additional discussion on
|
|
|
|
|
how the `branch.<name>.remote` and `branch.<name>.merge` options are used.
|
2007-10-03 01:33:30 +02:00
|
|
|
|
|
|
|
|
--no-track::
|
2009-04-13 13:11:56 +02:00
|
|
|
Do not set up "upstream" configuration, even if the
|
branch: add flags and config to inherit tracking
It can be helpful when creating a new branch to use the existing
tracking configuration from the branch point. However, there is
currently not a method to automatically do so.
Teach git-{branch,checkout,switch} an "inherit" argument to the
"--track" option. When this is set, creating a new branch will cause the
tracking configuration to default to the configuration of the branch
point, if set.
For example, if branch "main" tracks "origin/main", and we run
`git checkout --track=inherit -b feature main`, then branch "feature"
will track "origin/main". Thus, `git status` will show us how far
ahead/behind we are from origin, and `git pull` will pull from origin.
This is particularly useful when creating branches across many
submodules, such as with `git submodule foreach ...` (or if running with
a patch such as [1], which we use at $job), as it avoids having to
manually set tracking info for each submodule.
Since we've added an argument to "--track", also add "--track=direct" as
another way to explicitly get the original "--track" behavior ("--track"
without an argument still works as well).
Finally, teach branch.autoSetupMerge a new "inherit" option. When this
is set, "--track=inherit" becomes the default behavior.
[1]: https://lore.kernel.org/git/20180927221603.148025-1-sbeller@google.com/
Signed-off-by: Josh Steadmon <steadmon@google.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2021-12-21 04:30:23 +01:00
|
|
|
branch.autoSetupMerge configuration variable is set.
|
2007-10-03 01:33:30 +02:00
|
|
|
|
branch: add --recurse-submodules option for branch creation
To improve the submodules UX, we would like to teach Git to handle
branches in submodules. Start this process by teaching "git branch" the
--recurse-submodules option so that "git branch --recurse-submodules
topic" will create the `topic` branch in the superproject and its
submodules.
Although this commit does not introduce breaking changes, it does not
work well with existing --recurse-submodules commands because "git
branch --recurse-submodules" writes to the submodule ref store, but most
commands only consider the superproject gitlink and ignore the submodule
ref store. For example, "git checkout --recurse-submodules" will check
out the commits in the superproject gitlinks (and put the submodules in
detached HEAD) instead of checking out the submodule branches.
Because of this, this commit introduces a new configuration value,
`submodule.propagateBranches`. The plan is for Git commands to
prioritize submodule ref store information over superproject gitlinks if
this value is true. Because "git branch --recurse-submodules" writes to
submodule ref stores, for the sake of clarity, it will not function
unless this configuration value is set.
This commit also includes changes that support working with submodules
from a superproject commit because "branch --recurse-submodules" (and
future commands) need to read .gitmodules and gitlinks from the
superproject commit, but submodules are typically read from the
filesystem's .gitmodules and the index's gitlinks. These changes are:
* add a submodules_of_tree() helper that gives the relevant
information of an in-tree submodule (e.g. path and oid) and
initializes the repository
* add is_tree_submodule_active() by adding a treeish_name parameter to
is_submodule_active()
* add the "submoduleNotUpdated" advice to advise users to update the
submodules in their trees
Incidentally, fix an incorrect usage string that combined the 'list'
usage of git branch (-l) with the 'create' usage; this string has been
incorrect since its inception, a8dfd5eac4 (Make builtin-branch.c use
parse_options., 2007-10-07).
Helped-by: Jonathan Tan <jonathantanmy@google.com>
Signed-off-by: Glen Choo <chooglen@google.com>
Reviewed-by: Jonathan Tan <jonathantanmy@google.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2022-01-29 01:04:45 +01:00
|
|
|
--recurse-submodules::
|
|
|
|
|
THIS OPTION IS EXPERIMENTAL! Causes the current command to
|
|
|
|
|
recurse into submodules if `submodule.propagateBranches` is
|
|
|
|
|
enabled. See `submodule.propagateBranches` in
|
|
|
|
|
linkgit:git-config[1]. Currently, only branch creation is
|
|
|
|
|
supported.
|
|
|
|
|
+
|
|
|
|
|
When used in branch creation, a new branch <branchname> will be created
|
|
|
|
|
in the superproject and all of the submodules in the superproject's
|
|
|
|
|
<start-point>. In submodules, the branch will point to the submodule
|
|
|
|
|
commit in the superproject's <start-point> but the branch's tracking
|
|
|
|
|
information will be set up based on the submodule's branches and remotes
|
|
|
|
|
e.g. `git branch --recurse-submodules topic origin/main` will create the
|
|
|
|
|
submodule branch "topic" that points to the submodule commit in the
|
|
|
|
|
superproject's "origin/main", but tracks the submodule's "origin/main".
|
|
|
|
|
|
2010-01-18 21:44:11 +01:00
|
|
|
--set-upstream::
|
2017-08-17 04:54:24 +02:00
|
|
|
As this option had confusing syntax, it is no longer supported.
|
|
|
|
|
Please use `--track` or `--set-upstream-to` instead.
|
2010-01-18 21:44:11 +01:00
|
|
|
|
2012-08-20 15:47:38 +02:00
|
|
|
-u <upstream>::
|
|
|
|
|
--set-upstream-to=<upstream>::
|
|
|
|
|
Set up <branchname>'s tracking information so <upstream> is
|
|
|
|
|
considered <branchname>'s upstream branch. If no <branchname>
|
|
|
|
|
is specified, then it defaults to the current branch.
|
|
|
|
|
|
2012-08-30 19:23:12 +02:00
|
|
|
--unset-upstream::
|
|
|
|
|
Remove the upstream information for <branchname>. If no branch
|
|
|
|
|
is specified it defaults to the current branch.
|
|
|
|
|
|
2011-09-21 00:10:08 +02:00
|
|
|
--edit-description::
|
|
|
|
|
Open an editor and edit the text to explain what the branch is
|
2015-09-14 16:10:53 +02:00
|
|
|
for, to be used by various other commands (e.g. `format-patch`,
|
|
|
|
|
`request-pull`, and `merge` (if enabled)). Multi-line explanations
|
|
|
|
|
may be used.
|
2011-09-21 00:10:08 +02:00
|
|
|
|
2012-03-06 10:32:45 +01:00
|
|
|
--contains [<commit>]::
|
|
|
|
|
Only list branches which contain the specified commit (HEAD
|
2013-01-31 07:46:11 +01:00
|
|
|
if not specified). Implies `--list`.
|
2008-04-18 00:27:08 +02:00
|
|
|
|
ref-filter: add --no-contains option to tag/branch/for-each-ref
Change the tag, branch & for-each-ref commands to have a --no-contains
option in addition to their longstanding --contains options.
This allows for finding the last-good rollout tag given a known-bad
<commit>. Given a hypothetically bad commit cf5c7253e0, the git
version to revert to can be found with this hacky two-liner:
(git tag -l 'v[0-9]*'; git tag -l --contains cf5c7253e0 'v[0-9]*') |
sort | uniq -c | grep -E '^ *1 ' | awk '{print $2}' | tail -n 10
With this new --no-contains option the same can be achieved with:
git tag -l --no-contains cf5c7253e0 'v[0-9]*' | sort | tail -n 10
As the filtering machinery is shared between the tag, branch &
for-each-ref commands, implement this for those commands too. A
practical use for this with "branch" is e.g. finding branches which
were branched off between v2.8.0 and v2.10.0:
git branch --contains v2.8.0 --no-contains v2.10.0
The "describe" command also has a --contains option, but its semantics
are unrelated to what tag/branch/for-each-ref use --contains for. A
--no-contains option for "describe" wouldn't make any sense, other
than being exactly equivalent to not supplying --contains at all,
which would be confusing at best.
Add a --without option to "tag" as an alias for --no-contains, for
consistency with --with and --contains. The --with option is
undocumented, and possibly the only user of it is
Junio (<xmqqefy71iej.fsf@gitster.mtv.corp.google.com>). But it's
trivial to support, so let's do that.
The additions to the the test suite are inverse copies of the
corresponding --contains tests. With this change --no-contains for
tag, branch & for-each-ref is just as well tested as the existing
--contains option.
In addition to those tests, add a test for "tag" which asserts that
--no-contains won't find tree/blob tags, which is slightly
unintuitive, but consistent with how --contains works & is documented.
Signed-off-by: Ævar Arnfjörð Bjarmason <avarab@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2017-03-24 19:40:57 +01:00
|
|
|
--no-contains [<commit>]::
|
|
|
|
|
Only list branches which don't contain the specified commit
|
|
|
|
|
(HEAD if not specified). Implies `--list`.
|
|
|
|
|
|
2009-10-09 12:18:58 +02:00
|
|
|
--merged [<commit>]::
|
|
|
|
|
Only list branches whose tips are reachable from the
|
2020-09-16 04:08:40 +02:00
|
|
|
specified commit (HEAD if not specified). Implies `--list`.
|
2008-04-18 00:27:08 +02:00
|
|
|
|
2009-10-09 12:18:58 +02:00
|
|
|
--no-merged [<commit>]::
|
|
|
|
|
Only list branches whose tips are not reachable from the
|
2020-09-16 04:08:40 +02:00
|
|
|
specified commit (HEAD if not specified). Implies `--list`.
|
2008-04-18 00:27:08 +02:00
|
|
|
|
2005-08-27 03:18:48 +02:00
|
|
|
<branchname>::
|
2005-11-14 17:53:42 +01:00
|
|
|
The name of the branch to create or delete.
|
2006-05-21 03:54:46 +02:00
|
|
|
The new branch name must pass all checks defined by
|
2007-12-29 07:20:38 +01:00
|
|
|
linkgit:git-check-ref-format[1]. Some of these checks
|
2006-05-21 03:54:46 +02:00
|
|
|
may restrict the characters allowed in a branch name.
|
2005-08-23 10:49:47 +02:00
|
|
|
|
2006-01-29 15:02:51 +01:00
|
|
|
<start-point>::
|
2009-10-09 20:34:08 +02:00
|
|
|
The new branch head will point to this commit. It may be
|
|
|
|
|
given as a branch name, a commit-id, or a tag. If this
|
|
|
|
|
option is omitted, the current HEAD will be used instead.
|
2006-04-28 15:15:04 +02:00
|
|
|
|
2006-11-28 15:47:40 +01:00
|
|
|
<oldbranch>::
|
|
|
|
|
The name of an existing branch to rename.
|
|
|
|
|
|
|
|
|
|
<newbranch>::
|
|
|
|
|
The new name for an existing branch. The same restrictions as for
|
2009-03-17 07:16:17 +01:00
|
|
|
<branchname> apply.
|
2005-08-23 10:49:47 +02:00
|
|
|
|
2015-09-23 20:11:12 +02:00
|
|
|
--sort=<key>::
|
|
|
|
|
Sort based on the key given. Prefix `-` to sort in descending
|
|
|
|
|
order of the value. You may use the --sort=<key> option
|
|
|
|
|
multiple times, in which case the last key becomes the primary
|
|
|
|
|
key. The keys supported are the same as those in `git
|
2018-08-16 11:35:08 +02:00
|
|
|
for-each-ref`. Sort order defaults to the value configured for the
|
|
|
|
|
`branch.sort` variable if exists, or to sorting based on the
|
2015-09-23 20:11:12 +02:00
|
|
|
full refname (including `refs/...` prefix). This lists
|
|
|
|
|
detached HEAD (if present) first, then local branches and
|
2018-08-16 11:35:08 +02:00
|
|
|
finally remote-tracking branches. See linkgit:git-config[1].
|
2015-09-23 20:11:12 +02:00
|
|
|
|
2005-12-13 08:24:06 +01:00
|
|
|
|
2015-09-23 20:11:13 +02:00
|
|
|
--points-at <object>::
|
|
|
|
|
Only list branches of the given object.
|
2005-12-13 08:24:06 +01:00
|
|
|
|
2017-01-10 09:49:53 +01:00
|
|
|
--format <format>::
|
2017-08-18 16:51:22 +02:00
|
|
|
A string that interpolates `%(fieldname)` from a branch ref being shown
|
|
|
|
|
and the object it points at. The format is the same as
|
2017-01-10 09:49:53 +01:00
|
|
|
that of linkgit:git-for-each-ref[1].
|
|
|
|
|
|
2017-11-19 16:03:49 +01:00
|
|
|
CONFIGURATION
|
|
|
|
|
-------------
|
|
|
|
|
`pager.branch` is only respected when listing branches, i.e., when
|
2017-11-19 16:03:50 +01:00
|
|
|
`--list` is used or implied. The default is to use a pager.
|
2017-11-19 16:03:49 +01:00
|
|
|
See linkgit:git-config[1].
|
|
|
|
|
|
docs: add CONFIGURATION sections that fuzzy map to built-ins
Add a CONFIGURATION section to the documentation of various built-ins,
for those cases where the relevant config/NAME.txt doesn't map only to
one git-NAME.txt. In particular:
* config/blame.txt: used by git-{blame,annotate}.txt. Since the
git-annotate(1) documentation refers to git-blame(1) don't add a
"CONFIGURATION" section to git-annotate(1), only to git-blame(1).
* config/checkout.txt: maps to both git-checkout.txt and
git-switch.txt (but nothing else).
* config/init.txt: should be included in git-init(1) and
git-clone(1).
* config/column.txt: We should ideally mention the relevant subset of
this in git-{branch,clean,status,tag}.txt, but let's punt on it for
now. We will when we eventually split these sort of files into
e.g. config/column.txt and
config/column/{branch,clean,status,tag}.txt, with the former
including the latter set.
Things that are being left out, and why:
* config/{remote,remotes,credential}.txt: Configuration that affects
how we talk to remote repositories is harder to untangle. We'll need
to include some of this in git-{fetch,remote,push,ls-remote}.txt
etc., but some of those only use a small subset of these
options. Let's leave this for now.
Signed-off-by: Ævar Arnfjörð Bjarmason <avarab@gmail.com>
Reviewed-by: Matheus Tavares <matheus.bernardino@usp.br>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2022-09-07 10:27:05 +02:00
|
|
|
include::includes/cmd-config-section-rest.txt[]
|
|
|
|
|
|
|
|
|
|
include::config/branch.txt[]
|
|
|
|
|
|
2018-04-30 17:35:33 +02:00
|
|
|
EXAMPLES
|
2006-04-28 15:15:04 +02:00
|
|
|
--------
|
2005-12-13 08:24:06 +01:00
|
|
|
|
2009-03-17 07:16:17 +01:00
|
|
|
Start development from a known tag::
|
2005-12-13 08:24:06 +01:00
|
|
|
+
|
|
|
|
|
------------
|
|
|
|
|
$ git clone git://git.kernel.org/pub/scm/.../linux-2.6 my2.6
|
|
|
|
|
$ cd my2.6
|
2006-04-28 15:15:04 +02:00
|
|
|
$ git branch my2.6.14 v2.6.14 <1>
|
2019-03-29 11:39:19 +01:00
|
|
|
$ git switch my2.6.14
|
2005-12-13 08:24:06 +01:00
|
|
|
------------
|
2006-04-28 15:15:04 +02:00
|
|
|
+
|
|
|
|
|
<1> This step and the next one could be combined into a single step with
|
2019-01-22 21:16:35 +01:00
|
|
|
"checkout -b my2.6.14 v2.6.14".
|
2005-12-13 08:24:06 +01:00
|
|
|
|
2009-03-17 07:16:17 +01:00
|
|
|
Delete an unneeded branch::
|
2005-12-13 08:24:06 +01:00
|
|
|
+
|
|
|
|
|
------------
|
|
|
|
|
$ git clone git://git.kernel.org/.../git.git my.git
|
|
|
|
|
$ cd my.git
|
2007-07-16 13:38:47 +02:00
|
|
|
$ git branch -d -r origin/todo origin/html origin/man <1>
|
|
|
|
|
$ git branch -D test <2>
|
2006-04-28 15:15:04 +02:00
|
|
|
------------
|
|
|
|
|
+
|
2009-03-17 07:16:17 +01:00
|
|
|
<1> Delete the remote-tracking branches "todo", "html" and "man". The next
|
2019-01-22 21:16:35 +01:00
|
|
|
'fetch' or 'pull' will create them again unless you configure them not to.
|
|
|
|
|
See linkgit:git-fetch[1].
|
2009-03-17 07:16:17 +01:00
|
|
|
<2> Delete the "test" branch even if the "master" branch (or whichever branch
|
2019-01-22 21:16:35 +01:00
|
|
|
is currently checked out) does not have all commits from the test branch.
|
2006-04-28 15:15:04 +02:00
|
|
|
|
2019-05-29 01:16:05 +02:00
|
|
|
Listing branches from a specific remote::
|
|
|
|
|
+
|
|
|
|
|
------------
|
|
|
|
|
$ git branch -r -l '<remote>/<pattern>' <1>
|
|
|
|
|
$ git for-each-ref 'refs/remotes/<remote>/<pattern>' <2>
|
|
|
|
|
------------
|
|
|
|
|
+
|
|
|
|
|
<1> Using `-a` would conflate <remote> with any local branches you happen to
|
|
|
|
|
have been prefixed with the same <remote> pattern.
|
|
|
|
|
<2> `for-each-ref` can take a wide range of options. See linkgit:git-for-each-ref[1]
|
|
|
|
|
|
|
|
|
|
Patterns will normally need quoting.
|
2006-04-28 15:15:04 +02:00
|
|
|
|
2018-04-30 17:35:33 +02:00
|
|
|
NOTES
|
2006-04-28 15:15:04 +02:00
|
|
|
-----
|
|
|
|
|
|
2019-03-29 11:39:19 +01:00
|
|
|
If you are creating a branch that you want to switch to immediately,
|
|
|
|
|
it is easier to use the "git switch" command with its `-c` option to
|
|
|
|
|
do the same thing with a single command.
|
2006-04-28 15:15:04 +02:00
|
|
|
|
ref-filter: add --no-contains option to tag/branch/for-each-ref
Change the tag, branch & for-each-ref commands to have a --no-contains
option in addition to their longstanding --contains options.
This allows for finding the last-good rollout tag given a known-bad
<commit>. Given a hypothetically bad commit cf5c7253e0, the git
version to revert to can be found with this hacky two-liner:
(git tag -l 'v[0-9]*'; git tag -l --contains cf5c7253e0 'v[0-9]*') |
sort | uniq -c | grep -E '^ *1 ' | awk '{print $2}' | tail -n 10
With this new --no-contains option the same can be achieved with:
git tag -l --no-contains cf5c7253e0 'v[0-9]*' | sort | tail -n 10
As the filtering machinery is shared between the tag, branch &
for-each-ref commands, implement this for those commands too. A
practical use for this with "branch" is e.g. finding branches which
were branched off between v2.8.0 and v2.10.0:
git branch --contains v2.8.0 --no-contains v2.10.0
The "describe" command also has a --contains option, but its semantics
are unrelated to what tag/branch/for-each-ref use --contains for. A
--no-contains option for "describe" wouldn't make any sense, other
than being exactly equivalent to not supplying --contains at all,
which would be confusing at best.
Add a --without option to "tag" as an alias for --no-contains, for
consistency with --with and --contains. The --with option is
undocumented, and possibly the only user of it is
Junio (<xmqqefy71iej.fsf@gitster.mtv.corp.google.com>). But it's
trivial to support, so let's do that.
The additions to the the test suite are inverse copies of the
corresponding --contains tests. With this change --no-contains for
tag, branch & for-each-ref is just as well tested as the existing
--contains option.
In addition to those tests, add a test for "tag" which asserts that
--no-contains won't find tree/blob tags, which is slightly
unintuitive, but consistent with how --contains works & is documented.
Signed-off-by: Ævar Arnfjörð Bjarmason <avarab@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2017-03-24 19:40:57 +01:00
|
|
|
The options `--contains`, `--no-contains`, `--merged` and `--no-merged`
|
|
|
|
|
serve four related but different purposes:
|
2008-04-18 00:27:08 +02:00
|
|
|
|
|
|
|
|
- `--contains <commit>` is used to find all branches which will need
|
|
|
|
|
special attention if <commit> were to be rebased or amended, since those
|
|
|
|
|
branches contain the specified <commit>.
|
|
|
|
|
|
ref-filter: add --no-contains option to tag/branch/for-each-ref
Change the tag, branch & for-each-ref commands to have a --no-contains
option in addition to their longstanding --contains options.
This allows for finding the last-good rollout tag given a known-bad
<commit>. Given a hypothetically bad commit cf5c7253e0, the git
version to revert to can be found with this hacky two-liner:
(git tag -l 'v[0-9]*'; git tag -l --contains cf5c7253e0 'v[0-9]*') |
sort | uniq -c | grep -E '^ *1 ' | awk '{print $2}' | tail -n 10
With this new --no-contains option the same can be achieved with:
git tag -l --no-contains cf5c7253e0 'v[0-9]*' | sort | tail -n 10
As the filtering machinery is shared between the tag, branch &
for-each-ref commands, implement this for those commands too. A
practical use for this with "branch" is e.g. finding branches which
were branched off between v2.8.0 and v2.10.0:
git branch --contains v2.8.0 --no-contains v2.10.0
The "describe" command also has a --contains option, but its semantics
are unrelated to what tag/branch/for-each-ref use --contains for. A
--no-contains option for "describe" wouldn't make any sense, other
than being exactly equivalent to not supplying --contains at all,
which would be confusing at best.
Add a --without option to "tag" as an alias for --no-contains, for
consistency with --with and --contains. The --with option is
undocumented, and possibly the only user of it is
Junio (<xmqqefy71iej.fsf@gitster.mtv.corp.google.com>). But it's
trivial to support, so let's do that.
The additions to the the test suite are inverse copies of the
corresponding --contains tests. With this change --no-contains for
tag, branch & for-each-ref is just as well tested as the existing
--contains option.
In addition to those tests, add a test for "tag" which asserts that
--no-contains won't find tree/blob tags, which is slightly
unintuitive, but consistent with how --contains works & is documented.
Signed-off-by: Ævar Arnfjörð Bjarmason <avarab@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2017-03-24 19:40:57 +01:00
|
|
|
- `--no-contains <commit>` is the inverse of that, i.e. branches that don't
|
|
|
|
|
contain the specified <commit>.
|
|
|
|
|
|
2008-04-18 00:27:08 +02:00
|
|
|
- `--merged` is used to find all branches which can be safely deleted,
|
|
|
|
|
since those branches are fully contained by HEAD.
|
|
|
|
|
|
|
|
|
|
- `--no-merged` is used to find branches which are candidates for merging
|
|
|
|
|
into HEAD, since those branches are not fully contained by HEAD.
|
2005-12-13 08:24:06 +01:00
|
|
|
|
2020-09-18 23:58:42 +02:00
|
|
|
include::ref-reachability-filters.txt[]
|
2020-09-16 04:08:39 +02:00
|
|
|
|
2009-08-22 02:45:18 +02:00
|
|
|
SEE ALSO
|
|
|
|
|
--------
|
|
|
|
|
linkgit:git-check-ref-format[1],
|
|
|
|
|
linkgit:git-fetch[1],
|
2009-10-09 20:34:08 +02:00
|
|
|
linkgit:git-remote[1],
|
|
|
|
|
link:user-manual.html#what-is-a-branch[``Understanding history: What is
|
|
|
|
|
a branch?''] in the Git User's Manual.
|
2009-08-22 02:45:18 +02:00
|
|
|
|
2005-08-23 10:49:47 +02:00
|
|
|
GIT
|
|
|
|
|
---
|
2008-06-06 09:07:32 +02:00
|
|
|
Part of the linkgit:git[1] suite
|