Commit 61caf1ab by Marcus Winter

updated and fixed documentation

parent 696bc68d
...@@ -179,6 +179,11 @@ Similarly, automatic initialization of the task scheduler by the MTAPI C++ ...@@ -179,6 +179,11 @@ Similarly, automatic initialization of the task scheduler by the MTAPI C++
interface can be disabled with -DUSE_AUTOMATIC_INITIALIZATION=OFF. This way, interface can be disabled with -DUSE_AUTOMATIC_INITIALIZATION=OFF. This way,
unexpected delays after startup can be avoided, e.g. for timing measurements. unexpected delays after startup can be avoided, e.g. for timing measurements.
Furthermore, EMB² can be built to work with threading analysis tools such as
Helgrind or ThreadSanitizer.
To enable support for them use -DTHREADING_ANALYSIS_MODE=ON. This uses mutexes
around atomics to avoid false positives and degrades performance significantly.
The tutorial of EMB² comes with example source files in doc/examples/. These The tutorial of EMB² comes with example source files in doc/examples/. These
can be built with the other source files using CMake option -DBUILD_EXAMPLES=ON can be built with the other source files using CMake option -DBUILD_EXAMPLES=ON
in the generation step. Note, however, that the examples use C++11 features and in the generation step. Note, however, that the examples use C++11 features and
......
...@@ -133,7 +133,7 @@ EMBB_DEFINE_AND_ASSIGN(4, "") ...@@ -133,7 +133,7 @@ EMBB_DEFINE_AND_ASSIGN(4, "")
/* /*
* Now, using the basic functions above, we generate the respective functions * Now, using the basic functions above, we generate the respective functions
* for all basic data types, like "unsigned short". For that purpose, the * for all basic data types, like "unsigned short". For that purpose, the
* following generator macro is used. This macro is calleuild-work-Desktop-Defaultd by the macros in the * following generator macro is used. This macro is called by the macros in the
* generator header, defining the implementation for the basic data types. * generator header, defining the implementation for the basic data types.
* *
* For unsigned short and for and_assign.h, the following method would be * For unsigned short and for and_assign.h, the following method would be
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or sign in to comment