1
# Copyright (C) 2004, 2005 by Canonical Ltd
1
# Copyright (C) 2005-2011 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., 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.
33
To make a branch, use 'bzr init' in an existing directory, then 'bzr
34
add' to make files versioned. 'bzr add .' will recursively add all
37
'bzr status' describes files that are unknown, ignored, or modified.
38
'bzr diff' shows the text changes to the tree or named files.
39
'bzr commit -m <MESSAGE>' commits all changes in that branch.
41
'bzr move' and 'bzr rename' allow you to rename files or directories.
42
'bzr remove' makes a file unversioned but keeps the working copy;
43
to delete that too simply delete the file.
45
'bzr log' shows a history of changes, and
46
'bzr info' gives summary statistical information.
47
'bzr check' validates all files are stored safely.
49
Files can be ignored by giving a path or a glob in .bzrignore at the
50
top of the tree. Use 'bzr ignored' to see what files are ignored and
51
why, and 'bzr unknowns' to see files that are neither versioned or
54
For more help on any command, type 'bzr help COMMAND', or 'bzr help
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17
from __future__ import absolute_import
19
# TODO: Some way to get a list of external commands (defined by shell
20
# scripts) so that they can be included in the help listing as well.
21
# It should be enough to just list the plugin directory and look for
22
# executable files with reasonable names.
24
# TODO: `help commands --all` should show hidden commands
62
def help(topic=None, outfile = None):
66
outfile.write(global_help)
67
elif topic == 'commands':
68
help_commands(outfile = outfile)
29
commands as _mod_commands,
39
def help(topic=None, outfile=None):
40
"""Write the help for the specific topic to outfile"""
42
outfile = ui.ui_factory.make_output_stream()
44
indices = HelpIndices()
46
alias = _mod_commands.get_alias(topic)
48
topics = indices.search(topic)
50
for index, topic_obj in topics[1:]:
51
shadowed_terms.append('%s%s' % (index.prefix,
52
topic_obj.get_help_topic()))
54
outfile.write(source.get_help_text(shadowed_terms))
55
except errors.NoHelpTopic:
60
outfile.write("'bzr %s' is an alias for 'bzr %s'.\n" % (topic,
64
def help_commands(outfile=None):
65
"""List all commands"""
67
outfile = ui.ui_factory.make_output_stream()
68
outfile.write(_help_commands_to_text('commands'))
71
def _help_commands_to_text(topic):
72
"""Generate the help text for the list of commands"""
74
if topic == 'hidden-commands':
70
help_on_command(topic, outfile = outfile)
73
def command_usage(cmdname, cmdclass):
74
"""Return single-line grammar for command.
76
Only describes arguments, not options.
78
names = list(_mod_commands.all_command_names())
79
commands = ((n, _mod_commands.get_cmd_object(n)) for n in names)
80
shown_commands = [(n, o) for n, o in commands if o.hidden == hidden]
81
max_name = max(len(n) for n, o in shown_commands)
82
indent = ' ' * (max_name + 1)
83
width = osutils.terminal_width()
85
width = osutils.default_terminal_width
86
# we need one extra space for terminals that wrap on last char
89
for cmd_name, cmd_object in sorted(shown_commands):
90
plugin_name = cmd_object.plugin_name()
91
if plugin_name is None:
94
plugin_name = ' [%s]' % plugin_name
96
cmd_help = cmd_object.help()
98
firstline = cmd_help.split('\n', 1)[0]
101
helpstring = '%-*s %s%s' % (max_name, cmd_name, firstline, plugin_name)
102
lines = utextwrap.wrap(
103
helpstring, subsequent_indent=indent,
105
break_long_words=False)
107
out.append(line + '\n')
111
help_topics.topic_registry.register("commands",
112
_help_commands_to_text,
113
"Basic help for all commands",
114
help_topics.SECT_HIDDEN)
115
help_topics.topic_registry.register("hidden-commands",
116
_help_commands_to_text,
117
"All hidden commands",
118
help_topics.SECT_HIDDEN)
121
class HelpIndices(object):
122
"""Maintainer of help topics across multiple indices.
124
It is currently separate to the HelpTopicRegistry because of its ordered
125
nature, but possibly we should instead structure it as a search within the
126
registry and add ordering and searching facilities to the registry. The
127
registry would probably need to be restructured to support that cleanly
128
which is why this has been implemented in parallel even though it does as a
129
result permit searching for help in indices which are not discoverable via
132
Each index has a unique prefix string, such as "commands", and contains
133
help topics which can be listed or searched.
79
for aname in cmdclass.takes_args:
81
if aname[-1] in ['$', '+']:
82
aname = aname[:-1] + '...'
83
elif aname[-1] == '?':
84
aname = '[' + aname[:-1] + ']'
85
elif aname[-1] == '*':
86
aname = '[' + aname[:-1] + '...]'
95
def help_on_command(cmdname, outfile = None):
96
cmdname = str(cmdname)
101
from inspect import getdoc
103
topic, cmdclass = commands.get_cmd_class(cmdname)
105
doc = getdoc(cmdclass)
107
raise NotImplementedError("sorry, no detailed help yet for %r" % cmdname)
109
outfile.write('usage: ' + command_usage(topic, cmdclass) + '\n')
112
outfile.write('aliases: ' + ', '.join(cmdclass.aliases) + '\n')
118
help_on_option(cmdclass.takes_options, outfile = None)
121
def help_on_option(options, outfile = None):
130
outfile.write('\noptions:\n')
133
for shortname, longname in commands.SHORT_OPTIONS.items():
135
l += ', -' + shortname
137
outfile.write(l + '\n')
140
def help_commands(outfile = None):
141
"""List all commands"""
149
for cmdname, cmdclass in commands.get_all_cmds():
150
accu.append((cmdname, cmdclass))
152
for cmdname, cmdclass in accu:
155
outfile.write(command_usage(cmdname, cmdclass) + '\n')
156
help = inspect.getdoc(cmdclass)
158
outfile.write(" " + help.split('\n', 1)[0] + '\n')
138
help_topics.HelpTopicIndex(),
139
_mod_commands.HelpCommandIndex(),
140
plugin.PluginsHelpIndex(),
141
help_topics.ConfigOptionHelpIndex(),
144
def _check_prefix_uniqueness(self):
145
"""Ensure that the index collection is able to differentiate safely."""
147
for index in self.search_path:
148
prefixes.setdefault(index.prefix, []).append(index)
149
for prefix, indices in prefixes.items():
151
raise errors.DuplicateHelpPrefix(prefix)
153
def search(self, topic):
154
"""Search for topic across the help search path.
156
:param topic: A string naming the help topic to search for.
157
:raises: NoHelpTopic if none of the indexs in search_path have topic.
158
:return: A list of HelpTopics which matched 'topic'.
160
self._check_prefix_uniqueness()
162
for index in self.search_path:
163
result.extend([(index, _topic) for _topic in index.get_topics(topic)])
165
raise errors.NoHelpTopic(topic)
added
removed
bzrlib/help.py
