[Branch,~linaro-validation/lava-dispatcher/trunk] Rev 149: Merge doc update to milestone 2011.10

Message ID 20111025021113.31175.18867.launchpad@ackee.canonical.com
State Accepted
Headers show

Commit Message

Spring Zhang Oct. 25, 2011, 2:11 a.m.
Merge authors:
  Spring Zhang (qzhang)
Related merge proposals:
  https://code.launchpad.net/~qzhang/lava-dispatcher/update-doc-201110/+merge/80171
  proposed by: Spring Zhang (qzhang)
  review: Approve - Michael Hudson-Doyle (mwhudson)
------------------------------------------------------------
revno: 149 [merge]
committer: Spring Zhang <spring.zhang@linaro.org>
branch nick: update-doc-201110
timestamp: Tue 2011-10-25 10:09:18 +0800
message:
  Merge doc update to milestone 2011.10
added:
  doc/code.rst
modified:
  doc/changes.rst
  doc/index.rst
  lava_dispatcher/android_client.py
  lava_dispatcher/client.py


--
lp:lava-dispatcher
https://code.launchpad.net/~linaro-validation/lava-dispatcher/trunk

You are subscribed to branch lp:lava-dispatcher.
To unsubscribe from this branch go to https://code.launchpad.net/~linaro-validation/lava-dispatcher/trunk/+edit-subscription

Patch

=== modified file 'doc/changes.rst'
--- doc/changes.rst	2011-10-09 07:17:05 +0000
+++ doc/changes.rst	2011-10-21 05:59:21 +0000
@@ -1,6 +1,19 @@ 
 Version History
 ***************
 
+.. _version_0_3_4:
+
+Version 0.3.4(Milestone 11.10)
+==============================
+
+* Documentation for lava-dispatcher is now available from lava-dispatcher.readthedocs.org
+
+* Added support for snowball boards
+
+* Move bootloader prompt string to device_type configuration file
+
+* Bug fixes: #873043, #861115, #867858, #863091, #872948, #877045, #855384
+
 .. _version_0_3:
 
 Version 0.3(Milestone 11.09)

=== added file 'doc/code.rst'
--- doc/code.rst	1970-01-01 00:00:00 +0000
+++ doc/code.rst	2011-10-24 02:35:49 +0000
@@ -0,0 +1,12 @@ 
+
+Code Documentation
+******************
+
+.. automodule:: lava_dispatcher
+    :members:
+
+.. automodule:: lava_dispatcher.client
+    :members:
+
+.. automodule:: lava_dispatcher.android_client
+    :members:

=== modified file 'doc/index.rst'
--- doc/index.rst	2011-10-09 09:46:11 +0000
+++ doc/index.rst	2011-10-25 02:01:41 +0000
@@ -45,8 +45,11 @@ 
 * Extensible device types and boards configuration editing, can add new device and new board.
 * Make use of the output of LAVA test, which is Linaro Dashboard Bundle format, upload test results to the LAVA Dashboard for result archiving and analysis.
 
-.. seealso:: See what's new in :ref:`version_0_3`
-
+.. seealso:: See what's new in :ref:`version_0_3_4`
+
+.. todo::
+
+    Add inline document to source code and open code reference in doc
 
 Latest documentation
 ====================

=== modified file 'lava_dispatcher/android_client.py'
--- lava_dispatcher/android_client.py	2011-10-20 20:40:04 +0000
+++ lava_dispatcher/android_client.py	2011-10-25 02:01:41 +0000
@@ -31,6 +31,10 @@ 
 
 
 class LavaAndroidClient(LavaClient):
+    """
+    LavaAndroidClient manipulates the board running Android system, bootup,
+    reset, power off the board, sends commands to board to execute
+    """
     def __init__(self, context, config):
         LavaClient.__init__(self, context, config)
         # use a random result directory on android for they are using same host

=== modified file 'lava_dispatcher/client.py'
--- lava_dispatcher/client.py	2011-10-24 17:13:35 +0000
+++ lava_dispatcher/client.py	2011-10-25 02:02:17 +0000
@@ -28,6 +28,10 @@ 
 import logging
 
 class LavaClient(object):
+    """
+    LavaClient manipulates the target board, bootup, reset, power off the board,
+    sends commands to board to execute
+    """
     def __init__(self, context, config):
         self.context = context
         self.config = config
@@ -81,7 +85,8 @@ 
         return self.device_option("lmc_dev_arg")
 
     def in_master_shell(self, timeout=10):
-        """ Check that we are in a shell on the master image
+        """
+        Check that we are in a shell on the master image
         """
         self.proc.sendline("")
         id = self.proc.expect([self.master_str, pexpect.TIMEOUT],
@@ -90,7 +95,8 @@ 
             raise OperationFailed
 
     def in_test_shell(self):
-        """ Check that we are in a shell on the test image
+        """
+        Check that we are in a shell on the test image
         """
         self.proc.sendline("")
         id = self.proc.expect([self.tester_str, pexpect.TIMEOUT])
@@ -98,7 +104,8 @@ 
             raise OperationFailed
 
     def boot_master_image(self):
-        """ reboot the system, and check that we are in a master shell
+        """
+        reboot the system, and check that we are in a master shell
         """
         self.soft_reboot()
         try:
@@ -112,7 +119,8 @@ 
         self.proc.expect(self.master_str)
 
     def boot_linaro_image(self):
-        """ Reboot the system to the test image
+        """
+        Reboot the system to the test image
         """
         self.soft_reboot()
         try:
@@ -290,5 +298,6 @@ 
 
 
 class OperationFailed(GeneralError):
-    pass
-
+    """
+    The exception throws when a file system or system operation fails.
+    """