Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

XDG Base Directory Specification compliance #4844

Closed
wants to merge 3 commits into from
Closed
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Update documentation accordingly
Specify the backwards-compatible behaviour on config file searching.
juanmeleiro committed Apr 12, 2020
commit e2da5abb4d02acf249752d1cf3ee65187e254073
13 changes: 7 additions & 6 deletions docs/reference/repl.rst
Original file line number Diff line number Diff line change
@@ -40,12 +40,13 @@ Idris supports initialisation scripts.
Initialisation scripts
~~~~~~~~~~~~~~~~~~~~~~

When the Idris REPL starts up, it will attempt to open the file
repl/init in Idris's application data directory. The application data
directory is the result of the Haskell function call
``getAppUserDataDirectory "idris"``, which on most Unix-like systems
will return $HOME/.idris and on various versions of Windows will return
paths such as ``C:/Documents And Settings/user/Application Data/appName``.
When the Idris REPL starts up, it will attempt to open the file repl/init in
Idris's application data directory. The application data directory is the result
of the Haskell function call ``getAppUserDataDirectory "idris"``, if that
exists, or ``getXdgDirectory XdgConfig "idris"`` otherwise. On most Unix-like
systems that will return, respectively, $HOME/.idris or $HOME/.config/idris, and
on various versions of Windows will return paths such as ``C:/Documents And
Settings/user/Application Data/appName``.

The file repl/init is a newline-separate list of REPL commands. Not all
commands are supported in initialisation scripts — only the subset that