From 34790634eca32d2ed97fc4484d2ab236fe10d930 Mon Sep 17 00:00:00 2001 From: Sebastien Awwad Date: Tue, 8 Jan 2019 10:58:17 -0500 Subject: [PATCH] DOC: Clarify update instructions for requirements files Signed-off-by: Sebastien Awwad --- dev-requirements.txt | 12 +++++++++++- requirements.txt | 11 +++++++++-- 2 files changed, 20 insertions(+), 3 deletions(-) diff --git a/dev-requirements.txt b/dev-requirements.txt index 12763745..8874e49f 100644 --- a/dev-requirements.txt +++ b/dev-requirements.txt @@ -1,9 +1,19 @@ # -# This file is autogenerated by pip-compile +# This file is (mostly) autogenerated by pip-compile. # To update, run: # # pip-compile --output-file dev-requirements.txt dev-requirements.txt # +# Run pip-compile in both Python2 and Python3, and combine the dependencies, +# adding the following as necessary: +# - Add version directives like ' ; python_version >= "3.0"' based on which +# dependencies are required for Python2 vs Python3 (or other version +# constraints). +# - Add ' # pyup: ignore' for any dependency that must remain outdated +# because later versions drop support for (e.g.) Python2. +# +# Be sure to leave these comments at the top of the new file. +# -e . asn1crypto==0.24.0 astroid==1.6.5 ; python_version < "3.0" # pyup: ignore diff --git a/requirements.txt b/requirements.txt index bbfef15d..a6dc9a4a 100644 --- a/requirements.txt +++ b/requirements.txt @@ -4,8 +4,15 @@ # # pip-compile --generate-hashes --output-file requirements.txt requirements.in # -# But run it in both Python2 and Python3, and combine the files carefully with -# directives like "; python_version < "3.0" and "# pyup: ignore" as necessary. +# Run pip-compile in both Python2 and Python3, and combine the dependencies, +# adding the following as necessary: +# - Add version directives like ' ; python_version >= "3.0"' based on which +# dependencies are required for Python2 vs Python3 (or other version +# constraints). +# - Add ' # pyup: ignore' for any dependency that must remain outdated +# because later versions drop support for (e.g.) Python2. +# +# Be sure to leave these comments at the top of the new file. # asn1crypto==0.24.0 \ --hash=sha256:2f1adbb7546ed199e3c90ef23ec95c5cf3585bac7d11fb7eb562a3fe89c64e87 \