diff runtime/doc/debug.txt @ 857:b933657f7c9d

updated for version 7.0g01
author vimboss
date Tue, 02 May 2006 22:08:30 +0000
parents 8cd729851562
children 4bac29d27e2f
line wrap: on
line diff
--- a/runtime/doc/debug.txt
+++ b/runtime/doc/debug.txt
@@ -1,4 +1,4 @@
-*debug.txt*     For Vim version 7.0g.  Last change: 2006 Apr 30
+*debug.txt*     For Vim version 7.0g.  Last change: 2006 May 01
 
 
 		  VIM REFERENCE MANUAL    by Bram Moolenaar
@@ -47,9 +47,9 @@ some steps to provide a useful bug repor
 GENERIC ~
 
 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 (same date).
+for gvim.exe, or vim.pdb for vim.exe. The PDB should be available from the
+same place that you obtained the executable. Be sure to use the PDB that
+matches the EXE (same date).
 
 If you built the executable yourself with the Microsoft Visual C++ compiler,
 then the PDB was built with the EXE.
@@ -65,10 +65,11 @@ a Vim executable compiled with the Borla
 |debug-gcc|) for the Cygwin and MinGW compilers.
 
 
-Debugging Vim crashes with Visual Studio 2005/Visual C++ 2005 Express ~
+								*debug-vs2005*
+2.2 Debugging Vim crashes with Visual Studio 2005/Visual C++ 2005 Express ~
 
 First launch vim.exe or gvim.exe and then launch Visual Studio.  (If you don't
-have Visual Studio, follow the instructions in src/INSTALLpc.txt to obtain a
+have Visual Studio, follow the instructions at |get-ms-debuggers| to obtain a
 free copy of Visual C++ 2005 Express Edition.)
 
 On the Tools menu, click Attach to Process.  Choose the Vim process.
@@ -94,18 +95,57 @@ at ":help bug-reports".  Paste the call 
 If you have a non-free version of Visual Studio, you can save a minidump via
 the Debug menu and send it with the bug report.  A minidump is a small file
 (<100KB), which contains information about the state of your process.
+Visual C++ 2005 Express Edition cannot save minidumps and it cannot be
+installed as a just-in-time debugger. Use WinDbg, |debug-windbg|, if you
+need to save minidumps or you want a just-in-time (postmortem) debugger.
 
+								*debug-windbg*
+2.3 Debugging Vim crashes with WinDbg ~
+
+See |get-ms-debuggers| to obtain a copy of WinDbg.
 
-Debugging Vim with Debugging Tools ~
+As with the Visual Studio IDE, you can attach WinDbg to a running Vim process.
+You can also have your system automatically invoke WinDbg as a postmortem
+debugger. To set WinDbg as your postmortem debugger, run "windbg -I".
+
+To attach WinDbg to a running Vim process, launch WinDbg. On the File menu,
+choose Attach to a Process. Select the Vim process and click OK.
+
+At this point, choose Symbol File Path on the File menu, and add the folder
+containing your Vim PDB to the sympath. If you have Vim source available,
+use Source File Path on the File menu. You can now open source files in WinDbg
+and set breakpoints, if you like. Reproduce your crash. WinDbg should open the
+source file at the point of the crash. Using the View menu, you can examine
+the call stack, local variables, watch windows, and so on.
 
-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.
+If WinDbg is your postmortem debugger, you do not need to attach WinDbg to
+your Vim process. Simply reproduce the crash and WinDbg will launch
+automatically. As above, set the Symbol File Path and the Source File Path.
+
+To save a minidump, type the following at the WinDbg command line: >
+        .dump vim.dmp
+<
+							*debug-minidump*
+2.4 Opening a Minidump ~
+
+If you have a minidump file, you can open it in Visual Studio or in WinDbg.
 
-The Debugging Tools for Windows can be downloaded from
+In Visual Studio 2005: on the File menu, choose Open, then Project/Solution.
+Navigate to the .dmp file and open it. Now press F5 to invoke the debugger.
+Follow the instructions in |debug-vs2005| to set the Symbol File Path.
+
+In WinDbg: choose Open Crash Dump on the File menu. Follow the instructions in
+|debug-windbg| to set the Symbol File Path.
+
+							*get-ms-debuggers*
+2.5 Obtaining Microsoft Debugging Tools ~
+
+The Debugging Tools for Windows (including WinDbg) can be downloaded from
     http://www.microsoft.com/whdc/devtools/debugging/default.mspx
 This includes the WinDbg debugger.
 
+Visual C++ 2005 Express Edition can be downloaded for free from:
+    http://msdn.microsoft.com/vstudio/express/visualC/default.aspx
 
 =========================================================================
  vim:tw=78:ts=8:ft=help:norl: