README.md in pry-moves-1.0.1 vs README.md in pry-moves-1.0.2
- old
+ new
@@ -23,14 +23,18 @@
* `g 10` - **goto** line 10
* `bt` - show backtrace, excluding hidden frames
* `bt +` `bt hidden` - show backtrace including hidden frames
* `bt a` `bt all` - full backtrace with system and hidden frames
* `bt 10` - go to backtrace line 10
+ * `bt save` - save backtrace to memory
+ * `bt diff` - diff with saved backtrace
* `bt > foo` - write backtrace to file `log/backtrace_foo.log`
-* `up`/`down`/`top`/`bottom` - move over call stack
+* `up`/`down`/`top`/`bottom` (`bm`) - move over call stack
* `up +` - move up, including vapid frames (block callers, hidden frames)
* `up pattern` - move up till first frame which method name or file position in format `folder/script.rb:12` matches regexp pattern
+* `%` - print current frame of call stack (alias to `whereami`)
+* `$` - fully print current function without line numbers
* `debug some_method(some_param)` - call `some_method(some_param)` and interactively step into it. This way you can virtually "step back" by executing previous pieces of code from current method
* `.method` or `123` or `:hash_key` - Continue traversing of last object in history. E.g. `orders` will list array, then `3` will enter `orders[3]`, then `.price` will enter `orders[3].price`
* `watch variable` - display variable's value on each step
* `@` - restart. Set config `PryMoves.reload_rake_tasks = true` to automatically reload rake tasks
* `#` - exit with code 3, can be wrapped in bash script to fully reload ruby scripts
@@ -56,18 +60,22 @@
_Demo class source [here](https://github.com/garmoshka-mo/pry-moves/issues/1)_
## Backtrace and call stack
-You can explicitly hide frames from backtrace and call stack by defining `hide_from_stack` variable:
+You can explicitly hide frames from call stack by defining variables like this:
```ruby
def insignificant_method
hide_from_stack = true
something_insignificant
yield
end
```
+
+* `hide_from_stack` - hide this function from stack
+* `pry_moves_stack_tip` - stop on first frame above this function
+* `pry_moves_stack_end` - limits stack from bottom, not possible to step below this frame
## Configuration
Here is default configuration, you can reassign it: