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
26
18
"""Bazaar-NG -- a free distributed version-control tool
27
19
http://bazaar-ng.org/
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
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
66
58
help_on_command(topic, outfile = outfile)
69
def command_usage(cmd_object):
61
def command_usage(cmdname, cmdclass):
70
62
"""Return single-line grammar for command.
72
64
Only describes arguments, not options.
74
s = 'bzr ' + cmd_object.name() + ' '
75
for aname in cmd_object.takes_args:
67
for aname in cmdclass.takes_args:
76
68
aname = aname.upper()
77
69
if aname[-1] in ['$', '+']:
78
70
aname = aname[:-1] + '...'
91
def help_on_command(cmdname, outfile=None):
92
from bzrlib.commands import get_cmd_object
83
def help_on_command(cmdname, outfile = None):
94
84
cmdname = str(cmdname)
96
86
if outfile == None:
97
87
outfile = sys.stdout
99
cmd_object = get_cmd_object(cmdname)
89
from inspect import getdoc
91
topic, cmdclass = commands.get_cmd_class(cmdname)
101
doc = cmd_object.help()
93
doc = getdoc(cmdclass)
103
95
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)
97
outfile.write('usage: ' + command_usage(topic, cmdclass) + '\n')
100
outfile.write('aliases: ' + ', '.join(cmdclass.aliases) + '\n')
113
102
outfile.write(doc)
114
103
if doc[-1] != '\n':
115
104
outfile.write('\n')
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()
106
help_on_option(cmdclass.takes_options, outfile = None)
109
def help_on_option(options, outfile = None):
124
115
if outfile == None:
125
116
outfile = sys.stdout
126
118
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):
121
for shortname, longname in commands.SHORT_OPTIONS.items():
123
l += ', -' + shortname
125
outfile.write(l + '\n')
128
def help_commands(outfile = None):
143
129
"""List all commands"""
144
from bzrlib.commands import (builtin_command_names,
145
plugin_command_names,
148
133
if outfile == None:
149
134
outfile = sys.stdout
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:
137
for cmdname, cmdclass in commands.get_all_cmds():
138
accu.append((cmdname, cmdclass))
140
for cmdname, cmdclass in accu:
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
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
