From 988a58f949ac1771f7f805a1bf45e8895ab6f884 Mon Sep 17 00:00:00 2001 From: "Chris St. Pierre" Date: Thu, 17 Jan 2013 11:16:26 -0500 Subject: docs: removed stray reference to SETUP global --- doc/development/cfg.txt | 1 - 1 file changed, 1 deletion(-) (limited to 'doc/development') diff --git a/doc/development/cfg.txt b/doc/development/cfg.txt index 6533e0d7a..c3b8d12af 100644 --- a/doc/development/cfg.txt +++ b/doc/development/cfg.txt @@ -58,7 +58,6 @@ exceptions: Global Variables ================ -.. autodata:: Bcfg2.Server.Plugins.Cfg.SETUP .. autodata:: Bcfg2.Server.Plugins.Cfg.CFG Existing Cfg Handlers -- cgit v1.2.3-1-g7c22 From b79027f553c82be75e49bcf9bde2f92ab72304c7 Mon Sep 17 00:00:00 2001 From: "Chris St. Pierre" Date: Thu, 17 Jan 2013 13:39:48 -0500 Subject: removed straggling references to removed stuff --- doc/development/cfg.txt | 7 ------- doc/development/fam.txt | 5 ----- 2 files changed, 12 deletions(-) (limited to 'doc/development') diff --git a/doc/development/cfg.txt b/doc/development/cfg.txt index c3b8d12af..71c455b52 100644 --- a/doc/development/cfg.txt +++ b/doc/development/cfg.txt @@ -80,18 +80,11 @@ Creators .. autoclass:: Bcfg2.Server.Plugins.Cfg.CfgPrivateKeyCreator.CfgPrivateKeyCreator .. autoclass:: Bcfg2.Server.Plugins.Cfg.CfgPublicKeyCreator.CfgPublicKeyCreator -Filters -------- - -.. autoclass:: Bcfg2.Server.Plugins.Cfg.CfgCatFilter.CfgCatFilter -.. autoclass:: Bcfg2.Server.Plugins.Cfg.CfgDiffFilter.CfgDiffFilter - Info Handlers ------------- .. autoclass:: Bcfg2.Server.Plugins.Cfg.CfgDefaultInfo .. autoclass:: Bcfg2.Server.Plugins.Cfg.CfgInfoXML.CfgInfoXML -.. autoclass:: Bcfg2.Server.Plugins.Cfg.CfgLegacyInfo.CfgLegacyInfo Verifiers --------- diff --git a/doc/development/fam.txt b/doc/development/fam.txt index c2c3b14f5..e967aaf68 100644 --- a/doc/development/fam.txt +++ b/doc/development/fam.txt @@ -56,11 +56,6 @@ Pseudo .. automodule:: Bcfg2.Server.FileMonitor.Pseudo -Fam ---- - -.. automodule:: Bcfg2.Server.FileMonitor.Fam - Gamin ----- -- cgit v1.2.3-1-g7c22 From 25cb6db5ccb0c8e8302c220a90344a95baf3909b Mon Sep 17 00:00:00 2001 From: "Chris St. Pierre" Date: Tue, 5 Feb 2013 14:04:09 -0500 Subject: moved some libraries in Bcfg2/ into more specific (Server/ or Client/) places --- doc/development/core.txt | 4 ++-- doc/development/plugins.txt | 22 ++++++++++++---------- 2 files changed, 14 insertions(+), 12 deletions(-) (limited to 'doc/development') diff --git a/doc/development/core.txt b/doc/development/core.txt index 3607533ea..205eb5c59 100644 --- a/doc/development/core.txt +++ b/doc/development/core.txt @@ -59,7 +59,7 @@ Builtin Core The builtin server core consists of the core implementation (:class:`Bcfg2.Server.BuiltinCore.Core`) and the XML-RPC server -implementation (:mod:`Bcfg2.SSLServer`). +implementation (:mod:`Bcfg2.Server.SSLServer`). Core ~~~~ @@ -69,7 +69,7 @@ Core XML-RPC Server ~~~~~~~~~~~~~~ -.. automodule:: Bcfg2.SSLServer +.. automodule:: Bcfg2.Server.SSLServer CherryPy Core ------------- diff --git a/doc/development/plugins.txt b/doc/development/plugins.txt index 91a4e6868..04b9ff7b1 100644 --- a/doc/development/plugins.txt +++ b/doc/development/plugins.txt @@ -128,13 +128,15 @@ The two attributes you need to know about are: of the caching mode. See :ref:`server-caching` for a description of each mode. * :attr:`Bcfg2.Server.Core.metadata_cache`: A dict-like - :class:`Bcfg2.Cache.Cache` object that stores the cached data. + :class:`Bcfg2.Server.Cache.Cache` object that stores the cached + data. :class:`Bcfg2.Server.Plugin.base.Plugin` objects have access to the :class:`Bcfg2.Server.Core` object as ``self.core``. In general, -you'll be interested in the :func:`Bcfg2.Cache.Cache.expire` method; -if called with no arguments, it expires all cached data; if called -with one string argument, it expires cached data for the named client. +you'll be interested in the :func:`Bcfg2.Server.Cache.Cache.expire` +method; if called with no arguments, it expires all cached data; if +called with one string argument, it expires cached data for the named +client. It's important, therefore, that your Connector plugin can either track when changes are made to the group membership it reports, and expire @@ -163,7 +165,7 @@ Tracking Execution Time .. versionadded:: 1.3.0 Statistics can and should track execution time statistics using -:mod:`Bcfg2.Statistics`. This module tracks execution time for the +:mod:`Bcfg2.Server.Statistics`. This module tracks execution time for the server core and for plugins, and exposes that data via ``bcfg2-admin perf``. This data can be invaluable for locating bottlenecks or other performance issues. @@ -175,7 +177,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, ...): ... @@ -184,13 +186,13 @@ This will track the execution time of ``do_something``. More granular usage is possible by using :func:`time.time` to manually determine the execution time of a given event and calling -:func:`Bcfg2.Statistics.Statistics.add_value` with an appropriate +:func:`Bcfg2.Server.Statistics.Statistics.add_value` with an appropriate statistic name. -Bcfg2.Statistics -^^^^^^^^^^^^^^^^ +Bcfg2.Server.Statistics +^^^^^^^^^^^^^^^^^^^^^^^ -.. automodule:: Bcfg2.Statistics +.. automodule:: Bcfg2.Server.Statistics Plugin Helper Classes --------------------- -- cgit v1.2.3-1-g7c22 From 65caf3f586d7985d88652c73e7b214ba3e40eac2 Mon Sep 17 00:00:00 2001 From: "Chris St. Pierre" Date: Wed, 6 Feb 2013 16:47:44 -0500 Subject: documented which XML files have which features --- doc/development/cfg.txt | 1 - 1 file changed, 1 deletion(-) (limited to 'doc/development') diff --git a/doc/development/cfg.txt b/doc/development/cfg.txt index 71c455b52..a4360559f 100644 --- a/doc/development/cfg.txt +++ b/doc/development/cfg.txt @@ -97,6 +97,5 @@ Other Cfg Objects These other objects comprise the remainder of the Cfg plugin, and are included for completeness. -.. autoattribute:: Bcfg2.Server.Plugins.Cfg.DEFAULT_INFO .. autoclass:: Bcfg2.Server.Plugins.Cfg.CfgEntrySet .. autoclass:: Bcfg2.Server.Plugins.Cfg.Cfg -- cgit v1.2.3-1-g7c22 From ad66b2e22eb64299d2f4dcd29e15e7083887813f Mon Sep 17 00:00:00 2001 From: "Chris St. Pierre" 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 | 6 ++++++ doc/development/utils.txt | 15 +++++++++++++++ 3 files changed, 28 insertions(+), 2 deletions(-) create mode 100644 doc/development/utils.txt (limited to 'doc/development') 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 04b9ff7b1..3ca137159 100644 --- a/doc/development/plugins.txt +++ b/doc/development/plugins.txt @@ -210,3 +210,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