Correct a type and make change the value of the OPENINGS constant to 'O',
[cvs2svn.git] / README
blob2147f3e41f63ec91d3eacee1cf6e07292ca86c29
1 cvs2svn.py: a script to create SVN repositories from CVS repositories.
3    ****************************** Warning ******************************
4    *                                                                   *
5    *          This is BETA SOFTWARE; your mileage may vary.            *
6    *                                                                   *
7    *                  http://cvs2svn.tigris.org/                       *
8    *                                                                   *
9    *********************************************************************
11 Prerequisites:
12 ==============
14   - Install RCS.  cvs2svn.py uses the "co" command.  The RCS home page
15     is http://www.cs.purdue.edu/homes/trinkle/RCS/.
17   - Get at least Python 2.0; see http://www.python.org/.
19   - Make sure you have GNU 'sort' installed, or some other sort
20     program that handles large files other than by reading them
21     entirely into memory.  GNU sort is part of the coreutils
22     package, see http://www.gnu.org/software/coreutils/.
24 Installation:
25 =============
27   - As root, run 'make install'.
29   - Or, if you do not wish to install cvs2svn.py on your system, you
30     can simply run it out of this directory.  As long as it can find
31     the 'cvs2svn_rcsparse' library, it should be happy.
33 Basic Usage:
34 ============
36   To create a new Subversion repository by converting an existing CVS
37   repository, run the script like this:
39      $ cvs2svn.py -s NEW_SVNREPOS CVSREPOS
41   To create a new Subversion repository containing only trunk commits,
42   and omitting all branches and tags from the CVS repository, do
44      $ cvs2svn.py --trunk-only -s NEW_SVNREPOS CVSREPOS
46   To create a Subversion dumpfile (suitable for 'svnadmin load') from
47   a CVS repository, run it like this:
49      $ cvs2svn.py --dump-only --dumpfile DUMPFILE CVSREPOS
51   As it works, cvs2svn.py will create many temporary files in the
52   current directory.  This is normal.  If the entire conversion is
53   successful, however, those tempfiles will be automatically removed.
54   If the conversion is not successful, or if you specify the
55   '--skip-cleanup' option, cvs2svn will leave the temporary files
56   behind for possible debugging.
58   To see more options, run:
60      $ cvs2svn.py --help
62   To report a bug, see the file BUGS.
64   To contribute to cvs2svn development, see http://cvs2svn.tigris.org/,
65   and check out the latest sources with
67      $ svn co http://svn.collab.net/repos/cvs2svn/trunk/ cvs2svn