[commit: ghc] master: Fix index entries in "separate compilation" section (0e1b6f8)

git at git.haskell.org git at git.haskell.org
Thu Aug 17 20:43:58 UTC 2017


Repository : ssh://git@git.haskell.org/ghc

On branch  : master
Link       : http://ghc.haskell.org/trac/ghc/changeset/0e1b6f85c69834e907ebcb9fcb5c94e6a2fb3287/ghc

>---------------------------------------------------------------

commit 0e1b6f85c69834e907ebcb9fcb5c94e6a2fb3287
Author: Chris Martin <ch.martin at gmail.com>
Date:   Mon Aug 14 21:15:22 2017 -0400

    Fix index entries in "separate compilation" section
    
    This appears to have been a mistake from the translation of the manual into RST
    format by 4fd6207ec6.


>---------------------------------------------------------------

0e1b6f85c69834e907ebcb9fcb5c94e6a2fb3287
 docs/users_guide/separate_compilation.rst | 14 +++++++++-----
 1 file changed, 9 insertions(+), 5 deletions(-)

diff --git a/docs/users_guide/separate_compilation.rst b/docs/users_guide/separate_compilation.rst
index 06af6f0..85c8254 100644
--- a/docs/users_guide/separate_compilation.rst
+++ b/docs/users_guide/separate_compilation.rst
@@ -522,11 +522,15 @@ files, thus: ::
         g :: TA -> TB
         g (MkTA x) = MkTB x
 
-``hs-boot`` files importing, ``hi-boot`` files Here ``A`` imports ``B``,
-but ``B`` imports ``A`` with a ``{-# SOURCE #-}`` pragma, which breaks
-the circular dependency. Every loop in the module import graph must be
-broken by a ``{-# SOURCE #-}`` import; or, equivalently, the module
-import graph must be acyclic if ``{-# SOURCE #-}`` imports are ignored.
+.. index::
+   single: ``hs-boot`` files
+   single: importing, ``hi-boot`` files
+
+Here ``A`` imports ``B``, but ``B`` imports ``A`` with a
+``{-# SOURCE #-}`` pragma, which breaks the circular dependency. Every
+loop in the module import graph must be broken by a ``{-# SOURCE #-}``
+import; or, equivalently, the module import graph must be acyclic if
+``{-# SOURCE #-}`` imports are ignored.
 
 For every module ``A.hs`` that is ``{-# SOURCE #-}``-imported in this
 way there must exist a source file ``A.hs-boot``. This file contains an



More information about the ghc-commits mailing list