1
# Copyright (C) 2005, 2006, 2007 Aaron Bentley <aaron@aaronbentley.com>
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.
25
from bzrlib.lazy_import import lazy_import
26
lazy_import(globals(), """
27
from bzrlib import help, urlutils
31
from version import version_info, __version__
32
from command import BzrToolsCommand
33
from errors import CommandError, NoPyBaz
34
from patchsource import BzrPatchSource
38
import bzrlib.builtins
39
import bzrlib.commands
40
from bzrlib.branch import Branch
41
from bzrlib.bzrdir import BzrDir
42
from bzrlib.commands import get_cmd_object
43
from bzrlib.errors import BzrCommandError
45
from bzrlib.trace import note
46
from bzrlib.option import Option
47
sys.path.insert(0, os.path.realpath(os.path.join(os.path.dirname(__file__),
51
from command import BzrToolsCommand
53
bzrlib.ignores.add_runtime_ignores(['./.shelf'])
56
class cmd_clean_tree(BzrToolsCommand):
57
"""Remove unwanted files from working tree.
59
By default, only unknown files, not ignored files, are deleted. Versioned
60
files are never deleted.
62
Another class is 'detritus', which includes files emitted by bzr during
63
normal operations and selftests. (The value of these files decreases with
66
If no options are specified, unknown files are deleted. Otherwise, option
67
flags are respected, and may be combined.
69
To check what clean-tree will do, use --dry-run.
71
takes_options = [Option('ignored', help='Delete all ignored files.'),
72
Option('detritus', help='Delete conflict files, merge'
73
' backups, and failed selftest dirs.'),
75
help='Delete files unknown to bzr (default).'),
76
Option('dry-run', help='Show files to delete instead of'
78
def run(self, unknown=False, ignored=False, detritus=False, dry_run=False):
79
from clean_tree import clean_tree
80
if not (unknown or ignored or detritus):
82
clean_tree('.', unknown=unknown, ignored=ignored, detritus=detritus,
86
class cmd_graph_ancestry(BzrToolsCommand):
87
"""Produce ancestry graphs using dot.
89
Output format is detected according to file extension. Some of the more
90
common output formats are html, png, gif, svg, ps. An extension of '.dot'
91
will cause a dot graph file to be produced. HTML output has mouseovers
92
that show the commit message.
94
Branches are labeled r?, where ? is the revno. If they have no revno,
95
with the last 5 characters of their revision identifier are used instead.
97
The value starting with d is "(maximum) distance from the null revision".
99
If --merge-branch is specified, the two branches are compared and a merge
103
white normal revision
106
orange COMMON history
107
blue COMMON non-history ancestor
108
green Merge base (COMMON ancestor farthest from the null revision)
109
dotted Ghost revision (missing from branch storage)
111
Ancestry is usually collapsed by skipping revisions with a single parent
112
and descendant. The number of skipped revisions is shown on the arrow.
113
This feature can be disabled with --no-collapse.
115
By default, revisions are ordered by distance from root, but they can be
116
clustered instead using --cluster.
118
If available, rsvg is used to antialias PNG and JPEG output, but this can
119
be disabled with --no-antialias.
121
takes_args = ['file', 'merge_branch?']
122
takes_options = [Option('no-collapse', help="Do not skip simple nodes."),
123
Option('no-antialias',
124
help="Do not use rsvg to produce antialiased output."),
125
Option('merge-branch', type=str,
126
help="Use this branch to calcuate a merge base."),
127
Option('cluster', help="Use clustered output."),
128
Option('max-distance',
129
help="Show no nodes farther than this.", type=int),
131
help='Source branch to use (default is current'
136
def run(self, file, merge_branch=None, no_collapse=False,
137
no_antialias=False, cluster=False, max_distance=100,
139
if max_distance == -1:
146
graph.write_ancestry_file(directory, file, not no_collapse,
147
not no_antialias, merge_branch, ranking,
148
max_distance=max_distance)
151
class cmd_fetch_ghosts(BzrToolsCommand):
152
"""Attempt to retrieve ghosts from another branch.
153
If the other branch is not supplied, the last-pulled branch is used.
155
aliases = ['fetch-missing']
156
takes_args = ['branch?']
157
takes_options = [Option('no-fix', help="Skip additional synchonization.")]
158
def run(self, branch=None, no_fix=False):
159
from fetch_ghosts import fetch_ghosts
160
fetch_ghosts(branch, no_fix)
162
strip_help="""Strip the smallest prefix containing num leading slashes from \
163
each file name found in the patch file."""
166
class cmd_patch(BzrToolsCommand):
167
"""Apply a named patch to the current tree.
169
takes_args = ['filename?']
170
takes_options = [Option('strip', type=int, help=strip_help),
171
Option('silent', help='Suppress chatter.')]
172
def run(self, filename=None, strip=None, silent=False):
173
from patch import patch
174
from bzrlib.workingtree import WorkingTree
175
wt = WorkingTree.open_containing('.')[0]
178
return patch(wt, filename, strip, silent)
181
class cmd_shelve(BzrToolsCommand):
182
"""Temporarily set aside some changes from the current tree.
184
Shelve allows you to temporarily put changes you've made "on the shelf",
185
ie. out of the way, until a later time when you can bring them back from
186
the shelf with the 'unshelve' command.
188
Shelve is intended to help separate several sets of text changes that have
189
been inappropriately mingled. If you just want to get rid of all changes
190
(text and otherwise) and you don't need to restore them later, use revert.
191
If you want to shelve all text changes at once, use shelve --all.
193
By default shelve asks you what you want to shelve, press '?' at the
194
prompt to get help. To shelve everything run shelve --all.
196
If filenames are specified, only the changes to those files will be
197
shelved, other files will be left untouched.
199
If a revision is specified, changes since that revision will be shelved.
201
You can put multiple items on the shelf. Normally each time you run
202
unshelve the most recently shelved changes will be reinstated. However,
203
you can also unshelve changes in a different order by explicitly
204
specifiying which changes to unshelve. This works best when the changes
205
don't depend on each other.
207
While you have patches on the shelf you can view and manipulate them with
208
the 'shelf' command. Run 'bzr shelf -h' for more info.
211
takes_args = ['file*']
212
takes_options = [Option('message',
213
help='A message to associate with the shelved changes.',
214
short_name='m', type=unicode),
216
Option('all', help='Shelve all changes without prompting.'),
217
Option('no-color', help='Never display changes in color.')]
219
def run(self, all=False, file_list=None, message=None, revision=None,
221
if revision is not None and revision:
222
if len(revision) == 1:
223
revision = revision[0]
225
raise CommandError("shelve only accepts a single revision "
228
source = BzrPatchSource(revision, file_list)
229
s = shelf.Shelf(source.base)
230
s.shelve(source, all, message, no_color)
234
# The following classes are only used as subcommands for 'shelf', they're
235
# not to be registered directly with bzr.
237
class cmd_shelf_list(bzrlib.commands.Command):
238
"""List the patches on the current shelf."""
239
aliases = ['list', 'ls']
244
class cmd_shelf_delete(bzrlib.commands.Command):
245
"""Delete the patch from the current shelf."""
246
aliases = ['delete', 'del']
247
takes_args = ['patch']
248
def run(self, patch):
249
self.shelf.delete(patch)
252
class cmd_shelf_switch(bzrlib.commands.Command):
253
"""Switch to the other shelf, create it if necessary."""
255
takes_args = ['othershelf']
256
def run(self, othershelf):
257
s = shelf.Shelf(self.shelf.base, othershelf)
261
class cmd_shelf_show(bzrlib.commands.Command):
262
"""Show the contents of the specified or topmost patch."""
263
aliases = ['show', 'cat', 'display']
264
takes_args = ['patch?']
265
def run(self, patch=None):
266
self.shelf.display(patch)
269
class cmd_shelf_upgrade(bzrlib.commands.Command):
270
"""Upgrade old format shelves."""
271
aliases = ['upgrade']
276
class cmd_shelf(BzrToolsCommand):
277
"""Perform various operations on your shelved patches. See also shelve."""
278
takes_args = ['subcommand', 'args*']
280
subcommands = [cmd_shelf_list, cmd_shelf_delete, cmd_shelf_switch,
281
cmd_shelf_show, cmd_shelf_upgrade]
283
def run(self, subcommand, args_list):
286
if args_list is None:
288
cmd = self._get_cmd_object(subcommand)
289
source = BzrPatchSource()
290
s = shelf.Shelf(source.base)
293
if args_list is None:
295
return cmd.run_argv_aliases(args_list)
297
def _get_cmd_object(self, cmd_name):
298
for cmd_class in self.subcommands:
299
for alias in cmd_class.aliases:
300
if alias == cmd_name:
302
raise CommandError("Unknown shelf subcommand '%s'" % cmd_name)
305
text = ["%s\n\nSubcommands:\n" % self.__doc__]
307
for cmd_class in self.subcommands:
308
text.extend(self.sub_help(cmd_class) + ['\n'])
312
def sub_help(self, cmd_class):
314
cmd_obj = cmd_class()
317
usage = cmd_obj._usage()
318
usage = usage.replace('bzr shelf-', '')
319
text.append('%s%s\n' % (indent, usage))
321
text.append('%s%s\n' % (2 * indent, cmd_class.__doc__))
323
# Somewhat copied from bzrlib.help.help_on_command_options
325
for option_name, option in sorted(cmd_obj.options().items()):
326
if option_name == 'help':
328
option_help.append('%s--%s' % (3 * indent, option_name))
329
if option.type is not None:
330
option_help.append(' %s' % option.argname.upper())
331
if option.short_name():
332
option_help.append(', -%s' % option.short_name())
333
option_help.append('%s%s\n' % (2 * indent, option.help))
335
if len(option_help) > 0:
336
text.append('%soptions:\n' % (2 * indent))
337
text.extend(option_help)
342
class cmd_unshelve(BzrToolsCommand):
343
"""Restore shelved changes.
345
By default the most recently shelved changes are restored. However if you
346
specify a patch by name those changes will be restored instead.
348
See 'shelve' for more information.
351
Option('all', help='Unshelve all changes without prompting.'),
352
Option('force', help='Force unshelving even if errors occur.'),
353
Option('no-color', help='Never display changes in color.')
355
takes_args = ['patch?']
356
def run(self, patch=None, all=False, force=False, no_color=False):
357
source = BzrPatchSource()
358
s = shelf.Shelf(source.base)
359
s.unshelve(source, patch, all, force, no_color)
363
class cmd_shell(BzrToolsCommand):
364
"""Begin an interactive shell tailored for bzr.
365
Bzr commands can be used without typing bzr first, and will be run natively
366
when possible. Tab completion is tailored for bzr. The shell prompt shows
367
the branch nick, revno, and path.
369
If it encounters any moderately complicated shell command, it will punt to
374
bzr bzrtools:287/> status
377
bzr bzrtools:287/> status --[TAB][TAB]
378
--all --help --revision --show-ids
379
bzr bzrtools:287/> status --
383
return shell.run_shell()
386
class cmd_branch_history(BzrToolsCommand):
388
Display the development history of a branch.
390
Each different committer or branch nick is considered a different line of
391
development. Committers are treated as the same if they have the same
392
name, or if they have the same email address.
394
takes_args = ["branch?"]
395
def run(self, branch=None):
396
from branchhistory import branch_history
397
return branch_history(branch)
400
class cmd_zap(BzrToolsCommand):
402
Remove a lightweight checkout, if it can be done safely.
404
This command will remove a lightweight checkout without losing data. That
405
means it only removes lightweight checkouts, and only if they have no
408
If --branch is specified, the branch will be deleted too, but only if the
409
the branch has no new commits (relative to its parent).
411
takes_options = [Option("branch", help="Remove associated branch from"
413
Option('force', help='Delete tree even if contents are'
415
takes_args = ["checkout"]
416
def run(self, checkout, branch=False, force=False):
418
return zap(checkout, remove_branch=branch, allow_modified=force)
421
class cmd_cbranch(BzrToolsCommand):
423
Create a new checkout, associated with a new repository branch.
425
When you cbranch, bzr looks up a target location in locations.conf, and
426
creates the branch there.
428
In your locations.conf, add the following lines:
429
[/working_directory_root]
430
cbranch_target = /branch_root
431
cbranch_target:policy = appendpath
433
This will mean that if you run "bzr cbranch foo/bar foo/baz" in the
434
working directory root, the branch will be created in
435
"/branch_root/foo/baz"
437
NOTE: cbranch also supports "cbranch_root", but that behaviour is
440
takes_options = [Option("lightweight",
441
help="Create a lightweight checkout."), 'revision',
442
Option('files-from', type=unicode,
443
help='Accelerate checkout using files from this'
446
help='Hard-link files from source/files-from tree'
448
takes_args = ["source", "target?"]
449
def run(self, source, target=None, lightweight=False, revision=None,
450
files_from=None, hardlink=False):
451
from cbranch import cbranch
452
return cbranch(source, target, lightweight=lightweight,
453
revision=revision, files_from=files_from,
457
class cmd_branches(BzrToolsCommand):
458
"""Scan a location for branches"""
459
takes_args = ["location?"]
460
def run(self, location=None):
461
from branches import branches
462
return branches(location)
464
class cmd_trees(BzrToolsCommand):
465
"""Scan a location for trees"""
466
takes_args = ['location?']
467
def run(self, location='.'):
468
from bzrlib.workingtree import WorkingTree
469
from bzrlib.transport import get_transport
470
t = get_transport(location)
471
for tree in WorkingTree.find_trees(location):
472
self.outf.write('%s\n' % t.relpath(
473
tree.bzrdir.root_transport.base))
475
class cmd_multi_pull(BzrToolsCommand):
476
"""Pull all the branches under a location, e.g. a repository.
478
Both branches present in the directory and the branches of checkouts are
481
takes_args = ["location?"]
482
def run(self, location=None):
483
from bzrlib.transport import get_transport
484
from bzrtools import iter_branch_tree
487
t = get_transport(location)
488
possible_transports = []
490
print "Can't list this type of location."
492
for branch, wt in iter_branch_tree(t):
497
parent = branch.get_parent()
504
if base.startswith(t.base):
505
relpath = base[len(t.base):].rstrip('/')
508
print "Pulling %s from %s" % (relpath, parent)
510
branch_t = get_transport(parent, possible_transports)
511
pullable.pull(Branch.open_from_transport(branch_t))
517
class cmd_import(BzrToolsCommand):
518
"""Import sources from a directory, tarball or zip file
520
This command will import a directory, tarball or zip file into a bzr
521
tree, replacing any versioned files already present. If a directory is
522
specified, it is used as the target. If the directory does not exist, or
523
is not versioned, it is created.
525
Tarballs may be gzip or bzip2 compressed. This is autodetected.
527
If the tarball or zip has a single root directory, that directory is
528
stripped when extracting the tarball. This is not done for directories.
531
takes_args = ['source', 'tree?']
532
def run(self, source, tree=None):
533
from upstream_import import do_import
534
do_import(source, tree)
537
class cmd_cdiff(BzrToolsCommand):
538
"""A color version of bzr's diff"""
539
takes_args = property(lambda x: get_cmd_object('diff').takes_args)
540
takes_options = list(get_cmd_object('diff').takes_options) + [
541
Option('check-style',
542
help='Warn if trailing whitespace or spurious changes have been'
545
def run(self, check_style=False, *args, **kwargs):
546
from colordiff import colordiff
547
colordiff(check_style, *args, **kwargs)
550
class cmd_baz_import(BzrToolsCommand):
551
"""Import an Arch or Baz archive into a bzr repository.
553
This command should be used on local archives (or mirrors) only. It is
554
quite slow on remote archives.
556
reuse_history allows you to specify any previous imports you
557
have done of different archives, which this archive has branches
558
tagged from. This will dramatically reduce the time to convert
559
the archive as it will not have to convert the history already
560
converted in that other branch.
562
If you specify prefixes, only branches whose names start with that prefix
563
will be imported. Skipped branches will be listed, so you can import any
564
branches you missed by accident. Here's an example of doing a partial
565
import from thelove@canonical.com:
566
bzr baz-import thelove thelove@canonical.com --prefixes dists:talloc-except
568
WARNING: Encoding should not be specified unless necessary, because if you
569
specify an encoding, your converted branch will not interoperate with
570
independently-converted branches, unless the other branches were converted
571
with exactly the same encoding. Any encoding recognized by Python may
572
be specified. Aliases are not detected, so 'utf_8', 'U8', 'UTF' and 'utf8'
575
takes_args = ['to_root_dir', 'from_archive', 'reuse_history*']
576
takes_options = ['verbose', Option('prefixes', type=str,
577
help="Prefixes of branches to import, colon-separated."),
578
Option('encoding', type=str,
579
help='Force encoding to specified value. See WARNING.')]
581
def run(self, to_root_dir, from_archive, encoding=None, verbose=False,
582
reuse_history_list=[], prefixes=None):
583
from errors import NoPyBaz
586
baz_import.baz_import(to_root_dir, from_archive, encoding,
587
verbose, reuse_history_list, prefixes)
589
print "This command is disabled. Please install PyBaz."
592
class cmd_baz_import_branch(BzrToolsCommand):
593
"""Import an Arch or Baz branch into a bzr branch.
595
WARNING: Encoding should not be specified unless necessary, because if you
596
specify an encoding, your converted branch will not interoperate with
597
independently-converted branches, unless the other branches were converted
598
with exactly the same encoding. Any encoding recognized by Python may
599
be specified. Aliases are not detected, so 'utf_8', 'U8', 'UTF' and 'utf8'
602
takes_args = ['to_location', 'from_branch?', 'reuse_history*']
603
takes_options = ['verbose',
604
Option('max-count', type=int,
605
help='Maximim revisions to import at once.'),
606
Option('encoding', type=str,
607
help='Force encoding to specified value. See WARNING.')]
609
def run(self, to_location, from_branch=None, fast=False, max_count=None,
610
encoding=None, verbose=False, dry_run=False,
611
reuse_history_list=[]):
612
from errors import NoPyBaz
615
baz_import.baz_import_branch(to_location, from_branch, fast,
616
max_count, verbose, encoding, dry_run,
619
print "This command is disabled. Please install PyBaz."
622
class cmd_rspush(BzrToolsCommand):
623
"""Upload this branch to another location using rsync.
625
If no location is specified, the last-used location will be used. To
626
prevent dirty trees from being uploaded, rspush will error out if there are
627
unknown files or local changes. It will also error out if the upstream
628
directory is non-empty and not an earlier version of the branch.
630
takes_args = ['location?']
631
takes_options = [Option('overwrite', help='Ignore differences between'
632
' branches and overwrite unconditionally.'),
633
Option('no-tree', help='Do not push the working tree,'
636
def run(self, location=None, overwrite=False, no_tree=False):
637
from bzrlib import workingtree
639
cur_branch = workingtree.WorkingTree.open_containing(".")[0]
640
bzrtools.rspush(cur_branch, location, overwrite=overwrite,
641
working_tree=not no_tree)
644
class cmd_link_tree(BzrToolsCommand):
645
"""Hardlink matching files to another tree.
647
Only files with identical content and execute bit will be linked.
649
takes_args = ['location']
651
def run(self, location):
652
from bzrlib import workingtree
653
from bzrlib.plugins.bzrtools.link_tree import link_tree
654
target_tree = workingtree.WorkingTree.open_containing(".")[0]
655
source_tree = workingtree.WorkingTree.open(location)
656
target_tree.lock_write()
658
source_tree.lock_read()
660
link_tree(target_tree, source_tree)
669
cmd_baz_import_branch,
691
if hasattr(bzrlib.commands, 'register_command'):
692
for command in commands:
693
bzrlib.commands.register_command(command)
697
from bzrlib.tests.TestUtil import TestLoader
699
from doctest import DocTestSuite, ELLIPSIS
700
from unittest import TestSuite
702
import tests.clean_tree
703
import tests.test_dotgraph
704
import tests.is_clean
705
import tests.test_cbranch
706
import tests.test_link_tree
707
import tests.test_patch
708
import tests.test_rspush
709
import tests.upstream_import
711
import tests.blackbox
712
import tests.shelf_tests
714
result.addTest(DocTestSuite(bzrtools, optionflags=ELLIPSIS))
715
result.addTest(tests.clean_tree.test_suite())
718
result.addTest(DocTestSuite(baz_import))
721
result.addTest(tests.test_suite())
722
result.addTest(TestLoader().loadTestsFromModule(tests.shelf_tests))
723
result.addTest(tests.blackbox.test_suite())
724
result.addTest(tests.upstream_import.test_suite())
725
result.addTest(zap.test_suite())
726
result.addTest(TestLoader().loadTestsFromModule(tests.test_dotgraph))
727
result.addTest(TestLoader().loadTestsFromModule(tests.is_clean))
728
result.addTest(TestLoader().loadTestsFromModule(tests.test_link_tree))
729
result.addTest(TestLoader().loadTestsFromModule(tests.test_patch))
730
result.addTest(TestLoader().loadTestsFromModule(tests.test_rspush))
731
result.addTest(TestLoader().loadTestsFromModule(tests.test_cbranch))
added
removed
__init__.py
