From: Martin Quinson Date: Fri, 28 Jun 2019 23:05:36 +0000 (+0200) Subject: doc: various formating fixups X-Git-Tag: v3.23.2~62 X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/commitdiff_plain/409b6c7008f4666656cb9e49336319a33ecb90ed doc: various formating fixups --- diff --git a/docs/source/Configuring_SimGrid.rst b/docs/source/Configuring_SimGrid.rst index 1eb7edb09e..b980e4ad1a 100644 --- a/docs/source/Configuring_SimGrid.rst +++ b/docs/source/Configuring_SimGrid.rst @@ -81,8 +81,8 @@ Existing Configuration Items The full list can be retrieved by passing ``--help`` and ``--help-cfg`` to an executable that uses SimGrid. Try passing ``help`` as a value to get the list of values accepted by a given - option. For example, ``--cfg=plugin:help`` will give you the list - of plugins available in your installation of SimGrid. + option. For example, ``--cfg=plugin:help`` will give you the list + of plugins available in your installation of SimGrid. - **contexts/factory:** :ref:`cfg=contexts/factory` - **contexts/guard-size:** :ref:`cfg=contexts/guard-size` diff --git a/docs/source/Tutorial_Algorithms.rst b/docs/source/Tutorial_Algorithms.rst index d5b16cfccb..7ec4f4791d 100644 --- a/docs/source/Tutorial_Algorithms.rst +++ b/docs/source/Tutorial_Algorithms.rst @@ -202,6 +202,8 @@ This time, we have all parts: once the program is compiled, we can execute it as follows. Note how the XBT_INFO() requests turned into informative messages. +.. "WARNING: Over dedent has detected" is expected here as we remove the $ marker this way + .. literalinclude:: ../../examples/s4u/app-masterworkers/s4u-app-masterworkers.tesh :language: shell :start-after: s4u-app-masterworkers-fun diff --git a/docs/source/app_smpi.rst b/docs/source/app_smpi.rst index 1b140ecea5..048413c7ba 100644 --- a/docs/source/app_smpi.rst +++ b/docs/source/app_smpi.rst @@ -532,7 +532,7 @@ privatized the globals through static analysis of the source code. But our implementation was not robust enough to be used in production, so it was removed at some point. Currently, SMPI comes with two privatization mechanisms that you can :ref:`select at runtime -`_. The dlopen approach is used by +`. The dlopen approach is used by default as it is much faster and still very robust. The mmap approach is an older approach that proves to be slower. diff --git a/docs/source/community.rst b/docs/source/community.rst index a62d5ed3b0..e012d35480 100644 --- a/docs/source/community.rst +++ b/docs/source/community.rst @@ -22,7 +22,7 @@ to us and say hello! We love earing about how people use SimGrid. - For questions or remarks, drop us an email on the `user mailing list `_ (to subscribe, visit the `web interface - `_); + `__); you can also check out `our archives `_. We prefer you to **not use private emails**. SimGrid is an open @@ -31,7 +31,7 @@ to us and say hello! We love earing about how people use SimGrid. list. - Join us on IRC and ask your question directly on the channel \#simgrid at ``irc.debian.org`` - (or use the ugly `web interface `_ + (or use the ugly `web interface `__ if you don't have a `real client `_ installed). When no non-french speaker are connected, we usually