1
# Copyright (C) 2004, 2005, 2006 by Canonical Ltd
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.
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.
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
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.
22
# TODO: `help commands --all` should show hidden commands
26
"""Bazaar-NG -- a free distributed version-control tool
27
http://bazaar-vcs.org/
31
bzr init makes this directory a versioned branch
32
bzr branch make a copy of another branch
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
38
bzr status summarize changes in working copy
39
bzr diff show detailed diffs
41
bzr merge pull in changes from another branch
42
bzr commit save some or all changes
44
bzr log show history of changes
45
bzr check validate storage
47
bzr help init more help on e.g. init command
48
bzr help commands list all commands
55
def help(topic=None, outfile = None):
59
outfile.write(global_help)
60
elif topic == 'commands':
61
help_commands(outfile = outfile)
63
help_on_command(topic, outfile = outfile)
66
def command_usage(cmd_object):
67
"""Return single-line grammar for command.
69
Only describes arguments, not options.
71
s = 'bzr ' + cmd_object.name() + ' '
72
for aname in cmd_object.takes_args:
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] + '...]'
88
def print_command_plugin(cmd_object, outfile, format):
89
"""Print the plugin that provides a command object, if any.
91
If the cmd_object is provided by a plugin, prints the plugin name to
92
outfile using the provided format string.
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)
100
def help_on_command(cmdname, outfile=None):
101
from bzrlib.commands import get_cmd_object
103
cmdname = str(cmdname)
108
cmd_object = get_cmd_object(cmdname)
110
doc = cmd_object.help()
112
raise NotImplementedError("sorry, no detailed help yet for %r" % cmdname)
114
print >>outfile, 'usage:', command_usage(cmd_object)
116
if cmd_object.aliases:
117
print >>outfile, 'aliases:',
118
print >>outfile, ', '.join(cmd_object.aliases)
122
print_command_plugin(cmd_object, outfile, '%s\n\n')
127
help_on_command_options(cmd_object, outfile)
130
def help_on_command_options(cmd, outfile=None):
131
from bzrlib.option import Option
132
options = cmd.options()
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()
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
149
wrapped = textwrap.fill(l, initial_indent='', subsequent_indent=30*' ')
150
outfile.write(wrapped + '\n')
153
def help_commands(outfile=None):
154
"""List all commands"""
155
from bzrlib.commands import (builtin_command_names,
156
plugin_command_names,
162
names = set() # to eliminate duplicates
163
names.update(builtin_command_names())
164
names.update(plugin_command_names())
168
for cmd_name in names:
169
cmd_object = get_cmd_object(cmd_name)
170
if cmd_object.hidden:
172
print >>outfile, command_usage(cmd_object)
174
plugin_name = cmd_object.plugin_name()
175
print_command_plugin(cmd_object, outfile, ' %s\n')
177
cmd_help = cmd_object.help()
179
firstline = cmd_help.split('\n', 1)[0]
180
print >>outfile, ' ' + firstline
added
removed
bzrlib/help.py
