Subject: addt'l minor debugger documentation issues
From: Robert Dodier
Date: Sat, 13 Dec 2003 20:34:59 -0800 (PST)
Hello,
I have collected some additional issues about the
debugger documentation. I'm hoping to revise the
texinfo files which have to do with the debugger and
then convince someone to commit the changes. Does
that seem like a plan?
I have specific changes in mind for each of these items,
so if anyone would like to discuss more details, that's great.
- merror.lisp: strike extraneous right parenthesis
in error message ("try DEBUGMODE(TRUE);)"),
and change "DEBUGMODE(TRUE)" to "DEBUGMODE:TRUE" since
DEBUGMODE is documented as a variable ?
- grep -i '$lispdebugmode' *.lisp; grep -i '$debugprintmode' *.lisp
-- yield only one commented-out line each
grep -i '$debug\W' *.lisp -- yields a commented-out line, and also
"(SUBC $DEBUGGING () $TRACE $DEBUG $DEBUGMODE $BREAK
$BINDTEST $OPTIONSET)" in option.lisp
- from this it appears that LISPDEBUGMODE, DEBUGPRINTMODE,
and DEBUG are obsolete
- Command.texi: strike entries for DEBUG and DEBUGPRINTMODE ?
- Program.texi: strike entry for LISPDEBUGMODE ?
- in debugger: "help" and "?" don't show help, only ":help"
-- so:
- merror.lisp: "Entering the Maxima Debugger dbm"
-> "Entering the Maxima Debugger. Type :h for debugger
commands, :q to quit the debugger, or DESCRIBE(DEBUGGING);
for more information." ?
- mdebug.lisp: ":foo" yields "FOO is not break command"
-- "FOO is not break command" -> "FOO is not a debugger
command. Type :h for help." ?
- Debugging.texi: rename section "Keyword Commands" to
"Debugger Commands" ?
- Command.texi: rework entry for DEBUGMODE
- mdebug.lisp: beautify the output under "Break commands start with"
-- align descriptions to make them easier to comprehend
- Debugging.texi: commands under "Definitions for Debugging"
appear to work as advertised, but there are many small
changes that can make the descriptions clearer
If you have any comments, that will be very helpful.
Robert Dodier
__________________________________
Do you Yahoo!?
New Yahoo! Photos - easier uploading and sharing.
http://photos.yahoo.com/