Mercurial > octave-antonio

annotate scripts/miscellaneous/debug.m @ 20164:df437a52bcaf stable

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc: Update more docstrings to have one sentence summary as first line. Reviewed miscellaneous, sparse, strings in scripts directory. * scripts/miscellaneous/bzip2.m, scripts/miscellaneous/citation.m, scripts/miscellaneous/compare_versions.m, scripts/miscellaneous/computer.m, scripts/miscellaneous/debug.m, scripts/miscellaneous/dir.m, scripts/miscellaneous/edit.m, scripts/miscellaneous/error_ids.m, scripts/miscellaneous/fileattrib.m, scripts/miscellaneous/fullfile.m, scripts/miscellaneous/genvarname.m, scripts/miscellaneous/gzip.m, scripts/miscellaneous/mkoctfile.m, scripts/miscellaneous/news.m, scripts/miscellaneous/open.m, scripts/miscellaneous/parseparams.m, scripts/miscellaneous/recycle.m, scripts/miscellaneous/run.m, scripts/miscellaneous/swapbytes.m, scripts/miscellaneous/tar.m, scripts/miscellaneous/tmpnam.m, scripts/miscellaneous/unpack.m, scripts/miscellaneous/what.m, scripts/sparse/bicg.m, scripts/sparse/bicgstab.m, scripts/sparse/cgs.m, scripts/sparse/colperm.m, scripts/sparse/eigs.m, scripts/sparse/etreeplot.m, scripts/sparse/gmres.m, scripts/sparse/gplot.m, scripts/sparse/ichol.m, scripts/sparse/ilu.m, scripts/sparse/pcg.m, scripts/sparse/pcr.m, scripts/sparse/qmr.m, scripts/sparse/spaugment.m, scripts/sparse/spconvert.m, scripts/sparse/spdiags.m, scripts/sparse/spfun.m, scripts/sparse/spones.m, scripts/sparse/sprandsym.m, scripts/sparse/spstats.m, scripts/sparse/spy.m, scripts/sparse/svds.m, scripts/sparse/treelayout.m, scripts/sparse/treeplot.m, scripts/strings/base2dec.m, scripts/strings/bin2dec.m, scripts/strings/blanks.m, scripts/strings/cstrcat.m, scripts/strings/deblank.m, scripts/strings/dec2base.m, scripts/strings/dec2bin.m, scripts/strings/dec2hex.m, scripts/strings/findstr.m, scripts/strings/hex2dec.m, scripts/strings/index.m, scripts/strings/isletter.m, scripts/strings/isstrprop.m, scripts/strings/mat2str.m, scripts/strings/ostrsplit.m, scripts/strings/regexptranslate.m, scripts/strings/rindex.m, scripts/strings/str2num.m, scripts/strings/strcat.m, scripts/strings/strchr.m, scripts/strings/strjoin.m, scripts/strings/strjust.m, scripts/strings/strmatch.m, scripts/strings/strsplit.m, scripts/strings/strtok.m, scripts/strings/strtrim.m, scripts/strings/strtrunc.m, scripts/strings/substr.m, scripts/strings/untabify.m, scripts/time/datenum.m: Update more docstrings to have one sentence summary as first line.
author Rik <rik@octave.org>
date Mon, 04 May 2015 14:22:02 -0700
parents 4197fc428c7d
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
19697
4197fc428c7d maint: Update copyright notices for 2015.
John W. Eaton <jwe@octave.org>
parents: 19596
diff changeset
1 ## Copyright (C) 2008-2015 David Bateman
7817
31fb919ba0c0 Add the debug function
David Bateman <dbateman@free.fr>
parents:
diff changeset
2 ##
31fb919ba0c0 Add the debug function
David Bateman <dbateman@free.fr>
parents:
diff changeset
3 ## This file is part of Octave.
31fb919ba0c0 Add the debug function
David Bateman <dbateman@free.fr>
parents:
diff changeset
4 ##
31fb919ba0c0 Add the debug function
David Bateman <dbateman@free.fr>
parents:
diff changeset
5 ## Octave is free software; you can redistribute it and/or modify it
31fb919ba0c0 Add the debug function
David Bateman <dbateman@free.fr>
parents:
diff changeset
6 ## under the terms of the GNU General Public License as published by
31fb919ba0c0 Add the debug function
David Bateman <dbateman@free.fr>
parents:
diff changeset
7 ## the Free Software Foundation; either version 3 of the License, or (at
31fb919ba0c0 Add the debug function
David Bateman <dbateman@free.fr>
parents:
diff changeset
8 ## your option) any later version.
31fb919ba0c0 Add the debug function
David Bateman <dbateman@free.fr>
parents:
diff changeset
9 ##
31fb919ba0c0 Add the debug function
David Bateman <dbateman@free.fr>
parents:
diff changeset
10 ## Octave is distributed in the hope that it will be useful, but
31fb919ba0c0 Add the debug function
David Bateman <dbateman@free.fr>
parents:
diff changeset
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
31fb919ba0c0 Add the debug function
David Bateman <dbateman@free.fr>
parents:
diff changeset
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
31fb919ba0c0 Add the debug function
David Bateman <dbateman@free.fr>
parents:
diff changeset
13 ## General Public License for more details.
31fb919ba0c0 Add the debug function
David Bateman <dbateman@free.fr>
parents:
diff changeset
14 ##
31fb919ba0c0 Add the debug function
David Bateman <dbateman@free.fr>
parents:
diff changeset
15 ## You should have received a copy of the GNU General Public License
31fb919ba0c0 Add the debug function
David Bateman <dbateman@free.fr>
parents:
diff changeset
16 ## along with Octave; see the file COPYING. If not, see
31fb919ba0c0 Add the debug function
David Bateman <dbateman@free.fr>
parents:
diff changeset
17 ## <http://www.gnu.org/licenses/>.
31fb919ba0c0 Add the debug function
David Bateman <dbateman@free.fr>
parents:
diff changeset
18
31fb919ba0c0 Add the debug function
David Bateman <dbateman@free.fr>
parents:
diff changeset
19 ## -*- texinfo -*-
31fb919ba0c0 Add the debug function
David Bateman <dbateman@free.fr>
parents:
diff changeset
20 ## @deftypefn {Function File} {} debug ()
19177
0aa59fd7e6f1 debug.m: Mark documentation m-file as tested for BIST testing.
Rik <rik@octave.org>
parents: 18372
diff changeset
21 ## Summary of debugging commands.
0aa59fd7e6f1 debug.m: Mark documentation m-file as tested for BIST testing.
Rik <rik@octave.org>
parents: 18372
diff changeset
22 ##
0aa59fd7e6f1 debug.m: Mark documentation m-file as tested for BIST testing.
Rik <rik@octave.org>
parents: 18372
diff changeset
23 ## For more information on each command and available options use
0aa59fd7e6f1 debug.m: Mark documentation m-file as tested for BIST testing.
Rik <rik@octave.org>
parents: 18372
diff changeset
24 ## @code{help CMD}.
19593
446c46af4b42 strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 18372
diff changeset
25 ##
14050
472a25155d82 doc: Clarify documentation on debug commands (Bug #34712)
Rik <octave@nomad.inbox5.com>
parents: 13867
diff changeset
26 ## The debugging commands available in Octave are
7817
31fb919ba0c0 Add the debug function
David Bateman <dbateman@free.fr>
parents:
diff changeset
27 ##
31fb919ba0c0 Add the debug function
David Bateman <dbateman@free.fr>
parents:
diff changeset
28 ## @table @code
31fb919ba0c0 Add the debug function
David Bateman <dbateman@free.fr>
parents:
diff changeset
29 ## @item dbstop
31fb919ba0c0 Add the debug function
David Bateman <dbateman@free.fr>
parents:
diff changeset
30 ## Add a breakpoint.
31fb919ba0c0 Add the debug function
David Bateman <dbateman@free.fr>
parents:
diff changeset
31 ##
31fb919ba0c0 Add the debug function
David Bateman <dbateman@free.fr>
parents:
diff changeset
32 ## @item dbclear
31fb919ba0c0 Add the debug function
David Bateman <dbateman@free.fr>
parents:
diff changeset
33 ## Remove a breakpoint.
31fb919ba0c0 Add the debug function
David Bateman <dbateman@free.fr>
parents:
diff changeset
34 ##
31fb919ba0c0 Add the debug function
David Bateman <dbateman@free.fr>
parents:
diff changeset
35 ## @item dbstatus
31fb919ba0c0 Add the debug function
David Bateman <dbateman@free.fr>
parents:
diff changeset
36 ## List all breakpoints.
31fb919ba0c0 Add the debug function
David Bateman <dbateman@free.fr>
parents:
diff changeset
37 ##
14050
472a25155d82 doc: Clarify documentation on debug commands (Bug #34712)
Rik <octave@nomad.inbox5.com>
parents: 13867
diff changeset
38 ## @item dbwhere
472a25155d82 doc: Clarify documentation on debug commands (Bug #34712)
Rik <octave@nomad.inbox5.com>
parents: 13867
diff changeset
39 ## Report the current file and line number where execution is stopped.
472a25155d82 doc: Clarify documentation on debug commands (Bug #34712)
Rik <octave@nomad.inbox5.com>
parents: 13867
diff changeset
40 ##
472a25155d82 doc: Clarify documentation on debug commands (Bug #34712)
Rik <octave@nomad.inbox5.com>
parents: 13867
diff changeset
41 ## @item dbtype
18372
765520694992 doc: Add dblist to list of commands from 'help debug'.
Rik <rik@octave.org>
parents: 17744
diff changeset
42 ## Display the code of the function being debugged, enumerating
14050
472a25155d82 doc: Clarify documentation on debug commands (Bug #34712)
Rik <octave@nomad.inbox5.com>
parents: 13867
diff changeset
43 ## the line numbers.
472a25155d82 doc: Clarify documentation on debug commands (Bug #34712)
Rik <octave@nomad.inbox5.com>
parents: 13867
diff changeset
44 ##
18372
765520694992 doc: Add dblist to list of commands from 'help debug'.
Rik <rik@octave.org>
parents: 17744
diff changeset
45 ## @item dblist
765520694992 doc: Add dblist to list of commands from 'help debug'.
Rik <rik@octave.org>
parents: 17744
diff changeset
46 ## List 10 lines of code centered around the line number where execution is
765520694992 doc: Add dblist to list of commands from 'help debug'.
Rik <rik@octave.org>
parents: 17744
diff changeset
47 ## stopped.
765520694992 doc: Add dblist to list of commands from 'help debug'.
Rik <rik@octave.org>
parents: 17744
diff changeset
48 ##
14050
472a25155d82 doc: Clarify documentation on debug commands (Bug #34712)
Rik <octave@nomad.inbox5.com>
parents: 13867
diff changeset
49 ## @item dbstep
472a25155d82 doc: Clarify documentation on debug commands (Bug #34712)
Rik <octave@nomad.inbox5.com>
parents: 13867
diff changeset
50 ## @itemx dbnext
14053
4f7bbf1c6fe4 debug.m: Hint more at the capabilities of dbstep (bug #34712)
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 14050
diff changeset
51 ## Execute (step) one or more lines, follow execution into (step into) a
4f7bbf1c6fe4 debug.m: Hint more at the capabilities of dbstep (bug #34712)
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 14050
diff changeset
52 ## function call, or execute until the end of a function (step out), and
4f7bbf1c6fe4 debug.m: Hint more at the capabilities of dbstep (bug #34712)
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 14050
diff changeset
53 ## re-enter debug mode.
14050
472a25155d82 doc: Clarify documentation on debug commands (Bug #34712)
Rik <octave@nomad.inbox5.com>
parents: 13867
diff changeset
54 ##
7817
31fb919ba0c0 Add the debug function
David Bateman <dbateman@free.fr>
parents:
diff changeset
55 ## @item dbcont
14050
472a25155d82 doc: Clarify documentation on debug commands (Bug #34712)
Rik <octave@nomad.inbox5.com>
parents: 13867
diff changeset
56 ## Continue normal code execution from the debug prompt.
472a25155d82 doc: Clarify documentation on debug commands (Bug #34712)
Rik <octave@nomad.inbox5.com>
parents: 13867
diff changeset
57 ##
472a25155d82 doc: Clarify documentation on debug commands (Bug #34712)
Rik <octave@nomad.inbox5.com>
parents: 13867
diff changeset
58 ## @item dbquit
472a25155d82 doc: Clarify documentation on debug commands (Bug #34712)
Rik <octave@nomad.inbox5.com>
parents: 13867
diff changeset
59 ## Quit debugging mode immediately and return to the main prompt.
7817
31fb919ba0c0 Add the debug function
David Bateman <dbateman@free.fr>
parents:
diff changeset
60 ##
31fb919ba0c0 Add the debug function
David Bateman <dbateman@free.fr>
parents:
diff changeset
61 ## @item dbstack
31fb919ba0c0 Add the debug function
David Bateman <dbateman@free.fr>
parents:
diff changeset
62 ## Print a backtrace of the execution stack.
31fb919ba0c0 Add the debug function
David Bateman <dbateman@free.fr>
parents:
diff changeset
63 ##
31fb919ba0c0 Add the debug function
David Bateman <dbateman@free.fr>
parents:
diff changeset
64 ## @item dbup
14050
472a25155d82 doc: Clarify documentation on debug commands (Bug #34712)
Rik <octave@nomad.inbox5.com>
parents: 13867
diff changeset
65 ## Move up the execution stack.
7817
31fb919ba0c0 Add the debug function
David Bateman <dbateman@free.fr>
parents:
diff changeset
66 ##
31fb919ba0c0 Add the debug function
David Bateman <dbateman@free.fr>
parents:
diff changeset
67 ## @item dbdown
14050
472a25155d82 doc: Clarify documentation on debug commands (Bug #34712)
Rik <octave@nomad.inbox5.com>
parents: 13867
diff changeset
68 ## Move down the execution stack.
7817
31fb919ba0c0 Add the debug function
David Bateman <dbateman@free.fr>
parents:
diff changeset
69 ##
14050
472a25155d82 doc: Clarify documentation on debug commands (Bug #34712)
Rik <octave@nomad.inbox5.com>
parents: 13867
diff changeset
70 ## @item keyboard
472a25155d82 doc: Clarify documentation on debug commands (Bug #34712)
Rik <octave@nomad.inbox5.com>
parents: 13867
diff changeset
71 ## Force entry into debug mode from an m-file.
7817
31fb919ba0c0 Add the debug function
David Bateman <dbateman@free.fr>
parents:
diff changeset
72 ##
31fb919ba0c0 Add the debug function
David Bateman <dbateman@free.fr>
parents:
diff changeset
73 ## @item debug_on_error
14050
472a25155d82 doc: Clarify documentation on debug commands (Bug #34712)
Rik <octave@nomad.inbox5.com>
parents: 13867
diff changeset
74 ## Configure whether Octave enters debug mode when it encounters an error.
7817
31fb919ba0c0 Add the debug function
David Bateman <dbateman@free.fr>
parents:
diff changeset
75 ##
31fb919ba0c0 Add the debug function
David Bateman <dbateman@free.fr>
parents:
diff changeset
76 ## @item debug_on_warning
14050
472a25155d82 doc: Clarify documentation on debug commands (Bug #34712)
Rik <octave@nomad.inbox5.com>
parents: 13867
diff changeset
77 ## Configure whether Octave enters debug mode when it encounters a warning.
7817
31fb919ba0c0 Add the debug function
David Bateman <dbateman@free.fr>
parents:
diff changeset
78 ##
31fb919ba0c0 Add the debug function
David Bateman <dbateman@free.fr>
parents:
diff changeset
79 ## @item debug_on_interrupt
14050
472a25155d82 doc: Clarify documentation on debug commands (Bug #34712)
Rik <octave@nomad.inbox5.com>
parents: 13867
diff changeset
80 ## Configure whether Octave enters debug mode when it encounters an interrupt.
11587
c792872f8942 all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
81 ##
14050
472a25155d82 doc: Clarify documentation on debug commands (Bug #34712)
Rik <octave@nomad.inbox5.com>
parents: 13867
diff changeset
82 ## @item isdebugmode
472a25155d82 doc: Clarify documentation on debug commands (Bug #34712)
Rik <octave@nomad.inbox5.com>
parents: 13867
diff changeset
83 ## Return true if in debug mode.
7817
31fb919ba0c0 Add the debug function
David Bateman <dbateman@free.fr>
parents:
diff changeset
84 ## @end table
31fb919ba0c0 Add the debug function
David Bateman <dbateman@free.fr>
parents:
diff changeset
85 ##
31fb919ba0c0 Add the debug function
David Bateman <dbateman@free.fr>
parents:
diff changeset
86 ## @noindent
20164
df437a52bcaf doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19697
diff changeset
87 ## When Octave encounters a breakpoint, or other reason to enter debug mode,
df437a52bcaf doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19697
diff changeset
88 ## the prompt changes to @qcode{"debug>"}. The workspace of the function
7817
31fb919ba0c0 Add the debug function
David Bateman <dbateman@free.fr>
parents:
diff changeset
89 ## where the breakpoint was encountered becomes available and any Octave
14050
472a25155d82 doc: Clarify documentation on debug commands (Bug #34712)
Rik <octave@nomad.inbox5.com>
parents: 13867
diff changeset
90 ## command that is valid in that workspace context may be executed.
7817
31fb919ba0c0 Add the debug function
David Bateman <dbateman@free.fr>
parents:
diff changeset
91 ##
14050
472a25155d82 doc: Clarify documentation on debug commands (Bug #34712)
Rik <octave@nomad.inbox5.com>
parents: 13867
diff changeset
92 ## @seealso{dbstop, dbclear, dbstatus, dbwhere, dbtype, dbcont, dbquit,
17341
f4772605aec3 debug.m: Fix spacing in @seealso macro (bug #39871)
Rik <rik@octave.org>
parents: 17338
diff changeset
93 ## dbstack, dbup, dbdown, keyboard, debug_on_error, debug_on_warning,
f4772605aec3 debug.m: Fix spacing in @seealso macro (bug #39871)
Rik <rik@octave.org>
parents: 17338
diff changeset
94 ## debug_on_interrupt, isdebugmode}
7817
31fb919ba0c0 Add the debug function
David Bateman <dbateman@free.fr>
parents:
diff changeset
95 ## @end deftypefn
31fb919ba0c0 Add the debug function
David Bateman <dbateman@free.fr>
parents:
diff changeset
96
31fb919ba0c0 Add the debug function
David Bateman <dbateman@free.fr>
parents:
diff changeset
97 function debug ()
31fb919ba0c0 Add the debug function
David Bateman <dbateman@free.fr>
parents:
diff changeset
98 help ("debug");
31fb919ba0c0 Add the debug function
David Bateman <dbateman@free.fr>
parents:
diff changeset
99 endfunction
17338
1c89599167a6 maint: End m-files with 1 blank line.
Rik <rik@octave.org>
parents: 17281
diff changeset
100
19177
0aa59fd7e6f1 debug.m: Mark documentation m-file as tested for BIST testing.
Rik <rik@octave.org>
parents: 18372
diff changeset
101
0aa59fd7e6f1 debug.m: Mark documentation m-file as tested for BIST testing.
Rik <rik@octave.org>
parents: 18372
diff changeset
102 ## Mark file as being tested. No real test needed for a documentation .m file
0aa59fd7e6f1 debug.m: Mark documentation m-file as tested for BIST testing.
Rik <rik@octave.org>
parents: 18372
diff changeset
103 %!assert (1)
0aa59fd7e6f1 debug.m: Mark documentation m-file as tested for BIST testing.
Rik <rik@octave.org>
parents: 18372
diff changeset
104