Request: Tutorial on Using the Debugger
Nobody has claimed this yet.
- Dominant language
- Nix
- Stars
- 4k
- Forks
- 339
- Avg merge
- 2d 11h
- Merged PRs (30d)
- 7
Description
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.breakin your code, and then executenix (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.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the proposed builtins.break example, the nix build, develop, eval, run, and shell --debugger commands, and the linked debugger video. The tutorial should explain the debugger's features and make its use discoverable for readers of nix.dev.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100