haskell / haskell/cabal

Cabal passes `--source-*` options to Haddock even when new hyperlinked-sources backend is in use

Open
#9,693 0 comments 0 reactions 0 assignees View on GitHub
needs triage type: bug
Dominant language
Haskell
Stars
1.7k
Forks
750
Avg merge
4d 3h
Merged PRs (30d)
28

Description

**Describe the bug**
Run `cabal haddock` with building of hyperlinked sources enabled. `haddock` will rightly complain that:
```
Warning: --source-* options are ignored when --hyperlinked-source is enabled.
```

**To Reproduce**
Steps to reproduce the behavior:

```
$ cabal unpack acme-box
$ cd acme-box-*
$ cat > cabal.project <

Contributor guide

Open the contributing guide

Research direction

Reproduce with the acme-box example, a cabal.project setting haddock-hyperlink-source: True, and cabal haddock. Start at the cabal haddock command's Haddock option handling; done means --source-* options are omitted when hyperlinked sources are enabled and the warning no longer appears.

Written by the indexing model from the issue text.

Assessment

Tech stack
haskell
Domain
build-system, cli
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.