Commit 5b204c67 authored by Marco Villegas's avatar Marco Villegas
Browse files

Update long outdated readme file.

parent d218e10b
Loading
Loading
Loading
Loading
+36 −35
Original line number Diff line number Diff line
= Version Control API -- Git backend =

Git backend for Version Control API -
Provides Git commit information as a pluggable backend.
Provides a git back-end for versioncontrol module.

== Summary ==

SHORT DESCRIPTION
-----------------
This module provides an implementation of the Version Control API that makes
it possible to use the Git version control system. It can retrieve commit
information by parsing commit logs.
This module provides an implementation of the Version Control API that makes it
possible to use the http://git-scm.com[Git] version control system.

For the API documentation, have a look at the module file or run doxygen/phpdoc
on it to get a fancier version of the docs.
It mainly calls git binary and parses the output to get the information.

Any bug reports or feature requests concerning the Git backend in general
should be submitted to the Git backend issue queue:
http://drupal.org/project/issues/versioncontrol_git.
should be submitted to the relevant issue queue:
https://www.drupal.org/project/issues/versioncontrol_git.

If you know that the functionality is (or should be) provided by the
Version Control API (and not by the Git backend), please submit an issue there:
http://drupal.org/project/issues/versioncontrol.
https://www.drupal.org/project/issues/versioncontrol.

== Install ==

Install as usual, see http://drupal.org/node/70151 for further information.

INSTALL
-------
We need at least versioncontrol api version 6.x-1.0-rc1.
If you've problems with the module, please check that your server is running
git 1.6.2.2 or later. We don't check against earlier versions of git.

AUTHOR
------
Jimmy Berry ("boombatower", http://drupal.org/user/214218) (orginal version
for Drupal 5)
Cornelius Riemenschneider ("CorniI", http://drupal.org/user/136353)

ROADMAP
------
We need to provide git hooks for updating and later for access control.
Also some cli scripts would be very nice for updating without drupal cron
system.
Rewrite versioncontrol_git_update_repository_callback().

CREDITS
-------
A good amount of code in Version Control / Project Node Integration was taken
from the CVS backend module on drupal.org, its author (Jakob Petsovits, among others)
deserve a lot of credits and may also hold copyright for parts of this module.
git 1.7.0.5 or later.

== Credits ==

Original version for Drupal 5 by https://www.drupal.org/u/boombatower[Jimmy
Berry].
A good amount of code was taken from the CVS backend module, its author, 
https://www.drupal.org/u/jpetso[Jakob Petsovits], among others, deserve a lot of
credits and may also hold copyright for parts of this module.

Initial 6.x-1.x version by https://www.drupal.org/u/marvil07[Marco Villegas],
followed by the parsing logic rewrite by http://drupal.org/user/136353[Cornelius
Riemenschneider].

Rewrite for 6.x-2.x by https://www.drupal.org/u/marvil07[Marco Villegas],
https://www.drupal.org/u/sdboyer[Sam Boyer],
https://www.drupal.org/u/tizzo[Howard Tyson] and
https://www.drupal.org/u/mikey_p[Michael Prasuhn].
Version Control Event implementation by
https://www.drupal.org/u/cvangysel[Christophe Van Gysel].

Currently maintained by https://www.drupal.org/u/sdboyer[Sam Boyer] and
https://www.drupal.org/u/marvil07[Marco Villegas].