Skip to content

Commit a7f411a

Browse files
committed
Add a page about package configuration locations
1 parent cea72a9 commit a7f411a

File tree

2 files changed

+26
-0
lines changed

2 files changed

+26
-0
lines changed

mkdocs.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -97,6 +97,7 @@ nav:
9797
- docs/package-management-tips.md
9898
- docs/package-management-faq.md
9999
- docs/filesystem-paths.md
100+
- docs/configuration.md
100101
- Languages & Tools:
101102
- docs/cmake.md
102103
- docs/autotools.md

web/docs/configuration.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# Configuration Locations
2+
3+
Cygwin packages, like openssh and git, follow the standard Unix conventions and
4+
use your `$HOME` or `$HOME/.config` directory for storing the user configuration
5+
and `/etc` for the system configuration.
6+
7+
For native Windows programs the situation is a bit more complicated. For the
8+
user configuration some programs use the standard Windows paths, such as
9+
`%USERPROFILE%\AppData\Roaming`. In some cases native Windows programs are
10+
minimally ported from Unix and will write to `%USERPROFILE%\.appname` or
11+
`%USERPROFILE%\.config\appname`, or they will prefer the `HOME` environment
12+
variable over `USERPROFILE` and store their configuration in `$HOME\.appname` or
13+
`$HOME\.config\appname` like their Unix variants. For the system configuration
14+
some programs might store them alongside their other data files or in case they
15+
were ported from Unix they might follow the Unix layout and store things in
16+
`$MINGW_PREFIX/etc/appname`
17+
18+
## FAQ
19+
20+
**Can't all programs use the same location for their user configuration?**
21+
22+
While having two locations for configuration can be confusing we want native
23+
programs to follow Windows conventions and be independent from MSYS2. Also we
24+
don't want to change the behavior of programs compared to their upstream
25+
versions unless we have to.

0 commit comments

Comments
 (0)