Clarify the relationship between ~/.cabal/config and cabal.project files #6319
Labels
documentation
re: config-file
Concerning the cabal configuration file and the `--config-file` option
re: project-file
Concerning cabal.project files
The
~/.cabal/config
andcabal.project
files are ostensibly very similar, and the documentation forcabal.project
files states the following:At first I interpreted this to mean that
~/.cabal/config
is basically just a globalcabal.project
file, albeit probably without clearly project-specific options likepackages
. However, this appears to not be the case: some things use a shared syntax between the two files, but others do not. For example,package
stanzas are not allowed in~/.cabal/config
(why not?).It would be nice if the documentation were clearer about how these configuration formats relate, if they relate at all.
(This is very related to #2403.)
The text was updated successfully, but these errors were encountered: