3
Various useful plugins for working with bzr.
1
# Copyright (C) 2005, 2006, 2007 Aaron Bentley <aaron@aaronbentley.com>
2
# Copyright (C) 2005, 2006 Canonical Limited.
3
# Copyright (C) 2006 Michael Ellerman.
5
# This program is free software; you can redistribute it and/or modify
6
# it under the terms of the GNU General Public License as published by
7
# the Free Software Foundation; either version 2 of the License, or
8
# (at your option) any later version.
10
# This program is distributed in the hope that it will be useful,
11
# but WITHOUT ANY WARRANTY; without even the implied warranty of
12
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13
# GNU General Public License for more details.
15
# You should have received a copy of the GNU General Public License
16
# along with this program; if not, write to the Free Software
17
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
21
from bzrlib.lazy_import import lazy_import
22
lazy_import(globals(), """
23
from bzrlib import help, urlutils
27
from command import BzrToolsCommand
7
28
from errors import CommandError
8
29
from patchsource import BzrPatchSource
9
from shelf import Shelf
33
import bzrlib.builtins
34
import bzrlib.commands
35
from bzrlib.branch import Branch
36
from bzrlib.bzrdir import BzrDir
37
from bzrlib.commands import get_cmd_object
38
from bzrlib.errors import BzrCommandError
40
from bzrlib.trace import note
12
41
from bzrlib.option import Option
14
from bzrlib.errors import BzrCommandError
15
from reweave_inventory import cmd_fix
16
sys.path.insert(0, os.path.realpath(os.path.join(os.path.dirname(__file__),
18
from bzrlib import DEFAULT_IGNORE
21
DEFAULT_IGNORE.append('./.shelf')
22
DEFAULT_IGNORE.append('./.bzr-shelf*')
25
Option.OPTIONS['ignored'] = Option('ignored',
26
help='delete all ignored files.')
27
Option.OPTIONS['detritus'] = Option('detritus',
28
help='delete conflict files merge backups, and failed selftest dirs.' +
29
'(*.THIS, *.BASE, *.OTHER, *~, *.tmp')
30
Option.OPTIONS['dry-run'] = Option('dry-run',
31
help='show files to delete instead of deleting them.')
33
class cmd_clean_tree(bzrlib.commands.Command):
34
"""Remove unwanted files from working tree. <BZRTOOLS>
35
Normally, ignored files are left alone.
43
from command import BzrToolsCommand
46
class cmd_clean_tree(BzrToolsCommand):
47
"""Remove unwanted files from working tree.
49
By default, only unknown files, not ignored files, are deleted. Versioned
50
files are never deleted.
52
Another class is 'detritus', which includes files emitted by bzr during
53
normal operations and selftests. (The value of these files decreases with
56
If no options are specified, unknown files are deleted. Otherwise, option
57
flags are respected, and may be combined.
59
To check what clean-tree will do, use --dry-run.
37
takes_options = ['ignored', 'detritus', 'dry-run']
38
def run(self, ignored=False, detritus=False, dry_run=False):
61
takes_options = [Option('ignored', help='Delete all ignored files.'),
62
Option('detritus', help='Delete conflict files, merge'
63
' backups, and failed selftest dirs.'),
65
help='Delete files unknown to bzr (default).'),
66
Option('dry-run', help='Show files to delete instead of'
68
Option('force', help='Do not prompt before deleting.')]
69
def run(self, unknown=False, ignored=False, detritus=False, dry_run=False,
39
71
from clean_tree import clean_tree
40
clean_tree('.', ignored=ignored, detritus=detritus, dry_run=dry_run)
42
Option.OPTIONS['merge-branch'] = Option('merge-branch',type=str)
44
class cmd_graph_ancestry(bzrlib.commands.Command):
45
"""Produce ancestry graphs using dot. <BZRTOOLS>
72
if not (unknown or ignored or detritus):
76
clean_tree('.', unknown=unknown, ignored=ignored, detritus=detritus,
77
dry_run=dry_run, no_prompt=force)
80
class cmd_graph_ancestry(BzrToolsCommand):
81
"""Produce ancestry graphs using dot.
47
83
Output format is detected according to file extension. Some of the more
48
84
common output formats are html, png, gif, svg, ps. An extension of '.dot'
76
112
If available, rsvg is used to antialias PNG and JPEG output, but this can
77
113
be disabled with --no-antialias.
79
takes_args = ['branch', 'file']
80
takes_options = [Option('no-collapse', help="Do not skip simple nodes"),
115
takes_args = ['file', 'merge_branch?']
116
takes_options = [Option('no-collapse', help="Do not skip simple nodes."),
81
117
Option('no-antialias',
82
help="Do not use rsvg to produce antialiased output"),
83
Option('merge-branch', type=str,
84
help="Use this branch to calcuate a merge base"),
85
Option('cluster', help="Use clustered output.")]
86
def run(self, branch, file, no_collapse=False, no_antialias=False,
87
merge_branch=None, cluster=False):
118
help="Do not use rsvg to produce antialiased output."),
119
Option('merge-branch', type=str,
120
help="Use this branch to calcuate a merge base."),
121
Option('cluster', help="Use clustered output."),
122
Option('max-distance',
123
help="Show no nodes farther than this.", type=int),
125
help='Source branch to use (default is current'
130
def run(self, file, merge_branch=None, no_collapse=False,
131
no_antialias=False, cluster=False, max_distance=100,
133
if max_distance == -1:
90
137
ranking = "cluster"
92
139
ranking = "forced"
93
graph.write_ancestry_file(branch, file, not no_collapse,
94
not no_antialias, merge_branch, ranking)
96
class cmd_fetch_ghosts(bzrlib.commands.Command):
97
"""Attempt to retrieve ghosts from another branch. <BZRTOOLS>
140
graph.write_ancestry_file(directory, file, not no_collapse,
141
not no_antialias, merge_branch, ranking,
142
max_distance=max_distance)
145
class cmd_fetch_ghosts(BzrToolsCommand):
146
"""Attempt to retrieve ghosts from another branch.
98
147
If the other branch is not supplied, the last-pulled branch is used.
100
149
aliases = ['fetch-missing']
101
150
takes_args = ['branch?']
102
takes_options = [Option('no-fix')]
151
takes_options = [Option('no-fix', help="Skip additional synchonization.")]
103
152
def run(self, branch=None, no_fix=False):
104
153
from fetch_ghosts import fetch_ghosts
105
154
fetch_ghosts(branch, no_fix)
107
156
strip_help="""Strip the smallest prefix containing num leading slashes from \
108
157
each file name found in the patch file."""
109
Option.OPTIONS['strip'] = Option('strip', type=int, help=strip_help)
110
Option.OPTIONS['bzrdiff'] = Option('bzrdiff',type=None,
111
help="""Handle extra bzr tags""")
112
class cmd_patch(bzrlib.commands.Command):
113
"""Apply a named patch to the current tree. <BZRTOOLS>
160
class cmd_patch(BzrToolsCommand):
161
"""Apply a named patch to the current tree.
115
163
takes_args = ['filename?']
116
takes_options = ['strip','bzrdiff']
117
def run(self, filename=None, strip=-1, bzrdiff=0):
164
takes_options = [Option('strip', type=int, help=strip_help),
165
Option('silent', help='Suppress chatter.')]
166
def run(self, filename=None, strip=None, silent=False):
118
167
from patch import patch
119
168
from bzrlib.workingtree import WorkingTree
120
169
wt = WorkingTree.open_containing('.')[0]
122
if bzrdiff: strip = 0
125
return patch(wt, filename, strip, legacy= not bzrdiff)
127
class cmd_shelve(bzrlib.commands.Command):
128
"""Temporarily set aside some changes from the current tree. <BZRTOOLS>
172
return patch(wt, filename, strip, silent)
175
class cmd_shelve1(BzrToolsCommand):
176
"""Temporarily set aside some changes from the current tree.
130
178
Shelve allows you to temporarily put changes you've made "on the shelf",
131
179
ie. out of the way, until a later time when you can bring them back from
132
the shelf with the 'unshelve' command.
180
the shelf with the 'unshelve1' command.
134
182
Shelve is intended to help separate several sets of text changes that have
135
183
been inappropriately mingled. If you just want to get rid of all changes
136
184
(text and otherwise) and you don't need to restore them later, use revert.
137
If you want to shelve all text changes at once, use shelve --all.
139
By default shelve asks you what you want to shelve, press '?' at the
140
prompt to get help. To shelve everything run shelve --all.
142
You can put multiple items on the shelf, each time you run unshelve the
143
most recently shelved changes will be reinstated.
185
If you want to shelve all text changes at once, use shelve1 --all.
187
By default shelve1 asks you what you want to shelve, press '?' at the
188
prompt to get help. To shelve everything run shelve1 --all.
145
190
If filenames are specified, only the changes to those files will be
146
191
shelved, other files will be left untouched.
148
193
If a revision is specified, changes since that revision will be shelved.
195
You can put multiple items on the shelf. Normally each time you run
196
unshelve1 the most recently shelved changes will be reinstated. However,
197
you can also unshelve changes in a different order by explicitly
198
specifiying which changes to unshelve1. This works best when the changes
199
don't depend on each other.
201
While you have patches on the shelf you can view and manipulate them with
202
the 'shelf' command. Run 'bzr shelf -h' for more info.
151
206
takes_args = ['file*']
152
takes_options = ['message', 'revision',
153
Option('all', help='Shelve all changes without prompting')]
207
takes_options = [Option('message',
208
help='A message to associate with the shelved changes.',
209
short_name='m', type=unicode),
211
Option('all', help='Shelve all changes without prompting.'),
212
Option('no-color', help='Never display changes in color.')]
155
def run(self, all=False, file_list=None, message=None, revision=None):
214
def run(self, all=False, file_list=None, message=None, revision=None,
156
216
if revision is not None and revision:
157
217
if len(revision) == 1:
158
218
revision = revision[0]
163
223
source = BzrPatchSource(revision, file_list)
164
s = Shelf(source.base)
165
s.shelve(source, all, message)
224
s = shelf.Shelf(source.base)
225
s.shelve(source, all, message, no_color)
168
class cmd_shelf(bzrlib.commands.Command):
169
"""Perform various operations on your shelved patches. See also shelve.
172
list (ls) List the patches on the current shelf.
173
delete (del) <patch> Delete a patch from the current shelf.
174
switch <shelf> Switch to the named shelf, create it if necessary.
175
show <patch> Show the contents of the specified patch.
176
upgrade Upgrade old format shelves.
229
# The following classes are only used as subcommands for 'shelf', they're
230
# not to be registered directly with bzr.
232
class cmd_shelf_list(bzrlib.commands.Command):
233
"""List the patches on the current shelf."""
234
aliases = ['list', 'ls']
239
class cmd_shelf_delete(bzrlib.commands.Command):
240
"""Delete the patch from the current shelf."""
241
aliases = ['delete', 'del']
242
takes_args = ['patch']
243
def run(self, patch):
244
self.shelf.delete(patch)
247
class cmd_shelf_switch(bzrlib.commands.Command):
248
"""Switch to the other shelf, create it if necessary."""
250
takes_args = ['othershelf']
251
def run(self, othershelf):
252
s = shelf.Shelf(self.shelf.base, othershelf)
256
class cmd_shelf_show(bzrlib.commands.Command):
257
"""Show the contents of the specified or topmost patch."""
258
aliases = ['show', 'cat', 'display']
259
takes_args = ['patch?']
260
def run(self, patch=None):
261
self.shelf.display(patch)
264
class cmd_shelf_upgrade(bzrlib.commands.Command):
265
"""Upgrade old format shelves."""
266
aliases = ['upgrade']
271
class cmd_shelf(BzrToolsCommand):
272
"""Perform various operations on your shelved patches. See also shelve1."""
178
273
takes_args = ['subcommand', 'args*']
275
subcommands = [cmd_shelf_list, cmd_shelf_delete, cmd_shelf_switch,
276
cmd_shelf_show, cmd_shelf_upgrade]
180
278
def run(self, subcommand, args_list):
281
if args_list is None:
283
cmd = self._get_cmd_object(subcommand)
183
284
source = BzrPatchSource()
184
s = Shelf(source.base)
186
if subcommand == 'ls' or subcommand == 'list':
187
self.__check_no_args(args_list, "shelf list takes no arguments!")
189
elif subcommand == 'delete' or subcommand == 'del':
190
self.__check_one_arg(args_list, "shelf delete takes one argument!")
191
s.delete(args_list[0])
192
elif subcommand == 'switch':
193
self.__check_one_arg(args_list, "shelf switch takes one argument!")
194
s = Shelf(source.base, args_list[0])
196
elif subcommand == 'show':
197
self.__check_one_arg(args_list, "shelf show takes one argument!")
198
s.display(args_list[0])
199
elif subcommand == 'upgrade':
200
self.__check_no_args(args_list, "shelf upgrade takes no arguments!")
203
print subcommand, args_list
204
print >>sys.stderr, "Unknown shelf subcommand '%s'" % subcommand
206
def __check_one_arg(self, args, msg):
207
if args is None or len(args) != 1:
208
raise CommandError(msg)
210
def __check_no_args(self, args, msg):
212
raise CommandError(msg)
215
class cmd_unshelve(bzrlib.commands.Command):
216
"""Restore the most recently shelved changes to current tree. <BZRTOOLS>
217
See 'shelve' for more information.
285
s = shelf.Shelf(source.base)
288
if args_list is None:
290
return cmd.run_argv_aliases(args_list)
292
def _get_cmd_object(self, cmd_name):
293
for cmd_class in self.subcommands:
294
for alias in cmd_class.aliases:
295
if alias == cmd_name:
297
raise CommandError("Unknown shelf subcommand '%s'" % cmd_name)
300
text = ["%s\n\nSubcommands:\n" % self.__doc__]
302
for cmd_class in self.subcommands:
303
text.extend(self.sub_help(cmd_class) + ['\n'])
307
def sub_help(self, cmd_class):
309
cmd_obj = cmd_class()
312
usage = cmd_obj._usage()
313
usage = usage.replace('bzr shelf-', '')
314
text.append('%s%s\n' % (indent, usage))
316
text.append('%s%s\n' % (2 * indent, cmd_class.__doc__))
318
# Somewhat copied from bzrlib.help.help_on_command_options
320
for option_name, option in sorted(cmd_obj.options().items()):
321
if option_name == 'help':
323
option_help.append('%s--%s' % (3 * indent, option_name))
324
if option.type is not None:
325
option_help.append(' %s' % option.argname.upper())
326
if option.short_name():
327
option_help.append(', -%s' % option.short_name())
328
option_help.append('%s%s\n' % (2 * indent, option.help))
330
if len(option_help) > 0:
331
text.append('%soptions:\n' % (2 * indent))
332
text.extend(option_help)
337
class cmd_unshelve1(BzrToolsCommand):
338
"""Restore shelved changes.
340
By default the most recently shelved changes are restored. However if you
341
specify a patch by name those changes will be restored instead.
343
See 'shelve1' for more information.
345
aliases = ['unshelve']
219
346
takes_options = [
220
Option('all', help='Unshelve all changes without prompting'),
221
Option('force', help='Force unshelving even if errors occur'),
223
def run(self, all=False, force=False):
347
Option('all', help='Unshelve all changes without prompting.'),
348
Option('force', help='Force unshelving even if errors occur.'),
349
Option('no-color', help='Never display changes in color.')
351
takes_args = ['patch?']
352
def run(self, patch=None, all=False, force=False, no_color=False):
224
353
source = BzrPatchSource()
225
s = Shelf(source.base)
226
s.unshelve(source, all, force)
354
s = shelf.Shelf(source.base)
355
s.unshelve(source, patch, all, force, no_color)
230
class cmd_shell(bzrlib.commands.Command):
231
"""Begin an interactive shell tailored for bzr. <BZRTOOLS>
359
class cmd_shell(BzrToolsCommand):
360
"""Begin an interactive shell tailored for bzr.
232
361
Bzr commands can be used without typing bzr first, and will be run natively
233
362
when possible. Tab completion is tailored for bzr. The shell prompt shows
234
363
the branch nick, revno, and path.
260
390
takes_args = ["branch?"]
261
391
def run(self, branch=None):
262
from branchhistory import branch_history
392
from branchhistory import branch_history
263
393
return branch_history(branch)
265
commands = [cmd_shelve, cmd_unshelve, cmd_shelf, cmd_clean_tree,
266
cmd_graph_ancestry, cmd_fetch_ghosts, cmd_patch, cmd_shell,
267
cmd_fix, cmd_branch_history]
269
command_decorators = []
271
command_decorators = []
273
import bzrlib.builtins
274
if not hasattr(bzrlib.builtins, "cmd_push"):
275
commands.append(push.cmd_push)
277
command_decorators.append(push.cmd_push)
279
from errors import NoPyBaz
282
commands.append(baz_import.cmd_baz_import_branch)
283
commands.append(baz_import.cmd_baz_import)
286
class cmd_baz_import_branch(bzrlib.commands.Command):
287
"""Disabled. (Requires PyBaz) <BZRTOOLS>"""
288
takes_args = ['to_location?', 'from_branch?', 'reuse_history*']
289
takes_options = ['verbose', Option('max-count', type=int)]
290
def run(self, to_location=None, from_branch=None, fast=False,
291
max_count=None, verbose=False, dry_run=False,
292
reuse_history_list=[]):
293
print "This command is disabled. Please install PyBaz."
296
class cmd_baz_import(bzrlib.commands.Command):
297
"""Disabled. (Requires PyBaz) <BZRTOOLS>"""
298
takes_args = ['to_root_dir?', 'from_archive?', 'reuse_history*']
299
takes_options = ['verbose', Option('prefixes', type=str,
300
help="Prefixes of branches to import")]
301
def run(self, to_root_dir=None, from_archive=None, verbose=False,
302
reuse_history_list=[], prefixes=None):
303
print "This command is disabled. Please install PyBaz."
304
commands.extend((cmd_baz_import_branch, cmd_baz_import))
307
if hasattr(bzrlib.commands, 'register_command'):
308
for command in commands:
309
bzrlib.commands.register_command(command)
310
for command in command_decorators:
311
command._original_command = bzrlib.commands.register_command(
317
from bzrlib.tests.TestUtil import TestLoader
319
from doctest import DocTestSuite, ELLIPSIS
320
from unittest import TestSuite
322
import tests.blackbox
323
import tests.shelf_tests
325
result.addTest(DocTestSuite(bzrtools, optionflags=ELLIPSIS))
326
result.addTest(clean_tree.test_suite())
327
result.addTest(DocTestSuite(baz_import))
328
result.addTest(tests.test_suite())
329
result.addTest(TestLoader().loadTestsFromModule(tests.shelf_tests))
330
result.addTest(tests.blackbox.test_suite())
396
class cmd_zap(BzrToolsCommand):
398
Remove a lightweight checkout, if it can be done safely.
400
This command will remove a lightweight checkout without losing data. That
401
means it only removes lightweight checkouts, and only if they have no
404
If --branch is specified, the branch will be deleted too, but only if the
405
the branch has no new commits (relative to its parent).
407
takes_options = [Option("branch", help="Remove associated branch from"
409
Option('force', help='Delete tree even if contents are'
411
takes_args = ["checkout"]
412
def run(self, checkout, branch=False, force=False):
414
return zap(checkout, remove_branch=branch, allow_modified=force)
417
class cmd_cbranch(BzrToolsCommand):
419
Create a new checkout, associated with a new repository branch.
421
When you cbranch, bzr looks up a target location in locations.conf, and
422
creates the branch there.
424
In your locations.conf, add the following lines:
425
[/working_directory_root]
426
cbranch_target = /branch_root
427
cbranch_target:policy = appendpath
429
This will mean that if you run "bzr cbranch foo/bar foo/baz" in the
430
working directory root, the branch will be created in
431
"/branch_root/foo/baz"
433
NOTE: cbranch also supports "cbranch_root", but that behaviour is
436
takes_options = [Option("lightweight",
437
help="Create a lightweight checkout."), 'revision',
438
Option('files-from', type=unicode,
439
help='Accelerate checkout using files from this'
442
help='Hard-link files from source/files-from tree'
444
takes_args = ["source", "target?"]
445
def run(self, source, target=None, lightweight=False, revision=None,
446
files_from=None, hardlink=False):
447
from cbranch import cbranch
448
return cbranch(source, target, lightweight=lightweight,
449
revision=revision, files_from=files_from,
453
class cmd_branches(BzrToolsCommand):
454
"""Scan a location for branches"""
455
takes_args = ["location?"]
456
def run(self, location=None):
457
from branches import branches
458
return branches(location)
460
class cmd_trees(BzrToolsCommand):
461
"""Scan a location for trees"""
462
takes_args = ['location?']
463
def run(self, location='.'):
464
from bzrlib.workingtree import WorkingTree
465
from bzrlib.transport import get_transport
466
t = get_transport(location)
467
for tree in WorkingTree.find_trees(location):
468
self.outf.write('%s\n' % t.relpath(
469
tree.bzrdir.root_transport.base))
471
class cmd_multi_pull(BzrToolsCommand):
472
"""Pull all the branches under a location, e.g. a repository.
474
Both branches present in the directory and the branches of checkouts are
477
takes_args = ["location?"]
478
def run(self, location=None):
479
from bzrlib.transport import get_transport
480
from bzrtools import iter_branch_tree
483
t = get_transport(location)
484
possible_transports = []
486
print "Can't list this type of location."
488
for branch, wt in iter_branch_tree(t):
493
parent = branch.get_parent()
500
if base.startswith(t.base):
501
relpath = base[len(t.base):].rstrip('/')
504
print "Pulling %s from %s" % (relpath, parent)
506
branch_t = get_transport(parent, possible_transports)
507
pullable.pull(Branch.open_from_transport(branch_t))
513
class cmd_import(BzrToolsCommand):
514
"""Import sources from a directory, tarball or zip file
516
This command will import a directory, tarball or zip file into a bzr
517
tree, replacing any versioned files already present. If a directory is
518
specified, it is used as the target. If the directory does not exist, or
519
is not versioned, it is created.
521
Tarballs may be gzip or bzip2 compressed. This is autodetected.
523
If the tarball or zip has a single root directory, that directory is
524
stripped when extracting the tarball. This is not done for directories.
527
takes_args = ['source', 'tree?']
528
def run(self, source, tree=None):
529
from upstream_import import do_import
530
do_import(source, tree)
533
class cmd_cdiff(BzrToolsCommand):
534
"""A color version of bzr's diff"""
535
takes_args = property(lambda x: get_cmd_object('diff').takes_args)
536
takes_options = list(get_cmd_object('diff').takes_options) + [
537
Option('check-style',
538
help='Warn if trailing whitespace or spurious changes have been'
541
def run(self, check_style=False, *args, **kwargs):
542
from colordiff import colordiff
543
colordiff(check_style, *args, **kwargs)
546
class cmd_rspush(BzrToolsCommand):
547
"""Upload this branch to another location using rsync.
549
If no location is specified, the last-used location will be used. To
550
prevent dirty trees from being uploaded, rspush will error out if there are
551
unknown files or local changes. It will also error out if the upstream
552
directory is non-empty and not an earlier version of the branch.
554
takes_args = ['location?']
555
takes_options = [Option('overwrite', help='Ignore differences between'
556
' branches and overwrite unconditionally.'),
557
Option('no-tree', help='Do not push the working tree,'
560
def run(self, location=None, overwrite=False, no_tree=False):
561
from bzrlib import workingtree
563
cur_branch = workingtree.WorkingTree.open_containing(".")[0]
564
bzrtools.rspush(cur_branch, location, overwrite=overwrite,
565
working_tree=not no_tree)
568
class cmd_link_tree(BzrToolsCommand):
569
"""Hardlink matching files to another tree.
571
Only files with identical content and execute bit will be linked.
573
takes_args = ['location']
575
def run(self, location):
576
from bzrlib import workingtree
577
from bzrlib.plugins.bzrtools.link_tree import link_tree
578
target_tree = workingtree.WorkingTree.open_containing(".")[0]
579
source_tree = workingtree.WorkingTree.open(location)
580
target_tree.lock_write()
582
source_tree.lock_read()
584
link_tree(target_tree, source_tree)
590
from heads import cmd_heads
added
removed
command_classes.py
