Skip to content
Browse files

Add some debugging docs

Also ensure JLINE_LOGGING gets looked at for `lein trampoline run`
launches.
  • Loading branch information...
1 parent 08e226f commit e330a75d659bc87cda98149a8f5f54dac7d840ed @trptcolin committed Sep 19, 2012
Showing with 32 additions and 7 deletions.
  1. +28 −5 README.md
  2. +1 −1 project.clj
  3. +3 −1 src/java/reply/hacks/CustomizableBufferLineNumberingPushbackReader.java
View
33 README.md
@@ -33,13 +33,16 @@ And here's how to get a standalone version up and running (assuming you have
## Usage
-Run `bin/reply.sh` on Mac/Linux, or `bin\reply.bat` on Windows.
+The easiest way: use `lein repl` (for 2.x). Skip the rest if that's all you
+need.
-And if you want to really live the high life, add the bin directory to
-your $PATH.
+Running `lein trampoline run` at the command line, in this project, will get
+you the latest stuff on master.
-If you want additional stuff on the classpath, you can set `$USER_CP`. For
-instance:
+There are also example bin scripts that are currently just set up to work with
+Leiningen 1.x (2.x already contains REPLy, just not necessarily always the
+latest from master here). If you want additional stuff on the classpath, you
+can set `$USER_CP`. For instance:
USER_CP=`lein classpath` reply
@@ -62,6 +65,26 @@ For details on the latest and greatest:
$ reply --help
+## Debugging
+
+If you're having problems, feel free to [open an
+issue](https://github.com/trptcolin/reply/issues), but the following may help.
+
+For keybinding issues, check out `~/.inputrc` - you can mostly use the same
+specifications there as you can with normal readline applications like bash,
+but from time to time we do come across missing features that we then add to
+[jline](https://github.com/jline/jline2).
+
+To get a very detailed look at what jline is doing under the hood, you can
+`export JLINE_LOGGING=trace` (or `debug`) before starting REPLy. There may be
+more output than you'd like, but this kind of output is especially helpful when
+debugging keybinding issues.
+
+You can use the `--standalone` flag to rule out any nREPL-related questions,
+but I'm not aware of anyone using `--standalone` for other purposes. Please let
+me know if you are!
+
+
## Thanks
Thanks to the developers of [Clojure](https://github.com/clojure/clojure),
View
2 project.clj
@@ -23,4 +23,4 @@
:source-paths ["src/clj"]
:java-source-paths ["src/java"]
:test-paths ["spec"]
- :main ^{:skip-aot true} reply.main))
+ :main ^{:skip-aot true} reply.ReplyMain))
View
4 src/java/reply/hacks/CustomizableBufferLineNumberingPushbackReader.java
@@ -26,7 +26,9 @@ public CustomizableBufferLineNumberingPushbackReader(Reader r){
}
- // this constructor is the only change from clojure.lang
+ // This constructor is the only change from clojure.lang. Once the patch is
+ // released in clojure 1.5 and leiningen starts using it, we can use
+ // clojure's LineNumberingPushbackReader for this.
public CustomizableBufferLineNumberingPushbackReader(Reader r, int sz){
super(new LineNumberReader(r, sz));
}

0 comments on commit e330a75

Please sign in to comment.
Something went wrong with that request. Please try again.