aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorStefan Kangas2024-07-08 14:10:46 +0200
committerStefan Kangas2024-07-08 14:10:46 +0200
commite43e9d09986e23d021afb56b4ced440ae8784e33 (patch)
tree3472b4cff921a1edb48d0f4ea5f7ee9cf587573f
parent4c6e9f5b0046648cd01da443cab33c30666c978d (diff)
downloademacs-e43e9d09986e23d021afb56b4ced440ae8784e33.tar.gz
emacs-e43e9d09986e23d021afb56b4ced440ae8784e33.zip
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.
-rw-r--r--lisp/net/ange-ftp.el24
-rw-r--r--lisp/net/dictionary.el2
-rw-r--r--lisp/net/eudc.el8
-rw-r--r--lisp/net/eww.el2
-rw-r--r--lisp/net/rcirc.el2
-rw-r--r--lisp/net/tramp-adb.el2
-rw-r--r--lisp/net/tramp-cmds.el2
-rw-r--r--lisp/net/tramp-crypt.el2
-rw-r--r--lisp/net/tramp-message.el2
-rw-r--r--lisp/net/tramp-sh.el2
-rw-r--r--lisp/net/tramp.el2
11 files changed, 25 insertions, 25 deletions
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 @@
227 227
228;; Tips for using ange-ftp: 228;; Tips for using ange-ftp:
229;; 229;;
230;; 1. For dired to work on a host which marks symlinks with a trailing @ in 230;; 1. For Dired to work on a host which marks symlinks with a trailing @ in
231;; an ls -alF listing, you need to (setq dired-ls-F-marks-symlinks t). 231;; an ls -alF listing, you need to (setq dired-ls-F-marks-symlinks t).
232;; Most UNIX systems do not do this, but ULTRIX does. If you think that 232;; Most UNIX systems do not do this, but ULTRIX does. If you think that
233;; there is a chance you might connect to an ULTRIX machine (such as 233;; there is a chance you might connect to an ULTRIX machine (such as
234;; prep.ai.mit.edu), then set this variable accordingly. This will have 234;; prep.ai.mit.edu), then set this variable accordingly. This will have
235;; the side effect that dired will have problems with symlinks whose names 235;; the side effect that Dired will have problems with symlinks whose names
236;; end in an @. If you get yourself into this situation then editing 236;; end in an @. If you get yourself into this situation then editing
237;; dired's ls-switches to remove "F", will temporarily fix things. 237;; Dired's ls-switches to remove "F", will temporarily fix things.
238;; 238;;
239;; 2. If you know that you are connecting to a certain non-UNIX machine 239;; 2. If you know that you are connecting to a certain non-UNIX machine
240;; frequently, and ange-ftp seems to be unable to guess its host-type, 240;; frequently, and ange-ftp seems to be unable to guess its host-type,
@@ -257,8 +257,8 @@
257;; moving them through the local machine. Again, be careful when doing 257;; moving them through the local machine. Again, be careful when doing
258;; this with binary files on non-Unix machines. 258;; this with binary files on non-Unix machines.
259;; 259;;
260;; 5. Beware that dired over ftp will use your setting of dired-no-confirm 260;; 5. Beware that Dired over ftp will use your setting of dired-no-confirm
261;; (list of dired commands for which confirmation is not asked). You 261;; (list of Dired commands for which confirmation is not asked). You
262;; might want to reconsider your setting of this variable, because you 262;; might want to reconsider your setting of this variable, because you
263;; might want confirmation for more commands on remote direds than on 263;; might want confirmation for more commands on remote direds than on
264;; local direds. For example, I strongly recommend that you not include 264;; local direds. For example, I strongly recommend that you not include
@@ -266,7 +266,7 @@
266;; might be a good idea to have an alist ange-ftp-dired-no-confirm of 266;; might be a good idea to have an alist ange-ftp-dired-no-confirm of
267;; pairs ( TYPE . LIST ), where TYPE is an operating system type and LIST 267;; pairs ( TYPE . LIST ), where TYPE is an operating system type and LIST
268;; is a list of commands for which confirmation would be suppressed. Then 268;; is a list of commands for which confirmation would be suppressed. Then
269;; remote dired listings would take their (buffer-local) value of 269;; remote Dired listings would take their (buffer-local) value of
270;; dired-no-confirm from this alist. Who votes for this? 270;; dired-no-confirm from this alist. Who votes for this?
271 271
272;; --------------------------------------------------------------------- 272;; ---------------------------------------------------------------------
@@ -317,7 +317,7 @@
317;; overwrite FILE.TXT;3, but instead will want to create FILE.TXT;4, and 317;; overwrite FILE.TXT;3, but instead will want to create FILE.TXT;4, and
318;; attach the buffer to this file. To get out of this situation, M-x 318;; attach the buffer to this file. To get out of this situation, M-x
319;; write-file /ymir.claremont.edu:FILE.TXT will attach the buffer to 319;; write-file /ymir.claremont.edu:FILE.TXT will attach the buffer to
320;; latest version of the file. For this reason, in dired "f" 320;; latest version of the file. For this reason, in Dired "f"
321;; (dired-find-file), always loads the file sans version, whereas "v", 321;; (dired-find-file), always loads the file sans version, whereas "v",
322;; (dired-view-file), always loads the explicit version number. The 322;; (dired-view-file), always loads the explicit version number. The
323;; reasoning being that it reasonable to view old versions of a file, but 323;; reasoning being that it reasonable to view old versions of a file, but
@@ -514,7 +514,7 @@
514;; containing spaces, but beware that the remote ftpd may not like them 514;; containing spaces, but beware that the remote ftpd may not like them
515;; much. 515;; much.
516;; 516;;
517;; 12. The dired support for non-Unix-like systems does not currently work. 517;; 12. The Dired support for non-Unix-like systems does not currently work.
518;; It needs to be reimplemented by modifying the parse-...-listing 518;; It needs to be reimplemented by modifying the parse-...-listing
519;; functions to convert the directory listing to ls -l format. 519;; functions to convert the directory listing to ls -l format.
520;; 520;;
@@ -524,8 +524,8 @@
524;; parsing a listing with the F switch. This will cause ange-ftp to 524;; parsing a listing with the F switch. This will cause ange-ftp to
525;; incorrectly get the name of a symlink on a non-ULTRIX host if its name 525;; incorrectly get the name of a symlink on a non-ULTRIX host if its name
526;; ends in an @. ange-ftp will correct itself if you take F out of the 526;; ends in an @. ange-ftp will correct itself if you take F out of the
527;; dired ls switches (C-u s will allow you to edit the switches). The 527;; Dired ls switches (C-u s will allow you to edit the switches). The
528;; dired buffer will be automatically reverted, which will allow ange-ftp 528;; Dired buffer will be automatically reverted, which will allow ange-ftp
529;; to fix its files hashtable. A cookie to anyone who can think of a 529;; to fix its files hashtable. A cookie to anyone who can think of a
530;; fast, sure-fire way to recognize ULTRIX over ftp. 530;; fast, sure-fire way to recognize ULTRIX over ftp.
531 531
@@ -611,9 +611,9 @@
611;; Thanks to Jamie Zawinski for bugfixes and for ideas such as gateways. 611;; Thanks to Jamie Zawinski for bugfixes and for ideas such as gateways.
612;; 612;;
613;; Thanks to Ken Laprade for improved .netrc parsing, password reading, and 613;; Thanks to Ken Laprade for improved .netrc parsing, password reading, and
614;; dired / shell auto-loading. 614;; Dired / shell auto-loading.
615;; 615;;
616;; Thanks to Sebastian Kremer for dired support and for many ideas and 616;; Thanks to Sebastian Kremer for Dired support and for many ideas and
617;; bugfixes. 617;; bugfixes.
618;; 618;;
619;; Thanks to Joe Wells for bugfixes, the original non-UNIX system support, 619;; 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 b12f3fa4368..f17dc160997 100644
--- a/lisp/net/dictionary.el
+++ b/lisp/net/dictionary.el
@@ -472,7 +472,7 @@ Otherwise, `dictionary-search' displays definitions in a *Dictionary* buffer."
472 :vert-only t 472 :vert-only t
473 :help "Go backwards in history.") 473 :help "Go backwards in history.")
474 map) 474 map)
475 "Like the default `tool-bar-map', but with additions for Dictionary mode") 475 "Like the default `tool-bar-map', but with additions for Dictionary mode.")
476 476
477;;;###autoload 477;;;###autoload
478(define-derived-mode dictionary-mode special-mode "Dictionary" 478(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
382 382
383When REVERSE is nil or omitted, the attribute names are 383When REVERSE is nil or omitted, the attribute names are
384translated from EUDC generic names to protocol-specific 384translated from EUDC generic names to protocol-specific
385names. When REVERSE is non-nil, the translation is from 385names. When REVERSE is non-nil, the translation is from
386protocol-specific names back to EUDC generic names." 386protocol-specific names back to EUDC generic names."
387 (if eudc-protocol-attributes-translation-alist 387 (if eudc-protocol-attributes-translation-alist
388 (mapcar (lambda (attribute) 388 (mapcar (lambda (attribute)
@@ -406,7 +406,7 @@ The translation is done according to
406 406
407When REVERSE is nil or omitted, the attribute names are 407When REVERSE is nil or omitted, the attribute names are
408translated from EUDC generic names to protocol-specific 408translated from EUDC generic names to protocol-specific
409names. When REVERSE is non-nil, the translation is from 409names. When REVERSE is non-nil, the translation is from
410protocol-specific names back to EUDC generic names." 410protocol-specific names back to EUDC generic names."
411 (if eudc-protocol-attributes-translation-alist 411 (if eudc-protocol-attributes-translation-alist
412 (let (trans) 412 (let (trans)
@@ -918,7 +918,7 @@ non-nil, collect results from all servers."
918 (if valid-comment-given comment nil))) 918 (if valid-comment-given comment nil)))
919 (progn 919 (progn
920 (error "Error: the function referenced by \ 920 (error "Error: the function referenced by \
921`eudc-inline-expansion-format' is expected to return a list.") 921`eudc-inline-expansion-format' is expected to return a list")
922 nil)))) 922 nil))))
923 923
924 ;; fallback behavior (nil function, or non-matching type) 924 ;; fallback behavior (nil function, or non-matching type)
@@ -1110,7 +1110,7 @@ queries the server for the existing fields and displays a corresponding form."
1110 (eudc-install-menu) 1110 (eudc-install-menu)
1111 (if eudc-ignore-options-file 1111 (if eudc-ignore-options-file
1112 (warn "Not saving bookmark due to `eudc-ignore-options-file'\ 1112 (warn "Not saving bookmark due to `eudc-ignore-options-file'\
1113 customization. Instead, customize `eudc-server-hotlist' to include %s:%s" 1113 customization. Instead, customize `eudc-server-hotlist' to include %s:%s"
1114 protocol server) 1114 protocol server)
1115 (eudc-save-options)))) 1115 (eudc-save-options))))
1116 1116
diff --git a/lisp/net/eww.el b/lisp/net/eww.el
index 94bfd333fa9..f9db0559853 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)."
1306 "Check if point is within a field and toggle text conversion. 1306 "Check if point is within a field and toggle text conversion.
1307Set `text-conversion-style' to the value `action' if it isn't 1307Set `text-conversion-style' to the value `action' if it isn't
1308already and point is within the prompt field, or if 1308already and point is within the prompt field, or if
1309`text-conversion-style' is `nil', so as to guarantee that 1309`text-conversion-style' is nil, so as to guarantee that
1310the input method functions properly for the purpose of typing 1310the input method functions properly for the purpose of typing
1311within text input fields." 1311within text input fields."
1312 (when (and (eq major-mode 'eww-mode) 1312 (when (and (eq major-mode 'eww-mode)
diff --git a/lisp/net/rcirc.el b/lisp/net/rcirc.el
index b913ba9e0a3..659035d4acb 100644
--- a/lisp/net/rcirc.el
+++ b/lisp/net/rcirc.el
@@ -1197,7 +1197,7 @@ With no argument or nil as argument, use the current buffer."
1197 "Return PROCESS server name, given by the 001 response." 1197 "Return PROCESS server name, given by the 001 response."
1198 (with-rcirc-process-buffer process 1198 (with-rcirc-process-buffer process
1199 (or rcirc-server-name 1199 (or rcirc-server-name
1200 (warn "server name for process %S unknown" process)))) 1200 (warn "Server name for process %S unknown" process))))
1201 1201
1202(defun rcirc-nick (process) 1202(defun rcirc-nick (process)
1203 "Return PROCESS nick." 1203 "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."
919 919
920(defun tramp-adb-handle-get-remote-uid (vec id-format) 920(defun tramp-adb-handle-get-remote-uid (vec id-format)
921 "Like `tramp-get-remote-uid' for Tramp files. 921 "Like `tramp-get-remote-uid' for Tramp files.
922 ID-FORMAT valid values are `string' and `integer'." 922ID-FORMAT valid values are `string' and `integer'."
923 (tramp-adb-send-command vec "id") 923 (tramp-adb-send-command vec "id")
924 (tramp-read-id-output vec) 924 (tramp-read-id-output vec)
925 (tramp-get-connection-property vec (format "uid-%s" id-format))) 925 (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."
630;;;###tramp-autoload 630;;;###tramp-autoload
631(defun tramp-recompile-elpa-command-completion-p (_symbol _buffer) 631(defun tramp-recompile-elpa-command-completion-p (_symbol _buffer)
632 "A predicate for `tramp-recompile-elpa'. 632 "A predicate for `tramp-recompile-elpa'.
633It is completed by \"M-x TAB\" only if package.el is loaded, and 633It is completed by `M-x TAB' only if package.el is loaded, and
634Tramp is an installed ELPA package." 634Tramp is an installed ELPA package."
635 ;; We cannot apply `package-installed-p', this would also return the 635 ;; We cannot apply `package-installed-p', this would also return the
636 ;; builtin package. 636 ;; builtin package.
diff --git a/lisp/net/tramp-crypt.el b/lisp/net/tramp-crypt.el
index a7af64bff5c..d44a656035d 100644
--- a/lisp/net/tramp-crypt.el
+++ b/lisp/net/tramp-crypt.el
@@ -117,7 +117,7 @@ initializing a new encrypted remote directory."
117;; `command-completion-default-include-p'. 117;; `command-completion-default-include-p'.
118(defun tramp-crypt-command-completion-p (symbol _buffer) 118(defun tramp-crypt-command-completion-p (symbol _buffer)
119 "A predicate for Tramp interactive commands. 119 "A predicate for Tramp interactive commands.
120They are completed by \"M-x TAB\" only when encryption support is enabled." 120They are completed by `M-x TAB' only when encryption support is enabled."
121 (and tramp-crypt-enabled 121 (and tramp-crypt-enabled
122 ;; `tramp-crypt-remove-directory' needs to be completed only in 122 ;; `tramp-crypt-remove-directory' needs to be completed only in
123 ;; case we have already encrypted directories. 123 ;; 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."
127;; `command-completion-default-include-p'. 127;; `command-completion-default-include-p'.
128(defun tramp-debug-buffer-command-completion-p (_symbol buffer) 128(defun tramp-debug-buffer-command-completion-p (_symbol buffer)
129 "A predicate for Tramp interactive commands. 129 "A predicate for Tramp interactive commands.
130They are completed by \"M-x TAB\" only in Tramp debug buffers." 130They are completed by `M-x TAB' only in Tramp debug buffers."
131 (declare (tramp-suppress-trace t)) 131 (declare (tramp-suppress-trace t))
132 (with-current-buffer buffer 132 (with-current-buffer buffer
133 (string-equal 133 (string-equal
diff --git a/lisp/net/tramp-sh.el b/lisp/net/tramp-sh.el
index bce7c323dad..4a0c09ff722 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.")
107 107
108(defcustom tramp-use-connection-share (not (eq system-type 'windows-nt)) 108(defcustom tramp-use-connection-share (not (eq system-type 'windows-nt))
109 "Whether to use connection share in ssh or PuTTY. 109 "Whether to use connection share in ssh or PuTTY.
110Set it to t, if you want Tramp to apply respective options. These 110Set it to t, if you want Tramp to apply respective options. These
111are `tramp-ssh-controlmaster-options' for ssh, and \"-share\" for PuTTY. 111are `tramp-ssh-controlmaster-options' for ssh, and \"-share\" for PuTTY.
112Set it to nil, if you use Control* or Proxy* options in your ssh 112Set it to nil, if you use Control* or Proxy* options in your ssh
113configuration. 113configuration.
diff --git a/lisp/net/tramp.el b/lisp/net/tramp.el
index abde62d4371..e8329c82743 100644
--- a/lisp/net/tramp.el
+++ b/lisp/net/tramp.el
@@ -2699,7 +2699,7 @@ Run BODY."
2699;; `command-completion-default-include-p'. 2699;; `command-completion-default-include-p'.
2700(defun tramp-command-completion-p (_symbol buffer) 2700(defun tramp-command-completion-p (_symbol buffer)
2701 "A predicate for Tramp interactive commands. 2701 "A predicate for Tramp interactive commands.
2702They are completed by \"M-x TAB\" only if the current buffer is remote." 2702They are completed by `M-x TAB' only if the current buffer is remote."
2703 (tramp-tramp-file-p (tramp-get-default-directory buffer))) 2703 (tramp-tramp-file-p (tramp-get-default-directory buffer)))
2704 2704
2705(defun tramp-connectable-p (vec-or-filename) 2705(defun tramp-connectable-p (vec-or-filename)