Merge lp:~jtatum/mago/docupdates into lp:~mago-contributors/mago/mago-1.0

[James Tatum]

[James Tatum (jtatum)]

Cleaning up some documentation.

[Ara Pulido (ara)]

Merging it, as it is correct and it does not involve any code.

Thanks!

review: Approve

=== modified file 'README'
--- README	2009-07-28 15:37:36 +0000
+++ README	2009-09-10 03:10:32 +0000
@@ -1,6 +1,6 @@
 MAGO
 ----
-Mago is an desktop testing initiative, built on top of LDTP (http://ldtp.freedesktop.org/), that aims to have a set of processes and code to make writing automated test scripts easier and more reusable. Although we started this effort as an Ubuntu project it works for vanilla GNOME in most of the cases. 
+Mago is a desktop testing initiative, built on top of LDTP (http://ldtp.freedesktop.org/), that aims to have a set of processes and code to make writing automated test scripts easier and more reusable. Although we started this effort as an Ubuntu project it works for vanilla GNOME in most of the cases. 
 
 How to run the tests
 --------------------
@@ -21,23 +21,44 @@
 
 Mago syntax
 -----------
-Usage: mago [OPTIONS]
+Usage: mago [options]
+
+Execute automated tests
 
 Options:
   -h, --help            show this help message and exit
-  -l FILE, --log=FILE   The file to write the log to.
-  --log-level=LOG_LEVEL
-                        One of debug, info, warning, error or critical.
-  -a APPLICATION, --application=APPLICATION
+  -i, --info            Display information about test cases without executing
+                        them
+
+  Test selection options:
+    -a APPLICATION, --application=APPLICATION
                         Application name to test. Option can be repeated and
                         defaults to all applications
-  -s SUITE, --suite=SUITE
+    -n NAME, --suite_name=NAME
                         Suite name to test within applications. Option can be
-                        repeated and default to all suites
-  -f FILE, --file=FILE  XML file name of the suite to test within
-                        applications.
-  -t FILE, --target=FILE
+                        repeated and default to all suites unless suite name
+                        or suite file filtering has been enabled
+    -f FILE, --suite_file=FILE
+                        Suite file to test within applications. Option can be
+                        repeated and default to all suites unless suite name
+                        or suite file filtering has been enabled
+    -c CASE, --case=CASE
+                        Test cases to run (all, if not specified).
+
+  Logging options:
+    -l FILE, --log=FILE
+                        The file to write the log to.
+    --log-level=LOG_LEVEL
+                        One of debug, info, warning, error or critical.
+    -t DIR, --target=DIR
                         Target directory for logs and reports. Defaults to:
                         ~/.mago
-  -c CASE, --case=CASE  Test cases to run (all, if not specified).
+
+Logging
+-------
+By default, logs are written at ~/.mago. This folder can be changed using the -t option (see above).
+
+Two different logs are written per test:
+ * A XML file, easier to parse.
+ * A HTML file, better for reporting.
 
 
=== modified file 'TODO'
--- TODO	2009-06-23 13:26:34 +0000
+++ TODO	2009-09-10 03:10:32 +0000
@@ -1,3 +1,4 @@
+TODO items are tracked in the bug tracker and mago roadmap.
 
- * mago/gnome.py
-   + Seahorse cleanup does not delete created keys
+Bug tracker: https://bugs.edge.launchpad.net/mago
+Roadmap: http://mago.ubuntu.com/Roadmap
 
=== added file 'gnome-screenshot/README'
--- gnome-screenshot/README	1970-01-01 00:00:00 +0000
+++ gnome-screenshot/README	2009-09-10 03:10:32 +0000
@@ -0,0 +1,27 @@
+GNOME-SCREENSHOT TESTS
+-----------
+Tests that verify "Take Screenshot" functionality.
+
+Safety
+------
+These tests are non-destructive and safe to run.
+
+Configuration
+-------------
+No configuration is needed
+
+Version
+-------
+Tests were updated for Ubuntu Karmic
+
+Available Testsuites
+--------------------
+
+* take screenshot (testcases wiki: gns-001 through gns-003)
+  Tests that take and verify screen shots
+  - Grab Desktop
+    Takes a screen shot of the entire desktop
+  - Grab Window
+    Takes a screen shot of the current window after a delay
+  - Grab Area
+    Takes a screen shot of a small area of the screen