summaryrefslogtreecommitdiffstats
path: root/doc/index.rst
Commit message (Collapse)AuthorAgeFilesLines
* cmd: Add command to display or save Linux PStore dumpsFrédéric Danis2020-10-141-0/+7
| | | | | | | | | | | | | | | | | | | | | | | | | This patch adds a new pstore command allowing to display or save ramoops logs (oops, panic, console, ftrace and user) generated by a previous kernel crash. PStore parameters can be set in U-Boot configuration file, or at run-time using "pstore set" command. Records size should be the same as the ones used by kernel, and should be a power of 2. This command allows: - to display uncompressed logs - to save compressed or uncompressed logs, compressed logs are saved as a compressed stream, it may need some work to be able to decompress it, e.g. adding a fake header: "printf "\x1f\x8b\x08\x00\x00\x00\x00\x00\x00\x00" | cat - dmesg-ramoops-0.enc.z | gzip -dc" - ECC part is not used to check memory corruption - only 1st FTrace log is displayed or saved Signed-off-by: Frédéric Danis <frederic.danis@collabora.com> [trini: Minor updates for current design, correct spacing in rST] Signed-off-by: Tom Rini <trini@konsulko.com> Cc: Heinrich Schuchardt <xypron.glpk@gmx.de> Cc: Wolfgang Denk <wd@denx.de> Cc: Heiko Schocher <hs@denx.de>
* doc: describe the analysis of crash dumpsHeinrich Schuchardt2020-05-011-0/+11
| | | | | | | Provide an overview of the analysis of U-Boot crash dumps. Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de> Acked-by: Ilias Apalodimas <ilias.apalodimas@linaro.org>
* doc: android: Convert to Sphinx formatSam Protsenko2020-02-041-0/+12
| | | | | | | | | | | | | | Convert Android documentation from regular txt format to Sphinx (RST). Also add Android index.rst file and reference it in root index.rst, so that Android documentation is visible. Test: $ make htmldocs $ xdg-open doc/output/index.html Signed-off-by: Sam Protsenko <joe.skb7@gmail.com> Signed-off-by: Lokesh Vutla <lokeshvutla@ti.com>
* doc: Add documentation for how to build U-Boot host toolsBin Meng2019-10-281-0/+11
| | | | | | | This adds a reST document for how to build U-Boot host tools, including information for both Linux and Windows. Signed-off-by: Bin Meng <bmeng.cn@gmail.com>
* doc: integrate UEFI documentation into Sphinx toctreeHeinrich Schuchardt2019-07-301-0/+13
| | | | | | | | | Change the UEFI documentation to Sphinx style and integrate it into the rest of the Sphinx generated documentation. Remove the inaccurate TODO list in doc/uefi/uefi.rst. Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
* doc: Add board specific info to Sphinx TOC treeBin Meng2019-07-241-0/+11
| | | | | | | Add index.rst for board. More docs will be added later. Signed-off-by: Bin Meng <bmeng.cn@gmail.com> Reviewed-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
* doc: Add architecture specific info to Sphinx TOC treeBin Meng2019-07-241-0/+11
| | | | | | | | Add index.rst for architecture specific info. More docs will be added later. Signed-off-by: Bin Meng <bmeng.cn@gmail.com> Reviewed-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
* doc: Add driver-model to Sphinx TOC treeBin Meng2019-07-241-0/+11
| | | | | | | Add index.rst for driver model. More docs will be added later. Signed-off-by: Bin Meng <bmeng.cn@gmail.com> Reviewed-by: Heinrich Schuchardt <xypron.glkpk@gmx.de>
* doc: Add top-level description about U-Boot documentationBin Meng2019-07-241-3/+19
| | | | | | | | | This updates the index.rst to add top-level description about U-Boot documentation. Words are taken from Linux kernel docs and modified for U-Boot. Signed-off-by: Bin Meng <bmeng.cn@gmail.com> Reviewed-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
* doc: Move existing rst files into api sub-directoryBin Meng2019-07-241-3/+11
| | | | | | | | | Currently the Sphinx doc only contains API descriptions of several U-Boot subsystems. For future extension, group these existing docs into an API sub-directory. Signed-off-by: Bin Meng <bmeng.cn@gmail.com> Reviewed-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
* doc: Remove duplicated documentation directoryBreno Matheus Lima2019-06-201-0/+11
Commit ad7061ed742e ("doc: Move device tree bindings documentation to doc/device-tree-bindings") moved all device tree binding documentation to doc/device-tree-bindings directory. The current U-Boot project still have two documentation directories: - doc/ - Documentation/ Move all documentation and sphinx files to doc directory so all content can be in a common place. Signed-off-by: Breno Lima <breno.lima@nxp.com>