diff --git a/docs/commands/set.rst b/docs/commands/set.rst index 151c4ff2..b844d0ac 100644 --- a/docs/commands/set.rst +++ b/docs/commands/set.rst @@ -1,5 +1,17 @@ .. _set: +**set* [ *set-subcommand* ] + +Modifies parts of the debugger environment. + +You can give unique prefix of the name of a subcommand to get information +about just that subcommand. + +Type `set` for a list of set subcommands and what they do. Type help set * +for just the list of set subcommands. + +All of the "set" commands have a corresponding :ref:`show ` command. + Set === diff --git a/docs/commands/show.rst b/docs/commands/show.rst index 195244d7..888835b5 100644 --- a/docs/commands/show.rst +++ b/docs/commands/show.rst @@ -1,5 +1,15 @@ .. _show: +**show** [ *subcommand* ] + +A command for showing things about the debugger. You can give unique +prefix of the name of a subcommand to get information about just that +subcommand. + +Type `show` for a list of show subcommands and what they do. Type help +`show *` for just a list of show subcommands. Many of the "show" +commands have a corresponding :ref:`set ` command. + Show ==== diff --git a/docs/entry-exit.rst b/docs/entry-exit.rst index 90608efc..ee99e12f 100644 --- a/docs/entry-exit.rst +++ b/docs/entry-exit.rst @@ -14,7 +14,7 @@ Invoking the Debugger Initially =============================== The simplest way to debug your program is to call run `trepan2` (or -`trepan3k` for Python). Give the name of your program and its options +`trepan3k` for Python 3). Give the name of your program and its options and any debugger options: .. code:: console @@ -33,7 +33,7 @@ For help on trepan2's options add the ``--help`` option. ... To separate options to the program you want to debug from trepan2's -options put == after the debugger's options: +options put `--` after the debugger's options: .. code:: console @@ -49,7 +49,7 @@ Calling the debugger from IPython Installing the IPython extension -------------------------------- -Use the `trepan IPython extension `_. +Use the `trepan IPython extension `_. To install execute the the following code snippet in an IPython shell or IPython notebook cell: diff --git a/trepan/processor/command/quit.py b/trepan/processor/command/quit.py index af249df7..e49a0fb5 100644 --- a/trepan/processor/command/quit.py +++ b/trepan/processor/command/quit.py @@ -48,7 +48,7 @@ class QuitCommand(Mbase_cmd.DebuggerCommand): """ aliases = ('q',) - category = 'support' + category = 'running' min_args = 0 max_args = 0 name = os.path.basename(__file__).split('.')[0] diff --git a/trepan/processor/command/restart.py b/trepan/processor/command/restart.py index 012f3cc8..17ef4fb6 100644 --- a/trepan/processor/command/restart.py +++ b/trepan/processor/command/restart.py @@ -26,7 +26,7 @@ class RestartCommand(Mbase_cmd.DebuggerCommand): Restart debugger and program via an *exec()* call. All state is lost, and new copy of the debugger is used.""" - category = 'support' + category = 'running' min_args = 0 max_args = 0 name = os.path.basename(__file__).split('.')[0] diff --git a/trepan/processor/command/run.py b/trepan/processor/command/run.py index eab92702..bd06351d 100644 --- a/trepan/processor/command/run.py +++ b/trepan/processor/command/run.py @@ -35,7 +35,7 @@ class RunCommand(Mbase_cmd.DebuggerCommand): """ aliases = ('R',) - category = 'support' + category = 'running' min_args = 0 max_args = 0 name = os.path.basename(__file__).split('.')[0] diff --git a/trepan/processor/command/set.py b/trepan/processor/command/set.py index 2765225b..e5f982a5 100644 --- a/trepan/processor/command/set.py +++ b/trepan/processor/command/set.py @@ -1,5 +1,5 @@ # -*- coding: utf-8 -*- -# Copyright (C) 2009, 2013 Rocky Bernstein +# Copyright (C) 2009, 2013, 2015 Rocky Bernstein # # This program is free software: you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by @@ -20,7 +20,7 @@ class SetCommand(base_submgr.SubcommandMgr): - """**set** *set subcommand* + """**set** *set-subcommand* Modifies parts of the debugger environment. @@ -29,6 +29,8 @@ class SetCommand(base_submgr.SubcommandMgr): Type `set` for a list of *set* subcommands and what they do. Type `help set *` for just the list of *set* subcommands. + +All of the `set` commands have a corresponding `show` command. """ category = 'data' diff --git a/trepan/processor/command/show.py b/trepan/processor/command/show.py index d25163eb..0ada2ef3 100644 --- a/trepan/processor/command/show.py +++ b/trepan/processor/command/show.py @@ -28,6 +28,8 @@ class ShowCommand(Mbase_submgr.SubcommandMgr): Type `show` for a list of *show* subcommands and what they do. Type `help show *` for just a list of *show* subcommands. + +Many of the `show` commands have a corresponding `set` command. """ category = 'status'