16
16
# along with this program; if not, write to the Free Software
17
17
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
20
Various useful plugins for working with bzr.
26
__version__ = '0.17.0'
29
version_info = tuple(int(n) for n in __version__.split('.'))
32
def check_bzrlib_version(desired):
33
"""Check that bzrlib is compatible.
35
If version is < bzrtools version, assume incompatible.
36
If version == bzrtools version, assume completely compatible
37
If version == bzrtools version + 1, assume compatible, with deprecations
38
Otherwise, assume incompatible.
40
desired_plus = (desired[0], desired[1]+1)
41
bzrlib_version = bzrlib.version_info[:2]
42
if bzrlib_version == desired:
45
from bzrlib.trace import warning
47
# get the message out any way we can
48
from warnings import warn as warning
49
if bzrlib_version < desired:
50
warning('Installed Bazaar version %s is too old to be used with'
52
'"Bzrtools" %s.' % (bzrlib.__version__, __version__))
53
# Not using BzrNewError, because it may not exist.
54
raise Exception, ('Version mismatch', version_info)
56
warning('Plugin "Bzrtools" is not up to date with installed Bazaar'
58
' There should be a newer version of Bzrtools available, e.g.'
60
% (bzrlib.__version__, bzrlib_version[0], bzrlib_version[1]))
61
if bzrlib_version != desired_plus:
62
raise Exception, 'Version mismatch'
65
check_bzrlib_version(version_info[:2])
67
21
from bzrlib.lazy_import import lazy_import
68
22
lazy_import(globals(), """
69
from bzrlib import help
23
from bzrlib import help, urlutils
73
from errors import CommandError, NoPyBaz
27
from command import BzrToolsCommand
28
from errors import CommandError
74
29
from patchsource import BzrPatchSource
78
33
import bzrlib.builtins
79
34
import bzrlib.commands
35
from bzrlib.branch import Branch
36
from bzrlib.bzrdir import BzrDir
80
37
from bzrlib.commands import get_cmd_object
81
38
from bzrlib.errors import BzrCommandError
82
39
import bzrlib.ignores
40
from bzrlib.trace import note
83
41
from bzrlib.option import Option
84
sys.path.insert(0, os.path.realpath(os.path.join(os.path.dirname(__file__),
89
bzrlib.ignores.add_runtime_ignores(['./.shelf'])
92
class cmd_clean_tree(bzrlib.commands.Command):
43
from command import BzrToolsCommand
46
class cmd_clean_tree(BzrToolsCommand):
93
47
"""Remove unwanted files from working tree.
95
49
By default, only unknown files, not ignored files, are deleted. Versioned
105
59
To check what clean-tree will do, use --dry-run.
107
takes_options = [Option('ignored', help='delete all ignored files.'),
108
Option('detritus', help='delete conflict files, merge'
109
' backups, and failed selftest dirs.'),
111
help='delete files unknown to bzr. (default)'),
112
Option('dry-run', help='show files to delete instead of'
114
def run(self, unknown=False, 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,
115
71
from clean_tree import clean_tree
116
72
if not (unknown or ignored or detritus):
118
76
clean_tree('.', unknown=unknown, ignored=ignored, detritus=detritus,
122
class cmd_graph_ancestry(bzrlib.commands.Command):
77
dry_run=dry_run, no_prompt=force)
80
class cmd_graph_ancestry(BzrToolsCommand):
123
81
"""Produce ancestry graphs using dot.
125
83
Output format is detected according to file extension. Some of the more
154
112
If available, rsvg is used to antialias PNG and JPEG output, but this can
155
113
be disabled with --no-antialias.
157
takes_args = ['branch', 'file']
158
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."),
159
117
Option('no-antialias',
160
help="Do not use rsvg to produce antialiased output"),
161
Option('merge-branch', type=str,
162
help="Use this branch to calcuate a merge base"),
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."),
163
121
Option('cluster', help="Use clustered output."),
164
Option('max-distance', help="Show no nodes farther than this",
166
def run(self, branch, file, no_collapse=False, no_antialias=False,
167
merge_branch=None, cluster=False, max_distance=None):
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:
170
137
ranking = "cluster"
172
139
ranking = "forced"
173
graph.write_ancestry_file(branch, file, not no_collapse,
174
not no_antialias, merge_branch, ranking,
140
graph.write_ancestry_file(directory, file, not no_collapse,
141
not no_antialias, merge_branch, ranking,
175
142
max_distance=max_distance)
178
class cmd_fetch_ghosts(bzrlib.commands.Command):
145
class cmd_fetch_ghosts(BzrToolsCommand):
179
146
"""Attempt to retrieve ghosts from another branch.
180
147
If the other branch is not supplied, the last-pulled branch is used.
182
149
aliases = ['fetch-missing']
183
150
takes_args = ['branch?']
184
takes_options = [Option('no-fix')]
151
takes_options = [Option('no-fix', help="Skip additional synchonization.")]
185
152
def run(self, branch=None, no_fix=False):
186
153
from fetch_ghosts import fetch_ghosts
187
154
fetch_ghosts(branch, no_fix)
205
172
return patch(wt, filename, strip, silent)
208
class cmd_shelve(bzrlib.commands.Command):
175
class cmd_shelve1(BzrToolsCommand):
209
176
"""Temporarily set aside some changes from the current tree.
211
178
Shelve allows you to temporarily put changes you've made "on the shelf",
212
179
ie. out of the way, until a later time when you can bring them back from
213
the shelf with the 'unshelve' command.
180
the shelf with the 'unshelve1' command.
215
182
Shelve is intended to help separate several sets of text changes that have
216
183
been inappropriately mingled. If you just want to get rid of all changes
217
184
(text and otherwise) and you don't need to restore them later, use revert.
218
If you want to shelve all text changes at once, use shelve --all.
185
If you want to shelve all text changes at once, use shelve1 --all.
220
By default shelve asks you what you want to shelve, press '?' at the
221
prompt to get help. To shelve everything run shelve --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.
223
190
If filenames are specified, only the changes to those files will be
224
191
shelved, other files will be left untouched.
226
193
If a revision is specified, changes since that revision will be shelved.
228
195
You can put multiple items on the shelf. Normally each time you run
229
unshelve the most recently shelved changes will be reinstated. However,
196
unshelve1 the most recently shelved changes will be reinstated. However,
230
197
you can also unshelve changes in a different order by explicitly
231
specifiying which changes to unshelve. This works best when the changes
198
specifiying which changes to unshelve1. This works best when the changes
232
199
don't depend on each other.
234
201
While you have patches on the shelf you can view and manipulate them with
235
202
the 'shelf' command. Run 'bzr shelf -h' for more info.
238
206
takes_args = ['file*']
239
takes_options = ['message', 'revision',
240
Option('all', help='Shelve all changes without prompting'),
241
Option('no-color', help='Never display changes in color')]
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.')]
243
214
def run(self, all=False, file_list=None, message=None, revision=None,
366
class cmd_unshelve(bzrlib.commands.Command):
337
class cmd_unshelve1(BzrToolsCommand):
367
338
"""Restore shelved changes.
369
340
By default the most recently shelved changes are restored. However if you
370
341
specify a patch by name those changes will be restored instead.
372
See 'shelve' for more information.
343
See 'shelve1' for more information.
345
aliases = ['unshelve']
374
346
takes_options = [
375
Option('all', help='Unshelve all changes without prompting'),
376
Option('force', help='Force unshelving even if errors occur'),
377
Option('no-color', help='Never display changes in color')
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.')
379
351
takes_args = ['patch?']
380
352
def run(self, patch=None, all=False, force=False, no_color=False):
432
404
If --branch is specified, the branch will be deleted too, but only if the
433
405
the branch has no new commits (relative to its parent).
435
takes_options = [Option("branch", help="Remove associtated branch from"
407
takes_options = [Option("branch", help="Remove associated branch from"
409
Option('force', help='Delete tree even if contents are'
437
411
takes_args = ["checkout"]
438
def run(self, checkout, branch=False):
412
def run(self, checkout, branch=False, force=False):
439
413
from zap import zap
440
return zap(checkout, remove_branch=branch)
443
class cmd_cbranch(bzrlib.commands.Command):
414
return zap(checkout, remove_branch=branch, allow_modified=force)
417
class cmd_cbranch(BzrToolsCommand):
445
419
Create a new checkout, associated with a new repository branch.
447
421
When you cbranch, bzr looks up a target location in locations.conf, and
448
422
creates the branch there.
453
427
cbranch_target:policy = appendpath
455
429
This will mean that if you run "bzr cbranch foo/bar foo/baz" in the
456
working directory root, the branch will be created in
430
working directory root, the branch will be created in
457
431
"/branch_root/foo/baz"
459
433
NOTE: cbranch also supports "cbranch_root", but that behaviour is
462
takes_options = [Option("lightweight",
463
help="Create a lightweight checkout"), 'revision']
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'
464
444
takes_args = ["source", "target?"]
465
def run(self, source, target=None, lightweight=False, revision=None):
445
def run(self, source, target=None, lightweight=False, revision=None,
446
files_from=None, hardlink=False):
466
447
from cbranch import cbranch
467
return cbranch(source, target, lightweight=lightweight,
471
class cmd_branches(bzrlib.commands.Command):
448
return cbranch(source, target, lightweight=lightweight,
449
revision=revision, files_from=files_from,
453
class cmd_branches(BzrToolsCommand):
472
454
"""Scan a location for branches"""
473
455
takes_args = ["location?"]
474
456
def run(self, location=None):
475
457
from branches import branches
476
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))
479
class cmd_multi_pull(bzrlib.commands.Command):
471
class cmd_multi_pull(BzrToolsCommand):
480
472
"""Pull all the branches under a location, e.g. a repository.
482
474
Both branches present in the directory and the branches of checkouts are
485
477
takes_args = ["location?"]
486
478
def run(self, location=None):
487
from bzrlib.branch import Branch
488
479
from bzrlib.transport import get_transport
489
480
from bzrtools import iter_branch_tree
490
481
if location is None:
492
483
t = get_transport(location)
484
possible_transports = []
493
485
if not t.listable():
494
486
print "Can't list this type of location."
512
504
print "Pulling %s from %s" % (relpath, parent)
514
pullable.pull(Branch.open(parent))
506
branch_t = get_transport(parent, possible_transports)
507
pullable.pull(Branch.open_from_transport(branch_t))
515
508
except Exception, e:
519
class cmd_branch_mark(bzrlib.commands.Command):
521
Add, view or list branch markers <EXPERIMENTAL>
523
To add a mark, do 'bzr branch-mark MARK'.
524
To list marks, do 'bzr branch-mark' (this lists all marks for the branch's
526
To delete a mark, do 'bzr branch-mark --delete MARK'
528
These marks can be used to track a branch's status.
530
takes_args = ['mark?', 'branch?']
531
takes_options = [Option('delete', help='Delete this mark')]
532
def run(self, mark=None, branch=None, delete=False):
533
from branch_mark import branch_mark
534
branch_mark(mark, branch, delete)
537
class cmd_import(bzrlib.commands.Command):
513
class cmd_import(BzrToolsCommand):
538
514
"""Import sources from a directory, tarball or zip file
540
516
This command will import a directory, tarball or zip file into a bzr
541
517
tree, replacing any versioned files already present. If a directory is
542
518
specified, it is used as the target. If the directory does not exist, or
547
523
If the tarball or zip has a single root directory, that directory is
548
524
stripped when extracting the tarball. This is not done for directories.
551
527
takes_args = ['source', 'tree?']
552
528
def run(self, source, tree=None):
553
529
from upstream_import import do_import
554
530
do_import(source, tree)
557
class cmd_cdiff(bzrlib.commands.Command):
533
class cmd_cdiff(BzrToolsCommand):
558
534
"""A color version of bzr's diff"""
559
535
takes_args = property(lambda x: get_cmd_object('diff').takes_args)
561
def _takes_options(self):
562
options = list(get_cmd_object('diff').takes_options)
563
options.append(Option('check-style',
536
takes_options = list(get_cmd_object('diff').takes_options) + [
537
Option('check-style',
564
538
help='Warn if trailing whitespace or spurious changes have been'
568
takes_options = property(_takes_options)
570
541
def run(self, check_style=False, *args, **kwargs):
571
542
from colordiff import colordiff
572
543
colordiff(check_style, *args, **kwargs)
575
class cmd_baz_import(bzrlib.commands.Command):
576
"""Import an Arch or Baz archive into a bzr repository.
578
This command should be used on local archives (or mirrors) only. It is
579
quite slow on remote archives.
581
reuse_history allows you to specify any previous imports you
582
have done of different archives, which this archive has branches
583
tagged from. This will dramatically reduce the time to convert
584
the archive as it will not have to convert the history already
585
converted in that other branch.
587
If you specify prefixes, only branches whose names start with that prefix
588
will be imported. Skipped branches will be listed, so you can import any
589
branches you missed by accident. Here's an example of doing a partial
590
import from thelove@canonical.com:
591
bzr baz-import thelove thelove@canonical.com --prefixes dists:talloc-except
593
WARNING: Encoding should not be specified unless necessary, because if you
594
specify an encoding, your converted branch will not interoperate with
595
independently-converted branches, unless the other branches were converted
596
with exactly the same encoding. Any encoding recognized by Python may
597
be specified. Aliases are not detected, so 'utf_8', 'U8', 'UTF' and 'utf8'
600
takes_args = ['to_root_dir', 'from_archive', 'reuse_history*']
601
takes_options = ['verbose', Option('prefixes', type=str,
602
help="Prefixes of branches to import, colon-separated"),
603
Option('encoding', type=str,
604
help='Force encoding to specified value. See WARNING.')]
606
def run(self, to_root_dir, from_archive, encoding=None, verbose=False,
607
reuse_history_list=[], prefixes=None):
608
from errors import NoPyBaz
611
baz_import.baz_import(to_root_dir, from_archive, encoding,
612
verbose, reuse_history_list, prefixes)
614
print "This command is disabled. Please install PyBaz."
617
class cmd_baz_import_branch(bzrlib.commands.Command):
618
"""Import an Arch or Baz branch into a bzr branch.
620
WARNING: Encoding should not be specified unless necessary, because if you
621
specify an encoding, your converted branch will not interoperate with
622
independently-converted branches, unless the other branches were converted
623
with exactly the same encoding. Any encoding recognized by Python may
624
be specified. Aliases are not detected, so 'utf_8', 'U8', 'UTF' and 'utf8'
627
takes_args = ['to_location', 'from_branch?', 'reuse_history*']
628
takes_options = ['verbose', Option('max-count', type=int),
629
Option('encoding', type=str,
630
help='Force encoding to specified value. See WARNING.')]
632
def run(self, to_location, from_branch=None, fast=False, max_count=None,
633
encoding=None, verbose=False, dry_run=False,
634
reuse_history_list=[]):
635
from errors import NoPyBaz
638
baz_import.baz_import_branch(to_location, from_branch, fast,
639
max_count, verbose, encoding, dry_run,
642
print "This command is disabled. Please install PyBaz."
645
class cmd_rspush(bzrlib.commands.Command):
546
class cmd_rspush(BzrToolsCommand):
646
547
"""Upload this branch to another location using rsync.
648
If no location is specified, the last-used location will be used. To
649
prevent dirty trees from being uploaded, rspush will error out if there are
650
unknown files or local changes. It will also error out if the upstream
651
directory is non-empty and not an earlier version of the branch.
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.
653
554
takes_args = ['location?']
654
555
takes_options = [Option('overwrite', help='Ignore differences between'
655
' branches and overwrite unconditionally'),
556
' branches and overwrite unconditionally.'),
656
557
Option('no-tree', help='Do not push the working tree,'
657
558
' just the .bzr.')]
660
561
from bzrlib import workingtree
662
563
cur_branch = workingtree.WorkingTree.open_containing(".")[0]
663
bzrtools.rspush(cur_branch, location, overwrite=overwrite,
564
bzrtools.rspush(cur_branch, location, overwrite=overwrite,
664
565
working_tree=not no_tree)
667
class cmd_switch(bzrlib.commands.Command):
668
"""Set the branch of a lightweight checkout and update."""
670
takes_args = ['to_location']
672
def run(self, to_location):
673
from switch import cmd_switch
674
cmd_switch().run(to_location)
679
cmd_baz_import_branch,
701
if hasattr(bzrlib.commands, 'register_command'):
702
for command in commands:
703
bzrlib.commands.register_command(command)
707
from bzrlib.tests.TestUtil import TestLoader
709
from doctest import DocTestSuite, ELLIPSIS
710
from unittest import TestSuite
712
import tests.clean_tree
713
import tests.is_clean
714
import tests.upstream_import
716
import tests.blackbox
717
import tests.shelf_tests
719
result.addTest(DocTestSuite(bzrtools, optionflags=ELLIPSIS))
720
result.addTest(tests.clean_tree.test_suite())
723
result.addTest(DocTestSuite(baz_import))
726
result.addTest(tests.test_suite())
727
result.addTest(TestLoader().loadTestsFromModule(tests.shelf_tests))
728
result.addTest(tests.blackbox.test_suite())
729
result.addTest(tests.upstream_import.test_suite())
730
result.addTest(zap.test_suite())
731
result.addTest(TestLoader().loadTestsFromModule(tests.is_clean))
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)