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/
31
bzr init makes this directory a versioned branch
32
bzr branch make a copy of another branch
34
bzr add make files or directories versioned
35
bzr ignore ignore a file or pattern
36
bzr mv move or rename a versioned file
38
bzr status summarize changes in working copy
39
bzr diff show detailed diffs
41
bzr merge pull in changes from another branch
42
bzr commit save some or all changes
44
bzr log show history of changes
45
bzr check validate storage
47
bzr help init more help on e.g. init command
48
bzr help commands list all commands
21
**WARNING: THIS IS AN UNSTABLE DEVELOPMENT VERSION**
23
* Metadata format is not stable yet -- you may need to
24
discard history in the future.
26
* Many commands unimplemented or partially implemented.
28
* Space-inefficient storage.
30
* No merge operators yet.
37
Show software version/licence/non-warranty.
39
Start versioning the current directory
43
Show revision history.
46
bzr move FROM... DESTDIR
47
Move one or more files to a different directory.
49
Show changes from last revision to working copy.
50
bzr commit -m 'MESSAGE'
51
Store current state as new revision.
52
bzr export [-r REVNO] DESTINATION
53
Export the branch state at a previous version.
55
Show summary of pending changes.
57
Make a file not versioned.
59
Show statistics about this branch.
61
Verify history is stored safely.
62
(for more type 'bzr help commands')
55
def help(topic=None, outfile = None):
59
outfile.write(global_help)
60
69
elif topic == 'commands':
61
help_commands(outfile = outfile)
63
help_on_command(topic, outfile = outfile)
66
def command_usage(cmd_object):
67
"""Return single-line grammar for command.
69
Only describes arguments, not options.
71
s = 'bzr ' + cmd_object.name() + ' '
72
for aname in cmd_object.takes_args:
72
help_on_command(topic)
75
def help_on_command(cmdname):
76
cmdname = str(cmdname)
78
from inspect import getdoc
80
topic, cmdclass = commands.get_cmd_class(cmdname)
82
doc = getdoc(cmdclass)
84
raise NotImplementedError("sorry, no detailed help yet for %r" % cmdname)
87
short, rest = doc.split('\n', 1)
92
print 'usage: bzr ' + topic,
93
for aname in cmdclass.takes_args:
73
94
aname = aname.upper()
74
95
if aname[-1] in ['$', '+']:
75
96
aname = aname[:-1] + '...'
77
98
aname = '[' + aname[:-1] + ']'
78
99
elif aname[-1] == '*':
79
100
aname = '[' + aname[:-1] + '...]'
88
def help_on_command(cmdname, outfile=None):
89
from bzrlib.commands import get_cmd_object
91
cmdname = str(cmdname)
96
cmd_object = get_cmd_object(cmdname)
98
doc = cmd_object.help()
100
raise NotImplementedError("sorry, no detailed help yet for %r" % cmdname)
102
print >>outfile, 'usage:', command_usage(cmd_object)
104
if cmd_object.aliases:
105
print >>outfile, 'aliases:',
106
print >>outfile, ', '.join(cmd_object.aliases)
113
help_on_command_options(cmd_object, outfile)
116
def help_on_command_options(cmd, outfile=None):
117
from bzrlib.option import Option
118
options = cmd.options()
106
print 'aliases: ' + ', '.join(cmdclass.aliases)
111
help_on_option(cmdclass.takes_options)
114
def help_on_option(options):
123
outfile.write('\noptions:\n')
124
for option_name, option in sorted(options.items()):
125
l = ' --' + option_name
126
if option.type is not None:
127
l += ' ' + option.argname.upper()
128
short_name = option.short_name()
130
assert len(short_name) == 1
131
l += ', -' + short_name
132
l += (30 - len(l)) * ' ' + option.help
133
# TODO: split help over multiple lines with correct indenting and
135
wrapped = textwrap.fill(l, initial_indent='', subsequent_indent=30*' ')
136
outfile.write(wrapped + '\n')
139
def help_commands(outfile=None):
124
for shortname, longname in commands.SHORT_OPTIONS.items():
126
l += ', -' + shortname
140
132
"""List all commands"""
141
from bzrlib.commands import (builtin_command_names,
142
plugin_command_names,
148
names = set() # to eliminate duplicates
149
names.update(builtin_command_names())
150
names.update(plugin_command_names())
154
for cmd_name in names:
155
cmd_object = get_cmd_object(cmd_name)
156
if cmd_object.hidden:
137
for cmdname, cmdclass in commands.get_all_cmds():
138
accu.append((cmdname, cmdclass))
140
for cmdname, cmdclass in accu:
158
print >>outfile, command_usage(cmd_object)
159
cmd_help = cmd_object.help()
161
firstline = cmd_help.split('\n', 1)[0]
162
print >>outfile, ' ' + firstline
144
help = inspect.getdoc(cmdclass)
146
print " " + help.split('\n', 1)[0]
added
removed
bzrlib/help.py
