Arbit - next generation project tracking
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

:Author: 		Kore Nordmann
:Date:			Tue, 12 Jan 2010 22:45:36 +0100
:Revision: 		3
:Copyright:		CC by-sa

===========
VCS Wrapper
===========

The VCS implements an abstraction layer for read access to various version
control systems. It is meant to offer generic support for as many VCS as
possible.

The source runs on PHP 5.2 (and of course 5.3), to enable a wide adoption, and
already supports the following VCS:

- SVN

  - Using the SVN command line interface
  - Using the PHP extension `pecl/svn`__

- CVS, using the CVS command line client, contributed by Manuel Pichler

- GIT, using the GIT command line client

- Mercurial, using the hg command line client, contributed by Tobias Tom

- Archive, using the ZipArchive__ PHP class

Each wrapper has special requirements, like the installed extensions or CLI
tools. The core itself only depends on a default PHP 5.2 installation - it
uses the default modules SPL, xmlreader (SVN-Cli), PCRE and optionally
SQLite3 for faster caching of the version control metadata cache metadata.

The wrapper has been developed test-driven and has a quite high test coverage.
But there may still be some special issues inside the VCS, which we were not
aware of while developing this first version.

A basic overview, the original design document can both be found inside the
wiki__ in the `issue tracker`__ for the project.

__ http://pecl.php.net/package/svn
__ http://docs.php.net/manual/en/book.zip.php
__ http://tracker.arbitracker.org/vcs_wrapper/documentation/view/Start
__ http://tracker.arbitracker.org/vcs_wrapper

Download and test
=================

There is no release yet, but you can `check it out from SVN`__. We would like
to ask you to test the VCS wrapper and maybe provide implementations for your
favourite VCS. The source code is licensed under LGPL 3, so you should be able
to integrate it in your tools.

__ /vcs_wrapper/download.html