[gtk+] docs: Flesh out the inspector section a bit
- From: Matthias Clasen <matthiasc src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [gtk+] docs: Flesh out the inspector section a bit
- Date: Sat, 24 May 2014 14:08:44 +0000 (UTC)
commit 1d897a9bf2fe2079c669973e9a6e02e4c939f974
Author: Matthias Clasen <mclasen redhat com>
Date: Sat May 24 10:07:46 2014 -0400
docs: Flesh out the inspector section a bit
docs/reference/gtk/running.sgml | 22 +++++++++++++++-------
1 files changed, 15 insertions(+), 7 deletions(-)
---
diff --git a/docs/reference/gtk/running.sgml b/docs/reference/gtk/running.sgml
index 4c0e520..fd33457 100644
--- a/docs/reference/gtk/running.sgml
+++ b/docs/reference/gtk/running.sgml
@@ -532,19 +532,27 @@ nevertheless.
<inlinegraphic fileref="inspector.png" format="PNG"></inlinegraphic>
<para>
- GTK+ includes an interactive debugger which lets you explore the
- widget tree of any GTK+ application at runtime, as well as tweak
- the theme and trigger visual debugging aids.
+ GTK+ includes an interactive debugger, called the GTK+ Inspector, which
+ lets you explore the widget tree of any GTK+ application at runtime, as
+ well as tweak the theme and trigger visual debugging aids. You can
+ easily try out changes at runtime before putting them into the code.
</para>
<para>
- To enable the debugger, you can use the Control-Shift-I or
+ Note that the GTK+ inspector can only show GTK+ internals. It can not
+ understand the application-specific logic of a GTK+ application. Also,
+ the fact that the GTK+ inspector is running in the application process
+ limits what it can do. It is meant as a complement to full-blown debuggers
+ and system tracing facilities such as DTrace, not as a replacement.
+ </para>
+ <para>
+ To enable the GTK+ inspector, you can use the Control-Shift-I or
Control-Shift-D keyboard shortcuts, or set the
<envar>GTK_DEBUG=interactive</envar> environment variable.
</para>
<para>
- In some situations, it may be inappropriate to give users access
- to the interactive debugger. The keyboard shortcuts can be disabled
- with the `enable-inspector-keybinding` key in the `org.gtk.Settings.Debug`
+ In some situations, it may be inappropriate to give users access to the
+ GTK+ inspector. The keyboard shortcuts can be disabled with the
+ `enable-inspector-keybinding` key in the `org.gtk.Settings.Debug`
GSettings schema.
</para>
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]