octave: scripts/miscellaneous/debug.m annotate

annotate scripts/miscellaneous/debug.m @ 23084:ef4d915df748

maint: Merge stable to default.

author	John W. Eaton <jwe@octave.org>
date	Mon, 23 Jan 2017 14:27:48 -0500
parents	3a2b891d0b33 e9a0469dedd9
children	092078913d54

rev	line source
22323 bac0d6f07a3e maint: Update copyright notices for 2016. John W. Eaton <jwe@octave.org> parents: 20852 diff changeset	1 ## Copyright (C) 2008-2016 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
22755 3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22323 diff changeset	7 ## the Free Software Foundation; either version 3 of the License, or
3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22323 diff changeset	8 ## (at your option) any later version.
7817 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
22755 3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22323 diff changeset	12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22323 diff changeset	13 ## GNU General Public License for more details.
7817 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 --
20852 516bb87ea72e 2015 Code Sprint: remove class of function from docstring for all m-files. Rik <rik@octave.org> parents: 20164 diff changeset	20 ## @deftypefn {} {} 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)

Mercurial > octave

annotate scripts/miscellaneous/debug.m @ 23084:ef4d915df748