Merge branch 'feat/network_hints' into 'master'

tools: Update idf-py hints with networking component info

Closes IDF-5672

See merge request espressif/esp-idf!20471
This commit is contained in:
David Čermák
2022-10-12 16:27:11 +08:00
3 changed files with 33 additions and 14 deletions

View File

@@ -137,10 +137,3 @@ IP Addresses
You are advised to use esp-netif defined IP structures. Please note that with default compatibility enabled, the LwIP structs will still work.
* :component_file:`esp-netif IP address definitions <esp_netif/include/esp_netif_ip_addr.h#L96>`
Next Steps
^^^^^^^^^^
To port an application which may fully benefit from the :doc:`/api-reference/network/esp_netif`, you also need to disable the tcpip_adapter compatibility layer in the component configuration option. Please go to ``ESP NETIF Adapter`` > ``Enable backward compatible tcpip_adapter interface``. After that, check if your project compiles.
The TCP/IP adapter includes many dependencies. Thus, disabling its compatibility might help separate the application from using specific TCP/IP stack API directly.

View File

@@ -137,10 +137,3 @@ IP 地址
推荐使用 esp-netif 定义的 IP 结构。请注意在启用默认兼容性时LwIP 结构体仍然可以工作。
* :component_file:`esp-netif IP address definitions <esp_netif/include/esp_netif_ip_addr.h#L96>`
后续步骤
^^^^^^^^^^^^^^
为了令移植应用程序可以使用 :doc:`/api-reference/network/esp_netif`,还需在组件配置中禁用 tcpip_adapter 兼容层。请前往 ``ESP NETIF Adapter`` > ``Enable backward compatible tcpip_adapter interface`` 进行设置,并检查项目是否编译成功。
TCP/IP 适配器涉及大量依赖项,禁用兼容层可能有助于将应用程序与使用特定 TCP/IP 软件栈的 API 分离开来。

View File

@@ -228,3 +228,36 @@
re: "fatal error: (esp_rom_tjpgd.h): No such file or directory"
hint: "{} was removed. Please use esp_jpeg component from IDF component manager instead.\nPlease look out for component in 'https://components.espressif.com' and add using 'idf.py add-dependency' command.\nRefer to the migration guide for more details."
match_to_output: True
-
re: "(fatal error: tcpip_adapter.h: No such file or directory|error: implicit declaration of function 'tcpip_adapter_init')"
hint: "TCP/IP adapter compatibility layer has been removed. Please migrate to ESP-NETIF.\nRefer to the Networking migration guide, section TCP/IP adapter, for more details."
-
re: "error: macro \"(ETH_\\w+_CONFIG)\" requires 2 arguments, but only 1 given"
hint: "Macro {} now accepts both SPI host and SPI device related configuration. The SPI-Ethernet Module initialization has been simplified to allocate an SPI device internally so the configuration structure requires the related configuration.\nPlease refer to the Networking migration guide, section SPI-Ethernet Module Initialization, for more details."
match_to_output: True
-
re: "error: implicit declaration of function '(esp_eth_detect_phy_addr)'"
hint: "Function {}() has been renamed to esp_eth_phy_802_3_detect_phy_addr().\nPlease refer to the Networking migration guide, section PHY Address Auto-detect, for more details."
match_to_output: True
-
re: "error: too few arguments to function '(esp_eth_mac_\\w+)'"
hint: "Function {}() has been refactored to accept device specific configuration and MAC specific configuration.\nPlease refer to the Ethernet section of Networking migration guide for more details."
match_to_output: True
-
re: "error: implicit declaration of function 'esp_eth_phy_new_{}'"
hint: "Function {}() has been removed, please use {}() instead.\nPlease refer to the Networking migration guide, section PHY Address Auto-detect, for more details."
variables:
-
re_variables: ['ksz8081']
hint_variables: ['esp_eth_phy_new_ksz8081', 'esp_eth_phy_new_ksz80xx']
-
re_variables: ['ksz8041']
hint_variables: ['esp_eth_phy_new_ksz8041', 'esp_eth_phy_new_ksz80xx']
-
re_variables: ['lan8720']
hint_variables: ['esp_eth_phy_new_lan8720', 'esp_eth_phy_new_lan87xx']