X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/0bc630c2ea7629342151adfbe8c71065fca003e0..757ea9f06e8648bf2d3c6582a0c2b6f2ab48ed26:/doc/doxygen/deployment.doc diff --git a/doc/doxygen/deployment.doc b/doc/doxygen/deployment.doc index 107b44b3ca..7168ff3a65 100644 --- a/doc/doxygen/deployment.doc +++ b/doc/doxygen/deployment.doc @@ -1,29 +1,29 @@ -/*! \page deployment Deploy the simulation +/*! @page deployment Deploy the simulation -\section dep_over Overview +@section dep_over Overview When you want to simulate the behavior of your code with SimGrid, you need to tell SimGrid exactly what code (that you wrote) is supposed to be run by which host - so you need to assign -processes/functions to hosts. The hosts in question here are the hosts of your platform model; see Section \ref platform for details on how to set one up. +processes/functions to hosts. The hosts in question here are the hosts of your platform model; see Section @ref platform for details on how to set one up. -This assignment of the form \c code -> \c host is what the deployment file is all about, which will +This assignment of the form @c code -> @c host is what the deployment file is all about, which will be discussed briefly here. -\note +@note You can bypass the deployment file by hardcoding it in your user code, at least when you're using MSG. -The deployment file looks just like a \ref platform "platform" file, except that in -this case, only two different tags are used: \c process and \c argument, whereas +The deployment file looks just like a @ref platform "platform" file, except that in +this case, only two different tags are used: @c process and @c argument, whereas the latter is just used to supply additional configuration options to the process; the -order in which the \c argument tags are given is important and depends on the application. +order in which the @c argument tags are given is important and depends on the application. ### The process tag ### #### Attribute list #### -%As already written above, the \c process tag is the tag that defines which host -executes which function (from your application). Hence, the \c host and \c function +%As already written above, the @c process tag is the tag that defines which host +executes which function (from your application). Hence, the @c host and @c function attributes are mandatory; however, there are some optional attributes to the process tag. Here is a list of all attributes of this tag: | Attribute name | Mandatory | Values | Description | @@ -36,14 +36,14 @@ attributes are mandatory; however, there are some optional attributes to the pro #### An example #### -A complete example including a \ref MSG_ext_ms_application "deployment file" can be found -in the Section \ref MSG_ex_basics "MSG basics". +A complete example including a @ref MSG_ext_ms_application "deployment file" can be found +in the Section @ref msg_ex_basics "MSG basics". -See also files such as \c examples/msg/masterslave/deployment_masterslave.xml. +See also files such as @c examples/msg/masterslave/deployment_masterslave.xml. ### The argument tag ### -This tag must always be contained by a \c process tag - it doesn't make sense +This tag must always be contained by a @c process tag - it doesn't make sense without it. The way this works is that the order of arguments must be pre-defined by the user: @@ -59,9 +59,9 @@ executed by this process) in the order you declare them. #### An example #### -A complete example including a \ref MSG_ext_ms_application "deployment file" can be found -in the Section \ref MSG_ex_basics "MSG basics". +A complete example including a @ref MSG_ext_ms_application "deployment file" can be found +in the Section @ref msg_ex_basics "MSG basics". -See also files such as \c examples/msg/masterslave/deployment_masterslave.xml. +See also files such as @c examples/msg/masterslave/deployment_masterslave.xml. */