Checkdoc fixes in `vc/*.el`

* lisp/vc/ediff-init.el (ediff-start-narrowed)
(ediff-buffer-values-orig-A, ediff-buffer-values-orig-B)
(ediff-buffer-values-orig-C, ediff-buffer-values-orig-Ancestor):
* lisp/vc/ediff-mult.el:
* lisp/vc/ediff-ptch.el (ediff-get-patch-buffer):
* lisp/vc/emerge.el (emerge-before-flag, emerge-after-flag):
* lisp/vc/vc-dav.el (vc-dav-checkin):
* lisp/vc/vc-git.el (vc-git-command):
* lisp/vc/vc-hg.el (vc-hg-command):
* lisp/vc/vc-src.el (vc-src-command):
* lisp/vc/vc-svn.el (vc-svn-command):
* lisp/vc/vc.el (vc-checkin): Checkdoc fixes.

(cherry picked from commit e392382e2e26ea6d6afa459621c289007c8ea77c)

diff --git a/lisp/vc/ediff-init.el b/lisp/vc/ediff-init.el
index c5eda873b5e13f7429d97ed214674801c7af57f0..1b478d3f9b7f0e7b8ce09e9047dfdb364230627d 100644 (file)
--- a/lisp/vc/ediff-init.el
+++ b/lisp/vc/ediff-init.el
@@ -594,7 +594,7 @@ highlighted using ASCII flags."
 (ediff-defvar-local ediff-visible-bounds nil)
 
 (ediff-defvar-local ediff-start-narrowed t
-  "Non-nil means start narrowed, if doing ediff-windows-* or ediff-regions-*")
+  "Non-nil means start narrowed, if doing ediff-windows-* or ediff-regions-*.")
 (ediff-defvar-local ediff-quit-widened t
   "Non-nil means: when finished, Ediff widens buffers A/B.
 Actually, Ediff restores the scope of visibility that existed at startup.")
@@ -624,13 +624,13 @@ It's a number rather than string.")
 
 
 (ediff-defvar-local ediff-buffer-values-orig-A nil
-  "The original values of ediff-protected-variables for buffer A.")
+  "The original values of `ediff-protected-variables' for buffer A.")
 (ediff-defvar-local ediff-buffer-values-orig-B nil
-  "The original values of ediff-protected-variables for buffer B.")
+  "The original values of `ediff-protected-variables' for buffer B.")
 (ediff-defvar-local ediff-buffer-values-orig-C nil
-  "The original values of ediff-protected-variables for buffer C.")
+  "The original values of `ediff-protected-variables' for buffer C.")
 (ediff-defvar-local ediff-buffer-values-orig-Ancestor nil
-  "The original values of ediff-protected-variables for buffer Ancestor.")
+  "The original values of `ediff-protected-variables' for buffer Ancestor.")
 
 (defconst ediff-buffer-values-orig-alist
   '((A . ediff-buffer-values-orig-A)

diff --git a/lisp/vc/ediff-mult.el b/lisp/vc/ediff-mult.el
index 66d4935cd757d5081bd5e61f60b54441ec4cd99c..b320c7d1f490caacdef4ab836c74dc6788949c4d 100644 (file)
--- a/lisp/vc/ediff-mult.el
+++ b/lisp/vc/ediff-mult.el
@@ -43,7 +43,7 @@
 ;;                                 (...) ...)
 ;;         The function ediff-make-new-meta-list-element can be used to create
 ;;         2nd and subsequent elements of that list (i.e., after the
-;;         description header). See ediff-make-new-meta-list-element for the
+;;         description header).  See ediff-make-new-meta-list-element for the
 ;;         explanation of the two nil placeholders in such elements.
 ;;
 ;;         There is API for extracting the components of the members of the

diff --git a/lisp/vc/ediff-ptch.el b/lisp/vc/ediff-ptch.el
index 2d5d46098905663eff90ea40a3ee191f0a706a70..3b76964327a3b46c5189ca5d147d9c0adeb563e6 100644 (file)
--- a/lisp/vc/ediff-ptch.el
+++ b/lisp/vc/ediff-ptch.el
@@ -542,8 +542,8 @@ are two possible targets for this %spatch.  However, these files do not exist."
 
 (defun ediff-get-patch-buffer (&optional arg patch-buf)
   "Obtain patch buffer.  If patch is already in a buffer---use it.
-Else, read patch file into a new buffer. If patch buffer is passed as an
-optional argument, then use it."
+Else, read patch file into a new buffer.  If patch buffer is passed as
+an optional argument, then use it."
   (let ((last-nonmenu-event t) ; Emacs: don't use dialog box
        last-command-event)    ; XEmacs: don't use dialog box
 

diff --git a/lisp/vc/emerge.el b/lisp/vc/emerge.el
index 5328ebc73ad9cb3784954ebdfbeef7312233d8f7..ca48f2f3c7b2751f2ffa9dc87f56725783a9e2f8 100644 (file)
--- a/lisp/vc/emerge.el
+++ b/lisp/vc/emerge.el
@@ -128,14 +128,14 @@ copied to the designated output file."
   :type 'boolean)
 
 (defcustom emerge-before-flag "vvvvvvvvvvvvvvvvvvvv\n"
-  "Flag placed above the highlighted block of code.  Must end with newline.
-Must be set before Emerge is loaded, or  emerge-new-flags  must be run
-after setting."
+  "Flag placed above the highlighted block of code.
+Must end with newline.  Must be set before Emerge is loaded, or
+`emerge-new-flags' must be run after setting."
   :type 'string)
 (defcustom emerge-after-flag "^^^^^^^^^^^^^^^^^^^^\n"
-  "Flag placed below the highlighted block of code.  Must end with newline.
-Must be set before Emerge is loaded, or  emerge-new-flags  must be run
-after setting."
+  "Flag placed below the highlighted block of code.
+Must end with newline.  Must be set before Emerge is loaded, or
+`emerge-new-flags' must be run after setting."
   :type 'string)
 
 ;; Hook variables

diff --git a/lisp/vc/vc-dav.el b/lisp/vc/vc-dav.el
index ae2cf149771329f3a49d04fe2219c4490645458e..0e85e71de40ed5fe15f4dcbb5ad41f1d745f7617 100644 (file)
--- a/lisp/vc/vc-dav.el
+++ b/lisp/vc/vc-dav.el
@@ -1,6 +1,6 @@
 ;;; vc-dav.el --- vc.el support for WebDAV  -*- lexical-binding: t; -*-
 
-;; Copyright (C) 2001, 2004-2024 Free Software Foundation, Inc.
+;; Copyright (C) 2001-2024 Free Software Foundation, Inc.
 
 ;; Author: Bill Perry <wmperry@gnu.org>
 ;; Keywords: url, vc
@@ -82,7 +82,7 @@ See `vc-checkout-model' for a list of possible values."
   )
 
 (defun vc-dav-checkin (_url _comment &optional _rev)
-  "Commit changes in URL to WebDAV. COMMENT is used as a check-in comment."
+  "Commit changes in URL to WebDAV.  COMMENT is used as a check-in comment."
   ;; This should PUT the resource and release any locks that we hold.
   )
 

diff --git a/lisp/vc/vc-git.el b/lisp/vc/vc-git.el
index 0541b16d6257205b0fb43ba825d99ee256fdc4f4..e8257c5dbd016cea8929cbed6510d86c4a0dcf1a 100644 (file)
--- a/lisp/vc/vc-git.el
+++ b/lisp/vc/vc-git.el
@@ -2177,7 +2177,7 @@ This command shares argument histories with \\[rgrep] and \\[grep]."
 
 (defun vc-git-command (buffer okstatus file-or-list &rest flags)
   "A wrapper around `vc-do-command' for use in vc-git.el.
-The difference to vc-do-command is that this function always invokes
+The difference to `vc-do-command' is that this function always invokes
 `vc-git-program'."
   (let ((coding-system-for-read
          (or coding-system-for-read vc-git-log-output-coding-system))

diff --git a/lisp/vc/vc-hg.el b/lisp/vc/vc-hg.el
index 7de41a2ae50485b6e6a32c4bb431b5be97d17e79..876d86dc24ffb5d3e866d0fe168359f24b84f165 100644 (file)
--- a/lisp/vc/vc-hg.el
+++ b/lisp/vc/vc-hg.el
@@ -1553,7 +1553,7 @@ This runs the command \"hg merge\"."
 
 (defun vc-hg-command (buffer okstatus file-or-list &rest flags)
   "A wrapper around `vc-do-command' for use in vc-hg.el.
-This function differs from vc-do-command in that it invokes
+This function differs from `vc-do-command' in that it invokes
 `vc-hg-program', and passes `vc-hg-global-switches' to it before FLAGS."
   ;; Disable pager.
   (let ((process-environment (cons "HGPLAIN=1" process-environment))

diff --git a/lisp/vc/vc-src.el b/lisp/vc/vc-src.el
index c85c90f789763417c929fbc33a7ed75b95b98b7f..27f58cb3369144e47837daa82fbf28863ae5ee1b 100644 (file)
--- a/lisp/vc/vc-src.el
+++ b/lisp/vc/vc-src.el
@@ -211,7 +211,7 @@ For a description of possible values, see `vc-check-master-templates'."
 
 (defun vc-src-command (buffer file-or-list &rest flags)
   "A wrapper around `vc-do-command' for use in vc-src.el.
-This function differs from vc-do-command in that it invokes `vc-src-program'."
+This function differs from `vc-do-command' in that it invokes `vc-src-program'."
   (let (file-list)
     (cond ((stringp file-or-list)
           (setq file-list (list "--" file-or-list)))

diff --git a/lisp/vc/vc-svn.el b/lisp/vc/vc-svn.el
index ae281e54519d548d01401aed97b4cbc9f58d4edb..d1d4204d05507e663afaeb8175653cb44c2ae5c1 100644 (file)
--- a/lisp/vc/vc-svn.el
+++ b/lisp/vc/vc-svn.el
@@ -661,7 +661,7 @@ NAME is assumed to be a URL."
 
 (defun vc-svn-command (buffer okstatus file-or-list &rest flags)
   "A wrapper around `vc-do-command' for use in vc-svn.el.
-The difference to vc-do-command is that this function always invokes `svn',
+The difference to `vc-do-command' is that this function always invokes `svn',
 and that it passes `vc-svn-global-switches' to it before FLAGS."
   (apply #'vc-do-command (or buffer "*vc*") okstatus vc-svn-program file-or-list
          (if (stringp vc-svn-global-switches)

diff --git a/lisp/vc/vc.el b/lisp/vc/vc.el
index 9705939c304e269123338b954e67fcc8c5aa6164..15636048307c674f99776c653b0223e48ce80369 100644 (file)
--- a/lisp/vc/vc.el
+++ b/lisp/vc/vc.el
@@ -1691,10 +1691,12 @@ Type \\[vc-next-action] to check in changes.")
       "Please explain why you stole the lock.  Type \\`C-c C-c' when done"))))
 
 (defun vc-checkin (files backend &optional comment initial-contents rev patch-string)
-  "Check in FILES. COMMENT is a comment string; if omitted, a
-buffer is popped up to accept a comment.  If INITIAL-CONTENTS is
-non-nil, then COMMENT is used as the initial contents of the log
-entry buffer.
+  "Check in FILES.
+
+COMMENT is a comment string; if omitted, a buffer is popped up to accept
+a comment.  If INITIAL-CONTENTS is non-nil, then COMMENT is used as the
+initial contents of the log entry buffer.
+
 The optional argument REV may be a string specifying the new revision
 level (only supported for some older VCSes, like RCS and CVS).
 The optional argument PATCH-STRING is a string to check in as a patch.