1
# Copyright (C) 2004, 2005, 2006 by Canonical Ltd
1
# Copyright (C) 2004, 2005 by Canonical Ltd
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
5
5
# the Free Software Foundation; either version 2 of the License, or
6
6
# (at your option) any later version.
8
8
# This program is distributed in the hope that it will be useful,
9
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
11
# GNU General Public License for more details.
13
13
# You should have received a copy of the GNU General Public License
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
"""Bazaar -- a free distributed version-control tool
27
http://bazaar-vcs.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
18
"""Bazaar-NG -- a free distributed version-control tool
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
63
70
help_on_command(topic, outfile = outfile)
66
def command_usage(cmd_object):
73
def command_usage(cmdname, cmdclass):
67
74
"""Return single-line grammar for command.
69
76
Only describes arguments, not options.
71
s = 'bzr ' + cmd_object.name() + ' '
72
for aname in cmd_object.takes_args:
79
for aname in cmdclass.takes_args:
73
80
aname = aname.upper()
74
81
if aname[-1] in ['$', '+']:
75
82
aname = aname[:-1] + '...'
88
def print_command_plugin(cmd_object, outfile, format):
89
"""Print the plugin that provides a command object, if any.
91
If the cmd_object is provided by a plugin, prints the plugin name to
92
outfile using the provided format string.
94
plugin_name = cmd_object.plugin_name()
95
if plugin_name is not None:
96
out_str = '(From plugin "%s")' % plugin_name
97
outfile.write(format % out_str)
100
def help_on_command(cmdname, outfile=None):
101
from bzrlib.commands import get_cmd_object
95
def help_on_command(cmdname, outfile = None):
103
96
cmdname = str(cmdname)
105
98
if outfile == None:
106
99
outfile = sys.stdout
108
cmd_object = get_cmd_object(cmdname)
101
from inspect import getdoc
103
topic, cmdclass = commands.get_cmd_class(cmdname)
110
doc = cmd_object.help()
105
doc = getdoc(cmdclass)
112
107
raise NotImplementedError("sorry, no detailed help yet for %r" % cmdname)
114
print >>outfile, 'usage:', command_usage(cmd_object)
116
if cmd_object.aliases:
117
print >>outfile, 'aliases:',
118
print >>outfile, ', '.join(cmd_object.aliases)
122
print_command_plugin(cmd_object, outfile, '%s\n\n')
109
outfile.write('usage: ' + command_usage(topic, cmdclass) + '\n')
112
outfile.write('aliases: ' + ', '.join(cmdclass.aliases) + '\n')
124
114
outfile.write(doc)
125
115
if doc[-1] != '\n':
126
116
outfile.write('\n')
127
help_on_command_options(cmd_object, outfile)
130
def help_on_command_options(cmd, outfile=None):
131
from bzrlib.option import Option
132
options = cmd.options()
118
help_on_option(cmdclass.takes_options, outfile = None)
121
def help_on_option(options, outfile = None):
135
127
if outfile == None:
136
128
outfile = sys.stdout
137
130
outfile.write('\noptions:\n')
138
for option_name, option in sorted(options.items()):
139
l = ' --' + option_name
140
if option.type is not None:
141
l += ' ' + option.argname.upper()
142
short_name = option.short_name()
144
assert len(short_name) == 1
145
l += ', -' + short_name
146
l += (30 - len(l)) * ' ' + option.help
147
# TODO: split help over multiple lines with correct indenting and
149
wrapped = textwrap.fill(l, initial_indent='', subsequent_indent=30*' ')
150
outfile.write(wrapped + '\n')
153
def help_commands(outfile=None):
133
for shortname, longname in commands.SHORT_OPTIONS.items():
135
l += ', -' + shortname
137
outfile.write(l + '\n')
140
def help_commands(outfile = None):
154
141
"""List all commands"""
155
from bzrlib.commands import (builtin_command_names,
156
plugin_command_names,
159
145
if outfile == None:
160
146
outfile = sys.stdout
162
names = set() # to eliminate duplicates
163
names.update(builtin_command_names())
164
names.update(plugin_command_names())
168
for cmd_name in names:
169
cmd_object = get_cmd_object(cmd_name)
170
if cmd_object.hidden:
149
for cmdname, cmdclass in commands.get_all_cmds():
150
accu.append((cmdname, cmdclass))
152
for cmdname, cmdclass in accu:
172
print >>outfile, command_usage(cmd_object)
174
plugin_name = cmd_object.plugin_name()
175
print_command_plugin(cmd_object, outfile, ' %s\n')
177
cmd_help = cmd_object.help()
179
firstline = cmd_help.split('\n', 1)[0]
180
print >>outfile, ' ' + firstline
155
outfile.write(command_usage(cmdname, cmdclass) + '\n')
156
help = inspect.getdoc(cmdclass)
158
outfile.write(" " + help.split('\n', 1)[0] + '\n')
added
removed
bzrlib/help.py
