]> git.eshelyaron.com Git - emacs.git/commitdiff
diff-no-select doc string clarification
authorLars Ingebrigtsen <larsi@gnus.org>
Sat, 12 Sep 2020 11:08:29 +0000 (13:08 +0200)
committerLars Ingebrigtsen <larsi@gnus.org>
Sat, 12 Sep 2020 11:08:36 +0000 (13:08 +0200)
* lisp/vc/diff.el (diff-no-select): Update doc string from the trunk,
don't merge.

lisp/vc/diff.el

index 9e7e771963c8d298da5e527b5504f9250fd2b74c..469888078c467c30eee3063db864f87445040487 100644 (file)
@@ -145,9 +145,17 @@ Possible values are:
 
 (defun diff-no-select (old new &optional switches no-async buf)
   ;; Noninteractive helper for creating and reverting diff buffers
-  "Compare the OLD and NEW file/buffer, and return a diff buffer.
+  "Compare the OLD and NEW file/buffer.
+If the optional SWITCHES is nil, the switches specified in the
+variable ‘diff-switches’ are passed to the diff command,
+otherwise SWITCHES is used.  SWITCHES can be a string or a list
+of strings.
 
-See `diff' for the meaning of the arguments."
+If NO-ASYNC is non-nil, call diff synchronously.
+
+By default, this function creates the diff in the \"*Diff*\"
+buffer.  If BUF is non-nil, BUF is used instead.  This function
+returns the buffer used."
   (unless (bufferp new) (setq new (expand-file-name new)))
   (unless (bufferp old) (setq old (expand-file-name old)))
   (or switches (setq switches diff-switches)) ; If not specified, use default.