summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorChris St. Pierre <chris.a.st.pierre@gmail.com>2011-04-13 13:29:48 -0400
committerChris St. Pierre <chris.a.st.pierre@gmail.com>2011-04-13 13:29:48 -0400
commit5819d7182ac703c9f830df1ea2b940fbfa976db7 (patch)
tree56bd88b8f34e7d0a636f42b8e91aaf1daa988cc0 /doc
parentc89cd2a8c930f3a2fc686b555079c9bc60803e0c (diff)
downloadbcfg2-5819d7182ac703c9f830df1ea2b940fbfa976db7.tar.gz
bcfg2-5819d7182ac703c9f830df1ea2b940fbfa976db7.tar.bz2
bcfg2-5819d7182ac703c9f830df1ea2b940fbfa976db7.zip
A property file can now have a matching .xsd file (e.g.,
"Properties/foo.xml" and "Properties/foo.xsd") which specifies a schema for that property file. bcfg2-repo-validate will check the property file against its schema. Updated bcfg2-repo-validate man page with several new options.
Diffstat (limited to 'doc')
-rw-r--r--doc/server/plugins/connectors/properties.txt11
1 files changed, 10 insertions, 1 deletions
diff --git a/doc/server/plugins/connectors/properties.txt b/doc/server/plugins/connectors/properties.txt
index ae8bf0caa..ef408916e 100644
--- a/doc/server/plugins/connectors/properties.txt
+++ b/doc/server/plugins/connectors/properties.txt
@@ -24,11 +24,20 @@ Properties adds a new dictionary to client metadata instances that maps
property file names to PropertyFile instances. PropertyFile instances
contain parsed XML data as the "data" attribute.
+The XML data in a property file is arbitrary, but a matching ``.xsd``
+file can be created to assign a schema to a property file, which will
+be checked when running ``bcfg2-repo-validate``. For instance, given::
+
+ Properties/dns-config.xml
+ Properties/dns-config.xsd
+
+``dns-config.xml`` will be validated against ``dns-config.xsd``.
+
Usage
=====
Specific property files can be referred to in
-templates as metadata.Properties[<filename>]. The
+templates as ``metadata.Properties[<filename>]``. The
data attribute is an LXML element object. (Documented
`here <http://codespeak.net/lxml/tutorial.html#the-element-class>`_)