release-notes/Cabal-3.8.1.0.md

   1 Cabal 3.8.1.0 Changelog
   2 ---
   3
   4 ### Significant changes
   5
   6 - Split out package `Cabal-syntax` for `.cabal` file syntax and parsing [#7559](https://github.com/haskell/cabal/issues/7559) [#7620](https://github.com/haskell/cabal/pull/7620)
   7
   8 - Unmarked "visibility: public" and "build-depends: pkg:lib" syntaxes as experimental, allowing Hackage upload of packages exposing or using multiple public libraries [#6801](https://github.com/haskell/cabal/issues/6801) [#7286](https://github.com/haskell/cabal/issues/7286) [#8089](https://github.com/haskell/cabal/pull/8089)
   9
  10 - Add code-generators field to test-suite stanza [#4500](https://github.com/haskell/cabal/issues/4500) [#7688](https://github.com/haskell/cabal/pull/7688)
  11
  12   Test-suite stanzas now may contain a `code-generators:` field that can be used to run executables as preprocessors which take existing locations of library code and cabal-generated ghc build flags, and output new modules for use in the test stanza. This can be used to automatically generate drivers for "discover" style tests, including doctests.
  13
  14 - Windows: redo the fix to breakage caused by new autoconf; the wrong fix made cabal sometimes fail with old autoconf [#7494](https://github.com/haskell/cabal/issues/7494) [#7649](https://github.com/haskell/cabal/issues/7649)
  15
  16   - Reverts #7510 that failed on Windows when used with pre-generated scripts included in packages such as network, time, process.
  17   - Adds a subtler fix/workaround for the deficiencies of new autoconf versions on Windows.
  18
  19 - Windows: rewrite paths to configure [#7494](https://github.com/haskell/cabal/issues/7494) [#7649](https://github.com/haskell/cabal/issues/7649)
  20 - Enabled foreign library building on apple silicon [#7837](https://github.com/haskell/cabal/issues/7837) [#8227](https://github.com/haskell/cabal/issues/8227) [#8232](https://github.com/haskell/cabal/pull/8232)
  21
  22   - Enabled foreign library building on apple silicon
  23   - Updated error message for foreign library builds on unsupported platforms
  24
  25 - Allow preprocessors to register a reordering [#55](https://github.com/haskell/cabal/issues/55) [#1906](https://github.com/haskell/cabal/issues/1906)
  26
  27   - Changes the PreProcessor type to include a field ppOrdering so that modules are presented to the preprocessor in the right order (w.r.t. dependencies)
  28
  29 - Use ghc -flink-rts option when available [#7763](https://github.com/haskell/cabal/issues/7763) [#7764](https://github.com/haskell/cabal/pull/7764) [#8111](https://github.com/haskell/cabal/pull/8111)
  30
  31   Previously Cabal did quite some headstands to link against libHSrts.
  32   Note only this is complex but it couples very tightly to GHC's implementation.
  33   Thankfully, as of GHC 9.0 GHC provides a -flink-rts flag for precisely this purpose.
  34   Use it when available.
  35
  36   It fixed a bug which make Cabal unusable to build foreign libraries for windows and ghc 9.0 or 9.2.
  37   See <https://gitlab.haskell.org/ghc/ghc/-/issues/20520>
  38
  39 - Remove the Generic instance of LicenseId [#8074](https://github.com/haskell/cabal/issues/8074) [#8117](https://github.com/haskell/cabal/pull/8117)
  40
  41   - The `Generic` instance of LicenseId is removed, due to the extraordinary amount of memory required to compile
  42     the Generic instances of large sum types in GHC.
  43
  44
  45 ### Other changes
  46
  47 - Handle option argument parse errors without 'error' [#7573](https://github.com/haskell/cabal/issues/7573) [#7579](https://github.com/haskell/cabal/pull/7579)
  48
  49   - Errors parsing arguments such as `-v=3` no longer result in
  50     stack traces.
  51   - `Distribution.ReadE.readEOrFail` was removed.
  52
  53 - Fix bugs in filename validation [#7426](https://github.com/haskell/cabal/issues/7426) [#7429](https://github.com/haskell/cabal/pull/7429) [#7479](https://github.com/haskell/cabal/pull/7479)
  54
  55   - Relative paths starting with single-character directories are now properly allowed
  56   - `cabal check` rejects paths which are invalid on Windows or in tarballs
  57
  58 - Fix test --enable-coverage for multi-package projects [#5213](https://github.com/haskell/cabal/issues/5213) [#5433](https://github.com/haskell/cabal/issues/5433) [#7200](https://github.com/haskell/cabal/issues/7200) [#7250](https://github.com/haskell/cabal/pull/7250) [#7467](https://github.com/haskell/cabal/pull/7467)
  59
  60   - Fix `cabal test --enable-coverage` for multi-package projects by invoking `hpc markup --include=` and listing only modules of libraries of the single tested package.
  61
  62 - Make cabal respect setgid permission bit when creating directories [#7560](https://github.com/haskell/cabal/issues/7560) [#7572](https://github.com/haskell/cabal/pull/7572)
  63
  64   - Previously cabal would override an admin's choice to use setgid on the
  65     .cabal directory by using hardcoded file and directory modes upon
  66     creation. Instead we now take what the system decides and only add to
  67     that set of permissions.
  68
  69 - Handle conditionals in duplicate module checks [#4629](https://github.com/haskell/cabal/issues/4629) [#7525](https://github.com/haskell/cabal/issues/7525) [#7616](https://github.com/haskell/cabal/pull/7616)
  70
  71   Improves `cabal check` logic for duplicate modules to take into account conditional branches. If a module appears on both sides of an `if/else` clause in a cabal file, it is now correctly not reported as a duplicate.
  72
  73 - Allow glob-star matches with literal filenames (no extensions) [#5883](https://github.com/haskell/cabal/issues/5883) [#8005](https://github.com/haskell/cabal/pull/8005)
  74
  75   - Cabal file glob syntax extended to allow matches of the form dir/**/FileNoExtension
  76
  77 - Flatten duplicate warnings about experimental features [#8023](https://github.com/haskell/cabal/pull/8023)
  78
  79   - Make builds that use experimental Cabal language features less noisy. At -v1
  80     (normal) we show just first instance of use of experimental cabal language
  81   features, along with count of further occurrences in the same file.
  82
  83 - Fix Cabal not finding public sublibraries of installed packages [#7270](https://github.com/haskell/cabal/issues/7270) [#8089](https://github.com/haskell/cabal/pull/8089)
  84
  85   Fix bug in lookup of installed sublibraries with nonexact dependencies (ie. when
  86   not using --exact-configuration). That is the mode of operation of distribution
  87   packages, so this should allow distros to package Cabal packages with multiple
  88   libraries.
  89
  90 - Make type field optional for tests and benchmarks [#7459](https://github.com/haskell/cabal/issues/7459) [#8115](https://github.com/haskell/cabal/pull/8115)
  91
  92   Allow the omission of the `type` field in `test-suite` and `benchmark` stanzas
  93   when the type can be inferred by the presence of `main-is` or `test-module`.
  94
  95 - Improve error message for empty --allow-newer=  [#7740](https://github.com/haskell/cabal/issues/7740) [#8140](https://github.com/haskell/cabal/pull/8140)
  96
  97   Instead of internal error, the message now explains that empty argument for
  98
  99   argument) means.
 100
 101 - Fix haddock command via Setup.hs for internal libraries [#1919](https://github.com/haskell/cabal/issues/1919) [#7827](https://github.com/haskell/cabal/pull/7827)
 102 - `ghc-options` and `--with-gcc` are now passed to GHC when compiling C and C++ sources [#4439](https://github.com/haskell/cabal/issues/4439) [#5440](https://github.com/haskell/cabal/pull/5440) [#7874](https://github.com/haskell/cabal/pull/7874)
 103 - 'cabal check' to fail when no upper bounds for base or Cabal are present in setup dependencies [#4683](https://github.com/haskell/cabal/issues/4683) [#5370](https://github.com/haskell/cabal/pull/5370) [#7409](https://github.com/haskell/cabal/pull/7409)
 104 - --repl-options doesn’t split on whitespace [#6190](https://github.com/haskell/cabal/issues/6190) [#7799](https://github.com/haskell/cabal/pull/7799)
 105 - '--repl-no-load' option skips startup modules load in REPL [#7541](https://github.com/haskell/cabal/issues/7541) [#7578](https://github.com/haskell/cabal/pull/7578)
 106 - Add -c alias for --constraint command line flag [#7765](https://github.com/haskell/cabal/issues/7765) [#7766](https://github.com/haskell/cabal/pull/7766)
 107 - Add fields extra-libraries-static and extra-lib-dirs-static [#6688](https://github.com/haskell/cabal/issues/6688) [#7399](https://github.com/haskell/cabal/issues/7399) [#7536](https://github.com/haskell/cabal/pull/7536)
 108 - Paths passed to GHC are now relative to the current working directory
 109 - raise lower bound of process and remove compatibility shims [#7922](https://github.com/haskell/cabal/pull/7922)
 110 - changes the cabal check warning about long synopsis, so it warns only synopsis bigger than the set size [#7932](https://github.com/haskell/cabal/issues/7932) [#7933](https://github.com/haskell/cabal/pull/7933)
 111 - Remove bootstrapping plan files from version control, and simplify bootstrap update Makefile targets. [#7949](https://github.com/haskell/cabal/pull/7949)
 112 - Remove deprecated file finding functions [#7955](https://github.com/haskell/cabal/pull/7955)
 113 - Support GHC 9.4's `clang`-based Windows toolchain [#8062](https://github.com/haskell/cabal/pull/8062)
 114 - Add support for the 64-bit S390X architecture [#8065](https://github.com/haskell/cabal/pull/8065)
 115 - Add wasm32-wasi to recognized arch/os [#8096](https://github.com/haskell/cabal/pull/8096)
 116
 117 - *Cabal-syntax* Derive Eq for DependencyMap [#7849](https://github.com/haskell/cabal/issues/7849) [#8061](https://github.com/haskell/cabal/pull/8061)
 118 - *Cabal-syntax* Allow trailing whitespace after flags in cabal.project [#7279](https://github.com/haskell/cabal/issues/7279) [#8006](https://github.com/haskell/cabal/pull/8006)
 119 - *Cabal-syntax* Update the SPDX License List to version 3.16 [#8126](https://github.com/haskell/cabal/issues/8126) [#8127](https://github.com/haskell/cabal/pull/8127)
 120
 121   The LicenseId and LicenseExceptionId types are updated to reflect the SPDX License List version 3.16 (2022-02-06).
 122
 123 - *Cabal-syntax* Future compat for liftA2 being exported from Prelude [#8823](https://github.com/haskell/cabal/pull/8823)
 124
 125   - liftA2 will be exported from Prelude in the future(see https://github.com/haskell/core-libraries-committee/issues/50).
 126       Cabal-syntax was future-proofed to have no warnings when that happens.
 127
 128 - *Cabal-syntax* cabal init -n: avoid extra blank lines [#8236](https://github.com/haskell/cabal/issues/8236) [#8292](https://github.com/haskell/cabal/pull/8292)
 129
 130 - Added fields :pkg-field:`extra-libraries-static` and
 131   :pkg-field:`extra-lib-dirs-static` to allow Haskell libraries to remember
 132   linker flags needed for fully static linking of system libraries into executables. [#7536](https://github.com/haskell/cabal/pull/7536)
 133
 134 - The existing field :pkg-field:`pkgconfig-depends` can used to append the relevant
 135   output of ``pkg-config --libs --static`` to these new fields automatically.
 136   When :pkg-field:`extra-libraries-static` is not given, it defaults to
 137   :pkg-field:`extra-libraries`. When :pkg-field:`extra-lib-dirs-static` is not
 138   given, it defaults to :pkg-field:`extra-lib-dirs`. [#7536](https://github.com/haskell/cabal/pull/7536)
 139
 140 - Remove the GHC version upper bound when deciding whether to filter GHC arguments
 141
 142   - Previously, for unknown new versions of GHC, it was not filtering GHC arguments at all, while now it filters them in the same way as for the last known GHC version. This seems a better default and it's one less place to update at release time. Perhaps erroring out or emitting a warning would be safer, but we already emit a general warning elsewhere.