doc: Correct properties usage (#1005)

Signed-off-by: Sol Jerome <sol.jerome@gmail.com>

4 files changed, 29 insertions, 19 deletions

diff --git a/doc/client/metadata.txt b/doc/client/metadata.txt
index 2a19f3a1a..27870ba9a 100644
--- a/doc/client/metadata.txt
+++ b/doc/client/metadata.txt
@@ -22,22 +22,23 @@ interaction:
 * Statistics Upload
 
 This construction process spans several server plugins. The
-:ref:`server-plugins-grouping-metadata` is responsible for initial
-instance creation, including the client hostname, profile, and basic
-group memberships. After this initial creation, Connector plugins (such as
-:ref:`server-plugins-probes-index` or :ref:`server-plugins-properties`)
-can add additional group memberships for clients. These memberships
-are merged into the instance; that is, the new group memberships are
-treated as if they were included in groups.xml. If any of these groups
-are defined in groups.xml, then groups included there are included in
-the ClientMetadata instance group list. At the end of this process, the
-ClientMetadata instance has its complete set of group memberships. At this
-point, each connector plugin has the opportunity to return an additional
-object which will be placed in an attribute corresponding to the Connector
-name. For example, the Probes plugin returns a dictionary of probe name
-to probe result mappings for the client. This dictionary is available as
-the "Probes" attribute. With this, ClientMetadata resolution is complete,
-and the ClientMetadata instance can be used by the rest of the system.
+:ref:`server-plugins-grouping-metadata` is responsible for
+initial instance creation, including the client hostname,
+profile, and basic group memberships. After this initial creation,
+Connector plugins (such as :ref:`server-plugins-probes-index` or
+:ref:`server-plugins-connectors-properties`) can add additional group
+memberships for clients. These memberships are merged into the instance;
+that is, the new group memberships are treated as if they were included
+in groups.xml. If any of these groups are defined in groups.xml,
+then groups included there are included in the ClientMetadata instance
+group list. At the end of this process, the ClientMetadata instance has
+its complete set of group memberships. At this point, each connector
+plugin has the opportunity to return an additional object which will be
+placed in an attribute corresponding to the Connector name. For example,
+the Probes plugin returns a dictionary of probe name to probe result
+mappings for the client. This dictionary is available as the "Probes"
+attribute. With this, ClientMetadata resolution is complete, and the
+ClientMetadata instance can be used by the rest of the system.
 
 Contents
 ========
diff --git a/doc/server/plugins/connectors/properties.txt b/doc/server/plugins/connectors/properties.txt
index 9fb0dba87..e82cfc570 100644
--- a/doc/server/plugins/connectors/properties.txt
+++ b/doc/server/plugins/connectors/properties.txt
@@ -1,6 +1,6 @@
 .. -*- mode: rst -*-
 
-.. _server-plugins-properties:
+.. _server-plugins-connectors-properties:
 
 ==========
 Properties
diff --git a/doc/server/plugins/generators/tcheetah.txt b/doc/server/plugins/generators/tcheetah.txt
index da615bed7..ef8bb5513 100644
--- a/doc/server/plugins/generators/tcheetah.txt
+++ b/doc/server/plugins/generators/tcheetah.txt
@@ -50,6 +50,12 @@ self.metadata is an instance of the class ClientMetadata and documented
 self.metadata.Properties.data
 =============================
 
+.. note::
+
+    If you want to use Properties, you will need to enable the
+    :ref:`server-plugins-connectors-properties` plugin in
+    ``/etc/bcfg2.conf``.
+
 Properties.data is a python `ElementTree <http://codespeak.net/lxml/>`_
 object, loaded from the data in ``/var/lib/bcfg2/Properties/<properties
 file>.xml``. That file should have a ``Properties`` node at its root.
diff --git a/doc/server/plugins/generators/tgenshi/index.txt b/doc/server/plugins/generators/tgenshi/index.txt
index c1970ee0d..0fc541b52 100644
--- a/doc/server/plugins/generators/tgenshi/index.txt
+++ b/doc/server/plugins/generators/tgenshi/index.txt
@@ -48,8 +48,11 @@ supported.
 Inside of templates
 ===================
 
-* **metadata** is the client's :ref:`metadata <server-plugins-grouping-metadata-clientmetadata>`
-* **properties.properties** is an xml document of unstructured data
+* **metadata** is the client's :ref:`metadata
+  <server-plugins-grouping-metadata-clientmetadata>`
+* **metadata.Properties** is an xml document of unstructured data (only
+  available when used in conjunction with the
+  :ref:`server-plugins-connectors-properties` plugin)
 * **name** is the path name specified in bcfg
 * **path** is the path to the TGenshi template