1
# Copyright (C) 2004, 2005 by Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
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
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
25
"""Bazaar-NG -- a free distributed version-control tool
28
WARNING: This is an unstable development version.
33
bzr init makes this directory a versioned branch
34
bzr branch make a copy of another branch
36
bzr add make files or directories versioned
37
bzr ignore ignore a file or pattern
38
bzr mv move or rename a versioned file
40
bzr status summarize changes in working copy
41
bzr diff show detailed diffs
43
bzr merge pull in changes from another branch
44
bzr commit save some or all changes
46
bzr log show history of changes
47
bzr check validate storage
49
bzr help init more help on e.g. init command
50
bzr help commands list all commands
57
def help(topic=None, outfile = None):
61
outfile.write(global_help)
62
elif topic == 'commands':
63
help_commands(outfile = outfile)
65
help_on_command(topic, outfile = outfile)
68
def command_usage(cmd_object):
69
"""Return single-line grammar for command.
71
Only describes arguments, not options.
73
s = 'bzr ' + cmd_object.name() + ' '
74
for aname in cmd_object.takes_args:
76
if aname[-1] in ['$', '+']:
77
aname = aname[:-1] + '...'
78
elif aname[-1] == '?':
79
aname = '[' + aname[:-1] + ']'
80
elif aname[-1] == '*':
81
aname = '[' + aname[:-1] + '...]'
90
def help_on_command(cmdname, outfile=None):
91
from bzrlib.commands import get_cmd_object
93
cmdname = str(cmdname)
98
cmd_object = get_cmd_object(cmdname)
100
doc = cmd_object.help()
102
raise NotImplementedError("sorry, no detailed help yet for %r" % cmdname)
104
print >>outfile, 'usage:', command_usage(cmd_object)
106
if cmd_object.aliases:
107
print >>outfile, 'aliases:',
108
print >>outfile, ', '.join(cmd_object.aliases)
115
help_on_command_options(cmd_object, outfile=None)
118
def help_on_command_options(cmd, outfile=None):
119
from bzrlib.option import Option
120
options = cmd.options()
125
outfile.write('\noptions:\n')
126
for option_name, option in sorted(options.items()):
127
l = ' --' + option_name
128
if option.type is not None:
129
l += ' ' + option.argname.upper()
130
short_name = option.short_name()
132
assert len(short_name) == 1
133
l += ', -' + shortname
134
l += (30 - len(l)) * ' ' + option.help
135
# TODO: split help over multiple lines with correct indenting and
137
outfile.write(l + '\n')
140
def help_commands(outfile=None):
141
"""List all commands"""
142
from bzrlib.commands import (builtin_command_names,
143
plugin_command_names,
149
names = set() # to eliminate duplicates
150
names.update(builtin_command_names())
151
names.update(plugin_command_names())
155
for cmd_name in names:
156
cmd_object = get_cmd_object(cmd_name)
157
if cmd_object.hidden:
159
print >>outfile, command_usage(cmd_object)
160
cmd_help = cmd_object.help()
162
firstline = cmd_help.split('\n', 1)[0]
163
print >>outfile, ' ' + firstline
added
removed
bzrlib/help.py
