alex/esp-idf
alex/esp-idf
1
0
Fork 0
mirror of https://github.com/espressif/esp-idf.git synced 2024-10-05 20:47:46 -04:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

Merge branch 'bugfix/mqtt_docs_migration_5.x' into 'master'

Browse Source 
mqtt/docs: Mention removal of user_context in 5.x migration guide

Closes IDFGH-9261

See merge request espressif/esp-idf!22177
This commit is contained in:
David Čermák 2023-02-02 18:55:29 +08:00
commit b37980d26e
2 changed files with 6 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
docs/en/migration-guides/release-5.x/5.0/protocols.rst
View File

@ -169,7 +169,7 @@ MQTT Client
Breaking Changes (Summary) Breaking Changes (Summary)
~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~
- :cpp:type:`esp_mqtt_client_config_t` have all fields grouped in sub structs. - :cpp:type:`esp_mqtt_client_config_t` have all fields grouped in sub structs.
Most common configurations are listed below: Most common configurations are listed below:
@ -177,9 +177,11 @@ Most common configurations are listed below:
- Security related to broker verification in :cpp:member:`esp_mqtt_client_config_t::broker::verification` - Security related to broker verification in :cpp:member:`esp_mqtt_client_config_t::broker::verification`
- Client username is set in :cpp:member:`esp_mqtt_client_config_t::credentials::username` - Client username is set in :cpp:member:`esp_mqtt_client_config_t::credentials::username`
- :cpp:type:`esp_mqtt_client_config_t` no longer supports the ``user_context`` field. Please use :cpp:func:`esp_mqtt_client_register_event` instead for registering an event handler; the last argument ``event_handler_arg`` can be used to pass user context to the handler.
ESP-Modbus ESP-Modbus
---------- -----------
Breaking Changes (Summary) Breaking Changes (Summary)
~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~

2
docs/zh_CN/migration-guides/release-5.x/5.0/protocols.rst
View File

@ -177,6 +177,8 @@ MQTT 客户端
- 通过 :cpp:member:`esp_mqtt_client_config_t::broker::verification` 配置 MQTT Broker 身份验证的相关安全问题 - 通过 :cpp:member:`esp_mqtt_client_config_t::broker::verification` 配置 MQTT Broker 身份验证的相关安全问题
- 通过 :cpp:member:`esp_mqtt_client_config_t::credentials::username` 配置客户端用户名 - 通过 :cpp:member:`esp_mqtt_client_config_t::credentials::username` 配置客户端用户名
- :cpp:type:`esp_mqtt_client_config_t` 不再支持 ``user_context`` 字段。之后注册事件处理程序，请使用 :cpp:func:`esp_mqtt_client_register_event`；最后一个参数 ``event_handler_arg`` 可用于将用户上下文传递给处理程序。
ESP-Modbus ESP-Modbus
---------- ----------