[llvm] 2fdedf9 - [doc] Clarify constrained fcmps behavior

[Thomas Preud'homme via llvm-commits]

Author: Thomas Preud'homme
Date: 2021-04-23T11:55:20+01:00
New Revision: 2fdedf905a6bd8e44a28191bb91f74a705b9c3f6

URL: https://github.com/llvm/llvm-project/commit/2fdedf905a6bd8e44a28191bb91f74a705b9c3f6
DIFF: https://github.com/llvm/llvm-project/commit/2fdedf905a6bd8e44a28191bb91f74a705b9c3f6.diff

LOG: [doc] Clarify constrained fcmps behavior

Reviewed By: uweigand

Differential Revision: https://reviews.llvm.org/D101053

Added: 
    

Modified: 
    llvm/docs/LangRef.rst

Removed: 
    


################################################################################
diff  --git a/llvm/docs/LangRef.rst b/llvm/docs/LangRef.rst
index 6770ad8b78c54..5beed04d002a2 100644
--- a/llvm/docs/LangRef.rst
+++ b/llvm/docs/LangRef.rst
@@ -19285,7 +19285,11 @@ The quiet comparison operation performed by
 '``llvm.experimental.constrained.fcmp``' will only raise an exception
 if either operand is a SNAN.  The signaling comparison operation
 performed by '``llvm.experimental.constrained.fcmps``' will raise an
-exception if either operand is a NAN (QNAN or SNAN).
+exception if either operand is a NAN (QNAN or SNAN). Such an exception
+does not preclude a result being produced (e.g. exception might only
+set a flag), therefore the distinction between ordered and unordered
+comparisons is also relevant for the
+'``llvm.experimental.constrained.fcmps``' intrinsic.
 
 '``llvm.experimental.constrained.fmuladd``' Intrinsic
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^