1
# Copyright (C) 2005, 2006 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
3
20
Various useful plugins for working with bzr.
6
from errors import CommandError
26
__version__ = '0.14.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 bzr version %s is too old to be used with bzrtools'
51
' %s.' % (bzrlib.__version__, __version__))
52
# Not using BzrNewError, because it may not exist.
53
raise Exception, ('Version mismatch', version_info)
55
warning('Bzrtools is not up to date with installed bzr version %s.'
56
' \nThere should be a newer version available, e.g. %i.%i.'
57
% (bzrlib.__version__, bzrlib_version[0], bzrlib_version[1]))
58
if bzrlib_version != desired_plus:
59
raise Exception, 'Version mismatch'
62
check_bzrlib_version(version_info[:2])
65
from errors import CommandError, NoPyBaz
7
66
from patchsource import BzrPatchSource
8
67
from shelf import Shelf
9
from switch import cmd_switch
13
from bzrlib import DEFAULT_IGNORE
14
71
import bzrlib.builtins
16
72
import bzrlib.commands
17
73
from bzrlib.commands import get_cmd_object
18
74
from bzrlib.errors import BzrCommandError
19
75
from bzrlib.help import command_usage
20
77
from bzrlib.option import Option
21
78
sys.path.insert(0, os.path.realpath(os.path.join(os.path.dirname(__file__),
25
DEFAULT_IGNORE.append('./.shelf')
26
DEFAULT_IGNORE.append('./.bzr-shelf*')
83
bzrlib.ignores.add_runtime_ignores(['./.shelf'])
29
86
class cmd_clean_tree(bzrlib.commands.Command):
30
87
"""Remove unwanted files from working tree.
31
Normally, ignored files are left alone.
89
By default, only unknown files, not ignored files, are deleted. Versioned
90
files are never deleted.
92
Another class is 'detritus', which includes files emitted by bzr during
93
normal operations and selftests. (The value of these files decreases with
96
If no options are specified, unknown files are deleted. Otherwise, option
97
flags are respected, and may be combined.
99
To check what clean-tree will do, use --dry-run.
33
101
takes_options = [Option('ignored', help='delete all ignored files.'),
34
Option('detritus', help='delete conflict files merge'
35
' backups, and failed selftest dirs. (*.THIS, '
36
'*.BASE, *.OTHER, *~, *.tmp)'),
102
Option('detritus', help='delete conflict files, merge'
103
' backups, and failed selftest dirs.'),
105
help='delete files unknown to bzr. (default)'),
37
106
Option('dry-run', help='show files to delete instead of'
38
107
' deleting them.')]
39
def run(self, ignored=False, detritus=False, dry_run=False):
108
def run(self, unknown=False, ignored=False, detritus=False, dry_run=False):
40
109
from clean_tree import clean_tree
41
clean_tree('.', ignored=ignored, detritus=detritus, dry_run=dry_run)
110
if not (unknown or ignored or detritus):
112
clean_tree('.', unknown=unknown, ignored=ignored, detritus=detritus,
43
116
class cmd_graph_ancestry(bzrlib.commands.Command):
44
117
"""Produce ancestry graphs using dot.
351
435
Create a new checkout, associated with a new repository branch.
353
When you cbranch, bzr looks up the repository associated with your current
354
directory in branches.conf. It creates a new branch in that repository
355
with the same name and relative path as the checkout you request.
357
The branches.conf parameter is "cbranch_root". So if you want
358
cbranch operations in /home/jrandom/bigproject to produce branches in
359
/home/jrandom/bigproject/repository, you'd add this:
361
[/home/jrandom/bigproject]
362
cbranch_root = /home/jrandom/bigproject/repository
364
Note that if "/home/jrandom/bigproject/repository" isn't a repository,
365
standalone branches will be produced. Standalone branches will also
366
be produced if the source branch is in 0.7 format (or earlier).
437
When you cbranch, bzr looks up a target location in locations.conf, and
438
creates the branch there.
440
In your locations.conf, add the following lines:
441
[/working_directory_root]
442
cbranch_target = /branch_root
443
cbranch_target:policy = appendpath
445
This will mean that if you run "bzr cbranch foo/bar foo/baz" in the
446
working directory root, the branch will be created in
447
"/branch_root/foo/baz"
449
NOTE: cbranch also supports "cbranch_root", but that behaviour is
368
452
takes_options = [Option("lightweight",
369
help="Create a lightweight checkout")]
453
help="Create a lightweight checkout"), 'revision']
370
454
takes_args = ["source", "target?"]
371
def run(self, source, target=None, lightweight=False):
455
def run(self, source, target=None, lightweight=False, revision=None):
372
456
from cbranch import cbranch
373
return cbranch(source, target, lightweight=lightweight)
457
return cbranch(source, target, lightweight=lightweight,
376
461
class cmd_branches(bzrlib.commands.Command):
483
552
from colordiff import colordiff
484
553
colordiff(*args, **kwargs)
486
commands = [cmd_shelve, cmd_unshelve, cmd_shelf, cmd_clean_tree,
487
cmd_graph_ancestry, cmd_fetch_ghosts, cmd_patch, cmd_shell,
488
cmd_branch_history, cmd_zap, cmd_cbranch, cmd_branches,
489
cmd_multi_pull, cmd_switch, cmd_branch_mark, cmd_import, cmd_shove,
493
commands.append(rspush.cmd_rspush)
495
from errors import NoPyBaz
498
commands.append(baz_import.cmd_baz_import_branch)
499
commands.append(baz_import.cmd_baz_import)
502
class cmd_baz_import_branch(bzrlib.commands.Command):
503
"""Disabled. (Requires PyBaz)"""
504
takes_args = ['to_location?', 'from_branch?', 'reuse_history*']
505
takes_options = ['verbose', Option('max-count', type=int)]
506
def run(self, to_location=None, from_branch=None, fast=False,
507
max_count=None, verbose=False, dry_run=False,
508
reuse_history_list=[]):
509
print "This command is disabled. Please install PyBaz."
512
class cmd_baz_import(bzrlib.commands.Command):
513
"""Disabled. (Requires PyBaz)"""
514
takes_args = ['to_root_dir?', 'from_archive?', 'reuse_history*']
515
takes_options = ['verbose', Option('prefixes', type=str,
516
help="Prefixes of branches to import")]
517
def run(self, to_root_dir=None, from_archive=None, verbose=False,
518
reuse_history_list=[], prefixes=None):
519
print "This command is disabled. Please install PyBaz."
520
commands.extend((cmd_baz_import_branch, cmd_baz_import))
556
class cmd_baz_import(bzrlib.commands.Command):
557
"""Import an Arch or Baz archive into a bzr repository.
559
This command should be used on local archives (or mirrors) only. It is
560
quite slow on remote archives.
562
reuse_history allows you to specify any previous imports you
563
have done of different archives, which this archive has branches
564
tagged from. This will dramatically reduce the time to convert
565
the archive as it will not have to convert the history already
566
converted in that other branch.
568
If you specify prefixes, only branches whose names start with that prefix
569
will be imported. Skipped branches will be listed, so you can import any
570
branches you missed by accident. Here's an example of doing a partial
571
import from thelove@canonical.com:
572
bzr baz-import thelove thelove@canonical.com --prefixes dists:talloc-except
574
WARNING: Encoding should not be specified unless necessary, because if you
575
specify an encoding, your converted branch will not interoperate with
576
independently-converted branches, unless the other branches were converted
577
with exactly the same encoding. Any encoding recognized by Python may
578
be specified. Aliases are not detected, so 'utf_8', 'U8', 'UTF' and 'utf8'
581
takes_args = ['to_root_dir', 'from_archive', 'reuse_history*']
582
takes_options = ['verbose', Option('prefixes', type=str,
583
help="Prefixes of branches to import, colon-separated"),
584
Option('encoding', type=str,
585
help='Force encoding to specified value. See WARNING.')]
587
def run(self, to_root_dir, from_archive, encoding=None, verbose=False,
588
reuse_history_list=[], prefixes=None):
589
from errors import NoPyBaz
592
baz_import.baz_import(to_root_dir, from_archive, encoding,
593
verbose, reuse_history_list, prefixes)
595
print "This command is disabled. Please install PyBaz."
598
class cmd_baz_import_branch(bzrlib.commands.Command):
599
"""Import an Arch or Baz branch into a bzr branch.
601
WARNING: Encoding should not be specified unless necessary, because if you
602
specify an encoding, your converted branch will not interoperate with
603
independently-converted branches, unless the other branches were converted
604
with exactly the same encoding. Any encoding recognized by Python may
605
be specified. Aliases are not detected, so 'utf_8', 'U8', 'UTF' and 'utf8'
608
takes_args = ['to_location', 'from_branch?', 'reuse_history*']
609
takes_options = ['verbose', Option('max-count', type=int),
610
Option('encoding', type=str,
611
help='Force encoding to specified value. See WARNING.')]
613
def run(self, to_location, from_branch=None, fast=False, max_count=None,
614
encoding=None, verbose=False, dry_run=False,
615
reuse_history_list=[]):
616
from errors import NoPyBaz
619
baz_import.baz_import_branch(to_location, from_branch, fast,
620
max_count, verbose, encoding, dry_run,
623
print "This command is disabled. Please install PyBaz."
626
class cmd_rspush(bzrlib.commands.Command):
627
"""Upload this branch to another location using rsync.
629
If no location is specified, the last-used location will be used. To
630
prevent dirty trees from being uploaded, rspush will error out if there are
631
unknown files or local changes. It will also error out if the upstream
632
directory is non-empty and not an earlier version of the branch.
634
takes_args = ['location?']
635
takes_options = [Option('overwrite', help='Ignore differences between'
636
' branches and overwrite unconditionally'),
637
Option('no-tree', help='Do not push the working tree,'
640
def run(self, location=None, overwrite=False, no_tree=False):
641
from bzrlib import workingtree
643
cur_branch = workingtree.WorkingTree.open_containing(".")[0]
644
bzrtools.rspush(cur_branch, location, overwrite=overwrite,
645
working_tree=not no_tree)
648
class cmd_switch(bzrlib.commands.Command):
649
"""Set the branch of a lightweight checkout and update."""
651
takes_args = ['to_location']
653
def run(self, to_location):
654
from switch import cmd_switch
655
cmd_switch().run(to_location)
660
cmd_baz_import_branch,
523
682
if hasattr(bzrlib.commands, 'register_command'):