From 6d9c67b14f86e16e2c4fefe44443e18bada3ed1a Mon Sep 17 00:00:00 2001 From: Martin Quinson Date: Thu, 20 Dec 2012 01:49:28 +0100 Subject: [PATCH] remove a bit of cruft from the install doc, more remains to be cleaned --- doc/doxygen/inside_cmake.doc | 18 ++++++++++++++++++ doc/doxygen/install.doc | 22 ++++++---------------- 2 files changed, 24 insertions(+), 16 deletions(-) diff --git a/doc/doxygen/inside_cmake.doc b/doc/doxygen/inside_cmake.doc index 4d89a4988c..64071bdc2e 100644 --- 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 here. + +\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 /buildtools/Cmake/DefinePackages.cmake. diff --git a/doc/doxygen/install.doc b/doc/doxygen/install.doc index a522f4561d..d78e20aaa9 100644 --- a/doc/doxygen/install.doc +++ b/doc/doxygen/install.doc @@ -3,19 +3,11 @@ \section install_cmake Installing the SimGrid library -\subsection install_intro Some generalities +\subsection install_installing_cmake Installing cmake -\subsubsection install_intro1 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 here. - -\subsubsection install_intro2 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. - -\subsubsection install_intro3 What cmake need? - -CMake depends on a few other tools like: +You must have cmake in order to compile SimGrid. If you cannot find a +binary package of cmake for your system, you'll need to recompile it. +In turn, cmake has a few dependencies: For Unix and MacOS: \li make @@ -46,7 +38,7 @@ Note that if you want change the compiler, you can simply specify the environmen export CXX=clang++ \endverbatim -\subsubsection install_cmakeoption1 Options list +\subsubsection install_cmakeoption1 SimGrid configuration options \verbatim "cmake -D[name]=[value] ... ./" @@ -75,8 +67,6 @@ Note that if you want change the compiler, you can simply specify the environmen pipol_user \endverbatim -\subsubsection install_cmakeoption2 Options explaination - \li enable_gtnets: set to true implies that user wants to use gtnets. \li enable_ns3: set to true implies that user wants to use ns3. @@ -145,7 +135,7 @@ gtnets_path null pipol_user null \endverbatim -\subsubsection install_cmakeoption4 Option's cache and how to reset? +\subsubsection install_cmakeoption4 How to reset the cache of options When options have been set they are keep into a cache file named "CMakeCache.txt". So if you want reset values you just delete this file located to the project directory. -- 2.20.1