summaryrefslogtreecommitdiff
path: root/doc/parens.texi
diff options
context:
space:
mode:
authorAndrew Whatson <whatson@gmail.com>2020-07-07 11:04:33 +1000
committerAndrew Whatson <whatson@gmail.com>2020-07-07 13:25:08 +1000
commit161f4cce06ca2c575672d12a6e9f5ced6d94401c (patch)
tree667266dba0815f37ed7fb1bc9daa5e52e3acc7da /doc/parens.texi
parentfc81121015f43709abf9dc4d623e26fdb45cae3a (diff)
downloadgeiser-161f4cce06ca2c575672d12a6e9f5ced6d94401c.tar.gz
geiser-161f4cce06ca2c575672d12a6e9f5ced6d94401c.tar.bz2
Add docs for per-project repl instances
Diffstat (limited to 'doc/parens.texi')
-rw-r--r--doc/parens.texi22
1 files changed, 22 insertions, 0 deletions
diff --git a/doc/parens.texi b/doc/parens.texi
index 118c020..1207761 100644
--- a/doc/parens.texi
+++ b/doc/parens.texi
@@ -204,6 +204,28 @@ A final tip: if you want Geiser to start automatically a REPL for you if
it notices that there's no one active when it enters @i{geiser-mode},
you can customize @code{geiser-mode-start-repl-p} to @code{t}.
+@subsubheading Managing multiple scheme projects
+@cindex dir-locals
+@cindex project.el
+@cindex projectile
+@anchor{repl-per-project} By default, Geiser will re-use a single REPL
+for all buffers sharing the same scheme implementation. This works well
+enough in many cases, but may become problematic (or at least annoying)
+when working on multiple projects with separate dependencies and include
+paths.
+
+Geiser provides optional support for using separate REPLs for each
+project, which can be enabled by customizing
+@code{geiser-repl-current-project-function} and selecting your Emacs
+project-management library of choice (eg. @code{project.el} or
+@code{projectile}). With this configured, new REPLs will automatically
+associate themselves with the current project, and all Geiser commands
+will ignore REPLs that are not associated with the project.
+
+This can be very convenient when used with a @file{.dir-locals.el} in
+the project root to set include paths, ensuring that Geiser REPLs will
+always know where to find your project's modules or dependencies.
+
@subsubheading Switching between source files and the REPL
@cindex switching to REPL
@cindex switching to source