summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAndreas Klebinger <klebinger.andreas@gmx.at>2020-09-17 14:53:56 +0200
committerMarge Bot <ben+marge-bot@smart-cactus.org>2020-09-19 15:50:33 -0400
commit8f8d51f137ffcdbc4432febc5d1a11a564807b1b (patch)
treef9387e7ca4c611fb2902d188fb29ba3db2d19c2c
parentf1accd00969e0b2993f14ee4ed858cea0c13357e (diff)
downloadhaskell-8f8d51f137ffcdbc4432febc5d1a11a564807b1b.tar.gz
Fix docs who misstated how the RTS treats size suffixes.
They are parsed as multiples of 1024. Not 1000. The docs used to imply otherwise. See decodeSize in rts/RtsFlags.c for the logic for this.
-rw-r--r--docs/users_guide/runtime_control.rst4
1 files changed, 2 insertions, 2 deletions
diff --git a/docs/users_guide/runtime_control.rst b/docs/users_guide/runtime_control.rst
index 2cbcf74047..4c5c437753 100644
--- a/docs/users_guide/runtime_control.rst
+++ b/docs/users_guide/runtime_control.rst
@@ -81,8 +81,8 @@ command line to go to the program (and not the RTS), use a
the program, while ``--`` will.
As always, for RTS options that take ⟨size⟩s: If the last character of
-⟨size⟩ is a K or k, multiply by 1000; if an M or m, by 1,000,000; if a G
-or G, by 1,000,000,000. (And any wraparound in the counters is *your*
+⟨size⟩ is a K or k, multiply by 1024; if an M or m, by 1024*1024; if a G
+or G, by 1024^3. (And any wraparound in the counters is *your*
fault!)
Giving a ``+RTS -?`` RTS option will print out the RTS