diff options
Diffstat (limited to 'lisp/net/tramp.el')
| -rw-r--r-- | lisp/net/tramp.el | 28 |
1 files changed, 15 insertions, 13 deletions
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." ;;; Config Manipulation Functions: (defun tramp-set-completion-function (method function-list) - "Sets the list of completion functions for METHOD. + "Set the list of completion functions for METHOD. FUNCTION-LIST is a list of entries of the form (FUNCTION FILE). The FUNCTION is intended to parse FILE according its syntax. It might be a predefined FUNCTION, or a user defined FUNCTION. @@ -2052,7 +2052,7 @@ Example: (cons method r))))) (defun tramp-get-completion-function (method) - "Returns a list of completion functions for METHOD. + "Return a list of completion functions for METHOD. For definition of that list see `tramp-set-completion-function'." (append `(;; Default settings are taken into account. @@ -2629,7 +2629,7 @@ not in completion mode." ;; "/x:y@""/[x/y@" "/x:y@z" "/[x/y@z" "/x:y@z:" "/[x/y@z]" ;;["x" "y" nil nil] ["x" "y" "z" nil] ["x" "y" "z" ""] (defun tramp-completion-dissect-file-name (name) - "Returns a list of `tramp-file-name' structures. + "Return a list of `tramp-file-name' structures. They are collected by `tramp-completion-dissect-file-name1'." (let* ((x-nil "\\|\\(\\)") (tramp-completion-ipv6-regexp @@ -2702,7 +2702,7 @@ They are collected by `tramp-completion-dissect-file-name1'." tramp-completion-file-name-structure6))))) (defun tramp-completion-dissect-file-name1 (structure name) - "Returns a `tramp-file-name' structure matching STRUCTURE. + "Return a `tramp-file-name' structure matching STRUCTURE. The structure consists of remote method, remote user, remote host and localname (filename on remote host)." (save-match-data @@ -2718,7 +2718,7 @@ remote host and localname (filename on remote host)." ;; This function returns all possible method completions, adding the ;; trailing method delimiter. (defun tramp-get-completion-methods (partial-method) - "Returns all method completions for PARTIAL-METHOD." + "Return all method completions for PARTIAL-METHOD." (mapcar (lambda (method) (and method @@ -2729,7 +2729,7 @@ remote host and localname (filename on remote host)." ;; Compares partial user and host names with possible completions. (defun tramp-get-completion-user-host (method partial-user partial-host user host) - "Returns the most expanded string for user and host name completion. + "Return the most expanded string for user and host name completion. PARTIAL-USER must match USER, PARTIAL-HOST must match HOST." (cond @@ -4228,13 +4228,13 @@ the remote host use line-endings as defined in the variable (delete-region (point) (point-max))))))) (defun tramp-get-inode (vec) - "Returns the virtual inode number. + "Return the virtual inode number. If it doesn't exist, generate a new one." (with-tramp-file-property vec (tramp-file-name-localname vec) "inode" (setq tramp-inodes (1+ tramp-inodes)))) (defun tramp-get-device (vec) - "Returns the virtual device number. + "Return the virtual device number. If it doesn't exist, generate a new one." (with-tramp-connection-property (tramp-get-connection-process vec) "device" (cons -1 (setq tramp-devices (1+ tramp-devices))))) @@ -4261,7 +4261,7 @@ If both files are local, the function returns t." (string-equal (file-remote-p file1) (file-remote-p file2))))) (defun tramp-mode-string-to-int (mode-string) - "Converts a ten-letter `drwxrwxrwx'-style mode string into mode bits." + "Convert a ten-letter `drwxrwxrwx'-style mode string into mode bits." (let* (case-fold-search (mode-chars (string-to-vector mode-string)) (owner-read (aref mode-chars 1)) @@ -4631,7 +4631,7 @@ ALIST is of the form ((FROM . TO) ...)." (defun tramp-call-process (vec program &optional infile destination display &rest args) - "Calls `call-process' on the local host. + "Call `call-process' on the local host. It always returns a return code. The Lisp error raised when PROGRAM is nil is trapped also, returning 1. Furthermore, traces are written with verbosity of 6." @@ -4665,7 +4665,7 @@ are written with verbosity of 6." (defun tramp-call-process-region (vec start end program &optional delete buffer display &rest args) - "Calls `call-process-region' on the local host. + "Call `call-process-region' on the local host. It always returns a return code. The Lisp error raised when PROGRAM is nil is trapped also, returning 1. Furthermore, traces are written with verbosity of 6." @@ -4696,7 +4696,7 @@ are written with verbosity of 6." (defun tramp-process-lines (vec program &rest args) - "Calls `process-lines' on the local host. + "Call `process-lines' on the local host. If an error occurs, it returns nil. Traces are written with verbosity of 6." (let ((default-directory (tramp-compat-temporary-file-directory)) @@ -4852,7 +4852,9 @@ Only works for Bourne-like shells." ;;; the process property `remote-pid'. (defun tramp-interrupt-process (&optional process _current-group) - "Interrupt remote process PROC." + "Interrupt remote PROCESS. +PROCESS can be a process, a buffer with an associated process, the +name of a process or buffer, or nil to default to the current buffer." ;; CURRENT-GROUP is not implemented yet. (let ((proc (cond ((processp process) process) |