Skip to content
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

Jump to bottom

Minimally document externall debugging tools #77

Open
wants to merge 7 commits into
base: master
Choose a base branch
from
Open

Minimally document externall debugging tools #77

Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
7c504b4
fixed the additional args for sys images
MariusDrulea Sep 4, 2023
b67cac6
document external tools for debugging:
MariusDrulea Sep 4, 2023
df7fd6e
add documentation for externall tools
MariusDrulea Sep 4, 2023
4028efb
remove the note in debugging with external tools
MariusDrulea Sep 5, 2023
f469661
removed commas in sample code
MariusDrulea Sep 5, 2023
dc9b9c0
update the comment related to custom sys images
MariusDrulea Sep 5, 2023
0d80004
only brief description on other debugging tools
MariusDrulea Sep 5, 2023
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
12 changes: 11 additions & 1 deletion docs/src/userguide/debugging.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -137,7 +137,7 @@ Custom julia sys images can also be used when debugging. Go to julia-vscode exte
Once in the settings, use "-J" option followed by your path to the custom sys image. Note this "Additional Args" settings are currently used only when debugging in the REPL mode, see the `@run` macron in the example bellow.
```
"julia.additionalArgs": [
"-JC:\\temp\\sys_custom.so",
"-J", "C:\\temp\\sys_custom.so",
],
```
### Example for fast(er) debugging
Expand All @@ -148,3 +148,13 @@ In the following code we use the packages GLMakie and Statistics. GLMakie is a p
As the debugger hits the desired line of code we can step inside the `mean` function (Statistics) and debug there.

![Debugger](../assets/debugger/19.png)

## Other tools for debugging
You can also use the packages _Debugger.jl_ and _Infiltrator.jl_ for debugging. These packages offer debugging in REPL and are not connected to the vscode-julia extension. Both packages can be used in combination with a custom system image. They are briefly described bellow. Use the provided links for more information.

### Debugger.jl
[Debugger.jl](https://github.com/JuliaDebug/Debugger.jl) uses [JuliaInterpreter.jl](https://github.com/JuliaDebug/JuliaInterpreter.jl) in order to debug the code in REPL. Note that vscode-julia extension also uses JuliaInterpreter, but offers UI based debugging. JuliaInterpreter allows the users to specify which modules will get compiled and which will get interpretted. You can achieve the same behavior as in [`ALL_MODULES_EXCEPT_MAIN`](https://www.julia-vscode.org/docs/dev/userguide/debugging/#ALL_MODULES_EXCEPT_MAIN), but using the REPL.

### Infiltrator.jl
The _@infiltrate_ macro sets an infiltration point in the code. The advantage of Infiltrator over Debugger is that Infiltrator has neglijible performance overhead. You can inspect the local variables in the current call-stack. The disadvantage is that you cannot step-in or step-over instructions. Instead you can jump to the next infiltration point.
The full description is here: [Infiltrator.jl](https://github.com/JuliaDebug/Infiltrator.jl)
Loading