erikgrinaker / toydb

Distributed SQL database in Rust, written as a learning project
Apache License 2.0
5.99k stars 555 forks source link

Add debugging instructions #50

Closed zaaath closed 2 years ago

zaaath commented 2 years ago

This adds instructions on how to set up debugging environment in VS Code for both, the engine and the sql client. Debugging specific tests works great as well.

Context: when I first started working my way through the toydb codebase, it was hard to understand what's going on (even though the docs, the tests, and the code itself are beautifully written!) without a debugger, and I couldn't find instructions on how to debug the code in the repo itself. I ended up googling around and setting up debugging environments on two laptops. With this PR I want to make it easier for the new engineers to onboard.

zaaath commented 2 years ago

@erikgrinaker is there something missing in this PR? what is the next step to get this approved?

erikgrinaker commented 2 years ago

Hey @leotoff! Thanks for the PR, and sorry for the late reply -- it's been a busy week. I'll get back to you in a bit.

erikgrinaker commented 2 years ago

PS: please wrap lines at 100 chars, for consistency.

zaaath commented 2 years ago

Sorry about the delay, I'm working on addressing outstanding issues.

Tasks:

erikgrinaker commented 2 years ago

Whoops, totally forgot about this. Thanks again!