summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorStefan Holdermans <stefan@holdermans.nl>2020-04-21 12:25:51 +0200
committerMarge Bot <ben+marge-bot@smart-cactus.org>2020-05-21 12:16:08 -0400
commitcf5663300c3d8b8b3c7dc2cd0dce2c923ec68987 (patch)
tree18a58ed887dbff264080a8820f34d9c7cb928ff5
parenta0b79e1b16887371d5cd14d53a607772ca730fb5 (diff)
downloadhaskell-cf5663300c3d8b8b3c7dc2cd0dce2c923ec68987.tar.gz
Update documentation for GHCi :script
This patch adds the fixes that allow for file names containing spaces to be passed to GHCi's ':script' command to the release notes for 8.12 and expands the user-guide documentation for ':script' by mentioning how such file names can be passed. Related to #18027.
-rw-r--r--docs/users_guide/8.12.1-notes.rst3
-rw-r--r--docs/users_guide/ghci.rst8
2 files changed, 8 insertions, 3 deletions
diff --git a/docs/users_guide/8.12.1-notes.rst b/docs/users_guide/8.12.1-notes.rst
index 9fabc47310..eb72ca9bde 100644
--- a/docs/users_guide/8.12.1-notes.rst
+++ b/docs/users_guide/8.12.1-notes.rst
@@ -100,6 +100,9 @@ Compiler
GHCi
~~~~
+- The ``:script`` command now allows for file names that contain spaces to
+ passed as arguments: either by enclosing the file names in double quotes or by
+ escaping spaces in file names with a backslash. (#18027)
Runtime system
~~~~~~~~~~~~~~
diff --git a/docs/users_guide/ghci.rst b/docs/users_guide/ghci.rst
index 59d5a65423..ce0734cfc2 100644
--- a/docs/users_guide/ghci.rst
+++ b/docs/users_guide/ghci.rst
@@ -2695,9 +2695,11 @@ commonly used commands.
.. ghci-cmd:: :script; [⟨n⟩] ⟨filename⟩
- Executes the lines of a file as a series of GHCi commands. This
- command is compatible with multiline statements as set by
- :ghci-cmd:`:set +m`
+ Executes the lines of a file as a series of GHCi commands. The syntax for
+ file-name arguments respects shell quoting rules, i.e., file names
+ containing spaces can be enclosed in double quotes or with spaces escaped
+ with a backslash. This command is compatible with multiline statements as
+ set by :ghci-cmd:`:set +m`
.. ghci-cmd:: :set; [⟨option⟩ ...]