Skip to content

Commit 5ec43ca

Browse files
committed
Re #4983 Add online documentation of hidden options
1 parent 31c0154 commit 5ec43ca

File tree

4 files changed

+39
-0
lines changed

4 files changed

+39
-0
lines changed

doc/build_command.md

+21
Original file line numberDiff line numberDiff line change
@@ -581,13 +581,19 @@ Default: Disabled
581581
Set the flag to enable executable profiling for TARGETs and all its
582582
dependencies.
583583

584+
The flag affects the location of the local project installation directory. See
585+
the [`stack path --local-install-root`](path_command.md) command.
586+
584587
### `--[no-]executable-stripping` flag
585588

586589
Default: Enabled
587590

588591
Unset the flag to disable executable stripping for TARGETs and all its
589592
dependencies.
590593

594+
The flag may affect the location of the local project installation directory.
595+
See the [`stack path --local-install-root`](path_command.md) command.
596+
591597
### `--fast` flag
592598

593599
GHC has many flags that specify individual optimisations of the compiler. GHC
@@ -636,13 +642,19 @@ Default: Disabled
636642

637643
Set the flag to enable library profiling for TARGETs and all its dependencies.
638644

645+
The flag affects the location of the local project installation directory. See
646+
the [`stack path --local-install-root`](path_command.md) command.
647+
639648
### `--[no-]library-stripping` flag
640649

641650
Default: Enabled
642651

643652
Unset the flag to disable library stripping for TARGETs and all its
644653
dependencies.
645654

655+
The flag may affect the location of the local project installation directory.
656+
See the [`stack path --local-install-root`](path_command.md) command.
657+
646658
### `--pedantic` flag
647659

648660
Pass the flag to build your project with the GHC options `-Wall` and `-Werror`.
@@ -654,6 +666,9 @@ Pass the flag to build your project with the GHC options `-Wall` and `-Werror`.
654666
Pass the flag to enable profiling in libraries, executables, etc. for all
655667
expressions, and generate a profiling report in tests or benchmarks.
656668

669+
The flag affects the location of the local project installation directory. See
670+
the [`stack path --local-install-root`](path_command.md) command.
671+
657672
### `--[no-]split-objs` flag
658673

659674
:octicons-beaker-24: Experimental
@@ -677,11 +692,17 @@ executables, etc. for all expressions, producing larger executables but allowing
677692
the use of standard debuggers/profiling tools/other utilities that use debugging
678693
symbols.
679694

695+
The flag affects the location of the local project installation directory. See
696+
the [`stack path --local-install-root`](path_command.md) command.
697+
680698
### `--trace` flag
681699

682700
Pass the flag to enable profiling in libraries, executables, etc. for all
683701
expressions, and generate a backtrace on exception.
684702

703+
The flag affects the location of the local project installation directory. See
704+
the [`stack path --local-install-root`](path_command.md) command.
705+
685706
## Flags affecting other tools' behaviour
686707

687708
### `--PROG-option` options

doc/config_command.md

+6
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,12 @@ for a Stack environment. Flags modify the script that is output:
3434
* `--[no-]keep-ghc-rts` (disabled by default) keep/discard any `GHCRTS`
3535
environment variable
3636

37+
The command also accepts flags and options of the
38+
[`stack build`](build_command.md#flags-affecting-ghcs-behaviour) command that
39+
affect the location of the local project installation directory, such as
40+
`--profile` and `--no-strip`. For further information, see the documentation of
41+
the [project Stack work directory](stack_work.md#project-stack-work-directory).
42+
3743
## The `stack config set` commands
3844

3945
~~~text

doc/exec_command.md

+6
Original file line numberDiff line numberDiff line change
@@ -64,3 +64,9 @@ command line arguments. For example, to pass `'a single quoted string'`:
6464

6565
The content of single quotes is taken literally. Within single quotes, `''`
6666
escapes a single quote.
67+
68+
The command also accepts flags and options of the
69+
[`stack build`](build_command.md#flags-affecting-ghcs-behaviour) command that
70+
affect the location of the local project installation directory, such as
71+
`--profile` and `--no-strip`. For further information, see the documentation of
72+
the [project Stack work directory](stack_work.md#project-stack-work-directory).

doc/path_command.md

+6
Original file line numberDiff line numberDiff line change
@@ -41,3 +41,9 @@ Pass the following flags for information about specific files or locations:
4141
|--snapshot-install-root|The root directory for snapshot installation. |
4242
|--snapshot-pkg-db |The snapshot package database. |
4343
|--stack-root |The Stack root. |
44+
45+
The command also accepts flags and options of the
46+
[`stack build`](build_command.md#flags-affecting-ghcs-behaviour) command that
47+
affect the location of the local project installation directory, such as
48+
`--profile` and `--no-strip`. For further information, see the documentation of
49+
the [project Stack work directory](stack_work.md#project-stack-work-directory).

0 commit comments

Comments
 (0)