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
18
26
"""Bazaar-NG -- a free distributed version-control tool
19
27
http://bazaar-ng.org/
21
WARNING: This is an unstable development version.
29
Please remember to keep backups!
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
43
'bzr help commands' for all commands.
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
58
65
help_on_command(topic, outfile = outfile)
61
def command_usage(cmdname, cmdclass):
68
def command_usage(cmd_object):
62
69
"""Return single-line grammar for command.
64
71
Only describes arguments, not options.
67
for aname in cmdclass.takes_args:
73
s = 'bzr ' + cmd_object.name() + ' '
74
for aname in cmd_object.takes_args:
68
75
aname = aname.upper()
69
76
if aname[-1] in ['$', '+']:
70
77
aname = aname[:-1] + '...'
83
def help_on_command(cmdname, outfile = None):
90
def help_on_command(cmdname, outfile=None):
91
from bzrlib.commands import get_cmd_object
84
93
cmdname = str(cmdname)
86
95
if outfile == None:
87
96
outfile = sys.stdout
89
from inspect import getdoc
91
topic, cmdclass = commands.get_cmd_class(cmdname)
98
cmd_object = get_cmd_object(cmdname)
93
doc = getdoc(cmdclass)
100
doc = cmd_object.help()
95
102
raise NotImplementedError("sorry, no detailed help yet for %r" % cmdname)
97
outfile.write('usage: ' + command_usage(topic, cmdclass) + '\n')
100
outfile.write('aliases: ' + ', '.join(cmdclass.aliases) + '\n')
104
print >>outfile, 'usage:', command_usage(cmd_object)
106
if cmd_object.aliases:
107
print >>outfile, 'aliases:',
108
print >>outfile, ', '.join(cmd_object.aliases)
102
112
outfile.write(doc)
103
113
if doc[-1] != '\n':
104
114
outfile.write('\n')
106
help_on_option(cmdclass.takes_options, outfile = None)
109
def help_on_option(options, outfile = None):
115
help_on_command_options(cmd_object, outfile)
118
def help_on_command_options(cmd, outfile=None):
119
from bzrlib.option import Option
120
options = cmd.options()
115
123
if outfile == None:
116
124
outfile = sys.stdout
118
125
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):
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 += ', -' + short_name
134
l += (30 - len(l)) * ' ' + option.help
135
# TODO: split help over multiple lines with correct indenting and
137
wrapped = textwrap.fill(l, initial_indent='', subsequent_indent=30*' ')
138
outfile.write(wrapped + '\n')
141
def help_commands(outfile=None):
129
142
"""List all commands"""
143
from bzrlib.commands import (builtin_command_names,
144
plugin_command_names,
133
147
if outfile == None:
134
148
outfile = sys.stdout
137
for cmdname, cmdclass in commands.get_all_cmds():
138
accu.append((cmdname, cmdclass))
140
for cmdname, cmdclass in accu:
150
names = set() # to eliminate duplicates
151
names.update(builtin_command_names())
152
names.update(plugin_command_names())
156
for cmd_name in names:
157
cmd_object = get_cmd_object(cmd_name)
158
if cmd_object.hidden:
143
outfile.write(command_usage(cmdname, cmdclass) + '\n')
144
help = inspect.getdoc(cmdclass)
146
outfile.write(" " + help.split('\n', 1)[0] + '\n')
160
print >>outfile, command_usage(cmd_object)
161
cmd_help = cmd_object.help()
163
firstline = cmd_help.split('\n', 1)[0]
164
print >>outfile, ' ' + firstline
added
removed
bzrlib/help.py
