summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBozhidar Batsov <bozhidar@batsov.com>2016-04-12 18:10:53 -0700
committerBozhidar Batsov <bozhidar@batsov.com>2016-04-12 18:11:08 -0700
commit7a1c6862a6b58e8166ad75ff04d203fadf1ac21e (patch)
tree8deff5e0633af3e3390f37bbdfde310c3cf3cc03
parentf3e837695a3dc319740d800c4c1e71272d14cee6 (diff)
Document a bunch of features
-rw-r--r--doc/images/classpath_browser.pngbin0 -> 564764 bytes
-rw-r--r--doc/images/ns_browser.pngbin0 -> 292793 bytes
-rw-r--r--doc/images/tracing.pngbin0 -> 487588 bytes
-rw-r--r--doc/index.md6
-rw-r--r--doc/miscellaneous_features.md42
5 files changed, 45 insertions, 3 deletions
diff --git a/doc/images/classpath_browser.png b/doc/images/classpath_browser.png
new file mode 100644
index 00000000..d5be671e
--- /dev/null
+++ b/doc/images/classpath_browser.png
Binary files differ
diff --git a/doc/images/ns_browser.png b/doc/images/ns_browser.png
new file mode 100644
index 00000000..bd8d7438
--- /dev/null
+++ b/doc/images/ns_browser.png
Binary files differ
diff --git a/doc/images/tracing.png b/doc/images/tracing.png
new file mode 100644
index 00000000..be02780b
--- /dev/null
+++ b/doc/images/tracing.png
Binary files differ
diff --git a/doc/index.md b/doc/index.md
index 9c785344..a49fc5aa 100644
--- a/doc/index.md
+++ b/doc/index.md
@@ -64,15 +64,15 @@ CIDER packs plenty of features. Here are some of them (in no particular order):
* Apropos
* [Debugger](debugging.md)
* [Value inspector](miscellaneous_features.md#value-inspection)
-* Function tracing
+* [Function tracing](miscellaneous_features.md#tracing-function-execution)
* [Interactive macroexpansion](miscellaneous_features.md#macroexpansion)
* Enhanced Clojure font-locking and indentation
* [Grimoire](http://conj.io/) integration
* [`clojure.test` integration](running_tests.md)
* [Smart code reloading](miscellaneous_features.md#code-reloading)
* [Pretty-printing of results](configuration.md#pretty-printing)
-* Classpath browser
-* Namespace browser
+* [Classpath browser](miscellaneous_features.md#classpath-browser)
+* [Namespace browser](miscellaneous_features.md#namespace-browser)
* nREPL session management
* [Scratchpad](miscellaneous_features.md#using-a-scratchpad)
* [Minibuffer code evaluation](miscellaneous_features.md#evaluating-clojure-code-in-the-minibuffer)
diff --git a/doc/miscellaneous_features.md b/doc/miscellaneous_features.md
index 7f404167..240e0a44 100644
--- a/doc/miscellaneous_features.md
+++ b/doc/miscellaneous_features.md
@@ -141,6 +141,48 @@ and
(setq cider-refresh-show-log-buffer t)
```
+### Tracing function execution
+
+You can trace the results produced by functions using <kbd>C-c M-t v</kbd>. The
+command will prompt you for the name of the function you want to trace.
+Evaluating the command again for the same function will result in the function
+being untraced.
+
+![Tracing](images/tracing.png)
+
+You can also use <kbd>C-c M-t n</kbd> to toggle tracing on and off for an entire
+namespace.
+
+### Classpath browser
+
+You can easily browse the items on your classpath with the command `cider-classpath`.
+
+Here you can see it in action:
+
+![Classpath Browser](images/classpath_browser.png)
+
+Press <kbd>RET</kbd> on a classpath entry to navigate into it.
+
+### Namespace browser
+
+You can browse the contents of any loaded namespace with the command `cider-browse-ns`.
+The command will prompt you for the namespace to browse.
+
+![Namespace Browser](images/ns_browser.png)
+
+You can also browse all available namespaces with `cider-browse-ns-all`.
+
+There are a bunch of useful keybindings that are defined in browser buffers.
+
+Keyboard shortcut | Description
+--------------------------------|-------------------------------
+<kbd>d</kbd> | Display documentation for item at point.
+<kbd>RET</kbd> | Browse ns or display documentation for item at point.
+<kbd>s</kbd> | Go to definition for item at point.
+<kbd>^</kbd> | Browse all namespaces.
+<kbd>n</kbd> | Go to next line.
+<kbd>p</kbd> | Go to previos line.
+
### Managing multiple connections
You can connect to multiple nREPL servers using <kbd>M-x cider-jack-in</kbd> (or