Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
andreasabel opened this issue Mar 4, 2025 · 1 comment
Open
Labels
cabal-install: cmd/clean documentation re: help-text Concerning option --help and hints given to the user type: enhancement

Comments

@andreasabel
Copy link
Member

$ 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)".

@ulysses4ever
Copy link
Collaborator

Likely a dup of #7924

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cabal-install: cmd/clean documentation re: help-text Concerning option --help and hints given to the user type: enhancement
Projects
None yet
Development

No branches or pull requests

2 participants