summaryrefslogtreecommitdiff
path: root/tempest/README.rst
diff options
context:
space:
mode:
authorAttila Fazekas <afazekas@redhat.com>2013-07-24 10:25:02 +0200
committerAttila Fazekas <afazekas@redhat.com>2013-07-24 13:49:14 +0200
commit58d23301ba51be2e8e96e906ea5d134cb2211542 (patch)
tree9b8ba88948ee83ee35b2dc545e621c0e7b92bd26 /tempest/README.rst
parent47ff791416dea008a51e0a2b36b088778c0e1fb5 (diff)
downloadtempest-58d23301ba51be2e8e96e906ea5d134cb2211542.tar.gz
Fixing man page generation
The man page generation failed with sphinx v1.1.3 and docutils 0.10 and 0.11. Adding docutils==0.9.1 to the test-requirements.txt in order to solve this issue. The docutils==0.9.1 is on the common OpenStack dependency list. Several doc creation warning and error also fixed by this change. Change-Id: Icb412876f5a989e6b8aa4886f2a246127a76521a
Diffstat (limited to 'tempest/README.rst')
-rw-r--r--tempest/README.rst16
1 files changed, 8 insertions, 8 deletions
diff --git a/tempest/README.rst b/tempest/README.rst
index 8f07a0774..33021c884 100644
--- a/tempest/README.rst
+++ b/tempest/README.rst
@@ -1,6 +1,6 @@
-============
+============================
Tempest Field Guide Overview
-============
+============================
Tempest is designed to be useful for a large number of different
environments. This includes being useful for gating commits to
@@ -26,7 +26,7 @@ documented in a README.rst file in the directory.
api
-------------
+---
API tests are validation tests for the OpenStack API. They should not
use the existing python clients for OpenStack, but should instead use
@@ -41,7 +41,7 @@ frameworks.
cli
-------------
+---
CLI tests use the openstack CLI to interact with the OpenStack
cloud. CLI testing in unit tests is somewhat difficult because unlike
@@ -51,7 +51,7 @@ prereqs having a running OpenStack cloud.
scenario
-------------
+--------
Scenario tests are complex "through path" tests for OpenStack
functionality. They are typically a series of steps where complicated
@@ -61,7 +61,7 @@ Scenario tests can and should use the OpenStack python clients.
stress
------------
+------
Stress tests are designed to stress an OpenStack environment by
running a high workload against it and seeing what breaks. Tools may
@@ -72,7 +72,7 @@ moves into here.
thirdparty
-------------
+----------
Many openstack components include 3rdparty API support. It is
completely legitimate for Tempest to include tests of 3rdparty APIs,
@@ -81,7 +81,7 @@ validation.
whitebox
-----------
+--------
Whitebox tests are tests which require access to the database of the
target OpenStack machine to verify internal state after operations