Merge pull request #10122 from cniethammer/promote_use_of_mpirun_n_option

Use '-n' instead of '-np' option in documentation, examples, and tests

Author: jsquyres

.github/issue_template.md

@@ -28,6 +28,6 @@ Please describe, in detail, the problem that you are having, including the behav
 
 **Note**: If you include verbatim output (or a code block), please use a [GitHub Markdown](https://help.github.com/articles/creating-and-highlighting-code-blocks/) code block like below:
 ```shell
-shell$ mpirun -np 2 ./hello_world
+shell$ mpirun -n 2 ./hello_world
 ```
 

docs/developers/frameworks.rst

@@ -166,7 +166,7 @@ values of parameters:
 
    .. code-block:: sh
 
-      shell$ mpirun --mca btl_tcp_frag_size 65536 -np 2 hello_world_mpi
+      shell$ mpirun --mca btl_tcp_frag_size 65536 -n 2 hello_world_mpi
 
    .. error:: TODO Do we need content here about PMIx and PRTE MCA vars
               and corresponding command line switches?

docs/faq/debugging.rst

@@ -209,7 +209,7 @@ be to assume that the following would immediately work:
 
 .. code-block:: sh
 
-    shell$ mpirun -np 4 xterm -e gdb my_mpi_application
+    shell$ mpirun -n 4 xterm -e gdb my_mpi_application
 
 If running on a personal computer, this will probably work.  You can
 also use `tmpi <https://github.com/Azrael3000/tmpi>`_ to launch the
@@ -281,7 +281,7 @@ following:
 
       shell$ hostname
       arcade.example.come
-      shell$ mpirun -np 4 --hostfile my_hostfile \
+      shell$ mpirun -n 4 --hostfile my_hostfile \
           -x DISPLAY=arcade.example.com:0 xterm -e gdb my_mpi_application
 
    .. warning:: X traffic is fairly "heavy" |mdash| if you are
@@ -466,15 +466,15 @@ enabled. Then simply run your application with Valgrind, e.g.:
 
 .. code-block:: sh
 
-   shell$ mpirun -np 2 valgrind ./my_app
+   shell$ mpirun -n 2 valgrind ./my_app
 
 Or if you enabled Memchecker, but you don't want to check the
 application at this time, then just run your application as
 usual. E.g.:
 
 .. code-block:: sh
 
-   shell$ mpirun -np 2 ./my_app
+   shell$ mpirun -n 2 ./my_app
 
 /////////////////////////////////////////////////////////////////////////
 
@@ -572,7 +572,7 @@ line:
 
 .. code-block:: sh
 
-   shell$ mpirun -np 2 valgrind --suppressions=$PREFIX/share/openmpi/openmpi-valgrind.supp
+   shell$ mpirun -n 2 valgrind --suppressions=$PREFIX/share/openmpi/openmpi-valgrind.supp
 
 More information on suppression-files and how to generate them can be
 found in `Valgrind's documentation

docs/faq/general-tuning.rst

@@ -222,7 +222,7 @@ listed below, and are resolved in the following priority order:
 
    .. code-block:: sh
 
-      shell$ mpirun --mca mpi_show_handle_leaks 1 -np 4 a.out
+      shell$ mpirun --mca mpi_show_handle_leaks 1 -n 4 a.out
 
    This sets the MCA parameter ``mpi_show_handle_leaks`` to the value
    of 1 before running ``a.out`` with four processes.  In general, the
@@ -245,7 +245,7 @@ listed below, and are resolved in the following priority order:
 
       shell$ OMPI_MCA_mpi_show_handle_leaks=1
       shell$ export OMPI_MCA_mpi_show_handle_leaks
-      shell$ mpirun -np 4 a.out
+      shell$ mpirun -n 4 a.out
 
    Note that setting environment variables to values with multiple words
    requires quoting, such as:
@@ -347,29 +347,29 @@ will typically run the application as:
 
 .. code-block:: sh
 
-   shell$ mpirun -np 2 a.out
+   shell$ mpirun -n 2 a.out
 
 To use the ``foo.conf`` AMCA parameter file, this command line
 changes to:
 
 .. code-block:: sh
 
-   shell$ mpirun -np 2 --am foo.conf a.out
+   shell$ mpirun -n 2 --am foo.conf a.out
 
 If the user wants to override a parameter set in ``foo.conf`` they
 can add it to the command line:
 
 .. code-block:: sh
 
-   shell$ mpirun -np 2 --am foo.conf --mca btl tcp,self a.out
+   shell$ mpirun -n 2 --am foo.conf --mca btl tcp,self a.out
 
 AMCA parameter files can be coupled if more than one file is to be
 used. If we have another AMCA parameter file called ``bar.conf``
 that we want to use, we add it to the command line as follows:
 
 .. code-block:: sh
 
-   shell$ mpirun -np 2 --am foo.conf:bar.conf a.out
+   shell$ mpirun -n 2 --am foo.conf:bar.conf a.out
 
 AMCA parameter files are loaded in priority order. This means that
 ``foo.conf`` AMCA file has priority over the ``bar.conf`` file. So
@@ -423,22 +423,22 @@ will typically run the application as:
 
 .. code-block:: sh
 
-   shell$ mpirun -np 2 a.out
+   shell$ mpirun -n 2 a.out
 
 To use the ``foo.conf`` tuned parameter file, this command line
 changes to:
 
 .. code-block:: sh
 
-   shell$ mpirun -np 2 --tune foo.conf a.out
+   shell$ mpirun -n 2 --tune foo.conf a.out
 
 Tuned parameter files can be coupled if more than one file is to be
 used. If we have another tuuned parameter file called ``bar.conf``
 that we want to use, we add it to the command line as follows:
 
 .. code-block:: sh
 
-   shell$ mpirun -np 2 --tune foo.conf,bar.conf a.out
+   shell$ mpirun -n 2 --tune foo.conf,bar.conf a.out
 
 
 The contents of tuned files consist of one or more lines, each of

docs/faq/ompio.rst

@@ -82,7 +82,7 @@ mechanism available in Open MPI to influence a parameter value, e.g.:
 
 .. code-block:: sh
 
-   shell$ mpirun --mca fcoll dynamic -np 64 ./a.out
+   shell$ mpirun --mca fcoll dynamic -n 64 ./a.out
 
 ``fs`` and ``fbtl`` components are typically chosen based on the file
 system type utilized (e.g. the ``pvfs2`` component is chosen when the
@@ -222,7 +222,7 @@ IMB:
 
 .. code-block:: sh
 
-   shell$ mpirun -np 1 ./IMB-IO S_write_indv
+   shell$ mpirun -n 1 ./IMB-IO S_write_indv
 
 For IMB, use the values obtained for AGGREGATE test cases. Plot the
 bandwidth over the message length. The recommended value for