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
3
20
Various useful plugins for working with bzr.
7
from errors import CommandError
26
__version__ = '0.16.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
8
74
from patchsource import BzrPatchSource
9
from shelf import Shelf
10
from switch import cmd_switch
78
import bzrlib.builtins
79
import bzrlib.commands
80
from bzrlib.commands import get_cmd_object
81
from bzrlib.errors import BzrCommandError
13
83
from bzrlib.option import Option
15
from bzrlib.errors import BzrCommandError
16
sys.path.insert(0, os.path.realpath(os.path.join(os.path.dirname(__file__),
84
sys.path.insert(0, os.path.realpath(os.path.join(os.path.dirname(__file__),
18
from bzrlib import DEFAULT_IGNORE
21
DEFAULT_IGNORE.append('./.shelf')
22
DEFAULT_IGNORE.append('./.bzr-shelf*')
25
Option.OPTIONS['ignored'] = Option('ignored',
26
help='delete all ignored files.')
27
Option.OPTIONS['detritus'] = Option('detritus',
28
help='delete conflict files merge backups, and failed selftest dirs.' +
29
'(*.THIS, *.BASE, *.OTHER, *~, *.tmp')
30
Option.OPTIONS['dry-run'] = Option('dry-run',
31
help='show files to delete instead of deleting them.')
89
bzrlib.ignores.add_runtime_ignores(['./.shelf'])
33
92
class cmd_clean_tree(bzrlib.commands.Command):
34
"""Remove unwanted files from working tree. <BZRTOOLS>
35
Normally, ignored files are left alone.
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.
37
takes_options = ['ignored', 'detritus', 'dry-run']
38
def run(self, ignored=False, detritus=False, dry_run=False):
107
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)'),
112
Option('dry-run', help='show files to delete instead of'
114
def run(self, unknown=False, ignored=False, detritus=False, dry_run=False):
39
115
from clean_tree import clean_tree
40
clean_tree('.', ignored=ignored, detritus=detritus, dry_run=dry_run)
116
if not (unknown or ignored or detritus):
118
clean_tree('.', out=self.outf, unknown=unknown, ignored=ignored,
119
detritus=detritus, dry_run=dry_run)
42
Option.OPTIONS['merge-branch'] = Option('merge-branch',type=str)
44
122
class cmd_graph_ancestry(bzrlib.commands.Command):
45
"""Produce ancestry graphs using dot. <BZRTOOLS>
123
"""Produce ancestry graphs using dot.
47
125
Output format is detected according to file extension. Some of the more
48
126
common output formats are html, png, gif, svg, ps. An extension of '.dot'
49
127
will cause a dot graph file to be produced. HTML output has mouseovers
77
155
be disabled with --no-antialias.
79
157
takes_args = ['branch', 'file']
80
takes_options = [Option('no-collapse', help="Do not skip simple nodes"),
158
takes_options = [Option('no-collapse', help="Do not skip simple nodes"),
81
159
Option('no-antialias',
82
help="Do not use rsvg to produce antialiased output"),
83
Option('merge-branch', type=str,
84
help="Use this branch to calcuate a merge base"),
85
Option('cluster', help="Use clustered output.")]
160
help="Do not use rsvg to produce antialiased output"),
161
Option('merge-branch', type=str,
162
help="Use this branch to calcuate a merge base"),
163
Option('cluster', help="Use clustered output."),
164
Option('max-distance', help="Show no nodes farther than this",
86
166
def run(self, branch, file, no_collapse=False, no_antialias=False,
87
merge_branch=None, cluster=False):
167
merge_branch=None, cluster=False, max_distance=None):
90
170
ranking = "cluster"
92
172
ranking = "forced"
93
graph.write_ancestry_file(branch, file, not no_collapse,
94
not no_antialias, merge_branch, ranking)
173
graph.write_ancestry_file(branch, file, not no_collapse,
174
not no_antialias, merge_branch, ranking,
175
max_distance=max_distance)
96
178
class cmd_fetch_ghosts(bzrlib.commands.Command):
97
"""Attempt to retrieve ghosts from another branch. <BZRTOOLS>
179
"""Attempt to retrieve ghosts from another branch.
98
180
If the other branch is not supplied, the last-pulled branch is used.
100
182
aliases = ['fetch-missing']
107
189
strip_help="""Strip the smallest prefix containing num leading slashes from \
108
190
each file name found in the patch file."""
109
Option.OPTIONS['strip'] = Option('strip', type=int, help=strip_help)
110
Option.OPTIONS['bzrdiff'] = Option('bzrdiff',type=None,
111
help="""Handle extra bzr tags""")
112
193
class cmd_patch(bzrlib.commands.Command):
113
"""Apply a named patch to the current tree. <BZRTOOLS>
194
"""Apply a named patch to the current tree.
115
196
takes_args = ['filename?']
116
takes_options = ['strip','bzrdiff']
117
def run(self, filename=None, strip=-1, bzrdiff=0):
197
takes_options = [Option('strip', type=int, help=strip_help),
198
Option('silent', help='Suppress chatter')]
199
def run(self, filename=None, strip=None, silent=False):
118
200
from patch import patch
119
201
from bzrlib.workingtree import WorkingTree
120
202
wt = WorkingTree.open_containing('.')[0]
122
if bzrdiff: strip = 0
205
return patch(wt, filename, strip, silent)
125
return patch(wt, filename, strip, legacy= not bzrdiff)
127
208
class cmd_shelve(bzrlib.commands.Command):
128
"""Temporarily set aside some changes from the current tree. <BZRTOOLS>
209
"""Temporarily set aside some changes from the current tree.
130
211
Shelve allows you to temporarily put changes you've made "on the shelf",
131
212
ie. out of the way, until a later time when you can bring them back from
163
252
source = BzrPatchSource(revision, file_list)
164
s = Shelf(source.base)
165
s.shelve(source, all, message)
253
s = shelf.Shelf(source.base)
254
s.shelve(source, all, message, no_color)
258
# The following classes are only used as subcommands for 'shelf', they're
259
# not to be registered directly with bzr.
261
class cmd_shelf_list(bzrlib.commands.Command):
262
"""List the patches on the current shelf."""
263
aliases = ['list', 'ls']
268
class cmd_shelf_delete(bzrlib.commands.Command):
269
"""Delete the patch from the current shelf."""
270
aliases = ['delete', 'del']
271
takes_args = ['patch']
272
def run(self, patch):
273
self.shelf.delete(patch)
276
class cmd_shelf_switch(bzrlib.commands.Command):
277
"""Switch to the other shelf, create it if necessary."""
279
takes_args = ['othershelf']
280
def run(self, othershelf):
281
s = shelf.Shelf(self.shelf.base, othershelf)
285
class cmd_shelf_show(bzrlib.commands.Command):
286
"""Show the contents of the specified or topmost patch."""
287
aliases = ['show', 'cat', 'display']
288
takes_args = ['patch?']
289
def run(self, patch=None):
290
self.shelf.display(patch)
293
class cmd_shelf_upgrade(bzrlib.commands.Command):
294
"""Upgrade old format shelves."""
295
aliases = ['upgrade']
168
300
class cmd_shelf(bzrlib.commands.Command):
169
"""Perform various operations on your shelved patches. See also shelve.
172
list (ls) List the patches on the current shelf.
173
delete (del) <patch> Delete a patch from the current shelf.
174
switch <shelf> Switch to the named shelf, create it if necessary.
175
show <patch> Show the contents of the specified patch.
176
upgrade Upgrade old format shelves.
301
"""Perform various operations on your shelved patches. See also shelve."""
178
302
takes_args = ['subcommand', 'args*']
304
subcommands = [cmd_shelf_list, cmd_shelf_delete, cmd_shelf_switch,
305
cmd_shelf_show, cmd_shelf_upgrade]
180
307
def run(self, subcommand, args_list):
310
if args_list is None:
312
cmd = self._get_cmd_object(subcommand)
183
313
source = BzrPatchSource()
184
s = Shelf(source.base)
186
if subcommand == 'ls' or subcommand == 'list':
187
self.__check_no_args(args_list, "shelf list takes no arguments!")
189
elif subcommand == 'delete' or subcommand == 'del':
190
self.__check_one_arg(args_list, "shelf delete takes one argument!")
191
s.delete(args_list[0])
192
elif subcommand == 'switch':
193
self.__check_one_arg(args_list, "shelf switch takes one argument!")
194
s = Shelf(source.base, args_list[0])
196
elif subcommand == 'show':
197
self.__check_one_arg(args_list, "shelf show takes one argument!")
198
s.display(args_list[0])
199
elif subcommand == 'upgrade':
200
self.__check_no_args(args_list, "shelf upgrade takes no arguments!")
203
print subcommand, args_list
204
print >>sys.stderr, "Unknown shelf subcommand '%s'" % subcommand
206
def __check_one_arg(self, args, msg):
207
if args is None or len(args) != 1:
208
raise CommandError(msg)
210
def __check_no_args(self, args, msg):
212
raise CommandError(msg)
314
s = shelf.Shelf(source.base)
317
if args_list is None:
319
return cmd.run_argv_aliases(args_list)
321
def _get_cmd_object(self, cmd_name):
322
for cmd_class in self.subcommands:
323
for alias in cmd_class.aliases:
324
if alias == cmd_name:
326
raise CommandError("Unknown shelf subcommand '%s'" % cmd_name)
329
text = ["%s\n\nSubcommands:\n" % self.__doc__]
331
for cmd_class in self.subcommands:
332
text.extend(self.sub_help(cmd_class) + ['\n'])
336
def sub_help(self, cmd_class):
338
cmd_obj = cmd_class()
341
usage = help.command_usage(cmd_obj)
342
usage = usage.replace('bzr shelf-', '')
343
text.append('%s%s\n' % (indent, usage))
345
text.append('%s%s\n' % (2 * indent, cmd_class.__doc__))
347
# Somewhat copied from bzrlib.help.help_on_command_options
349
for option_name, option in sorted(cmd_obj.options().items()):
350
if option_name == 'help':
352
option_help.append('%s--%s' % (3 * indent, option_name))
353
if option.type is not None:
354
option_help.append(' %s' % option.argname.upper())
355
if option.short_name():
356
option_help.append(', -%s' % option.short_name())
357
option_help.append('%s%s\n' % (2 * indent, option.help))
359
if len(option_help) > 0:
360
text.append('%soptions:\n' % (2 * indent))
361
text.extend(option_help)
215
366
class cmd_unshelve(bzrlib.commands.Command):
216
"""Restore the most recently shelved changes to current tree. <BZRTOOLS>
367
"""Restore shelved changes.
369
By default the most recently shelved changes are restored. However if you
370
specify a patch by name those changes will be restored instead.
217
372
See 'shelve' for more information.
219
374
takes_options = [
220
375
Option('all', help='Unshelve all changes without prompting'),
221
376
Option('force', help='Force unshelving even if errors occur'),
223
def run(self, all=False, force=False):
377
Option('no-color', help='Never display changes in color')
379
takes_args = ['patch?']
380
def run(self, patch=None, all=False, force=False, no_color=False):
224
381
source = BzrPatchSource()
225
s = Shelf(source.base)
226
s.unshelve(source, all, force)
382
s = shelf.Shelf(source.base)
383
s.unshelve(source, patch, all, force, no_color)
230
387
class cmd_shell(bzrlib.commands.Command):
231
"""Begin an interactive shell tailored for bzr. <BZRTOOLS>
388
"""Begin an interactive shell tailored for bzr.
232
389
Bzr commands can be used without typing bzr first, and will be run natively
233
390
when possible. Tab completion is tailored for bzr. The shell prompt shows
234
391
the branch nick, revno, and path.
281
443
class cmd_cbranch(bzrlib.commands.Command):
283
Create a new checkout, associated with a new repository branch. <BZRTOOLS>
285
When you cbranch, bzr looks up the repository associated with your current
286
directory in branches.conf. It creates a new branch in that repository
287
with the same name and relative path as the checkout you request.
289
The branches.conf parameter is "cbranch_root". So if you want
290
cbranch operations in /home/jrandom/bigproject to produce branches in
291
/home/jrandom/bigproject/repository, you'd add this:
293
[/home/jrandom/bigproject]
294
cbranch_root = /home/jrandom/bigproject/repository
296
Note that if "/home/jrandom/bigproject/repository" isn't a repository,
297
standalone branches will be produced. Standalone branches will also
298
be produced if the source branch is in 0.7 format (or earlier).
445
Create a new checkout, associated with a new repository branch.
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
300
takes_options = [Option("lightweight",
301
help="Create a lightweight checkout")]
462
takes_options = [Option("lightweight",
463
help="Create a lightweight checkout"), 'revision']
302
464
takes_args = ["source", "target?"]
303
def run(self, source, target=None, lightweight=False):
465
def run(self, source, target=None, lightweight=False, revision=None):
304
466
from cbranch import cbranch
305
return cbranch(source, target, lightweight=lightweight)
467
return cbranch(source, target, lightweight=lightweight,
308
471
class cmd_branches(bzrlib.commands.Command):
309
"""Scan a location for branches <BZRTOOLS>"""
472
"""Scan a location for branches"""
310
473
takes_args = ["location?"]
311
474
def run(self, location=None):
312
475
from branches import branches
371
534
branch_mark(mark, branch, delete)
374
commands = [cmd_shelve, cmd_unshelve, cmd_shelf, cmd_clean_tree,
375
cmd_graph_ancestry, cmd_fetch_ghosts, cmd_patch, cmd_shell,
376
cmd_branch_history, cmd_zap, cmd_cbranch, cmd_branches,
377
cmd_multi_pull, cmd_switch, cmd_branch_mark]
382
import bzrlib.builtins
383
commands.append(rspush.cmd_rspush)
385
from errors import NoPyBaz
388
commands.append(baz_import.cmd_baz_import_branch)
389
commands.append(baz_import.cmd_baz_import)
392
class cmd_baz_import_branch(bzrlib.commands.Command):
393
"""Disabled. (Requires PyBaz) <BZRTOOLS>"""
394
takes_args = ['to_location?', 'from_branch?', 'reuse_history*']
395
takes_options = ['verbose', Option('max-count', type=int)]
396
def run(self, to_location=None, from_branch=None, fast=False,
397
max_count=None, verbose=False, dry_run=False,
398
reuse_history_list=[]):
399
print "This command is disabled. Please install PyBaz."
402
class cmd_baz_import(bzrlib.commands.Command):
403
"""Disabled. (Requires PyBaz) <BZRTOOLS>"""
404
takes_args = ['to_root_dir?', 'from_archive?', 'reuse_history*']
405
takes_options = ['verbose', Option('prefixes', type=str,
406
help="Prefixes of branches to import")]
407
def run(self, to_root_dir=None, from_archive=None, verbose=False,
408
reuse_history_list=[], prefixes=None):
409
print "This command is disabled. Please install PyBaz."
410
commands.extend((cmd_baz_import_branch, cmd_baz_import))
537
class cmd_import(bzrlib.commands.Command):
538
"""Import sources from a directory, tarball or zip file
540
This command will import a directory, tarball or zip file into a bzr
541
tree, replacing any versioned files already present. If a directory is
542
specified, it is used as the target. If the directory does not exist, or
543
is not versioned, it is created.
545
Tarballs may be gzip or bzip2 compressed. This is autodetected.
547
If the tarball or zip has a single root directory, that directory is
548
stripped when extracting the tarball. This is not done for directories.
551
takes_args = ['source', 'tree?']
552
def run(self, source, tree=None):
553
from upstream_import import do_import
554
do_import(source, tree)
557
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):
571
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,
413
701
if hasattr(bzrlib.commands, 'register_command'):