Skip to content

Commit 271ae8f

Browse files
ffaf1geekosaur
authored andcommitted
3.12 changelog fixup (#9922)
* Incorporate Brandon’s suggestions See #9920. * Incorporate Artem’s suggestions See #9920. * Do not repeat yourself
1 parent cb8dcc4 commit 271ae8f

File tree

2 files changed

+54
-55
lines changed

2 files changed

+54
-55
lines changed

release-notes/Cabal-3.12.0.0.md

Lines changed: 21 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ Cabal and Cabal-syntax 3.12.0.0 changelog and release notes
3838
build the package. This allows us to configure all the packages we intend
3939
to load into the repl without building any dependenices which we will load
4040
in the same session, because the promise is satisifed due to loading the
41-
package and it's dependency into one multi-session which ensures the
41+
package and its dependency into one multi-session which ensures the
4242
dependency is built before it is needed.
4343

4444
A user of ./Setup configure specifies a promised dependency by using the
@@ -73,12 +73,6 @@ Cabal and Cabal-syntax 3.12.0.0 changelog and release notes
7373
This library was only used by internal tests, and now lives in the
7474
`Cabal-tests` library which is shared across test components.
7575
76-
- Distinguish `powerpc64le`, by adding `PPC64LE` constructor to type `Arch` [#9534](https://github.com/haskell/cabal/issues/9534) [#9535](https://github.com/haskell/cabal/pull/9535)
77-
78-
Adds constructor `PPC64LE` to type `Arch` to distinguish architecture
79-
powerpc64le from powerpc64. Existing constructor `PPC64` now exclusively
80-
represents powerpc64.
81-
8276
- PkgConfig individual calls [#9134](https://github.com/haskell/cabal/pull/9134)
8377
8478
`cabal` invokes `pkg-config` individually for each lib if querying for all
@@ -118,7 +112,7 @@ Cabal and Cabal-syntax 3.12.0.0 changelog and release notes
118112
the repl and instead instruct the command to write the necessary build
119113
flags to a directiory. The option is called `--repl-multi-file <DIR>`.
120114
121-
This is useful when starting multi-component sessions as we want to query
115+
This is useful when starting multi-component sessions, as we want to query
122116
Setup.hs for the arguments which are needed to build each component but
123117
not for ./Setup to start the repl itself.
124118
@@ -169,12 +163,19 @@ Cabal and Cabal-syntax 3.12.0.0 changelog and release notes
169163
to decide whether to allow or discard such inexact matches.
170164
171165
- Document `remote-repo-cache` as implemented. [#8737](https://github.com/haskell/cabal/issues/8737) [#8738](https://github.com/haskell/cabal/pull/8738)
166+
172167
- Deduplicate LD_LIBRARY_PATH when running tests [#8728](https://github.com/haskell/cabal/pull/8728)
173-
- Add support for the 64-bit RISC-V architecture [#9062](https://github.com/haskell/cabal/pull/9062)
174-
- Add support for 64-bit LoongArch architecture [#9215](https://github.com/haskell/cabal/pull/9215)
168+
169+
- Add support for a number of architectures:
170+
171+
- RISC-V [#9062](https://github.com/haskell/cabal/pull/9062)
172+
- 64-bit LoongArch [#9215](https://github.com/haskell/cabal/pull/9215)
173+
- 64-bit SPARC as a separate architecture [#9445](https://github.com/haskell/cabal/pull/9445)
174+
175175
- Don't report `index.html` file as created, if not created by Haddock [#5120](https://github.com/haskell/cabal/issues/5120) [#9332](https://github.com/haskell/cabal/pull/9332)
176+
176177
- Enable using $ORIGIN in RPATH on GNU/Hurd [#9441](https://github.com/haskell/cabal/pull/9441)
177-
- Add support for 64-bit SPARC as a separate architecture [#9445](https://github.com/haskell/cabal/pull/9445)
178+
178179
179180
- Make check comply with Hackage requirements [#8897](https://github.com/haskell/cabal/pull/8897)
180181
@@ -185,9 +186,9 @@ Cabal and Cabal-syntax 3.12.0.0 changelog and release notes
185186
third-party tools to know if a specific error will preclude a package
186187
from being uploaded to Hacakge.
187188
188-
- Add language extension ExtendedLiterals [#8992](https://github.com/haskell/cabal/pull/8992)
189+
- Add language extension `ExtendedLiterals` [#8992](https://github.com/haskell/cabal/pull/8992)
189190
190-
Adds support for the ExtendedLiterals language extension (GHC proposal #451)
191+
Adds support for the `ExtendedLiterals` language extension (GHC proposal #451)
191192
192193
- Warn about inconsistent indentation [#8975](https://github.com/haskell/cabal/pull/8975)
193194
@@ -212,19 +213,19 @@ Cabal and Cabal-syntax 3.12.0.0 changelog and release notes
212213
Such insonsistency seems to be always a mistake, and it's easy to fix once
213214
a machine points it out.
214215
215-
- Add LexBraces lexer warning [#8577](https://github.com/haskell/cabal/issues/8577)
216+
- Add `LexBraces` lexer warning [#8577](https://github.com/haskell/cabal/issues/8577)
216217
217-
LexBraces warning is issued when brace delimiting syntax is used. This
218+
`LexBraces` warning is issued when brace delimiting syntax is used. This
218219
way, using `readFields'`, a low-lever consumer may decide whether braces
219220
were used.
220221
221-
(Looking for a brace character in the input is imprecise, as braces can
222-
occur inside field content).
222+
Looking for a brace character in the input is imprecise, as braces can
223+
occur inside field content.
223224
224225
This warning is not propagated to parser warnings, so e.g.
225-
readGenericPackageDescription doesn't warn about it. This is because all
226+
`readGenericPackageDescription` doesn't warn about it. This is because all
226227
parser warnings prevent uploads to Hackage, and using braces (or not) is
227-
opinionated choice.
228+
a matter of opinion.
228229
229230
- Distinguish `powerpc64le`, by adding `PPC64LE` constructor to type `Arch` [#9534](https://github.com/haskell/cabal/issues/9534) [#9535](https://github.com/haskell/cabal/pull/9535)
230231
@@ -236,7 +237,7 @@ Cabal and Cabal-syntax 3.12.0.0 changelog and release notes
236237
237238
`cabal` invokes `pkg-config` individually for each lib if querying for all doesn't return the expected result
238239
239-
- Add language extension ListTuplePuns [#8854](https://github.com/haskell/cabal/pull/8854)
240+
- Add language extension `ListTuplePuns` [#8854](https://github.com/haskell/cabal/pull/8854)
240241
241242
Adds support for the `ListTuplePuns` language extension (GHC proposal #475)
242243
@@ -248,10 +249,6 @@ Cabal and Cabal-syntax 3.12.0.0 changelog and release notes
248249
249250
- Add language extension `TypeAbstractions` [#9496](https://github.com/haskell/cabal/issues/9496) [#9502](https://github.com/haskell/cabal/pull/9502)
250251
251-
- Add support for the 64-bit RISC-V architecture [#9062](https://github.com/haskell/cabal/pull/9062)
252-
- Add support for 64-bit LoongArch architecture [#9215](https://github.com/haskell/cabal/pull/9215)
253-
- Add support for 64-bit SPARC as a separate architecture [#9445](https://github.com/haskell/cabal/pull/9445)
254-
255252
- Update SPDX License List to version `3.23 2024-02-08` [#9818](https://github.com/haskell/cabal/pull/9818)
256253
257254
- LicenseId and LicenseExceptionId now conform to SPDX License List

release-notes/WIP-cabal-install-3.12.x.0.md

Lines changed: 33 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,10 @@
33
cabal-install and cabal-install-solver 3.12.1.0 changelog and release notes
44
---
55

6-
- Add --project-dir flag [#7695](https://github.com/haskell/cabal/issues/7695) [#7940](https://github.com/haskell/cabal/issues/7940) [#8454](https://github.com/haskell/cabal/pull/8454)
6+
- Add `--project-dir` flag [#7695](https://github.com/haskell/cabal/issues/7695) [#7940](https://github.com/haskell/cabal/issues/7940) [#8454](https://github.com/haskell/cabal/pull/8454)
77

8-
- Added --project-dir flag for specifying the project's root directory
9-
- Deprecated using --project-file with an absolute filepath without also using --project-dir
8+
- Added `--project-dir` flag for specifying the project's root directory
9+
- Deprecated using `--project-file` with an absolute filepath without also using `--project-dir`.
1010

1111
- Remove useles "Log" log level [#9151](https://github.com/haskell/cabal/issues/9151) [#9346](https://github.com/haskell/cabal/pull/9346)
1212

@@ -32,7 +32,7 @@ cabal-install and cabal-install-solver 3.12.1.0 changelog and release notes
3232
a flag which specifies which libraries should be included in the coverage
3333
report for some testsuite.
3434

35-
- Redesign 'cabal path' command to account for projects [#9673](https://github.com/haskell/cabal/pull/9673)
35+
- Redesign `cabal path` command to account for projects [#9673](https://github.com/haskell/cabal/pull/9673)
3636

3737
Previously, `cabal path` was only able to query from the global configuration file, e.g., `~/.cabal/config` or the XDG equivalent.
3838
We take the foundations and enhance `cabal path` to take project configuration, such as `cabal.project`, into account.
@@ -55,11 +55,27 @@ cabal-install and cabal-install-solver 3.12.1.0 changelog and release notes
5555
To do that, we re-configure the compiler program, and outputs the location, version and compiler flavour.
5656
This is helpful for downstream tools, such as HLS, to figure out the GHC version required to compile a project with, without dependency solving.
5757

58+
- Add support for authentication tokens for uploading to Hackage [#6738](https://github.com/haskell/cabal/issues/6738) [#9058](https://github.com/haskell/cabal/pull/9058)
59+
60+
A new flag `--token` (`-t`) has been created. Token authentication takes
61+
precedence over username and password meaning that, if a token is set,
62+
the username and password flags are ignored.
63+
64+
- Make --(test-)show-details=direct the default [#8942](https://github.com/haskell/cabal/pull/8942)
65+
66+
This option leaves it up to the testing framework to decide what and how to print out,
67+
potentially leading to a prettier output. For example, most of the testing frameworks
68+
use colors, which wouldn't be seen with any other option.
69+
70+
This comes with a tradeoff, though: Cabal will not create a log file with this option.
71+
If you prefer a log file, consider setting `--test-show-details=streaming` (or something
72+
else) manually.
73+
5874
### Other changes
5975

6076
- Script cache dir is the base16 hash of the canonical path of the script. [#9459](https://github.com/haskell/cabal/pull/9459)
6177

62-
Script cache dir is the base16 hash of the canonical path of the script.
78+
This fixes sporadic path failures on both Windows and Linux (e.g. [#9334](https://github.com/haskell/cabal/issues/9334)).
6379

6480
- Die if package list is missing [#8944](https://github.com/haskell/cabal/pull/8944)
6581

@@ -83,22 +99,6 @@ cabal-install and cabal-install-solver 3.12.1.0 changelog and release notes
8399
before the build, that an overwrite policy flag would be needed for the
84100
install to succeed.
85101

86-
- Add support for authentication tokens for uploading to Hackage [#6738](https://github.com/haskell/cabal/issues/6738) [#9058](https://github.com/haskell/cabal/pull/9058)
87-
88-
A new flag `--token` (`-t`) has been created. Token authentication takes
89-
precedence over username and password meaning that, if a token is set,
90-
the username and password flags are ignored.
91-
92-
- Make --(test-)show-details=direct the default [#8942](https://github.com/haskell/cabal/pull/8942)
93-
94-
This option leaves it up to the testing framework to decide what and how to print out,
95-
potentially leading to a prettier output. For example, most of the testing frameworks
96-
use colors, which wouldn't be seen with any other option.
97-
98-
This comes with a tradeoff, though: Cabal will not create a log file with this option.
99-
If you prefer a log file, consider setting `--test-show-details=streaming` (or something
100-
else) manually.
101-
102102
- Make sure Haskell files in explicit source directories take precedence over autogenerated Haskell files [#8689](https://github.com/haskell/cabal/issues/8689) [#8690](https://github.com/haskell/cabal/pull/8690)
103103

104104
- Changed order or directories in GHC invocation so that source
@@ -127,13 +127,13 @@ cabal-install and cabal-install-solver 3.12.1.0 changelog and release notes
127127
name did not match exactly. Now they will be cached even if the header's
128128
capitalization is different.
129129

130-
- Clarify the semantics of the -package-db flag [#9678](https://github.com/haskell/cabal/issues/9678)
130+
- Clarify the semantics of the `--package-db` flag [#9678](https://github.com/haskell/cabal/issues/9678)
131131

132132
The `--package-db` flag now only applies to the default
133133
immutable initial package stack rather than also applying to the store
134134
package database.
135135

136-
This fixes an assertion failure which was triggered when using -package-db and also
136+
This fixes an assertion failure which was triggered when using `--package-db` and also
137137
clarifies how it should interact with `--store-dir` and `--dist-dir` flags.
138138

139139
- PkgConfig individual calls [#9134](https://github.com/haskell/cabal/pull/9134)
@@ -212,14 +212,14 @@ cabal-install and cabal-install-solver 3.12.1.0 changelog and release notes
212212
cabal-install would silently ignore them. Now cabal-install will emit a
213213
warning.
214214

215-
- Fix precedence for PATH for build-tools-depends [#8972](https://github.com/haskell/cabal/pull/8972)
215+
- Fix precedence for PATH for `build-tools-depends` [#8972](https://github.com/haskell/cabal/pull/8972)
216216

217217
Fixes a bug introduced in #8506 that caused executables in the path to
218-
take precedence over those specified in build-tools-depends.
218+
take precedence over those specified in `build-tools-depends`.
219219

220-
- Remove --cabal-file flags from v2 commands [#6880](https://github.com/haskell/cabal/issues/6880) [#7225](https://github.com/haskell/cabal/issues/7225) [#8395](https://github.com/haskell/cabal/issues/8395) [#9123](https://github.com/haskell/cabal/pull/9123)
220+
- Remove `--cabal-file` flags from v2 commands [#6880](https://github.com/haskell/cabal/issues/6880) [#7225](https://github.com/haskell/cabal/issues/7225) [#8395](https://github.com/haskell/cabal/issues/8395) [#9123](https://github.com/haskell/cabal/pull/9123)
221221

222-
The --cabal-file flag was never meant for public use but only for testing.
222+
The `--cabal-file` flag was never meant for public use but only for testing.
223223
To avoid confusing the users any further we removed the flag from v2
224224
commands.
225225

@@ -228,16 +228,19 @@ cabal-install and cabal-install-solver 3.12.1.0 changelog and release notes
228228
The "Executing·install·plan··serially" and other similar "Executing
229229
install plan··..." outputs no longer contain double spaces.
230230

231-
- Guard PackageInfo_* modules behind `cabal-version` ≥ 3.12 [#9331](https://github.com/haskell/cabal/issues/9331) [#9481](https://github.com/haskell/cabal/pull/9481)
231+
- Guard `PackageInfo_*` modules behind `cabal-version` ≥ 3.12 [#9331](https://github.com/haskell/cabal/issues/9331) [#9481](https://github.com/haskell/cabal/pull/9481)
232232

233-
`cabal check` now warns whenever PackageInfo_* autogen modules are
233+
`cabal check` now warns whenever `PackageInfo_*` autogen modules are
234234
used with `cabal-version` ≥ 3.12.
235-
Additionally, `cabal configure` will fail if you try to use PackageInfo_*
235+
Additionally, `cabal configure` will fail if you try to use `PackageInfo_*`
236236
with `cabal-version` < 3.12.
237237

238238
- cabal init now generates cabal versions older than 1.12 with the correct >= syntax [#8206](https://github.com/haskell/cabal/issues/8206) [#8860](https://github.com/haskell/cabal/pull/8860)
239+
239240
- `cabal init`: suggest BSD-3 as default license [#8757](https://github.com/haskell/cabal/issues/8757) [#8764](https://github.com/haskell/cabal/pull/8764)
241+
240242
- Do not ask overwrite permissions on blank project [#9150](https://github.com/haskell/cabal/issues/9150) [#9155](https://github.com/haskell/cabal/pull/9155)
243+
241244
- Don't report `index.html` file as created, if not created by Haddock [#5120](https://github.com/haskell/cabal/issues/5120) [#9332](https://github.com/haskell/cabal/pull/9332)
242245

243246
- Shorten solver rejection messages by removing repetition [#4251](https://github.com/haskell/cabal/issues/4251) [#9559](https://github.com/haskell/cabal/issues/9559) [#9560](https://github.com/haskell/cabal/pull/9560)
@@ -284,4 +287,3 @@ cabal-install and cabal-install-solver 3.12.1.0 changelog and release notes
284287
This change matters to BSD-2-Clause and BSD-3-Clause licences. For these two
285288
licences, `cabal init` created a licence file that slightly differed from
286289
wording published at SPDX. This has been rectified.
287-

0 commit comments

Comments
 (0)