Skip to content

Commit 8dab141

Browse files
committed
Remove 'The' from subheadings
1 parent ded2b43 commit 8dab141

File tree

3 files changed

+46
-46
lines changed

3 files changed

+46
-46
lines changed

doc/environment_variables.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ Related command: all commands that make use of Stack's global YAML configuration
7474
file (`config.yaml`).
7575

7676
Overridden by: Stack's global
77-
[`--stack-root`](global_flags.md#the---stack-root-option) option.
77+
[`--stack-root`](global_flags.md#stack-root-option) option.
7878

7979
The environment variable `STACK_ROOT` can be used to specify the Stack root
8080
directory.
@@ -85,7 +85,7 @@ Related command: all commands that make use of Stack's work directories.
8585

8686
Overridden by: Stack's [`work-dir`](yaml_configuration.md#work-dir) non-project
8787
specific configuration option, or global
88-
[`--work-dir`](global_flags.md#the---work-dir-option) option.
88+
[`--work-dir`](global_flags.md#work-dir-option) option.
8989

9090
The environment variable `STACK_WORK` can be used to specify the path of Stack's
9191
work directory, within a local project or package directory, and override
@@ -100,7 +100,7 @@ YAML configuration file (`config.yaml`).
100100

101101
Overridden by: the use of Stack's `STACK_ROOT` environment variable, or the use
102102
of Stack's global
103-
[`--stack-root`](global_flags.md#the---stack-root-option) option.
103+
[`--stack-root`](global_flags.md#stack-root-option) option.
104104

105105
On Unix-like operating systems and Windows, Stack can be configured to follow
106106
the XDG Base Directory Specification if the environment variable `STACK_XDG` is
@@ -112,7 +112,7 @@ Related command: all commands that make use of Stack's project-level YAML
112112
configuration file.
113113

114114
Overridden by: Stack's global
115-
[`--stack-yaml`](global_flags.md#the---stack-yaml-option) option.
115+
[`--stack-yaml`](global_flags.md#stack-yaml-option) option.
116116

117117
The environment variable `STACK_YAML` can be used to specify Stack's
118118
project-level YAML configuration file.

doc/global_flags.md

Lines changed: 41 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ flags and options apply to all of Stack's commands. In addition, all of Stack's
77
commands accept the `--setup-info-yaml` and `--snapshot-location-base` options
88
and the `--help` flag.
99

10-
## The `--allow-different-user` flag
10+
## `--allow-different-user` flag
1111

1212
Restrictions: POSIX systems only
1313

@@ -18,109 +18,109 @@ to use a Stack installation. For further information, see the documentation for
1818
the corresponding non-project specific configuration
1919
[option](yaml_configuration.md#allow-different-user).
2020

21-
## The `--arch` option
21+
## `--arch` option
2222

2323
Pass the option `--arch <architecture>` to specify the relevant machine
2424
architecture. For further information, see the documentation for the
2525
corresponding non-project specific configuration
2626
[option](yaml_configuration.md#arch).
2727

28-
## The `--color` or `-colour` options
28+
## `--color` or `-colour` options
2929

3030
Pass the option `stack --color <when>` to specify when to use color in output.
3131
For further information, see the documentation for the corresponding non-project
3232
specific configuration [option](yaml_configuration.md#color).
3333

34-
## The `--compiler` option
34+
## `--compiler` option
3535

3636
Pass the option `--compiler <compiler>` to specify the compiler. For further
3737
information, see the [YAML configuration](yaml_configuration.md#compiler)
3838
documentation.
3939

40-
## The `--custom-preprocessor-extensions` option
40+
## `--custom-preprocessor-extensions` option
4141

4242
Pass the option `--custom-preprocessor-extensions <extension>` to specify an
4343
extension used for a custom preprocessor. For further information, see the
4444
documentation for the corresponding non-project specific configuration
4545
[option](yaml_configuration.md#custom-preprocessor-extensions).
4646

47-
## The `--docker*` flags and options
47+
## `--docker*` flags and options
4848

4949
Stack supports automatically performing builds inside a Docker container. For
5050
further information see `stack --docker-help` or the
5151
[Docker integratiom](docker_integration.md) documentation.
5252

53-
## The `--[no-]dump-logs` flag
53+
## `--[no-]dump-logs` flag
5454

5555
Default: Dump warning logs
5656

5757
Enables/disables the dumping of the build output logs for local packages to the
5858
console. For further information, see the documentation for the corresponding
5959
non-project specific configuration [option](yaml_configuration.md#dump-logs).
6060

61-
## The `--extra-include-dirs` option
61+
## `--extra-include-dirs` option
6262

6363
Pass the option `--extra-include-dirs <director>` to specify an extra directory
6464
to check for C header files. The option can be specified multiple times. For
6565
further information, see the documentation for the corresponding non-project
6666
specific configuration [option](yaml_configuration.md#extra-include-dirs).
6767

68-
## The `--extra-lib-dirs` option
68+
## `--extra-lib-dirs` option
6969

7070
Pass the option `--extra-lib-dirs <director>` to specify an extra directory
7171
to check for libraries. The option can be specified multiple times. For further
7272
information, see the documentation for the corresponding non-project specific
7373
configuration [option](yaml_configuration.md#extra-lib-dirs).
7474

75-
## The `--ghc-build` option
75+
## `--ghc-build` option
7676

7777
Pass the option `--ghc-build <build>` to specify the relevant specialised GHC
7878
build. For further information, see the documentation for the corresponding
7979
non-project specific configuration [option](yaml_configuration.md#ghc-build).
8080

81-
## The `--ghc-variant` option
81+
## `--ghc-variant` option
8282

8383
Pass the option `--ghc-variant <variant>` to specify the relevant GHC variant.
8484
For further information, see the documentation for the corresponding non-project
8585
specific configuration [option](yaml_configuration.md#ghc-variant).
8686

87-
## The `--hpack-numeric-version` flag
87+
## `--hpack-numeric-version` flag
8888

8989
Pass the flag `--hpack-numeric-version` to cause Stack to report the numeric
9090
version of its built-in Hpack library to standard output (e.g. `0.35.0`) and
9191
quit.
9292

93-
## The `--[no-]install-ghc` flag
93+
## `--[no-]install-ghc` flag
9494

9595
Default: Enabled
9696

9797
Enables/disables the download and instalation of GHC if necessary. For further
9898
information, see the documentation for the corresponding non-project specific
9999
configuration [option](yaml_configuration.md#install-ghc).
100100

101-
## The `--jobs` or `-j` option
101+
## `--jobs` or `-j` option
102102

103103
Pass the option `--jobs <number_of_jobs>` to specify the number of concurrent
104104
jobs to run. For further information, see the documentation for the
105105
corresponding non-project specific configuration
106106
[option](yaml_configuration.md#jobs).
107107

108-
## The `--local-bin-path` option
108+
## `--local-bin-path` option
109109

110110
Pass the option `--local-bin-path <directory>` to specify the directory in which
111111
Stack installs executables. For further information, see the documentation for
112112
the corresponding non-project specific configuration
113113
[option](yaml_configuration.md#local-bin-path).
114114

115-
## The `--lock-file` option
115+
## `--lock-file` option
116116

117117
Default: `read-write`, if snapshot specified in YAML configuration file;
118118
`read-only`, if a different snapshot is specified on the command line.
119119

120120
Pass the option `--lock-file <mode>` to specify how Stack interacts with lock
121121
files. Valid modes are `error-on-write`, `ignore`, `read-only` and `read-write`.
122122

123-
## The `--[no-]modify-code-page` flag
123+
## `--[no-]modify-code-page` flag
124124

125125
Restrictions: Windows systems only
126126

@@ -130,23 +130,23 @@ Enables/disables setting the codepage to support UTF-8. For further information,
130130
see the documentation for the corresponding non-project specific configuration
131131
[option](yaml_configuration.md#modify-code-page).
132132

133-
## The `--nix*` flags and options
133+
## `--nix*` flags and options
134134

135135
Stack can be configured to integrate with Nix. For further information, see
136136
`stack --nix-help` or the [Nix integration](nix_integration.md) documentation.
137137

138-
## The `--numeric-version` flag
138+
## `--numeric-version` flag
139139

140140
Pass the flag `--numeric-version` to cause Stack to report its numeric version
141141
to standard output (e.g. `2.9.1`) and quit.
142142

143-
## The `--resolver` option
143+
## `--resolver` option
144144

145145
Pass the option `--resolver <snapshot>` to specify the snapshot. For further
146146
information, see the
147147
[YAML configuration](yaml_configuration.md#resolver-or-snapshot) documentation.
148148

149-
## The `--[no-]rsl-in-log` flag
149+
## `--[no-]rsl-in-log` flag
150150

151151
[:octicons-tag-24: 2.9.1](https://github.com/commercialhaskell/stack/releases/tag/v2.9.1)
152152

@@ -156,26 +156,26 @@ Enables/disables the logging of the raw snapshot layer (rsl) in debug output.
156156
Information about the raw snapshot layer can be lengthy. If you do not need it,
157157
it is best omitted from the debug output.
158158

159-
## The `--[no-]script-no-run-compile` flag
159+
## `--[no-]script-no-run-compile` flag
160160

161161
Default: Disabled
162162

163163
Enables/disables the use of options `--no-run --compile` with the
164164
[`stack script` command](script_command.md).
165165

166-
## The `--silent` flag
166+
## `--silent` flag
167167

168168
Equivalent to the `--verbosity silent` option.
169169

170-
## The `--[no-]skip-ghc-check` option
170+
## `--[no-]skip-ghc-check` option
171171

172172
Default: Disabled
173173

174174
Enables/disables the skipping of checking the GHC version and architecture. For
175175
further information, see the documentation for the corresponding non-project
176176
specific configuration [option](yaml_configuration.md#skip-ghc-check).
177177

178-
## The `--[no-]skip-msys` option
178+
## `--[no-]skip-msys` option
179179

180180
Restrictions: Windows systems only
181181

@@ -185,20 +185,20 @@ Enables/disables the skipping of installing MSYS2. For further information, see
185185
the documentation for the corresponding non-project specific configuration
186186
[option](yaml_configuration.md#skip-msys).
187187

188-
## The `--stack-colors` or `--stack-colours` options
188+
## `--stack-colors` or `--stack-colours` options
189189

190190
Pass the option `--stack-colors <styles>` to specify Stack's output styles. For
191191
further information, see the documentation for the corresponding non-project
192192
specific configuration [option](yaml_configuration.md#stack-colors).
193193

194-
## The `--stack-root` option
194+
## `--stack-root` option
195195

196196
Overrides: `STACK_ROOT` environment variable
197197

198198
Pass the option `--stack-root <absolute_path_to_the_Stack_root>` to specify the
199199
path to the Stack root directory. The path must be an absolute one.
200200

201-
## The `--stack-yaml` option
201+
## `--stack-yaml` option
202202

203203
Default: `stack.yaml`
204204

@@ -207,64 +207,64 @@ Overrides: `STACK_YAML` enviroment variable
207207
Pass the option `--stack-yaml <file>` to specify Stack's project-level YAML
208208
configuration file.
209209

210-
## The `--[no-]system-ghc` flag
210+
## `--[no-]system-ghc` flag
211211

212212
Default: Disabled
213213

214214
Enables/disables the use of a GHC executable on the PATH, if one is available
215215
and its version matches.
216216

217-
## The `--[no-]terminal` flag
217+
## `--[no-]terminal` flag
218218

219219
Default: Stack is running in a terminal (as detected)
220220

221221
Enables/disables whether Stack is running in a terminal.
222222

223-
## The `--terminal-width` option
223+
## `--terminal-width` option
224224

225225
Default: the terminal width (if detected); otherwise `100`
226226

227227
Pass the option `--terminal-width <width>` to specify the width of the terminal,
228228
used by Stack's pretty printed messages.
229229

230-
## The `--[no-]time-in-logs` flag
230+
## `--[no-]time-in-logs` flag
231231

232232
Default: Enabled
233233

234234
Enables/disables the inclusion of time stamps against logging entries when the
235235
verbosity level is 'debug'.
236236

237-
## The `--verbose` or `-v` flags
237+
## `--verbose` or `-v` flags
238238

239239
Equivalent to the `--verbosity debug` option.
240240

241-
## The `--verbosity` option
241+
## `--verbosity` option
242242

243243
Default: `info`
244244

245245
Pass the option `--verbosity <log_level>` to specify the level for logging.
246246
Possible levels are `silent`, `error`, `warn`, `info` and `debug`, in order of
247247
increasing amounts of information provided by logging.
248248

249-
## The `--version` flag
249+
## `--version` flag
250250

251251
Pass the flag `--version` to cause Stack to report its version to standard
252252
output and quit. For versions that are release candidates, the report will list
253253
the dependencies that Stack has been compiled with.
254254

255-
## The `--with-gcc` option
255+
## `--with-gcc` option
256256

257257
Pass the option `--with-gcc <path_to_gcc>` to specify use of a GCC executable.
258258
For further information, see the documentation for the corresponding non-project
259259
specific configuration [option](yaml_configuration.md#with-gcc).
260260

261-
## The `--with-hpack` option
261+
## `--with-hpack` option
262262

263263
Pass the option `--with-hpack <hpack>` to specify use of an Hpack executable.
264264
For further information, see the documentation for the corresponding
265265
non-project specific configuration [option](yaml_configuration.md#with-hpack).
266266

267-
## The `--work-dir` option
267+
## `--work-dir` option
268268

269269
Default: `.stack-work`
270270

@@ -278,21 +278,21 @@ path must be a relative one, relative to the the root directory of the project
278278
or package. The relative path cannot include a `..` (parent directory)
279279
component.
280280

281-
## The `--setup-info-yaml` command option
281+
## `--setup-info-yaml` command option
282282

283283
Default: `https://raw.githubusercontent.com/commercialhaskell/stackage-content/master/stack/stack-setup-2.yaml`
284284

285285
The `--setup-info-yaml <url>` command option specifies the location of a
286286
`setup-info` dictionary. The option can be specified multiple times.
287287

288-
## The `--snapshot-location-base` command option
288+
## `--snapshot-location-base` command option
289289

290290
Default: `https://raw.githubusercontent.com/commercialhaskell/stackage-snapshots/master`
291291

292292
The `--snapshot-location-base <url>` command option specifies the base location
293293
of snapshots.
294294

295-
## The `--help` command flag
295+
## `--help` command flag
296296

297297
If Stack is passed the `--help` command flag, it will output help for the
298298
command.

doc/yaml_configuration.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1566,7 +1566,7 @@ with-hpack: /usr/local/bin/hpack
15661566
Default: `.stack-work`
15671567

15681568
Command line equivalent (takes precedence):
1569-
[`--work-dir`](global_flags.md#the---work-dir-option) option
1569+
[`--work-dir`](global_flags.md#work-dir-option) option
15701570

15711571
Environment variable alternative (lowest precedence):
15721572
[`STACK_WORK`](environment_variables.md#stack_work)

0 commit comments

Comments
 (0)