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
20
3
Various useful plugins for working with bzr.
25
from bzrlib.lazy_import import lazy_import
26
lazy_import(globals(), """
27
from bzrlib import help, urlutils
31
from version import version_info, __version__
32
from command import BzrToolsCommand
33
7
from errors import CommandError
34
8
from patchsource import BzrPatchSource
9
from shelf import Shelf
38
import bzrlib.builtins
39
import bzrlib.commands
40
from bzrlib.branch import Branch
41
from bzrlib.bzrdir import BzrDir
42
from bzrlib.commands import get_cmd_object
12
from bzrlib.option import Option
43
14
from bzrlib.errors import BzrCommandError
45
from bzrlib.trace import note
46
from bzrlib.option import Option
47
sys.path.insert(0, os.path.realpath(os.path.join(os.path.dirname(__file__),
51
from command import BzrToolsCommand
53
bzrlib.ignores.add_runtime_ignores(['./.shelf'])
56
class cmd_clean_tree(BzrToolsCommand):
57
"""Remove unwanted files from working tree.
59
By default, only unknown files, not ignored files, are deleted. Versioned
60
files are never deleted.
62
Another class is 'detritus', which includes files emitted by bzr during
63
normal operations and selftests. (The value of these files decreases with
66
If no options are specified, unknown files are deleted. Otherwise, option
67
flags are respected, and may be combined.
69
To check what clean-tree will do, use --dry-run.
15
sys.path.insert(0, os.path.realpath(os.path.join(os.path.dirname(__file__),
17
from bzrlib import DEFAULT_IGNORE
20
DEFAULT_IGNORE.append('./.shelf')
21
DEFAULT_IGNORE.append('./.bzr-shelf*')
24
Option.OPTIONS['ignored'] = Option('ignored',
25
help='delete all ignored files.')
26
Option.OPTIONS['detritus'] = Option('detritus',
27
help='delete conflict files merge backups, and failed selftest dirs.' +
28
'(*.THIS, *.BASE, *.OTHER, *~, *.tmp')
29
Option.OPTIONS['dry-run'] = Option('dry-run',
30
help='show files to delete instead of deleting them.')
32
class cmd_clean_tree(bzrlib.commands.Command):
33
"""Remove unwanted files from working tree. <BZRTOOLS>
34
Normally, ignored files are left alone.
71
takes_options = [Option('ignored', help='Delete all ignored files.'),
72
Option('detritus', help='Delete conflict files, merge'
73
' backups, and failed selftest dirs.'),
75
help='Delete files unknown to bzr (default).'),
76
Option('dry-run', help='Show files to delete instead of'
78
def run(self, unknown=False, ignored=False, detritus=False, dry_run=False):
36
takes_options = ['ignored', 'detritus', 'dry-run']
37
def run(self, ignored=False, detritus=False, dry_run=False):
79
38
from clean_tree import clean_tree
80
if not (unknown or ignored or detritus):
82
clean_tree('.', unknown=unknown, ignored=ignored, detritus=detritus,
86
class cmd_graph_ancestry(BzrToolsCommand):
87
"""Produce ancestry graphs using dot.
39
clean_tree('.', ignored=ignored, detritus=detritus, dry_run=dry_run)
41
Option.OPTIONS['merge-branch'] = Option('merge-branch',type=str)
43
class cmd_graph_ancestry(bzrlib.commands.Command):
44
"""Produce ancestry graphs using dot. <BZRTOOLS>
89
46
Output format is detected according to file extension. Some of the more
90
47
common output formats are html, png, gif, svg, ps. An extension of '.dot'
118
75
If available, rsvg is used to antialias PNG and JPEG output, but this can
119
76
be disabled with --no-antialias.
121
takes_args = ['file', 'merge_branch?']
122
takes_options = [Option('no-collapse', help="Do not skip simple nodes."),
78
takes_args = ['branch', 'file']
79
takes_options = [Option('no-collapse', help="Do not skip simple nodes"),
123
80
Option('no-antialias',
124
help="Do not use rsvg to produce antialiased output."),
125
Option('merge-branch', type=str,
126
help="Use this branch to calcuate a merge base."),
127
Option('cluster', help="Use clustered output."),
128
Option('max-distance',
129
help="Show no nodes farther than this.", type=int),
131
help='Source branch to use (default is current'
136
def run(self, file, merge_branch=None, no_collapse=False,
137
no_antialias=False, cluster=False, max_distance=100,
139
if max_distance == -1:
81
help="Do not use rsvg to produce antialiased output"),
82
Option('merge-branch', type=str,
83
help="Use this branch to calcuate a merge base"),
84
Option('cluster', help="Use clustered output.")]
85
def run(self, branch, file, no_collapse=False, no_antialias=False,
86
merge_branch=None, cluster=False):
143
89
ranking = "cluster"
145
91
ranking = "forced"
146
graph.write_ancestry_file(directory, file, not no_collapse,
147
not no_antialias, merge_branch, ranking,
148
max_distance=max_distance)
151
class cmd_fetch_ghosts(BzrToolsCommand):
152
"""Attempt to retrieve ghosts from another branch.
92
graph.write_ancestry_file(branch, file, not no_collapse,
93
not no_antialias, merge_branch, ranking)
95
class cmd_fetch_ghosts(bzrlib.commands.Command):
96
"""Attempt to retrieve ghosts from another branch. <BZRTOOLS>
153
97
If the other branch is not supplied, the last-pulled branch is used.
155
99
aliases = ['fetch-missing']
156
100
takes_args = ['branch?']
157
takes_options = [Option('no-fix', help="Skip additional synchonization.")]
101
takes_options = [Option('no-fix')]
158
102
def run(self, branch=None, no_fix=False):
159
103
from fetch_ghosts import fetch_ghosts
160
104
fetch_ghosts(branch, no_fix)
162
106
strip_help="""Strip the smallest prefix containing num leading slashes from \
163
107
each file name found in the patch file."""
166
class cmd_patch(BzrToolsCommand):
167
"""Apply a named patch to the current tree.
108
Option.OPTIONS['strip'] = Option('strip', type=int, help=strip_help)
109
Option.OPTIONS['bzrdiff'] = Option('bzrdiff',type=None,
110
help="""Handle extra bzr tags""")
111
class cmd_patch(bzrlib.commands.Command):
112
"""Apply a named patch to the current tree. <BZRTOOLS>
169
114
takes_args = ['filename?']
170
takes_options = [Option('strip', type=int, help=strip_help),
171
Option('silent', help='Suppress chatter.')]
172
def run(self, filename=None, strip=None, silent=False):
115
takes_options = ['strip','bzrdiff']
116
def run(self, filename=None, strip=-1, bzrdiff=0):
173
117
from patch import patch
174
118
from bzrlib.workingtree import WorkingTree
175
119
wt = WorkingTree.open_containing('.')[0]
178
return patch(wt, filename, strip, silent)
181
class cmd_shelve(BzrToolsCommand):
182
"""Temporarily set aside some changes from the current tree.
121
if bzrdiff: strip = 0
124
return patch(wt, filename, strip, legacy= not bzrdiff)
126
class cmd_shelve(bzrlib.commands.Command):
127
"""Temporarily set aside some changes from the current tree. <BZRTOOLS>
184
129
Shelve allows you to temporarily put changes you've made "on the shelf",
185
130
ie. out of the way, until a later time when you can bring them back from
228
162
source = BzrPatchSource(revision, file_list)
229
s = shelf.Shelf(source.base)
230
s.shelve(source, all, message, no_color)
163
s = Shelf(source.base)
164
s.shelve(source, all, message)
234
# The following classes are only used as subcommands for 'shelf', they're
235
# not to be registered directly with bzr.
237
class cmd_shelf_list(bzrlib.commands.Command):
238
"""List the patches on the current shelf."""
239
aliases = ['list', 'ls']
244
class cmd_shelf_delete(bzrlib.commands.Command):
245
"""Delete the patch from the current shelf."""
246
aliases = ['delete', 'del']
247
takes_args = ['patch']
248
def run(self, patch):
249
self.shelf.delete(patch)
252
class cmd_shelf_switch(bzrlib.commands.Command):
253
"""Switch to the other shelf, create it if necessary."""
255
takes_args = ['othershelf']
256
def run(self, othershelf):
257
s = shelf.Shelf(self.shelf.base, othershelf)
261
class cmd_shelf_show(bzrlib.commands.Command):
262
"""Show the contents of the specified or topmost patch."""
263
aliases = ['show', 'cat', 'display']
264
takes_args = ['patch?']
265
def run(self, patch=None):
266
self.shelf.display(patch)
269
class cmd_shelf_upgrade(bzrlib.commands.Command):
270
"""Upgrade old format shelves."""
271
aliases = ['upgrade']
276
class cmd_shelf(BzrToolsCommand):
277
"""Perform various operations on your shelved patches. See also shelve."""
167
class cmd_shelf(bzrlib.commands.Command):
168
"""Perform various operations on your shelved patches. See also shelve.
171
list (ls) List the patches on the current shelf.
172
delete (del) <patch> Delete a patch from the current shelf.
173
switch <shelf> Switch to the named shelf, create it if necessary.
174
show <patch> Show the contents of the specified patch.
175
upgrade Upgrade old format shelves.
278
177
takes_args = ['subcommand', 'args*']
280
subcommands = [cmd_shelf_list, cmd_shelf_delete, cmd_shelf_switch,
281
cmd_shelf_show, cmd_shelf_upgrade]
283
179
def run(self, subcommand, args_list):
286
if args_list is None:
288
cmd = self._get_cmd_object(subcommand)
289
182
source = BzrPatchSource()
290
s = shelf.Shelf(source.base)
293
if args_list is None:
295
return cmd.run_argv_aliases(args_list)
297
def _get_cmd_object(self, cmd_name):
298
for cmd_class in self.subcommands:
299
for alias in cmd_class.aliases:
300
if alias == cmd_name:
302
raise CommandError("Unknown shelf subcommand '%s'" % cmd_name)
305
text = ["%s\n\nSubcommands:\n" % self.__doc__]
307
for cmd_class in self.subcommands:
308
text.extend(self.sub_help(cmd_class) + ['\n'])
312
def sub_help(self, cmd_class):
314
cmd_obj = cmd_class()
317
usage = cmd_obj._usage()
318
usage = usage.replace('bzr shelf-', '')
319
text.append('%s%s\n' % (indent, usage))
321
text.append('%s%s\n' % (2 * indent, cmd_class.__doc__))
323
# Somewhat copied from bzrlib.help.help_on_command_options
325
for option_name, option in sorted(cmd_obj.options().items()):
326
if option_name == 'help':
328
option_help.append('%s--%s' % (3 * indent, option_name))
329
if option.type is not None:
330
option_help.append(' %s' % option.argname.upper())
331
if option.short_name():
332
option_help.append(', -%s' % option.short_name())
333
option_help.append('%s%s\n' % (2 * indent, option.help))
335
if len(option_help) > 0:
336
text.append('%soptions:\n' % (2 * indent))
337
text.extend(option_help)
342
class cmd_unshelve(BzrToolsCommand):
343
"""Restore shelved changes.
345
By default the most recently shelved changes are restored. However if you
346
specify a patch by name those changes will be restored instead.
183
s = Shelf(source.base)
185
if subcommand == 'ls' or subcommand == 'list':
186
self.__check_no_args(args_list, "shelf list takes no arguments!")
188
elif subcommand == 'delete' or subcommand == 'del':
189
self.__check_one_arg(args_list, "shelf delete takes one argument!")
190
s.delete(args_list[0])
191
elif subcommand == 'switch':
192
self.__check_one_arg(args_list, "shelf switch takes one argument!")
193
s = Shelf(source.base, args_list[0])
195
elif subcommand == 'show':
196
self.__check_one_arg(args_list, "shelf show takes one argument!")
197
s.display(args_list[0])
198
elif subcommand == 'upgrade':
199
self.__check_no_args(args_list, "shelf upgrade takes no arguments!")
202
print subcommand, args_list
203
print >>sys.stderr, "Unknown shelf subcommand '%s'" % subcommand
205
def __check_one_arg(self, args, msg):
206
if args is None or len(args) != 1:
207
raise CommandError(msg)
209
def __check_no_args(self, args, msg):
211
raise CommandError(msg)
214
class cmd_unshelve(bzrlib.commands.Command):
215
"""Restore the most recently shelved changes to current tree. <BZRTOOLS>
348
216
See 'shelve' for more information.
350
218
takes_options = [
351
Option('all', help='Unshelve all changes without prompting.'),
352
Option('force', help='Force unshelving even if errors occur.'),
353
Option('no-color', help='Never display changes in color.')
355
takes_args = ['patch?']
356
def run(self, patch=None, all=False, force=False, no_color=False):
219
Option('all', help='Unshelve all changes without prompting'),
220
Option('force', help='Force unshelving even if errors occur'),
222
def run(self, all=False, force=False):
357
223
source = BzrPatchSource()
358
s = shelf.Shelf(source.base)
359
s.unshelve(source, patch, all, force, no_color)
224
s = Shelf(source.base)
225
s.unshelve(source, all, force)
363
class cmd_shell(BzrToolsCommand):
364
"""Begin an interactive shell tailored for bzr.
229
class cmd_shell(bzrlib.commands.Command):
230
"""Begin an interactive shell tailored for bzr. <BZRTOOLS>
365
231
Bzr commands can be used without typing bzr first, and will be run natively
366
232
when possible. Tab completion is tailored for bzr. The shell prompt shows
367
233
the branch nick, revno, and path.
394
259
takes_args = ["branch?"]
395
260
def run(self, branch=None):
396
from branchhistory import branch_history
261
from branchhistory import branch_history
397
262
return branch_history(branch)
400
class cmd_zap(BzrToolsCommand):
265
class cmd_zap(bzrlib.commands.Command):
402
Remove a lightweight checkout, if it can be done safely.
404
This command will remove a lightweight checkout without losing data. That
405
means it only removes lightweight checkouts, and only if they have no
408
If --branch is specified, the branch will be deleted too, but only if the
409
the branch has no new commits (relative to its parent).
267
Remove a checkout, if it can be done safely. <BZRTOOLS>
269
This command will remove a checkout without losing data. That means
270
it only removes checkouts, and only if they have no uncommitted changes.
411
takes_options = [Option("branch", help="Remove associated branch from"
413
Option('force', help='Delete tree even if contents are'
415
272
takes_args = ["checkout"]
416
def run(self, checkout, branch=False, force=False):
273
def run(self, checkout):
417
274
from zap import zap
418
return zap(checkout, remove_branch=branch, allow_modified=force)
421
class cmd_cbranch(BzrToolsCommand):
423
Create a new checkout, associated with a new repository branch.
425
When you cbranch, bzr looks up a target location in locations.conf, and
426
creates the branch there.
428
In your locations.conf, add the following lines:
429
[/working_directory_root]
430
cbranch_target = /branch_root
431
cbranch_target:policy = appendpath
433
This will mean that if you run "bzr cbranch foo/bar foo/baz" in the
434
working directory root, the branch will be created in
435
"/branch_root/foo/baz"
437
NOTE: cbranch also supports "cbranch_root", but that behaviour is
440
takes_options = [Option("lightweight",
441
help="Create a lightweight checkout."), 'revision',
442
Option('files-from', type=unicode,
443
help='Accelerate checkout using files from this'
446
help='Hard-link files from source/files-from tree'
448
takes_args = ["source", "target?"]
449
def run(self, source, target=None, lightweight=False, revision=None,
450
files_from=None, hardlink=False):
278
class cmd_cbranch(bzrlib.commands.Command):
280
Create a new checkout, associated with a new repository branch. <BZRTOOLS>
282
When you cbranch, bzr looks up the repository associated with your current
283
directory in branches.conf. It creates a new branch in that repository
284
with the same name and relative path as the checkout you request.
286
takes_args = ["source", "target"]
287
def run(self, source, target):
451
288
from cbranch import cbranch
452
return cbranch(source, target, lightweight=lightweight,
453
revision=revision, files_from=files_from,
457
class cmd_branches(BzrToolsCommand):
458
"""Scan a location for branches"""
459
takes_args = ["location?"]
460
def run(self, location=None):
461
from branches import branches
462
return branches(location)
464
class cmd_trees(BzrToolsCommand):
465
"""Scan a location for trees"""
466
takes_args = ['location?']
467
def run(self, location='.'):
468
from bzrlib.workingtree import WorkingTree
469
from bzrlib.transport import get_transport
470
t = get_transport(location)
471
for tree in WorkingTree.find_trees(location):
472
self.outf.write('%s\n' % t.relpath(
473
tree.bzrdir.root_transport.base))
475
class cmd_multi_pull(BzrToolsCommand):
476
"""Pull all the branches under a location, e.g. a repository.
478
Both branches present in the directory and the branches of checkouts are
481
takes_args = ["location?"]
482
def run(self, location=None):
483
from bzrlib.transport import get_transport
484
from bzrtools import iter_branch_tree
487
t = get_transport(location)
488
possible_transports = []
490
print "Can't list this type of location."
492
for branch, wt in iter_branch_tree(t):
497
parent = branch.get_parent()
504
if base.startswith(t.base):
505
relpath = base[len(t.base):].rstrip('/')
508
print "Pulling %s from %s" % (relpath, parent)
510
branch_t = get_transport(parent, possible_transports)
511
pullable.pull(Branch.open_from_transport(branch_t))
517
class cmd_import(BzrToolsCommand):
518
"""Import sources from a directory, tarball or zip file
520
This command will import a directory, tarball or zip file into a bzr
521
tree, replacing any versioned files already present. If a directory is
522
specified, it is used as the target. If the directory does not exist, or
523
is not versioned, it is created.
525
Tarballs may be gzip or bzip2 compressed. This is autodetected.
527
If the tarball or zip has a single root directory, that directory is
528
stripped when extracting the tarball. This is not done for directories.
531
takes_args = ['source', 'tree?']
532
def run(self, source, tree=None):
533
from upstream_import import do_import
534
do_import(source, tree)
537
class cmd_cdiff(BzrToolsCommand):
538
"""A color version of bzr's diff"""
539
takes_args = property(lambda x: get_cmd_object('diff').takes_args)
540
takes_options = list(get_cmd_object('diff').takes_options) + [
541
Option('check-style',
542
help='Warn if trailing whitespace or spurious changes have been'
545
def run(self, check_style=False, *args, **kwargs):
546
from colordiff import colordiff
547
colordiff(check_style, *args, **kwargs)
550
class cmd_rspush(BzrToolsCommand):
551
"""Upload this branch to another location using rsync.
553
If no location is specified, the last-used location will be used. To
554
prevent dirty trees from being uploaded, rspush will error out if there are
555
unknown files or local changes. It will also error out if the upstream
556
directory is non-empty and not an earlier version of the branch.
558
takes_args = ['location?']
559
takes_options = [Option('overwrite', help='Ignore differences between'
560
' branches and overwrite unconditionally.'),
561
Option('no-tree', help='Do not push the working tree,'
564
def run(self, location=None, overwrite=False, no_tree=False):
565
from bzrlib import workingtree
567
cur_branch = workingtree.WorkingTree.open_containing(".")[0]
568
bzrtools.rspush(cur_branch, location, overwrite=overwrite,
569
working_tree=not no_tree)
572
class cmd_link_tree(BzrToolsCommand):
573
"""Hardlink matching files to another tree.
575
Only files with identical content and execute bit will be linked.
577
takes_args = ['location']
579
def run(self, location):
580
from bzrlib import workingtree
581
from bzrlib.plugins.bzrtools.link_tree import link_tree
582
target_tree = workingtree.WorkingTree.open_containing(".")[0]
583
source_tree = workingtree.WorkingTree.open(location)
584
target_tree.lock_write()
586
source_tree.lock_read()
588
link_tree(target_tree, source_tree)
594
from heads import cmd_heads
289
return cbranch(source, target)
291
commands = [cmd_shelve, cmd_unshelve, cmd_shelf, cmd_clean_tree,
292
cmd_graph_ancestry, cmd_fetch_ghosts, cmd_patch, cmd_shell,
293
cmd_branch_history, cmd_zap, cmd_cbranch]
296
command_decorators = []
299
import bzrlib.builtins
300
if not hasattr(bzrlib.builtins, "cmd_push"):
301
commands.append(push.cmd_push)
303
command_decorators.append(push.cmd_push)
305
from errors import NoPyBaz
308
commands.append(baz_import.cmd_baz_import_branch)
309
commands.append(baz_import.cmd_baz_import)
312
class cmd_baz_import_branch(bzrlib.commands.Command):
313
"""Disabled. (Requires PyBaz) <BZRTOOLS>"""
314
takes_args = ['to_location?', 'from_branch?', 'reuse_history*']
315
takes_options = ['verbose', Option('max-count', type=int)]
316
def run(self, to_location=None, from_branch=None, fast=False,
317
max_count=None, verbose=False, dry_run=False,
318
reuse_history_list=[]):
319
print "This command is disabled. Please install PyBaz."
322
class cmd_baz_import(bzrlib.commands.Command):
323
"""Disabled. (Requires PyBaz) <BZRTOOLS>"""
324
takes_args = ['to_root_dir?', 'from_archive?', 'reuse_history*']
325
takes_options = ['verbose', Option('prefixes', type=str,
326
help="Prefixes of branches to import")]
327
def run(self, to_root_dir=None, from_archive=None, verbose=False,
328
reuse_history_list=[], prefixes=None):
329
print "This command is disabled. Please install PyBaz."
330
commands.extend((cmd_baz_import_branch, cmd_baz_import))
618
333
if hasattr(bzrlib.commands, 'register_command'):
619
334
for command in commands:
620
335
bzrlib.commands.register_command(command)
336
for command in command_decorators:
337
command._original_command = bzrlib.commands.register_command(
623
341
def test_suite():
624
343
from bzrlib.tests.TestUtil import TestLoader
626
345
from doctest import DocTestSuite, ELLIPSIS
627
346
from unittest import TestSuite
629
import tests.clean_tree
630
import tests.test_dotgraph
631
import tests.is_clean
632
import tests.test_cbranch
633
import tests.test_link_tree
634
import tests.test_patch
635
import tests.test_rspush
636
import tests.upstream_import
638
349
import tests.blackbox
639
350
import tests.shelf_tests
640
351
result = TestSuite()
641
352
result.addTest(DocTestSuite(bzrtools, optionflags=ELLIPSIS))
642
result.addTest(tests.clean_tree.test_suite())
353
result.addTest(clean_tree.test_suite())
354
result.addTest(DocTestSuite(baz_import))
643
355
result.addTest(tests.test_suite())
644
356
result.addTest(TestLoader().loadTestsFromModule(tests.shelf_tests))
645
357
result.addTest(tests.blackbox.test_suite())
646
result.addTest(tests.upstream_import.test_suite())
647
358
result.addTest(zap.test_suite())
648
result.addTest(TestLoader().loadTestsFromModule(tests.test_dotgraph))
649
result.addTest(TestLoader().loadTestsFromModule(tests.is_clean))
650
result.addTest(TestLoader().loadTestsFromModule(tests.test_link_tree))
651
result.addTest(TestLoader().loadTestsFromModule(tests.test_patch))
652
result.addTest(TestLoader().loadTestsFromModule(tests.test_rspush))
653
result.addTest(TestLoader().loadTestsFromModule(tests.test_cbranch))
added
removed
__init__.py
