Merge pull request #420 from david-cermak/bugfix/examples_override_path

Add override_path in example manifests
2025-07-15 19:42:09 +02:00 · 2023-11-10 07:53:31 +01:00
parent e6fa2f84a2 1ee9dae6bf
commit 24f07f920f
64 changed files with 94 additions and 1201 deletions
--- a/components/asio/examples/asio_chat/CMakeLists.txt
+++ b/components/asio/examples/asio_chat/CMakeLists.txt
@ -2,9 +2,5 @@
 # in this exact order for cmake to work correctly
 cmake_minimum_required(VERSION 3.16)

-# (Not part of the boilerplate)
-# This example uses an extra component for common functions such as Wi-Fi and Ethernet connection.
-set(EXTRA_COMPONENT_DIRS ../.. ../../../../common_components/protocol_examples_common)
-
 include($ENV{IDF_PATH}/tools/cmake/project.cmake)
 project(asio_chat)
--- a/components/asio/examples/asio_chat/main/idf_component.yml
+++ b/components/asio/examples/asio_chat/main/idf_component.yml
@ -3,4 +3,6 @@ dependencies:
  idf: ">=5.0"
  espressif/asio:
    version: "^1.14.1"
-    override_path: '../../../'
+    override_path: "../../../"
+  protocol_examples_common:
+    path: ${IDF_PATH}/examples/common_components/protocol_examples_common
--- a/components/asio/examples/async_request/CMakeLists.txt
+++ b/components/asio/examples/async_request/CMakeLists.txt
@ -2,9 +2,5 @@
 # in this exact order for cmake to work correctly
 cmake_minimum_required(VERSION 3.16)

-# (Not part of the boilerplate)
-# This example uses an extra component for common functions such as Wi-Fi and Ethernet connection.
-set(EXTRA_COMPONENT_DIRS ../../ ../../../../common_components/protocol_examples_common)
-
 include($ENV{IDF_PATH}/tools/cmake/project.cmake)
 project(async_http_request)
--- a/components/asio/examples/async_request/main/idf_component.yml
+++ b/components/asio/examples/async_request/main/idf_component.yml
@ -3,4 +3,6 @@ dependencies:
  idf: ">=5.0"
  espressif/asio:
    version: "^1.14.1"
-    override_path: '../../../'
+    override_path: "../../../"
+  protocol_examples_common:
+    path: ${IDF_PATH}/examples/common_components/protocol_examples_common
--- a/components/asio/examples/socks4/CMakeLists.txt
+++ b/components/asio/examples/socks4/CMakeLists.txt
@ -2,9 +2,5 @@
 # in this exact order for cmake to work correctly
 cmake_minimum_required(VERSION 3.16)

-# (Not part of the boilerplate)
-# This example uses an extra component for common functions such as Wi-Fi and Ethernet connection.
-set(EXTRA_COMPONENT_DIRS ../.. ../../../../common_components/protocol_examples_common)
-
 include($ENV{IDF_PATH}/tools/cmake/project.cmake)
 project(asio_sock4)
--- a/components/asio/examples/socks4/main/idf_component.yml
+++ b/components/asio/examples/socks4/main/idf_component.yml
@ -3,4 +3,6 @@ dependencies:
  idf: ">=5.0"
  espressif/asio:
    version: "^1.14.1"
-    override_path: '../../../'
+    override_path: "../../../"
+  protocol_examples_common:
+    path: ${IDF_PATH}/examples/common_components/protocol_examples_common
--- a/components/asio/examples/ssl_client_server/CMakeLists.txt
+++ b/components/asio/examples/ssl_client_server/CMakeLists.txt
@ -2,9 +2,6 @@
 # in this exact order for cmake to work correctly
 cmake_minimum_required(VERSION 3.16)

-# (Not part of the boilerplate)
-# This example uses an extra component for common functions such as Wi-Fi and Ethernet connection.
-set(EXTRA_COMPONENT_DIRS ../.. ../../../../common_components/protocol_examples_common)
 set(EXCLUDE_COMPONENTS openssl)

 include($ENV{IDF_PATH}/tools/cmake/project.cmake)
--- a/components/asio/examples/ssl_client_server/main/idf_component.yml
+++ b/components/asio/examples/ssl_client_server/main/idf_component.yml
@ -3,4 +3,6 @@ dependencies:
  idf: ">=5.0"
  espressif/asio:
    version: "^1.14.1"
-    override_path: '../../../'
+    override_path: "../../../"
+  protocol_examples_common:
+    path: ${IDF_PATH}/examples/common_components/protocol_examples_common
--- a/components/asio/examples/tcp_echo_server/CMakeLists.txt
+++ b/components/asio/examples/tcp_echo_server/CMakeLists.txt
@ -2,9 +2,5 @@
 # in this exact order for cmake to work correctly
 cmake_minimum_required(VERSION 3.16)

-# (Not part of the boilerplate)
-# This example uses an extra component for common functions such as Wi-Fi and Ethernet connection.
-set(EXTRA_COMPONENT_DIRS ../.. ../../../../common_components/protocol_examples_common)
-
 include($ENV{IDF_PATH}/tools/cmake/project.cmake)
 project(asio_tcp_echo_server)
--- a/components/asio/examples/tcp_echo_server/main/idf_component.yml
+++ b/components/asio/examples/tcp_echo_server/main/idf_component.yml
@ -3,4 +3,6 @@ dependencies:
  idf: ">=5.0"
  espressif/asio:
    version: "^1.14.1"
-    override_path: '../../../'
+    override_path: "../../../"
+  protocol_examples_common:
+    path: ${IDF_PATH}/examples/common_components/protocol_examples_common
--- a/components/asio/examples/udp_echo_server/CMakeLists.txt
+++ b/components/asio/examples/udp_echo_server/CMakeLists.txt
@ -2,9 +2,5 @@
 # in this exact order for cmake to work correctly
 cmake_minimum_required(VERSION 3.16)

-# (Not part of the boilerplate)
-# This example uses an extra component for common functions such as Wi-Fi and Ethernet connection.
-set(EXTRA_COMPONENT_DIRS ../../ ../../../../common_components/protocol_examples_common)
-
 include($ENV{IDF_PATH}/tools/cmake/project.cmake)
 project(asio_udp_echo_server)
--- a/components/asio/examples/udp_echo_server/main/idf_component.yml
+++ b/components/asio/examples/udp_echo_server/main/idf_component.yml
@ -3,4 +3,6 @@ dependencies:
  idf: ">=5.0"
  espressif/asio:
    version: "^1.14.1"
-    override_path: '../../../'
+    override_path: "../../../"
+  protocol_examples_common:
+    path: ${IDF_PATH}/examples/common_components/protocol_examples_common
--- a/components/asio/idf_component.yml
+++ b/components/asio/idf_component.yml
@ -1,6 +1,9 @@
 version: "1.28.0~0"
-description: ASIO
+description: Cross-platform C++ library for network and I/O programming
 url: https://github.com/espressif/esp-protocols/tree/master/components/asio
+issues: https://github.com/espressif/esp-protocols/issues
+documentation: https://docs.espressif.com/projects/esp-protocols/asio/docs/latest/index.html
+repository: https://github.com/espressif/esp-protocols.git
 dependencies:
  idf:
    version: ">=5.0"
--- a/components/esp_modem/examples/ap_to_pppos/CMakeLists.txt
+++ b/components/esp_modem/examples/ap_to_pppos/CMakeLists.txt
@ -2,7 +2,5 @@
 # CMakeLists in this exact order for cmake to work correctly
 cmake_minimum_required(VERSION 3.5)

-set(EXTRA_COMPONENT_DIRS "../..")
-
 include($ENV{IDF_PATH}/tools/cmake/project.cmake)
 project(ap-to-pppos)
--- a/components/esp_modem/examples/ap_to_pppos/main/idf_component.yml
+++ b/components/esp_modem/examples/ap_to_pppos/main/idf_component.yml
@ -0,0 +1,4 @@
+dependencies:
+  espressif/esp_modem:
+    version: "^1.0.1"
+    override_path: "../../../"
--- a/components/esp_modem/examples/linux_modem/CMakeLists.txt
+++ b/components/esp_modem/examples/linux_modem/CMakeLists.txt
@ -2,7 +2,7 @@ cmake_minimum_required(VERSION 3.5)

 include($ENV{IDF_PATH}/tools/cmake/project.cmake)

-set(EXTRA_COMPONENT_DIRS ../.. ../../port/linux)
+set(EXTRA_COMPONENT_DIRS ../../port/linux)

 set(COMPONENTS main)
 project(linux_modem)
--- a/components/esp_modem/examples/linux_modem/main/idf_component.yml
+++ b/components/esp_modem/examples/linux_modem/main/idf_component.yml
@ -0,0 +1,4 @@
+dependencies:
+  espressif/esp_modem:
+    version: "^1.0.1"
+    override_path: "../../../"
--- a/components/esp_modem/examples/modem_console/Makefile
+++ b/components/esp_modem/examples/modem_console/Makefile
@ -1,10 +0,0 @@
-#
-# This is a project Makefile. It is assumed the directory this Makefile resides in is a
-# project subdirectory.
-#
-
-PROJECT_NAME := modem-console
-
-EXTRA_COMPONENT_DIRS = $(IDF_PATH)/examples/common_components/protocol_examples_common
-
-include $(IDF_PATH)/make/project.mk
--- a/components/esp_modem/examples/modem_console/main/component.mk
+++ b/components/esp_modem/examples/modem_console/main/component.mk
@ -1,4 +0,0 @@
-#
-# "main" pseudo-component makefile.
-#
-# (Uses default behaviour of compiling all source files in directory, adding 'include' to include path.)
--- a/components/esp_modem/examples/modem_psm/CMakeLists.txt
+++ b/components/esp_modem/examples/modem_psm/CMakeLists.txt
@ -4,7 +4,5 @@
 # CMakeLists in this exact order for cmake to work correctly
 cmake_minimum_required(VERSION 3.16)

-set(EXTRA_COMPONENT_DIRS "../..")
-
 include($ENV{IDF_PATH}/tools/cmake/project.cmake)
 project(modem_psm)
--- a/components/esp_modem/examples/modem_psm/main/idf_component.yml
+++ b/components/esp_modem/examples/modem_psm/main/idf_component.yml
@ -0,0 +1,4 @@
+dependencies:
+  espressif/esp_modem:
+    version: "^1.0.1"
+    override_path: "../../../"
--- a/components/esp_modem/examples/modem_tcp_client/CMakeLists.txt
+++ b/components/esp_modem/examples/modem_tcp_client/CMakeLists.txt
@ -2,7 +2,5 @@
 # in this exact order for cmake to work correctly
 cmake_minimum_required(VERSION 3.8)

-set(EXTRA_COMPONENT_DIRS "../..")
-
 include($ENV{IDF_PATH}/tools/cmake/project.cmake)
 project(modem_tcp_client)
--- a/components/esp_modem/examples/modem_tcp_client/main/idf_component.yml
+++ b/components/esp_modem/examples/modem_tcp_client/main/idf_component.yml
@ -0,0 +1,4 @@
+dependencies:
+  espressif/esp_modem:
+    version: "^1.0.1"
+    override_path: "../../../"
--- a/components/esp_modem/examples/pppos_client/CMakeLists.txt
+++ b/components/esp_modem/examples/pppos_client/CMakeLists.txt
@ -2,7 +2,5 @@
 # in this exact order for cmake to work correctly
 cmake_minimum_required(VERSION 3.5)

-set(EXTRA_COMPONENT_DIRS "../..")
-
 include($ENV{IDF_PATH}/tools/cmake/project.cmake)
 project(pppos_client)
--- a/components/esp_modem/examples/simple_cmux_client/CMakeLists.txt
+++ b/components/esp_modem/examples/simple_cmux_client/CMakeLists.txt
@ -3,7 +3,5 @@
 cmake_minimum_required(VERSION 3.8)
 set(CMAKE_CXX_STANDARD 17)

-set(EXTRA_COMPONENT_DIRS "../..")
-
 include($ENV{IDF_PATH}/tools/cmake/project.cmake)
 project(simple_cmux_client)
--- a/components/esp_modem/examples/simple_cmux_client/main/idf_component.yml
+++ b/components/esp_modem/examples/simple_cmux_client/main/idf_component.yml
@ -0,0 +1,4 @@
+dependencies:
+  espressif/esp_modem:
+    version: "^1.0.1"
+    override_path: "../../../"
--- a/components/esp_modem/idf_component.yml
+++ b/components/esp_modem/idf_component.yml
@ -1,6 +1,9 @@
 version: "1.0.4"
-description: esp modem
+description: Library for communicating with cellular modems in command and data modes
 url: https://github.com/espressif/esp-protocols/tree/master/components/esp_modem
+issues: https://github.com/espressif/esp-protocols/issues
+documentation: https://docs.espressif.com/projects/esp-protocols/esp_modem/docs/latest/index.html
+repository: https://github.com/espressif/esp-protocols.git
 dependencies:
  # Required IDF version
  idf:
--- a/components/esp_modem/test/target/main/component.mk
+++ b/components/esp_modem/test/target/main/component.mk
@ -1,8 +0,0 @@
-#
-# Main component makefile.
-#
-# This Makefile can be left empty. By default, it will take the sources in the
-# src/ directory, compile them and link them into lib(subdirectory_name).a
-# in the build directory. This behaviour is entirely configurable,
-# please read the ESP-IDF documents if you need to do this.
-#
--- a/components/esp_mqtt_cxx/examples/ssl/CMakeLists.txt
+++ b/components/esp_mqtt_cxx/examples/ssl/CMakeLists.txt
@ -2,12 +2,6 @@
 # CMakeLists in this exact order for cmake to work correctly
 cmake_minimum_required(VERSION 3.16)

-# (Not part of the boilerplate) This example uses an extra component for common
-# functions such as Wi-Fi and Ethernet connection.
-# The path to esp_mqtt_cxx is also added.
-set(EXTRA_COMPONENT_DIRS
-    "../../../../common_components/protocol_examples_common" "../../")
-
 include($ENV{IDF_PATH}/tools/cmake/project.cmake)
 project(mqtt_ssl_cxx)

--- a/components/esp_mqtt_cxx/examples/ssl/main/idf_component.yml
+++ b/components/esp_mqtt_cxx/examples/ssl/main/idf_component.yml
@ -2,4 +2,7 @@ dependencies:
  ## Required IDF version
  idf: ">=5.0"
  espressif/esp_mqtt_cxx:
-    version: "^0.1.0"
+    version: "~0"
+    override_path: "../../../"
+  protocol_examples_common:
+    path: ${IDF_PATH}/examples/common_components/protocol_examples_common
--- a/components/esp_mqtt_cxx/examples/tcp/CMakeLists.txt
+++ b/components/esp_mqtt_cxx/examples/tcp/CMakeLists.txt
@ -2,11 +2,5 @@
 # in this exact order for cmake to work correctly
 cmake_minimum_required(VERSION 3.16)

-# (Not part of the boilerplate)
-# This example uses an extra component for common functions such as Wi-Fi and Ethernet connection.
-# The path to esp_mqtt_cxx is also added.
-set(EXTRA_COMPONENT_DIRS
-    "../../../../common_components/protocol_examples_common" "../../")
-
 include($ENV{IDF_PATH}/tools/cmake/project.cmake)
 project(mqtt_tcp_cxx)
--- a/components/esp_mqtt_cxx/examples/tcp/main/idf_component.yml
+++ b/components/esp_mqtt_cxx/examples/tcp/main/idf_component.yml
@ -2,4 +2,7 @@ dependencies:
  ## Required IDF version
  idf: ">=5.0"
  espressif/esp_mqtt_cxx:
-    version: "^0.1.0"
+    version: "~0"
+    override_path: "../../../"
+  protocol_examples_common:
+    path: ${IDF_PATH}/examples/common_components/protocol_examples_common
--- a/components/esp_mqtt_cxx/idf_component.yml
+++ b/components/esp_mqtt_cxx/idf_component.yml
@ -1,6 +1,9 @@
 version: "0.2.0"
-description: esp mqtt cxx
+description: C++ APIs for ESP-MQTT library
 url: https://github.com/espressif/esp-protocols/tree/master/components/esp_mqtt_cxx
+issues: https://github.com/espressif/esp-protocols/issues
+documentation: https://docs.espressif.com/projects/esp-protocols/esp_mqtt_cxx/docs/latest/index.html
+repository: https://github.com/espressif/esp-protocols.git
 dependencies:
  espressif/esp-idf-cxx: "^1.0.0-beta"
  # Required IDF version
--- a/components/esp_websocket_client/examples/linux/CMakeLists.txt
+++ b/components/esp_websocket_client/examples/linux/CMakeLists.txt
@ -8,7 +8,6 @@ set(EXTRA_COMPONENT_DIRS
  "${common_component_dir}/linux_compat"
  "${common_component_dir}/linux_compat/freertos")

-list(APPEND EXTRA_COMPONENT_DIRS $ENV{IDF_PATH}/examples/common_components/protocol_examples_common)
 list(APPEND EXTRA_COMPONENT_DIRS $ENV{IDF_PATH}/examples/protocols/linux_stubs/esp_stubs)
 include($ENV{IDF_PATH}/tools/cmake/project.cmake)

--- a/components/esp_websocket_client/examples/linux/main/idf_component.yml
+++ b/components/esp_websocket_client/examples/linux/main/idf_component.yml
@ -0,0 +1,3 @@
+dependencies:
+  protocol_examples_common:
+    path: ${IDF_PATH}/examples/common_components/protocol_examples_common
--- a/components/esp_websocket_client/examples/target/CMakeLists.txt
+++ b/components/esp_websocket_client/examples/target/CMakeLists.txt
@ -2,9 +2,5 @@
 # in this exact order for cmake to work correctly
 cmake_minimum_required(VERSION 3.5)

-set(EXTRA_COMPONENT_DIRS "../..")
-# This example uses an extra component for common functions such as Wi-Fi and Ethernet connection.
-list(APPEND EXTRA_COMPONENT_DIRS "../../../../common_components/protocol_examples_common")
-
 include($ENV{IDF_PATH}/tools/cmake/project.cmake)
 project(websocket_example)
--- a/components/esp_websocket_client/examples/target/main/idf_component.yml
+++ b/components/esp_websocket_client/examples/target/main/idf_component.yml
@ -3,3 +3,6 @@ dependencies:
  idf: ">=5.0"
  espressif/esp_websocket_client:
    version: "^1.0.0"
+    override_path: "../../../"
+  protocol_examples_common:
+    path: ${IDF_PATH}/examples/common_components/protocol_examples_common
--- a/components/esp_websocket_client/idf_component.yml
+++ b/components/esp_websocket_client/idf_component.yml
@ -1,5 +1,5 @@
 version: "1.1.0"
-description: esp websocket client
+description: WebSocket protocol client for ESP-IDF
 url: https://github.com/espressif/esp-protocols/tree/master/components/esp_websocket_client
 dependencies:
  idf:
--- a/components/mdns/examples/CMakeLists.txt
+++ b/components/mdns/examples/CMakeLists.txt
@ -1,10 +0,0 @@
-# The following lines of boilerplate have to be in your project's CMakeLists
-# in this exact order for cmake to work correctly
-cmake_minimum_required(VERSION 3.5)
-
-set(EXTRA_COMPONENT_DIRS "..")
-# This example uses an extra component for common functions such as Wi-Fi and Ethernet connection.
-list(APPEND EXTRA_COMPONENT_DIRS "../../../common_components/protocol_examples_common")
-
-include($ENV{IDF_PATH}/tools/cmake/project.cmake)
-project(mdns_test)
--- a/components/mdns/examples/main/idf_component.yml
+++ b/components/mdns/examples/main/idf_component.yml
@ -1,5 +0,0 @@
-dependencies:
-  ## Required IDF version
-  idf: ">=5.0"
-  espressif/mdns:
-    version: "^1.0.0"
--- a/components/mdns/examples/query_advertise/CMakeLists.txt
+++ b/components/mdns/examples/query_advertise/CMakeLists.txt
@ -0,0 +1,6 @@
+# The following lines of boilerplate have to be in your project's CMakeLists
+# in this exact order for cmake to work correctly
+cmake_minimum_required(VERSION 3.5)
+
+include($ENV{IDF_PATH}/tools/cmake/project.cmake)
+project(query_advertise)
--- a/components/mdns/examples/query_advertise/README.md
+++ b/components/mdns/examples/query_advertise/README.md
@ -1,6 +1,6 @@
 # mDNS example

-Shows how to use mDNS to advertise lookup services and hosts
+Shows how to use mDNS to advertise and query services and hosts

 ## Example workflow

--- a/components/mdns/examples/query_advertise/main/CMakeLists.txt
+++ b/components/mdns/examples/query_advertise/main/CMakeLists.txt
--- a/components/mdns/examples/query_advertise/main/Kconfig.projbuild
+++ b/components/mdns/examples/query_advertise/main/Kconfig.projbuild
--- a/components/mdns/examples/query_advertise/main/idf_component.yml
+++ b/components/mdns/examples/query_advertise/main/idf_component.yml
@ -0,0 +1,8 @@
+dependencies:
+  ## Required IDF version
+  idf: ">=5.0"
+  espressif/mdns:
+    version: "^1.0.0"
+    override_path: "../../../"
+  protocol_examples_common:
+    path: ${IDF_PATH}/examples/common_components/protocol_examples_common
--- a/components/mdns/examples/query_advertise/main/mdns_example_main.c
+++ b/components/mdns/examples/query_advertise/main/mdns_example_main.c
--- a/components/mdns/examples/query_advertise/pytest_mdns.py
+++ b/components/mdns/examples/query_advertise/pytest_mdns.py
--- a/components/mdns/examples/query_advertise/sdkconfig.ci.eth_custom_netif
+++ b/components/mdns/examples/query_advertise/sdkconfig.ci.eth_custom_netif
--- a/components/mdns/examples/query_advertise/sdkconfig.ci.eth_def
+++ b/components/mdns/examples/query_advertise/sdkconfig.ci.eth_def
--- a/components/mdns/examples/query_advertise/sdkconfig.ci.eth_no_ipv6
+++ b/components/mdns/examples/query_advertise/sdkconfig.ci.eth_no_ipv6
--- a/components/mdns/examples/query_advertise/sdkconfig.ci.eth_socket
+++ b/components/mdns/examples/query_advertise/sdkconfig.ci.eth_socket
--- a/components/mdns/tests/test_apps/CMakeLists.txt
+++ b/components/mdns/tests/test_apps/CMakeLists.txt
@ -2,10 +2,6 @@
 # in this exact order for cmake to work correctly
 cmake_minimum_required(VERSION 3.5)

-# (Not part of the boilerplate)
-# This example uses an extra component for common functions such as Wi-Fi and Ethernet connection.
-set(EXTRA_COMPONENT_DIRS ../../ ../../../../common_components/protocol_examples_common)
-
 include($ENV{IDF_PATH}/tools/cmake/project.cmake)

 project(mdns_test_app)
--- a/components/mdns/tests/test_apps/main/idf_component.yml
+++ b/components/mdns/tests/test_apps/main/idf_component.yml
@ -0,0 +1,8 @@
+dependencies:
+  ## Required IDF version
+  idf: ">=5.0"
+  espressif/mdns:
+    version: "^1.0.0"
+    override_path: "../../../"
+  protocol_examples_common:
+    path: ${IDF_PATH}/examples/common_components/protocol_examples_common