From fb43948413a3752613ff17bbd9c3bce1d5452109 Mon Sep 17 00:00:00 2001 From: Ivan Grokhotkov Date: Mon, 21 Aug 2017 00:01:03 +0800 Subject: [PATCH] Update several Kconfig files to make help texts compatible with ReST --- components/esp32/Kconfig | 29 ++++++++++---------- components/freertos/Kconfig | 2 +- components/partition_table/Kconfig.projbuild | 2 +- components/spi_flash/Kconfig | 8 ++++-- 4 files changed, 21 insertions(+), 20 deletions(-) diff --git a/components/esp32/Kconfig b/components/esp32/Kconfig index 3a7ce72f1b..b50649ce49 100644 --- a/components/esp32/Kconfig +++ b/components/esp32/Kconfig @@ -253,6 +253,7 @@ choice CONSOLE_UART default CONSOLE_UART_DEFAULT help Select whether to use UART for console output (through stdout and stderr). + - Default is to use UART0 on pins GPIO1(TX) and GPIO3(RX). - If "Custom" is selected, UART0 or UART1 can be chosen, and any pins can be selected. @@ -315,22 +316,17 @@ config ULP_COPROC_ENABLED If this option is enabled, further coprocessor configuration will appear in the Components menu. config ULP_COPROC_RESERVE_MEM - int "RTC slow memory reserved for coprocessor" - default 512 - range 32 8192 - depends on ULP_COPROC_ENABLED + int + prompt "RTC slow memory reserved for coprocessor" if ULP_COPROC_ENABLED + default 512 if ULP_COPROC_ENABLED + range 32 8192 if ULP_COPROC_ENABLED + default 0 if !ULP_COPROC_ENABLED + range 0 0 if !ULP_COPROC_ENABLED help Bytes of memory to reserve for ULP coprocessor firmware & data. Data is reserved at the beginning of RTC slow memory. -# Set CONFIG_ULP_COPROC_RESERVE_MEM to 0 if ULP is disabled -config ULP_COPROC_RESERVE_MEM - int - default 0 - depends on !ULP_COPROC_ENABLED - - choice ESP32_PANIC prompt "Panic handler behaviour" default ESP32_PANIC_PRINT_REBOOT @@ -542,6 +538,7 @@ config ESP32_RTC_CLK_CAL_CYCLES When this option is set to 0, clock calibration will not be performed at startup, and approximate clock frequencies will be assumed: + - 150000 Hz if internal RC oscillator is used as clock source - 32768 Hz if the 32k crystal oscillator is used @@ -568,8 +565,10 @@ choice ESP32_XTAL_FREQ_SEL default ESP32_XTAL_FREQ_AUTO help ESP32 currently supports the following XTAL frequencies: - - 26 MHz - - 40 MHz + + - 26 MHz + - 40 MHz + Startup code can automatically estimate XTAL frequency. This feature uses the internal 8MHz oscillator as a reference. Because the internal oscillator frequency is temperature dependent, it is not recommended @@ -591,8 +590,6 @@ config ESP32_XTAL_FREQ default 40 if ESP32_XTAL_FREQ_40 default 26 if ESP32_XTAL_FREQ_26 -endmenu - config NO_BLOBS bool "No Binary Blobs" depends on !BT_ENABLED @@ -601,6 +598,8 @@ config NO_BLOBS If enabled, this disables the linking of binary libraries in the application build. Note that after enabling this Wi-Fi/Bluetooth will not work. +endmenu + menu Wi-Fi config SW_COEXIST_ENABLE diff --git a/components/freertos/Kconfig b/components/freertos/Kconfig index d2f6ca8f79..8342e2c515 100644 --- a/components/freertos/Kconfig +++ b/components/freertos/Kconfig @@ -240,7 +240,7 @@ config ENABLE_STATIC_TASK_CLEAN_UP_HOOK help Enable this option to make FreeRTOS call the static task clean up hook when a task is deleted. - Bear in mind that if this option is enabled you will need to implement the following function: + Bear in mind that if this option is enabled you will need to implement the following function:: void vPortCleanUpTCB ( void *pxTCB ) { // place clean up code here diff --git a/components/partition_table/Kconfig.projbuild b/components/partition_table/Kconfig.projbuild index 5a12512d56..a6176e0fd1 100644 --- a/components/partition_table/Kconfig.projbuild +++ b/components/partition_table/Kconfig.projbuild @@ -1,6 +1,6 @@ menu "Partition Table" -choice +choice PARTITION_TABLE_TYPE prompt "Partition Table" default PARTITION_TABLE_SINGLE_APP help diff --git a/components/spi_flash/Kconfig b/components/spi_flash/Kconfig index 1aa2d0a492..8b9c714820 100644 --- a/components/spi_flash/Kconfig +++ b/components/spi_flash/Kconfig @@ -5,9 +5,11 @@ config SPI_FLASH_ENABLE_COUNTERS default 0 help This option enables the following APIs: - spi_flash_reset_counters - spi_flash_dump_counters - spi_flash_get_counters + + - spi_flash_reset_counters + - spi_flash_dump_counters + - spi_flash_get_counters + These APIs may be used to collect performance data for spi_flash APIs and to help understand behaviour of libraries which use SPI flash.