From: Christian Heinrich Date: Tue, 23 Aug 2016 14:53:17 +0000 (+0200) Subject: [DOC] Remove references to old 'power' attribute from the platform doc X-Git-Tag: v3_14~459^2~1 X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/commitdiff_plain/f1bac9f63fe8744840fc04de2e3bc23beed2bfd1 [DOC] Remove references to old 'power' attribute from the platform doc --- diff --git a/doc/doxygen/platform.doc b/doc/doxygen/platform.doc index 7f4b8f22fb..8137f80862 100644 --- a/doc/doxygen/platform.doc +++ b/doc/doxygen/platform.doc @@ -137,8 +137,8 @@ routing | yes | Full\| Floyd\| Dijkstra\| DijkstraCache\| None\| V Example: \code - - + + @@ -161,7 +161,7 @@ Attribute name | Mandatory | Values | Description --------------- | --------- | ------ | ----------- id | yes | String | The identifier of the host. facilitates referring to this AS. speed | yes | double (must be > 0.0) | Computational power of every core of this host in FLOPS. Must be larger than 0.0. -core | no | int (Default: 1) | The number of cores of this host. If more than one core is specified, the "power" parameter refers to every core, i.e., the total computational power is no_of_cores*power.
If 6 cores are specified, up to 6 tasks can be executed without sharing the computational power; if more than 6 tasks are executed, computational power will be shared among these tasks.
Warning: Although functional, this model was never scientifically assessed. +core | no | int (Default: 1) | The number of cores of this host. If more than one core is specified, the "speed" parameter refers to every core, i.e., the total computational power is no_of_cores*speed.
If 6 cores are specified, up to 6 tasks can be executed without sharing the computational power; if more than 6 tasks are executed, computational power will be shared among these tasks.
Warning: Although functional, this model was never scientifically assessed. availability_file| no | string | (Relative or absolute) filename to use as input; must contain availability traces for this host. The syntax of this file is defined below.
Note: The filename must be specified with your system's format. state_file | no | string | Same mechanism as availability_file.
Note: The filename must be specified with your system's format. coordinates | no | string | Must be provided when choosing the Vivaldi, coordinate-based routing model for the AS the host belongs to. More details can be found in the Section \ref pf_P2P_tags. @@ -177,8 +177,8 @@ Tag name | Description | Documentation ### Example ### \verbatim - - + + @@ -196,7 +196,7 @@ and a separate text file whose syntax is exemplified below. \verbatim - + \endverbatim @@ -231,7 +231,7 @@ It is also possible to specify whether the host is up or down by setting the \verbatim - + \endverbatim @@ -320,7 +320,7 @@ id | yes | string | The identifier of the cluster. Facilitate prefix | yes | string | Each node of the cluster has to have a name. This name will be prefixed with this prefix. suffix | yes | string | Each node of the cluster will be suffixed with this suffix radical | yes | string | Regexp used to generate cluster nodes name. Syntax: "10-20" will give you 11 machines numbered from 10 to 20, "10-20;2" will give you 12 machines, one with the number 2, others numbered as before. The produced number is concatenated between prefix and suffix to form machine names. -power | yes | int | Same as the ``power`` attribute of the ``\`` tag. +speed | yes | int | Same as the ``speed`` attribute of the ``\`` tag. core | no | int (default: 1) | Same as the ``core`` attribute of the ``\`` tag. bw | yes | int | Bandwidth for the links between nodes and backbone (if any). See the \ref pf_link "link section" for syntax/details. lat | yes | int | Latency for the links between nodes and backbone (if any). See link section for syntax/details. @@ -349,10 +349,10 @@ Consider the following two (and independent) uses of the ``cluster`` tag: \verbatim + speed="1e9" bw="125e6" lat="5E-5"/> \endverbatim @@ -386,7 +386,7 @@ id | yes | string | The identifier of the cabinet. Facilitate prefix | yes | string | Each node of the cabinet has to have a name. This name will be prefixed with this prefix. suffix | yes | string | Each node of the cabinet will be suffixed with this suffix radical | yes | string | Regexp used to generate cabinet nodes name. Syntax: "10-20" will give you 11 machines numbered from 10 to 20, "10-20;2" will give you 12 machines, one with the number 2, others numbered as before. The produced number is concatenated between prefix and suffix to form machine names. -power | yes | int | Same as the ``power`` attribute of the \ref pf_host "<host>" tag. +speed | yes | int | Same as the ``speed`` attribute of the \ref pf_host "<host>" tag. bw | yes | int | Bandwidth for the links between nodes and backbone (if any). See the \ref pf_link "link section" for syntax/details. lat | yes | int | Latency for the links between nodes and backbone (if any). See the \ref pf_link "link section" for syntax/details. @@ -403,11 +403,11 @@ shows how to use the cabinet tag. \verbatim + speed="1Gf" bw="125MBps" lat="100us" radical="1-10"/> + speed="1Gf" bw="125MBps" lat="100us" radical="11-20"/> + speed="1Gf" bw="125MBps" lat="100us" radical="21-30"/> @@ -442,7 +442,7 @@ and values. These are: Attribute name | Mandatory | Values | Description --------------- | --------- | ------ | ----------- id | yes | string | The identifier of the peer. Facilitates referring to this peer. -power | yes | int | See the description of the ``host`` tag for this attribute +speed | yes | int | See the description of the ``host`` tag for this attribute bw_in | yes | int | Bandwidth downstream bw_out | yes | int | Bandwidth upstream lat | yes | double | Latency for both up- and downstream, in seconds. @@ -455,7 +455,7 @@ Internally, SimGrid transforms any ``\`` construct such as \verbatim @@ -465,7 +465,7 @@ is completely equivalent to the following declaration: \verbatim - + @@ -884,11 +884,11 @@ Here is a simple example, taken from the file ``examples/platform/storage.xml``: content="content/small_content.txt" content_type="txt_unix" attach="denise"/> - + - + @@ -1050,11 +1050,11 @@ Floyd example: - + @@ -1091,9 +1091,9 @@ routing model (the path is given relative to SimGrid's source directory) Dijkstra example : \verbatim - - - + + + @@ -1114,7 +1114,7 @@ Dijkstra example : DijkstraCache example: \verbatim - + ... (platform unchanged compared to upper example) \endverbatim @@ -1141,8 +1141,8 @@ if there are no example files listed here, this is likely to be correct. Full example : \verbatim - - + + @@ -1305,12 +1305,12 @@ This is mainly useful when you're in the \ref pf_routing_model_full "Full routin \verbatim + radical="150-299" speed="1000000000" bw="125000000" lat="5E-5" + bb_bw="2250000000" bb_lat="5E-4"/> @@ -1470,7 +1470,7 @@ information to SimGrid. Here is a file doing it all : \verbatim - + @@ -1478,9 +1478,9 @@ information to SimGrid. Here is a file doing it all : - - - + + + @@ -1606,7 +1606,7 @@ entity. \verbatim - + @@ -1693,8 +1693,8 @@ non-intuitive schema ... Something like that : - - + + @@ -1748,10 +1748,10 @@ complicated in using it, here is an example of it: - - + + ... - + \endverbatim @@ -1778,9 +1778,9 @@ That is for example what is commonly done when using peers (see Section \ref pf_ - - - + + + \endverbatim