Custom-build: Document breaking change on built comps.
commitf501843439c449ca9d9e6d62f804a96886b48b4e
authorRodrigo Mesquita <rodrigo.m.mesquita@gmail.com>
Tue, 3 Sep 2024 15:31:59 +0000 (3 16:31 +0100)
committerMikolaj <281893+Mikolaj@users.noreply.github.com>
Fri, 6 Sep 2024 18:20:55 +0000 (6 18:20 +0000)
tree861f47998de18e9822857d472c4833ed894f38e1
parent3a6f73ed7286ff69702bb83233a7b328f39c966b
Custom-build: Document breaking change on built comps.

As mentioned by e8c9d19, Cabal 3.12 introduced a breaking change where
an unnecessary (not requested) component of a package with a "Custom"
build-type is no longer built.

This caused breakage for Agda, and was undocumented.

The behaviour, despite breaking, is the desired one -- a package
shouldn't assume the executable will be built if only the library was
requested. This commit documents the breaking change to make sure it is
more visible.

In the meantime, we've also patched Agda to no longer expect the
executable to be built when only the library is installed.

Closes #9777 and #10235
release-notes/Cabal-3.12.0.0.md