diff options
author | Benjamin Maurer <maurer.benjamin@gmail.com> | 2021-09-21 12:09:09 +0200 |
---|---|---|
committer | Marge Bot <ben+marge-bot@smart-cactus.org> | 2021-09-28 09:58:13 -0400 |
commit | 028abd5bf398db6d872a10342695e8e84e0827b3 (patch) | |
tree | 01d6960af5ee37cc682fb339ba69a18cda8095ca /docs | |
parent | 62b4a89b6ec9d424231f7c68180363a86ac44344 (diff) | |
download | haskell-028abd5bf398db6d872a10342695e8e84e0827b3.tar.gz |
Documented yet undocumented dump flags #18641
Diffstat (limited to 'docs')
-rw-r--r-- | docs/users_guide/debugging.rst | 38 | ||||
-rw-r--r-- | docs/users_guide/expected-undocumented-flags.txt | 6 |
2 files changed, 38 insertions, 6 deletions
diff --git a/docs/users_guide/debugging.rst b/docs/users_guide/debugging.rst index b9dcdb4a47..ec40a5e251 100644 --- a/docs/users_guide/debugging.rst +++ b/docs/users_guide/debugging.rst @@ -235,6 +235,12 @@ the desugarer and includes the simplifier, worker-wrapper transformation, the rule engine, the specialiser, the strictness/occurrence analyser, and a common subexpression elimination pass. +.. ghc-flag:: -ddump-call-arity + :shortdesc: Dump output of the call arity analysis pass. + :type: dynamic + + Dump output of the call arity analysis pass (:ghc-flag:`-fcall-arity`). + .. ghc-flag:: -ddump-core-stats :shortdesc: Print a one-line summary of the size of the Core program at the end of the optimisation pipeline @@ -253,6 +259,12 @@ subexpression elimination pass. sensible default. :ghc-flag:`-ddump-ds-preopt` shows the output after desugaring but before the very simple optimiser. +.. ghc-flag:: -ddump-exitify + :shortdesc: Dump output of the exitification pass. + :type: dynamic + + Dump output of the exitification pass (:ghc-flag:`-fexitification`), + which tries to pull out code out of recursive functions. .. ghc-flag:: -ddump-simpl-iterations :shortdesc: Dump output from each simplifier iteration @@ -268,6 +280,13 @@ subexpression elimination pass. Dump statistics about how many of each kind of transformation took place. If you add :ghc-flag:`-dppr-debug` you get more detailed information. +.. ghc-flag:: -ddump-simpl-trace + :shortdesc: Dump trace messages in simplifier + :type: dynamic + + Dump trace messages from various functions of the simplifier. + Produces quite a lot of output. + .. ghc-flag:: -dverbose-core2core :shortdesc: Show output from each core-to-core pass :type: dynamic @@ -405,6 +424,12 @@ subexpression elimination pass. Dump output of Core preparation pass +.. ghc-flag:: -ddump-view-pattern-commoning + :shortdesc: Dump commoned view patterns + :type: dynamic + + Print the view patterns that are commoned. + STG representation ~~~~~~~~~~~~~~~~~~ @@ -598,6 +623,13 @@ assembler. Alias for :ghc-flag:`-ddump-cmm-opt` +.. ghc-flag:: -ddump-asm-conflicts + :shortdesc: Dump register conflicts from the register allocator. + :type: dynamic + + Dump (virtual) register conflicts ("interferences") from the + graph coloring register allocator (:ghc-flag:`-fregs-graph`). + .. ghc-flag:: -ddump-asm-native :shortdesc: Dump initial assembly :type: dynamic @@ -654,6 +686,12 @@ These flags dump various bits of information from other backends. Dump byte-code objects (BCOs) produced for the GHC's byte-code interpreter. +.. ghc-flag:: -ddump-debug + :shortdesc: Dump generated DWARF debug information + :type: dynamic + + Dump generated debug information (DWARF) produced with the :ghc-flag:`-g` flag. + .. ghc-flag:: -ddump-rtti :shortdesc: Trace runtime type inference :type: dynamic diff --git a/docs/users_guide/expected-undocumented-flags.txt b/docs/users_guide/expected-undocumented-flags.txt index 0cfa302985..b155c82505 100644 --- a/docs/users_guide/expected-undocumented-flags.txt +++ b/docs/users_guide/expected-undocumented-flags.txt @@ -22,12 +22,6 @@ -XTraditionalRecordSyntax -copy-libs-when-linking -dannot-lint --ddump-asm-conflicts --ddump-call-arity --ddump-debug --ddump-exitify --ddump-simpl-trace --ddump-view-pattern-commoning -dppr-ticks -dsource-stats -dstg-stats |