summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAthas <athas@sigkill.dk>2019-12-01 15:01:12 -0500
committerMarge Bot <ben+marge-bot@smart-cactus.org>2019-12-03 00:00:09 -0500
commit5a4b8d0cf2ff83d1a04826b9624fffec7b9a5683 (patch)
treef90e2e4e523c36254e012dcf5cd15f304691981a
parentfbbe18a274cd094a0582396e83619378a7071386 (diff)
downloadhaskell-5a4b8d0cf2ff83d1a04826b9624fffec7b9a5683.tar.gz
Document RTS behaviour upon encountering '--'.
-rw-r--r--docs/users_guide/runtime_control.rst3
1 files changed, 2 insertions, 1 deletions
diff --git a/docs/users_guide/runtime_control.rst b/docs/users_guide/runtime_control.rst
index 1f4b766400..f6dd9a62e8 100644
--- a/docs/users_guide/runtime_control.rst
+++ b/docs/users_guide/runtime_control.rst
@@ -77,7 +77,8 @@ the end of the command line, as in this example:
If you absolutely positively want all the rest of the options in a
command line to go to the program (and not the RTS), use a
-``--RTS``.
+``--RTS`` or ``--``. The difference is that ``--RTS`` will not be passed to
+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