Merge branch 'feat/add_constraint_files' into 'master'

add a note regarding separate constraint files Closes IDF-10232 See merge request espressif/esp-idf!33230
espressif · Sep 18, 2024 · eb606b9 · eb606b9
2 parents eb676c0 + 7a03ac3
commit eb606b9
Show file tree

Hide file tree

Showing 5 changed files with 20 additions and 0 deletions.
diff --git a/tools/requirements/requirements.ci.txt b/tools/requirements/requirements.ci.txt
@@ -1,5 +1,9 @@
 # Python package requirements for CI in ESP-IDF.
 # This feature can be enabled by running "install.{sh,bat,ps1,fish} --enable-ci"
+#
+# This file lists Python packages without version specifiers. Version details
+# are stored in a separate constraints file. For more information, visit:
+# https://docs.espressif.com/projects/esp-idf/en/latest/api-guides/tools/idf-tools.html
 
 # ci
 coverage

diff --git a/tools/requirements/requirements.core.txt b/tools/requirements/requirements.core.txt
@@ -1,4 +1,8 @@
 # Python package requirements for ESP-IDF. These are the so called core features which are installed in all systems.
+#
+# This file lists Python packages without version specifiers. Version details
+# are stored in a separate constraints file. For more information, visit:
+# https://docs.espressif.com/projects/esp-idf/en/latest/api-guides/tools/idf-tools.html
 
 setuptools
 packaging

diff --git a/tools/requirements/requirements.docs.txt b/tools/requirements/requirements.docs.txt
@@ -1,5 +1,9 @@
 # Python package requirements for building the documentation of ESP-IDF.
 # This feature can be enabled by running "install.{sh,bat,ps1,fish} --enable-docs"
+#
+# This file lists Python packages without version specifiers. Version details
+# are stored in a separate constraints file. For more information, visit:
+# https://docs.espressif.com/projects/esp-idf/en/latest/api-guides/tools/idf-tools.html
 
 esp-docs
 linuxdoc
diff --git a/tools/requirements/requirements.gdbgui.txt b/tools/requirements/requirements.gdbgui.txt
@@ -1,5 +1,9 @@
 # Python package requirements for gdbgui support ESP-IDF.
 # This feature can be enabled by running "install.{sh,bat,ps1,fish} --enable-gdbgui"
+#
+# This file lists Python packages without version specifiers. Version details
+# are stored in a separate constraints file. For more information, visit:
+# https://docs.espressif.com/projects/esp-idf/en/latest/api-guides/tools/idf-tools.html
 
 # gdbgui Python 3.11 issue https://github.com/cs01/gdbgui/issues/447 was fixed in 0.15.2.0. Windows users need an
 # older Python to use since new gdbgui versions don't support Windows anymore.

diff --git a/tools/requirements/requirements.pytest.txt b/tools/requirements/requirements.pytest.txt
@@ -1,5 +1,9 @@
 # Python package requirements for pytest in ESP-IDF.
 # This feature can be enabled by running "install.{sh,bat,ps1,fish} --enable-pytest"
+#
+# This file lists Python packages without version specifiers. Version details
+# are stored in a separate constraints file. For more information, visit:
+# https://docs.espressif.com/projects/esp-idf/en/latest/api-guides/tools/idf-tools.html
 
 pytest-embedded-serial-esp
 pytest-embedded-idf