From: Eli Zaretskii <eliz@gnu.org>
To: Jari Aalto <jari.aalto@cante.net>
Cc: cyd@stupidchicken.com, 7667-done@debbugs.gnu.org
Subject: bug#7667: Emacs info: function toggle-debug-on-quit is not documented
Date: Sat, 25 Dec 2010 12:38:31 +0200 [thread overview]
Message-ID: <83sjxmcf2w.fsf@gnu.org> (raw)
In-Reply-To: <87y67jwkxt.fsf@picasso.cante.net>
> 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.
prev parent reply other threads:[~2010-12-25 10:38 UTC|newest]
Thread overview: 4+ messages / expand[flat|nested] mbox.gz Atom feed top
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 [this message]
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=83sjxmcf2w.fsf@gnu.org \
--to=eliz@gnu.org \
--cc=7667-done@debbugs.gnu.org \
--cc=cyd@stupidchicken.com \
--cc=jari.aalto@cante.net \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this external index
https://git.savannah.gnu.org/cgit/emacs.git
https://git.savannah.gnu.org/cgit/emacs/org-mode.git
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.