michaelh/zephyr
1
0
Fork 0
Code Releases Activity

doc: kconfig: Explain the '<type> <prompt>' shorthand

Browse source 
The board porting guide assumed that people were already familiar with
the Kconfig 'bool "foo"' shorthand for giving a symbol's type and prompt
at the same time. I got an email pointing out that it isn't obvious.

Explain the shorthand, and also mention that it's the preferred style in
Zephyr.

Signed-off-by: Ulf Magnusson <Ulf.Magnusson@nordicsemi.no>
This commit is contained in:
Ulf Magnusson 2018-09-28 16:46:31 +02:00 • committed by Carles Cufí
commit 8dce59b681
1 changed files with 5 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

8
doc/porting/board_porting.rst
View file

@ -178,12 +178,14 @@ Here are some examples of visible and invisible symbols:
default FOO
config VISIBLE_1
bool "Enable stuff"
config VISIBLE_2
string
prompt "Foo value"
config VISIBLE_2
# Shorthand for giving a type and a prompt at the same time. This is
# the preferred style in Zephyr.
bool "Enable stuff"
Configuring visible Kconfig symbols
-----------------------------------