summaryrefslogtreecommitdiff
path: root/doc/usage
diff options
context:
space:
mode:
authorSimon Glass <[email protected]>2023-07-30 21:01:46 -0600
committerBin Meng <[email protected]>2023-08-09 23:31:12 +0800
commit63af90e7f0cab3b5197c19744f5e807ebc325c81 (patch)
tree2d264d8c4e98d5cb0e93fd4731aedcc67df877ae /doc/usage
parent5e541a05f70296dbad07fc1f4e8678ad207bb476 (diff)
env: Explain how to use #include files in text environment
Provide documentation on how to share common settings among boards. Signed-off-by: Simon Glass <[email protected]> Reviewed-by: Andy Shevchenko <[email protected]> # Intel Edison Reviewed-by: Bin Meng <[email protected]>
Diffstat (limited to 'doc/usage')
-rw-r--r--doc/usage/environment.rst6
1 files changed, 6 insertions, 0 deletions
diff --git a/doc/usage/environment.rst b/doc/usage/environment.rst
index 91dc07b17bc..c6439dde668 100644
--- a/doc/usage/environment.rst
+++ b/doc/usage/environment.rst
@@ -81,6 +81,12 @@ Example::
echo CONFIG_SYS_BOARD boot failed - please check your image
echo Load address is CONFIG_SYS_LOAD_ADDR
+Settings which are common to a group of boards can use #include to bring in
+a common file in the `include/env` directory, containing environment
+settings. For example::
+
+ #include <env/ti/mmc.env>
+
If CONFIG_ENV_SOURCE_FILE is empty and the default filename is not present, then
the old-style C environment is used instead. See below.