About this repository
=====================

Welcome to the Webware Subversion repository.  This document gives
some conventions for how to use this repository.

Access
------

You probably already have a checkout of the repository if you are
reading this.  If not, run::

    svn co svn://w4py.org/

This will create a directory ``w4py.org`` with a checkout of the
entire repository.  You can also check out separate pieces of the
repository.

You do not need a user account to check out from the repository, only
to commit changes.  You are asked for this information when you first
check something in.  Currently user accounts are managed separately
for subversion, and usernames and passwords are kept in a plain text
file on the disk.  (So passwords should not be valuable!)  Email
webware-devel@lists.sf.net about an account.  (For any admins, user
information is stored in ``/etc/subversion/passwd``)

Updates
-------

Any updates anywhere in this repository are mailed to
webware-checkins@lists.sf.net -- feel free to subscribe_ if you want
to keep up to date.

.. _subscribe: http://lists.sourceforge.net/mailman/listinfo/webware-checkins

Layout
------

Because Subversion allows you to rearrange files in the repository, it
is not as important to determine the Right Layout early in the
process, as it is in CVS.  These conventions are subject to change,
feel free to discuss these on the webware-devel list.  However, we
should try to be consistent within the repository.

All files are kept in a common repository.  This is so that files can
be moved around at will -- moving files inside a repository is easy.
This way we don't have to come up with strong distinctions between
different kinds of code.  "Sandbox" code can turn into production
code, content can be moved into and out of documentation, etc.  Try
not to muck things up too much (e.g., don't check in ``.pyc`` files),
but don't be too worried about it.

For personal files or files that have not otherwise been categorized,
use the ``/home`` directory, making a subdirectory matching your
username.  This is akin to the `Webware Sandbox`_.  If you aren't sure
where to put something, put it in your home directory, then ask
someone else where else it might go.

.. _Webware Sandbox: http://webware-sandbox.sf.net

Other modules can go directly in the root of the repository.  These
would be modules like ``Webware``, ``webwareforpython.org`` (the
website), etc.  (*I'm not sure about this part -- there's a variety of
opinions here*)

Branches and tags should go in ``/branches`` and ``/tags`` -- these
are copies of a tree, marking a particular point in time or a
particular branch of development.  There is not ``/trunk`` directory
-- the root is the trunk.  (Except for these special directories)

Again, these aren't set in stone, but this seems like a good place to
start from.

  -- Ian Bicking, 6 Apr 2004