Skip to content

Commit 4070c58

Browse files
committed
Explain what "latest libgit2" means better
pygit2 targets the master branch, and "latest" isn't well-defined in this case, as libgit2's default branch is development.
1 parent 8c69751 commit 4070c58

File tree

1 file changed

+6
-4
lines changed

1 file changed

+6
-4
lines changed

docs/install.rst

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,10 @@ How to Install
66
.. contents::
77

88

9-
First you need to install the latest version of libgit2. You can find
10-
platform-specific instructions to build the library in the libgit2 website:
9+
First you need to install the latest release of libgit2. If you clone
10+
the repository, make sure to use the ``master`` branch. You can find
11+
platform-specific instructions to build the library in the libgit2
12+
website:
1113

1214
http://libgit2.github.com
1315

@@ -55,7 +57,7 @@ instructions in the libgit2 ``README.md``):
5557

5658
.. code-block:: sh
5759
58-
$ git clone git://github.com/libgit2/libgit2.git
60+
$ git clone -b master git://github.com/libgit2/libgit2.git
5961
$ mkdir libgit2/build
6062
$ cd libgit2/build
6163
$ cmake ..
@@ -105,7 +107,7 @@ from a bash shell:
105107
.. code-block:: sh
106108
107109
$ export LIBGIT2=C:/Dev/libgit2
108-
$ git clone git://github.com/libgit2/libgit2.git
110+
$ git clone -b master git://github.com/libgit2/libgit2.git
109111
$ cd libgit2
110112
$ mkdir build
111113
$ cd build

0 commit comments

Comments
 (0)