Table of Contents

• In a nutshell
• Installation
• Configuration
• Manage file revisions
• Academic use case

In a nutshell

arcv is a safe, easy-to-use & learn revision control system which leaves the user’s original source file tree intact and ensures revisions integrity.

Its simplicity of use enables instant step-in and limits to its bare minimum the learning curve and the daily time overhead to manage revision control.

arcv only relies on standard system tools and unless other tools it does not define its own command set overlay for managing files.

Installation

For convenience, the script install_arcv.sh is supplied for an instant installation. This will install 2 debian packages arcv and shell-api.

Click to download and then run it:

sudo install_arcv.sh

If you prefer or if necessary, you can go through the installation steps described in Download and installation section of the arcv documentation.

Configuration

1) To create the default configuration file:

av check

Note	This creates .config/Arcv/arcv.yml , which contains a parameter pointing to ~/arcv.yml.

2) Configure in ~/arcv.yml the host and the path of the directory used as central repository

Table 1. Operational configuration parameters

Parameter	Value
host	Name of the host on the LAN where the repository is located
storage	Absolute path to the repository on 'host'
storage-via-mount	Mountpoint path or a sumo address to the repository if this latter is not accessed locally from 'host'

Note	To try out arcv locally directly after installation, it is enough to set host to the local hostname and storage to the absolute path to the directory used as repository.

Note	If you move arcv.yml in another place, call av -f your/new/path/to/arcv.yml.

Comprehensive documentation of all configuration parameters are described in the Operational configuration section of the arcv documentation.

Manage file revisions

From here on, you can put your project folder under revision control simply by executing

Initiate revision control

cd my/project/folder/

av

At that point, revision 0 of the project is backed up into the repository and can be retrieved later. Further changes can be checked in by executing av.

Check in new files

av

Note	Check the Cheatsheet page for an oversight of all available operations.

Note	For a comprehensive documentation of all commands, please check the Commands section of the arcv documentation.

Academic use case

The following pictures show an academic use case. The first diagram is a scenario in which a folder containing 2 files are initially put under revision control. Then, the new file with the dashes is added to the folder and checked in. In the next folder update, the dashed file is actually removed and replaced with the new light blue file. At last, the dark blue file is added and checked in.

The following diagram shows a scenario where revision 2 of the previously checked in files is retrieved (checked out):