From 7529afd05546b0f8cf0e690c0399b81aba938c19 Mon Sep 17 00:00:00 2001 From: Stefan Kangas Date: Mon, 8 Jul 2024 14:37:29 +0200 Subject: [PATCH] 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) --- lisp/vc/ediff-init.el | 10 +++++----- lisp/vc/ediff-mult.el | 2 +- lisp/vc/ediff-ptch.el | 4 ++-- lisp/vc/emerge.el | 12 ++++++------ lisp/vc/vc-dav.el | 4 ++-- lisp/vc/vc-git.el | 2 +- lisp/vc/vc-hg.el | 2 +- lisp/vc/vc-src.el | 2 +- lisp/vc/vc-svn.el | 2 +- lisp/vc/vc.el | 10 ++++++---- 10 files changed, 26 insertions(+), 24 deletions(-) diff --git a/lisp/vc/ediff-init.el b/lisp/vc/ediff-init.el index c5eda873b5e..1b478d3f9b7 100644 --- 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 66d4935cd75..b320c7d1f49 100644 --- 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 2d5d4609890..3b76964327a 100644 --- 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 5328ebc73ad..ca48f2f3c7b 100644 --- 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 ae2cf149771..0e85e71de40 100644 --- 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 ;; 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 0541b16d625..e8257c5dbd0 100644 --- 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 7de41a2ae50..876d86dc24f 100644 --- 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 c85c90f7897..27f58cb3369 100644 --- 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 ae281e54519..d1d4204d055 100644 --- 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 9705939c304..15636048307 100644 --- 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. -- 2.39.2