summaryrefslogtreecommitdiff
path: root/docs/users_guide/runtime_control.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/users_guide/runtime_control.rst')
-rw-r--r--docs/users_guide/runtime_control.rst20
1 files changed, 14 insertions, 6 deletions
diff --git a/docs/users_guide/runtime_control.rst b/docs/users_guide/runtime_control.rst
index 049ba13839..a68b1bd266 100644
--- a/docs/users_guide/runtime_control.rst
+++ b/docs/users_guide/runtime_control.rst
@@ -313,7 +313,7 @@ collection. Hopefully, you won't need any of these in normal operation,
but there are several things that can be tweaked for maximum
performance.
-.. rts-flag:: -xn
+.. rts-flag:: --nonmoving-gc
:default: off
:since: 8.10.1
@@ -324,12 +324,20 @@ performance.
Enable the concurrent mark-and-sweep garbage collector for old generation
collectors. Typically GHC uses a stop-the-world copying garbage collector
for all generations. This can cause long pauses in execution during major
- garbage collections. :rts-flag:`-xn` enables the use of a concurrent
- mark-and-sweep garbage collector for oldest generation collections.
- Under this collection strategy oldest-generation garbage collection
- can proceed concurrently with mutation.
+ garbage collections. :rts-flag:`--nonmoving-gc` enables the use of a
+ concurrent mark-and-sweep garbage collector for oldest generation
+ collections. Under this collection strategy oldest-generation garbage
+ collection can proceed concurrently with mutation.
+
+ Note that :rts-flag:`--nonmoving-gc` cannot be used with ``-G1`` nor
+ :rts-flag:`-c`.
+
+.. rts-flag:: -xn
+
+ :default: off
+ :since: 8.10.1
- Note that :rts-flag:`-xn` cannot be used with ``-G1`` nor :rts-flag:`-c`.
+ An alias for :rts-flag:`--nonmoving-gc`
.. rts-flag:: -A ⟨size⟩