haskell / haskell/cabal

Consider reverting default usage of `--enable-documentation` in cabal haddock

Open
#8,725 22 comments 1 reaction 0 assignees View on GitHub
attention: pr-welcome cabal-install: cmd/haddock re: enable-documentation type: discussion
Dominant language
Haskell
Stars
1.7k
Forks
750
Avg merge
4d 3h
Merged PRs (30d)
28

Description

I was bitten by #8707 and I had no idea what was going on, had to search the issue tracker to find it.

Looks like now `cabal haddock` will with default settings (i.e. no `documentation: True` in the config file or `--disable-documentation` passed explicitly) lead to rebuild of all dependencies.

What is worse, if someone doesn't want to enable `documentation: True`, there seems to be no way to permanently disable this behavior.

This looks like a quite bad UX change to me.

Can this please be reverted? Or resolved in a better way.

PRs in question:

- https://github.com/haskell/cabal/pull/8259
- #8330

Contributor guide

Open the contributing guide

Research direction

Start by reading #8707 and the referenced PRs #8259 and #8330 to understand why cabal haddock rebuilds dependencies by default and how configuration and command-line options interact. Done means the default behavior and a permanent opt-out are agreed and covered by the relevant tests, though no test or source file is named here.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.