Skip to content

Commit

Permalink
README: GHC compatiblity (#2820)
Browse files Browse the repository at this point in the history
Copy the _GHC compatibility_ section in README.md from the master
branch, to accurately reflect the GHC's supported by 1.8.
  • Loading branch information
DigitalBrains1 authored Oct 8, 2024
1 parent b0fff6f commit 6c9585a
Showing 1 changed file with 8 additions and 5 deletions.
13 changes: 8 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,16 +66,19 @@ Note that release branches might contain non-released patches.
| | Linux | Windows | macOS | Clash (released) | Clash (development version)
|------|-------|---------|-------|------------------|--------------------------
| 8.6 | ✔️ | ✔️ | ✔️ | 1.0 - 1.8 | ❌
| 8.8 | ✔️ | ❌ | ✔️ | 1.0 - 1.8 | ❌
| 8.10 | ✔️ | ✔️ | ❌ | 1.2 - 1.8 | ✔️
| 8.8 | ✔️ | ❌ | ✔️ | 1.0 - 1.8 | ❌
| 8.10 | ✔️ | ✔️ | ❌ | 1.2 - 1.8 | ✔️
| 9.0 | ✔️ | ✔️² | ✔️ | 1.4 - 1.8 | ✔️
| 9.2 | ⚠️¹ | ⚠️¹ | ⚠️¹ | 1.8 | ⚠️¹️
| 9.4 | ✔️ | ✔️ | ✔️ | 1.8 | ✔️
| 9.6 | ✔️ | ✔️ | ✔️ | 1.8 | ✔️
| 9.4 | ⚠️³ ️ | ⚠️³ | ️⚠️³ ️ | 1.8 | ✔️
| 9.6 | ✔️³ | ✔️³ | ✔️³ | 1.8 | ✔️
| 9.8 | ✔️ | ✔️ | ✔️ | 1.8 | ️✔️

¹ GHC 9.2 contains a regression, rendering Clash error messages indecipherable. This change was reverted in 9.4.

² GHC 9.0.2 on Windows fails to compile `clash-cores`. We therefore don't run the Clash testsuite on CI for this combination.
² GHC 9.0.2 on Windows fails to compile `clash-cores`. We therefore don't run the Clash test suite on CI for this combination.

³ Clash starts extremely slowly when compiled with 9.4.8 up to and including 9.6.2. Consider downgrading to 9.4.7 or upgrading to 9.6.3 and up.

## Cabal
To use Cabal you need both Cabal and GHC installed on your system. We recommend using [ghcup](https://www.haskell.org/ghcup/). For more information, see [https://www.haskell.org/downloads/](https://www.haskell.org/downloads/).
Expand Down

0 comments on commit 6c9585a

Please sign in to comment.