release-notes/WIP-Cabal-3.12.x.0.md

   1 Cabal 3.12.1.0 changelog and release notes.
   2
   3 This file will be edited and the changes incorprated into the official
   4 3.12.1.0 Cabal and Cabal-syntax release notes.
   5
   6 ---
   7
   8 ### Significant changes
   9
  10 - Deprecation of the `__HADDOCK_VERSION__` macro:
  11     In the next major version of Cabal, we no longer define the
  12     `__HADDOCK_VERSION__` macro when invoking GHC through Haddock, since doing
  13     so essentially guarantees recompilation during documentation generation. We
  14     audited all uses of `__HADDOCK_VERSION__` in hackage, ensuring there was a
  15     reasonable path forward to migrate away from using `__HADDOCK_VERSION__` for
  16     each, while generating the same documentation as it did before.  If you are
  17     a user of `__HADDOCK_VERSION__`, please take a look at the discussion in
  18     https://github.com/haskell/cabal/pull/9177 and reach out to us if your use
  19     case is not covered.