summaryrefslogtreecommitdiffstats
path: root/doc/plugins/version
diff options
context:
space:
mode:
Diffstat (limited to 'doc/plugins/version')
-rw-r--r--doc/plugins/version/bzr.txt18
-rw-r--r--doc/plugins/version/fossil.txt13
-rw-r--r--doc/plugins/version/git.txt13
-rw-r--r--doc/plugins/version/svn.txt13
4 files changed, 57 insertions, 0 deletions
diff --git a/doc/plugins/version/bzr.txt b/doc/plugins/version/bzr.txt
index 83bea745e..d4e624daf 100644
--- a/doc/plugins/version/bzr.txt
+++ b/doc/plugins/version/bzr.txt
@@ -3,3 +3,21 @@
===
Bzr
===
+
+Why use the Bazaar plugin
+=========================
+
+The Bazaar plugin is useful if you would like to track changes to your bcfg2 repository using a `Bazaar <http://bazaar-vcs.org/>`_ backend. Currently, it enables you to get revision information out of your repository for reporting purposes. Future plans are to commit changes to the repo which are made by the server.
+
+How to enable the Bazaar plugin
+===============================
+
+Simply add "Bzr" to your plugins line in /etc/bcfg2.conf::
+
+ [server]
+ plugins = Base,Bundler,Cfg,...,Bzr
+
+Usage notes
+===========
+
+Unlike other VCS plugins for BCFG2, the Bazaar plugin checks whether there are uncommitted changes to the repository. If there are, this plugin appends a "+" after the version number. Essentially, this means you're using that version, "plus" some changes.
diff --git a/doc/plugins/version/fossil.txt b/doc/plugins/version/fossil.txt
index 893ab266e..d77e45693 100644
--- a/doc/plugins/version/fossil.txt
+++ b/doc/plugins/version/fossil.txt
@@ -3,3 +3,16 @@
======
Fossil
======
+
+Why use the Fossil plugin
+=========================
+
+The Fossil plugin is useful if you would like to track changes to your bcfg2 repository using a `Fossil SCM <http://fossil-scm.org>`_ backend. Currently, It enables you to get revision information out of your repository for reporting purposes. Future plans are to commit changes to the repo which are made by the server.
+
+How to enable the Fossil plugin
+===============================
+
+Simply add "Fossil" to your plugins line in /etc/bcfg2.conf::
+
+ [server]
+ plugins = Base,Bundler,Cfg,...,Fossil
diff --git a/doc/plugins/version/git.txt b/doc/plugins/version/git.txt
index 621c64127..1b538f475 100644
--- a/doc/plugins/version/git.txt
+++ b/doc/plugins/version/git.txt
@@ -3,3 +3,16 @@
===
Git
===
+
+Why use the Git plugin
+======================
+
+The Git plugin is useful if you would like to track changes to your bcfg2 repository using a `Git <http://git-scm.com/>`_ backend. Currently, It enables you to get revision information out of your repository for reporting purposes. Future plans are to commit changes to the repo which are made by the server.
+
+How to enable the Git plugin
+============================
+
+The Git plugin uses `Dulwich <http://samba.org/~jelmer/dulwich/>`_ to interface with git repositories. Therefore, you will need to install Dulwich on the bcfg2 server first. Once installed, simply add Git to your plugins line in /etc/bcfg2.conf::
+
+ [server]
+ plugins = Base,Bundler,Cfg,...,Git
diff --git a/doc/plugins/version/svn.txt b/doc/plugins/version/svn.txt
index cfe44c707..e5ceb7aef 100644
--- a/doc/plugins/version/svn.txt
+++ b/doc/plugins/version/svn.txt
@@ -3,3 +3,16 @@
===
Svn
===
+
+Why use the Svn plugin
+======================
+
+The Svn plugin is useful if you would like to track changes to your bcfg2 repository using a `Subversion <http://subversion.tigris.org/>`_ backend. It deprecates the previous Subversion integration mentioned here at ftp://ftp.mcs.anl.gov/pub/bcfg/papers/directing-change-with-bcfg2.pdf. Currently, It enables you to get revision information out of your repository for reporting purposes. Future plans are to commit changes to the repo which are made by the server.
+
+How to enable the Svn plugin
+============================
+
+Simply add Svn to your plugins line in /etc/bcfg2.conf::
+
+ [server]
+ plugins = Base,Bundler,Cfg,DBStats,Decisions,Metadata,NagiosGen,Pkgmgr,Probes,Rules,SSHbase,TGenshi,Svn