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.18.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 or (bzrlib_version == desired_plus and
43
bzrlib.version_info[3] == 'dev'):
46
from bzrlib.trace import warning
48
# get the message out any way we can
49
from warnings import warn as warning
50
if bzrlib_version < desired:
51
warning('Installed Bazaar version %s is too old to be used with'
53
'"Bzrtools" %s.' % (bzrlib.__version__, __version__))
54
# Not using BzrNewError, because it may not exist.
55
raise Exception, ('Version mismatch', version_info)
57
warning('Plugin "Bzrtools" is not up to date with installed Bazaar'
59
' There should be a newer version of Bzrtools available, e.g.'
61
% (bzrlib.__version__, bzrlib_version[0], bzrlib_version[1]))
62
if bzrlib_version != desired_plus:
63
raise Exception, 'Version mismatch'
66
check_bzrlib_version(version_info[:2])
68
23
from bzrlib.lazy_import import lazy_import
69
24
lazy_import(globals(), """
70
from bzrlib import help
25
from bzrlib import help, urlutils
74
from errors import CommandError, NoPyBaz
29
from command import BzrToolsCommand
30
from errors import CommandError
75
31
from patchsource import BzrPatchSource
79
35
import bzrlib.builtins
80
36
import bzrlib.commands
37
from bzrlib.branch import Branch
38
from bzrlib.bzrdir import BzrDir
81
39
from bzrlib.commands import get_cmd_object
82
40
from bzrlib.errors import BzrCommandError
83
41
import bzrlib.ignores
84
from bzrlib.option import Option
85
sys.path.insert(0, os.path.realpath(os.path.join(os.path.dirname(__file__),
90
bzrlib.ignores.add_runtime_ignores(['./.shelf'])
93
class cmd_clean_tree(bzrlib.commands.Command):
94
"""Remove unwanted files from working tree.
96
By default, only unknown files, not ignored files, are deleted. Versioned
97
files are never deleted.
99
Another class is 'detritus', which includes files emitted by bzr during
100
normal operations and selftests. (The value of these files decreases with
103
If no options are specified, unknown files are deleted. Otherwise, option
104
flags are respected, and may be combined.
106
To check what clean-tree will do, use --dry-run.
108
takes_options = [Option('ignored', help='delete all ignored files.'),
109
Option('detritus', help='delete conflict files, merge'
110
' backups, and failed selftest dirs.'),
112
help='delete files unknown to bzr. (default)'),
113
Option('dry-run', help='show files to delete instead of'
115
def run(self, unknown=False, ignored=False, detritus=False, dry_run=False):
116
from clean_tree import clean_tree
117
if not (unknown or ignored or detritus):
119
clean_tree('.', unknown=unknown, ignored=ignored, detritus=detritus,
123
class cmd_graph_ancestry(bzrlib.commands.Command):
42
from bzrlib.trace import note
43
from bzrlib.option import Option, RegistryOption
44
from bzrlib.workingtree import WorkingTree
46
from command import BzrToolsCommand
49
class cmd_graph_ancestry(BzrToolsCommand):
124
50
"""Produce ancestry graphs using dot.
126
52
Output format is detected according to file extension. Some of the more
127
53
common output formats are html, png, gif, svg, ps. An extension of '.dot'
128
54
will cause a dot graph file to be produced. HTML output has mouseovers
155
81
If available, rsvg is used to antialias PNG and JPEG output, but this can
156
82
be disabled with --no-antialias.
158
takes_args = ['branch', 'file']
159
takes_options = [Option('no-collapse', help="Do not skip simple nodes"),
84
takes_args = ['file', 'merge_branch?']
85
takes_options = [Option('no-collapse', help="Do not skip simple nodes."),
160
86
Option('no-antialias',
161
help="Do not use rsvg to produce antialiased output"),
87
help="Do not use rsvg to produce antialiased output."),
162
88
Option('merge-branch', type=str,
163
help="Use this branch to calcuate a merge base"),
89
help="Use this branch to calcuate a merge base."),
164
90
Option('cluster', help="Use clustered output."),
165
Option('max-distance', help="Show no nodes farther than this",
167
def run(self, branch, file, no_collapse=False, no_antialias=False,
168
merge_branch=None, cluster=False, max_distance=None):
91
Option('max-distance',
92
help="Show no nodes farther than this.", type=int),
94
help='Source branch to use (default is current'
99
def run(self, file, merge_branch=None, no_collapse=False,
100
no_antialias=False, cluster=False, max_distance=100,
102
if max_distance == -1:
171
106
ranking = "cluster"
173
108
ranking = "forced"
174
graph.write_ancestry_file(branch, file, not no_collapse,
109
graph.write_ancestry_file(directory, file, not no_collapse,
175
110
not no_antialias, merge_branch, ranking,
176
111
max_distance=max_distance)
179
class cmd_fetch_ghosts(bzrlib.commands.Command):
114
class cmd_fetch_ghosts(BzrToolsCommand):
180
115
"""Attempt to retrieve ghosts from another branch.
181
116
If the other branch is not supplied, the last-pulled branch is used.
183
118
aliases = ['fetch-missing']
184
119
takes_args = ['branch?']
185
takes_options = [Option('no-fix')]
120
takes_options = [Option('no-fix', help="Skip additional synchonization.")]
186
121
def run(self, branch=None, no_fix=False):
187
122
from fetch_ghosts import fetch_ghosts
188
fetch_ghosts(branch, no_fix)
123
fetch_ghosts(branch, do_reconcile=not no_fix)
190
125
strip_help="""Strip the smallest prefix containing num leading slashes from \
191
126
each file name found in the patch file."""
194
class cmd_patch(bzrlib.commands.Command):
129
class cmd_patch(BzrToolsCommand):
195
130
"""Apply a named patch to the current tree.
197
132
takes_args = ['filename?']
198
takes_options = [Option('strip', type=int, help=strip_help),
199
Option('silent', help='Suppress chatter')]
133
takes_options = [Option('strip', type=int, short_name='p',
135
Option('silent', help='Suppress chatter.')]
200
136
def run(self, filename=None, strip=None, silent=False):
201
137
from patch import patch
202
138
from bzrlib.workingtree import WorkingTree
206
142
return patch(wt, filename, strip, silent)
209
class cmd_shelve(bzrlib.commands.Command):
145
class cmd_shelve1(BzrToolsCommand):
210
146
"""Temporarily set aside some changes from the current tree.
212
148
Shelve allows you to temporarily put changes you've made "on the shelf",
213
149
ie. out of the way, until a later time when you can bring them back from
214
the shelf with the 'unshelve' command.
150
the shelf with the 'unshelve1' command.
216
152
Shelve is intended to help separate several sets of text changes that have
217
153
been inappropriately mingled. If you just want to get rid of all changes
218
154
(text and otherwise) and you don't need to restore them later, use revert.
219
If you want to shelve all text changes at once, use shelve --all.
155
If you want to shelve all text changes at once, use shelve1 --all.
221
By default shelve asks you what you want to shelve, press '?' at the
222
prompt to get help. To shelve everything run shelve --all.
157
By default shelve1 asks you what you want to shelve, press '?' at the
158
prompt to get help. To shelve everything run shelve1 --all.
224
160
If filenames are specified, only the changes to those files will be
225
161
shelved, other files will be left untouched.
227
163
If a revision is specified, changes since that revision will be shelved.
229
165
You can put multiple items on the shelf. Normally each time you run
230
unshelve the most recently shelved changes will be reinstated. However,
166
unshelve1 the most recently shelved changes will be reinstated. However,
231
167
you can also unshelve changes in a different order by explicitly
232
specifiying which changes to unshelve. This works best when the changes
168
specifiying which changes to unshelve1. This works best when the changes
233
169
don't depend on each other.
235
171
While you have patches on the shelf you can view and manipulate them with
236
the 'shelf' command. Run 'bzr shelf -h' for more info.
172
the 'shelf1' command. Run 'bzr shelf1 -h' for more info.
239
175
takes_args = ['file*']
240
takes_options = ['message', 'revision',
241
Option('all', help='Shelve all changes without prompting'),
242
Option('no-color', help='Never display changes in color')]
176
takes_options = [Option('message',
177
help='A message to associate with the shelved changes.',
178
short_name='m', type=unicode),
180
Option('all', help='Shelve all changes without prompting.'),
181
Option('no-color', help='Never display changes in color.')]
244
183
def run(self, all=False, file_list=None, message=None, revision=None,
433
380
If --branch is specified, the branch will be deleted too, but only if the
434
381
the branch has no new commits (relative to its parent).
383
If bzr-pipeline is also installed, the --store option will store changes
384
in the branch before deleting the tree. To restore the changes, do::
386
bzr checkout --lightweight $BRANCH $CHECKOUT
387
bzr switch-pipe -d $CHECKOUT `bzr nick -d $CHECKOUT`
436
takes_options = [Option("branch", help="Remove associtated branch from"
389
takes_options = [Option("branch", help="Remove associated branch from"
391
RegistryOption('change_policy',
392
'How to handle changed files',
394
('bzrlib.plugins.bzrtools.zap',
395
'change_policy_registry'),
438
398
takes_args = ["checkout"]
439
def run(self, checkout, branch=False):
441
return zap(checkout, remove_branch=branch)
444
class cmd_cbranch(bzrlib.commands.Command):
399
def run(self, checkout, branch=False, change_policy=None):
401
change_policy_registry,
405
if change_policy is None:
406
change_policy = change_policy_registry.get()
407
if change_policy is StoreChanges:
409
import bzrlib.plugins.pipeline
411
raise BzrCommandError('--store requires bzr-pipeline.')
412
return zap(checkout, remove_branch=branch, policy=change_policy)
415
class cmd_cbranch(BzrToolsCommand):
446
417
Create a new checkout, associated with a new repository branch.
463
434
takes_options = [Option("lightweight",
464
help="Create a lightweight checkout"), 'revision']
435
help="Create a lightweight checkout."), 'revision',
436
Option('files-from', type=unicode,
437
help='Accelerate checkout using files from this'
440
help='Hard-link files from source/files-from tree'
465
442
takes_args = ["source", "target?"]
466
def run(self, source, target=None, lightweight=False, revision=None):
443
def run(self, source, target=None, lightweight=False, revision=None,
444
files_from=None, hardlink=False):
467
445
from cbranch import cbranch
468
446
return cbranch(source, target, lightweight=lightweight,
472
class cmd_branches(bzrlib.commands.Command):
447
revision=revision, files_from=files_from,
451
class cmd_branches(BzrToolsCommand):
473
452
"""Scan a location for branches"""
474
453
takes_args = ["location?"]
475
454
def run(self, location=None):
476
455
from branches import branches
477
456
return branches(location)
458
class cmd_trees(BzrToolsCommand):
459
"""Scan a location for trees"""
460
takes_args = ['location?']
461
def run(self, location='.'):
462
from bzrlib.workingtree import WorkingTree
463
from bzrlib.transport import get_transport
464
t = get_transport(location)
465
for tree in WorkingTree.find_trees(location):
466
self.outf.write('%s\n' % t.relpath(
467
tree.bzrdir.root_transport.base))
480
class cmd_multi_pull(bzrlib.commands.Command):
469
class cmd_multi_pull(BzrToolsCommand):
481
470
"""Pull all the branches under a location, e.g. a repository.
483
472
Both branches present in the directory and the branches of checkouts are
513
502
print "Pulling %s from %s" % (relpath, parent)
515
pullable.pull(Branch.open(parent))
504
branch_t = get_transport(parent, possible_transports)
505
pullable.pull(Branch.open_from_transport(branch_t))
516
506
except Exception, e:
520
class cmd_branch_mark(bzrlib.commands.Command):
522
Add, view or list branch markers <EXPERIMENTAL>
524
To add a mark, do 'bzr branch-mark MARK'.
525
To list marks, do 'bzr branch-mark' (this lists all marks for the branch's
527
To delete a mark, do 'bzr branch-mark --delete MARK'
529
These marks can be used to track a branch's status.
531
takes_args = ['mark?', 'branch?']
532
takes_options = [Option('delete', help='Delete this mark')]
533
def run(self, mark=None, branch=None, delete=False):
534
from branch_mark import branch_mark
535
branch_mark(mark, branch, delete)
538
class cmd_import(bzrlib.commands.Command):
511
class cmd_import(BzrToolsCommand):
539
512
"""Import sources from a directory, tarball or zip file
541
514
This command will import a directory, tarball or zip file into a bzr
555
528
do_import(source, tree)
558
class cmd_cdiff(bzrlib.commands.Command):
531
class cmd_cdiff(BzrToolsCommand):
559
532
"""A color version of bzr's diff"""
560
533
takes_args = property(lambda x: get_cmd_object('diff').takes_args)
562
def _takes_options(self):
563
options = list(get_cmd_object('diff').takes_options)
564
options.append(Option('check-style',
534
takes_options = list(get_cmd_object('diff').takes_options) + [
535
RegistryOption.from_kwargs('color',
536
'Color mode to use.',
537
title='Color Mode', value_switches=False, enum_switch=True,
538
never='Never colorize output.',
539
auto='Only colorize output if terminal supports it and STDOUT is a'
541
always='Always colorize output (default).'),
542
Option('check-style',
565
543
help='Warn if trailing whitespace or spurious changes have been'
569
takes_options = property(_takes_options)
571
def run(self, check_style=False, *args, **kwargs):
546
def run(self, color='always', check_style=False, *args, **kwargs):
572
547
from colordiff import colordiff
573
colordiff(check_style, *args, **kwargs)
576
class cmd_baz_import(bzrlib.commands.Command):
577
"""Import an Arch or Baz archive into a bzr repository.
579
This command should be used on local archives (or mirrors) only. It is
580
quite slow on remote archives.
582
reuse_history allows you to specify any previous imports you
583
have done of different archives, which this archive has branches
584
tagged from. This will dramatically reduce the time to convert
585
the archive as it will not have to convert the history already
586
converted in that other branch.
588
If you specify prefixes, only branches whose names start with that prefix
589
will be imported. Skipped branches will be listed, so you can import any
590
branches you missed by accident. Here's an example of doing a partial
591
import from thelove@canonical.com:
592
bzr baz-import thelove thelove@canonical.com --prefixes dists:talloc-except
594
WARNING: Encoding should not be specified unless necessary, because if you
595
specify an encoding, your converted branch will not interoperate with
596
independently-converted branches, unless the other branches were converted
597
with exactly the same encoding. Any encoding recognized by Python may
598
be specified. Aliases are not detected, so 'utf_8', 'U8', 'UTF' and 'utf8'
601
takes_args = ['to_root_dir', 'from_archive', 'reuse_history*']
602
takes_options = ['verbose', Option('prefixes', type=str,
603
help="Prefixes of branches to import, colon-separated"),
604
Option('encoding', type=str,
605
help='Force encoding to specified value. See WARNING.')]
607
def run(self, to_root_dir, from_archive, encoding=None, verbose=False,
608
reuse_history_list=[], prefixes=None):
609
from errors import NoPyBaz
612
baz_import.baz_import(to_root_dir, from_archive, encoding,
613
verbose, reuse_history_list, prefixes)
615
print "This command is disabled. Please install PyBaz."
618
class cmd_baz_import_branch(bzrlib.commands.Command):
619
"""Import an Arch or Baz branch into a bzr branch.
621
WARNING: Encoding should not be specified unless necessary, because if you
622
specify an encoding, your converted branch will not interoperate with
623
independently-converted branches, unless the other branches were converted
624
with exactly the same encoding. Any encoding recognized by Python may
625
be specified. Aliases are not detected, so 'utf_8', 'U8', 'UTF' and 'utf8'
628
takes_args = ['to_location', 'from_branch?', 'reuse_history*']
629
takes_options = ['verbose', Option('max-count', type=int),
630
Option('encoding', type=str,
631
help='Force encoding to specified value. See WARNING.')]
633
def run(self, to_location, from_branch=None, fast=False, max_count=None,
634
encoding=None, verbose=False, dry_run=False,
635
reuse_history_list=[]):
636
from errors import NoPyBaz
639
baz_import.baz_import_branch(to_location, from_branch, fast,
640
max_count, verbose, encoding, dry_run,
643
print "This command is disabled. Please install PyBaz."
646
class cmd_rspush(bzrlib.commands.Command):
548
colordiff(color, check_style, *args, **kwargs)
551
class cmd_conflict_diff(BzrToolsCommand):
553
"""Compare a conflicted file against BASE."""
555
encoding_type = 'exact'
556
takes_args = ['file*']
558
RegistryOption.from_kwargs('direction', 'Direction of comparison.',
559
value_switches=True, enum_switch=False,
560
other='Compare OTHER against common base.',
561
this='Compare THIS against common base.')]
563
def run(self, file_list, direction='other'):
564
from bzrlib.plugins.bzrtools.colordiff import DiffWriter
565
from conflict_diff import ConflictDiffer
566
dw = DiffWriter(self.outf, check_style=False, color='auto')
567
ConflictDiffer().run(dw, file_list, direction)
570
class cmd_rspush(BzrToolsCommand):
647
571
"""Upload this branch to another location using rsync.
649
573
If no location is specified, the last-used location will be used. To
665
589
working_tree=not no_tree)
668
class cmd_switch(bzrlib.commands.Command):
669
"""Set the branch of a lightweight checkout and update."""
671
takes_args = ['to_location']
673
def run(self, to_location):
674
from switch import cmd_switch
675
cmd_switch().run(to_location)
680
cmd_baz_import_branch,
702
if hasattr(bzrlib.commands, 'register_command'):
703
for command in commands:
704
bzrlib.commands.register_command(command)
708
from bzrlib.tests.TestUtil import TestLoader
710
from doctest import DocTestSuite, ELLIPSIS
711
from unittest import TestSuite
713
import tests.clean_tree
714
import tests.is_clean
715
import tests.upstream_import
717
import tests.blackbox
718
import tests.shelf_tests
720
result.addTest(DocTestSuite(bzrtools, optionflags=ELLIPSIS))
721
result.addTest(tests.clean_tree.test_suite())
724
result.addTest(DocTestSuite(baz_import))
727
result.addTest(tests.test_suite())
728
result.addTest(TestLoader().loadTestsFromModule(tests.shelf_tests))
729
result.addTest(tests.blackbox.test_suite())
730
result.addTest(tests.upstream_import.test_suite())
731
result.addTest(zap.test_suite())
732
result.addTest(TestLoader().loadTestsFromModule(tests.is_clean))
592
class cmd_link_tree(BzrToolsCommand):
593
"""Hardlink matching files to another tree.
595
Only files with identical content and execute bit will be linked.
597
takes_args = ['location']
599
def run(self, location):
600
from bzrlib import workingtree
601
from bzrlib.plugins.bzrtools.link_tree import link_tree
602
target_tree = workingtree.WorkingTree.open_containing(".")[0]
603
source_tree = workingtree.WorkingTree.open(location)
604
target_tree.lock_write()
606
source_tree.lock_read()
608
link_tree(target_tree, source_tree)
615
class cmd_create_mirror(BzrToolsCommand):
616
"""Create a mirror of another branch.
618
This is similar to `bzr branch`, but copies more settings, including the
619
submit branch and nickname.
621
It sets the public branch and parent of the target to the source location.
624
takes_args = ['source', 'target']
626
def run(self, source, target):
627
source_branch = Branch.open(source)
628
from bzrlib.plugins.bzrtools.mirror import create_mirror
629
create_mirror(source_branch, target, [])