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
2
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
5
from errors import CommandError
34
6
from patchsource import BzrPatchSource
7
from shelf import Shelf
8
from switch import cmd_switch
38
12
import bzrlib.builtins
39
14
import bzrlib.commands
40
from bzrlib.branch import Branch
41
from bzrlib.bzrdir import BzrDir
42
15
from bzrlib.commands import get_cmd_object
43
16
from bzrlib.errors import BzrCommandError
17
from bzrlib.help import command_usage
44
18
import bzrlib.ignores
45
from bzrlib.trace import note
46
19
from bzrlib.option import Option
47
sys.path.insert(0, os.path.realpath(os.path.join(os.path.dirname(__file__),
20
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):
23
bzrlib.ignores.add_runtime_ignores(['./.shelf', './.bzr-shelf*'])
26
class cmd_clean_tree(bzrlib.commands.Command):
57
27
"""Remove unwanted files from working tree.
59
29
By default, only unknown files, not ignored files, are deleted. Versioned
118
87
If available, rsvg is used to antialias PNG and JPEG output, but this can
119
88
be disabled with --no-antialias.
121
takes_args = ['file', 'merge_branch?']
122
takes_options = [Option('no-collapse', help="Do not skip simple nodes."),
90
takes_args = ['branch', 'file']
91
takes_options = [Option('no-collapse', help="Do not skip simple nodes"),
123
92
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:
93
help="Do not use rsvg to produce antialiased output"),
94
Option('merge-branch', type=str,
95
help="Use this branch to calcuate a merge base"),
96
Option('cluster', help="Use clustered output.")]
97
def run(self, branch, file, no_collapse=False, no_antialias=False,
98
merge_branch=None, cluster=False):
143
101
ranking = "cluster"
145
103
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):
104
graph.write_ancestry_file(branch, file, not no_collapse,
105
not no_antialias, merge_branch, ranking)
107
class cmd_fetch_ghosts(bzrlib.commands.Command):
152
108
"""Attempt to retrieve ghosts from another branch.
153
109
If the other branch is not supplied, the last-pulled branch is used.
155
111
aliases = ['fetch-missing']
156
112
takes_args = ['branch?']
157
takes_options = [Option('no-fix', help="Skip additional synchonization.")]
113
takes_options = [Option('no-fix')]
158
114
def run(self, branch=None, no_fix=False):
159
115
from fetch_ghosts import fetch_ghosts
160
116
fetch_ghosts(branch, no_fix)
162
118
strip_help="""Strip the smallest prefix containing num leading slashes from \
163
119
each file name found in the patch file."""
166
class cmd_patch(BzrToolsCommand):
120
Option.OPTIONS['bzrdiff'] = Option('bzrdiff',type=None,
121
help="""Handle extra bzr tags""")
122
class cmd_patch(bzrlib.commands.Command):
167
123
"""Apply a named patch to the current tree.
169
125
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):
126
takes_options = [Option('strip', type=int, help=strip_help)]
127
def run(self, filename=None, strip=-1, bzrdiff=0):
173
128
from patch import patch
174
129
from bzrlib.workingtree import WorkingTree
175
130
wt = WorkingTree.open_containing('.')[0]
178
return patch(wt, filename, strip, silent)
181
class cmd_shelve(BzrToolsCommand):
132
if bzrdiff: strip = 0
135
return patch(wt, filename, strip, legacy= not bzrdiff)
137
class cmd_shelve(bzrlib.commands.Command):
182
138
"""Temporarily set aside some changes from the current tree.
184
140
Shelve allows you to temporarily put changes you've made "on the shelf",
348
292
See 'shelve' for more information.
350
294
takes_options = [
351
Option('all', help='Unshelve all changes without prompting.'),
352
Option('force', help='Force unshelving even if errors occur.'),
353
Option('no-color', help='Never display changes in color.')
295
Option('all', help='Unshelve all changes without prompting'),
296
Option('force', help='Force unshelving even if errors occur'),
355
298
takes_args = ['patch?']
356
def run(self, patch=None, all=False, force=False, no_color=False):
299
def run(self, patch=None, all=False, force=False):
357
300
source = BzrPatchSource()
358
s = shelf.Shelf(source.base)
359
s.unshelve(source, patch, all, force, no_color)
301
s = Shelf(source.base)
302
s.unshelve(source, patch, all, force)
363
class cmd_shell(BzrToolsCommand):
306
class cmd_shell(bzrlib.commands.Command):
364
307
"""Begin an interactive shell tailored for bzr.
365
308
Bzr commands can be used without typing bzr first, and will be run natively
366
309
when possible. Tab completion is tailored for bzr. The shell prompt shows
408
350
If --branch is specified, the branch will be deleted too, but only if the
409
351
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'
353
takes_options = [Option("branch", help="Remove associtated branch from"
415
355
takes_args = ["checkout"]
416
def run(self, checkout, branch=False, force=False):
356
def run(self, checkout, branch=False):
417
357
from zap import zap
418
return zap(checkout, remove_branch=branch, allow_modified=force)
421
class cmd_cbranch(BzrToolsCommand):
358
return zap(checkout, remove_branch=branch)
361
class cmd_cbranch(bzrlib.commands.Command):
423
363
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
365
When you cbranch, bzr looks up the repository associated with your current
366
directory in branches.conf. It creates a new branch in that repository
367
with the same name and relative path as the checkout you request.
369
The branches.conf parameter is "cbranch_root". So if you want
370
cbranch operations in /home/jrandom/bigproject to produce branches in
371
/home/jrandom/bigproject/repository, you'd add this:
373
[/home/jrandom/bigproject]
374
cbranch_root = /home/jrandom/bigproject/repository
376
Note that if "/home/jrandom/bigproject/repository" isn't a repository,
377
standalone branches will be produced. Standalone branches will also
378
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'
380
takes_options = [Option("lightweight",
381
help="Create a lightweight checkout"), 'revision']
448
382
takes_args = ["source", "target?"]
449
def run(self, source, target=None, lightweight=False, revision=None,
450
files_from=None, hardlink=False):
383
def run(self, source, target=None, lightweight=False, revision=None):
451
384
from cbranch import cbranch
452
return cbranch(source, target, lightweight=lightweight,
453
revision=revision, files_from=files_from,
457
class cmd_branches(BzrToolsCommand):
385
return cbranch(source, target, lightweight=lightweight,
389
class cmd_branches(bzrlib.commands.Command):
458
390
"""Scan a location for branches"""
459
391
takes_args = ["location?"]
460
392
def run(self, location=None):
461
393
from branches import branches
462
394
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):
397
class cmd_multi_pull(bzrlib.commands.Command):
476
398
"""Pull all the branches under a location, e.g. a repository.
478
400
Both branches present in the directory and the branches of checkouts are
481
403
takes_args = ["location?"]
482
404
def run(self, location=None):
405
from bzrlib.branch import Branch
483
406
from bzrlib.transport import get_transport
484
407
from bzrtools import iter_branch_tree
485
408
if location is None:
487
410
t = get_transport(location)
488
possible_transports = []
489
411
if not t.listable():
490
412
print "Can't list this type of location."
508
430
print "Pulling %s from %s" % (relpath, parent)
510
branch_t = get_transport(parent, possible_transports)
511
pullable.pull(Branch.open_from_transport(branch_t))
432
pullable.pull(Branch.open(parent))
512
433
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.
437
class cmd_branch_mark(bzrlib.commands.Command):
439
Add, view or list branch markers <EXPERIMENTAL>
441
To add a mark, do 'bzr branch-mark MARK'.
442
To list marks, do 'bzr branch-mark' (this lists all marks for the branch's
444
To delete a mark, do 'bzr branch-mark --delete MARK'
446
These marks can be used to track a branch's status.
448
takes_args = ['mark?', 'branch?']
449
takes_options = [Option('delete', help='Delete this mark')]
450
def run(self, mark=None, branch=None, delete=False):
451
from branch_mark import branch_mark
452
branch_mark(mark, branch, delete)
454
class cmd_import(bzrlib.commands.Command):
455
"""Import sources from a tarball
457
This command will import a tarball into a bzr tree, replacing any versioned
458
files already present. If a directory is specified, it is used as the
459
target. If the directory does not exist, or is not versioned, it is
525
462
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.
464
If the tarball has a single root directory, that directory is stripped
465
when extracting the tarball.
531
468
takes_args = ['source', 'tree?']
532
469
def run(self, source, tree=None):
533
470
from upstream_import import do_import
534
471
do_import(source, tree)
537
class cmd_cdiff(BzrToolsCommand):
473
class cmd_shove(bzrlib.commands.Command):
474
"""Apply uncommitted changes to another tree
476
This is useful when you start to make changes in one tree, then realize
477
they should really be done in a different tree.
479
Shove is implemented using merge, so:
480
- All changes, including renames and adds, will be applied.
481
- No changes that have already been applied will be applied.
482
- If the target is significantly different from the source, conflicts may
486
takes_args = ['target', 'source?']
487
def run(self, target, source='.'):
488
from shove import do_shove
489
do_shove(source, target)
491
class cmd_cdiff(bzrlib.commands.Command):
538
492
"""A color version of bzr's diff"""
539
493
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):
494
takes_options = property(lambda x: get_cmd_object('diff').takes_options)
495
def run(*args, **kwargs):
546
496
from colordiff import colordiff
547
colordiff(check_style, *args, **kwargs)
550
class cmd_rspush(BzrToolsCommand):
551
"""Upload this branch to another location using rsync.
553
If no location is specified, the last-used location will be used. To
554
prevent dirty trees from being uploaded, rspush will error out if there are
555
unknown files or local changes. It will also error out if the upstream
556
directory is non-empty and not an earlier version of the branch.
558
takes_args = ['location?']
559
takes_options = [Option('overwrite', help='Ignore differences between'
560
' branches and overwrite unconditionally.'),
561
Option('no-tree', help='Do not push the working tree,'
564
def run(self, location=None, overwrite=False, no_tree=False):
565
from bzrlib import workingtree
567
cur_branch = workingtree.WorkingTree.open_containing(".")[0]
568
bzrtools.rspush(cur_branch, location, overwrite=overwrite,
569
working_tree=not no_tree)
572
class cmd_link_tree(BzrToolsCommand):
573
"""Hardlink matching files to another tree.
575
Only files with identical content and execute bit will be linked.
577
takes_args = ['location']
579
def run(self, location):
580
from bzrlib import workingtree
581
from bzrlib.plugins.bzrtools.link_tree import link_tree
582
target_tree = workingtree.WorkingTree.open_containing(".")[0]
583
source_tree = workingtree.WorkingTree.open(location)
584
target_tree.lock_write()
586
source_tree.lock_read()
588
link_tree(target_tree, source_tree)
594
from heads import cmd_heads
497
colordiff(*args, **kwargs)
499
commands = [cmd_shelve, cmd_unshelve, cmd_shelf, cmd_clean_tree,
500
cmd_graph_ancestry, cmd_fetch_ghosts, cmd_patch, cmd_shell,
501
cmd_branch_history, cmd_zap, cmd_cbranch, cmd_branches,
502
cmd_multi_pull, cmd_switch, cmd_branch_mark, cmd_import, cmd_shove,
506
commands.append(rspush.cmd_rspush)
508
from errors import NoPyBaz
511
commands.append(baz_import.cmd_baz_import_branch)
512
commands.append(baz_import.cmd_baz_import)
515
class cmd_baz_import_branch(bzrlib.commands.Command):
516
"""Disabled. (Requires PyBaz)"""
517
takes_args = ['to_location?', 'from_branch?', 'reuse_history*']
518
takes_options = ['verbose', Option('max-count', type=int)]
519
def run(self, to_location=None, from_branch=None, fast=False,
520
max_count=None, verbose=False, dry_run=False,
521
reuse_history_list=[]):
522
print "This command is disabled. Please install PyBaz."
525
class cmd_baz_import(bzrlib.commands.Command):
526
"""Disabled. (Requires PyBaz)"""
527
takes_args = ['to_root_dir?', 'from_archive?', 'reuse_history*']
528
takes_options = ['verbose', Option('prefixes', type=str,
529
help="Prefixes of branches to import")]
530
def run(self, to_root_dir=None, from_archive=None, verbose=False,
531
reuse_history_list=[], prefixes=None):
532
print "This command is disabled. Please install PyBaz."
533
commands.extend((cmd_baz_import_branch, cmd_baz_import))
618
536
if hasattr(bzrlib.commands, 'register_command'):