Update FAQ and cosmetics for options.

git-svn-id: svn+ssh://scm.gforge.inria.fr/svn/simgrid/simgrid/trunk@7457 48e7efb5-ca39-0410-a469-dd3cf9ba447f

diff --git a/buildtools/Cmake/src/CMakeCompleteInFiles.txt b/buildtools/Cmake/src/CMakeCompleteInFiles.txt
index 3b333b0..54fe366 100644 (file)
--- a/buildtools/Cmake/src/CMakeCompleteInFiles.txt
+++ b/buildtools/Cmake/src/CMakeCompleteInFiles.txt
@@ -83,9 +83,9 @@ if(NOT disable_ruby)
        endif(RUBY_INCLUDE_PATH)
 endif(NOT disable_ruby)
 
-if(tracing)
+if(enable_tracing)
        SET(HAVE_TRACING 1)
-endif(tracing)
+endif(enable_tracing)
 
 #--------------------------------------------------------------------------------------------------
 ### Initialize of CONTEXT JAVA

diff --git a/buildtools/Cmake/src/CMakeMakeExeLib.txt b/buildtools/Cmake/src/CMakeMakeExeLib.txt
index 060c256..50d462e 100644 (file)
--- a/buildtools/Cmake/src/CMakeMakeExeLib.txt
+++ b/buildtools/Cmake/src/CMakeMakeExeLib.txt
@@ -1,13 +1,13 @@
 ### Make Libs
 
-if(supernovae)
+if(enable_supernovae)
        include(${PROJECT_DIRECTORY}/buildtools/Cmake/src/CMakeSupernovae.txt)
-else(supernovae)       
+else(enable_supernovae)        
        add_library(simgrid SHARED ${simgrid_sources})
        add_library(simgrid_static STATIC ${simgrid_sources})
        add_library(gras SHARED ${gras_sources})
        add_library(smpi STATIC ${SMPI_SRC})
-endif(supernovae)
+endif(enable_supernovae)
 
 set(GRAS_DEP "pthread")
 set(SIMGRID_DEP ${libruby})

diff --git a/buildtools/Cmake/src/CMakeOption.txt b/buildtools/Cmake/src/CMakeOption.txt
index 2e7f729..9361f2b 100644 (file)
--- a/buildtools/Cmake/src/CMakeOption.txt
+++ b/buildtools/Cmake/src/CMakeOption.txt
@@ -10,19 +10,19 @@ if(NOT with_context)
        set(with_context "auto" CACHE TYPE INTERNAL FORCE)
 endif(NOT with_context)
 
-
+option(disable_gtnets "This variable set the gtnets context." off)
 option(disable_java "This variable set the java context." off)
 option(disable_lua "This variable set lua use." off)
-option(disable_gtnets "This variable set the gtnets context." off)
 option(disable_ruby "This variable set ruby use." off)
-option(enable_compile_warnings "" off)
+
 option(enable_compile_optimizations "" off)
+option(enable_compile_warnings "" off)
 option(enable_maintainer_mode "Permit to make flex and flexml files." off)
+option(enable_supernovae "Supernovae mode." off)
+option(enable_tracing "Tracing mode." off)
 option(enable_coverage "Enable coverage." off)
 option(enable_memcheck "Enable memcheck." off)
-option(supernovae "Supernovae mode." off)
-option(tracing "Tracing mode." off)
-option(print_message "Enable print message during config." off)
+option(enable_print_message "Enable print message during config." off)
 
 mark_as_advanced(BIBTEX2HTML_PATH)
 mark_as_advanced(LUA_LIB_PATH_1)                                                                                                                      

diff --git a/buildtools/Cmake/src/CMakePrintArgs.txt b/buildtools/Cmake/src/CMakePrintArgs.txt
index 34a2e00..cf05408 100644 (file)
--- a/buildtools/Cmake/src/CMakePrintArgs.txt
+++ b/buildtools/Cmake/src/CMakePrintArgs.txt
@@ -1,7 +1,7 @@
 exec_program("echo `${CMAKE_C_COMPILER} --version | grep -E [0-9].[0-9].[0-9]$`" OUTPUT_VARIABLE "COMPILER_C_VERSION")
 exec_program("echo `${CMAKE_CXX_COMPILER} --version | grep -E [0-9].[0-9].[0-9]$`" OUTPUT_VARIABLE "COMPILER_CXX_VERSION")
 
-if(print_message)
+if(enable_print_message)
        message("")
        message("________________________________________________________________________________")
        message("________________________________________________________________________________ DEBUG")
@@ -75,7 +75,7 @@ if(print_message)
        message("________________________________________________________________________________")
        message("________________________________________________________________________________ DEBUG END")
        message("")
-endif(print_message)
+endif(enable_print_message)
 
 message("\nConfiguration of package `simgrid' (revision ${SVN_VERSION}${GIT_VERSION}) on arch (=${GRAS_THISARCH}):")
 message("           BUILDNAME :        ${BUILDNAME}")

diff --git a/doc/FAQ.doc b/doc/FAQ.doc
index d399c9f..e035c4d 100644 (file)
--- a/doc/FAQ.doc
+++ b/doc/FAQ.doc
@@ -388,7 +388,7 @@ CMake needs some prerequists like :
 
 \subsubsection faq_intro4 Cmake vs Autotools...
 
-
+TODO
 
 \subsection faq_cmakeoption Cmake options
 
@@ -405,14 +405,18 @@ CMake needs some prerequists like :
                enable_compile_optimizations            ON/OFF or TRUE/FALSE or 1/0
                enable_compile_warnings                 ON/OFF or TRUE/FALSE or 1/0
                enable_maintainer_mode                  ON/OFF or TRUE/FALSE or 1/0
-               
-               supernovae                              ON/OFF or TRUE/FALSE or 1/0
+               enable_supernovae                       ON/OFF or TRUE/FALSE or 1/0
+               enable_tracing                          ON/OFF or TRUE/FALSE or 1/0
+               enable_coverage                         ON/OFF or TRUE/FALSE or 1/0
+               enable_memcheck                         ON/OFF or TRUE/FALSE or 1/0 
+               enable_print_message                    ON/OFF or TRUE/FALSE or 1/0
 
                gtnets_path                             <path_to_gtnets_directory>
                prefix                                  <path_to_install_directory>
-               with_context                            auto/ucontext/pthread/window
+               BIBTEX2HTML                             <path_to_bibtex2html>
+               with_context                            auto/ucontext/pthread/window     
 \endverbatim
-
+                                                                                                                                                          
 \subsubsection faq_cmakeoption2 Options explaination
 
   \li disable_gtnets : set to true implie that user doesn't want to use gtnets.
@@ -427,27 +431,57 @@ CMake needs some prerequists like :
 
   \li enable_compile_warnings : add flags "-Wall -Wunused -Wmissing-prototypes -Wmissing-declarations -Wpointer-arith -Wchar-subscripts -Wcomment -Wformat -Wwrite-strings -Wno-unused-function -Wno-unused-parameter -Wno-strict-aliasing -Wno-format-nonliteral -Werror"
 
-  \li enable_maintainer_mode : set to true make doc and remake files with flex flexml.
+  \li enable_maintainer_mode : set to true it remakes some files.
 \verbatim
-/doc/html
-/src/gras/DataDesc/ddt_parse.yy.c
-/src/surf/simgrid_dtd.c
-/src/xbt/graphxml.c
-/src/simdag/dax_dtd.c
-/include/surf/simgrid_dtd.h
-/include/xbt/graphxml.h
-/src/simdag/dax_dtd.h
+include/surf/simgrid_dtd.h
+include/xbt/graphxml.h
+
+src/cunit_unit.c
+src/ex_unit.c
+src/dynar_unit.c
+src/dict_unit.c
+src/set_unit.c
+src/swag_unit.c
+src/xbt_str_unit.c
+src/xbt_strbuff_unit.c
+src/xbt_sha_unit.c
+src/config_unit.c
+src/xbt_synchro_unit.c
+src/simgrid_units_main.c
+
+src/simdag/dax_dtd.c
+src/simdag/dax_dtd.h
+src/simdag/dax_dtd.l
+
+src/surf/simgrid_dtd.c
+src/surf/simgrid_dtd.l
+
+src/xbt/graphxml.c
+src/xbt/graphxml.l
+
+src/gras/DataDesc/ddt_parse.yy.c
 \endverbatim
-  \li supernovae : set to true make one file for each lib and compile with those generated files.
+  \li enable_supernovae : set to true make one file for each lib and compile with those generated files.
 \verbatim
 /src/supernovae_sg.c
 /src/supernovae_gras.c                 
 /src/supernovae_smpi.c
 \endverbatim
+
+  \li enable_tracing : TODO by lucas
+
+  \li enable_coverage : When set to true this option enable code coverage by setting -fprofile-arcs -ftest-coverage flags.
+
+  \li enable_memcheck : When set to true this option enable tests for memcheck.
+
+  \li enable_print_message : This option when enable permits to see variables from gras_config.h
+
   \li gtnets_path : Path to gtnets install directory (ex /usr)
 
   \li prefix : Path where are installed lib/ doc/ and include/ directories (ex /usr/local)
 
+  \li BIBTEX2HTML : Path where is installed bibtex2html.
+
   \li with context : specify which context the user wants to use.
 
 \subsubsection faq_cmakeoption3 Initialisation
@@ -455,15 +489,24 @@ CMake needs some prerequists like :
 Those options are initialized the first time you launch \"cmake ./\" whithout specified option.
 
 \verbatim
-with_context                   auto
+disable_gtnets                 off
+disable_java                   off
+disable_lua                    off
+disable_ruby                   off
+
+enable_compile_optimizations   off
+enable_compile_warnings                off
 enable_maintainer_mode         off
-supernovae                     off
-disable_java                   off
-disable_lua                    off
-enable_compile_warnings        off
-enable_compile_optimizations   off
-disable_gtnets                 off
-disable_ruby                   on
+enable_supernovae              off
+enable_tracing                 off
+enable_coverage                off
+enable_memcheck                off
+enable_print_message           off
+
+gtnets_path                    null
+prefix                         null
+BIBTEX2HTML                    null
+with_context                   auto
 \endverbatim
 
 \subsubsection faq_cmakeoption4 Option's cache and how to reset?
@@ -495,10 +538,13 @@ cmake ./          configure the project
 make                   build all targets
 make VERBOSE=1         build all targets and print build command lines
 make test              test all targets and summarize
-make package           make the distrib
+make dist              make the distrib
+make distcheck         check the dist (make + make dist + make test) 
 make install-simgrid   install the project (doc/ lib/ include/)
+make uninstall         uninstall the project (doc/ lib/ include/)
 make clean             clean all targets
 make html              Create simgrid documentation
+make maintainer-clean   Remove all files generated by mainainer mode
 \endverbatim
 
 When the project have been succesfully compiling and build you can make tests.
@@ -512,12 +558,14 @@ ctest -D Continuous(Test|Coverage|MemCheck|Submit)
 ctest -D Experimental
 ctest -D Experimental(Start|Update|Configure|Build)
 ctest -D Experimental(Test|Coverage|MemCheck|Submit)
-ctest -D Nightly
+ctest -D Nightly                               
 ctest -D Nightly(Start|Update|Configure|Build)
 ctest -D Nightly(Test|Coverage|MemCheck|Submit)
 ctest -D NightlyMemoryCheck
 \endverbatim
 
+If you want to test before make a commit you can simply make "ctest -D Experimental" and then you can visualize results submitted into Cdash. <a href="http://cdash.inria.fr/CDash/index.php?project=Simgrid">(Go to Cdash site)</a>.
+
 \subsubsection faq_cmakecompilation4 Examples for different mode.
 
 \li Mode maintainer
@@ -824,9 +872,9 @@ Here are made files for the supernovae mode.
 
 Here is defined packages for install simgrid and make a distribution.
 
-\li CMakeFLEXml.txt
+\li CMakeMaintainerMode.txt
 
-Part for generated sources from flex and flexml.
+Part where are generated source files for maintainer mode.
 
 \li CMakeOption.txt
 
@@ -846,6 +894,7 @@ Here is a list of files involved into cmake build (relative to project directory
 \verbatim
 
 Cmake sources:
+       ./doc/CMakeLists.txt
        ./buildtools/Cmake/src/CMakeCompleteInFiles.txt
        ./buildtools/Cmake/src/CMakeDocs.txt
        ./buildtools/Cmake/src/CMakeMakeExeLib.txt
@@ -854,7 +903,7 @@ Cmake sources:
        ./buildtools/Cmake/src/CMakeFlags.txt
        ./buildtools/Cmake/src/CMakeSupernovae.txt
        ./buildtools/Cmake/src/CMakeDistrib.txt
-       ./buildtools/Cmake/src/CMakeFLEXml.txt
+       ./buildtools/Cmake/src/CMakeMaintainerMode.txt
        ./buildtools/Cmake/src/CMakeOption.txt
        ./buildtools/Cmake/src/CMakeTest.txt
        ./buildtools/Cmake/src/CTestConfig.cmake
@@ -878,6 +927,7 @@ Test files for define properties :
 
 CMakeLists for each binaries or examples:
        ./CMakeLists.txt
+       ./src/CMakeLists.txt
        ./teshsuite/gras/empty_main/CMakeLists.txt
        ./teshsuite/gras/small_sleep/CMakeLists.txt
        ./teshsuite/gras/datadesc/CMakeLists.txt