user-guide: Refer to MIN_VERSION_GLASGOW_HASKELL from intro
authorBen Gamari <ben@smart-cactus.org>
Thu, 21 Jan 2016 10:30:24 +0000 (11:30 +0100)
committerBen Gamari <ben@smart-cactus.org>
Thu, 21 Jan 2016 13:59:06 +0000 (14:59 +0100)
And fix markup.

docs/users_guide/intro.rst
docs/users_guide/phases.rst

index 281c04a..677f462 100644 (file)
@@ -175,3 +175,6 @@ numbering GHC versions:
 The version number of your copy of GHC can be found by invoking ``ghc``
 with the ``--version`` flag (see :ref:`options-help`).
 
+The compiler version can be tested within compiled code with the
+``MIN_VERSION_GLASGOW_HASKELL`` CPP macro (defined only when
+:ghc-flag:`-XCPP` is used). See :ref:`standard-cpp-macros` for details. 
index bc4e90f..e9637fa 100644 (file)
@@ -182,6 +182,11 @@ Options affecting the C pre-processor
 The GHC driver pre-defines several macros when processing Haskell source
 code (``.hs`` or ``.lhs`` files).
 
+.. _standard-cpp-macros:
+
+Standard CPP macros
+~~~~~~~~~~~~~~~~~~~
+
 The symbols defined by GHC are listed below. To check which symbols are
 defined by your local GHC installation, the following trick is useful:
 
@@ -258,7 +263,7 @@ defined by your local GHC installation, the following trick is useful:
     is required, the presence of the ``MIN_VERSION_GLASGOW_HASKELL``
     macro needs to be ensured before it is called, e.g.:
 
-    .. code-block: c
+    .. code-block:: c
 
         #ifdef MIN_VERSION_GLASGOW_HASKELL
         #if MIN_VERSION_GLASGOW_HASKELL(7,10,2,0)
@@ -451,6 +456,7 @@ Options affecting code generation
     no-op on that platform.
 
 .. ghc-flag:: -dynamic
+    :noindex:
 
     When generating code, assume that entities imported from a different
     package will reside in a different shared library or binary.