Document how to build shared libs with CMake

Also updated
https://tls.mbed.org/kb/compiling-and-building/how-do-i-build-compile-mbedtls

closes #267
This commit is contained in:
Manuel Pégourié-Gonnard 2015-09-01 10:08:28 +02:00
parent d68434efba
commit c881ca8502

View File

@ -89,13 +89,24 @@ CMake
In order to build the source using CMake, just enter at the command line:: In order to build the source using CMake, just enter at the command line::
cmake . cmake .
make make
In order to run the tests, enter::
make test
The test suites need Perl to be built. If you don't have Perl installed, you'll want to disable the test suites with:: The test suites need Perl to be built. If you don't have Perl installed, you'll want to disable the test suites with::
cmake -DENABLE_TESTING=Off . cmake -DENABLE_TESTING=Off .
If you disabled the test suites, but kept the programs enabled, you can still run a much smaller set of tests with::
programs/test/selftest
To configure CMake for building a shared library, use::
cmake -DUSE_SHARED_MBEDTLS_LIBRARY=On .
There are many different build modes available within the CMake buildsystem. Most of them are available for gcc and clang, though some are compiler-specific: There are many different build modes available within the CMake buildsystem. Most of them are available for gcc and clang, though some are compiler-specific:
- Release. - Release.
@ -121,23 +132,19 @@ There are many different build modes available within the CMake buildsystem. Mos
This activates the compiler warnings that depend on optimization and treats This activates the compiler warnings that depend on optimization and treats
all warnings as errors. all warnings as errors.
Switching build modes in CMake is simple. For debug mode, enter at the command line: Switching build modes in CMake is simple. For debug mode, enter at the command line::
cmake -D CMAKE_BUILD_TYPE:String="Debug" . cmake -D CMAKE_BUILD_TYPE=Debug .
To list other available CMake options, use::
cmake -LH
Note that, with CMake, if you want to change the compiler or its options after you already ran CMake, you need to clear its cache first, eg (using GNU find):: Note that, with CMake, if you want to change the compiler or its options after you already ran CMake, you need to clear its cache first, eg (using GNU find)::
find . -iname '*cmake*' -not -name CMakeLists.txt -exec rm -rf {} + find . -iname '*cmake*' -not -name CMakeLists.txt -exec rm -rf {} +
CC=gcc CFLAGS='-fstack-protector-strong -Wa,--noexecstack' cmake . CC=gcc CFLAGS='-fstack-protector-strong -Wa,--noexecstack' cmake .
In order to run the tests, enter::
make test
If you disabled the test suites, but kept the progams enabled, you can still run a much smaller set of tests with::
programs/test/selftest
Microsoft Visual Studio Microsoft Visual Studio
----------------------- -----------------------