haskell / haskell/cabal

Help text wrongly states that the default `--builddir` is `dist`

Open
#7,924 3 comments 1 reaction 0 assignees View on GitHub
documentation newcomer: 3-multi-file-refactor re: builddir re: help-text re: v1-vs-v2
Dominant language
Haskell
Stars
1.7k
Forks
750
Avg merge
4d 3h
Merged PRs (30d)
28

Description

Help text for `cabal install` still claims that the default `--builddir` is `dist` (rather than `dist-newstyle`).
```
$ cabal install --help | grep -B1 dist
--builddir=DIR The directory where Cabal puts generated build
files (default dist)
```

Contributor guide

Open the contributing guide

Research direction

Start by reproducing the issue with `cabal install --help | grep -B1 dist`, then locate the help-text entry for `--builddir` in the cabal-install sources. Update the stated default to `dist-newstyle` and rerun the command to confirm the displayed help is correct.

Written by the indexing model from the issue text.

Assessment

Tech stack
haskell
Domain
cli
Issue type
Bug
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.