3
Various useful plugins for working with bzr.
8
from shelf import Shelf
1
# Copyright (C) 2005, 2006, 2007 Aaron Bentley <aaron@aaronbentley.com>
2
# Copyright (C) 2005, 2006, 2011 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
23
from bzrlib.lazy_import import lazy_import
24
lazy_import(globals(), """
25
from bzrlib import help, urlutils
29
from command import BzrToolsCommand
30
from errors import CommandError
31
from patchsource import BzrPatchSource
11
from bzrlib.option import Option
35
import bzrlib.builtins
36
import bzrlib.commands
37
from bzrlib.branch import Branch
38
from bzrlib.bzrdir import BzrDir
39
from bzrlib.commands import get_cmd_object
13
40
from bzrlib.errors import BzrCommandError
14
from reweave_inventory import cmd_fix
15
sys.path.insert(0, os.path.realpath(os.path.join(os.path.dirname(__file__),
18
Option.OPTIONS['ignored'] = Option('ignored',
19
help='delete all ignored files.')
20
Option.OPTIONS['detritus'] = Option('detritus',
21
help='delete conflict files merge backups, and failed selftest dirs.' +
22
'(*.THIS, *.BASE, *.OTHER, *~, *.tmp')
23
Option.OPTIONS['dry-run'] = Option('dry-run',
24
help='show files to delete instead of deleting them.')
26
class cmd_clean_tree(bzrlib.commands.Command):
27
"""Remove unwanted files from working tree.
28
Normally, ignored files are left alone.
30
takes_options = ['ignored', 'detritus', 'dry-run']
31
def run(self, ignored=False, detritus=False, dry_run=False):
32
from clean_tree import clean_tree
33
clean_tree('.', ignored=ignored, detritus=detritus, dry_run=dry_run)
35
Option.OPTIONS['no-collapse'] = Option('no-collapse')
36
Option.OPTIONS['no-antialias'] = Option('no-antialias')
37
Option.OPTIONS['cluster'] = Option('cluster')
38
Option.OPTIONS['merge-branch'] = Option('merge-branch',type=str)
40
class cmd_graph_ancestry(bzrlib.commands.Command):
42
from bzrlib.trace import note
43
from bzrlib.option import Option, RegistryOption
44
from bzrlib.workingtree import WorkingTree
46
from command import BzrToolsCommand
49
class cmd_graph_ancestry(BzrToolsCommand):
41
50
"""Produce ancestry graphs using dot.
43
52
Output format is detected according to file extension. Some of the more
44
common output formats are png, gif, svg, ps. An extension of '.dot' will
45
cause a dot graph file to be produced.
53
common output formats are html, png, gif, svg, ps. An extension of '.dot'
54
will cause a dot graph file to be produced. HTML output has mouseovers
55
that show the commit message.
47
57
Branches are labeled r?, where ? is the revno. If they have no revno,
48
58
with the last 5 characters of their revision identifier are used instead.
60
The value starting with d is "(maximum) distance from the null revision".
50
62
If --merge-branch is specified, the two branches are compared and a merge
54
66
white normal revision
55
67
yellow THIS history
57
69
orange COMMON history
58
70
blue COMMON non-history ancestor
59
dotted Missing from branch storage
71
green Merge base (COMMON ancestor farthest from the null revision)
72
dotted Ghost revision (missing from branch storage)
61
Ancestry is usually collapsed by removing revisions with a single parent
74
Ancestry is usually collapsed by skipping revisions with a single parent
62
75
and descendant. The number of skipped revisions is shown on the arrow.
63
76
This feature can be disabled with --no-collapse.
68
81
If available, rsvg is used to antialias PNG and JPEG output, but this can
69
82
be disabled with --no-antialias.
71
takes_args = ['branch', 'file']
72
takes_options = ['no-collapse', 'no-antialias', 'merge-branch', 'cluster']
73
def run(self, branch, file, no_collapse=False, no_antialias=False,
74
merge_branch=None, cluster=False):
84
takes_args = ['file', 'merge_branch?']
85
takes_options = [Option('no-collapse', help="Do not skip simple nodes."),
86
Option('no-antialias',
87
help="Do not use rsvg to produce antialiased output."),
88
Option('merge-branch', type=str,
89
help="Use this branch to calcuate a merge base."),
90
Option('cluster', help="Use clustered output."),
91
Option('max-distance',
92
help="Show no nodes farther than this.", type=int),
94
help='Source branch to use (default is current'
99
def run(self, file, merge_branch=None, no_collapse=False,
100
no_antialias=False, cluster=False, max_distance=100,
102
if max_distance == -1:
77
106
ranking = "cluster"
79
108
ranking = "forced"
80
graph.write_ancestry_file(branch, file, not no_collapse,
81
not no_antialias, merge_branch, ranking)
83
class cmd_fetch_ghosts(bzrlib.commands.Command):
109
graph.write_ancestry_file(directory, file, not no_collapse,
110
not no_antialias, merge_branch, ranking,
111
max_distance=max_distance)
114
class cmd_fetch_ghosts(BzrToolsCommand):
84
115
"""Attempt to retrieve ghosts from another branch.
85
116
If the other branch is not supplied, the last-pulled branch is used.
87
118
aliases = ['fetch-missing']
88
119
takes_args = ['branch?']
89
takes_options = [Option('no-fix')]
120
takes_options = [Option('no-fix', help="Skip additional synchonization.")]
90
121
def run(self, branch=None, no_fix=False):
91
122
from fetch_ghosts import fetch_ghosts
92
fetch_ghosts(branch, no_fix)
123
fetch_ghosts(branch, do_reconcile=not no_fix)
94
125
strip_help="""Strip the smallest prefix containing num leading slashes from \
95
126
each file name found in the patch file."""
96
Option.OPTIONS['strip'] = Option('strip', type=int, help=strip_help)
97
class cmd_patch(bzrlib.commands.Command):
129
class cmd_patch(BzrToolsCommand):
98
130
"""Apply a named patch to the current tree.
100
132
takes_args = ['filename?']
101
takes_options = ['strip']
102
def run(self, filename=None, strip=0):
133
takes_options = [Option('strip', type=int, short_name='p',
135
Option('silent', help='Suppress chatter.')]
136
def run(self, filename=None, strip=None, silent=False):
103
137
from patch import patch
104
from bzrlib.branch import Branch
105
b = Branch.open_containing('.')[0]
106
return patch(b, filename, strip)
109
class cmd_shelve(bzrlib.commands.Command):
110
"""Temporarily remove some changes from the current tree.
111
Use 'unshelve' to restore these changes.
113
If filenames are specified, only changes to those files will be unshelved.
114
If a revision is specified, all changes since that revision will may be
138
from bzrlib.workingtree import WorkingTree
139
wt = WorkingTree.open_containing('.')[0]
142
return patch(wt, filename, strip, silent)
145
class cmd_shelve1(BzrToolsCommand):
146
"""Temporarily set aside some changes from the current tree.
148
Shelve allows you to temporarily put changes you've made "on the shelf",
149
ie. out of the way, until a later time when you can bring them back from
150
the shelf with the 'unshelve1' command.
152
Shelve is intended to help separate several sets of text changes that have
153
been inappropriately mingled. If you just want to get rid of all changes
154
(text and otherwise) and you don't need to restore them later, use revert.
155
If you want to shelve all text changes at once, use shelve1 --all.
157
By default shelve1 asks you what you want to shelve, press '?' at the
158
prompt to get help. To shelve everything run shelve1 --all.
160
If filenames are specified, only the changes to those files will be
161
shelved, other files will be left untouched.
163
If a revision is specified, changes since that revision will be shelved.
165
You can put multiple items on the shelf. Normally each time you run
166
unshelve1 the most recently shelved changes will be reinstated. However,
167
you can also unshelve changes in a different order by explicitly
168
specifiying which changes to unshelve1. This works best when the changes
169
don't depend on each other.
171
While you have patches on the shelf you can view and manipulate them with
172
the 'shelf1' command. Run 'bzr shelf1 -h' for more info.
117
175
takes_args = ['file*']
118
takes_options = ['all', 'message', 'revision']
119
def run(self, all=False, file_list=None, message=None, revision=None):
120
if file_list is not None and len(file_list) > 0:
121
branchdir = file_list[0]
176
takes_options = [Option('message',
177
help='A message to associate with the shelved changes.',
178
short_name='m', type=unicode),
180
Option('all', help='Shelve all changes without prompting.'),
181
Option('no-color', help='Never display changes in color.')]
183
def run(self, all=False, file_list=None, message=None, revision=None,
125
185
if revision is not None and revision:
126
186
if len(revision) == 1:
127
187
revision = revision[0]
129
raise BzrCommandError("shelve only accepts a single revision "
189
raise CommandError("shelve only accepts a single revision "
133
return s.shelve(all, message, revision, file_list)
136
class cmd_unshelve(bzrlib.commands.Command):
137
"""Restore previously-shelved changes to the current tree.
192
source = BzrPatchSource(revision, file_list)
193
s = shelf.Shelf(source.base)
194
s.shelve(source, all, message, no_color)
198
# The following classes are only used as subcommands for 'shelf1', they're
199
# not to be registered directly with bzr.
201
class cmd_shelf_list(bzrlib.commands.Command):
202
"""List the patches on the current shelf."""
203
aliases = ['list', 'ls']
208
class cmd_shelf_delete(bzrlib.commands.Command):
209
"""Delete the patch from the current shelf."""
210
aliases = ['delete', 'del']
211
takes_args = ['patch']
212
def run(self, patch):
213
self.shelf.delete(patch)
216
class cmd_shelf_switch(bzrlib.commands.Command):
217
"""Switch to the other shelf, create it if necessary."""
219
takes_args = ['othershelf']
220
def run(self, othershelf):
221
s = shelf.Shelf(self.shelf.base, othershelf)
225
class cmd_shelf_show(bzrlib.commands.Command):
226
"""Show the contents of the specified or topmost patch."""
227
aliases = ['show', 'cat', 'display']
228
takes_args = ['patch?']
229
def run(self, patch=None):
230
self.shelf.display(patch)
233
class cmd_shelf_upgrade(bzrlib.commands.Command):
234
"""Upgrade old format shelves."""
235
aliases = ['upgrade']
240
class cmd_shelf1(BzrToolsCommand):
241
"""Perform various operations on your shelved patches. See also shelve1."""
242
takes_args = ['subcommand', 'args*']
244
subcommands = [cmd_shelf_list, cmd_shelf_delete, cmd_shelf_switch,
245
cmd_shelf_show, cmd_shelf_upgrade]
247
def run(self, subcommand, args_list):
250
if args_list is None:
252
cmd = self._get_cmd_object(subcommand)
253
source = BzrPatchSource()
254
s = shelf.Shelf(source.base)
257
if args_list is None:
259
return cmd.run_argv_aliases(args_list)
261
def _get_cmd_object(self, cmd_name):
262
for cmd_class in self.subcommands:
263
for alias in cmd_class.aliases:
264
if alias == cmd_name:
266
raise CommandError("Unknown shelf subcommand '%s'" % cmd_name)
269
text = ["%s\n\nSubcommands:\n" % self.__doc__]
271
for cmd_class in self.subcommands:
272
text.extend(self.sub_help(cmd_class) + ['\n'])
276
def sub_help(self, cmd_class):
278
cmd_obj = cmd_class()
281
usage = cmd_obj._usage()
282
usage = usage.replace('bzr shelf-', '')
283
text.append('%s%s\n' % (indent, usage))
285
text.append('%s%s\n' % (2 * indent, cmd_class.__doc__))
287
# Somewhat copied from bzrlib.help.help_on_command_options
289
for option_name, option in sorted(cmd_obj.options().items()):
290
if option_name == 'help':
292
option_help.append('%s--%s' % (3 * indent, option_name))
293
if option.type is not None:
294
option_help.append(' %s' % option.argname.upper())
295
if option.short_name():
296
option_help.append(', -%s' % option.short_name())
297
option_help.append('%s%s\n' % (2 * indent, option.help))
299
if len(option_help) > 0:
300
text.append('%soptions:\n' % (2 * indent))
301
text.extend(option_help)
306
class cmd_unshelve1(BzrToolsCommand):
307
"""Restore shelved changes.
309
By default the most recently shelved changes are restored. However if you
310
specify a patch by name those changes will be restored instead.
312
See 'shelve1' for more information.
144
class cmd_shell(bzrlib.commands.Command):
315
Option('all', help='Unshelve all changes without prompting.'),
316
Option('force', help='Force unshelving even if errors occur.'),
317
Option('no-color', help='Never display changes in color.')
319
takes_args = ['patch?']
320
def run(self, patch=None, all=False, force=False, no_color=False):
321
source = BzrPatchSource()
322
s = shelf.Shelf(source.base)
323
s.unshelve(source, patch, all, force, no_color)
327
class cmd_shell(BzrToolsCommand):
145
328
"""Begin an interactive shell tailored for bzr.
146
329
Bzr commands can be used without typing bzr first, and will be run natively
147
330
when possible. Tab completion is tailored for bzr. The shell prompt shows
159
342
--all --help --revision --show-ids
160
343
bzr bzrtools:287/> status --
347
help='Branch in which to start the shell, '
348
'rather than the one containing the working directory.',
353
def run(self, directory=None):
164
return shell.run_shell()
166
commands = [cmd_shelve, cmd_unshelve, cmd_clean_tree, cmd_graph_ancestry,
167
cmd_fetch_ghosts, cmd_patch, cmd_shell, cmd_fix]
169
command_decorators = []
171
command_decorators = []
173
import bzrlib.builtins
174
if not hasattr(bzrlib.builtins, "cmd_annotate"):
175
commands.append(annotate.cmd_annotate)
176
if not hasattr(bzrlib.builtins, "cmd_push"):
177
commands.append(push.cmd_push)
179
command_decorators.append(push.cmd_push)
181
from errors import NoPyBaz
184
commands.append(baz_import.cmd_baz_import_branch)
185
commands.append(baz_import.cmd_baz_import)
188
class cmd_baz_import(bzrlib.commands.Command):
189
"""Disabled. (Requires PyBaz)"""
190
takes_args = ['to_root_dir?', 'from_archive?']
191
takes_options = ['verbose']
192
def run(self, to_root_dir=None, from_archive=None, verbose=False):
193
print "This command is disabled. Please install PyBaz."
194
commands.append(cmd_baz_import)
197
if hasattr(bzrlib.commands, 'register_command'):
198
for command in commands:
199
bzrlib.commands.register_command(command)
200
for command in command_decorators:
201
command._original_command = bzrlib.commands.register_command(
208
from doctest import DocTestSuite
209
from unittest import TestSuite, TestLoader
214
result.addTest(DocTestSuite(bzrtools))
215
result.addTest(clean_tree.test_suite())
216
result.addTest(DocTestSuite(baz_import))
217
result.addTest(tests.test_suite())
218
result.addTest(TestLoader().loadTestsFromModule(shelf_tests))
219
result.addTest(blackbox.test_suite())
355
return shell.run_shell(directory)
358
class cmd_branch_history(BzrToolsCommand):
360
Display the development history of a branch.
362
Each different committer or branch nick is considered a different line of
363
development. Committers are treated as the same if they have the same
364
name, or if they have the same email address.
366
takes_args = ["branch?"]
367
def run(self, branch=None):
368
from branchhistory import branch_history
369
return branch_history(branch)
372
class cmd_zap(BzrToolsCommand):
374
Remove a lightweight checkout, if it can be done safely.
376
This command will remove a lightweight checkout without losing data. That
377
means it only removes lightweight checkouts, and only if they have no
380
If --branch is specified, the branch will be deleted too, but only if the
381
the branch has no new commits (relative to its parent).
383
If bzr-pipeline is also installed, the --store option will store changes
384
in the branch before deleting the tree. To restore the changes, do::
386
bzr checkout --lightweight $BRANCH $CHECKOUT
387
bzr switch-pipe -d $CHECKOUT `bzr nick -d $CHECKOUT`
389
takes_options = [Option("branch", help="Remove associated branch from"
391
RegistryOption('change_policy',
392
'How to handle changed files',
394
('bzrlib.plugins.bzrtools.zap',
395
'change_policy_registry'),
398
takes_args = ["checkout"]
399
def run(self, checkout, branch=False, change_policy=None):
401
change_policy_registry,
405
if change_policy is None:
406
change_policy = change_policy_registry.get()
407
if change_policy is StoreChanges:
409
import bzrlib.plugins.pipeline
411
raise BzrCommandError('--store requires bzr-pipeline.')
412
return zap(checkout, remove_branch=branch, policy=change_policy)
415
class cmd_cbranch(BzrToolsCommand):
417
Create a new checkout, associated with a new repository branch.
419
When you cbranch, bzr looks up a target location in locations.conf, and
420
creates the branch there.
422
In your locations.conf, add the following lines:
423
[/working_directory_root]
424
cbranch_target = /branch_root
425
cbranch_target:policy = appendpath
427
This will mean that if you run "bzr cbranch foo/bar foo/baz" in the
428
working directory root, the branch will be created in
429
"/branch_root/foo/baz"
431
NOTE: cbranch also supports "cbranch_root", but that behaviour is
434
takes_options = [Option("lightweight",
435
help="Create a lightweight checkout."), 'revision',
436
Option('files-from', type=unicode,
437
help='Accelerate checkout using files from this'
440
help='Hard-link files from source/files-from tree'
442
takes_args = ["source", "target?"]
443
def run(self, source, target=None, lightweight=False, revision=None,
444
files_from=None, hardlink=False):
445
from cbranch import cbranch
446
return cbranch(source, target, lightweight=lightweight,
447
revision=revision, files_from=files_from,
451
class cmd_branches(BzrToolsCommand):
452
"""Scan a location for branches"""
453
takes_args = ["location?"]
454
def run(self, location=None):
455
from branches import branches
456
return branches(location)
458
class cmd_trees(BzrToolsCommand):
459
"""Scan a location for trees"""
460
takes_args = ['location?']
461
def run(self, location='.'):
462
from bzrlib.workingtree import WorkingTree
463
from bzrlib.transport import get_transport
464
t = get_transport(location)
465
for tree in WorkingTree.find_trees(location):
466
self.outf.write('%s\n' % t.relpath(
467
tree.bzrdir.root_transport.base))
469
class cmd_multi_pull(BzrToolsCommand):
470
"""Pull all the branches under a location, e.g. a repository.
472
Both branches present in the directory and the branches of checkouts are
475
takes_args = ["location?"]
476
def run(self, location=None):
477
from bzrlib.transport import get_transport
478
from bzrtools import iter_branch_tree
481
t = get_transport(location)
482
possible_transports = []
484
print "Can't list this type of location."
486
for branch, wt in iter_branch_tree(t):
491
parent = branch.get_parent()
498
if base.startswith(t.base):
499
relpath = base[len(t.base):].rstrip('/')
502
print "Pulling %s from %s" % (relpath, parent)
504
branch_t = get_transport(parent, possible_transports)
505
pullable.pull(Branch.open_from_transport(branch_t))
511
class cmd_import(BzrToolsCommand):
512
"""Import sources from a directory, tarball or zip file
514
This command will import a directory, tarball or zip file into a bzr
515
tree, replacing any versioned files already present. If a directory is
516
specified, it is used as the target. If the directory does not exist, or
517
is not versioned, it is created.
519
Tarballs may be gzip or bzip2 compressed. This is autodetected.
521
If the tarball or zip has a single root directory, that directory is
522
stripped when extracting the tarball. This is not done for directories.
525
takes_args = ['source', 'tree?']
526
def run(self, source, tree=None):
527
from upstream_import import do_import
528
do_import(source, tree)
531
class cmd_cdiff(BzrToolsCommand):
532
"""A color version of bzr's diff"""
533
takes_args = property(lambda x: get_cmd_object('diff').takes_args)
534
takes_options = list(get_cmd_object('diff').takes_options) + [
535
RegistryOption.from_kwargs('color',
536
'Color mode to use.',
537
title='Color Mode', value_switches=False, enum_switch=True,
538
never='Never colorize output.',
539
auto='Only colorize output if terminal supports it and STDOUT is a'
541
always='Always colorize output (default).'),
542
Option('check-style',
543
help='Warn if trailing whitespace or spurious changes have been'
546
def run(self, color='always', check_style=False, *args, **kwargs):
547
from colordiff import colordiff
548
colordiff(color, check_style, *args, **kwargs)
551
class cmd_conflict_diff(BzrToolsCommand):
553
"""Compare a conflicted file against BASE."""
555
encoding_type = 'exact'
556
takes_args = ['file*']
558
RegistryOption.from_kwargs('direction', 'Direction of comparison.',
559
value_switches=True, enum_switch=False,
560
other='Compare OTHER against common base.',
561
this='Compare THIS against common base.')]
563
def run(self, file_list, direction='other'):
564
from bzrlib.plugins.bzrtools.colordiff import DiffWriter
565
from conflict_diff import ConflictDiffer
566
dw = DiffWriter(self.outf, check_style=False, color='auto')
567
ConflictDiffer().run(dw, file_list, direction)
570
class cmd_rspush(BzrToolsCommand):
571
"""Upload this branch to another location using rsync.
573
If no location is specified, the last-used location will be used. To
574
prevent dirty trees from being uploaded, rspush will error out if there are
575
unknown files or local changes. It will also error out if the upstream
576
directory is non-empty and not an earlier version of the branch.
578
takes_args = ['location?']
579
takes_options = [Option('overwrite', help='Ignore differences between'
580
' branches and overwrite unconditionally.'),
581
Option('no-tree', help='Do not push the working tree,'
584
def run(self, location=None, overwrite=False, no_tree=False):
585
from bzrlib import workingtree
587
cur_branch = workingtree.WorkingTree.open_containing(".")[0]
588
bzrtools.rspush(cur_branch, location, overwrite=overwrite,
589
working_tree=not no_tree)
592
class cmd_link_tree(BzrToolsCommand):
593
"""Hardlink matching files to another tree.
595
Only files with identical content and execute bit will be linked.
597
takes_args = ['location']
599
def run(self, location):
600
from bzrlib import workingtree
601
from bzrlib.plugins.bzrtools.link_tree import link_tree
602
target_tree = workingtree.WorkingTree.open_containing(".")[0]
603
source_tree = workingtree.WorkingTree.open(location)
604
target_tree.lock_write()
606
source_tree.lock_read()
608
link_tree(target_tree, source_tree)
615
class cmd_create_mirror(BzrToolsCommand):
616
"""Create a mirror of another branch.
618
This is similar to `bzr branch`, but copies more settings, including the
619
submit branch and nickname.
621
It sets the public branch and parent of the target to the source location.
624
takes_args = ['source', 'target']
626
def run(self, source, target):
627
source_branch = Branch.open(source)
628
from bzrlib.plugins.bzrtools.mirror import create_mirror
629
create_mirror(source_branch, target, [])
added
removed
command_classes.py
