From b97705aaf91f94aee20e4d0b4cc14dd77d491810 Mon Sep 17 00:00:00 2001 From: navarro Date: Thu, 25 Oct 2012 15:36:34 +0200 Subject: [PATCH 1/1] Start to write dev_guide --- buildtools/Cmake/GenerateDevGuide.cmake | 7 ++-- doc/dev_guide/doxygen/cmake.doc | 44 ++++++++++++++++++++++ doc/user_guide/doxygen/install.doc | 49 ------------------------- 3 files changed, 47 insertions(+), 53 deletions(-) diff --git a/buildtools/Cmake/GenerateDevGuide.cmake b/buildtools/Cmake/GenerateDevGuide.cmake index a51e607dbc..4e1ce97acc 100644 --- a/buildtools/Cmake/GenerateDevGuide.cmake +++ b/buildtools/Cmake/GenerateDevGuide.cmake @@ -9,16 +9,15 @@ if(DOXYGEN_PATH) DEPENDS ${DEV_GUIDE_SOURCES} COMMAND ${CMAKE_COMMAND} -E remove_directory ${CMAKE_HOME_DIRECTORY}/doc/dev_guide/html COMMAND ${CMAKE_COMMAND} -E make_directory ${CMAKE_HOME_DIRECTORY}/doc/dev_guide/html + COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_HOME_DIRECTORY}/doc/simgrid.css ${CMAKE_HOME_DIRECTORY}/doc/dev_guide/html/ WORKING_DIRECTORY ${CMAKE_HOME_DIRECTORY}/doc/dev_guide/ ) - ADD_CUSTOM_COMMAND(TARGET dev_guide - COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_HOME_DIRECTORY}/doc/simgrid.css ${CMAKE_HOME_DIRECTORY}/doc/dev_guide/html/ - ) - ADD_CUSTOM_COMMAND(TARGET dev_guide COMMAND ${CMAKE_COMMAND} -E echo "XX First Doxygen pass" COMMAND ${DOXYGEN_PATH}/doxygen DevGuideDoxyfile + COMMAND ${CMAKE_HOME_DIRECTORY}/tools/doxygen/index_create.pl ../../shared/doxygen/simgriddevguide.tag index-API.doc + COMMAND ${CMAKE_COMMAND} -E echo "XX Second Doxygen pass" COMMAND ${DOXYGEN_PATH}/doxygen DevGuideDoxyfile diff --git a/doc/dev_guide/doxygen/cmake.doc b/doc/dev_guide/doxygen/cmake.doc index 13f80d97bb..2da858ef50 100644 --- a/doc/dev_guide/doxygen/cmake.doc +++ b/doc/dev_guide/doxygen/cmake.doc @@ -2,7 +2,51 @@ \page cmake SimGrid Developer Guide - Cmake \section cmake_dev_guide_src How to add sources? + +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 cmake_dev_guide_ex How to add examples? + +If you want make an example 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( ) +add_executable(get_sender get_sender.c) + +### Add definitions for compile +#target_link_libraries( ) +target_link_libraries(get_sender simgrid m pthread) +\endverbatim + +Then you have to modified /buildtools/Cmake/MakeExeLib.cmake and add +this line : +\verbatim +add_subdirectory(${CMAKE_HOME_DIRECTORY}/) +\endverbatim + \section cmake_dev_guide_test How to add tests? */ diff --git a/doc/user_guide/doxygen/install.doc b/doc/user_guide/doxygen/install.doc index 9269988742..cfa45260a2 100644 --- a/doc/user_guide/doxygen/install.doc +++ b/doc/user_guide/doxygen/install.doc @@ -259,55 +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( ) -add_executable(get_sender get_sender.c) - -### Add definitions for compile -#target_link_libraries( ) -target_link_libraries(get_sender simgrid m pthread) -\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 -- 2.20.1