summaryrefslogtreecommitdiffstats
path: root/doc/development/client-driver.txt
diff options
context:
space:
mode:
authorSol Jerome <sol.jerome@gmail.com>2010-12-08 19:43:54 -0600
committerSol Jerome <sol.jerome@gmail.com>2010-12-08 19:43:54 -0600
commit477c0fc85218cba12597cf3daf7728b127b0fd64 (patch)
tree0da3e2c73535cd97c22791e51e20b18b3192506c /doc/development/client-driver.txt
parent9f55492d9213861c75496e6c493ad90bb5c23872 (diff)
downloadbcfg2-477c0fc85218cba12597cf3daf7728b127b0fd64.tar.gz
bcfg2-477c0fc85218cba12597cf3daf7728b127b0fd64.tar.bz2
bcfg2-477c0fc85218cba12597cf3daf7728b127b0fd64.zip
doc: Finish merging remaining documentation updates
Signed-off-by: Sol Jerome <sol.jerome@gmail.com>
Diffstat (limited to 'doc/development/client-driver.txt')
-rw-r--r--doc/development/client-driver.txt16
1 files changed, 8 insertions, 8 deletions
diff --git a/doc/development/client-driver.txt b/doc/development/client-driver.txt
index 19da9cb67..cc065dd32 100644
--- a/doc/development/client-driver.txt
+++ b/doc/development/client-driver.txt
@@ -10,20 +10,20 @@ driver for a configuration element type. The included example describes
an existing driver, and the process that was used to create it.
#. Pick a name for the driver. In this case, we picked the name RPM.
-#. Add "RPM" to the ``__all__ list`` in ``src/lib/Client/Tools/__init__.py``
+#. Add "RPM" to the ``__all__`` list in ``src/lib/Client/Tools/__init__.py``
#. Create a file in ``src/lib/Client/Tools`` with the same name (RPM.py)
-#. Create a class in this file with the same name (``class RPM``)
+#. Create a class in this file with the same name (class RPM)
- * If it handles ``Package`` entries, subclass ``Bcfg2.Client.Tools.PkgTool``
+ * If it handles **Package** entries, subclass ``Bcfg2.Client.Tools.PkgTool``
(from here referenced as branch [P])
- * If it handles ``Service`` entries, subclass ``Bcfg2.Client.Tools.SvcTool``
+ * If it handles **Service** entries, subclass ``Bcfg2.Client.Tools.SvcTool``
(from here referenced as branch [S])
- * Otherwise, ``subclass Bcfg2.Client.Tools.Tool`` (from here referenced
+ * Otherwise, subclass ``Bcfg2.Client.Tools.Tool`` (from here referenced
as branch [T])
#. Set ``__name__`` to "RPM"
#. Add any required executable programs to ``__execs__``
-#. Set ``__handles__`` to a list of (``entry.tag``, ``entry.get('type')``)
+#. Set ``__handles__`` to a list of (**entry.tag**, **entry.get('type')**)
tuples. This determines which entries the Tool module can be used
on. In this case, we set ``__handles__ = [('Package', 'rpm')]``.
#. Add verification. This method should return True/False depending
@@ -46,9 +46,9 @@ an existing driver, and the process that was used to create it.
all-at-once installations, followed, in the case of failures,
by single installations. To enable this support, set the pkgtype
attribute to the package type handled by this driver. Set the
- ``pkgtool`` to a tuple ("command string %s", ("per-package string
+ pkgtool to a tuple ("command string %s", ("per-package string
format", [list of package entry fields])). For RPM, we have
- ``setup pkgtool = ("rpm --oldpackage --replacepkgs --quiet -U %s", ("%s", ["url"]))``
+ setup ``pkgtool = ("rpm --oldpackage --replacepkgs --quiet -U %s", ("%s", ["url"]))``
#. Implement entry removal