1
=====================================
2
The Docutils_ Subversion Repository
3
=====================================
6
:Contact: Felix.Wiemann@ososo.de
7
:Revision: $Revision: 4002 $
8
:Date: $Date: 2005-11-06 17:50:19 +0100 (Sun, 06 Nov 2005) $
9
:Copyright: This document has been placed in the public domain.
11
.. _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/
24
While the repository resides at BerliOS, all other project data
25
(web site, snapshots, releases, mailing lists, trackers) is hosted
28
For the project policy on repository use (check-in requirements,
29
branching, etc.), please see the `Docutils Project Policies`__.
31
__ policies.html#subversion-repository
34
Accessing the Repository
35
========================
40
The repository can be browsed and examined via the web at
41
http://svn.berlios.de/viewcvs/docutils/.
47
Anonymous (read-only) access is available at ``svn://svn.berlios.de/docutils/``.
49
To check out the current main source tree of Docutils, type ::
51
svn checkout svn://svn.berlios.de/docutils/trunk/docutils
53
To check out everything (main tree, sandboxes, and web site), type ::
55
svn checkout svn://svn.berlios.de/docutils/trunk docutils
57
This will create a working copy of the whole trunk in a new directory
60
If you cannot use the ``svn`` port, you can also use the HTTP access
61
method by substituting "http://svn.berlios.de/svnroot/repos" for
62
"svn://svn.berlios.de".
64
Note that you should *not* check out ``svn://svn.berlios.de/docutils``
65
(without "trunk"), because then you'd end up fetching the whole
66
Docutils tree for every branch and tag over and over again, wasting
67
your and BerliOS's bandwidth.
69
To update your working copy later on, cd into the working copy and
78
(Developers who had write-access for Docutils' CVS repository on
79
SourceForge.net should `register at BerliOS`__ and send a message with
80
their BerliOS user name to `Felix Wiemann <Felix.Wiemann@ososo.de>`_.)
82
__ https://developer.berlios.de/account/register.php
84
If you are a developer, you get read-write access via
85
``svn+ssh://<user>@svn.berlios.de/svnroot/repos/docutils/``, where
86
``<user>`` is your BerliOS user account name. So to retrieve a
89
svn checkout svn+ssh://<user>@svn.berlios.de/svnroot/repos/docutils/trunk \
92
If you previously had an anonymous working copy and gained developer
93
access, you can switch the URL associated with your working copy by
96
svn switch --relocate svn://svn.berlios.de/docutils/trunk/docutils \
97
svn+ssh://<user>@svn.berlios.de/svnroot/repos/docutils
99
(Again, ``<user>`` is your BerliOS user account name.)
101
If you cannot use the ``ssh`` port, you can also use the HTTPS access
102
method by substituting "https://svn.berlios.de" for
103
"svn+ssh://svn.berlios.de".
106
Setting Up Your Subversion Client For Development
107
`````````````````````````````````````````````````
109
Before commiting changes to the repository, please ensure that the
110
following lines are contained (and uncommented) in your
111
~/.subversion/config file, so that new files are added with the
112
correct properties set::
115
# For your convenience:
116
global-ignores = ... *.pyc ...
117
# For correct properties:
118
enable-auto-props = yes
121
*.py = svn:eol-style=native;svn:keywords=Author Date Id Revision
122
*.txt = svn:eol-style=native;svn:keywords=Author Date Id Revision
123
*.html = svn:eol-style=native;svn:keywords=Author Date Id Revision
124
*.xml = svn:eol-style=native;svn:keywords=Author Date Id Revision
125
*.tex = svn:eol-style=native;svn:keywords=Author Date Id Revision
126
*.css = svn:eol-style=native;svn:keywords=Author Date Id Revision
127
*.patch = svn:eol-style=native
128
*.sh = svn:eol-style=native;svn:executable;svn:keywords=Author Date Id Revision
129
*.png = svn:mime-type=image/png
130
*.jpg = svn:mime-type=image/jpeg
131
*.gif = svn:mime-type=image/gif
134
Setting Up SSH Access
135
`````````````````````
137
With a public & private key pair, you can access the shell and
138
Subversion servers without having to enter your password. There are
139
two places to add your SSH public key on BerliOS: your web account and
142
* Adding your SSH key to your BerliOS web account:
144
1. Log in on the web at https://developer.berlios.de/. Create your
145
account first if necessary. You should be taken to your "My
146
Personal Page" (https://developer.berlios.de/my/).
148
2. Choose "Account Options" from the menu below the top banner.
150
3. At the bottom of the "Account Maintenance" page
151
(https://developer.berlios.de/account/) you'll find a "Shell
152
Account Information" section; click on "[Edit Keys]".
154
4. Copy and paste your SSH public key into the edit box on this page
155
(https://developer.berlios.de/account/editsshkeys.php). Further
156
instructions are available on this page.
158
* Adding your SSH key to your BerliOS shell account:
160
1. Log in to the BerliOS shell server::
162
ssh <user>@shell.berlios.de
164
You'll be asked for your password, which you set when you created
167
2. Create a .ssh directory in your home directory, and remove
168
permissions for group & other::
173
Exit the SSH session.
175
3. Copy your public key to the .ssh directory on BerliOS::
177
scp .ssh/id_dsa.pub <user>@shell.berlios.de:.ssh/authorized_keys
179
Now you should be able to start an SSH session without needing your
186
The following tree shows the repository layout::
212
``docutils/branches/`` and ``docutils/tags/`` contain (shallow) copies
215
The main source tree lives at ``docutils/trunk/docutils/``, next to
216
the sandboxes (``docutils/trunk/sandbox/``) and the web site files
217
(``docutils/trunk/web/``).
added
removed
docs/dev/repository.txt
