changeset 82293:96cb0797d6c7

(vc-call): Add doc string.
author Jason Rumney <jasonr@gnu.org>
date Mon, 06 Aug 2007 11:03:35 +0000
parents 7dbd61707d6c
children 140b55e7437d
files lisp/vc-hooks.el
diffstat 1 files changed, 4 insertions(+), 1 deletions(-) [+]
line wrap: on
line diff
--- a/lisp/vc-hooks.el	Mon Aug 06 11:03:18 2007 +0000
+++ b/lisp/vc-hooks.el	Mon Aug 06 11:03:35 2007 +0000
@@ -279,7 +279,10 @@
      (t		(apply f args)))))
 
 (defmacro vc-call (fun file &rest args)
-  ;; BEWARE!! `file' is evaluated twice!!
+  "A convenience macro for calling VC backend functions.
+Functions called by this macro must accept FILE as the first argument.
+ARGS specifies any additional arguments. FUN should be unquoted.
+BEWARE!! `file' is evaluated twice!!"
   `(vc-call-backend (vc-backend ,file) ',fun ,file ,@args))
 
 (defsubst vc-parse-buffer (pattern i)