From: Stefan Kangas Date: Mon, 8 Jul 2024 12:10:46 +0000 (+0200) Subject: Checkdoc fixes in `net/*.el` X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=5b1a7e74905fe2353e4ebe68261f539090cc3ade;p=emacs.git Checkdoc fixes in `net/*.el` * lisp/net/ange-ftp.el: * lisp/net/dictionary.el (dictionary-tool-bar-map): * lisp/net/eudc.el (eudc-translate-query) (eudc-translate-attribute-list) (eudc-format-inline-expansion-result, eudc-bookmark-server): * lisp/net/eww.el (eww-check-text-conversion): * lisp/net/rcirc.el (rcirc-server-name): * lisp/net/tramp-adb.el (tramp-adb-handle-get-remote-uid): * lisp/net/tramp-cmds.el (tramp-recompile-elpa-command-completion-p): * lisp/net/tramp-crypt.el (tramp-crypt-command-completion-p): * lisp/net/tramp-message.el (tramp-debug-buffer-command-completion-p): * lisp/net/tramp-sh.el (tramp-use-connection-share): * lisp/net/tramp.el (tramp-command-completion-p): Checkdoc fixes. (cherry picked from commit e43e9d09986e23d021afb56b4ced440ae8784e33) --- diff --git a/lisp/net/ange-ftp.el b/lisp/net/ange-ftp.el index 7eb66bb062b..4ea57ee6572 100644 --- a/lisp/net/ange-ftp.el +++ b/lisp/net/ange-ftp.el @@ -227,14 +227,14 @@ ;; Tips for using ange-ftp: ;; -;; 1. For dired to work on a host which marks symlinks with a trailing @ in +;; 1. For Dired to work on a host which marks symlinks with a trailing @ in ;; an ls -alF listing, you need to (setq dired-ls-F-marks-symlinks t). ;; Most UNIX systems do not do this, but ULTRIX does. If you think that ;; there is a chance you might connect to an ULTRIX machine (such as ;; prep.ai.mit.edu), then set this variable accordingly. This will have -;; the side effect that dired will have problems with symlinks whose names +;; the side effect that Dired will have problems with symlinks whose names ;; end in an @. If you get yourself into this situation then editing -;; dired's ls-switches to remove "F", will temporarily fix things. +;; Dired's ls-switches to remove "F", will temporarily fix things. ;; ;; 2. If you know that you are connecting to a certain non-UNIX machine ;; frequently, and ange-ftp seems to be unable to guess its host-type, @@ -257,8 +257,8 @@ ;; moving them through the local machine. Again, be careful when doing ;; this with binary files on non-Unix machines. ;; -;; 5. Beware that dired over ftp will use your setting of dired-no-confirm -;; (list of dired commands for which confirmation is not asked). You +;; 5. Beware that Dired over ftp will use your setting of dired-no-confirm +;; (list of Dired commands for which confirmation is not asked). You ;; might want to reconsider your setting of this variable, because you ;; might want confirmation for more commands on remote direds than on ;; local direds. For example, I strongly recommend that you not include @@ -266,7 +266,7 @@ ;; might be a good idea to have an alist ange-ftp-dired-no-confirm of ;; pairs ( TYPE . LIST ), where TYPE is an operating system type and LIST ;; is a list of commands for which confirmation would be suppressed. Then -;; remote dired listings would take their (buffer-local) value of +;; remote Dired listings would take their (buffer-local) value of ;; dired-no-confirm from this alist. Who votes for this? ;; --------------------------------------------------------------------- @@ -317,7 +317,7 @@ ;; overwrite FILE.TXT;3, but instead will want to create FILE.TXT;4, and ;; attach the buffer to this file. To get out of this situation, M-x ;; write-file /ymir.claremont.edu:FILE.TXT will attach the buffer to -;; latest version of the file. For this reason, in dired "f" +;; latest version of the file. For this reason, in Dired "f" ;; (dired-find-file), always loads the file sans version, whereas "v", ;; (dired-view-file), always loads the explicit version number. The ;; reasoning being that it reasonable to view old versions of a file, but @@ -514,7 +514,7 @@ ;; containing spaces, but beware that the remote ftpd may not like them ;; much. ;; -;; 12. The dired support for non-Unix-like systems does not currently work. +;; 12. The Dired support for non-Unix-like systems does not currently work. ;; It needs to be reimplemented by modifying the parse-...-listing ;; functions to convert the directory listing to ls -l format. ;; @@ -524,8 +524,8 @@ ;; parsing a listing with the F switch. This will cause ange-ftp to ;; incorrectly get the name of a symlink on a non-ULTRIX host if its name ;; ends in an @. ange-ftp will correct itself if you take F out of the -;; dired ls switches (C-u s will allow you to edit the switches). The -;; dired buffer will be automatically reverted, which will allow ange-ftp +;; Dired ls switches (C-u s will allow you to edit the switches). The +;; Dired buffer will be automatically reverted, which will allow ange-ftp ;; to fix its files hashtable. A cookie to anyone who can think of a ;; fast, sure-fire way to recognize ULTRIX over ftp. @@ -611,9 +611,9 @@ ;; Thanks to Jamie Zawinski for bugfixes and for ideas such as gateways. ;; ;; Thanks to Ken Laprade for improved .netrc parsing, password reading, and -;; dired / shell auto-loading. +;; Dired / shell auto-loading. ;; -;; Thanks to Sebastian Kremer for dired support and for many ideas and +;; Thanks to Sebastian Kremer for Dired support and for many ideas and ;; bugfixes. ;; ;; Thanks to Joe Wells for bugfixes, the original non-UNIX system support, diff --git a/lisp/net/dictionary.el b/lisp/net/dictionary.el index 9b68eb34f74..25983e397c3 100644 --- a/lisp/net/dictionary.el +++ b/lisp/net/dictionary.el @@ -472,7 +472,7 @@ Otherwise, `dictionary-search' displays definitions in a *Dictionary* buffer." :vert-only t :help "Go backwards in history.") map) - "Like the default `tool-bar-map', but with additions for Dictionary mode") + "Like the default `tool-bar-map', but with additions for Dictionary mode.") ;;;###autoload (define-derived-mode dictionary-mode special-mode "Dictionary" diff --git a/lisp/net/eudc.el b/lisp/net/eudc.el index ea90e4a7e77..da8955d52c9 100644 --- a/lisp/net/eudc.el +++ b/lisp/net/eudc.el @@ -382,7 +382,7 @@ The translation is done according to When REVERSE is nil or omitted, the attribute names are translated from EUDC generic names to protocol-specific -names. When REVERSE is non-nil, the translation is from +names. When REVERSE is non-nil, the translation is from protocol-specific names back to EUDC generic names." (if eudc-protocol-attributes-translation-alist (mapcar (lambda (attribute) @@ -406,7 +406,7 @@ The translation is done according to When REVERSE is nil or omitted, the attribute names are translated from EUDC generic names to protocol-specific -names. When REVERSE is non-nil, the translation is from +names. When REVERSE is non-nil, the translation is from protocol-specific names back to EUDC generic names." (if eudc-protocol-attributes-translation-alist (let (trans) @@ -918,7 +918,7 @@ non-nil, collect results from all servers." (if valid-comment-given comment nil))) (progn (error "Error: the function referenced by \ -`eudc-inline-expansion-format' is expected to return a list.") +`eudc-inline-expansion-format' is expected to return a list") nil)))) ;; fallback behavior (nil function, or non-matching type) @@ -1110,7 +1110,7 @@ queries the server for the existing fields and displays a corresponding form." (eudc-install-menu) (if eudc-ignore-options-file (warn "Not saving bookmark due to `eudc-ignore-options-file'\ - customization. Instead, customize `eudc-server-hotlist' to include %s:%s" + customization. Instead, customize `eudc-server-hotlist' to include %s:%s" protocol server) (eudc-save-options)))) diff --git a/lisp/net/eww.el b/lisp/net/eww.el index 907b35f8565..b2e1c5a72e5 100644 --- a/lisp/net/eww.el +++ b/lisp/net/eww.el @@ -1306,7 +1306,7 @@ This consults the entries in `eww-readable-urls' (which see)." "Check if point is within a field and toggle text conversion. Set `text-conversion-style' to the value `action' if it isn't already and point is within the prompt field, or if -`text-conversion-style' is `nil', so as to guarantee that +`text-conversion-style' is nil, so as to guarantee that the input method functions properly for the purpose of typing within text input fields." (when (and (eq major-mode 'eww-mode) diff --git a/lisp/net/rcirc.el b/lisp/net/rcirc.el index b1721e8647b..0820191e9e7 100644 --- a/lisp/net/rcirc.el +++ b/lisp/net/rcirc.el @@ -1183,7 +1183,7 @@ With no argument or nil as argument, use the current buffer." "Return PROCESS server name, given by the 001 response." (with-rcirc-process-buffer process (or rcirc-server-name - (warn "server name for process %S unknown" process)))) + (warn "Server name for process %S unknown" process)))) (defun rcirc-nick (process) "Return PROCESS nick." diff --git a/lisp/net/tramp-adb.el b/lisp/net/tramp-adb.el index 5b1c4ba5b19..b26a93fc6e4 100644 --- a/lisp/net/tramp-adb.el +++ b/lisp/net/tramp-adb.el @@ -919,7 +919,7 @@ will be used." (defun tramp-adb-handle-get-remote-uid (vec id-format) "Like `tramp-get-remote-uid' for Tramp files. - ID-FORMAT valid values are `string' and `integer'." +ID-FORMAT valid values are `string' and `integer'." (tramp-adb-send-command vec "id") (tramp-read-id-output vec) (tramp-get-connection-property vec (format "uid-%s" id-format))) diff --git a/lisp/net/tramp-cmds.el b/lisp/net/tramp-cmds.el index ecb9071eb57..5b2646a0b03 100644 --- a/lisp/net/tramp-cmds.el +++ b/lisp/net/tramp-cmds.el @@ -630,7 +630,7 @@ If the buffer runs `dired', the buffer is reverted." ;;;###tramp-autoload (defun tramp-recompile-elpa-command-completion-p (_symbol _buffer) "A predicate for `tramp-recompile-elpa'. -It is completed by \"M-x TAB\" only if package.el is loaded, and +It is completed by `M-x TAB' only if package.el is loaded, and Tramp is an installed ELPA package." ;; We cannot apply `package-installed-p', this would also return the ;; builtin package. diff --git a/lisp/net/tramp-crypt.el b/lisp/net/tramp-crypt.el index 5a605d7a728..5d567b487a4 100644 --- a/lisp/net/tramp-crypt.el +++ b/lisp/net/tramp-crypt.el @@ -117,7 +117,7 @@ initializing a new encrypted remote directory." ;; `command-completion-default-include-p'. (defun tramp-crypt-command-completion-p (symbol _buffer) "A predicate for Tramp interactive commands. -They are completed by \"M-x TAB\" only when encryption support is enabled." +They are completed by `M-x TAB' only when encryption support is enabled." (and tramp-crypt-enabled ;; `tramp-crypt-remove-directory' needs to be completed only in ;; case we have already encrypted directories. diff --git a/lisp/net/tramp-message.el b/lisp/net/tramp-message.el index b1f7aa95049..36079c8844c 100644 --- a/lisp/net/tramp-message.el +++ b/lisp/net/tramp-message.el @@ -127,7 +127,7 @@ The outline level is equal to the verbosity of the Tramp message." ;; `command-completion-default-include-p'. (defun tramp-debug-buffer-command-completion-p (_symbol buffer) "A predicate for Tramp interactive commands. -They are completed by \"M-x TAB\" only in Tramp debug buffers." +They are completed by `M-x TAB' only in Tramp debug buffers." (declare (tramp-suppress-trace t)) (with-current-buffer buffer (string-equal diff --git a/lisp/net/tramp-sh.el b/lisp/net/tramp-sh.el index 38002f5eaf1..3205c77210f 100644 --- a/lisp/net/tramp-sh.el +++ b/lisp/net/tramp-sh.el @@ -107,7 +107,7 @@ detected as prompt when being sent on echoing hosts, therefore.") (defcustom tramp-use-connection-share (not (eq system-type 'windows-nt)) "Whether to use connection share in ssh or PuTTY. -Set it to t, if you want Tramp to apply respective options. These +Set it to t, if you want Tramp to apply respective options. These are `tramp-ssh-controlmaster-options' for ssh, and \"-share\" for PuTTY. Set it to nil, if you use Control* or Proxy* options in your ssh configuration. diff --git a/lisp/net/tramp.el b/lisp/net/tramp.el index 8b86a2aab4d..6e345ce52fd 100644 --- a/lisp/net/tramp.el +++ b/lisp/net/tramp.el @@ -2698,7 +2698,7 @@ Run BODY." ;; `command-completion-default-include-p'. (defun tramp-command-completion-p (_symbol buffer) "A predicate for Tramp interactive commands. -They are completed by \"M-x TAB\" only if the current buffer is remote." +They are completed by `M-x TAB' only if the current buffer is remote." (tramp-tramp-file-p (tramp-get-default-directory buffer))) (defun tramp-connectable-p (vec-or-filename)