diff options
| author | Zuul <zuul@review.openstack.org> | 2018-10-06 21:14:59 +0000 |
|---|---|---|
| committer | Gerrit Code Review <review@openstack.org> | 2018-10-06 21:14:59 +0000 |
| commit | 32bfe7808f7c988c1d1b9acccd6fd437894c6e3d (patch) | |
| tree | 2d90e362410db307e4b7e2efadc1c36903f4213a /doc | |
| parent | 36da1a13c0197b3daf02003188cbae93509a644f (diff) | |
| parent | 8ea9d9262de318bf24d32246e6891d7a39d4b91b (diff) | |
| download | pbr-32bfe7808f7c988c1d1b9acccd6fd437894c6e3d.tar.gz | |
Merge "packaging: Remove support for pyN requirement files"
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/source/user/features.rst | 10 | ||||
| -rw-r--r-- | doc/source/user/using.rst | 12 |
2 files changed, 11 insertions, 11 deletions
diff --git a/doc/source/user/features.rst b/doc/source/user/features.rst index 106fd1a..46c9d03 100644 --- a/doc/source/user/features.rst +++ b/doc/source/user/features.rst @@ -204,14 +204,16 @@ for your project and will then parse these files, split them up appropriately, and inject them into the ``install_requires``, ``tests_require`` and/or ``dependency_links`` arguments to ``setup``. Voila! -You can also have a requirement file for each specific major version of Python. -If you want to have a different package list for Python 3 then just drop a -``requirements-py3.txt`` and it will be used instead. - Finally, it is possible to specify groups of optional dependencies, or :ref:`"extra" requirements <extra-requirements>`, in your ``setup.cfg`` rather than ``setup.py``. +.. versionchanged:: 5.0 + + Previously you could specify requirements for a given major version of + Python using requirments files with a ``-pyN`` suffix. This was deprecated + in 4.0 and removed in 5.0 in favour of environment markers. + Automatic File Generation ------------------------- diff --git a/doc/source/user/using.rst b/doc/source/user/using.rst index b5e28eb..0104640 100644 --- a/doc/source/user/using.rst +++ b/doc/source/user/using.rst @@ -382,20 +382,18 @@ Requirements Requirements files are used in place of the ``install_requires`` and ``extras_require`` attributes. Requirement files should be given one of the -below names. This order is also the order that the requirements are tried in -(where ``N`` is the Python major version number used to install the package): +below names. This order is also the order that the requirements are tried in: -* ``requirements-pyN.txt`` -* ``tools/pip-requires-py3`` * ``requirements.txt`` * ``tools/pip-requires`` Only the first file found is used to install the list of packages it contains. -.. note:: +.. versionchanged:: 5.0 - The ``requirements-pyN.txt`` file is deprecated - ``requirements.txt`` - should be universal. You can use `Environment markers`_ for this purpose. + Previously you could specify requirements for a given major version of + Python using requirements files with a ``-pyN`` suffix. This was deprecated + in 4.0 and removed in 5.0 in favour of environment markers. .. _extra-requirements: |