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
26
"""Bazaar-NG -- a free distributed version-control tool
29
WARNING: This is an unstable development version.
34
bzr init makes this directory a versioned branch
35
bzr branch make a copy of another branch
37
bzr add make files or directories versioned
38
bzr ignore ignore a file or pattern
39
bzr mv move or rename a versioned file
41
bzr status summarize changes in working copy
42
bzr diff show detailed diffs
44
bzr merge pull in changes from another branch
45
bzr commit save some or all changes
47
bzr log show history of changes
48
bzr check validate storage
50
bzr help init more help on e.g. init command
51
bzr help commands list all commands
58
def help(topic=None, outfile = None):
62
outfile.write(global_help)
63
elif topic == 'commands':
64
help_commands(outfile = outfile)
66
help_on_command(topic, outfile = outfile)
69
def command_usage(cmd_object):
70
"""Return single-line grammar for command.
72
Only describes arguments, not options.
74
s = 'bzr ' + cmd_object.name() + ' '
75
for aname in cmd_object.takes_args:
77
if aname[-1] in ['$', '+']:
78
aname = aname[:-1] + '...'
79
elif aname[-1] == '?':
80
aname = '[' + aname[:-1] + ']'
81
elif aname[-1] == '*':
82
aname = '[' + aname[:-1] + '...]'
91
def help_on_command(cmdname, outfile=None):
92
from bzrlib.commands import get_cmd_object
94
cmdname = str(cmdname)
99
cmd_object = get_cmd_object(cmdname)
101
doc = cmd_object.help()
103
raise NotImplementedError("sorry, no detailed help yet for %r" % cmdname)
105
print >>outfile, 'usage:', command_usage(cmd_object)
107
if cmd_object.aliases:
108
print >>outfile, 'aliases:',
109
print >>outfile, ', '.join(cmd_object.aliases)
116
help_on_command_options(cmd_object, outfile)
119
def help_on_command_options(cmd, outfile=None):
120
from bzrlib.option import Option
121
options = cmd.options()
126
outfile.write('\noptions:\n')
127
for option_name, option in sorted(options.items()):
128
l = ' --' + option_name
129
if option.type is not None:
130
l += ' ' + option.argname.upper()
131
short_name = option.short_name()
133
assert len(short_name) == 1
134
l += ', -' + short_name
135
l += (30 - len(l)) * ' ' + option.help
136
# TODO: split help over multiple lines with correct indenting and
138
wrapped = textwrap.fill(l, initial_indent='', subsequent_indent=30*' ')
139
outfile.write(wrapped + '\n')
142
def help_commands(outfile=None):
143
"""List all commands"""
144
from bzrlib.commands import (builtin_command_names,
145
plugin_command_names,
151
names = set() # to eliminate duplicates
152
names.update(builtin_command_names())
153
names.update(plugin_command_names())
157
for cmd_name in names:
158
cmd_object = get_cmd_object(cmd_name)
159
if cmd_object.hidden:
161
print >>outfile, command_usage(cmd_object)
162
cmd_help = cmd_object.help()
164
firstline = cmd_help.split('\n', 1)[0]
165
print >>outfile, ' ' + firstline
added
removed
bzrlib/help.py
