1
# Copyright (C) 2004, 2005 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
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
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
50
def help(topic=None, outfile = None):
54
outfile.write(global_help)
55
elif topic == 'commands':
56
help_commands(outfile = outfile)
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))
50
def help_commands(outfile=None):
51
"""List all commands"""
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':
58
help_on_command(topic, outfile = outfile)
61
def command_usage(cmdname, cmdclass):
62
"""Return single-line grammar for command.
64
Only describes arguments, not options.
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):
78
plugin_name = cmd_object.plugin_name()
79
if plugin_name is None:
82
plugin_name = ' [%s]' % plugin_name
84
cmd_help = cmd_object.help()
86
firstline = cmd_help.split('\n', 1)[0]
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.SECT_HIDDEN)
101
help_topics.topic_registry.register("hidden-commands",
102
_help_commands_to_text,
103
"All hidden commands",
104
help_topics.SECT_HIDDEN)
107
class HelpIndices(object):
108
"""Maintainer of help topics across multiple indices.
110
It is currently separate to the HelpTopicRegistry because of its ordered
111
nature, but possibly we should instead structure it as a search within the
112
registry and add ordering and searching facilities to the registry. The
113
registry would probably need to be restructured to support that cleanly
114
which is why this has been implemented in parallel even though it does as a
115
result permit searching for help in indices which are not discoverable via
118
Each index has a unique prefix string, such as "commands", and contains
119
help topics which can be listed or searched.
67
for aname in cmdclass.takes_args:
69
if aname[-1] in ['$', '+']:
70
aname = aname[:-1] + '...'
71
elif aname[-1] == '?':
72
aname = '[' + aname[:-1] + ']'
73
elif aname[-1] == '*':
74
aname = '[' + aname[:-1] + '...]'
83
def help_on_command(cmdname, outfile = None):
84
cmdname = str(cmdname)
89
from inspect import getdoc
91
topic, cmdclass = commands.get_cmd_class(cmdname)
93
doc = getdoc(cmdclass)
95
raise NotImplementedError("sorry, no detailed help yet for %r" % cmdname)
97
outfile.write('usage: ' + command_usage(topic, cmdclass) + '\n')
100
outfile.write('aliases: ' + ', '.join(cmdclass.aliases) + '\n')
106
help_on_option(cmdclass.takes_options, outfile = None)
109
def help_on_option(options, 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):
129
"""List all 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')
124
help_topics.HelpTopicIndex(),
125
_mod_commands.HelpCommandIndex(),
126
plugin.PluginsHelpIndex(),
129
def _check_prefix_uniqueness(self):
130
"""Ensure that the index collection is able to differentiate safely."""
132
for index in self.search_path:
133
prefixes.setdefault(index.prefix, []).append(index)
134
for prefix, indices in prefixes.items():
136
raise errors.DuplicateHelpPrefix(prefix)
138
def search(self, topic):
139
"""Search for topic across the help search path.
141
:param topic: A string naming the help topic to search for.
142
:raises: NoHelpTopic if none of the indexs in search_path have topic.
143
:return: A list of HelpTopics which matched 'topic'.
145
self._check_prefix_uniqueness()
147
for index in self.search_path:
148
result.extend([(index, _topic) for _topic in index.get_topics(topic)])
150
raise errors.NoHelpTopic(topic)
added
removed
bzrlib/help.py
