aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorSimon Glass <sjg@chromium.org>2021-07-24 09:03:36 -0600
committerTom Rini <trini@konsulko.com>2021-08-02 13:32:14 -0400
commit7a4ff7c41bab8b43767eacc0b30ca1573ab6acb1 (patch)
treecafc141c866843e1a0b569834f3c67d273656822 /doc
parent5a94546e1cb302842aa0f65be0bb3585fd010ccd (diff)
downloadu-boot-7a4ff7c41bab8b43767eacc0b30ca1573ab6acb1.zip
u-boot-7a4ff7c41bab8b43767eacc0b30ca1573ab6acb1.tar.gz
u-boot-7a4ff7c41bab8b43767eacc0b30ca1573ab6acb1.tar.bz2
doc: Convert command-line info to rST
Take this part of the README and put it into rST format. Signed-off-by: Simon Glass <sjg@chromium.org>
Diffstat (limited to 'doc')
-rw-r--r--doc/usage/cmdline.rst56
-rw-r--r--doc/usage/index.rst1
2 files changed, 57 insertions, 0 deletions
diff --git a/doc/usage/cmdline.rst b/doc/usage/cmdline.rst
new file mode 100644
index 0000000..b3dbdb8
--- /dev/null
+++ b/doc/usage/cmdline.rst
@@ -0,0 +1,56 @@
+.. SPDX-License-Identifier: GPL-2.0+
+
+Command-line Parsing
+====================
+
+The command line is available in U-Boot proper, enabled by CONFIG_CMDLINE which
+is on by default. It is not enabled in SPL.
+
+There are two different command-line parsers available with U-Boot:
+the old "simple" one, and the much more powerful "hush" shell:
+
+Simple command-line parser
+--------------------------
+
+This takes very little code space and offers only basic features:
+
+- supports environment variables (through setenv / saveenv commands)
+- several commands on one line, separated by ';'
+- variable substitution using "... ${name} ..." syntax
+- special characters ('$', ';') can be escaped by prefixing with '\',
+ for example::
+
+ setenv bootcmd bootm \${address}
+
+- You can also escape text by enclosing in single apostrophes, for example::
+
+ setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
+
+Hush shell
+----------
+
+This is similar to Bourne shell, with control structures like:
+
+- `if`... `then` ... `else`... `fi`
+- `for`... `do` ... `done`
+- `while` ... `do` ... `done`
+- `until` ... `do` ... `done`
+
+Hush supports environment ("global") variables (through setenv / saveenv
+commands) and local shell variables (through standard shell syntax
+`name=value`); only environment variables can be used with the "run" command
+
+The Hush shell is enabled with `CONFIG_HUSH_PARSER`.
+
+General rules
+-------------
+
+#. If a command line (or an environment variable executed by a "run"
+ command) contains several commands separated by semicolon, and
+ one of these commands fails, then the remaining commands will be
+ executed anyway.
+
+#. If you execute several variables with one call to run (i. e.
+ calling run with a list of variables as arguments), any failing
+ command will cause "run" to terminate, i. e. the remaining
+ variables are not executed.
diff --git a/doc/usage/index.rst b/doc/usage/index.rst
index 719b2c9..356f2a5 100644
--- a/doc/usage/index.rst
+++ b/doc/usage/index.rst
@@ -9,6 +9,7 @@ Use U-Boot
fit
netconsole
partitions
+ cmdline
Shell commands
--------------