Skip to content

Commit 1ab0823

Browse files
authored
Mention Preferences in installation docs (#192)
1 parent 43d1c1a commit 1ab0823

File tree

1 file changed

+7
-6
lines changed

1 file changed

+7
-6
lines changed

docs/src/index.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -15,11 +15,12 @@ Pkg.add("FFTW")
1515

1616
from the Julia REPL.
1717

18-
Users with a build of Julia based on Intel's Math Kernel Library (MKL) can take use MKL
19-
for FFTs by setting an environment variable `JULIA_FFTW_PROVIDER` to `MKL` and running
20-
`Pkg.build("FFTW")`.
21-
Setting this environment variable only needs to be done for the first build of the package;
22-
after that, the package will remember to use MKL when building and updating.
23-
Note however that MKL provides only a subset of the functionality provided by FFTW. See
18+
Users with a build of Julia based on Intel's Math Kernel Library (MKL) can use MKL
19+
for FFTs by setting a preference in their top-level project by either using the
20+
`FFTW.set_provider!()` method, or by directly setting the preference using
21+
[`Preferences.jl`](https://github.com/JuliaPackaging/Preferences.jl). Note that this
22+
choice will be recorded for the current project, and other projects that wish to use
23+
MKL for FFTs should also set that same preference.
24+
Note further that MKL provides only a subset of the functionality provided by FFTW. See
2425
Intel's [documentation](https://software.intel.com/en-us/mkl-developer-reference-c-using-fftw3-wrappers)
2526
for more information about potential differences or gaps in functionality.

0 commit comments

Comments
 (0)