Skip to content

Commit a26f75e

Browse files
authored
Update documentation to latest SnoopCompile names (#43)
* Rename snoopi_deep -> snoop_inference, snoopr -> snoop_invalidations
1 parent c76eea0 commit a26f75e

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

docs/src/index.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -71,8 +71,8 @@ using the same workload you put inside the `@compile_workload` block.
7171

7272
If you're happy with the results, you're done! If you want deeper verification of whether it worked as
7373
expected, or if you suspect problems, the [SnoopCompile package](https://github.com/timholy/SnoopCompile.jl) provides diagnostic tools.
74-
Potential sources of trouble include invalidation (diagnosed with `SnoopCompileCore.@snoopr` and related tools)
75-
and omission of intended calls from inside the `@compile_workload` block (diagnosed with `SnoopCompileCore.@snoopi_deep` and related tools).
74+
Potential sources of trouble include invalidation (diagnosed with `SnoopCompileCore.@snoop_invalidations` and related tools)
75+
and omission of intended calls from inside the `@compile_workload` block (diagnosed with `SnoopCompileCore.@snoop_inference` and related tools).
7676

7777
!!! note
7878
`@compile_workload` works by monitoring type-inference. If the code was already inferred
@@ -81,7 +81,7 @@ and omission of intended calls from inside the `@compile_workload` block (diagno
8181

8282
You can use multiple `@compile_workload` blocks if you need to interleave `@setup_workload` code with
8383
code that you want precompiled.
84-
You can use `@snoopi_deep` to check for any (re)inference when you use the code in your package.
84+
You can use `@snoop_inference` to check for any (re)inference when you use the code in your package.
8585
To fix any specific problems, you can combine `@compile_workload` with manual `precompile` directives.
8686

8787
## Tutorial: local "Startup" packages
@@ -226,7 +226,7 @@ In that case, your best option is to fall back on Julia's own `precompile` funct
226226
However, as explained in [How PrecompileTools works](@ref), there are some differences between `precompile` and `@compile_workload`;
227227
most likely, you may need multiple `precompile` directives.
228228
Analysis with [SnoopCompile](https://github.com/timholy/SnoopCompile.jl) may be required to obtain the results you want;
229-
in particular, combining `@snoopi_deep` and `parcel` will allow you to generate a set of `precompile` directives that can be `include`d in your module definition.
229+
in particular, combining `@snoop_inference` and `parcel` will allow you to generate a set of `precompile` directives that can be `include`d in your module definition.
230230

231231
Be aware that `precompile` directives are more specific to the Julia version, CPU (integer width), and OS than running a workload.
232232

0 commit comments

Comments
 (0)