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
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 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
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()))
52
outfile.write(source.get_help_text(shadowed_terms))
53
except errors.NoHelpTopic:
58
outfile.write("'bzr %s' is an alias for 'bzr %s'.\n" % (topic,
62
def help_commands(outfile=None):
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**
23
* Metadata format is not stable yet -- you may need to
24
discard history in the future.
26
* Many commands unimplemented or partially implemented.
28
* Space-inefficient storage.
30
* No merge operators yet.
37
Show software version/licence/non-warranty.
39
Start versioning the current directory
43
Show revision history.
46
bzr move FROM... DESTDIR
47
Move one or more files to a different directory.
49
Show changes from last revision to working copy.
50
bzr commit -m 'MESSAGE'
51
Store current state as new revision.
52
bzr export [-r REVNO] DESTINATION
53
Export the branch state at a previous version.
55
Show summary of pending changes.
57
Make a file not versioned.
59
Show statistics about this branch.
61
Verify history is stored safely.
62
(for more type 'bzr help commands')
69
elif topic == 'commands':
72
help_on_command(topic)
75
def help_on_command(cmdname):
76
cmdname = str(cmdname)
78
from inspect import getdoc
80
topic, cmdclass = commands.get_cmd_class(cmdname)
82
doc = getdoc(cmdclass)
84
raise NotImplementedError("sorry, no detailed help yet for %r" % cmdname)
87
short, rest = doc.split('\n', 1)
92
print 'usage: bzr ' + topic,
93
for aname in cmdclass.takes_args:
95
if aname[-1] in ['$', '+']:
96
aname = aname[:-1] + '...'
97
elif aname[-1] == '?':
98
aname = '[' + aname[:-1] + ']'
99
elif aname[-1] == '*':
100
aname = '[' + aname[:-1] + '...]'
106
print 'aliases: ' + ', '.join(cmdclass.aliases)
111
help_on_option(cmdclass.takes_options)
114
def help_on_option(options):
124
for shortname, longname in commands.SHORT_OPTIONS.items():
126
l += ', -' + shortname
63
132
"""List all commands"""
66
outfile.write(_help_commands_to_text('commands'))
69
def _help_commands_to_text(topic):
70
"""Generate the help text for the list of commands"""
72
if topic == 'hidden-commands':
76
names = list(_mod_commands.all_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()
83
width = osutils.default_terminal_width
84
# we need one extra space for terminals that wrap on last char
87
for cmd_name, cmd_object in sorted(shown_commands):
88
plugin_name = cmd_object.plugin_name()
89
if plugin_name is None:
92
plugin_name = ' [%s]' % plugin_name
94
cmd_help = cmd_object.help()
96
firstline = cmd_help.split('\n', 1)[0]
99
helpstring = '%-*s %s%s' % (max_name, cmd_name, firstline, plugin_name)
100
lines = textwrap.wrap(
101
helpstring, subsequent_indent=indent,
103
break_long_words=False)
105
out.append(line + '\n')
109
help_topics.topic_registry.register("commands",
110
_help_commands_to_text,
111
"Basic help for all commands",
112
help_topics.SECT_HIDDEN)
113
help_topics.topic_registry.register("hidden-commands",
114
_help_commands_to_text,
115
"All hidden commands",
116
help_topics.SECT_HIDDEN)
119
class HelpIndices(object):
120
"""Maintainer of help topics across multiple indices.
122
It is currently separate to the HelpTopicRegistry because of its ordered
123
nature, but possibly we should instead structure it as a search within the
124
registry and add ordering and searching facilities to the registry. The
125
registry would probably need to be restructured to support that cleanly
126
which is why this has been implemented in parallel even though it does as a
127
result permit searching for help in indices which are not discoverable via
130
Each index has a unique prefix string, such as "commands", and contains
131
help topics which can be listed or searched.
136
help_topics.HelpTopicIndex(),
137
_mod_commands.HelpCommandIndex(),
138
plugin.PluginsHelpIndex(),
141
def _check_prefix_uniqueness(self):
142
"""Ensure that the index collection is able to differentiate safely."""
144
for index in self.search_path:
145
prefixes.setdefault(index.prefix, []).append(index)
146
for prefix, indices in prefixes.items():
148
raise errors.DuplicateHelpPrefix(prefix)
150
def search(self, topic):
151
"""Search for topic across the help search path.
153
:param topic: A string naming the help topic to search for.
154
:raises: NoHelpTopic if none of the indexs in search_path have topic.
155
:return: A list of HelpTopics which matched 'topic'.
157
self._check_prefix_uniqueness()
159
for index in self.search_path:
160
result.extend([(index, _topic) for _topic in index.get_topics(topic)])
162
raise errors.NoHelpTopic(topic)
137
for cmdname, cmdclass in commands.get_all_cmds():
138
accu.append((cmdname, cmdclass))
140
for cmdname, cmdclass in accu:
144
help = inspect.getdoc(cmdclass)
146
print " " + help.split('\n', 1)[0]
added
removed
bzrlib/help.py
