squashme Address review comments

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

Author: jsquyres

HACKING.md

@@ -12,5 +12,5 @@ Please see the content of this file in its new location:
 https://ompi.readthedocs.io/en/latest/developers/
 
 Additionally, see
-file:///Users/jsquyres/git/ompi/docs/_build/html/developers/prerequisites.html#sphinx
+https://ompi.readthedocs.io/en/latest/developers/prerequisites.html#sphinx
 if you want to edit and build the documentation locally.

config/opal_setup_sphinx.m4

@@ -22,17 +22,18 @@ AC_DEFUN([OPAL_SETUP_SPHINX],[
            AC_MSG_RESULT([no])])
 
     # To generate HTML docs + man pages, we need Sphinx.  If we have
-    # Sphinx, then we're able to install the docs (potentially
-    # overriding opal_install_docs from what it was set above).
+    # Sphinx, then we're able to both build and install the docs
+    # (potentially overriding opal_install_docs from what it was set
+    # above).
     AC_PATH_PROG([SPHINX_BUILD], [sphinx-build])
     AS_IF([test -n "$SPHINX_BUILD" && test -z "`echo $SPHINX_BUILD | $GREP missing`"],
           [ # If we're building, we're also installing, regardless of
             # whether we found pre-build docs or not (above).
            opal_install_docs=1],
           [SPHINX_BUILD=
            OPAL_MAKEDIST_DISABLE="$OPAL_MAKEDIST_DISABLE Sphinx/Documentation"
-           AC_MSG_WARN([*** Could not find a suitable sphinx-build on your system.])
-           AC_MSG_WARN([*** You will not be able to build a distribution tarball.])])
+           AC_MSG_NOTICE([Could not find a suitable sphinx-build on your system.])
+           AC_MSG_NOTICE([You will not be able to build a distribution tarball.])])
 
     AS_IF([test $opal_install_docs -eq 0],
           [AC_MSG_WARN([*** You will not have documentation installed.])
@@ -45,12 +46,11 @@ AC_DEFUN([OPAL_SETUP_SPHINX],[
     # Construct a summary message.  Due SUMMARY_ADD's implementation,
     # do *not* include a comma.
     AS_IF([test -n "$SPHINX_BUILD"],
+          [ # If we found Sphinx, we always both build and install.
+           summary_msg="building and installing"],
           [AS_IF([test $opal_install_docs -eq 1],
-                 [summary_msg="building and installing"],
-                 [summary_msg="building but not installing"])],
-          [AS_IF([test $opal_install_docs -eq 1],
-                 [summary_msg="not building but installing"],
-                 [summary_msg="not building and not installing"])])
+                 [summary_msg="installing packaged docs"],
+                 [summary_msg="no documentation available"])])
 
     OPAL_SUMMARY_ADD([Miscellaneous], [HTML docs and man pages], [],
                      [$summary_msg])

docs/Makefile.am

@@ -36,7 +36,6 @@ EXTRA_DIST         = \
         $(TEXT_SOURCES)
 
 ###########################################################################
-# Only build the docs if we have Sphinx
 if OPAL_BUILD_DOCS
 
 include $(top_srcdir)/Makefile.ompi-rules
@@ -83,10 +82,6 @@ CLEANFILES += $(TOP_SENTINEL_FILE)
 endif # OPAL_BUILD_DOCS
 
 ###########################################################################
-# Only install the docs if a) we already have them built (e.g., if we're
-# in a distribution tarball), or b) we just built them, above.
-# configure takes care of setting this AM CONDITIONAL for us.
-
 if OPAL_INSTALL_DOCS
 
 dist_man1_MANS = $(OUTDIR)/man/*.1