Skip to content

Commit 317832d

Browse files
committed
Fix typos in the docs/ sub-directory
Found via `codespell -q 3 -S ./3rd-party,./docs/news -L ans,chello,configury,inout,scoll` Fix RST formatting Signed-off-by: luz paz <luzpaz@pm.me>
1 parent 7abb14b commit 317832d

35 files changed

+66
-66
lines changed

docs/building-apps/building-static-apps.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ sub-optimal:
7474

7575
For example, if you launch N copies of your fully-statically-linked
7676
MPI application on a node, it will consume (N *
77-
size_of_the_application) bytes of RAM. Alternatiely, launching N
77+
size_of_the_application) bytes of RAM. Alternately, launching N
7878
copies of a dynamically-linked MPI application |mdash| where each
7979
of the copies have the same dependent libraries |mdash| will only
8080
load each shared dependent library into RAM once.
@@ -157,7 +157,7 @@ libraries that require additional steps to produce working
157157
fully-static MPI applications. For example, any library that has its
158158
own run-time plugin system (i.e., that opens dynamically shared
159159
objects ("DSOs") at run time) will have additional complications in
160-
producting fully-static builds.
160+
producing fully-static builds.
161161

162162
In such cases, you generally want to run ``mpicc ... --showme`` to see
163163
the compiler / linker commands that Open MPI's wrapper commands will

docs/faq/debugging.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -509,7 +509,7 @@ There are two cases:
509509
.. We do not make the code block below as "c" because the Sphinx C
510510
syntax highlighter fails to parse it as C and emits a warning.
511511
So we might as well just leave it as a plan verbatim block
512-
(i.e., not syntax hilighted).
512+
(i.e., not syntax highlighted).
513513
514514
.. code-block::
515515

docs/faq/general-tuning.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -166,7 +166,7 @@ files. If you need a component to be available to all nodes where you
166166
run MPI jobs, then you need to ensure that it is visible on all nodes
167167
(typically either by installing it on all nodes for non-networked
168168
filesystem installs, or by installing them in a directory that is
169-
visibile to all nodes via a networked filesystem). Open MPI does not
169+
visible to all nodes via a networked filesystem). Open MPI does not
170170
automatically send components to remote nodes when MPI jobs are run.
171171

172172
/////////////////////////////////////////////////////////////////////////
@@ -588,7 +588,7 @@ allocated.
588588
How do I tell Open MPI to use processor and/or memory affinity?
589589
---------------------------------------------------------------
590590

591-
Open MPI will, by default, enable processor and memory affinty when
591+
Open MPI will, by default, enable processor and memory affinity when
592592
not running in an oversubscribed environment (i.e., when the number of
593593
MPI processes are less than or equal two the number of processors
594594
available).

docs/faq/running-mpi-apps.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1312,8 +1312,8 @@ not 4), and can cause extremely bad performance.
13121312
13131313
/////////////////////////////////////////////////////////////////////////
13141314
1315-
Can I force Agressive or Degraded performance modes?
1316-
----------------------------------------------------
1315+
Can I force Aggressive or Degraded performance modes?
1316+
-----------------------------------------------------
13171317
13181318
Yes.
13191319

docs/faq/troubleshooting.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ why this can happen.
6161
linker is smart enough to not load ``libmpi`` twice |mdash| but it
6262
does keeps ``libmpi`` in a public scope.
6363
* Use the ``--disable-dlopen`` or ``--disable-mca-dso`` options to
64-
Open MPI's ``configure`` script (see this TODO NONEXISTANT FAQ entry
64+
Open MPI's ``configure`` script (see this TODO NONEXISTENT FAQ entry
6565
for more details on these
6666
options). These options slurp all of Open MPI's plugins up in to
6767
``libmpi`` |mdash| meaning that the plugins physically reside in

docs/features/extensions.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,8 @@ to MPI applications.
1515
provide new functionality to users, typically before it becomes
1616
standardized by the MPI Forum.
1717

18-
Available extenions
19-
-------------------
18+
Available extensions
19+
--------------------
2020

2121
The following extensions are included in this version of Open MPI:
2222

docs/features/ulfm.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -110,7 +110,7 @@ is definitely built.
110110
Support notes
111111
^^^^^^^^^^^^^
112112

113-
* ULFM Fault Tolerance does not apply to OpenSHMEM. It is recomended
113+
* ULFM Fault Tolerance does not apply to OpenSHMEM. It is recommended
114114
that if you are going to use ULFM, you should disable building
115115
OpenSHMEM with ``--disable-oshmem``.
116116

@@ -139,7 +139,7 @@ All runtime disabled components are listed in the ``ft-mpi`` aggregate
139139
MCA param file
140140
``$installdir/share/openmpi/amca-param-sets/ft-mpi``. You can tune the
141141
runtime behavior with ULFM by either setting or unsetting variables in
142-
this file (or by overiding the variable on the command line (e.g.,
142+
this file (or by overriding the variable on the command line (e.g.,
143143
``--mca btl ofi,self``). Note that if fault tolerance is disabled at
144144
runtime, these components will load normally (this may change observed
145145
performance when comparing with and without fault tolerance).
@@ -305,7 +305,7 @@ Known Limitations in ULFM
305305
* InfiniBand support is provided through the UCT BTL; fault tolerant
306306
operation over the UCX PML is not yet supported for production runs.
307307
* TOPO, FILE, RMA are not fault tolerant. They are expected to work
308-
properly before the occurence of the first failure.
308+
properly before the occurrence of the first failure.
309309

310310
Changelog
311311
---------
@@ -460,7 +460,7 @@ ULFM Standalone Release 1.0
460460
^^^^^^^^^^^^^^^^^^^^^^^^^^^
461461

462462
Focus has been toward improving performance, both before and after the
463-
occurence of failures. The list of new features includes:
463+
occurrence of failures. The list of new features includes:
464464

465465
* Support for the non-blocking version of the agreement, MPI_COMM_IAGREE.
466466
* Compliance with the latest ULFM specification draft. In particular,

docs/getting-help.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ places. If you have:
5858
.. important:: Please **use a descriptive "subject" line in your
5959
email!** Some Open MPI question-answering people decide whether
6060
to read a mail based on its subject line (e.g., to see if it's a
61-
question that they can answer). So please plese please use a
61+
question that they can answer). So please please please use a
6262
good subject line that succinctly describes your problem.
6363

6464
#. **A bug report:** you should probably post it to `Open MPI's Github
@@ -89,7 +89,7 @@ Please provide *all* of the following information:
8989
are not helpful; we need to know as much information about your
9090
environment as possible in order to provide meaningful assistance.
9191

92-
**The best way to get help** is to provide a "recipie" for
92+
**The best way to get help** is to provide a "recipe" for
9393
reproducing the problem. This will allow the Open MPI developers
9494
to see the error for themselves, and therefore be able to fix it.
9595

@@ -191,8 +191,8 @@ Please provide *all* of the following information:
191191
are not helpful; we need to know as much information about your
192192
environment as possible in order to provide meaningful assistance.
193193

194-
**The best way to get help** is to provide a "recipie" for
195-
reproducing the problaem. This will allow the Open MPI developers
194+
**The best way to get help** is to provide a "recipe" for
195+
reproducing the problem. This will allow the Open MPI developers
196196
to see the error for themselves, and therefore be able to fix it.
197197

198198
#. The version of Open MPI that you're using.

docs/installing-open-mpi/installation-location.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -158,7 +158,7 @@ upgrading your Open MPI installation:
158158
Relocating an Open MPI installation
159159
-----------------------------------
160160

161-
It can be desireable to initially install Open MPI to one location
161+
It can be desirable to initially install Open MPI to one location
162162
(e.g., ``/path/to/openmpi``) and then later move it to another
163163
location (e.g., ``/opt/myproduct/bundled-openmpi-a.b.c``).
164164

docs/installing-open-mpi/quickstart.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -55,5 +55,5 @@ The above patterns can be used in many environments.
5555

5656
Note that there are many, many configuration options available in the
5757
``./configure`` step. Some of them may be needed for your particular
58-
HPC network interconnect type and/or computing environmnet; see the
59-
rest of this chapter for desciptions of the available options.
58+
HPC network interconnect type and/or computing environment; see the
59+
rest of this chapter for descriptions of the available options.

0 commit comments

Comments
 (0)