-In addition to the classical cmake configuration variables, SimGrid
-accepts several options, as listed below.
-
- @li <b>CMAKE_INSTALL_PREFIX</b> (path): Where to install SimGrid
- (e.g. /usr/local or /opt).
-
- @li <b>enable_compile_optimizations</b> (ON/OFF): request the
- compiler to produce efficient code. You want to activate it,
- unless you want to debug SimGrid itself (as efficient code may
- be appear mangled to the debuggers).
-
- @li <b>enable_debug</b> (ON/OFF): disable this if simulation speed
- really matters to you. All log messages of gravity debug or
- below will be discarded at compilation time. Since there is
- quite a bunch of such log messages in SimGrid itself, this can
- reveal faster than discarding them at runtime as usually. But of
- course, it is then impossible to get any debug message from
- SimGrid if something goes wrong.
-
- @li <b>enable_msg_deprecated</b> (ON/OFF): enable this option if
- your code used a feature of Simgrid that was dropped or modified
- in recent releases of SimGrid. You should update your code if
- possible, but with this option, SimGrid will try to emulate its
- old behavior.
-
- @li <b>enable_model-checking</b> (ON/OFF): Only enable this if you
- actually plan to use the model-checking aspect of SimGrid. This
- mode of execution is still under heavy work, but it should be
- rather usable now. Be <b>warned</b> that this option will hinder
- your simulation speed even if you simulate without activating
- the model-checker. We are working on improving this situation.
-
- @li <b>enable_compile_warnings</b> (ON/OFF): request the compiler to
- issue error message whenever the source code is not perfectly
- clean. If you develop SimGrid itself, you must activate it to
- ensure the code quality, but as a user, that option will only
- bring you issues.
-
- @li <b>enable_maintainer_mode</b> (ON/OFF): you only need to set
- this option if you modify very specific parts of SimGrid itself
- (the XML parsers and other related elements). Adds an extra
- dependency on flex and flexml.
-
- @li <b>enable_tracing</b> (ON/OFF): disable this if you have issues
- with the tracing module. But this module is now very stable and
- you really should try to enjoy this beauty.
-
- @li <b>enable_smpi</b> (ON/OFF): disable this if you have issues
- with the module allowing to run MPI code on top of SimGrid. This
- module very stable, but if you really don't need it, you can
- disable it.
-
- @li <b>enable_mallocators</b> (ON/OFF): disable this when tracking
- memory issues within SimGrid, or the caching mechanism used
- internally will fool the debuggers.
-
- @li <b>enable_jedule</b> (ON/OFF): enable this to get SimDag
- producing traces that can then be visualized with the Jedule
- external tool.
-
- @li <b>enable_lua</b> (ON/OFF): enable this if you want to enjoy the
- lua bindings of SimGrid. Adds an extra dependency on lua library
+In addition to the classical cmake configuration variables, SimGrid accepts several options, as listed below.
+
+ @li <b>CMAKE_INSTALL_PREFIX</b> (path): Where to install SimGrid (/opt/simgrid, /usr/local, or elsewhere).
+
+ @li <b>enable_compile_optimizations</b> (ON/OFF) to request the compiler to produce efficient code. You want to
+ activate it, unless you plan to debug SimGrid itself. Indeed, efficient code may be appear mangled to debuggers.
+
+ @li <b>enable_compile_warnings</b> (ON/OFF) to request the compiler to issue error messages whenever the source code
+ is not perfectly clean. If you are a SimGrid developer, you have to activate this option to enforce the code
+ quality. As a regular user, this option is likely to bring you issues only.
+
+ @li <b>enable_debug</b> (ON/OFF) allows to discard all log messages of gravity debug or below at compile time, if
+ simulation speed matters. As there is quite a bunch of such log messages in SimGrid internals, this can reveal
+ faster than discarding them at runtime as usual. However, it obviously becomes impossible to get any debug
+ message from SimGrid if something goes wrong.
+
+ @li <b>enable_documentation</b> (ON/OFF) to generate the documentation pages.
+
+ @li <b>enable_java</b> (ON/OFF) to enjoy the java bindings of SimGrid.
+
+ @li <b>enable_jedule</b> (ON/OFF) to get SimDag producing execution traces that can then be visualized with the
+ Jedule external tool.
+
+ @li <b>enable_lua</b> (ON/OFF) to enjoy the lua bindings of SimGrid. It adds an extra dependency on the lua library