procyberian/emacs
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Checkdoc fixes in vc/*.el

Browse source 
* 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.
This commit is contained in:
Stefan Kangas 2024-07-08 14:37:29 +02:00
parent ef7364b070
commit e392382e2e
10 changed files with 26 additions and 24 deletions
Download patch file Download diff file Expand all files Collapse all files

10
lisp/vc/ediff-init.el
View file

@ -594,7 +594,7 @@ highlighted using ASCII flags."
(ediff-defvar-local ediff-visible-bounds nil) (ediff-defvar-local ediff-visible-bounds nil)
(ediff-defvar-local ediff-start-narrowed t (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 (ediff-defvar-local ediff-quit-widened t
"Non-nil means: when finished, Ediff widens buffers A/B. "Non-nil means: when finished, Ediff widens buffers A/B.
Actually, Ediff restores the scope of visibility that existed at startup.") 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 (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 (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 (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 (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 (defconst ediff-buffer-values-orig-alist
'((A . ediff-buffer-values-orig-A) '((A . ediff-buffer-values-orig-A)

2
lisp/vc/ediff-mult.el
View file

@ -43,7 +43,7 @@
;; (...) ...) ;; (...) ...)
;; The function ediff-make-new-meta-list-element can be used to create ;; The function ediff-make-new-meta-list-element can be used to create
;; 2nd and subsequent elements of that list (i.e., after the ;; 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. ;; explanation of the two nil placeholders in such elements.
;; ;;
;; There is API for extracting the components of the members of the ;; There is API for extracting the components of the members of the

4
lisp/vc/ediff-ptch.el
View file

@ -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) (defun ediff-get-patch-buffer (&optional arg patch-buf)
"Obtain patch buffer. If patch is already in a buffer---use it. "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 Else, read patch file into a new buffer. If patch buffer is passed as
optional argument, then use it." an optional argument, then use it."
(let ((last-nonmenu-event t) ; Emacs: don't use dialog box (let ((last-nonmenu-event t) ; Emacs: don't use dialog box
last-command-event) ; XEmacs: don't use dialog box last-command-event) ; XEmacs: don't use dialog box

12
lisp/vc/emerge.el
View file

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

4
lisp/vc/vc-dav.el
View file

@ -1,6 +1,6 @@
;;; vc-dav.el --- vc.el support for WebDAV -*- lexical-binding: t; -*- ;;; 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> ;; Author: Bill Perry <wmperry@gnu.org>
;; Keywords: url, vc ;; 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) (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. ;; This should PUT the resource and release any locks that we hold.
) )

2
lisp/vc/vc-git.el
View file

@ -2177,7 +2177,7 @@ This command shares argument histories with \\[rgrep] and \\[grep]."
(defun vc-git-command (buffer okstatus file-or-list &rest flags) (defun vc-git-command (buffer okstatus file-or-list &rest flags)
"A wrapper around `vc-do-command' for use in vc-git.el. "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'." `vc-git-program'."
(let ((coding-system-for-read (let ((coding-system-for-read
(or coding-system-for-read vc-git-log-output-coding-system)) (or coding-system-for-read vc-git-log-output-coding-system))

2
lisp/vc/vc-hg.el
View file

@ -1553,7 +1553,7 @@ This runs the command \"hg merge\"."
(defun vc-hg-command (buffer okstatus file-or-list &rest flags) (defun vc-hg-command (buffer okstatus file-or-list &rest flags)
"A wrapper around `vc-do-command' for use in vc-hg.el. "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." `vc-hg-program', and passes `vc-hg-global-switches' to it before FLAGS."
;; Disable pager. ;; Disable pager.
(let ((process-environment (cons "HGPLAIN=1" process-environment)) (let ((process-environment (cons "HGPLAIN=1" process-environment))

2
lisp/vc/vc-src.el
View file

@ -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) (defun vc-src-command (buffer file-or-list &rest flags)
"A wrapper around `vc-do-command' for use in vc-src.el. "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) (let (file-list)
(cond ((stringp file-or-list) (cond ((stringp file-or-list)
(setq file-list (list "--" file-or-list))) (setq file-list (list "--" file-or-list)))

2
lisp/vc/vc-svn.el
View file

@ -661,7 +661,7 @@ NAME is assumed to be a URL."
(defun vc-svn-command (buffer okstatus file-or-list &rest flags) (defun vc-svn-command (buffer okstatus file-or-list &rest flags)
"A wrapper around `vc-do-command' for use in vc-svn.el. "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." 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 (apply #'vc-do-command (or buffer "*vc*") okstatus vc-svn-program file-or-list
(if (stringp vc-svn-global-switches) (if (stringp vc-svn-global-switches)

10
lisp/vc/vc.el
View file

@ -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")))) "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) (defun vc-checkin (files backend &optional comment initial-contents rev patch-string)
"Check in FILES. COMMENT is a comment string; if omitted, a "Check in FILES.
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 COMMENT is a comment string; if omitted, a buffer is popped up to accept
entry buffer. 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 The optional argument REV may be a string specifying the new revision
level (only supported for some older VCSes, like RCS and CVS). 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. The optional argument PATCH-STRING is a string to check in as a patch.