X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/1290a5bf942b9018ab6e3e626655e55abeb36142..b97705aaf91f94aee20e4d0b4cc14dd77d491810:/doc/user_guide/doxygen/install.doc diff --git a/doc/user_guide/doxygen/install.doc b/doc/user_guide/doxygen/install.doc index 5048ab0c3b..cfa45260a2 100644 --- a/doc/user_guide/doxygen/install.doc +++ b/doc/user_guide/doxygen/install.doc @@ -1,4 +1,4 @@ -/*! \addtogroup SimGrid_install +/*! \page install Installing Simgrid \section install_cmake Installing the SimGrid library @@ -259,53 +259,6 @@ make make install \endverbatim - -\subsection install_cmakehowto How to modified sources files for developers - -\subsubsection install_cmakehowto1 Add an executable or examples. - -If you want make an executable you have to create a CMakeList.txt to the src directory. -You must specified where to create the executable, source list, dependencies and the name of the binary. - -\verbatim -cmake_minimum_required(VERSION 2.6) - -set(EXECUTABLE_OUTPUT_PATH "./") -set(LIBRARY_OUTPUT_PATH "${CMAKE_HOME_DIRECTORY}/lib") - -add_executable(get_sender get_sender.c) #add_executable( ) - -### Add definitions for compile -target_link_libraries(get_sender simgrid m pthread) #target_link_libraries( ) -\endverbatim - -Then you have to modified /buildtools/Cmake/MakeExeLib.cmake and add -this line : -\verbatim -add_subdirectory(${CMAKE_HOME_DIRECTORY}/) -\endverbatim - -\subsubsection install_cmakehowto2 Delete/add sources to lib. - -If you want modified, add or delete source files from a library you have to edit /buildtools/Cmake/DefinePackages.cmake - -\verbatim -set(JMSG_JAVA_SRC - ${CMAKE_HOME_DIRECTORY}/src/java/simgrid/msg/MsgException.java - ${CMAKE_HOME_DIRECTORY}/src/java/simgrid/msg/JniException.java - ${CMAKE_HOME_DIRECTORY}/src/java/simgrid/msg/NativeException.java - ${CMAKE_HOME_DIRECTORY}/src/java/simgrid/msg/HostNotFoundException.java - ${CMAKE_HOME_DIRECTORY}/src/java/simgrid/msg/ProcessNotFoundException.java - ${CMAKE_HOME_DIRECTORY}/src/java/simgrid/msg/Msg.java - ${CMAKE_HOME_DIRECTORY}/src/java/simgrid/msg/Process.java - ${CMAKE_HOME_DIRECTORY}/src/java/simgrid/msg/Host.java - ${CMAKE_HOME_DIRECTORY}/src/java/simgrid/msg/Task.java - ${CMAKE_HOME_DIRECTORY}/src/java/simgrid/msg/MsgNative.java - ${CMAKE_HOME_DIRECTORY}/src/java/simgrid/msg/ApplicationHandler.java - ${CMAKE_HOME_DIRECTORY}/src/java/simgrid/msg/Sem.java -) -\endverbatim - \section install_Win Installing the SimGrid framework on Windows \subsection install_Win_install Installing SimGrid with the automatic installer @@ -362,7 +315,8 @@ 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"). +- FindPCRE.cmake This finds and links to the pcre library (Normally included + into Simgrid directory "GnuWin32"). - README This explaination. \endverbatim @@ -385,8 +339,10 @@ create a target with the same name of the source. ################ # FIND TARGETS # ################ -add_executable(TARGET_NAME SOURCES) #It creates a target called 'TARGET_NAME.exe' with the sources 'SOURCES' -target_link_libraries(TARGET_NAME simgrid pcre) #Links TARGET_NAME with simgrid and pcre +#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) \endverbatim \li To initialize and build your project, you'll need to run \verbatim @@ -428,22 +384,19 @@ 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 sched.h: 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 sched.c: a C file including sched.h and - implementing the core of the scheduler. Most of these - functions use the MSG functions defined in section \ref - msg_task_usage. - - \li masterslave.c: 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()). +\li sched.h: 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 sched.c: a C file including sched.h and + implementing the core of the scheduler. Most of these + functions use the MSG functions defined in section \ref + msg_task_usage. +\li masterslave.c: 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