Skip to content

Commit 343b437

Browse files
committed
Label semaphore feature as experimental
1 parent bac8a3d commit 343b437

File tree

3 files changed

+17
-6
lines changed

3 files changed

+17
-6
lines changed

ChangeLog.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,11 @@ Behavior changes:
1212

1313
Other enhancements:
1414

15-
* Add flag `--[no-]semaphore` (default: disabled) to Stack's `build` command,
16-
to allow GHC to use a system semaphore to perform compilation in parallel when
17-
possible. Supported, by default, by GHC 9.10.1 or later.
15+
* Experimental: Add flag `--[no-]semaphore` (default: disabled) to Stack's
16+
`build` command, to allow GHC to use a system semaphore to perform compilation
17+
in parallel when possible. Supported, by default, by GHC 9.10.1 or later. The
18+
option is considered experiemental because, on Linux only, musl and non-musl
19+
semaphores are incompatible.
1820

1921
Bug fixes:
2022

doc/commands/build_command.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -919,6 +919,8 @@ the [`stack path --local-install-root`](path_command.md) command.
919919

920920
### `--[no]-semaphore` flag
921921

922+
:octicons-beaker-24: Experimental
923+
922924
:octicons-tag-24: UNRELEASED
923925

924926
Default: Disabled
@@ -934,6 +936,13 @@ parallel when possible.
934936
Cabal 3.12.0.0 (a boot package of GHC 9.10.1) and later. The flag is ignored
935937
with a warning when the feature is unsupported.
936938

939+
!!! warning
940+
941+
On Linux, musl and non-musl system semaphores are incompatible. That means
942+
that a Stack executable built on Alpine Linux (such as the official Stack
943+
for Linux) creates system semaphores that cannot be used by a GHC executable
944+
built on non-musl Linux distributions.
945+
937946
### `--[no-]split-objs` flag
938947

939948
:octicons-beaker-24: Experimental

doc/configure/yaml/non-project.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -157,9 +157,9 @@ Default:
157157

158158
~~~yaml
159159
build:
160-
# Since Stack UNRELEASED. Supported by GHC 9.8.1 or later with Cabal 3.12.0.0
161-
# (a boot package of GHC 9.10.1) or later. Ignored with a warning when
162-
# unsupported.
160+
# Experimental. Since Stack UNRELEASED. Supported by GHC 9.8.1 or later with
161+
# Cabal 3.12.0.0 (a boot package of GHC 9.10.1) or later. Ignored with a
162+
# warning when unsupported.
163163
semaphore: false
164164

165165
library-profiling: false

0 commit comments

Comments
 (0)