summaryrefslogtreecommitdiff
path: root/doc/build
AgeCommit message (Collapse)AuthorFilesLines
2024-07-19doc: move out-of-tree building info to HTMLHeinrich Schuchardt1-0/+28
Move the information about out-of-tree building from README to the generated HTML documentation. Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com> Reviewed-by: Simon Glass <sjg@chromium.org>
2024-04-13doc: build: fix gen_compile_commands section levelMattijs Korpershoek1-2/+2
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 <mkorpershoek@baylibre.com> Reviewed-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
2024-04-13doc: build: update docker image to latestMattijs Korpershoek1-1/+1
commit cacc0b2678c0 ("CI: Move to latest container image") updated the docker container image. Reflect the change in the documentation. Signed-off-by: Mattijs Korpershoek <mkorpershoek@baylibre.com> Reviewed-by: Heinrich Schuchardt <xypron.glpk@gmx.de> Reviewed-by: Tom Rini <trini@konsulko.com>
2023-12-18Merge tag 'v2024.01-rc5' into nextTom Rini1-12/+10
Prepare v2024.01-rc5
2023-12-13doc: Update documentation URLSimon Glass1-1/+1
Update to use the new docs.u-boot.org URL for documentation. Signed-off-by: Simon Glass <sjg@chromium.org>
2023-12-05doc: clang: Update and correct support notesTom Rini1-12/+10
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 <trini@konsulko.com> Reviewed-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
2023-11-11doc: build: fix wrongly written targests instead of targetsMilan P. Stanić1-1/+1
Signed-off-by: Milan P. Stanić <mps@arvanta.net> Reviewed-by: Simon Glass <sjg@chromium.org> Reviewed-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
2023-11-11doc: shorten overlong title underlinesHeinrich Schuchardt1-1/+1
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 <heinrich.schuchardt@canonical.com>
2023-10-26doc: build: update description of build dependencies for Alpine LinuxMilan P. Stanić1-2/+8
Signed-off-by: Milan P. Stanić <mps@arvanta.net> Reviewed-by: Simon Glass <sjg@chromium.org> Reformat and keep ncurses-dev needed for 'make menuconfig' Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
2023-10-11doc: add documentation for gen_compile_commands.pyJoao Marcos Costa2-0/+84
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 <jmcosta944@gmail.com> Tested-by: Joao Paulo Goncalves <joao.goncalves@toradex.com>
2023-09-22Allow Python packages to be droppedSimon Glass1-0/+9
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 <sjg@chromium.org> Reviewed-by: Mike Frysinger <vapier@chromium.org> [s/build bytes/builds bytes in tools.rst] Signed-off-by: Bin Meng <bmeng.cn@gmail.com>
2023-08-23doc: Explicitly list build dependencies for docsPaul Barker1-0/+11
Highlight the packages which need to be installed in order to build the docs. Signed-off-by: Paul Barker <paul.barker.ct@bp.renesas.com>
2023-06-01doc: Add info for building Xen target with ClangLeo Yan1-0/+36
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 <leo.yan@linaro.org>
2023-04-08doc: mention usage of .readthedocs.ymlHeinrich Schuchardt1-0/+3
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 <heinrich.schuchardt@canonical.com> Reviewed-by: Simon Glass <sjg@chromium.org>
2023-03-08buildman: Add a flag for reproducible buildsSimon Glass1-0/+2
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 <sjg@chromium.org>
2023-01-27doc: move 'Reproducible builds'Heinrich Schuchardt2-0/+26
Move the README section to the HTML documentation. Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com> Reviewed-by: Tom Rini <trini@konsulko.com> Reviewed-by: Simon Glass <sjg@chromium.org>
2023-01-09Merge branch 'next'Tom Rini1-1/+1
Signed-off-by: Tom Rini <trini@konsulko.com>
2023-01-04doc: building documentationHeinrich Schuchardt2-0/+91
Provide a man-page describing how to build the U-Boot documentation. Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
2022-12-05sandbox: Rework how SDL is enabled / disabledTom Rini1-1/+1
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 <sjg@chromium.org> Signed-off-by: Tom Rini <trini@konsulko.com> Reviewed-by: Simon Glass <sjg@chromium.org>
2022-11-22buildman: Convert documentation to rSTSimon Glass2-0/+2
Convert the buildman documentation to rST format and include it in the 'build' section. Signed-off-by: Simon Glass <sjg@chromium.org> Reviewed-by: Quentin Schulz <foss+uboot@0leil.net>
2022-10-10doc: add python3-filelock python3-pytest-xdistHeinrich Schuchardt1-3/+4
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 <heinrich.schuchardt@canonical.com> Reviewed-by: Simon Glass <sjg@chromium.org>
2022-09-02Makefile: Allow LTO to be disabled for a buildSimon Glass1-0/+17
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 <sjg@chromium.org>
2022-07-18doc: add package uuid-dev to build dependenciesHeinrich Schuchardt1-1/+1
Building mkeficapsule requires include uuid/uuid.h Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
2022-05-28doc/build/gcc: add more required packagesHeinrich Schuchardt1-4/+4
The following Python packages are used by U-Boot, too: * python3-asteval * python3-subunit * python3-testtools Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
2022-03-12doc: add libgnutls28-dev to build dependenciesHeinrich Schuchardt1-5/+6
mkeficapsule requires package libgnutls28-dev for building Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
2022-01-19doc: fix description of build dependencies for Alpine LinuxHeinrich Schuchardt1-1/+1
Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
2022-01-15doc: Building on Alpine LinuxHeinrich Schuchardt1-0/+10
Describe the required packages for building U-Boot on Alpine Linux Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
2021-10-21doc: add python3-pkg-resources to build dependenciesHeinrich Schuchardt1-3/+3
tools/binman/control.py imports Python package pkg_resources. Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com> Reviewed-by: Simon Glass <sjg@chromium.org>
2021-10-19Makefile: Only build dtc if neededSimon Glass1-0/+21
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 <sjg@chromium.org>
2021-08-14doc: add pkg-config to the build dependenciesHeinrich Schuchardt1-2/+2
tools/Makefile uses pkg-config. Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
2021-08-01doc: add graphviz imagemagick as build dependenciesHeinrich Schuchardt1-3/+3
'make htmldocs' requires graphviz and imagemagick (at least with Sphinx 3.5.4). Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
2021-07-28doc: sandbox: Fix up dependenciesSimon Glass1-2/+4
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 <sjg@chromium.org>
2021-04-07tools: Integrate the Dockerfile used for CITom Rini2-0/+15
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 <xypron.glpk@gmx.de> Signed-off-by: Tom Rini <trini@konsulko.com>
2021-02-28Correct U-Boot upstream repositoryHeinrich Schuchardt1-1/+1
The U-Boot source moves to https://source.denx.de/u-boot/u-boot.git effective 2021-02-28. Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
2020-12-15doc/build/gcc.rst: required packages for SUSEHeinrich Schuchardt1-0/+20
Describe the packages required to build U-Boot on SUSE. Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
2020-09-22doc/build/gcc.rst: add missing apt-get *install*Heinrich Schuchardt1-1/+1
The install command is missing for an apt-get command. Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
2020-09-12doc: describe building with GCCHeinrich Schuchardt2-0/+120
Provide a description of the U-Boot build process with GCC in the HTML documentation. Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
2020-09-12doc: describe source repositoryHeinrich Schuchardt2-0/+31
Add a chapter to the HTML documentation describing how to retrieve the U-Boot sources. Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
2020-08-04doc: move Clang documentation to HTMLHeinrich Schuchardt2-0/+77
* 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 <xypron.glpk@gmx.de>
2019-10-28doc: Add documentation for how to build U-Boot host toolsBin Meng2-0/+56
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>
generated by cgit v1.2.3 (git 2.25.1) at 2024-11-30 23:14:34 +0000