Skip to content

Commit 8a79822

Browse files
authored
minor tweak on sysimg.md (#56183)
1 parent a98f371 commit 8a79822

File tree

1 file changed

+6
-4
lines changed

1 file changed

+6
-4
lines changed

doc/src/devdocs/sysimg.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -166,15 +166,17 @@ debug info, respectively, and so will make debugging more difficult.
166166
types are not known. All printing should use a specific IO object with a known type.
167167
The easiest substitution is to use `print(Core.stdout, x)` instead of `print(x)` or
168168
`print(stdout, x)`.
169-
- Use tools like `JET`, `Cthulhu`, and/or `SnoopCompile` to identify failures of type-inference, and
170-
follow our [Performance Tips](@ref) to fix them.
169+
- Use tools like [JET.jl](https://github.com/aviatesk/JET.jl),
170+
[Cthulhu.jl](https://github.com/JuliaDebug/Cthulhu.jl), and/or
171+
[SnoopCompile](https://github.com/timholy/SnoopCompile.jl)
172+
to identify failures of type-inference, and follow our [Performance Tips](@ref) to fix them.
171173

172174
### Compatibility concerns
173175

174176
We have identified many small changes to Base that significantly increase the set of programs
175177
that can be reliably trimmed. Unfortunately some of those changes would be considered breaking,
176178
and so are only applied when trimming is requested (this is done by an external build script,
177-
currently maintained inside the test suite as `test/trimming/buildscript.jl`).
179+
currently maintained inside the test suite as `contrib/juliac-buildscript.jl`).
178180
Therefore in many cases trimming will require you to opt in to new variants of Base and some
179181
standard libraries.
180182

@@ -187,7 +189,7 @@ with trimming as you develop it.
187189
Package authors may wish to test that their package is "trimming safe", however this is impossible
188190
in general. Trimming is only expected to work given concrete entry points such as `main()` and
189191
library entry points meant to be called from outside Julia. For generic packages, existing tests
190-
for type stability like `@inferred` and `JET` are about as close as you can get to checking
192+
for type stability like `@inferred` and `JET.@report_call` are about as close as you can get to checking
191193
trim compatibility.
192194

193195
Trimming also introduces new compatibility issues between minor versions of Julia. At this time,

0 commit comments

Comments
 (0)