michaelh/zephyr
1
0
Fork 0
Code Releases Activity

doc: kconfig: Encourage dropping 'Enable ...' from most prompts

Browse source 
Usually, it's clear from context, and it makes things consistent.

Signed-off-by: Ulf Magnusson <Ulf.Magnusson@nordicsemi.no>
This commit is contained in:
Ulf Magnusson 2019-05-23 15:44:53 +02:00 • committed by Anas Nashif
commit e5cca102a5
1 changed files with 9 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

9
doc/guides/kconfig/index.rst
View file

@ -624,6 +624,15 @@ without prompts, and somewhat obscure.
definitions easier to discover and remove.
Prompt strings
==============
For a Kconfig symbol that enables a driver/subsystem FOO, consider having just
"Foo" as the prompt, instead of "Enable Foo support" or the like. It will
usually be clear in the context of an option that can be toggled on/off, and
makes things consistent.
Lesser-known/used Kconfig features
**********************************