haskell / haskell/cabal

Link failure with cabal haddock, data-files, and annotations.

Open
#5,594 3 comments 0 reactions 0 assignees View on GitHub
Dominant language
Haskell
Stars
1.7k
Forks
750
Avg merge
4d 3h
Merged PRs (30d)
28

Description

In a library with `data-files` set in the cabal file, if we try to use a function defined in the `Paths_*` generated module in an `{-# ANN module #-}` annotation, `cabal haddock` fails with a hard to understand GHCi linker error.

This is the case with cabal-install 2.2 and 2.4

[This gist](https://gist.github.com/Taneb/cafb8a4433298a24a100708a8529495a) has an example

Contributor guide

Open the contributing guide

Research direction

Start by reproducing the data-files, generated Paths_* module, and module annotation example from the linked gist with cabal haddock under cabal-install 2.2 or 2.4. Trace the resulting GHCi linker error through the Cabal/Haddock entry points; done means the example builds successfully without the hard-to-understand linker failure.

Written by the indexing model from the issue text.

Assessment

Tech stack
haskell
Domain
build-system, documentation
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.