diff options
| author | Tom Rini <[email protected]> | 2025-10-24 10:02:57 -0600 |
|---|---|---|
| committer | Tom Rini <[email protected]> | 2025-10-26 09:03:35 -0600 |
| commit | 11da3403e91c9f510495c75d07750b6ac3c3b2e7 (patch) | |
| tree | b6600db067b5260e8957a67e69b22c0e28111312 /doc/usage/cmd/cli.rst | |
| parent | 1f6da608c3d9a9a7d189177614cfb8d6a1ad8d6c (diff) | |
doc: usage: Add general rule for `$?`
For nearly all commands in U-Boot the '?' variable is handled the same
way with 0 meaning success, 1 meaning any failure. Explain this in the
general rules section of the cmdline documentation (with a link to a
counter example) and then remove the redundant wording from most
commands. We retain a section about the return value in a number of
places where we are doing something such as always returning a specific
value or we have useful additional information to go along with the
normal return codes.
Signed-off-by: Tom Rini <[email protected]>
Reviewed-by: Heinrich Schuchardt <[email protected]>
Diffstat (limited to 'doc/usage/cmd/cli.rst')
| -rw-r--r-- | doc/usage/cmd/cli.rst | 5 |
1 files changed, 0 insertions, 5 deletions
diff --git a/doc/usage/cmd/cli.rst b/doc/usage/cmd/cli.rst index 23e5ee7a902..97de5331d1b 100644 --- a/doc/usage/cmd/cli.rst +++ b/doc/usage/cmd/cli.rst @@ -70,8 +70,3 @@ compiled:: modern => cli set old Want to set current parser to old, but its code was not compiled! - -Return value ------------- - -The return value $? indicates whether the command succeeded. |