diff options
| author | Fraser Tweedale <frase@frase.id.au> | 2019-04-12 12:25:00 +1000 |
|---|---|---|
| committer | Marge Bot <ben+marge-bot@smart-cactus.org> | 2019-04-15 06:26:38 -0400 |
| commit | 5c06b60d0e2e270c9ccacebb96ca0da4d0f4e6d9 (patch) | |
| tree | 870f733508aa4a19d6f2cfec182d968e59865674 | |
| parent | 71cf94db8445e5d8225ce65a9feecbfaa3ac3fe3 (diff) | |
| download | haskell-5c06b60d0e2e270c9ccacebb96ca0da4d0f4e6d9.tar.gz | |
users-guide: update startup script order
Update users guide to match the new startup script order. Also
clarify that -ignore-dot-ghci does not apply to scripts specified
via the -ghci-script option.
Part of: https://gitlab.haskell.org/ghc/ghc/issues/14689
| -rw-r--r-- | docs/users_guide/ghci.rst | 16 |
1 files changed, 8 insertions, 8 deletions
diff --git a/docs/users_guide/ghci.rst b/docs/users_guide/ghci.rst index a9c280a8ec..28d3a4f5ee 100644 --- a/docs/users_guide/ghci.rst +++ b/docs/users_guide/ghci.rst @@ -3101,15 +3101,14 @@ When it starts, unless the :ghc-flag:`-ignore-dot-ghci` flag is given, GHCi reads and executes commands from the following files, in this order, if they exist: -1. :file:`./.ghci` +1. :file:`{ghcappdata}/ghci.conf`, where ⟨ghcappdata⟩ depends on + your system, but is usually something like :file:`$HOME/.ghc` on + Unix or :file:`C:/Documents and Settings/user/Application + Data/ghc` on Windows. -2. :file:`{appdata}/ghc/ghci.conf`, where ⟨appdata⟩ depends on your system, - but is usually something like - :file:`C:/Documents and Settings/user/Application Data` +2. :file:`$HOME/.ghci` -3. On Unix: :file:`$HOME/.ghc/ghci.conf` - -4. :file:`$HOME/.ghci` +3. :file:`./.ghci` The :file:`ghci.conf` file is most useful for turning on favourite options (e.g. ``:set +s``), and defining useful macros. @@ -3166,8 +3165,9 @@ read: :type: dynamic :category: - Read a specific file after the usual startup files. Maybe be + Read a specific file after the usual startup files. May be specified repeatedly for multiple inputs. + :ghc-flag:`-ignore-dot-ghci` does not apply to these files. When defining GHCi macros, there is some important behavior you should be aware of when names may conflict with built-in commands, especially |