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
21
from bzrlib.lazy_import import lazy_import
22
lazy_import(globals(), """
23
from bzrlib import help, urlutils
27
from command import BzrToolsCommand
28
from errors import CommandError
29
from patchsource import BzrPatchSource
33
import bzrlib.builtins
34
import bzrlib.commands
35
from bzrlib.branch import Branch
36
from bzrlib.bzrdir import BzrDir
37
from bzrlib.commands import get_cmd_object
38
from bzrlib.errors import BzrCommandError
40
from bzrlib.trace import note
41
from bzrlib.option import Option, RegistryOption
43
from command import BzrToolsCommand
46
class cmd_clean_tree(BzrToolsCommand):
47
"""Remove unwanted files from working tree.
49
By default, only unknown files, not ignored files, are deleted. Versioned
50
files are never deleted.
52
Another class is 'detritus', which includes files emitted by bzr during
53
normal operations and selftests. (The value of these files decreases with
56
If no options are specified, unknown files are deleted. Otherwise, option
57
flags are respected, and may be combined.
59
To check what clean-tree will do, use --dry-run.
61
takes_options = [Option('ignored', help='Delete all ignored files.'),
62
Option('detritus', help='Delete conflict files, merge'
63
' backups, and failed selftest dirs.'),
65
help='Delete files unknown to bzr (default).'),
66
Option('dry-run', help='Show files to delete instead of'
68
Option('force', help='Do not prompt before deleting.')]
69
def run(self, unknown=False, ignored=False, detritus=False, dry_run=False,
71
from clean_tree import clean_tree
72
if not (unknown or ignored or detritus):
76
clean_tree('.', unknown=unknown, ignored=ignored, detritus=detritus,
77
dry_run=dry_run, no_prompt=force)
80
class cmd_graph_ancestry(BzrToolsCommand):
81
"""Produce ancestry graphs using dot.
83
Output format is detected according to file extension. Some of the more
84
common output formats are html, png, gif, svg, ps. An extension of '.dot'
85
will cause a dot graph file to be produced. HTML output has mouseovers
86
that show the commit message.
88
Branches are labeled r?, where ? is the revno. If they have no revno,
89
with the last 5 characters of their revision identifier are used instead.
91
The value starting with d is "(maximum) distance from the null revision".
93
If --merge-branch is specified, the two branches are compared and a merge
100
orange COMMON history
101
blue COMMON non-history ancestor
102
green Merge base (COMMON ancestor farthest from the null revision)
103
dotted Ghost revision (missing from branch storage)
105
Ancestry is usually collapsed by skipping revisions with a single parent
106
and descendant. The number of skipped revisions is shown on the arrow.
107
This feature can be disabled with --no-collapse.
109
By default, revisions are ordered by distance from root, but they can be
110
clustered instead using --cluster.
112
If available, rsvg is used to antialias PNG and JPEG output, but this can
113
be disabled with --no-antialias.
115
takes_args = ['file', 'merge_branch?']
116
takes_options = [Option('no-collapse', help="Do not skip simple nodes."),
117
Option('no-antialias',
118
help="Do not use rsvg to produce antialiased output."),
119
Option('merge-branch', type=str,
120
help="Use this branch to calcuate a merge base."),
121
Option('cluster', help="Use clustered output."),
122
Option('max-distance',
123
help="Show no nodes farther than this.", type=int),
125
help='Source branch to use (default is current'
130
def run(self, file, merge_branch=None, no_collapse=False,
131
no_antialias=False, cluster=False, max_distance=100,
133
if max_distance == -1:
140
graph.write_ancestry_file(directory, file, not no_collapse,
141
not no_antialias, merge_branch, ranking,
142
max_distance=max_distance)
145
class cmd_fetch_ghosts(BzrToolsCommand):
146
"""Attempt to retrieve ghosts from another branch.
147
If the other branch is not supplied, the last-pulled branch is used.
149
aliases = ['fetch-missing']
150
takes_args = ['branch?']
151
takes_options = [Option('no-fix', help="Skip additional synchonization.")]
152
def run(self, branch=None, no_fix=False):
153
from fetch_ghosts import fetch_ghosts
154
fetch_ghosts(branch, no_fix)
156
strip_help="""Strip the smallest prefix containing num leading slashes from \
157
each file name found in the patch file."""
160
class cmd_patch(BzrToolsCommand):
161
"""Apply a named patch to the current tree.
163
takes_args = ['filename?']
164
takes_options = [Option('strip', type=int, help=strip_help),
165
Option('silent', help='Suppress chatter.')]
166
def run(self, filename=None, strip=None, silent=False):
167
from patch import patch
168
from bzrlib.workingtree import WorkingTree
169
wt = WorkingTree.open_containing('.')[0]
172
return patch(wt, filename, strip, silent)
175
class cmd_shelve1(BzrToolsCommand):
176
"""Temporarily set aside some changes from the current tree.
178
Shelve allows you to temporarily put changes you've made "on the shelf",
179
ie. out of the way, until a later time when you can bring them back from
180
the shelf with the 'unshelve1' command.
182
Shelve is intended to help separate several sets of text changes that have
183
been inappropriately mingled. If you just want to get rid of all changes
184
(text and otherwise) and you don't need to restore them later, use revert.
185
If you want to shelve all text changes at once, use shelve1 --all.
187
By default shelve1 asks you what you want to shelve, press '?' at the
188
prompt to get help. To shelve everything run shelve1 --all.
190
If filenames are specified, only the changes to those files will be
191
shelved, other files will be left untouched.
193
If a revision is specified, changes since that revision will be shelved.
195
You can put multiple items on the shelf. Normally each time you run
196
unshelve1 the most recently shelved changes will be reinstated. However,
197
you can also unshelve changes in a different order by explicitly
198
specifiying which changes to unshelve1. This works best when the changes
199
don't depend on each other.
201
While you have patches on the shelf you can view and manipulate them with
202
the 'shelf1' command. Run 'bzr shelf1 -h' for more info.
205
takes_args = ['file*']
206
takes_options = [Option('message',
207
help='A message to associate with the shelved changes.',
208
short_name='m', type=unicode),
210
Option('all', help='Shelve all changes without prompting.'),
211
Option('no-color', help='Never display changes in color.')]
213
def run(self, all=False, file_list=None, message=None, revision=None,
215
if revision is not None and revision:
216
if len(revision) == 1:
217
revision = revision[0]
219
raise CommandError("shelve only accepts a single revision "
222
source = BzrPatchSource(revision, file_list)
223
s = shelf.Shelf(source.base)
224
s.shelve(source, all, message, no_color)
228
# The following classes are only used as subcommands for 'shelf1', they're
229
# not to be registered directly with bzr.
231
class cmd_shelf_list(bzrlib.commands.Command):
232
"""List the patches on the current shelf."""
233
aliases = ['list', 'ls']
238
class cmd_shelf_delete(bzrlib.commands.Command):
239
"""Delete the patch from the current shelf."""
240
aliases = ['delete', 'del']
241
takes_args = ['patch']
242
def run(self, patch):
243
self.shelf.delete(patch)
246
class cmd_shelf_switch(bzrlib.commands.Command):
247
"""Switch to the other shelf, create it if necessary."""
249
takes_args = ['othershelf']
250
def run(self, othershelf):
251
s = shelf.Shelf(self.shelf.base, othershelf)
255
class cmd_shelf_show(bzrlib.commands.Command):
256
"""Show the contents of the specified or topmost patch."""
257
aliases = ['show', 'cat', 'display']
258
takes_args = ['patch?']
259
def run(self, patch=None):
260
self.shelf.display(patch)
263
class cmd_shelf_upgrade(bzrlib.commands.Command):
264
"""Upgrade old format shelves."""
265
aliases = ['upgrade']
270
class cmd_shelf1(BzrToolsCommand):
271
"""Perform various operations on your shelved patches. See also shelve1."""
272
takes_args = ['subcommand', 'args*']
274
subcommands = [cmd_shelf_list, cmd_shelf_delete, cmd_shelf_switch,
275
cmd_shelf_show, cmd_shelf_upgrade]
277
def run(self, subcommand, args_list):
280
if args_list is None:
282
cmd = self._get_cmd_object(subcommand)
283
source = BzrPatchSource()
284
s = shelf.Shelf(source.base)
287
if args_list is None:
289
return cmd.run_argv_aliases(args_list)
291
def _get_cmd_object(self, cmd_name):
292
for cmd_class in self.subcommands:
293
for alias in cmd_class.aliases:
294
if alias == cmd_name:
296
raise CommandError("Unknown shelf subcommand '%s'" % cmd_name)
299
text = ["%s\n\nSubcommands:\n" % self.__doc__]
301
for cmd_class in self.subcommands:
302
text.extend(self.sub_help(cmd_class) + ['\n'])
306
def sub_help(self, cmd_class):
308
cmd_obj = cmd_class()
311
usage = cmd_obj._usage()
312
usage = usage.replace('bzr shelf-', '')
313
text.append('%s%s\n' % (indent, usage))
315
text.append('%s%s\n' % (2 * indent, cmd_class.__doc__))
317
# Somewhat copied from bzrlib.help.help_on_command_options
319
for option_name, option in sorted(cmd_obj.options().items()):
320
if option_name == 'help':
322
option_help.append('%s--%s' % (3 * indent, option_name))
323
if option.type is not None:
324
option_help.append(' %s' % option.argname.upper())
325
if option.short_name():
326
option_help.append(', -%s' % option.short_name())
327
option_help.append('%s%s\n' % (2 * indent, option.help))
329
if len(option_help) > 0:
330
text.append('%soptions:\n' % (2 * indent))
331
text.extend(option_help)
336
class cmd_unshelve1(BzrToolsCommand):
337
"""Restore shelved changes.
339
By default the most recently shelved changes are restored. However if you
340
specify a patch by name those changes will be restored instead.
342
See 'shelve1' for more information.
345
Option('all', help='Unshelve all changes without prompting.'),
346
Option('force', help='Force unshelving even if errors occur.'),
347
Option('no-color', help='Never display changes in color.')
349
takes_args = ['patch?']
350
def run(self, patch=None, all=False, force=False, no_color=False):
351
source = BzrPatchSource()
352
s = shelf.Shelf(source.base)
353
s.unshelve(source, patch, all, force, no_color)
357
class cmd_shell(BzrToolsCommand):
358
"""Begin an interactive shell tailored for bzr.
359
Bzr commands can be used without typing bzr first, and will be run natively
360
when possible. Tab completion is tailored for bzr. The shell prompt shows
361
the branch nick, revno, and path.
363
If it encounters any moderately complicated shell command, it will punt to
368
bzr bzrtools:287/> status
371
bzr bzrtools:287/> status --[TAB][TAB]
372
--all --help --revision --show-ids
373
bzr bzrtools:287/> status --
377
return shell.run_shell()
380
class cmd_branch_history(BzrToolsCommand):
382
Display the development history of a branch.
384
Each different committer or branch nick is considered a different line of
385
development. Committers are treated as the same if they have the same
386
name, or if they have the same email address.
388
takes_args = ["branch?"]
389
def run(self, branch=None):
390
from branchhistory import branch_history
391
return branch_history(branch)
394
class cmd_zap(BzrToolsCommand):
396
Remove a lightweight checkout, if it can be done safely.
398
This command will remove a lightweight checkout without losing data. That
399
means it only removes lightweight checkouts, and only if they have no
402
If --branch is specified, the branch will be deleted too, but only if the
403
the branch has no new commits (relative to its parent).
405
takes_options = [Option("branch", help="Remove associated branch from"
407
Option('force', help='Delete tree even if contents are'
409
takes_args = ["checkout"]
410
def run(self, checkout, branch=False, force=False):
412
return zap(checkout, remove_branch=branch, allow_modified=force)
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_rspush(BzrToolsCommand):
552
"""Upload this branch to another location using rsync.
554
If no location is specified, the last-used location will be used. To
555
prevent dirty trees from being uploaded, rspush will error out if there are
556
unknown files or local changes. It will also error out if the upstream
557
directory is non-empty and not an earlier version of the branch.
559
takes_args = ['location?']
560
takes_options = [Option('overwrite', help='Ignore differences between'
561
' branches and overwrite unconditionally.'),
562
Option('no-tree', help='Do not push the working tree,'
565
def run(self, location=None, overwrite=False, no_tree=False):
566
from bzrlib import workingtree
568
cur_branch = workingtree.WorkingTree.open_containing(".")[0]
569
bzrtools.rspush(cur_branch, location, overwrite=overwrite,
570
working_tree=not no_tree)
573
class cmd_link_tree(BzrToolsCommand):
574
"""Hardlink matching files to another tree.
576
Only files with identical content and execute bit will be linked.
578
takes_args = ['location']
580
def run(self, location):
581
from bzrlib import workingtree
582
from bzrlib.plugins.bzrtools.link_tree import link_tree
583
target_tree = workingtree.WorkingTree.open_containing(".")[0]
584
source_tree = workingtree.WorkingTree.open(location)
585
target_tree.lock_write()
587
source_tree.lock_read()
589
link_tree(target_tree, source_tree)
added
removed
command_classes.py
