Skip to content

Commit 97f848d

Browse files
committed
ompi_info.1: switch order of text/example
Trivial change: put the explanation text *before* the example. Signed-off-by: Jeff Squyres <jsquyres@cisco.com>
1 parent 4b6390e commit 97f848d

File tree

1 file changed

+19
-19
lines changed

1 file changed

+19
-19
lines changed

docs/man-openmpi/man1/ompi_info.1.rst

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -163,65 +163,65 @@ more MCA parameters, use the ``--level`` command line option.
163163
EXAMPLES
164164
--------
165165

166+
Show the default output of options and listing of installed
167+
components in a human-readable / prettyprint format:
168+
166169
.. code-block::
167170
168171
ompi_info
169172
170-
Show the default output of options and listing of installed
171-
components in a human-readable / prettyprint format.
173+
Show the default output of options and listing of installed components
174+
in a machine-parsable format:
172175

173176
.. code-block::
174177
175178
ompi_info --parsable
176179
177-
Show the default output of options and listing of installed components
178-
in a machine-parsable format.
180+
Show the level 1 MCA parameters of the "tcp" BTL component in a
181+
human-readable / prettyprint format:
179182

180183
.. code-block::
181184
182185
ompi_info --param btl tcp
183186
184-
Show the level 1 MCA parameters of the "tcp" BTL component in a
185-
human-readable / prettyprint format.
187+
Show the level 1 through level 6 MCA parameters of the "tcp" BTL
188+
component in a human-readable / prettyprint format:
186189

187190
.. code-block::
188191
189192
ompi_info --param btl tcp --level 6
190193
191-
Show the level 1 through level 6 MCA parameters of the "tcp" BTL
192-
component in a human-readable / prettyprint format.
194+
Show the level 1 MCA parameters of the "tcp" BTL component in a
195+
machine-parsable format:
193196

194197
.. code-block::
195198
196199
ompi_info --param btl tcp --parsable
197200
198-
Show the level 1 MCA parameters of the "tcp" BTL component in a
199-
machine-parsable format.
201+
Show the level 3 MCA parameters of string type in a human-readable /
202+
prettyprint format:
200203

201204
.. code-block::
202205
203206
ompi_info --type string --pretty-print --level 3
204207
205-
Show the level 3 MCA parameters of string type in a human-readable /
206-
prettyprint format.
208+
Show the "bindir" that Open MPI was configured with:
207209

208210
.. code-block::
209211
210212
ompi_info --path bindir
211213
212-
Show the "bindir" that Open MPI was configured with.
214+
Show the version of Open MPI version numbers in a prettyprint format:
213215

214216
.. code-block::
215217
216218
ompi_info --version
217219
218-
Show the version of Open MPI version numbers in a prettyprint format.
220+
Show *all* information about the Open MPI installation, including all
221+
components that can be found, all the MCA parameters that they support
222+
(i.e., levels 1 through 9), versions of Open MPI and the components,
223+
etc.:
219224

220225
.. code-block::
221226
222227
ompi_info --all
223-
224-
Show *all* information about the Open MPI installation, including all
225-
components that can be found, all the MCA parameters that they support
226-
(i.e., levels 1 through 9), versions of Open MPI and the components,
227-
etc.

0 commit comments

Comments
 (0)