[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
master 3eb480c 1/3: ; Stylistic docfixes in net/*.el found by checkdoc
|
From: |
Stefan Kangas |
|
Subject: |
master 3eb480c 1/3: ; Stylistic docfixes in net/*.el found by checkdoc |
|
Date: |
Sun, 19 Sep 2021 10:57:57 -0400 (EDT) |
branch: master
commit 3eb480c8a425a6c563bb75b45911c3aa7169faee
Author: Stefan Kangas <stefan@marxist.se>
Commit: Stefan Kangas <stefan@marxist.se>
; Stylistic docfixes in net/*.el found by checkdoc
---
lisp/net/ange-ftp.el | 10 +++++-----
lisp/net/eudc-bob.el | 15 ++++++---------
lisp/net/eudc-hotlist.el | 5 ++---
lisp/net/eudcb-ldap.el | 2 +-
lisp/net/eww.el | 2 +-
lisp/net/hmac-def.el | 4 ++--
lisp/net/ldap.el | 3 +--
lisp/net/net-utils.el | 8 ++++----
lisp/net/ntlm.el | 29 ++++++++++++++---------------
lisp/net/quickurl.el | 2 +-
lisp/net/rlogin.el | 4 ++--
lisp/net/sasl-ntlm.el | 4 ++--
lisp/net/socks.el | 2 +-
lisp/net/telnet.el | 9 +++++----
14 files changed, 47 insertions(+), 52 deletions(-)
diff --git a/lisp/net/ange-ftp.el b/lisp/net/ange-ftp.el
index 25ae207..56a1d76 100644
--- a/lisp/net/ange-ftp.el
+++ b/lisp/net/ange-ftp.el
@@ -1357,7 +1357,7 @@ only return the directory part of FILE."
(defun ange-ftp-parse-netrc ()
;; We set this before actually doing it to avoid the possibility
- ;; of an infinite loop if ange-ftp-netrc-filename is an FTP file.
+ ;; of an infinite loop if `ange-ftp-netrc-filename' is an FTP file.
(interactive)
(let (file attr)
(let ((default-directory "/"))
@@ -3591,11 +3591,11 @@ Value is (0 0) if the modification time cannot be
determined."
(ange-ftp-real-verify-visited-file-modtime buf))))
(defun ange-ftp-file-size (file &optional ascii-mode)
- "Return the size of remote file FILE. Return -1 if can't get it.
-If ascii-mode is non-nil, return the size with the extra octets that
+ "Return the size of remote file FILE. Return -1 if can't get it.
+If ASCII-MODE is non-nil, return the size with the extra octets that
need to be inserted, one at the end of each line, to provide correct
-end-of-line semantics for a transfer using TYPE=A. The default is nil,
-so return the size on the remote host exactly. See RFC 3659."
+end-of-line semantics for a transfer using TYPE=A. The default is nil,
+so return the size on the remote host exactly. See RFC 3659."
(let* ((parsed (ange-ftp-ftp-name file))
(host (nth 0 parsed))
(user (nth 1 parsed))
diff --git a/lisp/net/eudc-bob.el b/lisp/net/eudc-bob.el
index 1d7af7f..7ad92b2 100644
--- a/lisp/net/eudc-bob.el
+++ b/lisp/net/eudc-bob.el
@@ -252,17 +252,14 @@ display a button."
;; If the first arguments can be nil here, then these 3 can be
;; defconsts once more.
-(easy-menu-define eudc-bob-generic-menu
- eudc-bob-generic-keymap
- ""
+(easy-menu-define eudc-bob-generic-menu eudc-bob-generic-keymap
+ "EUDC Binary Object Menu."
eudc-bob-generic-menu)
-(easy-menu-define eudc-bob-image-menu
- eudc-bob-image-keymap
- ""
+(easy-menu-define eudc-bob-image-menu eudc-bob-image-keymap
+ "EUDC Image Menu."
eudc-bob-image-menu)
-(easy-menu-define eudc-bob-sound-menu
- eudc-bob-sound-keymap
- ""
+(easy-menu-define eudc-bob-sound-menu eudc-bob-sound-keymap
+ "EUDC Sound Menu."
eudc-bob-sound-menu)
;;;###autoload
diff --git a/lisp/net/eudc-hotlist.el b/lisp/net/eudc-hotlist.el
index a737a99..43c1a28 100644
--- a/lisp/net/eudc-hotlist.el
+++ b/lisp/net/eudc-hotlist.el
@@ -174,9 +174,8 @@ These are the special commands of this mode:
["Save and Quit" eudc-hotlist-quit-edit t]
["Exit without Saving" kill-this-buffer t]))
-(easy-menu-define eudc-hotlist-emacs-menu
- eudc-hotlist-mode-map
- ""
+(easy-menu-define eudc-hotlist-emacs-menu eudc-hotlist-mode-map
+ "EUDC hotlist Menu."
eudc-hotlist-menu)
;;; eudc-hotlist.el ends here
diff --git a/lisp/net/eudcb-ldap.el b/lisp/net/eudcb-ldap.el
index 0aff276..fc48656 100644
--- a/lisp/net/eudcb-ldap.el
+++ b/lisp/net/eudcb-ldap.el
@@ -202,7 +202,7 @@ attribute names are returned. Default to `person'."
"Check if the current LDAP server has a configured search base."
(unless (or (eudc-ldap-get-host-parameter eudc-server 'base)
ldap-default-base
- (null (y-or-n-p "No search base defined. Configure it now? ")))
+ (null (y-or-n-p "No search base defined. Configure it now?")))
;; If the server is not in ldap-host-parameters-alist we add it for the
;; user
(if (null (assoc eudc-server ldap-host-parameters-alist))
diff --git a/lisp/net/eww.el b/lisp/net/eww.el
index c120297..36c6db0 100644
--- a/lisp/net/eww.el
+++ b/lisp/net/eww.el
@@ -57,7 +57,7 @@
:type 'string)
(defcustom eww-use-browse-url "\\`mailto:";
- "eww will use `browse-url' when following links that match this regexp.
+ "EWW will use `browse-url' when following links that match this regexp.
The action to be taken can be further customized via
`browse-url-handlers'."
:version "28.1"
diff --git a/lisp/net/hmac-def.el b/lisp/net/hmac-def.el
index 5ea8839..5af6d43 100644
--- a/lisp/net/hmac-def.el
+++ b/lisp/net/hmac-def.el
@@ -34,8 +34,8 @@ HMAC function is H(KEY XOR opad, H(KEY XOR ipad, TEXT)):
H is a cryptographic hash function, such as SHA1 and MD5, which takes
a string and return a digest of it (in binary form).
-B is a byte-length of a block size of H. (B=64 for both SHA1 and MD5.)
-L is a byte-length of hash outputs. (L=16 for MD5, L=20 for SHA1.)
+B is a byte length of a block size of H. (B=64 for both SHA1 and MD5.)
+L is a byte length of hash outputs. (L=16 for MD5, L=20 for SHA1.)
If BIT is non-nil, truncate output to specified bits."
`(defun ,name (text key)
,(concat "Compute "
diff --git a/lisp/net/ldap.el b/lisp/net/ldap.el
index 8b63dce..8b35a2d 100644
--- a/lisp/net/ldap.el
+++ b/lisp/net/ldap.el
@@ -154,8 +154,7 @@ Valid properties include:
(string :tag "Argument")))
(defcustom ldap-ldapsearch-password-prompt-regexp "Enter LDAP Password: "
- "A regular expression used to recognize the `ldapsearch'
-program's password prompt."
+ "Regexp used to recognize the `ldapsearch' program's password prompt."
:type 'regexp
:version "25.1")
diff --git a/lisp/net/net-utils.el b/lisp/net/net-utils.el
index 90cca7d..6f44d98 100644
--- a/lisp/net/net-utils.el
+++ b/lisp/net/net-utils.el
@@ -885,9 +885,9 @@ and `network-connection-service-alist', which see."
:type '(repeat (cons string string)))
(defcustom whois-guess-server t
- "If non-nil then whois will try to deduce the appropriate whois
-server from the query. If the query doesn't look like a domain or hostname
-then the server named by `whois-server-name' is used."
+ "If non-nil, try to deduce the appropriate whois server from the query.
+If the query doesn't look like a domain or hostname then the
+server named by `whois-server-name' is used."
:type 'boolean)
(defun whois-get-tld (host)
@@ -943,7 +943,7 @@ The port is deduced from
`network-connection-service-alist'."
;; Using a derived mode gives us keymaps, hooks, etc.
(define-derived-mode
network-connection-mode comint-mode "Network-Connection"
- "Major mode for interacting with the network-connection program.")
+ "Major mode for interacting with the `network-connection' program.")
(defun network-connection-mode-setup (host service)
(setq-local network-connection-host host)
diff --git a/lisp/net/ntlm.el b/lisp/net/ntlm.el
index 0450c80..747a69f 100644
--- a/lisp/net/ntlm.el
+++ b/lisp/net/ntlm.el
@@ -405,8 +405,8 @@ by PASSWORD-HASHES. PASSWORD-HASHES should be a return
value of
(ntlm-md4hash password)))
(defun ntlm-ascii2unicode (str len)
- "Convert an ASCII string into a NT Unicode string, which is
-little-endian utf16."
+ "Convert an ASCII string STR of length LEN into a NT Unicode string.
+NT Unicode strings are little-endian utf16."
;; FIXME: Can't we use encode-coding-string with a `utf-16le' coding system?
(let ((utf (make-string (* 2 len) 0))
(i 0)
@@ -428,25 +428,24 @@ little-endian utf16."
buf))
(defun ntlm-smb-passwd-hash (passwd)
- "Return the SMB password hash string of 16 bytes long for the given password
-string PASSWD. PASSWD is truncated to 14 bytes if longer."
+ "Return SMB password hash string of 16 bytes long for password string PASSWD.
+PASSWD is truncated to 14 bytes if longer."
(let ((len (min (length passwd) 14)))
(ntlm-smb-des-e-p16
(concat (substring (upcase passwd) 0 len) ;fill top 14 bytes with passwd
(make-string (- 15 len) 0)))))
(defun ntlm-smb-owf-encrypt (passwd c8)
- "Return the response string of 24 bytes long for the given password
-string PASSWD based on the DES encryption. PASSWD is of at most 14
-bytes long and the challenge string C8 of 8 bytes long."
+ "Return response string of 24 bytes long for password string PASSWD based on
DES encryption.
+PASSWD is of at most 14 bytes long and the challenge string C8 of
+8 bytes long."
(let* ((len (min (length passwd) 16))
(p22 (concat (substring passwd 0 len) ;Fill top 16 bytes with passwd.
(make-string (- 22 len) 0))))
(ntlm-smb-des-e-p24 p22 c8)))
(defun ntlm-smb-des-e-p24 (p22 c8)
- "Return a 24 bytes hashed string for a 21 bytes string P22 and a 8 bytes
-string C8."
+ "Return 24 bytes hashed string for a 21 bytes string P22 and a 8 bytes
string C8."
(concat (ntlm-smb-hash c8 p22 t) ;hash first 8 bytes of p22
(ntlm-smb-hash c8 (substring p22 7) t)
(ntlm-smb-hash c8 (substring p22 14) t)))
@@ -460,8 +459,8 @@ string C8."
(substring p15 7) t)))
(defun ntlm-smb-hash (in key forw)
- "Return the hash string of length 8 for a string IN of length 8 and
-a string KEY of length 8. FORW is t or nil."
+ "Return hash string of length 8 for a string IN of length 8 and a string KEY
of length 8.
+FORW is t or nil."
(let ((out (make-string 8 0))
(inb (make-string 64 0))
(keyb (make-string 64 0))
@@ -603,8 +602,8 @@ a string KEY of length 8. FORW is t or nil."
[ 2 1 14 7 4 10 8 13 15 12 9 0 3 5 6 11]]])
(defsubst ntlm-string-permute (in perm n)
- "Return a string of length N for a string IN and a permutation vector
-PERM of size N. The length of IN should be height of PERM."
+ "Return string of length N for string IN and permutation vector PERM of size
N.
+The length of IN should be height of PERM."
(let ((i 0) (out (make-string n 0)))
(while (< i n)
(aset out i (aref in (- (aref perm i) 1)))
@@ -701,8 +700,8 @@ backward."
(ntlm-string-permute rl ntlm-smb-perm6 64)))
(defun ntlm-md4hash (passwd)
- "Return the 16 bytes MD4 hash of a string PASSWD after converting it
-into a Unicode string. PASSWD is truncated to 128 bytes if longer."
+ "Return 16 bytes MD4 hash of string PASSWD after converting it to Unicode.
+PASSWD is truncated to 128 bytes if longer."
(let* ((len (min (length passwd) 128)) ;Pwd can't be > than 128 characters.
;; Password must be converted to NT Unicode.
(wpwd (ntlm-ascii2unicode passwd len)))
diff --git a/lisp/net/quickurl.el b/lisp/net/quickurl.el
index 046953f..7f147fa 100644
--- a/lisp/net/quickurl.el
+++ b/lisp/net/quickurl.el
@@ -284,7 +284,7 @@ It also restores point after the `read'."
"Return URL associated with key LOOKUP.
The lookup is done by looking in the alist `quickurl-urls' and the `cons'
-for the URL is returned. The actual method used to look into the alist
+for the URL is returned. The actual method used to look into the alist
depends on the setting of the variable `quickurl-assoc-function'."
(funcall quickurl-assoc-function lookup quickurl-urls))
diff --git a/lisp/net/rlogin.el b/lisp/net/rlogin.el
index 3136e53..a7001c1 100644
--- a/lisp/net/rlogin.el
+++ b/lisp/net/rlogin.el
@@ -238,8 +238,8 @@ ange-ftp. If called as a function, give it no argument.
If called with a negative prefix argument, disable directory tracking
entirely.
-If called with a positive, numeric prefix argument, e.g.
-`\\[universal-argument] 1 M-x rlogin-directory-tracking-mode',
+If called with a positive, numeric prefix argument, for example
+\\[universal-argument] 1 \\[rlogin-directory-tracking-mode],
then do directory tracking but assume the remote filesystem is the same as
the local system. This only works in general if the remote machine and the
local one share the same directories (e.g. through NFS)."
diff --git a/lisp/net/sasl-ntlm.el b/lisp/net/sasl-ntlm.el
index dfb7e71..9a5bba5 100644
--- a/lisp/net/sasl-ntlm.el
+++ b/lisp/net/sasl-ntlm.el
@@ -37,8 +37,8 @@
'(ignore ;nothing to do before making
sasl-ntlm-request ;authentication request
sasl-ntlm-response) ;response to challenge
- "A list of functions to be called in sequence for the NTLM
-authentication steps. They are called by `sasl-next-step'.")
+ "List of functions to call in sequence for the NTLM authentication steps.
+They are called by `sasl-next-step'.")
(defun sasl-ntlm-request (client _step)
"SASL step function to generate a NTLM authentication request to the server.
diff --git a/lisp/net/socks.el b/lisp/net/socks.el
index 7ac8bbb..be29960 100644
--- a/lisp/net/socks.el
+++ b/lisp/net/socks.el
@@ -154,7 +154,7 @@
(defcustom socks-server
(list "Default server" "socks" 1080 5)
- ""
+ "Socks server."
:type '(list
(string :format "" :value "Default server")
(string :tag "Server")
diff --git a/lisp/net/telnet.el b/lisp/net/telnet.el
index 9aa5d50..1716853 100644
--- a/lisp/net/telnet.el
+++ b/lisp/net/telnet.el
@@ -73,8 +73,9 @@ LOGIN-NAME, which is optional, says what to log in as on that
machine.")
(defvar telnet-prompt-pattern "^[^#$%>\n]*[#$%>] *")
(defvar telnet-replace-c-g nil)
(defvar-local telnet-remote-echoes t
- "True if the telnet process will echo input.")
-(defvar-local telnet-interrupt-string "\C-c" "String sent by C-c.")
+ "Non-nil if the telnet process will echo input.")
+(defvar-local telnet-interrupt-string "\C-c"
+ "String sent by C-c.")
(defvar-local telnet-count 0
"Number of output strings from telnet process while looking for password.")
@@ -123,7 +124,7 @@ rejecting one login and prompting again for a username and
password.")
;;maybe should have a flag for when have found type
(defun telnet-check-software-type-initialize (string)
- "Tries to put correct initializations in. Needs work."
+ "Try to put correct initializations in. Needs work."
(let ((case-fold-search t))
(cond ((string-match "unix" string)
(setq telnet-prompt-pattern comint-prompt-regexp)
@@ -246,7 +247,7 @@ Normally input is edited in Emacs and sent a line at a
time."
(define-derived-mode telnet-mode comint-mode "Telnet"
"This mode is for using telnet (or rsh) from a buffer to another host.
-It has most of the same commands as comint-mode.
+It has most of the same commands as `comint-mode'.
There is a variable `telnet-interrupt-string' which is the character
sent to try to stop execution of a job on the remote host.
Data is sent to the remote host when RET is typed."