Mercurial > hg > octave-lyh

annotate doc/interpreter/debug.txi @ 8428:ee1bc8aa226b

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Add cross reference from Plot Annotations to Text Properties.
author Francesco Potortì <pot@gnu.org>
date Fri, 26 Dec 2008 22:23:11 +0100
parents fa78cb8d8a5c
children 2beb59bf773a
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
6778
083721ae3dfa [project @ 2007-07-18 17:03:10 by jwe]
jwe
parents: 6648
diff changeset
1 @c Copyright (C) 1996, 1997, 2007 John W. Eaton
7018
fd42779a8428 [project @ 2007-10-13 00:52:12 by jwe]
jwe
parents: 6778
diff changeset
2 @c
fd42779a8428 [project @ 2007-10-13 00:52:12 by jwe]
jwe
parents: 6778
diff changeset
3 @c This file is part of Octave.
fd42779a8428 [project @ 2007-10-13 00:52:12 by jwe]
jwe
parents: 6778
diff changeset
4 @c
fd42779a8428 [project @ 2007-10-13 00:52:12 by jwe]
jwe
parents: 6778
diff changeset
5 @c Octave is free software; you can redistribute it and/or modify it
fd42779a8428 [project @ 2007-10-13 00:52:12 by jwe]
jwe
parents: 6778
diff changeset
6 @c under the terms of the GNU General Public License as published by the
fd42779a8428 [project @ 2007-10-13 00:52:12 by jwe]
jwe
parents: 6778
diff changeset
7 @c Free Software Foundation; either version 3 of the License, or (at
fd42779a8428 [project @ 2007-10-13 00:52:12 by jwe]
jwe
parents: 6778
diff changeset
8 @c your option) any later version.
fd42779a8428 [project @ 2007-10-13 00:52:12 by jwe]
jwe
parents: 6778
diff changeset
9 @c
fd42779a8428 [project @ 2007-10-13 00:52:12 by jwe]
jwe
parents: 6778
diff changeset
10 @c Octave is distributed in the hope that it will be useful, but WITHOUT
fd42779a8428 [project @ 2007-10-13 00:52:12 by jwe]
jwe
parents: 6778
diff changeset
11 @c ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
fd42779a8428 [project @ 2007-10-13 00:52:12 by jwe]
jwe
parents: 6778
diff changeset
12 @c FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
fd42779a8428 [project @ 2007-10-13 00:52:12 by jwe]
jwe
parents: 6778
diff changeset
13 @c for more details.
fd42779a8428 [project @ 2007-10-13 00:52:12 by jwe]
jwe
parents: 6778
diff changeset
14 @c
fd42779a8428 [project @ 2007-10-13 00:52:12 by jwe]
jwe
parents: 6778
diff changeset
15 @c You should have received a copy of the GNU General Public License
fd42779a8428 [project @ 2007-10-13 00:52:12 by jwe]
jwe
parents: 6778
diff changeset
16 @c along with Octave; see the file COPYING. If not, see
fd42779a8428 [project @ 2007-10-13 00:52:12 by jwe]
jwe
parents: 6778
diff changeset
17 @c <http://www.gnu.org/licenses/>.
4175
b3cd3d12da7e [project @ 2002-11-13 02:45:39 by jwe]
jwe
parents:
diff changeset
18
b3cd3d12da7e [project @ 2002-11-13 02:45:39 by jwe]
jwe
parents:
diff changeset
19 @node Debugging
b3cd3d12da7e [project @ 2002-11-13 02:45:39 by jwe]
jwe
parents:
diff changeset
20 @chapter Debugging
b3cd3d12da7e [project @ 2002-11-13 02:45:39 by jwe]
jwe
parents:
diff changeset
21
6646
bd0a70c3f2db [project @ 2007-05-22 02:27:43 by jwe]
jwe
parents: 4185
diff changeset
22 Octave includes a built-in debugger to aid in the development of
bd0a70c3f2db [project @ 2007-05-22 02:27:43 by jwe]
jwe
parents: 4185
diff changeset
23 scripts. This can be used to interrupt the execution of an Octave script
bd0a70c3f2db [project @ 2007-05-22 02:27:43 by jwe]
jwe
parents: 4185
diff changeset
24 at a certain point, or when certain conditions are met. Once execution
bd0a70c3f2db [project @ 2007-05-22 02:27:43 by jwe]
jwe
parents: 4185
diff changeset
25 has stopped, and debug mode is entered, the symbol table at the point
bd0a70c3f2db [project @ 2007-05-22 02:27:43 by jwe]
jwe
parents: 4185
diff changeset
26 where execution has stopped can be examined and modified to check for
bd0a70c3f2db [project @ 2007-05-22 02:27:43 by jwe]
jwe
parents: 4185
diff changeset
27 errors.
4175
b3cd3d12da7e [project @ 2002-11-13 02:45:39 by jwe]
jwe
parents:
diff changeset
28
6646
bd0a70c3f2db [project @ 2007-05-22 02:27:43 by jwe]
jwe
parents: 4185
diff changeset
29 The normal commandline editing and history functions are available in
7787
6b521b1e3631 Add dbquit and make dbstep compatible. Use parser in debug mode to handle multi-line input
David Bateman <dbateman@free.fr>
parents: 7018
diff changeset
30 debug mode.
6646
bd0a70c3f2db [project @ 2007-05-22 02:27:43 by jwe]
jwe
parents: 4185
diff changeset
31
bd0a70c3f2db [project @ 2007-05-22 02:27:43 by jwe]
jwe
parents: 4185
diff changeset
32 @menu
bd0a70c3f2db [project @ 2007-05-22 02:27:43 by jwe]
jwe
parents: 4185
diff changeset
33 * Entering Debug Mode::
7787
6b521b1e3631 Add dbquit and make dbstep compatible. Use parser in debug mode to handle multi-line input
David Bateman <dbateman@free.fr>
parents: 7018
diff changeset
34 * Leaving Debug Mode::
6646
bd0a70c3f2db [project @ 2007-05-22 02:27:43 by jwe]
jwe
parents: 4185
diff changeset
35 * Breakpoints::
bd0a70c3f2db [project @ 2007-05-22 02:27:43 by jwe]
jwe
parents: 4185
diff changeset
36 * Debug Mode::
7787
6b521b1e3631 Add dbquit and make dbstep compatible. Use parser in debug mode to handle multi-line input
David Bateman <dbateman@free.fr>
parents: 7018
diff changeset
37 * Call Stack::
6646
bd0a70c3f2db [project @ 2007-05-22 02:27:43 by jwe]
jwe
parents: 4185
diff changeset
38 @end menu
4175
b3cd3d12da7e [project @ 2002-11-13 02:45:39 by jwe]
jwe
parents:
diff changeset
39
6646
bd0a70c3f2db [project @ 2007-05-22 02:27:43 by jwe]
jwe
parents: 4185
diff changeset
40 @node Entering Debug Mode
bd0a70c3f2db [project @ 2007-05-22 02:27:43 by jwe]
jwe
parents: 4185
diff changeset
41 @section Entering Debug Mode
4175
b3cd3d12da7e [project @ 2002-11-13 02:45:39 by jwe]
jwe
parents:
diff changeset
42
6646
bd0a70c3f2db [project @ 2007-05-22 02:27:43 by jwe]
jwe
parents: 4185
diff changeset
43 There are two basic means of interrupting the execution of an Octave
bd0a70c3f2db [project @ 2007-05-22 02:27:43 by jwe]
jwe
parents: 4185
diff changeset
44 script. These are breakpoints @ref{Breakpoints}, discussed in the next
bd0a70c3f2db [project @ 2007-05-22 02:27:43 by jwe]
jwe
parents: 4185
diff changeset
45 section and interruption based on some condition.
bd0a70c3f2db [project @ 2007-05-22 02:27:43 by jwe]
jwe
parents: 4185
diff changeset
46
bd0a70c3f2db [project @ 2007-05-22 02:27:43 by jwe]
jwe
parents: 4185
diff changeset
47 Octave supports three means to stop execution based on the values set in
bd0a70c3f2db [project @ 2007-05-22 02:27:43 by jwe]
jwe
parents: 4185
diff changeset
48 the functions @code{debug_on_interrupt}, @code{debug_on_warning} and
bd0a70c3f2db [project @ 2007-05-22 02:27:43 by jwe]
jwe
parents: 4185
diff changeset
49 @code{debug_on_error}.
4175
b3cd3d12da7e [project @ 2002-11-13 02:45:39 by jwe]
jwe
parents:
diff changeset
50
4185
8f6d418d31c3 [project @ 2002-11-15 23:22:03 by jwe]
jwe
parents: 4175
diff changeset
51 @DOCSTRING(debug_on_interrupt)
4175
b3cd3d12da7e [project @ 2002-11-13 02:45:39 by jwe]
jwe
parents:
diff changeset
52
b3cd3d12da7e [project @ 2002-11-13 02:45:39 by jwe]
jwe
parents:
diff changeset
53 @DOCSTRING(debug_on_warning)
4185
8f6d418d31c3 [project @ 2002-11-15 23:22:03 by jwe]
jwe
parents: 4175
diff changeset
54
8f6d418d31c3 [project @ 2002-11-15 23:22:03 by jwe]
jwe
parents: 4175
diff changeset
55 @DOCSTRING(debug_on_error)
6646
bd0a70c3f2db [project @ 2007-05-22 02:27:43 by jwe]
jwe
parents: 4185
diff changeset
56
7787
6b521b1e3631 Add dbquit and make dbstep compatible. Use parser in debug mode to handle multi-line input
David Bateman <dbateman@free.fr>
parents: 7018
diff changeset
57 @node Leaving Debug Mode
6b521b1e3631 Add dbquit and make dbstep compatible. Use parser in debug mode to handle multi-line input
David Bateman <dbateman@free.fr>
parents: 7018
diff changeset
58 @section Leavinging Debug Mode
6b521b1e3631 Add dbquit and make dbstep compatible. Use parser in debug mode to handle multi-line input
David Bateman <dbateman@free.fr>
parents: 7018
diff changeset
59
6b521b1e3631 Add dbquit and make dbstep compatible. Use parser in debug mode to handle multi-line input
David Bateman <dbateman@free.fr>
parents: 7018
diff changeset
60 To leave the debug mode, you should simply type either @code{dbcont}
6b521b1e3631 Add dbquit and make dbstep compatible. Use parser in debug mode to handle multi-line input
David Bateman <dbateman@free.fr>
parents: 7018
diff changeset
61 or @code{return}.
6b521b1e3631 Add dbquit and make dbstep compatible. Use parser in debug mode to handle multi-line input
David Bateman <dbateman@free.fr>
parents: 7018
diff changeset
62
8275
aaccb1362347 debug.txi: typo
Soren Hauberg <hauberg@gmail.com>
parents: 7984
diff changeset
63 @DOCSTRING(dbcont)
7787
6b521b1e3631 Add dbquit and make dbstep compatible. Use parser in debug mode to handle multi-line input
David Bateman <dbateman@free.fr>
parents: 7018
diff changeset
64
6b521b1e3631 Add dbquit and make dbstep compatible. Use parser in debug mode to handle multi-line input
David Bateman <dbateman@free.fr>
parents: 7018
diff changeset
65 To quit debug mode and return directly to the prompt @code{dbquit}
6b521b1e3631 Add dbquit and make dbstep compatible. Use parser in debug mode to handle multi-line input
David Bateman <dbateman@free.fr>
parents: 7018
diff changeset
66 should be used instead
6b521b1e3631 Add dbquit and make dbstep compatible. Use parser in debug mode to handle multi-line input
David Bateman <dbateman@free.fr>
parents: 7018
diff changeset
67
6b521b1e3631 Add dbquit and make dbstep compatible. Use parser in debug mode to handle multi-line input
David Bateman <dbateman@free.fr>
parents: 7018
diff changeset
68 @DOCSTRING(dbquit)
6b521b1e3631 Add dbquit and make dbstep compatible. Use parser in debug mode to handle multi-line input
David Bateman <dbateman@free.fr>
parents: 7018
diff changeset
69
6b521b1e3631 Add dbquit and make dbstep compatible. Use parser in debug mode to handle multi-line input
David Bateman <dbateman@free.fr>
parents: 7018
diff changeset
70 Finally, typing @code{exit} or @code{quit} at the debug prompt will
6b521b1e3631 Add dbquit and make dbstep compatible. Use parser in debug mode to handle multi-line input
David Bateman <dbateman@free.fr>
parents: 7018
diff changeset
71 result in Octave terminating normally.
6b521b1e3631 Add dbquit and make dbstep compatible. Use parser in debug mode to handle multi-line input
David Bateman <dbateman@free.fr>
parents: 7018
diff changeset
72
6646
bd0a70c3f2db [project @ 2007-05-22 02:27:43 by jwe]
jwe
parents: 4185
diff changeset
73 @node Breakpoints
bd0a70c3f2db [project @ 2007-05-22 02:27:43 by jwe]
jwe
parents: 4185
diff changeset
74 @section Breakpoints
bd0a70c3f2db [project @ 2007-05-22 02:27:43 by jwe]
jwe
parents: 4185
diff changeset
75
bd0a70c3f2db [project @ 2007-05-22 02:27:43 by jwe]
jwe
parents: 4185
diff changeset
76 Breakpoints can be set in any Octave function, using the @code{dbstop}
bd0a70c3f2db [project @ 2007-05-22 02:27:43 by jwe]
jwe
parents: 4185
diff changeset
77 function.
bd0a70c3f2db [project @ 2007-05-22 02:27:43 by jwe]
jwe
parents: 4185
diff changeset
78
bd0a70c3f2db [project @ 2007-05-22 02:27:43 by jwe]
jwe
parents: 4185
diff changeset
79 @DOCSTRING(dbstop)
bd0a70c3f2db [project @ 2007-05-22 02:27:43 by jwe]
jwe
parents: 4185
diff changeset
80
bd0a70c3f2db [project @ 2007-05-22 02:27:43 by jwe]
jwe
parents: 4185
diff changeset
81 @noindent
8347
fa78cb8d8a5c corrections for typos
Brian Gough<bjg@network-theory.co.uk>
parents: 8286
diff changeset
82 Note that breakpoints cannot be set in built-in functions
6646
bd0a70c3f2db [project @ 2007-05-22 02:27:43 by jwe]
jwe
parents: 4185
diff changeset
83 (eg. @code{sin}, etc) or dynamically loaded function (ie. oct-files). To
bd0a70c3f2db [project @ 2007-05-22 02:27:43 by jwe]
jwe
parents: 4185
diff changeset
84 set a breakpoint immediately on entering a function, the breakpoint
bd0a70c3f2db [project @ 2007-05-22 02:27:43 by jwe]
jwe
parents: 4185
diff changeset
85 should be set to line 1. The leading comment block will be ignored and
bd0a70c3f2db [project @ 2007-05-22 02:27:43 by jwe]
jwe
parents: 4185
diff changeset
86 the breakpoint will be set to the first executable statement in the
bd0a70c3f2db [project @ 2007-05-22 02:27:43 by jwe]
jwe
parents: 4185
diff changeset
87 function. For example
bd0a70c3f2db [project @ 2007-05-22 02:27:43 by jwe]
jwe
parents: 4185
diff changeset
88
bd0a70c3f2db [project @ 2007-05-22 02:27:43 by jwe]
jwe
parents: 4185
diff changeset
89 @example
bd0a70c3f2db [project @ 2007-05-22 02:27:43 by jwe]
jwe
parents: 4185
diff changeset
90 @group
bd0a70c3f2db [project @ 2007-05-22 02:27:43 by jwe]
jwe
parents: 4185
diff changeset
91 dbstop ("asind", 1)
bd0a70c3f2db [project @ 2007-05-22 02:27:43 by jwe]
jwe
parents: 4185
diff changeset
92 @result{} 27
bd0a70c3f2db [project @ 2007-05-22 02:27:43 by jwe]
jwe
parents: 4185
diff changeset
93 @end group
bd0a70c3f2db [project @ 2007-05-22 02:27:43 by jwe]
jwe
parents: 4185
diff changeset
94 @end example
bd0a70c3f2db [project @ 2007-05-22 02:27:43 by jwe]
jwe
parents: 4185
diff changeset
95
bd0a70c3f2db [project @ 2007-05-22 02:27:43 by jwe]
jwe
parents: 4185
diff changeset
96 @noindent
bd0a70c3f2db [project @ 2007-05-22 02:27:43 by jwe]
jwe
parents: 4185
diff changeset
97 Note that the return value of @code{27} means that the breakpoint was
bd0a70c3f2db [project @ 2007-05-22 02:27:43 by jwe]
jwe
parents: 4185
diff changeset
98 effectively set to line 27. The status of breakpoints in a function can
bd0a70c3f2db [project @ 2007-05-22 02:27:43 by jwe]
jwe
parents: 4185
diff changeset
99 be queried with the @code{dbstatus} function.
bd0a70c3f2db [project @ 2007-05-22 02:27:43 by jwe]
jwe
parents: 4185
diff changeset
100
bd0a70c3f2db [project @ 2007-05-22 02:27:43 by jwe]
jwe
parents: 4185
diff changeset
101 @DOCSTRING(dbstatus)
bd0a70c3f2db [project @ 2007-05-22 02:27:43 by jwe]
jwe
parents: 4185
diff changeset
102
bd0a70c3f2db [project @ 2007-05-22 02:27:43 by jwe]
jwe
parents: 4185
diff changeset
103 @noindent
bd0a70c3f2db [project @ 2007-05-22 02:27:43 by jwe]
jwe
parents: 4185
diff changeset
104 Taking the above as an example, @code{dbstatus ("asind")} should return
bd0a70c3f2db [project @ 2007-05-22 02:27:43 by jwe]
jwe
parents: 4185
diff changeset
105 27. The breakpoints can then be cleared with the @code{dbclear} function
bd0a70c3f2db [project @ 2007-05-22 02:27:43 by jwe]
jwe
parents: 4185
diff changeset
106
bd0a70c3f2db [project @ 2007-05-22 02:27:43 by jwe]
jwe
parents: 4185
diff changeset
107 @DOCSTRING(dbclear)
bd0a70c3f2db [project @ 2007-05-22 02:27:43 by jwe]
jwe
parents: 4185
diff changeset
108
bd0a70c3f2db [project @ 2007-05-22 02:27:43 by jwe]
jwe
parents: 4185
diff changeset
109 @noindent
bd0a70c3f2db [project @ 2007-05-22 02:27:43 by jwe]
jwe
parents: 4185
diff changeset
110 To clear all of the breakpoints in a function the recommended means,
bd0a70c3f2db [project @ 2007-05-22 02:27:43 by jwe]
jwe
parents: 4185
diff changeset
111 following the above example, is then
bd0a70c3f2db [project @ 2007-05-22 02:27:43 by jwe]
jwe
parents: 4185
diff changeset
112
bd0a70c3f2db [project @ 2007-05-22 02:27:43 by jwe]
jwe
parents: 4185
diff changeset
113 @example
bd0a70c3f2db [project @ 2007-05-22 02:27:43 by jwe]
jwe
parents: 4185
diff changeset
114 dbclear ("asind", dbstatus ("asind"));
bd0a70c3f2db [project @ 2007-05-22 02:27:43 by jwe]
jwe
parents: 4185
diff changeset
115 @end example
bd0a70c3f2db [project @ 2007-05-22 02:27:43 by jwe]
jwe
parents: 4185
diff changeset
116
7984
bbaa5d7d0143 Some documentation updates
David Bateman <dbateman@free.fr>
parents: 7787
diff changeset
117 A breakpoint can be set in a subfunction. For example if a file contains
bbaa5d7d0143 Some documentation updates
David Bateman <dbateman@free.fr>
parents: 7787
diff changeset
118 the functions
bbaa5d7d0143 Some documentation updates
David Bateman <dbateman@free.fr>
parents: 7787
diff changeset
119
bbaa5d7d0143 Some documentation updates
David Bateman <dbateman@free.fr>
parents: 7787
diff changeset
120 @example
bbaa5d7d0143 Some documentation updates
David Bateman <dbateman@free.fr>
parents: 7787
diff changeset
121 function y = func1 (x)
bbaa5d7d0143 Some documentation updates
David Bateman <dbateman@free.fr>
parents: 7787
diff changeset
122 y = func2 (x);
bbaa5d7d0143 Some documentation updates
David Bateman <dbateman@free.fr>
parents: 7787
diff changeset
123 endfunction
bbaa5d7d0143 Some documentation updates
David Bateman <dbateman@free.fr>
parents: 7787
diff changeset
124 function y = func2 (x)
bbaa5d7d0143 Some documentation updates
David Bateman <dbateman@free.fr>
parents: 7787
diff changeset
125 y = x + 1;
bbaa5d7d0143 Some documentation updates
David Bateman <dbateman@free.fr>
parents: 7787
diff changeset
126 endfunction
bbaa5d7d0143 Some documentation updates
David Bateman <dbateman@free.fr>
parents: 7787
diff changeset
127 @end example
bbaa5d7d0143 Some documentation updates
David Bateman <dbateman@free.fr>
parents: 7787
diff changeset
128
bbaa5d7d0143 Some documentation updates
David Bateman <dbateman@free.fr>
parents: 7787
diff changeset
129 @noindent
bbaa5d7d0143 Some documentation updates
David Bateman <dbateman@free.fr>
parents: 7787
diff changeset
130 then a breakpoint can be set at the start of the subfunction directly
bbaa5d7d0143 Some documentation updates
David Bateman <dbateman@free.fr>
parents: 7787
diff changeset
131 with
bbaa5d7d0143 Some documentation updates
David Bateman <dbateman@free.fr>
parents: 7787
diff changeset
132
bbaa5d7d0143 Some documentation updates
David Bateman <dbateman@free.fr>
parents: 7787
diff changeset
133 @example
bbaa5d7d0143 Some documentation updates
David Bateman <dbateman@free.fr>
parents: 7787
diff changeset
134 @group
bbaa5d7d0143 Some documentation updates
David Bateman <dbateman@free.fr>
parents: 7787
diff changeset
135 dbstop (["func1", filemarker(), "func2"])
bbaa5d7d0143 Some documentation updates
David Bateman <dbateman@free.fr>
parents: 7787
diff changeset
136 @result{} 5
bbaa5d7d0143 Some documentation updates
David Bateman <dbateman@free.fr>
parents: 7787
diff changeset
137 @end group
bbaa5d7d0143 Some documentation updates
David Bateman <dbateman@free.fr>
parents: 7787
diff changeset
138 @end example
bbaa5d7d0143 Some documentation updates
David Bateman <dbateman@free.fr>
parents: 7787
diff changeset
139
bbaa5d7d0143 Some documentation updates
David Bateman <dbateman@free.fr>
parents: 7787
diff changeset
140 Note that @code{filemarker} returns a character that marks the
bbaa5d7d0143 Some documentation updates
David Bateman <dbateman@free.fr>
parents: 7787
diff changeset
141 subfunctions from the file containing them.
bbaa5d7d0143 Some documentation updates
David Bateman <dbateman@free.fr>
parents: 7787
diff changeset
142
6646
bd0a70c3f2db [project @ 2007-05-22 02:27:43 by jwe]
jwe
parents: 4185
diff changeset
143 Another simple means of setting a breakpoint in an Octave script is the
bd0a70c3f2db [project @ 2007-05-22 02:27:43 by jwe]
jwe
parents: 4185
diff changeset
144 use of the @code{keyboard} function.
bd0a70c3f2db [project @ 2007-05-22 02:27:43 by jwe]
jwe
parents: 4185
diff changeset
145
bd0a70c3f2db [project @ 2007-05-22 02:27:43 by jwe]
jwe
parents: 4185
diff changeset
146 @DOCSTRING(keyboard)
bd0a70c3f2db [project @ 2007-05-22 02:27:43 by jwe]
jwe
parents: 4185
diff changeset
147
bd0a70c3f2db [project @ 2007-05-22 02:27:43 by jwe]
jwe
parents: 4185
diff changeset
148 @noindent
bd0a70c3f2db [project @ 2007-05-22 02:27:43 by jwe]
jwe
parents: 4185
diff changeset
149 The @code{keyboard} function is typically placed in a script at the
bd0a70c3f2db [project @ 2007-05-22 02:27:43 by jwe]
jwe
parents: 4185
diff changeset
150 point where the user desires that the execution is stopped. It
bd0a70c3f2db [project @ 2007-05-22 02:27:43 by jwe]
jwe
parents: 4185
diff changeset
151 automatically sets the running script into the debug mode.
bd0a70c3f2db [project @ 2007-05-22 02:27:43 by jwe]
jwe
parents: 4185
diff changeset
152
bd0a70c3f2db [project @ 2007-05-22 02:27:43 by jwe]
jwe
parents: 4185
diff changeset
153 @node Debug Mode
bd0a70c3f2db [project @ 2007-05-22 02:27:43 by jwe]
jwe
parents: 4185
diff changeset
154 @section Debug Mode
bd0a70c3f2db [project @ 2007-05-22 02:27:43 by jwe]
jwe
parents: 4185
diff changeset
155
bd0a70c3f2db [project @ 2007-05-22 02:27:43 by jwe]
jwe
parents: 4185
diff changeset
156 There are two additional support functions that allow the user to
bd0a70c3f2db [project @ 2007-05-22 02:27:43 by jwe]
jwe
parents: 4185
diff changeset
157 interrogate where in the execution of a script Octave entered the debug
bd0a70c3f2db [project @ 2007-05-22 02:27:43 by jwe]
jwe
parents: 4185
diff changeset
158 mode and to print the code in the script surrounding the point where
bd0a70c3f2db [project @ 2007-05-22 02:27:43 by jwe]
jwe
parents: 4185
diff changeset
159 Octave entered debug mode.
bd0a70c3f2db [project @ 2007-05-22 02:27:43 by jwe]
jwe
parents: 4185
diff changeset
160
bd0a70c3f2db [project @ 2007-05-22 02:27:43 by jwe]
jwe
parents: 4185
diff changeset
161 @DOCSTRING(dbwhere)
bd0a70c3f2db [project @ 2007-05-22 02:27:43 by jwe]
jwe
parents: 4185
diff changeset
162
bd0a70c3f2db [project @ 2007-05-22 02:27:43 by jwe]
jwe
parents: 4185
diff changeset
163 @DOCSTRING(dbtype)
6647
415b8b0106d0 [project @ 2007-05-22 02:57:21 by jwe]
jwe
parents: 6646
diff changeset
164
6648
4971ff18d2d7 [project @ 2007-05-22 03:17:36 by jwe]
jwe
parents: 6647
diff changeset
165 Debug mode equally allows single line stepping through a function using
7787
6b521b1e3631 Add dbquit and make dbstep compatible. Use parser in debug mode to handle multi-line input
David Bateman <dbateman@free.fr>
parents: 7018
diff changeset
166 the commands @code{dbstep}.
6b521b1e3631 Add dbquit and make dbstep compatible. Use parser in debug mode to handle multi-line input
David Bateman <dbateman@free.fr>
parents: 7018
diff changeset
167
6b521b1e3631 Add dbquit and make dbstep compatible. Use parser in debug mode to handle multi-line input
David Bateman <dbateman@free.fr>
parents: 7018
diff changeset
168 @c leave dbnext undocumented
6b521b1e3631 Add dbquit and make dbstep compatible. Use parser in debug mode to handle multi-line input
David Bateman <dbateman@free.fr>
parents: 7018
diff changeset
169
8286
6f2d95255911 fix @seealso references to point to existing anchors
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 8275
diff changeset
170 @anchor{doc-dbnext}
7787
6b521b1e3631 Add dbquit and make dbstep compatible. Use parser in debug mode to handle multi-line input
David Bateman <dbateman@free.fr>
parents: 7018
diff changeset
171 @DOCSTRING(dbstep)
6b521b1e3631 Add dbquit and make dbstep compatible. Use parser in debug mode to handle multi-line input
David Bateman <dbateman@free.fr>
parents: 7018
diff changeset
172
6b521b1e3631 Add dbquit and make dbstep compatible. Use parser in debug mode to handle multi-line input
David Bateman <dbateman@free.fr>
parents: 7018
diff changeset
173 @node Call Stack
6b521b1e3631 Add dbquit and make dbstep compatible. Use parser in debug mode to handle multi-line input
David Bateman <dbateman@free.fr>
parents: 7018
diff changeset
174 @section Call Stack
6b521b1e3631 Add dbquit and make dbstep compatible. Use parser in debug mode to handle multi-line input
David Bateman <dbateman@free.fr>
parents: 7018
diff changeset
175
6b521b1e3631 Add dbquit and make dbstep compatible. Use parser in debug mode to handle multi-line input
David Bateman <dbateman@free.fr>
parents: 7018
diff changeset
176 @DOCSTRING(dbstack)
6b521b1e3631 Add dbquit and make dbstep compatible. Use parser in debug mode to handle multi-line input
David Bateman <dbateman@free.fr>
parents: 7018
diff changeset
177
6b521b1e3631 Add dbquit and make dbstep compatible. Use parser in debug mode to handle multi-line input
David Bateman <dbateman@free.fr>
parents: 7018
diff changeset
178 @DOCSTRING(dbup)
6b521b1e3631 Add dbquit and make dbstep compatible. Use parser in debug mode to handle multi-line input
David Bateman <dbateman@free.fr>
parents: 7018
diff changeset
179
6b521b1e3631 Add dbquit and make dbstep compatible. Use parser in debug mode to handle multi-line input
David Bateman <dbateman@free.fr>
parents: 7018
diff changeset
180 @DOCSTRING(dbdown)