Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Skip Haddock for GHC 8.6.5 #326

Merged
merged 4 commits into from
Aug 1, 2022
Merged

Conversation

parsonsmatt
Copy link
Collaborator

@parsonsmatt parsonsmatt commented Aug 1, 2022

GHC 8.6.5 is broken with module re-exports. We can either re-export everything, or just skip building Haddock. I'd rather skip building Haddocks for an old GHC than make the code experience worse, or more fragile.

Before submitting your PR, check that you've:

After submitting your PR:

  • Update the Changelog.md file with a link to your PR.
  • Check that CI passes (or if it fails, for reasons unrelated to your change, like CI timeouts).

@belevy
Copy link
Collaborator

belevy commented Aug 1, 2022

So were just dropping support for haddock in 8.6.5? What is support "policy" for GHC versions?

@parsonsmatt
Copy link
Collaborator Author

Here's the error we get:

esqueleto            >   Missing documentation for:
esqueleto            >     ExprParser (src/Database/Esqueleto/Internal/ExprParser.hs:53)
esqueleto            >     onExpr (src/Database/Esqueleto/Internal/ExprParser.hs:55)
esqueleto            >     skipToEscape (src/Database/Esqueleto/Internal/ExprParser.hs:62)
esqueleto            >     parseEscapedIdentifier (src/Database/Esqueleto/Internal/ExprParser.hs:65)
esqueleto            >     parseTableAccess (src/Database/Esqueleto/Internal/ExprParser.hs:72)
esqueleto            >     parseEscapedChars (src/Database/Esqueleto/Internal/ExprParser.hs:79)
esqueleto            > haddock: internal error: internal: extractDecl
esqueleto            > CallStack (from HasCallStack):
esqueleto            >   error, called at utils/haddock/haddock-api/src/Haddock/Interface/Create.hs:1116:12 in main:Haddock.Interface.Create

It's a Haddock bug that we're somehow getting triggered.

Seems related to this issue, which indicates that Haddock is just broken here for GHC 8.6 (see this comment. The fix is dropping the module re-export and replacing with an explicit export list.

But GHC 8.6.5 itself isn't hard to support, so I'm not terribly worried about keeping it around. If it does become a trouble, then we'll drop it. I think it makes sense to retain support for GHC 8.10.7 until people aren't using it much, which will be a while.

@parsonsmatt parsonsmatt changed the title Matt/fix haddock for ghc 86 Skip Haddock for GHC 8.6.5 Aug 1, 2022
@parsonsmatt
Copy link
Collaborator Author

if anyone is seeing this and wondering why, i'd be happy to accept a PR that just fixes it and re-enables, fwiw

@parsonsmatt parsonsmatt merged commit 2c942f3 into master Aug 1, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants