wip - cleanups

Signed-off-by: Jeff Squyres <[email protected]>

.gitignore

@@ -534,3 +534,7 @@ docs/_templates
 # Common Python virtual environment directory names
 venv
 py??
+
+# Sym links to PRRTE RST files
+docs/prrte-rst-content
+docs/schizo-ompi-rst-content

config/ompi_setup_prrte.m4

@@ -36,10 +36,21 @@ dnl
 dnl A Makefile conditional OMPI_WANT_PRRTE will be defined based on the
 dnl results of the build.
 AC_DEFUN([OMPI_SETUP_PRRTE],[
-    OPAL_VAR_SCOPE_PUSH([prrte_setup_internal_happy prrte_setup_external_happy target_rst_dir])
+    AC_REQUIRE([AC_PROG_LN_S])
+
+OPAL_VAR_SCOPE_PUSH([prrte_setup_internal_happy prrte_setup_external_happy target_rst_dir])
 
     opal_show_subtitle "Configuring PRRTE"
 
+    # We must have setup Sphinx before invoking this macro (i.e., it
+    # is a programming error -- not a run-time error -- if Sphinx was
+    # not previously setup).  Unfortunately, we can't AC REQUIRE it
+    # because the OAC SETUP SPHINX macro requires parameters.  The
+    # only publicly-visible env variable that OAC SETUP SPHINX sets is
+    # $SPHINX_BUILD -- but it may be empty if sphinx-build
+    # legitimately can't be found.  Sooo... we can't really tell here
+    # if OAC SETUP SPHINX has actually been invoked or not.
+
     # These are sym links to folders with PRRTE's RST files that we'll
     # slurp into mpirun.1.rst.  We'll remove these links now and
     # replace them with new links to the PRRTE that we find, below.
@@ -101,8 +112,9 @@ AC_DEFUN([OMPI_SETUP_PRRTE],[
     AM_CONDITIONAL([OMPI_WANT_PRRTE],
            [test "$prrte_setup_internal_happy" = "1" -o "$prrte_setup_external_happy" = "1"])
 
-    # If we are not building PRRTE, make dummy PRRTE docs files
-    AS_IF([test $OMPI_HAVE_PRRTE -eq 0],
+    # If we are building Sphinx docs but are not building PRRTE, make
+    # dummy PRRTE docs files
+    AS_IF([test -x "$SPHINX_BUILD" && test $OMPI_HAVE_PRRTE -eq 0],
           [_OMPI_SETUP_PRRTE_DUMMY_RST_FILES])
 
     AC_DEFINE_UNQUOTED([OMPI_HAVE_PRRTE],
@@ -298,7 +310,7 @@ AC_DEFUN([_OMPI_SETUP_PRRTE_INTERNAL], [
     AS_IF([test "$internal_prrte_happy" = "no" -a "$enable_internal_rte" != "no"],
           [AC_MSG_ERROR([PRRTE configuration failed.  Cannot continue.])])
 
-    AS_IF([test "$internal_prrte_happy" = "yes"],
+    AS_IF([test -n "$SPHINX_BUILD" && test "$internal_prrte_happy" = "yes"],
           [AC_MSG_CHECKING([for internal PRRTE RST files])
            _OMPI_SETUP_PRRTE_CHECK_AND_LINK(
               [$OMPI_TOP_SRCDIR/3rd-party/prrte/src/docs/prrte-rst-content],
@@ -307,8 +319,6 @@ AC_DEFUN([_OMPI_SETUP_PRRTE_INTERNAL], [
               [$OMPI_TOP_SRCDIR/3rd-party/prrte/src/mca/schizo/ompi],
               [$target_rst_dir/schizo-ompi-rst-content])
            AC_MSG_RESULT([found])
-           OPAL_SUMMARY_ADD([Miscellaneous], [PRRTE], [],
-                            [Found internal PRRTE RST files])
            $1], [$2])
 
     OPAL_VAR_SCOPE_POP
@@ -372,7 +382,7 @@ AC_DEFUN([_OMPI_SETUP_PRRTE_EXTERNAL], [
     AS_IF([test -n "${prterun_path}"],
           [AC_DEFINE_UNQUOTED([OMPI_PRTERUN_PATH], ["${prterun_path}"], [Path to prterun])])
 
-    AS_IF([test "$setup_prrte_external_happy" = "yes"],
+    AS_IF([test -n "$SPHINX_BUILD" && test "$setup_prrte_external_happy" = "yes"],
           [ # If this external PRRTE has installed the RST directories
             # that we care about, make sym links into OMPI's docs/
             # source tree.
@@ -384,17 +394,13 @@ AC_DEFUN([_OMPI_SETUP_PRRTE_EXTERNAL], [
                  [${LN_S} "$prrte_install_dir/prrte-rst-content" "$target_rst_dir"
                   ${LN_S} "$prrte_install_dir/schizo-ompi-rst-content" "$target_rst_dir"
                   AC_MSG_RESULT([found])
-                  OPAL_SUMMARY_ADD([Miscellaneous], [PRRTE], [],
-                                   [Found external PRRTE RST files])
                   ],
                  [ # This version of PRRTE doesn't have installed RST
                    # files.  So we make dummy "you don't get help" RST
                    # files.  Open to suggestion to do something
                    # better...?
                    AC_MSG_RESULT([not found (made empty dummy files)])
                    _OMPI_SETUP_PRRTE_DUMMY_RST_FILES
-                   OPAL_SUMMARY_ADD([Miscellaneous], [PRRTE], [],
-                                    [Did not find external PRRTE RST files])
                    ])
            $1], [$2])
 

docs/Makefile.am

@@ -878,6 +878,7 @@ $(ALL_MAN_BUILT): $(TEXT_SOURCE_FILES) $(SPHINX_CONFIG)
 $(ALL_MAN_BUILT):
 	$(OMPI_V_SPHINX_HTML) $(SPHINX_BUILD) -M html "$(srcdir)" "$(OUTDIR)" $(SPHINX_OPTS)
 	$(OMPI_V_SPHINX_MAN) $(SPHINX_BUILD) -M man "$(srcdir)" "$(OUTDIR)" $(SPHINX_OPTS)
+	$(OMPI_V_SPHINX_HTML) $(SPHINX_BUILD) -M latex "$(srcdir)" "$(OUTDIR)" $(SPHINX_OPTS)
 
 # A useful rule to invoke manually to ensure that all of the external
 # HTML links we have are valid.  Running this rule requires

docs/conf.py

@@ -12,7 +12,6 @@
 #
 import os
 import sys
-sys.path.insert(0, os.path.abspath('./_ext'))
 extensions = [ ]
 
 # -- Project information -----------------------------------------------------

docs/news/news-v5.0.x.rst

@@ -154,9 +154,10 @@ Open MPI version 5.0.0rc12
 
       - Many MPI one-sided and RDMA emulation fixes for the ``tcp`` BTL.
 
-        - This patch series fixs many issues when running with ``--mca
-          osc rdma --mca btl tcp``, i.e., TCP support for one sided
-          MPI calls.
+        This patch series fixs many issues when running with ``--mca
+        osc rdma --mca btl tcp``, i.e., TCP support for one sided
+        MPI calls.
+
       - Many MPI one-sided fixes for the ``uct`` BTL.
       - Added support for ``acc_single_intrinsic`` to the one-sided
         ``ucx`` component.