* bug#7667: Emacs info: function toggle-debug-on-quit is not documented
@ 2010-12-17 17:59 Jari Aalto
2010-12-21 7:03 ` Chong Yidong
0 siblings, 1 reply; 4+ messages in thread
From: Jari Aalto @ 2010-12-17 17:59 UTC (permalink / raw)
To: 7667
Package: emacs
Version: 23.2+1-5.1
Severity: normal
Function toggle-debug-on-quit is not documented in Emacs info page. Please
add it to file:
doc/emacs/trouble.texi
-- System Information
Debian Release: squeeze/sid
APT Prefers testing
APT policy: (990, testing) (500, unstable) (1, experimental)
Architecture: amd64
Kernel: Linux picasso 2.6.32-5-amd64 #1 SMP Fri Sep 17 21:50:19 UTC 2010 x86_64 GNU/Linux
Locale: LANG=en_DK.UTF-8
-- Versions of packages `emacs depends on'.
Depends:
emacs23 23.2+1-5.1 GNU Emacs is the extensible self-documenting
emacs23-lucid 23.2+1-5.1 GNU Emacs is the extensible self-documenting
emacs23-nox 23.2+1-5.1 GNU Emacs is the extensible self-documenting
^ permalink raw reply [flat|nested] 4+ messages in thread
* bug#7667: Emacs info: function toggle-debug-on-quit is not documented
2010-12-17 17:59 bug#7667: Emacs info: function toggle-debug-on-quit is not documented Jari Aalto
@ 2010-12-21 7:03 ` Chong Yidong
2010-12-21 9:10 ` Jari Aalto
0 siblings, 1 reply; 4+ messages in thread
From: Chong Yidong @ 2010-12-21 7:03 UTC (permalink / raw)
To: Jari Aalto; +Cc: 7667
Jari Aalto <jari.aalto@cante.net> writes:
> Function toggle-debug-on-quit is not documented in Emacs info
> page. Please add it to file:
>
> doc/emacs/trouble.texi
It's documented in the Lisp manual, and mentioned in the Emacs manual in
the node "Bugs" > "Checklist". Since this command is mostly useful for
Lisp debugging and programming, the documentation belongs in the Lisp
manual.
^ permalink raw reply [flat|nested] 4+ messages in thread
* bug#7667: Emacs info: function toggle-debug-on-quit is not documented
2010-12-21 7:03 ` Chong Yidong
@ 2010-12-21 9:10 ` Jari Aalto
2010-12-25 10:38 ` Eli Zaretskii
0 siblings, 1 reply; 4+ messages in thread
From: Jari Aalto @ 2010-12-21 9:10 UTC (permalink / raw)
To: Chong Yidong; +Cc: 7667, Jari Aalto
2010-12-21 09:03 Chong Yidong <cyd@stupidchicken.com>:
| Jari Aalto <jari.aalto@cante.net> writes:
|
| > Function toggle-debug-on-quit is not documented in Emacs info
| > page. Please add it to file:
| >
| > doc/emacs/trouble.texi
|
| It's documented in the Lisp manual, and mentioned in the Emacs manual in
| the node "Bugs" > "Checklist". Since this command is mostly useful for
| Lisp debugging and programming, the documentation belongs in the Lisp
| manual.
The doc/emacs/trouble.texi documents:
@chapter Dealing with Common Problems
@findex toggle-debug-on-error
@pindex Edebug
To make a backtrace for the error, use @kbd{M-x toggle-debug-on-error}
before the error happens (that is to say, you must give that command
and then make the bug happen). This causes the error to start the Lisp
debugger, which shows you a backtrace. Copy the text of the
debugger's backtrace into the bug report. @xref{Debugger,, The Lisp
Debugger, elisp, the Emacs Lisp Reference Manual}, for information on
debugging Emacs Lisp programs with the Edebug package.
This use of the debugger is possible only if you know how to make the
bug happen again. If you can't make it happen again, at least copy
the whole error message.
The toggle-debug-on-quit is comparable.
It would be awkward not to be able to find it with "s" search command; that
you would need to switch to entirely another info manual to see the
function.
Jari
^ permalink raw reply [flat|nested] 4+ messages in thread
* bug#7667: Emacs info: function toggle-debug-on-quit is not documented
2010-12-21 9:10 ` Jari Aalto
@ 2010-12-25 10:38 ` Eli Zaretskii
0 siblings, 0 replies; 4+ messages in thread
From: Eli Zaretskii @ 2010-12-25 10:38 UTC (permalink / raw)
To: Jari Aalto; +Cc: cyd, 7667-done
> From: Jari Aalto <jari.aalto@cante.net>
> Date: Tue, 21 Dec 2010 11:10:22 +0200
> Cc: 7667@debbugs.gnu.org, Jari Aalto <jari.aalto@cante.net>
>
> | It's documented in the Lisp manual, and mentioned in the Emacs manual in
> | the node "Bugs" > "Checklist". Since this command is mostly useful for
> | Lisp debugging and programming, the documentation belongs in the Lisp
> | manual.
>
> The doc/emacs/trouble.texi documents:
>
> @chapter Dealing with Common Problems
>
> @findex toggle-debug-on-error
> @pindex Edebug
> To make a backtrace for the error, use @kbd{M-x toggle-debug-on-error}
> before the error happens (that is to say, you must give that command
> and then make the bug happen). This causes the error to start the Lisp
> debugger, which shows you a backtrace. Copy the text of the
> debugger's backtrace into the bug report. @xref{Debugger,, The Lisp
> Debugger, elisp, the Emacs Lisp Reference Manual}, for information on
> debugging Emacs Lisp programs with the Edebug package.
>
> This use of the debugger is possible only if you know how to make the
> bug happen again. If you can't make it happen again, at least copy
> the whole error message.
>
> The toggle-debug-on-quit is comparable.
I see no harm in mentioning it in the Emacs manual, so I added a short
blurb about it.
> It would be awkward not to be able to find it with "s" search command
You should use `i', not `s' for searching an Info manual. Any
user-level variable and function in an Info manual should be indexed.
^ permalink raw reply [flat|nested] 4+ messages in thread
end of thread, other threads:[~2010-12-25 10:38 UTC | newest]
Thread overview: 4+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2010-12-17 17:59 bug#7667: Emacs info: function toggle-debug-on-quit is not documented Jari Aalto
2010-12-21 7:03 ` Chong Yidong
2010-12-21 9:10 ` Jari Aalto
2010-12-25 10:38 ` Eli Zaretskii
Code repositories for project(s) associated with this public inbox
https://git.savannah.gnu.org/cgit/emacs.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).