Skip to content

Commit b278745

Browse files
committed
Fix changed links
1 parent aa8ee1c commit b278745

38 files changed

+320
-283
lines changed

doc/README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -143,7 +143,7 @@ Stack can be installed directly or by using the GHCup tool.
143143
!!! info
144144

145145
By default, the Windows installer will set the
146-
[Stack root](stack_root.md) to `C:\sr`.
146+
[Stack root](topics/stack_root.md) to `C:\sr`.
147147

148148
!!! note
149149

@@ -318,13 +318,13 @@ section.
318318

319319
That was a really fast introduction on how to start to code in Haskell using
320320
Stack. If you want to go further, we highly recommend you read Stack's
321-
introductory [user's guide](GUIDE.md).
321+
introductory [user's guide](tutorial/index.md).
322322

323323
## Complete guide to Stack
324324

325-
A complete [user's guide](GUIDE.md) to Stack is available, covering all of
326-
the most common ways to use Stack. Terms used in Stack's documentation are also
327-
explained in the [glossary](glossary.md).
325+
A complete [user's guide](tutorial/index.md) to Stack is available, covering all
326+
of the most common ways to use Stack. Terms used in Stack's documentation are
327+
also explained in the [glossary](glossary.md).
328328

329329
## Why Stack?
330330

doc/commands/build_command.md

Lines changed: 23 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,8 @@ stack build [TARGET] [--dry-run] [--pedantic] [--fast] [--ghc-options OPTIONS]
2929
interface for simple tasks and flexibility for more complicated goals.
3030

3131
See the introductory part of Stack's
32-
[user's guide](GUIDE.md#the-stack-build-command) for an introduction to the
33-
command.
32+
[user's guide](../tutorial/hello_world_example.md#the-stack-build-command) for
33+
an introduction to the command.
3434

3535
## Synonyms
3636

@@ -208,15 +208,16 @@ its subdirectories.
208208
## Controlling what gets built
209209

210210
Stack will automatically build the necessary dependencies. See the introductory
211-
part of Stack's [user's guide](GUIDE.md#the-stack-build-command) for information
212-
about how these dependencies get specified.
211+
part of Stack's
212+
[user's guide](../tutorial/building_your_project.md#adding-dependencies) for
213+
information about how these dependencies get specified.
213214

214215
In addition to specifying targets, you can also control what gets built, or
215216
retained, with the flags and options listed below. You can also affect what gets
216217
built by specifying Cabal (the library) options for the configure step
217218
of the Cabal build process (for further information, see the documentation for
218-
the [configure-options](yaml_configuration.md#configure-options) configuration
219-
option).
219+
the [configure-options](../configure/yaml/non-project.md#configure-options)
220+
configuration option).
220221

221222
### `--bench` flag
222223

@@ -279,7 +280,7 @@ This overrides:
279280
!!! note
280281

281282
In order to set a Cabal flag for a GHC boot package, the package must be
282-
specified as an [extra-dep](yaml_configuration.md#extra-deps).
283+
specified as an [extra-dep](../configure/yaml/project.md#extra-deps).
283284

284285
### `--[no-]force-dirty` flag
285286

@@ -644,20 +645,22 @@ The effect of `--fast` can be overriden with Stack's
644645
Cabal's default behaviour). The exception is if Cabal's
645646
`--disable-optimization` flag or `--enable-optimization[=n]`, `-O[n]`
646647
options are used during the configure step of the Cabal build process; see
647-
Stack's [`configure-options`](yaml_configuration.md#configure-options) YAML
648-
configuration option.
648+
Stack's
649+
[`configure-options`](../configure/yaml/non-project.md#configure-options)
650+
YAML configuration option.
649651

650652
### `--ghc-options` option
651653

652654
GHC command line options can be specified for a package in its Cabal file
653655
(including one created from a `package.yaml` file). This option augments and, if
654656
applicable (see below), overrides any such GHC command line options and those
655657
specified in Stack's YAML configuration files - see the
656-
[`ghc-options`](yaml_configuration.md#ghc-options) configuration option.
658+
[`ghc-options`](../configure/yaml/non-project.md#ghc-options) configuration
659+
option.
657660

658661
`stack build --ghc-options <ghc_options>` passes the specified command line
659662
options to GHC, depending on Stack's
660-
[`apply-ghc-options`](yaml_configuration.md#apply-ghc-options) YAML
663+
[`apply-ghc-options`](../configure/yaml/non-project.md#apply-ghc-options) YAML
661664
configuration option. This option can be specified multiple times.
662665

663666
GHC's command line options are _order-dependent_ and evaluated from left to
@@ -757,14 +760,14 @@ to `happy` its `--ghc` flag.
757760
By default, all and any `--PROG-option` options on Stack's command line are
758761
applied to all project packages (targets or otherwise). This behaviour can be
759762
changed. See the
760-
[`apply-prog-options`](yaml_configuration.md#apply-prog-options) configuration
761-
option.
763+
[`apply-prog-options`](../configure/yaml/non-project.md#apply-prog-options)
764+
configuration option.
762765

763766
Stack can also be configured to pass Cabal's `--PROG-option`, `--PROG-options`
764767
or other options to Cabal during the configuration step. For further
765768
information, see the documentation for the
766-
[configure-options](yaml_configuration.md#configure-options) configuration
767-
option.
769+
[configure-options](../configure/yaml/non-project.md#configure-options)
770+
configuration option.
768771

769772
## Flags relating to build outputs
770773

@@ -877,9 +880,9 @@ package is targetted in a multi-package project (for example, using
877880
contents of the log files to the standard error output stream of the console
878881
at the end of the build, use Stack's `dump-logs` option. For further
879882
information about that option, see the
880-
[YAML configuration](yaml_configuration.md#dump-logs) documentation. The
881-
default `dump-logs` mode is to output the contents of any log files that
882-
include GHC warnings.
883+
[YAML configuration](../configure/yaml/non-project.md#dump-logs)
884+
documentation. The default `dump-logs` mode is to output the contents of any
885+
log files that include GHC warnings.
883886

884887
### `--[no]-open` flag
885888

@@ -932,8 +935,8 @@ All the following examples assume that:
932935
`stack.yaml` file in the current directory or ancestor directory and,
933936
consequently, the project-level configuration will be determined by a
934937
`stack.yaml` file in the `global-project` directory in the
935-
[Stack root](stack_root.md) (for further information, see the
936-
[YAML configuration](yaml_configuration.md) documentation); and
938+
[Stack root](../topics/stack_root.md) (for further information, see the
939+
[YAML configuration](../configure/yaml_configuration.md) documentation); and
937940

938941
* if `stack build` is commanded in a project directory, there is a
939942
`stack.yaml` file in that directory.

doc/commands/init_command.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,8 @@ By default:
2727

2828
If a snapshot is specified at the command line, `stack init` will try to use it.
2929
For further information, see the documentation for the
30-
[`--snapshot`](global_flags.md#-snapshot-option) and
31-
[`--resolver`](global_flags.md#-resolver-option) options.
30+
[`--snapshot`](../configure/global_flags.md#-snapshot-option) and
31+
[`--resolver`](../configure/global_flags.md#-resolver-option) options.
3232

3333
Otherwise, `stack init` will try to use the following Stackage snapshots in
3434
order of preference, using the first that is compatable: the most recent LTS

doc/commands/new_command.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ By default:
1919
skip such initialisation; and
2020

2121
* the project template is the one specified by the
22-
[default-template](yaml_configuration.md#default-template) option.
22+
[default-template](../configure/yaml/non-project.md#default-template) option.
2323

2424
A package name acceptable to Cabal comprises an alphanumeric 'word'; or two or
2525
more such words, with the words separated by a hyphen/minus character (`-`). A
@@ -49,8 +49,9 @@ These arguments are ignored if the `--no-init` flag is passed.
4949

5050
If a snapshot is specified at the command line and the project is initialised
5151
for use with Stack, `stack new` will try to use it. For further information, see
52-
the documentation for the [`--snapshot`](global_flags.md#-snapshot-option) and
53-
[`--resolver`](global_flags.md#-resolver-option) options.
52+
the documentation for the
53+
[`--snapshot`](../configre/global_flags.md#-snapshot-option) and
54+
[`--resolver`](../configure/global_flags.md#-resolver-option) options.
5455

5556
## Project templates
5657

doc/commands/script_command.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,9 @@ Non-project level configuration options in global configuration files
2121
!!! info
2222

2323
Non-project level configuration options may be useful if
24-
[`allow-newer`](yaml_configuration.md#allow-newer) and/or
25-
[`allow-newer-deps`](yaml_configuration.md#allow-newer-deps) are required.
24+
[`allow-newer`](../configure/yaml/non-project.md#allow-newer) and/or
25+
[`allow-newer-deps`](../configure/yaml/non-project.md#allow-newer-deps) are
26+
required.
2627

2728
## Project-level configuration file
2829

@@ -39,8 +40,8 @@ Stack root.
3940
## GHC
4041

4142
The `stack script` command behaves as if the
42-
[`--install-ghc`](global_flags.md#--no-install-ghc-flag) flag had been passed at
43-
the command line.
43+
[`--install-ghc`](../configure/global_flags.md#--no-install-ghc-flag) flag had
44+
been passed at the command line.
4445

4546
## Snapshot and extra-deps
4647

doc/commands/sdist_command.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ available modes for use with Cabal file revisions are `lower-revision`,
2727
`upper-revision` and `both-revision`.
2828

2929
For futher information, see the
30-
[YAML configuration](yaml_configuration.md#pvp-bounds) documentation.
30+
[YAML configuration](../configure/yaml/non-project.md#pvp-bounds) documentation.
3131

3232
## `--tar-dir` option
3333

doc/commands/setup_command.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,8 @@ Pass the option `--ghc-bindist <url>` to specify the URL of the GHC to be
2424
downloaded and installed. This option requires the use of the `--ghc-variant`
2525
option specifying a custom GHC variant. For further information about the
2626
`--ghc-variant` option, see the see the
27-
[YAML configuration](yaml_configuration.md#ghc-variant) documentation.
27+
[YAML configuration](../configure/yaml/non-project.md#ghc-variant)
28+
documentation.
2829

2930
If Stack is configured not to install GHC (`install-ghc: false` or passing the
3031
`--no-install-ghc` flag) then `stack setup` will warn that the flag and the

doc/commands/upgrade_command.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ When compiling from source code, by default:
7575
An earlier version of Stack could be inconsistent with some of the current
7676
contents of the Stack root. For further information about the contents of
7777
the Stack root and configuring its location, see the documentation about the
78-
[Stack root](stack_root.md).
78+
[Stack root](../topics/stack_root.md).
7979

8080
## Examples
8181

doc/commands/upload_command.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ available modes for use with Cabal file revisions are `lower-revision`,
5454
`upper-revision` and `both-revision`.
5555

5656
For futher information, see the
57-
[YAML configuration](yaml_configuration.md#pvp-bounds) documentation.
57+
[YAML configuration](../configure/yaml/non-project.md#pvp-bounds) documentation.
5858

5959
The `--tar-dir <path_to_directory>` option determines whether the package
6060
archive should be copied to the specified directory.

doc/configure/customisation_scripts.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,9 @@
88

99
On Unix-like operating systems and Windows, Stack's installation procedure can
1010
be fully customised by placing a `sh` shell script (a 'hook') in the
11-
[Stack root](stack_root.md) directory at `hooks/ghc-install.sh`. On Unix-like
12-
operating systems, the script file must be made executable. The script is run by
13-
the `sh` application (which is provided by MSYS2 on Windows).
11+
[Stack root](..topics/stack_root.md) directory at `hooks/ghc-install.sh`. On
12+
Unix-like operating systems, the script file must be made executable. The script
13+
is run by the `sh` application (which is provided by MSYS2 on Windows).
1414

1515
The script **must** return an exit code of `0` and the standard output **must**
1616
be the absolute path to the GHC binary that was installed. Otherwise Stack will

0 commit comments

Comments
 (0)