Skip to content

Commit baf8769

Browse files
committedJun 9, 2024
Re commercialhaskell#6610 Document STACK_CONFIG and STACK_GLOBAL_CONFIG
1 parent 6a26ee2 commit baf8769

File tree

1 file changed

+25
-6
lines changed

1 file changed

+25
-6
lines changed
 

‎doc/environment_variables.md

+25-6
Original file line numberDiff line numberDiff line change
@@ -84,10 +84,28 @@ Stack follows the standard at http://no-color.org/. Stack checks for a
8484
(regardless of its value), Stack prevents the addition of control character
8585
sequences for color to its output.
8686

87+
## `STACK_CONFIG`
88+
89+
Related command: all commands that make use of Stack's
90+
[global YAML configuration files](yaml_configuration.md) (`config.yaml`).
91+
92+
The environment variable `STACK_CONFIG` can be used to specify an absolute path
93+
to the user-specific global YAML configuration file, overriding the default.
94+
95+
## `STACK_GLOBAL_CONFIG`
96+
97+
Related command: all commands that make use of Stack's
98+
[global YAML configuration files](yaml_configuration.md) (`config.yaml`).
99+
100+
The environment variable `STACK_GLOBAL_CONFIG` can be used to specify an
101+
absolute path to the system-wide global YAML configuration file, overriding the
102+
default.
103+
87104
## `STACK_ROOT`
88105

89-
Related command: all commands that make use of Stack's global YAML configuration
90-
file (`config.yaml`).
106+
Related command: all commands that make use of Stack's
107+
[user-specific global YAML configuration file](yaml_configuration.md)
108+
(`config.yaml`).
91109

92110
Overridden by: Stack's global
93111
[`--stack-root`](global_flags.md#-stack-root-option) option.
@@ -111,8 +129,9 @@ the root directory of the project or package. The relative path cannot include a
111129

112130
## `STACK_XDG`
113131

114-
Related command: all commands that make use of Stack's user-specific general
115-
YAML configuration file (`config.yaml`).
132+
Related command: all commands that make use of Stack's
133+
[user-specific global YAML configuration file](yaml_configuration.md)
134+
(`config.yaml`).
116135

117136
Overridden by: the use of Stack's `STACK_ROOT` environment variable, or the use
118137
of Stack's global
@@ -124,8 +143,8 @@ set to any non-empty value.
124143

125144
## `STACK_YAML`
126145

127-
Related command: all commands that make use of Stack's project-level YAML
128-
configuration file.
146+
Related command: all commands that make use of Stack's
147+
[project-level YAML configuration file](yaml_configuration.md).
129148

130149
Overridden by: Stack's global
131150
[`--stack-yaml`](global_flags.md#-stack-yaml-option) option.

0 commit comments

Comments
 (0)
Please sign in to comment.