From 90de9d4036ebc5d00a49e349fb0696bce3fd4718 Mon Sep 17 00:00:00 2001 From: daiziyan Date: Thu, 27 Oct 2022 18:04:52 +0800 Subject: [PATCH] update provisioning and removed-components for migration-guides --- docs/en/migration-guides/release-5.x/5.0/provisioning.rst | 3 ++- docs/zh_CN/migration-guides/release-5.x/5.0/provisioning.rst | 2 +- .../migration-guides/release-5.x/5.0/removed-components.rst | 1 + 3 files changed, 4 insertions(+), 2 deletions(-) diff --git a/docs/en/migration-guides/release-5.x/5.0/provisioning.rst b/docs/en/migration-guides/release-5.x/5.0/provisioning.rst index f9950203ce..c4154f98d7 100644 --- a/docs/en/migration-guides/release-5.x/5.0/provisioning.rst +++ b/docs/en/migration-guides/release-5.x/5.0/provisioning.rst @@ -14,7 +14,8 @@ Wi-Fi Provisioning ------------------ .. list:: - * The ``pop`` field in the :cpp:func:`wifi_prov_mgr_start_provisioning` API is now deprecated. For backward compatibility, ``pop`` can be still passed as a string for security1. However for Security2 the ``wifi_prov_sec_params`` argument needs to be passed instead of ``pop``. This parameter should contain the structure (containing the security parameters) as required by the protocol version used. For example, when using security version 2, the ``wifi_prov_sec_params`` parameter should contain the pointer to the structure of type :cpp:type:`wifi_prov_security2_params_t`. For security 1 the behaviour and the usage of the API remains same. + * The ``pop`` field in the :cpp:func:`wifi_prov_mgr_start_provisioning` API is now deprecated. For backward compatibility, ``pop`` can be still passed as a string for security version 1. However, for security version 2, the ``wifi_prov_sec_params`` argument needs to be passed instead of ``pop``. This parameter should contain the structure (containing the security parameters) as required by the protocol version used. For example, when using security version 2, the ``wifi_prov_sec_params`` parameter should contain the pointer to the structure of type :cpp:type:`wifi_prov_security2_params_t`. For security 1, the behaviour and the usage of the API remain the same. + * The API :cpp:func:`wifi_prov_mgr_is_provisioned` does not return :c:macro:`ESP_ERR_INVALID_STATE` error any more. This API now works without any dependency on provisioning manager initialization state. ESP Local Control diff --git a/docs/zh_CN/migration-guides/release-5.x/5.0/provisioning.rst b/docs/zh_CN/migration-guides/release-5.x/5.0/provisioning.rst index 91ff8e5ccc..57435d798b 100644 --- a/docs/zh_CN/migration-guides/release-5.x/5.0/provisioning.rst +++ b/docs/zh_CN/migration-guides/release-5.x/5.0/provisioning.rst @@ -14,7 +14,7 @@ Wi-Fi 配置 ------------- .. list:: - * :cpp:func:`wifi_prov_mgr_start_provisioning` API 中的 ``pop`` 字段现已弃用。请使用 ``wifi_prov_sec_params`` 字段来代替 ``pop``。此参数应包含所使用的协议版本所要求的结构（包括安全参数）。例如，当使用安全版本 2 时，``wifi_prov_sec_params`` 参数应包含指向 :cpp:type:`wifi_prov_security2_params_t` 结构体类型的指针。 + * :cpp:func:`wifi_prov_mgr_start_provisioning` API 中的 ``pop`` 字段现已弃用。为了向后兼容，在使用安全版本 1 时，``pop`` 仍可以作为字符串传递。但在使用安全版本 2 时，请使用 ``wifi_prov_sec_params`` 字段来代替 ``pop``。此参数应包含所使用的协议版本所要求的结构（包括安全参数）。例如，当使用安全版本 2 时，``wifi_prov_sec_params`` 参数应包含指向 :cpp:type:`wifi_prov_security2_params_t` 结构体类型的指针。对于安全版本 1，该 API 的行为和使用方式保持不变。 * :cpp:func:`wifi_prov_mgr_is_provisioned` API 不再返回 :c:macro:`ESP_ERR_INVALID_STATE` 错误。此 API 现在可以在不依赖配置管理器初始化状态的情况下工作。 diff --git a/docs/zh_CN/migration-guides/release-5.x/5.0/removed-components.rst b/docs/zh_CN/migration-guides/release-5.x/5.0/removed-components.rst index 0b10c5fe7a..ec0cf7f702 100644 --- a/docs/zh_CN/migration-guides/release-5.x/5.0/removed-components.rst +++ b/docs/zh_CN/migration-guides/release-5.x/5.0/removed-components.rst @@ -23,6 +23,7 @@ * `esp-cryptoauthlib `_ * `qrcode `_ * `tjpgd `_ +* `esp_serial_slave_link `_ .. note:: 请注意，http 解析功能以前属于 ``nghttp`` 组件一部分，但现在属于 :component:`http_parser ` 组件。