From 3ee558ed001bbab4380adbc69643e02a477f68b1 Mon Sep 17 00:00:00 2001 From: Artem Pelenitsyn Date: Mon, 9 Sep 2024 23:34:29 -0400 Subject: [PATCH] Add changelogs for 3.14 Forward port of #10336, #10338, and #10358 --- Cabal-syntax/ChangeLog.md | 2 +- Cabal/ChangeLog.md | 3 + cabal-install-solver/ChangeLog.md | 2 +- cabal-install/changelog | 3 + changelog.d/configure-messages | 13 -- changelog.d/issue-10046 | 4 - changelog.d/issue-10051 | 4 - changelog.d/issue-10166 | 20 --- changelog.d/issue-4816 | 23 ---- changelog.d/issue-4816-2 | 26 ---- changelog.d/issue-8817 | 17 --- changelog.d/issue-9702 | 39 ------ changelog.d/pr-10089 | 12 -- changelog.d/pr-10103 | 14 -- changelog.d/pr-10115 | 10 -- changelog.d/pr-10122 | 10 -- changelog.d/pr-10128 | 12 -- changelog.d/pr-10217 | 10 -- changelog.d/pr-10240 | 13 -- changelog.d/pr-10245 | 8 -- changelog.d/pr-10261 | 12 -- changelog.d/pr-8717 | 25 ---- changelog.d/pr-9177 | 31 ----- changelog.d/pr-9551 | 19 --- changelog.d/pr-9740 | 9 -- changelog.d/pr-9821 | 21 --- changelog.d/pr-9969 | 18 --- release-notes/Cabal-3.14.0.0.md | 163 ++++++++++++++++++++++++ release-notes/cabal-install-3.14.0.0.md | 141 ++++++++++++++++++++ 29 files changed, 312 insertions(+), 372 deletions(-) delete mode 100644 changelog.d/configure-messages delete mode 100644 changelog.d/issue-10046 delete mode 100644 changelog.d/issue-10051 delete mode 100644 changelog.d/issue-10166 delete mode 100644 changelog.d/issue-4816 delete mode 100644 changelog.d/issue-4816-2 delete mode 100644 changelog.d/issue-8817 delete mode 100644 changelog.d/issue-9702 delete mode 100644 changelog.d/pr-10089 delete mode 100644 changelog.d/pr-10103 delete mode 100644 changelog.d/pr-10115 delete mode 100644 changelog.d/pr-10122 delete mode 100644 changelog.d/pr-10128 delete mode 100644 changelog.d/pr-10217 delete mode 100644 changelog.d/pr-10240 delete mode 100644 changelog.d/pr-10245 delete mode 100644 changelog.d/pr-10261 delete mode 100644 changelog.d/pr-8717 delete mode 100644 changelog.d/pr-9177 delete mode 100644 changelog.d/pr-9551 delete mode 100644 changelog.d/pr-9740 delete mode 100644 changelog.d/pr-9821 delete mode 100644 changelog.d/pr-9969 create mode 100644 release-notes/Cabal-3.14.0.0.md create mode 100644 release-notes/cabal-install-3.14.0.0.md diff --git a/Cabal-syntax/ChangeLog.md b/Cabal-syntax/ChangeLog.md index 73c417220df..cbba98a3cc4 100644 --- a/Cabal-syntax/ChangeLog.md +++ b/Cabal-syntax/ChangeLog.md @@ -1 +1 @@ -Please see https://github.com/haskell/cabal/blob/master/release-notes/Cabal-3.12.1.0.md +Please see https://github.com/haskell/cabal/blob/master/release-notes/Cabal-3.14.0.0.md diff --git a/Cabal/ChangeLog.md b/Cabal/ChangeLog.md index 681bbc5a84a..ea3b88e1082 100644 --- a/Cabal/ChangeLog.md +++ b/Cabal/ChangeLog.md @@ -1,3 +1,6 @@ +# 3.14.0.0 [Hécate](mailto:hecate+github@glitchbra.in) September 2024 +* See https://github.com/haskell/cabal/blob/master/release-notes/Cabal-3.14.0.0.md + # 3.12.1.0 [Artem Pelenitsyn](mailto:a.pelenitsyn@gmail.com) June 2024 * See https://github.com/haskell/cabal/blob/master/release-notes/Cabal-3.12.1.0.md diff --git a/cabal-install-solver/ChangeLog.md b/cabal-install-solver/ChangeLog.md index 3cd7794fe29..978ac0f1b07 100644 --- a/cabal-install-solver/ChangeLog.md +++ b/cabal-install-solver/ChangeLog.md @@ -1 +1 @@ -Please see https://github.com/haskell/cabal/blob/master/release-notes/cabal-install-3.12.1.0.md +Please see https://github.com/haskell/cabal/blob/master/release-notes/cabal-install-3.14.0.0.md diff --git a/cabal-install/changelog b/cabal-install/changelog index 281329c7fe7..67711276c8f 100644 --- a/cabal-install/changelog +++ b/cabal-install/changelog @@ -1,5 +1,8 @@ -*-change-log-*- +3.14.0.0 Hécate September 2024 + * See https://github.com/haskell/cabal/blob/master/release-notes/cabal-install-3.14.0.0.md + 3.12.1.0 Artem Pelenitsyn June 2024 * See https://github.com/haskell/cabal/blob/master/release-notes/cabal-install-3.12.1.0.md diff --git a/changelog.d/configure-messages b/changelog.d/configure-messages deleted file mode 100644 index f0fab79e734..00000000000 --- a/changelog.d/configure-messages +++ /dev/null @@ -1,13 +0,0 @@ -synopsis: clarify Cabal "configure" messages -packages: Cabal -prs: #9476 - -synopsis: { - - Cabal can issue a number of error messages referencing "Setup configure", - but it simply references "configure" which could mean any of three - things (Setup configure, the package's "configure" script, or "cabal - configure"). This has recently caught out even Cabal devs. Clarify these - messages. - -} diff --git a/changelog.d/issue-10046 b/changelog.d/issue-10046 deleted file mode 100644 index 668d077271e..00000000000 --- a/changelog.d/issue-10046 +++ /dev/null @@ -1,4 +0,0 @@ -synopsis: Bug fix - Don't pass --coverage-for for non-dependency libs of testsuite -packages: cabal-install -issues: #10046 -prs: #10250 diff --git a/changelog.d/issue-10051 b/changelog.d/issue-10051 deleted file mode 100644 index b582fc2b619..00000000000 --- a/changelog.d/issue-10051 +++ /dev/null @@ -1,4 +0,0 @@ -synopsis: Added `--all` and `--haddock-all` switches to `haddock-project` subcommand -packages: cabal-install -issues: #10051 -prs: #2272 diff --git a/changelog.d/issue-10166 b/changelog.d/issue-10166 deleted file mode 100644 index 02d313adca9..00000000000 --- a/changelog.d/issue-10166 +++ /dev/null @@ -1,20 +0,0 @@ -synopsis: Include package version when passing `--promised-dependency` flag -packages: Cabal Cabal-syntax -prs: #10248 -issues: #10166 - -description: { - -The --promised dependency flag now expects an argument in format - -``` -NAME-VER[:COMPONENT_NAME]=CID` -``` - -rather than - -``` -NAME[:COMPONENT_NAME]=CID -``` - -} diff --git a/changelog.d/issue-4816 b/changelog.d/issue-4816 deleted file mode 100644 index e0ac7700b7e..00000000000 --- a/changelog.d/issue-4816 +++ /dev/null @@ -1,23 +0,0 @@ -synopsis: Add support for building profiled dynamic way -packages: Cabal Cabal-syntax cabal-install -prs: #9900 -issues: #4816 - -description: { -Add support for profiled dynamic way - -New options for cabal.project and ./Setup interface: - -* `profiling-shared`: Enable building profiling dynamic way -* Passing `--enable-profiling` and `--enable-executable-dynamic` builds - profiled dynamic executables. - -Support for using `profiling-shared` is guarded behind a constraint -which ensures you are using `Cabal >= 3.13`. - -In the cabal file: - -* `ghc-prof-shared-options`, for passing options when building in - profiling dynamic way - -} diff --git a/changelog.d/issue-4816-2 b/changelog.d/issue-4816-2 deleted file mode 100644 index 96307c3f83e..00000000000 --- a/changelog.d/issue-4816-2 +++ /dev/null @@ -1,26 +0,0 @@ -synopsis: Fix interaction of `--*-shared` and `--*-executable-dynamic` options. -packages: cabal-install -prs: #9900 -issues: #10050 - -description: { - -If you explicitly request `--disable-shared` it should disable the building of -a shared library and override any automatic ways this option is turned on. - -Passing `--enable-executable-dynamic` turns on `--enable-shared` if the option is -not specified explicitly. - -Before this patch, writing `--disable-shared` on its own would not disable the building of shared libraries. Writing `--disable-shared` and `--disable-executable-dynamic` would disable shared library -creation (despite `--disable-executable-dynamic` being the default). - -Now: - -* If you specify `--enable-shared` then shared objects are built. -* If you specify `--disabled-shared` then shared objects are not built. -* If you don't explicitly specify whether you want to build shared libraries then - * `--enable-executable-dynamic` will automatically turn on building shared libraries - * `--enable-executable-dynamic --enable-profiling` will automatically turn on building - shared profiling libraries (if supported by your compiler). - -} diff --git a/changelog.d/issue-8817 b/changelog.d/issue-8817 deleted file mode 100644 index 0743671fa0d..00000000000 --- a/changelog.d/issue-8817 +++ /dev/null @@ -1,17 +0,0 @@ -synopsis: Neutral field to add files to sdist -packages: Cabal Cabal-syntax -prs: #10107 -issues: #8817 -significance: significant - -description: { - -Adds the `extra-files` field to the cabal file specification. This is like -the other `extra-*` fields in that it is copied with the `sdist` command, -except there are no other semantics. Compare to: - -* `extra-source-files`: Tracked by `cabal build`. - -* `extra-doc-files`: Copied by Haddock to the html directory. - -} diff --git a/changelog.d/issue-9702 b/changelog.d/issue-9702 deleted file mode 100644 index 7df998b8d8d..00000000000 --- a/changelog.d/issue-9702 +++ /dev/null @@ -1,39 +0,0 @@ -synopsis: Working directory support for Cabal -packages: Cabal-syntax Cabal cabal-install -prs: #9718 -issues: #9702 - -description: { - -The Cabal library is now able to handle a passed-in working directory, instead -of always relying on the current working directory of the parent process. - -In order to achieve this, the `SymbolicPath` abstraction was fleshed out, and -all fields of `PackageDescription` that, if relative, should be interpreted -with respect to e.g. the package root, use `SymbolicPath` instead of `FilePath`. - -This means that many library functions in `Cabal` take an extra argument of type -`Maybe (SymbolicPath CWD (Dir "Package))`, which is an optional (relative or -absolute) path to the package root (if relative, relative to the current working -directory). In addition, many functions that used to manipulate `FilePath`s now -manipulate `SymbolicPath`s, require explicit conversion using e.g. `getSymbolicPath`. - -To illustrate with file searching, the `Cabal` library defines: - -```haskell -findFileCwd - :: forall dir1 dir2 file - . Verbosity - -> Maybe (SymbolicPath CWD (Dir dir1)) - -- ^ working directory - -> [SymbolicPath dir1 (Dir dir2)] - -- ^ search directories - -> RelativePath dir2 File - -- ^ filename - -> IO (SymbolicPath dir1 File) -``` - -See Note [Symbolic paths] in `Distribution.Utils.Path` for further information -on the design of this API. -} - diff --git a/changelog.d/pr-10089 b/changelog.d/pr-10089 deleted file mode 100644 index ed322194e21..00000000000 --- a/changelog.d/pr-10089 +++ /dev/null @@ -1,12 +0,0 @@ -synopsis: `curl` transport now supports Basic authentication -packages: cabal-install -prs: #10089 - -description: { - -- The `curl` HTTP transport previously only supported the HTTP Digest - authentication scheme. Basic authentication is now supported - when using HTTPS; Curl will use the scheme offered by the server. - The `wget` transport already supports HTTPS. - -} diff --git a/changelog.d/pr-10103 b/changelog.d/pr-10103 deleted file mode 100644 index 3e68cf38d3c..00000000000 --- a/changelog.d/pr-10103 +++ /dev/null @@ -1,14 +0,0 @@ -synopsis: Enhance error detection for cabal root project files, including broken symlinks - -packages: cabal-install - -prs: #10103 - -issues: #9937 - -description: { - -- Added proper detection and reporting for issues with cabal root project files. Previously, these files were silently ignored if they were broken symlinks. Now, `cabal` will exit -with an error in such case. - -} diff --git a/changelog.d/pr-10115 b/changelog.d/pr-10115 deleted file mode 100644 index ce288c105c1..00000000000 --- a/changelog.d/pr-10115 +++ /dev/null @@ -1,10 +0,0 @@ -synopsis: Let cabal init remember chosen language within current session -packages: cabal-install -prs: #10115 -issues: #10096 - -description: { - -When cabal init asks for a language, the last choice will be used as the new default for the current session. - -} \ No newline at end of file diff --git a/changelog.d/pr-10122 b/changelog.d/pr-10122 deleted file mode 100644 index 7e9fbe10d47..00000000000 --- a/changelog.d/pr-10122 +++ /dev/null @@ -1,10 +0,0 @@ -synopsis: Clarify error message when pkg-config is not found -packages: cabal-install-solver -prs: #10122 - -description: { - -- The error message when pkg-config is not found or querying it fails will no -longer incorrectly claim that the package is missing in the database. - -} diff --git a/changelog.d/pr-10128 b/changelog.d/pr-10128 deleted file mode 100644 index 8c7cc45d204..00000000000 --- a/changelog.d/pr-10128 +++ /dev/null @@ -1,12 +0,0 @@ -synopsis: Add flag ignore-build-tools -packages: Cabal -prs: #10128 - -description: { - -- Adds flag --ignore-build-tools which allows a user to ignore the tool - dependencies declared in build-tool-depends. For general use, this flag - should never be needed, but it may be useful for packagers. - -} - diff --git a/changelog.d/pr-10217 b/changelog.d/pr-10217 deleted file mode 100644 index 8e520bab27e..00000000000 --- a/changelog.d/pr-10217 +++ /dev/null @@ -1,10 +0,0 @@ -synopsis: Do not try to build dynamic executables on Windows -packages: Cabal -prs: #10217 - -description: { - -- Cabal will now exit with a descriptive error message instead of attempting to - build a dynamic executable on Windows. - -} diff --git a/changelog.d/pr-10240 b/changelog.d/pr-10240 deleted file mode 100644 index 9bd05100ab7..00000000000 --- a/changelog.d/pr-10240 +++ /dev/null @@ -1,13 +0,0 @@ -synopsis: Filter out dinitial-unique and dunique-increment from package hash -packages: cabal-install -prs: #10122 - -description: { - -`-dinitial-unique` and `-dunique-increment` are now filtered out when computing the -store hash of a package. - -These options shouldn't affect the output of the package and hence -shouldn't affect the store hash of a package. - -} diff --git a/changelog.d/pr-10245 b/changelog.d/pr-10245 deleted file mode 100644 index 2ed3690720a..00000000000 --- a/changelog.d/pr-10245 +++ /dev/null @@ -1,8 +0,0 @@ -synopsis: Add MultilineStrings extension -packages: Cabal-syntax -prs: #10245 -description: { - -- adds support for the `MultilineStrings` language extension (GHC proposal #637) - -} diff --git a/changelog.d/pr-10261 b/changelog.d/pr-10261 deleted file mode 100644 index adcae60fd88..00000000000 --- a/changelog.d/pr-10261 +++ /dev/null @@ -1,12 +0,0 @@ -synopsis: Warn about git:// protocol -packages: cabal-install -prs: #10261 - -description: { - -`cabal check` will warn about insecure git:// protocol in `source-repository`. - -See [Git Book](https://git-scm.com/book/en/v2/Git-on-the-Server-The-Protocols#_the_cons_4) -for an explanation. - -} diff --git a/changelog.d/pr-8717 b/changelog.d/pr-8717 deleted file mode 100644 index b0ac7e09388..00000000000 --- a/changelog.d/pr-8717 +++ /dev/null @@ -1,25 +0,0 @@ -synopsis: Always pass `ghc-options` to GHC -packages: Cabal -prs: #8717 -issues: - -description: { - -Previously, options set in the package field `ghc-options` would not be passed -to GHC during the link phase for shared objects (where multiple `.o` or -`.dyn_o` files are merged into a single object file). This made it impossible -to use `ghc-options` to use a different linker by setting (for example) -`ghc-options: -optl-fuse-ld=mold -optlm-fuse-ld=mold`; the options would be -dropped in the link phase, falling back to the default linker. - -It was possible to work around this by duplicating the `ghc-options` to -`ghc-shared-options`, which _are_ passed in the shared link phase, but that had -the (undocumented and unfortunate) side-effect of disabling the GHC -`-dynamic-too` flag, effectively doubling compilation times when -`ghc-shared-options` are set. - -Now, `ghc-options` are combined with `ghc-shared-options` (to accurately -reflect the documentation on this feature) and the fact that -`ghc-shared-options` disables `-dynamic-too` is documented. - -} diff --git a/changelog.d/pr-9177 b/changelog.d/pr-9177 deleted file mode 100644 index 6b1eb227350..00000000000 --- a/changelog.d/pr-9177 +++ /dev/null @@ -1,31 +0,0 @@ -synopsis: Enable recompilation avoidance during Haddock generation -packages: cabal-install -prs: #9177 -issues: #9175 - -description: { - -* Haddock no longer writes compilation files by default, so we do not need to - pass tmp dirs for `-hidir`, `-stubdir`, and `-odir` via `--optghc`. Indeed, we - do not *want* to do so, since it results in recompilation for every invocation - of Haddock via Cabal. We now stop this from happening for Haddock versions - 2.28 and greater, since that is when Hi Haddock was introduced. - -* We no longer define the `__HADDOCK_VERSION__` macro when invoking GHC through - Haddock, since doing so essentially guarantees recompilation during - documentation generation. We audited all uses of `__HADDOCK_VERSION__` in - hackage, ensuring there was a reasonable path forward to migrate away from - using `__HADDOCK_VERSION__` for each, while generating the same documentation - as it did before. - If you are a user of `__HADDOCK_VERSION__`, please take a look at the - discussion in https://github.com/haskell/cabal/pull/9177 and reach out to us - if your use case is not covered. - -* Rename the `--haddock-lib` flag to `--haddock-resources-dir` (and - `haddock-lib:` cabal.project field to `haddock-resources-dir:`), and add this - flag to the users guide since it was missing an entry. - -* `documentation: true` or `--enable-documentation` now implies `-haddock` for - GHC. - -} diff --git a/changelog.d/pr-9551 b/changelog.d/pr-9551 deleted file mode 100644 index 5116234a653..00000000000 --- a/changelog.d/pr-9551 +++ /dev/null @@ -1,19 +0,0 @@ -synopsis: Introduce SetupHooks -packages: Cabal -prs: #9551 -description: { - Introduction of a new build type: Hooks. - This build type, intended as replacement to the Custom build type, integrates - better with the rest of the ecosystem (`cabal-install`, Haskell Language Server). - - The motivation and full design of this new build-type are specified in the - Haskell Foundation Tech Proposal - [Replacing the Cabal Custom build-type](https://github.com/haskellfoundation/tech-proposals/pull/60). - - Package authors willing to use this feature should declare `build-type: Hooks` - in their `.cabal` file, declare a custom-setup stanza with a dependency on the - `Cabal-hooks` package, and define a module `SetupHooks` that exports a value - `setupHooks :: SetupHooks`, using the API exported by `Distribution.Simple.SetupHooks` - from the `Cabal-hooks` package. Refer to the Haddock documentation of - `Distribution.Simple.SetupHooks` for example usage. -} diff --git a/changelog.d/pr-9740 b/changelog.d/pr-9740 deleted file mode 100644 index c5a3b9a173e..00000000000 --- a/changelog.d/pr-9740 +++ /dev/null @@ -1,9 +0,0 @@ -synopsis: Add language extension NamedDefaults -packages: Cabal-syntax -prs: #9740 - -description: { - -- adds support for the `NamedDefaults` language extension (GHC proposal #409) - -} diff --git a/changelog.d/pr-9821 b/changelog.d/pr-9821 deleted file mode 100644 index bc3e9dcae50..00000000000 --- a/changelog.d/pr-9821 +++ /dev/null @@ -1,21 +0,0 @@ -synopsis: `haddock-project` support for subcomponents -packages: cabal-install -prs: #9821 -issues: -significance: significant - -description: { - -- `haddock-project` handles sublibraries, test suites and benchmarks. -- `haddock` receives `--package-name` flag whcih allows to set names of - components which are included in the main `index.html` file. -- added `--use-unicode` flag to `haddock` and `haddock-project` commands. -- The directory structure of `./dist-newstyle` has changed. `haddock` - subcommand will install `package:sublib` component in a directory - `package/sublib` under `l/sublib/doc/html/`. This is important for - `haddock-project` command and in the future might will be useful for hackage - support of sublibraries. See - https://github.com/haskell/cabal/pull/9821#discussion_r1548557115. - -} - diff --git a/changelog.d/pr-9969 b/changelog.d/pr-9969 deleted file mode 100644 index 17a60b88e99..00000000000 --- a/changelog.d/pr-9969 +++ /dev/null @@ -1,18 +0,0 @@ -synopsis: Configure build-type in terms of Hooks -packages: Cabal cabal-install -prs: #9969 - -description: { - -The `build-type: Configure` is now implemented in terms of `build-type: Hooks` -rather than in terms of `build-type: Custom`. This moves the `Configure` -build-type away from the `Custom` issues. Eventually, `build-type: Hooks` will -no longer imply packages are built in legacy-fallback mode. Now, when that -happens, `Configure` will also stop implying `legacy-fallback`. - -The observable aspect of this change is `runConfigureScript` now having a -different type, and `autoconfSetupHooks` being exposed `Distribution.Simple`. -The former is motivated by internal implementation details, while the latter -provides the `SetupHooks` value for the `Configure` build type, which can be -consumed by other `Hooks` clients (e.g. eventually HLS). -} diff --git a/release-notes/Cabal-3.14.0.0.md b/release-notes/Cabal-3.14.0.0.md new file mode 100644 index 00000000000..004a462db8f --- /dev/null +++ b/release-notes/Cabal-3.14.0.0.md @@ -0,0 +1,163 @@ +Cabal and Cabal-syntax 3.14.0.0 changelog and release notes +--- + + +### Significant changes + +- Neutral field to add files to sdist [#8817](https://github.com/haskell/cabal/issues/8817) [#10107](https://github.com/haskell/cabal/pull/10107) + + Adds the `extra-files` field to the cabal file specification. This is like + the other `extra-*` fields in that it is copied with the `sdist` command, + except there are no other semantics. Compare to: + + * `extra-source-files`: Tracked by `cabal build`. + + * `extra-doc-files`: Copied by Haddock to the html directory. + +### Other changes + +- Include package version when passing `--promised-dependency` flag [#10166](https://github.com/haskell/cabal/issues/10166) [#10248](https://github.com/haskell/cabal/pull/10248) + + The `--promised-dependency` flag now expects an argument in the format + + ``` + NAME-VER[:COMPONENT_NAME]=CID + ``` + + rather than + + ``` + NAME[:COMPONENT_NAME]=CID + ``` + +- Add support for building profiled dynamic way [#4816](https://github.com/haskell/cabal/issues/4816) [#9900](https://github.com/haskell/cabal/pull/9900) + + Add support for profiled dynamic way + + New options for `cabal.project` and `./Setup` interface: + + * `profiling-shared`: Enable building profiling dynamic way + * Passing `--enable-profiling` and `--enable-executable-dynamic` builds + profiled dynamic executables. + + Support for using `profiling-shared` is guarded behind a constraint + which ensures you are using `Cabal >= 3.13`. + + In the cabal file: + + * `ghc-prof-shared-options`, for passing options when building in + profiling dynamic way + +- Working directory support for `Cabal` [#9702](https://github.com/haskell/cabal/issues/9702) [#9718](https://github.com/haskell/cabal/pull/9718) + + The `Cabal` library is now able to handle a passed-in working directory, instead + of always relying on the current working directory of the parent process. + + In order to achieve this, the `SymbolicPath` abstraction was fleshed out, and + all fields of `PackageDescription` that, if relative, should be interpreted + with respect to e.g. the package root, use `SymbolicPath` instead of `FilePath`. + + This means that many library functions in `Cabal` take an extra argument of type + `Maybe (SymbolicPath CWD (Dir "Package"))`, which is an optional (relative or + absolute) path to the package root (if relative, relative to the current working + directory). In addition, many functions that used to manipulate `FilePath`s now + manipulate `SymbolicPath`s, require explicit conversion using e.g. `getSymbolicPath`. + + To illustrate with file searching, the `Cabal` library defines: + + ```haskell + findFileCwd + :: forall dir1 dir2 file + . Verbosity + -> Maybe (SymbolicPath CWD (Dir dir1)) + + -> [SymbolicPath dir1 (Dir dir2)] + + -> RelativePath dir2 File + + -> IO (SymbolicPath dir1 File) + ``` + + See Note [Symbolic paths] in `Distribution.Utils.Path` for further information + on the design of this API. + +- Add `MultilineStrings` extension (GHC proposal #637) [#10245](https://github.com/haskell/cabal/pull/10245) + +- Add `NamedDefaults` extension (GHC proposal #409) [#9740](https://github.com/haskell/cabal/pull/9740) + +- Add `OrPatterns` extension (GHC proposal #958) [#10339](https://github.com/haskell/cabal/pull/10339) + + +### Other changes + +- Add flag `--ignore-build-tools` [#10128](https://github.com/haskell/cabal/pull/10128) + + - Adds flag `--ignore-build-tools` which allows a user to ignore the tool + dependencies declared in `build-tool-depends`. For general use, this flag + should never be needed, but it may be useful for packagers. + +- Do not try to build dynamic executables on Windows [#10217](https://github.com/haskell/cabal/pull/10217) + + - Cabal will now exit with a descriptive error message instead of attempting to + build a dynamic executable on Windows. + +- Always pass `ghc-options` to GHC [#8717](https://github.com/haskell/cabal/pull/8717) + + Previously, options set in the package field `ghc-options` would not be passed + to GHC during the link phase for shared objects (where multiple `.o` or + `.dyn_o` files are merged into a single object file). This made it impossible + to use `ghc-options` to use a different linker by setting (for example) + `ghc-options: -optl-fuse-ld=mold -optlm-fuse-ld=mold`; the options would be + dropped in the link phase, falling back to the default linker. + + It was possible to work around this by duplicating the `ghc-options` to + `ghc-shared-options`, which _are_ passed in the shared link phase, but that had + the undocumented and unfortunate side-effect of disabling the GHC + `-dynamic-too` flag, effectively doubling compilation times when + `ghc-shared-options` are set. + + Now, `ghc-options` are combined with `ghc-shared-options` (to accurately + reflect the documentation on this feature) and the fact that + `ghc-shared-options` disables `-dynamic-too` is documented. + +- Introduce `SetupHooks` [#9551](https://github.com/haskell/cabal/pull/9551) + + Introduction of a new build type: `Hooks`. + This build type, intended to eventually replace the `Custom` build type, integrates + better with the rest of the ecosystem (`cabal-install`, Haskell Language Server). + + The motivation and full design of this new build-type are specified in the + Haskell Foundation Tech Proposal + [Replacing the Cabal Custom build-type](https://github.com/haskellfoundation/tech-proposals/pull/60). + + Package authors willing to use this feature should declare `cabal-version: 3.14` and `build-type: Hooks` + in their `.cabal` file, declare a `custom-setup` stanza with a dependency on the + `Cabal-hooks` package, and define a module `SetupHooks` that exports a value + `setupHooks :: SetupHooks`, using the API exported by `Distribution.Simple.SetupHooks` + from the `Cabal-hooks` package. Refer to the Haddock documentation of + `Distribution.Simple.SetupHooks` for example usage. + +- Redefine `build-type: Configure` in terms of `Hooks` [#9969](https://github.com/haskell/cabal/pull/9969) + + The `build-type: Configure` is now implemented in terms of `build-type: Hooks` + rather than in terms of `build-type: Custom`. This moves the `Configure` + build-type away from the `Custom` issues. Eventually, `build-type: Hooks` will + no longer imply packages are built in legacy-fallback mode. When that + happens, `Configure` will also stop implying `legacy-fallback`. + + The observable aspect of this change is `runConfigureScript` now having a + different type, and `autoconfSetupHooks` being exposed by `Distribution.Simple`. + The former is motivated by internal implementation details, while the latter + provides the `SetupHooks` value for the `Configure` build type, which can be + consumed by other `Hooks` clients (e.g. eventually HLS). + +- Cabal can issue a number of error messages referencing "Setup configure", + but it simply references "configure" which could mean any of three + things (Setup configure, the package's "configure" script, or "cabal + configure"). This has recently caught out even Cabal devs. Clarify these + messages. [#9476](https://github.com/haskell/cabal/pull/9476) + +- Update the SPDX License List to version 3.25 + + The LicenseId and LicenseExceptionId types are updated to reflect the SPDX + License List version 3.25 (2024-08-19). diff --git a/release-notes/cabal-install-3.14.0.0.md b/release-notes/cabal-install-3.14.0.0.md new file mode 100644 index 00000000000..3a890db9acc --- /dev/null +++ b/release-notes/cabal-install-3.14.0.0.md @@ -0,0 +1,141 @@ +cabal-install 3.14.0.0 changelog and release notes. +--- + + +### Significant changes + +- `haddock-project` support for subcomponents [#9821](https://github.com/haskell/cabal/pull/9821) + + - `haddock-project` handles sublibraries, test suites and benchmarks. + - `haddock` receives `--package-name` flag which allows to set names of + components which are included in the main `index.html` file. + - added `--use-unicode` flag to `haddock` and `haddock-project` commands. + - The directory structure of `./dist-newstyle` has changed. `haddock` + subcommand will install `package:sublib` component in a directory + `package/sublib` under `l/sublib/doc/html/`. This is important for + `haddock-project` command and in the future might will be useful for hackage + support of sublibraries. See + https://github.com/haskell/cabal/pull/9821#discussion_r1548557115. + +- Redefine `build-type: Configure` in terms of `Hooks` [#9969](https://github.com/haskell/cabal/pull/9969) + + The `build-type: Configure` is now implemented in terms of `build-type: Hooks` + rather than in terms of `build-type: Custom`. This moves the `Configure` + build-type away from the `Custom` issues. Eventually, `build-type: Hooks` will + no longer imply packages are built in legacy-fallback mode. When that + happens, `Configure` will also stop implying `legacy-fallback`. + + The observable aspect of this change is `runConfigureScript` now having a + different type, and `autoconfSetupHooks` being exposed from `Distribution.Simple`. + The former is motivated by internal implementation details, while the latter + provides the `SetupHooks` value for the `Configure` build type, which can be + consumed by other `Hooks` clients (e.g. eventually HLS). + +### Other changes + +- Add support for building profiled dynamic way [#4816](https://github.com/haskell/cabal/issues/4816) [#9900](https://github.com/haskell/cabal/pull/9900) + + + New options for `cabal.project` and `./Setup` interface: + + * `profiling-shared`: Enable building profiling dynamic way + * Passing `--enable-profiling` and `--enable-executable-dynamic` builds + profiled dynamic executables. + + Support for using `profiling-shared` is guarded behind a constraint + which ensures you are using `Cabal >= 3.13`. + + In the `.cabal` file: + + * `ghc-prof-shared-options`, for passing options when building in + profiling dynamic way + +- Fix interaction of `--*-shared` and `--*-executable-dynamic` options. [#10050](https://github.com/haskell/cabal/issues/10050) [#9900](https://github.com/haskell/cabal/pull/9900) + + If you explicitly request `--disable-shared` it should disable the building of + a shared library and override any automatic ways this option is turned on. + + Passing `--enable-executable-dynamic` turns on `--enable-shared` if the option is + not specified explicitly. + + Before this patch, writing `--disable-shared` on its own would not disable the building of shared libraries. Writing `--disable-shared` and `--disable-executable-dynamic` would disable shared library + creation (despite `--disable-executable-dynamic` being the default). + + Now: + + * If you specify `--enable-shared` then shared objects are built. + * If you specify `--disabled-shared` then shared objects are not built. + * If you don't explicitly specify whether you want to build shared libraries then + * `--enable-executable-dynamic` will automatically turn on building shared libraries + * `--enable-executable-dynamic --enable-profiling` will automatically turn on building + shared profiling libraries (if supported by your compiler). + +- `curl` transport now supports Basic authentication [#10089](https://github.com/haskell/cabal/pull/10089) + + - The `curl` HTTP transport previously only supported the HTTP Digest + authentication scheme. Basic authentication is now supported + when using HTTPS; Curl will use the scheme offered by the server. + The `wget` transport already supports HTTPS. + +- Enhance error detection for cabal root project files, including broken symlinks [#9937](https://github.com/haskell/cabal/issues/9937) [#10103](https://github.com/haskell/cabal/pull/10103) + + - Added proper detection and reporting for issues with cabal root project files. Previously, these files were silently ignored if they were broken symlinks. Now, `cabal` will exit + with an error in such case. + +- Let cabal init remember chosen language within current session [#10096](https://github.com/haskell/cabal/issues/10096) [#10115](https://github.com/haskell/cabal/pull/10115) + + When `cabal init` asks for a language, the last choice made will be used as the new default for the current prompt. + +- Filter out `-dinitial-unique` and `-dunique-increment` from package hash [#10122](https://github.com/haskell/cabal/pull/10122) + + `-dinitial-unique` and `-dunique-increment` are now filtered out when computing the + store hash of a package. + + These options shouldn't affect the output of the package and hence + shouldn't affect the store hash of a package. + +- Warn about `git://` protocol [#10261](https://github.com/haskell/cabal/pull/10261) + + `cabal check` will warn about the insecure (and no longer supported by GitHub or Gitlab, among others) `git://` protocol in `source-repository`. + + See [Git Book](https://git-scm.com/book/en/v2/Git-on-the-Server-The-Protocols#_the_cons_4) + for an explanation. + +- Enable recompilation avoidance during Haddock generation [#9175](https://github.com/haskell/cabal/issues/9175) [#9177](https://github.com/haskell/cabal/pull/9177) + + * Haddock no longer writes compilation files by default, so we do not need to + pass tmp dirs for `-hidir`, `-stubdir`, and `-odir` via `--optghc`. Indeed, we + do not *want* to do so, since it results in recompilation for every invocation + of Haddock via Cabal. We now stop this from happening for Haddock versions + 2.28 and greater, since that is when Hi Haddock was introduced. + + * We no longer define the `__HADDOCK_VERSION__` macro when invoking GHC through + Haddock, since doing so essentially guarantees recompilation during + documentation generation. We audited all uses of `__HADDOCK_VERSION__` in + hackage, ensuring there was a reasonable path forward to migrate away from + using `__HADDOCK_VERSION__` for each, while generating the same documentation + as it did before. + If you are a user of `__HADDOCK_VERSION__`, please take a look at the + discussion in https://github.com/haskell/cabal/pull/9177 and reach out to us + if your use case is not covered. + + * Rename the `--haddock-lib` flag to `--haddock-resources-dir` (and + `haddock-lib:` cabal.project field to `haddock-resources-dir:`), and add this + flag to the users guide since it was missing an entry. + + * `documentation: true` or `--enable-documentation` now implies `-haddock` for + GHC. + +- Bug fix - Don't pass `--coverage-for` for non-dependency libs of testsuite [#10046](https://github.com/haskell/cabal/issues/10046) [#10250](https://github.com/haskell/cabal/pull/10250) + +- Added `--all` and `--haddock-all` switches to `haddock-project` subcommand [#10051](https://github.com/haskell/cabal/issues/10051) [#10163](https://github.com/haskell/cabal/pull/10163) + +- Clarify error message when `pkg-config` is not found [#10122](https://github.com/haskell/cabal/pull/10122) + + - The error message when `pkg-config` is not found or querying it fails will no + longer incorrectly claim that the package is missing in the database. + +- Update the SPDX License List to version 3.25 + + The LicenseId and LicenseExceptionId types are updated to reflect the SPDX + License List version 3.25 (2024-08-19).