kconfig: Get rid of 'option env' bounce symbols (4dc9e5b2) · Commits · Wenxi XU / zephyr

This commit gets rid of the 'option env="ENV_VAR"' bounce symbols. "$FOO" now expands directly to the value of the environment variable FOO, instead of to the value of the Kconfig symbol FOO. This change is likely to soon appear in the C tools as well. Those 'option env' symbols always seemed kinda pointless, and have broken dependency handling due to forcing symbol evaluation during parsing, before all the symbols have even been seen. Compatibility with the C tools could be retained by naming all 'option env' symbols the same as the environment variable they reference. This commit also updated the Zephyr documentation to explain the new behavior. It's relevant for $ZEPHYR_BASE and out-of-tree Kconfig extensions. Commit message from Kconfiglib (cbf32e29a130d) ============================================== Make "$FOO" directly reference the environment variable $FOO in e.g. 'source' statements, instead of the symbol FOO. Use os.path.expandvars() to expand strings (which preserves "$FOO" as-is if no environment variable FOO exists). This gets rid of the 'option env' "bounce" symbols, which are mostly just spam and are buggy in the C tools (dependencies aren't always respected, due to parsing and evaluation getting mixed up). The same change will probably appear soon in the C tools as well. Keep accepting 'option env' to preserve some backwards compatibility, but ignore it when expanding strings. For compatibility with the C tools, bounce symbols will need to be named the same as the environment variables they reference (which is the case for the Linux kernel). This is a compatibility break, so the major version will be bumped to 6 at the next release. The main motivation for adding this now is to allow recording properties on each MenuNode in a clean way. 'option env' symbols interact badly with delayed dependency propagation. Side note: I have a feeling that recording environment variable values might be redundant to trigger rebuilds if sync_deps() is run at each compile. It should detect all changes to symbol values due to environment variables changing value. Signed-off-by:

Ulf Magnusson <Ulf.Magnusson@nordicsemi.no>

Kconfig.zephyr

+3 −14

Original line number	Diff line number	Diff line
		@@ -6,17 +6,6 @@
		#
		# SPDX-License-Identifier: Apache-2.0
		#
		config KERNELVERSION
		string
		option env="KERNELVERSION"

		config ENV_VAR_SYM_BOARD_DIR
		string
		option env="ENV_VAR_BOARD_DIR"

		config ENV_VAR_SYM_ARCH
		string
		option env="ENV_VAR_ARCH"

		source "arch/Kconfig"

		@@ -44,7 +33,7 @@ source "tests/Kconfig"
		# because board usually overrides SoC values.
		#

		# $ENV_VAR_SYM_ARCH and $ENV_VAR_SYM_BOARD_DIR might be glob patterns
		# $ENV_VAR_ARCH and $ENV_VAR_BOARD_DIR might be glob patterns

		gsource "arch/$ENV_VAR_SYM_ARCH/soc/*/Kconfig.defconfig"
		gsource "$ENV_VAR_SYM_BOARD_DIR/Kconfig.defconfig"
		gsource "arch/$ENV_VAR_ARCH/soc/*/Kconfig.defconfig"
		gsource "$ENV_VAR_BOARD_DIR/Kconfig.defconfig"

arch/Kconfig

+2 −2

Original line number	Diff line number	Diff line
		@@ -332,7 +332,7 @@ config BOARD
		arch/<arch>/soc/<family>/<series>


		# $ENV_VAR_SYM_ARCH might be a glob pattern
		gsource "arch/$ENV_VAR_SYM_ARCH/Kconfig"
		# $ENV_VAR_ARCH might be a glob pattern
		gsource "arch/$ENV_VAR_ARCH/Kconfig"

		source "boards/Kconfig"

boards/Kconfig

+3 −3

Original line number	Diff line number	Diff line
		@@ -14,14 +14,14 @@ config QEMU_TARGET
		Mark all QEMU targets with this variable for checking whether we are
		running in an emulated environment.

		# $ENV_VAR_SYM_BOARD_DIR might be a glob pattern
		# $ENV_VAR_BOARD_DIR might be a glob pattern

		choice
		prompt "Board Selection"
		gsource "$ENV_VAR_SYM_BOARD_DIR/Kconfig.board"
		gsource "$ENV_VAR_BOARD_DIR/Kconfig.board"
		endchoice


		menu "Board Options"
		gsource "$ENV_VAR_SYM_BOARD_DIR/Kconfig"
		gsource "$ENV_VAR_BOARD_DIR/Kconfig"
		endmenu

doc/application/application-kconfig.include

+0 −4

Original line number	Diff line number	Diff line
		mainmenu "Your Application Name"

		config ZEPHYR_BASE
		string
		option env="ZEPHYR_BASE"

		source "$ZEPHYR_BASE/Kconfig.zephyr"

		# Your application configuration options go here.

doc/application/application.rst

+8 −2

Original line number	Diff line number	Diff line
		@@ -795,9 +795,15 @@ Make sure to follow these steps in order.

		.. literalinclude:: application-kconfig.include

		.. important::
		.. note::

		Environment variables in ``source`` statements are expanded directly,
		so you do not need to define a ``option env="ZEPHYR_BASE"`` Kconfig
		"bounce" symbol. If you use such a symbol, it must have the same name as
		the environment variable.

		The indented lines above must use tabs, not spaces.
		See the :ref:`kconfig_extensions_and_changes` section in the
		:ref:`board_porting_guide` for more information.

		#. Now include the mandatory boilerplate that integrates the
		application with the Zephyr build system on a new line, **after any

Admin message