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
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 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
33
def help(topic=None, outfile=None):
34
"""Write the help for the specific topic to outfile"""
41
if topic in help_topics.topic_registry:
42
txt = help_topics.topic_registry.get_detail(topic)
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':
45
help_on_command(topic, outfile=outfile)
48
def command_usage(cmd_object):
66
help_on_command(topic)
69
def command_usage(cmdname, cmdclass):
49
70
"""Return single-line grammar for command.
51
72
Only describes arguments, not options.
53
s = 'bzr ' + cmd_object.name() + ' '
54
for aname in cmd_object.takes_args:
75
for aname in cmdclass.takes_args:
55
76
aname = aname.upper()
56
77
if aname[-1] in ['$', '+']:
57
78
aname = aname[:-1] + '...'
70
def print_command_plugin(cmd_object, outfile, format):
71
"""Print the plugin that provides a command object, if any.
73
If the cmd_object is provided by a plugin, prints the plugin name to
74
outfile using the provided format string.
76
plugin_name = cmd_object.plugin_name()
77
if plugin_name is not None:
78
out_str = '(From plugin "%s")' % plugin_name
79
outfile.write(format % out_str)
82
def help_on_command(cmdname, outfile=None):
83
from bzrlib.commands import get_cmd_object
91
def help_on_command(cmdname):
85
92
cmdname = str(cmdname)
90
cmd_object = get_cmd_object(cmdname)
92
doc = cmd_object.help()
94
from inspect import getdoc
96
topic, cmdclass = commands.get_cmd_class(cmdname)
98
doc = getdoc(cmdclass)
94
100
raise NotImplementedError("sorry, no detailed help yet for %r" % cmdname)
96
print >>outfile, 'usage:', command_usage(cmd_object)
98
if cmd_object.aliases:
99
print >>outfile, 'aliases:',
100
print >>outfile, ', '.join(cmd_object.aliases)
104
print_command_plugin(cmd_object, outfile, '%s\n\n')
109
help_on_command_options(cmd_object, outfile)
112
def help_on_command_options(cmd, outfile=None):
113
from bzrlib.option import Option, get_optparser
116
options = cmd.options()
118
outfile.write(get_optparser(options).format_option_help())
121
def help_commands(outfile=None):
102
print 'usage:', command_usage(topic, cmdclass)
105
print 'aliases: ' + ', '.join(cmdclass.aliases)
109
help_on_option(cmdclass.takes_options)
112
def help_on_option(options):
122
for shortname, longname in commands.SHORT_OPTIONS.items():
124
l += ', -' + shortname
122
130
"""List all commands"""
125
outfile.write(_help_commands_to_text('commands'))
128
def _help_commands_to_text(topic):
129
"""Generate the help text for the list of commands"""
130
from bzrlib.commands import (builtin_command_names,
131
plugin_command_names,
134
if topic == 'hidden-commands':
138
names = set(builtin_command_names()) # to eliminate duplicates
139
names.update(plugin_command_names())
140
commands = ((n, get_cmd_object(n)) for n in names)
141
shown_commands = [(n, o) for n, o in commands if o.hidden == hidden]
142
max_name = max(len(n) for n, o in shown_commands)
143
indent = ' ' * (max_name + 1)
144
width = osutils.terminal_width() - 1
146
for cmd_name, cmd_object in sorted(shown_commands):
147
plugin_name = cmd_object.plugin_name()
148
if plugin_name is None:
151
plugin_name = ' [%s]' % plugin_name
153
cmd_help = cmd_object.help()
155
firstline = cmd_help.split('\n', 1)[0]
158
helpstring = '%-*s %s%s' % (max_name, cmd_name, firstline, plugin_name)
159
lines = textwrap.wrap(helpstring, subsequent_indent=indent,
162
out.append(line + '\n')
166
help_topics.topic_registry.register("commands",
167
_help_commands_to_text,
168
"Basic help for all commands")
169
help_topics.topic_registry.register("hidden-commands",
170
_help_commands_to_text,
171
"All hidden commands")
135
for cmdname, cmdclass in commands.get_all_cmds():
136
accu.append((cmdname, cmdclass))
138
for cmdname, cmdclass in accu:
141
print command_usage(cmdname, cmdclass)
142
help = inspect.getdoc(cmdclass)
144
print " " + help.split('\n', 1)[0]
added
removed
bzrlib/help.py
