Merge lp:~jtv/maas-test/housekeeping into lp:maas-test

[Jeroen T. Vermeulen]

Fix lint, update manpage.

Fixes several problems at once. Our generated manpage was out of date; we had lint in the code so a plain “make” or “make lint” would break; and due perhaps to some change in tooling the manpage no longer compiled from RST. The RST source for the manpage also had an extraneous heading accidentally inserted in it.

I didn't want to spend the time re-tweaking the levels of the section headings, which have to work right in both the man page and the HTML output; the change doesn't look too bad to me.

We have more problems: “make test” no longer works for me in a clean copy of trunk. But let's not get too much into one branch — this brings us some fixes now, and at least a plain “make” works again.

Jeroen

[Julian Edwards (julian-edwards)]

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

 review: approve
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.4.14 (GNU/Linux)
Comment: Using GnuPG with Thunderbird - http://www.enigmail.net/

iEYEARECAAYFAlLNAgwACgkQWhGlTF8G/Hc9kACeOoMi/tGmrUdW58/sK7VngAPn
lr0AnjvHXP0ovMg6XVk07Iay5RTfX/bd
=h5wc
-----END PGP SIGNATURE-----

review: Approve

=== modified file 'docs/man/maas-test.8.rst'
--- docs/man/maas-test.8.rst	2014-01-06 07:45:11 +0000
+++ docs/man/maas-test.8.rst	2014-01-08 07:40:55 +0000
@@ -1,8 +1,4 @@
 =========
-
-Test results
-============
-
 maas-test
 =========
 
@@ -63,7 +59,7 @@
 
 
 Preparing to run
-----------------
+================
 
 The test will run MAAS in a virtual machine.  It will not be installed on your
 physical system.  Nevertheless there are a few things you need to be aware of:
@@ -90,7 +86,7 @@
 
 
 Running
--------
+=======
 
 There is one required argument: the network interface which connects the
 testing system to the testing network, e.g. `eth1`.
@@ -107,10 +103,10 @@
 ============
 
 Once maas-test has finished testing the node it will upload the test
-results to Launchpad (unless told otherwise; see
-:ref:`reporting-options`). This allows you to share the test results
-with others, including the MAAS developers, by filing a Launchpad bug
-which includes the test results as an attachment.
+results to Launchpad (unless told otherwise; see the `reporting options`_).
+This allows you to share the test results with others, including the MAAS
+developers, by filing a Launchpad bug which includes the test results as an
+attachment.
 
 By defaults the results will also be written to timestamped log files
 under `~/.maas-test/logs`.
@@ -194,7 +190,8 @@
   The proxy software used is `polipo`.  The cache will be stored under
   `~/.maas-test`.
 
-.. _reporting-options
+.. _`reporting options`:
+
 --no-reporting
   Turn off all reporting of test results. Results will be written to
   stdout but not recorded elsewhere.

=== modified file 'maastest/report.py'
--- maastest/report.py	2014-01-06 07:45:52 +0000
+++ maastest/report.py	2014-01-08 07:40:55 +0000
@@ -30,6 +30,7 @@
 from apiclient import multipart
 from xdg import BaseDirectory
 
+
 # This is largely cargo-culted from apiclient.multipart because
 # Launchpad only pays attention to the first Content-Disposition header
 # on an attachment, and if we want the content to actually be attached
@@ -141,7 +142,8 @@
     """Handle the reporting of maas-test results.
 
     :param results: The results to report.
-    :param log_only: If True, write the results to a file but don't submit them to Launchpad.
+    :param log_only: If True, write the results to a file but don't submit
+        them to Launchpad.
     :param now: The current date/time (used for testing only).
     :type now: datetime.datetime.
     """

=== modified file 'man/maas-test.8'
--- man/maas-test.8	2013-12-10 13:56:55 +0000
+++ man/maas-test.8	2014-01-08 07:40:55 +0000
@@ -73,7 +73,7 @@
 .sp
 In addition to being on the testing network, the testing system must also have
 internet access.
-.SS Preparing to run
+.SH PREPARING TO RUN
 .sp
 The test will run MAAS in a virtual machine.  It will not be installed on your
 physical system.  Nevertheless there are a few things you need to be aware of:
@@ -99,7 +99,7 @@
 for the virtual machine, and for booting the node.  As a rule of thumb, count
 on half a gigabyte as a baseline, plus a quarter gigabyte for each combination
 of architecture and Ubuntu release that will run on the node.
-.SS Running
+.SH RUNNING
 .sp
 There is one required argument: the network interface which connects the
 testing system to the testing network, e.g. \fIeth1\fP\&.
@@ -113,6 +113,16 @@
 Manually when running in \fIinteractive mode\fP\&.  The test will stop and ask you
 to power up the node.
 .UNINDENT
+.SH TEST RESULTS
+.sp
+Once maas\-test has finished testing the node it will upload the test
+results to Launchpad (unless told otherwise; see the \fI\%reporting options\fP).
+This allows you to share the test results with others, including the MAAS
+developers, by filing a Launchpad bug which includes the test results as an
+attachment.
+.sp
+By defaults the results will also be written to timestamped log files
+under \fI~/.maas\-test/logs\fP\&.
 .SH OPTIONS
 .INDENT 0.0
 .TP
@@ -191,6 +201,17 @@
 The proxy software used is \fIpolipo\fP\&.  The cache will be stored under
 \fI~/.maas\-test\fP\&.
 .UNINDENT
+.INDENT 0.0
+.TP
+.B \-\-no\-reporting
+Turn off all reporting of test results. Results will be written to
+stdout but not recorded elsewhere.
+.TP
+.B \-\-log\-results\-only
+Write test results to a file, but don\(aqt upload them to Launchpad.
+Results will be written to a timestamped log file under
+~/.maas\-test/logs.
+.UNINDENT
 .SH REPORTING BUGS
 .sp
 Report bugs in Launchpad: \fI\%https://bugs.launchpad.net/maas\-test/\fP