Skip to content

Commit 29e9be6

Browse files
committed
Further extend documentation of stack ghci
1 parent bc418bc commit 29e9be6

File tree

1 file changed

+23
-10
lines changed

1 file changed

+23
-10
lines changed

doc/ghci.md

+23-10
Original file line numberDiff line numberDiff line change
@@ -58,9 +58,31 @@ By default:
5858
option with a file path to the executable to specify a different GHC
5959
executable;
6060

61+
* Stack performs an inital build step. Pass the `--no-build` flag to skip the
62+
step. Pass the `--ghc-options` option to pass flags or options to GHC. Pass
63+
the `--profile`, `--no-strip`, `--trace` flags for the same behaviour as in
64+
the case of the `stack build` command.
65+
66+
!!! info
67+
68+
Not performing the initial build step speeds up the startup of GHCi. It
69+
only works if the dependencies of the loaded packages have already been
70+
built.
71+
72+
* Stack runs GHCi via `ghc --interactive`. Pass the `--ghc-options` option to
73+
pass flags or options to GHC (during the initial build step) and to GHCi.
74+
Pass the `--pedantic` flag to pass the GHC options `-Wall` and `-Werror` to
75+
GHCi (only). Pass the `--ghci-options` option to pass flags or options to
76+
GHCi (only).
77+
78+
* Stack does not configure GHCi to hide unnecessary packages, unless there are
79+
no packages to expose. Pass the `--package-hiding` flag to hide unnecessary
80+
packages or `--no-package-hiding` flag not to hide unnecessary packages.
81+
6182
* Stack loads and imports all of the modules for each target. Pass the
6283
`--no-load` flag to skip the loading of modules. Pass the `--only-main` flag
63-
to skip the loading of modules other than the main module.
84+
to skip the loading of modules other than the main module. Pass the
85+
`--load-local-deps` flag to include all local dependencies of targets.
6486

6587
!!! info
6688

@@ -85,15 +107,6 @@ By default:
85107
to select one from a list of options. Pass the `--main-is <target>` option
86108
to specific which `Main` module to load.
87109

88-
* Stack performs an inital build step. Pass the `--no-build` flag to skip the
89-
step.
90-
91-
!!! info
92-
93-
Not performing the initial build step speeds up the startup of GHCi. It
94-
only works if the dependencies of the loaded packages have already been
95-
built.
96-
97110
Stack combines all of the GHC options of components.
98111

99112
!!! note

0 commit comments

Comments
 (0)