summaryrefslogtreecommitdiff
path: root/doc/develop
AgeCommit message (Collapse)Author
2021-04-06dm: core: Document the common error codesSimon Glass
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 <[email protected]> Reviewed-by: Sean Anderson <[email protected]>
2021-03-29Merge tag 'v2021.04-rc5' into nextTom Rini
Prepare v2021.04-rc5
2021-03-26Merge tag 'dm-pull-26mar21-take2' of git://git.denx.de/u-boot-dm into nextTom Rini
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
2021-03-26binman: Update various pieces of the documentationSimon Glass
A few sections are a little out of date now. Update them. Signed-off-by: Simon Glass <[email protected]>
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 <[email protected]>
2021-03-26doc: Move driver model docs under develop/Simon Glass
These docs are useful for developers, not users. Move them under that section. Suggested-by: Heinrich Schuchardt <[email protected]> Signed-off-by: Simon Glass <[email protected]>
2021-03-26doc: Move UEFI under develop/Simon Glass
Much of the content here is useful only for development. Move it under that section. Signed-off-by: Simon Glass <[email protected]> Reviewed-by: Heinrich Schuchardt <[email protected]>
2021-03-12log: Add return-checking macros for 0 being successSimon Glass
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 <[email protected]>
2021-03-12log: Handle line continuationSimon Glass
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 <[email protected]>
2021-03-12doc: Explain briefly how to write new testsSimon Glass
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 <[email protected]>
2021-03-12test: sandbox: Move sandbox test docs into doc/developSimon Glass
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 <[email protected]>
2021-03-12doc: Document how sandbox_spl_tests are runSimon Glass
Add a few notes about the sandbox_spl tests, since they are special. Signed-off-by: Simon Glass <[email protected]> Acked-by: Pratyush Yadav <[email protected]>
2021-03-12doc: Explain how to run tests without pytestSimon Glass
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 <[email protected]>
2021-03-12doc: Document make tcheckSimon Glass
Add a comment about this option in the documentation. Also mention the script that runs these combinations. Signed-off-by: Simon Glass <[email protected]> Reviewed-by: Heinrich Schuchardt <[email protected]>
2021-03-12doc: Tidy up testing sectionSimon Glass
Tweak this so the output looks a little better. Signed-off-by: Simon Glass <[email protected]> Reviewed-by: Heinrich Schuchardt <[email protected]>
2021-02-28uboot-test-hooks: Switch to our GitLab instanceTom Rini
As Stephen is no longer actively maintaining the uboot-test-hooks repository, switch to using the instance on our GitLab. Acked-by: Stephen Warren <[email protected]> Signed-off-by: Tom Rini <[email protected]>
2021-02-06Makefile: Provide numeric versionsSimon Glass
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 <[email protected]> Reviewed-by: Bin Meng <[email protected]>
2021-02-06README: Add doumentation for version informationSimon Glass
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 <[email protected]> Reviewed-by: Bin Meng <[email protected]>
2021-01-27doc: fix doc/develop/logging.rstHeinrich Schuchardt
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 <[email protected]>
2021-01-23doc: move README.menu to HTML documentationHeinrich Schuchardt
Convert README.menu to reStructured text and add it to the HTML documentation. Signed-off-by: Heinrich Schuchardt <[email protected]>
2021-01-23doc: move test/py/README.md to HTML documentationHeinrich Schuchardt
Convert test/py/README.md to restructured text and add it to the generated HTML documentation. Signed-off-by: Heinrich Schuchardt <[email protected]> Reviewed-by: Simon Glass <[email protected]>
2021-01-23doc: move test/README to HTML documentationHeinrich Schuchardt
Move test/README to the 'Develop U-Boot' chapter of the HTML documentation. Signed-off-by: Heinrich Schuchardt <[email protected]> Reviewed-by: Simon Glass <[email protected]>
2021-01-23doc: structure doc/develop/index.rstHeinrich Schuchardt
Provide sub-chapters for 'Develop U-Boot' Signed-off-by: Heinrich Schuchardt <[email protected]> Reviewed-by: Simon Glass <[email protected]>
2020-12-15doc: move README.trace to HTML documentationHeinrich Schuchardt
Convert README.trace to reStructured text and move it to develop/trace.rst. Signed-off-by: Heinrich Schuchardt <[email protected]> Reviewed-by: Simon Glass <[email protected]>
2020-12-15doc: move README.commands to HTML docHeinrich Schuchardt
Reformat README.commands as reStructured text and add it to the HTML documentation as develop/commands.rst. Signed-off-by: Heinrich Schuchardt <[email protected]> Reviewed-by: Simon Glass <[email protected]>
2020-12-15doc: global data pointer on x86, x86_64Heinrich Schuchardt
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 <[email protected]> Reviewed-by: Simon Glass <[email protected]>
2020-10-30doc: Update logging documentationSean Anderson
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 <[email protected]> Reviewed-by: Simon Glass <[email protected]>
2020-10-30doc: Add log kerneldocs to documentationSean Anderson
The functions in log.h are already mostly documented, so add them to the generated documentation. Signed-off-by: Sean Anderson <[email protected]> Reviewed-by: Simon Glass <[email protected]>
2020-10-27log: allow for message continuationHeinrich Schuchardt
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 <[email protected]> Reviewed-by: Simon Glass <[email protected]>
2020-10-22log: Tidy up documentationSimon Glass
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 <[email protected]>
2020-10-14doc: global data pointerHeinrich Schuchardt
Add the description of the global data pointer to the generated HTML documentation. Signed-off-by: Heinrich Schuchardt <[email protected]> Reviewed-by: Simon Glass <[email protected]>
2020-07-17doc: correct description of crash dumpsHeinrich Schuchardt
Correct the description of the ESR register. Fix a typo. Signed-off-by: Heinrich Schuchardt <[email protected]>
2020-07-17doc: Coccinelle: move to HTML docHeinrich Schuchardt
Move doc/README.coccinelle to doc/develop/coccinelle.rst using the current linux-next version of the text. Signed-off-by: Heinrich Schuchardt <[email protected]>
2020-06-11doc: move README.log to HTML documentationHeinrich Schuchardt
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 <[email protected]> Reviewed-by: Simon Glass <[email protected]>
2020-05-01doc: describe the analysis of crash dumpsHeinrich Schuchardt
Provide an overview of the analysis of U-Boot crash dumps. Signed-off-by: Heinrich Schuchardt <[email protected]> Acked-by: Ilias Apalodimas <[email protected]>