Skip to content

Commit 28591fd

Browse files
committed
[Docs] Mention enrich-classpath
1 parent 7cf86a6 commit 28591fd

File tree

2 files changed

+16
-0
lines changed

2 files changed

+16
-0
lines changed

doc/modules/ROOT/pages/basics/middleware_setup.adoc

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,12 @@ Use the convenient plugin for defaults, either in your project's
3535
[mx.cider/enrich-classpath "x.y.z"]]
3636
----
3737

38+
https://github.com/clojure-emacs/enrich-classpath[enrich-classpath] is a library (and Leiningen plugin) that, as its main feature, automatically downloads all available `.jars` with Java sources and javadocs for a given project, so that various tools (e.g. CIDER) can access it. Simply put - it allows you to navigate to Java sources and
39+
javadocs in your Clojure projects.
40+
41+
NOTE: `enrich-classpath` has a bit of a startup cost associated with it, the first time Java sources and javadocs are fetched. It can be turned
42+
off by setting `cider-enrich-classpath` to `nil`.
43+
3844
A minimal `profiles.clj` for CIDER would be:
3945

4046
[source,clojure]

doc/modules/ROOT/pages/troubleshooting.adoc

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -297,3 +297,13 @@ Or by customising the jack-in options.
297297
---
298298

299299
NOTE: Leiningen disables `OmitStackTraceInFastThrow` by default.
300+
301+
=== Errors Related to enrich-classpath
302+
303+
If you get any errors related to `enrich-classpath` when doing `cider-jack-in`, you can disable
304+
the `enrich-classpath` integration like this:
305+
306+
[source,lisp]
307+
----
308+
(setq cider-enrich-classpath nil)
309+
----

0 commit comments

Comments
 (0)