[svn] commit: r1443 - in /trunk/src/bin/bindctl: bindcmd.py bindctl-source.py.in cmdparse.py exception.py moduleinfo.py

[BIND 10 source code commits]

Author: jelte
Date: Tue Mar 16 12:39:09 2010
New Revision: 1443

Log:
added some module-level docstrings

Modified:
    trunk/src/bin/bindctl/bindcmd.py
    trunk/src/bin/bindctl/bindctl-source.py.in
    trunk/src/bin/bindctl/cmdparse.py
    trunk/src/bin/bindctl/exception.py
    trunk/src/bin/bindctl/moduleinfo.py

Modified: trunk/src/bin/bindctl/bindcmd.py
==============================================================================
--- trunk/src/bin/bindctl/bindcmd.py (original)
+++ trunk/src/bin/bindctl/bindcmd.py Tue Mar 16 12:39:09 2010
@@ -12,6 +12,11 @@
 # FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT,
 # NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION
 # WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+
+"""This module holds the BindCmdInterpreter class. This provides the
+   core functionality for bindctl. It maintains a session with
+   b10-cmdctl, holds local configuration and module information, and
+   handles command line interface commands"""
 
 import sys
 from cmd import Cmd

Modified: trunk/src/bin/bindctl/bindctl-source.py.in
==============================================================================
--- trunk/src/bin/bindctl/bindctl-source.py.in (original)
+++ trunk/src/bin/bindctl/bindctl-source.py.in Tue Mar 16 12:39:09 2010
@@ -15,6 +15,8 @@
 # NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION
 # WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 
+"""This is the main calling class for the bindctl configuration and
+   command tool. It sets up a command interpreter and runs that."""
 
 import sys; sys.path.append ('@@PYTHONPATH@@')
 
@@ -26,6 +28,7 @@
 __version__ = 'Bindctl'
 
 def prepare_config_commands(tool):
+    '''Prepare fixed commands for local configuration editing'''
     module = ModuleInfo(name = "config", desc = "Configuration commands")
     cmd = CommandInfo(name = "show", desc = "Show configuration")
     param = ParamInfo(name = "identifier", type = "string", optional=True)

Modified: trunk/src/bin/bindctl/cmdparse.py
==============================================================================
--- trunk/src/bin/bindctl/cmdparse.py (original)
+++ trunk/src/bin/bindctl/cmdparse.py Tue Mar 16 12:39:09 2010
@@ -12,6 +12,9 @@
 # FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT,
 # NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION
 # WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+
+
+"""This module holds the command parser class for bindctl"""
 
 import re
 from bindctl.exception import *

Modified: trunk/src/bin/bindctl/exception.py
==============================================================================
--- trunk/src/bin/bindctl/exception.py (original)
+++ trunk/src/bin/bindctl/exception.py Tue Mar 16 12:39:09 2010
@@ -13,7 +13,7 @@
 # NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION
 # WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 
-
+"""This module holds exception classes specific for bindctl"""
 class BindCtlException(Exception):
     """Abstract base class shared by all bindctl exceptions"""
     def __str__(self):

Modified: trunk/src/bin/bindctl/moduleinfo.py
==============================================================================
--- trunk/src/bin/bindctl/moduleinfo.py (original)
+++ trunk/src/bin/bindctl/moduleinfo.py Tue Mar 16 12:39:09 2010
@@ -13,6 +13,8 @@
 # NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION
 # WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 
+"""This module holds classes representing modules, commands and
+   parameters for use in bindctl"""
 
 try:
     from collections import OrderedDict