From 7a03ac385de4f5128c21321a93ad47144c92f75c Mon Sep 17 00:00:00 2001 From: Frantisek Hrbata Date: Tue, 10 Sep 2024 12:29:44 +0200 Subject: [PATCH] change: add a note regarding separate constraint files Signed-off-by: Frantisek Hrbata --- tools/requirements/requirements.ci.txt | 4 ++++ tools/requirements/requirements.core.txt | 4 ++++ tools/requirements/requirements.docs.txt | 4 ++++ tools/requirements/requirements.gdbgui.txt | 4 ++++ tools/requirements/requirements.pytest.txt | 4 ++++ 5 files changed, 20 insertions(+) diff --git a/tools/requirements/requirements.ci.txt b/tools/requirements/requirements.ci.txt index 0e5c231133..fa1ac259d4 100644 --- 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 index 9e5d4660bb..9e12cd16e2 100644 --- 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 index b790f25345..f267396680 100644 --- 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 index a00523d1e4..2d7f1cd434 100644 --- 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 index d94ee14ddb..68a5acb766 100644 --- 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