docs: document how requirements.txt is updated

we should update this document once
https://github.com/jazzband/pip-tools/issues/625 is fixed and/or
https://github.com/jazzband/pip-tools/issues/908 is merged

Signed-off-by: Kefu Chai <kchai@redhat.com>

diff --git a/docs/INSTALL.rst b/docs/INSTALL.rst
index e02704ef6990ff9cb5390361a85944eb8a6e4916..63c9369c67f1a057f210943a0f3230f183b19f42 100644 (file)
--- a/docs/INSTALL.rst
+++ b/docs/INSTALL.rst
@@ -60,3 +60,13 @@ Or from GitHub::
 
 where the dependencies for orchestrating are installed. They are used for
 interacting with the services to schedule tests and to report the test results.
+
+
+Update Dependencies
+-------------------
+
+We track the dependencies using ``requirements.txt``. These packages are tested,
+and should work with teuthology. But if you want to bump up the versions of them,
+please use the following command to update this file ::
+
+  pip-compile -qo- | sed '/^-e / d' > requirements.txt

diff --git a/requirements.in b/requirements.in
new file mode 100644 (file)
index 0000000..27b1825
--- /dev/null
+++ b/requirements.in
@@ -0,0 +1 @@
+-e .[coverage,orchestra,test]