summaryrefslogtreecommitdiffstats
path: root/doc/development
diff options
context:
space:
mode:
authorChris St. Pierre <chris.a.st.pierre@gmail.com>2013-03-21 14:37:27 -0400
committerChris St. Pierre <chris.a.st.pierre@gmail.com>2013-03-21 14:37:27 -0400
commitc9ba92ef62376bbf01da1eac96cd5a2b5eb65a66 (patch)
tree19a61840175d2fb16ea51dedf49abd45d2417774 /doc/development
parentf36c89f5e78a3a2fcd9ad4b38b8670895883bd38 (diff)
parente88c029c6fdbedb038443c8cbe52206d9ca9c1a2 (diff)
downloadbcfg2-c9ba92ef62376bbf01da1eac96cd5a2b5eb65a66.tar.gz
bcfg2-c9ba92ef62376bbf01da1eac96cd5a2b5eb65a66.tar.bz2
bcfg2-c9ba92ef62376bbf01da1eac96cd5a2b5eb65a66.zip
Merge branch 'maint'
Diffstat (limited to 'doc/development')
-rw-r--r--doc/development/client-driver.txt9
-rw-r--r--doc/development/plugins.txt8
-rw-r--r--doc/development/utils.txt15
3 files changed, 29 insertions, 3 deletions
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