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]>

Author: jsquyres

README.md

@@ -1502,11 +1502,20 @@ Additionally, if a search directory is specified in the form
   Enable the PERUSE MPI data analysis interface.
 
 * `--enable-heterogeneous`:
-  Enable support for running on heterogeneous clusters (e.g., machines
-  with different endian representations).  Heterogeneous support is
-  disabled by default because it imposes a minor performance penalty.
-
-  ***THIS FUNCTIONALITY IS CURRENTLY BROKEN - DO NOT USE***
+  Enable support for running on heterogeneous clusters where data
+  types are equivalent sizes across nodes, but may have differing
+  endian representations.  Heterogeneous support is disabled by
+  default because it imposes a minor performance penalty.
+
+  **NOTE:** Open MPI's heterogeneous support *will not correct for
+  differences in type sizes*.  For example, if an integer datatype is
+  32 bits in one MPI process, but the same integer datatype is 64 bits
+  in another MPI process, problems can (will) occur.  Similarly, the
+  same problems will occur if a floating point datatype uses X1 bits
+  for its mantissa and Y1 bits for its exponent, but the same floating
+  point datatype in another MPI process uses X2 and Y2 bits,
+  respectively (where X1 != X2 and/or Y1 != Y2).  Type size
+  differences like this will lead to unpredictable behavior.
 
 * `--with-wrapper-cflags=CFLAGS`
 * `--with-wrapper-cxxflags=CXXFLAGS`