X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/d2870500ed94896ec3b064fa67af8d729920c007..3fa78c2064c144ac3b4035142261bda6cead8211:/doc/doxygen/options.doc

diff --git a/doc/doxygen/options.doc b/doc/doxygen/options.doc
index 37832fe87d..a31c819f8e 100644
--- a/doc/doxygen/options.doc
+++ b/doc/doxygen/options.doc
@@ -117,11 +117,10 @@ described in
     lmm_solve (experts only; check the code for more info).
 
 If you compiled SimGrid accordingly, you can use packet-level network
-simulators as network models (see \ref pls). In that case, you have
+simulators as network models (see \ref pls_ns3). In that case, you have
 two extra models, described below, and some \ref options_pls "specific
 additional configuration flags".
-  - \b NS3: Network pseudo-model using the NS3 tcp model instead of an
-    analytic model
+  - \b NS3: Network pseudo-model using the NS3 tcp model
 
 Concerning the CPU, we have only one model for now:
   - \b Cas01: Simplistic CPU model (time=size/power)
@@ -553,7 +552,7 @@ to the most effient:
    pthreads or windows native threads)
  - \b ucontext: fast factory using System V contexts (or a portability
    layer of our own on top of Windows fibers)
- - \b raw: amazingly fast factory using a context switching mecanism
+ - \b raw: amazingly fast factory using a context switching mechanism
    of our own, directly implemented in assembly (only available for x86
    and amd64 platforms for now)
  - \b boost: This uses the [context implementation](http://www.boost.org/doc/libs/1_59_0/libs/context/doc/html/index.html)
@@ -636,7 +635,7 @@ which value is either:
 
 \section options_tracing Configuring the tracing subsystem
 
-The \ref tracing "tracing subsystem" can be configured in several
+The \ref outcomes_vizu "tracing subsystem" can be configured in several
 different ways depending on the nature of the simulator (MSG, SimDag,
 SMPI) and the kind of traces that need to be obtained. See the \ref
 tracing_tracing_options "Tracing Configuration Options subsection" to
@@ -683,7 +682,7 @@ reproduce an experiment. You have two ways to do that:
 
 - Add the contents of a textual file on top of the trace file as comment:
 \verbatim
---cfg=tracing/comment_file:my_file_with_additional_information.txt
+--cfg=tracing/comment-file:my_file_with_additional_information.txt
 \endverbatim
 
 Please, use these two parameters (for comments) to make reproducible
@@ -762,6 +761,33 @@ computation.
     you should check the SMPI_SAMPLE macros, documented in the chapter
     \ref SMPI_adapting_speed.
 
+\subsection options_model_smpi_adj_file smpi/comp-adjustment-file: Slow-down or speed-up parts of your code.
+
+This option allows you to pass a file that contains two columns: The first column
+defines the section that will be subject to a speedup; the second column is the speedup.
+
+For instance:
+
+\verbatim
+"start:stop","ratio"
+"exchange_1.f:30:exchange_1.f:130",1.18244559422142
+\endverbatim
+
+The first line is the header - you must include it.
+The following line means that the code between two consecutive MPI calls on
+line 30 in exchange_1.f and line 130 in exchange_1.f should receive a speedup
+of 1.18244559422142. The value for the second column is therefore a speedup, if it is
+larger than 1 and a slow-down if it is smaller than 1. Nothing will be changed if it is
+equal to 1.
+
+Of course, you can set any arbitrary filenames you want (so the start and end don't have to be
+in the same file), but be aware that this mechanism only supports @em consecutive calls!
+
+\note
+    Please note that you must pass the \b -trace-call-location flag to smpicc
+    or smpiff, respectively! This flag activates some macro definitions in our
+    mpi.h / mpi.f files that help with obtaining the call location.
+
 \subsection options_model_smpi_bw_factor smpi/bw-factor: Bandwidth factors
 
 The possible throughput of network links is often dependent on the
@@ -1118,6 +1144,7 @@ silently overflow on other parts of the memory.
 - \c smpi/async-small-thresh: \ref options_model_network_asyncsend
 - \c smpi/bw-factor: \ref options_model_smpi_bw_factor
 - \c smpi/coll-selector: \ref options_model_smpi_collectives
+- \c smpi/comp-adjustment-file: \ref options_model_smpi_adj_file
 - \c smpi/cpu-threshold: \ref options_smpi_bench
 - \c smpi/display-timing: \ref options_smpi_timing
 - \c smpi/lat-factor: \ref options_model_smpi_lat_factor