diff options
| author | Donald Stufft <donald@stufft.io> | 2015-04-22 20:43:05 -0400 |
|---|---|---|
| committer | Donald Stufft <donald@stufft.io> | 2015-04-22 20:43:05 -0400 |
| commit | bd39f99f4f093bede7aa90297059d61ec22bcab5 (patch) | |
| tree | 94ff0119d2deccb9367ff3916169e2516fbad8a6 /docs/user_guide.rst | |
| parent | bc5bb70e6004de5312f5d04d8d0374b3615a2e70 (diff) | |
| parent | ee0f460f02b7641ab8e7c47071803e641ef460d5 (diff) | |
| download | pip-bd39f99f4f093bede7aa90297059d61ec22bcab5.tar.gz | |
Merge pull request #2714 from mkohler/repeatability_caveat
Add setup_requires caveat to repeatability section.
Diffstat (limited to 'docs/user_guide.rst')
| -rw-r--r-- | docs/user_guide.rst | 7 |
1 files changed, 5 insertions, 2 deletions
diff --git a/docs/user_guide.rst b/docs/user_guide.rst index 7bf792b97..7f22acfa9 100644 --- a/docs/user_guide.rst +++ b/docs/user_guide.rst @@ -535,7 +535,7 @@ From within a real python, where ``SomePackage`` *is* installed globally, and is Ensuring Repeatability ********************** -Three things are required to fully guarantee a repeatable installation using requirements files. +Four things are required to fully guarantee a repeatable installation using requirements files. 1. The requirements file was generated by ``pip freeze`` or you're sure it only contains requirements that specify a specific version. @@ -544,7 +544,10 @@ Three things are required to fully guarantee a repeatable installation using req This guarantees that only what is explicitly listed in the requirements file is installed. -3. The installation is performed against an index or find-links location that is +3. None of the packages to be installed utilize the setup_requires keyword. See + :ref:`Controlling setup_requires<controlling-setup-requires>`. + +4. The installation is performed against an index or find-links location that is guaranteed to *not* allow archives to be changed and updated without a version increase. While this is safe on PyPI, it may not be safe for other indices. If you are working with an unsafe index, consider the `peep project |