aboutsummaryrefslogtreecommitdiff
path: root/BUILDING.md
diff options
context:
space:
mode:
authorDavid Benjamin <davidben@google.com>2024-01-16 17:07:50 -0500
committerBoringssl LUCI CQ <boringssl-scoped@luci-project-accounts.iam.gserviceaccount.com>2024-01-16 23:09:23 +0000
commitb96e8166f35ec679cb5afe94ea4581a373f25f66 (patch)
treecbd06dc2f0c08d6dda6f09b15a33bc495c34913b /BUILDING.md
parent3c88240d2c5a19be36a9980936006a0f5ee4ab76 (diff)
downloadboringssl-b96e8166f35ec679cb5afe94ea4581a373f25f66.zip
boringssl-b96e8166f35ec679cb5afe94ea4581a373f25f66.tar.gz
boringssl-b96e8166f35ec679cb5afe94ea4581a373f25f66.tar.bz2
Make the debug vs release build note in BUILDING.md more prominent
Change-Id: I3549fb623db267df5956c9412d758749abd2a4dc Reviewed-on: https://boringssl-review.googlesource.com/c/boringssl/+/65468 Commit-Queue: Bob Beck <bbe@google.com> Auto-Submit: David Benjamin <davidben@google.com> Reviewed-by: Bob Beck <bbe@google.com>
Diffstat (limited to 'BUILDING.md')
-rw-r--r--BUILDING.md15
1 files changed, 9 insertions, 6 deletions
diff --git a/BUILDING.md b/BUILDING.md
index e81b755..fb28e89 100644
--- a/BUILDING.md
+++ b/BUILDING.md
@@ -60,13 +60,12 @@ Using Make (does not work on Windows):
cmake -B build
make -C build
-You usually don't need to run `cmake` again after changing `CMakeLists.txt`
-files because the build scripts will detect changes to them and rebuild
-themselves automatically.
+This produces a debug build by default. Optimisation isn't enabled, and debug
+assertions are included. Pass `-DCMAKE_BUILD_TYPE=Release` to `cmake` to
+configure a release build:
-Note that the default build flags in the top-level `CMakeLists.txt` are for
-debugging—optimisation isn't enabled. Pass `-DCMAKE_BUILD_TYPE=Release` to
-`cmake` to configure a release build.
+ cmake -GNinja -B build -DCMAKE_BUILD_TYPE=Release
+ ninja -C build
If you want to cross-compile then there is an example toolchain file for 32-bit
Intel in `util/`. Wipe out the build directory, run `cmake` like this:
@@ -85,6 +84,10 @@ remove some code that is especially large.
See [CMake's documentation](https://cmake.org/cmake/help/v3.4/manual/cmake-variables.7.html)
for other variables which may be used to configure the build.
+You usually don't need to run `cmake` again after changing `CMakeLists.txt`
+files because the build scripts will detect changes to them and rebuild
+themselves automatically.
+
### Building for Android
It's possible to build BoringSSL with the Android NDK using CMake. Recent