diff options
| author | Juanma Barranquero | 2019-10-20 12:12:27 +0200 |
|---|---|---|
| committer | Juanma Barranquero | 2019-10-20 12:12:27 +0200 |
| commit | 41ba8231ef072571e1a6feabc15d113e5cf57556 (patch) | |
| tree | ebfb9888ed6f62295fac4a0c7858f6881ffda491 /lisp/net | |
| parent | e2acf4d29d6f03c7b8c6fbeb61ed1f4a6ef5b1fd (diff) | |
| download | emacs-41ba8231ef072571e1a6feabc15d113e5cf57556.tar.gz emacs-41ba8231ef072571e1a6feabc15d113e5cf57556.zip | |
lisp/*.el: Fix typos and improve some docstrings
* lisp/auth-source.el (auth-source-backend-parse-parameters)
(auth-source-search-collection)
(auth-source-secrets-listify-pattern)
(auth-source--decode-octal-string, auth-source-plstore-search):
* lisp/registry.el (registry-lookup)
(registry-lookup-breaks-before-lexbind)
(registry-lookup-secondary, registry-lookup-secondary-value)
(registry-search, registry-delete, registry-size, registry-full)
(registry-insert, registry-reindex, registry-prune)
(registry-collect-prune-candidates):
* lisp/subr.el (nbutlast, process-live-p):
* lisp/tab-bar.el (tab-bar-list):
* lisp/cedet/ede/linux.el (ede-linux--get-archs)
(ede-linux--include-path, ede-linux-load):
* lisp/erc/erc-log.el (erc-log-all-but-server-buffers):
* lisp/erc/erc-pcomplete.el (pcomplete-erc-commands)
(pcomplete-erc-ops, pcomplete-erc-not-ops, pcomplete-erc-nicks)
(pcomplete-erc-all-nicks, pcomplete-erc-channels)
(pcomplete-erc-command-name, pcomplete-erc-parse-arguments):
* lisp/eshell/em-term.el (eshell-visual-command-p):
* lisp/gnus/gnus-cache.el (gnus-cache-fully-p):
* lisp/gnus/nnmail.el (nnmail-get-active)
(nnmail-fancy-expiry-target):
* lisp/mail/mail-utils.el (mail-string-delete):
* lisp/mail/supercite.el (sc-hdr, sc-valid-index-p):
* lisp/net/ange-ftp.el (ange-ftp-use-smart-gateway-p):
* lisp/net/nsm.el (nsm-save-fingerprint-maybe)
(nsm-network-same-subnet, nsm-should-check):
* lisp/net/rcirc.el (rcirc-looking-at-input):
* lisp/net/tramp-cache.el (tramp-get-hash-table):
* lisp/net/tramp-compat.el (tramp-compat-process-running-p):
* lisp/net/tramp-smb.el (tramp-smb-get-share)
(tramp-smb-get-localname, tramp-smb-read-file-entry)
(tramp-smb-get-cifs-capabilities, tramp-smb-get-stat-capability):
* lisp/net/zeroconf.el (zeroconf-list-service-names)
(zeroconf-list-service-types, zeroconf-list-services)
(zeroconf-get-host, zeroconf-get-domain)
(zeroconf-get-host-domain):
* lisp/nxml/rng-xsd.el (rng-xsd-compile)
(rng-xsd-make-date-time-regexp, rng-xsd-convert-date-time):
* lisp/obsolete/erc-hecomplete.el (erc-hecomplete)
(erc-command-list, erc-complete-at-prompt):
* lisp/org/ob-scheme.el (org-babel-scheme-get-buffer-impl):
* lisp/org/ob-shell.el (org-babel--variable-assignments:sh-generic)
(org-babel--variable-assignments:bash_array)
(org-babel--variable-assignments:bash_assoc)
(org-babel--variable-assignments:bash):
* lisp/org/org-clock.el (org-day-of-week):
* lisp/progmodes/cperl-mode.el (cperl-char-ends-sub-keyword-p):
* lisp/progmodes/gud.el (gud-find-c-expr, gud-innermost-expr)
(gud-prev-expr, gud-next-expr):
* lisp/textmodes/table.el (table--at-cell-p, table--probe-cell)
(table--get-cell-justify-property)
(table--get-cell-valign-property)
(table--put-cell-justify-property)
(table--put-cell-valign-property): Fix typos.
* lisp/so-long.el (fboundp): Doc fix.
(so-long-mode-line-info, so-long-mode)
(so-long--check-header-modes): Fix typos.
* lisp/emulation/viper-mous.el (viper-surrounding-word)
(viper-mouse-click-get-word): Fix typos.
(viper-mouse-click-search-word): Doc fix.
* lisp/erc/erc-backend.el (erc-forward-word, erc-word-at-arg-p)
(erc-bounds-of-word-at-point): Fix typos.
(erc-decode-string-from-target, define-erc-response-handler):
Refill docstring.
* lisp/erc/erc-dcc.el (pcomplete/erc-mode/DCC): Fix typo.
(erc-dcc-get-host, erc-dcc-auto-mask-p, erc-dcc-get-file):
Doc fixes.
* lisp/erc/erc-networks.el (erc-network-name): Fix typo.
(erc-determine-network): Refill docstring.
* lisp/net/dbus.el (dbus-list-hash-table)
(dbus-string-to-byte-array, dbus-byte-array-to-string)
(dbus-check-event): Fix typos.
(dbus-introspect-get-property): Doc fix.
* lisp/net/tramp-adb.el (tramp-adb-file-name-handler):
Rename ARGS to ARGUMENTS. Doc fix.
(tramp-adb-sh-fix-ls-output, tramp-adb-execute-adb-command)
(tramp-adb-find-test-command): Fix typos.
* lisp/net/tramp.el (tramp-set-completion-function)
(tramp-get-completion-function)
(tramp-completion-dissect-file-name)
(tramp-completion-dissect-file-name1)
(tramp-get-completion-methods, tramp-get-completion-user-host)
(tramp-get-inode, tramp-get-device, tramp-mode-string-to-int)
(tramp-call-process, tramp-call-process-region)
(tramp-process-lines): Fix typos.
(tramp-interrupt-process): Doc fix.
* lisp/org/ob-core.el (org-babel-named-src-block-regexp-for-name)
(org-babel-named-data-regexp-for-name): Doc fix.
(org-babel-src-block-names, org-babel-result-names): Fix typos.
* lisp/progmodes/inf-lisp.el (lisp-input-filter): Doc fix.
(lisp-fn-called-at-pt): Fix typo.
* lisp/progmodes/xref.el (xref-backend-identifier-at-point):
Doc fix.
(xref-backend-identifier-completion-table): Fix typo.
Diffstat (limited to 'lisp/net')
| -rw-r--r-- | lisp/net/ange-ftp.el | 2 | ||||
| -rw-r--r-- | lisp/net/dbus.el | 10 | ||||
| -rw-r--r-- | lisp/net/nsm.el | 6 | ||||
| -rw-r--r-- | lisp/net/rcirc.el | 2 | ||||
| -rw-r--r-- | lisp/net/tramp-adb.el | 16 | ||||
| -rw-r--r-- | lisp/net/tramp-cache.el | 2 | ||||
| -rw-r--r-- | lisp/net/tramp-compat.el | 2 | ||||
| -rw-r--r-- | lisp/net/tramp-smb.el | 12 | ||||
| -rw-r--r-- | lisp/net/tramp.el | 28 | ||||
| -rw-r--r-- | lisp/net/zeroconf.el | 12 |
10 files changed, 47 insertions, 45 deletions
diff --git a/lisp/net/ange-ftp.el b/lisp/net/ange-ftp.el index b0a1e1799f5..a5fc9631e8a 100644 --- a/lisp/net/ange-ftp.el +++ b/lisp/net/ange-ftp.el | |||
| @@ -1708,7 +1708,7 @@ good, skip, fatal, or unknown." | |||
| 1708 | (not (string-match-p ange-ftp-local-host-regexp host)))) | 1708 | (not (string-match-p ange-ftp-local-host-regexp host)))) |
| 1709 | 1709 | ||
| 1710 | (defun ange-ftp-use-smart-gateway-p (host) | 1710 | (defun ange-ftp-use-smart-gateway-p (host) |
| 1711 | "Returns whether to access this HOST via a smart gateway." | 1711 | "Return whether to access this HOST via a smart gateway." |
| 1712 | (and ange-ftp-smart-gateway | 1712 | (and ange-ftp-smart-gateway |
| 1713 | (not (string-match-p ange-ftp-local-host-regexp host)))) | 1713 | (not (string-match-p ange-ftp-local-host-regexp host)))) |
| 1714 | 1714 | ||
diff --git a/lisp/net/dbus.el b/lisp/net/dbus.el index c3297ac9da6..f3f6fecb956 100644 --- a/lisp/net/dbus.el +++ b/lisp/net/dbus.el | |||
| @@ -493,7 +493,7 @@ This is an internal function, it shall not be used outside dbus.el." | |||
| 493 | ;;; Hash table of registered functions. | 493 | ;;; Hash table of registered functions. |
| 494 | 494 | ||
| 495 | (defun dbus-list-hash-table () | 495 | (defun dbus-list-hash-table () |
| 496 | "Returns all registered member registrations to D-Bus. | 496 | "Return all registered member registrations to D-Bus. |
| 497 | The return value is a list, with elements of kind (KEY . VALUE). | 497 | The return value is a list, with elements of kind (KEY . VALUE). |
| 498 | See `dbus-registered-objects-table' for a description of the | 498 | See `dbus-registered-objects-table' for a description of the |
| 499 | hash table." | 499 | hash table." |
| @@ -888,7 +888,7 @@ association to the service from D-Bus." | |||
| 888 | ;;; D-Bus type conversion. | 888 | ;;; D-Bus type conversion. |
| 889 | 889 | ||
| 890 | (defun dbus-string-to-byte-array (string) | 890 | (defun dbus-string-to-byte-array (string) |
| 891 | "Transforms STRING to list (:array :byte c1 :byte c2 ...). | 891 | "Transform STRING to list (:array :byte c1 :byte c2 ...). |
| 892 | STRING shall be UTF8 coded." | 892 | STRING shall be UTF8 coded." |
| 893 | (if (zerop (length string)) | 893 | (if (zerop (length string)) |
| 894 | '(:array :signature "y") | 894 | '(:array :signature "y") |
| @@ -897,7 +897,7 @@ STRING shall be UTF8 coded." | |||
| 897 | (setq result (append result (list :byte elt))))))) | 897 | (setq result (append result (list :byte elt))))))) |
| 898 | 898 | ||
| 899 | (defun dbus-byte-array-to-string (byte-array &optional multibyte) | 899 | (defun dbus-byte-array-to-string (byte-array &optional multibyte) |
| 900 | "Transforms BYTE-ARRAY into UTF8 coded string. | 900 | "Transform BYTE-ARRAY into UTF8 coded string. |
| 901 | BYTE-ARRAY must be a list of structure (c1 c2 ...), or a byte | 901 | BYTE-ARRAY must be a list of structure (c1 c2 ...), or a byte |
| 902 | array as produced by `dbus-string-to-byte-array'. The resulting | 902 | array as produced by `dbus-string-to-byte-array'. The resulting |
| 903 | string is unibyte encoded, unless MULTIBYTE is non-nil." | 903 | string is unibyte encoded, unless MULTIBYTE is non-nil." |
| @@ -947,7 +947,7 @@ STRING must have been encoded with `dbus-escape-as-identifier'." | |||
| 947 | ;;; D-Bus events. | 947 | ;;; D-Bus events. |
| 948 | 948 | ||
| 949 | (defun dbus-check-event (event) | 949 | (defun dbus-check-event (event) |
| 950 | "Checks whether EVENT is a well formed D-Bus event. | 950 | "Check whether EVENT is a well formed D-Bus event. |
| 951 | EVENT is a list which starts with symbol `dbus-event': | 951 | EVENT is a list which starts with symbol `dbus-event': |
| 952 | 952 | ||
| 953 | (dbus-event BUS TYPE SERIAL SERVICE PATH INTERFACE MEMBER HANDLER &rest ARGS) | 953 | (dbus-event BUS TYPE SERIAL SERVICE PATH INTERFACE MEMBER HANDLER &rest ARGS) |
| @@ -1319,7 +1319,7 @@ SERVICE is a service of D-Bus BUS at object path PATH." | |||
| 1319 | (push (dbus-introspect-get-attribute elt "name") result)))) | 1319 | (push (dbus-introspect-get-attribute elt "name") result)))) |
| 1320 | 1320 | ||
| 1321 | (defun dbus-introspect-get-property (bus service path interface property) | 1321 | (defun dbus-introspect-get-property (bus service path interface property) |
| 1322 | "This function returns PROPERTY of INTERFACE as XML object. | 1322 | "Return PROPERTY of INTERFACE as XML object. |
| 1323 | It must be located at SERVICE in D-Bus BUS at object path PATH. | 1323 | It must be located at SERVICE in D-Bus BUS at object path PATH. |
| 1324 | PROPERTY must be a string, element of the list returned by | 1324 | PROPERTY must be a string, element of the list returned by |
| 1325 | `dbus-introspect-get-property-names'. The resulting PROPERTY | 1325 | `dbus-introspect-get-property-names'. The resulting PROPERTY |
diff --git a/lisp/net/nsm.el b/lisp/net/nsm.el index 4ca770fd7e1..c47ef55a6f4 100644 --- a/lisp/net/nsm.el +++ b/lisp/net/nsm.el | |||
| @@ -179,7 +179,7 @@ See also: `nsm-check-tls-connection', `nsm-save-host-names', | |||
| 179 | (const :tag "High" high))))) | 179 | (const :tag "High" high))))) |
| 180 | 180 | ||
| 181 | (defun nsm-save-fingerprint-maybe (host port status &rest _) | 181 | (defun nsm-save-fingerprint-maybe (host port status &rest _) |
| 182 | "Saves the certificate's fingerprint. | 182 | "Save the certificate's fingerprint. |
| 183 | 183 | ||
| 184 | In order to detect man-in-the-middle attacks, when | 184 | In order to detect man-in-the-middle attacks, when |
| 185 | `network-security-level' is `high', this function will save the | 185 | `network-security-level' is `high', this function will save the |
| @@ -199,7 +199,7 @@ RESULTS is an alist where the keys are the checks run and the | |||
| 199 | values the results of the checks.") | 199 | values the results of the checks.") |
| 200 | 200 | ||
| 201 | (defun nsm-network-same-subnet (local-ip mask ip) | 201 | (defun nsm-network-same-subnet (local-ip mask ip) |
| 202 | "Returns t if IP is in the same subnet as LOCAL-IP/MASK. | 202 | "Return t if IP is in the same subnet as LOCAL-IP/MASK. |
| 203 | LOCAL-IP, MASK, and IP are specified as vectors of integers, and | 203 | LOCAL-IP, MASK, and IP are specified as vectors of integers, and |
| 204 | are expected to have the same length. Works for both IPv4 and | 204 | are expected to have the same length. Works for both IPv4 and |
| 205 | IPv6 addresses." | 205 | IPv6 addresses." |
| @@ -217,7 +217,7 @@ IPv6 addresses." | |||
| 217 | matches)) | 217 | matches)) |
| 218 | 218 | ||
| 219 | (defun nsm-should-check (host) | 219 | (defun nsm-should-check (host) |
| 220 | "Determines whether NSM should check for TLS problems for HOST. | 220 | "Determine whether NSM should check for TLS problems for HOST. |
| 221 | 221 | ||
| 222 | If `nsm-trust-local-network' is or returns non-nil, and if the | 222 | If `nsm-trust-local-network' is or returns non-nil, and if the |
| 223 | host address is a localhost address, or in the same subnet as one | 223 | host address is a localhost address, or in the same subnet as one |
diff --git a/lisp/net/rcirc.el b/lisp/net/rcirc.el index 5722582ab6c..4a94afe0917 100644 --- a/lisp/net/rcirc.el +++ b/lisp/net/rcirc.el | |||
| @@ -3063,7 +3063,7 @@ Passwords are stored in `rcirc-authinfo' (which see)." | |||
| 3063 | ;; When using M-x flyspell-mode, only check words after the prompt | 3063 | ;; When using M-x flyspell-mode, only check words after the prompt |
| 3064 | (put 'rcirc-mode 'flyspell-mode-predicate 'rcirc-looking-at-input) | 3064 | (put 'rcirc-mode 'flyspell-mode-predicate 'rcirc-looking-at-input) |
| 3065 | (defun rcirc-looking-at-input () | 3065 | (defun rcirc-looking-at-input () |
| 3066 | "Returns true if point is past the input marker." | 3066 | "Return true if point is past the input marker." |
| 3067 | (>= (point) rcirc-prompt-end-marker)) | 3067 | (>= (point) rcirc-prompt-end-marker)) |
| 3068 | 3068 | ||
| 3069 | 3069 | ||
diff --git a/lisp/net/tramp-adb.el b/lisp/net/tramp-adb.el index 982522bdaf4..e1706bebe6e 100644 --- a/lisp/net/tramp-adb.el +++ b/lisp/net/tramp-adb.el | |||
| @@ -177,14 +177,14 @@ It is used for TCP/IP devices." | |||
| 177 | tramp-adb-method))) | 177 | tramp-adb-method))) |
| 178 | 178 | ||
| 179 | ;;;###tramp-autoload | 179 | ;;;###tramp-autoload |
| 180 | (defun tramp-adb-file-name-handler (operation &rest args) | 180 | (defun tramp-adb-file-name-handler (operation &rest arguments) |
| 181 | "Invoke the ADB handler for OPERATION. | 181 | "Invoke the ADB handler for OPERATION. |
| 182 | First arg specifies the OPERATION, second arg is a list of arguments to | 182 | First arg specifies the OPERATION, second arg is a list of |
| 183 | pass to the OPERATION." | 183 | ARGUMENTS to pass to the OPERATION." |
| 184 | (let ((fn (assoc operation tramp-adb-file-name-handler-alist))) | 184 | (let ((fn (assoc operation tramp-adb-file-name-handler-alist))) |
| 185 | (if fn | 185 | (if fn |
| 186 | (save-match-data (apply (cdr fn) args)) | 186 | (save-match-data (apply (cdr fn) arguments)) |
| 187 | (tramp-run-real-handler operation args)))) | 187 | (tramp-run-real-handler operation arguments)))) |
| 188 | 188 | ||
| 189 | ;;;###tramp-autoload | 189 | ;;;###tramp-autoload |
| 190 | (tramp--with-startup | 190 | (tramp--with-startup |
| @@ -462,7 +462,7 @@ Convert (\"-al\") to (\"-a\" \"-l\"). Remove arguments like \"--dired\"." | |||
| 462 | 462 | ||
| 463 | (defun tramp-adb-sh-fix-ls-output (&optional sort-by-time) | 463 | (defun tramp-adb-sh-fix-ls-output (&optional sort-by-time) |
| 464 | "Insert dummy 0 in empty size columns. | 464 | "Insert dummy 0 in empty size columns. |
| 465 | Androids \"ls\" command doesn't insert size column for directories: | 465 | Android's \"ls\" command doesn't insert size column for directories: |
| 466 | Emacs dired can't find files." | 466 | Emacs dired can't find files." |
| 467 | (save-excursion | 467 | (save-excursion |
| 468 | ;; Insert missing size. | 468 | ;; Insert missing size. |
| @@ -1089,7 +1089,7 @@ E.g. a host name \"192.168.1.1#5555\" returns \"192.168.1.1:5555\" | |||
| 1089 | vec 'file-error "Could not find device %s" host))))))) | 1089 | vec 'file-error "Could not find device %s" host))))))) |
| 1090 | 1090 | ||
| 1091 | (defun tramp-adb-execute-adb-command (vec &rest args) | 1091 | (defun tramp-adb-execute-adb-command (vec &rest args) |
| 1092 | "Returns nil on success error-output on failure." | 1092 | "Return nil on success error-output on failure." |
| 1093 | (when (and (> (length (tramp-file-name-host vec)) 0) | 1093 | (when (and (> (length (tramp-file-name-host vec)) 0) |
| 1094 | ;; The -s switch is only available for ADB device commands. | 1094 | ;; The -s switch is only available for ADB device commands. |
| 1095 | (not (member (car args) '("connect" "disconnect")))) | 1095 | (not (member (car args) '("connect" "disconnect")))) |
| @@ -1103,7 +1103,7 @@ E.g. a host name \"192.168.1.1#5555\" returns \"192.168.1.1:5555\" | |||
| 1103 | (tramp-message vec 6 "%s" (buffer-string))))) | 1103 | (tramp-message vec 6 "%s" (buffer-string))))) |
| 1104 | 1104 | ||
| 1105 | (defun tramp-adb-find-test-command (vec) | 1105 | (defun tramp-adb-find-test-command (vec) |
| 1106 | "Checks, whether the ash has a builtin \"test\" command. | 1106 | "Check whether the ash has a builtin \"test\" command. |
| 1107 | This happens for Android >= 4.0." | 1107 | This happens for Android >= 4.0." |
| 1108 | (with-tramp-connection-property vec "test" | 1108 | (with-tramp-connection-property vec "test" |
| 1109 | (tramp-adb-send-command-and-check vec "type test"))) | 1109 | (tramp-adb-send-command-and-check vec "type test"))) |
diff --git a/lisp/net/tramp-cache.el b/lisp/net/tramp-cache.el index 1380d0368c7..0f7e14b704a 100644 --- a/lisp/net/tramp-cache.el +++ b/lisp/net/tramp-cache.el | |||
| @@ -97,7 +97,7 @@ details see the info pages." | |||
| 97 | "Whether persistent cache data have been changed.") | 97 | "Whether persistent cache data have been changed.") |
| 98 | 98 | ||
| 99 | (defun tramp-get-hash-table (key) | 99 | (defun tramp-get-hash-table (key) |
| 100 | "Returns the hash table for KEY. | 100 | "Return the hash table for KEY. |
| 101 | If it doesn't exist yet, it is created and initialized with | 101 | If it doesn't exist yet, it is created and initialized with |
| 102 | matching entries of `tramp-connection-properties'." | 102 | matching entries of `tramp-connection-properties'." |
| 103 | (or (gethash key tramp-cache-data) | 103 | (or (gethash key tramp-cache-data) |
diff --git a/lisp/net/tramp-compat.el b/lisp/net/tramp-compat.el index e83c1a1500b..232230f8697 100644 --- a/lisp/net/tramp-compat.el +++ b/lisp/net/tramp-compat.el | |||
| @@ -75,7 +75,7 @@ Add the extension of F, if existing." | |||
| 75 | #'tramp-handle-temporary-file-directory)) | 75 | #'tramp-handle-temporary-file-directory)) |
| 76 | 76 | ||
| 77 | (defun tramp-compat-process-running-p (process-name) | 77 | (defun tramp-compat-process-running-p (process-name) |
| 78 | "Returns t if system process PROCESS-NAME is running for `user-login-name'." | 78 | "Return t if system process PROCESS-NAME is running for `user-login-name'." |
| 79 | (when (stringp process-name) | 79 | (when (stringp process-name) |
| 80 | (cond | 80 | (cond |
| 81 | ;; GNU Emacs 22 on w32. | 81 | ;; GNU Emacs 22 on w32. |
diff --git a/lisp/net/tramp-smb.el b/lisp/net/tramp-smb.el index 2a9cf6a6d75..27c321bb9cb 100644 --- a/lisp/net/tramp-smb.el +++ b/lisp/net/tramp-smb.el | |||
| @@ -1577,14 +1577,14 @@ errors for shares like \"C$/\", which are common in Microsoft Windows." | |||
| 1577 | ;; Internal file name functions. | 1577 | ;; Internal file name functions. |
| 1578 | 1578 | ||
| 1579 | (defun tramp-smb-get-share (vec) | 1579 | (defun tramp-smb-get-share (vec) |
| 1580 | "Returns the share name of LOCALNAME." | 1580 | "Return the share name of LOCALNAME." |
| 1581 | (save-match-data | 1581 | (save-match-data |
| 1582 | (let ((localname (tramp-file-name-unquote-localname vec))) | 1582 | (let ((localname (tramp-file-name-unquote-localname vec))) |
| 1583 | (when (string-match "^/?\\([^/]+\\)/" localname) | 1583 | (when (string-match "^/?\\([^/]+\\)/" localname) |
| 1584 | (match-string 1 localname))))) | 1584 | (match-string 1 localname))))) |
| 1585 | 1585 | ||
| 1586 | (defun tramp-smb-get-localname (vec) | 1586 | (defun tramp-smb-get-localname (vec) |
| 1587 | "Returns the file name of LOCALNAME. | 1587 | "Return the file name of LOCALNAME. |
| 1588 | If VEC has no cifs capabilities, exchange \"/\" by \"\\\\\"." | 1588 | If VEC has no cifs capabilities, exchange \"/\" by \"\\\\\"." |
| 1589 | (save-match-data | 1589 | (save-match-data |
| 1590 | (let ((localname (tramp-file-name-unquote-localname vec))) | 1590 | (let ((localname (tramp-file-name-unquote-localname vec))) |
| @@ -1717,8 +1717,8 @@ Result is a list of (LOCALNAME MODE SIZE MONTH DAY TIME YEAR)." | |||
| 1717 | ;; So we try to analyze backwards. | 1717 | ;; So we try to analyze backwards. |
| 1718 | (defun tramp-smb-read-file-entry (share) | 1718 | (defun tramp-smb-read-file-entry (share) |
| 1719 | "Parse entry in SMB output buffer. | 1719 | "Parse entry in SMB output buffer. |
| 1720 | If SHARE is result, entries are of type dir. Otherwise, shares are listed. | 1720 | If SHARE is result, entries are of type dir. Otherwise, shares |
| 1721 | Result is the list (LOCALNAME MODE SIZE MTIME)." | 1721 | are listed. Result is the list (LOCALNAME MODE SIZE MTIME)." |
| 1722 | ;; We are called from `tramp-smb-get-file-entries', which sets the | 1722 | ;; We are called from `tramp-smb-get-file-entries', which sets the |
| 1723 | ;; current buffer. | 1723 | ;; current buffer. |
| 1724 | (let ((line (buffer-substring (point) (point-at-eol))) | 1724 | (let ((line (buffer-substring (point) (point-at-eol))) |
| @@ -1813,7 +1813,7 @@ Result is the list (LOCALNAME MODE SIZE MTIME)." | |||
| 1813 | (list localname mode size mtime)))) | 1813 | (list localname mode size mtime)))) |
| 1814 | 1814 | ||
| 1815 | (defun tramp-smb-get-cifs-capabilities (vec) | 1815 | (defun tramp-smb-get-cifs-capabilities (vec) |
| 1816 | "Check, whether the SMB server supports POSIX commands." | 1816 | "Check whether the SMB server supports POSIX commands." |
| 1817 | ;; When we are not logged in yet, we return nil. The | 1817 | ;; When we are not logged in yet, we return nil. The |
| 1818 | ;; connection-local property "posix" is not set explicitly; it is | 1818 | ;; connection-local property "posix" is not set explicitly; it is |
| 1819 | ;; just checked in order to let a user configure it to nil on hosts | 1819 | ;; just checked in order to let a user configure it to nil on hosts |
| @@ -1835,7 +1835,7 @@ Result is the list (LOCALNAME MODE SIZE MTIME)." | |||
| 1835 | (buffer-substring (point) (point-at-eol)) nil 'omit))))))))) | 1835 | (buffer-substring (point) (point-at-eol)) nil 'omit))))))))) |
| 1836 | 1836 | ||
| 1837 | (defun tramp-smb-get-stat-capability (vec) | 1837 | (defun tramp-smb-get-stat-capability (vec) |
| 1838 | "Check, whether the SMB server supports the STAT command." | 1838 | "Check whether the SMB server supports the STAT command." |
| 1839 | ;; When we are not logged in yet, we return nil. | 1839 | ;; When we are not logged in yet, we return nil. |
| 1840 | (if (and (tramp-smb-get-share vec) | 1840 | (if (and (tramp-smb-get-share vec) |
| 1841 | (process-live-p (tramp-get-connection-process vec))) | 1841 | (process-live-p (tramp-get-connection-process vec))) |
diff --git a/lisp/net/tramp.el b/lisp/net/tramp.el index 95ca6e3e2aa..37f34cf002b 100644 --- a/lisp/net/tramp.el +++ b/lisp/net/tramp.el | |||
| @@ -2008,7 +2008,7 @@ letter into the file name. This function removes it." | |||
| 2008 | ;;; Config Manipulation Functions: | 2008 | ;;; Config Manipulation Functions: |
| 2009 | 2009 | ||
| 2010 | (defun tramp-set-completion-function (method function-list) | 2010 | (defun tramp-set-completion-function (method function-list) |
| 2011 | "Sets the list of completion functions for METHOD. | 2011 | "Set the list of completion functions for METHOD. |
| 2012 | FUNCTION-LIST is a list of entries of the form (FUNCTION FILE). | 2012 | FUNCTION-LIST is a list of entries of the form (FUNCTION FILE). |
| 2013 | The FUNCTION is intended to parse FILE according its syntax. | 2013 | The FUNCTION is intended to parse FILE according its syntax. |
| 2014 | It might be a predefined FUNCTION, or a user defined FUNCTION. | 2014 | It might be a predefined FUNCTION, or a user defined FUNCTION. |
| @@ -2052,7 +2052,7 @@ Example: | |||
| 2052 | (cons method r))))) | 2052 | (cons method r))))) |
| 2053 | 2053 | ||
| 2054 | (defun tramp-get-completion-function (method) | 2054 | (defun tramp-get-completion-function (method) |
| 2055 | "Returns a list of completion functions for METHOD. | 2055 | "Return a list of completion functions for METHOD. |
| 2056 | For definition of that list see `tramp-set-completion-function'." | 2056 | For definition of that list see `tramp-set-completion-function'." |
| 2057 | (append | 2057 | (append |
| 2058 | `(;; Default settings are taken into account. | 2058 | `(;; Default settings are taken into account. |
| @@ -2629,7 +2629,7 @@ not in completion mode." | |||
| 2629 | ;; "/x:y@""/[x/y@" "/x:y@z" "/[x/y@z" "/x:y@z:" "/[x/y@z]" | 2629 | ;; "/x:y@""/[x/y@" "/x:y@z" "/[x/y@z" "/x:y@z:" "/[x/y@z]" |
| 2630 | ;;["x" "y" nil nil] ["x" "y" "z" nil] ["x" "y" "z" ""] | 2630 | ;;["x" "y" nil nil] ["x" "y" "z" nil] ["x" "y" "z" ""] |
| 2631 | (defun tramp-completion-dissect-file-name (name) | 2631 | (defun tramp-completion-dissect-file-name (name) |
| 2632 | "Returns a list of `tramp-file-name' structures. | 2632 | "Return a list of `tramp-file-name' structures. |
| 2633 | They are collected by `tramp-completion-dissect-file-name1'." | 2633 | They are collected by `tramp-completion-dissect-file-name1'." |
| 2634 | (let* ((x-nil "\\|\\(\\)") | 2634 | (let* ((x-nil "\\|\\(\\)") |
| 2635 | (tramp-completion-ipv6-regexp | 2635 | (tramp-completion-ipv6-regexp |
| @@ -2702,7 +2702,7 @@ They are collected by `tramp-completion-dissect-file-name1'." | |||
| 2702 | tramp-completion-file-name-structure6))))) | 2702 | tramp-completion-file-name-structure6))))) |
| 2703 | 2703 | ||
| 2704 | (defun tramp-completion-dissect-file-name1 (structure name) | 2704 | (defun tramp-completion-dissect-file-name1 (structure name) |
| 2705 | "Returns a `tramp-file-name' structure matching STRUCTURE. | 2705 | "Return a `tramp-file-name' structure matching STRUCTURE. |
| 2706 | The structure consists of remote method, remote user, | 2706 | The structure consists of remote method, remote user, |
| 2707 | remote host and localname (filename on remote host)." | 2707 | remote host and localname (filename on remote host)." |
| 2708 | (save-match-data | 2708 | (save-match-data |
| @@ -2718,7 +2718,7 @@ remote host and localname (filename on remote host)." | |||
| 2718 | ;; This function returns all possible method completions, adding the | 2718 | ;; This function returns all possible method completions, adding the |
| 2719 | ;; trailing method delimiter. | 2719 | ;; trailing method delimiter. |
| 2720 | (defun tramp-get-completion-methods (partial-method) | 2720 | (defun tramp-get-completion-methods (partial-method) |
| 2721 | "Returns all method completions for PARTIAL-METHOD." | 2721 | "Return all method completions for PARTIAL-METHOD." |
| 2722 | (mapcar | 2722 | (mapcar |
| 2723 | (lambda (method) | 2723 | (lambda (method) |
| 2724 | (and method | 2724 | (and method |
| @@ -2729,7 +2729,7 @@ remote host and localname (filename on remote host)." | |||
| 2729 | ;; Compares partial user and host names with possible completions. | 2729 | ;; Compares partial user and host names with possible completions. |
| 2730 | (defun tramp-get-completion-user-host | 2730 | (defun tramp-get-completion-user-host |
| 2731 | (method partial-user partial-host user host) | 2731 | (method partial-user partial-host user host) |
| 2732 | "Returns the most expanded string for user and host name completion. | 2732 | "Return the most expanded string for user and host name completion. |
| 2733 | PARTIAL-USER must match USER, PARTIAL-HOST must match HOST." | 2733 | PARTIAL-USER must match USER, PARTIAL-HOST must match HOST." |
| 2734 | (cond | 2734 | (cond |
| 2735 | 2735 | ||
| @@ -4228,13 +4228,13 @@ the remote host use line-endings as defined in the variable | |||
| 4228 | (delete-region (point) (point-max))))))) | 4228 | (delete-region (point) (point-max))))))) |
| 4229 | 4229 | ||
| 4230 | (defun tramp-get-inode (vec) | 4230 | (defun tramp-get-inode (vec) |
| 4231 | "Returns the virtual inode number. | 4231 | "Return the virtual inode number. |
| 4232 | If it doesn't exist, generate a new one." | 4232 | If it doesn't exist, generate a new one." |
| 4233 | (with-tramp-file-property vec (tramp-file-name-localname vec) "inode" | 4233 | (with-tramp-file-property vec (tramp-file-name-localname vec) "inode" |
| 4234 | (setq tramp-inodes (1+ tramp-inodes)))) | 4234 | (setq tramp-inodes (1+ tramp-inodes)))) |
| 4235 | 4235 | ||
| 4236 | (defun tramp-get-device (vec) | 4236 | (defun tramp-get-device (vec) |
| 4237 | "Returns the virtual device number. | 4237 | "Return the virtual device number. |
| 4238 | If it doesn't exist, generate a new one." | 4238 | If it doesn't exist, generate a new one." |
| 4239 | (with-tramp-connection-property (tramp-get-connection-process vec) "device" | 4239 | (with-tramp-connection-property (tramp-get-connection-process vec) "device" |
| 4240 | (cons -1 (setq tramp-devices (1+ tramp-devices))))) | 4240 | (cons -1 (setq tramp-devices (1+ tramp-devices))))) |
| @@ -4261,7 +4261,7 @@ If both files are local, the function returns t." | |||
| 4261 | (string-equal (file-remote-p file1) (file-remote-p file2))))) | 4261 | (string-equal (file-remote-p file1) (file-remote-p file2))))) |
| 4262 | 4262 | ||
| 4263 | (defun tramp-mode-string-to-int (mode-string) | 4263 | (defun tramp-mode-string-to-int (mode-string) |
| 4264 | "Converts a ten-letter `drwxrwxrwx'-style mode string into mode bits." | 4264 | "Convert a ten-letter `drwxrwxrwx'-style mode string into mode bits." |
| 4265 | (let* (case-fold-search | 4265 | (let* (case-fold-search |
| 4266 | (mode-chars (string-to-vector mode-string)) | 4266 | (mode-chars (string-to-vector mode-string)) |
| 4267 | (owner-read (aref mode-chars 1)) | 4267 | (owner-read (aref mode-chars 1)) |
| @@ -4631,7 +4631,7 @@ ALIST is of the form ((FROM . TO) ...)." | |||
| 4631 | 4631 | ||
| 4632 | (defun tramp-call-process | 4632 | (defun tramp-call-process |
| 4633 | (vec program &optional infile destination display &rest args) | 4633 | (vec program &optional infile destination display &rest args) |
| 4634 | "Calls `call-process' on the local host. | 4634 | "Call `call-process' on the local host. |
| 4635 | It always returns a return code. The Lisp error raised when | 4635 | It always returns a return code. The Lisp error raised when |
| 4636 | PROGRAM is nil is trapped also, returning 1. Furthermore, traces | 4636 | PROGRAM is nil is trapped also, returning 1. Furthermore, traces |
| 4637 | are written with verbosity of 6." | 4637 | are written with verbosity of 6." |
| @@ -4665,7 +4665,7 @@ are written with verbosity of 6." | |||
| 4665 | 4665 | ||
| 4666 | (defun tramp-call-process-region | 4666 | (defun tramp-call-process-region |
| 4667 | (vec start end program &optional delete buffer display &rest args) | 4667 | (vec start end program &optional delete buffer display &rest args) |
| 4668 | "Calls `call-process-region' on the local host. | 4668 | "Call `call-process-region' on the local host. |
| 4669 | It always returns a return code. The Lisp error raised when | 4669 | It always returns a return code. The Lisp error raised when |
| 4670 | PROGRAM is nil is trapped also, returning 1. Furthermore, traces | 4670 | PROGRAM is nil is trapped also, returning 1. Furthermore, traces |
| 4671 | are written with verbosity of 6." | 4671 | are written with verbosity of 6." |
| @@ -4696,7 +4696,7 @@ are written with verbosity of 6." | |||
| 4696 | 4696 | ||
| 4697 | (defun tramp-process-lines | 4697 | (defun tramp-process-lines |
| 4698 | (vec program &rest args) | 4698 | (vec program &rest args) |
| 4699 | "Calls `process-lines' on the local host. | 4699 | "Call `process-lines' on the local host. |
| 4700 | If an error occurs, it returns nil. Traces are written with | 4700 | If an error occurs, it returns nil. Traces are written with |
| 4701 | verbosity of 6." | 4701 | verbosity of 6." |
| 4702 | (let ((default-directory (tramp-compat-temporary-file-directory)) | 4702 | (let ((default-directory (tramp-compat-temporary-file-directory)) |
| @@ -4852,7 +4852,9 @@ Only works for Bourne-like shells." | |||
| 4852 | ;;; the process property `remote-pid'. | 4852 | ;;; the process property `remote-pid'. |
| 4853 | 4853 | ||
| 4854 | (defun tramp-interrupt-process (&optional process _current-group) | 4854 | (defun tramp-interrupt-process (&optional process _current-group) |
| 4855 | "Interrupt remote process PROC." | 4855 | "Interrupt remote PROCESS. |
| 4856 | PROCESS can be a process, a buffer with an associated process, the | ||
| 4857 | name of a process or buffer, or nil to default to the current buffer." | ||
| 4856 | ;; CURRENT-GROUP is not implemented yet. | 4858 | ;; CURRENT-GROUP is not implemented yet. |
| 4857 | (let ((proc (cond | 4859 | (let ((proc (cond |
| 4858 | ((processp process) process) | 4860 | ((processp process) process) |
diff --git a/lisp/net/zeroconf.el b/lisp/net/zeroconf.el index 36643a828eb..048f2e761b5 100644 --- a/lisp/net/zeroconf.el +++ b/lisp/net/zeroconf.el | |||
| @@ -253,7 +253,7 @@ the service. Usually, every string is a key=value pair. The | |||
| 253 | supported keys depend on the service type.") | 253 | supported keys depend on the service type.") |
| 254 | 254 | ||
| 255 | (defun zeroconf-list-service-names () | 255 | (defun zeroconf-list-service-names () |
| 256 | "Returns all discovered Avahi service names as list." | 256 | "Return all discovered Avahi service names as list." |
| 257 | (let (result) | 257 | (let (result) |
| 258 | (maphash | 258 | (maphash |
| 259 | (lambda (_key value) (add-to-list 'result (zeroconf-service-name value))) | 259 | (lambda (_key value) (add-to-list 'result (zeroconf-service-name value))) |
| @@ -261,7 +261,7 @@ supported keys depend on the service type.") | |||
| 261 | result)) | 261 | result)) |
| 262 | 262 | ||
| 263 | (defun zeroconf-list-service-types () | 263 | (defun zeroconf-list-service-types () |
| 264 | "Returns all discovered Avahi service types as list." | 264 | "Return all discovered Avahi service types as list." |
| 265 | (let (result) | 265 | (let (result) |
| 266 | (maphash | 266 | (maphash |
| 267 | (lambda (_key value) (add-to-list 'result (zeroconf-service-type value))) | 267 | (lambda (_key value) (add-to-list 'result (zeroconf-service-type value))) |
| @@ -269,7 +269,7 @@ supported keys depend on the service type.") | |||
| 269 | result)) | 269 | result)) |
| 270 | 270 | ||
| 271 | (defun zeroconf-list-services (type) | 271 | (defun zeroconf-list-services (type) |
| 272 | "Returns all discovered Avahi services for a given service type TYPE. | 272 | "Return all discovered Avahi services for a given service type TYPE. |
| 273 | The service type is one of the returned values of | 273 | The service type is one of the returned values of |
| 274 | `zeroconf-list-service-types'. The return value is a list | 274 | `zeroconf-list-service-types'. The return value is a list |
| 275 | \(SERVICE1 SERVICE2 ...). See `zeroconf-services-hash' for the | 275 | \(SERVICE1 SERVICE2 ...). See `zeroconf-services-hash' for the |
| @@ -341,19 +341,19 @@ type used when registering FUNCTION." | |||
| 341 | (remhash type table)))) | 341 | (remhash type table)))) |
| 342 | 342 | ||
| 343 | (defun zeroconf-get-host () | 343 | (defun zeroconf-get-host () |
| 344 | "Returns the local host name as string." | 344 | "Return the local host name as string." |
| 345 | (dbus-call-method | 345 | (dbus-call-method |
| 346 | :system zeroconf-service-avahi zeroconf-path-avahi | 346 | :system zeroconf-service-avahi zeroconf-path-avahi |
| 347 | zeroconf-interface-avahi-server "GetHostName")) | 347 | zeroconf-interface-avahi-server "GetHostName")) |
| 348 | 348 | ||
| 349 | (defun zeroconf-get-domain () | 349 | (defun zeroconf-get-domain () |
| 350 | "Returns the domain name as string." | 350 | "Return the domain name as string." |
| 351 | (dbus-call-method | 351 | (dbus-call-method |
| 352 | :system zeroconf-service-avahi zeroconf-path-avahi | 352 | :system zeroconf-service-avahi zeroconf-path-avahi |
| 353 | zeroconf-interface-avahi-server "GetDomainName")) | 353 | zeroconf-interface-avahi-server "GetDomainName")) |
| 354 | 354 | ||
| 355 | (defun zeroconf-get-host-domain () | 355 | (defun zeroconf-get-host-domain () |
| 356 | "Returns the local host name FQDN as string." | 356 | "Return the local host name FQDN as string." |
| 357 | (dbus-call-method | 357 | (dbus-call-method |
| 358 | :system zeroconf-service-avahi zeroconf-path-avahi | 358 | :system zeroconf-service-avahi zeroconf-path-avahi |
| 359 | zeroconf-interface-avahi-server "GetHostNameFqdn")) | 359 | zeroconf-interface-avahi-server "GetHostNameFqdn")) |