diff --git a/docs/en/api-guides/performance/ram-usage.rst b/docs/en/api-guides/performance/ram-usage.rst index ff08a79075..7eea8f3a5b 100644 --- a/docs/en/api-guides/performance/ram-usage.rst +++ b/docs/en/api-guides/performance/ram-usage.rst @@ -83,7 +83,7 @@ The default stack sizes for these tasks are usually set conservatively high, to - The Ethernet driver creates a task for the MAC to receive Ethernet frames. If using the default config ``ETH_MAC_DEFAULT_CONFIG`` then the task stack size is 4 KB. This setting can be changed by passing a custom :cpp:class:`eth_mac_config_t` struct when initializing the Ethernet MAC. - FreeRTOS idle task stack size is configured by :ref:`CONFIG_FREERTOS_IDLE_TASK_STACKSIZE`. - If using the :doc:`MQTT ` component, it creates a task with stack size configured by :ref:`CONFIG_MQTT_TASK_STACK_SIZE`. MQTT stack size can also be configured using ``task_stack`` field of :cpp:class:`esp_mqtt_client_config_t`. - - To see how to optimize RAM usage when using ``mDNS``, please check `Performance Optimization `__. + - To see how to optimize RAM usage when using ``mDNS``, please check `Performance Optimization `__. .. note:: diff --git a/docs/en/api-guides/performance/speed.rst b/docs/en/api-guides/performance/speed.rst index a32b592fb9..c8e338e3c3 100644 --- a/docs/en/api-guides/performance/speed.rst +++ b/docs/en/api-guides/performance/speed.rst @@ -170,7 +170,7 @@ Common priorities are: :SOC_BT_SUPPORTED: - :doc:`NimBLE Bluetooth Host ` host task has high priority (21). - The Ethernet driver creates a task for the MAC to receive Ethernet frames. If using the default config ``ETH_MAC_DEFAULT_CONFIG`` then the priority is medium-high (15). This setting can be changed by passing a custom :cpp:class:`eth_mac_config_t` struct when initializing the Ethernet MAC. - If using the :doc:`MQTT ` component, it creates a task with default priority 5 (:ref:`configurable`, depends on :ref:`CONFIG_MQTT_USE_CUSTOM_CONFIG` (also configurable runtime by ``task_prio`` field in the :cpp:class:`esp_mqtt_client_config_t`) - - To see what is the task priority for ``mDNS`` service, please check `Performance Optimization `__. + - To see what is the task priority for ``mDNS`` service, please check `Performance Optimization `__. .. only :: not CONFIG_FREERTOS_UNICORE diff --git a/docs/en/api-reference/protocols/asio.rst b/docs/en/api-reference/protocols/asio.rst index 48903c6934..17ca3015a0 100644 --- a/docs/en/api-reference/protocols/asio.rst +++ b/docs/en/api-reference/protocols/asio.rst @@ -7,9 +7,11 @@ The ESP-IDF component `ASIO` has been moved from ESP-IDF since version v5.0 to a * `ASIO component on GitHub `__ +To add ASIO component in your project, please run `idf.py add-dependency espressif/asio` + Hosted Documentation -------------------- The documentation can be found on the link below: -* `ASIO documentation (English) `__ +* `ASIO documentation (English) `__ diff --git a/docs/en/api-reference/protocols/mdns.rst b/docs/en/api-reference/protocols/mdns.rst index 70cacfd7cd..9010bbe642 100644 --- a/docs/en/api-reference/protocols/mdns.rst +++ b/docs/en/api-reference/protocols/mdns.rst @@ -8,9 +8,11 @@ The ESP-IDF component `mDNS` has been moved from ESP-IDF since version v5.0 to a * `mDNS component on GitHub `__ +To add mDNS component in your project, please run `idf.py add-dependency espressif/mdns` + Hosted Documentation -------------------- The documentation can be found on the link below: -* `mDNS documentation `__ +* `mDNS documentation `__ diff --git a/docs/en/libraries-and-frameworks/libs-frameworks.rst b/docs/en/libraries-and-frameworks/libs-frameworks.rst index e49b6b7ced..7f53b6b9b0 100644 --- a/docs/en/libraries-and-frameworks/libs-frameworks.rst +++ b/docs/en/libraries-and-frameworks/libs-frameworks.rst @@ -88,13 +88,13 @@ ESP-Protocols ESP-Protocols components: -* `esp_modem `_ enables connectivity with GSM/LTE modems using AT commands or PPP protocol, see the `esp_modem documentation `_. +* `esp_modem `_ enables connectivity with GSM/LTE modems using AT commands or PPP protocol, see the `esp_modem documentation `_. -* `mdns `_ (mDNS) is a multicast UDP service that is used to provide local network service and host discovery, see the `mdns documentation `_. +* `mdns `_ (mDNS) is a multicast UDP service that is used to provide local network service and host discovery, see the `mdns documentation `_. -* `esp_websocket_client `_ is a managed component for `esp-idf` that contains implementation of [WebSocket protocol client](https://datatracker.ietf.org/doc/html/rfc6455) for ESP32, see the `esp_websocket_client documentation `_. +* `esp_websocket_client `_ is a managed component for `esp-idf` that contains implementation of [WebSocket protocol client](https://datatracker.ietf.org/doc/html/rfc6455) for ESP32, see the `esp_websocket_client documentation `_. -* `asio `_ is a cross-platform C++ library, see https://think-async.com/Asio/. It provides a consistent asynchronous model using a modern C++ approach. , see the `asio documentation `_. +* `asio `_ is a cross-platform C++ library, see https://think-async.com/Asio/. It provides a consistent asynchronous model using a modern C++ approach. , see the `asio documentation `_. ESP-BSP ------- diff --git a/docs/zh_CN/api-reference/protocols/mdns.rst b/docs/zh_CN/api-reference/protocols/mdns.rst index 5e02000ea7..dc54178aee 100644 --- a/docs/zh_CN/api-reference/protocols/mdns.rst +++ b/docs/zh_CN/api-reference/protocols/mdns.rst @@ -13,4 +13,4 @@ mDNS 是一种组播 UDP 服务，用来提供本地网络服务和主机发现 请点击如下链接，查看 mDNS 的相关文档： -* `mDNS 文档 `__ +* `mDNS 文档 `__