cabal
cabal copied to clipboard
Organize docs for cabal-install commands into subsections
Lifted from: https://github.com/haskell/cabal/pull/8309#issuecomment-1192407285
The commands listed under 5.2 of the rtd docs appear in no recognizable order. Suggestions: break 5.2 into several sections grouping commands by theme.
- global command:
user-config
- package database commands:
update, list, info
- initialization & download:
init, fetch, get
- project configuration:
configure, freeze, gen-bounds
- project building and installing:
build, install, haddock, haddock-project, clean
- running and testing:
list-bin, repl, run, bench, test, exec
- sanity checks & shipping:
check, sdist, upload, report
This is a rough classification, open to amendments. I think some classification is better than just a soup in random order.
This is how they are divided in cabal help
[global]
update Updates list of known packages.
install Install packages.
help Help about commands.
info Display detailed information about a particular package.
list List packages matching a search string.
fetch Downloads packages for later installation.
user-config Display and update the user's global cabal configuration.
[package]
get Download/Extract a package's source code (repository).
init Create a new .cabal package file.
configure Add extra project configuration
build Compile targets within the project.
clean Clean the package store and remove temporary files.
run Run an executable.
repl Open an interactive session for the given component.
test Run test-suites
bench Run benchmarks
check Check the package for common mistakes.
sdist Generate a source distribution file (.tar.gz).
upload Uploads source packages or documentation to Hackage.
report Upload build reports to a remote server.
freeze Freeze dependencies.
gen-bounds Generate dependency bounds.
outdated Check for outdated dependencies
haddock Build Haddock documentation
hscolour Generate HsColour colourised code, in HTML format.
exec Give a command access to the store.
list-bin list path to a single executable.
I much much prefer your classification
Feel free to rework this totally.
Once #8309 is closed and this is closed, I definitely can!
This seems to have been addressed?
No objections, so closing.