Skip to content

Commit

Permalink
Merge pull request #12402 from jsquyres/pr/add-docs-download-page
Browse files Browse the repository at this point in the history
Minor docs update
  • Loading branch information
jsquyres authored Mar 12, 2024
2 parents a25dd5f + ce994f2 commit 05758bb
Show file tree
Hide file tree
Showing 4 changed files with 51 additions and 1 deletion.
2 changes: 1 addition & 1 deletion docs/Makefile.am
Original file line number Diff line number Diff line change
Expand Up @@ -962,8 +962,8 @@ $(builddir)/schizo-ompi-rst-content/schizo-ompi-cli.rstxt: $(OMPI_SCHIZO_OMPI_RS
else
$(builddir)/schizo-ompi-rst-content/schizo-ompi-cli.rstxt: $(builddir)/schizo-ompi-rst-content
$(builddir)/schizo-ompi-rst-content/schizo-ompi-cli.rstxt: $(srcdir)/no-prrte-content.rst.txt
dir=`dirname $@`; if test ! -d "$$dir"; then mkdir "$$dir"; fi
$(OMPI_V_SPHINX_COPYRST) \
dir=`dirname $@`; if test ! -d "$$dir"; then mkdir "$$dir"; fi; \
cp -pf $(srcdir)/no-prrte-content.rst.txt "$@"
endif

Expand Down
41 changes: 41 additions & 0 deletions docs/installing-open-mpi/downloading.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@

.. _building-open-mpi-downloading-label:

Downloading Open MPI
====================

Open MPI is generally available two ways:

#. As source code.

* The best place to get an official Open MPI source code
distribution is from `the main Open MPI web site
<https://www.open-mpi.org/>`_.

* Downstream Open MPI packagers (e.g., Linux distributions)
sometimes also provide source code distributions. They may
include additional patches or modifications.

Consult your favorite downstream packager for more details.

.. caution:: Do **not** download an Open MPI source code tarball
from GitHub.com. The tarballs automatically generated
by GitHub.com are incomplete and will not build
properly.

GitHub.com-generated tarballs are **not** official Open
MPI releases.

#. As binary packages.

* The Open MPI community does not provide binary packages on `the
main Open MPI web site <https://www.open-mpi.org/>`_.

* Various downstream packagers (e.g., Linux distributions,
Homebrew, MacPorts, etc.) *do* provide pre-built, binary packages
for Open MPI.

Consult your favorite downstream packager for more details.

The majority of the rest of this section deals with installing Open
MPI from source.
1 change: 1 addition & 0 deletions docs/installing-open-mpi/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ Building and installing Open MPI
:maxdepth: 1

quickstart
downloading
supported-systems
definitions
filesystem-requirements
Expand Down
8 changes: 8 additions & 0 deletions docs/installing-open-mpi/quickstart.rst
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,14 @@ packages:
Building from source
--------------------

Download the Open MPI source code from `the main Open MPI web site
<https://www.open-mpi.org/>`_.

.. caution:: Do **not** download an Open MPI source code tarball from
GitHub.com. The tarballs automatically generated by
GitHub.com are incomplete and will not build properly.
They are **not** official Open MPI releases.

Open MPI uses a traditional ``configure`` script paired with ``make``
to build. Typical installs can be of the pattern:

Expand Down

0 comments on commit 05758bb

Please sign in to comment.