summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorWei Fu <wefu@redhat.com>2021-09-30 13:11:20 +0300
committerAnup Patel <anup@brainfault.org>2021-10-20 12:40:52 +0300
commit422eda499cd6b69c0ca9f4cb06b3aceef17a3b27 (patch)
tree129d2f1b1d2d6ca462cfce58c2a1b8e5b33d60b4 /README.md
parent67cbbcb100d321ec61f6424392562834083e9c98 (diff)
downloadopensbi-422eda499cd6b69c0ca9f4cb06b3aceef17a3b27.tar.xz
Makefile: Add build time and compiler info string
When we are doing opensbi development, we want to know the build time and compiler info for debug purpose. To enable this message, please add "BUILD_INFO=y", like: ``` make BUILD_INFO=y ``` NOTE: Using `BUILD_INFO=y` without specifying SOURCE_DATE_EPOCH will violate "reproducible builds". So it's ONLY for development and debug purpose, and should NOT be used in a product which follows "reproducible builds". Signed-off-by: Wei Fu <wefu@redhat.com> Reviewed-by: Anup Patel <anup.patel@wdc.com> Reviewed-by: Alistair Francis <alistair.francis@wdc.com>
Diffstat (limited to 'README.md')
-rw-r--r--README.md24
1 files changed, 24 insertions, 0 deletions
diff --git a/README.md b/README.md
index 9fdf097..54fabe4 100644
--- a/README.md
+++ b/README.md
@@ -254,6 +254,29 @@ to produce broken binaries with missing relocations; it is therefore currently
recommended that this combination be avoided or *FW_PIC=n* be used to disable
building OpenSBI as a position-independent binary.
+Building with timestamp and compiler info
+-----------------------------------------
+
+When doing development, we may want to know the build time and compiler info
+for debug purpose. OpenSBI can also be built with timestamp and compiler info.
+To build with those info and print it out at boot time, we can just simply add
+`BUILD_INFO=y`, like:
+```
+make BUILD_INFO=y
+```
+
+But if you have used `BUILD_INFO=y`, and want to switch back to `BUILD_INFO=n`,
+you must do
+```
+make clean
+```
+before the next build.
+
+NOTE: Using `BUILD_INFO=y` without specifying SOURCE_DATE_EPOCH will violate
+[reproducible builds]. This definition is ONLY for development and debug
+purpose, and should NOT be used in a product which follows "reproducible
+builds".
+
Contributing to OpenSBI
-----------------------
@@ -336,3 +359,4 @@ make I=<install_directory> install_docs
[Doxygen manual]: http://www.doxygen.nl/manual/index.html
[Kendryte standalone SDK]: https://github.com/kendryte/kendryte-standalone-sdk
[third party notices]: ThirdPartyNotices.md
+[reproducible builds]: https://reproducible-builds.org