← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/commands.py

  • Committer: Martin Pool
  • Date: 2005-04-15 08:51:11 UTC
  • Revision ID: mbp@sourcefrog.net-20050415085111-dc9ee788d2cc1216
- New 'bzr help commands'

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/commands.py
17
17
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
18
18
 
19
19
"""Bazaar-NG -- a free distributed version-control tool
 
20
http://bazaar-ng.org/
20
21
 
21
22
**WARNING: THIS IS AN UNSTABLE DEVELOPMENT VERSION**
22
23
 
23
 
Current limitation include:
24
 
 
25
24
* Metadata format is not stable yet -- you may need to
26
25
  discard history in the future.
27
26
 
28
 
* Insufficient error handling.
29
 
 
30
27
* Many commands unimplemented or partially implemented.
31
28
 
32
29
* Space-inefficient storage.
33
30
 
34
31
* No merge operators yet.
35
32
 
36
 
Interesting commands::
 
33
Interesting commands:
37
34
 
38
35
  bzr help [COMMAND]
39
 
       Show help screen
 
36
      Show help screen
40
37
  bzr version
41
 
       Show software version/licence/non-warranty.
 
38
      Show software version/licence/non-warranty.
42
39
  bzr init
43
 
       Start versioning the current directory
 
40
      Start versioning the current directory
44
41
  bzr add FILE...
45
 
       Make files versioned.
 
42
      Make files versioned.
46
43
  bzr log
47
 
       Show revision history.
 
44
      Show revision history.
48
45
  bzr diff [FILE...]
49
 
       Show changes from last revision to working copy.
 
46
      Show changes from last revision to working copy.
50
47
  bzr commit -m 'MESSAGE'
51
 
       Store current state as new revision.
 
48
      Store current state as new revision.
52
49
  bzr export REVNO DESTINATION
53
 
       Export the branch state at a previous version.
 
50
      Export the branch state at a previous version.
54
51
  bzr status
55
 
       Show summary of pending changes.
 
52
      Show summary of pending changes.
56
53
  bzr remove FILE...
57
 
       Make a file not versioned.
 
54
      Make a file not versioned.
58
55
  bzr info
59
 
       Show statistics about this branch.
 
56
      Show statistics about this branch.
 
57
  bzr check
 
58
      Verify history is stored safely. 
 
59
  (for more type 'bzr help commands')
60
60
"""
61
61
 
62
62
 
680
680
def cmd_whoami():
681
681
    """Show bzr user id.
682
682
 
 
683
    usage: bzr whoami
 
684
 
683
685
    TODO: Command to show only the email-address part as parsed out.
684
686
    """
685
687
    print bzrlib.osutils.username()
731
733
def cmd_help(topic=None):
732
734
    if topic == None:
733
735
        print __doc__
734
 
        return
735
 
 
736
 
    # otherwise, maybe the name of a command?
737
 
    topic, cmdfn = get_cmd_handler(topic)
738
 
 
739
 
    doc = getdoc(cmdfn)
740
 
    if doc == None:
741
 
        bailout("sorry, no detailed help yet for %r" % topic)
742
 
 
743
 
    print doc
 
736
    elif topic == 'commands':
 
737
        help_commands()
 
738
    else:
 
739
        # otherwise, maybe the name of a command?
 
740
        topic, cmdfn = get_cmd_handler(topic)
 
741
 
 
742
        doc = getdoc(cmdfn)
 
743
        if doc == None:
 
744
            bailout("sorry, no detailed help yet for %r" % topic)
 
745
 
 
746
        print doc
 
747
 
 
748
 
 
749
def help_commands():
 
750
    """List all commands"""
 
751
    accu = []
 
752
    for k in globals().keys():
 
753
        if k.startswith('cmd_'):
 
754
            accu.append(k[4:].replace('_','-'))
 
755
    accu.sort()
 
756
    print "bzr commands: "
 
757
    for x in accu:
 
758
        print "   " + x
 
759
    print "note: some of these commands are internal-use or obsolete"
 
760
    # TODO: Some kind of marker for internal-use commands?
 
761
    # TODO: Show aliases?
744
762
        
745
763
 
746
764