From: lbobelin Date: Fri, 29 Jun 2012 20:00:53 +0000 (+0200) Subject: Added some stuff about deployment to please Fred. Corrected some stuff. X-Git-Tag: v3_8~393 X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/commitdiff_plain/a6399ec5be5b63718e15d25d870212bef3955f4d Added some stuff about deployment to please Fred. Corrected some stuff. --- diff --git a/buildtools/Cmake/DefinePackages.cmake b/buildtools/Cmake/DefinePackages.cmake index 0bfdd0f932..f457554c8a 100644 --- a/buildtools/Cmake/DefinePackages.cmake +++ b/buildtools/Cmake/DefinePackages.cmake @@ -592,6 +592,7 @@ set(USER_GUIDE_SOURCES doc/user_guide/doxygen/pls.doc doc/user_guide/doxygen/index.doc doc/user_guide/doxygen/platform.doc + doc/user_guide/doxygen/deployment.doc doc/user_guide/doxygen/UserGuideDoxyfile.in doc/user_guide/doxygen/UserGuideDoxygenLayout.xml ) diff --git a/doc/user_guide/doxygen/UserGuideDoxyfile.in b/doc/user_guide/doxygen/UserGuideDoxyfile.in index 5b454de4de..1bf013f09a 100644 --- a/doc/user_guide/doxygen/UserGuideDoxyfile.in +++ b/doc/user_guide/doxygen/UserGuideDoxyfile.in @@ -664,6 +664,7 @@ INPUT = index.doc \ examples.doc \ options.doc \ platform.doc \ + deployment.doc \ tracing.doc \ pls.doc \ bindings.doc diff --git a/doc/user_guide/doxygen/deployment.doc b/doc/user_guide/doxygen/deployment.doc new file mode 100644 index 0000000000..355cf35f4f --- /dev/null +++ b/doc/user_guide/doxygen/deployment.doc @@ -0,0 +1,38 @@ +/*! \page deployment Deployment description + +Deployment just consists of saying which +process runs where and which arguments it should take as input, the easier way to +understand how to write it is just to take a look at the examples. Here is an example of it: + +\verbatim + + + + + + + + + + + + + + + + + + + + + +\endverbatim + +There are additional attributes to the process tag, here is a list of attributes of process: + +\li host CDATA (mandatory): the host on which the function will be executed. +\li process CDATA (mandatory): the process function that will be executed on that host. +\li start_time: the time when the function will start. Default is zero. +\li kill_time: the time when the function will stop. Default is when it's actually finishing. + +*/ diff --git a/doc/user_guide/doxygen/examples.doc b/doc/user_guide/doxygen/examples.doc new file mode 100644 index 0000000000..e9053e9d49 --- /dev/null +++ b/doc/user_guide/doxygen/examples.doc @@ -0,0 +1,10 @@ +/** +\defgroup MSG_examples MSG examples +\brief MSG examples from examples directory examples/msg + +MSG comes with an extensive set of examples. It is sometimes difficult to find the one you need. This list aims at helping you finding the example from which you can learn what you want to. + +\section msg_bsc_ex Basic examples + +*/ + diff --git a/doc/user_guide/doxygen/platform.doc b/doc/user_guide/doxygen/platform.doc index f4f4eab8c3..72d45f1547 100644 --- a/doc/user_guide/doxygen/platform.doc +++ b/doc/user_guide/doxygen/platform.doc @@ -11,35 +11,9 @@ to its doc. (you can also check the section \ref pf_flexml_bypassing but this \li You can use two XML files: a platform description file and a deployment description one. -As the second one (deployment description) just consists of saying which -process runs where and which arguments it should take as input, the easier way to -understand how to write it is just to take a look at the examples. Here is an example of it: +For the deployment stuff, please takea look at \ref deployment -\verbatim - - - - - - - - - - - - - - - - - - - - - -\endverbatim - -The platform description is slightly more complicated. This documentation is all about how to write this file: what are the basic concept it relies on, what possibilities are offered, and some hints and tips on how to write a good platform description. +The platform description may be complicated. This documentation is all about how to write this file: what are the basic concept it relies on, what possibilities are offered, and some hints and tips on how to write a good platform description. \section pf_overview Some words about XML and DTD @@ -159,10 +133,6 @@ It is also possible to seamlessly declare a host whose availability changes over time using the availability_file attribute and a separate text file whose syntax is exemplified below. - -IMPORTANT NOTE: the numeric separator in both trace and availability depends on your system locale. Examples below holds for LC_NUMERIC=C. - - Adding a trace file \verbatim