← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/help.py

Merge bzr.dev

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/help.py
1
 
# Copyright (C) 2004, 2005 by Canonical Ltd
2
 
 
 
1
# Copyright (C) 2004, 2005, 2006 Canonical Ltd
 
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
5
5
# the Free Software Foundation; either version 2 of the License, or
6
6
# (at your option) any later version.
7
 
 
 
7
#
8
8
# This program is distributed in the hope that it will be useful,
9
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11
11
# GNU General Public License for more details.
12
 
 
 
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
17
 
global_help = \
18
 
"""Bazaar-NG -- a free distributed version-control tool
19
 
http://bazaar-ng.org/
20
 
 
21
 
WARNING: This is an unstable development version.
22
 
         Please keep backups.
23
 
 
24
 
Basic commands:
25
 
 
26
 
  bzr init      makes this branch versioned
27
 
  bzr branch    make a copy of another branch
28
 
 
29
 
  bzr add       make files or directories versioned
30
 
  bzr ignore    ignore a file or pattern
31
 
  bzr mv        move or rename a versioned file
32
 
 
33
 
  bzr status    summarize changes in working copy
34
 
  bzr diff      show detailed diffs
35
 
 
36
 
  bzr merge     pull in changes from another branch
37
 
  bzr commit    
38
 
 
39
 
  bzr log       show history of changes
40
 
  bzr check     validate storage
41
 
 
42
 
Use e.g. 'bzr help init' for more details, or 'bzr help commands' for
43
 
all commands.
44
 
"""
45
 
 
 
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
46
23
 
47
24
import sys
48
 
 
49
 
 
50
 
def help(topic=None, outfile = None):
51
 
    if outfile == None:
 
25
import textwrap
 
26
 
 
27
from bzrlib import (
 
28
    help_topics,
 
29
    osutils,
 
30
    )
 
31
 
 
32
 
 
33
def help(topic=None, outfile=None):
 
34
    """Write the help for the specific topic to outfile"""
 
35
    if outfile is None:
52
36
        outfile = sys.stdout
53
 
    if topic == None:
54
 
        outfile.write(global_help)
55
 
    elif topic == 'commands':
56
 
        help_commands(outfile = outfile)
 
37
 
 
38
    if topic is None:
 
39
        topic = 'basic'
 
40
 
 
41
    if topic in help_topics.topic_registry:
 
42
        txt = help_topics.topic_registry.get_detail(topic)
 
43
        outfile.write(txt)
57
44
    else:
58
 
        help_on_command(topic, outfile = outfile)
59
 
 
60
 
 
61
 
def command_usage(cmdname, cmdclass):
 
45
        help_on_command(topic, outfile=outfile)
 
46
 
 
47
 
 
48
def command_usage(cmd_object):
62
49
    """Return single-line grammar for command.
63
50
 
64
51
    Only describes arguments, not options.
65
52
    """
66
 
    s = cmdname + ' '
67
 
    for aname in cmdclass.takes_args:
 
53
    s = 'bzr ' + cmd_object.name() + ' '
 
54
    for aname in cmd_object.takes_args:
68
55
        aname = aname.upper()
69
56
        if aname[-1] in ['$', '+']:
70
57
            aname = aname[:-1] + '...'
80
67
    return s
81
68
 
82
69
 
83
 
def help_on_command(cmdname, outfile = None):
 
70
def print_command_plugin(cmd_object, outfile, format):
 
71
    """Print the plugin that provides a command object, if any.
 
72
 
 
73
    If the cmd_object is provided by a plugin, prints the plugin name to
 
74
    outfile using the provided format string.
 
75
    """
 
76
    plugin_name = cmd_object.plugin_name()
 
77
    if plugin_name is not None:
 
78
        out_str = '(From plugin "%s")' % plugin_name
 
79
        outfile.write(format % out_str)
 
80
 
 
81
 
 
82
def help_on_command(cmdname, outfile=None):
 
83
    from bzrlib.commands import get_cmd_object
 
84
 
84
85
    cmdname = str(cmdname)
85
 
 
86
 
    if outfile == None:
 
86
    cmd_object = get_cmd_object(cmdname)
 
87
 
 
88
    return help_on_command_object(cmd_object, cmdname, outfile)
 
89
 
 
90
 
 
91
def help_on_command_object(cmd_object, cmdname, outfile=None):
 
92
    """Generate help on the cmd_object with a supplied name of cmdname.
 
93
 
 
94
    :param cmd_object: An instance of a Command.
 
95
    :param cmdname: The user supplied name. This might be an alias for example.
 
96
    :param outfile: A stream to write the help to.
 
97
    """
 
98
    if outfile is None:
87
99
        outfile = sys.stdout
88
100
 
89
 
    from inspect import getdoc
90
 
    import commands
91
 
    topic, cmdclass = commands.get_cmd_class(cmdname)
92
 
 
93
 
    doc = getdoc(cmdclass)
94
 
    if doc == None:
 
101
    doc = cmd_object.help()
 
102
    if doc is None:
95
103
        raise NotImplementedError("sorry, no detailed help yet for %r" % cmdname)
96
104
 
97
 
    outfile.write('usage: ' + command_usage(topic, cmdclass) + '\n')
98
 
 
99
 
    if cmdclass.aliases:
100
 
        outfile.write('aliases: ' + ', '.join(cmdclass.aliases) + '\n')
101
 
    
 
105
    print >>outfile, 'usage:', command_usage(cmd_object)
 
106
 
 
107
    if cmd_object.aliases:
 
108
        print >>outfile, 'aliases:',
 
109
        print >>outfile, ', '.join(cmd_object.aliases)
 
110
 
 
111
    print >>outfile
 
112
 
 
113
    print_command_plugin(cmd_object, outfile, '%s\n\n')
 
114
 
102
115
    outfile.write(doc)
103
116
    if doc[-1] != '\n':
104
117
        outfile.write('\n')
105
 
    
106
 
    help_on_option(cmdclass.takes_options, outfile = None)
107
 
 
108
 
 
109
 
def help_on_option(options, outfile = None):
110
 
    import commands
111
 
    
112
 
    if not options:
113
 
        return
114
 
    
115
 
    if outfile == None:
 
118
    help_on_command_options(cmd_object, outfile)
 
119
    see_also = cmd_object.get_see_also()
 
120
    if see_also:
 
121
        outfile.write('\nSee also: ')
 
122
        outfile.write(', '.join(see_also))
 
123
        outfile.write('\n')
 
124
 
 
125
 
 
126
def help_on_command_options(cmd, outfile=None):
 
127
    from bzrlib.option import Option, get_optparser
 
128
    if outfile is None:
116
129
        outfile = sys.stdout
117
 
 
118
 
    outfile.write('\noptions:\n')
119
 
    for on in options:
120
 
        l = '    --' + on
121
 
        for shortname, longname in commands.SHORT_OPTIONS.items():
122
 
            if longname == on:
123
 
                l += ', -' + shortname
124
 
                break
125
 
        outfile.write(l + '\n')
126
 
 
127
 
 
128
 
def help_commands(outfile = None):
 
130
    options = cmd.options()
 
131
    outfile.write('\n')
 
132
    outfile.write(get_optparser(options).format_option_help())
 
133
 
 
134
 
 
135
def help_commands(outfile=None):
129
136
    """List all commands"""
130
 
    import inspect
131
 
    import commands
132
 
 
133
 
    if outfile == None:
 
137
    if outfile is None:
134
138
        outfile = sys.stdout
135
 
    
136
 
    accu = []
137
 
    for cmdname, cmdclass in commands.get_all_cmds():
138
 
        accu.append((cmdname, cmdclass))
139
 
    accu.sort()
140
 
    for cmdname, cmdclass in accu:
141
 
        if cmdclass.hidden:
142
 
            continue
143
 
        outfile.write(command_usage(cmdname, cmdclass) + '\n')
144
 
        help = inspect.getdoc(cmdclass)
145
 
        if help:
146
 
            outfile.write("    " + help.split('\n', 1)[0] + '\n')
147
 
 
148
 
            
149
 
 
 
139
    outfile.write(_help_commands_to_text('commands'))
 
140
 
 
141
 
 
142
def _help_commands_to_text(topic):
 
143
    """Generate the help text for the list of commands"""
 
144
    from bzrlib.commands import (builtin_command_names,
 
145
                                 plugin_command_names,
 
146
                                 get_cmd_object)
 
147
    out = []
 
148
    if topic == 'hidden-commands':
 
149
        hidden = True
 
150
    else:
 
151
        hidden = False
 
152
    names = set(builtin_command_names()) # to eliminate duplicates
 
153
    names.update(plugin_command_names())
 
154
    commands = ((n, get_cmd_object(n)) for n in names)
 
155
    shown_commands = [(n, o) for n, o in commands if o.hidden == hidden]
 
156
    max_name = max(len(n) for n, o in shown_commands)
 
157
    indent = ' ' * (max_name + 1)
 
158
    width = osutils.terminal_width() - 1
 
159
 
 
160
    for cmd_name, cmd_object in sorted(shown_commands):
 
161
        plugin_name = cmd_object.plugin_name()
 
162
        if plugin_name is None:
 
163
            plugin_name = ''
 
164
        else:
 
165
            plugin_name = ' [%s]' % plugin_name
 
166
 
 
167
        cmd_help = cmd_object.help()
 
168
        if cmd_help:
 
169
            firstline = cmd_help.split('\n', 1)[0]
 
170
        else:
 
171
            firstline = ''
 
172
        helpstring = '%-*s %s%s' % (max_name, cmd_name, firstline, plugin_name)
 
173
        lines = textwrap.wrap(helpstring, subsequent_indent=indent,
 
174
                              width=width)
 
175
        for line in lines:
 
176
            out.append(line + '\n')
 
177
    return ''.join(out)
 
178
 
 
179
 
 
180
help_topics.topic_registry.register("commands",
 
181
                                    _help_commands_to_text,
 
182
                                    "Basic help for all commands")
 
183
help_topics.topic_registry.register("hidden-commands", 
 
184
                                    _help_commands_to_text,
 
185
                                    "All hidden commands")