u-boot/doc/usage/index.rst
Simon Glass 86b9c3e4e4 env: Allow U-Boot scripts to be placed in a .env file
At present U-Boot environment variables, and thus scripts, are defined
by CONFIG_EXTRA_ENV_SETTINGS. It is painful to add large amounts of text
to this file and dealing with quoting and newlines is harder than it
should be. It would be better if we could just type the script into a
text file and have it included by U-Boot.

Add a feature that brings in a .env file associated with the board
config, if present. To use it, create a file in a board/<vendor>
directory, typically called <board>.env and controlled by the
CONFIG_ENV_SOURCE_FILE option.

The environment variables should be of the form "var=value". Values can
extend to multiple lines. See the README under 'Environment Variables:'
for more information and an example.

In many cases environment variables need access to the U-Boot CONFIG
variables to select different options. Enable this so that the environment
scripts can be as useful as the ones currently in the board config files.
This uses the C preprocessor, means that comments can be included in the
environment using /* ... */

Also support += to allow variables to be appended to. This is needed when
using the preprocessor.

Signed-off-by: Simon Glass <sjg@chromium.org>
Reviewed-by: Marek Behún <marek.behun@nic.cz>
Tested-by: Marek Behún <marek.behun@nic.cz>
2021-11-16 14:35:08 -05:00

51 lines
492 B
ReStructuredText

Use U-Boot
==========
.. toctree::
:maxdepth: 1
dfu
fdt_overlays
fit
netconsole
partitions
cmdline
environment
Shell commands
--------------
.. toctree::
:maxdepth: 1
addrmap
askenv
base
bootefi
booti
bootmenu
button
x86/cbsysinfo
conitrace
echo
exception
extension
exit
false
fatinfo
for
load
loady
mbr
md
mmc
pinmux
pstore
qfw
reset
sbi
scp03
setexpr
size
true
ums