summaryrefslogtreecommitdiff
path: root/doc/source/features.rst
diff options
context:
space:
mode:
Diffstat (limited to 'doc/source/features.rst')
-rw-r--r--doc/source/features.rst17
1 files changed, 16 insertions, 1 deletions
diff --git a/doc/source/features.rst b/doc/source/features.rst
index c176d01..61f15a8 100644
--- a/doc/source/features.rst
+++ b/doc/source/features.rst
@@ -25,7 +25,22 @@ Update tox.ini
Within the ``tox.ini`` file of your project add the following::
[testenv:debug]
- commands = oslo_debug_helper.sh {posargs}
+ commands = oslo_debug_helper {posargs}
+
+If the project name, and the module that precedes the tests directory do not
+match, then consider passing an argument to ``tox.ini``.
+
+For example, ``python-keystoneclient`` project has tests in
+``keystoneclient/tests``, thus it would have to pass in::
+
+ [testenv:debug]
+ commands = oslo_debug_helper -t keystoneclient/tests {posargs}
+
+Similarily, most ``oslo`` projects have the tests at the package level, it
+would have to pass in::
+
+ [testenv:debug]
+ commands = oslo_debug_helper -t tests {posargs}
To run with tox: