Copyright	(C) 2024 Martijn Bastiaan
License	BSD2 (see the file LICENSE)
Maintainer	QBayLogic B.V. <devops@qbaylogic.com>
Safe Haskell	None
Language	Haskell2010

Clash.Driver.BrokenGhcs

Description

Utilities to detect and report GHC / operating system combinations that are known to be buggy.

Synopsis

Documentation

Current OS. Currently only recognizes Linux, Windows, and macOS.

What OS GHC is broken on (or all)

Constructors

All
SomeOs OS

Constructors

Ghc
Fields major0 :: Int major1 :: Int patch :: Int

Instances details

Eq GhcVersion Source #
Instance details Defined in Clash.Driver.BrokenGhcs Methods (==) :: GhcVersion -> GhcVersion -> Bool Source # (/=) :: GhcVersion -> GhcVersion -> Bool Source #
Ord GhcVersion Source #
Instance details Defined in Clash.Driver.BrokenGhcs Methods compare :: GhcVersion -> GhcVersion -> Ordering Source # (<) :: GhcVersion -> GhcVersion -> Bool Source # (<=) :: GhcVersion -> GhcVersion -> Bool Source # (>) :: GhcVersion -> GhcVersion -> Bool Source # (>=) :: GhcVersion -> GhcVersion -> Bool Source # max :: GhcVersion -> GhcVersion -> GhcVersion Source # min :: GhcVersion -> GhcVersion -> GhcVersion Source #

Constructors

GhcRange
Fields from :: GhcVersion Start of range, inclusive to :: GhcVersion End of range, exclusive

Check if a GhcVersion is within a GhcRange

Construct a range of all GHC versions matching a major version

Constructors

Why
Fields what :: String What is broken solution :: String What can be done to work around or solve the issue issue :: String Link to issue brokenOn :: [(BrokenOn, GhcRange)] What operation systems are affected

Get current GHC version expressed as a triple. It probably does something non-sensible on unreleased GHCs.

Pretty print Why into an error message

Which GHCs are broken and why

Given a BrokenOn, determine whether current OS matches

Given a BrokenOn and GhcVersion, determine whether it matches current OS and GHC

Get first reason for GHC/OS being broken, if any

Throw an error if current OS / GHC version is known to be buggy