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 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
sys.path.insert(0, os.path.realpath(os.path.join(os.path.dirname(__file__),
17
Option.OPTIONS['ignored'] = Option('ignored',
18
help='delete all ignored files.')
19
Option.OPTIONS['detrius'] = Option('detrius',
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.')
25
class cmd_clean_tree(bzrlib.commands.Command):
26
"""Remove unwanted files from working tree.
27
Normally, ignored files are left alone.
29
takes_options = ['ignored', 'detrius', 'dry-run']
30
def run(self, ignored=False, detrius=False, dry_run=False):
31
from clean_tree import clean_tree
32
clean_tree('.', ignored=ignored, detrius=detrius, 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)
39
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):
40
50
"""Produce ancestry graphs using dot.
42
52
Output format is detected according to file extension. Some of the more
43
common output formats are png, gif, svg, ps. An extension of '.dot' will
44
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.
46
57
Branches are labeled r?, where ? is the revno. If they have no revno,
47
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".
49
62
If --merge-branch is specified, the two branches are compared and a merge
53
66
white normal revision
54
67
yellow THIS history
56
69
orange COMMON history
57
70
blue COMMON non-history ancestor
58
dotted Missing from branch storage
71
green Merge base (COMMON ancestor farthest from the null revision)
72
dotted Ghost revision (missing from branch storage)
60
Ancestry is usually collapsed by removing revisions with a single parent
74
Ancestry is usually collapsed by skipping revisions with a single parent
61
75
and descendant. The number of skipped revisions is shown on the arrow.
62
76
This feature can be disabled with --no-collapse.
67
81
If available, rsvg is used to antialias PNG and JPEG output, but this can
68
82
be disabled with --no-antialias.
70
takes_args = ['branch', 'file']
71
takes_options = ['no-collapse', 'no-antialias', 'merge-branch', 'cluster']
72
def run(self, branch, file, no_collapse=False, no_antialias=False,
73
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:
76
106
ranking = "cluster"
78
108
ranking = "forced"
79
graph.write_ancestry_file(branch, file, not no_collapse,
80
not no_antialias, merge_branch, ranking)
82
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):
83
115
"""Attempt to retrieve ghosts from another branch.
84
116
If the other branch is not supplied, the last-pulled branch is used.
86
118
aliases = ['fetch-missing']
87
119
takes_args = ['branch?']
88
def run(self, branch=None):
120
takes_options = [Option('no-fix', help="Skip additional synchonization.")]
121
def run(self, branch=None, no_fix=False):
89
122
from fetch_ghosts import fetch_ghosts
123
fetch_ghosts(branch, do_reconcile=not no_fix)
92
125
strip_help="""Strip the smallest prefix containing num leading slashes from \
93
126
each file name found in the patch file."""
94
Option.OPTIONS['strip'] = Option('strip', type=int, help=strip_help)
95
class cmd_patch(bzrlib.commands.Command):
129
class cmd_patch(BzrToolsCommand):
96
130
"""Apply a named patch to the current tree.
98
132
takes_args = ['filename?']
99
takes_options = ['strip']
100
def run(self, filename=None, strip=0):
133
takes_options = [Option('strip', type=int, help=strip_help),
134
Option('silent', help='Suppress chatter.')]
135
def run(self, filename=None, strip=None, silent=False):
101
136
from patch import patch
102
from bzrlib.branch import Branch
103
b = Branch.open_containing('.')[0]
104
return patch(b, filename, strip)
107
class cmd_shelve(bzrlib.commands.Command):
108
"""Temporarily remove some changes from the current tree.
109
Use 'unshelve' to restore these changes.
111
If filenames are specified, only changes to those files will be unshelved.
112
If a revision is specified, all changes since that revision will may be
137
from bzrlib.workingtree import WorkingTree
138
wt = WorkingTree.open_containing('.')[0]
141
return patch(wt, filename, strip, silent)
144
class cmd_shelve1(BzrToolsCommand):
145
"""Temporarily set aside some changes from the current tree.
147
Shelve allows you to temporarily put changes you've made "on the shelf",
148
ie. out of the way, until a later time when you can bring them back from
149
the shelf with the 'unshelve1' command.
151
Shelve is intended to help separate several sets of text changes that have
152
been inappropriately mingled. If you just want to get rid of all changes
153
(text and otherwise) and you don't need to restore them later, use revert.
154
If you want to shelve all text changes at once, use shelve1 --all.
156
By default shelve1 asks you what you want to shelve, press '?' at the
157
prompt to get help. To shelve everything run shelve1 --all.
159
If filenames are specified, only the changes to those files will be
160
shelved, other files will be left untouched.
162
If a revision is specified, changes since that revision will be shelved.
164
You can put multiple items on the shelf. Normally each time you run
165
unshelve1 the most recently shelved changes will be reinstated. However,
166
you can also unshelve changes in a different order by explicitly
167
specifiying which changes to unshelve1. This works best when the changes
168
don't depend on each other.
170
While you have patches on the shelf you can view and manipulate them with
171
the 'shelf1' command. Run 'bzr shelf1 -h' for more info.
115
174
takes_args = ['file*']
116
takes_options = ['all', 'message', 'revision']
117
def run(self, all=False, file_list=None, message=None, revision=None):
118
if file_list is not None and len(file_list) > 0:
119
branchdir = file_list[0]
175
takes_options = [Option('message',
176
help='A message to associate with the shelved changes.',
177
short_name='m', type=unicode),
179
Option('all', help='Shelve all changes without prompting.'),
180
Option('no-color', help='Never display changes in color.')]
182
def run(self, all=False, file_list=None, message=None, revision=None,
123
184
if revision is not None and revision:
124
185
if len(revision) == 1:
125
186
revision = revision[0]
127
raise BzrCommandError("shelve only accepts a single revision "
188
raise CommandError("shelve only accepts a single revision "
131
return s.shelve(all, message, revision, file_list)
134
class cmd_unshelve(bzrlib.commands.Command):
135
"""Restore previously-shelved changes to the current tree.
142
class cmd_shell(bzrlib.commands.Command):
191
source = BzrPatchSource(revision, file_list)
192
s = shelf.Shelf(source.base)
193
s.shelve(source, all, message, no_color)
197
# The following classes are only used as subcommands for 'shelf1', they're
198
# not to be registered directly with bzr.
200
class cmd_shelf_list(bzrlib.commands.Command):
201
"""List the patches on the current shelf."""
202
aliases = ['list', 'ls']
207
class cmd_shelf_delete(bzrlib.commands.Command):
208
"""Delete the patch from the current shelf."""
209
aliases = ['delete', 'del']
210
takes_args = ['patch']
211
def run(self, patch):
212
self.shelf.delete(patch)
215
class cmd_shelf_switch(bzrlib.commands.Command):
216
"""Switch to the other shelf, create it if necessary."""
218
takes_args = ['othershelf']
219
def run(self, othershelf):
220
s = shelf.Shelf(self.shelf.base, othershelf)
224
class cmd_shelf_show(bzrlib.commands.Command):
225
"""Show the contents of the specified or topmost patch."""
226
aliases = ['show', 'cat', 'display']
227
takes_args = ['patch?']
228
def run(self, patch=None):
229
self.shelf.display(patch)
232
class cmd_shelf_upgrade(bzrlib.commands.Command):
233
"""Upgrade old format shelves."""
234
aliases = ['upgrade']
239
class cmd_shelf1(BzrToolsCommand):
240
"""Perform various operations on your shelved patches. See also shelve1."""
241
takes_args = ['subcommand', 'args*']
243
subcommands = [cmd_shelf_list, cmd_shelf_delete, cmd_shelf_switch,
244
cmd_shelf_show, cmd_shelf_upgrade]
246
def run(self, subcommand, args_list):
249
if args_list is None:
251
cmd = self._get_cmd_object(subcommand)
252
source = BzrPatchSource()
253
s = shelf.Shelf(source.base)
256
if args_list is None:
258
return cmd.run_argv_aliases(args_list)
260
def _get_cmd_object(self, cmd_name):
261
for cmd_class in self.subcommands:
262
for alias in cmd_class.aliases:
263
if alias == cmd_name:
265
raise CommandError("Unknown shelf subcommand '%s'" % cmd_name)
268
text = ["%s\n\nSubcommands:\n" % self.__doc__]
270
for cmd_class in self.subcommands:
271
text.extend(self.sub_help(cmd_class) + ['\n'])
275
def sub_help(self, cmd_class):
277
cmd_obj = cmd_class()
280
usage = cmd_obj._usage()
281
usage = usage.replace('bzr shelf-', '')
282
text.append('%s%s\n' % (indent, usage))
284
text.append('%s%s\n' % (2 * indent, cmd_class.__doc__))
286
# Somewhat copied from bzrlib.help.help_on_command_options
288
for option_name, option in sorted(cmd_obj.options().items()):
289
if option_name == 'help':
291
option_help.append('%s--%s' % (3 * indent, option_name))
292
if option.type is not None:
293
option_help.append(' %s' % option.argname.upper())
294
if option.short_name():
295
option_help.append(', -%s' % option.short_name())
296
option_help.append('%s%s\n' % (2 * indent, option.help))
298
if len(option_help) > 0:
299
text.append('%soptions:\n' % (2 * indent))
300
text.extend(option_help)
305
class cmd_unshelve1(BzrToolsCommand):
306
"""Restore shelved changes.
308
By default the most recently shelved changes are restored. However if you
309
specify a patch by name those changes will be restored instead.
311
See 'shelve1' for more information.
314
Option('all', help='Unshelve all changes without prompting.'),
315
Option('force', help='Force unshelving even if errors occur.'),
316
Option('no-color', help='Never display changes in color.')
318
takes_args = ['patch?']
319
def run(self, patch=None, all=False, force=False, no_color=False):
320
source = BzrPatchSource()
321
s = shelf.Shelf(source.base)
322
s.unshelve(source, patch, all, force, no_color)
326
class cmd_shell(BzrToolsCommand):
327
"""Begin an interactive shell tailored for bzr.
328
Bzr commands can be used without typing bzr first, and will be run natively
329
when possible. Tab completion is tailored for bzr. The shell prompt shows
330
the branch nick, revno, and path.
332
If it encounters any moderately complicated shell command, it will punt to
337
bzr bzrtools:287/> status
340
bzr bzrtools:287/> status --[TAB][TAB]
341
--all --help --revision --show-ids
342
bzr bzrtools:287/> status --
147
commands = [cmd_shelve, cmd_unshelve, cmd_clean_tree, cmd_graph_ancestry,
148
cmd_fetch_ghosts, cmd_patch, cmd_shell]
150
import bzrlib.builtins
151
if not hasattr(bzrlib.builtins, "cmd_annotate"):
152
commands.append(annotate.cmd_annotate)
153
if not hasattr(bzrlib.builtins, "cmd_push"):
154
commands.append(push.cmd_push)
156
from errors import NoPyBaz
159
commands.append(baz_import.cmd_baz_import_branch)
160
commands.append(baz_import.cmd_baz_import)
163
class cmd_baz_import(bzrlib.commands.Command):
164
"""Disabled. (Requires PyBaz)"""
165
takes_args = ['to_root_dir?', 'from_archive?']
166
takes_options = ['verbose']
167
def run(self, to_root_dir=None, from_archive=None, verbose=False):
168
print "This command is disabled. Please install PyBaz."
169
commands.append(cmd_baz_import)
171
if hasattr(bzrlib.commands, 'register_command'):
172
for command in commands:
173
bzrlib.commands.register_command(command)
178
from doctest import DocTestSuite
179
from unittest import TestSuite, TestLoader
184
result.addTest(DocTestSuite(bzrtools))
185
result.addTest(clean_tree.test_suite())
186
result.addTest(DocTestSuite(baz_import))
187
result.addTest(tests.test_suite())
188
result.addTest(TestLoader().loadTestsFromModule(shelf_tests))
189
result.addTest(blackbox.test_suite())
346
return shell.run_shell()
349
class cmd_branch_history(BzrToolsCommand):
351
Display the development history of a branch.
353
Each different committer or branch nick is considered a different line of
354
development. Committers are treated as the same if they have the same
355
name, or if they have the same email address.
357
takes_args = ["branch?"]
358
def run(self, branch=None):
359
from branchhistory import branch_history
360
return branch_history(branch)
363
class cmd_zap(BzrToolsCommand):
365
Remove a lightweight checkout, if it can be done safely.
367
This command will remove a lightweight checkout without losing data. That
368
means it only removes lightweight checkouts, and only if they have no
371
If --branch is specified, the branch will be deleted too, but only if the
372
the branch has no new commits (relative to its parent).
374
takes_options = [Option("branch", help="Remove associated branch from"
376
Option('force', help='Delete tree even if contents are'
378
takes_args = ["checkout"]
379
def run(self, checkout, branch=False, force=False):
381
return zap(checkout, remove_branch=branch, allow_modified=force)
384
class cmd_cbranch(BzrToolsCommand):
386
Create a new checkout, associated with a new repository branch.
388
When you cbranch, bzr looks up a target location in locations.conf, and
389
creates the branch there.
391
In your locations.conf, add the following lines:
392
[/working_directory_root]
393
cbranch_target = /branch_root
394
cbranch_target:policy = appendpath
396
This will mean that if you run "bzr cbranch foo/bar foo/baz" in the
397
working directory root, the branch will be created in
398
"/branch_root/foo/baz"
400
NOTE: cbranch also supports "cbranch_root", but that behaviour is
403
takes_options = [Option("lightweight",
404
help="Create a lightweight checkout."), 'revision',
405
Option('files-from', type=unicode,
406
help='Accelerate checkout using files from this'
409
help='Hard-link files from source/files-from tree'
411
takes_args = ["source", "target?"]
412
def run(self, source, target=None, lightweight=False, revision=None,
413
files_from=None, hardlink=False):
414
from cbranch import cbranch
415
return cbranch(source, target, lightweight=lightweight,
416
revision=revision, files_from=files_from,
420
class cmd_branches(BzrToolsCommand):
421
"""Scan a location for branches"""
422
takes_args = ["location?"]
423
def run(self, location=None):
424
from branches import branches
425
return branches(location)
427
class cmd_trees(BzrToolsCommand):
428
"""Scan a location for trees"""
429
takes_args = ['location?']
430
def run(self, location='.'):
431
from bzrlib.workingtree import WorkingTree
432
from bzrlib.transport import get_transport
433
t = get_transport(location)
434
for tree in WorkingTree.find_trees(location):
435
self.outf.write('%s\n' % t.relpath(
436
tree.bzrdir.root_transport.base))
438
class cmd_multi_pull(BzrToolsCommand):
439
"""Pull all the branches under a location, e.g. a repository.
441
Both branches present in the directory and the branches of checkouts are
444
takes_args = ["location?"]
445
def run(self, location=None):
446
from bzrlib.transport import get_transport
447
from bzrtools import iter_branch_tree
450
t = get_transport(location)
451
possible_transports = []
453
print "Can't list this type of location."
455
for branch, wt in iter_branch_tree(t):
460
parent = branch.get_parent()
467
if base.startswith(t.base):
468
relpath = base[len(t.base):].rstrip('/')
471
print "Pulling %s from %s" % (relpath, parent)
473
branch_t = get_transport(parent, possible_transports)
474
pullable.pull(Branch.open_from_transport(branch_t))
480
class cmd_import(BzrToolsCommand):
481
"""Import sources from a directory, tarball or zip file
483
This command will import a directory, tarball or zip file into a bzr
484
tree, replacing any versioned files already present. If a directory is
485
specified, it is used as the target. If the directory does not exist, or
486
is not versioned, it is created.
488
Tarballs may be gzip or bzip2 compressed. This is autodetected.
490
If the tarball or zip has a single root directory, that directory is
491
stripped when extracting the tarball. This is not done for directories.
494
takes_args = ['source', 'tree?']
495
def run(self, source, tree=None):
496
from upstream_import import do_import
497
do_import(source, tree)
500
class cmd_cdiff(BzrToolsCommand):
501
"""A color version of bzr's diff"""
502
takes_args = property(lambda x: get_cmd_object('diff').takes_args)
503
takes_options = list(get_cmd_object('diff').takes_options) + [
504
RegistryOption.from_kwargs('color',
505
'Color mode to use.',
506
title='Color Mode', value_switches=False, enum_switch=True,
507
never='Never colorize output.',
508
auto='Only colorize output if terminal supports it and STDOUT is a'
510
always='Always colorize output (default).'),
511
Option('check-style',
512
help='Warn if trailing whitespace or spurious changes have been'
515
def run(self, color='always', check_style=False, *args, **kwargs):
516
from colordiff import colordiff
517
colordiff(color, check_style, *args, **kwargs)
520
class cmd_conflict_diff(BzrToolsCommand):
522
"""Compare a conflicted file against BASE."""
524
encoding_type = 'exact'
525
takes_args = ['file']
527
RegistryOption.from_kwargs('direction', 'Direction of comparison.',
528
value_switches=True, enum_switch=False,
529
other='Compare OTHER against common base.',
530
this='Compare THIS against common base.')]
532
def run(self, file, direction='other'):
533
from bzrlib.plugins.bzrtools.colordiff import DiffWriter
534
from conflict_diff import conflict_diff
535
dw = DiffWriter(self.outf, check_style=False, color='auto')
536
conflict_diff(dw, file, direction)
539
class cmd_rspush(BzrToolsCommand):
540
"""Upload this branch to another location using rsync.
542
If no location is specified, the last-used location will be used. To
543
prevent dirty trees from being uploaded, rspush will error out if there are
544
unknown files or local changes. It will also error out if the upstream
545
directory is non-empty and not an earlier version of the branch.
547
takes_args = ['location?']
548
takes_options = [Option('overwrite', help='Ignore differences between'
549
' branches and overwrite unconditionally.'),
550
Option('no-tree', help='Do not push the working tree,'
553
def run(self, location=None, overwrite=False, no_tree=False):
554
from bzrlib import workingtree
556
cur_branch = workingtree.WorkingTree.open_containing(".")[0]
557
bzrtools.rspush(cur_branch, location, overwrite=overwrite,
558
working_tree=not no_tree)
561
class cmd_link_tree(BzrToolsCommand):
562
"""Hardlink matching files to another tree.
564
Only files with identical content and execute bit will be linked.
566
takes_args = ['location']
568
def run(self, location):
569
from bzrlib import workingtree
570
from bzrlib.plugins.bzrtools.link_tree import link_tree
571
target_tree = workingtree.WorkingTree.open_containing(".")[0]
572
source_tree = workingtree.WorkingTree.open(location)
573
target_tree.lock_write()
575
source_tree.lock_read()
577
link_tree(target_tree, source_tree)
584
class cmd_create_mirror(BzrToolsCommand):
585
"""Create a mirror of another branch.
587
This is similar to `bzr branch`, but copies more settings, including the
588
submit branch and nickname.
590
It sets the public branch and parent of the target to the source location.
593
takes_args = ['source', 'target']
595
def run(self, source, target):
596
source_branch = Branch.open(source)
597
from bzrlib.plugins.bzrtools.mirror import create_mirror
598
create_mirror(source_branch, target, [])
added
removed
command_classes.py
