Merge pull request #2156 from input-output-hk/disable-doctests-on-ghc…

…-8.10.x Disable doctests on ghc 8.10.x
IntersectMBO · Feb 25, 2021 · c02b909 · c02b909
2 parents 0d81fb1 + 19cd73d
commit c02b909
Show file tree

Hide file tree

Showing 4 changed files with 36 additions and 0 deletions.
diff --git a/.github/workflows/haskell.yml b/.github/workflows/haskell.yml
@@ -13,6 +13,9 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
+        # WARNING Do not remove ghc-8.6.5 until doctests are working for ghc-8.10.x.
+        # Doctests for ghc-8.10.x are currently disabled via the CPP in DoctestDiscover.hs files
+        # See See https://gitlab.haskell.org/ghc/ghc/-/issues/19421
         ghc: ["8.6.5", "8.10.4"]
         os: [ubuntu-latest]
 

diff --git a/byron/ledger/executable-spec/test/DoctestDiscover.hs b/byron/ledger/executable-spec/test/DoctestDiscover.hs
@@ -1 +1,12 @@
+{-# LANGUAGE CPP #-}
+
+#if !MIN_VERSION_GLASGOW_HASKELL(8,10,0,0) || MIN_VERSION_GLASGOW_HASKELL(8,11,0,0)
 {-# OPTIONS_GHC -F -pgmF doctest-discover #-}
+#else
+module Main where
+
+import qualified System.IO as IO
+
+main :: IO ()
+main = IO.putStrLn "WARNING: doctest will not run on GHC 8.10.x.\nSee https://gitlab.haskell.org/ghc/ghc/-/issues/19421"
+#endif
diff --git a/semantics/executable-spec/test/DoctestDiscover.hs b/semantics/executable-spec/test/DoctestDiscover.hs
@@ -1 +1,12 @@
+{-# LANGUAGE CPP #-}
+
+#if !MIN_VERSION_GLASGOW_HASKELL(8,10,0,0) || MIN_VERSION_GLASGOW_HASKELL(8,11,0,0)
 {-# OPTIONS_GHC -F -pgmF doctest-discover #-}
+#else
+module Main where
+
+import qualified System.IO as IO
+
+main :: IO ()
+main = IO.putStrLn "WARNING: doctest will not run on GHC 8.10.x.\nSee https://gitlab.haskell.org/ghc/ghc/-/issues/19421"
+#endif
diff --git a/semantics/small-steps-test/test/DoctestDiscover.hs b/semantics/small-steps-test/test/DoctestDiscover.hs
@@ -1 +1,12 @@
+{-# LANGUAGE CPP #-}
+
+#if !MIN_VERSION_GLASGOW_HASKELL(8,10,0,0) || MIN_VERSION_GLASGOW_HASKELL(8,11,0,0)
 {-# OPTIONS_GHC -F -pgmF doctest-discover #-}
+#else
+module Main where
+
+import qualified System.IO as IO
+
+main :: IO ()
+main = IO.putStrLn "WARNING: doctest will not run on GHC 8.10.x.\nSee https://gitlab.haskell.org/ghc/ghc/-/issues/19421"
+#endif