Merge branch 'master' of scm.gforge.inria.fr:/gitroot/simgrid/simgrid into tomerge

[simgrid.git] / doc / doxygen / inside_cmake.doc

diff --git a/doc/doxygen/inside_cmake.doc b/doc/doxygen/inside_cmake.doc
index 4d89a49..aae6e29 100644 (file)
--- a/doc/doxygen/inside_cmake.doc
+++ b/doc/doxygen/inside_cmake.doc
@@ -3,6 +3,24 @@
 
 \tableofcontents
 
+\section inside_cmake_intro Generalities on Cmake
+
+\subsection inside_cmake_what What is Cmake?
+
+CMake is a family of tools designed to build, test and package
+software. CMake is used to control the software compilation process
+using simple platform and compiler independent configuration files.
+CMake generates native makefiles and workspaces that can be used in
+the compiler environment of your choice. For more information see
+official web site <a href="http://www.cmake.org/">here</a>.
+
+\subsection inside_cmake_why Why cmake?
+
+CMake permits to developers to compile projects on different
+platforms. Then many tools are embedded like ctest for making test, a
+link to cdash for vizualise results but also test coverage and bug
+reports.
+
 \section inside_cmake_addsrc How to add source files?
 
 If you want modified, add or delete source files from a library you have to edit <project/directory>/buildtools/Cmake/DefinePackages.cmake.
@@ -32,8 +50,8 @@ done by adding the files to the EXTRA_DIST list, as in the following
 example:
 
 \verbatim
-### If f2c is installed compiled source other-whise source is only copy in the dist 
-if(SMPI_F2C)
+### If fortran is installed compile source other-whise source is only copied in the dist 
+if(SMPI_FORTRAN)
   set(SMPI_SRC
     ${SMPI_SRC}
     src/smpi/smpi_f77.c
@@ -106,7 +124,7 @@ set(txt_files
 \endverbatim
 
 Then, you have to follow these steps:
-\li Add the following line to <project/directory>/buildtools/Cmake/MakeExeLib.cmake:
+\li Add the following line to <project/directory>/buildtools/Cmake/MakeExe.cmake:
 \verbatim
 add_subdirectory(${CMAKE_HOME_DIRECTORY}/<path_where_is_CMakeList.txt>)
 \endverbatim
@@ -228,11 +246,10 @@ ADD_TEST(NAME my-test-name
 As usual, you must run "make distcheck" after modifying the cmake files,
 to ensure that you did not forget any files in the distributed archive.
 
-\subsection inside_cmake_addtest_perf Performance testing in SimGrid
+\subsection inside_cmake_ci Continous Integration
 
-We are currently in the process of adding an infrastructure for
-performance regression testing, but this is not related to cmake
-anyhow. They are thus documented elsewhere, in Section \ref
-inside_autotests_perf
+We are using Continous Integration to help us provide a stable build
+across as many platforms as possible. %As this is not related to cmake,
+you have to head over to Section \ref inside_ci.
 
 */