modules/versioncontrol/README.txt

$Id$

Version Control API -
An interface to version control systems whose functionality
is provided by pluggable back-end modules.


SHORT DESCRIPTION
-----------------
This is a pure API module, providing functions for interfacing with
version control systems (VCS). In order to work, Version Control API
needs at least one VCS backend module that provides the specific VCS's
functionality.

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. The provided hooks for API users
are documented in hook_versioncontrol.php while backend authors find an
example backend module in the versioncontrol_fakecvs directory.

In subdirectories, you can find three modules that extend the basic
administration functionality of Version Control API with additional
functionality:

- Commit Log displays a history of commits and sends out notification mails
  to the version control administrator.
- Commit Restrictions grants or denies repository access
  based on path, branch or tag.
- Version Control Account Status requires users to submit motivation texts
  and meet approval of version control administrators before their VCS account
  is enabled.

Have a look at the OVERVIEW.txt file for a basic introduction into concepts,
forms and API of this module.


AUTHOR
------
Jakob Petsovits <jpetso at gmx DOT at>


CREDITS
-------
Some code in Version Control API was taken from the CVS integration module
on drupal.org, its authors deserve a lot of credits and may also hold copyright
for parts of this module.

This module was originally created as part of Google Summer of Code 2007,
so Google deserves some credits for making this possible. Thanks also
to Derek Wright (dww) and Andy Kirkham (AjK) for mentoring
the Summer of Code project.
1	$Id$
2
3	Version Control API -
4	An interface to version control systems whose functionality
5	is provided by pluggable back-end modules.
6
7
8	SHORT DESCRIPTION
9	-----------------
10	This is a pure API module, providing functions for interfacing with
11	version control systems (VCS). In order to work, Version Control API
12	needs at least one VCS backend module that provides the specific VCS's
13	functionality.
14
15	For the API documentation, have a look at the module file or run doxygen/phpdoc
16	on it to get a fancier version of the docs. The provided hooks for API users
17	are documented in hook_versioncontrol.php while backend authors find an
18	example backend module in the versioncontrol_fakecvs directory.
19
20	In subdirectories, you can find three modules that extend the basic
21	administration functionality of Version Control API with additional
22	functionality:
23
24	- Commit Log displays a history of commits and sends out notification mails
25	to the version control administrator.
26	- Commit Restrictions grants or denies repository access
27	based on path, branch or tag.
28	- Version Control Account Status requires users to submit motivation texts
29	and meet approval of version control administrators before their VCS account
30	is enabled.
31
32	Have a look at the OVERVIEW.txt file for a basic introduction into concepts,
33	forms and API of this module.
34
35
36	AUTHOR
37	------
38	Jakob Petsovits <jpetso at gmx DOT at>
39
40
41	CREDITS
42	-------
43	Some code in Version Control API was taken from the CVS integration module
44	on drupal.org, its authors deserve a lot of credits and may also hold copyright
45	for parts of this module.
46
47	This module was originally created as part of Google Summer of Code 2007,
48	so Google deserves some credits for making this possible. Thanks also
49	to Derek Wright (dww) and Andy Kirkham (AjK) for mentoring
50	the Summer of Code project.