mirror of
https://github.com/espressif/esp-idf.git
synced 2024-10-05 20:47:46 -04:00
Merge branch 'docs/fix_broken_example_links_for_releasev4.1' into 'release/v4.1'
docs: fix broken example links for release v4.1 See merge request espressif/esp-idf!12503
This commit is contained in:
commit
da1ed49a65
@ -141,9 +141,9 @@ ESP-NETIF programmer's manual
|
|||||||
|
|
||||||
Please refer to the example section for basic initialization of default interfaces:
|
Please refer to the example section for basic initialization of default interfaces:
|
||||||
|
|
||||||
- WiFi Station: :example:`examples/wifi/getting_started/station/main/station_example_main.c`
|
- WiFi Station: :example:`wifi/getting_started/station/main/station_example_main.c`
|
||||||
- WiFi Access Point: :example:`examples/wifi/getting_started/softAP/main/softap_example_main.c`
|
- WiFi Access Point: :example:`wifi/getting_started/softAP/main/softap_example_main.c`
|
||||||
- Ethernet :example:`examples/ethernet/basic/main/ethernet_example_main.c`
|
- Ethernet: :example:`ethernet/basic/main/ethernet_example_main.c`
|
||||||
|
|
||||||
For more specific cases please consult this guide: :doc:`/api-reference/network/esp_netif_driver`.
|
For more specific cases please consult this guide: :doc:`/api-reference/network/esp_netif_driver`.
|
||||||
|
|
||||||
|
@ -31,9 +31,9 @@ Network interface instance shall be explicitly constructed for the :doc:`/api-re
|
|||||||
For example initialization code for WiFi has to explicitly call ``esp_netif_create_default_wifi_sta();`` or ``esp_netif_create_default_wifi_ap();`` after the TCP/IP stack and the event loop have been initialized.
|
For example initialization code for WiFi has to explicitly call ``esp_netif_create_default_wifi_sta();`` or ``esp_netif_create_default_wifi_ap();`` after the TCP/IP stack and the event loop have been initialized.
|
||||||
Please consult an example initialization code for these three interfaces:
|
Please consult an example initialization code for these three interfaces:
|
||||||
|
|
||||||
- WiFi Station: :example:`examples/wifi/getting_started/station/main/station_example_main.c`
|
- WiFi Station: :example:`wifi/getting_started/station/main/station_example_main.c`
|
||||||
- WiFi Access Point: :example:`examples/wifi/getting_started/softAP/main/softap_example_main.c`
|
- WiFi Access Point: :example:`wifi/getting_started/softAP/main/softap_example_main.c`
|
||||||
- Ethernet :example:`examples/ethernet/basic/main/ethernet_example_main.c`
|
- Ethernet: :example:`ethernet/basic/main/ethernet_example_main.c`
|
||||||
|
|
||||||
|
|
||||||
Replacing other tcpip_adapter API
|
Replacing other tcpip_adapter API
|
||||||
|
@ -21,11 +21,11 @@ Internal asio settings for ESP include
|
|||||||
|
|
||||||
Application Example
|
Application Example
|
||||||
-------------------
|
-------------------
|
||||||
ESP examples are based on standard asio :example:`examples/protocols/asio`:
|
ESP examples are based on standard asio :example:`protocols/asio`:
|
||||||
|
|
||||||
- :example:`examples/protocols/asio/udp_echo_server`
|
- :example:`protocols/asio/udp_echo_server`
|
||||||
- :example:`examples/protocols/asio/tcp_echo_server`
|
- :example:`protocols/asio/tcp_echo_server`
|
||||||
- :example:`examples/protocols/asio/chat_client`
|
- :example:`protocols/asio/chat_client`
|
||||||
- :example:`examples/protocols/asio/chat_server`
|
- :example:`protocols/asio/chat_server`
|
||||||
|
|
||||||
Please refer to the specific example README.md for details
|
Please refer to the specific example README.md for details
|
||||||
|
@ -91,7 +91,7 @@ in CMake::
|
|||||||
|
|
||||||
spiffs_create_partition_image(my_spiffs_partition my_folder DEPENDS dep)
|
spiffs_create_partition_image(my_spiffs_partition my_folder DEPENDS dep)
|
||||||
|
|
||||||
+For an example, see :example:`examples/storage/spiffsgen>`.
|
For an example, see :example:`storage/spiffsgen`.
|
||||||
|
|
||||||
|
|
||||||
mkspiffs
|
mkspiffs
|
||||||
|
@ -32,9 +32,9 @@ TCP/IP 适配器静态定义了三个接口:
|
|||||||
。
|
。
|
||||||
请参阅这三个接口的初始化代码示例:
|
请参阅这三个接口的初始化代码示例:
|
||||||
|
|
||||||
- Wi-Fi Station::example:`examples/wifi/getting_started/station/main/station_example_main.c`
|
- Wi-Fi Station::example:`wifi/getting_started/station/main/station_example_main.c`
|
||||||
- Wi-Fi AP::example:`examples/wifi/getting_started/softAP/main/softap_example_main.c`
|
- Wi-Fi AP::example:`wifi/getting_started/softAP/main/softap_example_main.c`
|
||||||
- 以太网 :example:`examples/ethernet/basic/main/ethernet_example_main.c`
|
- 以太网::example:`ethernet/basic/main/ethernet_example_main.c`
|
||||||
|
|
||||||
|
|
||||||
更换其他 tcpip_adapter API
|
更换其他 tcpip_adapter API
|
||||||
|
@ -87,7 +87,7 @@ Make 构建系统和 CMake 构建系统结构有所不同,请注意以下几
|
|||||||
|
|
||||||
spiffs_create_partition_image(my_spiffs_partition my_folder DEPENDS dep)
|
spiffs_create_partition_image(my_spiffs_partition my_folder DEPENDS dep)
|
||||||
|
|
||||||
请参考 :example:`examples/storage/spiffsgen>`,查看示例。
|
请参考 :example:`storage/spiffsgen`,查看示例。
|
||||||
|
|
||||||
mkspiffs
|
mkspiffs
|
||||||
^^^^^^^^^^^
|
^^^^^^^^^^^
|
||||||
|
Loading…
Reference in New Issue
Block a user