From ed119096be6739b67d99acfa4c2d43627960f0e3 Mon Sep 17 00:00:00 2001
From: Thomas Miedema <thomasmiedema@gmail.com>
Date: Mon, 22 Feb 2016 14:31:40 +0100
Subject: [PATCH] Docs: -keep-llvm-file(s)/-ddump-llvm imply -fllvm

This fixes #9917.
---
 docs/users_guide/debugging.rst                        | 2 ++
 docs/users_guide/separate_compilation.rst             | 5 +++++
 utils/mkUserGuidePart/Options/CompilerDebugging.hs    | 3 ++-
 utils/mkUserGuidePart/Options/KeepingIntermediates.hs | 9 +++++----
 4 files changed, 14 insertions(+), 5 deletions(-)

diff --git a/docs/users_guide/debugging.rst b/docs/users_guide/debugging.rst
index a7bbbb5e0b..a4e2d2345f 100644
--- a/docs/users_guide/debugging.rst
+++ b/docs/users_guide/debugging.rst
@@ -144,6 +144,8 @@ Dumping out compiler intermediate structures
 
     .. ghc-flag:: -ddump-llvm
 
+        :implies: :ghc-flag:`-fllvm`
+
         LLVM code from the :ref:`LLVM code generator <llvm-code-gen>`
 
     .. ghc-flag:: -ddump-bcos
diff --git a/docs/users_guide/separate_compilation.rst b/docs/users_guide/separate_compilation.rst
index afdde8366d..a2ce5ebd50 100644
--- a/docs/users_guide/separate_compilation.rst
+++ b/docs/users_guide/separate_compilation.rst
@@ -334,12 +334,16 @@ The following options are useful for keeping certain intermediate files
 around, when normally GHC would throw these away after compilation:
 
 .. ghc-flag:: -keep-hc-file
+              -keep-hc-files
 
     Keep intermediate ``.hc`` files when doing ``.hs``-to-``.o``
     compilations via :ref:`C <c-code-gen>` (Note: ``.hc`` files are only
     generated by :ref:`unregisterised <unreg>` compilers).
 
 .. ghc-flag:: -keep-llvm-file
+              -keep-llvm-files
+
+    :implies: :ghc-flag:`-fllvm`
 
     Keep intermediate ``.ll`` files when doing ``.hs``-to-``.o``
     compilations via :ref:`LLVM <llvm-code-gen>` (Note: ``.ll`` files
@@ -347,6 +351,7 @@ around, when normally GHC would throw these away after compilation:
     to use :ghc-flag:`-fllvm` to force them to be produced).
 
 .. ghc-flag:: -keep-s-file
+              -keep-s-files
 
     Keep intermediate ``.s`` files.
 
diff --git a/utils/mkUserGuidePart/Options/CompilerDebugging.hs b/utils/mkUserGuidePart/Options/CompilerDebugging.hs
index 6160f01e8c..3f1d89999d 100644
--- a/utils/mkUserGuidePart/Options/CompilerDebugging.hs
+++ b/utils/mkUserGuidePart/Options/CompilerDebugging.hs
@@ -55,7 +55,8 @@ compilerDebuggingOptions =
          , flagType = DynamicFlag
          }
   , flag { flagName = "-ddump-llvm"
-         , flagDescription = "Dump LLVM intermediate code"
+         , flagDescription = "Dump LLVM intermediate code. "++
+           "Implies :ghc-flag:`-fllvm`."
          , flagType = DynamicFlag
          }
   , flag { flagName = "-ddump-occur-anal"
diff --git a/utils/mkUserGuidePart/Options/KeepingIntermediates.hs b/utils/mkUserGuidePart/Options/KeepingIntermediates.hs
index 9c93aedfeb..dd68de493e 100644
--- a/utils/mkUserGuidePart/Options/KeepingIntermediates.hs
+++ b/utils/mkUserGuidePart/Options/KeepingIntermediates.hs
@@ -5,19 +5,20 @@ import Types
 keepingIntermediatesOptions :: [Flag]
 keepingIntermediatesOptions =
   [ flag { flagName = "-keep-hc-file, -keep-hc-files"
-         , flagDescription = "retain intermediate ``.hc`` files"
+         , flagDescription = "Retain intermediate ``.hc`` files."
          , flagType = DynamicFlag
          }
   , flag { flagName = "-keep-llvm-file, -keep-llvm-files"
-         , flagDescription = "retain intermediate LLVM ``.ll`` files"
+         , flagDescription = "Retain intermediate LLVM ``.ll`` files. "++
+           "Implies :ghc-flag:`-fllvm`."
          , flagType = DynamicFlag
          }
   , flag { flagName = "-keep-s-file, -keep-s-files"
-         , flagDescription = "retain intermediate ``.s`` files"
+         , flagDescription = "Retain intermediate ``.s`` files."
          , flagType = DynamicFlag
          }
   , flag { flagName = "-keep-tmp-files"
-         , flagDescription = "retain all intermediate temporary files"
+         , flagDescription = "Retain all intermediate temporary files."
          , flagType = DynamicFlag
          }
   ]
-- 
GitLab