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
20
3
Various useful plugins for working with bzr.
26
__version__ = '0.13.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
66
from patchsource import BzrPatchSource
67
8
from shelf import Shelf
71
import bzrlib.builtins
72
import bzrlib.commands
73
from bzrlib.commands import get_cmd_object
11
from bzrlib.option import Option
74
13
from bzrlib.errors import BzrCommandError
75
from bzrlib.help import command_usage
77
from bzrlib.option import Option
78
sys.path.insert(0, os.path.realpath(os.path.join(os.path.dirname(__file__),
81
bzrlib.ignores.add_runtime_ignores(['./.shelf'])
14
sys.path.append(os.path.dirname(__file__))
15
from reweave_inventory import cmd_fix
17
Option.OPTIONS['ignored'] = Option('ignored',
18
help='delete all ignored files.')
19
Option.OPTIONS['detritus'] = Option('detritus',
20
help='delete conflict files merge backups, and failed selftest dirs.' +
21
'(*.THIS, *.BASE, *.OTHER, *~, *.tmp')
22
Option.OPTIONS['dry-run'] = Option('dry-run',
23
help='show files to delete instead of deleting them.')
84
25
class cmd_clean_tree(bzrlib.commands.Command):
85
26
"""Remove unwanted files from working tree.
87
By default, only unknown files, not ignored files, are deleted. Versioned
88
files are never deleted.
90
Another class is 'detritus', which includes files emitted by bzr during
91
normal operations and selftests. (The value of these files decreases with
94
If no options are specified, unknown files are deleted. Otherwise, option
95
flags are respected, and may be combined.
97
To check what clean-tree will do, use --dry-run.
27
Normally, ignored files are left alone.
99
takes_options = [Option('ignored', help='delete all ignored files.'),
100
Option('detritus', help='delete conflict files, merge'
101
' backups, and failed selftest dirs.'),
103
help='delete files unknown to bzr. (default)'),
104
Option('dry-run', help='show files to delete instead of'
106
def run(self, unknown=False, ignored=False, detritus=False, dry_run=False):
29
takes_options = ['ignored', 'detritus', 'dry-run']
30
def run(self, ignored=False, detritus=False, dry_run=False):
107
31
from clean_tree import clean_tree
108
if not (unknown or ignored or detritus):
110
clean_tree('.', unknown=unknown, ignored=ignored, detritus=detritus,
32
clean_tree('.', ignored=ignored, detritus=detritus, dry_run=dry_run)
34
Option.OPTIONS['no-collapse'] = Option('no-collapse')
35
Option.OPTIONS['no-antialias'] = Option('no-antialias')
36
Option.OPTIONS['cluster'] = Option('cluster')
37
Option.OPTIONS['merge-branch'] = Option('merge-branch',type=str)
114
39
class cmd_graph_ancestry(bzrlib.commands.Command):
115
40
"""Produce ancestry graphs using dot.
117
42
Output format is detected according to file extension. Some of the more
118
common output formats are html, png, gif, svg, ps. An extension of '.dot'
119
will cause a dot graph file to be produced. HTML output has mouseovers
120
that show the commit message.
43
common output formats are png, gif, svg, ps. An extension of '.dot' will
44
cause a dot graph file to be produced.
122
46
Branches are labeled r?, where ? is the revno. If they have no revno,
123
47
with the last 5 characters of their revision identifier are used instead.
125
The value starting with d is "(maximum) distance from the null revision".
127
49
If --merge-branch is specified, the two branches are compared and a merge
178
93
strip_help="""Strip the smallest prefix containing num leading slashes from \
179
94
each file name found in the patch file."""
180
Option.OPTIONS['bzrdiff'] = Option('bzrdiff',type=None,
181
help="""Handle extra bzr tags""")
95
Option.OPTIONS['strip'] = Option('strip', type=int, help=strip_help)
184
96
class cmd_patch(bzrlib.commands.Command):
185
97
"""Apply a named patch to the current tree.
187
99
takes_args = ['filename?']
188
takes_options = [Option('strip', type=int, help=strip_help)]
189
def run(self, filename=None, strip=-1, bzrdiff=0):
100
takes_options = ['strip']
101
def run(self, filename=None, strip=0):
190
102
from patch import patch
191
from bzrlib.workingtree import WorkingTree
192
wt = WorkingTree.open_containing('.')[0]
194
if bzrdiff: strip = 0
197
return patch(wt, filename, strip, legacy= not bzrdiff)
103
from bzrlib.branch import Branch
104
b = Branch.open_containing('.')[0]
105
return patch(b, filename, strip)
200
108
class cmd_shelve(bzrlib.commands.Command):
201
"""Temporarily set aside some changes from the current tree.
203
Shelve allows you to temporarily put changes you've made "on the shelf",
204
ie. out of the way, until a later time when you can bring them back from
205
the shelf with the 'unshelve' command.
207
Shelve is intended to help separate several sets of text changes that have
208
been inappropriately mingled. If you just want to get rid of all changes
209
(text and otherwise) and you don't need to restore them later, use revert.
210
If you want to shelve all text changes at once, use shelve --all.
212
By default shelve asks you what you want to shelve, press '?' at the
213
prompt to get help. To shelve everything run shelve --all.
215
If filenames are specified, only the changes to those files will be
216
shelved, other files will be left untouched.
218
If a revision is specified, changes since that revision will be shelved.
220
You can put multiple items on the shelf. Normally each time you run
221
unshelve the most recently shelved changes will be reinstated. However,
222
you can also unshelve changes in a different order by explicitly
223
specifiying which changes to unshelve. This works best when the changes
224
don't depend on each other.
226
While you have patches on the shelf you can view and manipulate them with
227
the 'shelf' command. Run 'bzr shelf -h' for more info.
109
"""Temporarily remove some changes from the current tree.
110
Use 'unshelve' to restore these changes.
112
If filenames are specified, only changes to those files will be unshelved.
113
If a revision is specified, all changes since that revision will may be
230
116
takes_args = ['file*']
231
takes_options = ['message', 'revision',
232
Option('all', help='Shelve all changes without prompting'),
233
Option('no-color', help='Never display changes in color')]
117
takes_options = ['all', 'message', 'revision']
118
def run(self, all=False, file_list=None, message=None, revision=None):
119
if file_list is not None and len(file_list) > 0:
120
branchdir = file_list[0]
235
def run(self, all=False, file_list=None, message=None, revision=None,
237
124
if revision is not None and revision:
238
125
if len(revision) == 1:
239
126
revision = revision[0]
241
raise CommandError("shelve only accepts a single revision "
128
raise BzrCommandError("shelve only accepts a single revision "
244
source = BzrPatchSource(revision, file_list)
245
s = Shelf(source.base)
246
s.shelve(source, all, message, no_color)
250
# The following classes are only used as subcommands for 'shelf', they're
251
# not to be registered directly with bzr.
253
class cmd_shelf_list(bzrlib.commands.Command):
254
"""List the patches on the current shelf."""
255
aliases = ['list', 'ls']
260
class cmd_shelf_delete(bzrlib.commands.Command):
261
"""Delete the patch from the current shelf."""
262
aliases = ['delete', 'del']
263
takes_args = ['patch']
264
def run(self, patch):
265
self.shelf.delete(patch)
268
class cmd_shelf_switch(bzrlib.commands.Command):
269
"""Switch to the other shelf, create it if necessary."""
271
takes_args = ['othershelf']
272
def run(self, othershelf):
273
s = Shelf(self.shelf.base, othershelf)
277
class cmd_shelf_show(bzrlib.commands.Command):
278
"""Show the contents of the specified or topmost patch."""
279
aliases = ['show', 'cat', 'display']
280
takes_args = ['patch?']
281
def run(self, patch=None):
282
self.shelf.display(patch)
285
class cmd_shelf_upgrade(bzrlib.commands.Command):
286
"""Upgrade old format shelves."""
287
aliases = ['upgrade']
292
class cmd_shelf(bzrlib.commands.Command):
293
"""Perform various operations on your shelved patches. See also shelve."""
294
takes_args = ['subcommand', 'args*']
296
subcommands = [cmd_shelf_list, cmd_shelf_delete, cmd_shelf_switch,
297
cmd_shelf_show, cmd_shelf_upgrade]
299
def run(self, subcommand, args_list):
302
if args_list is None:
304
cmd = self._get_cmd_object(subcommand)
305
source = BzrPatchSource()
306
s = Shelf(source.base)
308
return cmd.run_argv_aliases(args_list)
310
def _get_cmd_object(self, cmd_name):
311
for cmd_class in self.subcommands:
312
for alias in cmd_class.aliases:
313
if alias == cmd_name:
315
raise CommandError("Unknown shelf subcommand '%s'" % cmd_name)
318
text = ["%s\n\nSubcommands:\n" % self.__doc__]
320
for cmd_class in self.subcommands:
321
text.extend(self.sub_help(cmd_class) + ['\n'])
325
def sub_help(self, cmd_class):
327
cmd_obj = cmd_class()
330
usage = command_usage(cmd_obj)
331
usage = usage.replace('bzr shelf-', '')
332
text.append('%s%s\n' % (indent, usage))
334
text.append('%s%s\n' % (2 * indent, cmd_class.__doc__))
336
# Somewhat copied from bzrlib.help.help_on_command_options
338
for option_name, option in sorted(cmd_obj.options().items()):
339
if option_name == 'help':
341
option_help.append('%s--%s' % (3 * indent, option_name))
342
if option.type is not None:
343
option_help.append(' %s' % option.argname.upper())
344
if option.short_name():
345
option_help.append(', -%s' % option.short_name())
346
option_help.append('%s%s\n' % (2 * indent, option.help))
348
if len(option_help) > 0:
349
text.append('%soptions:\n' % (2 * indent))
350
text.extend(option_help)
132
return s.shelve(all, message, revision, file_list)
355
135
class cmd_unshelve(bzrlib.commands.Command):
356
"""Restore shelved changes.
358
By default the most recently shelved changes are restored. However if you
359
specify a patch by name those changes will be restored instead.
361
See 'shelve' for more information.
136
"""Restore previously-shelved changes to the current tree.
364
Option('all', help='Unshelve all changes without prompting'),
365
Option('force', help='Force unshelving even if errors occur'),
366
Option('no-color', help='Never display changes in color')
368
takes_args = ['patch?']
369
def run(self, patch=None, all=False, force=False, no_color=False):
370
source = BzrPatchSource()
371
s = Shelf(source.base)
372
s.unshelve(source, patch, all, force, no_color)
376
143
class cmd_shell(bzrlib.commands.Command):
377
"""Begin an interactive shell tailored for bzr.
378
Bzr commands can be used without typing bzr first, and will be run natively
379
when possible. Tab completion is tailored for bzr. The shell prompt shows
380
the branch nick, revno, and path.
382
If it encounters any moderately complicated shell command, it will punt to
387
bzr bzrtools:287/> status
390
bzr bzrtools:287/> status --[TAB][TAB]
391
--all --help --revision --show-ids
392
bzr bzrtools:287/> status --
396
return shell.run_shell()
399
class cmd_branch_history(bzrlib.commands.Command):
401
Display the development history of a branch.
403
Each different committer or branch nick is considered a different line of
404
development. Committers are treated as the same if they have the same
405
name, or if they have the same email address.
407
takes_args = ["branch?"]
408
def run(self, branch=None):
409
from branchhistory import branch_history
410
return branch_history(branch)
413
class cmd_zap(bzrlib.commands.Command):
415
Remove a lightweight checkout, if it can be done safely.
417
This command will remove a lightweight checkout without losing data. That
418
means it only removes lightweight checkouts, and only if they have no
421
If --branch is specified, the branch will be deleted too, but only if the
422
the branch has no new commits (relative to its parent).
424
takes_options = [Option("branch", help="Remove associtated branch from"
426
takes_args = ["checkout"]
427
def run(self, checkout, branch=False):
429
return zap(checkout, remove_branch=branch)
432
class cmd_cbranch(bzrlib.commands.Command):
434
Create a new checkout, associated with a new repository branch.
436
When you cbranch, bzr looks up the repository associated with your current
437
directory in locations.conf. It creates a new branch in that repository
438
with the same name and relative path as the checkout you request.
440
The locations.conf parameter is "cbranch_root". So if you want
441
cbranch operations in /home/jrandom/bigproject to produce branches in
442
/home/jrandom/bigproject/repository, you'd add this:
444
[/home/jrandom/bigproject]
445
cbranch_root = /home/jrandom/bigproject/repository
447
Note that if "/home/jrandom/bigproject/repository" isn't a repository,
448
standalone branches will be produced. Standalone branches will also
449
be produced if the source branch is in 0.7 format (or earlier).
451
takes_options = [Option("lightweight",
452
help="Create a lightweight checkout"), 'revision']
453
takes_args = ["source", "target?"]
454
def run(self, source, target=None, lightweight=False, revision=None):
455
from cbranch import cbranch
456
return cbranch(source, target, lightweight=lightweight,
460
class cmd_branches(bzrlib.commands.Command):
461
"""Scan a location for branches"""
462
takes_args = ["location?"]
463
def run(self, location=None):
464
from branches import branches
465
return branches(location)
468
class cmd_multi_pull(bzrlib.commands.Command):
469
"""Pull all the branches under a location, e.g. a repository.
471
Both branches present in the directory and the branches of checkouts are
474
takes_args = ["location?"]
475
def run(self, location=None):
476
from bzrlib.branch import Branch
477
from bzrlib.transport import get_transport
478
from bzrtools import iter_branch_tree
481
t = get_transport(location)
483
print "Can't list this type of location."
485
for branch, wt in iter_branch_tree(t):
490
parent = branch.get_parent()
497
if base.startswith(t.base):
498
relpath = base[len(t.base):].rstrip('/')
501
print "Pulling %s from %s" % (relpath, parent)
503
pullable.pull(Branch.open(parent))
508
class cmd_branch_mark(bzrlib.commands.Command):
510
Add, view or list branch markers <EXPERIMENTAL>
512
To add a mark, do 'bzr branch-mark MARK'.
513
To list marks, do 'bzr branch-mark' (this lists all marks for the branch's
515
To delete a mark, do 'bzr branch-mark --delete MARK'
517
These marks can be used to track a branch's status.
519
takes_args = ['mark?', 'branch?']
520
takes_options = [Option('delete', help='Delete this mark')]
521
def run(self, mark=None, branch=None, delete=False):
522
from branch_mark import branch_mark
523
branch_mark(mark, branch, delete)
526
class cmd_import(bzrlib.commands.Command):
527
"""Import sources from a tarball
529
This command will import a tarball into a bzr tree, replacing any versioned
530
files already present. If a directory is specified, it is used as the
531
target. If the directory does not exist, or is not versioned, it is
534
Tarballs may be gzip or bzip2 compressed. This is autodetected.
536
If the tarball has a single root directory, that directory is stripped
537
when extracting the tarball.
540
takes_args = ['source', 'tree?']
541
def run(self, source, tree=None):
542
from upstream_import import do_import
543
do_import(source, tree)
546
class cmd_cdiff(bzrlib.commands.Command):
547
"""A color version of bzr's diff"""
548
takes_args = property(lambda x: get_cmd_object('diff').takes_args)
549
takes_options = property(lambda x: get_cmd_object('diff').takes_options)
550
def run(*args, **kwargs):
551
from colordiff import colordiff
552
colordiff(*args, **kwargs)
555
class cmd_baz_import(bzrlib.commands.Command):
556
"""Import an Arch or Baz archive into a bzr repository.
558
This command should be used on local archives (or mirrors) only. It is
559
quite slow on remote archives.
561
reuse_history allows you to specify any previous imports you
562
have done of different archives, which this archive has branches
563
tagged from. This will dramatically reduce the time to convert
564
the archive as it will not have to convert the history already
565
converted in that other branch.
567
If you specify prefixes, only branches whose names start with that prefix
568
will be imported. Skipped branches will be listed, so you can import any
569
branches you missed by accident. Here's an example of doing a partial
570
import from thelove@canonical.com:
571
bzr baz-import thelove thelove@canonical.com --prefixes dists:talloc-except
573
takes_args = ['to_root_dir', 'from_archive', 'reuse_history*']
574
takes_options = ['verbose', Option('prefixes', type=str,
575
help="Prefixes of branches to import, colon-separated")]
577
def run(self, to_root_dir, from_archive, encoding=None, verbose=False,
578
reuse_history_list=[], prefixes=None):
579
from errors import NoPyBaz
582
baz_import.baz_import(to_root_dir, from_archive, encoding,
583
verbose, reuse_history_list, prefixes)
585
print "This command is disabled. Please install PyBaz."
588
class cmd_baz_import_branch(bzrlib.commands.Command):
589
"""Import an Arch or Baz branch into a bzr branch."""
590
takes_args = ['to_location', 'from_branch?', 'reuse_history*']
591
takes_options = ['verbose', Option('max-count', type=int)]
593
def run(self, to_location, from_branch=None, fast=False, max_count=None,
594
encoding=None, verbose=False, dry_run=False,
595
reuse_history_list=[]):
596
from errors import NoPyBaz
599
baz_import.baz_import_branch(to_location, from_branch, fast,
600
max_count, verbose, encoding, dry_run,
603
print "This command is disabled. Please install PyBaz."
606
class cmd_rspush(bzrlib.commands.Command):
607
"""Upload this branch to another location using rsync.
609
If no location is specified, the last-used location will be used. To
610
prevent dirty trees from being uploaded, rspush will error out if there are
611
unknown files or local changes. It will also error out if the upstream
612
directory is non-empty and not an earlier version of the branch.
614
takes_args = ['location?']
615
takes_options = [Option('overwrite', help='Ignore differences between'
616
' branches and overwrite unconditionally'),
617
Option('no-tree', help='Do not push the working tree,'
620
def run(self, location=None, overwrite=False, no_tree=False):
621
from bzrlib import workingtree
623
cur_branch = workingtree.WorkingTree.open_containing(".")[0]
624
bzrtools.rspush(cur_branch, location, overwrite=overwrite,
625
working_tree=not no_tree)
628
class cmd_switch(bzrlib.commands.Command):
629
"""Set the branch of a lightweight checkout and update."""
631
takes_args = ['to_location']
633
def run(self, to_location):
634
from switch import cmd_switch
635
cmd_switch().run(to_location)
640
cmd_baz_import_branch,
148
commands = [cmd_shelve, cmd_unshelve, cmd_clean_tree, cmd_graph_ancestry,
149
cmd_fetch_ghosts, cmd_patch, cmd_shell, cmd_fix]
151
command_decorators = []
153
import bzrlib.builtins
154
if not hasattr(bzrlib.builtins, "cmd_annotate"):
155
commands.append(annotate.cmd_annotate)
156
if not hasattr(bzrlib.builtins, "cmd_push"):
157
commands.append(push.cmd_push)
159
command_decorators.append(push.cmd_push)
161
from errors import NoPyBaz
164
commands.append(baz_import.cmd_baz_import)
167
class cmd_baz_import(bzrlib.commands.Command):
168
"""Disabled. (Requires PyBaz)"""
169
takes_args = ['to_root_dir?', 'from_archive?']
170
takes_options = ['verbose']
171
def run(self, to_root_dir=None, from_archive=None, verbose=False):
172
print "This command is disabled. Please install PyBaz."
173
commands.append(cmd_baz_import)
662
176
if hasattr(bzrlib.commands, 'register_command'):
663
177
for command in commands:
664
178
bzrlib.commands.register_command(command)
179
for command in command_decorators:
180
command._original_command = bzrlib.commands.register_command(
667
184
def test_suite():
668
from bzrlib.tests.TestUtil import TestLoader
670
from doctest import DocTestSuite, ELLIPSIS
671
from unittest import TestSuite
673
import tests.clean_tree
674
import upstream_import
676
import tests.blackbox
677
import tests.shelf_tests
185
from doctest import DocTestSuite
186
from unittest import TestSuite, TestLoader
678
190
result = TestSuite()
679
result.addTest(DocTestSuite(bzrtools, optionflags=ELLIPSIS))
680
result.addTest(tests.clean_tree.test_suite())
683
result.addTest(DocTestSuite(baz_import))
686
result.addTest(tests.test_suite())
687
result.addTest(TestLoader().loadTestsFromModule(tests.shelf_tests))
688
result.addTest(tests.blackbox.test_suite())
689
result.addTest(upstream_import.test_suite())
690
result.addTest(zap.test_suite())
191
result.addTest(DocTestSuite(bzrtools))
192
result.addTest(clean_tree.test_suite())
193
result.addTest(TestLoader().loadTestsFromModule(shelf_tests))
194
result.addTest(blackbox.test_suite())