2
"""Shelf - temporarily set aside changes, then bring them back."""
3
Various useful plugins for working with bzr.
4
5
import bzrlib.commands
8
from shelf import Shelf
11
from bzrlib.option import Option
5
12
import bzrlib.branch
6
13
from bzrlib.errors import BzrCommandError
7
from bzrlib.option import Option
8
from shelf import Shelf
14
sys.path.append(os.path.dirname(__file__))
15
from reweave_inventory import cmd_fix
17
Option.OPTIONS['ignored'] = Option('ignored',
18
help='delete all ignored files.')
19
Option.OPTIONS['detritus'] = Option('detritus',
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', 'detritus', 'dry-run']
30
def run(self, ignored=False, detritus=False, dry_run=False):
31
from clean_tree import clean_tree
32
clean_tree('.', ignored=ignored, detritus=detritus, 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):
40
"""Produce ancestry graphs using dot.
42
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.
46
Branches are labeled r?, where ? is the revno. If they have no revno,
47
with the last 5 characters of their revision identifier are used instead.
49
If --merge-branch is specified, the two branches are compared and a merge
57
blue COMMON non-history ancestor
58
dotted Missing from branch storage
60
Ancestry is usually collapsed by removing revisions with a single parent
61
and descendant. The number of skipped revisions is shown on the arrow.
62
This feature can be disabled with --no-collapse.
64
By default, revisions are ordered by distance from root, but they can be
65
clustered instead using --cluster.
67
If available, rsvg is used to antialias PNG and JPEG output, but this can
68
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):
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):
83
"""Attempt to retrieve ghosts from another branch.
84
If the other branch is not supplied, the last-pulled branch is used.
86
aliases = ['fetch-missing']
87
takes_args = ['branch?']
88
takes_options = [Option('no-fix')]
89
def run(self, branch=None, no_fix=False):
90
from fetch_ghosts import fetch_ghosts
91
fetch_ghosts(branch, no_fix)
93
strip_help="""Strip the smallest prefix containing num leading slashes from \
94
each file name found in the patch file."""
95
Option.OPTIONS['strip'] = Option('strip', type=int, help=strip_help)
96
class cmd_patch(bzrlib.commands.Command):
97
"""Apply a named patch to the current tree.
99
takes_args = ['filename?']
100
takes_options = ['strip']
101
def run(self, filename=None, strip=0):
102
from patch import patch
103
from bzrlib.branch import Branch
104
b = Branch.open_containing('.')[0]
105
return patch(b, filename, strip)
10
108
class cmd_shelve(bzrlib.commands.Command):
11
"""Temporarily set aside some changes to the current working tree.
13
Shelve allows you to temporarily put changes you've made "on the shelf",
14
ie. out of the way, until a later time when you can bring them back from
15
the shelf with the 'unshelve' command.
17
You can put multiple items on the shelf, each time you run unshelve the
18
most recently shelved changes will be reinstated.
20
If filenames are specified, only the changes to those files will be
21
shelved, other files will be left untouched.
23
If a revision is specified, changes since that revision will be shelved.
25
If you specifiy "--pick" you'll be prompted for each hunk of the diff as
26
to whether you want to shelve it or not. Press "?" at the prompt for help.
109
"""Temporarily remove some changes from the current tree.
110
Use 'unshelve' to restore these changes.
112
If filenames are specified, only changes to those files will be unshelved.
113
If a revision is specified, all changes since that revision will may be
28
116
takes_args = ['file*']
29
takes_options = [Option('pick'), 'message', 'revision']
30
def run(self, pick=False, file_list=None, message=None, revision=None):
117
takes_options = ['all', 'message', 'revision']
118
def run(self, all=False, file_list=None, message=None, revision=None):
31
119
if file_list is not None and len(file_list) > 0:
32
120
branchdir = file_list[0]
43
131
s = Shelf(branchdir)
44
return s.shelve(pick, message, revision, file_list)
132
return s.shelve(all, message, revision, file_list)
46
135
class cmd_unshelve(bzrlib.commands.Command):
47
"""Reinstate the most recently shelved changes.
48
See 'shelve' for more information.
136
"""Restore previously-shelved changes to the current tree.
50
takes_options = [Option('pick')]
51
def run(self, pick=False):
53
return s.unshelve(pick)
55
bzrlib.commands.register_command(cmd_shelve)
56
bzrlib.commands.register_command(cmd_unshelve)
143
class cmd_shell(bzrlib.commands.Command):
146
return shell.run_shell()
148
commands = [cmd_shelve, cmd_unshelve, cmd_clean_tree, cmd_graph_ancestry,
149
cmd_fetch_ghosts, cmd_patch, cmd_shell, cmd_fix]
151
command_decorators = []
153
import bzrlib.builtins
154
if not hasattr(bzrlib.builtins, "cmd_annotate"):
155
commands.append(annotate.cmd_annotate)
156
if not hasattr(bzrlib.builtins, "cmd_push"):
157
commands.append(push.cmd_push)
159
command_decorators.append(push.cmd_push)
161
from errors import NoPyBaz
164
commands.append(baz_import.cmd_baz_import)
167
class cmd_baz_import(bzrlib.commands.Command):
168
"""Disabled. (Requires PyBaz)"""
169
takes_args = ['to_root_dir?', 'from_archive?']
170
takes_options = ['verbose']
171
def run(self, to_root_dir=None, from_archive=None, verbose=False):
172
print "This command is disabled. Please install PyBaz."
173
commands.append(cmd_baz_import)
176
if hasattr(bzrlib.commands, 'register_command'):
177
for command in commands:
178
bzrlib.commands.register_command(command)
179
for command in command_decorators:
180
command._original_command = bzrlib.commands.register_command(
59
from bzrlib.tests.TestUtil import TestLoader
61
return TestLoader().loadTestsFromModule(tests)
185
from doctest import DocTestSuite
186
from unittest import TestSuite, TestLoader
191
result.addTest(DocTestSuite(bzrtools))
192
result.addTest(clean_tree.test_suite())
193
result.addTest(TestLoader().loadTestsFromModule(shelf_tests))
194
result.addTest(blackbox.test_suite())