summaryrefslogtreecommitdiffstats
path: root/doc/develop
Commit message (Collapse)AuthorAgeFilesLines
* doc: develop: Convert README.virtio to reSTBin Meng2021-05-102-0/+288
| | | | | | | This converts the existing README.virtio to reST, and puts it under the develop/driver-model/ directory. Signed-off-by: Bin Meng <bmeng.cn@gmail.com>
* doc: Add build instructions for OP-TEE backed EFI variablesIlias Apalodimas2021-04-101-1/+57
| | | | | | | | Since that invlolves external projects and not only U-Boot, add guidance for supported platforms Signed-off-by: Ilias Apalodimas <ilias.apalodimas@linaro.org> Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
* doc: Update uefi documentation for initrd loading optionsIlias Apalodimas2021-04-101-1/+21
| | | | | | | Document the command line options for efidebug and initrd loading Signed-off-by: Ilias Apalodimas <ilias.apalodimas@linaro.org> Rewiewed-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
* dm: core: Document the common error codesSimon Glass2021-04-061-0/+133
| | | | | | | | | Driver model uses quite strong conventions on error codes, but these are currently not clearly documented. Add a description of the commonly used errors. Signed-off-by: Simon Glass <sjg@chromium.org> Reviewed-by: Sean Anderson <seanga2@gmail.com>
* Merge tag 'v2021.04-rc5' into nextTom Rini2021-03-291-0/+8
|\ | | | | | | Prepare v2021.04-rc5
* \ Merge tag 'dm-pull-26mar21-take2' of git://git.denx.de/u-boot-dm into nextTom Rini2021-03-2626-0/+5795
|\ \ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | dtoc support for of-platdata-inst driver model support for of-platdata-inst support of-platdata-inst on x86 / coral binman support for exapanded entries binman convert docs to reST ti-sysc fix for duplicate uclass driver patman minor improvements pylibfdt build only if needed correct obscure CI error with OF_PLATDATA_INST
| * | binman: Update various pieces of the documentationSimon Glass2021-03-261-0/+1
| | | | | | | | | | | | | | | | | | A few sections are a little out of date now. Update them. Signed-off-by: Simon Glass <sjg@chromium.org>
| * | binman: doc: Add documentation to htmldocsSimon Glass2021-03-263-0/+28
| | | | | | | | | | | | | | | | | | | | | | | | 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>
| * | doc: Move driver model docs under develop/Simon Glass2021-03-2619-0/+4833
| | | | | | | | | | | | | | | | | | | | | | | | These docs are useful for developers, not users. Move them under that section. Suggested-by: Heinrich Schuchardt <xypron.glpk@gmx.de> Signed-off-by: Simon Glass <sjg@chromium.org>
| * | doc: Move UEFI under develop/Simon Glass2021-03-265-0/+933
|/ / | | | | | | | | | | | | | | Much of the content here is useful only for development. Move it under that section. Signed-off-by: Simon Glass <sjg@chromium.org> Reviewed-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
* | log: Add return-checking macros for 0 being successSimon Glass2021-03-121-1/+14
| | | | | | | | | | | | | | | | The existing log_ret() and log_msg_ret() macros consider an error to be less than zero. But some function may return a positive number to indicate a different kind of failure. Add macros to check for that also. Signed-off-by: Simon Glass <sjg@chromium.org>
* | log: Handle line continuationSimon Glass2021-03-121-0/+16
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | When multiple log() calls are used which don't end in newline, the log prefix is prepended multiple times in the same line. This makes the output look strange. Fix this by detecting when the previous log record did not end in newline. In that case, setting a flag. Drop the unused BUFFSIZE in the test while we are here. As an example implementation, update log_console to check the flag and produce the expected output. Signed-off-by: Simon Glass <sjg@chromium.org>
* | doc: Explain briefly how to write new testsSimon Glass2021-03-125-1/+358
| | | | | | | | | | | | | | | | Add a second on writing tests, covering when to use Python and C, where to put the tests, etc. Add a link to the existing Python test documentation. Signed-off-by: Simon Glass <sjg@chromium.org>
* | test: sandbox: Move sandbox test docs into doc/developSimon Glass2021-03-121-2/+42
| | | | | | | | | | | | | | | | | | | | | | | | At present some of the documentation about running sandbox tests is in the sandbox docs. It makes more sense to put it in with the other testing docs, with a link there from sandbox. Update the documentation accordingly. Also add a paragraph explaining why sandbox exists and the test philosophy that it uses. Signed-off-by: Simon Glass <sjg@chromium.org>
* | doc: Document how sandbox_spl_tests are runSimon Glass2021-03-122-0/+87
| | | | | | | | | | | | | | Add a few notes about the sandbox_spl tests, since they are special. Signed-off-by: Simon Glass <sjg@chromium.org> Acked-by: Pratyush Yadav <p.yadav@ti.com>
* | doc: Explain how to run tests without pytestSimon Glass2021-03-123-0/+90
| | | | | | | | | | | | | | | | | | Add details about how to run a sandbox test directly, without using pytest. This is more convenient for rapid development, since it is faster and allows easier use of a debugger. Also mention sandbox_flattree as an example of the different sandbox builds available. Signed-off-by: Simon Glass <sjg@chromium.org>
* | doc: Document make tcheckSimon Glass2021-03-121-1/+11
| | | | | | | | | | | | | | | | Add a comment about this option in the documentation. Also mention the script that runs these combinations. Signed-off-by: Simon Glass <sjg@chromium.org> Reviewed-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
* | doc: Tidy up testing sectionSimon Glass2021-03-121-8/+12
|/ | | | | | | Tweak this so the output looks a little better. Signed-off-by: Simon Glass <sjg@chromium.org> Reviewed-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
* uboot-test-hooks: Switch to our GitLab instanceTom Rini2021-02-281-1/+1
| | | | | | | | As Stephen is no longer actively maintaining the uboot-test-hooks repository, switch to using the instance on our GitLab. Acked-by: Stephen Warren <swarren@wwwdotorg.org> Signed-off-by: Tom Rini <trini@konsulko.com>
* Makefile: Provide numeric versionsSimon Glass2021-02-061-0/+8
| | | | | | | | | For SMBIOS we want to store the numeric version numbers in the tables. It does not make sense to parse the strings. Instead, add new #defines with the version and patchlevel. Signed-off-by: Simon Glass <sjg@chromium.org> Reviewed-by: Bin Meng <bmeng.cn@gmail.com>
* README: Add doumentation for version informationSimon Glass2021-02-062-0/+94
| | | | | | | | There are quite a few available version options in U-Boot. Add a list of the available Makefile variables and #defines, along with examples. Signed-off-by: Simon Glass <sjg@chromium.org> Reviewed-by: Bin Meng <bmeng.cn@gmail.com>
* doc: fix doc/develop/logging.rstHeinrich Schuchardt2021-01-271-10/+3
| | | | | | | | | | Sphinx 3 builds fail due to doc/develop/logging.rst producing duplicate labels. Include logging.h only once in the API section and use cross-references for the enums log_level_t and log_category_t. Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
* doc: move README.menu to HTML documentationHeinrich Schuchardt2021-01-232-0/+132
| | | | | | | Convert README.menu to reStructured text and add it to the HTML documentation. Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
* doc: move test/py/README.md to HTML documentationHeinrich Schuchardt2021-01-232-0/+427
| | | | | | | | Convert test/py/README.md to restructured text and add it to the generated HTML documentation. Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de> Reviewed-by: Simon Glass <sjg@chromium.org>
* doc: move test/README to HTML documentationHeinrich Schuchardt2021-01-232-0/+97
| | | | | | | Move test/README to the 'Develop U-Boot' chapter of the HTML documentation. Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de> Reviewed-by: Simon Glass <sjg@chromium.org>
* doc: structure doc/develop/index.rstHeinrich Schuchardt2021-01-231-3/+19
| | | | | | | Provide sub-chapters for 'Develop U-Boot' Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de> Reviewed-by: Simon Glass <sjg@chromium.org>
* doc: move README.trace to HTML documentationHeinrich Schuchardt2020-12-152-0/+356
| | | | | | | Convert README.trace to reStructured text and move it to develop/trace.rst. Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de> Reviewed-by: Simon Glass <sjg@chromium.org>
* doc: move README.commands to HTML docHeinrich Schuchardt2020-12-152-0/+227
| | | | | | | | Reformat README.commands as reStructured text and add it to the HTML documentation as develop/commands.rst. Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de> Reviewed-by: Simon Glass <sjg@chromium.org>
* doc: global data pointer on x86, x86_64Heinrich Schuchardt2020-12-151-1/+3
| | | | | | | | On x86 the global data pointer is stored in register fs. On x86_64 no register is used for the global data pointer. Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de> Reviewed-by: Simon Glass <sjg@chromium.org>
* doc: Update logging documentationSean Anderson2020-10-301-114/+107
| | | | | | | | | This updates logging documentation with some examples of the new commands added in the previous commits. It also removes some items from the to-do list which have been implemented. Signed-off-by: Sean Anderson <seanga2@gmail.com> Reviewed-by: Simon Glass <sjg@chromium.org>
* doc: Add log kerneldocs to documentationSean Anderson2020-10-301-0/+5
| | | | | | | | The functions in log.h are already mostly documented, so add them to the generated documentation. Signed-off-by: Sean Anderson <seanga2@gmail.com> Reviewed-by: Simon Glass <sjg@chromium.org>
* log: allow for message continuationHeinrich Schuchardt2020-10-271-0/+6
| | | | | | | | | | | | | | | | Some drivers use macro pr_cont() for continuing a message sent via printk. Hence if we want to convert printk messaging to using the logging system, we must support continuation of log messages too. As pr_cont() does not provide a message level we need a means of remembering the last log level. With the patch a pseudo log level LOGL_CONT as well as a pseudo log category LOGC_CONT are introduced. Using these results in the application of the same log level and category as in the previous log message. Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de> Reviewed-by: Simon Glass <sjg@chromium.org>
* log: Tidy up documentationSimon Glass2020-10-221-5/+8
| | | | | | | | | Fix up the documentation which was lost in a merge conflict in the conversion to RST. Fixes: 52d3df7fefe ("log: Allow LOG_DEBUG to always enable log output") Signed-off-by: Simon Glass <sjg@chromium.org>
* doc: global data pointerHeinrich Schuchardt2020-10-142-0/+54
| | | | | | | | Add the description of the global data pointer to the generated HTML documentation. Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de> Reviewed-by: Simon Glass <sjg@chromium.org>
* doc: correct description of crash dumpsHeinrich Schuchardt2020-07-171-3/+5
| | | | | | | | Correct the description of the ESR register. Fix a typo. Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
* doc: Coccinelle: move to HTML docHeinrich Schuchardt2020-07-172-0/+506
| | | | | | | Move doc/README.coccinelle to doc/develop/coccinelle.rst using the current linux-next version of the text. Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
* doc: move README.log to HTML documentationHeinrich Schuchardt2020-06-112-0/+291
| | | | | | | | | | Convert README.log to reStructuredText and add it to the generated HTML documentation. Assign doc/develop/logging.rst to the maintainer of LOGGING. Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de> Reviewed-by: Simon Glass <sjg@chromium.org>
* doc: describe the analysis of crash dumpsHeinrich Schuchardt2020-05-012-0/+132
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>
generated by cgit (git 2.34.1) at 2025-08-29 06:53:10 +0000