Skip to content

Commit 2a5e711

Browse files
authored
Rephrase the ExecutableProduct documentation (#1373)
Emphasize more strongly that the first form should be preferred, the second form is only there for people who really must support Julia before 1.6.
1 parent 44cfc61 commit 2a5e711

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

docs/src/jll.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -166,14 +166,17 @@ defines the following variables:
166166

167167
An [`ExecutableProduct`](@ref) is a binary executable that can be run on the
168168
current platform. If, for example, the `ExecutableProduct` has been called
169-
`mungify_exe`, the wrapper defines an exported function named `mungify_exe` that
170-
should run by the user in one the following ways:
169+
`mungify_exe`, the wrapper defines an exported function named `mungify_exe`.
170+
To run that the recommended way is the following:
171171

172172
```julia
173-
# Only available in Julia v1.6+
174173
run(`$(mungify_exe()) $arguments`)
175174
```
176175

176+
However, this is only available in Julia v1.6 and later. If you really must
177+
support older Julia versions, you can also use the following syntax, which
178+
however is not thread-safe and generally less flexible.
179+
177180
```julia
178181
mungify_exe() do exe
179182
run(`$exe $arguments`)
@@ -187,9 +190,6 @@ syntax you are defining the name of the variable that will be used to actually
187190
call the binary with
188191
[`run`](https://docs.julialang.org/en/v1/base/base/#Base.run).
189192

190-
The former form is only available when using Julia v1.6, but should be
191-
preferred going forward, as it is thread-safe and generally more flexible.
192-
193193
A common point of confusion about `ExecutableProduct`s in JLL packages is why
194194
these function wrappers are needed: while in principle you could run the
195195
executable directly by using its absolute path in `run`, these functions ensure

0 commit comments

Comments
 (0)