--- Begin Message ---
Subject: |
Emacs info: function toggle-debug-on-quit is not documented |
Date: |
Fri, 17 Dec 2010 19:59:36 +0200 |
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
--- End Message ---
--- Begin Message ---
Subject: |
Re: bug#7667: Emacs info: function toggle-debug-on-quit is not documented |
Date: |
Sat, 25 Dec 2010 12:38:31 +0200 |
> From: Jari Aalto <address@hidden>
> Date: Tue, 21 Dec 2010 11:10:22 +0200
> Cc: address@hidden, Jari Aalto <address@hidden>
>
> | 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.
--- End Message ---