Re: Outstanding patches, #58330

["Matthias Clasen" <matthiasc poet de>]

----- Original Message -----
From: "Tim Janik" <timj gtk org>
To: "Matthias Clasen" <matthiasc poet de>
Cc: "Gtk+ Developers" <gtk-devel-list gnome org>
Sent: Saturday, August 11, 2001 6:10 AM
Subject: Re: Outstanding patches, #58330


> On Thu, 9 Aug 2001, Matthias Clasen wrote:
>
> > This is currently just a documentation update, but I think it would make
> > more sense to remove
> > the completely unused debug flags from both debugging.txt and the enums.
> >
> > Comments ?
>
> rather than describing GRUNTIME_DEBUG, you better refer the user
> to glib/docs/debugging.txt.
>

Is the version appended below better ? Note that I removed information about
unused debug flags now.

Matthias




The GLIB, GDK, and GTK libraries have extensive support for
debugging the library and your programs.

The amount of debugging being done can be determined both
at run time and compile time.

COMPILE TIME OPTIONS
--------------------

At compile time, the amount of debugging support included is
determined by four macros:

G_ENABLE_DEBUG
  If set, enable support for runtime checking.

G_DISABLE_ASSERT
  If set, disable g_assert macros

G_DISABLE_CHECKS
  If set, disable the g_return_if_fail and g_return_val_if_fail macros

GTK_NO_CHECK_CASTS
  If set, don't check casts between different object types


Whether these macros are defined is controlled at configuration
time by the --enable-debug option.

--enable-debug=minimum [default]
  Enable only inexpensive sanity checking
    sets GTK_NO_CHECK_CASTS

--enable-debug=yes
  Enable all debugging support
    sets G_ENABLE_DEBUG

--enable-debug=no (or --disable-debug)
  Disable all debugging support (fastest)
    sets G_DISABLE_ASSERT, G_DISABLE_CHECKS, and GTK_NO_CHECK_CASTS


RUN TIME OPTIONS
----------------

At run time, if GTK+ was compiled with debugging enabled, different
types of debugging information can be printed out. This is controlled
by the:

  GTK_DEBUG and GDK_DEBUG environment variables
  --gtk-debug and --gdk-debug command line options
  --gtk-no-debug and --gdk-no-debug command line options

First the environment variables are applied, then the command line
options are applied in the order given on the command line.

Each of these can either be the special value 'all', or a sequence of
':' separated options. (case is ignored). The environment variables
and the --gtk-debug and --gdk-debug options add debugging options and
the --gtk-no-debug and --gdk-no-debug options remove them.

As noted below, some of these are useful in application debugging, but
most are only interested to those debugging the libraries

For instance:

  GDK_DEBUG_FLAGS=misc:dnd testgtk --gdk-no-debug dnd --gdk-debug events

runs testgtk with the 'misc' and 'events' debugging options.

See glib/docs/debugging.txt for information about debugging signal emission
and the object system.


 GDK_DEBUG
 ---------

 Application relevant options:

 'events' - Show all events received by GTK

 Options only interesting to library maintainers:

 'misc'          - Miscellaneous information
 'dnd'           - Information about drag-and-drop


 GTK_DEBUG
 ---------

 Options only interesting to library maintainers:

 'text'          - Information about text widget internals
 'tree'          - Information about tree widget internals
 'updates'       - Visual feedback about window updates


                                    - Owen Taylor <owt1 cornell edu>
                                      98/02/19