diff options
| author | Stefan Kangas | 2021-09-14 07:55:56 +0200 |
|---|---|---|
| committer | Stefan Kangas | 2021-09-14 07:57:14 +0200 |
| commit | 25ebb9374bdadf66153727831fc7ff131c8cf299 (patch) | |
| tree | 7ed04a5efe70f4f6e66118aebd9ccee12275d6bf /lisp/eshell | |
| parent | cf2fa6c87f4da4665ff8a9e8e220bba0b5bccefc (diff) | |
| download | emacs-25ebb9374bdadf66153727831fc7ff131c8cf299.tar.gz emacs-25ebb9374bdadf66153727831fc7ff131c8cf299.zip | |
; More minor docfixes found by checkdoc
Diffstat (limited to 'lisp/eshell')
| -rw-r--r-- | lisp/eshell/em-basic.el | 2 | ||||
| -rw-r--r-- | lisp/eshell/em-glob.el | 4 | ||||
| -rw-r--r-- | lisp/eshell/em-hist.el | 2 | ||||
| -rw-r--r-- | lisp/eshell/em-ls.el | 14 | ||||
| -rw-r--r-- | lisp/eshell/em-pred.el | 2 | ||||
| -rw-r--r-- | lisp/eshell/em-rebind.el | 2 | ||||
| -rw-r--r-- | lisp/eshell/em-smart.el | 4 | ||||
| -rw-r--r-- | lisp/eshell/esh-arg.el | 2 | ||||
| -rw-r--r-- | lisp/eshell/esh-cmd.el | 4 | ||||
| -rw-r--r-- | lisp/eshell/esh-ext.el | 2 | ||||
| -rw-r--r-- | lisp/eshell/esh-io.el | 2 | ||||
| -rw-r--r-- | lisp/eshell/esh-mode.el | 2 | ||||
| -rw-r--r-- | lisp/eshell/eshell.el | 10 |
13 files changed, 26 insertions, 26 deletions
diff --git a/lisp/eshell/em-basic.el b/lisp/eshell/em-basic.el index 64fc7e7f03b..af5550b11df 100644 --- a/lisp/eshell/em-basic.el +++ b/lisp/eshell/em-basic.el | |||
| @@ -164,7 +164,7 @@ or `eshell-printn' for display." | |||
| 164 | (set-default-file-modes | 164 | (set-default-file-modes |
| 165 | (- 511 (car (read-from-string | 165 | (- 511 (car (read-from-string |
| 166 | (concat "?\\" (number-to-string (car args))))))) | 166 | (concat "?\\" (number-to-string (car args))))))) |
| 167 | (error "setting umask symbolically is not yet implemented")) | 167 | (error "Setting umask symbolically is not yet implemented")) |
| 168 | (eshell-print | 168 | (eshell-print |
| 169 | "Warning: umask changed for all new files created by Emacs.\n")) | 169 | "Warning: umask changed for all new files created by Emacs.\n")) |
| 170 | nil)) | 170 | nil)) |
diff --git a/lisp/eshell/em-glob.el b/lisp/eshell/em-glob.el index e36f2d0c7fe..ba12e43a3c2 100644 --- a/lisp/eshell/em-glob.el +++ b/lisp/eshell/em-glob.el | |||
| @@ -91,7 +91,7 @@ This option slows down recursive glob processing by quite a bit." | |||
| 91 | 91 | ||
| 92 | (defcustom eshell-error-if-no-glob nil | 92 | (defcustom eshell-error-if-no-glob nil |
| 93 | "If non-nil, it is an error for a glob pattern not to match. | 93 | "If non-nil, it is an error for a glob pattern not to match. |
| 94 | This mimics the behavior of zsh if non-nil, but bash if nil." | 94 | This mimics the behavior of zsh if non-nil, but bash if nil." |
| 95 | :type 'boolean | 95 | :type 'boolean |
| 96 | :group 'eshell-glob) | 96 | :group 'eshell-glob) |
| 97 | 97 | ||
| @@ -266,7 +266,7 @@ the form: | |||
| 266 | 266 | ||
| 267 | ;; FIXME does this really need to abuse eshell-glob-matches, message-shown? | 267 | ;; FIXME does this really need to abuse eshell-glob-matches, message-shown? |
| 268 | (defun eshell-glob-entries (path globs &optional recurse-p) | 268 | (defun eshell-glob-entries (path globs &optional recurse-p) |
| 269 | "Glob the entries in PATHS, possibly recursing if RECURSE-P is non-nil." | 269 | "Glob the entries in PATH, possibly recursing if RECURSE-P is non-nil." |
| 270 | (let* ((entries (ignore-errors | 270 | (let* ((entries (ignore-errors |
| 271 | (file-name-all-completions "" path))) | 271 | (file-name-all-completions "" path))) |
| 272 | (case-fold-search eshell-glob-case-insensitive) | 272 | (case-fold-search eshell-glob-case-insensitive) |
diff --git a/lisp/eshell/em-hist.el b/lisp/eshell/em-hist.el index d82946add00..aa158fa24cc 100644 --- a/lisp/eshell/em-hist.el +++ b/lisp/eshell/em-hist.el | |||
| @@ -402,7 +402,7 @@ variable `eshell-input-filter' returns non-nil when called on the | |||
| 402 | command. | 402 | command. |
| 403 | 403 | ||
| 404 | This function is supposed to be called from the minibuffer, presumably | 404 | This function is supposed to be called from the minibuffer, presumably |
| 405 | as a minibuffer-exit-hook." | 405 | as a `minibuffer-exit-hook'." |
| 406 | (eshell-add-input-to-history | 406 | (eshell-add-input-to-history |
| 407 | (buffer-substring (minibuffer-prompt-end) (point-max)))) | 407 | (buffer-substring (minibuffer-prompt-end) (point-max)))) |
| 408 | 408 | ||
diff --git a/lisp/eshell/em-ls.el b/lisp/eshell/em-ls.el index 3d7c43b404b..57146bb126d 100644 --- a/lisp/eshell/em-ls.el +++ b/lisp/eshell/em-ls.el | |||
| @@ -35,10 +35,10 @@ | |||
| 35 | ;;;###autoload | 35 | ;;;###autoload |
| 36 | (progn | 36 | (progn |
| 37 | (defgroup eshell-ls nil | 37 | (defgroup eshell-ls nil |
| 38 | "This module implements the \"ls\" utility fully in Lisp. If it is | 38 | "This module implements the \"ls\" utility fully in Lisp. |
| 39 | passed any unrecognized command switches, it will revert to the | 39 | If it is passed any unrecognized command switches, it will revert |
| 40 | operating system's version. This version of \"ls\" uses text | 40 | to the operating system's version. This version of \"ls\" uses |
| 41 | properties to colorize its output based on the setting of | 41 | text properties to colorize its output based on the setting of |
| 42 | `eshell-ls-use-colors'." | 42 | `eshell-ls-use-colors'." |
| 43 | :tag "Implementation of `ls' in Lisp" | 43 | :tag "Implementation of `ls' in Lisp" |
| 44 | :group 'eshell-module)) | 44 | :group 'eshell-module)) |
| @@ -476,9 +476,9 @@ name should be displayed as, etc. Think of it as cooking a FILEINFO." | |||
| 476 | fileinfo) | 476 | fileinfo) |
| 477 | 477 | ||
| 478 | (defun eshell-ls-file (fileinfo &optional size-width copy-fileinfo) | 478 | (defun eshell-ls-file (fileinfo &optional size-width copy-fileinfo) |
| 479 | "Output FILE in long format. | 479 | "Output FILEINFO in long format. |
| 480 | FILE may be a string, or a cons cell whose car is the filename and | 480 | FILEINFO may be a string, or a cons cell whose car is the |
| 481 | whose cdr is the list of file attributes." | 481 | filename and whose cdr is the list of file attributes." |
| 482 | (if (not (cdr fileinfo)) | 482 | (if (not (cdr fileinfo)) |
| 483 | (funcall error-func (format "%s: No such file or directory\n" | 483 | (funcall error-func (format "%s: No such file or directory\n" |
| 484 | (car fileinfo))) | 484 | (car fileinfo))) |
diff --git a/lisp/eshell/em-pred.el b/lisp/eshell/em-pred.el index def52f42e55..639098a9b9e 100644 --- a/lisp/eshell/em-pred.el +++ b/lisp/eshell/em-pred.el | |||
| @@ -258,7 +258,7 @@ EXAMPLES: | |||
| 258 | (eshell-pred-mode)) | 258 | (eshell-pred-mode)) |
| 259 | 259 | ||
| 260 | (defun eshell-apply-modifiers (lst predicates modifiers) | 260 | (defun eshell-apply-modifiers (lst predicates modifiers) |
| 261 | "Apply to LIST a series of PREDICATES and MODIFIERS." | 261 | "Apply to list LST a series of PREDICATES and MODIFIERS." |
| 262 | (let (stringified) | 262 | (let (stringified) |
| 263 | (if (stringp lst) | 263 | (if (stringp lst) |
| 264 | (setq lst (list lst) | 264 | (setq lst (list lst) |
diff --git a/lisp/eshell/em-rebind.el b/lisp/eshell/em-rebind.el index fa61fffaec8..d70444ea109 100644 --- a/lisp/eshell/em-rebind.el +++ b/lisp/eshell/em-rebind.el | |||
| @@ -168,7 +168,7 @@ This is default behavior of shells like bash." | |||
| 168 | 168 | ||
| 169 | (defun eshell-lock-local-map (&optional arg) | 169 | (defun eshell-lock-local-map (&optional arg) |
| 170 | "Lock or unlock the current local keymap. | 170 | "Lock or unlock the current local keymap. |
| 171 | Within a prefix arg, set the local keymap to its normal value, and | 171 | With prefix ARG, set the local keymap to its normal value, and |
| 172 | lock it at that." | 172 | lock it at that." |
| 173 | (interactive "P") | 173 | (interactive "P") |
| 174 | (if (or arg (not eshell-lock-keymap)) | 174 | (if (or arg (not eshell-lock-keymap)) |
diff --git a/lisp/eshell/em-smart.el b/lisp/eshell/em-smart.el index d1c83db188a..dffc8f804b7 100644 --- a/lisp/eshell/em-smart.el +++ b/lisp/eshell/em-smart.el | |||
| @@ -131,7 +131,7 @@ only if that output can be presented in its entirely in the Eshell window." | |||
| 131 | :group 'eshell-smart) | 131 | :group 'eshell-smart) |
| 132 | 132 | ||
| 133 | (defcustom eshell-smart-space-goes-to-end t | 133 | (defcustom eshell-smart-space-goes-to-end t |
| 134 | "If non-nil, space will go to end of buffer when point-max is visible. | 134 | "If non-nil, space will go to end of buffer when `point-max' is visible. |
| 135 | That is, if a command is running and the user presses SPACE at a time | 135 | That is, if a command is running and the user presses SPACE at a time |
| 136 | when the end of the buffer is visible, point will go to the end of the | 136 | when the end of the buffer is visible, point will go to the end of the |
| 137 | buffer and smart-display will be turned off (that is, subsequently | 137 | buffer and smart-display will be turned off (that is, subsequently |
| @@ -195,7 +195,7 @@ The options are `begin', `after' or `end'." | |||
| 195 | 195 | ||
| 196 | ;; This is called by window-scroll-functions with two arguments. | 196 | ;; This is called by window-scroll-functions with two arguments. |
| 197 | (defun eshell-smart-scroll-window (wind _start) | 197 | (defun eshell-smart-scroll-window (wind _start) |
| 198 | "Scroll the given Eshell window accordingly." | 198 | "Scroll the given Eshell window WIND accordingly." |
| 199 | (unless eshell-currently-handling-window | 199 | (unless eshell-currently-handling-window |
| 200 | (let ((inhibit-point-motion-hooks t) | 200 | (let ((inhibit-point-motion-hooks t) |
| 201 | (eshell-currently-handling-window t)) | 201 | (eshell-currently-handling-window t)) |
diff --git a/lisp/eshell/esh-arg.el b/lisp/eshell/esh-arg.el index 3cf80e45187..1990c0cfa55 100644 --- a/lisp/eshell/esh-arg.el +++ b/lisp/eshell/esh-arg.el | |||
| @@ -203,7 +203,7 @@ treated as a literal character." | |||
| 203 | (setq eshell-current-modifiers nil)) | 203 | (setq eshell-current-modifiers nil)) |
| 204 | 204 | ||
| 205 | (defun eshell-finish-arg (&optional argument) | 205 | (defun eshell-finish-arg (&optional argument) |
| 206 | "Finish the current argument being processed." | 206 | "Finish the current ARGUMENT being processed." |
| 207 | (if argument | 207 | (if argument |
| 208 | (setq eshell-current-argument argument)) | 208 | (setq eshell-current-argument argument)) |
| 209 | (throw 'eshell-arg-done t)) | 209 | (throw 'eshell-arg-done t)) |
diff --git a/lisp/eshell/esh-cmd.el b/lisp/eshell/esh-cmd.el index 90a8f85665a..1aac95e0b4f 100644 --- a/lisp/eshell/esh-cmd.el +++ b/lisp/eshell/esh-cmd.el | |||
| @@ -1236,10 +1236,10 @@ or an external command." | |||
| 1236 | (eshell-external-command command args)))) | 1236 | (eshell-external-command command args)))) |
| 1237 | 1237 | ||
| 1238 | (defun eshell-exec-lisp (printer errprint func-or-form args form-p) | 1238 | (defun eshell-exec-lisp (printer errprint func-or-form args form-p) |
| 1239 | "Execute a lisp FUNC-OR-FORM, maybe passing ARGS. | 1239 | "Execute a Lisp FUNC-OR-FORM, maybe passing ARGS. |
| 1240 | PRINTER and ERRPRINT are functions to use for printing regular | 1240 | PRINTER and ERRPRINT are functions to use for printing regular |
| 1241 | messages, and errors. FORM-P should be non-nil if FUNC-OR-FORM | 1241 | messages, and errors. FORM-P should be non-nil if FUNC-OR-FORM |
| 1242 | represent a lisp form; ARGS will be ignored in that case." | 1242 | represent a Lisp form; ARGS will be ignored in that case." |
| 1243 | (eshell-condition-case err | 1243 | (eshell-condition-case err |
| 1244 | (let ((result | 1244 | (let ((result |
| 1245 | (save-current-buffer | 1245 | (save-current-buffer |
diff --git a/lisp/eshell/esh-ext.el b/lisp/eshell/esh-ext.el index 9930e0884cb..fa149dd46e3 100644 --- a/lisp/eshell/esh-ext.el +++ b/lisp/eshell/esh-ext.el | |||
| @@ -110,7 +110,7 @@ wholly ignored." | |||
| 110 | (autoload 'eshell-parse-command "esh-cmd") | 110 | (autoload 'eshell-parse-command "esh-cmd") |
| 111 | 111 | ||
| 112 | (defsubst eshell-invoke-batch-file (&rest args) | 112 | (defsubst eshell-invoke-batch-file (&rest args) |
| 113 | "Invoke a .BAT or .CMD file on DOS/Windows systems." | 113 | "Invoke a .BAT or .CMD file on MS-DOS/MS-Windows systems." |
| 114 | ;; since CMD.EXE can't handle forward slashes in the initial | 114 | ;; since CMD.EXE can't handle forward slashes in the initial |
| 115 | ;; argument... | 115 | ;; argument... |
| 116 | (setcar args (subst-char-in-string ?/ ?\\ (car args))) | 116 | (setcar args (subst-char-in-string ?/ ?\\ (car args))) |
diff --git a/lisp/eshell/esh-io.el b/lisp/eshell/esh-io.el index 0e98aa0049e..0e6121031dc 100644 --- a/lisp/eshell/esh-io.el +++ b/lisp/eshell/esh-io.el | |||
| @@ -34,7 +34,7 @@ | |||
| 34 | ;;;_* Redirect to a Buffer or Process | 34 | ;;;_* Redirect to a Buffer or Process |
| 35 | ;; | 35 | ;; |
| 36 | ;; Buffers and processes can be named with '#<buffer buffer-name>' and | 36 | ;; Buffers and processes can be named with '#<buffer buffer-name>' and |
| 37 | ;; '#<process process-name>', respectively. As a shorthand, | 37 | ;; '#<process process-name>', respectively. As a shorthand, |
| 38 | ;; '#<buffer-name>' without the explicit "buffer" arg is equivalent to | 38 | ;; '#<buffer-name>' without the explicit "buffer" arg is equivalent to |
| 39 | ;; '#<buffer buffer-name>'. | 39 | ;; '#<buffer buffer-name>'. |
| 40 | ;; | 40 | ;; |
diff --git a/lisp/eshell/esh-mode.el b/lisp/eshell/esh-mode.el index f9dbce9770d..a9775b7c568 100644 --- a/lisp/eshell/esh-mode.el +++ b/lisp/eshell/esh-mode.el | |||
| @@ -499,7 +499,7 @@ and the hook `eshell-exit-hook'." | |||
| 499 | (yank))) | 499 | (yank))) |
| 500 | 500 | ||
| 501 | (defun eshell-bol () | 501 | (defun eshell-bol () |
| 502 | "Goes to the beginning of line, then skips past the prompt, if any." | 502 | "Go to the beginning of line, then skip past the prompt, if any." |
| 503 | (interactive) | 503 | (interactive) |
| 504 | (beginning-of-line) | 504 | (beginning-of-line) |
| 505 | (and eshell-skip-prompt-function | 505 | (and eshell-skip-prompt-function |
diff --git a/lisp/eshell/eshell.el b/lisp/eshell/eshell.el index 101ac860346..35153675faa 100644 --- a/lisp/eshell/eshell.el +++ b/lisp/eshell/eshell.el | |||
| @@ -33,15 +33,15 @@ | |||
| 33 | ;; @ A high degree of configurability | 33 | ;; @ A high degree of configurability |
| 34 | ;; | 34 | ;; |
| 35 | ;; @ The ability to have the same shell on every system Emacs has been | 35 | ;; @ The ability to have the same shell on every system Emacs has been |
| 36 | ;; ported to. Since Eshell imposes no external requirements, and | 36 | ;; ported to. Since Eshell imposes no external requirements, and |
| 37 | ;; relies upon only the Lisp functions exposed by Emacs, it is quite | 37 | ;; relies upon only the Lisp functions exposed by Emacs, it is quite |
| 38 | ;; operating system independent. Several of the common UNIX | 38 | ;; operating system independent. Several of the common UNIX |
| 39 | ;; commands, such as ls, mv, rm, ln, etc., have been implemented in | 39 | ;; commands, such as ls, mv, rm, ln, etc., have been implemented in |
| 40 | ;; Lisp in order to provide a more consistent work environment. | 40 | ;; Lisp in order to provide a more consistent work environment. |
| 41 | ;; | 41 | ;; |
| 42 | ;; For those who might be using an older version of Eshell, version | 42 | ;; For those who might be using an older version of Eshell, version |
| 43 | ;; 2.1 represents an entirely new, module-based architecture. It | 43 | ;; 2.1 represents an entirely new, module-based architecture. It |
| 44 | ;; supports most of the features offered by modern shells. Here is a | 44 | ;; supports most of the features offered by modern shells. Here is a |
| 45 | ;; brief list of some of its more visible features: | 45 | ;; brief list of some of its more visible features: |
| 46 | ;; | 46 | ;; |
| 47 | ;; @ Command argument completion (tcsh, zsh) | 47 | ;; @ Command argument completion (tcsh, zsh) |
| @@ -136,7 +136,7 @@ | |||
| 136 | ;; errors, such as 'dri' for `dir'. Since executing non-existent | 136 | ;; errors, such as 'dri' for `dir'. Since executing non-existent |
| 137 | ;; programs is rarely the intention of the user, eshell could prompt | 137 | ;; programs is rarely the intention of the user, eshell could prompt |
| 138 | ;; for the replacement string, and then record that in a database of | 138 | ;; for the replacement string, and then record that in a database of |
| 139 | ;; known misspellings. (Note: The typo at the beginning of this | 139 | ;; known misspellings. (Note: The typo at the beginning of this |
| 140 | ;; paragraph wasn't discovered until two months after I wrote the | 140 | ;; paragraph wasn't discovered until two months after I wrote the |
| 141 | ;; text; it was not intentional). | 141 | ;; text; it was not intentional). |
| 142 | ;; | 142 | ;; |