summaryrefslogtreecommitdiff
path: root/docs/users_guide/profiling.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/users_guide/profiling.rst')
-rw-r--r--docs/users_guide/profiling.rst10
1 files changed, 9 insertions, 1 deletions
diff --git a/docs/users_guide/profiling.rst b/docs/users_guide/profiling.rst
index 1eddcb7160..6eb5008146 100644
--- a/docs/users_guide/profiling.rst
+++ b/docs/users_guide/profiling.rst
@@ -459,7 +459,7 @@ compiled program.
:type: dynamic
Deprecated alias for :ghc-flag:`-fprof-auto-exported`
-
+
.. ghc-flag:: -caf-all
:shortdesc: *(deprecated)* Alias for :ghc-flag:`-fprof-cafs`
:type: dynamic
@@ -886,6 +886,14 @@ There are three more options which relate to heap profiling:
profiles are always sampled with the frequency of the RTS clock. See
:ref:`prof-time-options` for changing that.
+.. rts-flag:: --no-automatic-heap-samples
+
+ :since: 9.2.1
+
+ Don't start heap profiling from the start of program execution. If this
+ option is enabled, it's expected that the user will manually start heap
+ profiling or request specific samples using functions from ``GHC.Profiling``.
+
.. rts-flag:: -L ⟨num⟩
Sets the maximum length of a cost-centre stack name in a heap