summaryrefslogtreecommitdiff
path: root/doc/develop
AgeCommit message (Collapse)Author
2022-10-03Prepare v2022.10v2022.10Tom Rini
Signed-off-by: Tom Rini <[email protected]>
2022-09-19Prepare v2022.10-rc5v2022.10-rc5Tom Rini
Signed-off-by: Tom Rini <[email protected]>
2022-09-05Prepare v2022.10-rc4v2022.10-rc4Tom Rini
Signed-off-by: Tom Rini <[email protected]>
2022-09-01doc: process, sending_patches: Update and correct the old "Patches" contentTom Rini
- Use gender-neutral language to refer to the user, consistently. - Reference the checkpatch document. - Move the section on commit message tags to the process document and reference this in sending_patches.rst. - Reword the custodian workflow process section to refer to this new section, integrate some of the wording from there in this new section. - Update the comment about GPLv2 applying to August 2022, to be clear this still is correct. - Reword the section about MAKEALL to talk about local build testing and link to the CI document. - Reference the system_configuration document for the note about modifying existing code. - Reword the patchwork flow section. Cc: Heinrich Schuchardt <[email protected]> Signed-off-by: Tom Rini <[email protected]>
2022-09-01doc: sending_patches.rst: Incorporate the old "Patches" wiki contentTom Rini
Import as-is much of the old "Patches" wiki page to the current sending_patches.rst file. This means we need to move patman to being included in the higher level ToC and add a reference for "Custodians" in the process document. A very minimal amount of content changing and rewording is done here as part of the import, in order to make the conversion easier. Cc: Heinrich Schuchardt <[email protected]> Signed-off-by: Tom Rini <[email protected]> Reviewed-by: Simon Glass <[email protected]>
2022-08-26Rename disto_[pxe_]getfile to distro_[pxe_]getfileDario Binacchi
Replace 'disto' with 'distro' since they are all functions about distro booting. Signed-off-by: Dario Binacchi <[email protected]>
2022-08-22Prepare v2022.10-rc3v2022.10-rc3Tom Rini
Signed-off-by: Tom Rini <[email protected]>
2022-08-20doc: dm: clarify activation.Michal Suchanek
Explain when devices should get activated. Signed-off-by: Michal Suchanek <[email protected]> Reviewed-by: Simon Glass <[email protected]> Reviewed-by: Heinrich Schuchardt <[email protected]>
2022-08-13patman: Add documentation to doc/Simon Glass
Link to patman's documentation from the doc/ directory so that it appears in the 'make htmldocs' output. Signed-off-by: Simon Glass <[email protected]> Signed-off-by: Heinrich Schuchardt <[email protected]>
2022-08-13doc: Drop a reference to TravisSimon Glass
This was widely used by U-Boot for a long time, but is not used anymore, with Gitlab and Azure taking over. Drop the text. Signed-off-by: Simon Glass <[email protected]> Reviewed-by: Heinrich Schuchardt <[email protected]>
2022-08-13doc: develop: Add a note about importing code from other projectsTom Rini
We talk about importing code from other projects in two places. The first place is in the coding style section, where we explain when to or not to deviate in terms of white space, etc. In the process documentation we now add a note about saying where the code was imported from and to ensure that you do not copy Signed-off-by or other tags. Signed-off-by: Tom Rini <[email protected]> Acked-by: Sudeep Holla <[email protected]> Reviewed-by: Heinrich Schuchardt <[email protected]> Signed-off-by: Heinrich Schuchardt <[email protected]>
2022-08-13doc: crash_dumps.rst missing documentation linkHeinrich Schuchardt
Add link to usage/cmd/exception.rst. Signed-off-by: Heinrich Schuchardt <[email protected]>
2022-08-13doc: add more details for crash dump analysisHeinrich Schuchardt
* describe crashs in UEFI binaries * provide architechture specific information for the sandbox and RISC-V Signed-off-by: Heinrich Schuchardt <[email protected]>
2022-08-13bootstd: doc: Fix typosPaul Barker
These typos were found while reading the docs. Signed-off-by: Paul Barker <[email protected]> Reviewed-by: Simon Glass <[email protected]> Reviewed-by: Heinrich Schuchardt <[email protected]>
2022-08-12bootstd: Update documentationSimon Glass
Add some documentation updates, particularly about global bootmeths. Signed-off-by: Simon Glass <[email protected]>
2022-08-12dm: core: Prepare for updating the device tree with ofnodeSimon Glass
Add some documentation and a new flag so that we can safely enabled using the ofnode interface to write to the device tree. Signed-off-by: Simon Glass <[email protected]>
2022-08-12dm: core: Introduce support for multiple treesSimon Glass
At present ofnode only works with a single device tree, for the most part. This is the control FDT used by U-Boot. When booting an OS we may obtain a different device tree and want to modify it. Add some initial support for this into the ofnode API. Note that we don't permit aliases in this other device tree, since the of_access implementation maintains a list of aliases collected at start-up. Also, we don't need aliases to do fixups in the other FDT. So make sure that flat tree and live tree processing are consistent in this area. Signed-off-by: Simon Glass <[email protected]>
2022-08-12dm: core: Add a note about how livetree updates workSimon Glass
The unflattening algorithm results in a single block of memory being allocated for the whole tree. When writing new properties, these are allocated new memory outside that block. When the block is freed, the allocated properties remain. Document how this works and the potential memory leak, as well as mentioning that updating the livetree is actually supported now. Signed-off-by: Simon Glass <[email protected]>
2022-08-12vbe: Add some documentationSimon Glass
Add a few links to documents about Verified Boot for Embedded (VBE). These will be expanded as development proceeds. Signed-off-by: Simon Glass <[email protected]>
2022-08-08Prepare v2022.10-rc2v2022.10-rc2Tom Rini
Signed-off-by: Tom Rini <[email protected]>
2022-08-05Revert "Revert "global: Remove CONFIG_SYS_EXTRA_OPTIONS support""Simon Glass
This is not needed now that CONFIG_SYS_TARGET_NAME is correctly determined when scanning Kconfig. This reverts commit 25b8acee2ea11a9edc100c42a61f5d6187eb6167. Signed-off-by: Simon Glass <[email protected]> Suggested-by: Tom Rini <[email protected]> Reviewed-by: Tom Rini <[email protected]>
2022-07-29doc: develop: Describe system configurationTom Rini
Start by describing in general the best practices for how to implement configuration of some aspect of U-Boot. This generally means finding the right choices for when something should be static or dynamically configured and enabled. Then further document when to use CONFIG or CFG namespaces for static configuration. Signed-off-by: Tom Rini <[email protected]> Reviewed-by: Heinrich Schuchardt <[email protected]> Signed-off-by: Heinrich Schuchardt <[email protected]>
2022-07-26log: force DEBUG when LOG_DEBUG is activatedPatrick Delaunay
When CONFIG_LOG is activated, if LOG_DEBUG is defined in a file and DEBUG is not defined the trace with debug() macro are not displayed, because the parameter cond : _DEBUG = 0 is checked in debug_cond(). With this patch the define DEBUG, used to force the trace generated by debug() macro, is linked with the define LOG_DEBUG, used to force the trace generated by other macros (log_debug, dev_dbg, pr_debug). We only need to define LOG_DEBUG in a file to activate all the traces generated by any U-Boot debug macro, as it is described in /doc/develop/logging.rst Signed-off-by: Patrick Delaunay <[email protected]>
2022-07-25Prepare v2022.10-rc1v2022.10-rc1Tom Rini
Signed-off-by: Tom Rini <[email protected]>
2022-07-18doc: typo 'formatted' in codingstyle.rstHeinrich Schuchardt
%s/formatted/format/ Fixes: 4211fb2ef6dd ("doc: Migrate CodingStyle wiki page to Sphinx") Signed-off-by: Heinrich Schuchardt <[email protected]> Reviewed-by: Tom Rini <[email protected]>
2022-07-14doc: Add in the historical release statistics found on the wikiTom Rini
The wiki had gitdm-generated release statistics starting with v1.3.0. Re-generate this information as Sphinx. This aims to be as historically accurate as possible and so some company renames were kept to their old rather than current name until we had made the switch previously. Signed-off-by: Tom Rini <[email protected]>
2022-07-14doc: process: Correct and expand slightly on the Merge Window conceptTom Rini
For quite a long time we've been using a 3 week, rather than 2 week, merge window as it was only 2 weeks during the timeframe where we did 2 month rather than 3 month releases. This corrects the places that still had 2 weeks and tries to make things a bit clearer overall. Cc: Heinrich Schuchardt <[email protected]> Signed-off-by: Tom Rini <[email protected]>
2022-07-14doc: Add doc/develop/release_cycle.rstTom Rini
Migrate the RelaseCycle wiki page to Sphinx. In terms of visible changes, we stop having a dynamic countdown to when the release is. And we drop the year-based statistics, that were not being kept up to date. For the moment, we only link to statistics for v2022.07 but will add back the historical data in a subsequent patch. Cc: Heinrich Schuchardt <[email protected]> Signed-off-by: Tom Rini <[email protected]>
2022-07-14process.rst: Modernize the "Workflow of a Custodian" sectionTom Rini
The "Workflow of a Custodian" section on the wiki had not been changed in quite some time to reflect how the process has been functioning for some time. First, update some links to point to modern and current sources of information. Second, and more overarching, reword much of the section. This expands on the expectations of both custodians and developers when it comes to rebasing patches. Rework the final points to be clearer that Custodians are expected to do their best to test the changes and ask for help when needed, as well as that pull requests are expected in a timely manner. Cc: Claudius Heine <[email protected]> Cc: Martin Bonner <[email protected]> Cc: Heinrich Schuchardt <[email protected]> Signed-off-by: Tom Rini <[email protected]>
2022-07-14process.rst: Perform minor cleanupsTom Rini
- Use gender-neutral language to refer to the user, consistently. - Reword a few places so that they read more naturally. - Make the long standing practice around "Twilight Time" more clear, hopefully. - Replace a reference to MAKEALL with a reference to CI testing as that's the current requirement. Cc: Claudius Heine <[email protected]> Cc: Martin Bonner <[email protected]> Cc: Heinrich Schuchardt <[email protected]> Signed-off-by: Tom Rini <[email protected]>
2022-07-14designprinciples.rst: Perform minor cleanupsTom Rini
- Remove some missed wiki markup, and escape a "\n" correctly. - Use gender-neutral language to refer to the user, consistently. Cc: Claudius Heine <[email protected]> Cc: Heinrich Schuchardt <[email protected]> Signed-off-by: Tom Rini <[email protected]>
2022-07-14doc: Migrate Process wiki page to SphinxTom Rini
Move the current Process wiki page to doc/develop/process.rst. The changes here are for formatting or slight rewording so that it reads well when linking to other Sphinx documents. Cc: Heinrich Schuchardt <[email protected]> Signed-off-by: Tom Rini <[email protected]>
2022-07-14doc: codingstyle: Remove comment about '//' style commentsTom Rini
For some time now we've allowed for '//' style comments, which mirrors the Linux kernel. So drop this point here. Cc: Heinrich Schuchardt <[email protected]> Signed-off-by: Tom Rini <[email protected]>
2022-07-14doc: Migrate DesignPrinciples wiki page to SphinxTom Rini
Move the current DesignPrinciples wiki page to doc/develop/designprinciples.rst. The changes here are for formatting or slight rewording so that it reads well when linking to other Sphinx documents. Cc: Heinrich Schuchardt <[email protected]> Signed-off-by: Tom Rini <[email protected]>
2022-07-14doc: Migrate CodingStyle wiki page to SphinxTom Rini
Move the current CodingStyle wiki page to doc/develop/codingstyle.rst. The changes here are for formatting or slight rewording so that it reads well when linking to other Sphinx documents. Cc: Heinrich Schuchardt <[email protected]> Signed-off-by: Tom Rini <[email protected]>
2022-07-13doc: Add statistics page for v2022.07Tom Rini
Our statistics pages have always been generated by gitdm. After patching gitdm to generate an acceptable Sphinx output for tables, include that and some other basic formatting here. Cc: Heinrich Schuchardt <[email protected]> Signed-off-by: Tom Rini <[email protected]> Reviewed-by: Heinrich Schuchardt <[email protected]> Signed-off-by: Heinrich Schuchardt <[email protected]>
2022-07-08Merge tag 'dm-pull-28jun22' of ↵Tom Rini
https://source.denx.de/u-boot/custodians/u-boot-dm into next nman external-symbol improvements Driver model memory-usage reporting patman test-reporting improvements Add bloblist design goals
2022-07-07arm: Remove PXA architecture supportTom Rini
With the last platform for this architecture removed, remove the rest of the architecture support as well. Cc: Marek Vasut <[email protected]> Signed-off-by: Tom Rini <[email protected]> Reviewed-by: Simon Glass <[email protected]>
2022-06-28bloblist: Describe the design goalsSimon Glass
Add a comment explaining the design goals of bloblist, to make it easier for people to understand and comment on the structure. Signed-off-by: Simon Glass <[email protected]>
2022-06-23linker_lists: Rename sections to remove . prefixAndrew Scull
Rename the sections used to implement linker lists so they begin with '__u_boot_list' rather than '.u_boot_list'. The double underscore at the start is still distinct from the single underscore used by the symbol names. Having a '.' in the section names conflicts with clang's ASAN instrumentation which tries to add redzones between the linker list elements, causing expected accesses to fail. However, clang doesn't try to add redzones to user sections, which are names with all alphanumeric and underscore characters. Signed-off-by: Andrew Scull <[email protected]> Reviewed-by: Simon Glass <[email protected]>
2022-06-06Convert CONFIG_SPL_SYS_MALLOC_SIMPLE to KconfigTom Rini
This converts the following to Kconfig: CONFIG_SPL_SYS_MALLOC_SIMPLE The problem here is that a few platforms have been doing: #ifdef CONFIG_SPL_BUILD #define CONFIG_SYS_MALLOC_SIMPLE #endif instead of defining CONFIG_SPL_SYS_MALLOC_SIMPLE directly. Correct this and update the documentation in a few places to match usage. Signed-off-by: Tom Rini <[email protected]>
2022-06-04EFI: Update the documentation to reflect the correct value of OsIndicationsSughosh Ganu
The OsIndications is a 64 bit variable, and the current code expects the value of the variable to be 64 bit. Update the documentation to reflect this fact. Signed-off-by: Sughosh Ganu <[email protected]> Reviewed-by: Heinrich Schuchardt <[email protected]>
2022-05-02Introduce Verifying Program Loader (VPL)Simon Glass
Add support for VPL, a new phase of U-Boot. This runs after TPL. It is responsible for selecting which SPL binary to run, based on a verified-boot process. Signed-off-by: Simon Glass <[email protected]>
2022-05-02doc: Expand SPL docs to explain the phase and configSimon Glass
Add a bit more information about how to use SPL. Signed-off-by: Simon Glass <[email protected]>
2022-05-02doc: Convert SPL documentation to ReSTSimon Glass
Move this documentation over to .rst format. Signed-off-by: Simon Glass <[email protected]>
2022-04-29doc: Correct position of gdb '--args' parameterAndrew Scull
The '--args' parameter to gdb comes before the binary that the debugger will be attached to rather than after the binary and before the arguments. Fix that in the docs. Signed-off-by: Andrew Scull <[email protected]> Cc: Simon Glass <[email protected]> Reviewed-by: Simon Glass <[email protected]>
2022-04-25nds32: Remove the architectureTom Rini
As removal of nds32 has been ack'd for the Linux kernel, remove support here as well. Cc: Rick Chen <[email protected]> Signed-off-by: Tom Rini <[email protected]> Reviewed-by: Rick Chen <[email protected]>
2022-04-25Merge branch '2022-04-25-initial-implementation-of-stdboot'Tom Rini
To quote the author: The bootflow feature provide a built-in way for U-Boot to automatically boot an Operating System without custom scripting and other customisation. This is called 'standard boot' since it provides a standard way for U-Boot to boot a distro, without scripting. It introduces the following concepts: - bootdev - a device which can hold a distro - bootmeth - a method to scan a bootdev to find bootflows (owned by U-Boot) - bootflow - a description of how to boot (owned by the distro) This series provides an implementation of these, enabled to scan for bootflows from MMC, USB and Ethernet. It supports the existing distro boot as well as the EFI loader flow (bootefi/bootmgr). It works similiarly to the existing script-based approach, but is native to U-Boot. With this we can boot on a Raspberry Pi 3 with just one command: bootflow scan -lb which means to scan, listing (-l) each bootflow and trying to boot each one (-b). The final patch shows this. With a standard way to identify boot devices, booting become easier. It also should be possible to support U-Boot scripts, for backwards compatibility only. ... The design is described in these two documents: https://drive.google.com/file/d/1ggW0KJpUOR__vBkj3l61L2dav4ZkNC12/view?usp=sharing https://drive.google.com/file/d/1kTrflO9vvGlKp-ZH_jlgb9TY3WYG6FF9/view?usp=sharing
2022-04-25bootstd: doc: Add documentationSimon Glass
Add documentation for this feature, including the commands and full devicetree bindings. Signed-off-by: Simon Glass <[email protected]>
2022-04-23dm: tag: add some documentAKASHI Takahiro
Some basic stuff about tag support is explained under doc/devlop/driver-model. Signed-off-by: AKASHI Takahiro <[email protected]> Reviewed-by: Simon Glass <[email protected]>