diff options
| author | Tobias Guggenmos <tguggenm@redhat.com> | 2019-09-07 16:23:01 +0200 |
|---|---|---|
| committer | Marge Bot <ben+marge-bot@smart-cactus.org> | 2019-10-03 12:17:33 -0400 |
| commit | ee6324adfed737fbf9ca3c36538145542b425617 (patch) | |
| tree | c8da23452d19ff3a8915c2118fa4b5849b832219 | |
| parent | e4c9389678f676aa664fa39cdaf8af865cc24855 (diff) | |
| download | haskell-ee6324adfed737fbf9ca3c36538145542b425617.tar.gz | |
Improve documentation for runtime debugging flags
| -rw-r--r-- | docs/users_guide/runtime_control.rst | 22 |
1 files changed, 22 insertions, 0 deletions
diff --git a/docs/users_guide/runtime_control.rst b/docs/users_guide/runtime_control.rst index c573576972..77b86e3c2a 100644 --- a/docs/users_guide/runtime_control.rst +++ b/docs/users_guide/runtime_control.rst @@ -1152,10 +1152,32 @@ recommended for everyday use! messages from the scheduler. Use ``+RTS -?`` to find out which debug flags are supported. + Full list of currently supported flags: + +.. rts-flag:: -Ds DEBUG: scheduler +.. rts-flag:: -Di DEBUG: interpreter +.. rts-flag:: -Dw DEBUG: weak +.. rts-flag:: -DG DEBUG: gccafs +.. rts-flag:: -Dg DEBUG: gc +.. rts-flag:: -Db DEBUG: block +.. rts-flag:: -DS DEBUG: sanity +.. rts-flag:: -Dt DEBUG: stable +.. rts-flag:: -Dp DEBUG: prof +.. rts-flag:: -Da DEBUG: apply +.. rts-flag:: -Dl DEBUG: linker +.. rts-flag:: -Dm DEBUG: stm +.. rts-flag:: -Dz DEBUG: stack squeezing +.. rts-flag:: -Dc DEBUG: program coverage +.. rts-flag:: -Dr DEBUG: sparks +.. rts-flag:: -DC DEBUG: compact + Debug messages will be sent to the binary event log file instead of stdout if the :rts-flag:`-l` option is added. This might be useful for reducing the overhead of debug tracing. + To figure out what exactly they do, the least bad way is to grep the rts/ directory in + the ghc code for macros like ``DEBUG(scheduler`` or ``DEBUG_scheduler``. + .. rts-flag:: -r ⟨file⟩ .. index:: |