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.

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

Request: Tutorial on Using the Debugger #774

Open
lorenzleutgeb opened this issue Oct 26, 2023 · 5 comments
Open

Request: Tutorial on Using the Debugger #774

lorenzleutgeb opened this issue Oct 26, 2023 · 5 comments
Labels
tutorial Topics for new tutorials

Comments

@lorenzleutgeb
Copy link
Member

lorenzleutgeb commented Oct 26, 2023

I think the debugger is quite hard to "discover", but can be a real life saver. It deserves a little more publicity.

My idea for a tutorial would be to (quite obviously) start off with a detailed version of:

Use builtins.break in your code, and then execute nix (build|develop|eval|run|shell) --debugger.

And then explain the features of the debugger.

There's a video on YouTube with a demo that serves as a first approximation: https://www.youtube.com/watch?v=ypFLcMCSzNA&t=291s

I could give it a go if maintainers think this would be desirable.

@fricklerhandwerk
Copy link
Collaborator

Yes, that would be very much appreciated!

@fricklerhandwerk fricklerhandwerk added the tutorial Topics for new tutorials label Oct 26, 2023
@infinisil
Copy link
Member

I think first of all the reference docs for the debugger should be written, they're currently inexistent!

@lorenzleutgeb lorenzleutgeb changed the title Request: Tutorial on using the debugger Request: Tutorial on Using the Debugger Nov 2, 2023
@rjpcasalino
Copy link
Contributor

rjpcasalino commented Nov 15, 2023

a good place to start/"steal" things from https://www.zknotes.com/note/5970 (if you haven't seen this already)
(found in release notes here: https://github.com/NixOS/nix/blob/master/doc/manual/src/release-notes/rl-2.9.md)

@aviallon
Copy link

TIL that a Nix debugger exists. Thanks, it will make my life easier.

@infinisil
Copy link
Member

Unfortunately the debugger has some problems, we ran into a few last Nix Hour. I don't think I'll be using it in practice

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
tutorial Topics for new tutorials
Projects
Status: No status
Development

No branches or pull requests

5 participants