kernel
/
git
mirror of https://git.kernel.org/pub/scm/git/git.git
1
0
Fork 0
Code Releases Activity

doc: apply new format to git-branch man page 

- Switch the synopsis to a synopsis block which automatically
  formats placeholders in italics and keywords in monospace
- Use _<placeholder>_ instead of <placeholder> in the description
- Use `backticks` for keywords and more complex option
descriptions. The new rendering engine applies synopsis rules to
these spans.

Possible values for some variables, that were mentioned in the description
prose, are now made into enumerated list.

Signed-off-by: Jean-Noël Avila <jn.avila@free.fr>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
maint
Jean-Noël Avila 2025-03-19 08:16:23 +00:00 committed by Junio C Hamano
parent e1b81f54da
commit 7b399322a2
2 changed files with 196 additions and 196 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

105
Documentation/config/branch.adoc
View File

@ -1,41 +1,42 @@
branch.autoSetupMerge:: `branch.autoSetupMerge`::
Tells 'git branch', 'git switch' and 'git checkout' to set up new branches Tells `git branch`, `git switch` and `git checkout` to set up new branches
so that linkgit:git-pull[1] will appropriately merge from the so that linkgit:git-pull[1] will appropriately merge from the
starting point branch. Note that even if this option is not set, starting point branch. Note that even if this option is not set,
this behavior can be chosen per-branch using the `--track` this behavior can be chosen per-branch using the `--track`
and `--no-track` options. The valid settings are: `false` -- no and `--no-track` options. This option defaults to `true`. The valid settings
automatic setup is done; `true` -- automatic setup is done when the are:
starting point is a remote-tracking branch; `always` -- `false`;; no automatic setup is done
automatic setup is done when the starting point is either a `true`;; automatic setup is done when the starting point is a remote-tracking branch
local branch or remote-tracking branch; `inherit` -- if the starting point `always`;; automatic setup is done when the starting point is either a
has a tracking configuration, it is copied to the new local branch or remote-tracking branch
branch; `simple` -- automatic setup is done only when the starting point `inherit`;; if the starting point has a tracking configuration, it is copied to the new
branch
`simple`;; automatic setup is done only when the starting point
is a remote-tracking branch and the new branch has the same name as the is a remote-tracking branch and the new branch has the same name as the
remote branch. This option defaults to true. remote branch.


branch.autoSetupRebase:: `branch.autoSetupRebase`::
When a new branch is created with 'git branch', 'git switch' or 'git checkout' When a new branch is created with `git branch`, `git switch` or `git checkout`
that tracks another branch, this variable tells Git to set that tracks another branch, this variable tells Git to set
up pull to rebase instead of merge (see "branch.<name>.rebase"). up pull to rebase instead of merge (see `branch.<name>.rebase`).
When `never`, rebase is never automatically set to true. The valid settings are:
When `local`, rebase is set to true for tracked branches of `never`;; rebase is never automatically set to true.
other local branches. `local`;; rebase is set to true for tracked branches of other local branches.
When `remote`, rebase is set to true for tracked branches of `remote`;; rebase is set to true for tracked branches of remote-tracking branches.
remote-tracking branches. `always`;; rebase will be set to true for all tracking branches.
When `always`, rebase will be set to true for all tracking
branches.
See "branch.autoSetupMerge" for details on how to set up a
branch to track another branch.
This option defaults to never.


branch.sort:: +
See `branch.autoSetupMerge` for details on how to set up a branch to track another branch.
This option defaults to `never`.

`branch.sort`::
This variable controls the sort ordering of branches when displayed by This variable controls the sort ordering of branches when displayed by
linkgit:git-branch[1]. Without the "--sort=<value>" option provided, the linkgit:git-branch[1]. Without the `--sort=<value>` option provided, the
value of this variable will be used as the default. value of this variable will be used as the default.
See linkgit:git-for-each-ref[1] field names for valid values. See linkgit:git-for-each-ref[1] field names for valid values.


branch.<name>.remote:: `branch.<name>.remote`::
When on branch <name>, it tells 'git fetch' and 'git push' When on branch _<name>_, it tells `git fetch` and `git push`
which remote to fetch from or push to. The remote to push to which remote to fetch from or push to. The remote to push to
may be overridden with `remote.pushDefault` (for all branches). may be overridden with `remote.pushDefault` (for all branches).
The remote to push to, for the current branch, may be further The remote to push to, for the current branch, may be further
@ -46,58 +47,58 @@ branch.<name>.remote::
Additionally, `.` (a period) is the current local repository Additionally, `.` (a period) is the current local repository
(a dot-repository), see `branch.<name>.merge`'s final note below. (a dot-repository), see `branch.<name>.merge`'s final note below.


branch.<name>.pushRemote:: `branch.<name>.pushRemote`::
When on branch <name>, it overrides `branch.<name>.remote` for When on branch _<name>_, it overrides `branch.<name>.remote` for
pushing. It also overrides `remote.pushDefault` for pushing pushing. It also overrides `remote.pushDefault` for pushing
from branch <name>. When you pull from one place (e.g. your from branch _<name>_. When you pull from one place (e.g. your
upstream) and push to another place (e.g. your own publishing upstream) and push to another place (e.g. your own publishing
repository), you would want to set `remote.pushDefault` to repository), you would want to set `remote.pushDefault` to
specify the remote to push to for all branches, and use this specify the remote to push to for all branches, and use this
option to override it for a specific branch. option to override it for a specific branch.


branch.<name>.merge:: `branch.<name>.merge`::
Defines, together with branch.<name>.remote, the upstream branch Defines, together with `branch.<name>.remote`, the upstream branch
for the given branch. It tells 'git fetch'/'git pull'/'git rebase' which for the given branch. It tells `git fetch`/`git pull`/`git rebase` which
branch to merge and can also affect 'git push' (see push.default). branch to merge and can also affect `git push` (see `push.default`).
When in branch <name>, it tells 'git fetch' the default When in branch _<name>_, it tells `git fetch` the default
refspec to be marked for merging in FETCH_HEAD. The value is refspec to be marked for merging in `FETCH_HEAD`. The value is
handled like the remote part of a refspec, and must match a handled like the remote part of a refspec, and must match a
ref which is fetched from the remote given by ref which is fetched from the remote given by
"branch.<name>.remote". `branch.<name>.remote`.
The merge information is used by 'git pull' (which first calls The merge information is used by `git pull` (which first calls
'git fetch') to lookup the default branch for merging. Without `git fetch`) to lookup the default branch for merging. Without
this option, 'git pull' defaults to merge the first refspec fetched. this option, `git pull` defaults to merge the first refspec fetched.
Specify multiple values to get an octopus merge. Specify multiple values to get an octopus merge.
If you wish to setup 'git pull' so that it merges into <name> from If you wish to setup `git pull` so that it merges into <name> from
another branch in the local repository, you can point another branch in the local repository, you can point
branch.<name>.merge to the desired branch, and use the relative path branch.<name>.merge to the desired branch, and use the relative path
setting `.` (a period) for branch.<name>.remote. setting `.` (a period) for `branch.<name>.remote`.


branch.<name>.mergeOptions:: `branch.<name>.mergeOptions`::
Sets default options for merging into branch <name>. The syntax and Sets default options for merging into branch _<name>_. The syntax and
supported options are the same as those of linkgit:git-merge[1], but supported options are the same as those of linkgit:git-merge[1], but
option values containing whitespace characters are currently not option values containing whitespace characters are currently not
supported. supported.


branch.<name>.rebase:: `branch.<name>.rebase`::
When true, rebase the branch <name> on top of the fetched branch, When true, rebase the branch _<name>_ on top of the fetched branch,
instead of merging the default branch from the default remote when instead of merging the default branch from the default remote when
"git pull" is run. See "pull.rebase" for doing this in a non `git pull` is run. See `pull.rebase` for doing this in a non
branch-specific manner. branch-specific manner.
+ +
When `merges` (or just 'm'), pass the `--rebase-merges` option to 'git rebase' When `merges` (or just `m`), pass the `--rebase-merges` option to `git rebase`
so that the local merge commits are included in the rebase (see so that the local merge commits are included in the rebase (see
linkgit:git-rebase[1] for details). linkgit:git-rebase[1] for details).
+ +
When the value is `interactive` (or just 'i'), the rebase is run in interactive When the value is `interactive` (or just `i`), the rebase is run in interactive
mode. mode.
+ +
*NOTE*: this is a possibly dangerous operation; do *not* use *NOTE*: this is a possibly dangerous operation; do *not* use
it unless you understand the implications (see linkgit:git-rebase[1] it unless you understand the implications (see linkgit:git-rebase[1]
for details). for details).


branch.<name>.description:: `branch.<name>.description`::
Branch description, can be edited with Branch description, can be edited with
`git branch --edit-description`. Branch description is `git branch --edit-description`. Branch description is
automatically added to the format-patch cover letter or automatically added to the `format-patch` cover letter or
request-pull summary. `request-pull` summary.

275
Documentation/git-branch.adoc
View File

@ -7,23 +7,23 @@ git-branch - List, create, or delete branches


SYNOPSIS SYNOPSIS
-------- --------
[verse] [synopsis]
'git branch' [--color[=<when>] | --no-color] [--show-current] git branch [--color[=<when>] | --no-color] [--show-current]
[-v [--abbrev=<n> | --no-abbrev]] [-v [--abbrev=<n> | --no-abbrev]]
[--column[=<options>] | --no-column] [--sort=<key>] [--column[=<options>] | --no-column] [--sort=<key>]
[--merged [<commit>]] [--no-merged [<commit>]] [--merged [<commit>]] [--no-merged [<commit>]]
[--contains [<commit>]] [--no-contains [<commit>]] [--contains [<commit>]] [--no-contains [<commit>]]
[--points-at <object>] [--format=<format>] [--points-at <object>] [--format=<format>]
[(-r | --remotes) | (-a | --all)] [(-r|--remotes) | (-a|--all)]
[--list] [<pattern>...] [--list] [<pattern>...]
'git branch' [--track[=(direct|inherit)] | --no-track] [-f] git branch [--track[=(direct|inherit)] | --no-track] [-f]
[--recurse-submodules] <branchname> [<start-point>] [--recurse-submodules] <branch-name> [<start-point>]
'git branch' (--set-upstream-to=<upstream> | -u <upstream>) [<branchname>] git branch (--set-upstream-to=<upstream>|-u <upstream>) [<branch-name>]
'git branch' --unset-upstream [<branchname>] git branch --unset-upstream [<branch-name>]
'git branch' (-m | -M) [<oldbranch>] <newbranch> git branch (-m|-M) [<old-branch>] <new-branch>
'git branch' (-c | -C) [<oldbranch>] <newbranch> git branch (-c|-C) [<old-branch>] <new-branch>
'git branch' (-d | -D) [-r] <branchname>... git branch (-d|-D) [-r] <branch-name>...
'git branch' --edit-description [<branchname>] git branch --edit-description [<branch-name>]


DESCRIPTION DESCRIPTION
----------- -----------
@ -49,173 +49,184 @@ With `--contains`, shows only the branches that contain the named commit
named commit), `--no-contains` inverts it. With `--merged`, only branches named commit), `--no-contains` inverts it. With `--merged`, only branches
merged into the named commit (i.e. the branches whose tip commits are 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 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> 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 argument is missing it defaults to `HEAD` (i.e. the tip of the current
branch). branch).


The command's second form creates a new branch head named <branchname> The command's second form creates a new branch head named _<branch-name>_
which points to the current `HEAD`, or <start-point> if given. As a 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 special case, for _<start-point>_, you may use `<rev-A>...<rev-B>` as a
the merge base of `A` and `B` if there is exactly one merge base. You shortcut for the merge base of _<rev-A>_ and _<rev-B>_ if there is exactly
can leave out at most one of `A` and `B`, in which case it defaults to one merge base. You can leave out at most one of _<rev-A>_ and _<rev-B>_,
`HEAD`. in which case it defaults to `HEAD`.


Note that this will create the new branch, but it will not switch the Note that this will create the new branch, but it will not switch the
working tree to it; use "git switch <newbranch>" to switch to the working tree to it; use `git switch <new-branch>` to switch to the
new branch. new branch.


When a local branch is started off a remote-tracking branch, Git sets up the When a local branch is started off a remote-tracking branch, Git sets up the
branch (specifically the `branch.<name>.remote` and `branch.<name>.merge` branch (specifically the `branch.<name>.remote` and `branch.<name>.merge`
configuration entries) so that 'git pull' will appropriately merge from configuration entries) so that `git pull` will appropriately merge from
the remote-tracking branch. This behavior may be changed via the global the remote-tracking branch. This behavior may be changed via the global
`branch.autoSetupMerge` configuration flag. That setting can be `branch.autoSetupMerge` configuration flag. That setting can be
overridden by using the `--track` and `--no-track` options, and overridden by using the `--track` and `--no-track` options, and
changed later using `git branch --set-upstream-to`. changed later using `git branch --set-upstream-to`.


With a `-m` or `-M` option, <oldbranch> will be renamed to <newbranch>. With a `-m` or `-M` option, _<old-branch>_ will be renamed to _<new-branch>_.
If <oldbranch> had a corresponding reflog, it is renamed to match If _<old-branch>_ had a corresponding reflog, it is renamed to match
<newbranch>, and a reflog entry is created to remember the branch _<new-branch>_, and a reflog entry is created to remember the branch
renaming. If <newbranch> exists, -M must be used to force the rename renaming. If _<new-branch>_ exists, `-M` must be used to force the rename
to happen. to happen.


The `-c` and `-C` options have the exact same semantics as `-m` and The `-c` and `-C` options have the exact same semantics as `-m` and
`-M`, except instead of the branch being renamed, it will be copied to a `-M`, except instead of the branch being renamed, it will be copied to a
new name, along with its config and reflog. new name, along with its config and reflog.


With a `-d` or `-D` option, `<branchname>` will be deleted. You may With a `-d` or `-D` option, _<branch-name>_ will be deleted. You may
specify more than one branch for deletion. If the branch currently specify more than one branch for deletion. If the branch currently
has a reflog then the reflog will also be deleted. has a reflog then the reflog will also be deleted.


Use `-r` together with `-d` to delete remote-tracking branches. Note, that it Use `-r` together with `-d` to delete remote-tracking branches. Note, that it
only makes sense to delete remote-tracking branches if they no longer exist only makes sense to delete remote-tracking branches if they no longer exist
in the remote repository or if 'git fetch' was configured not to fetch in the remote repository or if `git fetch` was configured not to fetch
them again. See also the 'prune' subcommand of linkgit:git-remote[1] for a them again. See also the `prune` subcommand of linkgit:git-remote[1] for a
way to clean up all obsolete remote-tracking branches. way to clean up all obsolete remote-tracking branches.




OPTIONS OPTIONS
------- -------
-d:: `-d`::
--delete:: `--delete`::
Delete a branch. The branch must be fully merged in its Delete a branch. The branch must be fully merged in its
upstream branch, or in `HEAD` if no upstream was set with upstream branch, or in `HEAD` if no upstream was set with
`--track` or `--set-upstream-to`. `--track` or `--set-upstream-to`.


-D:: `-D`::
Shortcut for `--delete --force`. Shortcut for `--delete --force`.


--create-reflog:: `--create-reflog`::
Create the branch's reflog. This activates recording of Create the branch's reflog. This activates recording of
all changes made to the branch ref, enabling use of date all changes made to the branch ref, enabling use of date
based sha1 expressions such as "<branchname>@\{yesterday}". based sha1 expressions such as `<branch-name>@{yesterday}`.
Note that in non-bare repositories, reflogs are usually Note that in non-bare repositories, reflogs are usually
enabled by default by the `core.logAllRefUpdates` config option. enabled by default by the `core.logAllRefUpdates` config option.
The negated form `--no-create-reflog` only overrides an earlier The negated form `--no-create-reflog` only overrides an earlier
`--create-reflog`, but currently does not negate the setting of `--create-reflog`, but currently does not negate the setting of
`core.logAllRefUpdates`. `core.logAllRefUpdates`.


-f:: `-f`::
--force:: `--force`::
Reset <branchname> to <start-point>, even if <branchname> exists Reset _<branch-name>_ to _<start-point>_, even if _<branch-name>_ exists
already. Without `-f`, 'git branch' refuses to change an existing branch. already. Without `-f`, `git branch` refuses to change an existing branch.
In combination with `-d` (or `--delete`), allow deleting the In combination with `-d` (or `--delete`), allow deleting the
branch irrespective of its merged status, or whether it even branch irrespective of its merged status, or whether it even
points to a valid commit. In combination with points to a valid commit. In combination with
`-m` (or `--move`), allow renaming the branch even if the new `-m` (or `--move`), allow renaming the branch even if the new
branch name already exists, the same applies for `-c` (or `--copy`). branch name already exists, the same applies for `-c` (or `--copy`).
+ +
Note that 'git branch -f <branchname> [<start-point>]', even with '-f', Note that `git branch -f <branch-name> [<start-point>]`, even with `-f`,
refuses to change an existing branch `<branchname>` that is checked out refuses to change an existing branch _<branch-name>_ that is checked out
in another worktree linked to the same repository. in another worktree linked to the same repository.


-m:: `-m`::
--move:: `--move`::
Move/rename a branch, together with its config and reflog. Move/rename a branch, together with its config and reflog.


-M:: `-M`::
Shortcut for `--move --force`. Shortcut for `--move --force`.


-c:: `-c`::
--copy:: `--copy`::
Copy a branch, together with its config and reflog. Copy a branch, together with its config and reflog.


-C:: `-C`::
Shortcut for `--copy --force`. Shortcut for `--copy --force`.


--color[=<when>]:: `--color[=<when>]`::
Color branches to highlight current, local, and Color branches to highlight current, local, and
remote-tracking branches. remote-tracking branches.
The value must be always (the default), never, or auto. The value must be `always` (the default), `never`, or `auto`.


--no-color:: `--no-color`::
Turn off branch colors, even when the configuration file gives the Turn off branch colors, even when the configuration file gives the
default to color output. default to color output.
Same as `--color=never`. Same as `--color=never`.


-i:: `-i`::
--ignore-case:: `--ignore-case`::
Sorting and filtering branches are case insensitive. Sorting and filtering branches are case insensitive.


--omit-empty:: `--omit-empty`::
Do not print a newline after formatted refs where the format expands Do not print a newline after formatted refs where the format expands
to the empty string. to the empty string.


--column[=<options>]:: `--column[=<options>]`::
--no-column:: `--no-column`::
Display branch listing in columns. See configuration variable Display branch listing in columns. See configuration variable
`column.branch` for option syntax. `--column` and `--no-column` `column.branch` for option syntax. `--column` and `--no-column`
without options are equivalent to 'always' and 'never' respectively. without options are equivalent to `always` and `never` respectively.
+ +
This option is only applicable in non-verbose mode. This option is only applicable in non-verbose mode.


-r:: `--sort=<key>`::
--remotes:: Sort based on _<key>_. Prefix `-` to sort in descending
List or delete (if used with -d) the remote-tracking branches. 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 linkgit:git-for-each-ref[1].
Sort order defaults to the value configured for the
`branch.sort` variable if it exists, or to sorting based on the
full refname (including `refs/...` prefix). This lists
detached `HEAD` (if present) first, then local branches and
finally remote-tracking branches. See linkgit:git-config[1].

`-r`::
`--remotes`::
List or delete (if used with `-d`) the remote-tracking branches.
Combine with `--list` to match the optional pattern(s). Combine with `--list` to match the optional pattern(s).


-a:: `-a`::
--all:: `--all`::
List both remote-tracking branches and local branches. List both remote-tracking branches and local branches.
Combine with `--list` to match optional pattern(s). Combine with `--list` to match optional pattern(s).


-l:: `-l`::
--list:: `--list`::
List branches. With optional `<pattern>...`, e.g. `git List branches. With optional `<pattern>...`, e.g. `git
branch --list 'maint-*'`, list only the branches that match branch --list 'maint-*'`, list only the branches that match
the pattern(s). the pattern(s).


--show-current:: `--show-current`::
Print the name of the current branch. In detached HEAD state, Print the name of the current branch. In detached `HEAD` state,
nothing is printed. nothing is printed.


-v:: `-v`::
-vv:: `-vv`::
--verbose:: `--verbose`::
When in list mode, When in list mode,
show sha1 and commit subject line for each head, along with show sha1 and commit subject line for each head, along with
relationship to upstream branch (if any). If given twice, print relationship to upstream branch (if any). If given twice, print
the path of the linked worktree (if any) and the name of the upstream 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 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 current worktree's `HEAD` will not have its path printed (it will always
be your current directory). be your current directory).


-q:: `-q`::
--quiet:: `--quiet`::
Be more quiet when creating or deleting a branch, suppressing Be more quiet when creating or deleting a branch, suppressing
non-error messages. non-error messages.


--abbrev=<n>:: `--abbrev=<n>`::
In the verbose listing that show the commit object name, In the verbose listing that show the commit object name,
show the shortest prefix that is at least '<n>' hexdigits show the shortest prefix that is at least _<n>_ hexdigits
long that uniquely refers the object. long that uniquely refers the object.
The default value is 7 and can be overridden by the `core.abbrev` The default value is 7 and can be overridden by the `core.abbrev`
config option. config option.


--no-abbrev:: `--no-abbrev`::
Display the full sha1s in the output listing rather than abbreviating them. Display the full sha1s in the output listing rather than abbreviating them.


-t:: `-t`::
--track[=(direct|inherit)]:: `--track[=(direct|inherit)]`::
When creating a new branch, set up `branch.<name>.remote` and When creating a new branch, set up `branch.<name>.remote` and
`branch.<name>.merge` configuration entries to set "upstream" tracking `branch.<name>.merge` configuration entries to set "upstream" tracking
configuration for the new branch. This configuration for the new branch. This
@ -229,7 +240,7 @@ The exact upstream branch is chosen depending on the optional argument:
itself as the upstream; `--track=inherit` means to copy the upstream itself as the upstream; `--track=inherit` means to copy the upstream
configuration of the start-point branch. configuration of the start-point branch.
+ +
The branch.autoSetupMerge configuration variable specifies how `git switch`, The `branch.autoSetupMerge` configuration variable specifies how `git switch`,
`git checkout` and `git branch` should behave when neither `--track` nor `git checkout` and `git branch` should behave when neither `--track` nor
`--no-track` are specified: `--no-track` are specified:
+ +
@ -238,106 +249,94 @@ were given whenever the start-point is a remote-tracking branch.
`false` behaves as if `--no-track` were given. `always` behaves as though `false` behaves as if `--no-track` were given. `always` behaves as though
`--track=direct` were given. `inherit` behaves as though `--track=inherit` `--track=direct` were given. `inherit` behaves as though `--track=inherit`
were given. `simple` behaves as though `--track=direct` were given only when 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 the _<start-point>_ is a remote-tracking branch and the new branch has the same
name as the remote branch. name as the remote branch.
+ +
See linkgit:git-pull[1] and linkgit:git-config[1] for additional discussion on 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. how the `branch.<name>.remote` and `branch.<name>.merge` options are used.


--no-track:: `--no-track`::
Do not set up "upstream" configuration, even if the Do not set up "upstream" configuration, even if the
branch.autoSetupMerge configuration variable is set. `branch.autoSetupMerge` configuration variable is set.


--recurse-submodules:: `--recurse-submodules`::
THIS OPTION IS EXPERIMENTAL! Causes the current command to THIS OPTION IS EXPERIMENTAL! Cause the current command to
recurse into submodules if `submodule.propagateBranches` is recurse into submodules if `submodule.propagateBranches` is
enabled. See `submodule.propagateBranches` in enabled. See `submodule.propagateBranches` in
linkgit:git-config[1]. Currently, only branch creation is linkgit:git-config[1]. Currently, only branch creation is
supported. supported.
+ +
When used in branch creation, a new branch <branchname> will be created When used in branch creation, a new branch _<branch-name>_ will be created
in the superproject and all of the submodules in the superproject's in the superproject and all of the submodules in the superproject's
<start-point>. In submodules, the branch will point to the submodule _<start-point>_. In submodules, the branch will point to the submodule
commit in the superproject's <start-point> but the branch's tracking 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 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 e.g. `git branch --recurse-submodules topic origin/main` will create the
submodule branch "topic" that points to the submodule commit in the submodule branch "topic" that points to the submodule commit in the
superproject's "origin/main", but tracks the submodule's "origin/main". superproject's "origin/main", but tracks the submodule's "origin/main".


--set-upstream:: `--set-upstream`::
As this option had confusing syntax, it is no longer supported. As this option had confusing syntax, it is no longer supported.
Please use `--track` or `--set-upstream-to` instead. Please use `--track` or `--set-upstream-to` instead.


-u <upstream>:: `-u <upstream>`::
--set-upstream-to=<upstream>:: `--set-upstream-to=<upstream>`::
Set up <branchname>'s tracking information so <upstream> is Set up _<branch-name>_'s tracking information so _<upstream>_ is
considered <branchname>'s upstream branch. If no <branchname> considered _<branch-name>_'s upstream branch. If no _<branch-name>_
is specified, then it defaults to the current branch. is specified, then it defaults to the current branch.


--unset-upstream:: `--unset-upstream`::
Remove the upstream information for <branchname>. If no branch Remove the upstream information for _<branch-name>_. If no branch
is specified it defaults to the current branch. is specified it defaults to the current branch.


--edit-description:: `--edit-description`::
Open an editor and edit the text to explain what the branch is Open an editor and edit the text to explain what the branch is
for, to be used by various other commands (e.g. `format-patch`, for, to be used by various other commands (e.g. `format-patch`,
`request-pull`, and `merge` (if enabled)). Multi-line explanations `request-pull`, and `merge` (if enabled)). Multi-line explanations
may be used. may be used.


--contains [<commit>]:: `--contains [<commit>]`::
Only list branches which contain the specified commit (HEAD Only list branches which contain _<commit>_ (`HEAD`
if not specified). Implies `--list`. if not specified). Implies `--list`.


--no-contains [<commit>]:: `--no-contains [<commit>]`::
Only list branches which don't contain the specified commit Only list branches which don't contain _<commit>_
(HEAD if not specified). Implies `--list`. (`HEAD` if not specified). Implies `--list`.


--merged [<commit>]:: `--merged [<commit>]`::
Only list branches whose tips are reachable from the Only list branches whose tips are reachable from
specified commit (HEAD if not specified). Implies `--list`. _<commit>_ (`HEAD` if not specified). Implies `--list`.


--no-merged [<commit>]:: `--no-merged [<commit>]`::
Only list branches whose tips are not reachable from the Only list branches whose tips are not reachable from
specified commit (HEAD if not specified). Implies `--list`. _<commit>_ (`HEAD` if not specified). Implies `--list`.


<branchname>:: `--points-at <object>`::
Only list branches of _<object>_.

`--format <format>`::
A string that interpolates `%(fieldname)` from a branch ref being shown
and the object it points at. _<format>_ is the same as
that of linkgit:git-for-each-ref[1].

_<branch-name>_::
The name of the branch to create or delete. The name of the branch to create or delete.
The new branch name must pass all checks defined by The new branch name must pass all checks defined by
linkgit:git-check-ref-format[1]. Some of these checks linkgit:git-check-ref-format[1]. Some of these checks
may restrict the characters allowed in a branch name. may restrict the characters allowed in a branch name.


<start-point>:: _<start-point>_::
The new branch head will point to this commit. It may be 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 given as a branch name, a commit-id, or a tag. If this
option is omitted, the current HEAD will be used instead. option is omitted, the current `HEAD` will be used instead.


<oldbranch>:: _<old-branch>_::
The name of an existing branch. If this option is omitted, The name of an existing branch. If this option is omitted,
the name of the current branch will be used instead. the name of the current branch will be used instead.


<newbranch>:: _<new-branch>_::
The new name for an existing branch. The same restrictions as for The new name for an existing branch. The same restrictions as for
<branchname> apply. _<branch-name>_ apply.

--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
for-each-ref`. Sort order defaults to the value configured for the
`branch.sort` variable if it exists, or to sorting based on the
full refname (including `refs/...` prefix). This lists
detached HEAD (if present) first, then local branches and
finally remote-tracking branches. See linkgit:git-config[1].


--points-at <object>::
Only list branches of the given object.

--format <format>::
A string that interpolates `%(fieldname)` from a branch ref being shown
and the object it points at. The format is the same as
that of linkgit:git-for-each-ref[1].


CONFIGURATION CONFIGURATION
------------- -------------
@ -374,7 +373,7 @@ $ git branch -D test <2>
------------ ------------
+ +
<1> Delete the remote-tracking branches "todo", "html" and "man". The next <1> Delete the remote-tracking branches "todo", "html" and "man". The next
'fetch' or 'pull' will create them again unless you configure them not to. `git fetch` or `git pullè will create them again unless you configure them not to.
See linkgit:git-fetch[1]. See linkgit:git-fetch[1].
<2> Delete the "test" branch even if the "master" branch (or whichever branch <2> Delete the "test" branch even if the "master" branch (or whichever branch
is currently checked out) does not have all commits from the test branch. is currently checked out) does not have all commits from the test branch.
@ -386,8 +385,8 @@ $ git branch -r -l '<remote>/<pattern>' <1>
$ git for-each-ref 'refs/remotes/<remote>/<pattern>' <2> $ git for-each-ref 'refs/remotes/<remote>/<pattern>' <2>
------------ ------------
+ +
<1> Using `-a` would conflate <remote> with any local branches you happen to <1> Using `-a` would conflate _<remote>_ with any local branches you happen to
have been prefixed with the same <remote> pattern. 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] <2> `for-each-ref` can take a wide range of options. See linkgit:git-for-each-ref[1]


Patterns will normally need quoting. Patterns will normally need quoting.
@ -396,24 +395,24 @@ NOTES
----- -----


If you are creating a branch that you want to switch to immediately, 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 it is easier to use the `git switch` command with its `-c` option to
do the same thing with a single command. do the same thing with a single command.


The options `--contains`, `--no-contains`, `--merged` and `--no-merged` The options `--contains`, `--no-contains`, `--merged` and `--no-merged`
serve four related but different purposes: serve four related but different purposes:


- `--contains <commit>` is used to find all branches which will need - `--contains <commit>` is used to find all branches which will need
special attention if <commit> were to be rebased or amended, since those special attention if _<commit>_ were to be rebased or amended, since those
branches contain the specified <commit>. branches contain the specified _<commit>_.


- `--no-contains <commit>` is the inverse of that, i.e. branches that don't - `--no-contains <commit>` is the inverse of that, i.e. branches that don't
contain the specified <commit>. contain the specified _<commit>_.


- `--merged` is used to find all branches which can be safely deleted, - `--merged` is used to find all branches which can be safely deleted,
since those branches are fully contained by HEAD. since those branches are fully contained by `HEAD`.


- `--no-merged` is used to find branches which are candidates for merging - `--no-merged` is used to find branches which are candidates for merging
into HEAD, since those branches are not fully contained by HEAD. into `HEAD`, since those branches are not fully contained by `HEAD`.


include::ref-reachability-filters.adoc[] include::ref-reachability-filters.adoc[]


@ -422,8 +421,8 @@ SEE ALSO
linkgit:git-check-ref-format[1], linkgit:git-check-ref-format[1],
linkgit:git-fetch[1], linkgit:git-fetch[1],
linkgit:git-remote[1], linkgit:git-remote[1],
link:user-manual.html#what-is-a-branch[``Understanding history: What is link:user-manual.html#what-is-a-branch["Understanding history: What is
a branch?''] in the Git User's Manual. a branch?"] in the Git User's Manual.


GIT GIT
--- ---