Skip to content

Commit 2b44bb8

Browse files
committed
Further document Stack's current approach to XDG
1 parent eca9f67 commit 2b44bb8

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

doc/GUIDE.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1483,6 +1483,21 @@ environment variable or using Stack's `--stack-root` option on the command line.
14831483
`~/.config/stack` on Unix-like operating systems and `%APPDIR%\stack` on
14841484
Windows.
14851485

1486+
This approach treats:
1487+
1488+
* the project-level YAML configuration file that is common to all projects
1489+
without another such file in their project directory or its ancestor
1490+
directories as _data_ rather than as part of Stack's own
1491+
_configuration_;
1492+
1493+
* the snapshots database as essential data rather than as non-essential
1494+
data that would be part of a _cache_, notwithstanding that Stack will
1495+
rebuild that database as its contents are needed; and
1496+
1497+
* the Pantry store as essential data rather than as non-essential data
1498+
that would be part of a _cache_, notwithstanding that Stack will
1499+
download the package index and rebuild the store if it is absent.
1500+
14861501
The location of the Stack root is reported by command:
14871502

14881503
~~~text

0 commit comments

Comments
 (0)