From: Martin Quinson Date: Mon, 25 Mar 2013 21:02:34 +0000 (+0100) Subject: documentation cosmetics X-Git-Tag: v3_9_90~412^2~96 X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/commitdiff_plain/f11b3ca51b38290288a29dd2f48d54aef6dbeb73 documentation cosmetics --- diff --git a/doc/doxygen/bindings.doc b/doc/doxygen/bindings.doc index 0a8cbbdb3a..accc6b908a 100644 --- a/doc/doxygen/bindings.doc +++ b/doc/doxygen/bindings.doc @@ -1,9 +1,9 @@ /*! \page bindings Bindings -\section bindings_binding_Ruby Ruby Binding +\section MSG_Ruby Ruby Binding Check online for our specific [Simgrid-Ruby documentation](http://simgrid.gforge.inria.fr/documentation.html). -\section bindings_binding_Java Java Binding +\section MSG_Java Java Binding Simgrid-java is a java API that let you use [Simgrid](http://simgrid.gforge.inria.fr/) MSG API in your favorite language (java). Without it, you would be forced to use C or one of the other bindings provided. diff --git a/doc/doxygen/module-msg.doc b/doc/doxygen/module-msg.doc index a96494e030..2241a153d3 100644 --- a/doc/doxygen/module-msg.doc +++ b/doc/doxygen/module-msg.doc @@ -1,18 +1,26 @@ /** \addtogroup MSG_API - MSG was the first distributed programming environment provided within - SimGrid. While almost realistic, it remains quite simple (simplistic?). - This describes the native to MSG. - - \section jMSG_who Who should use this (and who shouldn't) - - You should use MSG if you want to study some heuristics for a - given problem you don't really want to implement. If you want to - use the C programming language, your are in the right - section. To use the Java or Ruby programming interfaces, please refer to - the documentation provided in the relevant packages. - - \section MSG_funct Offered functionnalities +MSG was the first distributed programming environment provided within SimGrid, +and is still the most commonly used nowadays. If you are unsure of the interface +you should use, they you probably want to use MSG. It constitutes a convenient +simplification of the reality of distributed systems. It can be used to build +rather realistic simulations, but remains simple to use: most unpleasant +technical elements can be abstracted away rather easily. If you want to use the +C programming language, your are in the right section. If you prefer not to use +this venerable but demanding language, please refer to the @ref MSG_Java, the +@ref MSG_LUA, or the @ref MSG_Ruby (that are distributed separately). + +If you think that MSG may not be the interface you need, please consider the +other user interfaces provided by SimGrid: If you want to use DAGs, have a look +at the \ref SD_API programming environment. If you want to study an existing MPI +program, have a look at the \ref SMPI_API one. If none of those programming +environments fits your needs, you may consider implementing your own directly on +top of \ref SIMIX_API, or even on top of \ref SURF_API (but you want to contact +us before digging into these badly documented internal modules). + + + +\section MSG_funct Offered functionalities - \ref msg_simulation - \ref m_process_management - \ref m_host_management @@ -86,7 +94,7 @@ details). /** @defgroup msg_VMs VMs * @ingroup MSG_API - * @brief This section describes the interface created to mimick IaaS clouds. + * @brief This section describes the interface created to mimic IaaS clouds. * * With it, you can create virtual machines to put your processes * into, and interact directly with the VMs to manage groups of @@ -146,14 +154,13 @@ This is the lua bindings of the \ref MSG_API interface. \section lMSG_who Who should use this (and who shouldn't) -If you want to use MSG to study your algorithm, but you don't want to -use the C language (using \ref MSG_API), then you should use some -bindings such as this one. The advantage of the lua bindings is that -they are distributed directly with the main archive (in contrary to -Java and Ruby bindings, for example, that are distributed separately). -Another advantage of lua is that there is almost no performance loss -with regard to the C version (at least there shouln't be any -- it is -still to be precisely assessed). +If you want to use MSG to study your algorithm, but you don't want to use the C +language (using \ref MSG_API), then you should use some bindings such as this +one. Just like the \ref MSG_Java, the advantage of the lua bindings is that they +are distributed directly with the main archive (in contrary to Ruby bindings, +that are distributed separately). Another advantage of lua is that there is +almost no performance loss with regard to the C version (at least there +shouldn't be any -- it is still to be precisely assessed). \section MSG_Lua_funct Lua offered functionnalities in MSG diff --git a/doc/doxygen/module-smpi.doc b/doc/doxygen/module-smpi.doc index 77abc9bbd1..a5c509968a 100644 --- a/doc/doxygen/module-smpi.doc +++ b/doc/doxygen/module-smpi.doc @@ -16,18 +16,16 @@ otherwise increase their scalability (see @ref SMPI_adapting). SMPI is now considered as stable and you can use it in production. You may probably want to read the scientific publications that detail the models used and their limits, but this should not be absolutely -necessary. - -If you already fluently write and use MPI applications, SMPI should -sound very familiar to you. Use smpicc instead of mpicc, and smpirun -instead of mpirun. Some more information are given below on this page. +necessary. If you already fluently write and use MPI applications, +SMPI should sound very familiar to you. Use smpicc instead of mpicc, +and smpirun instead of mpirun (see below for more details). Of course, if you don't know what MPI is, the documentation of SMPI will seem a bit terse to you. You should pick up a good MPI tutorial -on the Internet (or a course in your university) and come back to SMPI -once you know a bit more about MPI. Alternatively, you may want to -turn to the other SimGrid interface such as the \ref MSG_API -environment, or the \ref SD_API one. +on the Internet (or a course in your favorite university) and come +back to SMPI once you know a bit more about MPI. Alternatively, you +may want to turn to the other SimGrid interfaces such as the +\ref MSG_API environment, or the \ref SD_API one. \section SMPI_what What can run within SMPI? diff --git a/doc/doxygen/modules.doc b/doc/doxygen/modules.doc index ce56ce343b..7b5f076a44 100644 --- a/doc/doxygen/modules.doc +++ b/doc/doxygen/modules.doc @@ -2,19 +2,6 @@ @defgroup MSG_API MSG @brief Simple programming environment -MSG was the first distributed programming environment provided within -SimGrid. While almost realistic, it remains quite simple -(simplistic?). - -@section MSG_who Who should use this (and who shouldn't) - -You should use this module if you want to study some heuristics for a -given problem you don't really want to implement. If you want to use -DAGs, have a look at the \ref SD_API programming environment. If you -want to study an existing MPI program, have a look at the \ref -SMPI_API one. If none of those programming environments fits your -needs, you may consider implementing your own directly on top of -\ref SURF_API (but you probably want to contact us before). */ /**