Document the global requirements format.

Change-Id: I4496209c95908179c4b383e7f0a5b8595173564b
This commit is contained in:
Robert Collins 2015-06-15 14:24:05 +12:00
parent a3a3f7f57a
commit 9414f91f87
1 changed files with 10 additions and 0 deletions

View File

@ -51,6 +51,16 @@ that are allowed in OpenStack projects. This is enforced for
``requirements.txt``, ``test-requirements.txt`` and extras defined in
``setup.cfg``.
Format
------
``global-requirements.txt`` supports a subset of pip requirement file
contents. Distributions may only be referenced by name, not URL. Options
(such as -e or -f) may not be used. Version specifiers, environment markers
and comments are all permitted. A single distribution may be listed more than
once if different specifiers are required with different markers - for
instance, if a dependency has dropped Python 2.7 support.
Enforcement for Test Runs
-------------------------