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
21
from bzrlib.lazy_import import lazy_import
69
22
lazy_import(globals(), """
70
from bzrlib import help
23
from bzrlib import help, urlutils
24
from bzrlib.plugins.bzrtools import shelf
74
from errors import CommandError, NoPyBaz
27
from bzrlib.plugins import bzrtools
28
from command import BzrToolsCommand
29
from errors import CommandError
75
30
from patchsource import BzrPatchSource
79
import bzrlib.builtins
80
32
import bzrlib.commands
33
from bzrlib.branch import Branch
81
34
from bzrlib.commands import get_cmd_object
82
35
from bzrlib.errors import BzrCommandError
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):
36
from bzrlib.option import Option, RegistryOption
39
class cmd_graph_ancestry(BzrToolsCommand):
124
40
"""Produce ancestry graphs using dot.
126
42
Output format is detected according to file extension. Some of the more
127
43
common output formats are html, png, gif, svg, ps. An extension of '.dot'
128
44
will cause a dot graph file to be produced. HTML output has mouseovers
155
71
If available, rsvg is used to antialias PNG and JPEG output, but this can
156
72
be disabled with --no-antialias.
158
takes_args = ['branch', 'file']
159
takes_options = [Option('no-collapse', help="Do not skip simple nodes"),
74
takes_args = ['file', 'merge_branch?']
75
takes_options = [Option('no-collapse', help="Do not skip simple nodes."),
160
76
Option('no-antialias',
161
help="Do not use rsvg to produce antialiased output"),
77
help="Do not use rsvg to produce antialiased output."),
162
78
Option('merge-branch', type=str,
163
help="Use this branch to calcuate a merge base"),
79
help="Use this branch to calcuate a merge base."),
164
80
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):
81
Option('max-distance',
82
help="Show no nodes farther than this.", type=int),
84
help='Source branch to use (default is current'
89
def run(self, file, merge_branch=None, no_collapse=False,
90
no_antialias=False, cluster=False, max_distance=100,
92
if max_distance == -1:
171
96
ranking = "cluster"
173
98
ranking = "forced"
174
graph.write_ancestry_file(branch, file, not no_collapse,
99
graph.write_ancestry_file(directory, file, not no_collapse,
175
100
not no_antialias, merge_branch, ranking,
176
101
max_distance=max_distance)
179
class cmd_fetch_ghosts(bzrlib.commands.Command):
104
class cmd_fetch_ghosts(BzrToolsCommand):
180
105
"""Attempt to retrieve ghosts from another branch.
181
106
If the other branch is not supplied, the last-pulled branch is used.
183
108
aliases = ['fetch-missing']
184
109
takes_args = ['branch?']
185
takes_options = [Option('no-fix')]
110
takes_options = [Option('no-fix', help="Skip additional synchonization.")]
186
111
def run(self, branch=None, no_fix=False):
187
112
from fetch_ghosts import fetch_ghosts
188
fetch_ghosts(branch, no_fix)
113
fetch_ghosts(branch, do_reconcile=not no_fix)
190
115
strip_help="""Strip the smallest prefix containing num leading slashes from \
191
116
each file name found in the patch file."""
194
class cmd_patch(bzrlib.commands.Command):
119
class cmd_patch(BzrToolsCommand):
195
120
"""Apply a named patch to the current tree.
197
122
takes_args = ['filename?']
198
takes_options = [Option('strip', type=int, help=strip_help),
199
Option('silent', help='Suppress chatter')]
123
takes_options = [Option('strip', type=int, short_name='p',
125
Option('silent', help='Suppress chatter.')]
200
126
def run(self, filename=None, strip=None, silent=False):
201
127
from patch import patch
202
128
from bzrlib.workingtree import WorkingTree
206
132
return patch(wt, filename, strip, silent)
209
class cmd_shelve(bzrlib.commands.Command):
135
class cmd_shelve1(BzrToolsCommand):
210
136
"""Temporarily set aside some changes from the current tree.
212
138
Shelve allows you to temporarily put changes you've made "on the shelf",
213
139
ie. out of the way, until a later time when you can bring them back from
214
the shelf with the 'unshelve' command.
140
the shelf with the 'unshelve1' command.
216
142
Shelve is intended to help separate several sets of text changes that have
217
143
been inappropriately mingled. If you just want to get rid of all changes
218
144
(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.
145
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.
147
By default shelve1 asks you what you want to shelve, press '?' at the
148
prompt to get help. To shelve everything run shelve1 --all.
224
150
If filenames are specified, only the changes to those files will be
225
151
shelved, other files will be left untouched.
227
153
If a revision is specified, changes since that revision will be shelved.
229
155
You can put multiple items on the shelf. Normally each time you run
230
unshelve the most recently shelved changes will be reinstated. However,
156
unshelve1 the most recently shelved changes will be reinstated. However,
231
157
you can also unshelve changes in a different order by explicitly
232
specifiying which changes to unshelve. This works best when the changes
158
specifiying which changes to unshelve1. This works best when the changes
233
159
don't depend on each other.
235
161
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.
162
the 'shelf1' command. Run 'bzr shelf1 -h' for more info.
239
165
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')]
166
takes_options = [Option('message',
167
help='A message to associate with the shelved changes.',
168
short_name='m', type=unicode),
170
Option('all', help='Shelve all changes without prompting.'),
171
Option('no-color', help='Never display changes in color.')]
244
173
def run(self, all=False, file_list=None, message=None, revision=None,
433
370
If --branch is specified, the branch will be deleted too, but only if the
434
371
the branch has no new commits (relative to its parent).
373
If bzr-pipeline is also installed, the --store option will store changes
374
in the branch before deleting the tree. To restore the changes, do::
376
bzr checkout --lightweight $BRANCH $CHECKOUT
377
bzr switch-pipe -d $CHECKOUT `bzr nick -d $CHECKOUT`
436
takes_options = [Option("branch", help="Remove associtated branch from"
379
takes_options = [Option("branch", help="Remove associated branch from"
381
RegistryOption('change_policy',
382
'How to handle changed files',
384
('bzrlib.plugins.bzrtools.zap',
385
'change_policy_registry'),
438
388
takes_args = ["checkout"]
439
def run(self, checkout, branch=False):
441
return zap(checkout, remove_branch=branch)
444
class cmd_cbranch(bzrlib.commands.Command):
389
def run(self, checkout, branch=False, change_policy=None):
391
change_policy_registry,
395
if change_policy is None:
396
change_policy = change_policy_registry.get()
397
if change_policy is StoreChanges:
399
import bzrlib.plugins.pipeline
401
raise BzrCommandError('--store requires bzr-pipeline.')
402
return zap(checkout, remove_branch=branch, policy=change_policy)
405
class cmd_cbranch(BzrToolsCommand):
446
407
Create a new checkout, associated with a new repository branch.
463
424
takes_options = [Option("lightweight",
464
help="Create a lightweight checkout"), 'revision']
425
help="Create a lightweight checkout."), 'revision',
426
Option('files-from', type=unicode,
427
help='Accelerate checkout using files from this'
430
help='Hard-link files from source/files-from tree'
465
432
takes_args = ["source", "target?"]
466
def run(self, source, target=None, lightweight=False, revision=None):
433
def run(self, source, target=None, lightweight=False, revision=None,
434
files_from=None, hardlink=False):
467
435
from cbranch import cbranch
468
436
return cbranch(source, target, lightweight=lightweight,
472
class cmd_branches(bzrlib.commands.Command):
437
revision=revision, files_from=files_from,
441
class cmd_list_branches(BzrToolsCommand):
473
442
"""Scan a location for branches"""
445
from bzrlib import commands
446
return commands.plugin_cmds.get_info('list-branches').aliases
474
448
takes_args = ["location?"]
475
449
def run(self, location=None):
476
450
from branches import branches
477
451
return branches(location)
453
class cmd_trees(BzrToolsCommand):
454
"""Scan a location for trees"""
455
takes_args = ['location?']
456
def run(self, location='.'):
457
from bzrlib.workingtree import WorkingTree
458
from bzrlib.transport import get_transport
459
t = get_transport(location)
460
for tree in WorkingTree.find_trees(location):
461
self.outf.write('%s\n' % t.relpath(
462
tree.bzrdir.root_transport.base))
480
class cmd_multi_pull(bzrlib.commands.Command):
464
class cmd_multi_pull(BzrToolsCommand):
481
465
"""Pull all the branches under a location, e.g. a repository.
483
467
Both branches present in the directory and the branches of checkouts are
513
497
print "Pulling %s from %s" % (relpath, parent)
515
pullable.pull(Branch.open(parent))
499
branch_t = get_transport(parent, possible_transports)
500
pullable.pull(Branch.open_from_transport(branch_t))
516
501
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):
506
class cmd_import(BzrToolsCommand):
539
507
"""Import sources from a directory, tarball or zip file
541
509
This command will import a directory, tarball or zip file into a bzr
555
523
do_import(source, tree)
558
class cmd_cdiff(bzrlib.commands.Command):
526
class cmd_cdiff(BzrToolsCommand):
559
527
"""A color version of bzr's diff"""
560
528
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',
529
takes_options = list(get_cmd_object('diff').takes_options) + [
530
RegistryOption.from_kwargs('color',
531
'Color mode to use.',
532
title='Color Mode', value_switches=False, enum_switch=True,
533
never='Never colorize output.',
534
auto='Only colorize output if terminal supports it and STDOUT is a'
536
always='Always colorize output (default).'),
537
Option('check-style',
565
538
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):
541
def run(self, color='always', check_style=False, *args, **kwargs):
572
542
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):
543
colordiff(color, check_style, *args, **kwargs)
546
class cmd_conflict_diff(BzrToolsCommand):
548
"""Compare a conflicted file against BASE."""
550
encoding_type = 'exact'
551
takes_args = ['file*']
553
RegistryOption.from_kwargs('direction', 'Direction of comparison.',
554
value_switches=True, enum_switch=False,
555
other='Compare OTHER against common base.',
556
this='Compare THIS against common base.')]
558
def run(self, file_list, direction='other'):
559
from bzrlib.plugins.bzrtools.colordiff import DiffWriter
560
from conflict_diff import ConflictDiffer
561
dw = DiffWriter(self.outf, check_style=False, color='auto')
562
ConflictDiffer().run(dw, file_list, direction)
565
class cmd_rspush(BzrToolsCommand):
647
566
"""Upload this branch to another location using rsync.
649
568
If no location is specified, the last-used location will be used. To
665
584
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))
587
class cmd_link_tree(BzrToolsCommand):
588
"""Hardlink matching files to another tree.
590
Only files with identical content and execute bit will be linked.
592
takes_args = ['location']
594
def run(self, location):
595
from bzrlib import workingtree
596
from bzrlib.plugins.bzrtools.link_tree import link_tree
597
target_tree = workingtree.WorkingTree.open_containing(".")[0]
598
source_tree = workingtree.WorkingTree.open(location)
599
target_tree.lock_write()
601
source_tree.lock_read()
603
link_tree(target_tree, source_tree)
610
class cmd_create_mirror(BzrToolsCommand):
611
"""Create a mirror of another branch.
613
This is similar to `bzr branch`, but copies more settings, including the
614
submit branch and nickname.
616
It sets the public branch and parent of the target to the source location.
619
takes_args = ['source', 'target']
621
def run(self, source, target):
622
source_branch = Branch.open(source)
623
from bzrlib.plugins.bzrtools.mirror import create_mirror
624
create_mirror(source_branch, target, [])