misc/README.md.erb in debug-1.0.0.beta3 vs misc/README.md.erb in debug-1.0.0.beta4
- old
+ new
@@ -60,17 +60,18 @@
# (3) Write `require 'debug...' in .rb files
$ cat target.rb
require 'debug/run' # start the debug console
-...
+... rest of program ...
# or
$ cat target.rb
require 'debug/session' # introduce the functionality
DEBUGGER__.console # and start the debug console
+... rest of program ...
$ ruby target.rb
```
When you run the program with the debug console, you will see the debug console prompt `(rdbg)`.
@@ -293,14 +294,14 @@
* `RUBY_DEBUG_NONSTOP`: 1 for nonstop at the beginning of program.
* `RUBY_DEBUG_INIT_SCRIPT`: Initial script path loaded at the first stop.
* `RUBY_DEBUG_COMMANDS`: Debug commands invoked at the first stop. Commands should be separated by ';;'.
* `RUBY_DEBUG_SHOW_SRC_LINES`: Show n lines source code on breakpoint (default: 10 lines).
* `RUBY_DEBUG_SHOW_FRAMES`: Show n frames on breakpoint (default: 2 frames).
-
* Remote debugging
* `RUBY_DEBUG_PORT`: TCP/IP remote debugging: port to open.
* `RUBY_DEBUG_HOST`: TCP/IP remote debugging: host (localhost if not given) to open.
+ * `RUBY_DEBUG_SOCK_PATH`: UNIX Domain Socket remote debugging: socket path to open.
* `RUBY_DEBUG_SOCK_DIR`: UNIX Domain Socket remote debugging: socket directory to open.
## Debug command on the debug console
* `Enter` repeats the last command (useful when repeating `step`s).
@@ -320,5 +321,7 @@
```
# Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/ruby/debug.
+
+Please also check the [contributing guideline](/CONTRIBUTING.md).