Mercurial > hg > octave-lyh
annotate scripts/miscellaneous/debug.m @ 17289:bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Macro handles options ("on") or properties ("position") more elegantly
than @code{"text"}.
* doc/interpreter/macros.texi: Add new @qcode macro.
* doc/interpreter/tips.txi: Add documentation about @qcode macro.
* doc/interpreter/basics.txi, doc/interpreter/container.txi,
doc/interpreter/emacs.txi, doc/interpreter/errors.txi,
doc/interpreter/eval.txi, doc/interpreter/expr.txi,
doc/interpreter/external.txi, doc/interpreter/func.txi,
doc/interpreter/grammar.txi, doc/interpreter/image.txi,
doc/interpreter/install.txi, doc/interpreter/interp.txi,
doc/interpreter/io.txi, doc/interpreter/matrix.txi,
doc/interpreter/numbers.txi, doc/interpreter/oop.txi,
doc/interpreter/package.txi, doc/interpreter/plot.txi,
doc/interpreter/quad.txi, doc/interpreter/sparse.txi,
doc/interpreter/strings.txi, doc/interpreter/system.txi,
doc/interpreter/vectorize.txi, libinterp/corefcn/balance.cc,
libinterp/corefcn/bitfcns.cc, libinterp/corefcn/cellfun.cc,
libinterp/corefcn/conv2.cc, libinterp/corefcn/data.cc,
libinterp/corefcn/debug.cc, libinterp/corefcn/defaults.cc,
libinterp/corefcn/dirfns.cc, libinterp/corefcn/dlmread.cc,
libinterp/corefcn/error.cc, libinterp/corefcn/file-io.cc,
libinterp/corefcn/find.cc, libinterp/corefcn/gammainc.cc,
libinterp/corefcn/graphics.cc, libinterp/corefcn/help.cc,
libinterp/corefcn/hex2num.cc, libinterp/corefcn/input.cc,
libinterp/corefcn/load-path.cc, libinterp/corefcn/load-save.cc,
libinterp/corefcn/ls-oct-ascii.cc, libinterp/corefcn/lu.cc,
libinterp/corefcn/luinc.cc, libinterp/corefcn/matrix_type.cc,
libinterp/corefcn/oct-hist.cc, libinterp/corefcn/pager.cc,
libinterp/corefcn/pr-output.cc, libinterp/corefcn/pt-jit.cc,
libinterp/corefcn/qz.cc, libinterp/corefcn/rand.cc,
libinterp/corefcn/regexp.cc, libinterp/corefcn/schur.cc,
libinterp/corefcn/sighandlers.cc, libinterp/corefcn/sparse.cc,
libinterp/corefcn/spparms.cc, libinterp/corefcn/str2double.cc,
libinterp/corefcn/svd.cc, libinterp/corefcn/symtab.cc,
libinterp/corefcn/syscalls.cc, libinterp/corefcn/toplev.cc,
libinterp/corefcn/tril.cc, libinterp/corefcn/typecast.cc,
libinterp/corefcn/utils.cc, libinterp/corefcn/variables.cc,
libinterp/dldfcn/__init_fltk__.cc, libinterp/dldfcn/chol.cc,
libinterp/dldfcn/colamd.cc, libinterp/dldfcn/fftw.cc, libinterp/dldfcn/qr.cc,
libinterp/dldfcn/symbfact.cc, libinterp/octave-value/ov-base.cc,
libinterp/octave-value/ov-fcn-handle.cc,
libinterp/octave-value/ov-fcn-inline.cc, libinterp/octave-value/ov-java.cc,
libinterp/octave-value/ov-range.cc, libinterp/octave-value/ov-struct.cc,
libinterp/octave-value/ov-usr-fcn.cc, libinterp/parse-tree/oct-parse.in.yy,
libinterp/parse-tree/pt-binop.cc, libinterp/parse-tree/pt-eval.cc,
libinterp/parse-tree/pt-mat.cc, scripts/@ftp/ftp.m,
scripts/deprecated/java_convert_matrix.m, scripts/deprecated/java_debug.m,
scripts/deprecated/java_unsigned_conversion.m, scripts/deprecated/shell_cmd.m,
scripts/general/dblquad.m, scripts/general/display.m,
scripts/general/genvarname.m, scripts/general/idivide.m,
scripts/general/interp1.m, scripts/general/interp2.m,
scripts/general/interp3.m, scripts/general/interpn.m, scripts/general/isa.m,
scripts/general/profexplore.m, scripts/general/profile.m,
scripts/general/quadgk.m, scripts/general/randi.m, scripts/general/structfun.m,
scripts/general/subsindex.m, scripts/general/triplequad.m,
scripts/geometry/griddata.m, scripts/geometry/griddata3.m,
scripts/geometry/griddatan.m, scripts/geometry/voronoi.m, scripts/help/help.m,
scripts/help/lookfor.m, scripts/image/cmpermute.m, scripts/image/colormap.m,
scripts/image/image.m, scripts/image/imagesc.m, scripts/image/imfinfo.m,
scripts/image/imformats.m, scripts/image/imread.m, scripts/image/imshow.m,
scripts/image/imwrite.m, scripts/image/ind2gray.m, scripts/image/lines.m,
scripts/image/rgb2ind.m, scripts/image/spinmap.m, scripts/io/dlmwrite.m,
scripts/io/strread.m, scripts/io/textread.m, scripts/io/textscan.m,
scripts/java/javaclasspath.m, scripts/java/usejava.m,
scripts/miscellaneous/bzip2.m, scripts/miscellaneous/computer.m,
scripts/miscellaneous/copyfile.m, scripts/miscellaneous/debug.m,
scripts/miscellaneous/dos.m, scripts/miscellaneous/edit.m,
scripts/miscellaneous/gzip.m, scripts/miscellaneous/license.m,
scripts/miscellaneous/mkoctfile.m, scripts/miscellaneous/movefile.m,
scripts/miscellaneous/parseparams.m, scripts/miscellaneous/unix.m,
scripts/optimization/fminbnd.m, scripts/optimization/fminsearch.m,
scripts/optimization/fminunc.m, scripts/optimization/fsolve.m,
scripts/optimization/fzero.m, scripts/optimization/glpk.m,
scripts/optimization/lsqnonneg.m, scripts/optimization/optimset.m,
scripts/optimization/pqpnonneg.m, scripts/pkg/pkg.m, scripts/plot/allchild.m,
scripts/plot/ancestor.m, scripts/plot/area.m, scripts/plot/axis.m,
scripts/plot/bar.m, scripts/plot/barh.m, scripts/plot/box.m,
scripts/plot/caxis.m, scripts/plot/cla.m, scripts/plot/clabel.m,
scripts/plot/clf.m, scripts/plot/close.m, scripts/plot/colorbar.m,
scripts/plot/daspect.m, scripts/plot/ezmesh.m, scripts/plot/ezmeshc.m,
scripts/plot/ezsurf.m, scripts/plot/ezsurfc.m, scripts/plot/findall.m,
scripts/plot/findobj.m, scripts/plot/gcbo.m, scripts/plot/gcf.m,
scripts/plot/gco.m, scripts/plot/grid.m, scripts/plot/guihandles.m,
scripts/plot/hdl2struct.m, scripts/plot/hidden.m, scripts/plot/hold.m,
scripts/plot/isonormals.m, scripts/plot/isosurface.m, scripts/plot/legend.m,
scripts/plot/mesh.m, scripts/plot/meshc.m, scripts/plot/meshz.m,
scripts/plot/newplot.m, scripts/plot/orient.m, scripts/plot/pareto.m,
scripts/plot/patch.m, scripts/plot/pbaspect.m, scripts/plot/pcolor.m,
scripts/plot/plot.m, scripts/plot/print.m,
scripts/plot/private/__add_default_menu__.m, scripts/plot/quiver.m,
scripts/plot/quiver3.m, scripts/plot/refreshdata.m, scripts/plot/saveas.m,
scripts/plot/scatter.m, scripts/plot/scatter3.m, scripts/plot/shading.m,
scripts/plot/shrinkfaces.m, scripts/plot/slice.m, scripts/plot/stem.m,
scripts/plot/stem3.m, scripts/plot/struct2hdl.m, scripts/plot/subplot.m,
scripts/plot/surf.m, scripts/plot/surfc.m, scripts/plot/surfl.m,
scripts/plot/tetramesh.m, scripts/plot/uigetfile.m, scripts/plot/uimenu.m,
scripts/plot/uiputfile.m, scripts/plot/waterfall.m, scripts/plot/whitebg.m,
scripts/plot/xlim.m, scripts/plot/ylim.m, scripts/plot/zlim.m,
scripts/polynomial/conv.m, scripts/polynomial/polyout.m,
scripts/polynomial/splinefit.m, scripts/set/ismember.m, scripts/set/powerset.m,
scripts/set/setdiff.m, scripts/set/union.m, scripts/set/unique.m,
scripts/signal/detrend.m, scripts/signal/filter2.m, scripts/signal/freqz.m,
scripts/signal/periodogram.m, scripts/signal/spectral_adf.m,
scripts/signal/spectral_xdf.m, scripts/sparse/eigs.m, scripts/sparse/svds.m,
scripts/specfun/legendre.m, scripts/special-matrix/gallery.m,
scripts/statistics/base/mean.m, scripts/statistics/base/moment.m,
scripts/statistics/tests/cor_test.m,
scripts/statistics/tests/kolmogorov_smirnov_test.m,
scripts/statistics/tests/kolmogorov_smirnov_test_2.m,
scripts/statistics/tests/kruskal_wallis_test.m,
scripts/statistics/tests/prop_test_2.m, scripts/statistics/tests/sign_test.m,
scripts/statistics/tests/t_test.m, scripts/statistics/tests/t_test_2.m,
scripts/statistics/tests/t_test_regression.m,
scripts/statistics/tests/u_test.m, scripts/statistics/tests/var_test.m,
scripts/statistics/tests/welch_test.m,
scripts/statistics/tests/wilcoxon_test.m, scripts/statistics/tests/z_test.m,
scripts/statistics/tests/z_test_2.m, scripts/strings/base2dec.m,
scripts/strings/index.m, scripts/strings/isstrprop.m,
scripts/strings/mat2str.m, scripts/strings/regexptranslate.m,
scripts/strings/rindex.m, scripts/strings/str2num.m, scripts/strings/strcat.m,
scripts/strings/strjust.m, scripts/strings/strmatch.m,
scripts/strings/validatestring.m, scripts/testfun/demo.m,
scripts/testfun/example.m, scripts/testfun/test.m, scripts/time/addtodate.m,
scripts/time/asctime.m, scripts/time/datestr.m, scripts/time/datetick.m,
scripts/time/weekday.m, scripts/ui/errordlg.m, scripts/ui/helpdlg.m,
scripts/ui/inputdlg.m, scripts/ui/listdlg.m, scripts/ui/msgbox.m,
scripts/ui/questdlg.m, scripts/ui/warndlg.m: Use new @qcode macro.
| author | Rik <rik@octave.org> |
|---|---|
| date | Mon, 19 Aug 2013 20:46:38 -0700 |
| parents | 72c96de7a403 |
| children | 1c89599167a6 |
| rev | line source |
|---|---|
|
14138
72c96de7a403
maint: update copyright notices for 2012
John W. Eaton <jwe@octave.org>
parents:
14053
diff
changeset
|
1 ## Copyright (C) 2008-2012 David Bateman |
| 7817 | 2 ## |
| 3 ## This file is part of Octave. | |
| 4 ## | |
| 5 ## Octave is free software; you can redistribute it and/or modify it | |
| 6 ## under the terms of the GNU General Public License as published by | |
| 7 ## the Free Software Foundation; either version 3 of the License, or (at | |
| 8 ## your option) any later version. | |
| 9 ## | |
| 10 ## Octave is distributed in the hope that it will be useful, but | |
| 11 ## WITHOUT ANY WARRANTY; without even the implied warranty of | |
| 12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
| 13 ## General Public License for more details. | |
| 14 ## | |
| 15 ## You should have received a copy of the GNU General Public License | |
| 16 ## along with Octave; see the file COPYING. If not, see | |
| 17 ## <http://www.gnu.org/licenses/>. | |
| 18 | |
| 19 ## -*- texinfo -*- | |
| 20 ## @deftypefn {Function File} {} debug () | |
|
14050
472a25155d82
doc: Clarify documentation on debug commands (Bug #34712)
Rik <octave@nomad.inbox5.com>
parents:
13867
diff
changeset
|
21 ## Summary of debugging commands. For more information on each command |
|
472a25155d82
doc: Clarify documentation on debug commands (Bug #34712)
Rik <octave@nomad.inbox5.com>
parents:
13867
diff
changeset
|
22 ## and available options use @code{help CMD}. |
|
472a25155d82
doc: Clarify documentation on debug commands (Bug #34712)
Rik <octave@nomad.inbox5.com>
parents:
13867
diff
changeset
|
23 ## |
|
472a25155d82
doc: Clarify documentation on debug commands (Bug #34712)
Rik <octave@nomad.inbox5.com>
parents:
13867
diff
changeset
|
24 ## The debugging commands available in Octave are |
| 7817 | 25 ## |
| 26 ## @table @code | |
| 27 ## @item dbstop | |
| 28 ## Add a breakpoint. | |
| 29 ## | |
| 30 ## @item dbclear | |
| 31 ## Remove a breakpoint. | |
| 32 ## | |
| 33 ## @item dbstatus | |
| 34 ## List all breakpoints. | |
| 35 ## | |
|
14050
472a25155d82
doc: Clarify documentation on debug commands (Bug #34712)
Rik <octave@nomad.inbox5.com>
parents:
13867
diff
changeset
|
36 ## @item dbwhere |
|
472a25155d82
doc: Clarify documentation on debug commands (Bug #34712)
Rik <octave@nomad.inbox5.com>
parents:
13867
diff
changeset
|
37 ## 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
|
38 ## |
|
472a25155d82
doc: Clarify documentation on debug commands (Bug #34712)
Rik <octave@nomad.inbox5.com>
parents:
13867
diff
changeset
|
39 ## @item dbtype |
|
472a25155d82
doc: Clarify documentation on debug commands (Bug #34712)
Rik <octave@nomad.inbox5.com>
parents:
13867
diff
changeset
|
40 ## List the function where execution is currently stopped, enumerating |
|
472a25155d82
doc: Clarify documentation on debug commands (Bug #34712)
Rik <octave@nomad.inbox5.com>
parents:
13867
diff
changeset
|
41 ## the line numbers. |
|
472a25155d82
doc: Clarify documentation on debug commands (Bug #34712)
Rik <octave@nomad.inbox5.com>
parents:
13867
diff
changeset
|
42 ## |
|
472a25155d82
doc: Clarify documentation on debug commands (Bug #34712)
Rik <octave@nomad.inbox5.com>
parents:
13867
diff
changeset
|
43 ## @item dbstep |
|
472a25155d82
doc: Clarify documentation on debug commands (Bug #34712)
Rik <octave@nomad.inbox5.com>
parents:
13867
diff
changeset
|
44 ## @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
|
45 ## 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
|
46 ## 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
|
47 ## re-enter debug mode. |
|
14050
472a25155d82
doc: Clarify documentation on debug commands (Bug #34712)
Rik <octave@nomad.inbox5.com>
parents:
13867
diff
changeset
|
48 ## |
| 7817 | 49 ## @item dbcont |
|
14050
472a25155d82
doc: Clarify documentation on debug commands (Bug #34712)
Rik <octave@nomad.inbox5.com>
parents:
13867
diff
changeset
|
50 ## 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
|
51 ## |
|
472a25155d82
doc: Clarify documentation on debug commands (Bug #34712)
Rik <octave@nomad.inbox5.com>
parents:
13867
diff
changeset
|
52 ## @item dbquit |
|
472a25155d82
doc: Clarify documentation on debug commands (Bug #34712)
Rik <octave@nomad.inbox5.com>
parents:
13867
diff
changeset
|
53 ## Quit debugging mode immediately and return to the main prompt. |
| 7817 | 54 ## |
| 55 ## @item dbstack | |
| 56 ## Print a backtrace of the execution stack. | |
| 57 ## | |
| 58 ## @item dbup | |
|
14050
472a25155d82
doc: Clarify documentation on debug commands (Bug #34712)
Rik <octave@nomad.inbox5.com>
parents:
13867
diff
changeset
|
59 ## Move up the execution stack. |
| 7817 | 60 ## |
| 61 ## @item dbdown | |
|
14050
472a25155d82
doc: Clarify documentation on debug commands (Bug #34712)
Rik <octave@nomad.inbox5.com>
parents:
13867
diff
changeset
|
62 ## Move down the execution stack. |
| 7817 | 63 ## |
|
14050
472a25155d82
doc: Clarify documentation on debug commands (Bug #34712)
Rik <octave@nomad.inbox5.com>
parents:
13867
diff
changeset
|
64 ## @item keyboard |
|
472a25155d82
doc: Clarify documentation on debug commands (Bug #34712)
Rik <octave@nomad.inbox5.com>
parents:
13867
diff
changeset
|
65 ## Force entry into debug mode from an m-file. |
| 7817 | 66 ## |
| 67 ## @item debug_on_error | |
|
14050
472a25155d82
doc: Clarify documentation on debug commands (Bug #34712)
Rik <octave@nomad.inbox5.com>
parents:
13867
diff
changeset
|
68 ## Configure whether Octave enters debug mode when it encounters an error. |
| 7817 | 69 ## |
| 70 ## @item debug_on_warning | |
|
14050
472a25155d82
doc: Clarify documentation on debug commands (Bug #34712)
Rik <octave@nomad.inbox5.com>
parents:
13867
diff
changeset
|
71 ## Configure whether Octave enters debug mode when it encounters a warning. |
| 7817 | 72 ## |
| 73 ## @item debug_on_interrupt | |
|
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 interrupt. |
|
11587
c792872f8942
all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
75 ## |
|
14050
472a25155d82
doc: Clarify documentation on debug commands (Bug #34712)
Rik <octave@nomad.inbox5.com>
parents:
13867
diff
changeset
|
76 ## @item isdebugmode |
|
472a25155d82
doc: Clarify documentation on debug commands (Bug #34712)
Rik <octave@nomad.inbox5.com>
parents:
13867
diff
changeset
|
77 ## Return true if in debug mode. |
| 7817 | 78 ## @end table |
| 79 ## | |
| 80 ## @noindent | |
|
14050
472a25155d82
doc: Clarify documentation on debug commands (Bug #34712)
Rik <octave@nomad.inbox5.com>
parents:
13867
diff
changeset
|
81 ## When Octave encounters a breakpoint, or other reason to enter debug |
|
17289
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
14138
diff
changeset
|
82 ## mode, the prompt changes to @qcode{"debug>"}. The workspace of the function |
| 7817 | 83 ## 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
|
84 ## command that is valid in that workspace context may be executed. |
| 7817 | 85 ## |
|
14050
472a25155d82
doc: Clarify documentation on debug commands (Bug #34712)
Rik <octave@nomad.inbox5.com>
parents:
13867
diff
changeset
|
86 ## @seealso{dbstop, dbclear, dbstatus, dbwhere, dbtype, dbcont, dbquit, |
|
472a25155d82
doc: Clarify documentation on debug commands (Bug #34712)
Rik <octave@nomad.inbox5.com>
parents:
13867
diff
changeset
|
87 ## dbstack, dbup, dbdown, keyboard, debug_on_error, debug_on_warning, |
|
472a25155d82
doc: Clarify documentation on debug commands (Bug #34712)
Rik <octave@nomad.inbox5.com>
parents:
13867
diff
changeset
|
88 ## debug_on_interrupt, isdebugmode} |
| 7817 | 89 ## @end deftypefn |
| 90 | |
| 91 function debug () | |
| 92 help ("debug"); | |
| 93 endfunction |