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
2
20
Various useful plugins for working with bzr.
11
version_info = tuple(int(n) for n in __version__.split('.'))
14
def check_bzrlib_version(desired):
15
"""Check that bzrlib is compatible.
17
If version is < bzrtools version, assume incompatible.
18
If version == bzrtools version, assume completely compatible
19
If version == bzrtools version + 1, assume compatible, with deprecations
20
Otherwise, assume incompatible.
22
desired_plus = (desired[0], desired[1]+1)
23
bzrlib_version = bzrlib.version_info[:2]
24
if bzrlib_version == desired:
27
from bzrlib.trace import warning
29
# get the message out any way we can
30
from warnings import warn as warning
31
if bzrlib_version < desired:
32
warning('Installed bzr version %s is too old to be used with bzrtools'
33
' %s.' % (bzrlib.__version__, __version__))
34
# Not using BzrNewError, because it may not exist.
35
raise Exception, ('Version mismatch', version_info)
37
warning('Bzrtools is not up to date with installed bzr version %s.'
38
' \nThere should be a newer version available, e.g. %i.%i.'
39
% (bzrlib.__version__, bzrlib_version[0], bzrlib_version[1]))
40
if bzrlib_version != desired_plus:
41
raise Exception, 'Version mismatch'
44
check_bzrlib_version(version_info[:2])
25
from bzrlib.lazy_import import lazy_import
26
lazy_import(globals(), """
27
from bzrlib import help
31
from version import version_info, __version__
32
from command import BzrToolsCommand
48
33
from errors import CommandError, NoPyBaz
49
34
from patchsource import BzrPatchSource
50
from shelf import Shelf
51
from switch import cmd_switch
55
38
import bzrlib.builtins
57
39
import bzrlib.commands
58
40
from bzrlib.commands import get_cmd_object
59
41
from bzrlib.errors import BzrCommandError
60
from bzrlib.help import command_usage
61
42
import bzrlib.ignores
62
43
from bzrlib.option import Option
63
sys.path.insert(0, os.path.realpath(os.path.join(os.path.dirname(__file__),
44
sys.path.insert(0, os.path.realpath(os.path.join(os.path.dirname(__file__),
48
from command import BzrToolsCommand
66
50
bzrlib.ignores.add_runtime_ignores(['./.shelf'])
69
class cmd_clean_tree(bzrlib.commands.Command):
53
class cmd_clean_tree(BzrToolsCommand):
70
54
"""Remove unwanted files from working tree.
72
56
By default, only unknown files, not ignored files, are deleted. Versioned
82
66
To check what clean-tree will do, use --dry-run.
84
takes_options = [Option('ignored', help='delete all ignored files.'),
85
Option('detritus', help='delete conflict files, merge'
86
' backups, and failed selftest dirs.'),
88
help='delete files unknown to bzr. (default)'),
89
Option('dry-run', help='show files to delete instead of'
68
takes_options = [Option('ignored', help='Delete all ignored files.'),
69
Option('detritus', help='Delete conflict files, merge'
70
' backups, and failed selftest dirs.'),
72
help='Delete files unknown to bzr (default).'),
73
Option('dry-run', help='Show files to delete instead of'
90
74
' deleting them.')]
91
75
def run(self, unknown=False, ignored=False, detritus=False, dry_run=False):
92
76
from clean_tree import clean_tree
131
115
If available, rsvg is used to antialias PNG and JPEG output, but this can
132
116
be disabled with --no-antialias.
134
takes_args = ['branch', 'file']
135
takes_options = [Option('no-collapse', help="Do not skip simple nodes"),
118
takes_args = ['file', 'merge_branch?']
119
takes_options = [Option('no-collapse', help="Do not skip simple nodes."),
136
120
Option('no-antialias',
137
help="Do not use rsvg to produce antialiased output"),
138
Option('merge-branch', type=str,
139
help="Use this branch to calcuate a merge base"),
140
Option('cluster', help="Use clustered output.")]
141
def run(self, branch, file, no_collapse=False, no_antialias=False,
142
merge_branch=None, cluster=False):
121
help="Do not use rsvg to produce antialiased output."),
122
Option('merge-branch', type=str,
123
help="Use this branch to calcuate a merge base."),
124
Option('cluster', help="Use clustered output."),
125
Option('max-distance',
126
help="Show no nodes farther than this.", type=int),
128
help='Source branch to use (default is current'
133
def run(self, file, merge_branch=None, no_collapse=False,
134
no_antialias=False, cluster=False, max_distance=100,
136
if max_distance == -1:
145
140
ranking = "cluster"
147
142
ranking = "forced"
148
graph.write_ancestry_file(branch, file, not no_collapse,
149
not no_antialias, merge_branch, ranking)
152
class cmd_fetch_ghosts(bzrlib.commands.Command):
143
graph.write_ancestry_file(directory, file, not no_collapse,
144
not no_antialias, merge_branch, ranking,
145
max_distance=max_distance)
148
class cmd_fetch_ghosts(BzrToolsCommand):
153
149
"""Attempt to retrieve ghosts from another branch.
154
150
If the other branch is not supplied, the last-pulled branch is used.
156
152
aliases = ['fetch-missing']
157
153
takes_args = ['branch?']
158
takes_options = [Option('no-fix')]
154
takes_options = [Option('no-fix', help="Skip additional synchonization.")]
159
155
def run(self, branch=None, no_fix=False):
160
156
from fetch_ghosts import fetch_ghosts
161
157
fetch_ghosts(branch, no_fix)
163
159
strip_help="""Strip the smallest prefix containing num leading slashes from \
164
160
each file name found in the patch file."""
165
Option.OPTIONS['bzrdiff'] = Option('bzrdiff',type=None,
166
help="""Handle extra bzr tags""")
169
class cmd_patch(bzrlib.commands.Command):
163
class cmd_patch(BzrToolsCommand):
170
164
"""Apply a named patch to the current tree.
172
166
takes_args = ['filename?']
173
takes_options = [Option('strip', type=int, help=strip_help)]
174
def run(self, filename=None, strip=-1, bzrdiff=0):
167
takes_options = [Option('strip', type=int, help=strip_help),
168
Option('silent', help='Suppress chatter.')]
169
def run(self, filename=None, strip=None, silent=False):
175
170
from patch import patch
176
171
from bzrlib.workingtree import WorkingTree
177
172
wt = WorkingTree.open_containing('.')[0]
179
if bzrdiff: strip = 0
182
return patch(wt, filename, strip, legacy= not bzrdiff)
185
class cmd_shelve(bzrlib.commands.Command):
175
return patch(wt, filename, strip, silent)
178
class cmd_shelve(BzrToolsCommand):
186
179
"""Temporarily set aside some changes from the current tree.
188
181
Shelve allows you to temporarily put changes you've made "on the shelf",
344
345
See 'shelve' for more information.
346
347
takes_options = [
347
Option('all', help='Unshelve all changes without prompting'),
348
Option('force', help='Force unshelving even if errors occur'),
349
Option('no-color', help='Never display changes in color')
348
Option('all', help='Unshelve all changes without prompting.'),
349
Option('force', help='Force unshelving even if errors occur.'),
350
Option('no-color', help='Never display changes in color.')
351
352
takes_args = ['patch?']
352
353
def run(self, patch=None, all=False, force=False, no_color=False):
353
354
source = BzrPatchSource()
354
s = Shelf(source.base)
355
s = shelf.Shelf(source.base)
355
356
s.unshelve(source, patch, all, force, no_color)
359
class cmd_shell(bzrlib.commands.Command):
360
class cmd_shell(BzrToolsCommand):
360
361
"""Begin an interactive shell tailored for bzr.
361
362
Bzr commands can be used without typing bzr first, and will be run natively
362
363
when possible. Tab completion is tailored for bzr. The shell prompt shows
404
405
If --branch is specified, the branch will be deleted too, but only if the
405
406
the branch has no new commits (relative to its parent).
407
takes_options = [Option("branch", help="Remove associtated branch from"
408
takes_options = [Option("branch", help="Remove associated branch from"
409
410
takes_args = ["checkout"]
410
411
def run(self, checkout, branch=False):
411
412
from zap import zap
412
413
return zap(checkout, remove_branch=branch)
415
class cmd_cbranch(bzrlib.commands.Command):
416
class cmd_cbranch(BzrToolsCommand):
417
418
Create a new checkout, associated with a new repository branch.
419
When you cbranch, bzr looks up the repository associated with your current
420
directory in locations.conf. It creates a new branch in that repository
421
with the same name and relative path as the checkout you request.
423
The locations.conf parameter is "cbranch_root". So if you want
424
cbranch operations in /home/jrandom/bigproject to produce branches in
425
/home/jrandom/bigproject/repository, you'd add this:
427
[/home/jrandom/bigproject]
428
cbranch_root = /home/jrandom/bigproject/repository
430
Note that if "/home/jrandom/bigproject/repository" isn't a repository,
431
standalone branches will be produced. Standalone branches will also
432
be produced if the source branch is in 0.7 format (or earlier).
420
When you cbranch, bzr looks up a target location in locations.conf, and
421
creates the branch there.
423
In your locations.conf, add the following lines:
424
[/working_directory_root]
425
cbranch_target = /branch_root
426
cbranch_target:policy = appendpath
428
This will mean that if you run "bzr cbranch foo/bar foo/baz" in the
429
working directory root, the branch will be created in
430
"/branch_root/foo/baz"
432
NOTE: cbranch also supports "cbranch_root", but that behaviour is
434
takes_options = [Option("lightweight",
435
help="Create a lightweight checkout"), 'revision']
435
takes_options = [Option("lightweight",
436
help="Create a lightweight checkout."), 'revision']
436
437
takes_args = ["source", "target?"]
437
438
def run(self, source, target=None, lightweight=False, revision=None):
438
439
from cbranch import cbranch
439
return cbranch(source, target, lightweight=lightweight,
440
return cbranch(source, target, lightweight=lightweight,
440
441
revision=revision)
443
class cmd_branches(bzrlib.commands.Command):
444
class cmd_branches(BzrToolsCommand):
444
445
"""Scan a location for branches"""
445
446
takes_args = ["location?"]
446
447
def run(self, location=None):
500
501
These marks can be used to track a branch's status.
502
503
takes_args = ['mark?', 'branch?']
503
takes_options = [Option('delete', help='Delete this mark')]
504
takes_options = [Option('delete', help='Delete this mark.')]
504
505
def run(self, mark=None, branch=None, delete=False):
505
506
from branch_mark import branch_mark
506
507
branch_mark(mark, branch, delete)
509
class cmd_import(bzrlib.commands.Command):
510
"""Import sources from a tarball
512
This command will import a tarball into a bzr tree, replacing any versioned
513
files already present. If a directory is specified, it is used as the
514
target. If the directory does not exist, or is not versioned, it is
510
class cmd_import(BzrToolsCommand):
511
"""Import sources from a directory, tarball or zip file
513
This command will import a directory, tarball or zip file into a bzr
514
tree, replacing any versioned files already present. If a directory is
515
specified, it is used as the target. If the directory does not exist, or
516
is not versioned, it is created.
517
518
Tarballs may be gzip or bzip2 compressed. This is autodetected.
519
If the tarball has a single root directory, that directory is stripped
520
when extracting the tarball.
520
If the tarball or zip has a single root directory, that directory is
521
stripped when extracting the tarball. This is not done for directories.
523
524
takes_args = ['source', 'tree?']
524
525
def run(self, source, tree=None):
525
526
from upstream_import import do_import
526
527
do_import(source, tree)
529
class cmd_cdiff(bzrlib.commands.Command):
530
class cmd_cdiff(BzrToolsCommand):
530
531
"""A color version of bzr's diff"""
531
532
takes_args = property(lambda x: get_cmd_object('diff').takes_args)
532
takes_options = property(lambda x: get_cmd_object('diff').takes_options)
533
def run(*args, **kwargs):
533
takes_options = list(get_cmd_object('diff').takes_options) + [
534
Option('check-style',
535
help='Warn if trailing whitespace or spurious changes have been'
538
def run(self, check_style=False, *args, **kwargs):
534
539
from colordiff import colordiff
535
colordiff(*args, **kwargs)
538
class cmd_baz_import(bzrlib.commands.Command):
540
colordiff(check_style, *args, **kwargs)
543
class cmd_baz_import(BzrToolsCommand):
539
544
"""Import an Arch or Baz archive into a bzr repository.
541
546
This command should be used on local archives (or mirrors) only. It is
542
547
quite slow on remote archives.
544
reuse_history allows you to specify any previous imports you
549
reuse_history allows you to specify any previous imports you
545
550
have done of different archives, which this archive has branches
546
tagged from. This will dramatically reduce the time to convert
551
tagged from. This will dramatically reduce the time to convert
547
552
the archive as it will not have to convert the history already
548
553
converted in that other branch.
552
557
branches you missed by accident. Here's an example of doing a partial
553
558
import from thelove@canonical.com:
554
559
bzr baz-import thelove thelove@canonical.com --prefixes dists:talloc-except
561
WARNING: Encoding should not be specified unless necessary, because if you
562
specify an encoding, your converted branch will not interoperate with
563
independently-converted branches, unless the other branches were converted
564
with exactly the same encoding. Any encoding recognized by Python may
565
be specified. Aliases are not detected, so 'utf_8', 'U8', 'UTF' and 'utf8'
556
568
takes_args = ['to_root_dir', 'from_archive', 'reuse_history*']
557
569
takes_options = ['verbose', Option('prefixes', type=str,
558
help="Prefixes of branches to import, colon-separated")]
570
help="Prefixes of branches to import, colon-separated."),
571
Option('encoding', type=str,
572
help='Force encoding to specified value. See WARNING.')]
560
def run(self, to_root_dir, from_archive, verbose=False,
574
def run(self, to_root_dir, from_archive, encoding=None, verbose=False,
561
575
reuse_history_list=[], prefixes=None):
562
576
from errors import NoPyBaz
564
578
import baz_import
565
baz_import.baz_import(to_root_dir, from_archive,
579
baz_import.baz_import(to_root_dir, from_archive, encoding,
566
580
verbose, reuse_history_list, prefixes)
568
582
print "This command is disabled. Please install PyBaz."
571
class cmd_baz_import_branch(bzrlib.commands.Command):
572
"""Import an Arch or Baz branch into a bzr branch."""
585
class cmd_baz_import_branch(BzrToolsCommand):
586
"""Import an Arch or Baz branch into a bzr branch.
588
WARNING: Encoding should not be specified unless necessary, because if you
589
specify an encoding, your converted branch will not interoperate with
590
independently-converted branches, unless the other branches were converted
591
with exactly the same encoding. Any encoding recognized by Python may
592
be specified. Aliases are not detected, so 'utf_8', 'U8', 'UTF' and 'utf8'
573
595
takes_args = ['to_location', 'from_branch?', 'reuse_history*']
574
takes_options = ['verbose', Option('max-count', type=int)]
596
takes_options = ['verbose',
597
Option('max-count', type=int,
598
help='Maximim revisions to import at once.'),
599
Option('encoding', type=str,
600
help='Force encoding to specified value. See WARNING.')]
576
602
def run(self, to_location, from_branch=None, fast=False, max_count=None,
577
verbose=False, dry_run=False, reuse_history_list=[]):
603
encoding=None, verbose=False, dry_run=False,
604
reuse_history_list=[]):
578
605
from errors import NoPyBaz
580
607
import baz_import
581
baz_import.baz_import_branch(to_location, from_branch, fast,
582
max_count, verbose, dry_run,
608
baz_import.baz_import_branch(to_location, from_branch, fast,
609
max_count, verbose, encoding, dry_run,
583
610
reuse_history_list)
585
612
print "This command is disabled. Please install PyBaz."
615
class cmd_rspush(BzrToolsCommand):
616
"""Upload this branch to another location using rsync.
618
If no location is specified, the last-used location will be used. To
619
prevent dirty trees from being uploaded, rspush will error out if there are
620
unknown files or local changes. It will also error out if the upstream
621
directory is non-empty and not an earlier version of the branch.
623
takes_args = ['location?']
624
takes_options = [Option('overwrite', help='Ignore differences between'
625
' branches and overwrite unconditionally.'),
626
Option('no-tree', help='Do not push the working tree,'
629
def run(self, location=None, overwrite=False, no_tree=False):
630
from bzrlib import workingtree
632
cur_branch = workingtree.WorkingTree.open_containing(".")[0]
633
bzrtools.rspush(cur_branch, location, overwrite=overwrite,
634
working_tree=not no_tree)
637
class cmd_switch(BzrToolsCommand):
638
"""Set the branch of a lightweight checkout and update."""
640
takes_args = ['to_location']
642
def run(self, to_location):
643
from switch import cmd_switch
644
cmd_switch().run(to_location)
590
649
cmd_baz_import_branch,
592
651
cmd_branch_history,
597
656
cmd_fetch_ghosts,
added
removed
__init__.py
