[Branch,~linaro-validation/lava-test/trunk] Rev 110: Start documenting the tests we have

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

Commit Message

Paul Larson Jan. 19, 2012, 5:48 p.m.
------------------------------------------------------------
revno: 110
committer: Paul Larson <paul.larson@linaro.org>
branch nick: doc-lava-test
timestamp: Wed 2012-01-18 18:11:33 -0600
message:
  Start documenting the tests we have
added:
  doc/tests.rst
modified:
  doc/index.rst
  doc/reference.rst
  lava_test/test_definitions/bootchart.py
  lava_test/test_definitions/firefox.py
  lava_test/test_definitions/glmemperf.py
  lava_test/test_definitions/gmpbench.py
  lava_test/test_definitions/gtkperf.py
  lava_test/test_definitions/insanity.py
  lava_test/test_definitions/ltp.py
  lava_test/test_definitions/peacekeeper.py
  lava_test/test_definitions/xrestop.py


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

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

Patch

=== modified file 'doc/index.rst'
--- doc/index.rst	2011-09-12 09:19:10 +0000
+++ doc/index.rst	2012-01-19 00:11:33 +0000
@@ -12,19 +12,18 @@ 
 
 .. seealso:: To learn more about LAVA see https://launchpad.net/lava
 
-60 second example
-=================
-
-This example will run on Ubuntu Lucid and beyond::
-
- $ sudo add-apt-repository ppa:linaro-validation/ppa
- $ sudo apt-get update
- $ sudo apt-get install lava-test
- $ lava-test install stream
- $ lava-test run stream
-
-.. seealso:: For a more thorough description see :ref:`usage`
-.. seealso:: For detailed installation istructions see :ref:`installation`
+Indices and tables
+==================
+
+.. toctree::
+    :maxdepth: 2
+    
+    installation.rst
+    usage.rst
+    tests.rst
+    reference.rst
+    changes.rst
+    todo.rst
 
 Features
 ========
@@ -39,8 +38,19 @@ 
   collections of tests (:class:`~lava_test.api.core.ITestProvider`).
 * Ever-growing collection of freely available and generic tests and benchmarks 
 
-.. seealso:: See what's new in :ref:`version_0_2`
-
+Quickstart
+==========
+
+This example will run on Ubuntu Lucid and beyond::
+
+ $ sudo add-apt-repository ppa:linaro-validation/ppa
+ $ sudo apt-get update
+ $ sudo apt-get install lava-test
+ $ lava-test install stream
+ $ lava-test run stream
+
+.. seealso:: For a more thorough description see :ref:`usage`
+.. seealso:: For detailed installation istructions see :ref:`installation`
 
 Latest documentation
 ====================
@@ -64,18 +74,6 @@ 
 Feel free to drop by to chat and ask questions.
 
 
-Indices and tables
-==================
-
-.. toctree::
-    :maxdepth: 2
-    
-    installation.rst
-    changes.rst
-    usage.rst
-    reference.rst
-    todo.rst
-
 * :ref:`genindex`
 * :ref:`modindex`
 * :ref:`search`

=== modified file 'doc/reference.rst'
--- doc/reference.rst	2011-09-12 09:19:10 +0000
+++ doc/reference.rst	2012-01-19 00:11:33 +0000
@@ -99,9 +99,3 @@ 
     :members:
 
 
-Abrek compatibility
-===================
-
-.. automodule:: abrek.testdef
-    :members:
-

=== added file 'doc/tests.rst'
--- doc/tests.rst	1970-01-01 00:00:00 +0000
+++ doc/tests.rst	2012-01-19 00:11:33 +0000
@@ -0,0 +1,89 @@ 
+.. _test:
+
+===============
+Supported Tests
+===============
+
+The following tests are currently supported in LAVA Test:
+
+ * `bootchart`_
+ * `firefox`_
+ * `glmemperf`_
+ * `gmpbench`_
+ * `gtkperf`_
+ * `insanity`_
+ * `ltp`_
+ * `peacekeeper`_
+ * `perf`_
+ * `posixtestsuite`_
+ * `pwrmgmt`_
+ * `pybench`_
+ * `smem`_
+ * `stream`_
+ * `tiobench`_
+ * `x11perf`_
+ * `xrestop`_
+
+bootchart
++++++++++
+.. automodule:: lava_test.test_definitions.bootchart
+
+firefox
++++++++
+.. automodule:: lava_test.test_definitions.firefox
+
+glmemperf
++++++++++
+.. automodule:: lava_test.test_definitions.glmemperf
+
+gmpbench
+++++++++
+.. automodule:: lava_test.test_definitions.gmpbench
+
+gtkperf
++++++++
+.. automodule:: lava_test.test_definitions.gtkperf
+
+insanity
+++++++++
+.. automodule:: lava_test.test_definitions.insanity
+
+ltp
++++
+.. automodule:: lava_test.test_definitions.ltp
+
+peacekeeper
++++++++++++
+.. automodule:: lava_test.test_definitions.peacekeeper
+
+posixtestsuite
+++++++++++++++
+.. automodule:: lava_test.test_definitions.posixtestsuite
+
+pwrmgmt
++++++++
+.. automodule:: lava_test.test_definitions.pwrmgmt
+
+pybench
++++++++
+.. automodule:: lava_test.test_definitions.pybench
+
+smem
+++++
+.. automodule:: lava_test.test_definitions.smem
+
+stream
+++++++
+.. automodule:: lava_test.test_definitions.stream
+
+tiobench
+++++++++
+.. automodule:: lava_test.test_definitions.tiobench
+
+x11perf
++++++++
+.. automodule:: lava_test.test_definitions.x11perf
+
+xrestop
++++++++
+.. automodule:: lava_test.test_definitions.xrestop

=== modified file 'lava_test/test_definitions/bootchart.py'
--- lava_test/test_definitions/bootchart.py	2011-10-20 12:12:15 +0000
+++ lava_test/test_definitions/bootchart.py	2012-01-19 00:11:33 +0000
@@ -13,6 +13,16 @@ 
 # You should have received a copy of the GNU General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
+"""
+Bootchart is a benchmark for measuring the time it takes to boot the system 
+to a point where it hands over control to the user.
+
+**URL:** http://bootchart.org
+
+**Default options:** None
+"""
+
+
 from lava_test.core.installers import TestInstaller
 from lava_test.core.parsers import TestParser
 from lava_test.core.runners import TestRunner

=== modified file 'lava_test/test_definitions/firefox.py'
--- lava_test/test_definitions/firefox.py	2011-10-20 12:12:15 +0000
+++ lava_test/test_definitions/firefox.py	2012-01-19 00:11:33 +0000
@@ -13,6 +13,13 @@ 
 # You should have received a copy of the GNU General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
+"""
+The firefox benchmark measure the startup time for the firefox browser.
+
+**URL:** https://github.com/janimo/firefox-startup-timing
+
+**Default Options:** None
+"""
 
 from lava_test.core.installers import TestInstaller
 from lava_test.core.parsers import TestParser

=== modified file 'lava_test/test_definitions/glmemperf.py'
--- lava_test/test_definitions/glmemperf.py	2011-10-20 12:12:15 +0000
+++ lava_test/test_definitions/glmemperf.py	2012-01-19 00:11:33 +0000
@@ -13,6 +13,18 @@ 
 # You should have received a copy of the GNU General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
+"""
+GLMemPerf is an OpenGL ES 2.0 performance estimation tool that aims to
+measure the memory bandwidth characteristics of a graphics implementation.
+It performs a number of blit style renders using different texture formats,
+sizes, orientations and fragment shaders. The results are given as frames
+per second numbers.
+
+**URL:** http://gitorious.org/meego-graphics/glmemperf
+
+**Default Options:** -e shimage
+"""
+
 
 from lava_test.core.installers import TestInstaller
 from lava_test.core.parsers import TestParser

=== modified file 'lava_test/test_definitions/gmpbench.py'
--- lava_test/test_definitions/gmpbench.py	2011-10-20 12:12:15 +0000
+++ lava_test/test_definitions/gmpbench.py	2012-01-19 00:11:33 +0000
@@ -14,10 +14,14 @@ 
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #
 """
-   This script automates the automate installation, execution, and
-   results parsing for the GMPbench test suite.
-   The GMPbench test Suite is an open source test suite with the goal of
-   comparing different processors performance against eachother.
+This script automates the automate installation, execution, and
+results parsing for the GMPbench test suite.
+The GMPbench test Suite is an open source test suite with the goal of
+comparing different processors performance against eachother.
+
+**URL:** http://gmplib.org/gmpbench.html
+
+**Default Options:** None
 
 """
 

=== modified file 'lava_test/test_definitions/gtkperf.py'
--- lava_test/test_definitions/gtkperf.py	2011-10-20 12:12:15 +0000
+++ lava_test/test_definitions/gtkperf.py	2012-01-19 00:11:33 +0000
@@ -13,6 +13,14 @@ 
 # You should have received a copy of the GNU General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
+"""
+GtkPerf is an application designed to test GTK+ performance using predefined GTK+ widgets.
+
+**URL:** http://gtkperf.sourceforge.net/
+
+**Default options:** -a -c 500
+"""
+
 import re
 
 from lava_test.core.installers import TestInstaller

=== modified file 'lava_test/test_definitions/insanity.py'
--- lava_test/test_definitions/insanity.py	2011-10-13 10:20:52 +0000
+++ lava_test/test_definitions/insanity.py	2012-01-19 00:11:33 +0000
@@ -14,6 +14,14 @@ 
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #
 
+"""
+GStreamer QA system
+
+**URL:** http://git.collabora.co.uk/?p=user/edward/gst-qa-system;a=summary
+
+**Default options:** None
+"""
+
 import os
 import re
 import subprocess

=== modified file 'lava_test/test_definitions/ltp.py'
--- lava_test/test_definitions/ltp.py	2012-01-11 19:49:35 +0000
+++ lava_test/test_definitions/ltp.py	2012-01-19 00:11:33 +0000
@@ -13,6 +13,15 @@ 
 # You should have received a copy of the GNU General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
+"""
+The Linux Test Project is a collection of tools for testing Linux with a 
+focus on the kernel.
+
+**URL:** http://ltp.sourceforge.net
+
+**Default options:** -f syscalls -p -q
+"""
+
 import re
 
 

=== modified file 'lava_test/test_definitions/peacekeeper.py'
--- lava_test/test_definitions/peacekeeper.py	2011-10-20 12:12:15 +0000
+++ lava_test/test_definitions/peacekeeper.py	2012-01-19 00:11:33 +0000
@@ -14,10 +14,12 @@ 
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
 """
-   This script automates the automate installation, execution, and
-   results parsing for the Peacekeeper browser benchmark.
-
-   http://clients.futuremark.com/peacekeeper/index.action
+This script automates the automate installation, execution, and
+results parsing for the Peacekeeper browser benchmark.
+
+**URL:** http://clients.futuremark.com/peacekeeper/index.action
+
+**Default options:** firefox
 """
 
 

=== modified file 'lava_test/test_definitions/xrestop.py'
--- lava_test/test_definitions/xrestop.py	2011-10-20 12:12:15 +0000
+++ lava_test/test_definitions/xrestop.py	2012-01-19 00:11:33 +0000
@@ -13,6 +13,14 @@ 
 # You should have received a copy of the GNU General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
+"""
+xrestop - test for X11 server resource usage monitor
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default options:
+ None
+"""
+
 from lava_test.core.installers import TestInstaller
 from lava_test.core.parsers import TestParser
 from lava_test.core.runners import TestRunner