Skip to content

Commit c5ae8b3

Browse files
committed
Re #6379 Improve arch option documentation
1 parent e534768 commit c5ae8b3

File tree

1 file changed

+19
-3
lines changed

1 file changed

+19
-3
lines changed

doc/yaml_configuration.md

+19-3
Original file line numberDiff line numberDiff line change
@@ -462,14 +462,30 @@ otherwise), and `targets` (all local packages that are targets).
462462

463463
Default: The machine architecture on which Stack is running.
464464

465-
Command line equivalent (takes precedence): `--arch` option
465+
Command line equivalent (takes precedence):
466+
[`--arch`](global_flags.md#-arch-option) option
466467

467468
Stack identifies different GHC executables by platform (operating system and
468469
machine architecture), (optional) GHC variant and (optional) GHC build.
469470
See [`setup-info`](#setup-info).
470471

471-
`arch` sets the machine architecture. Values are those recognized by Cabal,
472-
including `x86_64`, `i386` and `aarch64`.
472+
`arch` sets the machine architecture. Values can be those recognized by Cabal
473+
(the library) (which are case-insensitive and include `i386`, `x86_64`, and
474+
`aarch64` / `arm64`), or other values (which are case-sensitive and treated as
475+
an unknown 'other' architecture of the specified name).
476+
477+
!!! note
478+
479+
The machine architecture on which Stack is running is as classified by
480+
Cabal (the library). Cabal does not distinguish between certain
481+
architectures. Examples are `ppc64`/`powerpc64`/`powerpc64le` (classified as
482+
`ppc64`) and `arm`/`armel`/`armeb` (classified as `arm`).
483+
484+
!!! note
485+
486+
As Cabal (the library) does not distinguish between machine architectures
487+
`powerpc64` and `powerpc64le`, the latter can be specified in Stack's
488+
configuration as an 'other' architecture, such as `arch: ppc64le`.
473489

474490
### build
475491

0 commit comments

Comments
 (0)