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

Checkdoc fixes in net/*.el

Browse source 
* 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.
This commit is contained in:
Stefan Kangas 2024-07-08 14:10:46 +02:00
parent 4c6e9f5b00
commit e43e9d0998
11 changed files with 25 additions and 25 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

24
lisp/net/ange-ftp.el
View file

@ -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,

2
lisp/net/dictionary.el
View file

@ -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"

8
lisp/net/eudc.el
View file

@ -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))))

2
lisp/net/eww.el
View file

@ -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)

2
lisp/net/rcirc.el
View file

@ -1197,7 +1197,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."

2
lisp/net/tramp-adb.el
View file

@ -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)))

2
lisp/net/tramp-cmds.el
View file

@ -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.

2
lisp/net/tramp-crypt.el
View file

@ -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.

2
lisp/net/tramp-message.el
View file

@ -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

2
lisp/net/tramp-sh.el
View file

@ -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.

2
lisp/net/tramp.el
View file

@ -2699,7 +2699,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)