GNU bug report logs - #7667
Emacs info: function toggle-debug-on-quit is not documented

Previous Next

Full log

View this message in rfc822 format

From: help-debbugs <at> gnu.org (GNU bug Tracking System)
To: Eli Zaretskii <eliz <at> gnu.org>
Cc: tracker <at> debbugs.gnu.org
Subject: bug#7667: closed (Emacs info: function toggle-debug-on-quit is
 not documented)
Date: Sat, 25 Dec 2010 10:34:02 +0000

[Message part 1 (text/plain, inline)]

Your message dated Sat, 25 Dec 2010 12:38:31 +0200
with message-id <83sjxmcf2w.fsf <at> gnu.org>
and subject line Re: bug#7667: Emacs info: function toggle-debug-on-quit is not	documented
has caused the GNU bug report #7667,
regarding Emacs info: function toggle-debug-on-quit is not documented
to be marked as done.

(If you believe you have received this mail in error, please contact
help-debbugs <at> gnu.org.)


-- 
7667: http://debbugs.gnu.org/cgi/bugreport.cgi?bug=7667
GNU Bug Tracking System
Contact help-debbugs <at> gnu.org with problems

[Message part 2 (message/rfc822, inline)]

From: Jari Aalto <jari.aalto <at> cante.net>
To: submit <at> debbugs.gnu.org
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 

[Message part 3 (message/rfc822, inline)]

From: Eli Zaretskii <eliz <at> gnu.org>
To: Jari Aalto <jari.aalto <at> cante.net>
Cc: cyd <at> stupidchicken.com, 7667-done <at> debbugs.gnu.org
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 <jari.aalto <at> cante.net>
> Date: Tue, 21 Dec 2010 11:10:22 +0200
> Cc: 7667 <at> debbugs.gnu.org, Jari Aalto <jari.aalto <at> 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.

Previous Next

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.