diff options
| author | Ömer Sinan Ağacan <omeragacan@gmail.com> | 2020-01-17 10:27:49 +0300 |
|---|---|---|
| committer | Marge Bot <ben+marge-bot@smart-cactus.org> | 2020-01-20 15:31:33 -0500 |
| commit | 0499e3bcd0ea04b7371cee56a8aea1781e9e371f (patch) | |
| tree | 7f706bf2f13d26a2a80d5eaebb33e95ca194f1f1 | |
| parent | a71323ffebf7663c50025d2731bf9de2d04f82c3 (diff) | |
| download | haskell-0499e3bcd0ea04b7371cee56a8aea1781e9e371f.tar.gz | |
Fix +RTS -Z flag documentation
Stack squeezing is done on context switch, not on GC or stack overflow.
Fix the documentation.
Fixes #17685
[ci skip]
| -rw-r--r-- | docs/users_guide/runtime_control.rst | 2 | ||||
| -rw-r--r-- | rts/RtsFlags.c | 2 |
2 files changed, 2 insertions, 2 deletions
diff --git a/docs/users_guide/runtime_control.rst b/docs/users_guide/runtime_control.rst index 2cfd22e664..522aa72ce7 100644 --- a/docs/users_guide/runtime_control.rst +++ b/docs/users_guide/runtime_control.rst @@ -1332,7 +1332,7 @@ recommended for everyday use! .. rts-flag:: -Z - Turn *off* "update-frame squeezing" at garbage-collection time. + Turn *off* update frame squeezing on context switch. (There's no particularly good reason to turn it off, except to ensure the accuracy of certain data collected regarding thunk entry counts.) diff --git a/rts/RtsFlags.c b/rts/RtsFlags.c index 911cf32969..fe118ea5f0 100644 --- a/rts/RtsFlags.c +++ b/rts/RtsFlags.c @@ -324,7 +324,7 @@ usage_text[] = { " -S[<file>] Detailed GC statistics (if <file> omitted, uses stderr)", "", "", -" -Z Don't squeeze out update frames on stack overflow", +" -Z Don't squeeze out update frames on context switch", " -B Sound the bell at the start of each garbage collection", #if defined(PROFILING) "", |