Mercurial > hg > octave-lyh
annotate scripts/miscellaneous/debug.m @ 13867:922bfdd80413
Clean up help about old flags for debug variables
* debug.m: Change the wording about old flags into new functions
* pt-assign.cc (maybe_warn_former_built_in_variable): Clarify wording
about assigning values to functions.
| author | Jordi Gutiérrez Hermoso <jordigh@octave.org> |
|---|---|
| date | Mon, 14 Nov 2011 21:50:16 -0500 |
| parents | c792872f8942 |
| children | 472a25155d82 |
| rev | line source |
|---|---|
| 11523 | 1 ## Copyright (C) 2008-2011 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 () | |
|
9051
1bf0ce0930be
Grammar check TexInfo in all .m files
Rik <rdrider0-list@yahoo.com>
parents:
7817
diff
changeset
|
21 ## Summary of the debugging commands. The debugging commands that are |
| 7817 | 22 ## available in Octave are |
| 23 ## | |
| 24 ## @table @code | |
| 25 ## @item keyboard | |
| 26 ## Force entry into debug mode. | |
| 27 ## | |
| 28 ## @item dbstop | |
| 29 ## Add a breakpoint. | |
| 30 ## | |
| 31 ## @item dbclear | |
| 32 ## Remove a breakpoint. | |
| 33 ## | |
| 34 ## @item dbstatus | |
| 35 ## List all breakpoints. | |
| 36 ## | |
| 37 ## @item dbcont | |
| 38 ## Continue execution from the debug prompt. | |
| 39 ## | |
| 40 ## @item dbstack | |
| 41 ## Print a backtrace of the execution stack. | |
| 42 ## | |
| 43 ## @item dbstep | |
| 44 ## Execute one or more lines and re-enter debug mode | |
| 45 ## | |
| 46 ## @item dbtype | |
| 47 ## List the function where execution is currently stopped, enumerating | |
| 48 ## the lines. | |
| 49 ## | |
| 50 ## @item dbup | |
| 51 ## The workspace up the execution stack. | |
| 52 ## | |
| 53 ## @item dbdown | |
| 54 ## The workspace down the execution stack. | |
| 55 ## | |
| 56 ## @item dbquit | |
| 57 ## Quit debugging mode and return to the main prompt. | |
| 58 ## | |
| 59 ## @item debug_on_error | |
|
13867
922bfdd80413
Clean up help about old flags for debug variables
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
11587
diff
changeset
|
60 ## Function to query or set whether to enter debug mode in case Octave |
|
922bfdd80413
Clean up help about old flags for debug variables
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
11587
diff
changeset
|
61 ## encounters an error. |
| 7817 | 62 ## |
| 63 ## @item debug_on_warning | |
|
13867
922bfdd80413
Clean up help about old flags for debug variables
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
11587
diff
changeset
|
64 ## Function to query or set whether to enter debug mode in case Octave |
|
922bfdd80413
Clean up help about old flags for debug variables
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
11587
diff
changeset
|
65 ## encounters a warning. |
| 7817 | 66 ## |
| 67 ## @item debug_on_interrupt | |
|
13867
922bfdd80413
Clean up help about old flags for debug variables
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
11587
diff
changeset
|
68 ## Function to query or set whether to enter debug mode in case Octave |
|
922bfdd80413
Clean up help about old flags for debug variables
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
11587
diff
changeset
|
69 ## encounters an interupt. |
|
11587
c792872f8942
all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
70 ## |
| 7817 | 71 ## @end table |
| 72 ## | |
| 73 ## @noindent | |
| 74 ## when Octave encounters a breakpoint or other reason to enter debug | |
|
9051
1bf0ce0930be
Grammar check TexInfo in all .m files
Rik <rdrider0-list@yahoo.com>
parents:
7817
diff
changeset
|
75 ## mode, the prompt changes to @code{"debug>"}. The workspace of the function |
| 7817 | 76 ## where the breakpoint was encountered becomes available and any Octave |
| 77 ## command that works within that workspace may be executed. | |
| 78 ## | |
| 79 ## @seealso{dbstop, dbclear, dbstatus, dbcont, dbstack, dbstep, dbtype, | |
| 80 ## dbup, dbdown, dbquit, debug_on_error, debug_on_warning, | |
| 81 ## debug_on_interrupt} | |
| 82 ## @end deftypefn | |
| 83 | |
| 84 function debug () | |
| 85 help ("debug"); | |
| 86 endfunction |