Tom Rini 11da3403e9 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 <trini@konsulko.com>
Reviewed-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>

2025-10-26 09:03:35 -06:00

..

acpi.rst

acpi: Support checking checksums

2025-04-03 11:43:22 -06:00

addrmap.rst

doc: create index entries for commands

2024-01-17 08:40:19 +01:00

armffa.rst

doc: usage: Add general rule for $?

2025-10-26 09:03:35 -06:00

askenv.rst

doc: create index entries for commands

2024-01-17 08:40:19 +01:00

base.rst

doc: create index entries for commands

2024-01-17 08:40:19 +01:00

bdinfo.rst

doc: usage: Add general rule for $?

2025-10-26 09:03:35 -06:00

bind.rst

doc: usage: Add general rule for $?

2025-10-26 09:03:35 -06:00

blkcache.rst

doc: usage: Add general rule for $?

2025-10-26 09:03:35 -06:00

bootd.rst

doc: create index entries for commands

2024-01-17 08:40:19 +01:00

bootdev.rst

doc: Move bootstd into its own directory

2024-07-19 13:53:05 +02:00

bootefi.rst

efi_loader: Support loading a ramdisk with bootefi

2025-08-08 08:45:18 +02:00

bootelf.rst

doc: add bootelf command documentation

2024-07-14 09:56:24 +02:00

bootflow.rst

doc: Fix typo bootfloe to bootflow

2025-04-03 09:06:51 +02:00

booti.rst

doc: create index entries for commands

2024-01-17 08:40:19 +01:00

bootm.rst

doc: create index entries for commands

2024-01-17 08:40:19 +01:00

bootmenu.rst

cmd: bootmenu: add parameter -e for UEFI boot options

2025-01-05 02:30:48 +01:00

bootmeth.rst

bootstd: Add command to enable setting of bootmeth specific properties

2024-10-15 10:24:27 -06:00

bootstd.rst

bootstd: Add a simple command to list images

2025-01-15 08:48:42 -06:00

bootz.rst

doc: create index entries for commands

2024-01-17 08:40:19 +01:00

button.rst

doc: create index entries for commands

2024-01-17 08:40:19 +01:00

cat.rst

doc: usage: Add general rule for $?

2025-10-26 09:03:35 -06:00

cbcmos.rst

x86: coreboot: Allow building an expo for editing CMOS config

2024-11-03 21:27:12 -06:00

cbsysinfo.rst

x86: coreboot: Show the option table

2024-11-03 21:27:12 -06:00

cedit.rst

x86: coreboot: Allow building an expo for editing CMOS config

2024-11-03 21:27:12 -06:00

cli.rst

doc: usage: Add general rule for $?

2025-10-26 09:03:35 -06:00

cls.rst

doc: usage: Add general rule for $?

2025-10-26 09:03:35 -06:00

cmp.rst

Documentation:

2024-01-17 09:27:23 -05:00

coninfo.rst

doc: create index entries for commands

2024-01-17 08:40:19 +01:00

conitrace.rst

doc: create index entries for commands

2024-01-17 08:40:19 +01:00

cp.rst

doc: usage: Add general rule for $?

2025-10-26 09:03:35 -06:00

cpu.rst

doc: usage: Add general rule for $?

2025-10-26 09:03:35 -06:00

cpuid.rst

doc: usage: Add general rule for $?

2025-10-26 09:03:35 -06:00

cyclic.rst

doc: create index entries for commands

2024-01-17 08:40:19 +01:00

dm.rst

dm: core: Show device sequence instead in dm_dump_tree()

2024-08-27 14:30:02 -06:00

dmareset.rst

doc: usage: Add general rule for $?

2025-10-26 09:03:35 -06:00

ebtupdate.rst

doc: usage: Add general rule for $?

2025-10-26 09:03:35 -06:00

echo.rst

doc: create index entries for commands

2024-01-17 08:40:19 +01:00

efi.rst

doc: create index entries for commands

2024-01-17 08:40:19 +01:00

eficonfig.rst

doc: create index entries for commands

2024-01-17 08:40:19 +01:00

env.rst

env: remove vars that are not in default env

2024-08-15 11:50:47 -06:00

event.rst

doc: create index entries for commands

2024-01-17 08:40:19 +01:00

exception.rst

doc: create index entries for commands

2024-01-17 08:40:19 +01:00

exit.rst

doc: create index entries for commands

2024-01-17 08:40:19 +01:00

extension.rst

doc: create index entries for commands

2024-01-17 08:40:19 +01:00

false.rst

doc: create index entries for commands

2024-01-17 08:40:19 +01:00

fatinfo.rst

doc: usage: Add general rule for $?

2025-10-26 09:03:35 -06:00

fatload.rst

doc: create index entries for commands

2024-01-17 08:40:19 +01:00

fdt.rst

doc: usage: Add general rule for $?

2025-10-26 09:03:35 -06:00

font.rst

doc: usage: Add general rule for $?

2025-10-26 09:03:35 -06:00

for.rst

doc: typo Synopis

2024-03-21 07:29:19 +01:00

fuse.rst

doc: usage: Add general rule for $?

2025-10-26 09:03:35 -06:00

fwu_mdata.rst

doc: create index entries for commands

2024-01-17 08:40:19 +01:00

gpio.rst

doc: usage: Add general rule for $?

2025-10-26 09:03:35 -06:00

gpt.rst

doc: cmd: gpt: add information on type partition

2025-06-17 17:21:36 -06:00

history.rst

doc: typo Synopis

2024-03-21 07:29:19 +01:00

host.rst

doc: usage: Add general rule for $?

2025-10-26 09:03:35 -06:00

i3c.rst

doc: usage: Add general rule for $?

2025-10-26 09:03:35 -06:00

if.rst

doc: add reference to itest in if man-page

2024-03-27 09:30:07 +01:00

imxtract.rst

doc: usage: Add general rule for $?

2025-10-26 09:03:35 -06:00

itest.rst

doc: fix heading level of itest examples

2024-07-14 09:56:24 +02:00

load.rst

doc: create index entries for commands

2024-01-17 08:40:19 +01:00

loadb.rst

doc: usage: Add general rule for $?

2025-10-26 09:03:35 -06:00

loadm.rst

doc: usage: Add general rule for $?

2025-10-26 09:03:35 -06:00

loads.rst

doc: usage: Add general rule for $?

2025-10-26 09:03:35 -06:00

loadx.rst

doc: usage: Add general rule for $?

2025-10-26 09:03:35 -06:00

loady.rst

doc: usage: Add general rule for $?

2025-10-26 09:03:35 -06:00

mbr.rst

doc: create index entries for commands

2024-01-17 08:40:19 +01:00

md.rst

doc: remove duplicated "commands"

2025-04-25 17:28:10 +02:00

meminfo.rst

doc: update meminfo with arch specific information

2025-03-14 13:30:12 +02:00

mmc.rst

cmd: mmc: Allow using partition name in mmc erase command

2024-09-16 16:45:55 -06:00

msr.rst

doc: usage: Add general rule for $?

2025-10-26 09:03:35 -06:00

mtest.rst

doc: usage: Add general rule for $?

2025-10-26 09:03:35 -06:00

mtrr.rst

doc: typo Synopis

2024-03-21 07:29:19 +01:00

mv.rst

fs: fat: add rename

2025-03-07 11:50:22 -06:00

optee.rst

doc: usage: Add general rule for $?

2025-10-26 09:03:35 -06:00

panic.rst

doc: typo Synopis

2024-03-21 07:29:19 +01:00

part.rst

doc: usage: Add general rule for $?

2025-10-26 09:03:35 -06:00

pause.rst

doc: usage: Add general rule for $?

2025-10-26 09:03:35 -06:00

pinmux.rst

doc: usage: Add general rule for $?

2025-10-26 09:03:35 -06:00

printenv.rst

doc: create index entries for commands

2024-01-17 08:40:19 +01:00

pstore.rst

doc: create index entries for commands

2024-01-17 08:40:19 +01:00

pwm.rst

doc: usage: Add general rule for $?

2025-10-26 09:03:35 -06:00

qfw.rst

doc: create index entries for commands

2024-01-17 08:40:19 +01:00

read.rst

doc: separate read and write command documentation

2025-10-26 10:15:21 +00:00

reset.rst

doc: create index entries for commands

2024-01-17 08:40:19 +01:00

rng.rst

cmd/rng: fix long help text

2024-12-24 17:02:23 +01:00

saves.rst

doc: usage: Add general rule for $?

2025-10-26 09:03:35 -06:00

sb.rst

doc: sandbox: Fix the "sb" command name

2025-01-05 02:30:48 +01:00

sbi.rst

doc: create index entries for commands

2024-01-17 08:40:19 +01:00

scmi.rst

doc: usage: Add general rule for $?

2025-10-26 09:03:35 -06:00

scp03.rst

doc: create index entries for commands

2024-01-17 08:40:19 +01:00

seama.rst

doc: create index entries for commands

2024-01-17 08:40:19 +01:00

setexpr.rst

doc: usage: Add general rule for $?

2025-10-26 09:03:35 -06:00

sf.rst

doc: typo Synopis

2024-03-21 07:29:19 +01:00

size.rst

doc: usage: Add general rule for $?

2025-10-26 09:03:35 -06:00

sleep.rst

doc: create index entries for commands

2024-01-17 08:40:19 +01:00

sm.rst

doc: typo Synopis

2024-03-21 07:29:19 +01:00

smbios.rst

doc: usage: Add general rule for $?

2025-10-26 09:03:35 -06:00

sntp.rst

net: introduce CONFIG_DNS

2025-08-18 15:47:58 +02:00

sound.rst

doc: usage: Add general rule for $?

2025-10-26 09:03:35 -06:00

source.rst

doc: usage: Add general rule for $?

2025-10-26 09:03:35 -06:00

tcpm.rst

usb: tcpm: add core framework

2024-10-17 03:12:47 +02:00

temperature.rst

doc: usage: Add general rule for $?

2025-10-26 09:03:35 -06:00

test.rst

doc: document test command

2025-05-29 08:25:18 -06:00

tftpput.rst

doc: usage: Add general rule for $?

2025-10-26 09:03:35 -06:00

trace.rst

doc: typo Synopis

2024-03-21 07:29:19 +01:00

true.rst

doc: create index entries for commands

2024-01-17 08:40:19 +01:00

ums.rst

doc: usage: cmd: ums: fix dependencies

2024-09-21 11:22:42 +02:00

unbind.rst

doc: usage: Add general rule for $?

2025-10-26 09:03:35 -06:00

upl.rst

upl: Add initial documentation

2024-08-09 16:03:20 -06:00

ut.rst

test: Update documentation

2025-02-11 20:12:36 -06:00

wdt.rst

doc: usage: Add general rule for $?

2025-10-26 09:03:35 -06:00

wget.rst

doc: usage: Add general rule for $?

2025-10-26 09:03:35 -06:00

write.rst

doc: separate read and write command documentation

2025-10-26 10:15:21 +00:00

xxd.rst

doc: create index entries for commands

2024-01-17 08:40:19 +01:00