Merge branch 'jk/maint-avoid-streaming-filtered-contents' into maint

[git.git] / Documentation / git-branch.txt

diff --git a/Documentation/git-branch.txt b/Documentation/git-branch.txt
index 507b8d0ab2a2d524a607c5b91e6d17f6d2f36392..0427e80a35601e689a47299dce9c5517959bddf8 100644 (file)
--- a/Documentation/git-branch.txt
+++ b/Documentation/git-branch.txt
@@ -9,18 +9,23 @@ SYNOPSIS
 --------
 [verse]
 'git branch' [--color[=<when>] | --no-color] [-r | -a]
 --------
 [verse]
 'git branch' [--color[=<when>] | --no-color] [-r | -a]

-       [-v [--abbrev=<length> | --no-abbrev]]
-       [(--merged | --no-merged | --contains) [<commit>]]
+       [--list] [-v [--abbrev=<length> | --no-abbrev]]
+       [(--merged | --no-merged | --contains) [<commit>]] [<pattern>...]

 'git branch' [--set-upstream | --track | --no-track] [-l] [-f] <branchname> [<start-point>]
 'git branch' (-m | -M) [<oldbranch>] <newbranch>
 'git branch' (-d | -D) [-r] <branchname>...
 'git branch' [--set-upstream | --track | --no-track] [-l] [-f] <branchname> [<start-point>]
 'git branch' (-m | -M) [<oldbranch>] <newbranch>
 'git branch' (-d | -D) [-r] <branchname>...

+'git branch' --edit-description [<branchname>]

 
 DESCRIPTION
 -----------
 
 With no arguments, existing branches are listed and the current branch will
 be highlighted with an asterisk.  Option `-r` causes the remote-tracking
 
 DESCRIPTION
 -----------
 
 With no arguments, existing branches are listed and the current branch will
 be highlighted with an asterisk.  Option `-r` causes the remote-tracking

-branches to be listed, and option `-a` shows both.
+branches to be listed, and option `-a` shows both. This list mode is also
+activated by the `--list` option (see below).
+<pattern> restricts the output to matching branches, the pattern is a shell
+wildcard (i.e., matched using fnmatch(3))
+Multiple patterns may be given; if any of them matches, the tag is shown.

 
 With `--contains`, shows only the branches that contain the named commit
 (in other words, the branches whose tip commits are descendants of the
 
 With `--contains`, shows only the branches that contain the named commit
 (in other words, the branches whose tip commits are descendants of the


@@ -64,6 +69,7 @@ way to clean up all obsolete remote-tracking branches.
 OPTIONS
 -------
 -d::
 OPTIONS
 -------
 -d::

+--delete::

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


@@ -72,6 +78,7 @@ OPTIONS
        Delete a branch irrespective of its merged status.
 
 -l::
        Delete a branch irrespective of its merged status.
 
 -l::

+--create-reflog::

        Create the branch's reflog.  This activates recording of
        all changes made to the branch ref, enabling use of date
        based sha1 expressions such as "<branchname>@\{yesterday}".
        Create the branch's reflog.  This activates recording of
        all changes made to the branch ref, enabling use of date
        based sha1 expressions such as "<branchname>@\{yesterday}".


@@ -84,6 +91,7 @@ OPTIONS
        already. Without `-f` 'git branch' refuses to change an existing branch.
 
 -m::
        already. Without `-f` 'git branch' refuses to change an existing branch.
 
 -m::

+--move::

        Move/rename a branch and the corresponding reflog.
 
 -M::
        Move/rename a branch and the corresponding reflog.
 
 -M::


@@ -100,14 +108,21 @@ OPTIONS
        Same as `--color=never`.
 
 -r::
        Same as `--color=never`.
 
 -r::

+--remotes::

        List or delete (if used with -d) the remote-tracking branches.
 
 -a::
        List or delete (if used with -d) the remote-tracking branches.
 
 -a::

+--all::

        List both remote-tracking branches and local branches.
 
        List both remote-tracking branches and local branches.
 

+--list::
+       Activate the list mode. `git branch <pattern>` would try to create a branch,
+       use `git branch --list <pattern>` to list matching branches.
+

 -v::
 --verbose::
 -v::
 --verbose::

-       Show sha1 and commit subject line for each head, along with
+       When in list mode,
+       show sha1 and commit subject line for each head, along with

        relationship to upstream branch (if any). If given twice, print
        the name of the upstream branch, as well.
 
        relationship to upstream branch (if any). If given twice, print
        the name of the upstream branch, as well.
 


@@ -144,6 +159,10 @@ start-point is either a local or remote-tracking branch.
        like '--track' would when creating the branch, except that where
        branch points to is not changed.
 
        like '--track' would when creating the branch, except that where
        branch points to is not changed.
 

+--edit-description::
+       Open an editor and edit the text to explain what the branch is
+       for, to be used by various other commands (e.g. `request-pull`).
+

 --contains <commit>::
        Only list branches which contain the specified commit.
 
 --contains <commit>::
        Only list branches which contain the specified commit.