Fix doc deployment, completely disable JET (#437)

The most important change is to update the `repo` in `deploydocs`,
which should have happened when I transferred the package.

Also:
- Improve printing a bit
- disable JET and its tutorial for now

Author: timholy

.github/workflows/ci.yml

@@ -49,8 +49,8 @@ jobs:
         with:
           coverage: false    # FIXME: this is very sad, but coverage changes the snoop_inference.jl/Stale tests (as of Julia 1.13.0-DEV.1058)
       - run: julia  --check-bounds=yes --project -e 'using Pkg; Pkg.test(; test_args=["cthulhu"], coverage=false)'
-      - run: julia  --check-bounds=yes --project -e 'using Pkg; Pkg.test(; test_args=["jet"], coverage=false)'
-        continue-on-error: true   # JET test is non-fatal
+      # - run: julia  --check-bounds=yes --project -e 'using Pkg; Pkg.test(; test_args=["jet"], coverage=false)'
+      #   continue-on-error: true   # JET test is non-fatal
       # - uses: julia-actions/julia-processcoverage@v1
       #   with:
       #     directories: src,SnoopCompileCore/src

Project.toml

@@ -18,15 +18,15 @@ YAML = "ddb6d928-2868-570f-bddf-ab3f9cf99eb6"
 
 [weakdeps]
 Cthulhu = "f68482b8-f384-11e8-15f7-abe071a5a75f"
-JET = "c3a54625-cd67-489e-a8e7-0a5a0ff4e31b"
+# JET = "c3a54625-cd67-489e-a8e7-0a5a0ff4e31b"
 PyPlot = "d330b81b-6aea-500a-939a-2ce795aea3ee"
 
 [sources]
 SnoopCompileCore = {path = "SnoopCompileCore"}
 
 [extensions]
 CthulhuExt = "Cthulhu"
-JETExt = ["JET", "Cthulhu"]
+# JETExt = ["JET", "Cthulhu"]
 SCPrettyTablesExt = "PrettyTables"
 SCPyPlotExt = "PyPlot"
 
@@ -36,7 +36,7 @@ CodeTracking = "1.3.9, 2"
 Cthulhu = "2.17.6"
 FlameGraphs = "1"
 InteractiveUtils = "1"
-JET = "0.9, 0.10"
+# JET = "0.9, 0.10"
 MethodAnalysis = "1"
 OrderedCollections = "1"
 Pkg = "1"
@@ -55,7 +55,7 @@ julia = "1.12"
 [extras]
 Cthulhu = "f68482b8-f384-11e8-15f7-abe071a5a75f"
 Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
-JET = "c3a54625-cd67-489e-a8e7-0a5a0ff4e31b"
+# JET = "c3a54625-cd67-489e-a8e7-0a5a0ff4e31b"
 MethodAnalysis = "85b6ec6f-f7df-4429-9514-a64bcd9ee824"
 Pkg = "44cfe95a-1eb2-52ea-b672-e2afdf69b78f"
 PrettyTables = "08abe8d2-0d0c-5749-adfa-8a2ac140af0d"
@@ -64,4 +64,5 @@ Random = "9a3f8284-a2c9-5f02-9a11-845980a1fd5c"
 Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
 
 [targets]
-test = ["Cthulhu", "PrettyTables", "Documenter", "JET", "MethodAnalysis", "Pkg", "Random", "REPL", "Test"]
+# test = ["Cthulhu", "PrettyTables", "Documenter", "JET", "MethodAnalysis", "Pkg", "Random", "REPL", "Test"]
+test = ["Cthulhu", "PrettyTables", "Documenter", "MethodAnalysis", "Pkg", "Random", "REPL", "Test"]

docs/Project.toml

@@ -2,17 +2,21 @@
 AbstractTrees = "1520ce14-60c1-5f80-bbc7-55ef81b5835c"
 Cthulhu = "f68482b8-f384-11e8-15f7-abe071a5a75f"
 Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
-JET = "c3a54625-cd67-489e-a8e7-0a5a0ff4e31b"
+# JET = "c3a54625-cd67-489e-a8e7-0a5a0ff4e31b"
 MethodAnalysis = "85b6ec6f-f7df-4429-9514-a64bcd9ee824"
 PyPlot = "d330b81b-6aea-500a-939a-2ce795aea3ee"
 SnoopCompile = "aa65fe97-06da-5843-b5b1-d5d13cad87d2"
 SnoopCompileCore = "e2b509da-e806-4183-be48-004708413034"
 
+[sources]
+SnoopCompile = {path = ".."}
+SnoopCompileCore = {path = "../SnoopCompileCore"}
+
 [compat]
 AbstractTrees = "0.4"
 Cthulhu = "2"
 Documenter = "1"
-JET = "0.9"
+# JET = "0.9"
 MethodAnalysis = "0.4"
 PyPlot = "2"
 SnoopCompile = "3"

docs/make.jl

@@ -13,14 +13,14 @@ makedocs(
     # doctest = :fix,
     warnonly=true,    # delete when https://github.com/JuliaDocs/Documenter.jl/issues/2541 is fixed
     pages = ["index.md",
-             "Basic tutorials" => ["tutorials/invalidations.md", "tutorials/snoop_inference.md", "tutorials/snoop_llvm.md", "tutorials/pgdsgui.md", "tutorials/jet.md"],
+             "Basic tutorials" => ["tutorials/invalidations.md", "tutorials/snoop_inference.md", "tutorials/snoop_llvm.md", "tutorials/pgdsgui.md", #="tutorials/jet.md"=#],   # FIXME re-enable jet tutorial when JET supports 1.12
              "Advanced tutorials" => ["tutorials/snoop_inference_analysis.md", "tutorials/snoop_inference_parcel.md"],
              "Explanations" => ["explanations/tools.md", "explanations/gotchas.md", "explanations/fixing_inference.md", "explanations/invalidation_classes.md", "explanations/devs.md"],
              "reference.md",
-    ]
+    ],
 )
 
 deploydocs(
-    repo = "github.com/timholy/SnoopCompile.jl.git",
+    repo = "github.com/JuliaDebug/SnoopCompile.jl.git",
     push_preview=true
 )

docs/src/tutorials/snoop_inference.md

@@ -38,7 +38,7 @@ end
 
 # output
 
-FlattenDemo
+Main.var"Main".FlattenDemo
 ```
 
 The main call, `packintype`, stores the input in a `struct`, and then calls functions that extract the field value and performs arithmetic on the result.
@@ -55,7 +55,7 @@ julia> tinf = @snoop_inference FlattenDemo.packintype(1);
 julia> using SnoopCompile
 
 julia> tinf
-InferenceTimingNode: 0.002712/0.003278 on Core.Compiler.Timings.ROOT() with 1 direct children
+InferenceTimingNode: 0.000010/0.002443 on MethodInstance for Base.Compiler.Timings.ROOT() with 1 direct children
 ```
 
 !!! tip
@@ -80,7 +80,7 @@ If you do have a lot of invalidations, [`precompile_blockers`](@ref) may be an e
 
 Let's start unpacking the output of `@snoop_inference` and see how to get more insight.
 First, notice that the output is an `InferenceTimingNode`: it's the root element of a tree of such nodes, all connected by caller-callee relationships.
-Indeed, this particular node is for `Core.Compiler.Timings.ROOT()`, a "dummy" node that is the root of all such trees.
+Indeed, this particular node is for `Base.Compiler.Timings.ROOT()`, a "dummy" node that is the root of all such trees.
 
 You may have noticed that this `ROOT` node prints with two numbers.
 It will be easier to understand their meaning if we first display the whole tree.
@@ -90,14 +90,13 @@ We can do that with the [AbstractTrees](https://github.com/JuliaCollections/Abst
 julia> using AbstractTrees
 
 julia> print_tree(tinf, maxdepth=100)
-InferenceTimingNode: 0.002712/0.003278 on Core.Compiler.Timings.ROOT() with 1 direct children
-└─ InferenceTimingNode: 0.000133/0.000566 on FlattenDemo.packintype(::Int64) with 2 direct children
-   ├─ InferenceTimingNode: 0.000094/0.000094 on FlattenDemo.MyType{Int64}(::Int64) with 0 direct children
-   └─ InferenceTimingNode: 0.000089/0.000339 on FlattenDemo.dostuff(::FlattenDemo.MyType{Int64}) with 2 direct children
-      ├─ InferenceTimingNode: 0.000064/0.000122 on FlattenDemo.extract(::FlattenDemo.MyType{Int64}) with 2 direct children
-      │  ├─ InferenceTimingNode: 0.000034/0.000034 on getproperty(::FlattenDemo.MyType{Int64}, ::Symbol) with 0 direct children
-      │  └─ InferenceTimingNode: 0.000024/0.000024 on getproperty(::FlattenDemo.MyType{Int64}, x::Symbol) with 0 direct children
-      └─ InferenceTimingNode: 0.000127/0.000127 on FlattenDemo.domath(::Int64) with 0 direct children
+InferenceTimingNode: 0.000010/0.002443 on MethodInstance for Base.Compiler.Timings.ROOT() with 1 direct children
+└─ InferenceTimingNode: 0.001744/0.002433 on MethodInstance for Main.var"Main".FlattenDemo.packintype(::Int64) with 2 direct children
+   ├─ InferenceTimingNode: 0.000067/0.000070 on MethodInstance for MyType{Int64}(::Int64) with 0 direct children
+   └─ InferenceTimingNode: 0.000140/0.000415 on MethodInstance for Main.var"Main".FlattenDemo.dostuff(::MyType{Int64}) with 2 direct children
+      ├─ InferenceTimingNode: 0.000090/0.000124 on MethodInstance for Main.var"Main".FlattenDemo.extract(::MyType{Int64}) with 1 direct children
+      │  └─ InferenceTimingNode: 0.000027/0.000027 on MethodInstance for getproperty(::MyType{Int64}, ::Symbol) with 0 direct children
+      └─ InferenceTimingNode: 0.000073/0.000073 on MethodInstance for Main.var"Main".FlattenDemo.domath(::Int64) with 0 direct children
 ```
 
 This tree structure reveals the caller-callee relationships, showing the specific types that were used for each `MethodInstance`.
@@ -112,10 +111,10 @@ You can extract the `MethodInstance` with
 
 ```jldoctest flatten-demo
 julia> Core.MethodInstance(tinf)
-MethodInstance for Core.Compiler.Timings.ROOT()
+MethodInstance for Base.Compiler.Timings.ROOT()
 
 julia> Core.MethodInstance(tinf.children[1])
-MethodInstance for FlattenDemo.packintype(::Int64)
+MethodInstance for Main.var"Main".FlattenDemo.packintype(::Int64)
 ```
 
 Each node in this tree is accompanied by a pair of numbers.

docs/src/tutorials/jet.md docs/src_disabled/jet.mddocs/src/tutorials/jet.md renamed to docs/src_disabled/jet.md

@@ -50,7 +50,7 @@ julia> mapfib(list) = map(fib, list)
 mapfib (generic function with 1 method)
 
 julia> tinf = @snoop_inference try mapfib(list) catch end
-InferenceTimingNode: 0.049825/0.071476 on Core.Compiler.Timings.ROOT() with 5 direct children
+InferenceTimingNode: 0.049825/0.071476 on Base.Compiler.Timings.ROOT() with 5 direct children
 
 julia> @report_call mapfib(list)
 No errors detected

ext/JETExt.jl

@@ -47,17 +47,18 @@ lookups_key(ip) = ip
 lookups_key(ip::Ptr{Nothing}) = UInt(ip)
 
 _showtiming(io, node) = print(io, @sprintf("%8.6f", exclusive(node)), "/", @sprintf("%8.6f", inclusive(node)), " on ")
+showmi(io, mi::MethodInstance) = print(io, replace(sprint(show, mi), "MethodInstance for " => ""))
 function Base.show(io::IO, node::InferenceTiming)
     print(io, "InferenceTiming: ")
     _showtiming(io, node)
-    show(io, MethodInstance(node))
+    showmi(io, MethodInstance(node))
 end
 
 # This should be in SnoopCompileCore, except that it promises not to specialize Base methods to avoid invalidating other code
 function Base.show(io::IO, node::InferenceTimingNode)
     print(io, "InferenceTimingNode: ")
     _showtiming(io, node)
-    show(io, MethodInstance(node))
+    showmi(io, MethodInstance(node))
     print(io, " with ", string(length(node.children)), " direct children")
 end
 
@@ -76,10 +77,10 @@ We'll use [`SnoopCompile.flatten_demo`](@ref), which runs `@snoop_inference` on
 
 ```jldoctest flatten; setup=:(using SnoopCompile), filter=r"([0-9]*\\.?[0-9]+([eE][-+]?[0-9]+)?/[0-9]*\\.?[0-9]+([eE][-+]?[0-9]+)?|WARNING: replacing module FlattenDemo\\.\\n)"
 julia> tinf = SnoopCompile.flatten_demo()
-InferenceTimingNode: 0.002148974/0.002767166 on Core.Compiler.Timings.ROOT() with 1 direct children
+InferenceTimingNode: 0.002148974/0.002767166 on Base.Compiler.Timings.ROOT() with 1 direct children
 
 julia> using AbstractTrees; print_tree(tinf)
-InferenceTimingNode: 0.00242354/0.00303526 on Core.Compiler.Timings.ROOT() with 1 direct children
+InferenceTimingNode: 0.00242354/0.00303526 on Base.Compiler.Timings.ROOT() with 1 direct children
 └─ InferenceTimingNode: 0.000150891/0.000611721 on SnoopCompile.FlattenDemo.packintype(::$Int) with 2 direct children
    ├─ InferenceTimingNode: 0.000105318/0.000105318 on SnoopCompile.FlattenDemo.MyType{$Int}(::$Int) with 0 direct children
    └─ InferenceTimingNode: 9.43e-5/0.000355512 on SnoopCompile.FlattenDemo.dostuff(::SnoopCompile.FlattenDemo.MyType{$Int}) with 2 direct children
@@ -95,8 +96,8 @@ that `getproperty` was inferred with. This reflects constant-propagation in infe
 Then:
 ```jldoctest flatten; setup=:(using SnoopCompile), filter=[r"[0-9]*\\.?[0-9]+([eE][-+]?[0-9]+)?/[0-9]*\\.?[0-9]+([eE][-+]?[0-9]+)?", r"WARNING: replacing module FlattenDemo.*"]
 julia> flatten(tinf; sortby=nothing)
-8-element Vector{SnoopCompileCore.InferenceTiming}:
- InferenceTiming: 0.002423543/0.0030352639999999998 on Core.Compiler.Timings.ROOT()
+8-element Vector{InferenceTiming}:
+ InferenceTiming: 0.002423543/0.0030352639999999998 on Base.Compiler.Timings.ROOT()
  InferenceTiming: 0.000150891/0.0006117210000000001 on SnoopCompile.FlattenDemo.packintype(::$Int)
  InferenceTiming: 0.000105318/0.000105318 on SnoopCompile.FlattenDemo.MyType{$Int}(::$Int)
  InferenceTiming: 9.43e-5/0.00035551200000000005 on SnoopCompile.FlattenDemo.dostuff(::SnoopCompile.FlattenDemo.MyType{$Int})
@@ -108,20 +109,20 @@ julia> flatten(tinf; sortby=nothing)
 
 ```
 julia> flatten(tinf; tmin=1e-4)                        # sorts by exclusive time (the time before the '/')
-4-element Vector{SnoopCompileCore.InferenceTiming}:
+4-element Vector{InferenceTiming}:
  InferenceTiming: 0.000105318/0.000105318 on SnoopCompile.FlattenDemo.MyType{$Int}(::$Int)
  InferenceTiming: 0.000136496/0.000136496 on SnoopCompile.FlattenDemo.domath(::$Int)
  InferenceTiming: 0.000150891/0.0006117210000000001 on SnoopCompile.FlattenDemo.packintype(::$Int)
- InferenceTiming: 0.002423543/0.0030352639999999998 on Core.Compiler.Timings.ROOT()
+ InferenceTiming: 0.002423543/0.0030352639999999998 on Base.Compiler.Timings.ROOT()
 
 julia> flatten(tinf; sortby=inclusive, tmin=1e-4)      # sorts by inclusive time (the time after the '/')
-6-element Vector{SnoopCompileCore.InferenceTiming}:
+6-element Vector{InferenceTiming}:
  InferenceTiming: 0.000105318/0.000105318 on SnoopCompile.FlattenDemo.MyType{$Int}(::$Int)
  InferenceTiming: 6.6458e-5/0.000124716 on SnoopCompile.FlattenDemo.extract(::SnoopCompile.FlattenDemo.MyType{$Int})
  InferenceTiming: 0.000136496/0.000136496 on SnoopCompile.FlattenDemo.domath(::$Int)
  InferenceTiming: 9.43e-5/0.00035551200000000005 on SnoopCompile.FlattenDemo.dostuff(::SnoopCompile.FlattenDemo.MyType{$Int})
  InferenceTiming: 0.000150891/0.0006117210000000001 on SnoopCompile.FlattenDemo.packintype(::$Int)
- InferenceTiming: 0.002423543/0.0030352639999999998 on Core.Compiler.Timings.ROOT()
+ InferenceTiming: 0.002423543/0.0030352639999999998 on Base.Compiler.Timings.ROOT()
 ```
 
 As you can see, `sortby` affects not just the order but also the selection of frames; with exclusive times, `dostuff` did
@@ -162,7 +163,7 @@ We'll use [`SnoopCompile.flatten_demo`](@ref), which runs `@snoop_inference` on
 
 ```jldoctest accum1; setup=:(using SnoopCompile), filter=[r"(in|@)", r"([0-9]*\\.?[0-9]+([eE][-+]?[0-9]+)?|:[0-9]+\\)|at .*/inference_demos.jl:\\d+|at Base\\.jl:\\d+|at compiler/typeinfer\\.jl:\\d+|WARNING: replacing module FlattenDemo\\.\\n)"]
 julia> tinf = SnoopCompile.flatten_demo()
-InferenceTimingNode: 0.004978/0.005447 on Core.Compiler.Timings.ROOT() with 1 direct children
+InferenceTimingNode: 0.004978/0.005447 on Base.Compiler.Timings.ROOT() with 1 direct children
 
 julia> accumulate_by_source(flatten(tinf))
 7-element Vector{Tuple{Float64, Union{Method, Core.MethodInstance}}}:
@@ -306,14 +307,14 @@ main purpose of PrecompileTools.)
 julia> module A
        a(x) = x
        end
-Main.A
+A
 
 julia> module B
        using ..A
        struct BType end    # this type is not known to A
        b(x) = x
        end
-Main.B
+B
 ```
 
 Now let's run these methods to generate some compiled `MethodInstance`s:
@@ -323,23 +324,23 @@ julia> A.a(3.2)          # Float64 is not "owned" by A, but A loads Base so A kn
 3.2
 
 julia> A.a(B.BType())    # B.BType is not known to A
-Main.B.BType()
+B.BType()
 
 julia> B.b(B.BType())    # B knows about B.BType
-Main.B.BType()
+B.BType()
 
 julia> mia1, mia2 = Base.specializations(only(methods(A.a)));
 
 julia> @show mia1 SnoopCompile.isprecompilable(mia1);
-mia1 = MethodInstance for Main.A.a(::Float64)
+mia1 = MethodInstance for A.a(::Float64)
 SnoopCompile.isprecompilable(mia1) = true
 
 julia> @show mia2 SnoopCompile.isprecompilable(mia2);
-mia2 = MethodInstance for Main.A.a(::Main.B.BType)
+mia2 = MethodInstance for A.a(::B.BType)
 SnoopCompile.isprecompilable(mia2) = false
 
 julia> mib = only(Base.specializations(only(methods(B.b))))
-MethodInstance for Main.B.b(::Main.B.BType)
+MethodInstance for B.b(::B.BType)
 
 julia> SnoopCompile.isprecompilable(mib)
 true
@@ -454,7 +455,7 @@ We'll use [`SnoopCompile.itrigs_demo`](@ref), which runs `@snoop_inference` on a
 
 ```jldoctest parceltree; setup=:(using SnoopCompile), filter=r"([0-9]*\\.?[0-9]+([eE][-+]?[0-9]+)?|WARNING: replacing module ItrigDemo\\.\\n|UInt8|Float64|SnoopCompile\\.ItrigDemo\\.)"
 julia> tinf = SnoopCompile.itrigs_demo()
-InferenceTimingNode: 0.004490576/0.004711168 on Core.Compiler.Timings.ROOT() with 2 direct children
+InferenceTimingNode: 0.004490576/0.004711168 on Base.Compiler.Timings.ROOT() with 2 direct children
 
 julia> ttot, pcs = SnoopCompile.parcel(tinf);
 
@@ -808,7 +809,7 @@ We'll use [`SnoopCompile.itrigs_demo`](@ref), which runs `@snoop_inference` on a
 
 ```jldoctest triggers; setup=:(using SnoopCompile), filter=r"([0-9]*\\.?[0-9]+([eE][-+]?[0-9]+)?|.*/inference_demos\\.jl:\\d+|WARNING: replacing module ItrigDemo\\.\\n)"
 julia> tinf = SnoopCompile.itrigs_demo()
-InferenceTimingNode: 0.004490576/0.004711168 on Core.Compiler.Timings.ROOT() with 2 direct children
+InferenceTimingNode: 0.004490576/0.004711168 on Base.Compiler.Timings.ROOT() with 2 direct children
 
 julia> itrigs = inference_triggers(tinf)
 2-element Vector{InferenceTrigger}:
@@ -1822,7 +1823,7 @@ a workload designed to yield reproducible results:
 
 ```jldoctest flamegraph; setup=:(using SnoopCompile), filter=r"([0-9]*\\.?[0-9]+([eE][-+]?[0-9]+)?/[0-9]*\\.?[0-9]+([eE][-+]?[0-9]+)?|at.*typeinfer\\.jl:\\d+|0:\\d+|WARNING: replacing module FlattenDemo\\.\\n)"
 julia> tinf = SnoopCompile.flatten_demo()
-InferenceTimingNode: 0.002148974/0.002767166 on Core.Compiler.Timings.ROOT() with 1 direct children
+InferenceTimingNode: 0.002148974/0.002767166 on Base.Compiler.Timings.ROOT() with 1 direct children
 
 julia> fg = flamegraph(tinf)
 Node(FlameGraphs.NodeData(ROOT() at typeinfer.jl:75, 0x00, 0:3334431))