summaryrefslogtreecommitdiff
path: root/lisp/emacs-lisp
diff options
context:
space:
mode:
authorLute Kamstra <lute@gnu.org>2005-06-14 12:00:50 +0000
committerLute Kamstra <lute@gnu.org>2005-06-14 12:00:50 +0000
commit8ac3941d044540b246c150fe0b167bdd4bd973b1 (patch)
treec11e6ed5166501ef05263eb6a4896491c852af9c /lisp/emacs-lisp
parentca0a690049b390729fd6f85f590a57a3a48ba748 (diff)
downloademacs-8ac3941d044540b246c150fe0b167bdd4bd973b1.tar.gz
emacs-8ac3941d044540b246c150fe0b167bdd4bd973b1.tar.bz2
emacs-8ac3941d044540b246c150fe0b167bdd4bd973b1.zip
(debug-on-entry): Fix docstring.
Diffstat (limited to 'lisp/emacs-lisp')
-rw-r--r--lisp/emacs-lisp/debug.el12
1 files changed, 9 insertions, 3 deletions
diff --git a/lisp/emacs-lisp/debug.el b/lisp/emacs-lisp/debug.el
index 0745508b64b..0ee67355bf4 100644
--- a/lisp/emacs-lisp/debug.el
+++ b/lisp/emacs-lisp/debug.el
@@ -656,10 +656,16 @@ functions to break on entry."
;;;###autoload
(defun debug-on-entry (function)
"Request FUNCTION to invoke debugger each time it is called.
+
When called interactively, prompt for FUNCTION in the minibuffer.
-If you tell the debugger to continue, FUNCTION's execution proceeds.
-This works by modifying the definition of FUNCTION,
-which must be written in Lisp, not predefined.
+
+This works by modifying the definition of FUNCTION. If you tell the
+debugger to continue, FUNCTION's execution proceeds. If FUNCTION is a
+normal function or a macro written in Lisp, you can also step through
+its execution. FUNCTION can also be a primitive that is not a special
+form, in which case stepping is not possible. Break-on-entry for
+primitive functions only works when that function is called from Lisp.
+
Use \\[cancel-debug-on-entry] to cancel the effect of this command.
Redefining FUNCTION also cancels it."
(interactive "aDebug on entry (to function): ")