summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/conf.py2
-rw-r--r--doc/development/compat.txt2
-rw-r--r--doc/exts/xmlschema.py7
-rw-r--r--doc/help/troubleshooting.txt4
-rw-r--r--doc/man/bcfg2.conf.txt12
-rw-r--r--doc/man/bcfg2.txt9
-rw-r--r--doc/reports/dynamic.txt14
-rw-r--r--doc/server/plugins/generators/packages.txt16
-rw-r--r--doc/server/plugins/generators/rules.txt2
-rw-r--r--doc/server/plugins/version/git.txt6
10 files changed, 45 insertions, 29 deletions
diff --git a/doc/conf.py b/doc/conf.py
index a1bceb1b1..d3d30687b 100644
--- a/doc/conf.py
+++ b/doc/conf.py
@@ -66,7 +66,7 @@ else:
# The short X.Y version.
version = '1.3'
# The full version, including alpha/beta/rc tags.
-release = '1.3.0'
+release = '1.3.1'
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
diff --git a/doc/development/compat.txt b/doc/development/compat.txt
index b7bf87bec..90df45676 100644
--- a/doc/development/compat.txt
+++ b/doc/development/compat.txt
@@ -98,6 +98,8 @@ behavior (e.g., :func:`input`) do not cause unexpected side-effects.
+---------------------------------+--------------------------------------------------+---------------------------------------------------------+
| reduce | :func:`reduce` | :func:`functools.reduce` |
+---------------------------------+--------------------------------------------------+---------------------------------------------------------+
+| long | :func:`long` | :func:`int` |
++---------------------------------+--------------------------------------------------+---------------------------------------------------------+
Python 2.4 compatibility
------------------------
diff --git a/doc/exts/xmlschema.py b/doc/exts/xmlschema.py
index 727b4bbd0..24cbf2e2d 100644
--- a/doc/exts/xmlschema.py
+++ b/doc/exts/xmlschema.py
@@ -76,6 +76,11 @@ from sphinx.util.nodes import make_refnode, split_explicit_title, \
from sphinx.util.compat import Directive
from sphinx.domains import ObjType, Domain
+try:
+ from new import classobj
+except ImportError:
+ classobj = type
+
XS = "http://www.w3.org/2001/XMLSchema"
XS_NS = "{%s}" % XS
NSMAP = dict(xs=XS)
@@ -653,7 +658,7 @@ def append_node(parent, cls_or_node, *contents):
def build_node(cls_or_node, *contents):
- if isinstance(cls_or_node, type):
+ if isinstance(cls_or_node, (type, classobj)):
rv = cls_or_node()
else:
rv = cls_or_node
diff --git a/doc/help/troubleshooting.txt b/doc/help/troubleshooting.txt
index 35c1e93a2..aac831ae0 100644
--- a/doc/help/troubleshooting.txt
+++ b/doc/help/troubleshooting.txt
@@ -56,8 +56,8 @@ the debug level individually on a given plugin, e.g.::
Finally, the File Activity Monitor has its own analogue to these two
methods, for setting the debug level of the FAM:
- bcfg2-admin xcmd toggle_fam_debug
- bcfg2-admin xcmd set_fam_debug false
+ bcfg2-admin xcmd Inotify.toggle_debug
+ bcfg2-admin xcmd Inotify.set_debug false
Check if all repository XML files conform to schemas
====================================================
diff --git a/doc/man/bcfg2.conf.txt b/doc/man/bcfg2.conf.txt
index d8f2bc3df..3a0217aef 100644
--- a/doc/man/bcfg2.conf.txt
+++ b/doc/man/bcfg2.conf.txt
@@ -729,11 +729,21 @@ control the database connection of the server.
port
Port for database connections. Not used for sqlite3.
+Reporting options
+-----------------
+
+ config
+ Specifies the location of the reporting configuration (default
+ is /etc/bcfg2-web.conf.
+
time_zone
- Specify a time zone other than that used on the system. (Note
+ Specifies a time zone other than that used on the system. (Note
that this will cause the Bcfg2 server to log messages in this
time zone as well).
+ web_debug
+ Turn on Django debugging.
+
See Also
--------
diff --git a/doc/man/bcfg2.txt b/doc/man/bcfg2.txt
index 6a77a4a3c..6df4f9b4f 100644
--- a/doc/man/bcfg2.txt
+++ b/doc/man/bcfg2.txt
@@ -88,10 +88,13 @@ Options
the constraints of correctness, and thus should only
be used in safe conditions.
-r mode Cause bcfg2 to remove extra configuration elements
- it detects. Mode is one of "all", "Services", or
- "Packages". "all" removes all entries. Likewise,
- "Services" and "Packages" remove only the extra
+ it detects. Mode is one of "all", "Services",
+ "Packages", or "Users". "all" removes all extra entries.
+ "Services", "Packages", and "Users" remove only the extra
configuration elements of the respective type.
+ ("Services" actually just disables extra services,
+ since they can't be removed, and "Users" removes
+ extra POSIXUser and POSIXUser entries.)
-s servicemode Set bcfg2 interaction level for services. Default
behavior is to modify all services affected by
reconfiguration. "build" mode attempts to stop all
diff --git a/doc/reports/dynamic.txt b/doc/reports/dynamic.txt
index 19c947a71..14eff6f54 100644
--- a/doc/reports/dynamic.txt
+++ b/doc/reports/dynamic.txt
@@ -166,20 +166,22 @@ Upgrading
2. Replace the DBStats plugin with the Reporting plugin.
3. Migrate historic data.
- Run `tools/upgrade/1.3/migrate_dbstats.py`
+ Run ``tools/upgrade/1.3/migrate_dbstats.py``
The reporting schema is now managed using `South <http://south.aeracode.org>`_
instead of a set of custom scripts. This creates the new schema and imports
all of the historic data to the new format.
-.. Note:
+ .. note::
- After the database is upgraded all of the old tables are left intact. To
- remove them any table starting with reports_ can be dropped.
+ After the database is upgraded all of the old tables are left
+ intact. To remove them any table starting with reports_ can
+ be dropped.
4. `(Optional)` Run the :ref:`Report Collector <report_collector>`
- Add "transport = LocalFilesystem" under "[reporting]" in `bcfg2.conf`.
- Restart the bcfg2-server and start the bcfg2-report-collector.
+ Add "transport = LocalFilesystem" under "[reporting]" in
+ ``bcfg2.conf``. Restart the bcfg2-server and start the
+ bcfg2-report-collector.
Configuring
===========
diff --git a/doc/server/plugins/generators/packages.txt b/doc/server/plugins/generators/packages.txt
index b6aa6190e..73145fd6b 100644
--- a/doc/server/plugins/generators/packages.txt
+++ b/doc/server/plugins/generators/packages.txt
@@ -279,7 +279,8 @@ something like this:
<Source type="apt" recommended="true" ...>
.. warning:: You must regenerate the Packages cache when adding or
- removing the recommended attribute.
+ removing the recommended attribute (``bcfg2-admin xcmd
+ Packages.Refresh``).
.. [#f1] Bcfg2 will by default add **Essential** packages to the
client specification. You can disable this behavior by
@@ -383,9 +384,9 @@ will report information like::
Packages: Updating http://mirror.centos.org/centos/5/extras/x86_64/repodata/filelists.xml.gz
Packages: Updating http://mirror.centos.org/centos/5/extras/x86_64/repodata/primary.xml.gz
-Once line per file download needed. ``Packages/sources.xml`` will
-be reloaded at this time, so any source specification changes (new
-or modified sources in this file) will be reflected by the server at
+One line per file download needed. ``Packages/sources.xml`` will be
+reloaded at this time, so any source specification changes (new or
+modified sources in this file) will be reflected by the server at
this point.
This process is much, much faster if you use the :ref:`native yum
@@ -488,7 +489,6 @@ Benefits to this include:
* Much lower memory usage by the ``bcfg2-server`` process.
* Much faster ``Packages.Refresh`` behavior.
* More accurate dependency resolution.
-* Support for package groups.
Drawbacks include:
@@ -537,9 +537,9 @@ generally be overridden:
Package Groups
--------------
-Yum package groups are supported by the native Yum libraries. To
-include a package group, use the
-:xml:attribute:`PackageStructure:group` attribute of the
+Yum package groups are supported by both the native Yum libraries and
+Bcfg2's internal dependency resolver. To include a package group, use
+the :xml:attribute:`PackageStructure:group` attribute of the
:xml:element:`Package` tag. You can use either the short group ID or
the long group name:
diff --git a/doc/server/plugins/generators/rules.txt b/doc/server/plugins/generators/rules.txt
index a3f29a803..2789411e7 100644
--- a/doc/server/plugins/generators/rules.txt
+++ b/doc/server/plugins/generators/rules.txt
@@ -393,7 +393,7 @@ For example:
<MemberOf>lp</MemberOf>
<MemberOf>adm</MemberOf>
<MemberOf>bin</MemberOf>
- </BoundPOSIXUser>
+ </POSIXUser>
The group specified will automatically be created if it does not
exist, even if there is no :xml:type:`POSIXGroup tag <POSIXGroupType>`
diff --git a/doc/server/plugins/version/git.txt b/doc/server/plugins/version/git.txt
index 3f7ab9d9b..64ff422ca 100644
--- a/doc/server/plugins/version/git.txt
+++ b/doc/server/plugins/version/git.txt
@@ -13,12 +13,6 @@ reporting purposes. Once the plugin is enabled, every time a client
checks in, it will include the current repository revision in the
reports/statistics.
-As with the other Version plugins, the Git plugin enables you to get
-revision information out of your repository for reporting
-purposes. Once the plugin is enabled, every time a client checks in,
-it will include the current repository revision in the
-reports/statistics.
-
Additionally, if the ``GitPython`` library is installed, the Git
plugin exposes an additional XML-RPC method call, ``Git.Update``.
With no arguments, ``Git.Update`` updates the working copy to the
generated by cgit v1.2.3-1-g7c22 (git 2.25.1) at 2024-07-11 00:11:55 +0000