Quick recipe for systems using apt

sudo apt-get install golang                 # To build it
sudo apt-get install cvs-fast-export        # For importing CVS repos
sudo apt-get install subversion             # For importing SVN ropos
sudo apt-get install hg-git-fast-import     # For exporting hg repos
sudo apt-get install asciidoctor            # To render docs
sudo apt-get install golint shellcheck      # For testing
sudo apt-get install mercurial rsync cvs    # For testing
sudo apt-get install gnuplot                # For benchmarking
make                                        # Build it
make check                                  # Run the tests

Prerequisites

This code is developed under Linux and expected to work under any other Unix, including OS X. Full function has been confirmed under MS-Windows/WSL, but native MS-Windows is not supported.

You will need 64-bit hardware. This code is not intended to run on 32-bit machines (which have an address space too small to be useful for surgery on large repositories) and may not even build on them.

You will need git at version 2.19.2 or later. Versions of reposurgeon after 4.7 assume the --show-original-ids option of git-fast-export is available.

You will need the Go compiler at revision 1.12 or later. Note, you may have to tweak your $PATH variable to make the Go tools visible.

hg-git-fast-import is required if you want to write Mercurial repositories, but not to read them. Note that this is not part of stock Mercurial, but does a better job of handling odd cases than the stock 'hg-fastimport' plugin.

A few scripts are written in shell. Any Bourne-shell-like implementation will do. The restricted shell shipped on Debian/Ubuntu will work. Shell is almost certainly already installed on your system.

You will need asciidoctor to format the documentation.

golint, shellcheck, mercurial, cvs, and rsync are required for the full regression tests, but not for running the code. The importers are also required for testing. Very old versions of Subversion (certainly 1.6 or earlier, but not 1.9 or later) will cause one spurious test failure.

gnuplot is only required if you’re planning to try performance-tuning with repobench.

Building the software

To build the tools, simply run "make" in the toplevel directory. This also builds the suite documentation.

Testing the software

There is an extensive regression-test suite in the test/ directory. To test the correctness of this software once its prerequisites are installed, invoke make check in the main directory.

Note to packagers

It probably is not necessary to package repobench, as it is a benchmarking tool only of interest to developers working with the source distribution.