summaryrefslogtreecommitdiff
path: root/HACKING.rst
diff options
context:
space:
mode:
authorMatt Riedemann <mriedem@us.ibm.com>2015-07-14 11:56:45 -0700
committerMatt Riedemann <mriedem@us.ibm.com>2015-07-14 11:56:45 -0700
commitf72b7e35c8b208782c32177f8966ffc10a69974b (patch)
tree9b67bbef73283510c4805cf03463c11c2e03845d /HACKING.rst
parent42d91ebee0a2b162d9711be5e8b5a04486d63a63 (diff)
downloadnova-f72b7e35c8b208782c32177f8966ffc10a69974b.tar.gz
Update HACKING.rst for running tests and building docs
There are three updates here: 1. Point to the correct path of development.environment.rst. 2. Update the path to test_wsgi.py after the test restructure that happened in Kilo. 3. Just tell people to use `tox -e docs` for building docs. Change-Id: I03295a6d9c90e9a2962999726d254bc4971c4909
Diffstat (limited to 'HACKING.rst')
-rw-r--r--HACKING.rst6
1 files changed, 3 insertions, 3 deletions
diff --git a/HACKING.rst b/HACKING.rst
index 42a0a4581d..96e129ee47 100644
--- a/HACKING.rst
+++ b/HACKING.rst
@@ -76,13 +76,13 @@ testr arguments that are needed to tox. For example, you can run:
--analyze-isolation to its argument list.
Python packages may also have dependencies that are outside of tox's ability
-to install. Please refer to doc/source/devref/development.environment.rst for
+to install. Please refer to ``doc/source/development.environment.rst`` for
a list of those packages on Ubuntu, Fedora and Mac OS X.
To run a single or restricted set of tests, pass a regex that matches
the class name containing the tests as an extra ``tox`` argument;
e.g. ``tox -- TestWSGIServer`` (note the double-hypen) will test all
-WSGI server tests from ``nova/tests/test_wsgi.py``; ``--
+WSGI server tests from ``nova/tests/unit/test_wsgi.py``; ``--
TestWSGIServer.test_uri_length_limit`` would run just that test, and
``-- TestWSGIServer|TestWSGIServerWithSSL`` would run tests from both
classes.
@@ -98,7 +98,7 @@ http://wiki.openstack.org/testr
Building Docs
-------------
Normal Sphinx docs can be built via the setuptools ``build_sphinx`` command. To
-do this via ``tox``, simply run ``tox -evenv -- python setup.py build_sphinx``,
+do this via ``tox``, simply run ``tox -e docs``,
which will cause a virtualenv with all of the needed dependencies to be
created and then inside of the virtualenv, the docs will be created and
put into doc/build/html.