From: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
Date: Sun, 14 Jul 2024 07:18:04 +0000 (+0200)
Subject: doc: move out-of-tree building info to HTML
X-Git-Url: http://git.dujemihanovic.xyz/contact?a=commitdiff_plain;h=c72a163e545d3f34d30c0384f1f47aa2de66f08f;p=u-boot.git

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>
---

diff --git a/README b/README
index b89768f179..b76449b70a 100644
--- a/README
+++ b/README
@@ -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:
diff --git a/doc/build/gcc.rst b/doc/build/gcc.rst
index 3c64657727..d8fcfdc4bf 100644
--- a/doc/build/gcc.rst
+++ b/doc/build/gcc.rst
@@ -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
 ~~~~~~~~~~~~~~~~