summaryrefslogtreecommitdiff
path: root/runtime/doc/debug.txt
blob: a0fef1b6460483e0c374925ca0529efc353eb505 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
*debug.txt*     For Vim version 7.0aa.  Last change: 2005 Sep 01


		  VIM REFERENCE MANUAL    by Bram Moolenaar


Debugging Vim						*debug-vim*

This is for debugging Vim itself, when it doesn't work properly.

1. Location of a crash, using gcc and gdb	|debug-gcc|
2. Windows Bug Reporting               		|debug-win32|

==============================================================================

1. Location of a crash, using gcc and gdb		*debug-gcc*

When Vim crashes in one of the test files, and you are using gcc for
compilation, here is what you can do to find out exactly where Vim crashes.
This also applies when using the MingW tools.

1. Compile Vim with the "-g" option (there is a line in the Makefile for this,
   which you can uncomment).

2. Execute these commands (replace "11" with the test that fails): >
	cd testdir
	gdb ../vim
	run -u unix.vim -U NONE -s dotest.in test11.in

3. Check where Vim crashes, gdb should give a message for this.

4. Get a stack trace from gdb with this command: >
	where
<  You can check out different places in the stack trace with: >
	frame 3
<  Replace "3" with one of the numbers in the stack trace.

==============================================================================

2. Windows Bug Reporting                       		*debug-win32*

If the Windows version of Vim crashes in a reproducible manner,
you can take some steps to provide a useful bug report.

First, you must obtain the debugger symbols (PDB) file for your executable:
gvim.pdb for gvim.exe, or vim.pdb for vim.exe. It should be available
from the same place that you obtained the executable. Be sure to use
the PDB that matches the EXE.

If you built the executable yourself with the Microsoft Visual C++ compiler,
then the PDB was built with the EXE.

You can download the Microsoft Visual C++ Toolkit from
    http://msdn.microsoft.com/visualc/vctoolkit2003/
This contains the command-line tools, but not the Visual Studio IDE.

The Debugging Tools for Windows can be downloaded from
    http://www.microsoft.com/whdc/devtools/debugging/default.mspx
This includes the WinDbg debugger.

If you have Visual Studio, use that instead of the VC Toolkit
and WinDbg.


(No idea what to do if your binary was built with the Borland or Cygwin
compilers. Sorry.)

=========================================================================
 vim:tw=78:ts=8:ft=help:norl: