procyberian/emacs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Clarify semantics of trace-function CONTEXT argument

Browse source 
* lisp/emacs-lisp/trace.el (trace-function-foreground): Explain that
CONTEXT should be a function, when called from Lisp.
This commit is contained in:
Noam Postavsky 2020-04-14 22:10:58 -04:00
parent 821760fdc4
commit 45a64c97c7
1 changed files with 3 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
lisp/emacs-lisp/trace.el
View file

@ -292,7 +292,9 @@ If `current-prefix-arg' is non-nil, also read a buffer and a \"context\"
(defun trace-function-foreground (function &optional buffer context)
"Trace calls to function FUNCTION.
With a prefix argument, also prompt for the trace buffer (default
`trace-buffer'), and a Lisp expression CONTEXT.
`trace-buffer'), and a Lisp expression CONTEXT. When called from
Lisp, CONTEXT should be a function of no arguments which returns
a value to insert into BUFFER during the trace.
Tracing a function causes every call to that function to insert
into BUFFER Lisp-style trace messages that display the function's