diff options
| author | Jack Neely <jjneely@ncsu.edu> | 2011-06-10 13:29:23 -0400 |
|---|---|---|
| committer | Jack Neely <jjneely@ncsu.edu> | 2011-06-10 13:29:23 -0400 |
| commit | 90c85147bacea14771abf8faa1fc5f185418d14b (patch) | |
| tree | b10e06fc80ed714f5376b169e32b8953479211f1 /doc/development | |
| parent | 4f3da4543ec4e8c3c4776ae2ee3611e47ce78525 (diff) | |
| parent | ce6a228d33ace4136dc2b5388c64795dfbd26ffb (diff) | |
| download | bcfg2-90c85147bacea14771abf8faa1fc5f185418d14b.tar.gz bcfg2-90c85147bacea14771abf8faa1fc5f185418d14b.tar.bz2 bcfg2-90c85147bacea14771abf8faa1fc5f185418d14b.zip | |
Merge branch 'master' of github.com:solj/bcfg2
Diffstat (limited to 'doc/development')
| -rw-r--r-- | doc/development/client-driver.txt | 1 | ||||
| -rw-r--r-- | doc/development/docstyleguide.txt | 6 | ||||
| -rw-r--r-- | doc/development/plugins.txt | 6 |
3 files changed, 9 insertions, 4 deletions
diff --git a/doc/development/client-driver.txt b/doc/development/client-driver.txt index cc065dd32..32bb0aff4 100644 --- a/doc/development/client-driver.txt +++ b/doc/development/client-driver.txt @@ -10,7 +10,6 @@ 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`` #. 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) diff --git a/doc/development/docstyleguide.txt b/doc/development/docstyleguide.txt index fda1037f3..59db58362 100644 --- a/doc/development/docstyleguide.txt +++ b/doc/development/docstyleguide.txt @@ -25,3 +25,9 @@ Basics When used alone this refers to a Bcfg2 :term:`repository`. When there is a chance for confusion, for instance in documents also talking about :term:`VCS`, be sure to use the longer Bcfg2 :term:`repository`. + +Sections +-------- + +Unless necessary, all the documentation follows the sections header +rules available at http://docs.python.org/documenting/rest.html#sections. diff --git a/doc/development/plugins.txt b/doc/development/plugins.txt index 709b9fcec..4c723f7e9 100644 --- a/doc/development/plugins.txt +++ b/doc/development/plugins.txt @@ -139,7 +139,7 @@ Example Plugin __version__ = '1' __author__ = 'me@me.com' __rmi__ = ['myfunction'] - # myfunction is not available remotely as MyPlugin.myfunction + # myfunction is now available remotely as MyPlugin.myfunction def __init__(self, core, datastore): Bcfg2.Server.Plugin.Plugin.__init__(self, core, datastore) @@ -206,8 +206,8 @@ do so. We will call our new plugin `MyMetadata`. __version__ = '$Id$' __author__ = 'bcfg-dev@mcs.anl.gov' - def __init__(self, core, datastore, watch_clients=True): - Bcfg2.Server.Plugins.Metadata.Metadata.__init__(self, core, datastore, watch_clients) + def __init__(self, core, datastore, watch_clients=True): + Bcfg2.Server.Plugins.Metadata.Metadata.__init__(self, core, datastore, watch_clients) #. Add MyMetadata to ``src/lib/Server/Plugins/__init__.py`` #. Replace Metadata with MyMetadata in the plugins line of bcfg2.conf |