haskell / haskell/cabal

`runghc Setup.hs haddock` does not allow for `--haddock-options=--prologue=my-prologue`

Open
#10,922 0 comments 1 reaction 0 assignees View on GitHub
type: enhancement
Dominant language
Haskell
Stars
1.7k
Forks
750
Avg merge
4d 3h
Merged PRs (30d)
28

Description

Haddock only allows `--prologue` to be specified once, ending in failure if the option is specified more than once.

`runghc Setup.hs haddock` makes use of the `--prologue` option itself, setting it to the content of the Cabal file's `description` field.

However, as a consequence, a user then has no mechanism to specify his or her own Haddock prologue.

A possible solution:

Cabal (the library) provides a `--haddock-prologue=` option that, if specified, prevails over Cabal's default use of `--prologue`.

Related Stack issue:
* https://github.com/commercialhaskell/stack/issues/6718

Contributor guide

Open the contributing guide

Research direction

Start by reproducing the behavior with `runghc Setup.hs haddock` and `--haddock-options=--prologue=my-prologue`. Read the Cabal library's Haddock option handling and related tests, then verify that the proposed `--haddock-prologue=` option lets users provide a prologue without Haddock receiving duplicate `--prologue` options.

Written by the indexing model from the issue text.

Assessment

Tech stack
haskell
Domain
build-system
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
40/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.