Skip to content

Commit 2422747

Browse files
authored
Merge pull request #316 from smoors/optarch
update optarch usage for EB 5
2 parents 07cb934 + 8cc9a6c commit 2422747

File tree

1 file changed

+5
-12
lines changed

1 file changed

+5
-12
lines changed

docs/controlling-compiler-optimization-flags.md

+5-12
Original file line numberDiff line numberDiff line change
@@ -76,22 +76,17 @@ should use, rather than the ones used by default (depending on the compiler in t
7676
Like any other configuration setting, this can also be specified via `$EASYBUILD_OPTARCH`, or by defining `optarch`
7777
in an EasyBuild configuration file (cfr. [Consistency across supported configuration types][configuration_consistency]).
7878

79-
For example, by specifying `--optarch=march=core2`, EasyBuild will use `-march=core2` rather than the default
79+
For example, by specifying `--optarch=-march=core2`, EasyBuild will use `-march=core2` rather than the default
8080
flag `--march=native` (when using GCC compilers).
8181

8282
Likewise, to avoid using the default `-xHost` flag with the Intel compilers and using `-xSSSE3` instead,
83-
you can define `$EASYBUILD_OPTARCH` to be equal to `xSSSE3`.
84-
85-
!!! note
86-
The first dash (`-`) is added automagically to the value specified to `--optarch`,
87-
because of technicalities with the current implementation.
83+
you can define `$EASYBUILD_OPTARCH` to be equal to `-xSSSE3`.
8884

8985
The `--optarch` configuration option gives you flexibility to define the specific target architecture optimization
9086
flags you want, but requires that you take care of specifying different flags for different compilers and choose
9187
the right flags depending on your specific processor architecture.
9288

9389

94-
9590
### Optimizing for a generic processor architecture via `--optarch=GENERIC` {: #controlling_compiler_optimization_flags_optarch_generic }
9691

9792
To make EasyBuild optimize for a *generic* processor architecture, `--optarch` can be set to '`GENERIC`'.
@@ -121,16 +116,14 @@ compiler used on the packages to be installed.
121116

122117
The syntax is `<compiler:flags>;<compiler:flags>`, where `:` separates the compiler name from the compiler flags,
123118
and `;` separates different compilers. This is an example for the Intel and GCC compilers:
124-
`--optarch='Intel:xHost;GCC:march=x86-64 -mtune=generic'`. As in the simple cases, EasyBuild adds one `-` to the
125-
flags specified, so the flags passed to the Intel and GCC compilers in this case are `-xHost` and
126-
`-march=x86-64 -mtune=generic`. Please note the quotes to escape the space in the GCC flags.
119+
`--optarch='Intel:-xHost;GCC:-march=x86-64 -mtune=generic'`. Please note the quotes to escape the space in the GCC flags.
127120

128121
Additionally, `GENERIC` is also supported on a compiler basis, allowing to specify a generic compilation for the
129-
desired compilers. This is an example of this usage: `--optarch=Intel:xHost;GCC:GENERIC`. Of course, this is
122+
desired compilers. This is an example of this usage: `--optarch=Intel:-xHost;GCC:GENERIC`. Of course, this is
130123
supported just for compiler toolchains that recognize `GENERIC`.
131124

132125
The options for each compiler are set independently. That means that if a GCC-based toolchain is used, but the only
133-
compiler specified is `Intel` (for example with `--optarch=Intel:xCORE-AVX2`), then EasyBuild will behave as if
126+
compiler specified is `Intel` (for example with `--optarch=Intel:-xCORE-AVX2`), then EasyBuild will behave as if
134127
`--optarch` was not specified for this toolchain.
135128

136129
The compiler name corresponds to the value of the `COMPILER_FAMILY` constant of the toolchain. Two common examples

0 commit comments

Comments
 (0)