From: Junio C Hamano Date: Tue, 9 Jul 2019 22:25:34 +0000 (-0700) Subject: Merge branch 'po/doc-branch' X-Git-Tag: v2.23.0-rc0~94 X-Git-Url: https://git.lorimer.id.au/gitweb.git/diff_plain/ecf55ae4f0f73a9759eb58e01cfcc6758acc07c2 Merge branch 'po/doc-branch' Doc update. * po/doc-branch: doc branch: provide examples for listing remote tracking branches --- ecf55ae4f0f73a9759eb58e01cfcc6758acc07c2 diff --cc Documentation/git-branch.txt index 7c8fa3b64f,c57f6a15c6..16e14c6282 --- a/Documentation/git-branch.txt +++ b/Documentation/git-branch.txt @@@ -8,8 -8,8 +8,8 @@@ git-branch - List, create, or delete br SYNOPSIS -------- [verse] - 'git branch' [--color[=] | --no-color] [-r | -a] - [--list] [--show-current] [-v [--abbrev= | --no-abbrev]] -'git branch' [--color[=] | --no-color] ++'git branch' [--color[=] | --no-color] [--show-current] + [-v [--abbrev= | --no-abbrev]] [--column[=] | --no-column] [--sort=] [(--merged | --no-merged) []] [--contains []] @@@ -26,15 -28,17 +28,19 @@@ DESCRIPTIO ----------- If `--list` is given, or if there are no non-option arguments, existing -branches are listed; the current branch will be highlighted with an -asterisk. Option `-r` causes the remote-tracking branches to be listed, +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, - and option `-a` shows both local and remote branches. If a `` + and option `-a` shows both local and remote branches. + + If a `` 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 - it matches any of the patterns. Note that when providing a - ``, you must use `--list`; otherwise the command is interpreted + it matches any of the patterns. + + Note that when providing a + ``, you must use `--list`; otherwise the command may be interpreted as branch creation. With `--contains`, shows only the branches that contain the named commit