byebug 1.1.0 → 1.1.1

data/lib/byebug/commands/stepping.rb

@@ -34,11 +34,11 @@ module Byebug
     end
 
     class << self
-      def help_command
-        'next'
+      def names
+        %w(next)
       end
 
-      def help(cmd)
+      def description
         %{
           n[ext][+-]?[ nnn]\tstep over once or nnn times,
           \t\t'+' forces to move to another line.
@@ -62,16 +62,16 @@ module Byebug
     def execute
       steps, force = parse_stepping_args("Step", @match)
       return unless steps
-      @state.context.step steps, force
+      @state.context.step_into steps, force
       @state.proceed
     end
 
     class << self
-      def help_command
-        'step'
+      def names
+        %w(step)
       end
 
-      def help(cmd)
+      def description
         %{
           s[tep][+-]?[ nnn]\tstep (into methods) once or nnn times
           \t\t'+' forces to move to another line.

data/lib/byebug/commands/trace.rb

@@ -1,5 +1,6 @@
 module Byebug
-  class TraceCommand < Command # :nodoc:
+
+  class TraceCommand < Command
     def regexp
       /^\s* tr(?:ace)? (?: \s+ (\S+))      # on | off | var(iable)
                        (?: \s+ (\S+))?     # (all | variable-name)?
@@ -10,13 +11,8 @@ module Byebug
     def execute
       if @match[1] =~ /on|off/
         onoff = 'on' == @match[1]
-        #if @match[2]
-          Byebug.tracing = onoff
-          print "Tracing is #{onoff ? 'on' : 'off'}\n"
-        #else
-        #  Byebug.current_context.tracing = onoff
-        #  print "Tracing #{onoff ? 'on' : 'off'} on current thread.\n"
-        #end
+        Byebug.tracing = onoff
+        print "Tracing is #{onoff ? 'on' : 'off'}\n"
       elsif @match[1] =~ /var(?:iable)?/
         varname=@match[2]
         if debug_eval("defined?(#{varname})")
@@ -39,14 +35,13 @@ module Byebug
     end
 
     class << self
-      def help_command
-        'trace'
+      def names
+        %w(trace)
       end
 
-      def help(cmd)
+      def description
         %{
-          tr[ace] (on|off)\tset trace mode of current thread
-          tr[ace] (on|off) all\tset trace mode of all threads
+          tr[ace] (on|off)\tset trace mode
           tr[ace] var(iable) VARNAME [stop|nostop]\tset trace variable on VARNAME
         }
       end

data/lib/byebug/commands/variables.rb

@@ -41,11 +41,11 @@ module Byebug
     end
 
     class << self
-      def help_command
-        'var'
+      def names
+        %w(var)
       end
 
-      def help(cmd)
+      def description
         %{
           v[ar] cl[ass] \t\t\tshow class variables of self
         }
@@ -74,11 +74,11 @@ module Byebug
     end
 
     class << self
-      def help_command
-        'var'
+      def names
+        %w(var)
       end
 
-      def help(cmd)
+      def description
         %{
           v[ar] co[nst] <object>\t\tshow constants of object
         }
@@ -96,11 +96,11 @@ module Byebug
     end
 
     class << self
-      def help_command
-        'var'
+      def names
+        %w(var)
       end
 
-      def help(cmd)
+      def description
         %{
           v[ar] g[lobal]\t\t\tshow global variables
         }
@@ -119,11 +119,11 @@ module Byebug
     end
 
     class << self
-      def help_command
-        'var'
+      def names
+        %w(var)
       end
 
-      def help(cmd)
+      def description
         %{
           v[ar] i[nstance] <object>\tshow instance variables of object
         }
@@ -146,11 +146,11 @@ module Byebug
     end
 
     class << self
-      def help_command
-        'var'
+      def names
+        %w(var)
       end
 
-      def help(cmd)
+      def description
         %{
           v[ar] l[ocal]\t\t\tshow local variables
         }
@@ -186,11 +186,11 @@ module Byebug
     end
 
     class << self
-      def help_command
-        'var'
+      def names
+        %w(var)
       end
 
-      def help(cmd)
+      def description
         %{
           v[ar] ct\t\t\tshow class heirarchy of object
         }

data/lib/byebug/context.rb

@@ -44,9 +44,9 @@ module Byebug
       handler.at_line(self, file, line)
     end
 
-    def at_return(file, line)
-      handler.at_return(self, file, line)
-    end
+    #def at_return(file, line)
+    #  handler.at_return(self, file, line)
+    #end
 
   end
 end

data/lib/byebug/interface.rb

@@ -28,26 +28,21 @@ module Byebug
     def aprint(msg)
       print afmt(msg)
     end
-
   end
 
   class LocalInterface < Interface
     attr_accessor :command_queue, :history_length, :history_save, :histfile
     attr_accessor :restart_file
 
-    unless defined?(FILE_HISTORY)
-      FILE_HISTORY = ".byebug_hist"
-    end
+    FILE_HISTORY = ".byebug_hist" unless defined?(FILE_HISTORY)
 
     def initialize()
       super
       @command_queue = []
       @have_readline = false
       @history_save = true
-      # take gdb's default
       @history_length = ENV["HISTSIZE"] ? ENV["HISTSIZE"].to_i : 256
-      @histfile = File.join(ENV["HOME"]||ENV["HOMEPATH"]||".",
-                            FILE_HISTORY)
+      @histfile = File.join(ENV["HOME"]||ENV["HOMEPATH"]||".", FILE_HISTORY)
       open(@histfile, 'r') do |file|
         file.each do |line|
           line.chomp!

data/lib/byebug/processor.rb

@@ -52,9 +52,9 @@ module Byebug
       @display = []
 
       @mutex = Mutex.new
-      @last_cmd  = nil
-      @last_file = nil   # Filename the last time we stopped
-      @last_line = nil   # line number the last time we stopped
+      @last_cmd                      = nil
+      @last_file                     = nil   # Filename the last time we stopped
+      @last_line                     = nil   # line number the last time we stopped
       @byebug_breakpoints_were_empty = false # Show breakpoints 1st time
       @byebug_displays_were_empty    = true  # No display 1st time
       @byebug_context_was_dead       = true  # Assume we haven't started.
@@ -92,8 +92,6 @@ module Byebug
       # FIXME: use annotations routines
       if Byebug.annotate.to_i > 2
         file_line = "\032\032source #{file_line}"
-      #elsif ENV['EMACS']
-      #  file_line = "\032\032#{file_line}"
       end
       print file_line
     end
@@ -133,7 +131,6 @@ module Byebug
       aprint 'stopped' if Byebug.annotate.to_i > 2
       file = CommandProcessor.canonic_file(context.frame_file(0))
       line = context.frame_line(0)
-      #print afmt("%s:%d" % [file, line]) if ENV['EMACS']
       print "Catchpoint at %s:%d: `%s' (%s)\n", file, line, excpt, excpt.class
       fs = context.stack_size
       tb = caller(0)[-fs..-1]
@@ -165,17 +162,12 @@ module Byebug
     end
     protect :at_line
 
-    def at_return(context, file, line)
-      #context.stop_frame = -1
-    end
-
     private
-
       ##
       # Prompt shown before reading a command.
       #
       def prompt(context)
-        p = '(byebug:%s) ' % (context.dead?  ? 'post-mortem' : context.thnum)
+        p = "(byebug#{context.dead?  ? ':post-mortem' : ''}) "
         p = afmt("pre-prompt")+p+"\n"+afmt("prompt") if Byebug.annotate.to_i > 2
         return p
       end
@@ -220,11 +212,8 @@ module Byebug
       #
       def process_commands(context, file, line)
         state, commands = always_run(context, file, line, 1)
-        if Command.settings[:byebugtesting]
-          $byebug_state = state
-        else
-          $byebug_state = nil
-        end
+        $byebug_state = Command.settings[:testing] ? state : nil
+
         splitter = lambda do |str|
           str.split(/;/).inject([]) do |m, v|
             if m.empty?
@@ -248,11 +237,9 @@ module Byebug
         end
 
         while !state.proceed?
-          input = if @interface.command_queue.empty?
-                    @interface.read_command(prompt(context))
-                  else
-                    @interface.command_queue.shift
-                  end
+          input = @interface.command_queue.empty? ?
+                  @interface.read_command(prompt(context)) :
+                  @interface.command_queue.shift
           break unless input
           catch(:debug_error) do
             if input == ""

data/lib/byebug/version.rb

@@ -1,3 +1,3 @@
 module Byebug
-  VERSION = '1.1.0'
+  VERSION = '1.1.1'
 end

data/old_doc/byebug.1

@@ -1,10 +1,10 @@
 .\" $Id: byebug.1 516 2007-12-31 05:55:24Z rockyb $
 .TH byebug 1 
 .SH NAME
-byebug \- Fast Ruby byebug
+byebug \- Fast Ruby debugger
 .SH SYNOPSIS
 .B byebug 
-[byebug-options] 
+[byebug-options]
 byebug
 [script-options...]
 .SH "DESCRIPTION"
@@ -154,43 +154,18 @@ automatically when program state is changed. This can be used by
 front-ends such as GNU Emacs to post this updated information without
 having to poll for it.
 .TP
-.B \-\-client
-Connect to a remote byebug. Used with another byebug invocation using \-\-server.
-See also \-\-host and \-\-cport options
-.TP
-.B \-\-cport=PORT
-Port used for control commands.
-.TP
 .B \-d | \-\-debug
 Set $DEBUG true.
 .TP
-.B \-\-emacs
-Activates full GNU Emacs mode. Is the equivalent of setting the
-options \-\-emacs\-basic, \-\-annotate=3, \-\-no-stop, \-\-no\-control
-and \-\-post\-mortem.
-.TP
-.B \-\-emacs-basic
-Activates GNU Emacs mode. Byebug prompts are prefaced with two octal
-032 characters.
-.TP
-.B \-h | \-\-host=HOST
-Host name used for remote debugging.
-.TP
 .B \-I | \-\-include PATH
 Add PATH to $LOAD_PATH
 .TP
 .B \-m | \-\-post-mortem
 Activate post-mortem mode.
 .TP
-.B \-\-no-control
-Do not automatically start control thread.
-.TP
 .B \-\-no\-stop
 Do not stop when script is loaded.
 .TP
-.B \-p | \-\-port=PORT
-Host name used for remote debugging.
-.TP
 .B \-r | \-\-require SCRIPT
 Require the library, before executing your script.
 .TP
@@ -222,20 +197,13 @@ Keep frame bindings.
 .TP
 .B \-\-script=FILE
 Name of the script file to run
-.B \-s | \-\-server
-Listen for remote connections. Another byebug session accesses using the \-\-client option.
-See also the \-\-host, \-\-port and
-\-\-cport options
-.TP
-.B \-w | \-\-wait
-Wait for a client connection, implies -s option.
 .TP
 .B \-\-help
 Show invocation help and exit.
 .PD
 .SH "SEE ALSO"
 .Sp
-https://github.com/cldwalker/byebug
+https://github.com/deivid-rodriguez/byebug
 .SH AUTHOR
 byebug was written by Kent Siblev. This manual page was written by Rocky
 Bernstein <rocky@gnu.org>

data/old_doc/byebug.texi

@@ -195,13 +195,11 @@ definition but in Ruby line 4 is executed, the name @code{triangle} (probably)
 does not exist so issuing a method call of @code{triangle} will raise a
 ``method not found'' error.
 
-@code{byebug}'s prompt is @code{(byebug:@emph{n})}. The @emph{n} is the thread
-number. Here it is 1 which is usually the case for the main thread. If the
-program has died and you are in post-mortem debugging, there is no thread
-number. In this situation, the string @code{post-mortem} is used in place of a
-thread number. If the program has terminated normally, the string this position
-will be @code{ctrl}. The commands which are available change depending on the
-program state.
+@code{byebug}'s prompt is @code{(byebug)}. If the program has died and you are
+in post-mortem debugging @code{byebug:post-mortem} is used instead. If the
+program has terminated normally, the string this position will be
+@code{byebug:ctrl}. The commands which are available change depending on the
+program's state.
 
 The first command, @code{list} (@pxref{List}), prints 10 lines centered around
 the current line; the current line here is line 4 and is marked by @code{=>}, so
@@ -844,8 +842,6 @@ candidate += 1
 The loop between lines 23--26 gets interleaved between those of
 @code{Sieve::next_prime}, lines 6--19 above.
 
-A similar kind of thing can occur when debugging programs with many threads.
-
 @node No Parameter Values in a Call Stack
 @subsection No Parameter Values in a Call Stack
 In traditional debuggers, in a call stack you can generally see the names of the
@@ -896,7 +892,6 @@ To be continued...
 @item line tracing and non-interactive tracing.
 @item mixing in Byebug.debug with byebug
 @item post-mortem debugging and setting up for that
-@item threading?
 @item references to videos
 @end itemize
 @end ifset
@@ -936,34 +931,25 @@ byebug @value{BYEBUG_VERSION}
 Usage: byebug [options] <script.rb> -- <script.rb parameters>
 
 Options:
-    -A, --annotate LEVEL             Set annotation level
-    -c, --client                     Connect to remote byebug
-        --cport PORT                 Port used for control commands
-    -d, --debug                      Set $DEBUG=true
-        --emacs                      Activates full Emacs support
-        --emacs-basic                Activates basic Emacs mode
-    -h, --host HOST                  Host name used for remote debugging
-    -I, --include PATH               Add PATH to $LOAD_PATH
-        --keep-frame-binding         Keep frame bindings
-    -m, --post-mortem                Activate post-mortem mode
-        --no-control                 Do not automatically start control thread
-        --no-quit                    Do not quit when script finishes
-        --no-rewrite-program         Do not set $0 to the program being debugged
-        --no-stop                    Do not stop when script is loaded
-    -nx                              Not run byebug initialization files (e.g. .byebugrc
-    -p, --port PORT                  Port used for remote debugging
-    -r, --require SCRIPT             Require the library, before executing your script
-        --restart-script FILE        Name of the script file to run. Erased after read
-        --script FILE                Name of the script file to run
-    -s, --server                     Listen for remote connections
-    -w, --wait                       Wait for a client connection, implies -s option
-    -x, --trace                      Turn on line tracing
+    -A, --annotate LEVEL       Set annotation level
+    -d, --debug                Set $DEBUG=true
+    -I, --include PATH         Add PATH to $LOAD_PATH
+        --keep-frame-binding   Keep frame bindings
+    -m, --post-mortem          Activate post-mortem mode
+        --no-quit              Do not quit when script finishes
+        --no-rewrite-program   Do not set $0 to the program being debugged
+        --no-stop              Do not stop when script is loaded
+    -nx                        Don't run any initialization files like .byebugrc
+    -r, --require SCRIPT       Require the library, before executing your script
+        --restart-script FILE  Name of the script file to run. Erased after read
+        --script FILE          Name of the script file to run
+    -x, --trace                Turn on line tracing
 
 Common options:
-        --verbose                    Turn on verbose mode
-        --help                       Show this message
-        --version                    Print the version
-    -v                               Print version number, then turn on verbose mode
+        --verbose              Turn on verbose mode
+        --help                 Show this message
+        --version              Print the version
+    -v                         Print version number, then turn on verbose mode
 @end smallexample
 
 Options for the @code{byebug} are shown in the following list.
@@ -1004,23 +990,10 @@ Set gdb-style annotation @var{level}, a number. Additional information is output
 automatically when program state is changed. This can be used by front-ends such
 as GNU Emacs to post this updated information without having to poll for it.
 
-@item -c | --client
-@cindex @option{-c}
-@cindex @option{--client}
-Connect to remote byebug. The remote byebug should have been set up previously
-or you will get a connection error and @code{byebug} will terminate.
-
-@item --cport @var{port}
-@cindex @option{--cport} @var{port}
-Port used for control commands.
-
 @item --debug
 @cindex @option{--debug}
 Set @code{$DEBUG} to @code{true}. This option is compatible with Ruby's.
 
-@item -h | --host @var{host-address}
-Connect host address for remote debugging.
-
 @item -I --include @var{PATH}
 @cindex @option{-I} @var{PATH}
 @cindex @option{--include} @var{PATH}
@@ -1060,10 +1033,6 @@ If your program raises an exception that isn't caught you can enter byebug for
 inspection of what went wrong. You may also want to use this option in
 conjunction with @option{--no-stop}. See also @ref{Post-Mortem Debugging}.
 
-@item --no-control
-@cindex @option{--no-control}
-Do not automatically start control thread.
-
 @item --no-quit
 @cindex @option{--no-quit}
 Restart byebug when your program terminates normally.
@@ -1080,11 +1049,6 @@ Normally the @code{byebug} stops before executing the first statement. If
 instead you want it to start running initially and will perhaps break it later
 in the running, use this options.
 
-@item -p | --port @var{port}
-@cindex @option{-p} @var{port}
-@cindex @option{--port} @var{port}
-Port used for remote debugging.
-
 @item -r | --require @var{library}
 @cindex @option{-r}
 @cindex @option{--require}
@@ -1098,18 +1062,6 @@ Require the library, before executing your script. However if the library
 happend to be @code{debug}, we'll just ignore the require (since we're already a
 debugger). This option is compatible with Ruby's.
 
-@item -s | --server
-@cindex @option{-s}
-@cindex @option{--server}
-Debug the program but listen for remote connections on the default port or port
-set up via the @option{--port} option. See also @option{--wait}.
-
-@item -w | --wait
-@cindex @option{-w}
-@cindex @option{--wait}
-Debug the program but stop waiting for a client connection first. This option
-automatically sets @option{--server} option.
-
 @item -x | --trace
 @cindex @option{-x}
 @cindex @option{--trace}
@@ -1365,10 +1317,9 @@ parameters.
 @node Command Output
 @section Command Output
 In the command-line interface, when @code{byebug} is waiting for input it
-presents a prompt of the form @code{(byebug:}@emph{x}@code{)}. If debugging
-locally, @emph{x} will be the thread number. Usual the main thread is 1, so
-often you'll see @code{(byebug:1)}. In the control interface though @emph{x}
-will be @code{ctrl} and in post-mortem debugging @code{post-mortem}.
+presents a prompt of the form @code{(byebug)}. If the program has terminated
+normally the prompt will be @code{(byebug:ctrl)} and in post-mortem debugging it
+will be @code{(byebug:post-mortem)}.
 
 In the local interface, whenever @code{byebug} gives an error message such as
 for an invalid command, or an invalid location position, it will generally
@@ -1400,7 +1351,7 @@ byebug help v@value{BYEBUG_VERSION}
 Type 'help <command-name>' for help on a specific command
 
 Available commands:
-backtrace  delete   enable  help  list    ps       save    thread     where
+backtrace  delete   enable  help  list    ps       save    where
 break      disable  eval    info  method  putl     set     trace
 catch      display  exit    irb   next    quit     show    undisplay
 condition  down     finish  jump  p       reload   source  up
@@ -1461,8 +1412,6 @@ info line -- Line number and file name of current position in source file
 info locals -- Local variables of the current stack frame
 info program -- Execution status of the program
 info stack -- Backtrace of the stack
-info thread -- List info about thread NUM
-info threads -- information of currently-known threads
 info variables -- Local and instance variables of the current stack frame
 @end example
 
@@ -1501,8 +1450,7 @@ With an integer argument, list info on that breakpoint.
 @itemx q
 
 To exit @code{byebug}, use the @code{quit} command (abbreviated @code{q}), or
-alias @code{exit}. A simple @code{quit} tries to terminate all threads in
-effect.
+alias @code{exit}.
 
 Normally if you are in an interactive session, this command will prompt to ask
 if you really want to quit. If you don't want any questions asked, enter
@@ -1529,17 +1477,6 @@ Also, since this relies on the the OS @code{exec} call, this command is
 available only if your OS supports @code{exec}; OSX for example does not (yet).
 @end table
 
-@node Interrupt
-@subsection Interrupt (@samp{interrupt})
-
-@table @code
-@kindex interrupt
-@kindex i
-@item interrupt
-@itemx i
-Interrupt the program. Useful if there are multiple threads running.
-@end table
-
 @node Source
 @subsection Running Byebug Commands (@samp{source})
 
@@ -2066,9 +2003,9 @@ a resynchronization if there is a front end also watching over things.
 @end table
 
 @table @code
-@kindex frame @r{[}@ovar{n} @r{[}thread @var{thread-num}@r{]}@r{]}
+@kindex frame @r{[} @ovar{n}@r{]}
 @cindex current stack frame
-@item frame @ovar{n} @r{[}thread @var{thread-num}@r{]}
+@item frame@r{[} @ovar{n}@r{]}
 The @code{frame} command allows you to move from one stack frame to another, and
 to print the stack frame you select.  @var{n} is the the stack frame number or 0
 if no frame number is given; @code{frame 0} then will always show the current
@@ -2081,9 +2018,6 @@ stack frame.
 Without an argument, @code{frame} prints the current stack frame. Since the
 current position is redisplayed, it may trigger a resynchronization if there is
 a front end also watching over things.
-
-If a thread number is given then we set the context for evaluating expressions
-to that frame of that thread.
 @end table
 
 @node Stopping
@@ -2797,64 +2731,6 @@ and @code{to_s} method is called.
 @item info stack
 Backtrace of the stack. An alias for @code{where}. @xref{Backtrace}.
 
-@kindex info thread
-@item info thread @ovar{thread-number} @r{[} terse | verbose@r{]}
-If no thread number is given, we list info for all threads. @code{terse} and
-@code{verbose} options are possible. If terse, just give summary thread name
-information. See information under @code{info threads} for more detail about
-this summary information.
-If @code{verbose} is appended to the end of the command, then the entire stack
-trace is given for each thread.
-
-@kindex info threads @r{[} terse | verbose@r{]}
-@item info threads
-List information about currently-known threads. This information includes
-whether the thread is current (+), if it is suspended ($), or ignored (!); the
-thread number and the top stack item. If @code{verbose} is given then the entire
-stack frame is shown. Here it is an example:
-
-@smallexample
-(byebug:7) info threads
-  1 #<Thread:0xb7d08704 sleep>  ./test/thread1.rb:27
- !2 #<Byebug::DebugThread:0xb7782e4c sleep>  
-  3 #<Thread:0xb777e220 sleep>  ./test/thread1.rb:11
-  4 #<Thread:0xb777e144 sleep>  ./test/thread1.rb:11
-  5 #<Thread:0xb777e07c sleep>  ./test/thread1.rb:11
-  6 #<Thread:0xb777dfb4 sleep>  ./test/thread1.rb:11
-+ 7 #<Thread:0xb777deec run>  ./test/thread1.rb:14
-(byebug:1)
-@end smallexample
-
-Thread 7 is the current thread since it has a plus sign in front. Thread 2 is
-ignored since it has a @code{!}. A ``verbose'' listing of the above:
-
-@smallexample
-(byebug:7) info threads verbose
-  1 #<Thread:0xb7d08704 sleep>  
-  #0 Integer.join at test/thread1.rb:27
-  #1 at test/thread1.rb:27
- !2 #<Byebug::DebugThread:0xb7782e4c sleep>  
-  3 #<Thread:0xb777e220 sleep>  
-  #0 sleep(count#Fixnum) at test/thread1.rb:11
-  #1 Object.fn(count#Fixnum, i#Fixnum) at test/thread1.rb:11
-  #2 at test/thread1.rb:23
-  4 #<Thread:0xb777e144 sleep>  
-  #0 sleep(count#Fixnum) at test/thread1.rb:11
-  #1 Object.fn(count#Fixnum, i#Fixnum) at test/thread1.rb:11
-  #2 at test/thread1.rb:23
-  5 #<Thread:0xb777e07c sleep>  
-  #0 sleep(count#Fixnum) at test/thread1.rb:11
-  #1 Object.fn(count#Fixnum, i#Fixnum) at test/thread1.rb:11
-  #2 at test/thread1.rb:23
-  6 #<Thread:0xb777dfb4 sleep>  
-  #0 sleep(count#Fixnum) at test/thread1.rb:11
-  #1 Object.fn(count#Fixnum, i#Fixnum) at test/thread1.rb:11
-  #2 at test/thread1.rb:23
-+ 7 #<Thread:0xb777deec run>  
-  #0 Object.fn(count#Fixnum, i#Fixnum) at test/thread1.rb:14
-  #1 at test/thread1.rb:23
-@end smallexample
-
 @kindex info variables
 @item info variables
 Local and instance variables.
@@ -2965,21 +2841,18 @@ be @code{(byebug:post-mortem)}.
 @node Byebug.run
 @subsection @code{Byebug.start}, @code{Byebug.started?}, @code{Byebug.stop}, @code{Byebug.run_script}
 
-In order to provide better debugging information regarding the stack
-frame(s) across all threads, byebug has to intercept each call,
-save some information and on return remove it. Possibly, in Ruby 1.9
-possibly this will not be needed. Therefore one has to issue call to
-indicate start saving information and another call to stop. Of course,
-If you call byebug from the outset via @code{byebug} this is done
-for you.
+In order to provide better debugging information regarding the stack frame(s),
+byebug has to intercept each call, save some information and on return remove
+it. Therefore one has to issue a call to indicate byebug to start saving
+information and another call to stop. Of course, if you call byebug from the
+outset via @code{byebug} this is done for you.
 
 @table @code
 @item Byebug.start(@ovar{options}) @ovar{block}
 @vindex @code{Byebug.start(options)}
 @vindex @code{Byebug.start(block)}
 Turn on add additional instrumentation code to facilitate debugging. A
-system even table hook is installed and some variables are set up to
-access thread frames.
+system even table hook is installed and some variables are set up.
 
 This needs to be done before entering byebug; therefore a call
 to byebug issue a @code{Byebug.start} call if necessary.
@@ -3105,7 +2978,7 @@ Fixnum: 1 if on or 0 if off.
 Boolean. True if basename on. @xref{Basename}.
 @item :callstyle
 Symbol: @code{:short} or @code{:last}. @xref{Callstyle}.
-@item :byebugtesting
+@item :testing
 Boolean. True if currently testing byebug.
 @item :force_stepping
 Boolean. True if stepping should go to a line different from the last
@@ -3254,33 +3127,32 @@ another one. If it does, it's undefined which one will get matched and run.
 In addition the instance needs these methods:
 @table @code
 @item execute
-Code which gets run when you type a command (string) that matches the commands
+Code which gets run when you type a command (string) that matches the command's
 regular expression.
-@item help
+@item description
 A string which gets displayed when folks ask for help on that command.
-@item help_command
-A name the help system uses to show what commands are available.
+@item names
+Names and aliases of the command as an array of strings.
 @end table
 
 Here's a small example of a new command:
 @smallexample
 module Byebug
   class MyCommand < Command
-  def regexp
-    /^\s*me$/ # Regexp that will match your command
-  end
+    def regexp
+      /^\s*me$/ # Regexp that will match your command
+    end
 
-  def execute
-    puts "hi" # What you want to happen when your command runs
-  end
-  class << self
-    def help_command
-      'me' # String name of command
+    def execute
+      puts "hi" # What you want to happen when your command runs
     end
-    def help(cmd)
-   # Some sort of help text.
-   %@{This does whatever it is I want to do@}
-   end
+    class << self
+      def names
+        %w(me)
+      end
+      def description
+        %@{This does whatever it is I want to do@}
+     end
   end
 end
 @end smallexample
@@ -3302,14 +3174,14 @@ ruby /tmp/testit.rb:
 /tmp/testit.rb:7
 y=2
 (byebug:1) help
-byebug help v0.10.3
+byebug help v1.1.0
 Type 'help <command-name>' for help on a specific command
 Available commands:
 backtrace delete  enable help method putl    set    trace
 break     disable eval   info next   quit    show   undisplay
 catch     display exit   irb  p      reload  source up
 condition down    finish list pp     restart step   var
-continue edit     frame  me   ps     save    thread where
+continue edit     frame  me   ps     save    where
                   ^^ This is you
 
 (byebug:1) help me
@@ -3326,8 +3198,8 @@ hi
 
 @item byebug @ovar{steps=1}
 @vindex @code{Kernel::byebug}
-Enters byebug in the current thread after a stepping @var{steps} line-event
-steps. Before entering byebug startup script is read.
+Enters byebug after @var{steps} line-event steps. Before entering byebug, the
+startup script is read.
 
 Setting @var{steps} to 0 will cause a break in byebug subroutine and not wait
 for any line event to occur. This could be useful you want to stop right after
@@ -3336,16 +3208,14 @@ the last statement in some scope.
 Consider this example:
 @smallexample
 $ cat scope-test.rb
-
-require 'rubygems'
 require 'byebug' ; Byebug.start
 1.times do
-   a = 1
-   byebug   # implied steps=1
- end
+  a = 1
+  byebug   # implied steps=1
+end
 y = 1
 
-$ scope-test.rb:8
+$ ruby scope-test.rb
 y = 1
 (byebug:1) p a
 NameError Exception: undefined local variable or method `a' for main:Object
@@ -3354,13 +3224,11 @@ NameError Exception: undefined local variable or method `a' for main:Object
 
 Byebug will stop at the line event which follows @samp{a=1}. This is outside the
 @code{do} block scope where @var{a} is defined. If instead you want to stop
-before leaving the @code{do} loop it is possibly to stop right inside
-@code{byebug}; call with 0 zero parameter:
+before leaving the @code{do} loop it is possible to stop right inside
+@code{byebug}; call byebug with 0 zero parameter:
 
 @smallexample
 $ cat scope-test.rb
-
-require 'rubygems'
 require 'byebug' ; Byebug.start
 1.times do
    a = 1
@@ -3368,15 +3236,15 @@ require 'byebug' ; Byebug.start
 end
 y = 1
 
-$ scope-test.rb:8
+$ ruby scope-test.rb
 ../lib/byebug.rb:386
-Byebug.current_context.stop_frame = 0
+Byebug.context.stop_frame = 0
 (byebug:1) where
 --> #0 Kernel.byebug(steps#Fixnum) at ../lib/byebug-base.rb:386
-    #1 at scope-test.rb:6
-    #2 at scope-test.rb:4
+    #1 at scope-test.rb:4
+    #2 at scope-test.rb:2
 (byebug:1) up
-#1 at scope-test.rb:6
+#1 at scope-test.rb:4
 (byebug:1) p a
 1
 (byebug:1)
@@ -3417,9 +3285,9 @@ don't worry @code{rake test} will do step 2 for you. You should see a
 line that ends something like:
 
 @smallexample
-Finished tests in 2.839674s, 130.6488 tests/s, 141.9177 assertions/s.
+Finished tests in 2.358177s, 155.2046 tests/s, 172.1669 assertions/s.
 
-371 tests, 403 assertions, 0 failures, 0 errors, 25 skips
+366 tests, 406 assertions, 0 failures, 0 errors, 17 skips
 @end smallexample
 
 The number of seconds, tests, and assertions may be different from the above.