diff options
| author | Ben Gamari <ben@smart-cactus.org> | 2021-04-22 13:12:49 -0400 |
|---|---|---|
| committer | Marge Bot <ben+marge-bot@smart-cactus.org> | 2021-04-26 23:55:44 -0400 |
| commit | 3339ed49b103d5aab42733dfb434de3a9a27bf2b (patch) | |
| tree | d22ce506b4ee4bf2a65e52a7db79cdcff0d25508 | |
| parent | 9f9fab1531d62f6d30c853722548393be264120b (diff) | |
| download | haskell-3339ed49b103d5aab42733dfb434de3a9a27bf2b.tar.gz | |
users-guide: Document deprecation of -funfolding-keeness-factor
See #15304.
| -rw-r--r-- | docs/users_guide/9.0.1-notes.rst | 7 | ||||
| -rw-r--r-- | docs/users_guide/expected-undocumented-flags.txt | 1 | ||||
| -rw-r--r-- | docs/users_guide/using-optimisation.rst | 9 |
3 files changed, 16 insertions, 1 deletions
diff --git a/docs/users_guide/9.0.1-notes.rst b/docs/users_guide/9.0.1-notes.rst index 95e9852e61..c1da0ec854 100644 --- a/docs/users_guide/9.0.1-notes.rst +++ b/docs/users_guide/9.0.1-notes.rst @@ -248,6 +248,13 @@ Compiler default, as proposed in `GHC proposal #314 <https://github.com/ghc-proposals/ghc-proposals/pull/314>`_ +- 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/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 523b0a7e66..79cac66a17 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 |