[PATCH 1/2] env: Move the doc comment to the code

This doesn't really make much sense in the documentation. Add a code comment instead.
Suggested-by: Heinrich Schuchardt xypron.glpk@gmx.de
Signed-off-by: Simon Glass sjg@chromium.org ---
common/autoboot.c | 5 +++++ doc/usage/environment.rst | 1 - 2 files changed, 5 insertions(+), 1 deletion(-)
diff --git a/common/autoboot.c b/common/autoboot.c index b8861d56218..63f2587941d 100644 --- a/common/autoboot.c +++ b/common/autoboot.c @@ -446,6 +446,11 @@ const char *bootdelay_process(void) s = env_get("bootdelay"); bootdelay = s ? (int)simple_strtol(s, NULL, 10) : CONFIG_BOOTDELAY;
+ /* + * Does it really make sense that the devicetree overrides the user + * setting? It is possibly helpful for security since the device tree + * may be signed whereas the environment is often loaded from storage. + */ if (IS_ENABLED(CONFIG_OF_CONTROL)) bootdelay = ofnode_conf_read_int("bootdelay", bootdelay);
diff --git a/doc/usage/environment.rst b/doc/usage/environment.rst index d295cc89878..4b228c1de3c 100644 --- a/doc/usage/environment.rst +++ b/doc/usage/environment.rst @@ -120,7 +120,6 @@ bootdelay The default value is defined by CONFIG_BOOTDELAY. The value of 'bootdelay' is overridden by the /config/bootdelay value in the device-tree if CONFIG_OF_CONTROL=y. - Does it really make sense that the devicetree overrides the user setting?
bootcmd The command that is run if the user does not enter the shell during the

Drop this text at the end since it already mentions bootp and dhcp.
Signed-off-by: Simon Glass sjg@chromium.org Suggested-by: Heinrich Schuchardt xypron.glpk@gmx.de ---
doc/usage/environment.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/doc/usage/environment.rst b/doc/usage/environment.rst index 4b228c1de3c..80550fc4478 100644 --- a/doc/usage/environment.rst +++ b/doc/usage/environment.rst @@ -170,7 +170,7 @@ autoload if set to "no" (any string beginning with 'n'), "bootp" and "dhcp" will just load perform a lookup of the configuration from the BOOTP server, but not try to - load any image using TFTP or DHCP. + load any image.
autostart if set to "yes", an image loaded using the "bootp", "dhcp",

On Fri, Mar 11, 2022 at 04:22:39PM -0700, Simon Glass wrote:
Drop this text at the end since it already mentions bootp and dhcp.
Signed-off-by: Simon Glass sjg@chromium.org Suggested-by: Heinrich Schuchardt xypron.glpk@gmx.de
Applied to u-boot/master, thanks!

On Fri, Mar 11, 2022 at 04:22:38PM -0700, Simon Glass wrote:
This doesn't really make much sense in the documentation. Add a code comment instead.
Suggested-by: Heinrich Schuchardt xypron.glpk@gmx.de
Signed-off-by: Simon Glass sjg@chromium.org
Applied to u-boot/master, thanks!
participants (2)
-
Simon Glass
-
Tom Rini