diff options
| author | Tom Rini <[email protected]> | 2022-09-02 21:51:21 -0400 |
|---|---|---|
| committer | Tom Rini <[email protected]> | 2022-09-02 21:53:36 -0400 |
| commit | 98b3a998b31a83d8167f888b11ddd5cce8194f35 (patch) | |
| tree | 91e5c815982e9f1823f86f61bc49e28d948d1b4c /doc/usage | |
| parent | 2d7069126d11f8708ee38c68b1c6cafae5e50dae (diff) | |
| parent | 21ddac140e3040b2693c1a5558a84c19a879c04f (diff) | |
Merge branch '2022-09-02-assorted-improvements' into next
- DM RTC improvements that should help in CI, allow disabling LTO from
the make line, add extension (cape, etc) support to distro bootcmd,
add a pause command and re-enable ARM v4T support.
Diffstat (limited to 'doc/usage')
| -rw-r--r-- | doc/usage/cmd/pause.rst | 53 | ||||
| -rw-r--r-- | doc/usage/index.rst | 1 |
2 files changed, 54 insertions, 0 deletions
diff --git a/doc/usage/cmd/pause.rst b/doc/usage/cmd/pause.rst new file mode 100644 index 00000000000..c79e399c020 --- /dev/null +++ b/doc/usage/cmd/pause.rst @@ -0,0 +1,53 @@ +.. SPDX-License-Identifier: GPL-2.0-or-later: + +pause command +============= + +Synopsis +-------- + +:: + + pause [prompt] + + +Description +----------- + +The pause command delays execution waiting for any user input. + +It can accept a single parameter to change the prompt message. + +Examples +-------- + +Using with the default prompt: + +:: + + => pause + Press any key to continue... + + +Using with a custom prompt: + +:: + + => pause 'Prompt for pause...' + Prompt for pause... + +Note that complex prompts require proper quoting: + +:: + + => pause Prompt for pause... + pause - delay until user input + + Usage: + pause [prompt] - Wait until users presses any key. [prompt] can be used to customize the message. + +Return value +------------ + +The return value $? is always set to 0 (true), unless invoked in an invalid +manner. diff --git a/doc/usage/index.rst b/doc/usage/index.rst index 28f9683a3e6..5170fa8b4a5 100644 --- a/doc/usage/index.rst +++ b/doc/usage/index.rst @@ -52,6 +52,7 @@ Shell commands cmd/mbr cmd/md cmd/mmc + cmd/pause cmd/pinmux cmd/printenv cmd/pstore |
