[PATCH] doc branch: provide examples for listing remote tracking branches

From: Philip Oakley <philipoakley@iee.org>
Date: May 28, 2019, 12:13 UTC
Message-ID: <20190528121315.2604-1-philipoakley@iee.org>
In-Reply-To: <CACsJy8CwY8gzeWa9kNRX3ecez1JGiQiaOknbAoU7S+hiXBoUGQ@mail.gmail.com>

The availability of these pattern selections is not obvious from the man pages, as per mail thread <87lfz3vcbt.fsf@evledraar.gmail.com>.

Provide examples.

Signed-off-by: Philip Oakley <philipoakley@iee.org>
---

in response to <CACsJy8CwY8gzeWa9kNRX3ecez1JGiQiaOknbAoU7S+hiXBoUGQ@mail.gmail.com> https://public-inbox.org/git/?q=%3CCACsJy8CwY8gzeWa9kNRX3ecez1JGiQiaOknbAoU7S%2BhiXBoUGQ%40mail.gmail.com%3E

to: "Git Mailing List <git@vger.kernel.org>" cc: "Duy Nguyen <pclouds@gmail.com>" cc: "Ævar Arnfjörð Bjarmason <avarab@gmail.com>"

 Documentation/git-branch.txt | 12 ++++++++++++
 1 file changed, 12 insertions(+)

diff --git a/Documentation/git-branch.txt b/Documentation/git-branch.txt
index 3bd83a7cbd..7ed91f1be3 100644
--- a/Documentation/git-branch.txt
+++ b/Documentation/git-branch.txt
@@ -314,6 +314,18 @@ $ git branch -D test                                    <2>
 <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.
 
+Listing branches from a specific remote::
++
+------------
+$ git branch -a -l '<remote>/<pattern>'                 <1>
+$ git for-each-ref 'refs/remotes/<remote>/<pattern>'    <2>
+------------
++
+<1> This can 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.
 
 NOTES
 -----

-- 
2.22.0.rc1.windows.1