diff options
| author | Ben Gamari <ben@smart-cactus.org> | 2021-04-08 09:12:51 -0400 |
|---|---|---|
| committer | Ben Gamari <ben@smart-cactus.org> | 2021-04-08 12:21:58 -0400 |
| commit | 2aadabd8233264e3c573ab22ae9344373173985f (patch) | |
| tree | cfa6fe95e3b1418c95a253af32ae04aa23a3cadf | |
| parent | fc3c704905914f046e700e3e874999c1dd094d93 (diff) | |
| download | haskell-2aadabd8233264e3c573ab22ae9344373173985f.tar.gz | |
users-guide: Document deprecation of -funfolding-keeness-factor
See #15304.
| -rw-r--r-- | docs/users_guide/9.0.1-notes.rst | 6 | ||||
| -rw-r--r-- | docs/users_guide/using-optimisation.rst | 12 |
2 files changed, 10 insertions, 8 deletions
diff --git a/docs/users_guide/9.0.1-notes.rst b/docs/users_guide/9.0.1-notes.rst index 470d0ae9b2..c0db022030 100644 --- a/docs/users_guide/9.0.1-notes.rst +++ b/docs/users_guide/9.0.1-notes.rst @@ -256,6 +256,12 @@ Compiler - A new flag :ghc-flag:`-flink-rts` to enable linking the RTS when linking shared libraries. +- The ``-funfolding-keeness-factor`` flag has been deprecated as its scaling + strategy resulted in unreasonably large discounts in some cases (see + :ghc-ticket:`15304`). Users who previously used this flag to suggest + more aggressive inlining are advised to look at + :ghc-flag:`-funfolding-use-threshold=⟨n⟩` or use :pragma:`INLINE` pragmas to + more precisely force inlining. GHCi ~~~~ diff --git a/docs/users_guide/using-optimisation.rst b/docs/users_guide/using-optimisation.rst index 44ad26a60e..2fef06c01c 100644 --- a/docs/users_guide/using-optimisation.rst +++ b/docs/users_guide/using-optimisation.rst @@ -1228,17 +1228,13 @@ by saying ``-fno-wombat``. How eager should the compiler be to inline functions? .. ghc-flag:: -funfolding-keeness-factor=⟨n⟩ - :shortdesc: *default: 1.5.* Tweak unfolding settings. + :shortdesc: This has been deprecated in GHC 9.0.1. :type: dynamic :category: - :default: 1.5 - - .. index:: - single: inlining, controlling - single: unfolding, controlling - - How eager should the compiler be to inline functions? + 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. |