summaryrefslogtreecommitdiff
path: root/docs/users_guide/ffi-chap.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/users_guide/ffi-chap.rst')
-rw-r--r--docs/users_guide/ffi-chap.rst22
1 files changed, 22 insertions, 0 deletions
diff --git a/docs/users_guide/ffi-chap.rst b/docs/users_guide/ffi-chap.rst
index 320a3a6e70..6d41fa15d1 100644
--- a/docs/users_guide/ffi-chap.rst
+++ b/docs/users_guide/ffi-chap.rst
@@ -8,6 +8,12 @@ Foreign function interface (FFI)
single: interfacing with native code
.. ghc-flag:: -XForeignFunctionInterface
+ :shortdesc: Enable :ref:`foreign function interface <ffi>`.
+ :type: dynamic
+ :reverse: -XNoForeignFunctionInterface
+ :category: language
+
+ :since: 6.8.1
Allow use of the Haskell foreign function interface.
@@ -118,6 +124,14 @@ come with GHC. For more details see the
Interruptible foreign calls
~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.. ghc-flag:: -XInterruptibleFFI
+ :shortdesc: Enable interruptible FFI.
+ :type: dynamic
+ :reverse: -XNoInterruptibleFFI
+ :category: language
+
+ :since: 7.2.1
+
This concerns the interaction of foreign calls with
``Control.Concurrent.throwTo``. Normally when the target of a
``throwTo`` is involved in a foreign call, the exception is not raised
@@ -167,6 +181,14 @@ it is not typically necessary to handle ``ERROR_OPERATION_ABORTED``.
The CAPI calling convention
~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.. ghc-flag:: -XCApiFFI
+ :shortdesc: Enable :ref:`the CAPI calling convention <ffi-capi>`.
+ :type: dynamic
+ :reverse: -XNoCAPIFFI
+ :category: language
+
+ :since: 7.10.1
+
The ``CApiFFI`` extension allows a calling convention of ``capi`` to be
used in foreign declarations, e.g. ::