haskell / haskell/cabal

`cabal clean --help` still thinks that `dist` is the default `--builddir`

Open
#10,813 1 comment 0 reactions 0 assignees View on GitHub
cabal-install: cmd/clean documentation re: help-text type: enhancement
Dominant language
Haskell
Stars
1.7k
Forks
750
Avg merge
4d 3h
Merged PRs (30d)
28

Description

```
$ cabal-3.14.1.1 clean --help
Clean the package store and remove temporary files.

Usage: cabal-3.14.1.1 new-clean [FLAGS]

Removes all temporary files created during the building process (.hi, .o,
preprocessed sources, etc.) and also empties out the local caches (by
default).

Flags for clean:
...
--builddir=DIR The directory where Cabal puts generated build
files (default dist)
```
- That should be `dist-newstyle` rather than `dist`, I suppose.
- `new-clean` should be just `clean` (correct would also be `v2-clean` but the `v2` prefix is generally not printed).

I also think it would be good that the help text "Removes all temporary files..." would add the clarification "in DIR (see --builddir below)".

Contributor guide

Open the contributing guide

Research direction

Start by locating the Cabal help text for the clean command and its --builddir flag, then run cabal-3.14.1.1 clean --help to compare the current output with the issue. Done means the default reads dist-newstyle, the usage line uses clean rather than new-clean, and the temporary-files description refers to the selected build directory.

Written by the indexing model from the issue text.

Assessment

Tech stack
haskell
Domain
cli
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
52/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.