Skip to content

docs: add a note to load Infiltrator to readme #166

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
pfitzseb merged 1 commit into from
Jan 19, 2026
Merged

docs: add a note to load Infiltrator to readme #166

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 5 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,10 +89,11 @@ backing module to `Main` and therefore export the contents of the safehouse to t
Using Infiltrator for debugging packages or scripts requires a little bit of setup.

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.
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.
3. Load your package.
4. Add `Main.@infiltrate` statements as breakpoints wherever desired.
5. Run a function that ends up executing the method containing the breakpoint.
2. Load Infiltrator.jl with `using Infiltrator` in the REPL
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.
4. Load your package.
5. Add `Main.@infiltrate` statements as breakpoints wherever desired.
6. Run a function that ends up executing the method containing the breakpoint.

The ordering of steps 3 and 4 is important: loading your package after adding `Main.@infiltrate` statements will
Copy link

@MagicMuscleMan MagicMuscleMan Jan 19, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@pfitzseb Thanks for the fast PR. Strictly speaking this "step 3 and 4" now has a different meaning. Was this on purpose?

Copy link
Member Author

@pfitzseb pfitzseb Jan 19, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

no, just missed that: e02f7ea

prevent if from loading, because that macro does not exist during precompilation.
Expand Down
Loading