diff options
| author | milde <milde@929543f6-e4f2-0310-98a6-ba3bd3dd1d04> | 2021-11-05 11:10:26 +0000 |
|---|---|---|
| committer | milde <milde@929543f6-e4f2-0310-98a6-ba3bd3dd1d04> | 2021-11-05 11:10:26 +0000 |
| commit | 0c49bd88f4530921719c75fb6415ff5d19ecca5e (patch) | |
| tree | 74678a6482333b53690f1d9d004b57a218c035ae /docutils/docs/dev | |
| parent | 48f8227ae0610590ffbb940a551629d05af9b821 (diff) | |
| download | docutils-0c49bd88f4530921719c75fb6415ff5d19ecca5e.tar.gz | |
Repository documentation: make clear that Github mirrors are from 3rd party.
git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk@8876 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
Diffstat (limited to 'docutils/docs/dev')
| -rw-r--r-- | docutils/docs/dev/repository.txt | 71 |
1 files changed, 37 insertions, 34 deletions
diff --git a/docutils/docs/dev/repository.txt b/docutils/docs/dev/repository.txt index 679fc825e..2e3ca921e 100644 --- a/docutils/docs/dev/repository.txt +++ b/docutils/docs/dev/repository.txt @@ -2,7 +2,7 @@ The Docutils_ Version Repository ===================================== -:Author: Lea Wiemann +:Author: Lea Wiemann, Docutils developers :Contact: docutils-develop@lists.sourceforge.net :Revision: $Revision$ :Date: $Date$ @@ -33,10 +33,9 @@ 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/docutils.git providing +There is a Git_ mirror at http://repo.or.cz/docutils.git providing `web access`_ and the base for `creating a local Git clone`_. -(Another mirror is available at -https://github.com/live-clones/docutils/tree/master/docutils.) +[#github-mirrors]_ For the project policy on repository use (check-in requirements, branching, etc.), please see the `Docutils Project Policies`__. @@ -55,24 +54,40 @@ __ policies.html#subversion-repository Accessing the Repository ======================== -General Information -------------------- - Web Access -~~~~~~~~~~ +---------- The repository can be browsed and examined via the web at -http://sourceforge.net/p/docutils/code +http://sourceforge.net/p/docutils/code. -Alternatively, use the web interface of a `Git mirror`_. +Alternatively, use the web interface at http://repo.or.cz/docutils.git. +[#github-mirrors]_ +.. [#github-mirrors] There are also 3rd-party mirrors and forks at + GitHub, some of them orphaned. At the time of this writing (2021-11-03), + https://github.com/live-clones/docutils/tree/master/docutils + provides an hourly updated clone. Repository Access Methods -~~~~~~~~~~~~~~~~~~~~~~~~~ +------------------------- + +To get a checkout, first determine the root of the repository depending +on your preferred protocol: + +anonymous access: (read only) + Subversion_: ``http://svn.code.sf.net/p/docutils/code`` + + Git_: ``git://repo.or.cz/docutils.git`` + +`developer access`_: (read and write) + ``svn+ssh://<USERNAME>@svn.code.sf.net/p/docutils/code`` + +Checking Out the Repository +--------------------------- .. _creating a local Git clone: -Users of Git_ can clone a mirror of the docutils repository with :: +Git_ users can clone a mirror of the docutils repository with :: git clone git://repo.or.cz/docutils.git @@ -82,32 +97,20 @@ Developer access (read and write) is possible with `git svn`_. .. _Git documentation: https://git.wiki.kernel.org/index.php/GitDocumentation .. _git svn: https://git.wiki.kernel.org/index.php/Git-svn +Subversion_ users can use the following commands +(substitute your preferred repository root for ROOT): -To get a checkout with Subversion_, first determine -the root of the repository depending on your preferred protocol: - -anonymous access: (read only) - ``http://svn.code.sf.net/p/docutils/code`` - -`developer access`_: (read and write) - ``svn+ssh://<USERNAME>@svn.code.sf.net/p/docutils/code`` - - -Checking Out the Repository -~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -To check out only the current main source tree of Docutils, type :: +* To check out only the current main source tree of Docutils, type :: svn checkout ROOT/trunk/docutils -(Substitute your preferred repository root for ROOT.) To check out -everything (main tree, sandboxes, web site, and parallel projects), -type :: +* To check out everything (main tree, sandboxes, web site, and parallel + projects), type :: svn checkout ROOT/trunk docutils -This will create a working copy of the whole trunk in a new directory -called ``docutils``. + This will create a working copy of the whole trunk in a new directory + called ``docutils``. Note that you probably do *not* want to check out the ROOT itself (without "/trunk"), because then you'd end up fetching the whole @@ -119,7 +122,7 @@ type :: svn update Switching the Repository Root -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +----------------------------- If you changed your mind and want to use a different repository root, ``cd`` into your working copy and type:: @@ -130,7 +133,7 @@ If you changed your mind and want to use a different repository root, .. _developer access: Information for Developers --------------------------- +========================== If you would like to have write access to the repository, register with SourceForge.net_ and send your SourceForge.net @@ -144,7 +147,7 @@ __ http://sourceforge.net/p/forge/documentation/svn/ Setting Up Your Subversion Client For Development -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +------------------------------------------------- Before committing changes to the repository, please ensure that the following lines are contained (and uncommented) in your local |
