Skip to content

Default cabal.project in cabal repo fails with cabal-install older than latest release; hard to diagnose #8133

Open
@Mikolaj

Description

@Mikolaj

Our default project file is confusing to newbies with an older cabal-install installed. In particular, the file has tests enabled, but cabal-testsuite apparently requires cabal-install >= 3.6 to compile (Custom setup, sigh), which is not stated in any obvious place the newbie would look at and the compilation errors are opaque. I'm being told @ezyang may be the last person alive to know why the tests need a new cabal to compile and how we'd get around to simplifying their compilation.

To be fair, in README we say to use cabal install --project-file=cabal.project.release cabal-install. However, I think, at least another warning in the default project file would be needed or commenting out the test suite, with an explanation, or perhaps even kill the project file, though the -fno-ignore-asserts are useful and also a newbie with Tests: True in the global config file would be bitten just as before.

OTOH, if cabal devs just do cabal build and so the project file is supposed to be the perfect default for them, we should not make life harder for them, e.g., by disabling the testsuite. But if so, it's worth mentioning somewhere (is it?), or new cabal devs may be usure whether to follow the readme, or use the default cabal.project.

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions