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
Various useful plugins for working with bzr.
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
66
from patchsource import BzrPatchSource
67
from shelf import Shelf
71
import bzrlib.builtins
72
import bzrlib.commands
73
from bzrlib.commands import get_cmd_object
74
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__),
83
bzrlib.ignores.add_runtime_ignores(['./.shelf'])
86
class cmd_clean_tree(bzrlib.commands.Command):
87
"""Remove unwanted files from working tree.
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.
101
takes_options = [Option('ignored', help='delete all ignored files.'),
102
Option('detritus', help='delete conflict files, merge'
103
' backups, and failed selftest dirs.'),
105
help='delete files unknown to bzr. (default)'),
106
Option('dry-run', help='show files to delete instead of'
108
def run(self, unknown=False, ignored=False, detritus=False, dry_run=False):
109
from clean_tree import clean_tree
110
if not (unknown or ignored or detritus):
112
clean_tree('.', unknown=unknown, ignored=ignored, detritus=detritus,
116
class cmd_graph_ancestry(bzrlib.commands.Command):
117
"""Produce ancestry graphs using dot.
119
Output format is detected according to file extension. Some of the more
120
common output formats are html, png, gif, svg, ps. An extension of '.dot'
121
will cause a dot graph file to be produced. HTML output has mouseovers
122
that show the commit message.
124
Branches are labeled r?, where ? is the revno. If they have no revno,
125
with the last 5 characters of their revision identifier are used instead.
127
The value starting with d is "(maximum) distance from the null revision".
129
If --merge-branch is specified, the two branches are compared and a merge
133
white normal revision
136
orange COMMON history
137
blue COMMON non-history ancestor
138
green Merge base (COMMON ancestor farthest from the null revision)
139
dotted Ghost revision (missing from branch storage)
141
Ancestry is usually collapsed by skipping revisions with a single parent
142
and descendant. The number of skipped revisions is shown on the arrow.
143
This feature can be disabled with --no-collapse.
145
By default, revisions are ordered by distance from root, but they can be
146
clustered instead using --cluster.
148
If available, rsvg is used to antialias PNG and JPEG output, but this can
149
be disabled with --no-antialias.
151
takes_args = ['branch', 'file']
152
takes_options = [Option('no-collapse', help="Do not skip simple nodes"),
153
Option('no-antialias',
154
help="Do not use rsvg to produce antialiased output"),
155
Option('merge-branch', type=str,
156
help="Use this branch to calcuate a merge base"),
157
Option('cluster', help="Use clustered output.")]
158
def run(self, branch, file, no_collapse=False, no_antialias=False,
159
merge_branch=None, cluster=False):
165
graph.write_ancestry_file(branch, file, not no_collapse,
166
not no_antialias, merge_branch, ranking)
169
class cmd_fetch_ghosts(bzrlib.commands.Command):
170
"""Attempt to retrieve ghosts from another branch.
171
If the other branch is not supplied, the last-pulled branch is used.
173
aliases = ['fetch-missing']
174
takes_args = ['branch?']
175
takes_options = [Option('no-fix')]
176
def run(self, branch=None, no_fix=False):
177
from fetch_ghosts import fetch_ghosts
178
fetch_ghosts(branch, no_fix)
180
strip_help="""Strip the smallest prefix containing num leading slashes from \
181
each file name found in the patch file."""
184
class cmd_patch(bzrlib.commands.Command):
185
"""Apply a named patch to the current tree.
187
takes_args = ['filename?']
188
takes_options = [Option('strip', type=int, help=strip_help)]
189
def run(self, filename=None, strip=None):
190
from patch import patch
191
from bzrlib.workingtree import WorkingTree
192
wt = WorkingTree.open_containing('.')[0]
195
return patch(wt, filename, strip)
198
class cmd_shelve(bzrlib.commands.Command):
199
"""Temporarily set aside some changes from the current tree.
201
Shelve allows you to temporarily put changes you've made "on the shelf",
202
ie. out of the way, until a later time when you can bring them back from
203
the shelf with the 'unshelve' command.
205
Shelve is intended to help separate several sets of text changes that have
206
been inappropriately mingled. If you just want to get rid of all changes
207
(text and otherwise) and you don't need to restore them later, use revert.
208
If you want to shelve all text changes at once, use shelve --all.
210
By default shelve asks you what you want to shelve, press '?' at the
211
prompt to get help. To shelve everything run shelve --all.
213
If filenames are specified, only the changes to those files will be
214
shelved, other files will be left untouched.
216
If a revision is specified, changes since that revision will be shelved.
218
You can put multiple items on the shelf. Normally each time you run
219
unshelve the most recently shelved changes will be reinstated. However,
220
you can also unshelve changes in a different order by explicitly
221
specifiying which changes to unshelve. This works best when the changes
222
don't depend on each other.
224
While you have patches on the shelf you can view and manipulate them with
225
the 'shelf' command. Run 'bzr shelf -h' for more info.
228
takes_args = ['file*']
229
takes_options = ['message', 'revision',
230
Option('all', help='Shelve all changes without prompting'),
231
Option('no-color', help='Never display changes in color')]
233
def run(self, all=False, file_list=None, message=None, revision=None,
235
if revision is not None and revision:
236
if len(revision) == 1:
237
revision = revision[0]
239
raise CommandError("shelve only accepts a single revision "
242
source = BzrPatchSource(revision, file_list)
243
s = Shelf(source.base)
244
s.shelve(source, all, message, no_color)
248
# The following classes are only used as subcommands for 'shelf', they're
249
# not to be registered directly with bzr.
251
class cmd_shelf_list(bzrlib.commands.Command):
252
"""List the patches on the current shelf."""
253
aliases = ['list', 'ls']
258
class cmd_shelf_delete(bzrlib.commands.Command):
259
"""Delete the patch from the current shelf."""
260
aliases = ['delete', 'del']
261
takes_args = ['patch']
262
def run(self, patch):
263
self.shelf.delete(patch)
266
class cmd_shelf_switch(bzrlib.commands.Command):
267
"""Switch to the other shelf, create it if necessary."""
269
takes_args = ['othershelf']
270
def run(self, othershelf):
271
s = Shelf(self.shelf.base, othershelf)
275
class cmd_shelf_show(bzrlib.commands.Command):
276
"""Show the contents of the specified or topmost patch."""
277
aliases = ['show', 'cat', 'display']
278
takes_args = ['patch?']
279
def run(self, patch=None):
280
self.shelf.display(patch)
283
class cmd_shelf_upgrade(bzrlib.commands.Command):
284
"""Upgrade old format shelves."""
285
aliases = ['upgrade']
290
class cmd_shelf(bzrlib.commands.Command):
291
"""Perform various operations on your shelved patches. See also shelve."""
292
takes_args = ['subcommand', 'args*']
294
subcommands = [cmd_shelf_list, cmd_shelf_delete, cmd_shelf_switch,
295
cmd_shelf_show, cmd_shelf_upgrade]
297
def run(self, subcommand, args_list):
300
if args_list is None:
302
cmd = self._get_cmd_object(subcommand)
303
source = BzrPatchSource()
304
s = Shelf(source.base)
306
return cmd.run_argv_aliases(args_list)
308
def _get_cmd_object(self, cmd_name):
309
for cmd_class in self.subcommands:
310
for alias in cmd_class.aliases:
311
if alias == cmd_name:
313
raise CommandError("Unknown shelf subcommand '%s'" % cmd_name)
316
text = ["%s\n\nSubcommands:\n" % self.__doc__]
318
for cmd_class in self.subcommands:
319
text.extend(self.sub_help(cmd_class) + ['\n'])
323
def sub_help(self, cmd_class):
325
cmd_obj = cmd_class()
328
usage = command_usage(cmd_obj)
329
usage = usage.replace('bzr shelf-', '')
330
text.append('%s%s\n' % (indent, usage))
332
text.append('%s%s\n' % (2 * indent, cmd_class.__doc__))
334
# Somewhat copied from bzrlib.help.help_on_command_options
336
for option_name, option in sorted(cmd_obj.options().items()):
337
if option_name == 'help':
339
option_help.append('%s--%s' % (3 * indent, option_name))
340
if option.type is not None:
341
option_help.append(' %s' % option.argname.upper())
342
if option.short_name():
343
option_help.append(', -%s' % option.short_name())
344
option_help.append('%s%s\n' % (2 * indent, option.help))
346
if len(option_help) > 0:
347
text.append('%soptions:\n' % (2 * indent))
348
text.extend(option_help)
353
class cmd_unshelve(bzrlib.commands.Command):
354
"""Restore shelved changes.
356
By default the most recently shelved changes are restored. However if you
357
specify a patch by name those changes will be restored instead.
359
See 'shelve' for more information.
362
Option('all', help='Unshelve all changes without prompting'),
363
Option('force', help='Force unshelving even if errors occur'),
364
Option('no-color', help='Never display changes in color')
366
takes_args = ['patch?']
367
def run(self, patch=None, all=False, force=False, no_color=False):
368
source = BzrPatchSource()
369
s = Shelf(source.base)
370
s.unshelve(source, patch, all, force, no_color)
374
class cmd_shell(bzrlib.commands.Command):
375
"""Begin an interactive shell tailored for bzr.
376
Bzr commands can be used without typing bzr first, and will be run natively
377
when possible. Tab completion is tailored for bzr. The shell prompt shows
378
the branch nick, revno, and path.
380
If it encounters any moderately complicated shell command, it will punt to
385
bzr bzrtools:287/> status
388
bzr bzrtools:287/> status --[TAB][TAB]
389
--all --help --revision --show-ids
390
bzr bzrtools:287/> status --
394
return shell.run_shell()
397
class cmd_branch_history(bzrlib.commands.Command):
399
Display the development history of a branch.
401
Each different committer or branch nick is considered a different line of
402
development. Committers are treated as the same if they have the same
403
name, or if they have the same email address.
405
takes_args = ["branch?"]
406
def run(self, branch=None):
407
from branchhistory import branch_history
408
return branch_history(branch)
411
class cmd_zap(bzrlib.commands.Command):
413
Remove a lightweight checkout, if it can be done safely.
415
This command will remove a lightweight checkout without losing data. That
416
means it only removes lightweight checkouts, and only if they have no
419
If --branch is specified, the branch will be deleted too, but only if the
420
the branch has no new commits (relative to its parent).
422
takes_options = [Option("branch", help="Remove associtated branch from"
424
takes_args = ["checkout"]
425
def run(self, checkout, branch=False):
427
return zap(checkout, remove_branch=branch)
430
class cmd_cbranch(bzrlib.commands.Command):
432
Create a new checkout, associated with a new repository branch.
434
When you cbranch, bzr looks up the repository associated with your current
435
directory in locations.conf. It creates a new branch in that repository
436
with the same name and relative path as the checkout you request.
438
The locations.conf parameter is "cbranch_root". So if you want
439
cbranch operations in /home/jrandom/bigproject to produce branches in
440
/home/jrandom/bigproject/repository, you'd add this:
442
[/home/jrandom/bigproject]
443
cbranch_root = /home/jrandom/bigproject/repository
445
Note that if "/home/jrandom/bigproject/repository" isn't a repository,
446
standalone branches will be produced. Standalone branches will also
447
be produced if the source branch is in 0.7 format (or earlier).
449
takes_options = [Option("lightweight",
450
help="Create a lightweight checkout"), 'revision']
451
takes_args = ["source", "target?"]
452
def run(self, source, target=None, lightweight=False, revision=None):
453
from cbranch import cbranch
454
return cbranch(source, target, lightweight=lightweight,
458
class cmd_branches(bzrlib.commands.Command):
459
"""Scan a location for branches"""
460
takes_args = ["location?"]
461
def run(self, location=None):
462
from branches import branches
463
return branches(location)
466
class cmd_multi_pull(bzrlib.commands.Command):
467
"""Pull all the branches under a location, e.g. a repository.
469
Both branches present in the directory and the branches of checkouts are
472
takes_args = ["location?"]
473
def run(self, location=None):
474
from bzrlib.branch import Branch
475
from bzrlib.transport import get_transport
476
from bzrtools import iter_branch_tree
479
t = get_transport(location)
481
print "Can't list this type of location."
483
for branch, wt in iter_branch_tree(t):
488
parent = branch.get_parent()
495
if base.startswith(t.base):
496
relpath = base[len(t.base):].rstrip('/')
499
print "Pulling %s from %s" % (relpath, parent)
501
pullable.pull(Branch.open(parent))
506
class cmd_branch_mark(bzrlib.commands.Command):
508
Add, view or list branch markers <EXPERIMENTAL>
510
To add a mark, do 'bzr branch-mark MARK'.
511
To list marks, do 'bzr branch-mark' (this lists all marks for the branch's
513
To delete a mark, do 'bzr branch-mark --delete MARK'
515
These marks can be used to track a branch's status.
517
takes_args = ['mark?', 'branch?']
518
takes_options = [Option('delete', help='Delete this mark')]
519
def run(self, mark=None, branch=None, delete=False):
520
from branch_mark import branch_mark
521
branch_mark(mark, branch, delete)
524
class cmd_import(bzrlib.commands.Command):
525
"""Import sources from a tarball
527
This command will import a tarball into a bzr tree, replacing any versioned
528
files already present. If a directory is specified, it is used as the
529
target. If the directory does not exist, or is not versioned, it is
532
Tarballs may be gzip or bzip2 compressed. This is autodetected.
534
If the tarball has a single root directory, that directory is stripped
535
when extracting the tarball.
538
takes_args = ['source', 'tree?']
539
def run(self, source, tree=None):
540
from upstream_import import do_import
541
do_import(source, tree)
544
class cmd_cdiff(bzrlib.commands.Command):
545
"""A color version of bzr's diff"""
546
takes_args = property(lambda x: get_cmd_object('diff').takes_args)
547
takes_options = property(lambda x: get_cmd_object('diff').takes_options)
548
def run(*args, **kwargs):
549
from colordiff import colordiff
550
colordiff(*args, **kwargs)
553
class cmd_baz_import(bzrlib.commands.Command):
554
"""Import an Arch or Baz archive into a bzr repository.
556
This command should be used on local archives (or mirrors) only. It is
557
quite slow on remote archives.
559
reuse_history allows you to specify any previous imports you
560
have done of different archives, which this archive has branches
561
tagged from. This will dramatically reduce the time to convert
562
the archive as it will not have to convert the history already
563
converted in that other branch.
565
If you specify prefixes, only branches whose names start with that prefix
566
will be imported. Skipped branches will be listed, so you can import any
567
branches you missed by accident. Here's an example of doing a partial
568
import from thelove@canonical.com:
569
bzr baz-import thelove thelove@canonical.com --prefixes dists:talloc-except
571
WARNING: Encoding should not be specified unless necessary, because if you
572
specify an encoding, your converted branch will not interoperate with
573
independently-converted branches, unless the other branches were converted
574
with exactly the same encoding. Any encoding recognized by Python may
575
be specified. Aliases are not detected, so 'utf_8', 'U8', 'UTF' and 'utf8'
578
takes_args = ['to_root_dir', 'from_archive', 'reuse_history*']
579
takes_options = ['verbose', Option('prefixes', type=str,
580
help="Prefixes of branches to import, colon-separated"),
581
Option('encoding', type=str,
582
help='Force encoding to specified value. See WARNING.')]
584
def run(self, to_root_dir, from_archive, encoding=None, verbose=False,
585
reuse_history_list=[], prefixes=None):
586
from errors import NoPyBaz
589
baz_import.baz_import(to_root_dir, from_archive, encoding,
590
verbose, reuse_history_list, prefixes)
592
print "This command is disabled. Please install PyBaz."
595
class cmd_baz_import_branch(bzrlib.commands.Command):
596
"""Import an Arch or Baz branch into a bzr branch.
598
WARNING: Encoding should not be specified unless necessary, because if you
599
specify an encoding, your converted branch will not interoperate with
600
independently-converted branches, unless the other branches were converted
601
with exactly the same encoding. Any encoding recognized by Python may
602
be specified. Aliases are not detected, so 'utf_8', 'U8', 'UTF' and 'utf8'
605
takes_args = ['to_location', 'from_branch?', 'reuse_history*']
606
takes_options = ['verbose', Option('max-count', type=int),
607
Option('encoding', type=str,
608
help='Force encoding to specified value. See WARNING.')]
610
def run(self, to_location, from_branch=None, fast=False, max_count=None,
611
encoding=None, verbose=False, dry_run=False,
612
reuse_history_list=[]):
613
from errors import NoPyBaz
616
baz_import.baz_import_branch(to_location, from_branch, fast,
617
max_count, verbose, encoding, dry_run,
620
print "This command is disabled. Please install PyBaz."
623
class cmd_rspush(bzrlib.commands.Command):
624
"""Upload this branch to another location using rsync.
626
If no location is specified, the last-used location will be used. To
627
prevent dirty trees from being uploaded, rspush will error out if there are
628
unknown files or local changes. It will also error out if the upstream
629
directory is non-empty and not an earlier version of the branch.
631
takes_args = ['location?']
632
takes_options = [Option('overwrite', help='Ignore differences between'
633
' branches and overwrite unconditionally'),
634
Option('no-tree', help='Do not push the working tree,'
637
def run(self, location=None, overwrite=False, no_tree=False):
638
from bzrlib import workingtree
640
cur_branch = workingtree.WorkingTree.open_containing(".")[0]
641
bzrtools.rspush(cur_branch, location, overwrite=overwrite,
642
working_tree=not no_tree)
645
class cmd_switch(bzrlib.commands.Command):
646
"""Set the branch of a lightweight checkout and update."""
648
takes_args = ['to_location']
650
def run(self, to_location):
651
from switch import cmd_switch
652
cmd_switch().run(to_location)
657
cmd_baz_import_branch,
679
if hasattr(bzrlib.commands, 'register_command'):
680
for command in commands:
681
bzrlib.commands.register_command(command)
685
from bzrlib.tests.TestUtil import TestLoader
687
from doctest import DocTestSuite, ELLIPSIS
688
from unittest import TestSuite
690
import tests.clean_tree
691
import upstream_import
693
import tests.blackbox
694
import tests.shelf_tests
696
result.addTest(DocTestSuite(bzrtools, optionflags=ELLIPSIS))
697
result.addTest(tests.clean_tree.test_suite())
700
result.addTest(DocTestSuite(baz_import))
703
result.addTest(tests.test_suite())
704
result.addTest(TestLoader().loadTestsFromModule(tests.shelf_tests))
705
result.addTest(tests.blackbox.test_suite())
706
result.addTest(upstream_import.test_suite())
707
result.addTest(zap.test_suite())