1
# Copyright (C) 2005, 2006, 2007 Aaron Bentley <aaron.bentley@utoronto.ca>
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.
26
__version__ = '0.17.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:
45
from bzrlib.trace import warning
47
# get the message out any way we can
48
from warnings import warn as warning
49
if bzrlib_version < desired:
50
warning('Installed Bazaar version %s is too old to be used with'
52
'"Bzrtools" %s.' % (bzrlib.__version__, __version__))
53
# Not using BzrNewError, because it may not exist.
54
raise Exception, ('Version mismatch', version_info)
56
warning('Plugin "Bzrtools" is not up to date with installed Bazaar'
58
' There should be a newer version of Bzrtools available, e.g.'
60
% (bzrlib.__version__, bzrlib_version[0], bzrlib_version[1]))
61
if bzrlib_version != desired_plus:
62
raise Exception, 'Version mismatch'
65
check_bzrlib_version(version_info[:2])
67
from bzrlib.lazy_import import lazy_import
68
lazy_import(globals(), """
69
from bzrlib import help
73
from errors import CommandError, NoPyBaz
6
from errors import CommandError
74
7
from patchsource import BzrPatchSource
8
from shelf import Shelf
9
from switch import cmd_switch
13
from bzrlib import DEFAULT_IGNORE
78
14
import bzrlib.builtins
79
16
import bzrlib.commands
80
from bzrlib.commands import get_cmd_object
81
17
from bzrlib.errors import BzrCommandError
18
from bzrlib.help import command_usage
83
19
from bzrlib.option import Option
84
20
sys.path.insert(0, os.path.realpath(os.path.join(os.path.dirname(__file__),
89
bzrlib.ignores.add_runtime_ignores(['./.shelf'])
24
DEFAULT_IGNORE.append('./.shelf')
25
DEFAULT_IGNORE.append('./.bzr-shelf*')
92
28
class cmd_clean_tree(bzrlib.commands.Command):
93
"""Remove unwanted files from working tree.
95
By default, only unknown files, not ignored files, are deleted. Versioned
96
files are never deleted.
98
Another class is 'detritus', which includes files emitted by bzr during
99
normal operations and selftests. (The value of these files decreases with
102
If no options are specified, unknown files are deleted. Otherwise, option
103
flags are respected, and may be combined.
105
To check what clean-tree will do, use --dry-run.
29
"""Remove unwanted files from working tree. <BZRTOOLS>
30
Normally, ignored files are left alone.
107
32
takes_options = [Option('ignored', help='delete all ignored files.'),
108
Option('detritus', help='delete conflict files, merge'
109
' backups, and failed selftest dirs.'),
111
help='delete files unknown to bzr. (default)'),
33
Option('detritus', help='delete conflict files merge'
34
' backups, and failed selftest dirs. (*.THIS, '
35
'*.BASE, *.OTHER, *~, *.tmp)'),
112
36
Option('dry-run', help='show files to delete instead of'
113
37
' deleting them.')]
114
def run(self, unknown=False, ignored=False, detritus=False, dry_run=False):
38
def run(self, ignored=False, detritus=False, dry_run=False):
115
39
from clean_tree import clean_tree
116
if not (unknown or ignored or detritus):
118
clean_tree('.', unknown=unknown, ignored=ignored, detritus=detritus,
40
clean_tree('.', ignored=ignored, detritus=detritus, dry_run=dry_run)
122
42
class cmd_graph_ancestry(bzrlib.commands.Command):
123
"""Produce ancestry graphs using dot.
43
"""Produce ancestry graphs using dot. <BZRTOOLS>
125
45
Output format is detected according to file extension. Some of the more
126
46
common output formats are html, png, gif, svg, ps. An extension of '.dot'
443
344
class cmd_cbranch(bzrlib.commands.Command):
445
Create a new checkout, associated with a new repository branch.
346
Create a new checkout, associated with a new repository branch. <BZRTOOLS>
447
When you cbranch, bzr looks up a target location in locations.conf, and
448
creates the branch there.
450
In your locations.conf, add the following lines:
451
[/working_directory_root]
452
cbranch_target = /branch_root
453
cbranch_target:policy = appendpath
455
This will mean that if you run "bzr cbranch foo/bar foo/baz" in the
456
working directory root, the branch will be created in
457
"/branch_root/foo/baz"
459
NOTE: cbranch also supports "cbranch_root", but that behaviour is
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).
462
363
takes_options = [Option("lightweight",
463
help="Create a lightweight checkout"), 'revision']
364
help="Create a lightweight checkout")]
464
365
takes_args = ["source", "target?"]
465
def run(self, source, target=None, lightweight=False, revision=None):
366
def run(self, source, target=None, lightweight=False):
466
367
from cbranch import cbranch
467
return cbranch(source, target, lightweight=lightweight,
368
return cbranch(source, target, lightweight=lightweight)
471
371
class cmd_branches(bzrlib.commands.Command):
472
"""Scan a location for branches"""
372
"""Scan a location for branches <BZRTOOLS>"""
473
373
takes_args = ["location?"]
474
374
def run(self, location=None):
475
375
from branches import branches
553
452
from upstream_import import do_import
554
453
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 = ['source?', 'target']
469
def run(self, target, source='.'):
470
from shove import do_shove
471
do_shove(source, target)
557
473
class cmd_cdiff(bzrlib.commands.Command):
558
"""A color version of bzr's diff"""
559
takes_args = property(lambda x: get_cmd_object('diff').takes_args)
561
def _takes_options(self):
562
options = list(get_cmd_object('diff').takes_options)
563
options.append(Option('check-style',
564
help='Warn if trailing whitespace or spurious changes have been'
568
takes_options = property(_takes_options)
570
def run(self, check_style=False, *args, **kwargs):
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):
571
478
from colordiff import colordiff
572
colordiff(check_style, *args, **kwargs)
575
class cmd_baz_import(bzrlib.commands.Command):
576
"""Import an Arch or Baz archive into a bzr repository.
578
This command should be used on local archives (or mirrors) only. It is
579
quite slow on remote archives.
581
reuse_history allows you to specify any previous imports you
582
have done of different archives, which this archive has branches
583
tagged from. This will dramatically reduce the time to convert
584
the archive as it will not have to convert the history already
585
converted in that other branch.
587
If you specify prefixes, only branches whose names start with that prefix
588
will be imported. Skipped branches will be listed, so you can import any
589
branches you missed by accident. Here's an example of doing a partial
590
import from thelove@canonical.com:
591
bzr baz-import thelove thelove@canonical.com --prefixes dists:talloc-except
593
WARNING: Encoding should not be specified unless necessary, because if you
594
specify an encoding, your converted branch will not interoperate with
595
independently-converted branches, unless the other branches were converted
596
with exactly the same encoding. Any encoding recognized by Python may
597
be specified. Aliases are not detected, so 'utf_8', 'U8', 'UTF' and 'utf8'
600
takes_args = ['to_root_dir', 'from_archive', 'reuse_history*']
601
takes_options = ['verbose', Option('prefixes', type=str,
602
help="Prefixes of branches to import, colon-separated"),
603
Option('encoding', type=str,
604
help='Force encoding to specified value. See WARNING.')]
606
def run(self, to_root_dir, from_archive, encoding=None, verbose=False,
607
reuse_history_list=[], prefixes=None):
608
from errors import NoPyBaz
611
baz_import.baz_import(to_root_dir, from_archive, encoding,
612
verbose, reuse_history_list, prefixes)
614
print "This command is disabled. Please install PyBaz."
617
class cmd_baz_import_branch(bzrlib.commands.Command):
618
"""Import an Arch or Baz branch into a bzr branch.
620
WARNING: Encoding should not be specified unless necessary, because if you
621
specify an encoding, your converted branch will not interoperate with
622
independently-converted branches, unless the other branches were converted
623
with exactly the same encoding. Any encoding recognized by Python may
624
be specified. Aliases are not detected, so 'utf_8', 'U8', 'UTF' and 'utf8'
627
takes_args = ['to_location', 'from_branch?', 'reuse_history*']
628
takes_options = ['verbose', Option('max-count', type=int),
629
Option('encoding', type=str,
630
help='Force encoding to specified value. See WARNING.')]
632
def run(self, to_location, from_branch=None, fast=False, max_count=None,
633
encoding=None, verbose=False, dry_run=False,
634
reuse_history_list=[]):
635
from errors import NoPyBaz
638
baz_import.baz_import_branch(to_location, from_branch, fast,
639
max_count, verbose, encoding, dry_run,
642
print "This command is disabled. Please install PyBaz."
645
class cmd_rspush(bzrlib.commands.Command):
646
"""Upload this branch to another location using rsync.
648
If no location is specified, the last-used location will be used. To
649
prevent dirty trees from being uploaded, rspush will error out if there are
650
unknown files or local changes. It will also error out if the upstream
651
directory is non-empty and not an earlier version of the branch.
653
takes_args = ['location?']
654
takes_options = [Option('overwrite', help='Ignore differences between'
655
' branches and overwrite unconditionally'),
656
Option('no-tree', help='Do not push the working tree,'
659
def run(self, location=None, overwrite=False, no_tree=False):
660
from bzrlib import workingtree
662
cur_branch = workingtree.WorkingTree.open_containing(".")[0]
663
bzrtools.rspush(cur_branch, location, overwrite=overwrite,
664
working_tree=not no_tree)
667
class cmd_switch(bzrlib.commands.Command):
668
"""Set the branch of a lightweight checkout and update."""
670
takes_args = ['to_location']
672
def run(self, to_location):
673
from switch import cmd_switch
674
cmd_switch().run(to_location)
679
cmd_baz_import_branch,
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))
701
518
if hasattr(bzrlib.commands, 'register_command'):