Skip to content

Commit 98013c8

Browse files
committed
Indicate in the docs which options can impact performance
1 parent 17ae83e commit 98013c8

File tree

3 files changed

+11
-6
lines changed

3 files changed

+11
-6
lines changed

doc/repl/basic_usage.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -50,9 +50,10 @@ Please, avoid killing REPL buffers with <kbd>C-c C-k</kbd>
5050
## Known Limitations
5151

5252
Performance can degrade when the REPL buffer grows very large. This is
53-
especially true if `cider-repl-use-clojure-font-lock` is enabled. You can use
54-
`cider-repl-clear-output` to either clear the result of the previous evaluation,
55-
or with a prefix argument clear the entire REPL buffer.
53+
especially true if either `cider-repl-use-clojure-font-lock` or
54+
`nrepl-log-messages` are enabled. You can use `cider-repl-clear-output` to
55+
either clear the result of the previous evaluation, or with a prefix argument
56+
clear the entire REPL buffer.
5657

5758
Very long lines are guaranteed to bring Emacs to a crawl, so using a value of
5859
`cider-print-fn` that wraps lines beyond a certain width (i.e. any of the

doc/repl/configuration.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -141,6 +141,8 @@ use:
141141
(setq cider-repl-use-clojure-font-lock nil)
142142
```
143143

144+
Note that enabling font-locking in the REPL can negatively impact performance.
145+
144146
## Pretty printing in the REPL
145147

146148
By default the REPL always prints the results of your evaluations using the

doc/troubleshooting.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -68,9 +68,11 @@ you can step forward until you find the problem.
6868

6969
### Missing `*nrepl-messages*` buffer
7070

71-
nREPL message logging is not enabled by default. Set `nrepl-log-messages` to
72-
`t` to activate it. Alternatively you can use <kbd>M-x</kbd> `nrepl-toggle-message-logging`
73-
to enable/disable logging temporary within your current Emacs session.
71+
nREPL message logging is not enabled by default. Set `nrepl-log-messages` to `t`
72+
to activate it. Alternatively you can use <kbd>M-x</kbd>
73+
`nrepl-toggle-message-logging` to enable/disable logging temporary within your
74+
current Emacs session. Note that enabling message logging can impact
75+
performance.
7476

7577
### `cider-debug` complains that it “failed to instrument ...”
7678

0 commit comments

Comments
 (0)