summaryrefslogtreecommitdiff
path: root/doc/build
AgeCommit message (Collapse)Author
2025-11-15docker: Correct the linux/arm64 platform stringBin Meng
The Dockerfile is using linux/arm64 without the /v8 suffix. Signed-off-by: Bin Meng <[email protected]> Reviewed-by: Heinrich Schuchardt <[email protected]>
2025-09-27doc: build: documentation: add description of KDOC_WERRORE Shattow
Describe KDOC_WERROR and recommend when building documentation for a patch submission. Signed-off-by: E Shattow <[email protected]>
2025-08-30doc: Capitalize the word Buildman whenever it's used as a proper nounAdriano Carvalho
This consistency reads a bit nicer. Signed-off-by: Adriano Carvalho <[email protected]>
2025-08-30doc: Fix obvious typos and minor improvementsAdriano Carvalho
These are fixes to what looks like obvious typos. Some minor improvments are also included, such as: - Write "symbolic link" instead of symlink - Correct capitalization for LLVM (all caps) - Remove dead link and surrounding sentence Signed-off-by: Adriano Carvalho <[email protected]>
2025-06-07doc: build: fix typo in gcc.rstBehradElmi
Fix a typo error in gcc.rst, changing "out-out-tree" to "out-of-tree" in the Out-of-tree section. Signed-off-by: BehradElmi <[email protected]> Reviewed-by: Heinrich Schuchardt <[email protected]>
2025-05-09Dockerfile: use lz4 instead of lz4-toolsHeinrich Schuchardt
Since Ubuntu Jammy lz4-tools is only a virtual package which pulls in lz4 as dependency. Update documentation too. Signed-off-by: Heinrich Schuchardt <[email protected]> Reviewed-by: Tom Rini <[email protected]>
2025-04-24python: Use and refer to the venv module rather than virtualenvTom Rini
Using some form of sandbox with Python modules is a long standing best practice with the language. There are a number of ways to have a Python sandbox be created. At this point in time, it seems the Python community is moving towards using the "venv" module provided with Python rather than a separate tool. To match that we make the following changes: - Refer to a "Python sandbox" rather than virtualenv in comments, etc. - Install the python3-venv module in our container and not virtualenv. - In our CI files, invoke "python -m venv" rather than "virtualenv". - In documentation, tell users to install python3-venv and not virtualenv. Signed-off-by: Tom Rini <[email protected]>
2025-04-03doc: build: docker: Use code-block for syntax highlightingLeonard Anderweit
Use ..code-block:: syntax highlighting instead of :: so all bash commands use the same syntax highlighting. Signed-off-by: Leonard Anderweit <[email protected]> Reviewed-by: Quentin Schulz <[email protected]>
2025-04-03doc: build: docker: Fix code highlighting syntaxLeonard Anderweit
Remove double :: before .. code-block:: bash to correctly highlight the following commands. Signed-off-by: Leonard Anderweit <[email protected]> Reviewed-by: Quentin Schulz <[email protected]>
2024-12-21doc: Expand what we say about building the docker container a bitTom Rini
First, try and be slightly clearer about what "buildx" is with respect to the docker build process. Second, now that we build the container for both amd64 and arm64, we should document how to make a docker "builder" that has multiple nodes. With this one node should be amd64 and one node arm64, and with reasonably fast arm64 hardware this will be much quicker than using QEMU. Signed-off-by: Tom Rini <[email protected]> Reviewed-by: Simon Glass <[email protected]>
2024-12-02docker: Support building for multiple architecturesSimon Glass
Add instructions on how to build the file for multiple architectures. Add a message indicating what is happening. Update the documentation as well. Signed-off-by: Simon Glass <[email protected]> Reviewed-by: Tom Rini <[email protected]>
2024-07-19doc: move out-of-tree building info to HTMLHeinrich Schuchardt
Move the information about out-of-tree building from README to the generated HTML documentation. Signed-off-by: Heinrich Schuchardt <[email protected]> Reviewed-by: Simon Glass <[email protected]>
2024-04-13doc: build: fix gen_compile_commands section levelMattijs Korpershoek
The 2 subsections of this page ("Compatible IDEs" and "Usage") are using the same header level as the title (with "==="). Because of this, they always appear in the HTML rendered ToC. Drop the subsections one level lower by replacing "=" by "-". This fixes the HTML rendering. Signed-off-by: Mattijs Korpershoek <[email protected]> Reviewed-by: Heinrich Schuchardt <[email protected]>
2024-04-13doc: build: update docker image to latestMattijs Korpershoek
commit cacc0b2678c0 ("CI: Move to latest container image") updated the docker container image. Reflect the change in the documentation. Signed-off-by: Mattijs Korpershoek <[email protected]> Reviewed-by: Heinrich Schuchardt <[email protected]> Reviewed-by: Tom Rini <[email protected]>
2023-12-18Merge tag 'v2024.01-rc5' into nextTom Rini
Prepare v2024.01-rc5
2023-12-13doc: Update documentation URLSimon Glass
Update to use the new docs.u-boot.org URL for documentation. Signed-off-by: Simon Glass <[email protected]>
2023-12-05doc: clang: Update and correct support notesTom Rini
At this point, clang can be used on both 32bit and 64bit targets without issue. Make note of logic we have that will inform clang of the architecture to build for. Signed-off-by: Tom Rini <[email protected]> Reviewed-by: Heinrich Schuchardt <[email protected]>
2023-11-11doc: build: fix wrongly written targests instead of targetsMilan P. Stanić
Signed-off-by: Milan P. Stanić <[email protected]> Reviewed-by: Simon Glass <[email protected]> Reviewed-by: Heinrich Schuchardt <[email protected]>
2023-11-11doc: shorten overlong title underlinesHeinrich Schuchardt
Title underlines should match the length of the title. Unfortunately docutils only catches underlines that are too short. Add some missing empty lines after titles. Signed-off-by: Heinrich Schuchardt <[email protected]>
2023-10-26doc: build: update description of build dependencies for Alpine LinuxMilan P. Stanić
Signed-off-by: Milan P. Stanić <[email protected]> Reviewed-by: Simon Glass <[email protected]> Reformat and keep ncurses-dev needed for 'make menuconfig' Signed-off-by: Heinrich Schuchardt <[email protected]>
2023-10-11doc: add documentation for gen_compile_commands.pyJoao Marcos Costa
This documentation briefly explains what is a compilation database, and how to use the script to generate one. This is not a portage, as there was no original documentation in the Linux sources. Acknowledge the documentation in the script's header and in doc/build index. Signed-off-by: Joao Marcos Costa <[email protected]> Tested-by: Joao Paulo Goncalves <[email protected]>
2023-09-22Allow Python packages to be droppedSimon Glass
When building in a portage chroot, we do not have the environment needed to build pylibfdt. It is instead build as a separate package. Provide a build option to tell U-Boot to skip this part of the build. We still need it to use binman, etc. but don't need it to build its dependencies. Signed-off-by: Simon Glass <[email protected]> Reviewed-by: Mike Frysinger <[email protected]> [s/build bytes/builds bytes in tools.rst] Signed-off-by: Bin Meng <[email protected]>
2023-08-23doc: Explicitly list build dependencies for docsPaul Barker
Highlight the packages which need to be installed in order to build the docs. Signed-off-by: Paul Barker <[email protected]>
2023-06-01doc: Add info for building Xen target with ClangLeo Yan
When build Xen target with Clang, the linker reports failure. This patch adds the related info in the documentation as a known issue and gives details for how to dismiss the building failure with Clang. Signed-off-by: Leo Yan <[email protected]>
2023-04-08doc: mention usage of .readthedocs.ymlHeinrich Schuchardt
Mention that HTML pages are published at https://u-boot.readthedocs.io/ and that the file .readthedocs.yml controls the build process. Signed-off-by: Heinrich Schuchardt <[email protected]> Reviewed-by: Simon Glass <[email protected]>
2023-03-08buildman: Add a flag for reproducible buildsSimon Glass
This is quite a useful thing to use when building since it avoids small size changes between commits. Add a -r flag for it. Also undefine CONFIG_LOCALVERSION_AUTO since this appends the git hash to the version string, causing every build to be slightly different. Signed-off-by: Simon Glass <[email protected]>
2023-01-27doc: move 'Reproducible builds'Heinrich Schuchardt
Move the README section to the HTML documentation. Signed-off-by: Heinrich Schuchardt <[email protected]> Reviewed-by: Tom Rini <[email protected]> Reviewed-by: Simon Glass <[email protected]>
2023-01-09Merge branch 'next'Tom Rini
Signed-off-by: Tom Rini <[email protected]>
2023-01-04doc: building documentationHeinrich Schuchardt
Provide a man-page describing how to build the U-Boot documentation. Signed-off-by: Heinrich Schuchardt <[email protected]>
2022-12-05sandbox: Rework how SDL is enabled / disabledTom Rini
Given that we can use Kconfig logic directly to see if we have a program available on the host or not, change from passing NO_SDL to instead controlling CONFIG_SANDBOX_SDL in Kconfig directly. Introduce CONFIG_HOST_HAS_SDL as the way to test for sdl2-config and default CONFIG_SANDBOX_SDL on if we have that, or not. Cc: Simon Glass <[email protected]> Signed-off-by: Tom Rini <[email protected]> Reviewed-by: Simon Glass <[email protected]>
2022-11-22buildman: Convert documentation to rSTSimon Glass
Convert the buildman documentation to rST format and include it in the 'build' section. Signed-off-by: Simon Glass <[email protected]> Reviewed-by: Quentin Schulz <[email protected]>
2022-10-10doc: add python3-filelock python3-pytest-xdistHeinrich Schuchardt
Packages python3-filelock python3-pytest-xdist as required to run 'make tests'. Add them to the required packages list in the documentation. Signed-off-by: Heinrich Schuchardt <[email protected]> Reviewed-by: Simon Glass <[email protected]>
2022-09-02Makefile: Allow LTO to be disabled for a buildSimon Glass
LTO (Link-Time Optimisation) is an very useful feature which can significantly reduce the size of U-Boot binaries. So far it has been made available for selected ARM boards and sandbox. However, incremental builds are much slower when LTO is used. For example, an incremental build of sandbox takes 2.1 seconds on my machine, but 6.7 seconds with LTO enabled. Add a NO_LTO parameter to the build, similar to NO_SDL, so it can be disabled during development if needed, for faster builds. Add some documentation about LTO while we are here. Signed-off-by: Simon Glass <[email protected]>
2022-07-18doc: add package uuid-dev to build dependenciesHeinrich Schuchardt
Building mkeficapsule requires include uuid/uuid.h Signed-off-by: Heinrich Schuchardt <[email protected]>
2022-05-28doc/build/gcc: add more required packagesHeinrich Schuchardt
The following Python packages are used by U-Boot, too: * python3-asteval * python3-subunit * python3-testtools Signed-off-by: Heinrich Schuchardt <[email protected]>
2022-03-12doc: add libgnutls28-dev to build dependenciesHeinrich Schuchardt
mkeficapsule requires package libgnutls28-dev for building Signed-off-by: Heinrich Schuchardt <[email protected]>
2022-01-19doc: fix description of build dependencies for Alpine LinuxHeinrich Schuchardt
Signed-off-by: Heinrich Schuchardt <[email protected]>
2022-01-15doc: Building on Alpine LinuxHeinrich Schuchardt
Describe the required packages for building U-Boot on Alpine Linux Signed-off-by: Heinrich Schuchardt <[email protected]>
2021-10-21doc: add python3-pkg-resources to build dependenciesHeinrich Schuchardt
tools/binman/control.py imports Python package pkg_resources. Signed-off-by: Heinrich Schuchardt <[email protected]> Reviewed-by: Simon Glass <[email protected]>
2021-10-19Makefile: Only build dtc if neededSimon Glass
At present U-Boot always builds dtc if CONFIG_OF_CONTROL is defined, even when DTC is provided. The built dtc is not actually used, so this is a waste of time. Update the Makefile logic to build dtc only if one is not provided to the build with the DTC variable. Add documentation to explain this. This saves about 3.5 seconds of elapsed time on a clean build of sandbox_spl for me. Signed-off-by: Simon Glass <[email protected]>
2021-08-14doc: add pkg-config to the build dependenciesHeinrich Schuchardt
tools/Makefile uses pkg-config. Signed-off-by: Heinrich Schuchardt <[email protected]>
2021-08-01doc: add graphviz imagemagick as build dependenciesHeinrich Schuchardt
'make htmldocs' requires graphviz and imagemagick (at least with Sphinx 3.5.4). Signed-off-by: Heinrich Schuchardt <[email protected]>
2021-07-28doc: sandbox: Fix up dependenciesSimon Glass
These are out of date. Update them and point to the existing build instructions to avoid duplication. Add a few that are missing. Signed-off-by: Simon Glass <[email protected]>
2021-04-07tools: Integrate the Dockerfile used for CITom Rini
Integrate the Dockerfile from https://source.denx.de/u-boot/gitlab-ci-runner.git as of commit bc6130d572f1 ("Dockerfile: Remove high UID/GID") and introduce a short rST on how to build the container. Cc: Heinrich Schuchardt <[email protected]> Signed-off-by: Tom Rini <[email protected]>
2021-02-28Correct U-Boot upstream repositoryHeinrich Schuchardt
The U-Boot source moves to https://source.denx.de/u-boot/u-boot.git effective 2021-02-28. Signed-off-by: Heinrich Schuchardt <[email protected]>
2020-12-15doc/build/gcc.rst: required packages for SUSEHeinrich Schuchardt
Describe the packages required to build U-Boot on SUSE. Signed-off-by: Heinrich Schuchardt <[email protected]>
2020-09-22doc/build/gcc.rst: add missing apt-get *install*Heinrich Schuchardt
The install command is missing for an apt-get command. Signed-off-by: Heinrich Schuchardt <[email protected]>
2020-09-12doc: describe building with GCCHeinrich Schuchardt
Provide a description of the U-Boot build process with GCC in the HTML documentation. Signed-off-by: Heinrich Schuchardt <[email protected]>
2020-09-12doc: describe source repositoryHeinrich Schuchardt
Add a chapter to the HTML documentation describing how to retrieve the U-Boot sources. Signed-off-by: Heinrich Schuchardt <[email protected]>
2020-08-04doc: move Clang documentation to HTMLHeinrich Schuchardt
* Move README.clang to doc/build/clang.rst and reformat as reStructeredText. * Indicate that -ffixed-r9 and -ffixed-x18 are used to reserve registers for gd. * Minor editing. Signed-off-by: Heinrich Schuchardt <[email protected]>