Merge lp:~javier.collado/utah/bug1039555-client into lp:~utah/utah/bug1039555

[Javier Collado]

This merge contains the changes needed to generate a man page for the client.

Note that the merge is against a branch owned by the team (lp:~utah/utah/bug1039555) to handle all the changes for this bug. Hence, this branch doesn't attempt to fix the whole bug, but just a part of it which is the generation of the man page for the client.

Remaining changes:
- Set final text for the `utah` man page
- Generate man pages for the server scripts
- Set the final text for the server scripts

Every set of changes is expected to be handled in a different branch to be merged also against lp:~utah/utah/bug1039555. Once everything is in that branch, the merge against lp:utah/dev will be proposed.

[lp:~javier.collado/utah/bug1039555-client]

662. By Javier Collado on 2012-08-22

Added python-sphinx as build dependency

Otherwise packaging while fail when trying to generate man pages.

[Max Brustkern (nuclearbob)]

I think "Ubuntu Automation Test Harness" should be "Ubuntu Test Automation Harness" or just "UTAH." UATH is the old version.

[lp:~javier.collado/utah/bug1039555-client]

663. By Javier Collado on 2012-08-22

Fixed typo (uath -> utah)

[Javier Collado (javier.collado)]

@Max

Thanks, I copied client.py output without realizing about the type. Fixed it in the man page and in a couple of other places.

review: Needs Resubmitting

[Javier Collado (javier.collado)]

@Max

Let me know if you find some other issue. Otherwise, I'll merge this and continue the work on the man pages.

[Max Brustkern (nuclearbob)]

Looks good to me. Merge away!

=== modified file 'Makefile'
--- Makefile	2012-08-14 16:42:41 +0000
+++ Makefile	2012-08-22 16:44:18 +0000
@@ -1,5 +1,5 @@
 PYC_PATTERN?=*.pyc
-all: client conf/utah/bootspeed-preseed.cfg conf/utah/bridged-network-vm.xml conf/utah/config
+all: client conf/utah/bootspeed-preseed.cfg conf/utah/bridged-network-vm.xml conf/utah/config manpages
 
 client:
 	[ -d "client" ] || mkdir client
@@ -17,6 +17,9 @@
 conf/utah/config:
 	./utah/config.py > conf/utah/config
 
+manpages:
+	cd docs && make man
+
 clean:
 	find . -name "$(PYC_PATTERN)" -delete
 	rm -rf client
@@ -26,4 +29,4 @@
 	rm -f utah_*
 	rm -f utah-*
 
-.PHONY: client clean
+.PHONY: client clean manpages
 
=== modified file 'client-Makefile'
--- client-Makefile	2012-05-21 14:05:50 +0000
+++ client-Makefile	2012-08-22 16:44:18 +0000
@@ -1,4 +1,4 @@
-all: utah-client_fake_all.deb utah/config
+all: utah-client_fake_all.deb utah/config manpages
 
 utah-client_fake_all.deb:
 	touch utah-client_fake_all.deb
@@ -6,7 +6,10 @@
 utah/config:
 	touch utah/config
 
+manpages:
+	cd docs && make man
+
 clean:
 	rm utah/config
 
-.PHONY: clean
+.PHONY: clean manpages
 
=== modified file 'client.py'
--- client.py	2012-08-09 21:39:20 +0000
+++ client.py	2012-08-22 16:44:18 +0000
@@ -23,7 +23,7 @@
     import argparse
 
     parser = argparse.ArgumentParser(
-            description='Ubuntu Automation Testing Harness')
+            description='Ubuntu Testing Automation Harness')
     parser.add_argument('--resume', action='store_true',
                         help='Continue a previous run.  Used after a reboot')
     parser.add_argument('-s', '--state-file',
 
=== modified file 'debian/control'
--- debian/control	2012-08-14 16:55:16 +0000
+++ debian/control	2012-08-22 16:44:18 +0000
@@ -3,7 +3,7 @@
 X-Python-Version: >= 2.5
 Priority: optional
 Maintainer: Max Brustkern <[e-mail]>
-Build-Depends: debhelper (>= 7.0.50~), python-all, devscripts
+Build-Depends: debhelper (>= 7.0.50~), devscripts, python-all, python-sphinx
 Standards-Version: 3.9.3
 Homepage: https://code.launchpad.net/utah
 Vcs-Bzr: https://code.launchpad.net/utah
 
=== added file 'debian/utah-client.manpages'
--- debian/utah-client.manpages	1970-01-01 00:00:00 +0000
+++ debian/utah-client.manpages	2012-08-22 16:44:18 +0000
@@ -0,0 +1,1 @@
+docs/build/man/utah.1
 
=== modified file 'docs/source/conf.py'
--- docs/source/conf.py	2012-08-20 11:33:46 +0000
+++ docs/source/conf.py	2012-08-22 16:44:18 +0000
@@ -230,7 +230,7 @@
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
 man_pages = [
-    ('index', 'utah', u'UTAH Documentation',
+    ('man/utah', 'utah', u'Ubuntu Test Automation Harness',
      [u'Canonical Ltd'], 1)
 ]
 
 
=== added directory 'docs/source/man'
=== added file 'docs/source/man/utah.rst'
--- docs/source/man/utah.rst	1970-01-01 00:00:00 +0000
+++ docs/source/man/utah.rst	2012-08-22 16:44:18 +0000
@@ -0,0 +1,32 @@
+:orphan:
+
+utah manual page
+================
+
+Synopsis
+--------
+
+utah [-h] [--resume] [-s STATE_FILE] [-f {text,yaml,json}] [-t TESTDIR] [-r RUNLIST] [-o OUTPUT] [-a] [-d]
+
+Description
+-----------
+
+:program:`utah` executes a runlist and generates a file with the results
+
+Options
+-------
+-h, --help            show this help message and exit
+--resume              Continue a previous run. Used after a reboot
+-s STATE_FILE, --state-file STATE_FILE
+                      File to use for storing state (default
+                      "/var/lib/utah/state.yaml"
+-f <text,yaml,json>, --format <text,yaml,json>
+                      Output format (default "yaml")
+-t TESTDIR, --testdir TESTDIR
+                      Main test directory
+-r RUNLIST, --runlist RUNLIST
+                      runlist file name
+-o OUTPUT, --output OUTPUT
+                      write output to this file
+-a, --append          append to output
+-d, --debug           Print debugging output
 
=== modified file 'utah_howto.txt'
--- utah_howto.txt	2012-08-02 14:18:50 +0000
+++ utah_howto.txt	2012-08-22 16:44:18 +0000
@@ -60,7 +60,7 @@
 usage: utah [-h] [--resume] [-s STATE_FILE] [-f {text,yaml}] [-t TESTDIR]
             [-r RUNLIST] [-o OUTPUT] [-a] [-d]
 
-Ubuntu Automation Testing Harness
+Ubuntu Testing Automation Harness
 
 optional arguments:
   -h, --help            show this help message and exit