zephyr/doc/application/application-kconfig.include

# SPDX-License-Identifier: Apache-2.0

mainmenu "Your Application Name"

# Your application configuration options go here

# Sources Kconfig.zephyr in the Zephyr root directory.
#
# Note: All 'source' statements work relative to the Zephyr root directory (due
# to the $srctree environment variable being set to $ZEPHYR_BASE). If you want
# to 'source' relative to the current Kconfig file instead, use 'rsource' (or a
# path relative to the Zephyr root).
source "Kconfig.zephyr"
license: cleanup: add SPDX Apache-2.0 license identifier Update the files which contain no license information with the 'Apache-2.0' SPDX license identifier. Many source files in the tree are missing licensing information, which makes it harder for compliance tools to determine the correct license. By default all files without license information are under the default license of Zephyr, which is Apache version 2. Signed-off-by: Anas Nashif <anas.nashif@intel.com> 2019-04-06 21:08:09 +08:00			`# SPDX-License-Identifier: Apache-2.0`

doc: application: re-work CMakeLists.txt / configuration division Fix a few issues related to the description of an application's CMakeLists.txt file, and how that relates to its configuraiton. Make sure the section "Application CMakeLists.txt" appears under the parent "CMake" section, instead of on its own. The order in which lines appear in the application CMakeLists.txt is important, and that's not coming through clearly, so try to improve that. Document how the values for BOARD and CONF_FILE are determined by boilerplate.cmake here. Also document usage of KCONFIG_ROOT, as its Kbuild-based equivalent is something that users ask about. Merge some content from the following section "Application Configuration" into the appropriate places, to keep the document flow working. Add references in "Application Configuration" to definitions provided previously in the document, for clarity. Signed-off-by: Marti Bolivar <marti@opensourcefoundries.com> 2017-11-03 02:14:10 +08:00			`mainmenu "Your Application Name"`

Kconfig: Document the new prefer-earlier-defaults behavior Update the documentation to say that earlier defaults are preferred, while explaining Kconfig.defconfig files. Keep the section that covered the Zephyr prefer-later-defaults patch as documentation for the behavior having changed. It will be linked in a warning later. Also add documentation explaining how to configure choices, including using multiple definition locations to change a choice 'default'. Document that 'range's can be added/overriden as well. This works reliably now. Signed-off-by: Ulf Magnusson <Ulf.Magnusson@nordicsemi.no> 2018-08-01 01:20:44 +08:00			`# Your application configuration options go here`
doc: application: re-work CMakeLists.txt / configuration division Fix a few issues related to the description of an application's CMakeLists.txt file, and how that relates to its configuraiton. Make sure the section "Application CMakeLists.txt" appears under the parent "CMake" section, instead of on its own. The order in which lines appear in the application CMakeLists.txt is important, and that's not coming through clearly, so try to improve that. Document how the values for BOARD and CONF_FILE are determined by boilerplate.cmake here. Also document usage of KCONFIG_ROOT, as its Kbuild-based equivalent is something that users ask about. Merge some content from the following section "Application Configuration" into the appropriate places, to keep the document flow working. Add references in "Application Configuration" to definitions provided previously in the document, for clarity. Signed-off-by: Marti Bolivar <marti@opensourcefoundries.com> 2017-11-03 02:14:10 +08:00
Kconfig: Remove redundant $(ZEPHYR_BASE) from 'source's The $srctree environment variable gives the path relative to which '(o)source' statements work (the current directory is used if $srctree is unset). It is set to $ZEPHYR_BASE in cmake/kconfig.cmake, so there's no need to qualify the source of Kconfig.zephyr in sample Kconfig files (or in external projects). All 'source's in Zephyr assume that the Zephyr root directory is used as the srctree as well, and would break otherwise. Remove the $(ZEPHYR_BASE)s to make it clearer that all 'source' statements work relative to the Zephyr root. There was some user confusion on IRC. Also explain how things work in the documentation. Signed-off-by: Ulf Magnusson <Ulf.Magnusson@nordicsemi.no> 2018-10-10 22:52:59 +08:00			`# Sources Kconfig.zephyr in the Zephyr root directory.`
			`#`
			`# Note: All 'source' statements work relative to the Zephyr root directory (due`
			`# to the $srctree environment variable being set to $ZEPHYR_BASE). If you want`
			`# to 'source' relative to the current Kconfig file instead, use 'rsource' (or a`
			`# path relative to the Zephyr root).`
			`source "Kconfig.zephyr"`