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
3
20
Various useful plugins for working with bzr.
6
from errors import CommandError
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
7
34
from patchsource import BzrPatchSource
8
from shelf import Shelf
9
from switch import cmd_switch
13
from bzrlib import DEFAULT_IGNORE
14
38
import bzrlib.builtins
16
39
import bzrlib.commands
40
from bzrlib.branch import Branch
41
from bzrlib.bzrdir import BzrDir
42
from bzrlib.commands import get_cmd_object
17
43
from bzrlib.errors import BzrCommandError
18
from bzrlib.help import command_usage
45
from bzrlib.trace import note
19
46
from bzrlib.option import Option
20
sys.path.insert(0, os.path.realpath(os.path.join(os.path.dirname(__file__),
47
sys.path.insert(0, os.path.realpath(os.path.join(os.path.dirname(__file__),
24
DEFAULT_IGNORE.append('./.shelf')
25
DEFAULT_IGNORE.append('./.bzr-shelf*')
28
class cmd_clean_tree(bzrlib.commands.Command):
29
"""Remove unwanted files from working tree. <BZRTOOLS>
30
Normally, ignored files are left alone.
51
from command import BzrToolsCommand
53
bzrlib.ignores.add_runtime_ignores(['./.shelf'])
56
class cmd_clean_tree(BzrToolsCommand):
57
"""Remove unwanted files from working tree.
59
By default, only unknown files, not ignored files, are deleted. Versioned
60
files are never deleted.
62
Another class is 'detritus', which includes files emitted by bzr during
63
normal operations and selftests. (The value of these files decreases with
66
If no options are specified, unknown files are deleted. Otherwise, option
67
flags are respected, and may be combined.
69
To check what clean-tree will do, use --dry-run.
32
takes_options = [Option('ignored', help='delete all ignored files.'),
33
Option('detritus', help='delete conflict files merge'
34
' backups, and failed selftest dirs. (*.THIS, '
35
'*.BASE, *.OTHER, *~, *.tmp)'),
36
Option('dry-run', help='show files to delete instead of'
71
takes_options = [Option('ignored', help='Delete all ignored files.'),
72
Option('detritus', help='Delete conflict files, merge'
73
' backups, and failed selftest dirs.'),
75
help='Delete files unknown to bzr (default).'),
76
Option('dry-run', help='Show files to delete instead of'
37
77
' deleting them.')]
38
def run(self, ignored=False, detritus=False, dry_run=False):
78
def run(self, unknown=False, ignored=False, detritus=False, dry_run=False):
39
79
from clean_tree import clean_tree
40
clean_tree('.', ignored=ignored, detritus=detritus, dry_run=dry_run)
42
class cmd_graph_ancestry(bzrlib.commands.Command):
43
"""Produce ancestry graphs using dot. <BZRTOOLS>
80
if not (unknown or ignored or detritus):
82
clean_tree('.', unknown=unknown, ignored=ignored, detritus=detritus,
86
class cmd_graph_ancestry(BzrToolsCommand):
87
"""Produce ancestry graphs using dot.
45
89
Output format is detected according to file extension. Some of the more
46
90
common output formats are html, png, gif, svg, ps. An extension of '.dot'
74
118
If available, rsvg is used to antialias PNG and JPEG output, but this can
75
119
be disabled with --no-antialias.
77
takes_args = ['branch', 'file']
78
takes_options = [Option('no-collapse', help="Do not skip simple nodes"),
121
takes_args = ['file', 'merge_branch?']
122
takes_options = [Option('no-collapse', help="Do not skip simple nodes."),
79
123
Option('no-antialias',
80
help="Do not use rsvg to produce antialiased output"),
81
Option('merge-branch', type=str,
82
help="Use this branch to calcuate a merge base"),
83
Option('cluster', help="Use clustered output.")]
84
def run(self, branch, file, no_collapse=False, no_antialias=False,
85
merge_branch=None, cluster=False):
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:
88
143
ranking = "cluster"
90
145
ranking = "forced"
91
graph.write_ancestry_file(branch, file, not no_collapse,
92
not no_antialias, merge_branch, ranking)
94
class cmd_fetch_ghosts(bzrlib.commands.Command):
95
"""Attempt to retrieve ghosts from another branch. <BZRTOOLS>
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):
152
"""Attempt to retrieve ghosts from another branch.
96
153
If the other branch is not supplied, the last-pulled branch is used.
98
155
aliases = ['fetch-missing']
99
156
takes_args = ['branch?']
100
takes_options = [Option('no-fix')]
157
takes_options = [Option('no-fix', help="Skip additional synchonization.")]
101
158
def run(self, branch=None, no_fix=False):
102
159
from fetch_ghosts import fetch_ghosts
103
160
fetch_ghosts(branch, no_fix)
105
162
strip_help="""Strip the smallest prefix containing num leading slashes from \
106
163
each file name found in the patch file."""
107
Option.OPTIONS['bzrdiff'] = Option('bzrdiff',type=None,
108
help="""Handle extra bzr tags""")
109
class cmd_patch(bzrlib.commands.Command):
110
"""Apply a named patch to the current tree. <BZRTOOLS>
166
class cmd_patch(BzrToolsCommand):
167
"""Apply a named patch to the current tree.
112
169
takes_args = ['filename?']
113
takes_options = [Option('strip', type=int, help=strip_help)]
114
def run(self, filename=None, strip=-1, bzrdiff=0):
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):
115
173
from patch import patch
116
174
from bzrlib.workingtree import WorkingTree
117
175
wt = WorkingTree.open_containing('.')[0]
119
if bzrdiff: strip = 0
122
return patch(wt, filename, strip, legacy= not bzrdiff)
124
class cmd_shelve(bzrlib.commands.Command):
125
"""Temporarily set aside some changes from the current tree. <BZRTOOLS>
178
return patch(wt, filename, strip, silent)
181
class cmd_shelve(BzrToolsCommand):
182
"""Temporarily set aside some changes from the current tree.
127
184
Shelve allows you to temporarily put changes you've made "on the shelf",
128
185
ie. out of the way, until a later time when you can bring them back from
323
394
takes_args = ["branch?"]
324
395
def run(self, branch=None):
325
from branchhistory import branch_history
396
from branchhistory import branch_history
326
397
return branch_history(branch)
329
class cmd_zap(bzrlib.commands.Command):
400
class cmd_zap(BzrToolsCommand):
331
Remove a checkout, if it can be done safely. <BZRTOOLS>
333
This command will remove a checkout without losing data. That means
334
it only removes checkouts, and only if they have no uncommitted changes.
402
Remove a lightweight checkout, if it can be done safely.
404
This command will remove a lightweight checkout without losing data. That
405
means it only removes lightweight checkouts, and only if they have no
408
If --branch is specified, the branch will be deleted too, but only if the
409
the branch has no new commits (relative to its parent).
336
takes_options = [Option("branch", help="Remove associtated branch from"
411
takes_options = [Option("branch", help="Remove associated branch from"
413
Option('force', help='Delete tree even if contents are'
338
415
takes_args = ["checkout"]
339
def run(self, checkout, branch=False):
416
def run(self, checkout, branch=False, force=False):
340
417
from zap import zap
341
return zap(checkout, remove_branch=branch)
344
class cmd_cbranch(bzrlib.commands.Command):
346
Create a new checkout, associated with a new repository branch. <BZRTOOLS>
348
When you cbranch, bzr looks up the repository associated with your current
349
directory in branches.conf. It creates a new branch in that repository
350
with the same name and relative path as the checkout you request.
352
The branches.conf parameter is "cbranch_root". So if you want
353
cbranch operations in /home/jrandom/bigproject to produce branches in
354
/home/jrandom/bigproject/repository, you'd add this:
356
[/home/jrandom/bigproject]
357
cbranch_root = /home/jrandom/bigproject/repository
359
Note that if "/home/jrandom/bigproject/repository" isn't a repository,
360
standalone branches will be produced. Standalone branches will also
361
be produced if the source branch is in 0.7 format (or earlier).
363
takes_options = [Option("lightweight",
364
help="Create a lightweight checkout")]
418
return zap(checkout, remove_branch=branch, allow_modified=force)
421
class cmd_cbranch(BzrToolsCommand):
423
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
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'
365
448
takes_args = ["source", "target?"]
366
def run(self, source, target=None, lightweight=False):
449
def run(self, source, target=None, lightweight=False, revision=None,
450
files_from=None, hardlink=False):
367
451
from cbranch import cbranch
368
return cbranch(source, target, lightweight=lightweight)
371
class cmd_branches(bzrlib.commands.Command):
372
"""Scan a location for branches <BZRTOOLS>"""
452
return cbranch(source, target, lightweight=lightweight,
453
revision=revision, files_from=files_from,
457
class cmd_branches(BzrToolsCommand):
458
"""Scan a location for branches"""
373
459
takes_args = ["location?"]
374
460
def run(self, location=None):
375
461
from branches import branches
376
462
return branches(location)
379
class cmd_multi_pull(bzrlib.commands.Command):
380
"""Pull all the branches under a location, e.g. a repository. <BZRTOOLS>
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):
476
"""Pull all the branches under a location, e.g. a repository.
382
478
Both branches present in the directory and the branches of checkouts are
385
481
takes_args = ["location?"]
386
482
def run(self, location=None):
387
from bzrlib.branch import Branch
388
483
from bzrlib.transport import get_transport
389
484
from bzrtools import iter_branch_tree
390
485
if location is None:
392
487
t = get_transport(location)
488
possible_transports = []
393
489
if not t.listable():
394
490
print "Can't list this type of location."
412
508
print "Pulling %s from %s" % (relpath, parent)
414
pullable.pull(Branch.open(parent))
510
branch_t = get_transport(parent, possible_transports)
511
pullable.pull(Branch.open_from_transport(branch_t))
415
512
except Exception, e:
419
class cmd_branch_mark(bzrlib.commands.Command):
421
Add, view or list branch markers <EXPERIMENTAL>
423
To add a mark, do 'bzr branch-mark MARK'.
424
To list marks, do 'bzr branch-mark' (this lists all marks for the branch's
426
To delete a mark, do 'bzr branch-mark --delete MARK'
428
These marks can be used to track a branch's status.
430
takes_args = ['mark?', 'branch?']
431
takes_options = [Option('delete', help='Delete this mark')]
432
def run(self, mark=None, branch=None, delete=False):
433
from branch_mark import branch_mark
434
branch_mark(mark, branch, delete)
436
class cmd_import(bzrlib.commands.Command):
437
"""Import sources from a tarball <BZRTOOLS>
439
This command will import a tarball into a bzr tree, replacing any versioned
440
files already present. If a directory is specified, it is used as the
441
target. If the directory does not exist, or is not versioned, it is
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.
444
525
Tarballs may be gzip or bzip2 compressed. This is autodetected.
446
If the tarball has a single root directory, that directory is stripped
447
when extracting the tarball.
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.
450
531
takes_args = ['source', 'tree?']
451
532
def run(self, source, tree=None):
452
533
from upstream_import import do_import
453
534
do_import(source, tree)
455
class cmd_shove(bzrlib.commands.Command):
456
"""Apply uncommitted changes to another tree <BZRTOOLS>
458
This is useful when you start to make changes in one tree, then realize
459
they should really be done in a different tree.
461
Shove is implemented using merge, so:
462
- All changes, including renames and adds, will be applied.
463
- No changes that have already been applied will be applied.
464
- If the target is significantly different from the source, conflicts may
468
takes_args = ['target', 'source?']
469
def run(self, target, source='.'):
470
from shove import do_shove
471
do_shove(source, target)
473
class cmd_cdiff(bzrlib.commands.Command):
474
"""A color version of bzr's diff <BZRTOOLS>"""
475
takes_args = bzrlib.builtins.cmd_diff.takes_args
476
takes_options = bzrlib.builtins.cmd_diff.takes_options
477
def run(*args, **kwargs):
537
class cmd_cdiff(BzrToolsCommand):
538
"""A color version of bzr's diff"""
539
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):
478
546
from colordiff import colordiff
479
colordiff(*args, **kwargs)
481
commands = [cmd_shelve, cmd_unshelve, cmd_shelf, cmd_clean_tree,
482
cmd_graph_ancestry, cmd_fetch_ghosts, cmd_patch, cmd_shell,
483
cmd_branch_history, cmd_zap, cmd_cbranch, cmd_branches,
484
cmd_multi_pull, cmd_switch, cmd_branch_mark, cmd_import, cmd_shove,
488
commands.append(rspush.cmd_rspush)
490
from errors import NoPyBaz
493
commands.append(baz_import.cmd_baz_import_branch)
494
commands.append(baz_import.cmd_baz_import)
497
class cmd_baz_import_branch(bzrlib.commands.Command):
498
"""Disabled. (Requires PyBaz) <BZRTOOLS>"""
499
takes_args = ['to_location?', 'from_branch?', 'reuse_history*']
500
takes_options = ['verbose', Option('max-count', type=int)]
501
def run(self, to_location=None, from_branch=None, fast=False,
502
max_count=None, verbose=False, dry_run=False,
503
reuse_history_list=[]):
504
print "This command is disabled. Please install PyBaz."
507
class cmd_baz_import(bzrlib.commands.Command):
508
"""Disabled. (Requires PyBaz) <BZRTOOLS>"""
509
takes_args = ['to_root_dir?', 'from_archive?', 'reuse_history*']
510
takes_options = ['verbose', Option('prefixes', type=str,
511
help="Prefixes of branches to import")]
512
def run(self, to_root_dir=None, from_archive=None, verbose=False,
513
reuse_history_list=[], prefixes=None):
514
print "This command is disabled. Please install PyBaz."
515
commands.extend((cmd_baz_import_branch, cmd_baz_import))
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,
518
692
if hasattr(bzrlib.commands, 'register_command'):