diff mbox series

[1/1] doc/arch/sandbox.rst: reformat command line options

Message ID 20200919180547.19386-1-xypron.glpk@gmx.de
State Accepted
Delegated to: Simon Glass
Headers show
Series [1/1] doc/arch/sandbox.rst: reformat command line options | expand

Commit Message

Heinrich Schuchardt Sept. 19, 2020, 6:05 p.m. UTC
Reformat the command line options chapter so that the command line options
clearly stand out.

Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
---
 doc/arch/sandbox.rst | 57 +++++++++++++++++++++++++-------------------
 1 file changed, 33 insertions(+), 24 deletions(-)

--
2.28.0

Comments

Simon Glass Sept. 22, 2020, 6:49 p.m. UTC | #1
On Sat, 19 Sep 2020 at 12:05, Heinrich Schuchardt <xypron.glpk@gmx.de> wrote:
>
> Reformat the command line options chapter so that the command line options
> clearly stand out.
>
> Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
> ---
>  doc/arch/sandbox.rst | 57 +++++++++++++++++++++++++-------------------
>  1 file changed, 33 insertions(+), 24 deletions(-)
>

Reviewed-by: Simon Glass <sjg@chromium.org>
Simon Glass Oct. 5, 2020, 9:32 p.m. UTC | #2
On Sat, 19 Sep 2020 at 12:05, Heinrich Schuchardt <xypron.glpk@gmx.de> wrote:
>
> Reformat the command line options chapter so that the command line options
> clearly stand out.
>
> Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
> ---
>  doc/arch/sandbox.rst | 57 +++++++++++++++++++++++++-------------------
>  1 file changed, 33 insertions(+), 24 deletions(-)
>

Reviewed-by: Simon Glass <sjg@chromium.org>

Applied to u-boot-dm/next, thanks!
diff mbox series

Patch

diff --git a/doc/arch/sandbox.rst b/doc/arch/sandbox.rst
index 360f22461a..4674c420ac 100644
--- a/doc/arch/sandbox.rst
+++ b/doc/arch/sandbox.rst
@@ -97,30 +97,39 @@  Command-line Options
 --------------------

 Various options are available, mostly for test purposes. Use -h to see
-available options. Some of these are described below.
-
-The terminal is normally in what is called 'raw-with-sigs' mode. This means
-that you can use arrow keys for command editing and history, but if you
-press Ctrl-C, U-Boot will exit instead of handling this as a keypress.
-
-Other options are 'raw' (so Ctrl-C is handled within U-Boot) and 'cooked'
-(where the terminal is in cooked mode and cursor keys will not work, Ctrl-C
-will exit).
-
-As mentioned above, -l causes the LCD emulation window to be shown.
-
-A device tree binary file can be provided with -d. If you edit the source
-(it is stored at arch/sandbox/dts/sandbox.dts) you must rebuild U-Boot to
-recreate the binary file.
-
-To use the default device tree, use -D. To use the test device tree, use -T.
-
-To execute commands directly, use the -c option. You can specify a single
-command, or multiple commands separated by a semicolon, as is normal in
-U-Boot. Be careful with quoting as the shell will normally process and
-swallow quotes. When -c is used, U-Boot exits after the command is complete,
-but you can force it to go to interactive mode instead with -i.
-
+available options. Some of these are described below:
+
+* -t, --terminal <arg>
+  - The terminal is normally in what is called 'raw-with-sigs' mode. This means
+  that you can use arrow keys for command editing and history, but if you
+  press Ctrl-C, U-Boot will exit instead of handling this as a keypress.
+  Other options are 'raw' (so Ctrl-C is handled within U-Boot) and 'cooked'
+  (where the terminal is in cooked mode and cursor keys will not work, Ctrl-C
+  will exit).
+
+* -l
+  - Show the LCD emulation window.
+
+* -d <device_tree>
+  - A device tree binary file can be provided with -d. If you edit the source
+  (it is stored at arch/sandbox/dts/sandbox.dts) you must rebuild U-Boot to
+  recreate the binary file.
+
+* -D
+  - To use the default device tree, use -D.
+
+* -T
+  - To use the test device tree, use -T.
+
+* -c [<cmd>;]<cmd>
+  - To execute commands directly, use the -c option. You can specify a single
+  command, or multiple commands separated by a semicolon, as is normal in
+  U-Boot. Be careful with quoting as the shell will normally process and
+  swallow quotes. When -c is used, U-Boot exits after the command is complete,
+  but you can force it to go to interactive mode instead with -i.
+
+* -i
+  - Go to interactive mode after executing the commands specified by -c.

 Memory Emulation
 ----------------