diff options
| author | Carrie Xu <carrie.xmy@gmail.com> | 2021-10-06 23:02:04 +0800 |
|---|---|---|
| committer | Marge Bot <ben+marge-bot@smart-cactus.org> | 2021-12-01 03:08:46 -0500 |
| commit | 7acb945d443e26c7e51850c9c51321b0a5a7978a (patch) | |
| tree | 7ee62d80c789f3a801c8314d1b1252c1a9ca186c /docs | |
| parent | 87bd9a675441513871de55c3cca47a7bb3341639 (diff) | |
| download | haskell-7acb945d443e26c7e51850c9c51321b0a5a7978a.tar.gz | |
Dump non-module specific info to file #20316
- Change the dumpPrefix to FilePath, and default to non-module
- Add dot to seperate dump-file-prefix and suffix
- Modify user guide to introduce how dump files are named
- This commit does not affect Ghci dump file naming.
See also #17500
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/users_guide/debugging.rst | 12 |
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. |