From b4ec5b5ba51aafa4d46843bfb3620461cd99d4f0 Mon Sep 17 00:00:00 2001 From: Augustin Degomme Date: Fri, 12 Jun 2020 12:11:04 +0200 Subject: [PATCH] spelling mistakes in docs/ --- docs/find-missing.ignore | 2 +- docs/manpages/tesh.pod | 6 +++--- docs/source/Configuring_SimGrid.rst | 10 +++++----- docs/source/Deploying_your_Application.rst | 2 +- docs/source/Installing_SimGrid.rst | 2 +- docs/source/Start_Your_Own_Project.rst | 2 +- docs/source/app_msg.rst | 2 +- docs/source/application.rst | 2 +- docs/source/platform_howtos.rst | 4 ++-- 9 files changed, 16 insertions(+), 16 deletions(-) diff --git a/docs/find-missing.ignore b/docs/find-missing.ignore index cce9236018..e2ec4edbd1 100644 --- a/docs/find-missing.ignore +++ b/docs/find-missing.ignore @@ -1,5 +1,5 @@ This file lists the symbols ignored in the documentation. -It follows the RST syntact but is completely ignored by sphinx. +It follows the RST syntax but is completely ignored by sphinx. It is only used by find-missing, that will not report any definition linked here as missing. # These ones trigger a bug in autodoxy, that get confused with the const in the function parameter diff --git a/docs/manpages/tesh.pod b/docs/manpages/tesh.pod index 259a2fe72f..da7ef424f0 100755 --- a/docs/manpages/tesh.pod +++ b/docs/manpages/tesh.pod @@ -189,7 +189,7 @@ same timestamp. Here is a SimGrid example: ! output sort 19 $ ./some_simgrid_simulator --log=root.fmt:[%10.6r]%e(%i:%P@%h)%e%m%n -This approach may seem surprizing at the first glance but it does its job: +This approach may seem surprising at the first glance but it does its job: =over 4 @@ -213,7 +213,7 @@ usable by others, who knows? =head2 Ignoring some output -Some outputed lines can be ignored by setting the ignore command followed +Some outputted lines can be ignored by setting the ignore command followed by a regular expression: ! ignore .*0x[0-9A-F]+\. @@ -224,7 +224,7 @@ by a regular expression: =head2 Colored and formatted text -Tesh removes ANSI/VT100 control sequences from outputed text to make easier the writing of tests. +Tesh removes ANSI/VT100 control sequences from outputted text to make easier the writing of tests. $ printf "I \033[0;31mlove\033[0m tesh\n" > I love tesh diff --git a/docs/source/Configuring_SimGrid.rst b/docs/source/Configuring_SimGrid.rst index 029884cdca..a419959303 100644 --- a/docs/source/Configuring_SimGrid.rst +++ b/docs/source/Configuring_SimGrid.rst @@ -415,7 +415,7 @@ Simulating Asynchronous Send It is possible to specify that messages below a certain size (in bytes) will be sent as soon as the call to MPI_Send is issued, without waiting for -the correspondant receive. This threshold can be configured through +the correspondent receive. This threshold can be configured through the ``smpi/async-small-thresh`` item. The default value is 0. This behavior can also be manually set for mailboxes, by setting the receiving mode of the mailbox with a call to @@ -444,7 +444,7 @@ Configuring the Storage model .. _cfg=storage/max_file_descriptors: -File Descriptor Cound per Host +File Descriptor Count per Host ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ **Option** ``storage/max_file_descriptors`` **Default:** 1024 @@ -530,7 +530,7 @@ Specifying a liveness property If you want to specify liveness properties, you have to pass them on the command line, specifying the name of the file containing the property, as formatted by the `ltl2ba `_ program. -Note that ltl2ba is not part of SimGrid and must be installed separatly. +Note that ltl2ba is not part of SimGrid and must be installed separately. .. code-block:: shell @@ -719,7 +719,7 @@ MC-related options, keep non-MC-related ones and add Currently, if the path is of the form ``X;Y;Z``, each number denotes the actor's pid that is selected at each indecision point. If it's of the form ``X/a;Y/b``, the X and Y are the selected pids while the a -and b are the return values of their simcalls. In the previouse +and b are the return values of their simcalls. In the previous example, ``1/3;1/4``, you can see from the full output that the actor 1 is doing MC_RANDOM simcalls, so the 3 and 4 simply denote the values that these simcall return. @@ -1390,7 +1390,7 @@ for each shared block. With the ``global`` algorithm, each call to SMPI_SHARED_MALLOC() returns a new address, but it only points to a shadow block: its memory area is mapped on a 1 MiB file on disk. If the returned block is of size -N MiB, then the same file is mapped N times to cover the whole bloc. +N MiB, then the same file is mapped N times to cover the whole block. At the end, no matter how many times you call SMPI_SHARED_MALLOC, this will only consume 1 MiB in memory. diff --git a/docs/source/Deploying_your_Application.rst b/docs/source/Deploying_your_Application.rst index 23dab0552b..2eb5d0fa76 100644 --- a/docs/source/Deploying_your_Application.rst +++ b/docs/source/Deploying_your_Application.rst @@ -20,7 +20,7 @@ study on your :ref:`simulated platform `, i.e. to specify which actor should be started on which host. You can do so directly in your program (as shown in :ref:`these examples `), or using an XML deployment file. Unless you have a good reason, you should keep your application apart -from the deployment as it will :ref:`ease your experimental campain afterward +from the deployment as it will :ref:`ease your experimental campaign afterward `. Deploying actors from XML is easy: it only involves 3 tags: :ref:`pf_tag_actor`, diff --git a/docs/source/Installing_SimGrid.rst b/docs/source/Installing_SimGrid.rst index 78e9c9f628..47c344749e 100644 --- a/docs/source/Installing_SimGrid.rst +++ b/docs/source/Installing_SimGrid.rst @@ -72,7 +72,7 @@ per year, numbered 3.24 or 3.25. Backward compatibility is ensured for one year: Code compiling without warning on 3.24 will still compile with 3.28, but maybe with some deprecation warnings. You should update your SimGrid installation at least once a year and fix those -deprecation warnings: the compatiblity wrappers are usually removed +deprecation warnings: the compatibility wrappers are usually removed after 4 versions. Another approach is to never update your SimGrid installation, but we don't provide any support to old versions. diff --git a/docs/source/Start_Your_Own_Project.rst b/docs/source/Start_Your_Own_Project.rst index 6297e2ee85..d24eea4304 100644 --- a/docs/source/Start_Your_Own_Project.rst +++ b/docs/source/Start_Your_Own_Project.rst @@ -192,6 +192,6 @@ Sometimes, the compilation only spits very few "undefined reference" errors. A possible cause is that the system selected an old version of the SimGrid library somewhere on your disk. -Dicover which version is used with ``ldd name-of-yoursimulator``. +Discover which version is used with ``ldd name-of-yoursimulator``. Once you've found the obsolete copy of SimGrid, just erase it, and recompile and relaunch your program. diff --git a/docs/source/app_msg.rst b/docs/source/app_msg.rst index 432b50520d..f68fe2d38e 100644 --- a/docs/source/app_msg.rst +++ b/docs/source/app_msg.rst @@ -276,7 +276,7 @@ Network Zone (:cpp:class:`msg_file_t`) and associated functions. Java bindings ************* -This section describes jMSG, the Java API to Simgrid. This API mimicks +This section describes jMSG, the Java API to Simgrid. This API mimics :ref:`MSG `, which is a simple yet somehow realistic interface. The full reference documentation is provided at the end of this page. diff --git a/docs/source/application.rst b/docs/source/application.rst index a568dc4305..4e46704a50 100644 --- a/docs/source/application.rst +++ b/docs/source/application.rst @@ -26,7 +26,7 @@ to mix several interfaces in the same simulation. - In some cases, you may want to replay an execution trace in the simulator. This trace lists the events of your application or of your workload, and your application is decomposed as a list of event handlers that are - fired according to the trace. SimGrid comes with a build-in support + fired according to the trace. SimGrid comes with a built-in support for MPI traces (with solutions to import traces captured by several MPI profilers). You can reuse this mechanism for any kind of trace that you want to replay, for example to study how a P2P DHT overlay diff --git a/docs/source/platform_howtos.rst b/docs/source/platform_howtos.rst index 2a135eaaf3..e7dc6206e9 100644 --- a/docs/source/platform_howtos.rst +++ b/docs/source/platform_howtos.rst @@ -288,8 +288,8 @@ on such a simple example: - When data is transferred from A to B, some TCP ACK messages travel in the opposite direction. To reflect the impact of this `cross-traffic`, SimGrid simulates a flow from B to A that represents an additional bandwidth - consumption of `0.05`. The route from B to A is implicity declared in the - platfrom file and uses the same link `link1` as if the two hosts were + consumption of `0.05`. The route from B to A is implicitly declared in the + platform file and uses the same link `link1` as if the two hosts were connected through a communication bus. The bandwidth share allocated to the flow from A to B is then the available bandwidth of `link1` (i.e., 97% of the nominal bandwidth of 1Mb/s) divided by 1.05 (i.e., the total consumption). -- 2.20.1