mirror of
https://github.com/zephyrproject-rtos/zephyr
synced 2025-08-14 03:25:55 +00:00
ef11776460
Add a new 'Kconfig tips and best practices' page that covers some Kconfig best practices, tips, and arcana, like the following: - What should be turned into a Kconfig symbol? - Best practices and pitfalls for 'select' - Factoring out common dependencies - Kconfig shorthands - Redundant defaults - Explanations of various more obscure Kconfig features, like 'imply', optional prompts, optional choices, and 'visible if' Link the new page in the sidebar (under Developer Guides), the application development primer, and the architecture and board porting guides. Perhaps other, more Zephyr-specific information could be added later on as well, but this is a good start. Include some other Kconfig-related documentation improvements as well: - In the application development primer, give 'CONFIG_FOO=n' as the way to set a bool symbol to 'n', instead of '# CONFIG_FOO is not set'. That seems to be what people usually do in practice in Zephyr. Explain why '# CONFIG_FOO is not set' works as well. There's a technical reason for it, related to Make. - Mention that the recommended syntax for referencing environment variables is now $(FOO) (which uses the Kconfig preprocessor) - Mention that the kconfiglib.py docstring has more in-depth information about how symbol values are calculated. Signed-off-by: Ulf Magnusson <Ulf.Magnusson@nordicsemi.no> |
||
|---|---|---|
| .. | ||
| board | ||
| arch.rst | ||
| board_porting.rst | ||
| cmsis_rtos_v1.rst | ||
| ip-stack-migrate.rst | ||
| porting_to_zephyr.rst | ||
| porting.rst | ||
| shields.rst | ||