From: Jim Porter <jporterbugs@gmail.com>
Date: Fri, 14 Jun 2024 04:44:40 +0000 (-0700)
Subject: ; * lisp/eshell/em-script.el (eshell-execute-file): Improve docstring.
X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=d2a31670501188280b41d58aff7c3bbf12ee5297;p=emacs.git

; * lisp/eshell/em-script.el (eshell-execute-file): Improve docstring.

(cherry picked from commit 19b407ac749fcb8d978e8263ed98328100128de5)
---

diff --git a/lisp/eshell/em-script.el b/lisp/eshell/em-script.el
index 6cddffdcf5f..ba020d2eb5b 100644
--- a/lisp/eshell/em-script.el
+++ b/lisp/eshell/em-script.el
@@ -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)))