From 7aaac1ccdd8b0373140b3855cebfa80558ddc8d4 Mon Sep 17 00:00:00 2001 From: Christian Heinrich Date: Sat, 12 Sep 2015 20:09:44 +0200 Subject: [PATCH 1/1] [Doc] Updated deployment description file. --- doc/doxygen/deployment.doc | 30 ++++++++++++++++++++++++++++-- 1 file changed, 28 insertions(+), 2 deletions(-) diff --git a/doc/doxygen/deployment.doc b/doc/doxygen/deployment.doc index 460b2a4ae8..06602e3d5b 100644 --- a/doc/doxygen/deployment.doc +++ b/doc/doxygen/deployment.doc @@ -22,7 +22,9 @@ order in which the \c argument tags are given is important and depends on the ap #### Attribute list #### -There are optional attributes to the process tag, here is a list of all attributes of this tag: +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 | | --------------- | --------- | ---------------------- | ----------- | @@ -32,10 +34,34 @@ There are optional attributes to the process tag, here is a list of all attribut | kill_time | no | int (Default: -1.0) | The simulated time when this function will end to be computed. By default, it stops only when it's done. | | on_failure | no | DIE\|RESTART (Default: "DIE") | What should be done when the process fails. | -### An example ### +#### 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". +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 +without it. + +The way this works is that the order of arguments must be pre-defined by the user: +It is totally up to you what your code expects as arguments and in which +order. The arguments will be passed to your code (that is: to the function +executed by this process) in the order you declare them. + +#### Attribute list #### + +| Attribute name | Mandatory | Values | Description | +| --------------- | --------- | ---------------------- | ----------- | +| value | yes | String | Contains the value for this parameter | + +#### 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". + +See also files such as \c examples/msg/masterslave/deployment_masterslave.xml. */ -- 2.20.1