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()
43
topics = indices.search(topic)
45
for index, topic in topics[1:]:
46
shadowed_terms.append('%s%s' % (index.prefix, topic.get_help_topic()))
47
outfile.write(topics[0][1].get_help_text(shadowed_terms))
139
50
def help_commands(outfile=None):
140
51
"""List all commands"""
141
from bzrlib.commands import (builtin_command_names,
142
plugin_command_names,
145
52
if outfile is None:
146
53
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)
54
outfile.write(_help_commands_to_text('commands'))
57
@symbol_versioning.deprecated_function(symbol_versioning.zero_sixteen)
58
def command_usage(cmd):
62
def _help_commands_to_text(topic):
63
"""Generate the help text for the list of commands"""
65
if topic == 'hidden-commands':
69
names = set(_mod_commands.builtin_command_names()) # to eliminate duplicates
70
names.update(_mod_commands.plugin_command_names())
71
commands = ((n, _mod_commands.get_cmd_object(n)) for n in names)
72
shown_commands = [(n, o) for n, o in commands if o.hidden == hidden]
73
max_name = max(len(n) for n, o in shown_commands)
74
indent = ' ' * (max_name + 1)
75
width = osutils.terminal_width() - 1
77
for cmd_name, cmd_object in sorted(shown_commands):
160
78
plugin_name = cmd_object.plugin_name()
161
print_command_plugin(cmd_object, outfile, ' %s\n')
79
if plugin_name is None:
82
plugin_name = ' [%s]' % plugin_name
163
84
cmd_help = cmd_object.help()
165
86
firstline = cmd_help.split('\n', 1)[0]
166
print >>outfile, ' ' + firstline
89
helpstring = '%-*s %s%s' % (max_name, cmd_name, firstline, plugin_name)
90
lines = textwrap.wrap(helpstring, subsequent_indent=indent,
93
out.append(line + '\n')
97
help_topics.topic_registry.register("commands",
98
_help_commands_to_text,
99
"Basic help for all commands")
100
help_topics.topic_registry.register("hidden-commands",
101
_help_commands_to_text,
102
"All hidden commands")
105
class HelpIndices(object):
106
"""Maintainer of help topics across multiple indices.
108
It is currently separate to the HelpTopicRegistry because of its ordered
109
nature, but possibly we should instead structure it as a search within the
110
registry and add ordering and searching facilities to the registry. The
111
registry would probably need to be restructured to support that cleanly
112
which is why this has been implemented in parallel even though it does as a
113
result permit searching for help in indices which are not discoverable via
116
Each index has a unique prefix string, such as "commands", and contains
117
help topics which can be listed or searched.
122
help_topics.HelpTopicIndex(),
123
_mod_commands.HelpCommandIndex(),
124
plugin.PluginsHelpIndex(),
127
def _check_prefix_uniqueness(self):
128
"""Ensure that the index collection is able to differentiate safely."""
130
for index in self.search_path:
131
prefixes.setdefault(index.prefix, []).append(index)
132
for prefix, indices in prefixes.items():
134
raise errors.DuplicateHelpPrefix(prefix)
136
def search(self, topic):
137
"""Search for topic across the help search path.
139
:param topic: A string naming the help topic to search for.
140
:raises: NoHelpTopic if none of the indexs in search_path have topic.
141
:return: A list of HelpTopics which matched 'topic'.
143
self._check_prefix_uniqueness()
145
for index in self.search_path:
146
result.extend([(index, _topic) for _topic in index.get_topics(topic)])
148
raise errors.NoHelpTopic(topic)
added
removed
bzrlib/help.py
