From: Simon Glass <sjg@chromium.org>
Date: Fri, 22 Oct 2021 03:08:48 +0000 (-0600)
Subject: doc: Mention CONFIG_DEFAULT_ENV_FILE
X-Git-Tag: v2025.01-rc5-pxa1908~1591^2~24^2~4
X-Git-Url: http://git.dujemihanovic.xyz/%22http:/www.sics.se/static/login.html?a=commitdiff_plain;h=1df02d1d0152b5029e96517f7a7dc1c389610b66;p=u-boot.git

doc: Mention CONFIG_DEFAULT_ENV_FILE

Add mention of this option since it does a similar thing to the text
environment.

Signed-off-by: Simon Glass <sjg@chromium.org>
Suggested-by: Rasmus Villemoes <rasmus.villemoes@prevas.dk>
Reviewed-by: Marek BehĂșn <marek.behun@nic.cz>
---

diff --git a/doc/usage/environment.rst b/doc/usage/environment.rst
index 043c02d9a9..6f3066e2b6 100644
--- a/doc/usage/environment.rst
+++ b/doc/usage/environment.rst
@@ -458,3 +458,18 @@ The signature of the callback functions is::
   include/search.h
 
 The return value is 0 if the variable change is accepted and 1 otherwise.
+
+
+External environment file
+-------------------------
+
+The `CONFIG_USE_DEFAULT_ENV_FILE` option provides a way to bypass the
+environment generation in U-Boot. If enabled, then `CONFIG_DEFAULT_ENV_FILE`
+provides the name of a file which is converted into the environment,
+completely bypassing the standard environment variables in `env_default.h`.
+
+The format is the same as accepted by the mkenvimage tool, with lines containing
+key=value pairs. Blank lines and lines beginning with # are ignored.
+
+Future work may unify this feature with the text-based environment, perhaps
+moving the contents of `env_default.h` to a text file.