diff --git a/docs/launching-apps/quickstart.rst b/docs/launching-apps/quickstart.rst index 5196968ef35..aa671ccbc09 100644 --- a/docs/launching-apps/quickstart.rst +++ b/docs/launching-apps/quickstart.rst @@ -173,7 +173,7 @@ Using Open MPI's :ref:`mpirun(1) ` .. note:: Technically, Open MPI's :ref:`mpirun(1) ` is a thin layer around the PRRTE ``prun``. Hence, most of the functionality described here is really about ``prun``. For - simplicity, however, this docmentation will describe + simplicity, however, this documentation will describe everything in terms of ``mpirun``. When using the full-featured :ref:`mpirun(1) ` in a @@ -249,4 +249,3 @@ For example: Similar to the prior example, this example launches 40 copies of ``mpi-hello-world``, but it does so via the Slurm ``srun`` command without using :ref:`mpirun(1) `. - diff --git a/docs/launching-apps/ssh.rst b/docs/launching-apps/ssh.rst index 969e55fa826..39bd04a2732 100644 --- a/docs/launching-apps/ssh.rst +++ b/docs/launching-apps/ssh.rst @@ -39,7 +39,7 @@ There are three mechanisms for specifying the hosts that an MPI job will run on: If you are running in a scheduled environment (e.g., in a Slurm, Torque, or LSF job), Open MPI will automatically get the lists of hosts from the scheduler. See the next subsections for details about - launching MPI jobs in supported scheduled environements. + launching MPI jobs in supported scheduled environments. .. important:: The specification of hosts using any of the above methods has nothing to do with the network interfaces diff --git a/docs/launching-apps/unusual.rst b/docs/launching-apps/unusual.rst index 81737785393..058005fd0b8 100644 --- a/docs/launching-apps/unusual.rst +++ b/docs/launching-apps/unusual.rst @@ -42,7 +42,7 @@ the target display, perhaps something like this: shell$ xhost + shell$ mpirun -n 4 -x DISPLAY=my_desktop.secure-cluster.example.com a.out -However, this technique is not generally suitable for unsecure +However, this technique is not generally suitable for insecure environments (because it allows anyone to read and write to your display). A slightly more secure way is to only allow X connections from the nodes where your application will be running: diff --git a/docs/man-openmpi/man1/mpirun.1.rst b/docs/man-openmpi/man1/mpirun.1.rst index 4b20b874e36..33412896104 100644 --- a/docs/man-openmpi/man1/mpirun.1.rst +++ b/docs/man-openmpi/man1/mpirun.1.rst @@ -93,7 +93,7 @@ Except where noted, these concepts and command line argument are all applicable to Open MPI as well. Open MPI extends the available PRRTE command line options, and also slightly modifies the PRRTE's default behaviors in a few cases. These will be specifically described in the -docuemtnation below. +documentation below. COMMAND LINE OPTIONS -------------------- @@ -193,7 +193,7 @@ processes will be bound to the package. context. If no value is provided for the number of copies to execute (i.e., neither the ``-n`` nor its synonyms are provided on the command line), Open MPI will automatically execute a copy of the - program on each process slot (see PRRTE's `defintion of "slot" + program on each process slot (see PRRTE's `definition of "slot" `_ for description of a "process slot"). This feature, however, can only be used in the SPMD model and will return an error (without @@ -428,7 +428,7 @@ Setting MCA parameters: parameters passed via ``--mca`` and handle them appropriately, but it may not always guess correctly. It is best to use ``--pmixmca`` and ``--prtemca`` when - passing MCA parammeters to PMIx and PRRTE, respectively. + passing MCA parameters to PMIx and PRRTE, respectively. * ``--pmixmca ``: Send arguments to MCA modules in the PMIx subsystem. See the :ref:`Setting MCA Parameters @@ -520,14 +520,14 @@ There are also other options: via the ``slots`` keyword in a hostfile or from a resource manager such as Slurm), the use of this option changes the default calculation of number of slots on a node. See the PRRTE's - `defintion of "slot" + `definition of "slot" `_ for more details. Also note that the use of this option changes the Open MPI's definition of a "processor element" from a processor core to a hardware thread. See - PRRTE's `defintion of a "processor element" + PRRTE's `definition of a "processor element" `_ for more details. @@ -1206,7 +1206,7 @@ Means that: * Rank 1 runs on node bb, bound to logical package 0, cores 0 and 1. * Rank 2 runs on node cc, bound to logical cores 2 and 3. -Note that only logicical processor locations are supported. By default, the values specifed are assumed to be cores. If you intend to specify specific hardware threads then you must add the ``:hwtcpus`` qualifier to the ``--map-by`` command line option (e.g., ``--map-by rankfile:file=myrankfile:hwtcpus``). +Note that only logicical processor locations are supported. By default, the values specified are assumed to be cores. If you intend to specify specific hardware threads then you must add the ``:hwtcpus`` qualifier to the ``--map-by`` command line option (e.g., ``--map-by rankfile:file=myrankfile:hwtcpus``). If the binding specification overlaps between any two ranks then an error occurs. If you intend to allow processes to share the same logical processing unit then you must pass the ``--bind-to :overload-allowed`` command line option to tell the runtime to ignore this check. diff --git a/docs/mca.rst b/docs/mca.rst index 3ab33d46fe0..71695920251 100644 --- a/docs/mca.rst +++ b/docs/mca.rst @@ -737,7 +737,7 @@ but may be removed in future releases. / rank / stdout / stderr / stdddiag. - ``orte_output_filename`` - Value: ```` + Value: ```` - ``output`` Value: ``file=`` @@ -1145,4 +1145,3 @@ Multiple suffixes may be appended to a mapping value: # New environment variable: (suffix on value) export PRTE_MCA_rmaps_default_mapping_policy=ppr:4:package:hwtcpus:oversubscribe - diff --git a/docs/release-notes/changelog/v3.1.x.rst b/docs/release-notes/changelog/v3.1.x.rst index de265cf19ac..68502fce637 100644 --- a/docs/release-notes/changelog/v3.1.x.rst +++ b/docs/release-notes/changelog/v3.1.x.rst @@ -218,7 +218,7 @@ Open MPI version 3.1.0 absolute path before being passed to other nodes. - Add monitoring component for PML, OSC, and COLL to track data movement of MPI applications. See - ompi/mca/commmon/monitoring/HowTo_pml_monitoring.tex for more + ompi/mca/common/monitoring/HowTo_pml_monitoring.tex for more information about the monitoring framework. - Add support for communicator assertions: ``mpi_assert_no_any_tag``, ``mpi_assert_no_any_source``, ``mpi_assert_exact_length``, and diff --git a/docs/tuning-apps/mpi-io/ompio.rst b/docs/tuning-apps/mpi-io/ompio.rst index ddb84d62874..b2fe04d03bb 100644 --- a/docs/tuning-apps/mpi-io/ompio.rst +++ b/docs/tuning-apps/mpi-io/ompio.rst @@ -73,7 +73,7 @@ mechanism available in Open MPI to influence a parameter value, e.g.: system type utilized (e.g. the ``pvfs2`` component is chosen when the file is located on an PVFS2/OrangeFS file system, the ``lustre`` component is chosen for Lustre file systems, etc.). The ``ufs`` ``fs`` -component is used if no file system specific component is availabe +component is used if no file system specific component is available (e.g. local file systems, NFS, BeefFS, etc.), and the ``posix`` ``fbtl`` component is used as the default component for read/write operations. @@ -86,7 +86,7 @@ important ``fcoll`` components are: * ``dynamic_gen2``: the default component used on lustre file system. This component is based on the two-phase I/O algorithm with - a static file partioning strategy, i.e. an aggregator processes will + a static file partitioning strategy, i.e. an aggregator processes will by default only write data to a single storage server. * ``vulcan``: the default component used on all other file @@ -142,7 +142,7 @@ operation are listed below: regular 2-D or 3-D data decomposition can try changing this parameter to 4 (hybrid) algorithm. -#. ``fs_ufs_lock_algorithm``: Parameter used to determing what part of +#. ``fs_ufs_lock_algorithm``: Parameter used to determine what part of a file needs to be locked for a file operation. Since the ``ufs`` ``fs`` component is used on multiple file systems, OMPIO automatically chooses the value required for correctness on all diff --git a/docs/tuning-apps/networking/ib-and-roce.rst b/docs/tuning-apps/networking/ib-and-roce.rst index 32ba7936cc2..7b722faf9a4 100644 --- a/docs/tuning-apps/networking/ib-and-roce.rst +++ b/docs/tuning-apps/networking/ib-and-roce.rst @@ -155,7 +155,7 @@ questions in your e-mail: #. Which UCX and OpenFabrics version are you running? Please specify where you got the software from (e.g., from the OpenFabrics and/or UCX community web sites, already included in your Linux - distribution, downloade from NVIDIA's web site, etc.). + distribution, downloaded from NVIDIA's web site, etc.). #. What distro and version of Linux are you running? What is your kernel version?