← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/help.py

  • Committer: mbp at sourcefrog
  • Date: 2005-04-09 04:01:25 UTC
  • Revision ID: mbp@sourcefrog.net-20050409040125-5c53f66535269927911b91b9
Revfile:- new find-sha command and implementation- new _check_index helper

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/help.py
1
 
# Copyright (C) 2004, 2005, 2006 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
 
import textwrap
24
 
 
25
 
global_help = \
26
 
"""Bazaar-NG -- a free distributed version-control tool
27
 
http://bazaar-vcs.org/
28
 
 
29
 
Basic commands:
30
 
 
31
 
  bzr init           makes this directory a versioned branch
32
 
  bzr branch         make a copy of another branch
33
 
 
34
 
  bzr add            make files or directories versioned
35
 
  bzr ignore         ignore a file or pattern
36
 
  bzr mv             move or rename a versioned file
37
 
 
38
 
  bzr status         summarize changes in working copy
39
 
  bzr diff           show detailed diffs
40
 
 
41
 
  bzr merge          pull in changes from another branch
42
 
  bzr commit         save some or all changes
43
 
 
44
 
  bzr log            show history of changes
45
 
  bzr check          validate storage
46
 
 
47
 
  bzr help init      more help on e.g. init command
48
 
  bzr help commands  list all commands
49
 
"""
50
 
 
51
 
 
52
 
import sys
53
 
 
54
 
 
55
 
def help(topic=None, outfile = None):
56
 
    if outfile == None:
57
 
        outfile = sys.stdout
58
 
    if topic == None:
59
 
        outfile.write(global_help)
60
 
    elif topic == 'commands':
61
 
        help_commands(outfile = outfile)
62
 
    else:
63
 
        help_on_command(topic, outfile = outfile)
64
 
 
65
 
 
66
 
def command_usage(cmd_object):
67
 
    """Return single-line grammar for command.
68
 
 
69
 
    Only describes arguments, not options.
70
 
    """
71
 
    s = 'bzr ' + cmd_object.name() + ' '
72
 
    for aname in cmd_object.takes_args:
73
 
        aname = aname.upper()
74
 
        if aname[-1] in ['$', '+']:
75
 
            aname = aname[:-1] + '...'
76
 
        elif aname[-1] == '?':
77
 
            aname = '[' + aname[:-1] + ']'
78
 
        elif aname[-1] == '*':
79
 
            aname = '[' + aname[:-1] + '...]'
80
 
        s += aname + ' '
81
 
            
82
 
    assert s[-1] == ' '
83
 
    s = s[:-1]
84
 
    
85
 
    return s
86
 
 
87
 
 
88
 
def print_command_plugin(cmd_object, outfile, format):
89
 
    """Print the plugin that provides a command object, if any.
90
 
 
91
 
    If the cmd_object is provided by a plugin, prints the plugin name to
92
 
    outfile using the provided format string.
93
 
    """
94
 
    plugin_name = cmd_object.plugin_name()
95
 
    if plugin_name is not None:
96
 
        out_str = '(From plugin "%s")' % plugin_name
97
 
        outfile.write(format % out_str)
98
 
 
99
 
 
100
 
def help_on_command(cmdname, outfile=None):
101
 
    from bzrlib.commands import get_cmd_object
102
 
 
103
 
    cmdname = str(cmdname)
104
 
 
105
 
    if outfile == None:
106
 
        outfile = sys.stdout
107
 
 
108
 
    cmd_object = get_cmd_object(cmdname)
109
 
 
110
 
    doc = cmd_object.help()
111
 
    if doc == None:
112
 
        raise NotImplementedError("sorry, no detailed help yet for %r" % cmdname)
113
 
 
114
 
    print >>outfile, 'usage:', command_usage(cmd_object) 
115
 
 
116
 
    if cmd_object.aliases:
117
 
        print >>outfile, 'aliases:',
118
 
        print >>outfile, ', '.join(cmd_object.aliases)
119
 
 
120
 
    print >>outfile
121
 
 
122
 
    print_command_plugin(cmd_object, outfile, '%s\n\n')
123
 
 
124
 
    outfile.write(doc)
125
 
    if doc[-1] != '\n':
126
 
        outfile.write('\n')
127
 
    help_on_command_options(cmd_object, outfile)
128
 
 
129
 
 
130
 
def help_on_command_options(cmd, outfile=None):
131
 
    from bzrlib.option import Option
132
 
    options = cmd.options()
133
 
    if not options:
134
 
        return
135
 
    if outfile == None:
136
 
        outfile = sys.stdout
137
 
    outfile.write('\noptions:\n')
138
 
    for option_name, option in sorted(options.items()):
139
 
        l = '    --' + option_name
140
 
        if option.type is not None:
141
 
            l += ' ' + option.argname.upper()
142
 
        short_name = option.short_name()
143
 
        if short_name:
144
 
            assert len(short_name) == 1
145
 
            l += ', -' + short_name
146
 
        l += (30 - len(l)) * ' ' + option.help
147
 
        # TODO: split help over multiple lines with correct indenting and 
148
 
        # wrapping
149
 
        wrapped = textwrap.fill(l, initial_indent='', subsequent_indent=30*' ')
150
 
        outfile.write(wrapped + '\n')
151
 
 
152
 
 
153
 
def help_commands(outfile=None):
154
 
    """List all commands"""
155
 
    from bzrlib.commands import (builtin_command_names,
156
 
                                 plugin_command_names,
157
 
                                 get_cmd_object)
158
 
 
159
 
    if outfile == None:
160
 
        outfile = sys.stdout
161
 
 
162
 
    names = set()                       # to eliminate duplicates
163
 
    names.update(builtin_command_names())
164
 
    names.update(plugin_command_names())
165
 
    names = list(names)
166
 
    names.sort()
167
 
 
168
 
    for cmd_name in names:
169
 
        cmd_object = get_cmd_object(cmd_name)
170
 
        if cmd_object.hidden:
171
 
            continue
172
 
        print >>outfile, command_usage(cmd_object)
173
 
 
174
 
        plugin_name = cmd_object.plugin_name()
175
 
        print_command_plugin(cmd_object, outfile, '        %s\n')
176
 
 
177
 
        cmd_help = cmd_object.help()
178
 
        if cmd_help:
179
 
            firstline = cmd_help.split('\n', 1)[0]
180
 
            print >>outfile, '        ' + firstline
181