diff options
Diffstat (limited to 'docs/users_guide')
| -rw-r--r-- | docs/users_guide/runtime_control.xml | 28 | ||||
| -rw-r--r-- | docs/users_guide/using.xml | 5 |
2 files changed, 29 insertions, 4 deletions
diff --git a/docs/users_guide/runtime_control.xml b/docs/users_guide/runtime_control.xml index 6a3a9e3ee7..e15d5cc080 100644 --- a/docs/users_guide/runtime_control.xml +++ b/docs/users_guide/runtime_control.xml @@ -85,6 +85,34 @@ </sect2> + <sect2 id="rts-options-misc"> + <title>Miscellaneous RTS options</title> + + <variablelist> + <varlistentry> + <term><option>-V<replaceable>secs</replaceable></option></term> + <indexterm><primary><option>-V</option></primary><secondary>RTS + option</secondary></indexterm> + <listitem> + <para>Sets the interval that the RTS clock ticks at. The + runtime uses a single timer signal to count ticks; this timer + signal is used to control the context switch timer (<xref + linkend="sec-using-concurrent" />) and the heap profiling + timer <xref linkend="rts-options-heap-prof" />. Also, the + time profiler uses the RTS timer signal directly to record + time profiling samples.</para> + + <para>Normally, setting the <option>-V</option> option + directly is not necessary: the resolution of the RTS timer is + adjusted automatically if a short interval is requested with + the <option>-C</option> or <option>-i</option> options. + However, setting <option>-V</option> is required in order to + increase the resolution of the time profiler.</para> + </listitem> + </varlistentry> + </variablelist> + </sect2> + <sect2 id="rts-options-gc"> <title>RTS options to control the garbage collector</title> diff --git a/docs/users_guide/using.xml b/docs/users_guide/using.xml index 2868876737..7bf85ef382 100644 --- a/docs/users_guide/using.xml +++ b/docs/users_guide/using.xml @@ -1524,10 +1524,7 @@ f "2" = 2 every 4k of allocation). With <option>-C0</option> or <option>-C</option>, context switches will occur as often as possible (at every heap block allocation). By default, context - switches occur every 20ms. Note that GHC's internal timer ticks - every 20ms, and the context switch timer is always a multiple of - this timer, so 20ms is the maximum granularity available for timed - context switches.</para> + switches occur every 20ms.</para> </listitem> </varlistentry> </variablelist> |