diff options
| author | Alexander Esgen <alexander.esgen@tweag.io> | 2022-05-09 18:27:32 +0200 |
|---|---|---|
| committer | Andreas Klebinger <klebinger.andreas@gmx.at> | 2022-06-22 12:36:13 +0000 |
| commit | c1a950c1ea6f22a1d837389c02ba83122cb5c160 (patch) | |
| tree | 0cf75fee2a5f1c58ba7a4ebbb2527569b5c48471 | |
| parent | eb4fb8493823d9b962c26507d01a921dca8b8857 (diff) | |
| download | haskell-c1a950c1ea6f22a1d837389c02ba83122cb5c160.tar.gz | |
Correct documentation of defaults of the `-V` RTS option
| -rw-r--r-- | docs/users_guide/profiling.rst | 13 |
1 files changed, 7 insertions, 6 deletions
diff --git a/docs/users_guide/profiling.rst b/docs/users_guide/profiling.rst index 0258aad815..418c9b0bb0 100644 --- a/docs/users_guide/profiling.rst +++ b/docs/users_guide/profiling.rst @@ -554,14 +554,15 @@ enclosed between ``+RTS ... -RTS`` as usual): .. rts-flag:: -V ⟨secs⟩ - :default: 0.02 + :default: 0.001 when profiling, and 0.01 otherwise Sets the interval that the RTS clock ticks at, which is also the sampling - interval of the time and allocation profile. The default is 0.02 seconds. - The runtime uses a single timer signal to count ticks; this timer signal is - used to control the context switch timer (:ref:`using-concurrent`) and the - heap profiling timer :ref:`rts-options-heap-prof`. Also, the time profiler - uses the RTS timer signal directly to record time profiling samples. + interval of the time and allocation profile. The default is 0.001 seconds + when profiling, and 0.01 otherwise. The runtime uses a single timer signal + to count ticks; this timer signal is used to control the context switch + timer (:ref:`using-concurrent`) and the heap profiling timer + :ref:`rts-options-heap-prof`. Also, the time profiler uses the RTS timer + signal directly to record time profiling samples. Normally, setting the :rts-flag:`-V ⟨secs⟩` option directly is not necessary: the resolution of the RTS timer is adjusted automatically if a |