diff options
author | Adam Sandberg Ericsson <adam@sandbergericsson.se> | 2021-04-24 13:20:50 +0100 |
---|---|---|
committer | Adam Sandberg Ericsson <adam@sandbergericsson.se> | 2021-04-24 17:49:44 +0100 |
commit | 8dac61f361b6253eeddbc8464f6520fe000d2d52 (patch) | |
tree | c08923d50a6a86c462141d7d3ba999f3d4d69873 | |
parent | 7bc7eea3897dcb8a87fdb0921f451b9bc77309f6 (diff) | |
download | haskell-wip/adamse/rts-flags-docs.tar.gz |
docs: add a short up-front description for -O, -n, -qn, -I and -Iwwip/adamse/rts-flags-docs
-rw-r--r-- | docs/users_guide/runtime_control.rst | 29 |
1 files changed, 19 insertions, 10 deletions
diff --git a/docs/users_guide/runtime_control.rst b/docs/users_guide/runtime_control.rst index 25b27fdd1b..4b0ca7f0b0 100644 --- a/docs/users_guide/runtime_control.rst +++ b/docs/users_guide/runtime_control.rst @@ -492,10 +492,11 @@ performance. .. index:: single: old generation, size - Set the minimum size of the old generation. The old generation is collected - whenever it grows to this size or the value of the :rts-flag:`-F ⟨factor⟩` - option multiplied by the size of the live data at the previous major - collection, whichever is larger. + Set the minimum size of the old generation. + + The old generation is collected whenever it grows to this size or the value + of the :rts-flag:`-F ⟨factor⟩` option multiplied by the size of the live + data at the previous major collection, whichever is larger. .. rts-flag:: -n ⟨size⟩ @@ -504,6 +505,9 @@ performance. .. index:: single: allocation area, chunk size + Set the allocation area chunksize. Setting ``-n0`` means the allocation + area is not divided into chunks. + [Example: ``-n4m`` ] When set to a non-zero value, this option divides the allocation area (``-A`` value) into chunks of the specified size. During execution, when a processor exhausts its @@ -661,6 +665,8 @@ performance. .. index:: single: GC threads, setting the number of + Set the number of threads to use for the parallel GC. + By default, all of the capabilities participate in parallel garbage collection. If we want to use a very large ``-N`` value, however, this can reduce the performance of the GC. For this @@ -706,12 +712,13 @@ performance. .. index:: single: idle GC - In the threaded and SMP versions of the RTS (see - :ghc-flag:`-threaded`, :ref:`options-linker`), a major GC is automatically - performed if the runtime has been idle (no Haskell computation has - been running) for a period of time. The amount of idle time which - must pass before a GC is performed is set by the ``-I ⟨seconds⟩`` - option. Specifying ``-I0`` disables the idle GC. + Set the amount of idle time which must pass before a idle GC is + performed. Setting ``-I0`` disables the idle GC. + + In the threaded and SMP versions of the RTS (see :ghc-flag:`-threaded`, + :ref:`options-linker`), a major GC is automatically performed if the + runtime has been idle (no Haskell computation has been running) for a + period of time. For an interactive application, it is probably a good idea to use the idle GC, because this will allow finalizers to run and @@ -733,6 +740,8 @@ performance. .. index:: single: idle GC + Set the minimum wait time between runs of the idle GC. + By default, if idle GC is enabled in the threaded runtime, a major GC will be performed every time the process goes idle for a sufficiently long duration (see :rts-flag:`-I ⟨seconds⟩`). For |