summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorAndreas Klebinger <klebinger.andreas@gmx.at>2022-03-30 15:44:16 +0200
committerMarge Bot <ben+marge-bot@smart-cactus.org>2022-04-08 13:55:50 -0400
commit85f4a3c9c2635e71a9ab0b723774ec993fefb93d (patch)
tree8f721a85010a27fff52abad3e939066463eb3ea9 /docs
parent6e2c3b7cba823cd9c315edb9c0c0edeece33ac30 (diff)
downloadhaskell-85f4a3c9c2635e71a9ab0b723774ec993fefb93d.tar.gz
Add flag -fprof-manual which controls if GHC should honour manual cost centres.
This allows disabling of manual control centres in code a user doesn't control like libraries. Fixes #18867
Diffstat (limited to 'docs')
-rw-r--r--docs/users_guide/profiling.rst11
1 files changed, 11 insertions, 0 deletions
diff --git a/docs/users_guide/profiling.rst b/docs/users_guide/profiling.rst
index d1721919f4..0258aad815 100644
--- a/docs/users_guide/profiling.rst
+++ b/docs/users_guide/profiling.rst
@@ -463,6 +463,17 @@ compiled program.
"big" CAF cost-centre. With this option, all CAFs get their own
cost-centre. An "if all else fails" option…
+.. ghc-flag:: -fprof-manual
+ :shortdesc: Process manual ``SCC`` annotations.
+ :type: dynamic
+ :reverse: -fno-prof-manual
+ :category:
+
+ :default: on
+
+ Process (or ignore) manual ``SCC`` annotations. Can be helpful to ignore annotations from libraries which
+ are not desired.
+
.. ghc-flag:: -auto-all
:shortdesc: *(deprecated)* Alias for :ghc-flag:`-fprof-auto`
:type: dynamic