← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/help.py

merge from aaron - fixes bare excepts, adds ancestor namespace

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/help.py
 
1
# Copyright (C) 2004, 2005 by Canonical Ltd
 
2
 
 
3
# This program is free software; you can redistribute it and/or modify
 
4
# it under the terms of the GNU General Public License as published by
 
5
# the Free Software Foundation; either version 2 of the License, or
 
6
# (at your option) any later version.
 
7
 
 
8
# This program is distributed in the hope that it will be useful,
 
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
 
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
11
# GNU General Public License for more details.
 
12
 
 
13
# You should have received a copy of the GNU General Public License
 
14
# along with this program; if not, write to the Free Software
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
16
 
 
17
# TODO: Some way to get a list of external commands (defined by shell
 
18
# scripts) so that they can be included in the help listing as well.
 
19
# It should be enough to just list the plugin directory and look for
 
20
# executable files with reasonable names.
 
21
 
 
22
# TODO: `help commands --all` should show hidden commands
 
23
 
 
24
global_help = \
 
25
"""Bazaar-NG -- a free distributed version-control tool
 
26
http://bazaar-ng.org/
 
27
 
 
28
WARNING: This is an unstable development version.
 
29
         Please keep backups.
 
30
 
 
31
Basic commands:
 
32
 
 
33
  bzr init      makes this branch versioned
 
34
  bzr branch    make a copy of another branch
 
35
 
 
36
  bzr add       make files or directories versioned
 
37
  bzr ignore    ignore a file or pattern
 
38
  bzr mv        move or rename a versioned file
 
39
 
 
40
  bzr status    summarize changes in working copy
 
41
  bzr diff      show detailed diffs
 
42
 
 
43
  bzr merge     pull in changes from another branch
 
44
  bzr commit    save some or all changes
 
45
 
 
46
  bzr log       show history of changes
 
47
  bzr check     validate storage
 
48
 
 
49
Use e.g. 'bzr help init' for more details, or
 
50
'bzr help commands' for all commands.
 
51
"""
 
52
 
 
53
 
 
54
import sys
 
55
 
 
56
 
 
57
def help(topic=None, outfile = None):
 
58
    if outfile == None:
 
59
        outfile = sys.stdout
 
60
    if topic == None:
 
61
        outfile.write(global_help)
 
62
    elif topic == 'commands':
 
63
        help_commands(outfile = outfile)
 
64
    else:
 
65
        help_on_command(topic, outfile = outfile)
 
66
 
 
67
 
 
68
def command_usage(cmd_object):
 
69
    """Return single-line grammar for command.
 
70
 
 
71
    Only describes arguments, not options.
 
72
    """
 
73
    s = 'bzr ' + cmd_object.name() + ' '
 
74
    for aname in cmd_object.takes_args:
 
75
        aname = aname.upper()
 
76
        if aname[-1] in ['$', '+']:
 
77
            aname = aname[:-1] + '...'
 
78
        elif aname[-1] == '?':
 
79
            aname = '[' + aname[:-1] + ']'
 
80
        elif aname[-1] == '*':
 
81
            aname = '[' + aname[:-1] + '...]'
 
82
        s += aname + ' '
 
83
            
 
84
    assert s[-1] == ' '
 
85
    s = s[:-1]
 
86
    
 
87
    return s
 
88
 
 
89
 
 
90
def help_on_command(cmdname, outfile=None):
 
91
    from bzrlib.commands import get_cmd_object
 
92
 
 
93
    cmdname = str(cmdname)
 
94
 
 
95
    if outfile == None:
 
96
        outfile = sys.stdout
 
97
 
 
98
    cmd_object = get_cmd_object(cmdname)
 
99
 
 
100
    doc = cmd_object.help()
 
101
    if doc == None:
 
102
        raise NotImplementedError("sorry, no detailed help yet for %r" % cmdname)
 
103
 
 
104
    print >>outfile, 'usage:', command_usage(cmd_object) 
 
105
 
 
106
    if cmd_object.aliases:
 
107
        print >>outfile, 'aliases:',
 
108
        print >>outfile, ', '.join(cmd_object.aliases)
 
109
 
 
110
    print >>outfile
 
111
 
 
112
    outfile.write(doc)
 
113
    if doc[-1] != '\n':
 
114
        outfile.write('\n')
 
115
    
 
116
    help_on_options(cmd_object.takes_options, outfile=None)
 
117
 
 
118
 
 
119
def help_on_options(options, outfile=None):
 
120
    from bzrlib.commands import SHORT_OPTIONS
 
121
    
 
122
    if not options:
 
123
        return
 
124
    
 
125
    if outfile == None:
 
126
        outfile = sys.stdout
 
127
 
 
128
    outfile.write('\noptions:\n')
 
129
    for on in options:
 
130
        l = '    --' + on
 
131
        for shortname, longname in SHORT_OPTIONS.items():
 
132
            if longname == on:
 
133
                l += ', -' + shortname
 
134
                break
 
135
        outfile.write(l + '\n')
 
136
 
 
137
 
 
138
def help_commands(outfile=None):
 
139
    """List all commands"""
 
140
    from bzrlib.commands import (builtin_command_names,
 
141
                                 plugin_command_names,
 
142
                                 get_cmd_object)
 
143
 
 
144
    if outfile == None:
 
145
        outfile = sys.stdout
 
146
 
 
147
    names = set()                       # to eliminate duplicates
 
148
    names.update(builtin_command_names())
 
149
    names.update(plugin_command_names())
 
150
    names = list(names)
 
151
    names.sort()
 
152
 
 
153
    for cmd_name in names:
 
154
        cmd_object = get_cmd_object(cmd_name)
 
155
        if cmd_object.hidden:
 
156
            continue
 
157
        print >>outfile, command_usage(cmd_object)
 
158
        cmd_help = cmd_object.help()
 
159
        if cmd_help:
 
160
            firstline = cmd_help.split('\n', 1)[0]
 
161
            print >>outfile, '    ' + firstline
 
162