]> git.dujemihanovic.xyz Git - u-boot.git/commitdiff
README: Correct docs for CONFIG_SPL_BUILD
authorSimon Glass <sjg@chromium.org>
Sat, 18 Nov 2023 21:04:50 +0000 (14:04 -0700)
committerTom Rini <trini@konsulko.com>
Wed, 13 Dec 2023 16:51:24 +0000 (11:51 -0500)
This option is defined in both SPL and TPL builds, so correct the docs
related to this. Also point to spl_phase() which is normally a better
option. Mention VPL as well.

Signed-off-by: Simon Glass <sjg@chromium.org>
Reported-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
README

diff --git a/README b/README
index 60c6b8a19db1be743748e44ab1125bf0ae5f6da8..f26c34a5e200b16f486b6e03e4909ccf7ab976a1 100644 (file)
--- a/README
+++ b/README
@@ -1545,16 +1545,26 @@ Low Level (hardware related) configuration options:
                globally (CONFIG_CMD_MEMORY).
 
 - CONFIG_SPL_BUILD
-               Set when the currently-running compilation is for an artifact
-               that will end up in the SPL (as opposed to the TPL or U-Boot
-               proper). Code that needs stage-specific behavior should check
-               this.
+               Set when the currently running compilation is for an artifact
+               that will end up in one of the 'xPL' builds, i.e. SPL, TPL or
+               VPL. Code that needs phase-specific behaviour can check this,
+               or (where possible) use spl_phase() instead.
+
+               Note that CONFIG_SPL_BUILD *is* always defined when either
+               of CONFIG_TPL_BUILD / CONFIG_VPL_BUILD is defined. This can be
+               counter-intuitive and should perhaps be changed.
 
 - CONFIG_TPL_BUILD
-               Set when the currently-running compilation is for an artifact
-               that will end up in the TPL (as opposed to the SPL or U-Boot
-               proper). Code that needs stage-specific behavior should check
-               this.
+               Set when the currently running compilation is for an artifact
+               that will end up in the TPL build (as opposed to SPL, VPL or
+               U-Boot proper). Code that needs phase-specific behaviour can
+               check this, or (where possible) use spl_phase() instead.
+
+- CONFIG_VPL_BUILD
+               Set when the currently running compilation is for an artifact
+               that will end up in the VPL build (as opposed to the SPL, TPL
+               or U-Boot proper). Code that needs phase-specific behaviour can
+               check this, or (where possible) use spl_phase() instead.
 
 - CONFIG_ARCH_MAP_SYSMEM
                Generally U-Boot (and in particular the md command) uses