Skip to content

Commit 00f4f1c

Browse files
AlexBethelRomkaE
authored andcommitted
docs: Fix gpio_dump_io_configuration typo in docs
The mentioned `gpio_dump_all_io_configuration` function doesn't exist, the correct function is `gpio_dump_io_configuration`. Merges espressif#15031
1 parent d8fa2eb commit 00f4f1c

File tree

2 files changed

+2
-2
lines changed

2 files changed

+2
-2
lines changed

docs/en/api-reference/peripherals/gpio.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ In addition, if you would like to dump the configurations of all IOs, you can us
8181

8282
::
8383

84-
gpio_dump_all_io_configuration(stdout, SOC_GPIO_VALID_GPIO_MASK);
84+
gpio_dump_io_configuration(stdout, SOC_GPIO_VALID_GPIO_MASK);
8585

8686
If an IO pin is routed to a peripheral signal through the GPIO matrix, the signal ID printed in the dump information is defined in the :component_file:`soc/{IDF_TARGET_PATH_NAME}/include/soc/gpio_sig_map.h` header file. The word ``**RESERVED**`` indicates the IO is occupied by either SPI flash or PSRAM. It is strongly not recommended to reconfigure them for other application purposes.
8787

docs/zh_CN/api-reference/peripherals/gpio.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ GPIO 驱动提供了一个函数 :cpp:func:`gpio_dump_io_configuration` 用来
8181

8282
::
8383

84-
gpio_dump_all_io_configuration(stdout, SOC_GPIO_VALID_GPIO_MASK);
84+
gpio_dump_io_configuration(stdout, SOC_GPIO_VALID_GPIO_MASK);
8585

8686
如果 IO 管脚通过 GPIO 交换矩阵连接到内部外设信号,输出信息打印中的外设信号 ID 定义可以在 :component_file:`soc/{IDF_TARGET_PATH_NAME}/include/soc/gpio_sig_map.h` 头文件中查看。``**RESERVED**`` 字样则表示此 IO 用于连接 SPI flash 或 PSRAM,强烈建议不要重新配置这些管脚用于其他功能。
8787

0 commit comments

Comments
 (0)