diff --git a/docs/Makefile.am b/docs/Makefile.am index 4c2905a55ab..9083e02bb87 100644 --- a/docs/Makefile.am +++ b/docs/Makefile.am @@ -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 diff --git a/docs/installing-open-mpi/downloading.rst b/docs/installing-open-mpi/downloading.rst new file mode 100644 index 00000000000..8eb13771dd5 --- /dev/null +++ b/docs/installing-open-mpi/downloading.rst @@ -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 + `_. + + * 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 `_. + + * 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. diff --git a/docs/installing-open-mpi/index.rst b/docs/installing-open-mpi/index.rst index ae5242e7d56..ee6f1f10db2 100644 --- a/docs/installing-open-mpi/index.rst +++ b/docs/installing-open-mpi/index.rst @@ -7,6 +7,7 @@ Building and installing Open MPI :maxdepth: 1 quickstart + downloading supported-systems definitions filesystem-requirements diff --git a/docs/installing-open-mpi/quickstart.rst b/docs/installing-open-mpi/quickstart.rst index 8e940721a62..53ca0b2838f 100644 --- a/docs/installing-open-mpi/quickstart.rst +++ b/docs/installing-open-mpi/quickstart.rst @@ -53,6 +53,14 @@ packages: Building from source -------------------- +Download the Open MPI source code from `the main Open MPI web site +`_. + +.. 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: