This is the mail archive of the libstdc++@gcc.gnu.org mailing list for the libstdc++ project.


Index Nav: [Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav: [Date Prev] [Date Next] [Thread Prev] [Thread Next]
Other format: [Raw text]

Re: [libstdc++] Add brief documentation narrative for GDB pretty-printers. Add links to GDB wiki/manual


On Monday 05 October 2009 13:37:33, Phil Muldoon wrote:

> 2009-10-05  Phil Muldoon <pmuldoon@redhat.com>
> 
>      * doc/xml/manual/debug.xml: Add narrative for GDB Python pretty
>      printers.  Add links to GDB wiki/online manual
> 
> --
> 
> Index: libstdc++-v3/doc/xml/manual/debug.xml
> ===================================================================
> --- libstdc++-v3/doc/xml/manual/debug.xml    (revision 152442)
> +++ libstdc++-v3/doc/xml/manual/debug.xml    (working copy)
> @@ -217,6 +217,20 @@
>      set print demangle on
>      set demangle-style gnu-v3
> </programlisting>
> +
> +<para>
> +  GDB 7.0 will include support for writing pretty-printers in Python.
> +  A library of printers for STL classes already exists within the
> +  libstdc++ svn repository.  For information on enabling these printers,
> +  and for other GDB STL support options: please see
> + <ulink url="http://sourceware.org/gdb/wiki/STLSupport";> "GDB Support
> +  for STL" </ulink> in the GDB wiki.  Additionally, in-depth
> +  documentation and discussion of this feature can be found in the GDB
> +  manual.  Please see:
> + <ulink 
> url="http://sourceware.org/gdb/current/onlinedocs//gdb_24.html#SEC260";>
> +  "23.2.2.6 Pretty Printing" </ulink>

Is this for the manual, or web pages only?  Note that that gdb manual
url above is a pointer into the docs of the current development
sources.  At least "23.2.2.6", "SEC260" and "24" are quite volatile.
Of course, "GDB 7.0 will include" will sound weird shortly too.  :-)

Something like this would be more future proof, IMHO:

Starting with version 7.0, GDB includes support for writing
pretty-printers in Python.  Pretty printers for libstdc++ are
distributed with gcc starting from version 4.5.0.  The most up-to-date
version of these printers is always found in libstdc++ svn repository.
For information on enabling these printers, and for other GDB STL
support options: please see
<ulink url="http://sourceware.org/gdb/wiki/STLSupport";> "GDB Support
for STL" </ulink> in the GDB wiki.  Additionally, in-depth documentation
and discussion of the pretty printing feature can be found in
"Pretty Printing"" node in the GDB manual.  You can find online
versions of the GDB user manual in GDB's homepage, at
<ulink url="http://sourceware.org/gdb/";>GDB: The GNU Project Debugger</ulink>."

(untested, written in email client, yadda, yadda).

-- 
Pedro Alves


Index Nav: [Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav: [Date Prev] [Date Next] [Thread Prev] [Thread Next]