[PATCH] D67839: [FPEnv] Document requirement of function attributes with constrained floating point

[Kevin P. Neal via Phabricator via llvm-commits]

kpn created this revision.
kpn added reviewers: craig.topper, andrew.w.kaylor, cameron.mcinally, efriedma, hfinkel, uweigand, kbarton.
Herald added a project: LLVM.
Herald added a subscriber: llvm-commits.

We need to document the function attributes that are required for proper functioning of constrained intrinsics.


Repository:
  rG LLVM Github Monorepo

https://reviews.llvm.org/D67839

Files:
  llvm/docs/LangRef.rst


Index: llvm/docs/LangRef.rst
===================================================================
--- llvm/docs/LangRef.rst
+++ llvm/docs/LangRef.rst
@@ -15148,6 +15148,27 @@
 vectorized into a single instruction that raises each unique exception a single
 time.
 
+Required Function Attributes:
+"""""""""""""""""""""""""""""
+
+Proper :ref:`function attributes <fnattrs>` usage is required for the
+constrained intrinsics to function correctly.
+
+All function *calls* done in a function that uses constrained floating
+point intrinsics must have the ``strictfp`` attribute.
+
+All function *definitions* that use constrained floating point intrinsics
+must use a set of function attributes. All attributes are required. The
+complete list of required function attributes:
+
+::
+
+      strictfp
+      noimplicitfloat
+
+The constrained floating point intrinsics are still experimental and the above
+list may be subject to change.
+
 
 '``llvm.experimental.constrained.fadd``' Intrinsic
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^


-------------- next part --------------
A non-text attachment was scrubbed...
Name: D67839.221046.patch
Type: text/x-patch
Size: 1043 bytes
Desc: not available
URL: <http://lists.llvm.org/pipermail/llvm-commits/attachments/20190920/378c730e/attachment.bin>