X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/01dca8e143a11269ad071ccba4b2517a3f57cdad..1437b1f25521d507d90e78589106a1bd092b3d82:/doc/doxygen/install.doc
diff --git a/doc/doxygen/install.doc b/doc/doxygen/install.doc
index 1ddc77f627..bea5ec5a58 100644
--- a/doc/doxygen/install.doc
+++ b/doc/doxygen/install.doc
@@ -12,16 +12,17 @@ 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. Recompiling the archive should be done in a few lines:
+tools. First, 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:
-@verbatim
-wget https://gforge.inria.fr/frs/download.php/32047/SimGrid-3.9.tar.gz
-tar xf SimGrid-3.9.tar.gz
-cd SimGrid-3.9
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.sh}
+tar xf @SimGridRelease.tar.gz
+cd @SimGridRelease
cmake -DCMAKE_INSTALL_PREFIX=/opt/simgrid .
make
make install
-@endverbatim
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
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.
@@ -85,8 +86,7 @@ have access to your architecture to build SimGrid on it.
SimGrid only uses very standard tools:
@li C compiler, C++ compiler, make and friends.
- @li perl (but you may try to go without it) and libpcre (but we are
- working on removing this dependency)
+ @li perl (but you may try to go without it)
@li We use cmake to configure our compilation
(download page).
You need cmake version 2.8 or higher. You may want to use ccmake
@@ -100,7 +100,8 @@ Apple is ways to ancient to suffice. See also @ref install_cmake_mac.
On Windows, it is strongly advised to use the
MinGW
-environment to build SimGrid. Any other compilers are not tests
+environment to build SimGrid, with
+MSYS tools installed. Any other compilers are not tested
(and thus probably broken). We usually use the
activestate
version of Perl, and the
@@ -130,7 +131,7 @@ Note that compile-time options are very different from @ref 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
+can use environment variables. For example, you can change the used
compilers by issuing these commands before launching cmake:
@verbatim
@@ -138,6 +139,9 @@ export CC=gcc-4.4
export CXX=g++-4.4
@endverbatim
+Note that other variables are available, such as CFLAGS and CXXFLAGS to add
+options for respectively the C compiler and the C++ compiler.
+
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).
@@ -188,13 +192,6 @@ accepts several options, as listed below.
your simulation speed even if you simulate without activating
the model-checker. We are working on improving this situation.
- @li enable_supernovae (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 enable_compile_warnings (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
@@ -269,14 +266,14 @@ cmake [options] ..
make
@endverbatim
-\subsubsection install_cmake_win Cmake on Windows (with MinGW)
+\subsubsection install_cmake_win Cmake on Windows (with MinGW + MSYS)
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
+cmake -G "MSYS Makefiles" (other options) .
+make
@endverbatim
\subsubsection install_cmake_mac Cmake on Mac OSX
@@ -323,7 +320,7 @@ 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 distcheck Check the dist (make + make dist + tests on the distribution)
-make simgrid_documentation Create simgrid documentation
+make doc Create simgrid documentation
@endverbatim
If you want to see what is really happening, try adding VERBOSE=1 to
@@ -441,8 +438,6 @@ compiling a source file. There are:
\verbatim
- HelloWorld.c The example source file.
- CMakeLists.txt It allows to configure the project.
-- FindPCRE.cmake This finds and links to the pcre library (Normally included
- into Simgrid directory "GnuWin32").
- README This explaination.
\endverbatim
@@ -468,8 +463,8 @@ create a target with the same name of the source.
################
#It creates a target called 'TARGET_NAME.exe' with the sources 'SOURCES'
add_executable(TARGET_NAME SOURCES)
-#Links TARGET_NAME with simgrid and pcre
-target_link_libraries(TARGET_NAME simgrid pcre)
+#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