Skip to content

Document .cabal/config #2403

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
goldfirere opened this issue Feb 3, 2015 · 1 comment
Open

Document .cabal/config #2403

goldfirere opened this issue Feb 3, 2015 · 1 comment
Labels
cabal-install: other documentation re: config-file Concerning the cabal configuration file and the `--config-file` option

Comments

@goldfirere
Copy link

I just learned, via haskell-cafe, that I could say jobs: 4 in my ~/.cabal/config file to make my life better. I wish this had been in the documentation! (It's not at https://www.haskell.org/cabal/users-guide/ or anywhere underneath, that I could find.) Are there other options lurking undocumented in that file (such as ghc-options)?

Thanks!

@erikd
Copy link
Member

erikd commented Feb 20, 2015

cabal version 1.22 has a cabal user-config sub-command. The help output is here:

Display and update the user's global cabal configuration.

Usage: cabal user-config diff
   or: cabal user-config update

When upgrading cabal, the set of configuration keys and their default values
may change. This command provides means to merge the existing config in
~/.cabal/config (i.e. all bindings that are actually defined and not commented
out) and the default config of the new version.

diff: Shows a pseudo-diff of the user's ~/.cabal/config file and the default
configuration that would be created by cabal if the config file did not exist.
update: Applies the pseudo-diff to the configuration that would be created by
default, and write the result back to ~/.cabal/config.

which does a lot of what you want (although docs would also be nice).

@ttuegel ttuegel added this to the cabal-install-1.24 milestone Apr 23, 2015
@23Skidoo 23Skidoo modified the milestones: cabal-install 1.24, cabal-install 1.26 Feb 21, 2016
@ezyang ezyang modified the milestone: cabal-install 2.0 Sep 6, 2016
@ulysses4ever ulysses4ever added re: config-file Concerning the cabal configuration file and the `--config-file` option and removed old-milestone: cabal-install 2.0 labels Nov 20, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cabal-install: other documentation re: config-file Concerning the cabal configuration file and the `--config-file` option
Projects
None yet
Development

No branches or pull requests

6 participants