diff options
| author | Chris St. Pierre <chris.a.st.pierre@gmail.com> | 2013-03-21 14:35:04 -0400 |
|---|---|---|
| committer | Chris St. Pierre <chris.a.st.pierre@gmail.com> | 2013-03-21 14:35:04 -0400 |
| commit | 38f99b402d3118e2c26ff42d72ddf9b666adac13 (patch) | |
| tree | 705d18bed66337192816325facb1733280291ff5 /doc/development | |
| parent | a3f2a731bbef5d9c2033eed23432aa7792d47989 (diff) | |
| parent | 71d7285c405bd639f1f9f2642ea8fb567b97caec (diff) | |
| download | bcfg2-38f99b402d3118e2c26ff42d72ddf9b666adac13.tar.gz bcfg2-38f99b402d3118e2c26ff42d72ddf9b666adac13.tar.bz2 bcfg2-38f99b402d3118e2c26ff42d72ddf9b666adac13.zip | |
Merge branch '1.3.2' into maint
Conflicts:
src/lib/Bcfg2/Client/Tools/__init__.py
src/sbin/bcfg2-test
testsuite/Testsrc/Testlib/TestClient/TestTools/TestPOSIX/Test__init.py
testsuite/Testsrc/Testlib/TestClient/TestTools/TestPOSIXUsers.py
testsuite/Testsrc/test_code_checks.py
Diffstat (limited to 'doc/development')
| -rw-r--r-- | doc/development/client-driver.txt | 9 | ||||
| -rw-r--r-- | doc/development/plugins.txt | 8 | ||||
| -rw-r--r-- | doc/development/utils.txt | 15 |
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 |