1
# Copyright (C) 2004, 2005, 2006 by Canonical Ltd
1
# Copyright (C) 2004, 2005, 2006 Canonical Ltd
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.
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.
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
20
20
# executable files with reasonable names.
22
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):
33
def help(topic=None, outfile=None):
34
"""Write the help for the specific topic to outfile"""
57
36
outfile = sys.stdout
59
outfile.write(global_help)
60
elif topic == 'commands':
61
help_commands(outfile = outfile)
41
if topic in help_topics.topic_registry:
42
txt = help_topics.topic_registry.get_detail(topic)
63
help_on_command(topic, outfile = outfile)
45
help_on_command(topic, outfile=outfile)
66
48
def command_usage(cmd_object):
70
def print_command_plugin(cmd_object, outfile, format):
71
"""Print the plugin that provides a command object, if any.
73
If the cmd_object is provided by a plugin, prints the plugin name to
74
outfile using the provided format string.
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)
88
82
def help_on_command(cmdname, outfile=None):
89
83
from bzrlib.commands import get_cmd_object
91
85
cmdname = str(cmdname)
96
86
cmd_object = get_cmd_object(cmdname)
88
return help_on_command_object(cmd_object, cmdname, outfile)
91
def help_on_command_object(cmd_object, cmdname, outfile=None):
92
"""Generate help on the cmd_object with a supplied name of cmdname.
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.
98
101
doc = cmd_object.help()
100
103
raise NotImplementedError("sorry, no detailed help yet for %r" % cmdname)
102
print >>outfile, 'usage:', command_usage(cmd_object)
105
print >>outfile, 'usage:', command_usage(cmd_object)
104
107
if cmd_object.aliases:
105
108
print >>outfile, 'aliases:',
113
print_command_plugin(cmd_object, outfile, '%s\n\n')
110
115
outfile.write(doc)
111
116
if doc[-1] != '\n':
112
117
outfile.write('\n')
113
118
help_on_command_options(cmd_object, outfile)
119
see_also = cmd_object.get_see_also()
121
outfile.write('\nSee also: ')
122
outfile.write(', '.join(see_also))
116
126
def help_on_command_options(cmd, outfile=None):
117
from bzrlib.option import Option
127
from bzrlib.option import Option, get_optparser
118
130
options = cmd.options()
123
outfile.write('\noptions:\n')
124
for option_name, option in sorted(options.items()):
125
l = ' --' + option_name
126
if option.type is not None:
127
l += ' ' + option.argname.upper()
128
short_name = option.short_name()
130
assert len(short_name) == 1
131
l += ', -' + short_name
132
l += (30 - len(l)) * ' ' + option.help
133
# TODO: split help over multiple lines with correct indenting and
135
wrapped = textwrap.fill(l, initial_indent='', subsequent_indent=30*' ')
136
outfile.write(wrapped + '\n')
132
outfile.write(get_optparser(options).format_option_help())
139
135
def help_commands(outfile=None):
140
136
"""List all commands"""
139
outfile.write(_help_commands_to_text('commands'))
142
def _help_commands_to_text(topic):
143
"""Generate the help text for the list of commands"""
141
144
from bzrlib.commands import (builtin_command_names,
142
145
plugin_command_names,
148
names = set() # to eliminate duplicates
149
names.update(builtin_command_names())
148
if topic == 'hidden-commands':
152
names = set(builtin_command_names()) # to eliminate duplicates
150
153
names.update(plugin_command_names())
154
for cmd_name in names:
155
cmd_object = get_cmd_object(cmd_name)
156
if cmd_object.hidden:
158
print >>outfile, command_usage(cmd_object)
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
160
for cmd_name, cmd_object in sorted(shown_commands):
161
plugin_name = cmd_object.plugin_name()
162
if plugin_name is None:
165
plugin_name = ' [%s]' % plugin_name
159
167
cmd_help = cmd_object.help()
161
169
firstline = cmd_help.split('\n', 1)[0]
162
print >>outfile, ' ' + firstline
172
helpstring = '%-*s %s%s' % (max_name, cmd_name, firstline, plugin_name)
173
lines = textwrap.wrap(helpstring, subsequent_indent=indent,
176
out.append(line + '\n')
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")
added
removed
bzrlib/help.py
