delve/README.md

52 lines
1.4 KiB
Markdown
Raw Normal View History

2014-05-03 20:31:52 +00:00
# DBG
2014-07-21 16:40:21 +00:00
### What is DBG?
2014-05-03 20:31:52 +00:00
2014-07-21 16:44:53 +00:00
DBG is a Go debugger, written primarily in Go. It really needs a new name.
2014-05-03 20:31:52 +00:00
2014-08-23 13:50:18 +00:00
### Building
Currently, DBG requires the following [patch](https://codereview.appspot.com/117280043/) to be applied to your Go source to build.
2014-08-23 13:50:18 +00:00
2014-07-21 16:40:21 +00:00
### Features
* Attach to (trace) a running process
2014-08-27 22:51:56 +00:00
* Ability to launch a process and begin debugging it
2014-07-21 16:40:21 +00:00
* Set breakpoints
* Single step through a process
* Next through a process (step over / out of subroutines)
* Never retype commands, empty line defaults to previous command
### Usage
2014-08-27 22:51:56 +00:00
The debugger can be launched in two ways:
* Provide the name of the program you want to debug, and the debugger will launch it for you.
$ dbg -proc path/to/program
* Provide the pid of a currently running process, and the debugger will attach and begin the session.
$ dbg -pid 44839
Once inside a debugging session, the following commands may be used:
2014-07-21 16:41:50 +00:00
* `break` - Set break point at the entry point of a function, or at a specific file/line. Example: `break foo.go:13`.
2014-07-21 16:40:21 +00:00
2014-07-21 16:41:50 +00:00
* `step` - Single step through program.
2014-07-21 16:40:21 +00:00
2014-07-21 16:41:50 +00:00
* `next` - Step over to next source line.
2014-07-21 16:40:21 +00:00
### Upcoming features
* Handle Gos multithreaded nature better (follow goroutine accross thread contexts)
* In-scope variable evaluation
* In-scope variable setting
* Readline integration
* Ability to launch debugging session from debugged program, with breakpoint set correctly
2014-07-30 00:00:03 +00:00
* Support for OS X
2014-07-21 16:40:21 +00:00
### License
2014-05-03 20:31:52 +00:00
MIT