Mirrors/u-boot
2
0
Fork 0
mirror of https://github.com/AsahiLinux/u-boot synced 2024-12-25 04:23:46 +00:00
Code Issues Projects Releases Packages Wiki Activity
u-boot/doc/usage/index.rst

93 lines
1.1 KiB
ReStructuredText
Raw Normal View History

doc: move pstore.rst to usage/pstore.rst Let's have a separate chapter dedicated to using U-Boot. Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
2020-12-12 07:50:37 +00:00
Use U-Boot
==========
.. toctree::
doc: move README.fdt-overlays to HTML documentation Convert doc/README.fdt-overlays to doc/usage/fdt_overlays.rst. Edit the text for readability. Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
2020-12-31 15:43:37 +00:00
:maxdepth: 1
doc: move pstore.rst to usage/pstore.rst Let's have a separate chapter dedicated to using U-Boot. Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
2020-12-12 07:50:37 +00:00
doc: move README.dfu to HTML documentation Move README.dfu to doc/usage/dfu.rst and convert to reStructured text. In the long run this page should be split into two. One for the overview and one for the dfu command. UEFI capsule updates and dfutftp should be integrated into the overview page. Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
2021-03-05 11:58:37 +00:00
dfu
doc: Improve environment documentation Make various updates suggested during review of the rST conversion. Signed-off-by: Simon Glass <sjg@chromium.org> Reviewed-by: Marek Behún <marek.behun@nic.cz> Suggested-by: Wolfgang Denk <wd@denx.de>
2021-10-22 03:08:49 +00:00
environment
doc: move README.fdt-overlays to HTML documentation Convert doc/README.fdt-overlays to doc/usage/fdt_overlays.rst. Edit the text for readability. Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
2020-12-31 15:43:37 +00:00
fdt_overlays
binman: doc: Add documentation to htmldocs Add a link to binman's documentation and adjust the files so that it is accessible. Use the name README.rst so it is easy to discover when binman is installed without U-Boot. Signed-off-by: Simon Glass <sjg@chromium.org>
2021-03-18 07:25:13 +00:00
fit
doc: move README.NetConsole to HTML documentation Convert README.NetConsole to reStructured text and move it to doc/usage/netconsole.rst. Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de> Reviewed-by: Simon Glass <sjg@chromium.org>
2020-12-12 08:37:47 +00:00
netconsole
doc: Document partition specifications This documents the way U-Boot understands partitions specifications. This also updates the fastboot documentation for the changes in the previous commit. Signed-off-by: Sean Anderson <sean.anderson@seco.com> Reviewed-by: Simon Glass <sjg@chromium.org>
2021-02-05 14:39:02 +00:00
partitions
doc: Convert command-line info to rST Take this part of the README and put it into rST format. Signed-off-by: Simon Glass <sjg@chromium.org>
2021-07-24 15:03:36 +00:00
cmdline
doc: Convert semihosting readme to rST This converts the semihosting readme to rST. I have tried to make only cosmetic changes, but I did fix up the first link (which was broken). Signed-off-by: Sean Anderson <sean.anderson@seco.com>
2022-03-22 20:59:09 +00:00
semihosting
doc: move README.NetConsole to HTML documentation Convert README.NetConsole to reStructured text and move it to doc/usage/netconsole.rst. Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de> Reviewed-by: Simon Glass <sjg@chromium.org>
2020-12-12 08:37:47 +00:00
doc: move pstore.rst to usage/pstore.rst Let's have a separate chapter dedicated to using U-Boot. Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
2020-12-12 07:50:37 +00:00
Shell commands
--------------
.. toctree::
:maxdepth: 1
doc: usage: Group all shell command docs into cmd/ sub-directory Currently all shell command docs are put in the doc/usage root. Let's group them into cmd/ sub-directory. Signed-off-by: Bin Meng <bmeng.cn@gmail.com> Reviewed-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
2022-03-28 03:02:56 +00:00
cmd/acpi
cmd/addrmap
cmd/askenv
cmd/base
Documentation: man-page for command bootd Provide a man-page for the bootd command. Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com> Reviewed-by: Simon Glass <sjg@chromium.org>
2022-11-14 09:30:58 +00:00
cmd/bootd
bootstd: doc: Add documentation Add documentation for this feature, including the commands and full devicetree bindings. Signed-off-by: Simon Glass <sjg@chromium.org>
2022-04-25 05:31:26 +00:00
cmd/bootdev
doc: usage: Group all shell command docs into cmd/ sub-directory Currently all shell command docs are put in the doc/usage root. Let's group them into cmd/ sub-directory. Signed-off-by: Bin Meng <bmeng.cn@gmail.com> Reviewed-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
2022-03-28 03:02:56 +00:00
cmd/bootefi
bootstd: doc: Add documentation Add documentation for this feature, including the commands and full devicetree bindings. Signed-off-by: Simon Glass <sjg@chromium.org>
2022-04-25 05:31:26 +00:00
cmd/bootflow
doc: usage: Group all shell command docs into cmd/ sub-directory Currently all shell command docs are put in the doc/usage root. Let's group them into cmd/ sub-directory. Signed-off-by: Bin Meng <bmeng.cn@gmail.com> Reviewed-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
2022-03-28 03:02:56 +00:00
cmd/booti
cmd/bootmenu
bootstd: doc: Add documentation Add documentation for this feature, including the commands and full devicetree bindings. Signed-off-by: Simon Glass <sjg@chromium.org>
2022-04-25 05:31:26 +00:00
cmd/bootmeth
doc: usage: Group all shell command docs into cmd/ sub-directory Currently all shell command docs are put in the doc/usage root. Let's group them into cmd/ sub-directory. Signed-off-by: Bin Meng <bmeng.cn@gmail.com> Reviewed-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
2022-03-28 03:02:56 +00:00
cmd/button
doc: man-page for bootz command Provide a man-page for the bootz command. Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
2022-06-11 06:23:31 +00:00
cmd/bootz
cmd: cat: add new command Add cat command to print file content to standard out Reviewed-by: Simon Glass <sjg@chromium.org> Signed-off-by: Roger Knecht <rknecht@pm.me>
2022-09-03 11:34:53 +00:00
cmd/cat
doc: usage: Group all shell command docs into cmd/ sub-directory Currently all shell command docs are put in the doc/usage root. Let's group them into cmd/ sub-directory. Signed-off-by: Bin Meng <bmeng.cn@gmail.com> Reviewed-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
2022-03-28 03:02:56 +00:00
cmd/cbsysinfo
doc: man-page for cls Provide a man-page for the cls command. Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com> Reviewed-by: Simon Glass <sjg@chromium.org>
2022-10-07 18:51:35 +00:00
cmd/cls
doc: add man-page for cmp command Provide a man-page for the cmp command. Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
2022-11-13 12:27:32 +00:00
cmd/cmp
doc: usage: Group all shell command docs into cmd/ sub-directory Currently all shell command docs are put in the doc/usage root. Let's group them into cmd/ sub-directory. Signed-off-by: Bin Meng <bmeng.cn@gmail.com> Reviewed-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
2022-03-28 03:02:56 +00:00
cmd/conitrace
cyclic: Add documentation Add documentation for the cyclic function infrastructure, including the cyclic command. Signed-off-by: Stefan Roese <sr@denx.de> Reviewed-by: Simon Glass <sjg@chromium.org>
2022-09-02 11:57:53 +00:00
cmd/cyclic
dm: core: Add documentation for the dm command Add a description and examples for the dm subcommands. Signed-off-by: Simon Glass <sjg@chromium.org>
2022-05-08 10:39:22 +00:00
cmd/dm
doc: usage: Group all shell command docs into cmd/ sub-directory Currently all shell command docs are put in the doc/usage root. Let's group them into cmd/ sub-directory. Signed-off-by: Bin Meng <bmeng.cn@gmail.com> Reviewed-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
2022-03-28 03:02:56 +00:00
cmd/echo
doc:eficonfig: add documentation for eficonfig command Add documentation for eficonfig command. Signed-off-by: Masahisa Kojima <masahisa.kojima@linaro.org> Reviewed-by: Ilias Apalodimas <ilias.apalodimas@linaro.org>
2022-09-12 08:33:58 +00:00
cmd/eficonfig
doc: man-page for the env command Describe the env command. Signed-off-by: Patrick Delaunay <patrick.delaunay@foss.st.com>
2022-04-14 17:07:05 +00:00
cmd/env
Merge branch 'next' Signed-off-by: Tom Rini <trini@konsulko.com>
2022-04-04 14:45:33 +00:00
cmd/event
doc: usage: Group all shell command docs into cmd/ sub-directory Currently all shell command docs are put in the doc/usage root. Let's group them into cmd/ sub-directory. Signed-off-by: Bin Meng <bmeng.cn@gmail.com> Reviewed-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
2022-03-28 03:02:56 +00:00
cmd/exception
cmd/extension
cmd/exit
cmd/false
cmd/fatinfo
cmd/fatload
doc: Make a start on docs for fdt command Add some information about the 'fdt addr' subcommand, to get things started. Signed-off-by: Simon Glass <sjg@chromium.org>
2022-07-13 12:07:00 +00:00
cmd/fdt
video: Add commands to list and change fonts Add a new 'font' command which allows the fonts to be listed as well as selecting a different font and size. Allow the test to run on sandbox, where multiple font/size combinations are supported, as well as sandbox_flattree, where they are not. Signed-off-by: Simon Glass <sjg@chromium.org>
2022-10-06 14:36:16 +00:00
cmd/font
doc: usage: Group all shell command docs into cmd/ sub-directory Currently all shell command docs are put in the doc/usage root. Let's group them into cmd/ sub-directory. Signed-off-by: Bin Meng <bmeng.cn@gmail.com> Reviewed-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
2022-03-28 03:02:56 +00:00
cmd/for
FWU: cmd: Add a command to read FWU metadata Add a command to read the metadata as specified in the FWU specification and print the fields of the metadata. Signed-off-by: Sughosh Ganu <sughosh.ganu@linaro.org> Reviewed-by: Ilias Apalodimas <ilias.apalodimas@linaro.org> Reviewed-by: Etienne Carriere <etienne.carriere@linaro.org>
2022-10-21 12:46:04 +00:00
cmd/fwu_mdata
doc: man-page for gpio command Provide a man-page for the gpio command. Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
2022-08-02 12:20:32 +00:00
cmd/gpio
dm: Add documentation for host command and implementation Document the 'host' command and also the internals of how it is implemented. Signed-off-by: Simon Glass <sjg@chromium.org>
2022-10-30 01:47:18 +00:00
cmd/host
doc: usage: Group all shell command docs into cmd/ sub-directory Currently all shell command docs are put in the doc/usage root. Let's group them into cmd/ sub-directory. Signed-off-by: Bin Meng <bmeng.cn@gmail.com> Reviewed-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
2022-03-28 03:02:56 +00:00
cmd/load
cmd: load: add load command for memory mapped cp.b is used a lot as a way to load binaries to memory and execute them, however we may need to integrate this with the efi subsystem to set it up as a bootdev. So, introduce a loadm command that will be consistent with the other loadX commands and will call the efi API's. ex: loadm $kernel_addr $kernel_addr_r $kernel_size with this a kernel with CONFIG_EFI_STUB enabled will be loaded and then subsequently booted with bootefi command. Signed-off-by: Rui Miguel Silva <rui.silva@linaro.org> Reviewed-by: Tom Rini <trini@konsulko.com>
2022-05-11 09:55:40 +00:00
cmd/loadm
doc: usage: Group all shell command docs into cmd/ sub-directory Currently all shell command docs are put in the doc/usage root. Let's group them into cmd/ sub-directory. Signed-off-by: Bin Meng <bmeng.cn@gmail.com> Reviewed-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
2022-03-28 03:02:56 +00:00
cmd/loady
cmd/mbr
cmd/md
cmd/mmc
cmd: Add pause command This command is being introduced with the goal of allowing user-friendly "generic use case" U-Boot builds to pause until user input under some situations. The main use case would be when a boot failure happens, to pause until the user has had time to acknowledge the current state. Tested using: make && ./u-boot -v -T -c 'ut lib lib_test_hush_pause' Signed-off-by: Samuel Dionne-Riel <samuel@dionne-riel.com> Cc: Simon Glass <sjg@chromium.org>
2022-08-18 19:44:04 +00:00
cmd/pause
doc: usage: Group all shell command docs into cmd/ sub-directory Currently all shell command docs are put in the doc/usage root. Let's group them into cmd/ sub-directory. Signed-off-by: Bin Meng <bmeng.cn@gmail.com> Reviewed-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
2022-03-28 03:02:56 +00:00
cmd/pinmux
doc: man-page for the printenv command Privide a man-page for the printenv command. Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
2022-06-19 11:59:22 +00:00
cmd/printenv
doc: usage: Group all shell command docs into cmd/ sub-directory Currently all shell command docs are put in the doc/usage root. Let's group them into cmd/ sub-directory. Signed-off-by: Bin Meng <bmeng.cn@gmail.com> Reviewed-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
2022-03-28 03:02:56 +00:00
cmd/pstore
cmd/qfw
cmd/reset
doc: rng: Add documentation for the rng command Add a usage document for the 'rng' u-boot command. Signed-off-by: Sughosh Ganu <sughosh.ganu@linaro.org> Reviewed-by: Ilias Apalodimas <ilias.apalodimas@linaro.org> Reviewed-by: Simon Glass <sjg@chromium.org> Signed-off-by: Ilias Apalodimas <ilias.apalodimas@linaro.org>
2022-07-22 16:02:08 +00:00
cmd/rng
doc: usage: Group all shell command docs into cmd/ sub-directory Currently all shell command docs are put in the doc/usage root. Let's group them into cmd/ sub-directory. Signed-off-by: Bin Meng <bmeng.cn@gmail.com> Reviewed-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
2022-03-28 03:02:56 +00:00
cmd/sbi
cmd/sf
cmd/scp03
cmd/setexpr
cmd/size
doc: cmd: temperature: add documentation Add documentation for the temperature command. Signed-off-by: Robert Marko <robert.marko@sartura.hr> Reviewed-by: Simon Glass <sjg@chromium.org>
2022-09-06 11:30:34 +00:00
cmd/temperature
doc: man-page for tftpput Provide a man-page for the tftpput command. Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com> Reviewed-by: Simon Glass <sjg@chromium.org>
2022-09-03 11:31:04 +00:00
cmd/tftpput
doc: usage: Group all shell command docs into cmd/ sub-directory Currently all shell command docs are put in the doc/usage root. Let's group them into cmd/ sub-directory. Signed-off-by: Bin Meng <bmeng.cn@gmail.com> Reviewed-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
2022-03-28 03:02:56 +00:00
cmd/true
cmd/ums
test: doc: Add documentation for ut command Before adding more options, document this command. Signed-off-by: Simon Glass <sjg@chromium.org>
2022-10-30 01:47:11 +00:00
cmd/ut
doc: usage: Group all shell command docs into cmd/ sub-directory Currently all shell command docs are put in the doc/usage root. Let's group them into cmd/ sub-directory. Signed-off-by: Bin Meng <bmeng.cn@gmail.com> Reviewed-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
2022-03-28 03:02:56 +00:00
cmd/wdt
doc: cmd: wget: add documentation Add documentation for the wget command. Signed-off-by: Ying-Chun Liu (PaulLiu) <paul.liu@linaro.org> Cc: Christian Gmeiner <christian.gmeiner@gmail.com> Cc: Joe Hershberger <joe.hershberger@ni.com> Cc: Michal Simek <michal.simek@xilinx.com> Cc: Ramon Fried <rfried.dev@gmail.com> Cc: Simon Glass <sjg@chromium.org> Reviewed-by: Simon Glass <sjg@chromium.org> Reviewed-by: Ramon Fried <rfried.dev@gmail.com>
2022-11-08 06:17:30 +00:00
cmd/wget
cmd: xxd: add new command Add xxd command to print file content as hexdump to standard out Reviewed-by: Simon Glass <sjg@chromium.org> Signed-off-by: Roger Knecht <rknecht@pm.me>
2022-09-03 13:15:04 +00:00
cmd/xxd
doc: usage: Convert README.vxworks to reST This converts the existing README.vxworks to reST, and puts it under the doc/usage/os directory. Signed-off-by: Bin Meng <bmeng.cn@gmail.com> Reviewed-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
2022-03-28 02:43:49 +00:00
Booting OS
----------
.. toctree::
:maxdepth: 1
doc: usage: Convert README.plan9 to reST This converts the existing README.plan9 to reST, and puts it under the doc/usage/os directory. Signed-off-by: Bin Meng <bmeng.cn@gmail.com> Reviewed-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
2022-03-28 02:43:51 +00:00
os/plan9
doc: usage: Convert README.vxworks to reST This converts the existing README.vxworks to reST, and puts it under the doc/usage/os directory. Signed-off-by: Bin Meng <bmeng.cn@gmail.com> Reviewed-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
2022-03-28 02:43:49 +00:00
os/vxworks
Reference in a new issue Copy permalink