summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorChandan Singh <csingh43@bloomberg.net>2019-01-03 02:38:45 +0000
committerChandan Singh <csingh43@bloomberg.net>2019-01-03 03:44:17 +0000
commit1f7bc655eeb2ab83218070d950fa0f2726cd4ceb (patch)
tree8ed2bc613805c4c47316109b942b468c89fe7771
parent3fae34467f46d63407a8cf8d43f2df57f13af4e9 (diff)
downloadbuildstream-chandan/toxify.tar.gz
CONTRIBUTING.rst: Add instructions to recreate tox environmentchandan/toxify
When we update our dependencies, developers will eventually need to recreate their `tox` environments to get correct results. This happens because `tox` isn't particularly good at recognizing changes in the requirements files.
-rw-r--r--CONTRIBUTING.rst6
1 files changed, 6 insertions, 0 deletions
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst
index a8425f0a7..0079cb4b5 100644
--- a/CONTRIBUTING.rst
+++ b/CONTRIBUTING.rst
@@ -1541,6 +1541,12 @@ with::
Alternatively, any IDE plugin that uses pytest should automatically
detect the ``.pylintrc`` in the project's root directory.
+In case BuildStream's dependencies were updated since you last ran the
+tests, you might see some errors like
+``pytest: error: unrecognized arguments: --codestyle``. If this happens, you
+will need to force ``tox`` to recreate the test environment(s). To do so, you
+can run ``tox`` with ``-r`` or ``--recreate`` option.
+
.. note::
By default, we do not allow use of site packages in our ``tox``