Skip to content

Commit 991eb14

Browse files
authored
Merge pull request #166 from JuliaDebug/sp/update-readme
docs: add a note to load Infiltrator to readme
2 parents 0143746 + c8d1cb4 commit 991eb14

File tree

1 file changed

+5
-4
lines changed

1 file changed

+5
-4
lines changed

README.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -89,10 +89,11 @@ backing module to `Main` and therefore export the contents of the safehouse to t
8989
Using Infiltrator for debugging packages or scripts requires a little bit of setup.
9090

9191
1. Either your current environment or an environment futher down the [environment stack](https://docs.julialang.org/en/v1/manual/code-loading/#Environment-stacks) must contain Infiltrator.jl. I would recommend putting Infiltrator.jl into your global `@v1.xx` environment so that it is always available.
92-
2. Load [Revise.jl](https://github.com/timholy/Revise.jl) or use [VS Code's inline evaluation](https://www.julia-vscode.org/docs/stable/userguide/runningcode/) to seamlessly update your package code.
93-
3. Load your package.
94-
4. Add `Main.@infiltrate` statements as breakpoints wherever desired.
95-
5. Run a function that ends up executing the method containing the breakpoint.
92+
2. Load Infiltrator.jl with `using Infiltrator` in the REPL
93+
3. Load [Revise.jl](https://github.com/timholy/Revise.jl) or use [VS Code's inline evaluation](https://www.julia-vscode.org/docs/stable/userguide/runningcode/) to seamlessly update your package code.
94+
4. Load your package.
95+
5. Add `Main.@infiltrate` statements as breakpoints wherever desired.
96+
6. Run a function that ends up executing the method containing the breakpoint.
9697

9798
The ordering of steps 3 and 4 is important: loading your package after adding `Main.@infiltrate` statements will
9899
prevent if from loading, because that macro does not exist during precompilation.

0 commit comments

Comments
 (0)