Skip to content

Commit e6683c0

Browse files
committed
Improve --local-bin-path documentation
1 parent 081261d commit e6683c0

File tree

2 files changed

+15
-5
lines changed

2 files changed

+15
-5
lines changed

doc/global_flags.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -107,10 +107,13 @@ corresponding non-project specific configuration
107107

108108
## `--local-bin-path` option
109109

110-
Pass the option `--local-bin-path <directory>` to specify the directory in which
111-
Stack installs executables. For further information, see the documentation for
112-
the corresponding non-project specific configuration
113-
[option](yaml_configuration.md#local-bin-path).
110+
Pass the option `--local-bin-path <directory>` to set the target directory for
111+
[`stack build --copy-bins`](build_command.md#-no-copy-bins-flag) and
112+
`stack install`. An absolute or relative path can be specified. A relative path
113+
at the command line is always assumed to be relative to the current directory.
114+
115+
For further information, see the documentation for the corresponding non-project
116+
specific configuration [option](yaml_configuration.md#local-bin-path).
114117

115118
## `--lock-file` option
116119

doc/yaml_configuration.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -918,7 +918,14 @@ Default (on Windows): `%APPDATA%\local\bin`
918918

919919
Command line equivalent (takes precedence): `--local-bin-path` option
920920

921-
Target directory for `stack install` and `stack build --copy-bins`.
921+
Specifies the target directory for
922+
[`stack build --copy-bins`](build_command.md#-no-copy-bins-flag) and
923+
`stack install`. An absolute or relative path can be specified.
924+
925+
If the project-level configuration is provided in the `global-project` directory
926+
in the Stack root, a relative path is assumed to be relative to the current
927+
directory. Otherwise, it is assumed to be relative to the directory of the
928+
project-level configuration file.
922929

923930
### local-programs-path
924931

0 commit comments

Comments
 (0)