[commit: ghc] ghc-8.2: users-guide: Document requirement of at least one -dep-suffix (e84b18d)

[git at git.haskell.org]

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

On branch  : ghc-8.2
Link       : http://ghc.haskell.org/trac/ghc/changeset/e84b18dfa98c3d2fc9c9288203113a2fbca406ba/ghc

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

commit e84b18dfa98c3d2fc9c9288203113a2fbca406ba
Author: Ben Gamari <ben at smart-cactus.org>
Date:   Thu May 11 16:49:54 2017 -0400

    users-guide: Document requirement of at least one -dep-suffix
    
    This requirement was introduced around 7.8 but was never documented.
    
    Resolves #9287.
    
    (cherry picked from commit b9d1dae0c0ee0bd3b7e9be3c83ce932d837944f1)


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

e84b18dfa98c3d2fc9c9288203113a2fbca406ba
 docs/users_guide/separate_compilation.rst | 11 ++++++-----
 1 file changed, 6 insertions(+), 5 deletions(-)

diff --git a/docs/users_guide/separate_compilation.rst b/docs/users_guide/separate_compilation.rst
index a140d46..0c981d5 100644
--- a/docs/users_guide/separate_compilation.rst
+++ b/docs/users_guide/separate_compilation.rst
@@ -1188,13 +1188,14 @@ generation are:
 
 .. ghc-flag:: -dep-suffix <suf>
 
-    Make extra dependencies that declare that files with suffix
-    ``.<suf>_<osuf>`` depend on interface files with suffix
-    ``.<suf>_hi``, or (for ``{-# SOURCE #-}`` imports) on ``.hi-boot``.
+    Make dependencies that declare that files with suffix
+    ``.<suf><osuf>`` depend on interface files with suffix
+    ``.<suf>hi``, or (for ``{-# SOURCE #-}`` imports) on ``.hi-boot``.
     Multiple ``-dep-suffix`` flags are permitted. For example,
-    ``-dep-suffix a -dep-suffix b`` will make dependencies for ``.hs``
+    ``-dep-suffix a_ -dep-suffix b_`` will make dependencies for ``.hs``
     on ``.hi``, ``.a_hs`` on ``.a_hi``, and ``.b_hs`` on ``.b_hi``.
-    (Useful in conjunction with NoFib "ways".)
+    Note that you must provide at least one suffix; if you do not want a suffix
+    then pass ``-dep-suffix ''``.
 
 .. ghc-flag:: --exclude-module=<file>