cvs2git: clarify documentation of --use-external-blob-generator
[cvs2svn.git] / BUGS
1                                                        -*- text -*-
3                         REPORTING BUGS
4                         ==============
6 This document tells how and where to report bugs in cvs2svn.  It is
7 not a list of all outstanding bugs -- we use an online issue tracker
8 for that, see
12 Before reporting a bug:
14    a) Verify that you are running the latest version of cvs2svn.
16    b) Read the current frequently-asked-questions list at
17 to see if your problem has a
18       known solution, and to help determine if your problem is caused
19       by corruption in your CVS repository.
21    c) Check to see if your bug is already filed in the issue tracker
22       (see for a list of all open bugs).
24 Then, mail your bug report to
26 To be useful, a bug report should include the following information:
28    * The revision of cvs2svn you ran.  Run 'cvs2svn --version' to
29      determine this.
31    * The version of Subversion you used it with.  Run 'svnadmin
32      --version' to determine this.
34    * The exact cvs2svn command line you invoked, and the output it
35      produced.
37    * The contents of the configuration file that you used (if you used
38      the --config option).
40    * The data you ran it on.  If your CVS repository is small (only a
41      few kilobytes), then just provide the repository itself.  If it's
42      large, or if the data is confidential, then please try to come up
43      with some smaller, releasable data set that still stimulates the
44      bug.  The cvs2svn project includes one script that can often help
45      you narrow down the source of the bug to just a few *,v files,
46      and another that helps strip proprietary information out of your
47      repository.  See the FAQ ( for
48      more information.
50 The most important thing is that we be able to reproduce the bug :-).
51 If we can reproduce it, we can usually fix it.  If we can't reproduce
52 it, we'll probably never fix it.  So describing the bug conditions
53 accurately is crucial.  If in addition to that, you want to add some
54 speculations as to the cause of the bug, or even include a patch to
55 fix it, that's great!
57 Thank you in advance,
58 -The cvs2svn development team