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>
diff --git a/BUILDING.md b/BUILDING.md
index e81b755..fb28e89 100644
--- a/BUILDING.md
+++ b/BUILDING.md
@@ -60,13 +60,12 @@
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 @@
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
