(vc-switches): Give it a doc string.

diff --git a/lisp/ChangeLog b/lisp/ChangeLog
index 37f06b10a844a55ac78dd6435a9e8440512aa114..3e579879a9e6c180cfce51a1e85afa8cf637898c 100644 (file)
--- a/lisp/ChangeLog
+++ b/lisp/ChangeLog
@@ -1,3 +1,7 @@
+2008-09-28  Glenn Morris  <rgm@gnu.org>
+
+       * vc.el (vc-switches): Give it a doc string.
+
 2008-09-28  Romain Francoise  <romain@orebokech.com>
 
        * comint.el (comint-show-output): Adjust to stickiness changes of

diff --git a/lisp/vc.el b/lisp/vc.el
index 64b1e943f82a040e3edd938a4a231104f63a5207..a929c20ffb0849d4f3a6e889584e46e6d0edadab 100644 (file)
--- a/lisp/vc.el
+++ b/lisp/vc.el
@@ -1398,6 +1398,18 @@ Runs the normal hooks `vc-before-checkin-hook' and `vc-checkin-hook'."
       'undecided))
 
 (defun vc-switches (backend op)
+  "Return a list of vc-BACKEND switches for operation OP.
+BACKEND is a symbol such as `CVS', which will be downcased.
+OP is a symbol such as `diff'.
+
+In decreasing order of preference, returns the value of:
+vc-BACKEND-OP-switches (e.g. `vc-cvs-diff-switches');
+vc-OP-switches (e.g. `vc-diff-switches'); or, in the case of
+diff only, `vc-diff-switches'.
+
+If the chosen value is not a string or a list, returns nil.
+This is so that you may set, e.g. `vc-svn-diff-switches' to t in order
+to override the value of `vc-diff-switches' and `diff-switches'."
   (let ((switches
         (or (when backend
               (let ((sym (vc-make-backend-sym