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
# 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
63
elif topic == 'commands':
66
help_on_command(topic)
69
def help_on_command(cmdname):
70
cmdname = str(cmdname)
72
from inspect import getdoc
74
topic, cmdclass = commands.get_cmd_class(cmdname)
76
doc = getdoc(cmdclass)
78
raise NotImplementedError("sorry, no detailed help yet for %r" % cmdname)
81
short, rest = doc.split('\n', 1)
86
print 'usage: bzr ' + topic,
87
for aname in cmdclass.takes_args:
89
if aname[-1] in ['$', '+']:
90
aname = aname[:-1] + '...'
91
elif aname[-1] == '?':
92
aname = '[' + aname[:-1] + ']'
93
elif aname[-1] == '*':
94
aname = '[' + aname[:-1] + '...]'
100
print 'aliases: ' + ', '.join(cmdclass.aliases)
105
help_on_option(cmdclass.takes_options)
108
def help_on_option(options):
118
for shortname, longname in commands.SHORT_OPTIONS.items():
120
l += ', -' + shortname
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):
126
63
"""List all commands"""
131
for cmdname, cmdclass in commands.get_all_cmds():
132
accu.append((cmdname, cmdclass))
134
for cmdname, cmdclass in accu:
138
help = inspect.getdoc(cmdclass)
140
print " " + help.split('\n', 1)[0]
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() - 1
83
for cmd_name, cmd_object in sorted(shown_commands):
84
plugin_name = cmd_object.plugin_name()
85
if plugin_name is None:
88
plugin_name = ' [%s]' % plugin_name
90
cmd_help = cmd_object.help()
92
firstline = cmd_help.split('\n', 1)[0]
95
helpstring = '%-*s %s%s' % (max_name, cmd_name, firstline, plugin_name)
96
lines = textwrap.wrap(
97
helpstring, subsequent_indent=indent,
99
break_long_words=False)
101
out.append(line + '\n')
105
help_topics.topic_registry.register("commands",
106
_help_commands_to_text,
107
"Basic help for all commands",
108
help_topics.SECT_HIDDEN)
109
help_topics.topic_registry.register("hidden-commands",
110
_help_commands_to_text,
111
"All hidden commands",
112
help_topics.SECT_HIDDEN)
115
class HelpIndices(object):
116
"""Maintainer of help topics across multiple indices.
118
It is currently separate to the HelpTopicRegistry because of its ordered
119
nature, but possibly we should instead structure it as a search within the
120
registry and add ordering and searching facilities to the registry. The
121
registry would probably need to be restructured to support that cleanly
122
which is why this has been implemented in parallel even though it does as a
123
result permit searching for help in indices which are not discoverable via
126
Each index has a unique prefix string, such as "commands", and contains
127
help topics which can be listed or searched.
132
help_topics.HelpTopicIndex(),
133
_mod_commands.HelpCommandIndex(),
134
plugin.PluginsHelpIndex(),
137
def _check_prefix_uniqueness(self):
138
"""Ensure that the index collection is able to differentiate safely."""
140
for index in self.search_path:
141
prefixes.setdefault(index.prefix, []).append(index)
142
for prefix, indices in prefixes.items():
144
raise errors.DuplicateHelpPrefix(prefix)
146
def search(self, topic):
147
"""Search for topic across the help search path.
149
:param topic: A string naming the help topic to search for.
150
:raises: NoHelpTopic if none of the indexs in search_path have topic.
151
:return: A list of HelpTopics which matched 'topic'.
153
self._check_prefix_uniqueness()
155
for index in self.search_path:
156
result.extend([(index, _topic) for _topic in index.get_topics(topic)])
158
raise errors.NoHelpTopic(topic)
added
removed
bzrlib/help.py
