]> git.eshelyaron.com Git - emacs.git/commitdiff
; * lisp/eshell/em-script.el (eshell-execute-file): Improve docstring.
authorJim Porter <jporterbugs@gmail.com>
Fri, 14 Jun 2024 04:44:40 +0000 (21:44 -0700)
committerEshel Yaron <me@eshelyaron.com>
Sat, 15 Jun 2024 17:21:13 +0000 (19:21 +0200)
(cherry picked from commit 19b407ac749fcb8d978e8263ed98328100128de5)

lisp/eshell/em-script.el

index 6cddffdcf5fc990ea58f17ac5f11f3152d97c509..ba020d2eb5b9d800fb78c22e4673d5d4335e27b0 100644 (file)
@@ -108,6 +108,10 @@ Comments begin with `#'."
 ;;;###autoload
 (defun eshell-execute-file (file &optional args destination)
   "Execute a series of Eshell commands in FILE, passing ARGS.
+If DESTINATION is t, write the command output to the current buffer.  If
+nil, don't write the output anywhere.  For any other value, output to
+the corresponding Eshell target (see `eshell-get-target').
+
 Comments begin with `#'."
   (let ((eshell-non-interactive-p t)
         (stdout (if (eq destination t) (current-buffer) destination)))