From 777f1a4ceea35ce6c6856a717d8e9897630e85fb Mon Sep 17 00:00:00 2001 From: Martin Hunt Date: Thu, 19 Dec 2002 21:28:10 +0000 Subject: Updated Help. --- gdb/gdbtk/library/help/debug.html | 58 +++++++------- gdb/gdbtk/library/help/help.html | 18 +++-- gdb/gdbtk/library/help/images/index.gif | Bin 11645 -> 0 bytes gdb/gdbtk/library/help/images/insightbwr.png | Bin 0 -> 1556 bytes gdb/gdbtk/library/help/images/reg.png | Bin 0 -> 12541 bytes gdb/gdbtk/library/help/images/reg_menu.png | Bin 0 -> 14377 bytes gdb/gdbtk/library/help/images/watch.png | Bin 0 -> 14695 bytes gdb/gdbtk/library/help/index.html | 81 ++++++++----------- gdb/gdbtk/library/help/locals.html | 95 ++++++---------------- gdb/gdbtk/library/help/reg_pref.html | 20 ----- gdb/gdbtk/library/help/register.html | 36 +++++---- gdb/gdbtk/library/help/target.html | 49 ++++++------ gdb/gdbtk/library/help/watch.html | 115 +++++++++------------------ 13 files changed, 181 insertions(+), 291 deletions(-) delete mode 100644 gdb/gdbtk/library/help/images/index.gif create mode 100644 gdb/gdbtk/library/help/images/insightbwr.png create mode 100644 gdb/gdbtk/library/help/images/reg.png create mode 100644 gdb/gdbtk/library/help/images/reg_menu.png create mode 100644 gdb/gdbtk/library/help/images/watch.png delete mode 100644 gdb/gdbtk/library/help/reg_pref.html diff --git a/gdb/gdbtk/library/help/debug.html b/gdb/gdbtk/library/help/debug.html index 11b9979deca..528a868ff5f 100644 --- a/gdb/gdbtk/library/help/debug.html +++ b/gdb/gdbtk/library/help/debug.html @@ -1,16 +1,18 @@ -Debugging Help +Internal Debugging Help -

GDBTK Debugging Functions

-

Overview

-

This describes the basic internal functions for debugging GDBTK.

+

Insight Internal Debugging Functions

+

Overview

+

This describes the basic internal functions for debugging Insight. +This information is for Insight developers trying to debug Insight, +not for users trying to debug other programs.

-

Environment Variables

-

GDBTK_DEBUG - Setting this variable controls the Debug +

Environment Variables

+

GDBTK_DEBUG - Setting this variable controls the Debug window.

-

GDBTK_DEBUG may have the following values:

+

GDBTK_DEBUG may have the following values:

0 or unset
The Debug window is not opened and not listed on the menu. (You @@ -22,10 +24,10 @@ may still open it by typing Ctrl-U in the source window.)
-

GDBTK_TRACE - This variable determines if tracing is enbabled. -Tracing may only be enabled at GDBTK startup. Changing GDBTK_TRACE +

GDBTK_TRACE - This variable determines if tracing is enabled. +Tracing may only be enabled at GDBTK startup. Changing GDBTK_TRACE while GDBTK is running has no effect.

-

GDBTK_TRACE may have the following values:

+

GDBTK_TRACE may have the following values:

0 or unset
Tracing is not enabled.
@@ -34,42 +36,42 @@ while GDBTK is running has no effect.

so in the Debug Window or from the console. (The command to do this is "tk ::debug::trace_start).
2
-
Tracing is enabled and started immediately. +
Tracing is enabled and started immediately.
-

GDBTK_DEBUGFILE - This variable contains an optional filename +

GDBTK_DEBUGFILE - This variable contains an optional filename where GDBTK will write all debugging information. This information will include the output of all "debug" and "dbug" commands, as well as tracing, if it is enabled. The value of -GDBTK_DEBUGFILE will not change what is displayed in the Debug +GDBTK_DEBUGFILE will not change what is displayed in the Debug Window, with one exception; when the Debug Window is opened, it will read -the contents of GDBTK_DEBUGFILE (if it is set and not "stdout"). -

GDBTK_DEBUGFILE may have the following values:

+the contents of GDBTK_DEBUGFILE (if it is set and not "stdout"). +

GDBTK_DEBUGFILE may have the following values:

unset
No information will be logged.
-
filename
-
Debugging information will be logged to filename. +
filename
+
Debugging information will be logged to filename.
"stdout"
Debugging information will be written to stdout
-

Tcl Debugging Functions

+

Tcl Debugging Functions

All debugging functions have been moved into debug.tcl in the ::debug namespace. "debug" and "dbug" are imported into the global namespace.

The following are the standard debug message functions.

- +
 # -----------------------------------------------------------------------------
 # NAME:		debug::debug
 #
 # SYNOPSIS:	debug { {msg ""} }
 #
-# DESC:		Writes a message to the proper output. The priority of the 
+# DESC:		Writes a message to the proper output. The priority of the
 #		message is assumed to be "I" (informational). This function
 #		is provided for compatibility with the previous debug function.
 #		For higher priority messages, use dbug.
 #
-# ARGS:		msg - Message to be displayed. 
+# ARGS:		msg - Message to be displayed.
 # -----------------------------------------------------------------------------
 
 # -----------------------------------------------------------------------------
@@ -87,14 +89,14 @@ namespace. "debug" and "dbug" are imported into the global namespace.

 #				"E" - Error
 #				"X" - Fatal Error
 # ----------------------------------------------------------------------------
-
+

These next functions are used to trace variables, which should not be confused with the functions tracing.

- +

 # ----------------------------------------------------------------------------
 # NAME:		debug::trace_var
 # SYNOPSIS:	debug::trace_var {varName mode}
-# DESC:		Sets up variable trace.  When the trace is activated, 
+# DESC:		Sets up variable trace.  When the trace is activated,
 #		debugging messages will be displayed.
 # ARGS:		varName - the variable name
 #		mode - one of more of the following letters
@@ -112,10 +114,10 @@ confused with the functions tracing.

 # SYNOPSIS:	debug::remove_all_traces
 # DESC:		Removes all traces set up with "trace_var".
 # ----------------------------------------------------------------------------
-
-
 The following two functions may be used to start and stop tracing 
+
+

The following two functions may be used to start and stop tracing programmatically.

- +
 # -----------------------------------------------------------------------------
 # NAME:		::debug::trace_start
 # SYNOPSIS:	::debug::trace_start
@@ -126,6 +128,6 @@ programmatically.

 # SYNOPSIS:	::debug::trace_stop
 # DESC:		Stops logging of function trace information.
 # -----------------------------------------------------------------------------
-
+
diff --git a/gdb/gdbtk/library/help/help.html b/gdb/gdbtk/library/help/help.html index 3a3640da1a1..7cf93c3cedd 100644 --- a/gdb/gdbtk/library/help/help.html +++ b/gdb/gdbtk/library/help/help.html @@ -11,14 +11,16 @@ this window.

Help Window topics: