From d526c8745b61c1977b775cfe750a86c51dd6a9f3 Mon Sep 17 00:00:00 2001
From: "Chris St. Pierre" <chris.a.st.pierre@gmail.com>
Date: Wed, 13 Feb 2013 16:07:30 -0500
Subject: added docs for Bcfg2.Utils

---
 doc/development/client-driver.txt |  9 +++++++--
 doc/development/plugins.txt       |  8 +++++++-
 doc/development/utils.txt         | 15 +++++++++++++++
 3 files changed, 29 insertions(+), 3 deletions(-)
 create mode 100644 doc/development/utils.txt

(limited to 'doc')

diff --git a/doc/development/client-driver.txt b/doc/development/client-driver.txt
index 29216acd5..5977f2a91 100644
--- a/doc/development/client-driver.txt
+++ b/doc/development/client-driver.txt
@@ -65,6 +65,11 @@ Base Classes
 Helper Classes
 --------------
 
-.. autoclass:: Bcfg2.Client.Tools.ClassName
-.. autoclass:: Bcfg2.Client.Tools.Executor
 .. autoclass:: Bcfg2.Client.Tools.ToolInstantiationError
+
+See Also
+--------
+
+* :ref:`development-compat`
+* :ref:`development-utils`
+
diff --git a/doc/development/plugins.txt b/doc/development/plugins.txt
index 91a4e6868..593c2f83e 100644
--- a/doc/development/plugins.txt
+++ b/doc/development/plugins.txt
@@ -175,7 +175,7 @@ decorate functions that you would like to track execution times for:
 .. code-block:: python
 
     from Bcfg2.Server.Plugin import track_statistics
-    
+
     @track_statistics()
     def do_something(self, ...):
         ...
@@ -208,3 +208,9 @@ Plugin Exceptions
 -----------------
 
 .. automodule:: Bcfg2.Server.Plugin.exceptions
+
+See Also
+--------
+
+* :ref:`development-compat`
+* :ref:`development-utils
diff --git a/doc/development/utils.txt b/doc/development/utils.txt
new file mode 100644
index 000000000..a4c158bf0
--- /dev/null
+++ b/doc/development/utils.txt
@@ -0,0 +1,15 @@
+.. -*- mode: rst -*-
+
+.. _development-utils:
+
+================
+Common Utilities
+================
+
+Some helper functions, classes, etc., are useful to both the client
+and server.  Some of these are used to maintain
+:ref:`development-compat`, and should go in ``Bcfg2.Compat``.  Those
+that aren't strictly for Python compatibility go in ``Bcfg2.Utils``,
+which is documented below.
+
+.. automodule:: Bcfg2.Utils
-- 
cgit v1.2.3-1-g7c22