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
25
18
"""Bazaar-NG -- a free distributed version-control tool
26
19
http://bazaar-ng.org/
28
WARNING: This is an unstable development version.
33
bzr init makes this branch versioned
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
46
bzr log show history of changes
47
bzr check validate storage
49
Use e.g. 'bzr help init' for more details, or
50
'bzr help commands' for 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')
57
def help(topic=None, outfile = None):
61
outfile.write(global_help)
62
69
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:
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:
75
94
aname = aname.upper()
76
95
if aname[-1] in ['$', '+']:
77
96
aname = aname[:-1] + '...'
79
98
aname = '[' + aname[:-1] + ']'
80
99
elif aname[-1] == '*':
81
100
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)
116
help_on_options(cmd_object.takes_options, outfile=None)
119
def help_on_options(options, outfile=None):
120
from bzrlib.commands import SHORT_OPTIONS
106
print 'aliases: ' + ', '.join(cmdclass.aliases)
111
help_on_option(cmdclass.takes_options)
114
def help_on_option(options):
128
outfile.write('\noptions:\n')
129
122
for on in options:
131
for shortname, longname in SHORT_OPTIONS.items():
124
for shortname, longname in commands.SHORT_OPTIONS.items():
132
125
if longname == on:
133
126
l += ', -' + shortname
135
outfile.write(l + '\n')
138
def help_commands(outfile=None):
139
132
"""List all commands"""
140
from bzrlib.commands import (builtin_command_names,
141
plugin_command_names,
147
names = set() # to eliminate duplicates
148
names.update(builtin_command_names())
149
names.update(plugin_command_names())
153
for cmd_name in names:
154
cmd_object = get_cmd_object(cmd_name)
155
if cmd_object.hidden:
137
for cmdname, cmdclass in commands.get_all_cmds():
138
accu.append((cmdname, cmdclass))
140
for cmdname, cmdclass in accu:
157
print >>outfile, command_usage(cmd_object)
158
cmd_help = cmd_object.help()
160
firstline = cmd_help.split('\n', 1)[0]
161
print >>outfile, ' ' + firstline
144
help = inspect.getdoc(cmdclass)
146
print " " + help.split('\n', 1)[0]
added
removed
bzrlib/help.py
