aboutsummaryrefslogtreecommitdiff
path: root/doc/usage/index.rst
AgeCommit message (Collapse)Author
2022-10-30video: Add commands to list and change fontsSimon Glass
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-11doc: cmd: temperature: add documentationRobert Marko
Add documentation for the temperature command. Signed-off-by: Robert Marko <robert.marko@sartura.hr> Reviewed-by: Simon Glass <sjg@chromium.org>
2022-10-11cmd: xxd: add new commandRoger Knecht
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-10-11cmd: cat: add new commandRoger Knecht
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-10-10doc: man-page for clsHeinrich Schuchardt
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-09-19Merge branch 'master' into nextTom Rini
Signed-off-by: Tom Rini <trini@konsulko.com>
2022-09-14Merge tag 'efi-next-2022-09-14' of ↵Tom Rini
https://source.denx.de/u-boot/custodians/u-boot-efi into next Pull request for efi next UEFI: Implement a command eficonfig to maintain Load Options and boot order via menus.
2022-09-14doc:eficonfig: add documentation for eficonfig commandMasahisa Kojima
Add documentation for eficonfig command. Signed-off-by: Masahisa Kojima <masahisa.kojima@linaro.org> Reviewed-by: Ilias Apalodimas <ilias.apalodimas@linaro.org>
2022-09-13cyclic: Add documentationStefan Roese
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-09doc: man-page for tftpputHeinrich Schuchardt
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-02cmd: Add pause commandSamuel Dionne-Riel
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-13doc: man-page for gpio commandHeinrich Schuchardt
Provide a man-page for the gpio command. Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
2022-08-02doc: rng: Add documentation for the rng commandSughosh Ganu
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-26doc: Make a start on docs for fdt commandSimon Glass
Add some information about the 'fdt addr' subcommand, to get things started. Signed-off-by: Simon Glass <sjg@chromium.org>
2022-06-28dm: core: Add documentation for the dm commandSimon Glass
Add a description and examples for the dm subcommands. Signed-off-by: Simon Glass <sjg@chromium.org>
2022-06-22cmd: load: add load command for memory mappedRui Miguel Silva
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-06-19doc: man-page for the printenv commandHeinrich Schuchardt
Privide a man-page for the printenv command. Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
2022-06-19doc: man-page for bootz commandHeinrich Schuchardt
Provide a man-page for the bootz command. Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
2022-04-25bootstd: doc: Add documentationSimon Glass
Add documentation for this feature, including the commands and full devicetree bindings. Signed-off-by: Simon Glass <sjg@chromium.org>
2022-04-15doc: man-page for the env commandPatrick Delaunay
Describe the env command. Signed-off-by: Patrick Delaunay <patrick.delaunay@foss.st.com>
2022-04-04Merge branch 'next'Tom Rini
Signed-off-by: Tom Rini <trini@konsulko.com>
2022-04-01doc: Convert semihosting readme to rSTSean Anderson
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-31doc: usage: Convert README.plan9 to reSTBin Meng
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-31doc: usage: Convert README.vxworks to reSTBin Meng
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-31doc: usage: Group all shell command docs into cmd/ sub-directoryBin Meng
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-28Merge tag 'v2022.04-rc5' into nextTom Rini
Prepare v2022.04-rc5
2022-03-26doc: man-page for the wdt commandHeinrich Schuchardt
Describe the wdt command. Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
2022-03-10event: Add documentationSimon Glass
Add documentation for events, including the event command. Signed-off-by: Simon Glass <sjg@chromium.org>
2022-02-26doc: describe fatload commandHeinrich Schuchardt
Man-page for fatload command. Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
2022-01-25doc: Add usage information for the acpi commandSimon Glass
Add some documentation for this command. Signed-off-by: Simon Glass <sjg@chromium.org>
2021-12-21doc: remove duplicate page inclusionHeinrich Schuchardt
doc/usage/index.rst in branch origin/next includes usage/environment twice. Remove the duplicate entry. Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
2021-11-28sf: doc: Add documentation for the 'sf' commandSimon Glass
This command is fairly complicated so documentation is useful. Unfortunately I an not sure how the MTD side of things works and cannot find information about that. Signed-off-by: Simon Glass <sjg@chromium.org> Acked-by: Pratyush Yadav <p.yadav@ti.com> Reviewed-by: Jagan Teki <jagan@amarulasolutions.com> Acked-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
2021-11-16doc: Improve environment documentationSimon Glass
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-11-16env: Allow U-Boot scripts to be placed in a .env fileSimon Glass
At present U-Boot environment variables, and thus scripts, are defined by CONFIG_EXTRA_ENV_SETTINGS. It is painful to add large amounts of text to this file and dealing with quoting and newlines is harder than it should be. It would be better if we could just type the script into a text file and have it included by U-Boot. Add a feature that brings in a .env file associated with the board config, if present. To use it, create a file in a board/<vendor> directory, typically called <board>.env and controlled by the CONFIG_ENV_SOURCE_FILE option. The environment variables should be of the form "var=value". Values can extend to multiple lines. See the README under 'Environment Variables:' for more information and an example. In many cases environment variables need access to the U-Boot CONFIG variables to select different options. Enable this so that the environment scripts can be as useful as the ones currently in the board config files. This uses the C preprocessor, means that comments can be included in the environment using /* ... */ Also support += to allow variables to be appended to. This is needed when using the preprocessor. Signed-off-by: Simon Glass <sjg@chromium.org> Reviewed-by: Marek Behún <marek.behun@nic.cz> Tested-by: Marek Behún <marek.behun@nic.cz>
2021-08-02doc: Convert command-line info to rSTSimon Glass
Take this part of the README and put it into rST format. Signed-off-by: Simon Glass <sjg@chromium.org>
2021-07-27doc: usage: add description for setexpr commandRoland Gaudig
Add usage for the setexpr command. It has been added to describe mainly the new setexpr format string operation. Signed-off-by: Roland Gaudig <roland.gaudig@weidmueller.com> Reviewed-by: Simon Glass <sjg@chromium.org>
2021-06-28doc/usage: cmd-usage help file for askenvAdarsh Babu Kalepalli
help file for using askenv cmd is created. It provides description on the command purpose, description of arguments, couple of examples (illustrating command usage), configuration parameter and possible return values. Signed-off-by: Adarsh Babu Kalepalli <opensource.kab@gmail.com> Add missing entry in doc/usage/index.rst. Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
2021-06-09doc: usage: man-page for ums commandPatrick Delaunay
Provide a man-page for the ums command - USB Mass Storage. Signed-off-by: Patrick Delaunay <patrick.delaunay@foss.st.com> Reviewed-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
2021-06-09doc: usage: man-page for pinmux commandPatrick Delaunay
Provide a man-page for the pinmux command. Signed-off-by: Patrick Delaunay <patrick.delaunay@foss.st.com> Reviewed-by: Patrice Chotard <patrice.chotard@foss.st.com>
2021-06-09doc: usage: reorder commands in index.rstPatrick Delaunay
Reorder alphabetically the command in the index of usage in U-Boot documentation. Signed-off-by: Patrick Delaunay <patrick.delaunay@foss.st.com> Reviewed-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
2021-05-18doc: extension.rst missing in doc/usage/index.rstHeinrich Schuchardt
'make htmldocs' results in a build warning checking consistency... doc/usage/extension.rst: WARNING: document isn't included in any toctree Add the document to the index. Fixes: 2f84e9cf06d3 ("cmd: add support for a new "extension" command") Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
2021-05-18doc: man-page for size commandHeinrich Schuchardt
Provide a man-page for the size command. Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
2021-04-20doc: usage: add usage details for reset cmdIgor Opaniuk
Add usage details for reset command. Signed-off-by: Igor Opaniuk <igor.opaniuk@foundries.io>
2021-04-17doc: fatinfo man-pageHeinrich Schuchardt
Provide a man-page for the fatinfo command. Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
2021-04-10doc: mmc man-pageJaehoon Chung
Provide a man-pages for the mmc command. Signed-off-by: Jaehoon Chung <jh80.chung@samsung.com>
2021-03-29Merge tag 'v2021.04-rc5' into nextTom Rini
Prepare v2021.04-rc5
2021-03-27x86: Add a command to display coreboot sysinfoSimon Glass
This information is interesting to look at and can be important for debugging and inspection. Add a command to display it in a helpful format. Signed-off-by: Simon Glass <sjg@chromium.org>
2021-03-26binman: doc: Add documentation to htmldocsSimon Glass
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-16doc: move README.dfu to HTML documentationHeinrich Schuchardt
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-15Merge tag 'v2021.04-rc4' into nextTom Rini
Prepare v2021.04-rc4