summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBen Gamari <ben@smart-cactus.org>2021-04-22 13:12:49 -0400
committerBen Gamari <ben@smart-cactus.org>2021-05-12 18:44:50 -0400
commit9889c0bd67529ff1ca3a0234044ab6da2a92ef56 (patch)
tree7b491bdc3d1d8a4b593d0032d2f61cec2397499e
parent882cc3638224674805e2b26e43cad853983575b5 (diff)
downloadhaskell-9889c0bd67529ff1ca3a0234044ab6da2a92ef56.tar.gz
users-guide: Document deprecation of -funfolding-keeness-factor
See #15304. (cherry picked from commit 3339ed49b103d5aab42733dfb434de3a9a27bf2b)
-rw-r--r--docs/users_guide/expected-undocumented-flags.txt1
-rw-r--r--docs/users_guide/using-optimisation.rst9
2 files changed, 9 insertions, 1 deletions
diff --git a/docs/users_guide/expected-undocumented-flags.txt b/docs/users_guide/expected-undocumented-flags.txt
index 9bd179d6f7..f7e55fa573 100644
--- a/docs/users_guide/expected-undocumented-flags.txt
+++ b/docs/users_guide/expected-undocumented-flags.txt
@@ -82,7 +82,6 @@
-fspecialize-aggressively
-fth
-ftype-function-depth
--funfolding-keeness-factor
-fuse-rpaths
-fversion-macros
-fvia-c
diff --git a/docs/users_guide/using-optimisation.rst b/docs/users_guide/using-optimisation.rst
index 2722a285df..7cb7c3d790 100644
--- a/docs/users_guide/using-optimisation.rst
+++ b/docs/users_guide/using-optimisation.rst
@@ -1399,6 +1399,15 @@ by saying ``-fno-wombat``.
How eager should the compiler be to inline functions?
+.. ghc-flag:: -funfolding-keeness-factor=⟨n⟩
+ :shortdesc: This has been deprecated in GHC 9.0.1.
+ :type: dynamic
+ :category:
+
+ This factor was deprecated in GHC 9.0.1. See :ghc-ticket:`15304` for
+ details. Users who need to control inlining should rather consider
+ :ghc-flag:`-funfolding-use-threshold=⟨n⟩`.
+
.. ghc-flag:: -funfolding-use-threshold=⟨n⟩
:shortdesc: *default: 80.* Tweak unfolding settings.
:type: dynamic