Fix documentation for `-dth-dec-file`
authorNathan Collins <conathan@galois.com>
Thu, 14 Jun 2018 23:36:23 +0000 (16:36 -0700)
committerBen Gamari <ben@smart-cactus.org>
Fri, 15 Jun 2018 16:08:43 +0000 (12:08 -0400)
The docs said that it took a file argument, as in
`-dth-dec-file=<file>`, but it does not take a file argument!

docs/users_guide/debugging.rst
docs/users_guide/glasgow_exts.rst

index a3f0be7..de69db8 100644 (file)
@@ -173,11 +173,12 @@ These flags dump various information from GHC's typechecker and renamer.
     Dump Template Haskell expressions that we splice in, and what
     Haskell code the expression evaluates to.
 
-.. ghc-flag:: -dth-dec-file=⟨file⟩
-    :shortdesc: Show evaluated TH declarations in a .th.hs file
+.. ghc-flag:: -dth-dec-file
+    :shortdesc: Dump evaluated TH declarations into `*.th.hs` files
     :type: dynamic
 
-    Dump expansions of all top-level Template Haskell splices into ⟨file⟩.
+    Dump expansions of all top-level Template Haskell splices into
+    :file:`{module}.th.hs` for each file :file:`{module}.hs`.
 
 .. ghc-flag:: -ddump-types
     :shortdesc: Dump type signatures
index 9212eed..952b16c 100644 (file)
@@ -12681,9 +12681,9 @@ non-trivial program, you may be interested in combining this with the
 :ghc-flag:`-ddump-to-file` flag (see :ref:`dumping-output`. For each file using
 Template Haskell, this will show the output in a ``.dump-splices`` file.
 
-The flag :ghc-flag:`-dth-dec-file=⟨file⟩` shows the expansions of all top-level
+The flag :ghc-flag:`-dth-dec-file` dumps the expansions of all top-level
 TH declaration splices, both typed and untyped, in the file :file:`M.th.hs`
-where M is the name of the module being compiled. Note that other types of
+for each module `M` being compiled. Note that other types of
 splices (expressions, types, and patterns) are not shown. Application
 developers can check this into their repository so that they can grep for
 identifiers that were defined in Template Haskell. This is similar to using
@@ -12702,7 +12702,7 @@ Below is a sample output of :ghc-flag:`-ddump-splices` ::
       foo :: Int -> Int
       foo x = (x + 1)
 
-Below is the output of the same sample using :ghc-flag:`-dth-dec-file=⟨file⟩` ::
+Below is the output of the same sample using :ghc-flag:`-dth-dec-file` ::
 
     -- TH_pragma.hs:(6,4)-(8,26): Splicing declarations
     foo :: Int -> Int