diff bitten/slave.py @ 411:a169d2e96463

Use reStructuredText as the API documentation syntax.
author cmlenz
date Tue, 07 Aug 2007 11:29:11 +0000
parents 933105ab516b
children aa34d82b2c9a
line wrap: on
line diff
--- a/bitten/slave.py
+++ b/bitten/slave.py
@@ -29,6 +29,9 @@
 from bitten.recipe import Recipe, InvalidRecipeError
 from bitten.util import xmlio
 
+__all__ = ['BuildSlave', 'ExitSlave']
+__docformat__ = 'restructuredtext en'
+
 log = logging.getLogger('bitten.slave')
 
 
@@ -51,20 +54,19 @@
                  username=None, password=None):
         """Create the build slave instance.
         
-        @param url: The URL of the build master
-        @param port: TCP port number of the build master to connect to
-        @param name: The name with which this slave should identify itself
-        @param config: The slave configuration
-        @param dry_run: Whether the build outcome should not be reported back
-            to the master
-        @param work_dir: The working directory to use for build execution
-        @param keep_files: Whether files and directories created for build
-            execution should be kept when done
-        @param single_build: Whether this slave should exit after completing a 
-            single build, or continue processing builds forever
-        @param username: the username to use when authentication against the
-            build master is requested
-        @param password: the password to use when authentication is needed
+        :param url: The URL of the build master
+        :param name: The name with which this slave should identify itself
+        :param config: The slave configuration
+        :param dry_run: Whether the build outcome should not be reported back
+                        to the master
+        :param work_dir: The working directory to use for build execution
+        :param keep_files: Whether files and directories created for build
+                           execution should be kept when done
+        :param single_build: Whether this slave should exit after completing a 
+                             single build, or continue processing builds forever
+        :param username: the username to use when authentication against the
+                         build master is requested
+        :param password: the password to use when authentication is needed
         """
         self.url = url
         if name is None:
@@ -214,7 +216,8 @@
 
 class ExitSlave(Exception):
     """Exception used internally by the slave to signal that the slave process
-    should be stopped."""
+    should be stopped.
+    """
 
 
 def main():
Copyright (C) 2012-2017 Edgewall Software