doc: Add note about template extension locations

The code for supporting genshi templates alongside group and
host-specific files requires the user to append the extension to the end
(differently than how it is done in the TGenshi plugin).

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

2 files changed, 22 insertions, 8 deletions

diff --git a/doc/help/troubleshooting.txt b/doc/help/troubleshooting.txt
index bfd770cfd..17bc391bd 100644
--- a/doc/help/troubleshooting.txt
+++ b/doc/help/troubleshooting.txt
@@ -180,10 +180,12 @@ why.
 Why am I getting a traceback?
 -----------------------------
 
-If you get a traceback, please let us know by :ref:`reporting it
-<report-a-bug>` on Trac, via the mailing list, or on IRC. Your best bet
+If you get a traceback, please let us know by reporting it
+on `Trac ticket tracker`_, via the mailing list, or on IRC. Your best bet
 to get a quick response will be to jump on IRC during the daytime (CST).
 
+.. _Trac ticket tracker: http://bcfg2.org
+
 What is the most common cause of "The following entries are not handled by any tool"?
 -------------------------------------------------------------------------------------
 
diff --git a/doc/server/plugins/generators/cfg.txt b/doc/server/plugins/generators/cfg.txt
index 8b40eec67..612b14bec 100644
--- a/doc/server/plugins/generators/cfg.txt
+++ b/doc/server/plugins/generators/cfg.txt
@@ -24,12 +24,13 @@ the files on your clients, starting at the root level. For example::
     bin/  boot/  etc/  opt/  root/  usr/  var/
 
 Specific config files go in like-named directories in this
-heirarchy. For example the password file, ``/etc/passwd``, goes in
-``Cfg/etc/passwd/passwd``, while the ssh pam module config file,
-``/etc/pam.d/sshd``, goes in ``Cfg/etc/pam.d/sshd/sshd``. The reason
-for the like-name directory is to allow multiple versions of each file
-to exist, as described below. Note that these files are exact copies of
-what will appear on the client machine - no templates, XML wrappers, etc.
+heirarchy.  For example the password file, ``/etc/passwd``, goes
+in ``Cfg/etc/passwd/passwd``, while the ssh pam module config file,
+``/etc/pam.d/sshd``, goes in ``Cfg/etc/pam.d/sshd/sshd``. The reason for
+the like-name directory is to allow multiple versions of each file to
+exist, as described below. Note that these files are exact copies of what
+will appear on the client machine (except when using genshi templating --
+see below).
 
 Group-Specific Files
 ====================
@@ -157,6 +158,17 @@ will be processed using the new template style (like .newtxt in the TGenshi
 plugin).  Templates can be host and group specific as well.  Deltas will not
 be processed for any genshi base file.
 
+.. note::
+
+    If you are using genshi templating in combination with host-specific
+    or group-specific files, you will need to ensure that the ``.genshi``
+    extensions is at the **end** of the filename. Using the examples
+    from above for *host.example.com* and group *server* you would have
+    the following::
+
+        Cfg/etc/fstab/fstab.H_host.example.com.genshi
+        Cfg/etc/fstab/fstab.G50_server.genshi
+
 File permissions
 ================