Merge lp:~nuclearbob/utah/doc-updates into lp:utah

[Max Brustkern]

This branch contains several updates to the documentation based on feedback from users.

[lp:~nuclearbob/utah/doc-updates]

681. By Max Brustkern on 2012-09-26

Added note about installing just the client

[Joe Talbott (joetalbott)]

Looks good. Merge it.

review: Approve

=== modified file 'docs/source/development.rst'
--- docs/source/development.rst	2012-09-25 21:20:22 +0000
+++ docs/source/development.rst	2012-09-26 14:15:33 +0000
@@ -12,7 +12,7 @@
 Provisionioning
 ---------------
 
-Within the UATH code, provisioning machines is handled by subclasses of the
+Within the UTAH code, provisioning machines is handled by subclasses of the
 :py:class:`.Machine` class.
 
 Scripts should provision machines by creating an instance of a subclass of the
@@ -21,7 +21,7 @@
 collision.
 
 End users not writing scripts can provision machines automatically using
-scripts provided by the UATH package. Please see the main UATH page for that.
+scripts provided by the UTAH package. Please see the main UTAH page for that.
 
 UTAH Compatible Test Cases
 --------------------------
@@ -85,11 +85,9 @@
 ::
 
     - test: t1                             # directory
-      command: python test1.py a1 a2 a3    # command to run the test from within t1
       run_as: nobody                       # user that runs the test
 
     - test: t2                             # directory/binary
-      command: test2.sh
       overrides:                           # array of control properties to override
       - timeout: 200                       # timeout in seconds
 
@@ -99,9 +97,9 @@
 
     build_cmd:      make
     timeout:        300
-    ts_setup:       tsetup/setup.sh      # test case t1 is the set up for
+    ts_setup:       tsetup/setup.sh      # tsetup/setup.sh is the set up for
                                          # the whole test suite
-    ts_cleanup:     tcleanup/cleanup.sh  # clean up test case
+    ts_cleanup:     tcleanup/cleanup.sh  # clean up test suite
 
 
 To avoid excessive typing and repetition in runlists and control files the
@@ -134,6 +132,7 @@
 ::
 
     build_cmd:      make    # or scons or build.sh
+    command: python test1.py a1 a2 a3  # command to run the test from within t1
     description:
     ( tc_id: TC-INSTALL-ALTERNATE-01)
      dependencies:

=== modified file 'docs/source/introduction.rst'
--- docs/source/introduction.rst	2012-09-05 12:06:10 +0000
+++ docs/source/introduction.rst	2012-09-26 14:15:33 +0000
@@ -12,7 +12,7 @@
 
 All kind of end to end automated testing requires: 
 
-#. Provisioning a machine (or use an existing one)
+#. Provisioning a machine (or using an existing one)
 #. Running the tests
 #. Reporting the results
 
@@ -62,7 +62,7 @@
 by provisioning it with a particular provisioning method.
 
 **WARNING: Your machine will be modified, not to interfere with your current
-set-up or virtualised environment, so uath will create a new user called uath
+set-up or virtualised environment, so UTAH will create a new user called utah
 with sudo privileges to run the tests and have an inventory of existing VMs
 that you could be interested in for running tests.**
 
@@ -79,9 +79,11 @@
 There are some dependencies that need to be met in order to test with VMs, in a
 nutshell::
 
-    sudo apt-add-repository -y ppa:utah/daily
+    sudo apt-add-repository -y ppa:utah/stable
     sudo apt-get update
-    sudo apt-get install utah vm-tools
+    sudo apt-get install utah
+
+This will install the provisioning code as well as the test runner.  To install just the test runner, install the utah-client package.
 
 
 Usage of run_utah_tests.py: