Update several Kconfig files to make help texts compatible with ReST

This commit is contained in:
Ivan Grokhotkov
2017-08-21 00:01:03 +08:00
parent 9b18625d29
commit fb43948413
4 changed files with 21 additions and 20 deletions

View File

@@ -253,6 +253,7 @@ choice CONSOLE_UART
default CONSOLE_UART_DEFAULT default CONSOLE_UART_DEFAULT
help help
Select whether to use UART for console output (through stdout and stderr). Select whether to use UART for console output (through stdout and stderr).
- Default is to use UART0 on pins GPIO1(TX) and GPIO3(RX). - Default is to use UART0 on pins GPIO1(TX) and GPIO3(RX).
- If "Custom" is selected, UART0 or UART1 can be chosen, - If "Custom" is selected, UART0 or UART1 can be chosen,
and any pins can be selected. 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. If this option is enabled, further coprocessor configuration will appear in the Components menu.
config ULP_COPROC_RESERVE_MEM config ULP_COPROC_RESERVE_MEM
int "RTC slow memory reserved for coprocessor" int
default 512 prompt "RTC slow memory reserved for coprocessor" if ULP_COPROC_ENABLED
range 32 8192 default 512 if ULP_COPROC_ENABLED
depends on ULP_COPROC_ENABLED range 32 8192 if ULP_COPROC_ENABLED
default 0 if !ULP_COPROC_ENABLED
range 0 0 if !ULP_COPROC_ENABLED
help help
Bytes of memory to reserve for ULP coprocessor firmware & data. Bytes of memory to reserve for ULP coprocessor firmware & data.
Data is reserved at the beginning of RTC slow memory. 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 choice ESP32_PANIC
prompt "Panic handler behaviour" prompt "Panic handler behaviour"
default ESP32_PANIC_PRINT_REBOOT 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 When this option is set to 0, clock calibration will not be performed at
startup, and approximate clock frequencies will be assumed: startup, and approximate clock frequencies will be assumed:
- 150000 Hz if internal RC oscillator is used as clock source - 150000 Hz if internal RC oscillator is used as clock source
- 32768 Hz if the 32k crystal oscillator is used - 32768 Hz if the 32k crystal oscillator is used
@@ -568,8 +565,10 @@ choice ESP32_XTAL_FREQ_SEL
default ESP32_XTAL_FREQ_AUTO default ESP32_XTAL_FREQ_AUTO
help help
ESP32 currently supports the following XTAL frequencies: ESP32 currently supports the following XTAL frequencies:
- 26 MHz
- 40 MHz - 26 MHz
- 40 MHz
Startup code can automatically estimate XTAL frequency. This feature Startup code can automatically estimate XTAL frequency. This feature
uses the internal 8MHz oscillator as a reference. Because the internal uses the internal 8MHz oscillator as a reference. Because the internal
oscillator frequency is temperature dependent, it is not recommended 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 40 if ESP32_XTAL_FREQ_40
default 26 if ESP32_XTAL_FREQ_26 default 26 if ESP32_XTAL_FREQ_26
endmenu
config NO_BLOBS config NO_BLOBS
bool "No Binary Blobs" bool "No Binary Blobs"
depends on !BT_ENABLED 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 If enabled, this disables the linking of binary libraries in the application build. Note
that after enabling this Wi-Fi/Bluetooth will not work. that after enabling this Wi-Fi/Bluetooth will not work.
endmenu
menu Wi-Fi menu Wi-Fi
config SW_COEXIST_ENABLE config SW_COEXIST_ENABLE

View File

@@ -240,7 +240,7 @@ config ENABLE_STATIC_TASK_CLEAN_UP_HOOK
help help
Enable this option to make FreeRTOS call the static task clean up hook when a task is deleted. 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 ) { void vPortCleanUpTCB ( void *pxTCB ) {
// place clean up code here // place clean up code here

View File

@@ -1,6 +1,6 @@
menu "Partition Table" menu "Partition Table"
choice choice PARTITION_TABLE_TYPE
prompt "Partition Table" prompt "Partition Table"
default PARTITION_TABLE_SINGLE_APP default PARTITION_TABLE_SINGLE_APP
help help

View File

@@ -5,9 +5,11 @@ config SPI_FLASH_ENABLE_COUNTERS
default 0 default 0
help help
This option enables the following APIs: This option enables the following APIs:
spi_flash_reset_counters
spi_flash_dump_counters - spi_flash_reset_counters
spi_flash_get_counters - spi_flash_dump_counters
- spi_flash_get_counters
These APIs may be used to collect performance data for spi_flash APIs These APIs may be used to collect performance data for spi_flash APIs
and to help understand behaviour of libraries which use SPI flash. and to help understand behaviour of libraries which use SPI flash.