diff options
| author | Andreas Schneider <asn@cryptomilk.org> | 2015-02-10 08:23:25 +0100 |
|---|---|---|
| committer | Andreas Schneider <asn@cryptomilk.org> | 2015-02-10 15:49:30 +0100 |
| commit | 08860c880dddc65e26efd515214b1ab1e3ad25dd (patch) | |
| tree | b37343fb7f7e9519a57cb3c1795aa14bec06b223 /doc | |
| parent | 4132396b15da65bd3b6d5a756a78ac57217bbb2d (diff) | |
| download | cmocka-08860c880dddc65e26efd515214b1ab1e3ad25dd.tar.gz cmocka-08860c880dddc65e26efd515214b1ab1e3ad25dd.tar.bz2 cmocka-08860c880dddc65e26efd515214b1ab1e3ad25dd.zip | |
cmocka: Allow include of cmocka_platform.h
Signed-off-by: Andreas Schneider <asn@cryptomilk.org>
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/mainpage.dox | 12 |
1 files changed, 12 insertions, 0 deletions
diff --git a/doc/mainpage.dox b/doc/mainpage.dox index 5d658e0..925bfd2 100644 --- a/doc/mainpage.dox +++ b/doc/mainpage.dox @@ -83,6 +83,18 @@ the mock object to return. CMocka provides and API to easily mock code. <a href="https://lwn.net/Articles/558106/">Learn more ...</a> +@section main-embedded Embedded platforms + +It is possible that some embedded platforms do not provide definitions for +required types or that the guards to protect them are not defined. To address +this issue you can create a header file name 'cmocka_platform.h' with the +required types and definitions. After that point cmake to the include directory +using: + +<pre> + cmake -DCMOCKA_PLATFORM_INCLUDE=/home/compiler/my/include_directory .. +</pre> + @section main-threads Threading cmocka is not fully thread safe and it is not the goal of it to be it. We have |