Skip to content

Commit

Permalink
wip / first cut
Browse files Browse the repository at this point in the history
This is terribly incomplete, but just putting something here so that
others can see / get a flavor of what's going on.

Signed-off-by: Jeff Squyres <[email protected]>
  • Loading branch information
jsquyres committed Jul 11, 2023
1 parent 7b87ae4 commit 846a4a6
Show file tree
Hide file tree
Showing 6 changed files with 43 additions and 7 deletions.
1 change: 1 addition & 0 deletions docs/_ext
11 changes: 6 additions & 5 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,10 @@
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
#
# import os
# import sys
# sys.path.insert(0, os.path.abspath('.'))
import os
import sys
sys.path.insert(0, os.path.abspath('./_ext'))
extensions = [ 'prte' ]

# -- Project information -----------------------------------------------------

Expand Down Expand Up @@ -116,11 +117,11 @@
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
import sphinx_rtd_theme
extensions = [
extensions.extend([
'recommonmark',
"sphinx_rtd_theme",
"sphinx.ext.extlinks",
]
])

# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
Expand Down
35 changes: 33 additions & 2 deletions docs/man-openmpi/man1/mpirun.1.rst
Original file line number Diff line number Diff line change
Expand Up @@ -174,8 +174,39 @@ By default, Open MPI defines that a "processing element" is a
processor core. However, if ``--use-hwthread-cpus`` is specified on the
mpirun command line, then a "processing element" is a hardware thread.

OPTIONS
-------
OPTIONS (NEW / DYNAMICALLY IMPORTED FROM PRTE)
----------------------------------------------

From prterun(1)
^^^^^^^^^^^^^^^

These options are directly from ``prterun(1)``:

.. include:: mpirun/help-schizo-cli.rst

Open MPI-specific options
^^^^^^^^^^^^^^^^^^^^^^^^^

These options are specific to Open MPI:

.. include:: mpirun/help-schizo-ompi.rst

Deprecated options
^^^^^^^^^^^^^^^^^^

These are deprecated options:

.. include:: mpirun/help-schizo-deprecated.rst

OPTIONS (OLD / HARD-CODED CONTENT -- TO BE DELETED)
---------------------------------------------------

.. admonition:: This is old content
:class: error

This is the old section of manually hard-coded content. It will
likely someday be deleted and replaced with the dynamic content
from prterun.

mpirun will send the name of the directory where it was invoked on the
local node to each of the remote nodes, and attempt to change to that
Expand Down
1 change: 1 addition & 0 deletions docs/man-openmpi/man1/mpirun/help-schizo-cli.rst
1 change: 1 addition & 0 deletions docs/man-openmpi/man1/mpirun/help-schizo-deprecated.rst
1 change: 1 addition & 0 deletions docs/man-openmpi/man1/mpirun/help-schizo-ompi.rst

0 comments on commit 846a4a6

Please sign in to comment.