Skip to content

Commit 4c1cd3f

Browse files
authored
Merge pull request open-mpi#7254 from jsquyres/pr/v4.0.x/hwloc-readme-clarifications
v4.0.x: hwloc: clarify --with-hwloc behavior
2 parents f6914ee + 814f3e9 commit 4c1cd3f

File tree

2 files changed

+21
-19
lines changed

2 files changed

+21
-19
lines changed

README

Lines changed: 17 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1281,28 +1281,26 @@ MISCELLANEOUS SUPPORT LIBRARIES
12811281
this option is only needed for special configurations.
12821282

12831283
--with-hwloc(=value)
1284-
Build hwloc support (default: enabled). This option specifies where
1285-
to find the hwloc support headers and library. The following values
1286-
are permitted:
1284+
hwloc is a support library that provides processor and memory
1285+
affinity information for NUMA platforms. It is required by Open
1286+
MPI. Therefore, specifying --with-hwloc=no (or --without-hwloc) is
1287+
disallowed.
12871288

1288-
internal: Use Open MPI's internal copy of hwloc.
1289-
external: Use an external hwloc installation (rely on default
1290-
compiler and linker paths to find it)
1291-
<no value>: Same as "internal".
1292-
<directory>: Specify the location of a specific hwloc
1293-
installation to use
1289+
By default (i.e., if --with-hwloc is not specified, or if
1290+
--with-hwloc is specified without a value), Open MPI will first try
1291+
to find/use an hwloc installation on the current system. If Open
1292+
MPI cannot find one, it will fall back to build and use the internal
1293+
copy of hwloc included in the Open MPI source tree.
12941294

1295-
By default (or if --with-hwloc is specified with no VALUE), Open MPI
1296-
will build and use the copy of hwloc that it has in its source tree.
1297-
However, if the VALUE is "external", Open MPI will look for the
1298-
relevant hwloc header files and library in default compiler / linker
1299-
locations. Or, VALUE can be a directory tree where the hwloc header
1300-
file and library can be found. This option allows operating systems
1301-
to include Open MPI and use their default hwloc installation instead
1302-
of Open MPI's bundled hwloc.
1295+
Alternatively, the --with-hwloc option can be used to specify where
1296+
to find the hwloc support headers and library. The following values
1297+
are permitted:
13031298

1304-
hwloc is a support library that provides processor and memory
1305-
affinity information for NUMA platforms.
1299+
internal: Only use Open MPI's internal copy of hwloc.
1300+
external: Only use an external hwloc installation (rely on
1301+
default compiler and linker paths to find it).
1302+
<directory>: Only use the specific hwloc installation found in
1303+
the specified directory.
13061304

13071305
--with-hwloc-libdir=<directory>
13081306
Look in directory for the hwloc libraries. This option is only

opal/mca/hwloc/configure.m4

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -75,6 +75,10 @@ AC_DEFUN([MCA_opal_hwloc_CONFIG_REQUIRE],[
7575
AC_MSG_WARN([an external copy that you supply.])
7676
AC_MSG_ERROR([Cannot continue])])
7777

78+
# check for no-op
79+
AS_IF([test "$with_hwloc" = "yes"],
80+
[with_hwloc=""])
81+
7882
# set default
7983
opal_hwloc_base_enable_xml=0
8084

0 commit comments

Comments
 (0)