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
24
from bzrlib import osutils
27
"""Bazaar -- a free distributed version-control tool
28
http://bazaar-vcs.org/
18
"""Bazaar-NG -- a free distributed version-control tool
21
WARNING: This is an unstable development version.
32
bzr init makes this directory a versioned branch
33
bzr branch make a copy of another branch
35
bzr add make files or directories versioned
36
bzr ignore ignore a file or pattern
37
bzr mv move or rename a versioned file
39
bzr status summarize changes in working copy
40
bzr diff show detailed diffs
42
bzr merge pull in changes from another branch
43
bzr commit save some or all changes
45
bzr log show history of changes
46
bzr check validate storage
48
bzr help init more help on e.g. init command
49
bzr help commands list all commands
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
64
58
help_on_command(topic, outfile = outfile)
67
def command_usage(cmd_object):
61
def command_usage(cmdname, cmdclass):
68
62
"""Return single-line grammar for command.
70
64
Only describes arguments, not options.
72
s = 'bzr ' + cmd_object.name() + ' '
73
for aname in cmd_object.takes_args:
67
for aname in cmdclass.takes_args:
74
68
aname = aname.upper()
75
69
if aname[-1] in ['$', '+']:
76
70
aname = aname[:-1] + '...'
89
def print_command_plugin(cmd_object, outfile, format):
90
"""Print the plugin that provides a command object, if any.
92
If the cmd_object is provided by a plugin, prints the plugin name to
93
outfile using the provided format string.
95
plugin_name = cmd_object.plugin_name()
96
if plugin_name is not None:
97
out_str = '(From plugin "%s")' % plugin_name
98
outfile.write(format % out_str)
101
def help_on_command(cmdname, outfile=None):
102
from bzrlib.commands import get_cmd_object
83
def help_on_command(cmdname, outfile = None):
104
84
cmdname = str(cmdname)
107
87
outfile = sys.stdout
109
cmd_object = get_cmd_object(cmdname)
89
from inspect import getdoc
91
topic, cmdclass = commands.get_cmd_class(cmdname)
111
doc = cmd_object.help()
93
doc = getdoc(cmdclass)
113
95
raise NotImplementedError("sorry, no detailed help yet for %r" % cmdname)
115
print >>outfile, 'usage:', command_usage(cmd_object)
117
if cmd_object.aliases:
118
print >>outfile, 'aliases:',
119
print >>outfile, ', '.join(cmd_object.aliases)
123
print_command_plugin(cmd_object, outfile, '%s\n\n')
97
outfile.write('usage: ' + command_usage(topic, cmdclass) + '\n')
100
outfile.write('aliases: ' + ', '.join(cmdclass.aliases) + '\n')
125
102
outfile.write(doc)
126
103
if doc[-1] != '\n':
127
104
outfile.write('\n')
128
help_on_command_options(cmd_object, outfile)
131
def help_on_command_options(cmd, outfile=None):
132
from bzrlib.option import Option, get_optparser
106
help_on_option(cmdclass.takes_options, outfile = None)
109
def help_on_option(options, outfile = None):
134
116
outfile = sys.stdout
135
options = cmd.options()
137
outfile.write(get_optparser(options).format_option_help())
140
def help_commands(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):
141
129
"""List all commands"""
142
from bzrlib.commands import (builtin_command_names,
143
plugin_command_names,
146
134
outfile = sys.stdout
147
names = set(builtin_command_names()) # to eliminate duplicates
148
names.update(plugin_command_names())
149
commands = ((n, get_cmd_object(n)) for n in names)
150
shown_commands = [(n, o) for n, o in commands if not o.hidden]
151
max_name = max(len(n) for n, o in shown_commands)
152
indent = ' ' * (max_name + 1)
153
width = osutils.terminal_width() - 1
154
for cmd_name, cmd_object in sorted(shown_commands):
155
plugin_name = cmd_object.plugin_name()
156
if plugin_name is None:
159
plugin_name = ' [%s]' % plugin_name
161
cmd_help = cmd_object.help()
163
firstline = cmd_help.split('\n', 1)[0]
166
helpstring = '%-*s %s%s' % (max_name, cmd_name, firstline, plugin_name)
167
lines = textwrap.wrap(helpstring, subsequent_indent=indent,
170
outfile.write(line + '\n')
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')
added
removed
bzrlib/help.py
