Skip to content

Commit 05758bb

Browse files
authored
Merge pull request #12402 from jsquyres/pr/add-docs-download-page
Minor docs update
2 parents a25dd5f + ce994f2 commit 05758bb

File tree

4 files changed

+51
-1
lines changed

4 files changed

+51
-1
lines changed

docs/Makefile.am

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -962,8 +962,8 @@ $(builddir)/schizo-ompi-rst-content/schizo-ompi-cli.rstxt: $(OMPI_SCHIZO_OMPI_RS
962962
else
963963
$(builddir)/schizo-ompi-rst-content/schizo-ompi-cli.rstxt: $(builddir)/schizo-ompi-rst-content
964964
$(builddir)/schizo-ompi-rst-content/schizo-ompi-cli.rstxt: $(srcdir)/no-prrte-content.rst.txt
965-
dir=`dirname $@`; if test ! -d "$$dir"; then mkdir "$$dir"; fi
966965
$(OMPI_V_SPHINX_COPYRST) \
966+
dir=`dirname $@`; if test ! -d "$$dir"; then mkdir "$$dir"; fi; \
967967
cp -pf $(srcdir)/no-prrte-content.rst.txt "$@"
968968
endif
969969

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
2+
.. _building-open-mpi-downloading-label:
3+
4+
Downloading Open MPI
5+
====================
6+
7+
Open MPI is generally available two ways:
8+
9+
#. As source code.
10+
11+
* The best place to get an official Open MPI source code
12+
distribution is from `the main Open MPI web site
13+
<https://www.open-mpi.org/>`_.
14+
15+
* Downstream Open MPI packagers (e.g., Linux distributions)
16+
sometimes also provide source code distributions. They may
17+
include additional patches or modifications.
18+
19+
Consult your favorite downstream packager for more details.
20+
21+
.. caution:: Do **not** download an Open MPI source code tarball
22+
from GitHub.com. The tarballs automatically generated
23+
by GitHub.com are incomplete and will not build
24+
properly.
25+
26+
GitHub.com-generated tarballs are **not** official Open
27+
MPI releases.
28+
29+
#. As binary packages.
30+
31+
* The Open MPI community does not provide binary packages on `the
32+
main Open MPI web site <https://www.open-mpi.org/>`_.
33+
34+
* Various downstream packagers (e.g., Linux distributions,
35+
Homebrew, MacPorts, etc.) *do* provide pre-built, binary packages
36+
for Open MPI.
37+
38+
Consult your favorite downstream packager for more details.
39+
40+
The majority of the rest of this section deals with installing Open
41+
MPI from source.

docs/installing-open-mpi/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ Building and installing Open MPI
77
:maxdepth: 1
88

99
quickstart
10+
downloading
1011
supported-systems
1112
definitions
1213
filesystem-requirements

docs/installing-open-mpi/quickstart.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,14 @@ packages:
5353
Building from source
5454
--------------------
5555

56+
Download the Open MPI source code from `the main Open MPI web site
57+
<https://www.open-mpi.org/>`_.
58+
59+
.. caution:: Do **not** download an Open MPI source code tarball from
60+
GitHub.com. The tarballs automatically generated by
61+
GitHub.com are incomplete and will not build properly.
62+
They are **not** official Open MPI releases.
63+
5664
Open MPI uses a traditional ``configure`` script paired with ``make``
5765
to build. Typical installs can be of the pattern:
5866

0 commit comments

Comments
 (0)