]> git.eshelyaron.com Git - emacs.git/commitdiff
Clarify semantics of trace-function CONTEXT argument
authorNoam Postavsky <npostavs@gmail.com>
Wed, 15 Apr 2020 02:10:58 +0000 (22:10 -0400)
committerNoam Postavsky <npostavs@gmail.com>
Sat, 25 Apr 2020 13:55:37 +0000 (09:55 -0400)
* lisp/emacs-lisp/trace.el (trace-function-foreground): Explain that
CONTEXT should be a function, when called from Lisp.

lisp/emacs-lisp/trace.el

index 5c35036a50d30d107d2bd94ec62dc0a0680dadd6..4ebb7ff711d729a38a428a0f00d71342b68640ad 100644 (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