← Back to branch summary

~abentley/bzrtools/bzrtools.dev

« back to all changes in this revision

Viewing changes to __init__.py

  • Committer: Aaron Bentley
  • Date: 2005-11-17 16:39:52 UTC
  • Revision ID: abentley@panoramicfeedback.com-20051117163952-e916bbbc3580c727
Added shell docstring

Show diffs side-by-side

added added

removed removed

Lines of Context:
__init__.py
141
141
        return s.unshelve()
142
142
 
143
143
class cmd_shell(bzrlib.commands.Command):
 
144
    """Begin an interactive shell tailored for bzr.
 
145
    Bzr commands can be used without typing bzr first, and will be run natively
 
146
    when possible.  Tab completion is tailored for bzr.  The shell prompt shows
 
147
    the branch nick, revno, and path.
 
148
 
 
149
    If it encounters any moderately complicated shell command, it will punt to
 
150
    the system shell.
 
151
 
 
152
    Example:
 
153
    $ bzr shell
 
154
    bzr bzrtools:287/> status
 
155
    modified:
 
156
      __init__.py
 
157
    bzr bzrtools:287/> status --[TAB][TAB]
 
158
    --all        --help       --revision   --show-ids
 
159
    bzr bzrtools:287/> status --
 
160
    """
144
161
    def run(self):
145
162
        import shell
146
163
        return shell.run_shell()