You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Vdebug is a new, fast, powerful debugger client for Vim. It's multi-language,
6
8
and has been tested with PHP, Python, Ruby, Perl, Tcl and NodeJS. It interfaces with
7
9
**any** debugger that faithfully uses the DBGP protocol, such as Xdebug for PHP.
@@ -16,40 +18,43 @@ It's written in Python, and has an object-oriented interface that is easy to ext
16
18
and can even be used from the command-line. It even has unit tests covering
17
19
some of the more critical parts of the code.
18
20
19
-
# Getting help
21
+
##Getting help
20
22
21
23
If you're having trouble with Vdebug in any way, here are the steps you can take to get help (in the right order):
22
24
23
25
1.[Check the issues][3] to see whether it's already come up.
24
26
2. Visit the **#vdebug** irc channel on freenode, someone is normally there.
25
27
3.[Open a new issue.][4]
26
28
27
-
# News
29
+
##News
28
30
29
31
Follow me on Twitter, [@joonty](http://twitter.com/joonty), for Vdebug updates and release news.
30
32
31
-
***15/05/2014:** Version 1.4.2 was released. This fixes major problems with the latest version of Vim, which has stricter rules around function naming. See [this pull request for more details][5]
33
+
***26/08/2015:** Version 1.5.0 released. This has a whole series of fixes and even a couple of new features. See below for more information.
34
+
***15/05/2014:** Version 1.4.2 released. This fixes major problems with the latest version of Vim, which has stricter rules around function naming. See [this pull request for more details][5]
32
35
***12/04/2014:** My son was born! Hence no contact or work on Vdebug for the following month.
33
36
34
-
35
-
# Recent version (version 1.4.2)
37
+
## Recent version (version 1.5.0)
36
38
37
39
### Bug fixes:
38
-
* Allow overriding of options dictionary after sourcing vdebug (issues #112, #113)
39
-
* Show local file path in stack window if using path mapping (issue #118)
40
-
* Change function names for stricter rules introduced in Vim v.7.4.260 (thanks @BlackEagle, #158 and #155)
41
-
42
-
### Documentation:
43
-
* Various fixes
44
-
* Mention vim-nox package for Debian (thanks @henningda, #138)
45
-
* Add Python installation for Windows information (issue #135)
40
+
* Fix for remote and local file paths with a windows/unix setup (thanks @brothert, #130)
41
+
* Sort path maps by remote path length (thanks @ragol and @adambiggs, #153, #201)
42
+
* Default "stop" behaviour (default <F6>) actually stops rather than detaches (issue #166)
43
+
* Various documentation fixes (issue #172, issue #223, thanks @loonies for #210)
44
+
* Add documentation to show that komodo-debug doesn't work with nodejs > 0.10 (#202, #223)
45
+
* Don't override previously defined breakpoint highlights (#208)
46
46
47
47
### Features:
48
-
* Add completion to :Breakpoint command (thanks @tommcdo, #124)
49
-
* Add VdebugStart command (thanks @blueyed, #132)
50
-
* Sleep for 100ms in wait loop, don't consume as much CPU (thanks @blueyed, #133)
48
+
* Add support for Python 2.4 (thanks @mbarbon, #189)
49
+
* Add Vagrantfile and bootstrap for easier local development
50
+
* Add new VdebugTrace command for tracking individual variables and expressions (thanks @escher9, #178)
51
+
* Show ellipses for truncated arrays in watch window (#177)
52
+
* Bind to all available interfaces by default, instead of just localhost (#209, thanks @zolem)
53
+
54
+
### Misc:
55
+
* Changed HISTORY to CHANGELOG
51
56
52
-
# How to use
57
+
##How to use
53
58
54
59
First of all, scoot down to the quick guide below.
55
60
@@ -66,7 +71,7 @@ To get this help, type:
66
71
67
72
after installing the plugin. If this doesn't work, you will need to generate the help tags.
68
73
69
-
## Generating help tags
74
+
###Generating help tags
70
75
71
76
Some package managers, such as Vundle, will automatically generate help tags. Others, such as Pathogen, won't by default, so you have to do it yourself. Also, if you have installed Vdebug manually then you will also have to do this step.
72
77
@@ -84,27 +89,27 @@ To manually generate the tags, run this in vim:
84
89
85
90
where the path supplied is vdebug's doc directory. This should enable vdebug's help to be accessed.
86
91
87
-
# Installation
92
+
##Installation
88
93
89
94
**Requirements**:
90
95
91
-
* Vim compiled with Python 2.6+ support, tabs and signs (for Debian/Ubuntu this is provided in the vim-nox package)
96
+
* Vim compiled with Python 2.4+ support, tabs and signs (for Debian/Ubuntu this is provided in the vim-nox package)
92
97
* A programming language that has a DBGP debugger, e.g. PHP, Python, Ruby,
93
98
Perl, NodeJS, Tcl...
94
99
95
-
## Classic
100
+
###Classic
96
101
97
102
Clone or download a tarball of the plugin and move its content in your
98
103
`~/.vim/` directory.
99
104
100
105
Your `~/.vim/plugin/` directory should now contain vdebug.vim and a directory
101
106
called "python".
102
107
103
-
## Using git and Pathogen
108
+
###Using git and Pathogen
104
109
105
110
Clone this repository in your `~/.vim/bundle` directory
106
111
107
-
## Using vundle
112
+
###Using vundle
108
113
109
114
Add this to your `~/.vimrc` file:
110
115
@@ -118,7 +123,7 @@ Then, from the command line, run:
118
123
vim +BundleInstall +qall
119
124
```
120
125
121
-
# Quick guide
126
+
##Quick guide
122
127
123
128
Set up any DBGP protocol debugger, e.g. Xdebug. (See :help VdebugSetUp). Start Vdebug with `<F5>`, which will make it wait for an incoming connection. Run the script you want to debug, with the debugging engine enabled. A new tab will open with the debugging interface.
124
129
@@ -128,7 +133,7 @@ Once in debugging mode, the following default mappings are available:
128
133
*`<F2>`: step over
129
134
*`<F3>`: step into
130
135
*`<F4>`: step out
131
-
*`<F6>`: stop debugging
136
+
*`<F6>`: stop debugging (kills script)
132
137
*`<F7>`: detach script from debugger
133
138
*`<F9>`: run to cursor
134
139
*`<F10>`: toggle line breakpoint
@@ -143,7 +148,7 @@ To stop debugging, press `<F6>`. Press it again to close the debugger interface.
143
148
144
149
If you can't get a connection, then chances are you need to spend a bit of time setting up your environment. Type `:help Vdebug` for more information.
145
150
146
-
# Debugging
151
+
##Debugging
147
152
148
153
If you have a problem, and would like to see what's going on under the hood or raise an issue, it's best to create a log file. You can do this by setting these options before you start debugging:
149
154
@@ -156,14 +161,14 @@ Then start debugging, and you can follow what's added to the log file as you go.
156
161
157
162
If you're creating an issue then it's probably best to upload a log as a Gist, as it can be pretty large.
158
163
159
-
# Contributing
164
+
##Contributing
160
165
161
166
I gladly accept contributions to the code. Just fork the repository, make your changes and open a pull request with detail about your changes. There are a couple of conditions:
162
167
163
168
* The tests must pass (see below)
164
169
* Your commit messages should follow the [rules outlined here][2]
165
170
166
-
# Tests
171
+
##Tests
167
172
168
173
* The tests use `unittest2` and `mock`, so make sure they're installed
169
174
@@ -174,7 +179,7 @@ pip install mock
174
179
175
180
* To run the tests, run `python vdebugtests.py` in the top directory of the plugin
176
181
177
-
# Licence
182
+
##Licence
178
183
179
184
This plugin is released under the [MIT License][1].
0 commit comments