-/*!
-@page install Installing Simgrid
+/*! @page install Installing Simgrid
@tableofcontents
-The easiest way to install SimGrid is to go for a binary package.
-Under Debian or Ubuntu, this is very easy as SimGrid is directly
-integrated to the official repositories. Under Windows, SimGrid can be
-installed in a few clicks once you downloaded the installer from
-gforge. If you just want to use Java, simply copy the jar file on your
-disk and you're set.
-
-Recompiling an official archive is not much more complex, actually.
-SimGrid has very few dependencies and rely only on very standard
-tools. First, download the *@SimGridRelease.tar.gz* archive
-from [the download page](https://gforge.inria.fr/frs/?group_id=12).
+SimGrid should work out of the box on Linux, Mac OSX, FreeBSD, and Windows (under windows, only the Java interfaces are
+available at the moment).
+
+The easiest way to install SimGrid is to go for a @ref install_binary "binary package". Under Debian or Ubuntu, this is
+very easy as SimGrid is directly integrated to the official repositories. For other Linux variants, you probably want
+to go for a @ref install_src "source install". Please contact us if you want to contribute the build scripts for your
+preferred distribution. If you just want to use @ref install_binary_java "Java", simply copy the jar file on your disk
+and you're set.
+
+@section install_binary Pre-compiled Packages
+
+@subsection install_binary_linux Binaries for Linux
+
+Most of us use a Debian or Ubuntu system, so the packages for these
+systems are well integrated and up-to-date. To get these packages, simply type:
+
+@verbatim
+apt-get install simgrid
+@endverbatim
+
+@subsection install_binary_java Stable Java Package
+
+For the SimGrid Java bindings, grab the jar file from the [download
+page](https://gforge.inria.fr/frs/?group_id=12) and copy it in your
+classpath (typically, your source code root directory). This
+self-contained version even includes the SimGrid native components for
+the following architectures: Linux (Amd64, x86, Arm), Mac OS X 64
+bits, Windows 64 bits, FreeBSD (64 bits).
+
+@subsection install_binary_java_builder Nightly built Java Package
+
+For Windows, head to [AppVeyor](https://ci.appveyor.com/project/simgrid/simgrid).
+Click on the artefact link on the right, and grab your file. If the latest build failed, there will be no artefact. Then
+you will need to first click on "History" on the top and search for the last successful build.
+
+For non-Windows systems (Linux, Mac or FreeBSD), head to [Jenkins](https://ci.inria.fr/simgrid/job/SimGrid-Multi).
+In the build history, pick the last green (or at least yellow) build that is not blinking (i.e., not currently under
+build). In the list, pick a system that is close to yours, and click on the ball in the Debug row. The build artefact
+will appear on the top of the resulting page.
+
+@subsection install_binary_java_troubleshooting Binary Java Troubleshooting
+
+ - **Your architecture is not supported by this jarfile**. \n
+ If your system is in the list of the supported architectures (see
+ @ref install_binary_java "above"), then this is probably a bug that
+ @ref contributing_bugs "you should report".\n
+ If your system is actually not supported, you should compile your
+ own jarfile @ref install_src "by compiling SimGrid" on your
+ machine. If you feel so, @ref community_contact "contact us" so that we add
+ your architecture to the list.
+
+ - **Library not found: boost-context**.\n
+ You should obviously install the @c boost-context library on your
+ machine, for example with @c apt-get.
+
+@section install_src Source Installs
+
+@subsection install_src_deps Getting the Dependencies
+
+Recompiling an official archive is not much more complex. SimGrid only uses very standard tools:
+ - C compiler, C++ compiler, make and friends. SimGrid is rather
+ demanding on the compiler. We use the C++11 standard, and older
+ compilers tend to fail on us. It seems that g++ 5.0 or higher is
+ required nowadays (because of boost).
+ - perl (but you may try to go without it)
+ - We use cmake to configure our compilation
+ ([download page](http://www.cmake.org/cmake/resources/software.html)).
+ You need cmake version 2.8.8 or higher. You may want to use ccmake
+ for a graphical interface over cmake.
+ - boost:
+ - Debian / Ubuntu: `apt-get install libboost-dev libboost-context-dev`
+ - Max OS X: with [fink](http://www.finkproject.org/): `fink install boost1.53.nopython`,
+ or with homebrew: `brew install boost`
+ - Java (if you want to build the Java bindings):
+ - Debian / Ubuntu: `apt-get install default-jdk`
+ - Mac OS X or Windows: Grab a [full JDK](http://www.oracle.com/technetwork/java/javase/downloads)
+ - Lua (if you want to build with lua enabled):
+ - Debian / Ubuntu: `apt-get install liblua5.3-dev lua5.3`
+ - Windows: choco install lua53
+ - From the source: you need to patch the sources to build dynamic libraries
+ - [Download lua 5.3](http://www.lua.org/download.html). SimGrid
+ won't work with lua 5.2 as lua breaks the compatibility.
+ - Open the archive: `tar xvfz lua-5.3.*.tar.gz`
+ - Enter the directory: `cd lua-5.3*`
+ - Patch the sources: `patch -p1 < /path/to/simgrid/...../tools/lualib.patch`
+ - Build and install lua: `make linux && sudo make install`
+
+For platform-specific details, please see @ref install_cmake_mac,
+@ref install_cmake_windows, @ref install_java and @ref install_src_32bits
+
+@subsection install_src_fetch Getting the Sources
+
+You can download the *@SimGridRelease.tar.gz* archive from the
+[download page](https://gforge.inria.fr/frs/?group_id=12).
Then, recompiling the archive should be done in a few lines:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.sh}
make install
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-If you want to stay on the bleeding edge, you should get the latest
-git version, and recompile it as you would do for an official archive.
-Depending on the files you change in the source tree, some extra
-tools may be needed.
-
-@section install_binary Installing a binary package
-
-@subsection install_binary_linux Binary packages for linux
-
-Most of the developers use a Debian or Ubuntu system, and some of us
-happen to be Debian Maintainers, so the packages for these systems are
-well integrated with these systems and very uptodate. To install them,
-simply type:
-
-@verbatim
-apt-get install simgrid
-@endverbatim
-
-On other Linux variants, you probably want to go for a source install.
-Please contact us if you want to contribute the build scripts for your
-prefered distribution.
-
-@subsection install_binary_win Installation wizard for Windows
-
-Before starting the installation, make sure that you have the following dependencies:
- @li cmake 2.8 <a href="http://www.cmake.org/cmake/resources/software.html">(download page)</a>
- @li MinGW <a href="http://sourceforge.net/projects/mingw/files/MinGW/">(download page)</a>
- @li perl <a href="http://www.activestate.com/activeperl/downloads">(download page)</a>
- @li git <a href="http://msysgit.googlecode.com/files/Git-1.7.4-preview20110204.exe">(download page)</a>
-
-Then download the package <a href="https://gforge.inria.fr/frs/?group_id=12">SimGrid Installer</a>,
-execute it and follow instructions.
-
-@image html win_install_01.png Step 1: Accept the license.
-@image html win_install_02.png Step 2: Select packets to install.
-@image html win_install_03.png Step 3: Choice where to install packets previously selected. Please don't use spaces in path.
-@image html win_install_04.png Step 4: Add CLASSPATH to environment variables.
-@image html win_install_05.png Step 5: Add PATH to environment variables.
-@image html win_install_06.png Step 6: Restart your computer to take in consideration environment variables.
-
-@subsection install_binary_java Using the binary jar file
-
-The easiest way to install the Java bindings of SimGrid is to grab the
-jar file from the
-<a href="https://gforge.inria.fr/frs/?group_id=12">Download page</a>,
-and copy it in your classpath (typically, in the same directory than
-your source code). If you go for that version, there is no need to
-install the C library as it is bundled within the jar file. Actually,
-only a bunch of architectures are supported this way to keep the
-jarfile size under control and because we don't have access to every
-exotic architectures ourselves.
-
-If the jarfile fails on you, complaining that your architecture is not
-supported, drop us an email: we may extend the jarfile for you, if we
-have access to your architecture to build SimGrid on it.
-
-@section install_src Installing from source
-
-@subsection install_src_deps Resolving the dependencies
-
-SimGrid only uses very standard tools:
- @li C compiler, C++ compiler, make and friends.
- @li perl (but you may try to go without it)
- @li We use cmake to configure our compilation
- (<a href="http://www.cmake.org/cmake/resources/software.html">download page</a>).
- You need cmake version 2.8 or higher. You may want to use ccmake
- for a graphical interface over cmake.
-
-On MacOSX, it is advised to use the clang compiler (version 3.0 or
-higher), from either MacPort or XCode. If you insist on using gcc on
-this system, you still need a recent version of this compiler, so you
-need an unofficial gcc47 from MacPort because the version provided by
-Apple is ways to ancient to suffice. See also @ref install_cmake_mac.
-
-On Windows, it is strongly advised to use the
-<a href="http://sourceforge.net/projects/mingw/files/MinGW/">MinGW
-environment</a> to build SimGrid. Any other compilers are not tests
-(and thus probably broken). We usually use the
-<a href="http://www.activestate.com/activeperl/downloads">activestate</a>
-version of Perl, and the
-<a href="http://msysgit.googlecode.com/files/Git-1.7.4-preview20110204.exe">msys</a>
-version of git on this architecture, but YMMV. See also @ref install_cmake_win.
-
-@subsection install_src_fetch Retrieving the source
-
-If you just want to use SimGrid, you should probably grab the latest
-stable version available from the
-<a href="https://gforge.inria.fr/frs/?group_id=12">download page</a>.
-We do our best to release soon and release often, but sometimes you
-need to install the developer version of SimGrid, directly from the
-git repository. Avoid the git version if you are not sure, as it may
-break on you, or even worse.
+If you want to stay on the bleeding edge, you should get the latest git version, and recompile it as you would do for
+an official archive. Depending on the files you change in the source tree, some extra tools may be needed.
@verbatim
git clone git://scm.gforge.inria.fr/simgrid/simgrid.git simgrid
@endverbatim
-@subsection install_src_config Configuring the build
+@subsection install_src_config Build Configuration
-Note that compile-time options are very different from @ref options
-"run-time options".
+Note that compile-time options are very different from @ref options "run-time options".
-\subsubsection install_cmake_howto Setting compilation options
+@subsubsection install_cmake_howto Compilation Options
-The default configuration should be ok for most usages, but if you
-need to change something, there is several ways to do so. First, you
-can use environment variable. For example, you can change the used
-compilers by issuing these commands before launching cmake:
+The default configuration should be fine for most usages, but if you need to change something, there are several ways
+to do so. First, you can use environment variables. For example, you can change the compilers used by issuing these
+commands before launching cmake:
@verbatim
-export CC=gcc-4.4
-export CXX=g++-4.4
+export CC=gcc-5.1
+export CXX=g++-5.1
@endverbatim
+Note that other variables are available, such as CFLAGS and CXXFLAGS to add options respectively for the C and C++
+compilers.
+
Another way to do so is to use the -D argument of cmake as follows.
-Note that the terminating dot is mandatory (see @ref
-install_cmake_outsrc to understand its meaning).
+Note that the ending dot is mandatory (see @ref install_cmake_outsrc).
@verbatim
cmake -DCC=clang -DCXX=clang++ .
@endverbatim
-Finally, you can use a graphical interface such as ccmake to change
-these settings. Simply follow the instructions after starting the
-interface.
+Finally, you can use the ccmake graphical interface to change these settings.
@verbatim
ccmake .
@endverbatim
-\subsubsection install_cmake_list SimGrid compilation options
-
-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 debugers).
-
- @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 droped 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_supernovae</b> (ON/OFF): If you use an ancient
- compiler (such as gcc prior to 4.6), you want to enable this
- option to ensure that the whole SimGrid library is presented to
- the compiler as a unique compilation unit to allow cross-units
- optimizations. This is useless on modern compilers (and will
- soon be droped).
-
- @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_lib_static</b> (ON/OFF): enable this if you want to
- compile the static library (but you should consider enjoying
- this new century instead).
-
- @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 debugers.
-
- @li <b>enable_jedule</b> (ON/OFF): enable this to get SimDag
- producing traces that can then be vizualized 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
- and developper header files.
-
-
- @li <b>enable_gtnets</b> (ON/OFF): whether you want to use gtnets.
- See section @ref pls_simgrid_configuration_gtnets.
- @li <b>gtnets_path</b> (path): GTNetS installation directory
- (eg /usr or /opt).
- @li <b>enable_ns3</b> (ON/OFF): whether you want to use ns3.
- See section @ref pls_simgrid_configuration_ns3.
- @li <b>ns3_path</b> (path): NS3 installation directory (eg /usr or /opt).
- @li <b>enable_latency_bound_tracking</b> (ON/OFF): enable it if you
- want to be warned when communications are limited by round trip
- time while doing packet-level simulation.
-
-\subsubsection install_cmake_reset Resetting the compilation configuration
-
-If you need to empty the cache of values saved by cmake (either
-because you added a new library or because something seriously went
-wrong), you can simply delete the file CMakeCache.txt that is created
-at the root of the source tree. You may also want to edit this file
-directly in some circumstances.
-
-\subsubsection install_cmake_outsrc Compiling into a separate directory
+@subsubsection install_cmake_list SimGrid compilation options
+
+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 will bring you nothing.
+
+ @li <b>enable_debug</b> (ON/OFF). Disable this option toto discard
+ all log messages of gravity debug or below at compile time (see
+ @ref XBT_log). The resulting code is faster than if you
+ discarding these messages at runtime. However, it obviously
+ becomes impossible to get any debug info 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 to the
+ SimGrid internals (this require the liblua5.3-dev and lua-5.3 packages or equivalent).
+
+ @li <b>enable_lib_in_jar</b> (ON/OFF) to make sure that the native
+ java bindings are bundled in the jar file.
+
+ @li <b>enable_lto</b> (ON/OFF) to enable the Link Time Optimization
+ of the C compiler. This feature really speeds up the produced
+ code, but it is fragile with some versions of GCC.
+
+ @li <b>enable_maintainer_mode</b> (ON/OFF) is only needed if you plan to modify very specific parts of SimGrid
+ (e.g., the XML parsers and other related elements). Moreover, this adds an extra dependency on flex and flexml.
+
+ @li <b>enable_mallocators</b> (ON/OFF) has to be disabled when tracking memory issues within SimGrid,
+ or our internal memory caching mechanism will fool the debuggers.
+
+ @li <b>enable_model-checking</b> (ON/OFF) This execution gear
+ is very usable now, but enabling this option at compile time
+ will **hinder simulation speed** even when the model-checker is
+ not activated at run time.
+
+ @li <b>enable_ns3</b> (ON/OFF) if you want to use ns-3. See section @ref pls_ns3.
+
+ @li <b>enable_smpi</b> (ON/OFF) to run MPI code on top of SimGrid.
+
+ @li <b>enable_smpi_ISP_testsuite</b> (ON/OFF) to add many extra
+ tests for the model-checker module.
+
+ @li <b>enable_smpi_MPICH3_testsuite</b> (ON/OFF) to add many extra
+ tests for the MPI module.
+
+@subsubsection install_cmake_reset Reset the build configuration
+
+To empty the cmake cache (either when you add a new library or when
+things go seriously wrong), simply delete your @c CMakeCache.txt. You
+may also want to directly edit this file in some circumstances.
+
+@subsubsection install_cmake_outsrc Out of Tree Compilation
By default, the files produced during the compilation are placed in
-the source directory. As the compilation generates a lot of files, it
-is advised to to put them all in a separate directory. It is then
-easier to cleanup, and this allows to compile several configurations
-out of the same source tree. For that, simply enter the directory
-where you want the produced files to land, and invoke cmake (or
-ccmake) with the full path to the simgrid source as last argument.
-This approach is called "compilation out of source tree".
+the source directory. It is however often better to put them all in a
+separate directory: cleaning the tree becomes as easy as removing this
+directory, and you can have several such directories to test several
+parameter sets or architectures.
+
+For that, go to the directory where the files should be produced, and
+invoke cmake (or ccmake) with the full path to the SimGrid source as
+last argument.
@verbatim
mkdir build
make
@endverbatim
-\subsubsection install_cmake_win Cmake on Windows (with MinGW)
+@subsubsection install_cmake_mac Mac OS X Builds
-Cmake can produce several kind of of makefiles. Under Windows, it has
-no way of determining what kind you want to use, so you have to hint it:
-
-@verbatim
-cmake -G"MinGW Makefiles" (other options) .
-mingw32-make
-@endverbatim
-
-\subsubsection install_cmake_mac Cmake on Mac OSX
-
-SimGrid compiles like a charm with clang on Mac OSX:
+SimGrid compiles like a charm with clang (version 3.0 or higher) on Mac OS X:
@verbatim
cmake -DCMAKE_C_COMPILER=/path/to/clang -DCMAKE_CXX_COMPILER=/path/to/clang++ .
CMAKE_OSX_SYSROOT:PATH=/Applications/XCode.app/Contents/Developer/Platforms/MacOSX.platform/Developer
@endverbatim
-\subsection install_src_compil Compiling SimGrid
+In the El Capitan version of Max OS X, Apple decided that users don't
+need no /usr/include directory anymore. If you are hit by this pure
+madness, just run the following command to restore that classical
+UNIX directory: `xcode-select -install`
+
+@subsubsection install_cmake_windows Windows Builds
+
+Building SimGrid on Windows may be something of an adventure:
+We only manage to do so ourselves with MinGW-64, <a
+href="http://www.activestate.com/activeperl/downloads">ActiveState</a>
+Perl and <a href="http://msysgit.googlecode.com/files/Git-1.7.4-preview20110204.exe">msys</a>
+git). Have a look at out configuration scripts in @c appveyor.yml, but
+don't expect too much from us: we are really not fluent with Windows.
+Actually your help is welcome.
+
+The drawback of MinGW-64 is that the produced DLL are not compatible
+with MS Visual C. <a href="http://clang.llvm.org/docs/MSVCCompatibility.html">clang-cl</a>
+sounds promising to fix this. If you get something working, please
+@ref community_contact "tell us".
+
+@subsubsection install_java Build the Java bindings
+
+Once you have the [full JDK](http://www.oracle.com/technetwork/java/javase/downloads) installed
+(on Debian/Ubuntu, grab the package ```default-jdk``` for that), things should be as simple as:
+
+~~~~{.sh}
+cmake -Denable_java=ON .
+make
+~~~~
+
+After the compilation, the file ```simgrid.jar``` is produced in the
+root directory. If you only want to build the jarfile and its
+dependencies, type ```make simgrid-java_jar```. It will save you the
+time of building every C examples and other things that you don't need
+for Java.
+
+** **Error: jni could not be found**. Sometimes, the build system fails
+to find the JNI headers. In this case, you need to first locate them as follows:
+
+~~~~{.sh}
+$ locate jni.h
+/usr/lib/jvm/java-7-openjdk-amd64/include/jni.h
+/usr/lib/jvm/java-8-openjdk-amd64/include/jni.h
+~~~~
+
+Then, set the JAVA_INCLUDE_PATH environment variable to the right
+path, and relaunch cmake. If you have several version of jni installed
+(as above), use the right one (check the java version you use with
+```javac -version```).
+
+~~~~{.sh}
+export JAVA_INCLUDE_PATH=/usr/lib/jvm/java-8-openjdk-amd64/include/
+cmake -Denable_java=ON .
+make
+~~~~
+
+Note that the filename ```jni.h``` was removed from the path.
+
+@subsubsection install_src_32bits 32 bits Builds on Multi-arch Linux
+
+On a multiarch x86_64 Linux, it should be possible to compile a 32 bit
+version of SimGrid with something like:
+
+@verbatim
+CFLAGS=-m32 \
+CXXFLAGS=-m32 \
+PKG_CONFIG_LIBDIR=/usr/lib/i386-linux-gnu/pkgconfig/ \
+cmake . \
+-DCMAKE_SYSTEM_PROCESSOR=i386 \
+-DCMAKE_Fortran_COMPILER=/some/path/to/i686-linux-gnu-gfortran \
+-DGFORTRAN_EXE=/some/path/to/i686-linux-gnu-gfortran \
+-DCMAKE_Fortran_FLAGS=-m32
+@endverbatim
+
+If needed, implement @c i686-linux-gnu-gfortran as a script:
-In most cases, compiling and installing simgrid is enough:
+@verbatim
+#!/bin/sh
+exec gfortran -m32 "$@"
+@endverbatim
+
+@subsection install_src_compil Existing Compilation Targets
+
+In most cases, compiling and installing SimGrid is enough:
@verbatim
make
In addition, several compilation targets are provided in SimGrid. If
your system is well configured, the full list of targets is available
for completion when using the Tab key. Note that some of the existing
-targets are not really for publc consumption so don't worry if some
-stuff don't work for you.
+targets are not really for public consumption so don't worry if some
+stuff doesn't work for you.
@verbatim
-make simgrid Builds only the simgrid library and not any example
-make masterslave Builds only this example (and its dependencies)
+make simgrid Build only the SimGrid library and not any example
+make app-masterworker Build only this example (works for any example)
make clean Clean the results of a previous compilation
make install Install the project (doc/ bin/ lib/ include/)
make uninstall Uninstall the project (doc/ bin/ lib/ include/)
-make dist Cuild a distribution archive (tgz)
+make dist Build a distribution archive (tgz)
make distcheck Check the dist (make + make dist + tests on the distribution)
-make simgrid_documentation Create simgrid documentation
+make documentation Create SimGrid documentation
@endverbatim
If you want to see what is really happening, try adding VERBOSE=1 to
your compilation requests:
@verbatim
-make VERBOSE=1
+make VERBOSE=1
@endverbatim
-@subsection install_src_test Testing SimGrid
+@subsection install_src_test Testing your build
Once everything is built, you may want to test the result. SimGrid
-comes with an extensive set of regression tests (see @ref
-inside_cmake_addtest "that page of the insider manual" for more
-details). Running the tests is done using the ctest binary that comes
-with cmake. These tests are run every night and the result is publicly
-<a href="http://cdash.inria.fr/CDash/index.php?project=Simgrid">available</a>.
+comes with an extensive set of regression tests (as described in the
+@ref inside_tests "insider manual"). The tests are run with @c ctest, that comes with CMake.
+We run them every commit and the results are on [our
+Jenkins](https://ci.inria.fr/simgrid/).
-\verbatim
+@verbatim
ctest # Launch all tests
-ctest -D Experimental # Launch all tests and report the result to
- # http://cdash.inria.fr/CDash/index.php?project=SimGrid
ctest -R msg # Launch only the tests which name match the string "msg"
ctest -j4 # Launch all tests in parallel, at most 4 at the same time
ctest --verbose # Display all details on what's going on
ctest -R msg- -j5 --output-on-failure # You changed MSG and want to check that you didn't break anything, huh?
# That's fine, I do so all the time myself.
-\endverbatim
-
-\section install_setting_own Setting up your own code
-
-\subsection install_setting_MSG MSG code on Unix (Linux or Mac OSX)
-
-Do not build your simulator by modifying the SimGrid examples. Go
-outside the SimGrid source tree and create your own working directory
-(say <tt>/home/joe/SimGrid/MyFirstScheduler/</tt>).
-
-Suppose your simulation has the following structure (remember it is
-just an example to illustrate a possible way to compile everything;
-feel free to organize it as you want).
-
-\li <tt>sched.h</tt>: a description of the core of the
- scheduler (i.e. which functions are can be used by the
- agents). For example we could find the following functions
- (master, forwarder, slave).
-\li <tt>sched.c</tt>: a C file including <tt>sched.h</tt> and
- implementing the core of the scheduler. Most of these
- functions use the MSG functions defined in section \ref
- msg_task_usage.
-\li <tt>masterslave.c</tt>: a C file with the main function, i.e.
- the MSG initialization (MSG_init()), the platform
- creation (e.g. with MSG_create_environment()), the
- deployment phase (e.g. with MSG_function_register() and
- MSG_launch_application()) and the call to MSG_main()).
-
-To compile such a program, we suggest to use the following
-Makefile. It is a generic Makefile that we have used many times with
-our students when we teach the C language.
-
-\verbatim
-all: masterslave
-masterslave: masterslave.o sched.o
-
-INSTALL_PATH = $$HOME
-CC = gcc
-PEDANTIC_PARANOID_FREAK = -O0 -Wshadow -Wcast-align \
- -Waggregate-return -Wmissing-prototypes -Wmissing-declarations \
- -Wstrict-prototypes -Wmissing-prototypes -Wmissing-declarations \
- -Wmissing-noreturn -Wredundant-decls -Wnested-externs \
- -Wpointer-arith -Wwrite-strings -finline-functions
-REASONABLY_CAREFUL_DUDE = -Wall
-NO_PRAYER_FOR_THE_WICKED = -w -O2
-WARNINGS = $(REASONABLY_CAREFUL_DUDE)
-CFLAGS = -g $(WARNINGS)
-
-INCLUDES = -I$(INSTALL_PATH)/include
-DEFS = -L$(INSTALL_PATH)/lib/
-LDADD = -lm -lsimgrid
-LIBS =
-
-%: %.o
- $(CC) $(INCLUDES) $(DEFS) $(CFLAGS) $^ $(LIBS) $(LDADD) -o $@
-
-%.o: %.c
- $(CC) $(INCLUDES) $(DEFS) $(CFLAGS) -c -o $@ $<
-
-clean:
- rm -f $(BIN_FILES) *.o *~
-.SUFFIXES:
-.PHONY: clean
-
-\endverbatim
-
-The first two lines indicates what should be build when typing make
-(<tt>masterslave</tt>) and of which files it is to be made of
-(<tt>masterslave.o</tt> and <tt>sched.o</tt>). This makefile assumes
-that you have set up correctly your <tt>LD_LIBRARY_PATH</tt> variable
-(look, there is a <tt>LDADD = -lm -lsimgrid</tt>). If you prefer using
-the static version, remove the <tt>-lsimgrid</tt> and add a
-<tt>$(INSTALL_PATH)/lib/libsimgrid.a</tt> on the next line, right
-after the <tt>LIBS = </tt>.
-
-More generally, if you have never written a Makefile by yourself, type
-in a terminal: <tt>info make</tt> and read the introduction. The
-previous example should be enough for a first try but you may want to
-perform some more complex compilations...
-
-
-\subsection install_setting_win_provided Compile the "HelloWorld" project on Windows
-
-In the SimGrid install directory you should have an HelloWorld project to explain you how to start
-compiling a source file. There are:
-\verbatim
-- HelloWorld.c The example source file.
-- CMakeLists.txt It allows to configure the project.
-- README This explaination.
-\endverbatim
-
-Now let's compile this example:
-\li Run windows shell "cmd".
-\li Open HelloWorld Directory ('cd' command line).
-\li Create a build directory and change directory. (optional)
-\li Type 'cmake -G"MinGW Makefiles" \<path_to_HelloWorld_project\>'
-\li Run mingw32-make
-\li You should obtain a runnable example ("HelloWorld.exe").
-
-For compiling your own code you can simply copy the HelloWorld project and rename source name. It will
-create a target with the same name of the source.
-
-
-\subsection install_setting_win_new Adding and Compiling a new example on Windows
-
-\li Put your source file into the helloWord directory.
-\li Edit CMakeLists.txt by removing the Find Targets section and add those two lines into this section
-\verbatim
-################
-# FIND TARGETS #
-################
-#It creates a target called 'TARGET_NAME.exe' with the sources 'SOURCES'
-add_executable(TARGET_NAME SOURCES)
-#Links TARGET_NAME with simgrid
-target_link_libraries(TARGET_NAME simgrid)
-\endverbatim
-\li To initialize and build your project, you'll need to run
-\verbatim
-cmake -G"MinGW Makefiles" <path_to_HelloWorld_project>
-\endverbatim
-\li Run "mingw32-make"
-\li You should obtain "TARGET_NAME.exe".
-
-\subsection install_Win_ruby Setup a virtualbox to use SimGrid-Ruby on windows
-
-Allan Espinosa made these set of Vagrant rules available so that you
-can use the SimGrid Ruby bindings in a virtual machine using
-VirtualBox. Thanks to him for that. You can find his project here:
-https://github.com/aespinosa/simgrid-vagrant
-
-
+@endverbatim
*/
