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
25
"""Bazaar-NG -- a free distributed version-control tool
19
26
http://bazaar-ng.org/
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.
33
To make a branch, use 'bzr init' in an existing directory, then 'bzr
34
add' to make files versioned. 'bzr add .' will recursively add all
37
'bzr status' describes files that are unknown, ignored, or modified.
38
'bzr diff' shows the text changes to the tree or named files.
39
'bzr commit -m <MESSAGE>' commits all changes in that branch.
41
'bzr move' and 'bzr rename' allow you to rename files or directories.
42
'bzr remove' makes a file unversioned but keeps the working copy;
43
to delete that too simply delete the file.
45
'bzr log' shows a history of changes, and
46
'bzr info' gives summary statistical information.
47
'bzr check' validates all files are stored safely.
49
Files can be ignored by giving a path or a glob in .bzrignore at the
50
top of the tree. Use 'bzr ignored' to see what files are ignored and
51
why, and 'bzr unknowns' to see files that are neither versioned or
54
For more help on any command, type 'bzr help COMMAND', or 'bzr help
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.
57
def help(topic=None, outfile = None):
61
outfile.write(global_help)
63
62
elif topic == 'commands':
63
help_commands(outfile = outfile)
66
help_on_command(topic)
69
def command_usage(cmdname, cmdclass):
65
help_on_command(topic, outfile = outfile)
68
def command_usage(cmd_object):
70
69
"""Return single-line grammar for command.
72
71
Only describes arguments, not options.
75
for aname in cmdclass.takes_args:
73
s = 'bzr ' + cmd_object.name() + ' '
74
for aname in cmd_object.takes_args:
76
75
aname = aname.upper()
77
76
if aname[-1] in ['$', '+']:
78
77
aname = aname[:-1] + '...'
91
def help_on_command(cmdname):
90
def help_on_command(cmdname, outfile=None):
91
from bzrlib.commands import get_cmd_object
92
93
cmdname = str(cmdname)
94
from inspect import getdoc
96
topic, cmdclass = commands.get_cmd_class(cmdname)
98
doc = getdoc(cmdclass)
98
cmd_object = get_cmd_object(cmdname)
100
doc = cmd_object.help()
100
102
raise NotImplementedError("sorry, no detailed help yet for %r" % cmdname)
103
short, rest = doc.split('\n', 1)
108
print 'usage:', command_usage(topic, cmdclass)
111
print 'aliases: ' + ', '.join(cmdclass.aliases)
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_option(cmdclass.takes_options)
119
def help_on_option(options):
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
128
outfile.write('\noptions:\n')
127
129
for on in options:
129
for shortname, longname in commands.SHORT_OPTIONS.items():
131
for shortname, longname in SHORT_OPTIONS.items():
130
132
if longname == on:
131
133
l += ', -' + shortname
135
outfile.write(l + '\n')
138
def help_commands(outfile=None):
137
139
"""List all commands"""
142
for cmdname, cmdclass in commands.get_all_cmds():
143
accu.append((cmdname, cmdclass))
145
for cmdname, cmdclass in accu:
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:
148
print command_usage(cmdname, cmdclass)
149
help = inspect.getdoc(cmdclass)
151
print " " + help.split('\n', 1)[0]
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
added
removed
bzrlib/help.py
