summaryrefslogtreecommitdiffstats
path: root/doc/development
diff options
context:
space:
mode:
authorChris St. Pierre <chris.a.st.pierre@gmail.com>2013-08-14 13:12:13 -0400
committerChris St. Pierre <chris.a.st.pierre@gmail.com>2013-08-14 13:12:13 -0400
commit42248f4465110ce4779745e6145075a0a9574c1a (patch)
treea047d3ebf28c779993c9a143138b08c93fb05e16 /doc/development
parenta9a7c84703eb7250012fd68af3e4ca77eae07029 (diff)
downloadbcfg2-42248f4465110ce4779745e6145075a0a9574c1a.tar.gz
bcfg2-42248f4465110ce4779745e6145075a0a9574c1a.tar.bz2
bcfg2-42248f4465110ce4779745e6145075a0a9574c1a.zip
Revert "doc: minor fixes"
Commit had more stuff in it than it should have. This reverts commit a9a7c84703eb7250012fd68af3e4ca77eae07029.
Diffstat (limited to 'doc/development')
-rw-r--r--doc/development/caching.txt73
-rw-r--r--doc/development/cfg.txt6
-rw-r--r--doc/development/core.txt2
3 files changed, 6 insertions, 75 deletions
diff --git a/doc/development/caching.txt b/doc/development/caching.txt
deleted file mode 100644
index 47d627278..000000000
--- a/doc/development/caching.txt
+++ /dev/null
@@ -1,73 +0,0 @@
-.. -*- mode: rst -*-
-
-.. _development-cache:
-
-============================
- Server-side Caching System
-============================
-
-.. versionadded:: 1.4.0
-
-Bcfg2 caches two kinds of data:
-
-* The contents of all files that it reads in, including (often) an
- optimized representation. E.g., XML files are cached both in their
- raw (text) format, and also as :class:`lxml.etree._Element` objects.
-* Arbitrary data, in the server-side caching system documented on this
- page.
-
-The caching system keeps a single unified cache with all cache data in
-it. Each individual datum stored in the cache is associated with any
-number of "tags" -- simple terms that uniquely identify the datum.
-This lets you very easily expire related data from multiple caches at
-once; for isntance, for expiring all data related to a host:
-
-.. code-block:: python
-
- Bcfg2.Server.Cache.expire("foo.example.com")
-
-This would expire *all* data related to ``foo.example.com``,
-regardless of which plugin cached it, and so on.
-
-This permits a high level of interoperation between different plugins
-and the cache, which is necessary due to the wide distribution of data
-in Bcfg2 and the many different data sources that can be incorported.
-More technical details about writing code that uses the caches is below.
-
-Currently known caches are:
-
-.. currentmodule:: Bcfg2.Server.Plugins.Packages.Collection
-
-+-------------+---------------------------------------+-------------------------------------------------+------------------------------------------------------+
-| Tags | Key(s) | Values | Use |
-+=============+=======================================+=================================================+======================================================+
-| Metadata | Hostname | :class:`ClientMetadata | The :ref:`Metadata cache <server-caching>` |
-| | | <Bcfg2.Server.Plugins.Metadata.ClientMetadata>` | |
-+-------------+---------------------------------------+-------------------------------------------------+------------------------------------------------------+
-| Probes, | Hostname | ``list`` of group names | Groups set by :ref:`server-plugins-probes-index` |
-| probegroups | | | |
-+-------------+---------------------------------------+-------------------------------------------------+------------------------------------------------------+
-| Probes, | Hostname | ``dict`` of ``<probe name>``: | Other data set by :ref:`server-plugins-probes-index` |
-| probedata | | :class:`ProbeData | |
-| | | <Bcfg2.Server.Plugins.Probes.ProbeData>` | |
-+-------------+---------------------------------------+-------------------------------------------------+------------------------------------------------------+
-| Packages, | :attr:`Packages Collection cache key | :class:`Collection` | Kept by :ref:`server-plugins-generators-packages` in |
-| collections | <Collection.cachekey>` | | order to expire repository metadata cached on disk |
-+-------------+---------------------------------------+-------------------------------------------------+------------------------------------------------------+
-| Packages, | Hostname | :attr:`Packages Collection cache key | Used by the Packages plugin to return Collection |
-| clients | | <Collection.cachekey>` | objects for clients. This is cross-referenced with |
-| | | | the ``Packages, collections`` cache |
-+-------------+---------------------------------------+-------------------------------------------------+------------------------------------------------------+
-| Packages, | :attr:`Packages Collection cache key | ``set`` of package names | Cached results from looking up |
-| pkg_groups | <Collection.cachekey>`, | | ``<Package group="..."/>`` entries |
-| | hash of the selected package groups | | |
-+-------------+---------------------------------------+-------------------------------------------------+------------------------------------------------------+
-| Packages, | :attr:`Packages Collection cache key | ``set`` of package names | Cached results from resolving complete package sets |
-| pkg_sets | <Collection.cachekey>`, | | for clients |
-| | hash of the initial package selection | | |
-+-------------+---------------------------------------+-------------------------------------------------+------------------------------------------------------+
-
-These are enumerated so that they can be expired as needed by other
-plugins or other code points.
-
-.. automodule:: Bcfg2.Server.Cache
diff --git a/doc/development/cfg.txt b/doc/development/cfg.txt
index f93bb42c7..a4360559f 100644
--- a/doc/development/cfg.txt
+++ b/doc/development/cfg.txt
@@ -55,6 +55,11 @@ exceptions:
.. autoexception:: Bcfg2.Server.Plugin.exceptions.PluginInitError
:noindex:
+Global Variables
+================
+
+.. autodata:: Bcfg2.Server.Plugins.Cfg.CFG
+
Existing Cfg Handlers
=====================
@@ -94,4 +99,3 @@ included for completeness.
.. autoclass:: Bcfg2.Server.Plugins.Cfg.CfgEntrySet
.. autoclass:: Bcfg2.Server.Plugins.Cfg.Cfg
-.. automethod:: Bcfg2.Server.Plugins.Cfg.get_cfg
diff --git a/doc/development/core.txt b/doc/development/core.txt
index f5cc7de67..ecbcbebd3 100644
--- a/doc/development/core.txt
+++ b/doc/development/core.txt
@@ -86,4 +86,4 @@ Multiprocessing Core
CherryPy Core
-------------
-.. automodule:: Bcfg2.Server.CherrypyCore
+.. automodule:: Bcfg2.Server.CherryPyCore