summaryrefslogtreecommitdiffstats
path: root/doc/plugins/version/bzr.txt
diff options
context:
space:
mode:
Diffstat (limited to 'doc/plugins/version/bzr.txt')
-rw-r--r--doc/plugins/version/bzr.txt18
1 files changed, 18 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.