Update debugger page with experimental note + python 3 usage
authorMark Florisson <markflorisson88@gmail.com>
Thu, 9 Dec 2010 22:03:17 +0000 (23:03 +0100)
committerMark Florisson <markflorisson88@gmail.com>
Thu, 9 Dec 2010 22:03:17 +0000 (23:03 +0100)
src/userguide/debugging.rst

index c3d5dadcc757606a98bcf609ba149d122c75186e..a2753b3e9fb738375f57863a81604a390f64342d 100644 (file)
@@ -8,7 +8,11 @@ Debugging your Cython program
 
 Cython comes with an extension for the GNU Debugger that helps users debug 
 Cython code. To use this functionality, you will need to install gdb 7.2 or
-higher, build with Python support (linked to Python 2.5 or higher). 
+higher, built with Python support (linked to Python 2.5 or higher).
+The debugger supports debuggees with versions 2.6 and higher. For Python 3,
+code should be built with Python 3 and the debugger should be run with
+Python 2 (or at least it should be able to find the Python 2 Cython 
+installation).
 
 The debugger will need debug information that the Cython compiler can export.
 This can be achieved from within the setup
@@ -34,11 +38,9 @@ debug information using the ``--gdb`` flag::
 
     cython --gdb myfile.pyx
 
-.. note:: The debugger is not yet part of Cython, but can currently
-          be retrieved here:
-          https://github.com/markflorisson88/cython.
-          This is a branch of Cython and can as such be used standalone, or
-          pulled into the mainline Cython branch (https://github.com/cython/cython).
+.. note:: The debugger is newly part of Cython 0.14 and as such is still 
+          experimental. CC markflorisson88@gmail.com in your TRAC tickets or
+          mailing list complaints.
 
 Running the Debugger
 =====================
@@ -77,6 +79,7 @@ argument::
 
     $ cygdb --
 
+
 Using the Debugger
 ===================
 The Cython debugger comes with a set of commands that support breakpoints,