2005-09-08 08:26:23 +08:00
|
|
|
git-branch(1)
|
|
|
|
|
=============
|
2005-08-23 16:49:47 +08:00
|
|
|
|
|
|
|
|
NAME
|
|
|
|
|
----
|
2007-01-19 07:53:37 +08:00
|
|
|
git-branch - List, create, or delete branches
|
2005-08-23 16:49:47 +08:00
|
|
|
|
|
|
|
|
SYNOPSIS
|
|
|
|
|
--------
|
2006-03-18 08:24:37 +08:00
|
|
|
[verse]
|
2019-07-10 06:25:34 +08:00
|
|
|
'git branch' [--color[=<when>] | --no-color] [--show-current]
|
2020-11-05 06:01:37 +08:00
|
|
|
[-v [--abbrev=<n> | --no-abbrev]]
|
2017-03-25 02:40:58 +08:00
|
|
|
[--column[=<options>] | --no-column] [--sort=<key>]
|
2020-09-16 10:08:40 +08:00
|
|
|
[--merged [<commit>]] [--no-merged [<commit>]]
|
2020-06-24 22:46:31 +08:00
|
|
|
[--contains [<commit>]] [--no-contains [<commit>]]
|
2019-05-29 07:16:05 +08:00
|
|
|
[--points-at <object>] [--format=<format>]
|
|
|
|
|
[(-r | --remotes) | (-a | --all)]
|
|
|
|
|
[--list] [<pattern>...]
|
2018-08-31 04:04:53 +08:00
|
|
|
'git branch' [--track | --no-track] [-f] <branchname> [<start-point>]
|
2012-08-20 21:47:38 +08:00
|
|
|
'git branch' (--set-upstream-to=<upstream> | -u <upstream>) [<branchname>]
|
2012-08-31 01:23:12 +08:00
|
|
|
'git branch' --unset-upstream [<branchname>]
|
2008-06-30 14:09:04 +08: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-19 05:19:16 +08:00
|
|
|
'git branch' (-c | -C) [<oldbranch>] <newbranch>
|
2008-06-30 14:09:04 +08:00
|
|
|
'git branch' (-d | -D) [-r] <branchname>...
|
2011-09-21 06:10:08 +08:00
|
|
|
'git branch' --edit-description [<branchname>]
|
2005-08-23 16:49:47 +08:00
|
|
|
|
|
|
|
|
DESCRIPTION
|
|
|
|
|
-----------
|
2008-07-09 08:55:47 +08:00
|
|
|
|
2013-01-31 14:45:46 +08:00
|
|
|
If `--list` is given, or if there are no non-option arguments, existing
|
2019-04-29 13:19:43 +08: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 07:16:05 +08:00
|
|
|
and option `-a` shows both local and remote branches.
|
|
|
|
|
|
|
|
|
|
If a `<pattern>`
|
2013-01-31 14:45:46 +08: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 07:16:05 +08: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 14:45:46 +08:00
|
|
|
as branch creation.
|
2008-07-09 08:55:47 +08:00
|
|
|
|
2009-03-17 14:16:17 +08: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-25 02:40:58 +08: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 16:49:47 +08:00
|
|
|
|
2009-10-10 02:34:08 +08:00
|
|
|
The command's second form creates a new branch head named <branchname>
|
2019-04-27 20:02:22 +08: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 21:15:04 +08:00
|
|
|
|
2007-10-03 07:34:32 +08:00
|
|
|
Note that this will create the new branch, but it will not switch the
|
2019-03-29 18:39:19 +08:00
|
|
|
working tree to it; use "git switch <newbranch>" to switch to the
|
2007-10-03 07:34:32 +08:00
|
|
|
new branch.
|
|
|
|
|
|
2013-01-22 03:17:53 +08:00
|
|
|
When a local branch is started off a remote-tracking branch, Git sets up the
|
2013-09-09 04:58:13 +08:00
|
|
|
branch (specifically the `branch.<name>.remote` and `branch.<name>.merge`
|
|
|
|
|
configuration entries) so that 'git pull' will appropriately merge from
|
2010-11-02 23:31:24 +08:00
|
|
|
the remote-tracking branch. This behavior may be changed via the global
|
2015-03-12 04:32:45 +08:00
|
|
|
`branch.autoSetupMerge` configuration flag. That setting can be
|
2010-11-02 23:31:28 +08:00
|
|
|
overridden by using the `--track` and `--no-track` options, and
|
2012-08-20 21:47:38 +08:00
|
|
|
changed later using `git branch --set-upstream-to`.
|
2007-03-08 17:58:35 +08:00
|
|
|
|
2012-03-06 17:32:43 +08:00
|
|
|
With a `-m` or `-M` option, <oldbranch> will be renamed to <newbranch>.
|
2006-11-28 22:47:40 +08: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-19 05:19:16 +08:00
|
|
|
The `-c` and `-C` options have the exact same semantics as `-m` and
|
2021-02-04 05:07:32 +08: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-19 05:19:16 +08:00
|
|
|
|
2006-04-28 21:15:04 +08:00
|
|
|
With a `-d` or `-D` option, `<branchname>` will be deleted. You may
|
2006-05-19 17:16:58 +08:00
|
|
|
specify more than one branch for deletion. If the branch currently
|
2007-11-18 03:51:44 +08:00
|
|
|
has a reflog then the reflog will also be deleted.
|
|
|
|
|
|
2012-03-06 17:32:43 +08:00
|
|
|
Use `-r` together with `-d` to delete remote-tracking branches. Note, that it
|
2007-11-18 03:51:44 +08:00
|
|
|
only makes sense to delete remote-tracking branches if they no longer exist
|
2010-01-10 07:33:00 +08:00
|
|
|
in the remote repository or if 'git fetch' was configured not to fetch
|
2009-03-17 14:16:17 +08: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 08:24:37 +08:00
|
|
|
|
|
|
|
|
|
2005-08-23 16:49:47 +08:00
|
|
|
OPTIONS
|
|
|
|
|
-------
|
2005-11-15 00:53:42 +08:00
|
|
|
-d::
|
2011-08-28 22:54:30 +08:00
|
|
|
--delete::
|
2010-04-15 15:25:38 +08: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 15:46:43 +08:00
|
|
|
`--track` or `--set-upstream-to`.
|
2005-11-15 00:53:42 +08:00
|
|
|
|
|
|
|
|
-D::
|
2015-07-02 22:07:21 +08:00
|
|
|
Shortcut for `--delete --force`.
|
2005-11-15 00:53:42 +08:00
|
|
|
|
2011-08-28 22:54:30 +08:00
|
|
|
--create-reflog::
|
2007-07-02 13:28:20 +08:00
|
|
|
Create the branch's reflog. This activates recording of
|
|
|
|
|
all changes made to the branch ref, enabling use of date
|
2007-07-02 13:24:59 +08:00
|
|
|
based sha1 expressions such as "<branchname>@\{yesterday}".
|
2010-04-09 03:49:08 +08:00
|
|
|
Note that in non-bare repositories, reflogs are usually
|
2017-09-23 12:56:17 +08:00
|
|
|
enabled by default by the `core.logAllRefUpdates` config option.
|
2017-02-02 06:07:27 +08:00
|
|
|
The negated form `--no-create-reflog` only overrides an earlier
|
|
|
|
|
`--create-reflog`, but currently does not negate the setting of
|
2017-09-23 12:56:17 +08:00
|
|
|
`core.logAllRefUpdates`.
|
2006-05-19 17:16:58 +08:00
|
|
|
|
2006-01-29 22:02:51 +08:00
|
|
|
-f::
|
2009-08-29 17:05:00 +08:00
|
|
|
--force::
|
2017-10-18 10:34:31 +08:00
|
|
|
Reset <branchname> to <startpoint>, even if <branchname> exists
|
|
|
|
|
already. Without `-f`, 'git branch' refuses to change an existing branch.
|
2015-07-02 22:07:20 +08:00
|
|
|
In combination with `-d` (or `--delete`), allow deleting the
|
2021-08-28 02:35:35 +08:00
|
|
|
branch irrespective of its merged status, or whether it even
|
|
|
|
|
points to a valid commit. In combination with
|
2015-07-02 22:07:20 +08: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-19 05:19:16 +08:00
|
|
|
branch name already exists, the same applies for `-c` (or `--copy`).
|
2006-04-28 21:15:04 +08:00
|
|
|
|
2006-11-28 22:47:40 +08:00
|
|
|
-m::
|
2011-08-28 22:54:30 +08:00
|
|
|
--move::
|
2006-11-28 22:47:40 +08:00
|
|
|
Move/rename a branch and the corresponding reflog.
|
|
|
|
|
|
|
|
|
|
-M::
|
2015-07-02 22:07:21 +08:00
|
|
|
Shortcut for `--move --force`.
|
2006-11-28 22:47:40 +08: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-19 05:19:16 +08:00
|
|
|
-c::
|
|
|
|
|
--copy::
|
|
|
|
|
Copy a branch and the corresponding reflog.
|
|
|
|
|
|
|
|
|
|
-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 12:55:58 +08:00
|
|
|
--color[=<when>]::
|
2010-11-02 23:31:24 +08: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 12:55:58 +08:00
|
|
|
The value must be always (the default), never, or auto.
|
2007-01-03 23:36:29 +08: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 12:55:58 +08:00
|
|
|
Same as `--color=never`.
|
2007-01-03 23:36:29 +08:00
|
|
|
|
2016-12-04 10:52:25 +08:00
|
|
|
-i::
|
|
|
|
|
--ignore-case::
|
|
|
|
|
Sorting and filtering branches are case insensitive.
|
|
|
|
|
|
2012-04-13 18:54:38 +08:00
|
|
|
--column[=<options>]::
|
|
|
|
|
--no-column::
|
|
|
|
|
Display branch listing in columns. See configuration variable
|
2021-02-20 10:44:05 +08:00
|
|
|
`column.branch` for option syntax. `--column` and `--no-column`
|
2012-04-13 18:54:38 +08:00
|
|
|
without options are equivalent to 'always' and 'never' respectively.
|
|
|
|
|
+
|
|
|
|
|
This option is only applicable in non-verbose mode.
|
|
|
|
|
|
2006-04-28 21:15:04 +08:00
|
|
|
-r::
|
2011-08-28 22:54:30 +08:00
|
|
|
--remotes::
|
2006-12-21 12:18:07 +08:00
|
|
|
List or delete (if used with -d) the remote-tracking branches.
|
2019-05-29 07:16:05 +08:00
|
|
|
Combine with `--list` to match the optional pattern(s).
|
2006-11-22 03:31:24 +08:00
|
|
|
|
|
|
|
|
-a::
|
2011-08-28 22:54:30 +08:00
|
|
|
--all::
|
2006-11-22 03:31:24 +08:00
|
|
|
List both remote-tracking branches and local branches.
|
2019-05-29 07:16:05 +08:00
|
|
|
Combine with `--list` to match optional pattern(s).
|
2006-01-29 22:02:51 +08:00
|
|
|
|
2018-06-22 17:24:59 +08:00
|
|
|
-l::
|
2011-08-28 22:54:31 +08:00
|
|
|
--list::
|
2017-03-24 12:17:00 +08:00
|
|
|
List branches. With optional `<pattern>...`, e.g. `git
|
|
|
|
|
branch --list 'maint-*'`, list only the branches that match
|
|
|
|
|
the pattern(s).
|
2011-08-28 22:54:31 +08:00
|
|
|
|
2018-10-26 03:04:21 +08:00
|
|
|
--show-current::
|
|
|
|
|
Print the name of the current branch. In detached HEAD state,
|
|
|
|
|
nothing is printed.
|
|
|
|
|
|
2008-06-08 09:36:09 +08:00
|
|
|
-v::
|
2012-09-19 07:25:34 +08:00
|
|
|
-vv::
|
2008-06-08 09:36:09 +08:00
|
|
|
--verbose::
|
2011-09-09 05:09:50 +08:00
|
|
|
When in list mode,
|
|
|
|
|
show sha1 and commit subject line for each head, along with
|
2009-04-07 15:16:56 +08:00
|
|
|
relationship to upstream branch (if any). If given twice, print
|
2019-04-29 13:19:44 +08: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 21:45:10 +08:00
|
|
|
|
2012-03-27 07:51:06 +08:00
|
|
|
-q::
|
|
|
|
|
--quiet::
|
|
|
|
|
Be more quiet when creating or deleting a branch, suppressing
|
|
|
|
|
non-error messages.
|
|
|
|
|
|
2020-11-05 06:01:37 +08: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 14:06:08 +08:00
|
|
|
The default value is 7 and can be overridden by the `core.abbrev`
|
|
|
|
|
config option.
|
2006-11-24 21:45:10 +08:00
|
|
|
|
2007-03-03 08:31:17 +08:00
|
|
|
--no-abbrev::
|
2009-03-17 14:16:17 +08:00
|
|
|
Display the full sha1s in the output listing rather than abbreviating them.
|
2007-03-03 08:31:17 +08:00
|
|
|
|
2009-04-28 23:21:20 +08:00
|
|
|
-t::
|
2007-10-03 07:33:30 +08:00
|
|
|
--track::
|
2013-09-09 04:58:13 +08:00
|
|
|
When creating a new branch, set up `branch.<name>.remote` and
|
|
|
|
|
`branch.<name>.merge` configuration entries to mark the
|
2009-04-13 19:11:56 +08:00
|
|
|
start-point branch as "upstream" from the new branch. This
|
|
|
|
|
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.
|
|
|
|
|
+
|
2010-11-02 23:31:24 +08:00
|
|
|
This behavior is the default when the start point is a remote-tracking branch.
|
2015-03-12 04:32:45 +08:00
|
|
|
Set the branch.autoSetupMerge configuration variable to `false` if you
|
2019-03-29 18:39:19 +08:00
|
|
|
want `git switch`, `git checkout` and `git branch` to always behave as if `--no-track`
|
2009-04-13 19:11:56 +08:00
|
|
|
were given. Set it to `always` if you want this behavior when the
|
2010-11-02 23:31:24 +08:00
|
|
|
start-point is either a local or remote-tracking branch.
|
2007-10-03 07:33:30 +08:00
|
|
|
|
|
|
|
|
--no-track::
|
2009-04-13 19:11:56 +08:00
|
|
|
Do not set up "upstream" configuration, even if the
|
2015-03-12 04:32:45 +08:00
|
|
|
branch.autoSetupMerge configuration variable is true.
|
2007-10-03 07:33:30 +08:00
|
|
|
|
2010-01-19 04:44:11 +08:00
|
|
|
--set-upstream::
|
2017-08-17 10:54:24 +08:00
|
|
|
As this option had confusing syntax, it is no longer supported.
|
|
|
|
|
Please use `--track` or `--set-upstream-to` instead.
|
2010-01-19 04:44:11 +08:00
|
|
|
|
2012-08-20 21:47:38 +08: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-31 01:23:12 +08:00
|
|
|
--unset-upstream::
|
|
|
|
|
Remove the upstream information for <branchname>. If no branch
|
|
|
|
|
is specified it defaults to the current branch.
|
|
|
|
|
|
2011-09-21 06:10:08 +08:00
|
|
|
--edit-description::
|
|
|
|
|
Open an editor and edit the text to explain what the branch is
|
2015-09-14 22:10:53 +08: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 06:10:08 +08:00
|
|
|
|
2012-03-06 17:32:45 +08:00
|
|
|
--contains [<commit>]::
|
|
|
|
|
Only list branches which contain the specified commit (HEAD
|
2013-01-31 14:46:11 +08:00
|
|
|
if not specified). Implies `--list`.
|
2008-04-18 06:27:08 +08: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-25 02:40:57 +08:00
|
|
|
--no-contains [<commit>]::
|
|
|
|
|
Only list branches which don't contain the specified commit
|
|
|
|
|
(HEAD if not specified). Implies `--list`.
|
|
|
|
|
|
2009-10-09 18:18:58 +08:00
|
|
|
--merged [<commit>]::
|
|
|
|
|
Only list branches whose tips are reachable from the
|
2020-09-16 10:08:40 +08:00
|
|
|
specified commit (HEAD if not specified). Implies `--list`.
|
2008-04-18 06:27:08 +08:00
|
|
|
|
2009-10-09 18:18:58 +08:00
|
|
|
--no-merged [<commit>]::
|
|
|
|
|
Only list branches whose tips are not reachable from the
|
2020-09-16 10:08:40 +08:00
|
|
|
specified commit (HEAD if not specified). Implies `--list`.
|
2008-04-18 06:27:08 +08:00
|
|
|
|
2005-08-27 09:18:48 +08:00
|
|
|
<branchname>::
|
2005-11-15 00:53:42 +08:00
|
|
|
The name of the branch to create or delete.
|
2006-05-21 09:54:46 +08:00
|
|
|
The new branch name must pass all checks defined by
|
2007-12-29 14:20:38 +08:00
|
|
|
linkgit:git-check-ref-format[1]. Some of these checks
|
2006-05-21 09:54:46 +08:00
|
|
|
may restrict the characters allowed in a branch name.
|
2005-08-23 16:49:47 +08:00
|
|
|
|
2006-01-29 22:02:51 +08:00
|
|
|
<start-point>::
|
2009-10-10 02:34:08 +08: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 21:15:04 +08:00
|
|
|
|
2006-11-28 22:47:40 +08: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 14:16:17 +08:00
|
|
|
<branchname> apply.
|
2005-08-23 16:49:47 +08:00
|
|
|
|
2015-09-24 02:11:12 +08: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 17:35:08 +08: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-24 02:11:12 +08:00
|
|
|
full refname (including `refs/...` prefix). This lists
|
|
|
|
|
detached HEAD (if present) first, then local branches and
|
2018-08-16 17:35:08 +08:00
|
|
|
finally remote-tracking branches. See linkgit:git-config[1].
|
2015-09-24 02:11:12 +08:00
|
|
|
|
2005-12-13 15:24:06 +08:00
|
|
|
|
2015-09-24 02:11:13 +08:00
|
|
|
--points-at <object>::
|
|
|
|
|
Only list branches of the given object.
|
2005-12-13 15:24:06 +08:00
|
|
|
|
2017-01-10 16:49:53 +08:00
|
|
|
--format <format>::
|
2017-08-18 22:51:22 +08: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 16:49:53 +08:00
|
|
|
that of linkgit:git-for-each-ref[1].
|
|
|
|
|
|
2017-11-19 23:03:49 +08:00
|
|
|
CONFIGURATION
|
|
|
|
|
-------------
|
|
|
|
|
`pager.branch` is only respected when listing branches, i.e., when
|
2017-11-19 23:03:50 +08:00
|
|
|
`--list` is used or implied. The default is to use a pager.
|
2017-11-19 23:03:49 +08:00
|
|
|
See linkgit:git-config[1].
|
|
|
|
|
|
2018-04-30 23:35:33 +08:00
|
|
|
EXAMPLES
|
2006-04-28 21:15:04 +08:00
|
|
|
--------
|
2005-12-13 15:24:06 +08:00
|
|
|
|
2009-03-17 14:16:17 +08:00
|
|
|
Start development from a known tag::
|
2005-12-13 15:24:06 +08:00
|
|
|
+
|
|
|
|
|
------------
|
|
|
|
|
$ git clone git://git.kernel.org/pub/scm/.../linux-2.6 my2.6
|
|
|
|
|
$ cd my2.6
|
2006-04-28 21:15:04 +08:00
|
|
|
$ git branch my2.6.14 v2.6.14 <1>
|
2019-03-29 18:39:19 +08:00
|
|
|
$ git switch my2.6.14
|
2005-12-13 15:24:06 +08:00
|
|
|
------------
|
2006-04-28 21:15:04 +08:00
|
|
|
+
|
|
|
|
|
<1> This step and the next one could be combined into a single step with
|
2019-01-23 04:16:35 +08:00
|
|
|
"checkout -b my2.6.14 v2.6.14".
|
2005-12-13 15:24:06 +08:00
|
|
|
|
2009-03-17 14:16:17 +08:00
|
|
|
Delete an unneeded branch::
|
2005-12-13 15:24:06 +08:00
|
|
|
+
|
|
|
|
|
------------
|
|
|
|
|
$ git clone git://git.kernel.org/.../git.git my.git
|
|
|
|
|
$ cd my.git
|
2007-07-16 19:38:47 +08:00
|
|
|
$ git branch -d -r origin/todo origin/html origin/man <1>
|
|
|
|
|
$ git branch -D test <2>
|
2006-04-28 21:15:04 +08:00
|
|
|
------------
|
|
|
|
|
+
|
2009-03-17 14:16:17 +08:00
|
|
|
<1> Delete the remote-tracking branches "todo", "html" and "man". The next
|
2019-01-23 04:16:35 +08:00
|
|
|
'fetch' or 'pull' will create them again unless you configure them not to.
|
|
|
|
|
See linkgit:git-fetch[1].
|
2009-03-17 14:16:17 +08:00
|
|
|
<2> Delete the "test" branch even if the "master" branch (or whichever branch
|
2019-01-23 04:16:35 +08:00
|
|
|
is currently checked out) does not have all commits from the test branch.
|
2006-04-28 21:15:04 +08:00
|
|
|
|
2019-05-29 07:16:05 +08: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 21:15:04 +08:00
|
|
|
|
2018-04-30 23:35:33 +08:00
|
|
|
NOTES
|
2006-04-28 21:15:04 +08:00
|
|
|
-----
|
|
|
|
|
|
2019-03-29 18:39:19 +08: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 21:15:04 +08: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-25 02:40:57 +08:00
|
|
|
The options `--contains`, `--no-contains`, `--merged` and `--no-merged`
|
|
|
|
|
serve four related but different purposes:
|
2008-04-18 06:27:08 +08: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-25 02:40:57 +08:00
|
|
|
- `--no-contains <commit>` is the inverse of that, i.e. branches that don't
|
|
|
|
|
contain the specified <commit>.
|
|
|
|
|
|
2008-04-18 06:27:08 +08: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 15:24:06 +08:00
|
|
|
|
2020-09-19 05:58:42 +08:00
|
|
|
include::ref-reachability-filters.txt[]
|
2020-09-16 10:08:39 +08:00
|
|
|
|
2009-08-22 08:45:18 +08:00
|
|
|
SEE ALSO
|
|
|
|
|
--------
|
|
|
|
|
linkgit:git-check-ref-format[1],
|
|
|
|
|
linkgit:git-fetch[1],
|
2009-10-10 02:34:08 +08: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 08:45:18 +08:00
|
|
|
|
2005-08-23 16:49:47 +08:00
|
|
|
GIT
|
|
|
|
|
---
|
2008-06-06 15:07:32 +08:00
|
|
|
Part of the linkgit:git[1] suite
|
