Skip to content

Commit c2f0535

Browse files
authored
Clarify generation of LocalPreferences.toml (#2535)
[only docs]
1 parent 2693a72 commit c2f0535

File tree

1 file changed

+11
-11
lines changed

1 file changed

+11
-11
lines changed

docs/src/installation/overview.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -147,7 +147,15 @@ julia> CUDA.set_runtime_version!(local_toolkit=true)
147147
[ Info: Set CUDA.jl toolkit preference to use CUDA from the local system, please re-start Julia for this to take effect.
148148
```
149149

150-
After re-launching Julia:
150+
Calling `CUDA.set_runtime_version!(local_toolkit=true)` generates the following `LocalPreferences.toml` file in
151+
your active environment:
152+
153+
```
154+
[CUDA_Runtime_jll]
155+
local = "true"
156+
```
157+
158+
so that after re-launching Julia:
151159

152160
```
153161
julia> using CUDA
@@ -157,17 +165,9 @@ CUDA runtime 11.8, local installation
157165
...
158166
```
159167

160-
Calling the above helper function generates the following `LocalPreferences.toml` file in
161-
your active environment:
162-
163-
```
164-
[CUDA_Runtime_jll]
165-
local = "true"
166-
```
167-
168-
This preference not only configures CUDA.jl to use a local toolkit, it also prevents
168+
The preference `local = "true"` under `CUDA_Runtime_jll` not only configures CUDA.jl to use a local toolkit, it also prevents
169169
downloading any artifact, so it may be interesting to set this preference before ever
170-
importing CUDA.jl (e.g., by putting this preference file in a system-wide depot).
170+
importing CUDA.jl (e.g., by putting a `LocalPreferences.toml` file in a system-wide depot).
171171

172172
If CUDA.jl doesn't properly detect your local toolkit, it may be that certain libraries or
173173
binaries aren't on a globally-discoverable path. For more information, run Julia with the

0 commit comments

Comments
 (0)