doc: move 'Reproducible builds'

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>
This commit is contained in:
Heinrich Schuchardt 2023-01-25 19:15:00 +01:00
parent 0c4759fbfd
commit 2042365acf
3 changed files with 26 additions and 11 deletions

11
README
View file

@ -1713,17 +1713,6 @@ This firmware often needs to be loaded during U-Boot booting.
- CONFIG_SYS_MC_RSV_MEM_ALIGN - CONFIG_SYS_MC_RSV_MEM_ALIGN
Define alignment of reserved memory MC requires Define alignment of reserved memory MC requires
Reproducible builds
-------------------
In order to achieve reproducible builds, timestamps used in the U-Boot build
process have to be set to a fixed value.
This is done using the SOURCE_DATE_EPOCH environment variable.
SOURCE_DATE_EPOCH is to be set on the build host's shell, not as a configuration
option for U-Boot or an environment variable in U-Boot.
SOURCE_DATE_EPOCH should be set to a number of seconds since the epoch, in UTC.
Building the Software: Building the Software:
====================== ======================

1
doc/build/index.rst vendored
View file

@ -9,6 +9,7 @@ Build U-Boot
source source
gcc gcc
clang clang
reproducible
docker docker
tools tools
buildman buildman

25
doc/build/reproducible.rst vendored Normal file
View file

@ -0,0 +1,25 @@
Reproducible builds
===================
In order to achieve reproducible builds, timestamps used in the U-Boot build
process have to be set to a fixed value.
This is done using the SOURCE_DATE_EPOCH environment variable which specifies
the number of seconds since 1970-01-01T00:00:00Z.
Example
-------
To build the sandbox with 2023-01-01T00:00:00Z as timestamp we can use:
.. code-block:: bash
make sandbox_defconfig
SOURCE_DATE_EPOCH=1672531200 make
This date is shown when we launch U-Boot:
.. code-block:: console
./u-boot -T
U-Boot 2023.01 (Jan 01 2023 - 00:00:00 +0000)