1
# Copyright (C) 2004, 2005, 2006 Canonical Ltd
1
# Copyright (C) 2004, 2005 by 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
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
18
"""Bazaar-NG -- a free distributed version-control tool
21
WARNING: This is an unstable development version.
26
bzr init makes this branch versioned
27
bzr branch make a copy of another branch
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
33
bzr status summarize changes in working copy
34
bzr diff show detailed diffs
36
bzr merge pull in changes from another branch
39
bzr log show history of changes
40
bzr check validate storage
42
Use e.g. 'bzr help init' for more details, or 'bzr help commands' for
33
def help(topic=None, outfile=None):
34
"""Write the help for the specific topic to outfile"""
50
def help(topic=None, outfile = None):
36
52
outfile = sys.stdout
41
if topic in help_topics.topic_registry:
42
txt = help_topics.topic_registry.get_detail(topic)
54
outfile.write(global_help)
55
elif topic == 'commands':
56
help_commands(outfile = outfile)
45
help_on_command(topic, outfile=outfile)
48
def command_usage(cmd_object):
58
help_on_command(topic, outfile = outfile)
61
def command_usage(cmdname, cmdclass):
49
62
"""Return single-line grammar for command.
51
64
Only describes arguments, not options.
53
s = 'bzr ' + cmd_object.name() + ' '
54
for aname in cmd_object.takes_args:
67
for aname in cmdclass.takes_args:
55
68
aname = aname.upper()
56
69
if aname[-1] in ['$', '+']:
57
70
aname = aname[:-1] + '...'
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)
82
def help_on_command(cmdname, outfile=None):
83
from bzrlib.commands import get_cmd_object
83
def help_on_command(cmdname, outfile = None):
85
84
cmdname = str(cmdname)
88
87
outfile = sys.stdout
90
cmd_object = get_cmd_object(cmdname)
89
from inspect import getdoc
91
topic, cmdclass = commands.get_cmd_class(cmdname)
92
doc = cmd_object.help()
93
doc = getdoc(cmdclass)
94
95
raise NotImplementedError("sorry, no detailed help yet for %r" % cmdname)
96
print >>outfile, 'usage:', command_usage(cmd_object)
98
if cmd_object.aliases:
99
print >>outfile, 'aliases:',
100
print >>outfile, ', '.join(cmd_object.aliases)
104
print_command_plugin(cmd_object, outfile, '%s\n\n')
97
outfile.write('usage: ' + command_usage(topic, cmdclass) + '\n')
100
outfile.write('aliases: ' + ', '.join(cmdclass.aliases) + '\n')
106
102
outfile.write(doc)
107
103
if doc[-1] != '\n':
108
104
outfile.write('\n')
109
help_on_command_options(cmd_object, outfile)
112
def help_on_command_options(cmd, outfile=None):
113
from bzrlib.option import Option, get_optparser
106
help_on_option(cmdclass.takes_options, outfile = None)
109
def help_on_option(options, outfile = None):
115
116
outfile = sys.stdout
116
options = cmd.options()
118
outfile.write(get_optparser(options).format_option_help())
121
def help_commands(outfile=None):
118
outfile.write('\noptions:\n')
121
for shortname, longname in commands.SHORT_OPTIONS.items():
123
l += ', -' + shortname
125
outfile.write(l + '\n')
128
def help_commands(outfile = None):
122
129
"""List all commands"""
124
134
outfile = sys.stdout
125
outfile.write(_help_commands_to_text('commands'))
128
def _help_commands_to_text(topic):
129
"""Generate the help text for the list of commands"""
130
from bzrlib.commands import (builtin_command_names,
131
plugin_command_names,
134
if topic == 'hidden-commands':
138
names = set(builtin_command_names()) # to eliminate duplicates
139
names.update(plugin_command_names())
140
commands = ((n, get_cmd_object(n)) for n in names)
141
shown_commands = [(n, o) for n, o in commands if o.hidden == hidden]
142
max_name = max(len(n) for n, o in shown_commands)
143
indent = ' ' * (max_name + 1)
144
width = osutils.terminal_width() - 1
146
for cmd_name, cmd_object in sorted(shown_commands):
147
plugin_name = cmd_object.plugin_name()
148
if plugin_name is None:
151
plugin_name = ' [%s]' % plugin_name
153
cmd_help = cmd_object.help()
155
firstline = cmd_help.split('\n', 1)[0]
158
helpstring = '%-*s %s%s' % (max_name, cmd_name, firstline, plugin_name)
159
lines = textwrap.wrap(helpstring, subsequent_indent=indent,
162
out.append(line + '\n')
166
help_topics.topic_registry.register("commands",
167
_help_commands_to_text,
168
"Basic help for all commands")
169
help_topics.topic_registry.register("hidden-commands",
170
_help_commands_to_text,
171
"All hidden commands")
137
for cmdname, cmdclass in commands.get_all_cmds():
138
accu.append((cmdname, cmdclass))
140
for cmdname, cmdclass in accu:
143
outfile.write(command_usage(cmdname, cmdclass) + '\n')
144
help = inspect.getdoc(cmdclass)
146
outfile.write(" " + help.split('\n', 1)[0] + '\n')
added
removed
bzrlib/help.py
