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
from errors import CommandError, NoPyBaz
6
from errors import CommandError
34
7
from patchsource import BzrPatchSource
8
from shelf import Shelf
9
from switch import cmd_switch
38
13
import bzrlib.builtins
39
15
import bzrlib.commands
40
from bzrlib.branch import Branch
41
from bzrlib.bzrdir import BzrDir
42
16
from bzrlib.commands import get_cmd_object
43
17
from bzrlib.errors import BzrCommandError
18
from bzrlib.help import command_usage
44
19
import bzrlib.ignores
45
from bzrlib.trace import note
46
20
from bzrlib.option import Option
47
sys.path.insert(0, os.path.realpath(os.path.join(os.path.dirname(__file__),
21
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):
24
bzrlib.ignores.add_runtime_ignores(['./.shelf', './.bzr-shelf*'])
27
class cmd_clean_tree(bzrlib.commands.Command):
57
28
"""Remove unwanted files from working tree.
59
30
By default, only unknown files, not ignored files, are deleted. Versioned
118
88
If available, rsvg is used to antialias PNG and JPEG output, but this can
119
89
be disabled with --no-antialias.
121
takes_args = ['file', 'merge_branch?']
122
takes_options = [Option('no-collapse', help="Do not skip simple nodes."),
91
takes_args = ['branch', 'file']
92
takes_options = [Option('no-collapse', help="Do not skip simple nodes"),
123
93
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:
94
help="Do not use rsvg to produce antialiased output"),
95
Option('merge-branch', type=str,
96
help="Use this branch to calcuate a merge base"),
97
Option('cluster', help="Use clustered output.")]
98
def run(self, branch, file, no_collapse=False, no_antialias=False,
99
merge_branch=None, cluster=False):
143
102
ranking = "cluster"
145
104
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):
105
graph.write_ancestry_file(branch, file, not no_collapse,
106
not no_antialias, merge_branch, ranking)
108
class cmd_fetch_ghosts(bzrlib.commands.Command):
152
109
"""Attempt to retrieve ghosts from another branch.
153
110
If the other branch is not supplied, the last-pulled branch is used.
155
112
aliases = ['fetch-missing']
156
113
takes_args = ['branch?']
157
takes_options = [Option('no-fix', help="Skip additional synchonization.")]
114
takes_options = [Option('no-fix')]
158
115
def run(self, branch=None, no_fix=False):
159
116
from fetch_ghosts import fetch_ghosts
160
117
fetch_ghosts(branch, no_fix)
162
119
strip_help="""Strip the smallest prefix containing num leading slashes from \
163
120
each file name found in the patch file."""
166
class cmd_patch(BzrToolsCommand):
121
Option.OPTIONS['bzrdiff'] = Option('bzrdiff',type=None,
122
help="""Handle extra bzr tags""")
123
class cmd_patch(bzrlib.commands.Command):
167
124
"""Apply a named patch to the current tree.
169
126
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):
127
takes_options = [Option('strip', type=int, help=strip_help)]
128
def run(self, filename=None, strip=-1, bzrdiff=0):
173
129
from patch import patch
174
130
from bzrlib.workingtree import WorkingTree
175
131
wt = WorkingTree.open_containing('.')[0]
178
return patch(wt, filename, strip, silent)
181
class cmd_shelve(BzrToolsCommand):
133
if bzrdiff: strip = 0
136
return patch(wt, filename, strip, legacy= not bzrdiff)
138
class cmd_shelve(bzrlib.commands.Command):
182
139
"""Temporarily set aside some changes from the current tree.
184
141
Shelve allows you to temporarily put changes you've made "on the shelf",
408
351
If --branch is specified, the branch will be deleted too, but only if the
409
352
the branch has no new commits (relative to its parent).
411
takes_options = [Option("branch", help="Remove associated branch from"
413
Option('force', help='Delete tree even if contents are'
354
takes_options = [Option("branch", help="Remove associtated branch from"
415
356
takes_args = ["checkout"]
416
def run(self, checkout, branch=False, force=False):
357
def run(self, checkout, branch=False):
417
358
from zap import zap
418
return zap(checkout, remove_branch=branch, allow_modified=force)
421
class cmd_cbranch(BzrToolsCommand):
359
return zap(checkout, remove_branch=branch)
362
class cmd_cbranch(bzrlib.commands.Command):
423
364
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
366
When you cbranch, bzr looks up the repository associated with your current
367
directory in branches.conf. It creates a new branch in that repository
368
with the same name and relative path as the checkout you request.
370
The branches.conf parameter is "cbranch_root". So if you want
371
cbranch operations in /home/jrandom/bigproject to produce branches in
372
/home/jrandom/bigproject/repository, you'd add this:
374
[/home/jrandom/bigproject]
375
cbranch_root = /home/jrandom/bigproject/repository
377
Note that if "/home/jrandom/bigproject/repository" isn't a repository,
378
standalone branches will be produced. Standalone branches will also
379
be produced if the source branch is in 0.7 format (or earlier).
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'
381
takes_options = [Option("lightweight",
382
help="Create a lightweight checkout"), 'revision']
448
383
takes_args = ["source", "target?"]
449
def run(self, source, target=None, lightweight=False, revision=None,
450
files_from=None, hardlink=False):
384
def run(self, source, target=None, lightweight=False, revision=None):
451
385
from cbranch import cbranch
452
return cbranch(source, target, lightweight=lightweight,
453
revision=revision, files_from=files_from,
457
class cmd_branches(BzrToolsCommand):
386
return cbranch(source, target, lightweight=lightweight,
390
class cmd_branches(bzrlib.commands.Command):
458
391
"""Scan a location for branches"""
459
392
takes_args = ["location?"]
460
393
def run(self, location=None):
461
394
from branches import branches
462
395
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):
398
class cmd_multi_pull(bzrlib.commands.Command):
476
399
"""Pull all the branches under a location, e.g. a repository.
478
401
Both branches present in the directory and the branches of checkouts are
481
404
takes_args = ["location?"]
482
405
def run(self, location=None):
406
from bzrlib.branch import Branch
483
407
from bzrlib.transport import get_transport
484
408
from bzrtools import iter_branch_tree
485
409
if location is None:
487
411
t = get_transport(location)
488
possible_transports = []
489
412
if not t.listable():
490
413
print "Can't list this type of location."
508
431
print "Pulling %s from %s" % (relpath, parent)
510
branch_t = get_transport(parent, possible_transports)
511
pullable.pull(Branch.open_from_transport(branch_t))
433
pullable.pull(Branch.open(parent))
512
434
except Exception, e:
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.
438
class cmd_branch_mark(bzrlib.commands.Command):
440
Add, view or list branch markers <EXPERIMENTAL>
442
To add a mark, do 'bzr branch-mark MARK'.
443
To list marks, do 'bzr branch-mark' (this lists all marks for the branch's
445
To delete a mark, do 'bzr branch-mark --delete MARK'
447
These marks can be used to track a branch's status.
449
takes_args = ['mark?', 'branch?']
450
takes_options = [Option('delete', help='Delete this mark')]
451
def run(self, mark=None, branch=None, delete=False):
452
from branch_mark import branch_mark
453
branch_mark(mark, branch, delete)
455
class cmd_import(bzrlib.commands.Command):
456
"""Import sources from a tarball
458
This command will import a tarball into a bzr tree, replacing any versioned
459
files already present. If a directory is specified, it is used as the
460
target. If the directory does not exist, or is not versioned, it is
525
463
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.
465
If the tarball has a single root directory, that directory is stripped
466
when extracting the tarball.
531
469
takes_args = ['source', 'tree?']
532
470
def run(self, source, tree=None):
533
471
from upstream_import import do_import
534
472
do_import(source, tree)
537
class cmd_cdiff(BzrToolsCommand):
474
class cmd_shove(bzrlib.commands.Command):
475
"""Apply uncommitted changes to another tree
477
This is useful when you start to make changes in one tree, then realize
478
they should really be done in a different tree.
480
Shove is implemented using merge, so:
481
- All changes, including renames and adds, will be applied.
482
- No changes that have already been applied will be applied.
483
- If the target is significantly different from the source, conflicts may
487
takes_args = ['target', 'source?']
488
def run(self, target, source='.'):
489
from shove import do_shove
490
do_shove(source, target)
492
class cmd_cdiff(bzrlib.commands.Command):
538
493
"""A color version of bzr's diff"""
539
494
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):
495
takes_options = property(lambda x: get_cmd_object('diff').takes_options)
496
def run(*args, **kwargs):
546
497
from colordiff import colordiff
547
colordiff(check_style, *args, **kwargs)
550
class cmd_baz_import(BzrToolsCommand):
551
"""Import an Arch or Baz archive into a bzr repository.
553
This command should be used on local archives (or mirrors) only. It is
554
quite slow on remote archives.
556
reuse_history allows you to specify any previous imports you
557
have done of different archives, which this archive has branches
558
tagged from. This will dramatically reduce the time to convert
559
the archive as it will not have to convert the history already
560
converted in that other branch.
562
If you specify prefixes, only branches whose names start with that prefix
563
will be imported. Skipped branches will be listed, so you can import any
564
branches you missed by accident. Here's an example of doing a partial
565
import from thelove@canonical.com:
566
bzr baz-import thelove thelove@canonical.com --prefixes dists:talloc-except
568
WARNING: Encoding should not be specified unless necessary, because if you
569
specify an encoding, your converted branch will not interoperate with
570
independently-converted branches, unless the other branches were converted
571
with exactly the same encoding. Any encoding recognized by Python may
572
be specified. Aliases are not detected, so 'utf_8', 'U8', 'UTF' and 'utf8'
575
takes_args = ['to_root_dir', 'from_archive', 'reuse_history*']
576
takes_options = ['verbose', Option('prefixes', type=str,
577
help="Prefixes of branches to import, colon-separated."),
578
Option('encoding', type=str,
579
help='Force encoding to specified value. See WARNING.')]
581
def run(self, to_root_dir, from_archive, encoding=None, verbose=False,
582
reuse_history_list=[], prefixes=None):
583
from errors import NoPyBaz
586
baz_import.baz_import(to_root_dir, from_archive, encoding,
587
verbose, reuse_history_list, prefixes)
589
print "This command is disabled. Please install PyBaz."
592
class cmd_baz_import_branch(BzrToolsCommand):
593
"""Import an Arch or Baz branch into a bzr branch.
595
WARNING: Encoding should not be specified unless necessary, because if you
596
specify an encoding, your converted branch will not interoperate with
597
independently-converted branches, unless the other branches were converted
598
with exactly the same encoding. Any encoding recognized by Python may
599
be specified. Aliases are not detected, so 'utf_8', 'U8', 'UTF' and 'utf8'
602
takes_args = ['to_location', 'from_branch?', 'reuse_history*']
603
takes_options = ['verbose',
604
Option('max-count', type=int,
605
help='Maximim revisions to import at once.'),
606
Option('encoding', type=str,
607
help='Force encoding to specified value. See WARNING.')]
609
def run(self, to_location, from_branch=None, fast=False, max_count=None,
610
encoding=None, verbose=False, dry_run=False,
611
reuse_history_list=[]):
612
from errors import NoPyBaz
615
baz_import.baz_import_branch(to_location, from_branch, fast,
616
max_count, verbose, encoding, dry_run,
619
print "This command is disabled. Please install PyBaz."
622
class cmd_rspush(BzrToolsCommand):
623
"""Upload this branch to another location using rsync.
625
If no location is specified, the last-used location will be used. To
626
prevent dirty trees from being uploaded, rspush will error out if there are
627
unknown files or local changes. It will also error out if the upstream
628
directory is non-empty and not an earlier version of the branch.
630
takes_args = ['location?']
631
takes_options = [Option('overwrite', help='Ignore differences between'
632
' branches and overwrite unconditionally.'),
633
Option('no-tree', help='Do not push the working tree,'
636
def run(self, location=None, overwrite=False, no_tree=False):
637
from bzrlib import workingtree
639
cur_branch = workingtree.WorkingTree.open_containing(".")[0]
640
bzrtools.rspush(cur_branch, location, overwrite=overwrite,
641
working_tree=not no_tree)
644
class cmd_link_tree(BzrToolsCommand):
645
"""Hardlink matching files to another tree.
647
Only files with identical content and execute bit will be linked.
649
takes_args = ['location']
651
def run(self, location):
652
from bzrlib import workingtree
653
from bzrlib.plugins.bzrtools.link_tree import link_tree
654
target_tree = workingtree.WorkingTree.open_containing(".")[0]
655
source_tree = workingtree.WorkingTree.open(location)
656
target_tree.lock_write()
658
source_tree.lock_read()
660
link_tree(target_tree, source_tree)
666
from heads import cmd_heads
669
cmd_baz_import_branch,
498
colordiff(*args, **kwargs)
500
commands = [cmd_shelve, cmd_unshelve, cmd_shelf, cmd_clean_tree,
501
cmd_graph_ancestry, cmd_fetch_ghosts, cmd_patch, cmd_shell,
502
cmd_branch_history, cmd_zap, cmd_cbranch, cmd_branches,
503
cmd_multi_pull, cmd_switch, cmd_branch_mark, cmd_import, cmd_shove,
507
commands.append(rspush.cmd_rspush)
509
from errors import NoPyBaz
512
commands.append(baz_import.cmd_baz_import_branch)
513
commands.append(baz_import.cmd_baz_import)
516
class cmd_baz_import_branch(bzrlib.commands.Command):
517
"""Disabled. (Requires PyBaz)"""
518
takes_args = ['to_location?', 'from_branch?', 'reuse_history*']
519
takes_options = ['verbose', Option('max-count', type=int)]
520
def run(self, to_location=None, from_branch=None, fast=False,
521
max_count=None, verbose=False, dry_run=False,
522
reuse_history_list=[]):
523
print "This command is disabled. Please install PyBaz."
526
class cmd_baz_import(bzrlib.commands.Command):
527
"""Disabled. (Requires PyBaz)"""
528
takes_args = ['to_root_dir?', 'from_archive?', 'reuse_history*']
529
takes_options = ['verbose', Option('prefixes', type=str,
530
help="Prefixes of branches to import")]
531
def run(self, to_root_dir=None, from_archive=None, verbose=False,
532
reuse_history_list=[], prefixes=None):
533
print "This command is disabled. Please install PyBaz."
534
commands.extend((cmd_baz_import_branch, cmd_baz_import))
692
537
if hasattr(bzrlib.commands, 'register_command'):
added
removed
__init__.py
