From dc3765ede5a465739740df94e803f92fbbd0514a Mon Sep 17 00:00:00 2001 From: Marek Vasut Date: Sun, 19 Jul 2026 01:45:48 +0200 Subject: doc: Switch from setenv to env set The "env" command is the recommended environment management command, its "set" subcommand is the equivalent replacement for legacy "setenv" command. Update the documentation to use the contemporary "env set" command instead of legacy "setenv" command. Note that the "setenv" command is unlikely to be removed from U-Boot in the near future due to it being integral part of the command line ABI. Implemented using: $ sed -i 's@\@env set@g' $(git grep -li '\' doc/) README Signed-off-by: Marek Vasut --- doc/develop/bootstd/overview.rst | 4 ++-- doc/develop/distro.rst | 8 ++++---- doc/develop/uefi/u-boot_on_efi.rst | 4 ++-- doc/develop/uefi/uefi.rst | 12 ++++++------ 4 files changed, 14 insertions(+), 14 deletions(-) (limited to 'doc/develop') diff --git a/doc/develop/bootstd/overview.rst b/doc/develop/bootstd/overview.rst index 397f6db18b4..ec9fafa0fa0 100644 --- a/doc/develop/bootstd/overview.rst +++ b/doc/develop/bootstd/overview.rst @@ -152,7 +152,7 @@ boot_targets This environment variable can be used to control the list of bootdevs searched and their ordering, for example:: - setenv boot_targets "mmc0 mmc1 usb pxe" + env set boot_targets "mmc0 mmc1 usb pxe" Entries may be removed or re-ordered in this list to affect the boot order. If the variable is empty, the default ordering is used, based on the priority of @@ -169,7 +169,7 @@ used by the old distro scripts. This environment variable can be used to control the list of bootmeths used and their ordering for example:: - setenv bootmeths "extlinux efi" + env set bootmeths "extlinux efi" Entries may be removed or re-ordered in this list to affect the order the bootmeths are tried on each bootdev. If the variable is empty, the default diff --git a/doc/develop/distro.rst b/doc/develop/distro.rst index 01efce40a29..5e906750119 100644 --- a/doc/develop/distro.rst +++ b/doc/develop/distro.rst @@ -384,22 +384,22 @@ boot_scripts: scan_dev_for_extlinux: If you want to disable extlinux.conf on all disks, set the value to something - innocuous, e.g. setenv scan_dev_for_extlinux true. + innocuous, e.g. env set scan_dev_for_extlinux true. scan_dev_for_scripts: If you want to disable boot.scr on all disks, set the value to something - innocuous, e.g. setenv scan_dev_for_scripts true. + innocuous, e.g. env set scan_dev_for_scripts true. boot_net_usb_start: If you want to prevent USB enumeration by distro boot commands which execute - network operations, set the value to something innocuous, e.g. setenv + network operations, set the value to something innocuous, e.g. env set boot_net_usb_start true. This would be useful if you know your Ethernet device is not attached to USB, and you wish to increase boot speed by avoiding unnecessary actions. boot_net_pci_enum: If you want to prevent PCI enumeration by distro boot commands which execute - network operations, set the value to something innocuous, e.g. setenv + network operations, set the value to something innocuous, e.g. env set boot_net_pci_enum true. This would be useful if you know your Ethernet device is not attached to PCI, and you wish to increase boot speed by avoiding unnecessary actions. diff --git a/doc/develop/uefi/u-boot_on_efi.rst b/doc/develop/uefi/u-boot_on_efi.rst index 177e887ebd9..883bd2b1451 100644 --- a/doc/develop/uefi/u-boot_on_efi.rst +++ b/doc/develop/uefi/u-boot_on_efi.rst @@ -300,9 +300,9 @@ Content of **boot.scr**: .. code-block:: bash ext4load ${devtype} ${devnum}:${distro_bootpart} ${kernel_addr_r} ${prefix}Image - setenv kernel_size ${filesize} + env set kernel_size ${filesize} ext4load ${devtype} ${devnum}:${distro_bootpart} ${ramdisk_addr_r} ${prefix}Initrd - setenv initrd_size ${filesize} + env set initrd_size ${filesize} zboot ${kernel_addr_r} ${kernel_size} ${ramdisk_addr_r} ${initrd_size} Extlinux configuration diff --git a/doc/develop/uefi/uefi.rst b/doc/develop/uefi/uefi.rst index 3ca22b572a9..6fd1db6606d 100644 --- a/doc/develop/uefi/uefi.rst +++ b/doc/develop/uefi/uefi.rst @@ -170,11 +170,11 @@ Sign an image with one of the keys in "db" on your host Now in U-Boot install the keys on your board:: fatload mmc 0:1 PK.auth - setenv -e -nv -bs -rt -at -i :$filesize PK + env set -e -nv -bs -rt -at -i :$filesize PK fatload mmc 0:1 KEK.auth - setenv -e -nv -bs -rt -at -i :$filesize KEK + env set -e -nv -bs -rt -at -i :$filesize KEK fatload mmc 0:1 db.auth - setenv -e -nv -bs -rt -at -i :$filesize db + env set -e -nv -bs -rt -at -i :$filesize db Set up boot parameters on your board:: @@ -412,7 +412,7 @@ bit in OsIndications variable with .. code-block:: console - => setenv -e -nv -bs -rt -v OsIndications =0x0000000000000004 + => env set -e -nv -bs -rt -v OsIndications =0x0000000000000004 Since U-Boot doesn't currently support SetVariable at runtime, its value won't be taken over across the reboot. If this is the case, you can skip @@ -698,7 +698,7 @@ end up with "host not found". We need to preset the "httpserverip" environment variable to proceed the wget:: - setenv httpserverip 192.168.1.1 + env set httpserverip 192.168.1.1 UEFI HTTP(s) Boot using lwIP ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -789,7 +789,7 @@ If the environment variable is set to 'list' a list of all tests is shown. Below you can find the output of an example session:: - => setenv efi_selftest simple network protocol + => env set efi_selftest simple network protocol => bootefi selftest Testing EFI API implementation Selected test: 'simple network protocol' -- cgit v1.3.1