(vc-call): Add doc string.

2 files changed, 10 insertions, 1 deletions

diff --git a/lisp/ChangeLog b/lisp/ChangeLog
index 879d9646e04..4ec6319b06b 100644
--- a/lisp/ChangeLog
+++ b/lisp/ChangeLog
@@ -1,3 +1,9 @@
+2007-08-06  Jason Rumney  <jasonr@gnu.org>
+
+        * menu-bar.el (menu-bar-vc-filter): Use vc-call-backend.
+
+        * vc-hooks.el (vc-call): Add doc string.
+
 2007-08-06  Michael Albinus  <michael.albinus@gmx.de>
 
         * net/ange-ftp.el (ange-ftp-hook-function): Catch also errors in
diff --git a/lisp/vc-hooks.el b/lisp/vc-hooks.el
index 09001e59691..d38bc000465 100644
--- a/lisp/vc-hooks.el
+++ b/lisp/vc-hooks.el
@@ -279,7 +279,10 @@ It is usually called via the `vc-call' macro."
      (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)