Skip to content

Commit 25c1c87

Browse files
nsajkoKristofferC
authored andcommitted
profile: doc: update the Allocs.@profile doc string (#53825)
(cherry picked from commit d963a34)
1 parent df60193 commit 25c1c87

File tree

1 file changed

+11
-12
lines changed

1 file changed

+11
-12
lines changed

stdlib/Profile/src/Allocs.jl

Lines changed: 11 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -54,18 +54,17 @@ julia> last(sort(results.allocs, by=x->x.size))
5454
Profile.Allocs.Alloc(Vector{Any}, Base.StackTraces.StackFrame[_new_array_ at array.c:127, ...], 5576)
5555
```
5656
57-
The best way to visualize these is currently with the
58-
[PProf.jl](https://github.com/JuliaPerf/PProf.jl) package,
59-
by invoking `PProf.Allocs.pprof`.
60-
61-
!!! note
62-
The current implementation of the Allocations Profiler does not
63-
capture types for all allocations. Allocations for which the profiler
64-
could not capture the type are represented as having type
65-
`Profile.Allocs.UnknownType`.
66-
67-
You can read more about the missing types and the plan to improve this, here:
68-
<https://github.com/JuliaLang/julia/issues/43688>.
57+
See the profiling tutorial in the Julia documentation for more information.
58+
59+
!!! compat "Julia 1.11"
60+
61+
Older versions of Julia could not capture types in all cases. In older versions of
62+
Julia, if you see an allocation of type `Profile.Allocs.UnknownType`, it means that
63+
the profiler doesn't know what type of object was allocated. This mainly happened when
64+
the allocation was coming from generated code produced by the compiler. See
65+
[issue #43688](https://github.com/JuliaLang/julia/issues/43688) for more info.
66+
67+
Since Julia 1.11, all allocations should have a type reported.
6968
7069
!!! compat "Julia 1.8"
7170
The allocation profiler was added in Julia 1.8.

0 commit comments

Comments
 (0)