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
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
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
70
63
help_on_command(topic, outfile = outfile)
73
def command_usage(cmdname, cmdclass):
66
def command_usage(cmd_object):
74
67
"""Return single-line grammar for command.
76
69
Only describes arguments, not options.
79
for aname in cmdclass.takes_args:
71
s = 'bzr ' + cmd_object.name() + ' '
72
for aname in cmd_object.takes_args:
80
73
aname = aname.upper()
81
74
if aname[-1] in ['$', '+']:
82
75
aname = aname[:-1] + '...'
95
def help_on_command(cmdname, outfile = None):
88
def help_on_command(cmdname, outfile=None):
89
from bzrlib.commands import get_cmd_object
96
91
cmdname = str(cmdname)
98
93
if outfile == None:
99
94
outfile = sys.stdout
101
from inspect import getdoc
103
topic, cmdclass = commands.get_cmd_class(cmdname)
96
cmd_object = get_cmd_object(cmdname)
105
doc = getdoc(cmdclass)
98
doc = cmd_object.help()
107
100
raise NotImplementedError("sorry, no detailed help yet for %r" % cmdname)
109
outfile.write('usage: ' + command_usage(topic, cmdclass) + '\n')
112
outfile.write('aliases: ' + ', '.join(cmdclass.aliases) + '\n')
102
print >>outfile, 'usage:', command_usage(cmd_object)
104
if cmd_object.aliases:
105
print >>outfile, 'aliases:',
106
print >>outfile, ', '.join(cmd_object.aliases)
114
110
outfile.write(doc)
115
111
if doc[-1] != '\n':
116
112
outfile.write('\n')
118
help_on_option(cmdclass.takes_options, outfile = None)
121
def help_on_option(options, outfile = None):
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()
127
121
if outfile == None:
128
122
outfile = sys.stdout
130
123
outfile.write('\noptions:\n')
133
for shortname, longname in commands.SHORT_OPTIONS.items():
135
l += ', -' + shortname
137
outfile.write(l + '\n')
140
def help_commands(outfile = None):
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):
141
140
"""List all commands"""
141
from bzrlib.commands import (builtin_command_names,
142
plugin_command_names,
145
145
if outfile == None:
146
146
outfile = sys.stdout
149
for cmdname, cmdclass in commands.get_all_cmds():
150
accu.append((cmdname, cmdclass))
152
for cmdname, cmdclass in accu:
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:
155
outfile.write(command_usage(cmdname, cmdclass) + '\n')
156
help = inspect.getdoc(cmdclass)
158
outfile.write(" " + help.split('\n', 1)[0] + '\n')
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
added
removed
bzrlib/help.py
