1
1
Fork 0
mirror of https://github.com/pypa/pip synced 2023-12-13 21:30:23 +01:00

Added Bazaar to documentation and restructured version control part a bit

This commit is contained in:
Jannis Leidel 2009-01-21 03:49:40 +01:00
parent 22a9aa0c1b
commit ea4f112a49
3 changed files with 42 additions and 18 deletions

View file

@ -111,13 +111,13 @@ quickly see why that doesn't work.) You can add optional libraries and support
tools that MyApp doesn't strictly require.
You can also include "editable" packages -- packages that are checked out from
Subversion, Git and Mercurial. These are just like using the ``-e`` option
to pip. They look like::
Subversion, Git, Mercurial and Bazaar. These are just like using the ``-e``
option to pip. They look like::
-e svn+http://myrepo/svn/MyApp#egg=MyApp
You have to start the URL with ``svn+`` (or ``git+`` or ``hg+``), and you
have to include ``#egg=Package`` so pip knows what to expect at that URL.
You have to start the URL with ``svn+`` (``git+``, ``hg+``or ``bzr+``), and
you have to include ``#egg=Package`` so pip knows what to expect at that URL.
You can also include ``@rev`` in the URL, e.g., ``@275`` to check out
revision 275.

View file

@ -32,8 +32,9 @@ hg tip
Most importantly, anything that package requires will also be
installed by pip.
* Added support for editable packages created from Git and Mercurial
repositories and ability to freeze them.
* Added support for editable packages created from Git, Mercurial and Bazaar
repositories and ability to freeze them. Refactored support for version
control systems.
0.2.1
-----

View file

@ -37,39 +37,62 @@ easy_install).
Version Control
---------------
Right now pip knows Subversion, Git and Mercurial. Support for Bazaar is
propably coming soon, too.
Right now pip knows of the following major version control systems:
Subversion
~~~~~~~~~~
Pip supports the URL schemes ``svn``, ``svn+http``, ``svn+https``
You can also give specific revisions to an SVN URL, like::
-e svn+http://svn.myproject.org/svn/MyProject/trunk@2019#egg=MyProject
which will check out revision 2019. ``@{20080101}`` would also check
out the revision from 2008-01-01. You can only check out specific
out the revision from 2008-01-01. You can only check out specific
revisions using ``-e svn+...``.
Using Git and Mercurial is quite similar to that of Subversion -- just use the
appropriate URL scheme. For a Git repository that is served with the Git
protocoll you can use::
Git
~~~
Pip currently supports cloning over ``git``, ``git+http`` and ``git+ssh``::
-e git://git.myproject.org/MyProject.git#egg=MyProject
For a Git repository served over HTTP::
-e git+http://git.myproject.org/MyProject/#egg=MyProject
-e git+ssh://git@myproject.org/MyProject/#egg=MyProject
Passing branch names, a commit hash or a tag name is also possible::
-e git://git.myproject.org/MyProject.git@master#egg=MyProject
-e git://git.myproject.org/MyProject.git@v1.0#egg=MyProject
-e git://git.myproject.org/MyProject.git@da39a3ee5e6b4b0d3255bfef95601890afd80709#egg=MyProject
The same rules apply to Mercurial, use the ``hg+http`` URL scheme to get it
over HTTP::
Mercurial
~~~~~~~~~
The supported schemes are: ``hg+http`` and ``hg+ssh``::
-e hg+http://hg.myproject.org/MyProject/#egg=MyProject
-e hg+ssh://hg@myproject.org/MyProject/#egg=MyProject
You can also specify a revision number, a revision hash, a tag name or a local
branch name to clone from::
branch name::
-e hg+http://hg.myproject.org/MyProject/@da39a3ee5e6b#egg=MyProject
-e hg+http://hg.myproject.org/MyProject/@2019#egg=MyProject
-e hg+http://hg.myproject.org/MyProject/@v1.0#egg=MyProject
-e hg+http://hg.myproject.org/MyProject/@special_feature#egg=MyProject
Bazaar
~~~~~~
Pip supports Bazaar using the ``bzr+http``, ``bzr+https``, ``bzr+ssh`` and
``bzr+sftp`` schemes::
-e bzr+http://bzr.myproject.org/MyProject/trunk/#egg=MyProject
-e bzr+sftp://user@myproject.org/MyProject/trunk/#egg=MyProject
-e bzr+ssh://user@myproject.org/MyProject/trunk/#egg=MyProject
Tags or revisions can be installed like this::
-e bzr+https://bzr.myproject.org/MyProject/trunk/@2019#egg=MyProject
-e bzr+http://bzr.myproject.org/MyProject/trunk/@v1.0#egg=MyProject