summaryrefslogtreecommitdiff
path: root/Makefile
diff options
context:
space:
mode:
authorNed Batchelder <ned@nedbatchelder.com>2022-08-15 10:13:51 -0400
committerNed Batchelder <ned@nedbatchelder.com>2022-08-15 10:28:12 -0400
commitf7907ee21f9cff21b95f3e107907737ae3078940 (patch)
treeca36bf1c4350a97687a571df0f114c312727ea84 /Makefile
parent18b57e11f750aee913a107fedeea312965e5fba1 (diff)
downloadpython-coveragepy-git-f7907ee21f9cff21b95f3e107907737ae3078940.tar.gz
docs: add some `make upgrade` instructions to the Makefile
Diffstat (limited to 'Makefile')
-rw-r--r--Makefile9
1 files changed, 9 insertions, 0 deletions
diff --git a/Makefile b/Makefile
index c59fe0ec..7778a144 100644
--- a/Makefile
+++ b/Makefile
@@ -72,6 +72,15 @@ metasmoke:
##@ Requirements management
+# When updating requirements, a few rules to follow:
+#
+# 1) Don't install more than one .pip file at once. Always use pip-compile to
+# combine .in files onto a single .pip file that can be installed where needed.
+#
+# 2) Check manual pins before `make upgrade` to see if they can be removed. Look
+# in requirements/pins.pip, and search for "windows" in .in files to find pins
+# and extra requirements that have been needed, but might be obsolete.
+
.PHONY: upgrade
PIP_COMPILE = pip-compile --upgrade --allow-unsafe --generate-hashes