openstack
/
project-team-guide
Code Issues Proposed changes

Improve docs wrt generate-constraints 

The command seems to be out of date and there is a tox
target that already takes care of it with an up to date command
so let's instruct developers to use that.

Change-Id: I0848248e21dfc23466310ff1996f898f270dd12c
This commit is contained in:
Mohammed Naser 2021-12-05 09:42:22 +04:00
parent 0c17dd4a7c
commit 5e4eeade64
1 changed files with 2 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
doc/source/dependency-management.rst
View File

@ -125,10 +125,8 @@ Adding a new dependency
``openstack/requirements``, including any instructions for
excluding versions or choosing different versions for python 2
or 3. As part of the same review, run the following command
``generate-constraints -b blacklist.txt -p /usr/bin/python2.7 \
-p /usr/bin/python3.6 -r global-requirements.txt --version-map 3.6:3.4 \
--version-map 3.6:3.5 > upper-constraints.txt``. Be sure to only update
or add constraints related to your addition.
``tox -e generate``. Be sure to only update or add constraints related
to your addition.
2. Add the dependency to the appropriate requirements file(s) within
the project tree, providing a minimum version specifier. If the
``lower-constraints.txt`` file exists in the project tree, then update it