Skip to content

Commit bddfae2

Browse files
committed
Add preferences documentation
1 parent c118075 commit bddfae2

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

docs/src/index.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,3 +12,9 @@ Documentation for [HostCPUFeatures](https://github.com/JuliaSIMD/HostCPUFeatures
1212
```@autodocs
1313
Modules = [HostCPUFeatures]
1414
```
15+
16+
## Supported Preferences
17+
18+
- `cpu_target`: if provided, use this string as your CPU target for feature detection instead of `JULIA_CPU_TARGET`
19+
- `freeze_cpu_target`: if `true`, "freeze" the features detected based on your precompile-time CPU target and do not perform runtime feature detection
20+
- `allow_runtime_invalidation`: if `false`, warn when performing runtime feature detection (instead of invalidating) when CPU features don't match precompile-time

0 commit comments

Comments
 (0)