changeset 98386:48cf5d8c02af

(vc-switches): Give it a doc string.
author Glenn Morris <rgm@gnu.org>
date Sun, 28 Sep 2008 17:54:38 +0000
parents 8f747339c80c
children cbbaeba5093d
files lisp/vc.el
diffstat 1 files changed, 12 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- a/lisp/vc.el	Sun Sep 28 16:56:48 2008 +0000
+++ b/lisp/vc.el	Sun Sep 28 17:54:38 2008 +0000
@@ -1398,6 +1398,18 @@
       '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