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

* [PATCH 1/2] env: Move the doc comment to the code
@ 2022-03-11 23:22 Simon Glass
  2022-03-11 23:22 ` [PATCH 2/2] env: Drop the unncessary protocol mention in autoload Simon Glass
  2022-04-08 12:30 ` [PATCH 1/2] env: Move the doc comment to the code Tom Rini
  0 siblings, 2 replies; 4+ messages in thread
From: Simon Glass @ 2022-03-11 23:22 UTC (permalink / raw)
  To: U-Boot Mailing List
  Cc: Simon Glass, Heinrich Schuchardt, Da Xue, Heiko Schocher,
	Joe Hershberger, Steffen Jaeckel, Wolfgang Denk

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
-- 
2.35.1.723.g4982287a31-goog


^ permalink raw reply related	[flat|nested] 4+ messages in thread