git-branch

原文： https://git-scm.com/docs/git-branch

名称

git-branch - 列出，创建或删除分支

概要

  1. git branch [--color[=<when>] | --no-color] [-r | -a]
  2.     [--list] [-v [--abbrev=<length> | --no-abbrev]]
  3.     [--column[=<options>] | --no-column] [--sort=<key>]
  4.     [(--merged | --no-merged) [<commit>]]
  5.     [--contains [<commit]] [--no-contains [<commit>]]
  6.     [--points-at <object>] [--format=<format>] [<pattern>…​]
  7. git branch [--track | --no-track] [-f] <branchname> [<start-point>]
  8. git branch (--set-upstream-to=<upstream> | -u <upstream>) [<branchname>]
  9. git branch --unset-upstream [<branchname>]
  10. git branch (-m | -M) [<oldbranch>] <newbranch>
  11. git branch (-c | -C) [<oldbranch>] <newbranch>
  12. git branch (-d | -D) [-r] <branchname>…​
  13. git branch --edit-description [<branchname>]

描述

如果给出--list，或者没有非选项参数，则列出现有分支;当前分支将以星号突出显示。选项-r导致列出远程跟踪分支，选项-a显示本地和远程分支。如果给出&lt;pattern&gt;，则将其用作shell通配符以将输出限制为匹配的分支。如果给出了多个模式，则如果它与任何模式匹配，则显示分支。注意，提供&lt;pattern&gt;时，必须使用--list;否则该命令被解释为分支创建。

使用--contains，仅显示包含命名提交的分支（换句话说，提示提交是指定提交的后代的分支），--no-contains将其反转。使用--merged，将仅列出已合并到命名提交的分支（即，可以从命名提交到达提示提交的分支）。使用--no-merged将仅列出未合并到命名提交的分支。如果< commit>参数缺失它默认为HEAD（即当前分支的尖端）。

命令的第二个表单创建一个名为< branchname>的新分支头。它指向当前的HEAD，或者<起点>如果给予。

请注意，这将创建新分支，但不会将工作树切换到它;使用“git checkout< newbranch>”切换到新分支。

当远程跟踪分支启动本地分支时，Git设置分支（特别是branch.&lt;name&gt;.remote和branch.&lt;name&gt;.merge配置条目），以便 git pull 将从远程跟踪分支适当地合并。可以通过全局branch.autoSetupMerge配置标志更改此行为。可以使用--track和--no-track选项覆盖该设置，稍后使用git branch --set-upstream-to进行更改。

使用-m或-M选项，< oldbranch>将重命名为< newbranch>。如果< oldbranch>有一个相应的reflog，它被重命名为匹配< newbranch>，并创建一个reflog条目来记住分支重命名。如果< newbranch>存在，-M必须用于强制重命名发生。

-c和-C选项具有与-m和-M完全相同的语义，除了将分支与其配置重命名，并且reflog将被复制到新名称。

使用-d或-D选项，&lt;branchname&gt;将被删除。您可以指定多个分支进行删除。如果分支当前有reflog，那么reflog也将被删除。

将-r与-d一起使用以删除远程跟踪分支。请注意，如果远程存储库中不再存在远程跟踪分支，或者如果 git fetch 配置为不再获取它们，则删除它们才有意义。另请参阅 git-remote [1] 的 prune 子命令，了解清除所有过时的远程跟踪分支的方法。

OPTIONS

  1.  -d
  1.  --delete

删除分支。分支必须在其上游分支中完全合并，或者如果没有使用--track或--set-upstream-to设置上游，则必须在HEAD中合并。

  1.  -D

--delete --force的快捷方式。

  1.  --create-reflog

创建分支的reflog。这将激活对分支引用所做的所有更改的记录，从而可以使用基于日期的sha1表达式，例如“< branchname> @ {yesterday}”。请注意，在非裸存储库中，默认情况下，core.logAllRefUpdates配置选项通常会启用reflog。否定形式--no-create-reflog仅覆盖较早的--create-reflog，但目前不会否定core.logAllRefUpdates的设置。

  1.  -f
  1.  --force

重置< branchname>到< startpoint>，即使< branchname>已存在。没有-f， git branch 拒绝更改现有分支。与-d（或--delete）结合使用，允许删除分支，而不管其合并状态如何。与-m（或--move）结合使用，即使新分支名称已存在，也允许重命名分支，这同样适用于-c（或--copy）。

  1.  -m
  1.  --move

移动/重命名分支和相应的reflog。

  1.  -M

--move --force的快捷方式。

  1.  -c
  1.  --copy

复制分支和相应的reflog。

  1.  -C

--copy --force的快捷方式。

  1.  --color[=<when>]

颜色分支以突出显示当前，本地和远程跟踪分支。该值必须始终为（默认值），never或auto。

  1.  --no-color

即使配置文件提供默认的颜色输出，也要关闭分支颜色。与--color=never相同。

  1.  -i
  1.  --ignore-case

排序和过滤分支不区分大小写。

  1.  --column[=<options>]
  1.  --no-column

在列中显示分支列表。有关选项语法，请参阅配置变量column.branch。没有选项的--column和--no-column分别相当于和永远不会。

此选项仅适用于非详细模式。

  1.  -r
  1.  --remotes

列出或删除（如果与-d一起使用）远程跟踪分支。

  1.  -a
  1.  --all

列出远程跟踪分支和本地分支。

  1.  -l
  1.  --list

列出分支。使用可选的&lt;pattern&gt;...，例如git branch --list 'maint-*'，仅列出与模式匹配的分支。

  1.  -v
  1.  -vv
  1.  --verbose

在列表模式下，显示每个头的sha1和提交主题行，以及与上游分支（如果有）的关系。如果给出两次，也打印上游分支的名称（另请参见git remote show &lt;remote&gt;）。

  1.  -q
  1.  --quiet

在创建或删除分支时更安静，禁止出现非错误消息。

  1.  --abbrev=<length>

在输出列表中更改sha1的最小显示长度。默认值为7，可以通过core.abbrev配置选项覆盖。

  1.  --no-abbrev

在输出列表中显示完整的sha1，而不是缩写它们。

  1.  -t
  1.  --track

创建新分支时，设置branch.&lt;name&gt;.remote和branch.&lt;name&gt;.merge配置条目以将起点分支标记为新分支的“上游”。此配置将告诉git显示git status和git branch -v中两个分支之间的关系。此外，它在没有参数的情况下指示git pull在检出新分支时从上游拉出。

当起点是远程跟踪分支时，此行为是默认行为。如果希望git checkout和git branch始终表现得像--no-track一样，请将branch.autoSetupMerge配置变量设置为false。如果在起点是本地或远程跟踪分支时需要此行为，请将其设置为always。

  1.  --no-track

即使branch.autoSetupMerge配置变量为true，也不要设置“上游”配置。

  1.  --set-upstream

由于此选项具有令人困惑的语法，因此不再支持它。请改用--track或--set-upstream-to。

  1.  -u <upstream>
  1.  --set-upstream-to=<upstream>

设置< branchname>的跟踪信息，以便< upstream>被认为是< branchname>的上游分支。如果没有< branchname>如果已指定，则默认为当前分支。

  1.  --unset-upstream

删除< branchname>的上游信息。如果未指定分支，则默认为当前分支。

  1.  --edit-description

打开编辑器并编辑文本以解释分支的用途，供各种其他命令使用（例如format-patch，request-pull和merge（如果已启用））。可以使用多行解释。

  1.  --contains [<commit>]

仅列出包含指定提交的分支（如果未指定，则为HEAD）。意味着--list。

  1.  --no-contains [<commit>]

仅列出不包含指定提交的分支（如果未指定，则为HEAD）。意味着--list。

  1.  --merged [<commit>]

仅列出其提示可从指定提交到达的分支（如果未指定，则为HEAD）。意味着--list，与--no-merged不兼容。

  1.  --no-merged [<commit>]

仅列出其提示无法从指定的提交访问的分支（如果未指定，则为HEAD）。意味着--list，与--merged不兼容。

  1.  <branchname>

要创建或删除的分支的名称。新分支名称必须通过 git-check-ref-format [1] 定义的所有检查。其中一些检查可能会限制分支名称中允许的字符。

  1.  <start-point>

新的分支头将指向此提交。它可以作为分支名称，commit-id或标记给出。如果省略此选项，则将使用当前HEAD。

  1.  <oldbranch>

要重命名的现有分支的名称。

  1.  <newbranch>

现有分支的新名称。与< branchname>相同的限制应用。

  1.  --sort=<key>

根据给定的密钥排序。前缀-按值的降序排序。您可以使用—sort =< key>选项多次，在这种情况下，最后一个键成为主键。支持的键与git for-each-ref中的键相同。排序顺序默认为branch.sort变量（如果存在）配置的值，或基于完整refname（包括refs/...前缀）的排序。这首先列出分离的HEAD（如果存在），然后是本地分支，最后是远程跟踪分支。见 git-config [1] 。

  1.  --points-at <object>

仅列出给定对象的分支。

  1.  --format <format>

从显示的分支ref和它指向的对象插入%(fieldname)的字符串。格式与 git-for-each-ref [1] 的格式相同。

组态

仅在列出分支时，即使用或暗示--list时，才会遵守pager.branch。默认是使用寻呼机。见 git-config [1] 。

例子

  1.  Start development from a known tag
  1. $ git clone git://git.kernel.org/pub/scm/.../linux-2.6 my2.6
  2. $ cd my2.6
  3. $ git branch my2.6.14 v2.6.14   (1)
  4. $ git checkout my2.6.14
  1. 这一步和下一步可以通过“checkout -b my2.6.14 v2.6.14”组合成一个步骤。
  1.  Delete an unneeded branch
  1. $ git clone git://git.kernel.org/.../git.git my.git
  2. $ cd my.git
  3. $ git branch -d -r origin/todo origin/html origin/man   (1)
  4. $ git branch -D test                                    (2)

  1. 删除远程跟踪分支“todo”，“html”和“man”。下一个获取或拉将再次创建它们，除非你不配置它们。参见 git-fetch [1] 。

  2. 即使“master”分支（或当前检出的任何分支）没有来自测试分支的所有提交，也要删除“test”分支。

笔记

如果要创建要立即签出的分支，则可以更轻松地使用git checkout命令及其-b选项来创建分支并使用单个命令将其签出。

选项--contains，--no-contains，--merged和--no-merged有四个相关但不同的用途：

  • 如果< commit>，则--contains &lt;commit&gt;用于查找需要特别注意的所有分支。由于这些分支包含指定的< commit>，因此需要重新定义或修改。

  • --no-contains &lt;commit&gt;与此相反，即不包含指定的< commit>的分支。

  • --merged用于查找可以安全删除的所有分支，因为这些分支完全由HEAD包含。

  • --no-merged用于查找合并为HEAD的候选分支，因为这些分支未被HEAD完全包含。

也可以看看

git-check-ref-format [1] ， git-fetch [1] ， git-remote [1] ，“了解历史：什么是分支？“在Git用户手册中。

GIT

部分 git [1] 套件