forked from qt-creator/qt-creator
		
	debugger: adjust reference to startup commands to reality
Change-Id: I4369de839eba8cd30d261b74e89f2363ca815926 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@digia.com>
This commit is contained in:
		@@ -880,15 +880,17 @@
 | 
			
		||||
    is also easier to extend as the script is less dependent on the
 | 
			
		||||
    actual Qt version and does not need compilation.
 | 
			
		||||
 | 
			
		||||
    To extend the shipped Python based debugging helpers for custom types,
 | 
			
		||||
    define one Python function per user defined type in the
 | 
			
		||||
    GDB startup file. By default, the following startup file is used:
 | 
			
		||||
    \c{~/.gdbinit}. To use another file, select \gui {Tools > Options >
 | 
			
		||||
    Debugger > GDB}
 | 
			
		||||
    and specify a filename in the \gui {GDB startup script} field.
 | 
			
		||||
    To extend the shipped Python based debugging helpers for custom
 | 
			
		||||
    types, add debugging helper implementations to the GDB startup file
 | 
			
		||||
    \c{~/.gdbinit}, or specify them directly in the \gui{Additional
 | 
			
		||||
    Startup Commands} in \gui {Tools > Options > Debugger > GDB}.
 | 
			
		||||
 | 
			
		||||
    The function name has to be qdump__NS__Foo, where NS::Foo is the class
 | 
			
		||||
    or class template to be examined. Nested namespaces are possible.
 | 
			
		||||
    The implementation of a debugging helper typically
 | 
			
		||||
    consists of a single Python function, which needs to be named
 | 
			
		||||
    \c{qdump__NS__Foo}, where \c{NS::Foo} is the class
 | 
			
		||||
    or class template to be examined. Note that the \c{::} scope
 | 
			
		||||
    resolution operator is replaced by double underscores \c{__}.
 | 
			
		||||
    Nested namespaces are possible.
 | 
			
		||||
 | 
			
		||||
    The debugger plugin calls this function whenever you want to
 | 
			
		||||
    display an object of this type. The function is passed the following
 | 
			
		||||
@@ -915,9 +917,6 @@
 | 
			
		||||
        alloc = d_ptr["alloc"]
 | 
			
		||||
        size = d_ptr["size"]
 | 
			
		||||
 | 
			
		||||
        check(0 <= size and size <= alloc and alloc <= 1000 * 1000 * 1000)
 | 
			
		||||
        checkRef(d_ptr["ref"])
 | 
			
		||||
 | 
			
		||||
        innerType = templateArgument(value.type, 0)
 | 
			
		||||
        d.putItemCount(size)
 | 
			
		||||
        d.putNumChild(size)
 | 
			
		||||
 
 | 
			
		||||
@@ -229,7 +229,12 @@ GdbOptionsPageWidget::GdbOptionsPageWidget(QWidget *parent)
 | 
			
		||||
        "<html><head/><body><p>GDB commands entered here will be executed after "
 | 
			
		||||
        "GDB has been started and the debugging helpers have been initialized.</p>"
 | 
			
		||||
        "<p>You can add commands to load further debugging helpers here, or "
 | 
			
		||||
        "modify existing ones.</p><p>To execute arbitrary Python scripts, "
 | 
			
		||||
        "modify existing ones.</p>"
 | 
			
		||||
        "<p>To execute simple Python commands, prefix them with \"python\".</p>"
 | 
			
		||||
        "<p>To execute sequences of Python commands spanning multiple lines "
 | 
			
		||||
        "prepend the block with \"python\" on a separate line, and append "
 | 
			
		||||
        "\"end\" on a separate line.</p>"
 | 
			
		||||
        "<p>To execute arbitrary Python scripts, "
 | 
			
		||||
        "use <i>python execfile('/path/to/script.py')</i>.</p>"
 | 
			
		||||
        "</body></html>"));
 | 
			
		||||
 | 
			
		||||
 
 | 
			
		||||
		Reference in New Issue
	
	Block a user