Skip to content

Commit

Permalink
first pass at explaining source debugging
Browse files Browse the repository at this point in the history
  • Loading branch information
shiftkey committed Dec 11, 2014
1 parent 76360b2 commit fdaa9df
Showing 1 changed file with 32 additions and 0 deletions.
32 changes: 32 additions & 0 deletions docs/debugging-source.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# Debugging Octokit Source in your app

As of version 0.6, Octokit supports symbol debugging - this enables you to step
into the Octokit source without having the repository on your local machine.

### Enable Symbol Debugging

To enable this, you need to enable this in VS:

- From the top **Tools** menu, select **Options**
- Select **Debugging** from the left sidebar and expand **General**

Ensure you have checked **Enable source server support**:

![Enable source server support](https://cloud.githubusercontent.com/assets/359239/5388961/31f9b29e-8144-11e4-8c47-08aca6dee697.png)

### How does this actually work?

When you hit a breakpoint in your application, you can step into the
Octokit source code using `F11`. This will retrieve the source file associated
with a specific type, and cache it in your local symbols cache.

![F11 step into symbol](https://cloud.githubusercontent.com/assets/359239/5389259/74600502-8149-11e4-94f7-10dc79a0573f.gif)

You can then set subsequent breakpoints inside the source code, to return to
in the debugging session.

### Acknowledgements

Thanks to [Cameron Taggart](http://blog.ctaggart.com/) for building the
[SourceLink](https://github.com/ctaggart/SourceLink) framework which we use
to support this behaviour.

0 comments on commit fdaa9df

Please sign in to comment.