diff options
author | Sebastian Graf <sebastian.graf@kit.edu> | 2020-11-10 13:20:04 +0100 |
---|---|---|
committer | Sebastian Graf <sebastian.graf@kit.edu> | 2020-11-19 13:53:49 +0100 |
commit | fd1fa0fa20f6b431ef1f0fd8d48313632385dcfb (patch) | |
tree | ca7b3399ae76406b7089b6e1cdd216a55b9b78f4 /docs/users_guide/debugging.rst | |
parent | 07723a60e07a8b9d9d9b646eaa0ffcf214e02ef8 (diff) | |
download | haskell-wip/refactor-demand.tar.gz |
Update user's guide entry on demand analysis and worker/wrapperwip/refactor-demand
The demand signature notation has been undocumented for a long time.
The only source to understand it, apart from reading the `Outputable`
instance, has been an outdated wiki page.
Since the previous commits have reworked the demand lattice, I took
it as an opportunity to also write some documentation about notation.
Diffstat (limited to 'docs/users_guide/debugging.rst')
-rw-r--r-- | docs/users_guide/debugging.rst | 15 |
1 files changed, 10 insertions, 5 deletions
diff --git a/docs/users_guide/debugging.rst b/docs/users_guide/debugging.rst index 75728ae7d7..836be3a9ea 100644 --- a/docs/users_guide/debugging.rst +++ b/docs/users_guide/debugging.rst @@ -334,16 +334,22 @@ subexpression elimination pass. its rationale. .. ghc-flag:: -ddump-stranal - :shortdesc: Dump strictness analyser output + :shortdesc: Dump demand analysis output :type: dynamic - Dump strictness analyser output + Dump demand analysis output. + + See :ghc-flag:`-fstrictness` for the syntax and semantics of demand + annotations. .. ghc-flag:: -ddump-str-signatures - :shortdesc: Dump strictness signatures + :shortdesc: Dump top-level demand signatures :type: dynamic - Dump strictness signatures + Dump top-level demand signatures as produced by demand analysis. + + See :ghc-flag:`-fstrictness` for the syntax and semantics of demand + annotations. .. ghc-flag:: -ddump-cpranal :shortdesc: Dump CPR analysis output @@ -381,7 +387,6 @@ subexpression elimination pass. Dump output of Core preparation pass - STG representation ~~~~~~~~~~~~~~~~~~ |