diff options
| author | Ben Gamari <ben@smart-cactus.org> | 2020-12-10 12:56:37 -0500 |
|---|---|---|
| committer | Ben Gamari <ben@smart-cactus.org> | 2020-12-20 21:03:32 -0500 |
| commit | f266c813d41472a7b04531facfd9dbe52b878f40 (patch) | |
| tree | f9c18002924c98d51b494228924f9027f3827960 /docs | |
| parent | 853f35cf8d710fc8f162d00eddead590800a765c (diff) | |
| download | haskell-wip/T7275.tar.gz | |
rts: Enforce that mark-region isn't used with -hwip/T7275
As noted in #9666, the mark-region GC is not compatible with heap
profiling. Also add documentation for this flag.
Closes #9666.
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/users_guide/runtime_control.rst | 11 |
1 files changed, 11 insertions, 0 deletions
diff --git a/docs/users_guide/runtime_control.rst b/docs/users_guide/runtime_control.rst index 5d3b24adac..5b4766a678 100644 --- a/docs/users_guide/runtime_control.rst +++ b/docs/users_guide/runtime_control.rst @@ -411,6 +411,17 @@ performance. Note that :rts-flag:`--nonmoving-gc` cannot be used with ``-G1``, :rts-flag:`profiling <-hc>` nor :rts-flag:`-c`. +.. rts-flag:: -w + + :default: off + :since: a long time ago + :reverse: none + + Uses a mark-region garbage collection strategy for the oldest-generation heap. + Note that this cannot be used in conjunction with heap profiling + (:rts-flag:`-hT`) unless linked against the profiling runtime system with + :ghc-flag:`-prof`. + .. rts-flag:: -xn :default: off |