doc: move out-of-tree building info to HTML

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>
This commit is contained in:
Heinrich Schuchardt 2024-07-14 09:18:04 +02:00
parent 5c1b5e6bc5
commit c72a163e54
2 changed files with 28 additions and 20 deletions

20
README
View file

@ -1684,26 +1684,6 @@ images ready for download to / installation on your system:
- "u-boot" is an image in ELF binary format
- "u-boot.srec" is in Motorola S-Record format
By default the build is performed locally and the objects are saved
in the source directory. One of the two methods can be used to change
this behavior and build U-Boot to some external directory:
1. Add O= to the make command line invocations:
make O=/tmp/build distclean
make O=/tmp/build NAME_defconfig
make O=/tmp/build all
2. Set environment variable KBUILD_OUTPUT to point to the desired location:
export KBUILD_OUTPUT=/tmp/build
make distclean
make NAME_defconfig
make all
Note that the command line "O=" setting overrides the KBUILD_OUTPUT environment
variable.
User specific CPPFLAGS, AFLAGS and CFLAGS can be passed to the compiler by
setting the according environment variables KCPPFLAGS, KAFLAGS and KCFLAGS.
For example to treat all compiler warnings as errors:

28
doc/build/gcc.rst vendored
View file

@ -118,6 +118,34 @@ Assuming cross compiling on Debian for ARMv8 this would be
CROSS_COMPILE=aarch64-linux-gnu- make
Out-of-tree building
~~~~~~~~~~~~~~~~~~~~
By default building is performed locally and the objects are saved in the source
directory. To build out-out-tree use one of the two methods below:
Add O= parameter to the make command line:
.. code-block:: bash
make O=/tmp/build distclean
make O=/tmp/build NAME_defconfig
make O=/tmp/build
Use environment variable KBUILD_OUTPUT:
.. code-block:: bash
export KBUILD_OUTPUT=/tmp/build
make distclean
make NAME_defconfig
make
.. note::
The command line "O=" parameter overrides the KBUILD_OUTPUT environment
variable.
Build parameters
~~~~~~~~~~~~~~~~