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
23
from bzrlib.lazy_import import lazy_import
24
lazy_import(globals(), """
25
from bzrlib import help, urlutils
29
from command import BzrToolsCommand
7
30
from errors import CommandError
8
31
from patchsource import BzrPatchSource
9
from shelf import Shelf
10
from switch import cmd_switch
13
from bzrlib.option import Option
35
import bzrlib.builtins
36
import bzrlib.commands
37
from bzrlib.branch import Branch
38
from bzrlib.bzrdir import BzrDir
39
from bzrlib.commands import get_cmd_object
15
40
from bzrlib.errors import BzrCommandError
16
sys.path.insert(0, os.path.realpath(os.path.join(os.path.dirname(__file__),
18
from bzrlib import DEFAULT_IGNORE
19
from bzrlib.help import command_usage
22
DEFAULT_IGNORE.append('./.shelf')
23
DEFAULT_IGNORE.append('./.bzr-shelf*')
26
class cmd_clean_tree(bzrlib.commands.Command):
27
"""Remove unwanted files from working tree. <BZRTOOLS>
28
Normally, ignored files are left alone.
30
takes_options = [Option('ignored', help='delete all ignored files.'),
31
Option('detritus', help='delete conflict files merge'
32
' backups, and failed selftest dirs. (*.THIS, '
33
'*.BASE, *.OTHER, *~, *.tmp)'),
34
Option('dry-run', help='show files to delete instead of'
36
def run(self, ignored=False, detritus=False, dry_run=False):
37
from clean_tree import clean_tree
38
clean_tree('.', ignored=ignored, detritus=detritus, dry_run=dry_run)
40
class cmd_graph_ancestry(bzrlib.commands.Command):
41
"""Produce ancestry graphs using dot. <BZRTOOLS>
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):
50
"""Produce ancestry graphs using dot.
43
52
Output format is detected according to file extension. Some of the more
44
53
common output formats are html, png, gif, svg, ps. An extension of '.dot'
72
81
If available, rsvg is used to antialias PNG and JPEG output, but this can
73
82
be disabled with --no-antialias.
75
takes_args = ['branch', 'file']
76
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."),
77
86
Option('no-antialias',
78
help="Do not use rsvg to produce antialiased output"),
79
Option('merge-branch', type=str,
80
help="Use this branch to calcuate a merge base"),
81
Option('cluster', help="Use clustered output.")]
82
def run(self, branch, file, no_collapse=False, no_antialias=False,
83
merge_branch=None, cluster=False):
87
help="Do not use rsvg to produce antialiased output."),
88
Option('merge-branch', type=str,
89
help="Use this branch to calcuate a merge base."),
90
Option('cluster', help="Use clustered output."),
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:
86
106
ranking = "cluster"
88
108
ranking = "forced"
89
graph.write_ancestry_file(branch, file, not no_collapse,
90
not no_antialias, merge_branch, ranking)
92
class cmd_fetch_ghosts(bzrlib.commands.Command):
93
"""Attempt to retrieve ghosts from another branch. <BZRTOOLS>
109
graph.write_ancestry_file(directory, file, not no_collapse,
110
not no_antialias, merge_branch, ranking,
111
max_distance=max_distance)
114
class cmd_fetch_ghosts(BzrToolsCommand):
115
"""Attempt to retrieve ghosts from another branch.
94
116
If the other branch is not supplied, the last-pulled branch is used.
96
118
aliases = ['fetch-missing']
97
119
takes_args = ['branch?']
98
takes_options = [Option('no-fix')]
120
takes_options = [Option('no-fix', help="Skip additional synchonization.")]
99
121
def run(self, branch=None, no_fix=False):
100
122
from fetch_ghosts import fetch_ghosts
101
fetch_ghosts(branch, no_fix)
123
fetch_ghosts(branch, do_reconcile=not no_fix)
103
125
strip_help="""Strip the smallest prefix containing num leading slashes from \
104
126
each file name found in the patch file."""
105
Option.OPTIONS['bzrdiff'] = Option('bzrdiff',type=None,
106
help="""Handle extra bzr tags""")
107
class cmd_patch(bzrlib.commands.Command):
108
"""Apply a named patch to the current tree. <BZRTOOLS>
129
class cmd_patch(BzrToolsCommand):
130
"""Apply a named patch to the current tree.
110
132
takes_args = ['filename?']
111
takes_options = [Option('strip', type=int, help=strip_help)]
112
def run(self, filename=None, strip=-1, bzrdiff=0):
133
takes_options = [Option('strip', type=int, short_name='p',
135
Option('silent', help='Suppress chatter.')]
136
def run(self, filename=None, strip=None, silent=False):
113
137
from patch import patch
114
138
from bzrlib.workingtree import WorkingTree
115
139
wt = WorkingTree.open_containing('.')[0]
117
if bzrdiff: strip = 0
120
return patch(wt, filename, strip, legacy= not bzrdiff)
122
class cmd_shelve(bzrlib.commands.Command):
123
"""Temporarily set aside some changes from the current tree. <BZRTOOLS>
142
return patch(wt, filename, strip, silent)
145
class cmd_shelve1(BzrToolsCommand):
146
"""Temporarily set aside some changes from the current tree.
125
148
Shelve allows you to temporarily put changes you've made "on the shelf",
126
149
ie. out of the way, until a later time when you can bring them back from
127
the shelf with the 'unshelve' command.
150
the shelf with the 'unshelve1' command.
129
152
Shelve is intended to help separate several sets of text changes that have
130
153
been inappropriately mingled. If you just want to get rid of all changes
131
154
(text and otherwise) and you don't need to restore them later, use revert.
132
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.
134
By default shelve asks you what you want to shelve, press '?' at the
135
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.
137
160
If filenames are specified, only the changes to those files will be
138
161
shelved, other files will be left untouched.
271
class cmd_unshelve(bzrlib.commands.Command):
272
"""Restore shelved changes. <BZRTOOLS>
306
class cmd_unshelve1(BzrToolsCommand):
307
"""Restore shelved changes.
274
309
By default the most recently shelved changes are restored. However if you
275
310
specify a patch by name those changes will be restored instead.
277
See 'shelve' for more information.
312
See 'shelve1' for more information.
279
314
takes_options = [
280
Option('all', help='Unshelve all changes without prompting'),
281
Option('force', help='Force unshelving even if errors occur'),
315
Option('all', help='Unshelve all changes without prompting.'),
316
Option('force', help='Force unshelving even if errors occur.'),
317
Option('no-color', help='Never display changes in color.')
283
319
takes_args = ['patch?']
284
def run(self, patch=None, all=False, force=False):
320
def run(self, patch=None, all=False, force=False, no_color=False):
285
321
source = BzrPatchSource()
286
s = Shelf(source.base)
287
s.unshelve(source, patch, all, force)
322
s = shelf.Shelf(source.base)
323
s.unshelve(source, patch, all, force, no_color)
291
class cmd_shell(bzrlib.commands.Command):
292
"""Begin an interactive shell tailored for bzr. <BZRTOOLS>
327
class cmd_shell(BzrToolsCommand):
328
"""Begin an interactive shell tailored for bzr.
293
329
Bzr commands can be used without typing bzr first, and will be run natively
294
330
when possible. Tab completion is tailored for bzr. The shell prompt shows
295
331
the branch nick, revno, and path.
321
358
takes_args = ["branch?"]
322
359
def run(self, branch=None):
323
from branchhistory import branch_history
360
from branchhistory import branch_history
324
361
return branch_history(branch)
327
class cmd_zap(bzrlib.commands.Command):
364
class cmd_zap(BzrToolsCommand):
329
Remove a checkout, if it can be done safely. <BZRTOOLS>
331
This command will remove a checkout without losing data. That means
332
it only removes checkouts, and only if they have no uncommitted changes.
366
Remove a lightweight checkout, if it can be done safely.
368
This command will remove a lightweight checkout without losing data. That
369
means it only removes lightweight checkouts, and only if they have no
372
If --branch is specified, the branch will be deleted too, but only if the
373
the branch has no new commits (relative to its parent).
334
takes_options = [Option("branch", help="Remove associtated branch from"
375
takes_options = [Option("branch", help="Remove associated branch from"
377
Option('force', help='Delete tree even if contents are'
336
379
takes_args = ["checkout"]
337
def run(self, checkout, branch=False):
380
def run(self, checkout, branch=False, force=False):
338
381
from zap import zap
339
return zap(checkout, remove_branch=branch)
342
class cmd_cbranch(bzrlib.commands.Command):
344
Create a new checkout, associated with a new repository branch. <BZRTOOLS>
346
When you cbranch, bzr looks up the repository associated with your current
347
directory in branches.conf. It creates a new branch in that repository
348
with the same name and relative path as the checkout you request.
350
The branches.conf parameter is "cbranch_root". So if you want
351
cbranch operations in /home/jrandom/bigproject to produce branches in
352
/home/jrandom/bigproject/repository, you'd add this:
354
[/home/jrandom/bigproject]
355
cbranch_root = /home/jrandom/bigproject/repository
357
Note that if "/home/jrandom/bigproject/repository" isn't a repository,
358
standalone branches will be produced. Standalone branches will also
359
be produced if the source branch is in 0.7 format (or earlier).
361
takes_options = [Option("lightweight",
362
help="Create a lightweight checkout")]
382
return zap(checkout, remove_branch=branch, allow_modified=force)
385
class cmd_cbranch(BzrToolsCommand):
387
Create a new checkout, associated with a new repository branch.
389
When you cbranch, bzr looks up a target location in locations.conf, and
390
creates the branch there.
392
In your locations.conf, add the following lines:
393
[/working_directory_root]
394
cbranch_target = /branch_root
395
cbranch_target:policy = appendpath
397
This will mean that if you run "bzr cbranch foo/bar foo/baz" in the
398
working directory root, the branch will be created in
399
"/branch_root/foo/baz"
401
NOTE: cbranch also supports "cbranch_root", but that behaviour is
404
takes_options = [Option("lightweight",
405
help="Create a lightweight checkout."), 'revision',
406
Option('files-from', type=unicode,
407
help='Accelerate checkout using files from this'
410
help='Hard-link files from source/files-from tree'
363
412
takes_args = ["source", "target?"]
364
def run(self, source, target=None, lightweight=False):
413
def run(self, source, target=None, lightweight=False, revision=None,
414
files_from=None, hardlink=False):
365
415
from cbranch import cbranch
366
return cbranch(source, target, lightweight=lightweight)
369
class cmd_branches(bzrlib.commands.Command):
370
"""Scan a location for branches <BZRTOOLS>"""
416
return cbranch(source, target, lightweight=lightweight,
417
revision=revision, files_from=files_from,
421
class cmd_branches(BzrToolsCommand):
422
"""Scan a location for branches"""
371
423
takes_args = ["location?"]
372
424
def run(self, location=None):
373
425
from branches import branches
374
426
return branches(location)
377
class cmd_multi_pull(bzrlib.commands.Command):
378
"""Pull all the branches under a location, e.g. a repository. <BZRTOOLS>
428
class cmd_trees(BzrToolsCommand):
429
"""Scan a location for trees"""
430
takes_args = ['location?']
431
def run(self, location='.'):
432
from bzrlib.workingtree import WorkingTree
433
from bzrlib.transport import get_transport
434
t = get_transport(location)
435
for tree in WorkingTree.find_trees(location):
436
self.outf.write('%s\n' % t.relpath(
437
tree.bzrdir.root_transport.base))
439
class cmd_multi_pull(BzrToolsCommand):
440
"""Pull all the branches under a location, e.g. a repository.
380
442
Both branches present in the directory and the branches of checkouts are
383
445
takes_args = ["location?"]
384
446
def run(self, location=None):
385
from bzrlib.branch import Branch
386
447
from bzrlib.transport import get_transport
387
448
from bzrtools import iter_branch_tree
388
449
if location is None:
390
451
t = get_transport(location)
452
possible_transports = []
391
453
if not t.listable():
392
454
print "Can't list this type of location."
410
472
print "Pulling %s from %s" % (relpath, parent)
412
pullable.pull(Branch.open(parent))
474
branch_t = get_transport(parent, possible_transports)
475
pullable.pull(Branch.open_from_transport(branch_t))
413
476
except Exception, e:
417
class cmd_branch_mark(bzrlib.commands.Command):
419
Add, view or list branch markers <EXPERIMENTAL>
421
To add a mark, do 'bzr branch-mark MARK'.
422
To list marks, do 'bzr branch-mark' (this lists all marks for the branch's
424
To delete a mark, do 'bzr branch-mark --delete MARK'
426
These marks can be used to track a branch's status.
428
takes_args = ['mark?', 'branch?']
429
takes_options = [Option('delete', help='Delete this mark')]
430
def run(self, mark=None, branch=None, delete=False):
431
from branch_mark import branch_mark
432
branch_mark(mark, branch, delete)
434
class cmd_import(bzrlib.commands.Command):
435
"""Import sources from a tarball <BZRTOOLS>
437
This command will import a tarball into a bzr tree, replacing any versioned
438
files already present. If a directory is specified, it is used as the
439
target. If the directory does not exist, or is not versioned, it is
481
class cmd_import(BzrToolsCommand):
482
"""Import sources from a directory, tarball or zip file
484
This command will import a directory, tarball or zip file into a bzr
485
tree, replacing any versioned files already present. If a directory is
486
specified, it is used as the target. If the directory does not exist, or
487
is not versioned, it is created.
442
489
Tarballs may be gzip or bzip2 compressed. This is autodetected.
444
If the tarball has a single root directory, that directory is stripped
445
when extracting the tarball.
491
If the tarball or zip has a single root directory, that directory is
492
stripped when extracting the tarball. This is not done for directories.
448
495
takes_args = ['source', 'tree?']
449
496
def run(self, source, tree=None):
450
497
from upstream_import import do_import
451
498
do_import(source, tree)
454
commands = [cmd_shelve, cmd_unshelve, cmd_shelf, cmd_clean_tree,
455
cmd_graph_ancestry, cmd_fetch_ghosts, cmd_patch, cmd_shell,
456
cmd_branch_history, cmd_zap, cmd_cbranch, cmd_branches,
457
cmd_multi_pull, cmd_switch, cmd_branch_mark, cmd_import]
460
import bzrlib.builtins
461
commands.append(rspush.cmd_rspush)
463
from errors import NoPyBaz
466
commands.append(baz_import.cmd_baz_import_branch)
467
commands.append(baz_import.cmd_baz_import)
470
class cmd_baz_import_branch(bzrlib.commands.Command):
471
"""Disabled. (Requires PyBaz) <BZRTOOLS>"""
472
takes_args = ['to_location?', 'from_branch?', 'reuse_history*']
473
takes_options = ['verbose', Option('max-count', type=int)]
474
def run(self, to_location=None, from_branch=None, fast=False,
475
max_count=None, verbose=False, dry_run=False,
476
reuse_history_list=[]):
477
print "This command is disabled. Please install PyBaz."
480
class cmd_baz_import(bzrlib.commands.Command):
481
"""Disabled. (Requires PyBaz) <BZRTOOLS>"""
482
takes_args = ['to_root_dir?', 'from_archive?', 'reuse_history*']
483
takes_options = ['verbose', Option('prefixes', type=str,
484
help="Prefixes of branches to import")]
485
def run(self, to_root_dir=None, from_archive=None, verbose=False,
486
reuse_history_list=[], prefixes=None):
487
print "This command is disabled. Please install PyBaz."
488
commands.extend((cmd_baz_import_branch, cmd_baz_import))
491
if hasattr(bzrlib.commands, 'register_command'):
492
for command in commands:
493
bzrlib.commands.register_command(command)
497
from bzrlib.tests.TestUtil import TestLoader
499
from doctest import DocTestSuite, ELLIPSIS
500
from unittest import TestSuite
501
import tests.clean_tree
502
import upstream_import
504
import tests.blackbox
505
import tests.shelf_tests
507
result.addTest(DocTestSuite(bzrtools, optionflags=ELLIPSIS))
508
result.addTest(tests.clean_tree.test_suite())
511
result.addTest(DocTestSuite(baz_import))
514
result.addTest(tests.test_suite())
515
result.addTest(TestLoader().loadTestsFromModule(tests.shelf_tests))
516
result.addTest(tests.blackbox.test_suite())
517
result.addTest(upstream_import.test_suite())
518
result.addTest(zap.test_suite())
501
class cmd_cdiff(BzrToolsCommand):
502
"""A color version of bzr's diff"""
503
takes_args = property(lambda x: get_cmd_object('diff').takes_args)
504
takes_options = list(get_cmd_object('diff').takes_options) + [
505
RegistryOption.from_kwargs('color',
506
'Color mode to use.',
507
title='Color Mode', value_switches=False, enum_switch=True,
508
never='Never colorize output.',
509
auto='Only colorize output if terminal supports it and STDOUT is a'
511
always='Always colorize output (default).'),
512
Option('check-style',
513
help='Warn if trailing whitespace or spurious changes have been'
516
def run(self, color='always', check_style=False, *args, **kwargs):
517
from colordiff import colordiff
518
colordiff(color, check_style, *args, **kwargs)
521
class cmd_conflict_diff(BzrToolsCommand):
523
"""Compare a conflicted file against BASE."""
525
encoding_type = 'exact'
526
takes_args = ['file']
528
RegistryOption.from_kwargs('direction', 'Direction of comparison.',
529
value_switches=True, enum_switch=False,
530
other='Compare OTHER against common base.',
531
this='Compare THIS against common base.')]
533
def run(self, file, direction='other'):
534
from bzrlib.plugins.bzrtools.colordiff import DiffWriter
535
from conflict_diff import conflict_diff
536
dw = DiffWriter(self.outf, check_style=False, color='auto')
537
conflict_diff(dw, file, direction)
540
class cmd_rspush(BzrToolsCommand):
541
"""Upload this branch to another location using rsync.
543
If no location is specified, the last-used location will be used. To
544
prevent dirty trees from being uploaded, rspush will error out if there are
545
unknown files or local changes. It will also error out if the upstream
546
directory is non-empty and not an earlier version of the branch.
548
takes_args = ['location?']
549
takes_options = [Option('overwrite', help='Ignore differences between'
550
' branches and overwrite unconditionally.'),
551
Option('no-tree', help='Do not push the working tree,'
554
def run(self, location=None, overwrite=False, no_tree=False):
555
from bzrlib import workingtree
557
cur_branch = workingtree.WorkingTree.open_containing(".")[0]
558
bzrtools.rspush(cur_branch, location, overwrite=overwrite,
559
working_tree=not no_tree)
562
class cmd_link_tree(BzrToolsCommand):
563
"""Hardlink matching files to another tree.
565
Only files with identical content and execute bit will be linked.
567
takes_args = ['location']
569
def run(self, location):
570
from bzrlib import workingtree
571
from bzrlib.plugins.bzrtools.link_tree import link_tree
572
target_tree = workingtree.WorkingTree.open_containing(".")[0]
573
source_tree = workingtree.WorkingTree.open(location)
574
target_tree.lock_write()
576
source_tree.lock_read()
578
link_tree(target_tree, source_tree)
585
class cmd_create_mirror(BzrToolsCommand):
586
"""Create a mirror of another branch.
588
This is similar to `bzr branch`, but copies more settings, including the
589
submit branch and nickname.
591
It sets the public branch and parent of the target to the source location.
594
takes_args = ['source', 'target']
596
def run(self, source, target):
597
source_branch = Branch.open(source)
598
from bzrlib.plugins.bzrtools.mirror import create_mirror
599
create_mirror(source_branch, target, [])
added
removed
command_classes.py
