Skip to content

Commit a0d94b1

Browse files
committed
wip Give up and explicitly list all man pages
Signed-off-by: Jeff Squyres <[email protected]>
1 parent a5dd9f9 commit a0d94b1

File tree

2 files changed

+756
-18
lines changed

2 files changed

+756
-18
lines changed

config/opal_setup_sphinx.m4

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,13 @@ dnl
1212
AC_DEFUN([OPAL_SETUP_SPHINX],[
1313
OPAL_VAR_SCOPE_PUSH([summary_msg])
1414

15+
# This option is probably only helpful to developers: have
16+
# configure fail if Sphinx is not found (i.e., if you don't have
17+
# the ability to use Sphinx to build the HTML docs and man pages).
18+
AC_ARG_ENABLE([sphinx],
19+
[AS_HELP_STRING([--enable-sphinx],
20+
[Force configure to fail if Sphinx is not found (Sphinx is used to build the Open MPI and OpenSHMEM HTML docs and man pages). This option is likely only useful for Open MPI developers; end users who are building from Open MPI distribution tarballs do ***not*** need to have Sphinx installed])])
21+
1522
# Quick check to see if we have already-built docs (e.g., if we're
1623
# in a tarball vs. a fresh git clone).
1724
AC_MSG_CHECKING([if pre-built docs are available])
@@ -52,6 +59,13 @@ AC_DEFUN([OPAL_SETUP_SPHINX],[
5259
[summary_msg="installing packaged docs"],
5360
[summary_msg="no documentation available"])])
5461

62+
# If --enable-sphinx was specified and we did not find Sphinx,
63+
# abort. This is likely only useful to prevent "oops!" moments
64+
# from Open MPI developers.
65+
AS_IF([test -z "$SPHINX_BUILD" && test "$enable_sphinx" = "yes"],
66+
[AC_MSG_WARN([Sphinx was not found, but --enable-sphinx was specified])
67+
AC_MSG_ERROR([Cannot continue])])
68+
5569
OPAL_SUMMARY_ADD([Miscellaneous], [HTML docs and man pages], [],
5670
[$summary_msg])
5771

0 commit comments

Comments
 (0)