1
==========================
2
The Docutils_ Repository
3
==========================
6
:Revision: $Revision: 3179 $
7
:Date: $Date: 2005-04-06 21:38:32 +0200 (Wed, 06 Apr 2005) $
8
:Copyright: This document has been placed in the public domain.
10
.. _Docutils: http://docutils.sourceforge.net/
15
Docutils uses a Subversion_ repository located at ``svn.berlios.de``.
16
Subversion is exhaustively documented in the `Subversion Book`_
19
.. _Subversion: http://subversion.tigris.org/
20
.. _Subversion Book: http://svnbook.red-bean.com/
23
Accessing the Repository
24
========================
29
Anonymous (read-only) access is available at ``svn://svn.berlios.de/docutils/``.
31
To check out the current main source tree of Docutils, type ::
33
svn checkout svn://svn.berlios.de/docutils/trunk/docutils
35
To check out everything (main tree, sandboxes, and web site), type ::
37
svn checkout svn://svn.berlios.de/docutils/trunk docutils
39
This will create a working copy of the whole trunk in a new directory
42
Note that you should *never* check out
43
``svn://svn.berlios.de/docutils`` (without "trunk"), because then
44
you'd end up fetching the whole Docutils tree for every branch and tag
45
over and over again, wasting your and BerliOS's bandwidth.
47
To update your working copy later on, cd into the working copy and
56
If you are a developer, you get read-write access via
57
``svn+ssh://username@svn.berlios.de/svnroot/repos/docutils/``, where
58
``username`` is your BerliOS user name. So to retrieve a working
61
svn checkout svn+ssh://username@svn.berlios.de/svnroot/repos/docutils/trunk docutils
63
If you previously had an anonymous working copy and gained developer
64
access, you can switch the URL associated with your working copy by
67
svn switch --relocate svn://svn.berlios.de/docutils/trunk/docutils \
68
svn+ssh://username@svn.berlios.de/svnroot/repos/docutils
70
(``username`` is again your BerliOS user name.)
73
Setting Up Your Subversion Client For Development
74
`````````````````````````````````````````````````
76
Before commiting changes to the repository, please ensure that the
77
following lines are contained (and uncommented) in your
78
~/.subversion/config file, so that new files are added with the
79
correct properties set::
82
# For your convenience:
83
global-ignores = ... *.pyc ...
84
# For correct properties:
85
enable-auto-props = yes
88
*.py = svn:eol-style=native;svn:keywords=Author Date Id Revision
89
*.txt = svn:eol-style=native;svn:keywords=Author Date Id Revision
90
*.html = svn:eol-style=native;svn:keywords=Author Date Id Revision
91
*.xml = svn:eol-style=native;svn:keywords=Author Date Id Revision
92
*.tex = svn:eol-style=native;svn:keywords=Author Date Id Revision
93
*.sh = svn:eol-style=native;svn:executable;svn:keywords=Author Date Id Revision
94
*.png = svn:mime-type=image/png
100
With a public & private key pair, you can access the shell and
101
Subversion servers without having to enter your password. There are
102
two places to add your SSH public key on BerliOS: your web account and
105
* Adding your SSH key to your BerliOS web account:
107
1. Log in on the web at https://developer.berlios.de/. Create your
108
account first if necessary. You should be taken to your "My
109
Personal Page" (https://developer.berlios.de/my/).
111
2. Choose "Account Options" from the menu below the top banner.
113
3. At the bottom of the "Account Maintenance" page
114
(https://developer.berlios.de/account/) you'll find a "Shell
115
Account Information" section; click on "[Edit Keys]".
117
4. Copy and paste your SSH public key into the edit box on this page
118
(https://developer.berlios.de/account/editsshkeys.php). Further
119
instructions are available on this page.
121
* Adding your SSH key to your BerliOS shell account:
123
1. Log in to the BerliOS shell server::
125
ssh username@shell.berlios.de
127
You'll be asked for your password, which you set when you created
130
2. Create a .ssh directory in your home directory, and remove
131
permissions for group & other::
136
Exit the SSH session.
138
3. Copy your public key to the .ssh directory on BerliOS::
140
scp .ssh/id_dsa.pub username@shell.berlios.de:.ssh/authorized_keys
142
Now you should be able to start an SSH session without needing your
149
The repository can be browsed and examined via the web at
150
http://svn.berlios.de/viewcvs/docutils/.
156
The following tree shows the repository layout::
182
``docutils/branches/`` and ``docutils/tags/`` contain (shallow) copies
185
The main source tree lives at ``docutils/trunk/docutils/``, next to
186
the sandboxes (``docutils/trunk/sandbox/``) and the web site files
187
(``docutils/trunk/web/``).
added
removed
docs/dev/repository.txt
