doc: More suggested improvements from Philipp Riegger

Signed-off-by: Sol Jerome <solj@ices.utexas.edu>

git-svn-id: https://svn.mcs.anl.gov/repos/bcfg/trunk/bcfg2@5788 ce84e21b-d406-0410-9b95-82705330c041

6 files changed, 34 insertions, 20 deletions

diff --git a/doc/development/docstyleguide.txt b/doc/development/docstyleguide.txt
index 401a43bc0..fda1037f3 100644
--- a/doc/development/docstyleguide.txt
+++ b/doc/development/docstyleguide.txt
@@ -5,17 +5,23 @@
 Documentation Style Guide for Bcfg2
 ===================================
 
-This is a style guide to use when creating documentation for Bcfg2. It is meant to be helpful, not a hinderence.
+This is a style guide to use when creating documentation for Bcfg2. It
+is meant to be helpful, not a hinderence.
 
 Basics
 ------
 
-:Bcfg2:
+**Bcfg2**
+
     When referring to project, Bcfg2 is the preferred use of cases.
 
-:Monospace fonts:
-    When referring to commands written on the command line use monospace fonts.
+**Monospace fonts**
+
+    When referring to commands written on the command line use monospace
+    fonts.
 
-:Repository:
-    When used alone this refers to a Bcfg2 :term:`repository`. When there is a chance for confusion, for instance in documents also talking about :term:`VCS`, be sure to use the longer Bcfg2 :term:`repository`.
+**Repository**
 
+    When used alone this refers to a Bcfg2 :term:`repository`. When there
+    is a chance for confusion, for instance in documents also talking
+    about :term:`VCS`, be sure to use the longer Bcfg2 :term:`repository`.
diff --git a/doc/server/plugins/generators/tcheetah.txt b/doc/server/plugins/generators/tcheetah.txt
index 26b384628..e985816c9 100644
--- a/doc/server/plugins/generators/tcheetah.txt
+++ b/doc/server/plugins/generators/tcheetah.txt
@@ -103,8 +103,8 @@ bcfg2/TCheetah/foo/template
     #end for
 
     Probes:
-    #for $probe in $self.metadata.probes:
-     * $probe -- $self.metadata.probes[$probe]
+    #for $probe in $self.metadata.Probes:
+     * $probe -- $self.metadata.Probes[$probe]
     #end for
 
 bcfg2/TCheetah/foo/info
diff --git a/doc/server/plugins/generators/tgenshi/index.txt b/doc/server/plugins/generators/tgenshi/index.txt
index 186652029..71d0acfad 100644
--- a/doc/server/plugins/generators/tgenshi/index.txt
+++ b/doc/server/plugins/generators/tgenshi/index.txt
@@ -58,10 +58,11 @@ Genshi syntax.
 Examples: Old Genshi Syntax
 ---------------------------
 
-Genshi's web pages recommend against using this syntax, as it may disappear from future releases.
+Genshi's web pages recommend against using this syntax, as it may
+disappear from future releases.
 
 Group Negation
---------------
+^^^^^^^^^^^^^^
 
 Templates are also useful for cases where more sophisticated boolean
 operations than those supported by Cfg are needed. For example, the
diff --git a/doc/server/plugins/probes/index.txt b/doc/server/plugins/probes/index.txt
index 3c5387180..9b6f37b26 100644
--- a/doc/server/plugins/probes/index.txt
+++ b/doc/server/plugins/probes/index.txt
@@ -31,8 +31,9 @@ interpreter.
 
     Bcfg2 uses python mkstemp to create the Probe scripts on the
     client. If your /tmp directory is mounted **noexec**, you will
-    likely need to modify the TMPDIR so that the bcfg2 client creates
-    the temporary files in a directory from which it can execute.
+    likely need to modify the TMPDIR environment variable so that the
+    bcfg2 client creates the temporary files in a directory from which
+    it can execute.
 
 Now we need to figure out what exactly we want to do.  In this case,
 we want to hand out an ``/etc/auto.master`` file that looks like::
@@ -73,7 +74,7 @@ file looks like::
     /home      /etc/auto.home --timeout 3600
     /hometest  /etc/auto.hometest --timeout 3600
     /nfs       /etc/auto.nfs --timeout 3600
-    #if int($self.metadata.probes["scratchlocal"]) > 2
+    #if int($self.metadata.Probes["scratchlocal"]) > 2
     /scratch   /etc/auto.scratch --timeout 3600
     #end if
 
diff --git a/doc/server/plugins/version/git.txt b/doc/server/plugins/version/git.txt
index 7d901f38d..883189552 100644
--- a/doc/server/plugins/version/git.txt
+++ b/doc/server/plugins/version/git.txt
@@ -12,8 +12,12 @@ 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.
+reporting purposes. Once the plugin is enabled, every time a client
+checks in, it will include the current repository revision in the
+reports/statistics.
+
+Future plans are to commit changes to the repo which are made by the
+server (adding clients, ssh keys, etc).
 
 How to enable the Git plugin
 ============================
diff --git a/doc/server/plugins/version/svn.txt b/doc/server/plugins/version/svn.txt
index 2e26f00c8..8e98102ea 100644
--- a/doc/server/plugins/version/svn.txt
+++ b/doc/server/plugins/version/svn.txt
@@ -6,16 +6,18 @@
 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.
+repository for reporting purposes. Once the plugin is enabled, every time
+a client checks in, it will include the current repository revision in
+the reports/statistics.
+
+Future plans are to commit changes to the repo which are made by the
+server (adding clients, ssh keys, etc).
 
 How to enable the Svn plugin
 ============================