summaryrefslogtreecommitdiff
path: root/docs/users_guide/debugging.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/users_guide/debugging.rst')
-rw-r--r--docs/users_guide/debugging.rst12
1 files changed, 8 insertions, 4 deletions
diff --git a/docs/users_guide/debugging.rst b/docs/users_guide/debugging.rst
index ec40a5e251..569923ade4 100644
--- a/docs/users_guide/debugging.rst
+++ b/docs/users_guide/debugging.rst
@@ -27,10 +27,14 @@ Dumping out compiler intermediate structures
:shortdesc: Dump to files instead of stdout
:type: dynamic
- Causes the output from all of the flags listed below to be dumped
- to a file. The file name depends upon the output produced; for instance,
- output from :ghc-flag:`-ddump-simpl` will end up in
- :file:`{module}.dump-simpl`.
+ Causes the output from each of flags starting with "-ddump", to be
+ dumped to a file or files. If you want to have all the output from one
+ single flag saved to one file, use :ghc-flag:`-ddump-file-prefix=⟨str⟩`
+ (see descriptions below). Otherwise, the output will go to several
+ files, including one for non-module specific and several for module
+ specific. The suffix of a dump file depends on the flag turned on, for
+ instance, output from :ghc-flag:`-ddump-simpl` will end up in
+ :file:`prefix.dump-simpl`.
.. ghc-flag:: -ddump-file-prefix=⟨str⟩
:shortdesc: Set the prefix of the filenames used for debugging output.