20
20
# executable files with reasonable names.
22
22
# TODO: `help commands --all` should show hidden commands
26
"""Bazaar -- 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, get_optparser
134
options = cmd.options()
136
outfile.write(get_optparser(options).format_option_help())
28
commands as _mod_commands,
37
def help(topic=None, outfile=None):
38
"""Write the help for the specific topic to outfile"""
42
indices = HelpIndices()
44
alias = _mod_commands.get_alias(topic)
46
topics = indices.search(topic)
48
for index, topic in topics[1:]:
49
shadowed_terms.append('%s%s' % (index.prefix,
50
topic.get_help_topic()))
51
outfile.write(topics[0][1].get_help_text(shadowed_terms))
52
except errors.NoHelpTopic:
57
outfile.write("'bzr %s' is an alias for 'bzr %s'.\n" % (topic,
139
61
def help_commands(outfile=None):
140
62
"""List all commands"""
141
from bzrlib.commands import (builtin_command_names,
142
plugin_command_names,
145
63
if outfile is None:
146
64
outfile = sys.stdout
148
names = set() # to eliminate duplicates
149
names.update(builtin_command_names())
150
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)
65
outfile.write(_help_commands_to_text('commands'))
68
def _help_commands_to_text(topic):
69
"""Generate the help text for the list of commands"""
71
if topic == 'hidden-commands':
75
names = set(_mod_commands.builtin_command_names()) # to eliminate duplicates
76
names.update(_mod_commands.plugin_command_names())
77
commands = ((n, _mod_commands.get_cmd_object(n)) for n in names)
78
shown_commands = [(n, o) for n, o in commands if o.hidden == hidden]
79
max_name = max(len(n) for n, o in shown_commands)
80
indent = ' ' * (max_name + 1)
81
width = osutils.terminal_width() - 1
83
for cmd_name, cmd_object in sorted(shown_commands):
160
84
plugin_name = cmd_object.plugin_name()
161
print_command_plugin(cmd_object, outfile, ' %s\n')
85
if plugin_name is None:
88
plugin_name = ' [%s]' % plugin_name
163
90
cmd_help = cmd_object.help()
165
92
firstline = cmd_help.split('\n', 1)[0]
166
print >>outfile, ' ' + firstline
95
helpstring = '%-*s %s%s' % (max_name, cmd_name, firstline, plugin_name)
96
lines = textwrap.wrap(helpstring, subsequent_indent=indent,
99
out.append(line + '\n')
103
help_topics.topic_registry.register("commands",
104
_help_commands_to_text,
105
"Basic help for all commands",
106
help_topics.SECT_HIDDEN)
107
help_topics.topic_registry.register("hidden-commands",
108
_help_commands_to_text,
109
"All hidden commands",
110
help_topics.SECT_HIDDEN)
113
class HelpIndices(object):
114
"""Maintainer of help topics across multiple indices.
116
It is currently separate to the HelpTopicRegistry because of its ordered
117
nature, but possibly we should instead structure it as a search within the
118
registry and add ordering and searching facilities to the registry. The
119
registry would probably need to be restructured to support that cleanly
120
which is why this has been implemented in parallel even though it does as a
121
result permit searching for help in indices which are not discoverable via
124
Each index has a unique prefix string, such as "commands", and contains
125
help topics which can be listed or searched.
130
help_topics.HelpTopicIndex(),
131
_mod_commands.HelpCommandIndex(),
132
plugin.PluginsHelpIndex(),
135
def _check_prefix_uniqueness(self):
136
"""Ensure that the index collection is able to differentiate safely."""
138
for index in self.search_path:
139
prefixes.setdefault(index.prefix, []).append(index)
140
for prefix, indices in prefixes.items():
142
raise errors.DuplicateHelpPrefix(prefix)
144
def search(self, topic):
145
"""Search for topic across the help search path.
147
:param topic: A string naming the help topic to search for.
148
:raises: NoHelpTopic if none of the indexs in search_path have topic.
149
:return: A list of HelpTopics which matched 'topic'.
151
self._check_prefix_uniqueness()
153
for index in self.search_path:
154
result.extend([(index, _topic) for _topic in index.get_topics(topic)])
156
raise errors.NoHelpTopic(topic)
added
removed
bzrlib/help.py
