summaryrefslogtreecommitdiff
path: root/docs/dev
diff options
context:
space:
mode:
authormilde <milde@929543f6-e4f2-0310-98a6-ba3bd3dd1d04>2012-01-26 09:57:04 +0000
committermilde <milde@929543f6-e4f2-0310-98a6-ba3bd3dd1d04>2012-01-26 09:57:04 +0000
commitcf0886fc22cee98315c3ad0d22817af47d732fa1 (patch)
tree015be74ecac626f58e4ca0ac3b7a74be9dce32b8 /docs/dev
parente8d0605afd4966dbb52ad2c199e19e276db2d661 (diff)
downloaddocutils-cf0886fc22cee98315c3ad0d22817af47d732fa1.tar.gz
Add link to git mirror on http://repo.or.cz/w/docutils.git
Thanks to Kirill Smelkov for setting this up. git-svn-id: http://svn.code.sf.net/p/docutils/code/trunk/docutils@7324 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
Diffstat (limited to 'docs/dev')
-rw-r--r--docs/dev/repository.txt36
1 files changed, 29 insertions, 7 deletions
diff --git a/docs/dev/repository.txt b/docs/dev/repository.txt
index 0fe20d050..86bf312ed 100644
--- a/docs/dev/repository.txt
+++ b/docs/dev/repository.txt
@@ -21,15 +21,18 @@
the **whole document**, especially the section "`Information for
Developers`_"!
-Docutils uses a Subversion_ repository located at ``docutils.svn.sourceforge.net``.
-Subversion is exhaustively documented in the `Subversion Book`_
-(svnbook).
+Docutils uses a Subversion_ repository located at
+``docutils.svn.sourceforge.net``.
+Subversion is exhaustively documented in the `Subversion Book`_ (svnbook).
While Unix and Mac OS X users will probably prefer the standard
Subversion command line interface, Windows user may want to try
TortoiseSVN_, a convenient explorer extension. The instructions apply
analogously.
+There is a git_ mirror at http://repo.or.cz/w/docutils.git providing
+`web access`_ and the base for `creating a local git clone`_.
+
For the project policy on repository use (check-in requirements,
branching, etc.), please see the `Docutils Project Policies`__.
@@ -39,6 +42,7 @@ __ policies.html#subversion-repository
.. _Subversion Book: http://svnbook.red-bean.com/
.. _TortoiseSVN: http://tortoisesvn.tigris.org/
.. _SourceForge.net: http://sourceforge.net/
+.. _git: http://git-scm.com/
.. contents::
@@ -55,16 +59,23 @@ Web Access
The repository can be browsed and examined via the web at
http://docutils.svn.sourceforge.net/viewvc/docutils/.
+Alternatively, use the web interface of the git mirror at
+http://repo.or.cz/w/docutils.git.
Repository Access Methods
~~~~~~~~~~~~~~~~~~~~~~~~~
To get a checkout of the Docutils repository, first determine the root
-of the repository depending on your preferred protocol::
+of the repository depending on your preferred protocol:
+
+anonymous access: (read only)
+ ``https://docutils.svn.sourceforge.net/svnroot/docutils``
+
+`developer access`_: (read and write)
+ ``https://<username>@docutils.svn.sourceforge.net/svnroot/docutils``
- https://docutils.svn.sourceforge.net/svnroot/docutils (anonymous)
- https://<username>@docutils.svn.sourceforge.net/svnroot/docutils
- (developers only)
+git clone: (read only)
+ ``git clone git://repo.or.cz/docutils.git``
Checking Out the Repository
~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -91,6 +102,16 @@ type ::
svn update
+Creating a local git clone
+~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Users of git_ can clone a mirror of the docutils repository with ::
+
+ git clone git://repo.or.cz/docutils.git
+
+and proceed according to the `git documentation`_.
+
+.. _git documentation: http://git-scm.com/documentation
Switching the Repository Root
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -100,6 +121,7 @@ If you changed your mind and want to use a different repository root,
svn switch --relocate OLDROOT NEWROOT
+.. _developer access:
Information for Developers
--------------------------