From 22d1aef50dd440c120b43bf8947ea7197fdf178e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Richard=20M=C3=B6hn?= Date: Sun, 4 Jan 2015 20:42:44 +0100 Subject: [PATCH] Remove obsolete git-branch recipe MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit The git-branch recipe says: »Note that the next release will probably allow repo.listall_branches().« Concluding from the README, Repository.listall_branches() was included in some release prior to 0.20.0, so at least that statement is obsolete. However, since pygit2.org brings up fairly accurate results for a search on »list all branches«, I figured that the whole recipe isn't needed anymore. Therefore delete it. --- docs/recipes.rst | 1 - docs/recipes/git-branch.rst | 30 ------------------------------ 2 files changed, 31 deletions(-) delete mode 100644 docs/recipes/git-branch.rst diff --git a/docs/recipes.rst b/docs/recipes.rst index 019f863..14f31c0 100644 --- a/docs/recipes.rst +++ b/docs/recipes.rst @@ -17,7 +17,6 @@ Main porcelain commands .. toctree:: :maxdepth: 1 - git-branch (List, create, or delete branches.) git-init (Create an empty git repository or reinitialize an existing one.) git-log (Show commit logs.) git-show (Show various types of objects.) diff --git a/docs/recipes/git-branch.rst b/docs/recipes/git-branch.rst deleted file mode 100644 index 5db822b..0000000 --- a/docs/recipes/git-branch.rst +++ /dev/null @@ -1,30 +0,0 @@ -********************************************************************** -git-branch -********************************************************************** - ----------------------------------------------------------------------- -Listing branches ----------------------------------------------------------------------- - -====================================================================== -List all branches -====================================================================== - -.. code-block:: bash - - $> git branch - -.. code-block:: python - - >>> regex = re.compile('^refs/heads/') - >>> branches = filter(lambda r: regex.match(r), repo.listall_references()) - -`Note that the next release will probably allow` ``repo.listall_branches()``. - ----------------------------------------------------------------------- -References ----------------------------------------------------------------------- - -- git-branch_. - -.. _git-branch: https://www.kernel.org/pub/software/scm/git/docs/git-branch.html