diff --git a/components/freertos/FreeRTOS-Kernel-SMP/include/freertos/queue.h b/components/freertos/FreeRTOS-Kernel-SMP/include/freertos/queue.h index 6dbcebfa9ac..aa870690689 100644 --- a/components/freertos/FreeRTOS-Kernel-SMP/include/freertos/queue.h +++ b/components/freertos/FreeRTOS-Kernel-SMP/include/freertos/queue.h @@ -1649,7 +1649,7 @@ BaseType_t xQueueGiveMutexRecursive( QueueHandle_t xMutex ) PRIVILEGED_FUNCTION; * or semaphores contained in the set is in a state where a queue read or * semaphore take operation would be successful. * - * Note 1: See the documentation on https://www.FreeRTOS.org/RTOS-queue-sets.html + * Note 1: See the documentation on https://www.freertos.org/Documentation/02-Kernel/04-API-references/07-Queue-sets/00-RTOS-queue-sets * for reasons why queue sets are very rarely needed in practice as there are * simpler methods of blocking on multiple objects. * @@ -1746,7 +1746,7 @@ BaseType_t xQueueGiveMutexRecursive( QueueHandle_t xMutex ) PRIVILEGED_FUNCTION; * See FreeRTOS/Source/Demo/Common/Minimal/QueueSet.c for an example using this * function. * - * Note 1: See the documentation on https://www.FreeRTOS.org/RTOS-queue-sets.html + * Note 1: See the documentation on https://www.freertos.org/Documentation/02-Kernel/04-API-references/07-Queue-sets/00-RTOS-queue-sets * for reasons why queue sets are very rarely needed in practice as there are * simpler methods of blocking on multiple objects. * diff --git a/components/freertos/FreeRTOS-Kernel/include/freertos/queue.h b/components/freertos/FreeRTOS-Kernel/include/freertos/queue.h index 4c975649aba..2b131bc2f9b 100644 --- a/components/freertos/FreeRTOS-Kernel/include/freertos/queue.h +++ b/components/freertos/FreeRTOS-Kernel/include/freertos/queue.h @@ -1485,7 +1485,7 @@ BaseType_t xQueueGiveMutexRecursive( QueueHandle_t xMutex ) PRIVILEGED_FUNCTION; * or semaphores contained in the set is in a state where a queue read or * semaphore take operation would be successful. * - * Note 1: See the documentation on https://www.FreeRTOS.org/RTOS-queue-sets.html + * Note 1: See the documentation on https://www.freertos.org/Documentation/02-Kernel/04-API-references/07-Queue-sets/00-RTOS-queue-sets * for reasons why queue sets are very rarely needed in practice as there are * simpler methods of blocking on multiple objects. * @@ -1576,7 +1576,7 @@ BaseType_t xQueueRemoveFromSet( QueueSetMemberHandle_t xQueueOrSemaphore, * See FreeRTOS/Source/Demo/Common/Minimal/QueueSet.c for an example using this * function. * - * Note 1: See the documentation on https://www.FreeRTOS.org/RTOS-queue-sets.html + * Note 1: See the documentation on https://www.freertos.org/Documentation/02-Kernel/04-API-references/07-Queue-sets/00-RTOS-queue-sets * for reasons why queue sets are very rarely needed in practice as there are * simpler methods of blocking on multiple objects. * diff --git a/docs/en/api-guides/performance/size.rst b/docs/en/api-guides/performance/size.rst index 8d07ef677e5..199272931c9 100644 --- a/docs/en/api-guides/performance/size.rst +++ b/docs/en/api-guides/performance/size.rst @@ -170,7 +170,7 @@ By default, ESP-IDF uses Newlib "full" formatting for I/O functions (``printf()` Enabling "Nano" formatting reduces the stack usage of each function that calls ``printf()`` or another string formatting function, see :ref:`optimize-stack-sizes`. -"Nano" formatting does not support 64-bit integers, or C99 formatting features. For a full list of restrictions, search for ``--enable-newlib-nano-formatted-io`` in the `Newlib README file`_. +"Nano" formatting does not support 64-bit integers, or C99 formatting features. For a full list of restrictions, search for ``--enable-newlib-nano-formatted-io`` in the `Newlib documentation`_. .. only:: esp32c2 @@ -180,7 +180,7 @@ Enabling "Nano" formatting reduces the stack usage of each function that calls ` :ref:`CONFIG_NEWLIB_NANO_FORMAT` is enabled by default on {IDF_TARGET_NAME}. -.. _Newlib README file: https://sourceware.org/newlib/README +.. _Newlib documentation: https://sourceware.org/newlib/docs.html .. _minimizing_binary_mbedtls: diff --git a/docs/en/api-guides/tools/idf-docker-image.rst b/docs/en/api-guides/tools/idf-docker-image.rst index 37e1ed8785b..366a05719fd 100644 --- a/docs/en/api-guides/tools/idf-docker-image.rst +++ b/docs/en/api-guides/tools/idf-docker-image.rst @@ -162,7 +162,7 @@ To use these arguments, pass them via the ``--build-arg`` command line option. F --build-arg IDF_INSTALL_TARGETS=esp32c3 \ tools/docker -.. _remote serial ports: https://docs.espressif.com/projects/esptool/en/latest/esptool/remote-serial-ports.html +.. _remote serial ports: https://docs.espressif.com/projects/esptool/en/latest/remote-serial-ports.html .. _RFC2217: http://www.ietf.org/rfc/rfc2217.txt .. _esptool releases: https://github.com/espressif/esptool/releases .. _device option: https://docs.docker.com/engine/reference/run/#runtime-privilege-and-linux-capabilities diff --git a/docs/en/api-reference/protocols/esp_crt_bundle.rst b/docs/en/api-reference/protocols/esp_crt_bundle.rst index e807d1bba8a..a8e1be9af27 100644 --- a/docs/en/api-reference/protocols/esp_crt_bundle.rst +++ b/docs/en/api-reference/protocols/esp_crt_bundle.rst @@ -67,7 +67,7 @@ Another alternative would be to download the finished list directly from the cur The common certificates bundle were made by selecting the authorities with a market share of more than 1% from w3tech's `SSL Survey `_. -These authorities were then used to pick the names of the certificates for the filter list, ``cmn_crt_authorities.csv``, from `this list `_ provided by Mozilla. +These authorities were then used to pick the names of the certificates for the filter list, ``cmn_crt_authorities.csv``, from Mozilla's `Included CA Certificate List `_. Updating the Certificate Bundle diff --git a/docs/en/contribute/esp-idf-tests-with-pytest.rst b/docs/en/contribute/esp-idf-tests-with-pytest.rst index 424bf4218e2..9210de1d8e8 100644 --- a/docs/en/contribute/esp-idf-tests-with-pytest.rst +++ b/docs/en/contribute/esp-idf-tests-with-pytest.rst @@ -123,7 +123,7 @@ Finally, we have the test function. With a ``dut`` fixture. In single-dut test c Same App With Different sdkconfig Files ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -For some test cases, you may need to run the same app with different sdkconfig files. For detailed documentation regarding sdkconfig related concepts, please refer to `idf-build-apps Documentation `__. +For some test cases, you may need to run the same app with different sdkconfig files. For detailed documentation regarding sdkconfig related concepts, please refer to `idf-build-apps Documentation `__. Here's a simple example that demonstrates how to run the same app with different sdkconfig files. Assume we have the following folder structure: @@ -765,5 +765,5 @@ Let us assume the value of ``IDF_PERFORMANCE_MAX_RSA_2048KEY_PUBLIC_OP`` is 1900 Further Readings ================ -- `pytest documentation `_ +- `pytest documentation `_ - `pytest-embedded documentation `_ diff --git a/docs/zh_CN/api-guides/performance/size.rst b/docs/zh_CN/api-guides/performance/size.rst index a5705fa667b..b4c720d3630 100644 --- a/docs/zh_CN/api-guides/performance/size.rst +++ b/docs/zh_CN/api-guides/performance/size.rst @@ -170,7 +170,7 @@ ESP-IDF 的 I/O 函数（ ``printf()`` 和 ``scanf()`` 等）默认使用 Newlib 启用 Nano 格式化会减少调用 ``printf()`` 或其他字符串格式化函数的堆栈使用量，参阅 :ref:`optimize-stack-sizes`。 -“Nano” 格式化不支持 64 位整数或 C99 格式化功能。请在 `Newlib README 文件`_ 中搜索 ``--enable-newlib-nano-formatted-io`` 来获取完整的限制列表。 +“Nano” 格式化不支持 64 位整数或 C99 格式化功能。请在 `Newlib 文档`_ 中搜索 ``--enable-newlib-nano-formatted-io`` 来获取完整的限制列表。 .. only:: esp32c2 @@ -180,7 +180,7 @@ ESP-IDF 的 I/O 函数（ ``printf()`` 和 ``scanf()`` 等）默认使用 Newlib {IDF_TARGET_NAME} 会默认启用 :ref:`CONFIG_NEWLIB_NANO_FORMAT`。 -.. _Newlib README 文件: https://sourceware.org/newlib/README +.. _Newlib 文档: https://sourceware.org/newlib/docs.html .. _minimizing_binary_mbedtls: diff --git a/docs/zh_CN/api-guides/tools/idf-docker-image.rst b/docs/zh_CN/api-guides/tools/idf-docker-image.rst index 630a0eac696..cecca65b42b 100644 --- a/docs/zh_CN/api-guides/tools/idf-docker-image.rst +++ b/docs/zh_CN/api-guides/tools/idf-docker-image.rst @@ -162,7 +162,7 @@ ESP-IDF 库中的 Docker 文件提供了以下构建参数，可用于构建自 --build-arg IDF_INSTALL_TARGETS=esp32c3 \ tools/docker -.. _远程串行接口: https://docs.espressif.com/projects/esptool/en/latest/esptool/remote-serial-ports.html +.. _远程串行接口: https://docs.espressif.com/projects/esptool/en/latest/esp32/remote-serial-ports.html .. _RFC2217: http://www.ietf.org/rfc/rfc2217.txt .. _ESP 工具版本: https://github.com/espressif/esptool/releases .. _设备选项: https://docs.docker.com/engine/reference/run/#runtime-privilege-and-linux-capabilities diff --git a/docs/zh_CN/api-reference/protocols/esp_crt_bundle.rst b/docs/zh_CN/api-reference/protocols/esp_crt_bundle.rst index 2fdb0d4c4ad..038326e41e6 100644 --- a/docs/zh_CN/api-reference/protocols/esp_crt_bundle.rst +++ b/docs/zh_CN/api-reference/protocols/esp_crt_bundle.rst @@ -67,7 +67,7 @@ ESP x509 证书包 API 提供了一种简便的方法，帮助你安装自定义 常用证书包是通过筛选出市场份额超过 1% 的授权机构来决定的，筛选数据来自 w3tech 的 `SSL Survey `_。 -根据这些授权机构，从 Mozilla 提供的 `列表 `_ 的 ``cmn_crt_authorities.csv`` 中筛选证书名称。 +根据这些授权机构，从 Mozilla 提供的 `Included CA Certificate List `_ 中筛选 ``cmn_crt_authorities.csv`` 所需的证书名称。 更新证书包 diff --git a/docs/zh_CN/contribute/documenting-code.rst b/docs/zh_CN/contribute/documenting-code.rst index c8a1ee2d106..b0c9b7b1c84 100644 --- a/docs/zh_CN/contribute/documenting-code.rst +++ b/docs/zh_CN/contribute/documenting-code.rst @@ -212,4 +212,4 @@ Doxygen 支持多种格式，并支持文档内部的多个详情级别，具有 .. _interactive shell: http://interactive.blockdiag.com/?compression=deflate&src=eJxlUMFOwzAMvecrrO3aITYQQirlAIIzEseJQ5q4TUSIq8TVGIh_J2m7jbKc7Ge_5_dSO1Lv2soWvoVYgieNoMh7VGzJR9FJtugZ7lYQ0UcKEbYNOY36rRQHZHUPT68vV5tceGLbWCUzPfeaFFMoBZzecVc56vWwJFnWMmJ59CCZg617xpOFbTSyw0pmvT_HJ7hxtFNGBr6wvuu5SCkchcrZ1vAeXZomznh5YgTqfcpR02cBO6vZVDeXBRjMjKEcFRbLh8f18-Z2UUBDnqP9wmp9ncRmSSfND2ldGo2h_zse407g0Mxc1q7HzJ3-4jzYYTJjtQH3iSV-fgFzx50J -.. _Breathe: https://breathe.readthedocs.io/en/latest/2 +.. _Breathe: https://breathe.readthedocs.io/en/latest/ diff --git a/docs/zh_CN/contribute/esp-idf-tests-with-pytest.rst b/docs/zh_CN/contribute/esp-idf-tests-with-pytest.rst index db6ffa1df9c..dc3642fb58b 100644 --- a/docs/zh_CN/contribute/esp-idf-tests-with-pytest.rst +++ b/docs/zh_CN/contribute/esp-idf-tests-with-pytest.rst @@ -123,7 +123,7 @@ ESP-IDF 在主机端使用 pytest 框架（以及一些 pytest 插件）来自 使用不同的 sdkconfig 文件运行相同的应用程序 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -某些测试用例可能需要使用不同的 sdkconfig 文件运行相同的应用程序。与 sdkconfig 相关概念的详细文档，请参阅 `idf-build-apps 文档 `__。 +某些测试用例可能需要使用不同的 sdkconfig 文件运行相同的应用程序。与 sdkconfig 相关概念的详细文档，请参阅 `idf-build-apps 文档 `__。 以下是一个简单的示例，演示了如何使用不同的 sdkconfig 文件运行相同的应用程序。假设我们有以下文件夹结构： @@ -765,5 +765,5 @@ Pytest 使用技巧 扩展阅读 ============= -- `pytest 文档 `_ +- `pytest 文档 `_ - `pytest-embedded 文档 `_