[PATCH] D67360: [FPEnv] Document that constrained FP intrinsics cannot be mixed with non-constrained

[Andy Kaylor via Phabricator via llvm-commits]

andrew.w.kaylor added inline comments.


================
Comment at: docs/LangRef.rst:15062
 Each of these intrinsics corresponds to a normal floating-point operation.  The
-first two arguments and the return value are the same as the corresponding FP
+first arguments and the return value are the same as the corresponding FP
 operation.
----------------
As long as you're cleaning this up, I would suggest ditching the ordinal adjectives (which I never should have used in the original documentation as the problem you're fixing here should have been foreseeable).  How about saying "the data operands and the return value" here and referring to "rounding mode argument" and "exception behavior" argument below. You can't really say "next" and "last" there since they aren't always both used. 

Some additional rewriting will be necessary to avoid saying "the rounding mode argument is a metadata argument specifying the rounding mode...." Here's a suggestion:

> The rounding mode argument is a metadata string specifying what assumptions, if any, the optimizer can make when transforming constant values. Some constrained FP intrinsics omit this argument. If required by the intrinsic, this argument must be one of the following strings:
> 
> <...>
> 
> The exception behavior argument is a metadata string describing the floating point exception semantics that required for the intrinsic. This argument must be one of the following strings:




CHANGES SINCE LAST ACTION
  https://reviews.llvm.org/D67360/new/

https://reviews.llvm.org/D67360