diff options
author | Kenny Root <kroot@google.com> | 2015-10-02 16:09:15 -0700 |
---|---|---|
committer | Kenny Root <kroot@google.com> | 2015-10-02 16:09:49 -0700 |
commit | fe7305364c3369f9222a61646c5c9842eae9bceb (patch) | |
tree | 360ada970b7bb1046ae069d253ba24d9622eb3ad /src/BUILDING.md | |
parent | 691ef9d0ff0ece39ffd6a58960a7cd195ef584ae (diff) | |
parent | b452bce3bf2034466cee6206ebf3994409468ee4 (diff) | |
download | external_boringssl-fe7305364c3369f9222a61646c5c9842eae9bceb.zip external_boringssl-fe7305364c3369f9222a61646c5c9842eae9bceb.tar.gz external_boringssl-fe7305364c3369f9222a61646c5c9842eae9bceb.tar.bz2 |
Merge mnc-dr-dev-plus-aosp into mnc-ub-dev
This pulls in the latest version of BoringSSL.
Change-Id: I0ab5c73d60f41a696c9a828fac87670aaca10dec
Diffstat (limited to 'src/BUILDING.md')
-rw-r--r-- | src/BUILDING.md | 100 |
1 files changed, 100 insertions, 0 deletions
diff --git a/src/BUILDING.md b/src/BUILDING.md new file mode 100644 index 0000000..c75851f --- /dev/null +++ b/src/BUILDING.md @@ -0,0 +1,100 @@ +# Building BoringSSL + +## Build Prerequisites + + * [CMake] [1] 2.8.8 or later is required. + + * Perl 5.6.1 or later is required. On Windows, [Strawberry Perl] [2] and MSYS + Perl have both been reported to work. If not found by CMake, it may be + configured explicitly by setting `PERL_EXECUTABLE`. + + * On Windows you currently must use [Ninja] [3] to build; on other platforms, + it is not required, but recommended, because it makes builds faster. + + * If you need to build Ninja from source, then a recent version of + [Python] [4] is required (Python 2.7.5 works). + + * On Windows only, [Yasm] [5] is required. If not found by CMake, it may be + configured explicitly by setting `CMAKE_ASM_NASM_COMPILER`. + + * A C compiler is required. On Windows, MSVC 12 (Visual Studio 2013) or later + with Platform SDK 8.1 or later are supported. Recent versions of GCC and + Clang should work on non-Windows platforms, and maybe on Windows too. + + * [Go] [6] is required. If not found by CMake, the go executable may be + configured explicitly by setting `GO_EXECUTABLE`. + +## Building + +Using Ninja (note the 'N' is capitalized in the cmake invocation): + + mkdir build + cd build + cmake -GNinja .. + ninja + +Using Make (does not work on Windows): + + mkdir build + cd build + cmake .. + make + +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. + +Note that the default build flags in the top-level `CMakeLists.txt` are for +debugging—optimisation isn't enabled. + +If you want to cross-compile then there is an example toolchain file for 32-bit +Intel in `util/`. Wipe out the build directory, recreate it and run `cmake` like +this: + + cmake -DCMAKE_TOOLCHAIN_FILE=../util/32-bit-toolchain.cmake -GNinja .. + +If you want to build as a shared library, pass `-DBUILD_SHARED_LIBS=1`. On +Windows, where functions need to be tagged with `dllimport` when coming from a +shared library, define `BORINGSSL_SHARED_LIBRARY` in any code which `#include`s +the BoringSSL headers. + +### Building for Android + +It's possible to build BoringSSL with the Android NDK using CMake. This has +been tested with version 10d of the NDK. + +Unpack the Android NDK somewhere and export `ANDROID_NDK` to point to the +directory. Clone https://github.com/taka-no-me/android-cmake into `util/`. Then +make a build directory as above and run CMake *twice* like this: + + cmake -DANDROID_NATIVE_API_LEVEL=android-9 \ + -DANDROID_ABI=armeabi-v7a \ + -DCMAKE_TOOLCHAIN_FILE=../util/android-cmake/android.toolchain.cmake \ + -DANDROID_NATIVE_API_LEVEL=16 \ + -GNinja .. + +Once you've run that twice, Ninja should produce Android-compatible binaries. +You can replace `armeabi-v7a` in the above with `arm64-v8a` to build aarch64 +binaries. + +## Known Limitations on Windows + + * Versions of CMake since 3.0.2 have a bug in its Ninja generator that causes + yasm to output warnings + + yasm: warning: can open only one input file, only the last file will be processed + + These warnings can be safely ignored. The cmake bug is + http://www.cmake.org/Bug/view.php?id=15253. + + * CMake can generate Visual Studio projects, but the generated project files + don't have steps for assembling the assembly language source files, so they + currently cannot be used to build BoringSSL. + + + [1]: http://www.cmake.org/download/ + [2]: http://strawberryperl.com/ + [3]: https://martine.github.io/ninja/ + [4]: https://www.python.org/downloads/ + [5]: http://yasm.tortall.net/ + [6]: https://golang.org/dl/ |