Skip to content

Commit f9aa56f

Browse files
committed
README.md: make the heterogeneous support more clear
Remove ambiguous warning language (it's not clear if the "THIS FUNCTIONALITY..." warning applies to the option above or below the warning) and make it clear exactly the hetereogeneous option supports and does not support. Signed-off-by: Jeff Squyres <[email protected]>
1 parent 89c09f1 commit f9aa56f

File tree

1 file changed

+14
-5
lines changed

1 file changed

+14
-5
lines changed

README.md

Lines changed: 14 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1502,11 +1502,20 @@ Additionally, if a search directory is specified in the form
15021502
Enable the PERUSE MPI data analysis interface.
15031503

15041504
* `--enable-heterogeneous`:
1505-
Enable support for running on heterogeneous clusters (e.g., machines
1506-
with different endian representations). Heterogeneous support is
1507-
disabled by default because it imposes a minor performance penalty.
1508-
1509-
***THIS FUNCTIONALITY IS CURRENTLY BROKEN - DO NOT USE***
1505+
Enable support for running on heterogeneous clusters where data
1506+
types are equivalent sizes across nodes, but may have differing
1507+
endian representations. Heterogeneous support is disabled by
1508+
default because it imposes a minor performance penalty.
1509+
1510+
**NOTE:** Open MPI's heterogeneous support *will not correct for
1511+
differences in type sizes*. For example, if an integer datatype is
1512+
32 bits in one MPI process, but the same integer datatype is 64 bits
1513+
in another MPI process, problems can (will) occur. Similarly, the
1514+
same problems will occur if a floating point datatype uses X1 bits
1515+
for its mantissa and Y1 bits for its exponent, but the same floating
1516+
point datatype in another MPI process uses X2 and Y2 bits,
1517+
respectively (where X1 != X2 and/or Y1 != Y2). Type size
1518+
differences like this will lead to unpredictable behavior.
15101519

15111520
* `--with-wrapper-cflags=CFLAGS`
15121521
* `--with-wrapper-cxxflags=CXXFLAGS`

0 commit comments

Comments
 (0)