Clarify purpose of `~/.stack/global/stack.yaml` #969
Comments
In addition to comments for both files, I think we could enforce better naming to these files. change |
+1 to renaming to something like |
+1 to renaming defaults |
Here's what I'm thinking:
Also, probably:
And maybe?
I don't like that changing |
Ok, upon further reflection, thinking stack shouldn't attempt to rename/copy any files, and should just support using the old locations with deprecation warnings. Additionally, maybe And, finally, an idea: what if project config files ( |
* Rename `~/.stack/stack.yaml` to `~/.stack/config.yaml` * Rename `~/.stack/global` to `~/.stack/global-project` * Rename `/etc/stack/config` to `/etc/stack/config.yaml` * Support old locations of the renamed paths, with deprecation warnings * Clarify wording of some messages * Write comment to top of new `~/.stack/config.yaml` describing its purpose * Write comment to top of new `~/.stack/global-project/stack.yaml` describing its purpose * Write `~/.stack/global-project/README` describing the purpose of the directory
PR pushed: #1058 |
Rename config files and clarify their purposes (#969)
The
~/.stack/global/stack.yaml
file seems to be a common source of confusion (see #964, and I've seen the same thing a few other times). The stack.yaml documentation is pretty clear about its use, but I suspect in many cases people are just seeing astack.yaml
that exists under their~/.stack
and assuming it sets global default options without ever looking at that part of the documentation.I'm thinking we should have stack put a comment at the top of
~/.stack/global/stack.yaml
when it is generated stating what its use is and pointing people to the right place to put global defaults.The text was updated successfully, but these errors were encountered: