diff --git a/docs/users_guide/debugging.rst b/docs/users_guide/debugging.rst index a7bbbb5e0bbcfcaf78dd12538b16a6cde4cdd2a9..a4e2d2345f75c9b79acf9281ef68e5544c105cd5 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 ` .. ghc-flag:: -ddump-bcos diff --git a/docs/users_guide/separate_compilation.rst b/docs/users_guide/separate_compilation.rst index afdde8366da278fb6be6c0e5b6f6f92b6a5849b5..a2ce5ebd50ec0935a8eeb273e63ec5941d4b34fd 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 ` (Note: ``.hc`` files are only generated by :ref:`unregisterised ` 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 ` (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 6160f01e8c2990df11635361c4c5fc58c933df0f..3f1d89999d8816bea659b872b2effd22f3443e5c 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 9c93aedfeb89ac7c592bd130b018a8e56dccc542..dd68de493e2505da066890fbd0cd3d0443e83266 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 } ]