« back to all changes in this revision
Viewing changes to bzrlib/builtins.py
- browse files at revision 1724.2.14
- compare with another revision
- download diff
- download tarball
- view history from revision 1724.2.14
- Committer: John Arbash Meinel
- Date: 2006-06-19 14:40:19 UTC
- mto: This revision was merged to the branch mainline in revision 1794.
- Revision ID: john@arbash-meinel.com-20060619144019-873a4a8d252f7896
Refactor import stuff into separate functions. Update news
- files added:
- NEWS.developers
- bzrlib/bundle/old
- bzrlib/tests/interversionedfile_implementations
- bzrlib/tests/revisionstore_implementations
- bzrlib/util/configobj/docs
- bzrlib/util/urlgrabber
- files removed:
- .testr.conf
- apport
- bzrlib/benchmarks/tree_creator
- bzrlib/filters
- bzrlib/help_topics
- bzrlib/help_topics/en
- bzrlib/help_topics/es
- bzrlib/plugins/netrc_credential_store
- bzrlib/plugins/netrc_credential_store/tests
- bzrlib/plugins/news_merge
- bzrlib/plugins/news_merge/tests
- bzrlib/repofmt
- bzrlib/smart
- bzrlib/tests/commands
- bzrlib/tests/ftp_server
- bzrlib/tests/per_bzrdir_colo
- bzrlib/tests/per_foreign_vcs
- bzrlib/tests/per_interbranch
- bzrlib/tests/per_intertree
- bzrlib/tests/per_inventory
- bzrlib/tests/per_lock
- bzrlib/tests/per_repository_chk
- bzrlib/tests/per_repository_reference
- bzrlib/tests/per_tree
- bzrlib/tests/per_uifactory
- bzrlib/tests/ssl_certs
- bzrlib/transport/ftp
- bzrlib/util/tests
- bzrlib/version_info_formats
- contrib/debian
- doc/developers
- doc/developers/_static
- doc/developers/_templates
- doc/en
- doc/en/_static
- doc/en/_static/en
- doc/en/_templates
- doc/en/admin-guide
- doc/en/mini-tutorial
- doc/en/quick-reference
- doc/en/release-notes
- doc/en/tutorials
- doc/en/upgrade-guide
- doc/en/user-guide
- doc/en/user-guide/images
- doc/en/user-reference
- doc/en/whats-new
- doc/es
- doc/es/_static
- doc/es/_static/es
- doc/es/_templates
- doc/es/mini-tutorial
- doc/es/quick-reference
- doc/es/user-guide
- doc/ja
- doc/ja/_static
- doc/ja/_templates
- doc/ja/mini-tutorial
- doc/ja/tutorials
- doc/ja/upgrade-guide
- doc/ja/user-guide
- doc/ja/user-guide/images
- doc/ja/user-reference
- doc/ru
- doc/ru/_static
- doc/ru/_static/ru
- doc/ru/_templates
- doc/ru/mini-tutorial
- doc/ru/quick-reference
- doc/ru/tutorials
- doc/ru/user-guide
- doc/ru/user-guide/images
- man1
- tools/packaging
- tools/win32
- tools/win32/buildout-templates
- tools/win32/buildout-templates/bin
- files renamed:
- doc/developers/HACKING.txt => HACKING
- bzrlib/bundle/bundle_data.py => bzrlib/bundle/read_bundle.py
- bzrlib/bundle/serializer/v08.py => bzrlib/bundle/serializer/v07.py
- bzrlib/deprecated_graph.py => bzrlib/graph.py
- bzrlib/_patiencediff_py.py => bzrlib/patiencediff.py
- bzrlib/tests/http_utils.py => bzrlib/tests/HTTPTestUtil.py
- bzrlib/tests/per_branch/ => bzrlib/tests/branch_implementations/
- bzrlib/tests/per_bzrdir/ => bzrlib/tests/bzrdir_implementations/
- bzrlib/tests/per_interrepository/ => bzrlib/tests/interrepository_implementations/
- bzrlib/tests/per_repository/ => bzrlib/tests/repository_implementations/
- bzrlib/tests/test_commands.py => bzrlib/tests/test_command.py
- bzrlib/tests/test_deprecated_graph.py => bzrlib/tests/test_graph.py
- bzrlib/tests/test_revisionspec.py => bzrlib/tests/test_revisionnamespaces.py
- bzrlib/tests/per_repository/test_revision.py => bzrlib/tests/test_revprops.py
- bzrlib/tests/per_transport.py => bzrlib/tests/test_transport_implementations.py
- bzrlib/tests/per_versionedfile.py => bzrlib/tests/test_versionedfile.py
- bzrlib/tests/per_workingtree/ => bzrlib/tests/workingtree_implementations/
- bzrlib/transport/ftp/__init__.py => bzrlib/transport/ftp.py
- bzrlib/win32utils.py => bzrlib/win32console.py
- bzrlib/xml8.py => bzrlib/xml5.py
- bzrlib/help_topics/en/configuration.txt => doc/configuration.txt
- doc/en/user-guide/plugins.txt => doc/plugins.txt
- doc/en/user-guide/setting_up_email.txt => doc/setting_up_email.txt
- doc/en/user-guide/specifying_revisions.txt => doc/specifying_revisions.txt
- doc/en/tutorials/tutorial.txt => doc/tutorial.txt
- doc/en/user-guide/using_aliases.txt => doc/using_aliases.txt
- tools/generate_docs.py => generate_docs.py
- bzrlib/doc_generate/ => tools/doc_generate/
- files modified:
- .bzrignore
added
removed
bzrlib/builtins.py
1
# Copyright (C) 2005-2010 Canonical Ltd
2
#
1
# Copyright (C) 2004, 2005, 2006 by Canonical Ltd
2
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
5
5
# the Free Software Foundation; either version 2 of the License, or
6
6
# (at your option) any later version.
7
#
7
8
8
# This program is distributed in the hope that it will be useful,
9
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
11
# GNU General Public License for more details.
12
#
12
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
16
16
17
17
"""builtin bzr commands"""
18
18
19
20
import codecs
21
import errno
19
22
import os
20
21
from bzrlib.lazy_import import lazy_import
22
lazy_import(globals(), """
23
import codecs
24
import cStringIO
23
from shutil import rmtree
25
24
import sys
26
import time
27
25
28
26
import bzrlib
29
from bzrlib import (
30
bugtracker,
31
bundle,
32
btree_index,
33
bzrdir,
34
directory_service,
35
delta,
36
config,
37
errors,
38
globbing,
39
hooks,
40
log,
41
merge as _mod_merge,
42
merge_directive,
43
osutils,
44
reconfigure,
45
rename_map,
46
revision as _mod_revision,
47
static_tuple,
48
symbol_versioning,
49
timestamp,
50
transport,
51
ui,
52
urlutils,
53
views,
54
)
27
import bzrlib.branch
55
28
from bzrlib.branch import Branch
56
from bzrlib.conflicts import ConflictList
57
from bzrlib.transport import memory
58
from bzrlib.revisionspec import RevisionSpec, RevisionInfo
59
from bzrlib.smtp_connection import SMTPConnection
29
import bzrlib.bzrdir as bzrdir
30
from bzrlib.bundle import read_bundle_from_url
31
from bzrlib.bundle.read_bundle import BundleReader
32
from bzrlib.bundle.apply_bundle import install_bundle, merge_bundle
33
from bzrlib.commands import Command, display_command
34
import bzrlib.errors as errors
35
from bzrlib.errors import (BzrError, BzrCheckError, BzrCommandError,
36
NotBranchError, DivergedBranches, NotConflicted,
37
NoSuchFile, NoWorkingTree, FileInWrongBranch,
38
NotVersionedError, NotABundle)
39
from bzrlib.log import show_one_log
40
from bzrlib.merge import Merge3Merger
41
from bzrlib.option import Option
42
import bzrlib.osutils
43
from bzrlib.progress import DummyProgress, ProgressPhase
44
from bzrlib.revision import common_ancestor
45
from bzrlib.revisionspec import RevisionSpec
46
import bzrlib.trace
47
from bzrlib.trace import mutter, note, log_error, warning, is_quiet
48
from bzrlib.transport.local import LocalTransport
49
import bzrlib.ui
50
import bzrlib.urlutils as urlutils
60
51
from bzrlib.workingtree import WorkingTree
61
""")
62
63
from bzrlib.commands import (
64
Command,
65
builtin_command_registry,
66
display_command,
67
)
68
from bzrlib.option import (
69
ListOption,
70
Option,
71
RegistryOption,
72
custom_help,
73
_parse_revision_str,
74
)
75
from bzrlib.trace import mutter, note, warning, is_quiet, get_verbosity_level
76
77
78
def tree_files(file_list, default_branch=u'.', canonicalize=True,
79
apply_view=True):
52
53
54
def tree_files(file_list, default_branch=u'.'):
80
55
try:
81
return internal_tree_files(file_list, default_branch, canonicalize,
82
apply_view)
83
except errors.FileInWrongBranch, e:
84
raise errors.BzrCommandError("%s is not in the same branch as %s" %
85
(e.path, file_list[0]))
86
87
88
def tree_files_for_add(file_list):
89
"""
90
Return a tree and list of absolute paths from a file list.
91
92
Similar to tree_files, but add handles files a bit differently, so it a
93
custom implementation. In particular, MutableTreeTree.smart_add expects
94
absolute paths, which it immediately converts to relative paths.
95
"""
96
# FIXME Would be nice to just return the relative paths like
97
# internal_tree_files does, but there are a large number of unit tests
98
# that assume the current interface to mutabletree.smart_add
99
if file_list:
100
tree, relpath = WorkingTree.open_containing(file_list[0])
101
if tree.supports_views():
102
view_files = tree.views.lookup_view()
103
if view_files:
104
for filename in file_list:
105
if not osutils.is_inside_any(view_files, filename):
106
raise errors.FileOutsideView(filename, view_files)
107
file_list = file_list[:]
108
file_list[0] = tree.abspath(relpath)
109
else:
110
tree = WorkingTree.open_containing(u'.')[0]
111
if tree.supports_views():
112
view_files = tree.views.lookup_view()
113
if view_files:
114
file_list = view_files
115
view_str = views.view_display_str(view_files)
116
note("Ignoring files outside view. View is %s" % view_str)
117
return tree, file_list
118
119
120
def _get_one_revision(command_name, revisions):
121
if revisions is None:
122
return None
123
if len(revisions) != 1:
124
raise errors.BzrCommandError(
125
'bzr %s --revision takes exactly one revision identifier' % (
126
command_name,))
127
return revisions[0]
128
129
130
def _get_one_revision_tree(command_name, revisions, branch=None, tree=None):
131
"""Get a revision tree. Not suitable for commands that change the tree.
132
133
Specifically, the basis tree in dirstate trees is coupled to the dirstate
134
and doing a commit/uncommit/pull will at best fail due to changing the
135
basis revision data.
136
137
If tree is passed in, it should be already locked, for lifetime management
138
of the trees internal cached state.
139
"""
140
if branch is None:
141
branch = tree.branch
142
if revisions is None:
143
if tree is not None:
144
rev_tree = tree.basis_tree()
145
else:
146
rev_tree = branch.basis_tree()
147
else:
148
revision = _get_one_revision(command_name, revisions)
149
rev_tree = revision.as_tree(branch)
150
return rev_tree
56
return internal_tree_files(file_list, default_branch)
57
except FileInWrongBranch, e:
58
raise BzrCommandError("%s is not in the same branch as %s" %
59
(e.path, file_list[0]))
151
60
152
61
153
62
# XXX: Bad function name; should possibly also be a class method of
154
63
# WorkingTree rather than a function.
155
def internal_tree_files(file_list, default_branch=u'.', canonicalize=True,
156
apply_view=True):
64
def internal_tree_files(file_list, default_branch=u'.'):
157
65
"""Convert command-line paths to a WorkingTree and relative paths.
158
66
159
67
This is typically used for command-line processors that take one or
161
69
162
70
The filenames given are not required to exist.
163
71
164
:param file_list: Filenames to convert.
165
166
:param default_branch: Fallback tree path to use if file_list is empty or
167
None.
168
169
:param apply_view: if True and a view is set, apply it or check that
170
specified files are within it
72
:param file_list: Filenames to convert.
73
74
:param default_branch: Fallback tree path to use if file_list is empty or None.
171
75
172
76
:return: workingtree, [relative_paths]
173
77
"""
174
78
if file_list is None or len(file_list) == 0:
175
tree = WorkingTree.open_containing(default_branch)[0]
176
if tree.supports_views() and apply_view:
177
view_files = tree.views.lookup_view()
178
if view_files:
179
file_list = view_files
180
view_str = views.view_display_str(view_files)
181
note("Ignoring files outside view. View is %s" % view_str)
182
return tree, file_list
183
tree = WorkingTree.open_containing(osutils.realpath(file_list[0]))[0]
184
return tree, safe_relpath_files(tree, file_list, canonicalize,
185
apply_view=apply_view)
186
187
188
def safe_relpath_files(tree, file_list, canonicalize=True, apply_view=True):
189
"""Convert file_list into a list of relpaths in tree.
190
191
:param tree: A tree to operate on.
192
:param file_list: A list of user provided paths or None.
193
:param apply_view: if True and a view is set, apply it or check that
194
specified files are within it
195
:return: A list of relative paths.
196
:raises errors.PathNotChild: When a provided path is in a different tree
197
than tree.
198
"""
199
if file_list is None:
200
return None
201
if tree.supports_views() and apply_view:
202
view_files = tree.views.lookup_view()
203
else:
204
view_files = []
79
return WorkingTree.open_containing(default_branch)[0], file_list
80
tree = WorkingTree.open_containing(file_list[0])[0]
205
81
new_list = []
206
# tree.relpath exists as a "thunk" to osutils, but canonical_relpath
207
# doesn't - fix that up here before we enter the loop.
208
if canonicalize:
209
fixer = lambda p: osutils.canonical_relpath(tree.basedir, p)
210
else:
211
fixer = tree.relpath
212
82
for filename in file_list:
213
83
try:
214
relpath = fixer(osutils.dereference_path(filename))
215
if view_files and not osutils.is_inside_any(view_files, relpath):
216
raise errors.FileOutsideView(filename, view_files)
217
new_list.append(relpath)
84
new_list.append(tree.relpath(filename))
218
85
except errors.PathNotChild:
219
raise errors.FileInWrongBranch(tree.branch, filename)
220
return new_list
221
222
223
def _get_view_info_for_change_reporter(tree):
224
"""Get the view information from a tree for change reporting."""
225
view_info = None
226
try:
227
current_view = tree.views.get_view_info()[0]
228
if current_view is not None:
229
view_info = (current_view, tree.views.lookup_view())
230
except errors.ViewsNotSupported:
231
pass
232
return view_info
86
raise FileInWrongBranch(tree.branch, filename)
87
return tree, new_list
88
89
90
def get_format_type(typestring):
91
"""Parse and return a format specifier."""
92
if typestring == "weave":
93
return bzrdir.BzrDirFormat6()
94
if typestring == "default":
95
return bzrdir.BzrDirMetaFormat1()
96
if typestring == "metaweave":
97
format = bzrdir.BzrDirMetaFormat1()
98
format.repository_format = bzrlib.repository.RepositoryFormat7()
99
return format
100
if typestring == "knit":
101
format = bzrdir.BzrDirMetaFormat1()
102
format.repository_format = bzrlib.repository.RepositoryFormatKnit1()
103
return format
104
msg = "Unknown bzr format %s. Current formats are: default, knit,\n" \
105
"metaweave and weave" % typestring
106
raise BzrCommandError(msg)
233
107
234
108
235
109
# TODO: Make sure no commands unconditionally use the working directory as a
239
113
# opens the branch?)
240
114
241
115
class cmd_status(Command):
242
__doc__ = """Display status summary.
116
"""Display status summary.
243
117
244
118
This reports on versioned and unknown files, reporting them
245
119
grouped by state. Possible states are:
259
133
modified
260
134
Text has changed since the previous revision.
261
135
262
kind changed
263
File kind has been changed (e.g. from file to directory).
264
265
136
unknown
266
137
Not versioned and not matching an ignore pattern.
267
138
268
Additionally for directories, symlinks and files with an executable
269
bit, Bazaar indicates their type using a trailing character: '/', '@'
270
or '*' respectively.
271
272
To see ignored files use 'bzr ignored'. For details on the
139
To see ignored files use 'bzr ignored'. For details in the
273
140
changes to file texts, use 'bzr diff'.
274
141
275
Note that --short or -S gives status flags for each item, similar
276
to Subversion's status command. To get output similar to svn -q,
277
use bzr status -SV.
278
279
142
If no arguments are specified, the status of the entire working
280
143
directory is shown. Otherwise, only the status of the specified
281
144
files or directories is reported. If a directory is given, status
282
145
is reported for everything inside that directory.
283
146
284
Before merges are committed, the pending merge tip revisions are
285
shown. To see all pending merge revisions, use the -v option.
286
To skip the display of pending merge information altogether, use
287
the no-pending option or specify a file/directory.
288
289
147
If a revision argument is given, the status is calculated against
290
148
that revision, or between two revisions if two are provided.
291
149
"""
292
150
293
151
# TODO: --no-recurse, --recurse options
294
152
295
153
takes_args = ['file*']
296
takes_options = ['show-ids', 'revision', 'change', 'verbose',
297
Option('short', help='Use short status indicators.',
298
short_name='S'),
299
Option('versioned', help='Only show versioned files.',
300
short_name='V'),
301
Option('no-pending', help='Don\'t show pending merges.',
302
),
303
]
154
takes_options = ['show-ids', 'revision']
304
155
aliases = ['st', 'stat']
305
156
306
157
encoding_type = 'replace'
307
_see_also = ['diff', 'revert', 'status-flags']
308
158
309
159
@display_command
310
def run(self, show_ids=False, file_list=None, revision=None, short=False,
311
versioned=False, no_pending=False, verbose=False):
160
def run(self, show_ids=False, file_list=None, revision=None):
312
161
from bzrlib.status import show_tree_status
313
162
314
if revision and len(revision) > 2:
315
raise errors.BzrCommandError('bzr status --revision takes exactly'
316
' one or two revision specifiers')
317
318
tree, relfile_list = tree_files(file_list)
319
# Avoid asking for specific files when that is not needed.
320
if relfile_list == ['']:
321
relfile_list = None
322
# Don't disable pending merges for full trees other than '.'.
323
if file_list == ['.']:
324
no_pending = True
325
# A specific path within a tree was given.
326
elif relfile_list is not None:
327
no_pending = True
163
tree, file_list = tree_files(file_list)
164
328
165
show_tree_status(tree, show_ids=show_ids,
329
specific_files=relfile_list, revision=revision,
330
to_file=self.outf, short=short, versioned=versioned,
331
show_pending=(not no_pending), verbose=verbose)
166
specific_files=file_list, revision=revision,
167
to_file=self.outf)
332
168
333
169
334
170
class cmd_cat_revision(Command):
335
__doc__ = """Write out metadata for a revision.
336
171
"""Write out metadata for a revision.
172
337
173
The revision to print can either be specified by a specific
338
174
revision identifier, or you can use --revision.
339
175
"""
343
179
takes_options = ['revision']
344
180
# cat-revision is more for frontends so should be exact
345
181
encoding = 'strict'
346
347
def print_revision(self, revisions, revid):
348
stream = revisions.get_record_stream([(revid,)], 'unordered', True)
349
record = stream.next()
350
if record.storage_kind == 'absent':
351
raise errors.NoSuchRevision(revisions, revid)
352
revtext = record.get_bytes_as('fulltext')
353
self.outf.write(revtext.decode('utf-8'))
354
182
355
183
@display_command
356
184
def run(self, revision_id=None, revision=None):
185
357
186
if revision_id is not None and revision is not None:
358
raise errors.BzrCommandError('You can only supply one of'
359
' revision_id or --revision')
187
raise BzrCommandError('You can only supply one of revision_id or --revision')
360
188
if revision_id is None and revision is None:
361
raise errors.BzrCommandError('You must supply either'
362
' --revision or a revision_id')
189
raise BzrCommandError('You must supply either --revision or a revision_id')
363
190
b = WorkingTree.open_containing(u'.')[0].branch
364
191
365
revisions = b.repository.revisions
366
if revisions is None:
367
raise errors.BzrCommandError('Repository %r does not support '
368
'access to raw revision texts')
369
370
b.repository.lock_read()
371
try:
372
# TODO: jam 20060112 should cat-revision always output utf-8?
373
if revision_id is not None:
374
revision_id = osutils.safe_revision_id(revision_id, warn=False)
375
try:
376
self.print_revision(revisions, revision_id)
377
except errors.NoSuchRevision:
378
msg = "The repository %s contains no revision %s." % (
379
b.repository.base, revision_id)
380
raise errors.BzrCommandError(msg)
381
elif revision is not None:
382
for rev in revision:
383
if rev is None:
384
raise errors.BzrCommandError(
385
'You cannot specify a NULL revision.')
386
rev_id = rev.as_revision_id(b)
387
self.print_revision(revisions, rev_id)
388
finally:
389
b.repository.unlock()
390
391
392
class cmd_dump_btree(Command):
393
__doc__ = """Dump the contents of a btree index file to stdout.
394
395
PATH is a btree index file, it can be any URL. This includes things like
396
.bzr/repository/pack-names, or .bzr/repository/indices/a34b3a...ca4a4.iix
397
398
By default, the tuples stored in the index file will be displayed. With
399
--raw, we will uncompress the pages, but otherwise display the raw bytes
400
stored in the index.
401
"""
402
403
# TODO: Do we want to dump the internal nodes as well?
404
# TODO: It would be nice to be able to dump the un-parsed information,
405
# rather than only going through iter_all_entries. However, this is
406
# good enough for a start
407
hidden = True
408
encoding_type = 'exact'
409
takes_args = ['path']
410
takes_options = [Option('raw', help='Write the uncompressed bytes out,'
411
' rather than the parsed tuples.'),
412
]
413
414
def run(self, path, raw=False):
415
dirname, basename = osutils.split(path)
416
t = transport.get_transport(dirname)
417
if raw:
418
self._dump_raw_bytes(t, basename)
419
else:
420
self._dump_entries(t, basename)
421
422
def _get_index_and_bytes(self, trans, basename):
423
"""Create a BTreeGraphIndex and raw bytes."""
424
bt = btree_index.BTreeGraphIndex(trans, basename, None)
425
bytes = trans.get_bytes(basename)
426
bt._file = cStringIO.StringIO(bytes)
427
bt._size = len(bytes)
428
return bt, bytes
429
430
def _dump_raw_bytes(self, trans, basename):
431
import zlib
432
433
# We need to parse at least the root node.
434
# This is because the first page of every row starts with an
435
# uncompressed header.
436
bt, bytes = self._get_index_and_bytes(trans, basename)
437
for page_idx, page_start in enumerate(xrange(0, len(bytes),
438
btree_index._PAGE_SIZE)):
439
page_end = min(page_start + btree_index._PAGE_SIZE, len(bytes))
440
page_bytes = bytes[page_start:page_end]
441
if page_idx == 0:
442
self.outf.write('Root node:\n')
443
header_end, data = bt._parse_header_from_bytes(page_bytes)
444
self.outf.write(page_bytes[:header_end])
445
page_bytes = data
446
self.outf.write('\nPage %d\n' % (page_idx,))
447
decomp_bytes = zlib.decompress(page_bytes)
448
self.outf.write(decomp_bytes)
449
self.outf.write('\n')
450
451
def _dump_entries(self, trans, basename):
452
try:
453
st = trans.stat(basename)
454
except errors.TransportNotPossible:
455
# We can't stat, so we'll fake it because we have to do the 'get()'
456
# anyway.
457
bt, _ = self._get_index_and_bytes(trans, basename)
458
else:
459
bt = btree_index.BTreeGraphIndex(trans, basename, st.st_size)
460
for node in bt.iter_all_entries():
461
# Node is made up of:
462
# (index, key, value, [references])
463
try:
464
refs = node[3]
465
except IndexError:
466
refs_as_tuples = None
467
else:
468
refs_as_tuples = static_tuple.as_tuples(refs)
469
as_tuple = (tuple(node[1]), node[2], refs_as_tuples)
470
self.outf.write('%s\n' % (as_tuple,))
471
472
473
class cmd_remove_tree(Command):
474
__doc__ = """Remove the working tree from a given branch/checkout.
475
476
Since a lightweight checkout is little more than a working tree
477
this will refuse to run against one.
478
479
To re-create the working tree, use "bzr checkout".
480
"""
481
_see_also = ['checkout', 'working-trees']
482
takes_args = ['location*']
483
takes_options = [
484
Option('force',
485
help='Remove the working tree even if it has '
486
'uncommitted changes.'),
487
]
488
489
def run(self, location_list, force=False):
490
if not location_list:
491
location_list=['.']
492
493
for location in location_list:
494
d = bzrdir.BzrDir.open(location)
495
496
try:
497
working = d.open_workingtree()
498
except errors.NoWorkingTree:
499
raise errors.BzrCommandError("No working tree to remove")
500
except errors.NotLocalUrl:
501
raise errors.BzrCommandError("You cannot remove the working tree"
502
" of a remote path")
503
if not force:
504
if (working.has_changes()):
505
raise errors.UncommittedChanges(working)
506
507
if working.user_url != working.branch.user_url:
508
raise errors.BzrCommandError("You cannot remove the working tree"
509
" from a lightweight checkout")
510
511
d.destroy_workingtree()
512
192
# TODO: jam 20060112 should cat-revision always output utf-8?
193
if revision_id is not None:
194
self.outf.write(b.repository.get_revision_xml(revision_id).decode('utf-8'))
195
elif revision is not None:
196
for rev in revision:
197
if rev is None:
198
raise BzrCommandError('You cannot specify a NULL revision.')
199
revno, rev_id = rev.in_history(b)
200
self.outf.write(b.repository.get_revision_xml(rev_id).decode('utf-8'))
201
513
202
514
203
class cmd_revno(Command):
515
__doc__ = """Show current revision number.
204
"""Show current revision number.
516
205
517
206
This is equal to the number of revisions on this branch.
518
207
"""
519
208
520
_see_also = ['info']
521
209
takes_args = ['location?']
522
takes_options = [
523
Option('tree', help='Show revno of working tree'),
524
]
525
210
526
211
@display_command
527
def run(self, tree=False, location=u'.'):
528
if tree:
529
try:
530
wt = WorkingTree.open_containing(location)[0]
531
self.add_cleanup(wt.lock_read().unlock)
532
except (errors.NoWorkingTree, errors.NotLocalUrl):
533
raise errors.NoWorkingTree(location)
534
revid = wt.last_revision()
535
try:
536
revno_t = wt.branch.revision_id_to_dotted_revno(revid)
537
except errors.NoSuchRevision:
538
revno_t = ('???',)
539
revno = ".".join(str(n) for n in revno_t)
540
else:
541
b = Branch.open_containing(location)[0]
542
self.add_cleanup(b.lock_read().unlock)
543
revno = b.revno()
544
self.cleanup_now()
545
self.outf.write(str(revno) + '\n')
212
def run(self, location=u'.'):
213
self.outf.write(str(Branch.open_containing(location)[0].revno()))
214
self.outf.write('\n')
546
215
547
216
548
217
class cmd_revision_info(Command):
549
__doc__ = """Show revision number and revision id for a given revision identifier.
218
"""Show revision number and revision id for a given revision identifier.
550
219
"""
551
220
hidden = True
552
221
takes_args = ['revision_info*']
553
takes_options = [
554
'revision',
555
Option('directory',
556
help='Branch to examine, '
557
'rather than the one containing the working directory.',
558
short_name='d',
559
type=unicode,
560
),
561
Option('tree', help='Show revno of working tree'),
562
]
222
takes_options = ['revision']
563
223
564
224
@display_command
565
def run(self, revision=None, directory=u'.', tree=False,
566
revision_info_list=[]):
225
def run(self, revision=None, revision_info_list=[]):
567
226
568
try:
569
wt = WorkingTree.open_containing(directory)[0]
570
b = wt.branch
571
self.add_cleanup(wt.lock_read().unlock)
572
except (errors.NoWorkingTree, errors.NotLocalUrl):
573
wt = None
574
b = Branch.open_containing(directory)[0]
575
self.add_cleanup(b.lock_read().unlock)
576
revision_ids = []
227
revs = []
577
228
if revision is not None:
578
revision_ids.extend(rev.as_revision_id(b) for rev in revision)
229
revs.extend(revision)
579
230
if revision_info_list is not None:
580
for rev_str in revision_info_list:
581
rev_spec = RevisionSpec.from_string(rev_str)
582
revision_ids.append(rev_spec.as_revision_id(b))
583
# No arguments supplied, default to the last revision
584
if len(revision_ids) == 0:
585
if tree:
586
if wt is None:
587
raise errors.NoWorkingTree(directory)
588
revision_ids.append(wt.last_revision())
231
for rev in revision_info_list:
232
revs.append(RevisionSpec(rev))
233
if len(revs) == 0:
234
raise BzrCommandError('You must supply a revision identifier')
235
236
b = WorkingTree.open_containing(u'.')[0].branch
237
238
for rev in revs:
239
revinfo = rev.in_history(b)
240
if revinfo.revno is None:
241
print ' %s' % revinfo.rev_id
589
242
else:
590
revision_ids.append(b.last_revision())
591
592
revinfos = []
593
maxlen = 0
594
for revision_id in revision_ids:
595
try:
596
dotted_revno = b.revision_id_to_dotted_revno(revision_id)
597
revno = '.'.join(str(i) for i in dotted_revno)
598
except errors.NoSuchRevision:
599
revno = '???'
600
maxlen = max(maxlen, len(revno))
601
revinfos.append([revno, revision_id])
602
603
self.cleanup_now()
604
for ri in revinfos:
605
self.outf.write('%*s %s\n' % (maxlen, ri[0], ri[1]))
606
607
243
print '%4d %s' % (revinfo.revno, revinfo.rev_id)
244
245
608
246
class cmd_add(Command):
609
__doc__ = """Add specified files or directories.
247
"""Add specified files or directories.
610
248
611
249
In non-recursive mode, all the named items are added, regardless
612
250
of whether they were previously ignored. A warning is given if
628
266
you should never need to explicitly add a directory, they'll just
629
267
get added when you add a file in the directory.
630
268
631
--dry-run will show which files would be added, but not actually
269
--dry-run will show which files would be added, but not actually
632
270
add them.
633
634
--file-ids-from will try to use the file ids from the supplied path.
635
It looks up ids trying to find a matching parent directory with the
636
same filename, and then by pure path. This option is rarely needed
637
but can be useful when adding the same logical file into two
638
branches that will be merged later (without showing the two different
639
adds as a conflict). It is also useful when merging another project
640
into a subdirectory of this one.
641
642
Any files matching patterns in the ignore list will not be added
643
unless they are explicitly mentioned.
644
271
"""
645
272
takes_args = ['file*']
646
takes_options = [
647
Option('no-recurse',
648
help="Don't recursively add the contents of directories."),
649
Option('dry-run',
650
help="Show what would be done, but don't actually do anything."),
651
'verbose',
652
Option('file-ids-from',
653
type=unicode,
654
help='Lookup file ids from this tree.'),
655
]
273
takes_options = ['no-recurse', 'dry-run', 'verbose']
656
274
encoding_type = 'replace'
657
_see_also = ['remove', 'ignore']
658
275
659
def run(self, file_list, no_recurse=False, dry_run=False, verbose=False,
660
file_ids_from=None):
276
def run(self, file_list, no_recurse=False, dry_run=False, verbose=False):
661
277
import bzrlib.add
662
278
663
base_tree = None
664
if file_ids_from is not None:
665
try:
666
base_tree, base_path = WorkingTree.open_containing(
667
file_ids_from)
668
except errors.NoWorkingTree:
669
base_branch, base_path = Branch.open_containing(
670
file_ids_from)
671
base_tree = base_branch.basis_tree()
672
673
action = bzrlib.add.AddFromBaseAction(base_tree, base_path,
674
to_file=self.outf, should_print=(not is_quiet()))
675
else:
676
action = bzrlib.add.AddAction(to_file=self.outf,
677
should_print=(not is_quiet()))
678
679
if base_tree:
680
self.add_cleanup(base_tree.lock_read().unlock)
681
tree, file_list = tree_files_for_add(file_list)
682
added, ignored = tree.smart_add(file_list, not
683
no_recurse, action=action, save=not dry_run)
684
self.cleanup_now()
279
action = bzrlib.add.AddAction(to_file=self.outf,
280
should_print=(not is_quiet()))
281
282
added, ignored = bzrlib.add.smart_add(file_list, not no_recurse,
283
action=action, save=not dry_run)
685
284
if len(ignored) > 0:
686
285
if verbose:
687
286
for glob in sorted(ignored.keys()):
688
287
for path in ignored[glob]:
689
self.outf.write("ignored %s matching \"%s\"\n"
288
self.outf.write("ignored %s matching \"%s\"\n"
690
289
% (path, glob))
290
else:
291
match_len = 0
292
for glob, paths in ignored.items():
293
match_len += len(paths)
294
self.outf.write("ignored %d file(s).\n" % match_len)
295
self.outf.write("If you wish to add some of these files,"
296
" please add them by name.\n")
691
297
692
298
693
299
class cmd_mkdir(Command):
694
__doc__ = """Create a new versioned directory.
300
"""Create a new versioned directory.
695
301
696
302
This is equivalent to creating the directory and then adding it.
697
303
"""
701
307
702
308
def run(self, dir_list):
703
309
for d in dir_list:
310
os.mkdir(d)
704
311
wt, dd = WorkingTree.open_containing(d)
705
base = os.path.dirname(dd)
706
id = wt.path2id(base)
707
if id != None:
708
os.mkdir(d)
709
wt.add([dd])
710
self.outf.write('added %s\n' % d)
711
else:
712
raise errors.NotVersionedError(path=base)
312
wt.add([dd])
313
self.outf.write('added %s\n' % d)
713
314
714
315
715
316
class cmd_relpath(Command):
716
__doc__ = """Show path of a file relative to root"""
317
"""Show path of a file relative to root"""
717
318
718
319
takes_args = ['filename']
719
320
hidden = True
720
321
721
322
@display_command
722
323
def run(self, filename):
723
324
# TODO: jam 20050106 Can relpath return a munged path if
728
329
729
330
730
331
class cmd_inventory(Command):
731
__doc__ = """Show inventory of the current working copy or a revision.
332
"""Show inventory of the current working copy or a revision.
732
333
733
334
It is possible to limit the output to a particular entry
734
type using the --kind option. For example: --kind file.
735
736
It is also possible to restrict the list of files to a specific
737
set. For example: bzr inventory --show-ids this/file
335
type using the --kind option. For example; --kind file.
738
336
"""
739
337
740
hidden = True
741
_see_also = ['ls']
742
takes_options = [
743
'revision',
744
'show-ids',
745
Option('kind',
746
help='List entries of a particular kind: file, directory, symlink.',
747
type=unicode),
748
]
749
takes_args = ['file*']
750
338
takes_options = ['revision', 'show-ids', 'kind']
339
751
340
@display_command
752
def run(self, revision=None, show_ids=False, kind=None, file_list=None):
341
def run(self, revision=None, show_ids=False, kind=None):
753
342
if kind and kind not in ['file', 'directory', 'symlink']:
754
raise errors.BzrCommandError('invalid kind %r specified' % (kind,))
755
756
revision = _get_one_revision('inventory', revision)
757
work_tree, file_list = tree_files(file_list)
758
self.add_cleanup(work_tree.lock_read().unlock)
759
if revision is not None:
760
tree = revision.as_tree(work_tree.branch)
761
762
extra_trees = [work_tree]
763
self.add_cleanup(tree.lock_read().unlock)
764
else:
765
tree = work_tree
766
extra_trees = []
767
768
if file_list is not None:
769
file_ids = tree.paths2ids(file_list, trees=extra_trees,
770
require_versioned=True)
771
# find_ids_across_trees may include some paths that don't
772
# exist in 'tree'.
773
entries = sorted((tree.id2path(file_id), tree.inventory[file_id])
774
for file_id in file_ids if file_id in tree)
775
else:
776
entries = tree.inventory.entries()
777
778
self.cleanup_now()
779
for path, entry in entries:
343
raise BzrCommandError('invalid kind specified')
344
tree = WorkingTree.open_containing(u'.')[0]
345
if revision is None:
346
inv = tree.read_working_inventory()
347
else:
348
if len(revision) > 1:
349
raise BzrCommandError('bzr inventory --revision takes'
350
' exactly one revision identifier')
351
inv = tree.branch.repository.get_revision_inventory(
352
revision[0].in_history(tree.branch).rev_id)
353
354
for path, entry in inv.entries():
780
355
if kind and kind != entry.kind:
781
356
continue
782
357
if show_ids:
787
362
788
363
789
364
class cmd_mv(Command):
790
__doc__ = """Move or rename a file.
365
"""Move or rename a file.
791
366
792
:Usage:
367
usage:
793
368
bzr mv OLDNAME NEWNAME
794
795
369
bzr mv SOURCE... DESTINATION
796
370
797
371
If the last argument is a versioned directory, all the other names
798
372
are moved into it. Otherwise, there must be exactly two arguments
799
and the file is changed to a new name.
800
801
If OLDNAME does not exist on the filesystem but is versioned and
802
NEWNAME does exist on the filesystem but is not versioned, mv
803
assumes that the file has been manually moved and only updates
804
its internal inventory to reflect that change.
805
The same is valid when moving many SOURCE files to a DESTINATION.
373
and the file is changed to a new name, which must not already exist.
806
374
807
375
Files cannot be moved between branches.
808
376
"""
809
377
810
378
takes_args = ['names*']
811
takes_options = [Option("after", help="Move only the bzr identifier"
812
" of the file, because the file has already been moved."),
813
Option('auto', help='Automatically guess renames.'),
814
Option('dry-run', help='Avoid making changes when guessing renames.'),
815
]
816
379
aliases = ['move', 'rename']
817
380
encoding_type = 'replace'
818
381
819
def run(self, names_list, after=False, auto=False, dry_run=False):
820
if auto:
821
return self.run_auto(names_list, after, dry_run)
822
elif dry_run:
823
raise errors.BzrCommandError('--dry-run requires --auto.')
824
if names_list is None:
825
names_list = []
382
def run(self, names_list):
826
383
if len(names_list) < 2:
827
raise errors.BzrCommandError("missing file argument")
828
tree, rel_names = tree_files(names_list, canonicalize=False)
829
self.add_cleanup(tree.lock_tree_write().unlock)
830
self._run(tree, names_list, rel_names, after)
831
832
def run_auto(self, names_list, after, dry_run):
833
if names_list is not None and len(names_list) > 1:
834
raise errors.BzrCommandError('Only one path may be specified to'
835
' --auto.')
836
if after:
837
raise errors.BzrCommandError('--after cannot be specified with'
838
' --auto.')
839
work_tree, file_list = tree_files(names_list, default_branch='.')
840
self.add_cleanup(work_tree.lock_tree_write().unlock)
841
rename_map.RenameMap.guess_renames(work_tree, dry_run)
842
843
def _run(self, tree, names_list, rel_names, after):
844
into_existing = osutils.isdir(names_list[-1])
845
if into_existing and len(names_list) == 2:
846
# special cases:
847
# a. case-insensitive filesystem and change case of dir
848
# b. move directory after the fact (if the source used to be
849
# a directory, but now doesn't exist in the working tree
850
# and the target is an existing directory, just rename it)
851
if (not tree.case_sensitive
852
and rel_names[0].lower() == rel_names[1].lower()):
853
into_existing = False
854
else:
855
inv = tree.inventory
856
# 'fix' the case of a potential 'from'
857
from_id = tree.path2id(
858
tree.get_canonical_inventory_path(rel_names[0]))
859
if (not osutils.lexists(names_list[0]) and
860
from_id and inv.get_file_kind(from_id) == "directory"):
861
into_existing = False
862
# move/rename
863
if into_existing:
384
raise BzrCommandError("missing file argument")
385
tree, rel_names = tree_files(names_list)
386
387
if os.path.isdir(names_list[-1]):
864
388
# move into existing directory
865
# All entries reference existing inventory items, so fix them up
866
# for cicp file-systems.
867
rel_names = tree.get_canonical_inventory_paths(rel_names)
868
for src, dest in tree.move(rel_names[:-1], rel_names[-1], after=after):
869
if not is_quiet():
870
self.outf.write("%s => %s\n" % (src, dest))
389
for pair in tree.move(rel_names[:-1], rel_names[-1]):
390
self.outf.write("%s => %s\n" % pair)
871
391
else:
872
392
if len(names_list) != 2:
873
raise errors.BzrCommandError('to mv multiple files the'
874
' destination must be a versioned'
875
' directory')
876
877
# for cicp file-systems: the src references an existing inventory
878
# item:
879
src = tree.get_canonical_inventory_path(rel_names[0])
880
# Find the canonical version of the destination: In all cases, the
881
# parent of the target must be in the inventory, so we fetch the
882
# canonical version from there (we do not always *use* the
883
# canonicalized tail portion - we may be attempting to rename the
884
# case of the tail)
885
canon_dest = tree.get_canonical_inventory_path(rel_names[1])
886
dest_parent = osutils.dirname(canon_dest)
887
spec_tail = osutils.basename(rel_names[1])
888
# For a CICP file-system, we need to avoid creating 2 inventory
889
# entries that differ only by case. So regardless of the case
890
# we *want* to use (ie, specified by the user or the file-system),
891
# we must always choose to use the case of any existing inventory
892
# items. The only exception to this is when we are attempting a
893
# case-only rename (ie, canonical versions of src and dest are
894
# the same)
895
dest_id = tree.path2id(canon_dest)
896
if dest_id is None or tree.path2id(src) == dest_id:
897
# No existing item we care about, so work out what case we
898
# are actually going to use.
899
if after:
900
# If 'after' is specified, the tail must refer to a file on disk.
901
if dest_parent:
902
dest_parent_fq = osutils.pathjoin(tree.basedir, dest_parent)
903
else:
904
# pathjoin with an empty tail adds a slash, which breaks
905
# relpath :(
906
dest_parent_fq = tree.basedir
907
908
dest_tail = osutils.canonical_relpath(
909
dest_parent_fq,
910
osutils.pathjoin(dest_parent_fq, spec_tail))
911
else:
912
# not 'after', so case as specified is used
913
dest_tail = spec_tail
914
else:
915
# Use the existing item so 'mv' fails with AlreadyVersioned.
916
dest_tail = os.path.basename(canon_dest)
917
dest = osutils.pathjoin(dest_parent, dest_tail)
918
mutter("attempting to move %s => %s", src, dest)
919
tree.rename_one(src, dest, after=after)
920
if not is_quiet():
921
self.outf.write("%s => %s\n" % (src, dest))
922
923
393
raise BzrCommandError('to mv multiple files the destination '
394
'must be a versioned directory')
395
tree.rename_one(rel_names[0], rel_names[1])
396
self.outf.write("%s => %s\n" % (rel_names[0], rel_names[1]))
397
398
924
399
class cmd_pull(Command):
925
__doc__ = """Turn this branch into a mirror of another branch.
400
"""Turn this branch into a mirror of another branch.
926
401
927
By default, this command only works on branches that have not diverged.
928
Branches are considered diverged if the destination branch's most recent
929
commit is one that has not been merged (directly or indirectly) into the
930
parent.
402
This command only works on branches that have not diverged. Branches are
403
considered diverged if the destination branch's most recent commit is one
404
that has not been merged (directly or indirectly) into the parent.
931
405
932
406
If branches have diverged, you can use 'bzr merge' to integrate the changes
933
407
from one into the other. Once one branch has merged, the other should
934
408
be able to pull it again.
935
409
936
If you want to replace your local changes and just want your branch to
937
match the remote one, use pull --overwrite. This will work even if the two
938
branches have diverged.
410
If branches have diverged, you can use 'bzr merge' to pull the text changes
411
from one into the other. Once one branch has merged, the other should
412
be able to pull it again.
413
414
If you want to forget your local changes and just update your branch to
415
match the remote one, use pull --overwrite.
939
416
940
417
If there is no default location set, the first pull will set it. After
941
418
that, you can omit the location to use the default. To change the
942
default, use --remember. The value will only be saved if the remote
943
location can be accessed.
944
945
Note: The location can be specified either in the form of a branch,
946
or in the form of a path to a file containing a merge directive generated
947
with bzr send.
419
default, use --remember.
948
420
"""
949
421
950
_see_also = ['push', 'update', 'status-flags', 'send']
951
takes_options = ['remember', 'overwrite', 'revision',
952
custom_help('verbose',
953
help='Show logs of pulled revisions.'),
954
Option('directory',
955
help='Branch to pull into, '
956
'rather than the one containing the working directory.',
957
short_name='d',
958
type=unicode,
959
),
960
Option('local',
961
help="Perform a local pull in a bound "
962
"branch. Local pulls are not applied to "
963
"the master branch."
964
),
965
]
422
takes_options = ['remember', 'overwrite', 'revision', 'verbose']
966
423
takes_args = ['location?']
967
424
encoding_type = 'replace'
968
425
969
def run(self, location=None, remember=False, overwrite=False,
970
revision=None, verbose=False,
971
directory=None, local=False):
426
def run(self, location=None, remember=False, overwrite=False, revision=None, verbose=False):
972
427
# FIXME: too much stuff is in the command class
973
revision_id = None
974
mergeable = None
975
if directory is None:
976
directory = u'.'
977
428
try:
978
tree_to = WorkingTree.open_containing(directory)[0]
429
tree_to = WorkingTree.open_containing(u'.')[0]
979
430
branch_to = tree_to.branch
980
self.add_cleanup(tree_to.lock_write().unlock)
981
except errors.NoWorkingTree:
431
except NoWorkingTree:
982
432
tree_to = None
983
branch_to = Branch.open_containing(directory)[0]
984
self.add_cleanup(branch_to.lock_write().unlock)
985
986
if local and not branch_to.get_bound_location():
987
raise errors.LocalRequiresBoundBranch()
988
989
possible_transports = []
433
branch_to = Branch.open_containing(u'.')[0]
434
435
reader = None
990
436
if location is not None:
991
437
try:
992
mergeable = bundle.read_mergeable_from_url(location,
993
possible_transports=possible_transports)
994
except errors.NotABundle:
995
mergeable = None
438
reader = read_bundle_from_url(location)
439
except NotABundle:
440
pass # Continue on considering this url a Branch
996
441
997
442
stored_loc = branch_to.get_parent()
998
443
if location is None:
999
444
if stored_loc is None:
1000
raise errors.BzrCommandError("No pull location known or"
1001
" specified.")
445
raise BzrCommandError("No pull location known or specified.")
1002
446
else:
1003
447
display_url = urlutils.unescape_for_display(stored_loc,
1004
448
self.outf.encoding)
1005
if not is_quiet():
1006
self.outf.write("Using saved parent location: %s\n" % display_url)
449
self.outf.write("Using saved location: %s\n" % display_url)
1007
450
location = stored_loc
1008
451
1009
revision = _get_one_revision('pull', revision)
1010
if mergeable is not None:
1011
if revision is not None:
1012
raise errors.BzrCommandError(
1013
'Cannot use -r with merge directives or bundles')
1014
mergeable.install_revisions(branch_to.repository)
1015
base_revision_id, revision_id, verified = \
1016
mergeable.get_merge_request(branch_to.repository)
452
453
if reader is not None:
454
install_bundle(branch_to.repository, reader)
1017
455
branch_from = branch_to
1018
456
else:
1019
branch_from = Branch.open(location,
1020
possible_transports=possible_transports)
1021
self.add_cleanup(branch_from.lock_read().unlock)
457
branch_from = Branch.open(location)
1022
458
1023
459
if branch_to.get_parent() is None or remember:
1024
460
branch_to.set_parent(branch_from.base)
1025
461
1026
if revision is not None:
1027
revision_id = revision.as_revision_id(branch_from)
462
rev_id = None
463
if revision is None:
464
if reader is not None:
465
rev_id = reader.info.target
466
elif len(revision) == 1:
467
rev_id = revision[0].in_history(branch_from).rev_id
468
else:
469
raise BzrCommandError('bzr pull --revision takes one value.')
1028
470
471
old_rh = branch_to.revision_history()
1029
472
if tree_to is not None:
1030
view_info = _get_view_info_for_change_reporter(tree_to)
1031
change_reporter = delta._ChangeReporter(
1032
unversioned_filter=tree_to.is_ignored,
1033
view_info=view_info)
1034
result = tree_to.pull(
1035
branch_from, overwrite, revision_id, change_reporter,
1036
possible_transports=possible_transports, local=local)
473
count = tree_to.pull(branch_from, overwrite, rev_id)
1037
474
else:
1038
result = branch_to.pull(
1039
branch_from, overwrite, revision_id, local=local)
475
count = branch_to.pull(branch_from, overwrite, rev_id)
476
note('%d revision(s) pulled.' % (count,))
1040
477
1041
result.report(self.outf)
1042
if verbose and result.old_revid != result.new_revid:
1043
log.show_branch_change(
1044
branch_to, self.outf, result.old_revno,
1045
result.old_revid)
478
if verbose:
479
new_rh = branch_to.revision_history()
480
if old_rh != new_rh:
481
# Something changed
482
from bzrlib.log import show_changed_revisions
483
show_changed_revisions(branch_to, old_rh, new_rh,
484
to_file=self.outf)
1046
485
1047
486
1048
487
class cmd_push(Command):
1049
__doc__ = """Update a mirror of this branch.
1050
488
"""Update a mirror of this branch.
489
1051
490
The target branch will not have its working tree populated because this
1052
491
is both expensive, and is not supported on remote file systems.
1053
492
1054
493
Some smart servers or protocols *may* put the working tree in place in
1055
494
the future.
1056
495
1060
499
1061
500
If branches have diverged, you can use 'bzr push --overwrite' to replace
1062
501
the other branch completely, discarding its unmerged changes.
1063
502
1064
503
If you want to ensure you have the different changes in the other branch,
1065
504
do a merge (see bzr help merge) from the other branch, and commit that.
1066
505
After that you will be able to do a push without '--overwrite'.
1067
506
1068
507
If there is no default push location set, the first push will set it.
1069
508
After that, you can omit the location to use the default. To change the
1070
default, use --remember. The value will only be saved if the remote
1071
location can be accessed.
509
default, use --remember.
1072
510
"""
1073
511
1074
_see_also = ['pull', 'update', 'working-trees']
1075
takes_options = ['remember', 'overwrite', 'verbose', 'revision',
1076
Option('create-prefix',
1077
help='Create the path leading up to the branch '
1078
'if it does not already exist.'),
1079
Option('directory',
1080
help='Branch to push from, '
1081
'rather than the one containing the working directory.',
1082
short_name='d',
1083
type=unicode,
1084
),
1085
Option('use-existing-dir',
1086
help='By default push will fail if the target'
1087
' directory exists, but does not already'
1088
' have a control directory. This flag will'
1089
' allow push to proceed.'),
1090
Option('stacked',
1091
help='Create a stacked branch that references the public location '
1092
'of the parent branch.'),
1093
Option('stacked-on',
1094
help='Create a stacked branch that refers to another branch '
1095
'for the commit history. Only the work not present in the '
1096
'referenced branch is included in the branch created.',
1097
type=unicode),
1098
Option('strict',
1099
help='Refuse to push if there are uncommitted changes in'
1100
' the working tree, --no-strict disables the check.'),
1101
]
512
takes_options = ['remember', 'overwrite', 'verbose',
513
Option('create-prefix',
514
help='Create the path leading up to the branch '
515
'if it does not already exist')]
1102
516
takes_args = ['location?']
1103
517
encoding_type = 'replace'
1104
518
1105
519
def run(self, location=None, remember=False, overwrite=False,
1106
create_prefix=False, verbose=False, revision=None,
1107
use_existing_dir=False, directory=None, stacked_on=None,
1108
stacked=False, strict=None):
1109
from bzrlib.push import _show_push_branch
1110
1111
if directory is None:
1112
directory = '.'
1113
# Get the source branch
1114
(tree, br_from,
1115
_unused) = bzrdir.BzrDir.open_containing_tree_or_branch(directory)
1116
# Get the tip's revision_id
1117
revision = _get_one_revision('push', revision)
1118
if revision is not None:
1119
revision_id = revision.in_history(br_from).rev_id
1120
else:
1121
revision_id = None
1122
if tree is not None and revision_id is None:
1123
tree.check_changed_or_out_of_date(
1124
strict, 'push_strict',
1125
more_error='Use --no-strict to force the push.',
1126
more_warning='Uncommitted changes will not be pushed.')
1127
# Get the stacked_on branch, if any
1128
if stacked_on is not None:
1129
stacked_on = urlutils.normalize_url(stacked_on)
1130
elif stacked:
1131
parent_url = br_from.get_parent()
1132
if parent_url:
1133
parent = Branch.open(parent_url)
1134
stacked_on = parent.get_public_branch()
1135
if not stacked_on:
1136
# I considered excluding non-http url's here, thus forcing
1137
# 'public' branches only, but that only works for some
1138
# users, so it's best to just depend on the user spotting an
1139
# error by the feedback given to them. RBC 20080227.
1140
stacked_on = parent_url
1141
if not stacked_on:
1142
raise errors.BzrCommandError(
1143
"Could not determine branch to refer to.")
1144
1145
# Get the destination location
520
create_prefix=False, verbose=False):
521
# FIXME: Way too big! Put this into a function called from the
522
# command.
523
from bzrlib.transport import get_transport
524
525
br_from = Branch.open_containing('.')[0]
526
stored_loc = br_from.get_push_location()
1146
527
if location is None:
1147
stored_loc = br_from.get_push_location()
1148
528
if stored_loc is None:
1149
raise errors.BzrCommandError(
1150
"No push location known or specified.")
529
raise BzrCommandError("No push location known or specified.")
1151
530
else:
1152
531
display_url = urlutils.unescape_for_display(stored_loc,
1153
532
self.outf.encoding)
1154
self.outf.write("Using saved push location: %s\n" % display_url)
533
self.outf.write("Using saved location: %s" % display_url)
1155
534
location = stored_loc
1156
535
1157
_show_push_branch(br_from, revision_id, location, self.outf,
1158
verbose=verbose, overwrite=overwrite, remember=remember,
1159
stacked_on=stacked_on, create_prefix=create_prefix,
1160
use_existing_dir=use_existing_dir)
536
transport = get_transport(location)
537
location_url = transport.base
538
if br_from.get_push_location() is None or remember:
539
br_from.set_push_location(location_url)
540
541
old_rh = []
542
try:
543
dir_to = bzrlib.bzrdir.BzrDir.open(location_url)
544
br_to = dir_to.open_branch()
545
except NotBranchError:
546
# create a branch.
547
transport = transport.clone('..')
548
if not create_prefix:
549
try:
550
relurl = transport.relpath(location_url)
551
mutter('creating directory %s => %s', location_url, relurl)
552
transport.mkdir(relurl)
553
except NoSuchFile:
554
raise BzrCommandError("Parent directory of %s "
555
"does not exist." % location)
556
else:
557
current = transport.base
558
needed = [(transport, transport.relpath(location_url))]
559
while needed:
560
try:
561
transport, relpath = needed[-1]
562
transport.mkdir(relpath)
563
needed.pop()
564
except NoSuchFile:
565
new_transport = transport.clone('..')
566
needed.append((new_transport,
567
new_transport.relpath(transport.base)))
568
if new_transport.base == transport.base:
569
raise BzrCommandError("Could not create "
570
"path prefix.")
571
dir_to = br_from.bzrdir.clone(location_url,
572
revision_id=br_from.last_revision())
573
br_to = dir_to.open_branch()
574
count = len(br_to.revision_history())
575
else:
576
old_rh = br_to.revision_history()
577
try:
578
try:
579
tree_to = dir_to.open_workingtree()
580
except errors.NotLocalUrl:
581
warning('This transport does not update the working '
582
'tree of: %s' % (br_to.base,))
583
count = br_to.pull(br_from, overwrite)
584
except NoWorkingTree:
585
count = br_to.pull(br_from, overwrite)
586
else:
587
count = tree_to.pull(br_from, overwrite)
588
except DivergedBranches:
589
raise BzrCommandError("These branches have diverged."
590
" Try a merge then push with overwrite.")
591
note('%d revision(s) pushed.' % (count,))
592
593
if verbose:
594
new_rh = br_to.revision_history()
595
if old_rh != new_rh:
596
# Something changed
597
from bzrlib.log import show_changed_revisions
598
show_changed_revisions(br_to, old_rh, new_rh,
599
to_file=self.outf)
1161
600
1162
601
1163
602
class cmd_branch(Command):
1164
__doc__ = """Create a new branch that is a copy of an existing branch.
603
"""Create a new copy of a branch.
1165
604
1166
605
If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
1167
606
be used. In other words, "branch ../foo/bar" will attempt to create ./bar.
1168
If the FROM_LOCATION has no / or path separator embedded, the TO_LOCATION
1169
is derived from the FROM_LOCATION by stripping a leading scheme or drive
1170
identifier, if any. For example, "branch lp:foo-bar" will attempt to
1171
create ./foo-bar.
1172
607
1173
608
To retrieve the branch as of a particular revision, supply the --revision
1174
609
parameter, as in "branch foo/bar -r 5".
610
611
--basis is to speed up branching from remote branches. When specified, it
612
copies all the file-contents, inventory and revision data from the basis
613
branch before copying anything from the remote branch.
1175
614
"""
1176
1177
_see_also = ['checkout']
1178
615
takes_args = ['from_location', 'to_location?']
1179
takes_options = ['revision', Option('hardlink',
1180
help='Hard-link working tree files where possible.'),
1181
Option('no-tree',
1182
help="Create a branch without a working-tree."),
1183
Option('switch',
1184
help="Switch the checkout in the current directory "
1185
"to the new branch."),
1186
Option('stacked',
1187
help='Create a stacked branch referring to the source branch. '
1188
'The new branch will depend on the availability of the source '
1189
'branch for all operations.'),
1190
Option('standalone',
1191
help='Do not use a shared repository, even if available.'),
1192
Option('use-existing-dir',
1193
help='By default branch will fail if the target'
1194
' directory exists, but does not already'
1195
' have a control directory. This flag will'
1196
' allow branch to proceed.'),
1197
Option('bind',
1198
help="Bind new branch to from location."),
1199
]
616
takes_options = ['revision', 'basis']
1200
617
aliases = ['get', 'clone']
1201
618
1202
def run(self, from_location, to_location=None, revision=None,
1203
hardlink=False, stacked=False, standalone=False, no_tree=False,
1204
use_existing_dir=False, switch=False, bind=False):
1205
from bzrlib import switch as _mod_switch
1206
from bzrlib.tag import _merge_tags_if_possible
1207
accelerator_tree, br_from = bzrdir.BzrDir.open_tree_or_branch(
1208
from_location)
1209
revision = _get_one_revision('branch', revision)
1210
self.add_cleanup(br_from.lock_read().unlock)
1211
if revision is not None:
1212
revision_id = revision.as_revision_id(br_from)
1213
else:
1214
# FIXME - wt.last_revision, fallback to branch, fall back to
1215
# None or perhaps NULL_REVISION to mean copy nothing
1216
# RBC 20060209
1217
revision_id = br_from.last_revision()
1218
if to_location is None:
1219
to_location = urlutils.derive_to_location(from_location)
1220
to_transport = transport.get_transport(to_location)
1221
try:
1222
to_transport.mkdir('.')
1223
except errors.FileExists:
1224
if not use_existing_dir:
1225
raise errors.BzrCommandError('Target directory "%s" '
1226
'already exists.' % to_location)
1227
else:
1228
try:
1229
bzrdir.BzrDir.open_from_transport(to_transport)
1230
except errors.NotBranchError:
1231
pass
1232
else:
1233
raise errors.AlreadyBranchError(to_location)
1234
except errors.NoSuchFile:
1235
raise errors.BzrCommandError('Parent of "%s" does not exist.'
1236
% to_location)
1237
try:
1238
# preserve whatever source format we have.
1239
dir = br_from.bzrdir.sprout(to_transport.base, revision_id,
1240
possible_transports=[to_transport],
1241
accelerator_tree=accelerator_tree,
1242
hardlink=hardlink, stacked=stacked,
1243
force_new_repo=standalone,
1244
create_tree_if_local=not no_tree,
1245
source_branch=br_from)
1246
branch = dir.open_branch()
1247
except errors.NoSuchRevision:
1248
to_transport.delete_tree('.')
1249
msg = "The branch %s has no revision %s." % (from_location,
1250
revision)
1251
raise errors.BzrCommandError(msg)
1252
_merge_tags_if_possible(br_from, branch)
1253
# If the source branch is stacked, the new branch may
1254
# be stacked whether we asked for that explicitly or not.
1255
# We therefore need a try/except here and not just 'if stacked:'
1256
try:
1257
note('Created new stacked branch referring to %s.' %
1258
branch.get_stacked_on_url())
1259
except (errors.NotStacked, errors.UnstackableBranchFormat,
1260
errors.UnstackableRepositoryFormat), e:
619
def run(self, from_location, to_location=None, revision=None, basis=None):
620
from bzrlib.transport import get_transport
621
from bzrlib.osutils import rmtree
622
if revision is None:
623
revision = [None]
624
elif len(revision) > 1:
625
raise BzrCommandError(
626
'bzr branch --revision takes exactly 1 revision value')
627
try:
628
br_from = Branch.open(from_location)
629
except OSError, e:
630
if e.errno == errno.ENOENT:
631
raise BzrCommandError('Source location "%s" does not'
632
' exist.' % to_location)
633
else:
634
raise
635
br_from.lock_read()
636
try:
637
if basis is not None:
638
basis_dir = bzrdir.BzrDir.open_containing(basis)[0]
639
else:
640
basis_dir = None
641
if len(revision) == 1 and revision[0] is not None:
642
revision_id = revision[0].in_history(br_from)[1]
643
else:
644
# FIXME - wt.last_revision, fallback to branch, fall back to
645
# None or perhaps NULL_REVISION to mean copy nothing
646
# RBC 20060209
647
revision_id = br_from.last_revision()
648
if to_location is None:
649
to_location = os.path.basename(from_location.rstrip("/\\"))
650
name = None
651
else:
652
name = os.path.basename(to_location) + '\n'
653
654
to_transport = get_transport(to_location)
655
try:
656
to_transport.mkdir('.')
657
except bzrlib.errors.FileExists:
658
raise BzrCommandError('Target directory "%s" already'
659
' exists.' % to_location)
660
except bzrlib.errors.NoSuchFile:
661
raise BzrCommandError('Parent of "%s" does not exist.' %
662
to_location)
663
try:
664
# preserve whatever source format we have.
665
dir = br_from.bzrdir.sprout(to_transport.base,
666
revision_id, basis_dir)
667
branch = dir.open_branch()
668
except bzrlib.errors.NoSuchRevision:
669
to_transport.delete_tree('.')
670
msg = "The branch %s has no revision %s." % (from_location, revision[0])
671
raise BzrCommandError(msg)
672
except bzrlib.errors.UnlistableBranch:
673
rmtree(to_location)
674
msg = "The branch %s cannot be used as a --basis" % (basis,)
675
raise BzrCommandError(msg)
676
if name:
677
branch.control_files.put_utf8('branch-name', name)
1261
678
note('Branched %d revision(s).' % branch.revno())
1262
if bind:
1263
# Bind to the parent
1264
parent_branch = Branch.open(from_location)
1265
branch.bind(parent_branch)
1266
note('New branch bound to %s' % from_location)
1267
if switch:
1268
# Switch to the new branch
1269
wt, _ = WorkingTree.open_containing('.')
1270
_mod_switch.switch(wt.bzrdir, branch)
1271
note('Switched to branch: %s',
1272
urlutils.unescape_for_display(branch.base, 'utf-8'))
679
finally:
680
br_from.unlock()
1273
681
1274
682
1275
683
class cmd_checkout(Command):
1276
__doc__ = """Create a new checkout of an existing branch.
684
"""Create a new checkout of an existing branch.
1277
685
1278
686
If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
1279
687
the branch found in '.'. This is useful if you have removed the working tree
1280
688
or if it was never created - i.e. if you pushed the branch to its current
1281
689
location using SFTP.
1282
690
1283
691
If the TO_LOCATION is omitted, the last component of the BRANCH_LOCATION will
1284
692
be used. In other words, "checkout ../foo/bar" will attempt to create ./bar.
1285
If the BRANCH_LOCATION has no / or path separator embedded, the TO_LOCATION
1286
is derived from the BRANCH_LOCATION by stripping a leading scheme or drive
1287
identifier, if any. For example, "checkout lp:foo-bar" will attempt to
1288
create ./foo-bar.
1289
693
1290
694
To retrieve the branch as of a particular revision, supply the --revision
1291
695
parameter, as in "checkout foo/bar -r 5". Note that this will be immediately
1292
696
out of date [so you cannot commit] but it may be useful (i.e. to examine old
1293
697
code.)
698
699
--basis is to speed up checking out from remote branches. When specified, it
700
uses the inventory and file contents from the basis branch in preference to the
701
branch being checked out.
1294
702
"""
1295
1296
_see_also = ['checkouts', 'branch']
1297
703
takes_args = ['branch_location?', 'to_location?']
1298
takes_options = ['revision',
704
takes_options = ['revision', # , 'basis']
1299
705
Option('lightweight',
1300
help="Perform a lightweight checkout. Lightweight "
706
help="perform a lightweight checkout. Lightweight "
1301
707
"checkouts depend on access to the branch for "
1302
"every operation. Normal checkouts can perform "
708
"every operation. Normal checkouts can perform "
1303
709
"common operations like diff and status without "
1304
710
"such access, and also support local commits."
1305
711
),
1306
Option('files-from', type=str,
1307
help="Get file contents from this tree."),
1308
Option('hardlink',
1309
help='Hard-link working tree files where possible.'
1310
),
1311
712
]
1312
aliases = ['co']
1313
713
1314
def run(self, branch_location=None, to_location=None, revision=None,
1315
lightweight=False, files_from=None, hardlink=False):
714
def run(self, branch_location=None, to_location=None, revision=None, basis=None,
715
lightweight=False):
716
if revision is None:
717
revision = [None]
718
elif len(revision) > 1:
719
raise BzrCommandError(
720
'bzr checkout --revision takes exactly 1 revision value')
1316
721
if branch_location is None:
1317
branch_location = osutils.getcwd()
722
branch_location = bzrlib.osutils.getcwd()
1318
723
to_location = branch_location
1319
accelerator_tree, source = bzrdir.BzrDir.open_tree_or_branch(
1320
branch_location)
1321
revision = _get_one_revision('checkout', revision)
1322
if files_from is not None:
1323
accelerator_tree = WorkingTree.open(files_from)
1324
if revision is not None:
1325
revision_id = revision.as_revision_id(source)
724
source = Branch.open(branch_location)
725
if len(revision) == 1 and revision[0] is not None:
726
revision_id = revision[0].in_history(source)[1]
1326
727
else:
1327
728
revision_id = None
1328
729
if to_location is None:
1329
to_location = urlutils.derive_to_location(branch_location)
1330
# if the source and to_location are the same,
730
to_location = os.path.basename(branch_location.rstrip("/\\"))
731
# if the source and to_location are the same,
1331
732
# and there is no working tree,
1332
733
# then reconstitute a branch
1333
if (osutils.abspath(to_location) ==
1334
osutils.abspath(branch_location)):
734
if (bzrlib.osutils.abspath(to_location) ==
735
bzrlib.osutils.abspath(branch_location)):
1335
736
try:
1336
737
source.bzrdir.open_workingtree()
1337
738
except errors.NoWorkingTree:
1338
source.bzrdir.create_workingtree(revision_id)
739
source.bzrdir.create_workingtree()
1339
740
return
1340
source.create_checkout(to_location, revision_id, lightweight,
1341
accelerator_tree, hardlink)
741
try:
742
os.mkdir(to_location)
743
except OSError, e:
744
if e.errno == errno.EEXIST:
745
raise BzrCommandError('Target directory "%s" already'
746
' exists.' % to_location)
747
if e.errno == errno.ENOENT:
748
raise BzrCommandError('Parent of "%s" does not exist.' %
749
to_location)
750
else:
751
raise
752
old_format = bzrlib.bzrdir.BzrDirFormat.get_default_format()
753
bzrlib.bzrdir.BzrDirFormat.set_default_format(bzrdir.BzrDirMetaFormat1())
754
try:
755
if lightweight:
756
checkout = bzrdir.BzrDirMetaFormat1().initialize(to_location)
757
bzrlib.branch.BranchReferenceFormat().initialize(checkout, source)
758
else:
759
checkout_branch = bzrlib.bzrdir.BzrDir.create_branch_convenience(
760
to_location, force_new_tree=False)
761
checkout = checkout_branch.bzrdir
762
checkout_branch.bind(source)
763
if revision_id is not None:
764
rh = checkout_branch.revision_history()
765
checkout_branch.set_revision_history(rh[:rh.index(revision_id) + 1])
766
checkout.create_workingtree(revision_id)
767
finally:
768
bzrlib.bzrdir.BzrDirFormat.set_default_format(old_format)
1342
769
1343
770
1344
771
class cmd_renames(Command):
1345
__doc__ = """Show list of renamed files.
772
"""Show list of renamed files.
1346
773
"""
1347
774
# TODO: Option to show renames between two historical versions.
1348
775
1349
776
# TODO: Only show renames under dir, rather than in the whole branch.
1350
_see_also = ['status']
1351
777
takes_args = ['dir?']
1352
778
1353
779
@display_command
1354
780
def run(self, dir=u'.'):
1355
781
tree = WorkingTree.open_containing(dir)[0]
1356
self.add_cleanup(tree.lock_read().unlock)
1357
new_inv = tree.inventory
1358
old_tree = tree.basis_tree()
1359
self.add_cleanup(old_tree.lock_read().unlock)
1360
old_inv = old_tree.inventory
1361
renames = []
1362
iterator = tree.iter_changes(old_tree, include_unchanged=True)
1363
for f, paths, c, v, p, n, k, e in iterator:
1364
if paths[0] == paths[1]:
1365
continue
1366
if None in (paths):
1367
continue
1368
renames.append(paths)
782
old_inv = tree.basis_tree().inventory
783
new_inv = tree.read_working_inventory()
784
785
renames = list(bzrlib.tree.find_renames(old_inv, new_inv))
1369
786
renames.sort()
1370
787
for old_name, new_name in renames:
1371
788
self.outf.write("%s => %s\n" % (old_name, new_name))
1372
789
1373
790
1374
791
class cmd_update(Command):
1375
__doc__ = """Update a tree to have the latest code committed to its branch.
1376
792
"""Update a tree to have the latest code committed to its branch.
793
1377
794
This will perform a merge into the working tree, and may generate
1378
conflicts. If you have any local changes, you will still
795
conflicts. If you have any local changes, you will still
1379
796
need to commit them after the update for the update to be complete.
1380
1381
If you want to discard your local changes, you can just do a
797
798
If you want to discard your local changes, you can just do a
1382
799
'bzr revert' instead of 'bzr commit' after the update.
1383
1384
If the tree's branch is bound to a master branch, it will also update
1385
the branch from the master.
1386
800
"""
1387
1388
_see_also = ['pull', 'working-trees', 'status-flags']
1389
801
takes_args = ['dir?']
1390
takes_options = ['revision']
1391
aliases = ['up']
1392
802
1393
def run(self, dir='.', revision=None):
1394
if revision is not None and len(revision) != 1:
1395
raise errors.BzrCommandError(
1396
"bzr update --revision takes exactly one revision")
803
def run(self, dir='.'):
1397
804
tree = WorkingTree.open_containing(dir)[0]
1398
branch = tree.branch
1399
possible_transports = []
1400
master = branch.get_master_branch(
1401
possible_transports=possible_transports)
1402
if master is not None:
1403
branch_location = master.base
1404
tree.lock_write()
1405
else:
1406
branch_location = tree.branch.base
1407
tree.lock_tree_write()
1408
self.add_cleanup(tree.unlock)
1409
# get rid of the final '/' and be ready for display
1410
branch_location = urlutils.unescape_for_display(
1411
branch_location.rstrip('/'),
1412
self.outf.encoding)
1413
existing_pending_merges = tree.get_parent_ids()[1:]
1414
if master is None:
1415
old_tip = None
1416
else:
1417
# may need to fetch data into a heavyweight checkout
1418
# XXX: this may take some time, maybe we should display a
1419
# message
1420
old_tip = branch.update(possible_transports)
1421
if revision is not None:
1422
revision_id = revision[0].as_revision_id(branch)
1423
else:
1424
revision_id = branch.last_revision()
1425
if revision_id == _mod_revision.ensure_null(tree.last_revision()):
1426
revno = branch.revision_id_to_dotted_revno(revision_id)
1427
note("Tree is up to date at revision %s of branch %s" %
1428
('.'.join(map(str, revno)), branch_location))
1429
return 0
1430
view_info = _get_view_info_for_change_reporter(tree)
1431
change_reporter = delta._ChangeReporter(
1432
unversioned_filter=tree.is_ignored,
1433
view_info=view_info)
805
tree.lock_write()
1434
806
try:
1435
conflicts = tree.update(
1436
change_reporter,
1437
possible_transports=possible_transports,
1438
revision=revision_id,
1439
old_tip=old_tip)
1440
except errors.NoSuchRevision, e:
1441
raise errors.BzrCommandError(
1442
"branch has no revision %s\n"
1443
"bzr update --revision only works"
1444
" for a revision in the branch history"
1445
% (e.revision))
1446
revno = tree.branch.revision_id_to_dotted_revno(
1447
_mod_revision.ensure_null(tree.last_revision()))
1448
note('Updated to revision %s of branch %s' %
1449
('.'.join(map(str, revno)), branch_location))
1450
parent_ids = tree.get_parent_ids()
1451
if parent_ids[1:] and parent_ids[1:] != existing_pending_merges:
1452
note('Your local commits will now show as pending merges with '
1453
"'bzr status', and can be committed with 'bzr commit'.")
1454
if conflicts != 0:
1455
return 1
1456
else:
1457
return 0
807
if tree.last_revision() == tree.branch.last_revision():
808
# may be up to date, check master too.
809
master = tree.branch.get_master_branch()
810
if master is None or master.last_revision == tree.last_revision():
811
note("Tree is up to date.")
812
return
813
conflicts = tree.update()
814
note('Updated to revision %d.' %
815
(tree.branch.revision_id_to_revno(tree.last_revision()),))
816
if conflicts != 0:
817
return 1
818
else:
819
return 0
820
finally:
821
tree.unlock()
1458
822
1459
823
1460
824
class cmd_info(Command):
1461
__doc__ = """Show information about a working tree, branch or repository.
825
"""Show information about a working tree, branch or repository.
1462
826
1463
827
This command will show all known locations and formats associated to the
1464
tree, branch or repository.
1465
1466
In verbose mode, statistical information is included with each report.
1467
To see extended statistic information, use a verbosity level of 2 or
1468
higher by specifying the verbose option multiple times, e.g. -vv.
828
tree, branch or repository. Statistical information is included with
829
each report.
1469
830
1470
831
Branches and working trees will also report any missing revisions.
1471
1472
:Examples:
1473
1474
Display information on the format and related locations:
1475
1476
bzr info
1477
1478
Display the above together with extended format information and
1479
basic statistics (like the number of files in the working tree and
1480
number of revisions in the branch and repository):
1481
1482
bzr info -v
1483
1484
Display the above together with number of committers to the branch:
1485
1486
bzr info -vv
1487
832
"""
1488
_see_also = ['revno', 'working-trees', 'repositories']
1489
833
takes_args = ['location?']
1490
834
takes_options = ['verbose']
1491
encoding_type = 'replace'
1492
835
1493
836
@display_command
1494
837
def run(self, location=None, verbose=False):
1495
if verbose:
1496
noise_level = get_verbosity_level()
1497
else:
1498
noise_level = 0
1499
838
from bzrlib.info import show_bzrdir_info
1500
839
show_bzrdir_info(bzrdir.BzrDir.open_containing(location)[0],
1501
verbose=noise_level, outfile=self.outf)
840
verbose=verbose)
1502
841
1503
842
1504
843
class cmd_remove(Command):
1505
__doc__ = """Remove files or directories.
1506
1507
This makes bzr stop tracking changes to the specified files. bzr will delete
1508
them if they can easily be recovered using revert. If no options or
1509
parameters are given bzr will scan for files that are being tracked by bzr
1510
but missing in your tree and stop tracking them for you.
844
"""Make a file unversioned.
845
846
This makes bzr stop tracking changes to a versioned file. It does
847
not delete the working copy.
848
849
You can specify one or more files, and/or --new. If you specify --new,
850
only 'added' files will be removed. If you specify both, then new files
851
in the specified directories will be removed. If the directories are
852
also new, they will also be removed.
1511
853
"""
1512
854
takes_args = ['file*']
1513
takes_options = ['verbose',
1514
Option('new', help='Only remove files that have never been committed.'),
1515
RegistryOption.from_kwargs('file-deletion-strategy',
1516
'The file deletion mode to be used.',
1517
title='Deletion Strategy', value_switches=True, enum_switch=False,
1518
safe='Only delete files if they can be'
1519
' safely recovered (default).',
1520
keep='Delete from bzr but leave the working copy.',
1521
force='Delete all the specified files, even if they can not be '
1522
'recovered and even if they are non-empty directories.')]
1523
aliases = ['rm', 'del']
855
takes_options = ['verbose', Option('new', help='remove newly-added files')]
856
aliases = ['rm']
1524
857
encoding_type = 'replace'
1525
1526
def run(self, file_list, verbose=False, new=False,
1527
file_deletion_strategy='safe'):
858
859
def run(self, file_list, verbose=False, new=False):
1528
860
tree, file_list = tree_files(file_list)
1529
1530
if file_list is not None:
1531
file_list = [f for f in file_list]
1532
1533
self.add_cleanup(tree.lock_write().unlock)
1534
# Heuristics should probably all move into tree.remove_smart or
1535
# some such?
1536
if new:
1537
added = tree.changes_from(tree.basis_tree(),
1538
specific_files=file_list).added
1539
file_list = sorted([f[0] for f in added], reverse=True)
861
if new is False:
862
if file_list is None:
863
raise BzrCommandError('Specify one or more files to remove, or'
864
' use --new.')
865
else:
866
from bzrlib.delta import compare_trees
867
added = [compare_trees(tree.basis_tree(), tree,
868
specific_files=file_list).added]
869
file_list = sorted([f[0] for f in added[0]], reverse=True)
1540
870
if len(file_list) == 0:
1541
raise errors.BzrCommandError('No matching files.')
1542
elif file_list is None:
1543
# missing files show up in iter_changes(basis) as
1544
# versioned-with-no-kind.
1545
missing = []
1546
for change in tree.iter_changes(tree.basis_tree()):
1547
# Find paths in the working tree that have no kind:
1548
if change[1][1] is not None and change[6][1] is None:
1549
missing.append(change[1][1])
1550
file_list = sorted(missing, reverse=True)
1551
file_deletion_strategy = 'keep'
1552
tree.remove(file_list, verbose=verbose, to_file=self.outf,
1553
keep_files=file_deletion_strategy=='keep',
1554
force=file_deletion_strategy=='force')
871
raise BzrCommandError('No matching files.')
872
tree.remove(file_list, verbose=verbose, to_file=self.outf)
1555
873
1556
874
1557
875
class cmd_file_id(Command):
1558
__doc__ = """Print file_id of a particular file or directory.
876
"""Print file_id of a particular file or directory.
1559
877
1560
878
The file_id is assigned when the file is first added and remains the
1561
879
same through all revisions where the file exists, even when it is
1563
881
"""
1564
882
1565
883
hidden = True
1566
_see_also = ['inventory', 'ls']
1567
884
takes_args = ['filename']
1568
885
1569
886
@display_command
1570
887
def run(self, filename):
1571
888
tree, relpath = WorkingTree.open_containing(filename)
1572
i = tree.path2id(relpath)
1573
if i is None:
1574
raise errors.NotVersionedError(filename)
889
i = tree.inventory.path2id(relpath)
890
if i == None:
891
raise BzrError("%r is not a versioned file" % filename)
1575
892
else:
1576
893
self.outf.write(i + '\n')
1577
894
1578
895
1579
896
class cmd_file_path(Command):
1580
__doc__ = """Print path of file_ids to a file or directory.
897
"""Print path of file_ids to a file or directory.
1581
898
1582
899
This prints one line for each directory down to the target,
1583
900
starting at the branch root.
1589
906
@display_command
1590
907
def run(self, filename):
1591
908
tree, relpath = WorkingTree.open_containing(filename)
1592
fid = tree.path2id(relpath)
1593
if fid is None:
1594
raise errors.NotVersionedError(filename)
1595
segments = osutils.splitpath(relpath)
1596
for pos in range(1, len(segments) + 1):
1597
path = osutils.joinpath(segments[:pos])
1598
self.outf.write("%s\n" % tree.path2id(path))
909
inv = tree.inventory
910
fid = inv.path2id(relpath)
911
if fid == None:
912
raise BzrError("%r is not a versioned file" % filename)
913
for fip in inv.get_idpath(fid):
914
self.outf.write(fip + '\n')
1599
915
1600
916
1601
917
class cmd_reconcile(Command):
1602
__doc__ = """Reconcile bzr metadata in a branch.
918
"""Reconcile bzr metadata in a branch.
1603
919
1604
920
This can correct data mismatches that may have been caused by
1605
921
previous ghost operations or bzr upgrades. You should only
1606
need to run this command if 'bzr check' or a bzr developer
922
need to run this command if 'bzr check' or a bzr developer
1607
923
advises you to run it.
1608
924
1609
925
If a second branch is provided, cross-branch reconciliation is
1611
927
id which was not present in very early bzr versions is represented
1612
928
correctly in both branches.
1613
929
1614
At the same time it is run it may recompress data resulting in
930
At the same time it is run it may recompress data resulting in
1615
931
a potential saving in disk space or performance gain.
1616
932
1617
933
The branch *MUST* be on a listable system such as local disk or sftp.
1618
934
"""
1619
1620
_see_also = ['check']
1621
935
takes_args = ['branch?']
1622
936
1623
937
def run(self, branch="."):
1624
938
from bzrlib.reconcile import reconcile
1625
dir = bzrdir.BzrDir.open(branch)
939
dir = bzrlib.bzrdir.BzrDir.open(branch)
1626
940
reconcile(dir)
1627
941
1628
942
1629
943
class cmd_revision_history(Command):
1630
__doc__ = """Display the list of revision ids on a branch."""
1631
1632
_see_also = ['log']
1633
takes_args = ['location?']
1634
944
"""Display list of revision ids on this branch."""
1635
945
hidden = True
1636
946
1637
947
@display_command
1638
def run(self, location="."):
1639
branch = Branch.open_containing(location)[0]
1640
for revid in branch.revision_history():
1641
self.outf.write(revid)
948
def run(self):
949
branch = WorkingTree.open_containing(u'.')[0].branch
950
for patchid in branch.revision_history():
951
self.outf.write(patchid)
1642
952
self.outf.write('\n')
1643
953
1644
954
1645
955
class cmd_ancestry(Command):
1646
__doc__ = """List all revisions merged into this branch."""
1647
1648
_see_also = ['log', 'revision-history']
1649
takes_args = ['location?']
1650
956
"""List all revisions merged into this branch."""
1651
957
hidden = True
1652
958
1653
959
@display_command
1654
def run(self, location="."):
1655
try:
1656
wt = WorkingTree.open_containing(location)[0]
1657
except errors.NoWorkingTree:
1658
b = Branch.open(location)
1659
last_revision = b.last_revision()
1660
else:
1661
b = wt.branch
1662
last_revision = wt.last_revision()
1663
1664
revision_ids = b.repository.get_ancestry(last_revision)
960
def run(self):
961
tree = WorkingTree.open_containing(u'.')[0]
962
b = tree.branch
963
# FIXME. should be tree.last_revision
964
revision_ids = b.repository.get_ancestry(b.last_revision())
965
assert revision_ids[0] == None
1665
966
revision_ids.pop(0)
1666
967
for revision_id in revision_ids:
1667
968
self.outf.write(revision_id + '\n')
1668
969
1669
970
1670
971
class cmd_init(Command):
1671
__doc__ = """Make a directory into a versioned branch.
972
"""Make a directory into a versioned branch.
1672
973
1673
974
Use this to create an empty branch, or before importing an
1674
975
existing project.
1675
976
1676
If there is a repository in a parent directory of the location, then
977
If there is a repository in a parent directory of the location, then
1677
978
the history of the branch will be stored in the repository. Otherwise
1678
init creates a standalone branch which carries its own history
1679
in the .bzr directory.
979
init creates a standalone branch which carries its own history in
980
.bzr.
1680
981
1681
982
If there is already a branch at the location but it has no working tree,
1682
983
the tree can be populated with 'bzr checkout'.
1683
984
1684
Recipe for importing a tree of files::
1685
985
Recipe for importing a tree of files:
1686
986
cd ~/project
1687
987
bzr init
1688
988
bzr add .
1689
989
bzr status
1690
bzr commit -m "imported project"
990
bzr commit -m 'imported project'
1691
991
"""
1692
1693
_see_also = ['init-repository', 'branch', 'checkout']
1694
992
takes_args = ['location?']
1695
993
takes_options = [
1696
Option('create-prefix',
1697
help='Create the path leading up to the branch '
1698
'if it does not already exist.'),
1699
RegistryOption('format',
1700
help='Specify a format for this branch. '
1701
'See "help formats".',
1702
lazy_registry=('bzrlib.bzrdir', 'format_registry'),
1703
converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
1704
value_switches=True,
1705
title="Branch format",
1706
),
1707
Option('append-revisions-only',
1708
help='Never change revnos or the existing log.'
1709
' Append revisions to it only.')
1710
]
1711
def run(self, location=None, format=None, append_revisions_only=False,
1712
create_prefix=False):
994
Option('format',
995
help='Specify a format for this branch. Current'
996
' formats are: default, knit, metaweave and'
997
' weave. Default is knit; metaweave and'
998
' weave are deprecated',
999
type=get_format_type),
1000
]
1001
def run(self, location=None, format=None):
1002
from bzrlib.branch import Branch
1713
1003
if format is None:
1714
format = bzrdir.format_registry.make_bzrdir('default')
1004
format = get_format_type('default')
1715
1005
if location is None:
1716
1006
location = u'.'
1717
1718
to_transport = transport.get_transport(location)
1719
1720
# The path has to exist to initialize a
1721
# branch inside of it.
1722
# Just using os.mkdir, since I don't
1723
# believe that we want to create a bunch of
1724
# locations if the user supplies an extended path
1725
try:
1726
to_transport.ensure_base()
1727
except errors.NoSuchFile:
1728
if not create_prefix:
1729
raise errors.BzrCommandError("Parent directory of %s"
1730
" does not exist."
1731
"\nYou may supply --create-prefix to create all"
1732
" leading parent directories."
1733
% location)
1734
to_transport.create_prefix()
1735
1736
try:
1737
a_bzrdir = bzrdir.BzrDir.open_from_transport(to_transport)
1738
except errors.NotBranchError:
1007
else:
1008
# The path has to exist to initialize a
1009
# branch inside of it.
1010
# Just using os.mkdir, since I don't
1011
# believe that we want to create a bunch of
1012
# locations if the user supplies an extended path
1013
if not os.path.exists(location):
1014
os.mkdir(location)
1015
try:
1016
existing_bzrdir = bzrdir.BzrDir.open(location)
1017
except NotBranchError:
1739
1018
# really a NotBzrDir error...
1740
create_branch = bzrdir.BzrDir.create_branch_convenience
1741
branch = create_branch(to_transport.base, format=format,
1742
possible_transports=[to_transport])
1743
a_bzrdir = branch.bzrdir
1019
bzrdir.BzrDir.create_branch_convenience(location, format=format)
1744
1020
else:
1745
from bzrlib.transport.local import LocalTransport
1746
if a_bzrdir.has_branch():
1747
if (isinstance(to_transport, LocalTransport)
1748
and not a_bzrdir.has_workingtree()):
1749
raise errors.BranchExistsWithoutWorkingTree(location)
1750
raise errors.AlreadyBranchError(location)
1751
branch = a_bzrdir.create_branch()
1752
a_bzrdir.create_workingtree()
1753
if append_revisions_only:
1754
try:
1755
branch.set_append_revisions_only(True)
1756
except errors.UpgradeRequired:
1757
raise errors.BzrCommandError('This branch format cannot be set'
1758
' to append-revisions-only. Try --default.')
1759
if not is_quiet():
1760
from bzrlib.info import describe_layout, describe_format
1761
try:
1762
tree = a_bzrdir.open_workingtree(recommend_upgrade=False)
1763
except (errors.NoWorkingTree, errors.NotLocalUrl):
1764
tree = None
1765
repository = branch.repository
1766
layout = describe_layout(repository, branch, tree).lower()
1767
format = describe_format(a_bzrdir, repository, branch, tree)
1768
self.outf.write("Created a %s (format: %s)\n" % (layout, format))
1769
if repository.is_shared():
1770
#XXX: maybe this can be refactored into transport.path_or_url()
1771
url = repository.bzrdir.root_transport.external_url()
1772
try:
1773
url = urlutils.local_path_from_url(url)
1774
except errors.InvalidURL:
1775
pass
1776
self.outf.write("Using shared repository: %s\n" % url)
1021
if existing_bzrdir.has_branch():
1022
if existing_bzrdir.has_workingtree():
1023
raise errors.AlreadyBranchError(location)
1024
else:
1025
raise errors.BranchExistsWithoutWorkingTree(location)
1026
else:
1027
existing_bzrdir.create_branch()
1028
existing_bzrdir.create_workingtree()
1777
1029
1778
1030
1779
1031
class cmd_init_repository(Command):
1780
__doc__ = """Create a shared repository for branches to share storage space.
1781
1782
New branches created under the repository directory will store their
1783
revisions in the repository, not in the branch directory. For branches
1784
with shared history, this reduces the amount of storage needed and
1785
speeds up the creation of new branches.
1786
1787
If the --no-trees option is given then the branches in the repository
1788
will not have working trees by default. They will still exist as
1789
directories on disk, but they will not have separate copies of the
1790
files at a certain revision. This can be useful for repositories that
1791
store branches which are interacted with through checkouts or remote
1792
branches, such as on a server.
1793
1794
:Examples:
1795
Create a shared repository holding just branches::
1796
1797
bzr init-repo --no-trees repo
1798
bzr init repo/trunk
1799
1800
Make a lightweight checkout elsewhere::
1801
1802
bzr checkout --lightweight repo/trunk trunk-checkout
1803
cd trunk-checkout
1804
(add files here)
1032
"""Create a shared repository to hold branches.
1033
1034
New branches created under the repository directory will store their revisions
1035
in the repository, not in the branch directory, if the branch format supports
1036
shared storage.
1037
1038
example:
1039
bzr init-repo repo
1040
bzr init repo/trunk
1041
bzr checkout --lightweight repo/trunk trunk-checkout
1042
cd trunk-checkout
1043
(add files here)
1805
1044
"""
1806
1807
_see_also = ['init', 'branch', 'checkout', 'repositories']
1808
takes_args = ["location"]
1809
takes_options = [RegistryOption('format',
1810
help='Specify a format for this repository. See'
1811
' "bzr help formats" for details.',
1812
lazy_registry=('bzrlib.bzrdir', 'format_registry'),
1813
converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
1814
value_switches=True, title='Repository format'),
1815
Option('no-trees',
1816
help='Branches in the repository will default to'
1817
' not having a working tree.'),
1818
]
1045
takes_args = ["location"]
1046
takes_options = [Option('format',
1047
help='Specify a format for this repository.'
1048
' Current formats are: default, knit,'
1049
' metaweave and weave. Default is knit;'
1050
' metaweave and weave are deprecated',
1051
type=get_format_type),
1052
Option('trees',
1053
help='Allows branches in repository to have'
1054
' a working tree')]
1819
1055
aliases = ["init-repo"]
1820
1821
def run(self, location, format=None, no_trees=False):
1056
def run(self, location, format=None, trees=False):
1057
from bzrlib.transport import get_transport
1822
1058
if format is None:
1823
format = bzrdir.format_registry.make_bzrdir('default')
1824
1825
if location is None:
1826
location = '.'
1827
1828
to_transport = transport.get_transport(location)
1829
to_transport.ensure_base()
1830
1831
newdir = format.initialize_on_transport(to_transport)
1059
format = get_format_type('default')
1060
transport = get_transport(location)
1061
if not transport.has('.'):
1062
transport.mkdir('')
1063
newdir = format.initialize_on_transport(transport)
1832
1064
repo = newdir.create_repository(shared=True)
1833
repo.set_make_working_trees(not no_trees)
1834
if not is_quiet():
1835
from bzrlib.info import show_bzrdir_info
1836
show_bzrdir_info(repo.bzrdir, verbose=0, outfile=self.outf)
1065
repo.set_make_working_trees(trees)
1837
1066
1838
1067
1839
1068
class cmd_diff(Command):
1840
__doc__ = """Show differences in the working tree, between revisions or branches.
1841
1842
If no arguments are given, all changes for the current tree are listed.
1843
If files are given, only the changes in those files are listed.
1844
Remote and multiple branches can be compared by using the --old and
1845
--new options. If not provided, the default for both is derived from
1846
the first argument, if any, or the current tree if no arguments are
1847
given.
1069
"""Show differences in working tree.
1070
1071
If files are listed, only the changes in those files are listed.
1072
Otherwise, all changes for the tree are listed.
1848
1073
1849
1074
"bzr diff -p1" is equivalent to "bzr diff --prefix old/:new/", and
1850
1075
produces patches suitable for "patch -p1".
1851
1076
1852
:Exit values:
1853
1 - changed
1854
2 - unrepresentable changes
1855
3 - error
1856
0 - no change
1857
1858
:Examples:
1859
Shows the difference in the working tree versus the last commit::
1860
1861
bzr diff
1862
1863
Difference between the working tree and revision 1::
1864
1865
bzr diff -r1
1866
1867
Difference between revision 3 and revision 1::
1868
1869
bzr diff -r1..3
1870
1871
Difference between revision 3 and revision 1 for branch xxx::
1872
1873
bzr diff -r1..3 xxx
1874
1875
To see the changes introduced in revision X::
1876
1877
bzr diff -cX
1878
1879
Note that in the case of a merge, the -c option shows the changes
1880
compared to the left hand parent. To see the changes against
1881
another parent, use::
1882
1883
bzr diff -r<chosen_parent>..X
1884
1885
The changes introduced by revision 2 (equivalent to -r1..2)::
1886
1887
bzr diff -c2
1888
1889
Show just the differences for file NEWS::
1890
1891
bzr diff NEWS
1892
1893
Show the differences in working tree xxx for file NEWS::
1894
1895
bzr diff xxx/NEWS
1896
1897
Show the differences from branch xxx to this working tree:
1898
1899
bzr diff --old xxx
1900
1901
Show the differences between two branches for file NEWS::
1902
1903
bzr diff --old xxx --new yyy NEWS
1904
1905
Same as 'bzr diff' but prefix paths with old/ and new/::
1906
1907
bzr diff --prefix old/:new/
1077
examples:
1078
bzr diff
1079
bzr diff -r1
1080
bzr diff -r1..2
1081
bzr diff --diff-prefix old/:new/
1082
bzr diff bzr.mine bzr.dev
1083
bzr diff foo.c
1908
1084
"""
1909
_see_also = ['status']
1085
# TODO: Option to use external diff command; could be GNU diff, wdiff,
1086
# or a graphical diff.
1087
1088
# TODO: Python difflib is not exactly the same as unidiff; should
1089
# either fix it up or prefer to use an external diff.
1090
1091
# TODO: Selected-file diff is inefficient and doesn't show you
1092
# deleted files.
1093
1094
# TODO: This probably handles non-Unix newlines poorly.
1095
1910
1096
takes_args = ['file*']
1911
takes_options = [
1912
Option('diff-options', type=str,
1913
help='Pass these options to the external diff program.'),
1914
Option('prefix', type=str,
1915
short_name='p',
1916
help='Set prefixes added to old and new filenames, as '
1917
'two values separated by a colon. (eg "old/:new/").'),
1918
Option('old',
1919
help='Branch/tree to compare from.',
1920
type=unicode,
1921
),
1922
Option('new',
1923
help='Branch/tree to compare to.',
1924
type=unicode,
1925
),
1926
'revision',
1927
'change',
1928
Option('using',
1929
help='Use this command to compare files.',
1930
type=unicode,
1931
),
1932
RegistryOption('format',
1933
help='Diff format to use.',
1934
lazy_registry=('bzrlib.diff', 'format_registry'),
1935
value_switches=False, title='Diff format'),
1936
]
1097
takes_options = ['revision', 'diff-options', 'prefix']
1937
1098
aliases = ['di', 'dif']
1938
1099
encoding_type = 'exact'
1939
1100
1940
1101
@display_command
1941
1102
def run(self, revision=None, file_list=None, diff_options=None,
1942
prefix=None, old=None, new=None, using=None, format=None):
1943
from bzrlib.diff import (get_trees_and_branches_to_diff_locked,
1944
show_diff_trees)
1103
prefix=None):
1104
from bzrlib.diff import diff_cmd_helper, show_diff_trees
1945
1105
1946
1106
if (prefix is None) or (prefix == '0'):
1947
1107
# diff -p0 format
1950
1110
elif prefix == '1':
1951
1111
old_label = 'old/'
1952
1112
new_label = 'new/'
1953
elif ':' in prefix:
1113
else:
1114
if not ':' in prefix:
1115
raise BzrError("--diff-prefix expects two values separated by a colon")
1954
1116
old_label, new_label = prefix.split(":")
1117
1118
try:
1119
tree1, file_list = internal_tree_files(file_list)
1120
tree2 = None
1121
b = None
1122
b2 = None
1123
except FileInWrongBranch:
1124
if len(file_list) != 2:
1125
raise BzrCommandError("Files are in different branches")
1126
1127
tree1, file1 = WorkingTree.open_containing(file_list[0])
1128
tree2, file2 = WorkingTree.open_containing(file_list[1])
1129
if file1 != "" or file2 != "":
1130
# FIXME diff those two files. rbc 20051123
1131
raise BzrCommandError("Files are in different branches")
1132
file_list = None
1133
if revision is not None:
1134
if tree2 is not None:
1135
raise BzrCommandError("Can't specify -r with two branches")
1136
if (len(revision) == 1) or (revision[1].spec is None):
1137
return diff_cmd_helper(tree1, file_list, diff_options,
1138
revision[0],
1139
old_label=old_label, new_label=new_label)
1140
elif len(revision) == 2:
1141
return diff_cmd_helper(tree1, file_list, diff_options,
1142
revision[0], revision[1],
1143
old_label=old_label, new_label=new_label)
1144
else:
1145
raise BzrCommandError('bzr diff --revision takes exactly one or two revision identifiers')
1955
1146
else:
1956
raise errors.BzrCommandError(
1957
'--prefix expects two values separated by a colon'
1958
' (eg "old/:new/")')
1959
1960
if revision and len(revision) > 2:
1961
raise errors.BzrCommandError('bzr diff --revision takes exactly'
1962
' one or two revision specifiers')
1963
1964
if using is not None and format is not None:
1965
raise errors.BzrCommandError('--using and --format are mutually '
1966
'exclusive.')
1967
1968
(old_tree, new_tree,
1969
old_branch, new_branch,
1970
specific_files, extra_trees) = get_trees_and_branches_to_diff_locked(
1971
file_list, revision, old, new, self.add_cleanup, apply_view=True)
1972
return show_diff_trees(old_tree, new_tree, sys.stdout,
1973
specific_files=specific_files,
1974
external_diff_options=diff_options,
1975
old_label=old_label, new_label=new_label,
1976
extra_trees=extra_trees, using=using,
1977
format_cls=format)
1147
if tree2 is not None:
1148
return show_diff_trees(tree1, tree2, sys.stdout,
1149
specific_files=file_list,
1150
external_diff_options=diff_options,
1151
old_label=old_label, new_label=new_label)
1152
else:
1153
return diff_cmd_helper(tree1, file_list, diff_options,
1154
old_label=old_label, new_label=new_label)
1978
1155
1979
1156
1980
1157
class cmd_deleted(Command):
1981
__doc__ = """List files deleted in the working tree.
1158
"""List files deleted in the working tree.
1982
1159
"""
1983
1160
# TODO: Show files deleted since a previous revision, or
1984
1161
# between two revisions.
1986
1163
# directories with readdir, rather than stating each one. Same
1987
1164
# level of effort but possibly much less IO. (Or possibly not,
1988
1165
# if the directories are very large...)
1989
_see_also = ['status', 'ls']
1990
1166
takes_options = ['show-ids']
1991
1167
1992
1168
@display_command
1993
1169
def run(self, show_ids=False):
1994
1170
tree = WorkingTree.open_containing(u'.')[0]
1995
self.add_cleanup(tree.lock_read().unlock)
1996
1171
old = tree.basis_tree()
1997
self.add_cleanup(old.lock_read().unlock)
1998
1172
for path, ie in old.inventory.iter_entries():
1999
1173
if not tree.has_id(ie.file_id):
2000
1174
self.outf.write(path)
2005
1179
2006
1180
2007
1181
class cmd_modified(Command):
2008
__doc__ = """List files modified in working tree.
2009
"""
2010
1182
"""List files modified in working tree."""
2011
1183
hidden = True
2012
_see_also = ['status', 'ls']
2013
takes_options = [
2014
Option('null',
2015
help='Write an ascii NUL (\\0) separator '
2016
'between files rather than a newline.')
2017
]
2018
2019
1184
@display_command
2020
def run(self, null=False):
1185
def run(self):
1186
from bzrlib.delta import compare_trees
1187
2021
1188
tree = WorkingTree.open_containing(u'.')[0]
2022
td = tree.changes_from(tree.basis_tree())
1189
td = compare_trees(tree.basis_tree(), tree)
1190
2023
1191
for path, id, kind, text_modified, meta_modified in td.modified:
2024
if null:
2025
self.outf.write(path + '\0')
2026
else:
2027
self.outf.write(osutils.quotefn(path) + '\n')
1192
self.outf.write(path + '\n')
2028
1193
2029
1194
2030
1195
class cmd_added(Command):
2031
__doc__ = """List files added in working tree.
2032
"""
2033
1196
"""List files added in working tree."""
2034
1197
hidden = True
2035
_see_also = ['status', 'ls']
2036
takes_options = [
2037
Option('null',
2038
help='Write an ascii NUL (\\0) separator '
2039
'between files rather than a newline.')
2040
]
2041
2042
1198
@display_command
2043
def run(self, null=False):
1199
def run(self):
2044
1200
wt = WorkingTree.open_containing(u'.')[0]
2045
self.add_cleanup(wt.lock_read().unlock)
2046
basis = wt.basis_tree()
2047
self.add_cleanup(basis.lock_read().unlock)
2048
basis_inv = basis.inventory
1201
basis_inv = wt.basis_tree().inventory
2049
1202
inv = wt.inventory
2050
1203
for file_id in inv:
2051
1204
if file_id in basis_inv:
2052
1205
continue
2053
if inv.is_root(file_id) and len(basis_inv) == 0:
2054
continue
2055
1206
path = inv.id2path(file_id)
2056
if not os.access(osutils.abspath(path), os.F_OK):
1207
if not os.access(bzrlib.osutils.abspath(path), os.F_OK):
2057
1208
continue
2058
if null:
2059
self.outf.write(path + '\0')
2060
else:
2061
self.outf.write(osutils.quotefn(path) + '\n')
1209
self.outf.write(path + '\n')
2062
1210
2063
1211
2064
1212
class cmd_root(Command):
2065
__doc__ = """Show the tree root directory.
1213
"""Show the tree root directory.
2066
1214
2067
1215
The root is the nearest enclosing directory with a .bzr control
2068
1216
directory."""
2069
2070
1217
takes_args = ['filename?']
2071
1218
@display_command
2072
1219
def run(self, filename=None):
2075
1222
self.outf.write(tree.basedir + '\n')
2076
1223
2077
1224
2078
def _parse_limit(limitstring):
2079
try:
2080
return int(limitstring)
2081
except ValueError:
2082
msg = "The limit argument must be an integer."
2083
raise errors.BzrCommandError(msg)
2084
2085
2086
def _parse_levels(s):
2087
try:
2088
return int(s)
2089
except ValueError:
2090
msg = "The levels argument must be an integer."
2091
raise errors.BzrCommandError(msg)
2092
2093
2094
1225
class cmd_log(Command):
2095
__doc__ = """Show historical log for a branch or subset of a branch.
2096
2097
log is bzr's default tool for exploring the history of a branch.
2098
The branch to use is taken from the first parameter. If no parameters
2099
are given, the branch containing the working directory is logged.
2100
Here are some simple examples::
2101
2102
bzr log log the current branch
2103
bzr log foo.py log a file in its branch
2104
bzr log http://server/branch log a branch on a server
2105
2106
The filtering, ordering and information shown for each revision can
2107
be controlled as explained below. By default, all revisions are
2108
shown sorted (topologically) so that newer revisions appear before
2109
older ones and descendants always appear before ancestors. If displayed,
2110
merged revisions are shown indented under the revision in which they
2111
were merged.
2112
2113
:Output control:
2114
2115
The log format controls how information about each revision is
2116
displayed. The standard log formats are called ``long``, ``short``
2117
and ``line``. The default is long. See ``bzr help log-formats``
2118
for more details on log formats.
2119
2120
The following options can be used to control what information is
2121
displayed::
2122
2123
-l N display a maximum of N revisions
2124
-n N display N levels of revisions (0 for all, 1 for collapsed)
2125
-v display a status summary (delta) for each revision
2126
-p display a diff (patch) for each revision
2127
--show-ids display revision-ids (and file-ids), not just revnos
2128
2129
Note that the default number of levels to display is a function of the
2130
log format. If the -n option is not used, the standard log formats show
2131
just the top level (mainline).
2132
2133
Status summaries are shown using status flags like A, M, etc. To see
2134
the changes explained using words like ``added`` and ``modified``
2135
instead, use the -vv option.
2136
2137
:Ordering control:
2138
2139
To display revisions from oldest to newest, use the --forward option.
2140
In most cases, using this option will have little impact on the total
2141
time taken to produce a log, though --forward does not incrementally
2142
display revisions like --reverse does when it can.
2143
2144
:Revision filtering:
2145
2146
The -r option can be used to specify what revision or range of revisions
2147
to filter against. The various forms are shown below::
2148
2149
-rX display revision X
2150
-rX.. display revision X and later
2151
-r..Y display up to and including revision Y
2152
-rX..Y display from X to Y inclusive
2153
2154
See ``bzr help revisionspec`` for details on how to specify X and Y.
2155
Some common examples are given below::
2156
2157
-r-1 show just the tip
2158
-r-10.. show the last 10 mainline revisions
2159
-rsubmit:.. show what's new on this branch
2160
-rancestor:path.. show changes since the common ancestor of this
2161
branch and the one at location path
2162
-rdate:yesterday.. show changes since yesterday
2163
2164
When logging a range of revisions using -rX..Y, log starts at
2165
revision Y and searches back in history through the primary
2166
("left-hand") parents until it finds X. When logging just the
2167
top level (using -n1), an error is reported if X is not found
2168
along the way. If multi-level logging is used (-n0), X may be
2169
a nested merge revision and the log will be truncated accordingly.
2170
2171
:Path filtering:
2172
2173
If parameters are given and the first one is not a branch, the log
2174
will be filtered to show only those revisions that changed the
2175
nominated files or directories.
2176
2177
Filenames are interpreted within their historical context. To log a
2178
deleted file, specify a revision range so that the file existed at
2179
the end or start of the range.
2180
2181
Historical context is also important when interpreting pathnames of
2182
renamed files/directories. Consider the following example:
2183
2184
* revision 1: add tutorial.txt
2185
* revision 2: modify tutorial.txt
2186
* revision 3: rename tutorial.txt to guide.txt; add tutorial.txt
2187
2188
In this case:
2189
2190
* ``bzr log guide.txt`` will log the file added in revision 1
2191
2192
* ``bzr log tutorial.txt`` will log the new file added in revision 3
2193
2194
* ``bzr log -r2 -p tutorial.txt`` will show the changes made to
2195
the original file in revision 2.
2196
2197
* ``bzr log -r2 -p guide.txt`` will display an error message as there
2198
was no file called guide.txt in revision 2.
2199
2200
Renames are always followed by log. By design, there is no need to
2201
explicitly ask for this (and no way to stop logging a file back
2202
until it was last renamed).
2203
2204
:Other filtering:
2205
2206
The --message option can be used for finding revisions that match a
2207
regular expression in a commit message.
2208
2209
:Tips & tricks:
2210
2211
GUI tools and IDEs are often better at exploring history than command
2212
line tools: you may prefer qlog or viz from qbzr or bzr-gtk, the
2213
bzr-explorer shell, or the Loggerhead web interface. See the Plugin
2214
Guide <http://doc.bazaar.canonical.com/plugins/en/> and
2215
<http://wiki.bazaar.canonical.com/IDEIntegration>.
2216
2217
You may find it useful to add the aliases below to ``bazaar.conf``::
2218
2219
[ALIASES]
2220
tip = log -r-1
2221
top = log -l10 --line
2222
show = log -v -p
2223
2224
``bzr tip`` will then show the latest revision while ``bzr top``
2225
will show the last 10 mainline revisions. To see the details of a
2226
particular revision X, ``bzr show -rX``.
2227
2228
If you are interested in looking deeper into a particular merge X,
2229
use ``bzr log -n0 -rX``.
2230
2231
``bzr log -v`` on a branch with lots of history is currently
2232
very slow. A fix for this issue is currently under development.
2233
With or without that fix, it is recommended that a revision range
2234
be given when using the -v option.
2235
2236
bzr has a generic full-text matching plugin, bzr-search, that can be
2237
used to find revisions matching user names, commit messages, etc.
2238
Among other features, this plugin can find all revisions containing
2239
a list of words but not others.
2240
2241
When exploring non-mainline history on large projects with deep
2242
history, the performance of log can be greatly improved by installing
2243
the historycache plugin. This plugin buffers historical information
2244
trading disk space for faster speed.
1226
"""Show log of a branch, file, or directory.
1227
1228
By default show the log of the branch containing the working directory.
1229
1230
To request a range of logs, you can use the command -r begin..end
1231
-r revision requests a specific revision, -r ..end or -r begin.. are
1232
also valid.
1233
1234
examples:
1235
bzr log
1236
bzr log foo.c
1237
bzr log -r -10.. http://server/branch
2245
1238
"""
2246
takes_args = ['file*']
2247
_see_also = ['log-formats', 'revisionspec']
2248
takes_options = [
2249
Option('forward',
2250
help='Show from oldest to newest.'),
2251
'timezone',
2252
custom_help('verbose',
2253
help='Show files changed in each revision.'),
2254
'show-ids',
2255
'revision',
2256
Option('change',
2257
type=bzrlib.option._parse_revision_str,
2258
short_name='c',
2259
help='Show just the specified revision.'
2260
' See also "help revisionspec".'),
2261
'log-format',
2262
Option('levels',
2263
short_name='n',
2264
help='Number of levels to display - 0 for all, 1 for flat.',
2265
argname='N',
2266
type=_parse_levels),
2267
Option('message',
2268
short_name='m',
2269
help='Show revisions whose message matches this '
2270
'regular expression.',
2271
type=str),
2272
Option('limit',
2273
short_name='l',
2274
help='Limit the output to the first N revisions.',
2275
argname='N',
2276
type=_parse_limit),
2277
Option('show-diff',
2278
short_name='p',
2279
help='Show changes made in each revision as a patch.'),
2280
Option('include-merges',
2281
help='Show merged revisions like --levels 0 does.'),
2282
Option('exclude-common-ancestry',
2283
help='Display only the revisions that are not part'
2284
' of both ancestries (require -rX..Y)'
2285
)
2286
]
1239
1240
# TODO: Make --revision support uuid: and hash: [future tag:] notation.
1241
1242
takes_args = ['location?']
1243
takes_options = [Option('forward',
1244
help='show from oldest to newest'),
1245
'timezone',
1246
Option('verbose',
1247
help='show files changed in each revision'),
1248
'show-ids', 'revision',
1249
'log-format',
1250
'line', 'long',
1251
Option('message',
1252
help='show revisions whose message matches this regexp',
1253
type=str),
1254
'short',
1255
]
2287
1256
encoding_type = 'replace'
2288
1257
2289
1258
@display_command
2290
def run(self, file_list=None, timezone='original',
1259
def run(self, location=None, timezone='original',
2291
1260
verbose=False,
2292
1261
show_ids=False,
2293
1262
forward=False,
2294
1263
revision=None,
2295
change=None,
2296
1264
log_format=None,
2297
levels=None,
2298
1265
message=None,
2299
limit=None,
2300
show_diff=False,
2301
include_merges=False,
2302
exclude_common_ancestry=False,
2303
):
2304
from bzrlib.log import (
2305
Logger,
2306
make_log_request_dict,
2307
_get_info_for_log_files,
2308
)
1266
long=False,
1267
short=False,
1268
line=False):
1269
from bzrlib.log import log_formatter, show_log
1270
assert message is None or isinstance(message, basestring), \
1271
"invalid message argument %r" % message
2309
1272
direction = (forward and 'forward') or 'reverse'
2310
if (exclude_common_ancestry
2311
and (revision is None or len(revision) != 2)):
2312
raise errors.BzrCommandError(
2313
'--exclude-common-ancestry requires -r with two revisions')
2314
if include_merges:
2315
if levels is None:
2316
levels = 0
2317
else:
2318
raise errors.BzrCommandError(
2319
'--levels and --include-merges are mutually exclusive')
2320
2321
if change is not None:
2322
if len(change) > 1:
2323
raise errors.RangeInChangeOption()
2324
if revision is not None:
2325
raise errors.BzrCommandError(
2326
'--revision and --change are mutually exclusive')
2327
else:
2328
revision = change
2329
2330
file_ids = []
2331
filter_by_dir = False
2332
if file_list:
2333
# find the file ids to log and check for directory filtering
2334
b, file_info_list, rev1, rev2 = _get_info_for_log_files(
2335
revision, file_list, self.add_cleanup)
2336
for relpath, file_id, kind in file_info_list:
2337
if file_id is None:
2338
raise errors.BzrCommandError(
2339
"Path unknown at end or start of revision range: %s" %
2340
relpath)
2341
# If the relpath is the top of the tree, we log everything
2342
if relpath == '':
2343
file_ids = []
2344
break
2345
else:
2346
file_ids.append(file_id)
2347
filter_by_dir = filter_by_dir or (
2348
kind in ['directory', 'tree-reference'])
2349
else:
2350
# log everything
2351
# FIXME ? log the current subdir only RBC 20060203
2352
if revision is not None \
2353
and len(revision) > 0 and revision[0].get_branch():
2354
location = revision[0].get_branch()
2355
else:
2356
location = '.'
2357
dir, relpath = bzrdir.BzrDir.open_containing(location)
2358
b = dir.open_branch()
2359
self.add_cleanup(b.lock_read().unlock)
2360
rev1, rev2 = _get_revision_range(revision, b, self.name())
2361
2362
# Decide on the type of delta & diff filtering to use
2363
# TODO: add an --all-files option to make this configurable & consistent
2364
if not verbose:
2365
delta_type = None
2366
else:
2367
delta_type = 'full'
2368
if not show_diff:
2369
diff_type = None
2370
elif file_ids:
2371
diff_type = 'partial'
2372
else:
2373
diff_type = 'full'
2374
2375
# Build the log formatter
2376
if log_format is None:
2377
log_format = log.log_formatter_registry.get_default(b)
2378
# Make a non-encoding output to include the diffs - bug 328007
2379
unencoded_output = ui.ui_factory.make_output_stream(encoding_type='exact')
2380
lf = log_format(show_ids=show_ids, to_file=self.outf,
2381
to_exact_file=unencoded_output,
2382
show_timezone=timezone,
2383
delta_format=get_verbosity_level(),
2384
levels=levels,
2385
show_advice=levels is None)
2386
2387
# Choose the algorithm for doing the logging. It's annoying
2388
# having multiple code paths like this but necessary until
2389
# the underlying repository format is faster at generating
2390
# deltas or can provide everything we need from the indices.
2391
# The default algorithm - match-using-deltas - works for
2392
# multiple files and directories and is faster for small
2393
# amounts of history (200 revisions say). However, it's too
2394
# slow for logging a single file in a repository with deep
2395
# history, i.e. > 10K revisions. In the spirit of "do no
2396
# evil when adding features", we continue to use the
2397
# original algorithm - per-file-graph - for the "single
2398
# file that isn't a directory without showing a delta" case.
2399
partial_history = revision and b.repository._format.supports_chks
2400
match_using_deltas = (len(file_ids) != 1 or filter_by_dir
2401
or delta_type or partial_history)
2402
2403
# Build the LogRequest and execute it
2404
if len(file_ids) == 0:
2405
file_ids = None
2406
rqst = make_log_request_dict(
2407
direction=direction, specific_fileids=file_ids,
2408
start_revision=rev1, end_revision=rev2, limit=limit,
2409
message_search=message, delta_type=delta_type,
2410
diff_type=diff_type, _match_using_deltas=match_using_deltas,
2411
exclude_common_ancestry=exclude_common_ancestry,
2412
)
2413
Logger(b, rqst).show(lf)
2414
2415
2416
def _get_revision_range(revisionspec_list, branch, command_name):
2417
"""Take the input of a revision option and turn it into a revision range.
2418
2419
It returns RevisionInfo objects which can be used to obtain the rev_id's
2420
of the desired revisions. It does some user input validations.
2421
"""
2422
if revisionspec_list is None:
2423
rev1 = None
2424
rev2 = None
2425
elif len(revisionspec_list) == 1:
2426
rev1 = rev2 = revisionspec_list[0].in_history(branch)
2427
elif len(revisionspec_list) == 2:
2428
start_spec = revisionspec_list[0]
2429
end_spec = revisionspec_list[1]
2430
if end_spec.get_branch() != start_spec.get_branch():
2431
# b is taken from revision[0].get_branch(), and
2432
# show_log will use its revision_history. Having
2433
# different branches will lead to weird behaviors.
2434
raise errors.BzrCommandError(
2435
"bzr %s doesn't accept two revisions in different"
2436
" branches." % command_name)
2437
if start_spec.spec is None:
2438
# Avoid loading all the history.
2439
rev1 = RevisionInfo(branch, None, None)
2440
else:
2441
rev1 = start_spec.in_history(branch)
2442
# Avoid loading all of history when we know a missing
2443
# end of range means the last revision ...
2444
if end_spec.spec is None:
2445
last_revno, last_revision_id = branch.last_revision_info()
2446
rev2 = RevisionInfo(branch, last_revno, last_revision_id)
2447
else:
2448
rev2 = end_spec.in_history(branch)
2449
else:
2450
raise errors.BzrCommandError(
2451
'bzr %s --revision takes one or two values.' % command_name)
2452
return rev1, rev2
2453
2454
2455
def _revision_range_to_revid_range(revision_range):
2456
rev_id1 = None
2457
rev_id2 = None
2458
if revision_range[0] is not None:
2459
rev_id1 = revision_range[0].rev_id
2460
if revision_range[1] is not None:
2461
rev_id2 = revision_range[1].rev_id
2462
return rev_id1, rev_id2
1273
1274
# log everything
1275
file_id = None
1276
if location:
1277
# find the file id to log:
1278
1279
dir, fp = bzrdir.BzrDir.open_containing(location)
1280
b = dir.open_branch()
1281
if fp != '':
1282
try:
1283
# might be a tree:
1284
inv = dir.open_workingtree().inventory
1285
except (errors.NotBranchError, errors.NotLocalUrl):
1286
# either no tree, or is remote.
1287
inv = b.basis_tree().inventory
1288
file_id = inv.path2id(fp)
1289
else:
1290
# local dir only
1291
# FIXME ? log the current subdir only RBC 20060203
1292
dir, relpath = bzrdir.BzrDir.open_containing('.')
1293
b = dir.open_branch()
1294
1295
if revision is None:
1296
rev1 = None
1297
rev2 = None
1298
elif len(revision) == 1:
1299
rev1 = rev2 = revision[0].in_history(b).revno
1300
elif len(revision) == 2:
1301
if revision[0].spec is None:
1302
# missing begin-range means first revision
1303
rev1 = 1
1304
else:
1305
rev1 = revision[0].in_history(b).revno
1306
1307
if revision[1].spec is None:
1308
# missing end-range means last known revision
1309
rev2 = b.revno()
1310
else:
1311
rev2 = revision[1].in_history(b).revno
1312
else:
1313
raise BzrCommandError('bzr log --revision takes one or two values.')
1314
1315
# By this point, the revision numbers are converted to the +ve
1316
# form if they were supplied in the -ve form, so we can do
1317
# this comparison in relative safety
1318
if rev1 > rev2:
1319
(rev2, rev1) = (rev1, rev2)
1320
1321
if (log_format == None):
1322
default = bzrlib.config.BranchConfig(b).log_format()
1323
log_format = get_log_format(long=long, short=short, line=line, default=default)
1324
lf = log_formatter(log_format,
1325
show_ids=show_ids,
1326
to_file=self.outf,
1327
show_timezone=timezone)
1328
1329
show_log(b,
1330
lf,
1331
file_id,
1332
verbose=verbose,
1333
direction=direction,
1334
start_revision=rev1,
1335
end_revision=rev2,
1336
search=message)
1337
2463
1338
2464
1339
def get_log_format(long=False, short=False, line=False, default='long'):
2465
1340
log_format = default
2473
1348
2474
1349
2475
1350
class cmd_touching_revisions(Command):
2476
__doc__ = """Return revision-ids which affected a particular file.
1351
"""Return revision-ids which affected a particular file.
2477
1352
2478
1353
A more user-friendly interface is "bzr log FILE".
2479
1354
"""
2484
1359
@display_command
2485
1360
def run(self, filename):
2486
1361
tree, relpath = WorkingTree.open_containing(filename)
2487
file_id = tree.path2id(relpath)
2488
1362
b = tree.branch
2489
self.add_cleanup(b.lock_read().unlock)
2490
touching_revs = log.find_touching_revisions(b, file_id)
2491
for revno, revision_id, what in touching_revs:
1363
inv = tree.read_working_inventory()
1364
file_id = inv.path2id(relpath)
1365
for revno, revision_id, what in bzrlib.log.find_touching_revisions(b, file_id):
2492
1366
self.outf.write("%6d %s\n" % (revno, what))
2493
1367
2494
1368
2495
1369
class cmd_ls(Command):
2496
__doc__ = """List files in a tree.
1370
"""List files in a tree.
2497
1371
"""
1372
# TODO: Take a revision or remote path and list that tree instead.
1373
hidden = True
1374
takes_options = ['verbose', 'revision',
1375
Option('non-recursive',
1376
help='don\'t recurse into sub-directories'),
1377
Option('from-root',
1378
help='Print all paths from the root of the branch.'),
1379
Option('unknown', help='Print unknown files'),
1380
Option('versioned', help='Print versioned files'),
1381
Option('ignored', help='Print ignored files'),
2498
1382
2499
_see_also = ['status', 'cat']
2500
takes_args = ['path?']
2501
takes_options = [
2502
'verbose',
2503
'revision',
2504
Option('recursive', short_name='R',
2505
help='Recurse into subdirectories.'),
2506
Option('from-root',
2507
help='Print paths relative to the root of the branch.'),
2508
Option('unknown', help='Print unknown files.'),
2509
Option('versioned', help='Print versioned files.',
2510
short_name='V'),
2511
Option('ignored', help='Print ignored files.'),
2512
Option('null',
2513
help='Write an ascii NUL (\\0) separator '
2514
'between files rather than a newline.'),
2515
Option('kind',
2516
help='List entries of a particular kind: file, directory, symlink.',
2517
type=unicode),
2518
'show-ids',
2519
]
1383
Option('null', help='Null separate the files'),
1384
]
2520
1385
@display_command
2521
def run(self, revision=None, verbose=False,
2522
recursive=False, from_root=False,
1386
def run(self, revision=None, verbose=False,
1387
non_recursive=False, from_root=False,
2523
1388
unknown=False, versioned=False, ignored=False,
2524
null=False, kind=None, show_ids=False, path=None):
2525
2526
if kind and kind not in ('file', 'directory', 'symlink'):
2527
raise errors.BzrCommandError('invalid kind specified')
1389
null=False):
2528
1390
2529
1391
if verbose and null:
2530
raise errors.BzrCommandError('Cannot set both --verbose and --null')
1392
raise BzrCommandError('Cannot set both --verbose and --null')
2531
1393
all = not (unknown or versioned or ignored)
2532
1394
2533
1395
selection = {'I':ignored, '?':unknown, 'V':versioned}
2534
1396
2535
if path is None:
2536
fs_path = '.'
2537
else:
2538
if from_root:
2539
raise errors.BzrCommandError('cannot specify both --from-root'
2540
' and PATH')
2541
fs_path = path
2542
tree, branch, relpath = bzrdir.BzrDir.open_containing_tree_or_branch(
2543
fs_path)
2544
2545
# Calculate the prefix to use
2546
prefix = None
1397
tree, relpath = WorkingTree.open_containing(u'.')
2547
1398
if from_root:
2548
if relpath:
2549
prefix = relpath + '/'
2550
elif fs_path != '.' and not fs_path.endswith('/'):
2551
prefix = fs_path + '/'
2552
2553
if revision is not None or tree is None:
2554
tree = _get_one_revision_tree('ls', revision, branch=branch)
2555
2556
apply_view = False
2557
if isinstance(tree, WorkingTree) and tree.supports_views():
2558
view_files = tree.views.lookup_view()
2559
if view_files:
2560
apply_view = True
2561
view_str = views.view_display_str(view_files)
2562
note("Ignoring files outside view. View is %s" % view_str)
2563
2564
self.add_cleanup(tree.lock_read().unlock)
2565
for fp, fc, fkind, fid, entry in tree.list_files(include_root=False,
2566
from_dir=relpath, recursive=recursive):
2567
# Apply additional masking
2568
if not all and not selection[fc]:
2569
continue
2570
if kind is not None and fkind != kind:
2571
continue
2572
if apply_view:
2573
try:
2574
if relpath:
2575
fullpath = osutils.pathjoin(relpath, fp)
2576
else:
2577
fullpath = fp
2578
views.check_path_in_view(tree, fullpath)
2579
except errors.FileOutsideView:
2580
continue
2581
2582
# Output the entry
2583
if prefix:
2584
fp = osutils.pathjoin(prefix, fp)
2585
kindch = entry.kind_character()
2586
outstring = fp + kindch
2587
ui.ui_factory.clear_term()
2588
if verbose:
2589
outstring = '%-8s %s' % (fc, outstring)
2590
if show_ids and fid is not None:
2591
outstring = "%-50s %s" % (outstring, fid)
2592
self.outf.write(outstring + '\n')
2593
elif null:
2594
self.outf.write(fp + '\0')
2595
if show_ids:
2596
if fid is not None:
2597
self.outf.write(fid)
2598
self.outf.write('\0')
2599
self.outf.flush()
2600
else:
2601
if show_ids:
2602
if fid is not None:
2603
my_id = fid
2604
else:
2605
my_id = ''
2606
self.outf.write('%-50s %s\n' % (outstring, my_id))
1399
relpath = u''
1400
elif relpath:
1401
relpath += '/'
1402
if revision is not None:
1403
tree = tree.branch.repository.revision_tree(
1404
revision[0].in_history(tree.branch).rev_id)
1405
1406
for fp, fc, kind, fid, entry in tree.list_files():
1407
if fp.startswith(relpath):
1408
fp = fp[len(relpath):]
1409
if non_recursive and '/' in fp:
1410
continue
1411
if not all and not selection[fc]:
1412
continue
1413
if verbose:
1414
kindch = entry.kind_character()
1415
self.outf.write('%-8s %s%s\n' % (fc, fp, kindch))
1416
elif null:
1417
self.outf.write(fp + '\0')
1418
self.outf.flush()
2607
1419
else:
2608
self.outf.write(outstring + '\n')
1420
self.outf.write(fp + '\n')
2609
1421
2610
1422
2611
1423
class cmd_unknowns(Command):
2612
__doc__ = """List unknown files.
2613
"""
2614
2615
hidden = True
2616
_see_also = ['ls']
2617
1424
"""List unknown files."""
2618
1425
@display_command
2619
1426
def run(self):
1427
from bzrlib.osutils import quotefn
2620
1428
for f in WorkingTree.open_containing(u'.')[0].unknowns():
2621
self.outf.write(osutils.quotefn(f) + '\n')
1429
self.outf.write(quotefn(f) + '\n')
2622
1430
2623
1431
2624
1432
class cmd_ignore(Command):
2625
__doc__ = """Ignore specified files or patterns.
2626
2627
See ``bzr help patterns`` for details on the syntax of patterns.
2628
2629
If a .bzrignore file does not exist, the ignore command
2630
will create one and add the specified files or patterns to the newly
2631
created file. The ignore command will also automatically add the
2632
.bzrignore file to be versioned. Creating a .bzrignore file without
2633
the use of the ignore command will require an explicit add command.
1433
"""Ignore a command or pattern.
2634
1434
2635
1435
To remove patterns from the ignore list, edit the .bzrignore file.
2636
After adding, editing or deleting that file either indirectly by
2637
using this command or directly by using an editor, be sure to commit
2638
it.
2639
2640
Bazaar also supports a global ignore file ~/.bazaar/ignore. On Windows
2641
the global ignore file can be found in the application data directory as
2642
C:\\Documents and Settings\\<user>\\Application Data\\Bazaar\\2.0\\ignore.
2643
Global ignores are not touched by this command. The global ignore file
2644
can be edited directly using an editor.
2645
2646
Patterns prefixed with '!' are exceptions to ignore patterns and take
2647
precedence over regular ignores. Such exceptions are used to specify
2648
files that should be versioned which would otherwise be ignored.
2649
2650
Patterns prefixed with '!!' act as regular ignore patterns, but have
2651
precedence over the '!' exception patterns.
2652
2653
Note: ignore patterns containing shell wildcards must be quoted from
2654
the shell on Unix.
2655
2656
:Examples:
2657
Ignore the top level Makefile::
2658
2659
bzr ignore ./Makefile
2660
2661
Ignore .class files in all directories...::
2662
2663
bzr ignore "*.class"
2664
2665
...but do not ignore "special.class"::
2666
2667
bzr ignore "!special.class"
2668
2669
Ignore .o files under the lib directory::
2670
2671
bzr ignore "lib/**/*.o"
2672
2673
Ignore .o files under the lib directory::
2674
2675
bzr ignore "RE:lib/.*\.o"
2676
2677
Ignore everything but the "debian" toplevel directory::
2678
2679
bzr ignore "RE:(?!debian/).*"
2680
2681
Ignore everything except the "local" toplevel directory,
2682
but always ignore "*~" autosave files, even under local/::
2683
2684
bzr ignore "*"
2685
bzr ignore "!./local"
2686
bzr ignore "!!*~"
1436
1437
If the pattern contains a slash, it is compared to the whole path
1438
from the branch root. Otherwise, it is compared to only the last
1439
component of the path. To match a file only in the root directory,
1440
prepend './'.
1441
1442
Ignore patterns are case-insensitive on case-insensitive systems.
1443
1444
Note: wildcards must be quoted from the shell on Unix.
1445
1446
examples:
1447
bzr ignore ./Makefile
1448
bzr ignore '*.class'
2687
1449
"""
2688
2689
_see_also = ['status', 'ignored', 'patterns']
2690
takes_args = ['name_pattern*']
2691
takes_options = [
2692
Option('default-rules',
2693
help='Display the default ignore rules that bzr uses.')
2694
]
2695
2696
def run(self, name_pattern_list=None, default_rules=None):
2697
from bzrlib import ignores
2698
if default_rules is not None:
2699
# dump the default rules and exit
2700
for pattern in ignores.USER_DEFAULTS:
2701
self.outf.write("%s\n" % pattern)
2702
return
2703
if not name_pattern_list:
2704
raise errors.BzrCommandError("ignore requires at least one "
2705
"NAME_PATTERN or --default-rules.")
2706
name_pattern_list = [globbing.normalize_pattern(p)
2707
for p in name_pattern_list]
2708
for name_pattern in name_pattern_list:
2709
if (name_pattern[0] == '/' or
2710
(len(name_pattern) > 1 and name_pattern[1] == ':')):
2711
raise errors.BzrCommandError(
2712
"NAME_PATTERN should not be an absolute path")
1450
# TODO: Complain if the filename is absolute
1451
takes_args = ['name_pattern']
1452
1453
def run(self, name_pattern):
1454
from bzrlib.atomicfile import AtomicFile
1455
import os.path
1456
2713
1457
tree, relpath = WorkingTree.open_containing(u'.')
2714
ignores.tree_ignores_add_patterns(tree, name_pattern_list)
2715
ignored = globbing.Globster(name_pattern_list)
2716
matches = []
2717
tree.lock_read()
2718
for entry in tree.list_files():
2719
id = entry[3]
2720
if id is not None:
2721
filename = entry[0]
2722
if ignored.match(filename):
2723
matches.append(filename)
2724
tree.unlock()
2725
if len(matches) > 0:
2726
self.outf.write("Warning: the following files are version controlled and"
2727
" match your ignore pattern:\n%s"
2728
"\nThese files will continue to be version controlled"
2729
" unless you 'bzr remove' them.\n" % ("\n".join(matches),))
1458
ifn = tree.abspath('.bzrignore')
1459
1460
if os.path.exists(ifn):
1461
f = open(ifn, 'rt')
1462
try:
1463
igns = f.read().decode('utf-8')
1464
finally:
1465
f.close()
1466
else:
1467
igns = ''
1468
1469
# TODO: If the file already uses crlf-style termination, maybe
1470
# we should use that for the newly added lines?
1471
1472
if igns and igns[-1] != '\n':
1473
igns += '\n'
1474
igns += name_pattern + '\n'
1475
1476
f = AtomicFile(ifn, 'wt')
1477
try:
1478
f.write(igns.encode('utf-8'))
1479
f.commit()
1480
finally:
1481
f.close()
1482
1483
inv = tree.inventory
1484
if inv.path2id('.bzrignore'):
1485
mutter('.bzrignore is already versioned')
1486
else:
1487
mutter('need to make new .bzrignore file versioned')
1488
tree.add(['.bzrignore'])
2730
1489
2731
1490
2732
1491
class cmd_ignored(Command):
2733
__doc__ = """List ignored files and the patterns that matched them.
2734
2735
List all the ignored files and the ignore pattern that caused the file to
2736
be ignored.
2737
2738
Alternatively, to list just the files::
2739
2740
bzr ls --ignored
2741
"""
2742
2743
encoding_type = 'replace'
2744
_see_also = ['ignore', 'ls']
2745
1492
"""List ignored files and the patterns that matched them.
1493
1494
See also: bzr ignore"""
2746
1495
@display_command
2747
1496
def run(self):
2748
1497
tree = WorkingTree.open_containing(u'.')[0]
2749
self.add_cleanup(tree.lock_read().unlock)
2750
1498
for path, file_class, kind, file_id, entry in tree.list_files():
2751
1499
if file_class != 'I':
2752
1500
continue
2753
1501
## XXX: Slightly inefficient since this was already calculated
2754
1502
pat = tree.is_ignored(path)
2755
self.outf.write('%-50s %s\n' % (path, pat))
1503
print '%-50s %s' % (path, pat)
2756
1504
2757
1505
2758
1506
class cmd_lookup_revision(Command):
2759
__doc__ = """Lookup the revision-id from a revision-number
1507
"""Lookup the revision-id from a revision-number
2760
1508
2761
:Examples:
1509
example:
2762
1510
bzr lookup-revision 33
2763
1511
"""
2764
1512
hidden = True
2765
1513
takes_args = ['revno']
2766
1514
2767
1515
@display_command
2768
1516
def run(self, revno):
2769
1517
try:
2770
1518
revno = int(revno)
2771
1519
except ValueError:
2772
raise errors.BzrCommandError("not a valid revision-number: %r"
2773
% revno)
2774
revid = WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
2775
self.outf.write("%s\n" % revid)
1520
raise BzrCommandError("not a valid revision-number: %r" % revno)
1521
1522
print WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
2776
1523
2777
1524
2778
1525
class cmd_export(Command):
2779
__doc__ = """Export current or past revision to a destination directory or archive.
1526
"""Export past revision to destination directory.
2780
1527
2781
1528
If no revision is specified this exports the last committed revision.
2782
1529
2784
1531
given, try to find the format with the extension. If no extension
2785
1532
is found exports to a directory (equivalent to --format=dir).
2786
1533
2787
If root is supplied, it will be used as the root directory inside
2788
container formats (tar, zip, etc). If it is not supplied it will default
2789
to the exported filename. The root option has no effect for 'dir' format.
2790
2791
If branch is omitted then the branch containing the current working
2792
directory will be used.
2793
2794
Note: Export of tree with non-ASCII filenames to zip is not supported.
2795
2796
================= =========================
2797
Supported formats Autodetected by extension
2798
================= =========================
2799
dir (none)
1534
Root may be the top directory for tar, tgz and tbz2 formats. If none
1535
is given, the top directory will be the root name of the file.
1536
1537
Note: export of tree with non-ascii filenames to zip is not supported.
1538
1539
Supported formats Autodetected by extension
1540
----------------- -------------------------
1541
dir -
2800
1542
tar .tar
2801
1543
tbz2 .tar.bz2, .tbz2
2802
1544
tgz .tar.gz, .tgz
2803
1545
zip .zip
2804
================= =========================
2805
1546
"""
2806
takes_args = ['dest', 'branch_or_subdir?']
2807
takes_options = [
2808
Option('format',
2809
help="Type of file to export to.",
2810
type=unicode),
2811
'revision',
2812
Option('filters', help='Apply content filters to export the '
2813
'convenient form.'),
2814
Option('root',
2815
type=str,
2816
help="Name of the root directory inside the exported file."),
2817
Option('per-file-timestamps',
2818
help='Set modification time of files to that of the last '
2819
'revision in which it was changed.'),
2820
]
2821
def run(self, dest, branch_or_subdir=None, revision=None, format=None,
2822
root=None, filters=False, per_file_timestamps=False):
1547
takes_args = ['dest']
1548
takes_options = ['revision', 'format', 'root']
1549
def run(self, dest, revision=None, format=None, root=None):
1550
import os.path
2823
1551
from bzrlib.export import export
2824
2825
if branch_or_subdir is None:
2826
tree = WorkingTree.open_containing(u'.')[0]
2827
b = tree.branch
2828
subdir = None
1552
tree = WorkingTree.open_containing(u'.')[0]
1553
b = tree.branch
1554
if revision is None:
1555
# should be tree.last_revision FIXME
1556
rev_id = b.last_revision()
2829
1557
else:
2830
b, subdir = Branch.open_containing(branch_or_subdir)
2831
tree = None
2832
2833
rev_tree = _get_one_revision_tree('export', revision, branch=b, tree=tree)
1558
if len(revision) != 1:
1559
raise BzrError('bzr export --revision takes exactly 1 argument')
1560
rev_id = revision[0].in_history(b).rev_id
1561
t = b.repository.revision_tree(rev_id)
2834
1562
try:
2835
export(rev_tree, dest, format, root, subdir, filtered=filters,
2836
per_file_timestamps=per_file_timestamps)
1563
export(t, dest, format, root)
2837
1564
except errors.NoSuchExportFormat, e:
2838
raise errors.BzrCommandError('Unsupported export format: %s' % e.format)
1565
raise BzrCommandError('Unsupported export format: %s' % e.format)
2839
1566
2840
1567
2841
1568
class cmd_cat(Command):
2842
__doc__ = """Write the contents of a file as of a given revision to standard output.
2843
2844
If no revision is nominated, the last revision is used.
2845
2846
Note: Take care to redirect standard output when using this command on a
2847
binary file.
2848
"""
2849
2850
_see_also = ['ls']
2851
takes_options = [
2852
Option('name-from-revision', help='The path name in the old tree.'),
2853
Option('filters', help='Apply content filters to display the '
2854
'convenience form.'),
2855
'revision',
2856
]
1569
"""Write a file's text from a previous revision."""
1570
1571
takes_options = ['revision']
2857
1572
takes_args = ['filename']
2858
encoding_type = 'exact'
2859
1573
2860
1574
@display_command
2861
def run(self, filename, revision=None, name_from_revision=False,
2862
filters=False):
1575
def run(self, filename, revision=None):
2863
1576
if revision is not None and len(revision) != 1:
2864
raise errors.BzrCommandError("bzr cat --revision takes exactly"
2865
" one revision specifier")
2866
tree, branch, relpath = \
2867
bzrdir.BzrDir.open_containing_tree_or_branch(filename)
2868
self.add_cleanup(branch.lock_read().unlock)
2869
return self._run(tree, branch, relpath, filename, revision,
2870
name_from_revision, filters)
1577
raise BzrCommandError("bzr cat --revision takes exactly one number")
1578
tree = None
1579
try:
1580
tree, relpath = WorkingTree.open_containing(filename)
1581
b = tree.branch
1582
except NotBranchError:
1583
pass
2871
1584
2872
def _run(self, tree, b, relpath, filename, revision, name_from_revision,
2873
filtered):
2874
1585
if tree is None:
2875
tree = b.basis_tree()
2876
rev_tree = _get_one_revision_tree('cat', revision, branch=b)
2877
self.add_cleanup(rev_tree.lock_read().unlock)
2878
2879
old_file_id = rev_tree.path2id(relpath)
2880
2881
if name_from_revision:
2882
# Try in revision if requested
2883
if old_file_id is None:
2884
raise errors.BzrCommandError(
2885
"%r is not present in revision %s" % (
2886
filename, rev_tree.get_revision_id()))
2887
else:
2888
content = rev_tree.get_file_text(old_file_id)
2889
else:
2890
cur_file_id = tree.path2id(relpath)
2891
found = False
2892
if cur_file_id is not None:
2893
# Then try with the actual file id
2894
try:
2895
content = rev_tree.get_file_text(cur_file_id)
2896
found = True
2897
except errors.NoSuchId:
2898
# The actual file id didn't exist at that time
2899
pass
2900
if not found and old_file_id is not None:
2901
# Finally try with the old file id
2902
content = rev_tree.get_file_text(old_file_id)
2903
found = True
2904
if not found:
2905
# Can't be found anywhere
2906
raise errors.BzrCommandError(
2907
"%r is not present in revision %s" % (
2908
filename, rev_tree.get_revision_id()))
2909
if filtered:
2910
from bzrlib.filters import (
2911
ContentFilterContext,
2912
filtered_output_bytes,
2913
)
2914
filters = rev_tree._content_filter_stack(relpath)
2915
chunks = content.splitlines(True)
2916
content = filtered_output_bytes(chunks, filters,
2917
ContentFilterContext(relpath, rev_tree))
2918
self.cleanup_now()
2919
self.outf.writelines(content)
2920
else:
2921
self.cleanup_now()
2922
self.outf.write(content)
1586
b, relpath = Branch.open_containing(filename)
1587
if revision is None:
1588
revision_id = b.last_revision()
1589
else:
1590
revision_id = revision[0].in_history(b).rev_id
1591
b.print_file(relpath, revision_id)
2923
1592
2924
1593
2925
1594
class cmd_local_time_offset(Command):
2926
__doc__ = """Show the offset in seconds from GMT to local time."""
2927
hidden = True
1595
"""Show the offset in seconds from GMT to local time."""
1596
hidden = True
2928
1597
@display_command
2929
1598
def run(self):
2930
self.outf.write("%s\n" % osutils.local_time_offset())
1599
print bzrlib.osutils.local_time_offset()
2931
1600
2932
1601
2933
1602
2934
1603
class cmd_commit(Command):
2935
__doc__ = """Commit changes into a new revision.
2936
2937
An explanatory message needs to be given for each commit. This is
2938
often done by using the --message option (getting the message from the
2939
command line) or by using the --file option (getting the message from
2940
a file). If neither of these options is given, an editor is opened for
2941
the user to enter the message. To see the changed files in the
2942
boilerplate text loaded into the editor, use the --show-diff option.
2943
2944
By default, the entire tree is committed and the person doing the
2945
commit is assumed to be the author. These defaults can be overridden
2946
as explained below.
2947
2948
:Selective commits:
2949
2950
If selected files are specified, only changes to those files are
2951
committed. If a directory is specified then the directory and
2952
everything within it is committed.
2953
2954
When excludes are given, they take precedence over selected files.
2955
For example, to commit only changes within foo, but not changes
2956
within foo/bar::
2957
2958
bzr commit foo -x foo/bar
2959
2960
A selective commit after a merge is not yet supported.
2961
2962
:Custom authors:
2963
2964
If the author of the change is not the same person as the committer,
2965
you can specify the author's name using the --author option. The
2966
name should be in the same format as a committer-id, e.g.
2967
"John Doe <jdoe@example.com>". If there is more than one author of
2968
the change you can specify the option multiple times, once for each
2969
author.
2970
2971
:Checks:
2972
2973
A common mistake is to forget to add a new file or directory before
2974
running the commit command. The --strict option checks for unknown
2975
files and aborts the commit if any are found. More advanced pre-commit
2976
checks can be implemented by defining hooks. See ``bzr help hooks``
2977
for details.
2978
2979
:Things to note:
2980
2981
If you accidentially commit the wrong changes or make a spelling
2982
mistake in the commit message say, you can use the uncommit command
2983
to undo it. See ``bzr help uncommit`` for details.
2984
2985
Hooks can also be configured to run after a commit. This allows you
2986
to trigger updates to external systems like bug trackers. The --fixes
2987
option can be used to record the association between a revision and
2988
one or more bugs. See ``bzr help bugs`` for details.
2989
2990
A selective commit may fail in some cases where the committed
2991
tree would be invalid. Consider::
2992
2993
bzr init foo
2994
mkdir foo/bar
2995
bzr add foo/bar
2996
bzr commit foo -m "committing foo"
2997
bzr mv foo/bar foo/baz
2998
mkdir foo/bar
2999
bzr add foo/bar
3000
bzr commit foo/bar -m "committing bar but not baz"
3001
3002
In the example above, the last commit will fail by design. This gives
3003
the user the opportunity to decide whether they want to commit the
3004
rename at the same time, separately first, or not at all. (As a general
3005
rule, when in doubt, Bazaar has a policy of Doing the Safe Thing.)
1604
"""Commit changes into a new revision.
1605
1606
If no arguments are given, the entire tree is committed.
1607
1608
If selected files are specified, only changes to those files are
1609
committed. If a directory is specified then the directory and everything
1610
within it is committed.
1611
1612
A selected-file commit may fail in some cases where the committed
1613
tree would be invalid, such as trying to commit a file in a
1614
newly-added directory that is not itself committed.
3006
1615
"""
3007
1616
# TODO: Run hooks on tree to-be-committed, and after commit.
3008
1617
3013
1622
3014
1623
# XXX: verbose currently does nothing
3015
1624
3016
_see_also = ['add', 'bugs', 'hooks', 'uncommit']
3017
1625
takes_args = ['selected*']
3018
takes_options = [
3019
ListOption('exclude', type=str, short_name='x',
3020
help="Do not consider changes made to a given path."),
3021
Option('message', type=unicode,
3022
short_name='m',
3023
help="Description of the new revision."),
3024
'verbose',
3025
Option('unchanged',
3026
help='Commit even if nothing has changed.'),
3027
Option('file', type=str,
3028
short_name='F',
3029
argname='msgfile',
3030
help='Take commit message from this file.'),
3031
Option('strict',
3032
help="Refuse to commit if there are unknown "
3033
"files in the working tree."),
3034
Option('commit-time', type=str,
3035
help="Manually set a commit time using commit date "
3036
"format, e.g. '2009-10-10 08:00:00 +0100'."),
3037
ListOption('fixes', type=str,
3038
help="Mark a bug as being fixed by this revision "
3039
"(see \"bzr help bugs\")."),
3040
ListOption('author', type=unicode,
3041
help="Set the author's name, if it's different "
3042
"from the committer."),
3043
Option('local',
3044
help="Perform a local commit in a bound "
3045
"branch. Local commits are not pushed to "
3046
"the master branch until a normal commit "
3047
"is performed."
3048
),
3049
Option('show-diff', short_name='p',
3050
help='When no message is supplied, show the diff along'
3051
' with the status summary in the message editor.'),
3052
]
1626
takes_options = ['message', 'verbose',
1627
Option('unchanged',
1628
help='commit even if nothing has changed'),
1629
Option('file', type=str,
1630
argname='msgfile',
1631
help='file containing commit message'),
1632
Option('strict',
1633
help="refuse to commit if there are unknown "
1634
"files in the working tree."),
1635
Option('local',
1636
help="perform a local only commit in a bound "
1637
"branch. Such commits are not pushed to "
1638
"the master branch until a normal commit "
1639
"is performed."
1640
),
1641
]
3053
1642
aliases = ['ci', 'checkin']
3054
1643
3055
def _iter_bug_fix_urls(self, fixes, branch):
3056
# Configure the properties for bug fixing attributes.
3057
for fixed_bug in fixes:
3058
tokens = fixed_bug.split(':')
3059
if len(tokens) != 2:
3060
raise errors.BzrCommandError(
3061
"Invalid bug %s. Must be in the form of 'tracker:id'. "
3062
"See \"bzr help bugs\" for more information on this "
3063
"feature.\nCommit refused." % fixed_bug)
3064
tag, bug_id = tokens
3065
try:
3066
yield bugtracker.get_bug_url(tag, branch, bug_id)
3067
except errors.UnknownBugTrackerAbbreviation:
3068
raise errors.BzrCommandError(
3069
'Unrecognized bug %s. Commit refused.' % fixed_bug)
3070
except errors.MalformedBugIdentifier, e:
3071
raise errors.BzrCommandError(
3072
"%s\nCommit refused." % (str(e),))
3073
3074
def run(self, message=None, file=None, verbose=False, selected_list=None,
3075
unchanged=False, strict=False, local=False, fixes=None,
3076
author=None, show_diff=False, exclude=None, commit_time=None):
3077
from bzrlib.errors import (
3078
PointlessCommit,
3079
ConflictsInTree,
3080
StrictCommitFailed
3081
)
3082
from bzrlib.msgeditor import (
3083
edit_commit_message_encoded,
3084
generate_commit_message_template,
3085
make_commit_message_template_encoded
3086
)
3087
3088
commit_stamp = offset = None
3089
if commit_time is not None:
3090
try:
3091
commit_stamp, offset = timestamp.parse_patch_date(commit_time)
3092
except ValueError, e:
3093
raise errors.BzrCommandError(
3094
"Could not parse --commit-time: " + str(e))
1644
def run(self, message=None, file=None, verbose=True, selected_list=None,
1645
unchanged=False, strict=False, local=False):
1646
from bzrlib.commit import (NullCommitReporter, ReportCommitToLog)
1647
from bzrlib.errors import (PointlessCommit, ConflictsInTree,
1648
StrictCommitFailed)
1649
from bzrlib.msgeditor import edit_commit_message, \
1650
make_commit_message_template
1651
from tempfile import TemporaryFile
3095
1652
3096
1653
# TODO: Need a blackbox test for invoking the external editor; may be
3097
1654
# slightly problematic to run this cross-platform.
3098
1655
3099
# TODO: do more checks that the commit will succeed before
1656
# TODO: do more checks that the commit will succeed before
3100
1657
# spending the user's valuable time typing a commit message.
3101
3102
properties = {}
3103
1658
#
1659
# TODO: if the commit *does* happen to fail, then save the commit
1660
# message to a temporary file where it can be recovered
3104
1661
tree, selected_list = tree_files(selected_list)
3105
1662
if selected_list == ['']:
3106
1663
# workaround - commit of root of tree should be exactly the same
3108
1665
# selected-file merge commit is not done yet
3109
1666
selected_list = []
3110
1667
3111
if fixes is None:
3112
fixes = []
3113
bug_property = bugtracker.encode_fixes_bug_urls(
3114
self._iter_bug_fix_urls(fixes, tree.branch))
3115
if bug_property:
3116
properties['bugs'] = bug_property
3117
3118
1668
if local and not tree.branch.get_bound_location():
3119
1669
raise errors.LocalRequiresBoundBranch()
3120
3121
if message is not None:
3122
try:
3123
file_exists = osutils.lexists(message)
3124
except UnicodeError:
3125
# The commit message contains unicode characters that can't be
3126
# represented in the filesystem encoding, so that can't be a
3127
# file.
3128
file_exists = False
3129
if file_exists:
3130
warning_msg = (
3131
'The commit message is a file name: "%(f)s".\n'
3132
'(use --file "%(f)s" to take commit message from that file)'
3133
% { 'f': message })
3134
ui.ui_factory.show_warning(warning_msg)
3135
if '\r' in message:
3136
message = message.replace('\r\n', '\n')
3137
message = message.replace('\r', '\n')
3138
if file:
3139
raise errors.BzrCommandError(
3140
"please specify either --message or --file")
3141
3142
def get_message(commit_obj):
3143
"""Callback to get commit message"""
3144
if file:
3145
my_message = codecs.open(
3146
file, 'rt', osutils.get_user_encoding()).read()
3147
elif message is not None:
3148
my_message = message
3149
else:
3150
# No message supplied: make one up.
3151
# text is the status of the tree
3152
text = make_commit_message_template_encoded(tree,
3153
selected_list, diff=show_diff,
3154
output_encoding=osutils.get_user_encoding())
3155
# start_message is the template generated from hooks
3156
# XXX: Warning - looks like hooks return unicode,
3157
# make_commit_message_template_encoded returns user encoding.
3158
# We probably want to be using edit_commit_message instead to
3159
# avoid this.
3160
start_message = generate_commit_message_template(commit_obj)
3161
my_message = edit_commit_message_encoded(text,
3162
start_message=start_message)
3163
if my_message is None:
3164
raise errors.BzrCommandError("please specify a commit"
3165
" message with either --message or --file")
3166
if my_message == "":
3167
raise errors.BzrCommandError("empty commit message specified")
3168
return my_message
3169
3170
# The API permits a commit with a filter of [] to mean 'select nothing'
3171
# but the command line should not do that.
3172
if not selected_list:
3173
selected_list = None
1670
if message is None and not file:
1671
template = make_commit_message_template(tree, selected_list)
1672
message = edit_commit_message(template)
1673
if message is None:
1674
raise BzrCommandError("please specify a commit message"
1675
" with either --message or --file")
1676
elif message and file:
1677
raise BzrCommandError("please specify either --message or --file")
1678
1679
if file:
1680
message = codecs.open(file, 'rt', bzrlib.user_encoding).read()
1681
1682
if message == "":
1683
raise BzrCommandError("empty commit message specified")
1684
1685
if verbose:
1686
reporter = ReportCommitToLog()
1687
else:
1688
reporter = NullCommitReporter()
1689
3174
1690
try:
3175
tree.commit(message_callback=get_message,
3176
specific_files=selected_list,
1691
tree.commit(message, specific_files=selected_list,
3177
1692
allow_pointless=unchanged, strict=strict, local=local,
3178
reporter=None, verbose=verbose, revprops=properties,
3179
authors=author, timestamp=commit_stamp,
3180
timezone=offset,
3181
exclude=safe_relpath_files(tree, exclude))
1693
reporter=reporter)
3182
1694
except PointlessCommit:
3183
raise errors.BzrCommandError("No changes to commit."
3184
" Use --unchanged to commit anyhow.")
1695
# FIXME: This should really happen before the file is read in;
1696
# perhaps prepare the commit; get the message; then actually commit
1697
raise BzrCommandError("no changes to commit",
1698
["use --unchanged to commit anyhow"])
3185
1699
except ConflictsInTree:
3186
raise errors.BzrCommandError('Conflicts detected in working '
3187
'tree. Use "bzr conflicts" to list, "bzr resolve FILE" to'
3188
' resolve.')
1700
raise BzrCommandError("Conflicts detected in working tree. "
1701
'Use "bzr conflicts" to list, "bzr resolve FILE" to resolve.')
3189
1702
except StrictCommitFailed:
3190
raise errors.BzrCommandError("Commit refused because there are"
3191
" unknown files in the working tree.")
1703
raise BzrCommandError("Commit refused because there are unknown "
1704
"files in the working tree.")
3192
1705
except errors.BoundBranchOutOfDate, e:
3193
e.extra_help = ("\n"
3194
'To commit to master branch, run update and then commit.\n'
3195
'You can also pass --local to commit to continue working '
3196
'disconnected.')
3197
raise
1706
raise BzrCommandError(str(e)
1707
+ ' Either unbind, update, or'
1708
' pass --local to commit.')
3198
1709
3199
1710
3200
1711
class cmd_check(Command):
3201
__doc__ = """Validate working tree structure, branch consistency and repository history.
3202
3203
This command checks various invariants about branch and repository storage
3204
to detect data corruption or bzr bugs.
3205
3206
The working tree and branch checks will only give output if a problem is
3207
detected. The output fields of the repository check are:
3208
3209
revisions
3210
This is just the number of revisions checked. It doesn't
3211
indicate a problem.
3212
3213
versionedfiles
3214
This is just the number of versionedfiles checked. It
3215
doesn't indicate a problem.
3216
3217
unreferenced ancestors
3218
Texts that are ancestors of other texts, but
3219
are not properly referenced by the revision ancestry. This is a
3220
subtle problem that Bazaar can work around.
3221
3222
unique file texts
3223
This is the total number of unique file contents
3224
seen in the checked revisions. It does not indicate a problem.
3225
3226
repeated file texts
3227
This is the total number of repeated texts seen
3228
in the checked revisions. Texts can be repeated when their file
3229
entries are modified, but the file contents are not. It does not
3230
indicate a problem.
3231
3232
If no restrictions are specified, all Bazaar data that is found at the given
3233
location will be checked.
3234
3235
:Examples:
3236
3237
Check the tree and branch at 'foo'::
3238
3239
bzr check --tree --branch foo
3240
3241
Check only the repository at 'bar'::
3242
3243
bzr check --repo bar
3244
3245
Check everything at 'baz'::
3246
3247
bzr check baz
1712
"""Validate consistency of branch history.
1713
1714
This command checks various invariants about the branch storage to
1715
detect data corruption or bzr bugs.
3248
1716
"""
3249
3250
_see_also = ['reconcile']
3251
takes_args = ['path?']
3252
takes_options = ['verbose',
3253
Option('branch', help="Check the branch related to the"
3254
" current directory."),
3255
Option('repo', help="Check the repository related to the"
3256
" current directory."),
3257
Option('tree', help="Check the working tree related to"
3258
" the current directory.")]
3259
3260
def run(self, path=None, verbose=False, branch=False, repo=False,
3261
tree=False):
3262
from bzrlib.check import check_dwim
3263
if path is None:
3264
path = '.'
3265
if not branch and not repo and not tree:
3266
branch = repo = tree = True
3267
check_dwim(path, verbose, do_branch=branch, do_repo=repo, do_tree=tree)
1717
takes_args = ['branch?']
1718
takes_options = ['verbose']
1719
1720
def run(self, branch=None, verbose=False):
1721
from bzrlib.check import check
1722
if branch is None:
1723
tree = WorkingTree.open_containing()[0]
1724
branch = tree.branch
1725
else:
1726
branch = Branch.open(branch)
1727
check(branch, verbose)
1728
1729
1730
class cmd_scan_cache(Command):
1731
hidden = True
1732
def run(self):
1733
from bzrlib.hashcache import HashCache
1734
1735
c = HashCache(u'.')
1736
c.read()
1737
c.scan()
1738
1739
print '%6d stats' % c.stat_count
1740
print '%6d in hashcache' % len(c._cache)
1741
print '%6d files removed from cache' % c.removed_count
1742
print '%6d hashes updated' % c.update_count
1743
print '%6d files changed too recently to cache' % c.danger_count
1744
1745
if c.needs_write:
1746
c.write()
3268
1747
3269
1748
3270
1749
class cmd_upgrade(Command):
3271
__doc__ = """Upgrade branch storage to current format.
1750
"""Upgrade branch storage to current format.
3272
1751
3273
1752
The check command or bzr developers may sometimes advise you to run
3274
1753
this command. When the default format has changed you may also be warned
3275
1754
during other operations to upgrade.
3276
1755
"""
3277
3278
_see_also = ['check']
3279
1756
takes_args = ['url?']
3280
1757
takes_options = [
3281
RegistryOption('format',
3282
help='Upgrade to a specific format. See "bzr help'
3283
' formats" for details.',
3284
lazy_registry=('bzrlib.bzrdir', 'format_registry'),
3285
converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
3286
value_switches=True, title='Branch format'),
1758
Option('format',
1759
help='Upgrade to a specific format. Current formats'
1760
' are: default, knit, metaweave and weave.'
1761
' Default is knit; metaweave and weave are'
1762
' deprecated',
1763
type=get_format_type),
3287
1764
]
3288
1765
1766
3289
1767
def run(self, url='.', format=None):
3290
1768
from bzrlib.upgrade import upgrade
1769
if format is None:
1770
format = get_format_type('default')
3291
1771
upgrade(url, format)
3292
1772
3293
1773
3294
1774
class cmd_whoami(Command):
3295
__doc__ = """Show or set bzr user id.
3296
3297
:Examples:
3298
Show the email of the current user::
3299
3300
bzr whoami --email
3301
3302
Set the current user::
3303
3304
bzr whoami "Frank Chu <fchu@example.com>"
3305
"""
3306
takes_options = [ Option('email',
3307
help='Display email address only.'),
3308
Option('branch',
3309
help='Set identity for the current branch instead of '
3310
'globally.'),
3311
]
3312
takes_args = ['name?']
3313
encoding_type = 'replace'
3314
1775
"""Show bzr user id."""
1776
takes_options = ['email']
1777
3315
1778
@display_command
3316
def run(self, email=False, branch=False, name=None):
3317
if name is None:
3318
# use branch if we're inside one; otherwise global config
3319
try:
3320
c = Branch.open_containing('.')[0].get_config()
3321
except errors.NotBranchError:
3322
c = config.GlobalConfig()
3323
if email:
3324
self.outf.write(c.user_email() + '\n')
3325
else:
3326
self.outf.write(c.username() + '\n')
3327
return
3328
3329
# display a warning if an email address isn't included in the given name.
1779
def run(self, email=False):
3330
1780
try:
3331
config.extract_email_address(name)
3332
except errors.NoEmailInUsername, e:
3333
warning('"%s" does not seem to contain an email address. '
3334
'This is allowed, but not recommended.', name)
3335
3336
# use global config unless --branch given
3337
if branch:
3338
c = Branch.open_containing('.')[0].get_config()
1781
b = WorkingTree.open_containing(u'.')[0].branch
1782
config = bzrlib.config.BranchConfig(b)
1783
except NotBranchError:
1784
config = bzrlib.config.GlobalConfig()
1785
1786
if email:
1787
print config.user_email()
3339
1788
else:
3340
c = config.GlobalConfig()
3341
c.set_user_option('email', name)
1789
print config.username()
3342
1790
3343
1791
3344
1792
class cmd_nick(Command):
3345
__doc__ = """Print or set the branch nickname.
3346
3347
If unset, the tree root directory name is used as the nickname.
3348
To print the current nickname, execute with no argument.
3349
3350
Bound branches use the nickname of its master branch unless it is set
3351
locally.
1793
"""Print or set the branch nickname.
1794
1795
If unset, the tree root directory name is used as the nickname
1796
To print the current nickname, execute with no argument.
3352
1797
"""
3353
3354
_see_also = ['info']
3355
1798
takes_args = ['nickname?']
3356
1799
def run(self, nickname=None):
3357
1800
branch = Branch.open_containing(u'.')[0]
3362
1805
3363
1806
@display_command
3364
1807
def printme(self, branch):
3365
self.outf.write('%s\n' % branch.nick)
3366
3367
3368
class cmd_alias(Command):
3369
__doc__ = """Set/unset and display aliases.
3370
3371
:Examples:
3372
Show the current aliases::
3373
3374
bzr alias
3375
3376
Show the alias specified for 'll'::
3377
3378
bzr alias ll
3379
3380
Set an alias for 'll'::
3381
3382
bzr alias ll="log --line -r-10..-1"
3383
3384
To remove an alias for 'll'::
3385
3386
bzr alias --remove ll
3387
3388
"""
3389
takes_args = ['name?']
3390
takes_options = [
3391
Option('remove', help='Remove the alias.'),
3392
]
3393
3394
def run(self, name=None, remove=False):
3395
if remove:
3396
self.remove_alias(name)
3397
elif name is None:
3398
self.print_aliases()
3399
else:
3400
equal_pos = name.find('=')
3401
if equal_pos == -1:
3402
self.print_alias(name)
3403
else:
3404
self.set_alias(name[:equal_pos], name[equal_pos+1:])
3405
3406
def remove_alias(self, alias_name):
3407
if alias_name is None:
3408
raise errors.BzrCommandError(
3409
'bzr alias --remove expects an alias to remove.')
3410
# If alias is not found, print something like:
3411
# unalias: foo: not found
3412
c = config.GlobalConfig()
3413
c.unset_alias(alias_name)
3414
3415
@display_command
3416
def print_aliases(self):
3417
"""Print out the defined aliases in a similar format to bash."""
3418
aliases = config.GlobalConfig().get_aliases()
3419
for key, value in sorted(aliases.iteritems()):
3420
self.outf.write('bzr alias %s="%s"\n' % (key, value))
3421
3422
@display_command
3423
def print_alias(self, alias_name):
3424
from bzrlib.commands import get_alias
3425
alias = get_alias(alias_name)
3426
if alias is None:
3427
self.outf.write("bzr alias: %s: not found\n" % alias_name)
3428
else:
3429
self.outf.write(
3430
'bzr alias %s="%s"\n' % (alias_name, ' '.join(alias)))
3431
3432
def set_alias(self, alias_name, alias_command):
3433
"""Save the alias in the global config."""
3434
c = config.GlobalConfig()
3435
c.set_alias(alias_name, alias_command)
1808
print branch.nick
3436
1809
3437
1810
3438
1811
class cmd_selftest(Command):
3439
__doc__ = """Run internal test suite.
3440
3441
If arguments are given, they are regular expressions that say which tests
3442
should run. Tests matching any expression are run, and other tests are
3443
not run.
3444
3445
Alternatively if --first is given, matching tests are run first and then
3446
all other tests are run. This is useful if you have been working in a
3447
particular area, but want to make sure nothing else was broken.
3448
3449
If --exclude is given, tests that match that regular expression are
3450
excluded, regardless of whether they match --first or not.
3451
3452
To help catch accidential dependencies between tests, the --randomize
3453
option is useful. In most cases, the argument used is the word 'now'.
3454
Note that the seed used for the random number generator is displayed
3455
when this option is used. The seed can be explicitly passed as the
3456
argument to this option if required. This enables reproduction of the
3457
actual ordering used if and when an order sensitive problem is encountered.
3458
3459
If --list-only is given, the tests that would be run are listed. This is
3460
useful when combined with --first, --exclude and/or --randomize to
3461
understand their impact. The test harness reports "Listed nn tests in ..."
3462
instead of "Ran nn tests in ..." when list mode is enabled.
1812
"""Run internal test suite.
1813
1814
This creates temporary test directories in the working directory,
1815
but not existing data is affected. These directories are deleted
1816
if the tests pass, or left behind to help in debugging if they
1817
fail and --keep-output is specified.
1818
1819
If arguments are given, they are regular expressions that say
1820
which tests should run.
3463
1821
3464
1822
If the global option '--no-plugins' is given, plugins are not loaded
3465
1823
before running the selftests. This has two effects: features provided or
3466
1824
modified by plugins will not be tested, and tests provided by plugins will
3467
1825
not be run.
3468
1826
3469
Tests that need working space on disk use a common temporary directory,
3470
typically inside $TMPDIR or /tmp.
3471
3472
If you set BZR_TEST_PDB=1 when running selftest, failing tests will drop
3473
into a pdb postmortem session.
3474
3475
:Examples:
3476
Run only tests relating to 'ignore'::
3477
3478
bzr selftest ignore
3479
3480
Disable plugins and list tests as they're run::
3481
3482
bzr --no-plugins selftest -v
1827
examples:
1828
bzr selftest ignore
1829
bzr --no-plugins selftest -v
3483
1830
"""
1831
# TODO: --list should give a list of all available tests
1832
3484
1833
# NB: this is used from the class without creating an instance, which is
3485
1834
# why it does not have a self parameter.
3486
1835
def get_transport_type(typestring):
3487
1836
"""Parse and return a transport specifier."""
3488
1837
if typestring == "sftp":
3489
from bzrlib.tests import stub_sftp
3490
return stub_sftp.SFTPAbsoluteServer
1838
from bzrlib.transport.sftp import SFTPAbsoluteServer
1839
return SFTPAbsoluteServer
3491
1840
if typestring == "memory":
3492
from bzrlib.tests import test_server
3493
return memory.MemoryServer
1841
from bzrlib.transport.memory import MemoryServer
1842
return MemoryServer
3494
1843
if typestring == "fakenfs":
3495
from bzrlib.tests import test_server
3496
return test_server.FakeNFSServer
1844
from bzrlib.transport.fakenfs import FakeNFSServer
1845
return FakeNFSServer
3497
1846
msg = "No known transport type %s. Supported types are: sftp\n" %\
3498
1847
(typestring)
3499
raise errors.BzrCommandError(msg)
1848
raise BzrCommandError(msg)
3500
1849
3501
1850
hidden = True
3502
1851
takes_args = ['testspecs*']
3503
1852
takes_options = ['verbose',
3504
Option('one',
3505
help='Stop when one test fails.',
3506
short_name='1',
3507
),
3508
Option('transport',
1853
Option('one', help='stop when one test fails'),
1854
Option('keep-output',
1855
help='keep output directories when tests fail'),
1856
Option('transport',
3509
1857
help='Use a different transport by default '
3510
1858
'throughout the test suite.',
3511
1859
type=get_transport_type),
3512
Option('benchmark',
3513
help='Run the benchmarks rather than selftests.'),
1860
Option('benchmark', help='run the bzr bencharks.'),
3514
1861
Option('lsprof-timed',
3515
help='Generate lsprof output for benchmarked'
1862
help='generate lsprof output for benchmarked'
3516
1863
' sections of code.'),
3517
Option('lsprof-tests',
3518
help='Generate lsprof output for each test.'),
3519
Option('cache-dir', type=str,
3520
help='Cache intermediate benchmark output in this '
3521
'directory.'),
3522
Option('first',
3523
help='Run all tests, but run specified tests first.',
3524
short_name='f',
3525
),
3526
Option('list-only',
3527
help='List the tests instead of running them.'),
3528
RegistryOption('parallel',
3529
help="Run the test suite in parallel.",
3530
lazy_registry=('bzrlib.tests', 'parallel_registry'),
3531
value_switches=False,
3532
),
3533
Option('randomize', type=str, argname="SEED",
3534
help='Randomize the order of tests using the given'
3535
' seed or "now" for the current time.'),
3536
Option('exclude', type=str, argname="PATTERN",
3537
short_name='x',
3538
help='Exclude tests that match this regular'
3539
' expression.'),
3540
Option('subunit',
3541
help='Output test progress via subunit.'),
3542
Option('strict', help='Fail on missing dependencies or '
3543
'known failures.'),
3544
Option('load-list', type=str, argname='TESTLISTFILE',
3545
help='Load a test id list from a text file.'),
3546
ListOption('debugflag', type=str, short_name='E',
3547
help='Turn on a selftest debug flag.'),
3548
ListOption('starting-with', type=str, argname='TESTID',
3549
param_name='starting_with', short_name='s',
3550
help=
3551
'Load only the tests starting with TESTID.'),
3552
1864
]
3553
encoding_type = 'replace'
3554
3555
def __init__(self):
3556
Command.__init__(self)
3557
self.additional_selftest_args = {}
3558
3559
def run(self, testspecs_list=None, verbose=False, one=False,
3560
transport=None, benchmark=None,
3561
lsprof_timed=None, cache_dir=None,
3562
first=False, list_only=False,
3563
randomize=None, exclude=None, strict=False,
3564
load_list=None, debugflag=None, starting_with=None, subunit=False,
3565
parallel=None, lsprof_tests=False):
1865
1866
def run(self, testspecs_list=None, verbose=None, one=False,
1867
keep_output=False, transport=None, benchmark=None,
1868
lsprof_timed=None):
1869
import bzrlib.ui
3566
1870
from bzrlib.tests import selftest
3567
1871
import bzrlib.benchmarks as benchmarks
3568
from bzrlib.benchmarks import tree_creator
3569
3570
# Make deprecation warnings visible, unless -Werror is set
3571
symbol_versioning.activate_deprecation_warnings(override=False)
3572
3573
if cache_dir is not None:
3574
tree_creator.TreeCreator.CACHE_ROOT = osutils.abspath(cache_dir)
3575
if testspecs_list is not None:
3576
pattern = '|'.join(testspecs_list)
3577
else:
3578
pattern = ".*"
3579
if subunit:
3580
try:
3581
from bzrlib.tests import SubUnitBzrRunner
3582
except ImportError:
3583
raise errors.BzrCommandError("subunit not available. subunit "
3584
"needs to be installed to use --subunit.")
3585
self.additional_selftest_args['runner_class'] = SubUnitBzrRunner
3586
# On Windows, disable automatic conversion of '\n' to '\r\n' in
3587
# stdout, which would corrupt the subunit stream.
3588
if sys.platform == "win32" and sys.stdout.fileno() >= 0:
3589
import msvcrt
3590
msvcrt.setmode(sys.stdout.fileno(), os.O_BINARY)
3591
if parallel:
3592
self.additional_selftest_args.setdefault(
3593
'suite_decorators', []).append(parallel)
3594
if benchmark:
3595
test_suite_factory = benchmarks.test_suite
3596
# Unless user explicitly asks for quiet, be verbose in benchmarks
3597
verbose = not is_quiet()
3598
# TODO: should possibly lock the history file...
3599
benchfile = open(".perf_history", "at", buffering=1)
3600
self.add_cleanup(benchfile.close)
3601
else:
3602
test_suite_factory = None
3603
benchfile = None
3604
selftest_kwargs = {"verbose": verbose,
3605
"pattern": pattern,
3606
"stop_on_failure": one,
3607
"transport": transport,
3608
"test_suite_factory": test_suite_factory,
3609
"lsprof_timed": lsprof_timed,
3610
"lsprof_tests": lsprof_tests,
3611
"bench_history": benchfile,
3612
"matching_tests_first": first,
3613
"list_only": list_only,
3614
"random_seed": randomize,
3615
"exclude_pattern": exclude,
3616
"strict": strict,
3617
"load_list": load_list,
3618
"debug_flags": debugflag,
3619
"starting_with": starting_with
3620
}
3621
selftest_kwargs.update(self.additional_selftest_args)
3622
result = selftest(**selftest_kwargs)
3623
return int(not result)
1872
# we don't want progress meters from the tests to go to the
1873
# real output; and we don't want log messages cluttering up
1874
# the real logs.
1875
save_ui = bzrlib.ui.ui_factory
1876
print '%10s: %s' % ('bzr', bzrlib.osutils.realpath(sys.argv[0]))
1877
print '%10s: %s' % ('bzrlib', bzrlib.__path__[0])
1878
print
1879
bzrlib.trace.info('running tests...')
1880
try:
1881
bzrlib.ui.ui_factory = bzrlib.ui.SilentUIFactory()
1882
if testspecs_list is not None:
1883
pattern = '|'.join(testspecs_list)
1884
else:
1885
pattern = ".*"
1886
if benchmark:
1887
test_suite_factory = benchmarks.test_suite
1888
if verbose is None:
1889
verbose = True
1890
else:
1891
test_suite_factory = None
1892
if verbose is None:
1893
verbose = False
1894
result = selftest(verbose=verbose,
1895
pattern=pattern,
1896
stop_on_failure=one,
1897
keep_output=keep_output,
1898
transport=transport,
1899
test_suite_factory=test_suite_factory,
1900
lsprof_timed=lsprof_timed)
1901
if result:
1902
bzrlib.trace.info('tests passed')
1903
else:
1904
bzrlib.trace.info('tests failed')
1905
return int(not result)
1906
finally:
1907
bzrlib.ui.ui_factory = save_ui
1908
1909
1910
def _get_bzr_branch():
1911
"""If bzr is run from a branch, return Branch or None"""
1912
import bzrlib.errors
1913
from bzrlib.branch import Branch
1914
from bzrlib.osutils import abspath
1915
from os.path import dirname
1916
1917
try:
1918
branch = Branch.open(dirname(abspath(dirname(__file__))))
1919
return branch
1920
except bzrlib.errors.BzrError:
1921
return None
1922
1923
1924
def show_version():
1925
print "bzr (bazaar-ng) %s" % bzrlib.__version__
1926
# is bzrlib itself in a branch?
1927
branch = _get_bzr_branch()
1928
if branch:
1929
rh = branch.revision_history()
1930
revno = len(rh)
1931
print " bzr checkout, revision %d" % (revno,)
1932
print " nick: %s" % (branch.nick,)
1933
if rh:
1934
print " revid: %s" % (rh[-1],)
1935
print "Using python interpreter:", sys.executable
1936
import site
1937
print "Using python standard library:", os.path.dirname(site.__file__)
1938
print "Using bzrlib:",
1939
if len(bzrlib.__path__) > 1:
1940
# print repr, which is a good enough way of making it clear it's
1941
# more than one element (eg ['/foo/bar', '/foo/bzr'])
1942
print repr(bzrlib.__path__)
1943
else:
1944
print bzrlib.__path__[0]
1945
1946
print
1947
print bzrlib.__copyright__
1948
print "http://bazaar-vcs.org/"
1949
print
1950
print "bzr comes with ABSOLUTELY NO WARRANTY. bzr is free software, and"
1951
print "you may use, modify and redistribute it under the terms of the GNU"
1952
print "General Public License version 2 or later."
3624
1953
3625
1954
3626
1955
class cmd_version(Command):
3627
__doc__ = """Show version of bzr."""
3628
3629
encoding_type = 'replace'
3630
takes_options = [
3631
Option("short", help="Print just the version number."),
3632
]
3633
1956
"""Show version of bzr."""
3634
1957
@display_command
3635
def run(self, short=False):
3636
from bzrlib.version import show_version
3637
if short:
3638
self.outf.write(bzrlib.version_string + '\n')
3639
else:
3640
show_version(to_file=self.outf)
3641
1958
def run(self):
1959
show_version()
3642
1960
3643
1961
class cmd_rocks(Command):
3644
__doc__ = """Statement of optimism."""
3645
1962
"""Statement of optimism."""
3646
1963
hidden = True
3647
3648
1964
@display_command
3649
1965
def run(self):
3650
self.outf.write("It sure does!\n")
1966
print "it sure does!"
3651
1967
3652
1968
3653
1969
class cmd_find_merge_base(Command):
3654
__doc__ = """Find and print a base revision for merging two branches."""
1970
"""Find and print a base revision for merging two branches.
1971
"""
3655
1972
# TODO: Options to specify revisions on either side, as if
3656
1973
# merging only part of the history.
3657
1974
takes_args = ['branch', 'other']
3658
1975
hidden = True
3659
1976
3660
1977
@display_command
3661
1978
def run(self, branch, other):
3662
from bzrlib.revision import ensure_null
3663
1979
from bzrlib.revision import common_ancestor, MultipleRevisionSources
1980
3664
1981
branch1 = Branch.open_containing(branch)[0]
3665
1982
branch2 = Branch.open_containing(other)[0]
3666
self.add_cleanup(branch1.lock_read().unlock)
3667
self.add_cleanup(branch2.lock_read().unlock)
3668
last1 = ensure_null(branch1.last_revision())
3669
last2 = ensure_null(branch2.last_revision())
3670
3671
graph = branch1.repository.get_graph(branch2.repository)
3672
base_rev_id = graph.find_unique_lca(last1, last2)
3673
3674
self.outf.write('merge base is revision %s\n' % base_rev_id)
1983
1984
history_1 = branch1.revision_history()
1985
history_2 = branch2.revision_history()
1986
1987
last1 = branch1.last_revision()
1988
last2 = branch2.last_revision()
1989
1990
source = MultipleRevisionSources(branch1.repository,
1991
branch2.repository)
1992
1993
base_rev_id = common_ancestor(last1, last2, source)
1994
1995
print 'merge base is revision %s' % base_rev_id
1996
1997
return
1998
1999
if base_revno is None:
2000
raise bzrlib.errors.UnrelatedBranches()
2001
2002
print ' r%-6d in %s' % (base_revno, branch)
2003
2004
other_revno = branch2.revision_id_to_revno(base_revid)
2005
2006
print ' r%-6d in %s' % (other_revno, other)
2007
3675
2008
3676
2009
3677
2010
class cmd_merge(Command):
3678
__doc__ = """Perform a three-way merge.
3679
3680
The source of the merge can be specified either in the form of a branch,
3681
or in the form of a path to a file containing a merge directive generated
3682
with bzr send. If neither is specified, the default is the upstream branch
3683
or the branch most recently merged using --remember.
3684
3685
When merging a branch, by default the tip will be merged. To pick a different
3686
revision, pass --revision. If you specify two values, the first will be used as
3687
BASE and the second one as OTHER. Merging individual revisions, or a subset of
3688
available revisions, like this is commonly referred to as "cherrypicking".
3689
3690
Revision numbers are always relative to the branch being merged.
2011
"""Perform a three-way merge.
2012
2013
The branch is the branch you will merge from. By default, it will
2014
merge the latest revision. If you specify a revision, that
2015
revision will be merged. If you specify two revisions, the first
2016
will be used as a BASE, and the second one as OTHER. Revision
2017
numbers are always relative to the specified branch.
3691
2018
3692
2019
By default, bzr will try to merge in all new work from the other
3693
2020
branch, automatically determining an appropriate base. If this
3694
2021
fails, you may need to give an explicit base.
3695
2022
3696
2023
Merge will do its best to combine the changes in two branches, but there
3697
2024
are some kinds of problems only a human can fix. When it encounters those,
3698
2025
it will mark a conflict. A conflict means that you need to fix something,
3702
2029
3703
2030
If there is no default branch set, the first merge will set it. After
3704
2031
that, you can omit the branch to use the default. To change the
3705
default, use --remember. The value will only be saved if the remote
3706
location can be accessed.
3707
3708
The results of the merge are placed into the destination working
3709
directory, where they can be reviewed (with bzr diff), tested, and then
3710
committed to record the result of the merge.
3711
2032
default, use --remember.
2033
2034
Examples:
2035
2036
To merge the latest revision from bzr.dev
2037
bzr merge ../bzr.dev
2038
2039
To merge changes up to and including revision 82 from bzr.dev
2040
bzr merge -r 82 ../bzr.dev
2041
2042
To merge the changes introduced by 82, without previous changes:
2043
bzr merge -r 81..82 ../bzr.dev
2044
3712
2045
merge refuses to run if there are any uncommitted changes, unless
3713
--force is given. The --force option can also be used to create a
3714
merge revision which has more than two parents.
3715
3716
If one would like to merge changes from the working tree of the other
3717
branch without merging any committed revisions, the --uncommitted option
3718
can be given.
3719
3720
To select only some changes to merge, use "merge -i", which will prompt
3721
you to apply each diff hunk and file change, similar to "shelve".
3722
3723
:Examples:
3724
To merge the latest revision from bzr.dev::
3725
3726
bzr merge ../bzr.dev
3727
3728
To merge changes up to and including revision 82 from bzr.dev::
3729
3730
bzr merge -r 82 ../bzr.dev
3731
3732
To merge the changes introduced by 82, without previous changes::
3733
3734
bzr merge -r 81..82 ../bzr.dev
3735
3736
To apply a merge directive contained in /tmp/merge::
3737
3738
bzr merge /tmp/merge
3739
3740
To create a merge revision with three parents from two branches
3741
feature1a and feature1b:
3742
3743
bzr merge ../feature1a
3744
bzr merge ../feature1b --force
3745
bzr commit -m 'revision with three parents'
2046
--force is given.
2047
2048
The following merge types are available:
3746
2049
"""
3747
3748
encoding_type = 'exact'
3749
_see_also = ['update', 'remerge', 'status-flags', 'send']
3750
takes_args = ['location?']
3751
takes_options = [
3752
'change',
3753
'revision',
3754
Option('force',
3755
help='Merge even if the destination tree has uncommitted changes.'),
3756
'merge-type',
3757
'reprocess',
3758
'remember',
3759
Option('show-base', help="Show base revision text in "
3760
"conflicts."),
3761
Option('uncommitted', help='Apply uncommitted changes'
3762
' from a working copy, instead of branch changes.'),
3763
Option('pull', help='If the destination is already'
3764
' completely merged into the source, pull from the'
3765
' source rather than merging. When this happens,'
3766
' you do not need to commit the result.'),
3767
Option('directory',
3768
help='Branch to merge into, '
3769
'rather than the one containing the working directory.',
3770
short_name='d',
3771
type=unicode,
3772
),
3773
Option('preview', help='Instead of merging, show a diff of the'
3774
' merge.'),
3775
Option('interactive', help='Select changes interactively.',
3776
short_name='i')
3777
]
3778
3779
def run(self, location=None, revision=None, force=False,
3780
merge_type=None, show_base=False, reprocess=None, remember=False,
3781
uncommitted=False, pull=False,
3782
directory=None,
3783
preview=False,
3784
interactive=False,
3785
):
2050
takes_args = ['branch?']
2051
takes_options = ['revision', 'force', 'merge-type', 'reprocess', 'remember',
2052
Option('show-base', help="Show base revision text in "
2053
"conflicts")]
2054
2055
def help(self):
2056
from merge import merge_type_help
2057
from inspect import getdoc
2058
return getdoc(self) + '\n' + merge_type_help()
2059
2060
def run(self, branch=None, revision=None, force=False, merge_type=None,
2061
show_base=False, reprocess=False, remember=False):
3786
2062
if merge_type is None:
3787
merge_type = _mod_merge.Merge3Merger
3788
3789
if directory is None: directory = u'.'
3790
possible_transports = []
3791
merger = None
3792
allow_pending = True
3793
verified = 'inapplicable'
3794
tree = WorkingTree.open_containing(directory)[0]
3795
2063
merge_type = Merge3Merger
2064
2065
tree = WorkingTree.open_containing(u'.')[0]
2066
2067
if branch is not None:
2068
try:
2069
reader = read_bundle_from_url(branch)
2070
except NotABundle:
2071
pass # Continue on considering this url a Branch
2072
else:
2073
conflicts = merge_bundle(reader, tree, not force, merge_type,
2074
reprocess, show_base)
2075
if conflicts == 0:
2076
return 0
2077
else:
2078
return 1
2079
2080
branch = self._get_remembered_parent(tree, branch, 'Merging from')
2081
2082
if revision is None or len(revision) < 1:
2083
base = [None, None]
2084
other = [branch, -1]
2085
other_branch, path = Branch.open_containing(branch)
2086
else:
2087
if len(revision) == 1:
2088
base = [None, None]
2089
other_branch, path = Branch.open_containing(branch)
2090
revno = revision[0].in_history(other_branch).revno
2091
other = [branch, revno]
2092
else:
2093
assert len(revision) == 2
2094
if None in revision:
2095
raise BzrCommandError(
2096
"Merge doesn't permit that revision specifier.")
2097
other_branch, path = Branch.open_containing(branch)
2098
2099
base = [branch, revision[0].in_history(other_branch).revno]
2100
other = [branch, revision[1].in_history(other_branch).revno]
2101
2102
if tree.branch.get_parent() is None or remember:
2103
tree.branch.set_parent(other_branch.base)
2104
2105
if path != "":
2106
interesting_files = [path]
2107
else:
2108
interesting_files = None
2109
pb = bzrlib.ui.ui_factory.nested_progress_bar()
3796
2110
try:
3797
basis_tree = tree.revision_tree(tree.last_revision())
3798
except errors.NoSuchRevision:
3799
basis_tree = tree.basis_tree()
3800
3801
# die as quickly as possible if there are uncommitted changes
3802
if not force:
3803
if tree.has_changes():
3804
raise errors.UncommittedChanges(tree)
3805
3806
view_info = _get_view_info_for_change_reporter(tree)
3807
change_reporter = delta._ChangeReporter(
3808
unversioned_filter=tree.is_ignored, view_info=view_info)
3809
pb = ui.ui_factory.nested_progress_bar()
3810
self.add_cleanup(pb.finished)
3811
self.add_cleanup(tree.lock_write().unlock)
3812
if location is not None:
3813
2111
try:
3814
mergeable = bundle.read_mergeable_from_url(location,
3815
possible_transports=possible_transports)
3816
except errors.NotABundle:
3817
mergeable = None
2112
conflict_count = merge(other, base, check_clean=(not force),
2113
merge_type=merge_type,
2114
reprocess=reprocess,
2115
show_base=show_base,
2116
pb=pb, file_list=interesting_files)
2117
finally:
2118
pb.finished()
2119
if conflict_count != 0:
2120
return 1
3818
2121
else:
3819
if uncommitted:
3820
raise errors.BzrCommandError('Cannot use --uncommitted'
3821
' with bundles or merge directives.')
3822
3823
if revision is not None:
3824
raise errors.BzrCommandError(
3825
'Cannot use -r with merge directives or bundles')
3826
merger, verified = _mod_merge.Merger.from_mergeable(tree,
3827
mergeable, None)
3828
3829
if merger is None and uncommitted:
3830
if revision is not None and len(revision) > 0:
3831
raise errors.BzrCommandError('Cannot use --uncommitted and'
3832
' --revision at the same time.')
3833
merger = self.get_merger_from_uncommitted(tree, location, None)
3834
allow_pending = False
3835
3836
if merger is None:
3837
merger, allow_pending = self._get_merger_from_branch(tree,
3838
location, revision, remember, possible_transports, None)
3839
3840
merger.merge_type = merge_type
3841
merger.reprocess = reprocess
3842
merger.show_base = show_base
3843
self.sanity_check_merger(merger)
3844
if (merger.base_rev_id == merger.other_rev_id and
3845
merger.other_rev_id is not None):
3846
note('Nothing to do.')
3847
return 0
3848
if pull:
3849
if merger.interesting_files is not None:
3850
raise errors.BzrCommandError('Cannot pull individual files')
3851
if (merger.base_rev_id == tree.last_revision()):
3852
result = tree.pull(merger.other_branch, False,
3853
merger.other_rev_id)
3854
result.report(self.outf)
3855
2122
return 0
3856
if merger.this_basis is None:
3857
raise errors.BzrCommandError(
3858
"This branch has no commits."
3859
" (perhaps you would prefer 'bzr pull')")
3860
if preview:
3861
return self._do_preview(merger)
3862
elif interactive:
3863
return self._do_interactive(merger)
3864
else:
3865
return self._do_merge(merger, change_reporter, allow_pending,
3866
verified)
3867
3868
def _get_preview(self, merger):
3869
tree_merger = merger.make_merger()
3870
tt = tree_merger.make_preview_transform()
3871
self.add_cleanup(tt.finalize)
3872
result_tree = tt.get_preview_tree()
3873
return result_tree
3874
3875
def _do_preview(self, merger):
3876
from bzrlib.diff import show_diff_trees
3877
result_tree = self._get_preview(merger)
3878
show_diff_trees(merger.this_tree, result_tree, self.outf,
3879
old_label='', new_label='')
3880
3881
def _do_merge(self, merger, change_reporter, allow_pending, verified):
3882
merger.change_reporter = change_reporter
3883
conflict_count = merger.do_merge()
3884
if allow_pending:
3885
merger.set_pending()
3886
if verified == 'failed':
3887
warning('Preview patch does not match changes')
3888
if conflict_count != 0:
3889
return 1
3890
else:
3891
return 0
3892
3893
def _do_interactive(self, merger):
3894
"""Perform an interactive merge.
3895
3896
This works by generating a preview tree of the merge, then using
3897
Shelver to selectively remove the differences between the working tree
3898
and the preview tree.
3899
"""
3900
from bzrlib import shelf_ui
3901
result_tree = self._get_preview(merger)
3902
writer = bzrlib.option.diff_writer_registry.get()
3903
shelver = shelf_ui.Shelver(merger.this_tree, result_tree, destroy=True,
3904
reporter=shelf_ui.ApplyReporter(),
3905
diff_writer=writer(sys.stdout))
3906
try:
3907
shelver.run()
3908
finally:
3909
shelver.finalize()
3910
3911
def sanity_check_merger(self, merger):
3912
if (merger.show_base and
3913
not merger.merge_type is _mod_merge.Merge3Merger):
3914
raise errors.BzrCommandError("Show-base is not supported for this"
3915
" merge type. %s" % merger.merge_type)
3916
if merger.reprocess is None:
3917
if merger.show_base:
3918
merger.reprocess = False
3919
else:
3920
# Use reprocess if the merger supports it
3921
merger.reprocess = merger.merge_type.supports_reprocess
3922
if merger.reprocess and not merger.merge_type.supports_reprocess:
3923
raise errors.BzrCommandError("Conflict reduction is not supported"
3924
" for merge type %s." %
3925
merger.merge_type)
3926
if merger.reprocess and merger.show_base:
3927
raise errors.BzrCommandError("Cannot do conflict reduction and"
3928
" show base.")
3929
3930
def _get_merger_from_branch(self, tree, location, revision, remember,
3931
possible_transports, pb):
3932
"""Produce a merger from a location, assuming it refers to a branch."""
3933
from bzrlib.tag import _merge_tags_if_possible
3934
# find the branch locations
3935
other_loc, user_location = self._select_branch_location(tree, location,
3936
revision, -1)
3937
if revision is not None and len(revision) == 2:
3938
base_loc, _unused = self._select_branch_location(tree,
3939
location, revision, 0)
3940
else:
3941
base_loc = other_loc
3942
# Open the branches
3943
other_branch, other_path = Branch.open_containing(other_loc,
3944
possible_transports)
3945
if base_loc == other_loc:
3946
base_branch = other_branch
3947
else:
3948
base_branch, base_path = Branch.open_containing(base_loc,
3949
possible_transports)
3950
# Find the revision ids
3951
other_revision_id = None
3952
base_revision_id = None
3953
if revision is not None:
3954
if len(revision) >= 1:
3955
other_revision_id = revision[-1].as_revision_id(other_branch)
3956
if len(revision) == 2:
3957
base_revision_id = revision[0].as_revision_id(base_branch)
3958
if other_revision_id is None:
3959
other_revision_id = _mod_revision.ensure_null(
3960
other_branch.last_revision())
3961
# Remember where we merge from
3962
if ((remember or tree.branch.get_submit_branch() is None) and
3963
user_location is not None):
3964
tree.branch.set_submit_branch(other_branch.base)
3965
_merge_tags_if_possible(other_branch, tree.branch)
3966
merger = _mod_merge.Merger.from_revision_ids(pb, tree,
3967
other_revision_id, base_revision_id, other_branch, base_branch)
3968
if other_path != '':
3969
allow_pending = False
3970
merger.interesting_files = [other_path]
3971
else:
3972
allow_pending = True
3973
return merger, allow_pending
3974
3975
def get_merger_from_uncommitted(self, tree, location, pb):
3976
"""Get a merger for uncommitted changes.
3977
3978
:param tree: The tree the merger should apply to.
3979
:param location: The location containing uncommitted changes.
3980
:param pb: The progress bar to use for showing progress.
3981
"""
3982
location = self._select_branch_location(tree, location)[0]
3983
other_tree, other_path = WorkingTree.open_containing(location)
3984
merger = _mod_merge.Merger.from_uncommitted(tree, other_tree, pb)
3985
if other_path != '':
3986
merger.interesting_files = [other_path]
3987
return merger
3988
3989
def _select_branch_location(self, tree, user_location, revision=None,
3990
index=None):
3991
"""Select a branch location, according to possible inputs.
3992
3993
If provided, branches from ``revision`` are preferred. (Both
3994
``revision`` and ``index`` must be supplied.)
3995
3996
Otherwise, the ``location`` parameter is used. If it is None, then the
3997
``submit`` or ``parent`` location is used, and a note is printed.
3998
3999
:param tree: The working tree to select a branch for merging into
4000
:param location: The location entered by the user
4001
:param revision: The revision parameter to the command
4002
:param index: The index to use for the revision parameter. Negative
4003
indices are permitted.
4004
:return: (selected_location, user_location). The default location
4005
will be the user-entered location.
4006
"""
4007
if (revision is not None and index is not None
4008
and revision[index] is not None):
4009
branch = revision[index].get_branch()
4010
if branch is not None:
4011
return branch, branch
4012
if user_location is None:
4013
location = self._get_remembered(tree, 'Merging from')
4014
else:
4015
location = user_location
4016
return location, user_location
4017
4018
def _get_remembered(self, tree, verb_string):
2123
except bzrlib.errors.AmbiguousBase, e:
2124
m = ("sorry, bzr can't determine the right merge base yet\n"
2125
"candidates are:\n "
2126
+ "\n ".join(e.bases)
2127
+ "\n"
2128
"please specify an explicit base with -r,\n"
2129
"and (if you want) report this to the bzr developers\n")
2130
log_error(m)
2131
2132
# TODO: move up to common parent; this isn't merge-specific anymore.
2133
def _get_remembered_parent(self, tree, supplied_location, verb_string):
4019
2134
"""Use tree.branch's parent if none was supplied.
4020
2135
4021
2136
Report if the remembered location was used.
4022
2137
"""
4023
stored_location = tree.branch.get_submit_branch()
4024
stored_location_type = "submit"
4025
if stored_location is None:
4026
stored_location = tree.branch.get_parent()
4027
stored_location_type = "parent"
2138
if supplied_location is not None:
2139
return supplied_location
2140
stored_location = tree.branch.get_parent()
4028
2141
mutter("%s", stored_location)
4029
2142
if stored_location is None:
4030
raise errors.BzrCommandError("No location specified or remembered")
4031
display_url = urlutils.unescape_for_display(stored_location, 'utf-8')
4032
note(u"%s remembered %s location %s", verb_string,
4033
stored_location_type, display_url)
2143
raise BzrCommandError("No location specified or remembered")
2144
display_url = urlutils.unescape_for_display(stored_location, self.outf.encoding)
2145
self.outf.write("%s remembered location %s\n" % (verb_string, display_url))
4034
2146
return stored_location
4035
2147
4036
2148
4037
2149
class cmd_remerge(Command):
4038
__doc__ = """Redo a merge.
2150
"""Redo a merge.
4039
2151
4040
2152
Use this if you want to try a different merge technique while resolving
4041
conflicts. Some merge techniques are better than others, and remerge
2153
conflicts. Some merge techniques are better than others, and remerge
4042
2154
lets you try different ones on different files.
4043
2155
4044
2156
The options for remerge have the same meaning and defaults as the ones for
4045
2157
merge. The difference is that remerge can (only) be run when there is a
4046
2158
pending merge, and it lets you specify particular files.
4047
2159
4048
:Examples:
2160
Examples:
2161
$ bzr remerge --show-base
4049
2162
Re-do the merge of all conflicted files, and show the base text in
4050
conflict regions, in addition to the usual THIS and OTHER texts::
4051
4052
bzr remerge --show-base
4053
2163
conflict regions, in addition to the usual THIS and OTHER texts.
2164
2165
$ bzr remerge --merge-type weave --reprocess foobar
4054
2166
Re-do the merge of "foobar", using the weave merge algorithm, with
4055
additional processing to reduce the size of conflict regions::
4056
4057
bzr remerge --merge-type weave --reprocess foobar
4058
"""
2167
additional processing to reduce the size of conflict regions.
2168
2169
The following merge types are available:"""
4059
2170
takes_args = ['file*']
4060
takes_options = [
4061
'merge-type',
4062
'reprocess',
4063
Option('show-base',
4064
help="Show base revision text in conflicts."),
4065
]
2171
takes_options = ['merge-type', 'reprocess',
2172
Option('show-base', help="Show base revision text in "
2173
"conflicts")]
2174
2175
def help(self):
2176
from merge import merge_type_help
2177
from inspect import getdoc
2178
return getdoc(self) + '\n' + merge_type_help()
4066
2179
4067
2180
def run(self, file_list=None, merge_type=None, show_base=False,
4068
2181
reprocess=False):
4069
from bzrlib.conflicts import restore
2182
from bzrlib.merge import merge_inner, transform_tree
4070
2183
if merge_type is None:
4071
merge_type = _mod_merge.Merge3Merger
2184
merge_type = Merge3Merger
4072
2185
tree, file_list = tree_files(file_list)
4073
self.add_cleanup(tree.lock_write().unlock)
4074
parents = tree.get_parent_ids()
4075
if len(parents) != 2:
4076
raise errors.BzrCommandError("Sorry, remerge only works after normal"
4077
" merges. Not cherrypicking or"
4078
" multi-merges.")
4079
repository = tree.branch.repository
4080
interesting_ids = None
4081
new_conflicts = []
4082
conflicts = tree.conflicts()
4083
if file_list is not None:
4084
interesting_ids = set()
4085
for filename in file_list:
4086
file_id = tree.path2id(filename)
4087
if file_id is None:
4088
raise errors.NotVersionedError(filename)
4089
interesting_ids.add(file_id)
4090
if tree.kind(file_id) != "directory":
4091
continue
4092
4093
for name, ie in tree.inventory.iter_entries(file_id):
4094
interesting_ids.add(ie.file_id)
4095
new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
4096
else:
4097
# Remerge only supports resolving contents conflicts
4098
allowed_conflicts = ('text conflict', 'contents conflict')
4099
restore_files = [c.path for c in conflicts
4100
if c.typestring in allowed_conflicts]
4101
_mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
4102
tree.set_conflicts(ConflictList(new_conflicts))
4103
if file_list is not None:
4104
restore_files = file_list
4105
for filename in restore_files:
4106
try:
4107
restore(tree.abspath(filename))
4108
except errors.NotConflicted:
4109
pass
4110
# Disable pending merges, because the file texts we are remerging
4111
# have not had those merges performed. If we use the wrong parents
4112
# list, we imply that the working tree text has seen and rejected
4113
# all the changes from the other tree, when in fact those changes
4114
# have not yet been seen.
4115
tree.set_parent_ids(parents[:1])
2186
tree.lock_write()
4116
2187
try:
4117
merger = _mod_merge.Merger.from_revision_ids(None, tree, parents[1])
4118
merger.interesting_ids = interesting_ids
4119
merger.merge_type = merge_type
4120
merger.show_base = show_base
4121
merger.reprocess = reprocess
4122
conflicts = merger.do_merge()
2188
pending_merges = tree.pending_merges()
2189
if len(pending_merges) != 1:
2190
raise BzrCommandError("Sorry, remerge only works after normal"
2191
+ " merges. Not cherrypicking or"
2192
+ "multi-merges.")
2193
repository = tree.branch.repository
2194
base_revision = common_ancestor(tree.branch.last_revision(),
2195
pending_merges[0], repository)
2196
base_tree = repository.revision_tree(base_revision)
2197
other_tree = repository.revision_tree(pending_merges[0])
2198
interesting_ids = None
2199
if file_list is not None:
2200
interesting_ids = set()
2201
for filename in file_list:
2202
file_id = tree.path2id(filename)
2203
if file_id is None:
2204
raise NotVersionedError(filename)
2205
interesting_ids.add(file_id)
2206
if tree.kind(file_id) != "directory":
2207
continue
2208
2209
for name, ie in tree.inventory.iter_entries(file_id):
2210
interesting_ids.add(ie.file_id)
2211
transform_tree(tree, tree.basis_tree(), interesting_ids)
2212
if file_list is None:
2213
restore_files = list(tree.iter_conflicts())
2214
else:
2215
restore_files = file_list
2216
for filename in restore_files:
2217
try:
2218
restore(tree.abspath(filename))
2219
except NotConflicted:
2220
pass
2221
conflicts = merge_inner(tree.branch, other_tree, base_tree,
2222
this_tree=tree,
2223
interesting_ids = interesting_ids,
2224
other_rev_id=pending_merges[0],
2225
merge_type=merge_type,
2226
show_base=show_base,
2227
reprocess=reprocess)
4123
2228
finally:
4124
tree.set_parent_ids(parents)
2229
tree.unlock()
4125
2230
if conflicts > 0:
4126
2231
return 1
4127
2232
else:
4128
2233
return 0
4129
2234
4130
4131
2235
class cmd_revert(Command):
4132
__doc__ = """Revert files to a previous revision.
4133
4134
Giving a list of files will revert only those files. Otherwise, all files
4135
will be reverted. If the revision is not specified with '--revision', the
4136
last committed revision is used.
4137
4138
To remove only some changes, without reverting to a prior version, use
4139
merge instead. For example, "merge . --revision -2..-3" will remove the
4140
changes introduced by -2, without affecting the changes introduced by -1.
4141
Or to remove certain changes on a hunk-by-hunk basis, see the Shelf plugin.
4142
4143
By default, any files that have been manually changed will be backed up
4144
first. (Files changed only by merge are not backed up.) Backup files have
4145
'.~#~' appended to their name, where # is a number.
4146
4147
When you provide files, you can use their current pathname or the pathname
4148
from the target revision. So you can use revert to "undelete" a file by
4149
name. If you name a directory, all the contents of that directory will be
4150
reverted.
4151
4152
If you have newly added files since the target revision, they will be
4153
removed. If the files to be removed have been changed, backups will be
4154
created as above. Directories containing unknown files will not be
4155
deleted.
4156
4157
The working tree contains a list of revisions that have been merged but
4158
not yet committed. These revisions will be included as additional parents
4159
of the next commit. Normally, using revert clears that list as well as
4160
reverting the files. If any files are specified, revert leaves the list
4161
of uncommitted merges alone and reverts only the files. Use ``bzr revert
4162
.`` in the tree root to revert all files but keep the recorded merges,
4163
and ``bzr revert --forget-merges`` to clear the pending merge list without
4164
reverting any files.
4165
4166
Using "bzr revert --forget-merges", it is possible to apply all of the
4167
changes from a branch in a single revision. To do this, perform the merge
4168
as desired. Then doing revert with the "--forget-merges" option will keep
4169
the content of the tree as it was, but it will clear the list of pending
4170
merges. The next commit will then contain all of the changes that are
4171
present in the other branch, but without any other parent revisions.
4172
Because this technique forgets where these changes originated, it may
4173
cause additional conflicts on later merges involving the same source and
4174
target branches.
2236
"""Reverse all changes since the last commit.
2237
2238
Only versioned files are affected. Specify filenames to revert only
2239
those files. By default, any files that are changed will be backed up
2240
first. Backup files have a '~' appended to their name.
4175
2241
"""
4176
4177
_see_also = ['cat', 'export']
4178
takes_options = [
4179
'revision',
4180
Option('no-backup', "Do not save backups of reverted files."),
4181
Option('forget-merges',
4182
'Remove pending merge marker, without changing any files.'),
4183
]
2242
takes_options = ['revision', 'no-backup']
4184
2243
takes_args = ['file*']
2244
aliases = ['merge-revert']
4185
2245
4186
def run(self, revision=None, no_backup=False, file_list=None,
4187
forget_merges=None):
2246
def run(self, revision=None, no_backup=False, file_list=None):
2247
from bzrlib.commands import parse_spec
2248
if file_list is not None:
2249
if len(file_list) == 0:
2250
raise BzrCommandError("No files specified")
2251
else:
2252
file_list = []
2253
4188
2254
tree, file_list = tree_files(file_list)
4189
self.add_cleanup(tree.lock_tree_write().unlock)
4190
if forget_merges:
4191
tree.set_parent_ids(tree.get_parent_ids()[:1])
2255
if revision is None:
2256
# FIXME should be tree.last_revision
2257
rev_id = tree.last_revision()
2258
elif len(revision) != 1:
2259
raise BzrCommandError('bzr revert --revision takes exactly 1 argument')
4192
2260
else:
4193
self._revert_tree_to_revision(tree, revision, file_list, no_backup)
4194
4195
@staticmethod
4196
def _revert_tree_to_revision(tree, revision, file_list, no_backup):
4197
rev_tree = _get_one_revision_tree('revert', revision, tree=tree)
4198
tree.revert(file_list, rev_tree, not no_backup, None,
4199
report_changes=True)
2261
rev_id = revision[0].in_history(tree.branch).rev_id
2262
pb = bzrlib.ui.ui_factory.nested_progress_bar()
2263
try:
2264
tree.revert(file_list,
2265
tree.branch.repository.revision_tree(rev_id),
2266
not no_backup, pb)
2267
finally:
2268
pb.finished()
4200
2269
4201
2270
4202
2271
class cmd_assert_fail(Command):
4203
__doc__ = """Test reporting of assertion failures"""
4204
# intended just for use in testing
4205
2272
"""Test reporting of assertion failures"""
4206
2273
hidden = True
4207
4208
2274
def run(self):
4209
raise AssertionError("always fails")
2275
assert False, "always fails"
4210
2276
4211
2277
4212
2278
class cmd_help(Command):
4213
__doc__ = """Show help on a command or other topic.
4214
"""
2279
"""Show help on a command or other topic.
4215
2280
4216
_see_also = ['topics']
4217
takes_options = [
4218
Option('long', 'Show help on all commands.'),
4219
]
2281
For a list of all available commands, say 'bzr help commands'."""
2282
takes_options = [Option('long', 'show help on all commands')]
4220
2283
takes_args = ['topic?']
4221
2284
aliases = ['?', '--help', '-?', '-h']
4222
2285
4223
2286
@display_command
4224
2287
def run(self, topic=None, long=False):
4225
import bzrlib.help
2288
import help
4226
2289
if topic is None and long:
4227
2290
topic = "commands"
4228
bzrlib.help.help(topic)
2291
help.help(topic)
4229
2292
4230
2293
4231
2294
class cmd_shell_complete(Command):
4232
__doc__ = """Show appropriate completions for context.
2295
"""Show appropriate completions for context.
4233
2296
4234
For a list of all available commands, say 'bzr shell-complete'.
4235
"""
2297
For a list of all available commands, say 'bzr shell-complete'."""
4236
2298
takes_args = ['context?']
4237
2299
aliases = ['s-c']
4238
2300
hidden = True
4239
2301
4240
2302
@display_command
4241
2303
def run(self, context=None):
4242
2304
import shellcomplete
4243
2305
shellcomplete.shellcomplete(context)
4244
2306
4245
2307
2308
class cmd_fetch(Command):
2309
"""Copy in history from another branch but don't merge it.
2310
2311
This is an internal method used for pull and merge."""
2312
hidden = True
2313
takes_args = ['from_branch', 'to_branch']
2314
def run(self, from_branch, to_branch):
2315
from bzrlib.fetch import Fetcher
2316
from bzrlib.branch import Branch
2317
from_b = Branch.open(from_branch)
2318
to_b = Branch.open(to_branch)
2319
Fetcher(to_b, from_b)
2320
2321
4246
2322
class cmd_missing(Command):
4247
__doc__ = """Show unmerged/unpulled revisions between two branches.
4248
4249
OTHER_BRANCH may be local or remote.
4250
4251
To filter on a range of revisions, you can use the command -r begin..end
4252
-r revision requests a specific revision, -r ..end or -r begin.. are
4253
also valid.
4254
4255
:Exit values:
4256
1 - some missing revisions
4257
0 - no missing revisions
4258
4259
:Examples:
4260
4261
Determine the missing revisions between this and the branch at the
4262
remembered pull location::
4263
4264
bzr missing
4265
4266
Determine the missing revisions between this and another branch::
4267
4268
bzr missing http://server/branch
4269
4270
Determine the missing revisions up to a specific revision on the other
4271
branch::
4272
4273
bzr missing -r ..-10
4274
4275
Determine the missing revisions up to a specific revision on this
4276
branch::
4277
4278
bzr missing --my-revision ..-10
4279
"""
4280
4281
_see_also = ['merge', 'pull']
2323
"""Show unmerged/unpulled revisions between two branches.
2324
2325
OTHER_BRANCH may be local or remote."""
4282
2326
takes_args = ['other_branch?']
4283
takes_options = [
4284
Option('reverse', 'Reverse the order of revisions.'),
4285
Option('mine-only',
4286
'Display changes in the local branch only.'),
4287
Option('this' , 'Same as --mine-only.'),
4288
Option('theirs-only',
4289
'Display changes in the remote branch only.'),
4290
Option('other', 'Same as --theirs-only.'),
4291
'log-format',
4292
'show-ids',
4293
'verbose',
4294
custom_help('revision',
4295
help='Filter on other branch revisions (inclusive). '
4296
'See "help revisionspec" for details.'),
4297
Option('my-revision',
4298
type=_parse_revision_str,
4299
help='Filter on local branch revisions (inclusive). '
4300
'See "help revisionspec" for details.'),
4301
Option('include-merges',
4302
'Show all revisions in addition to the mainline ones.'),
4303
]
4304
encoding_type = 'replace'
2327
takes_options = [Option('reverse', 'Reverse the order of revisions'),
2328
Option('mine-only',
2329
'Display changes in the local branch only'),
2330
Option('theirs-only',
2331
'Display changes in the remote branch only'),
2332
'log-format',
2333
'line',
2334
'long',
2335
'short',
2336
'show-ids',
2337
'verbose'
2338
]
4305
2339
4306
@display_command
4307
2340
def run(self, other_branch=None, reverse=False, mine_only=False,
4308
theirs_only=False,
4309
log_format=None, long=False, short=False, line=False,
4310
show_ids=False, verbose=False, this=False, other=False,
4311
include_merges=False, revision=None, my_revision=None):
4312
from bzrlib.missing import find_unmerged, iter_log_revisions
4313
def message(s):
4314
if not is_quiet():
4315
self.outf.write(s)
4316
4317
if this:
4318
mine_only = this
4319
if other:
4320
theirs_only = other
4321
# TODO: We should probably check that we don't have mine-only and
4322
# theirs-only set, but it gets complicated because we also have
4323
# this and other which could be used.
4324
restrict = 'all'
4325
if mine_only:
4326
restrict = 'local'
4327
elif theirs_only:
4328
restrict = 'remote'
4329
4330
local_branch = Branch.open_containing(u".")[0]
4331
self.add_cleanup(local_branch.lock_read().unlock)
4332
2341
theirs_only=False, log_format=None, long=False, short=False, line=False,
2342
show_ids=False, verbose=False):
2343
from bzrlib.missing import find_unmerged, iter_log_data
2344
from bzrlib.log import log_formatter
2345
local_branch = bzrlib.branch.Branch.open_containing(u".")[0]
4333
2346
parent = local_branch.get_parent()
4334
2347
if other_branch is None:
4335
2348
other_branch = parent
4336
2349
if other_branch is None:
4337
raise errors.BzrCommandError("No peer location known"
4338
" or specified.")
4339
display_url = urlutils.unescape_for_display(parent,
4340
self.outf.encoding)
4341
message("Using saved parent location: "
4342
+ display_url + "\n")
4343
4344
remote_branch = Branch.open(other_branch)
2350
raise BzrCommandError("No missing location known or specified.")
2351
print "Using last location: " + local_branch.get_parent()
2352
remote_branch = bzrlib.branch.Branch.open(other_branch)
4345
2353
if remote_branch.base == local_branch.base:
4346
2354
remote_branch = local_branch
4347
else:
4348
self.add_cleanup(remote_branch.lock_read().unlock)
4349
4350
local_revid_range = _revision_range_to_revid_range(
4351
_get_revision_range(my_revision, local_branch,
4352
self.name()))
4353
4354
remote_revid_range = _revision_range_to_revid_range(
4355
_get_revision_range(revision,
4356
remote_branch, self.name()))
4357
4358
local_extra, remote_extra = find_unmerged(
4359
local_branch, remote_branch, restrict,
4360
backward=not reverse,
4361
include_merges=include_merges,
4362
local_revid_range=local_revid_range,
4363
remote_revid_range=remote_revid_range)
4364
4365
if log_format is None:
4366
registry = log.log_formatter_registry
4367
log_format = registry.get_default(local_branch)
4368
lf = log_format(to_file=self.outf,
4369
show_ids=show_ids,
4370
show_timezone='original')
4371
4372
status_code = 0
4373
if local_extra and not theirs_only:
4374
message("You have %d extra revision(s):\n" %
4375
len(local_extra))
4376
for revision in iter_log_revisions(local_extra,
4377
local_branch.repository,
4378
verbose):
4379
lf.log_revision(revision)
4380
printed_local = True
4381
status_code = 1
4382
else:
4383
printed_local = False
4384
4385
if remote_extra and not mine_only:
4386
if printed_local is True:
4387
message("\n\n\n")
4388
message("You are missing %d revision(s):\n" %
4389
len(remote_extra))
4390
for revision in iter_log_revisions(remote_extra,
4391
remote_branch.repository,
4392
verbose):
4393
lf.log_revision(revision)
4394
status_code = 1
4395
4396
if mine_only and not local_extra:
4397
# We checked local, and found nothing extra
4398
message('This branch is up to date.\n')
4399
elif theirs_only and not remote_extra:
4400
# We checked remote, and found nothing extra
4401
message('Other branch is up to date.\n')
4402
elif not (mine_only or theirs_only or local_extra or
4403
remote_extra):
4404
# We checked both branches, and neither one had extra
4405
# revisions
4406
message("Branches are up to date.\n")
4407
self.cleanup_now()
2355
local_branch.lock_read()
2356
try:
2357
remote_branch.lock_read()
2358
try:
2359
local_extra, remote_extra = find_unmerged(local_branch, remote_branch)
2360
if (log_format == None):
2361
default = bzrlib.config.BranchConfig(local_branch).log_format()
2362
log_format = get_log_format(long=long, short=short, line=line, default=default)
2363
lf = log_formatter(log_format, sys.stdout,
2364
show_ids=show_ids,
2365
show_timezone='original')
2366
if reverse is False:
2367
local_extra.reverse()
2368
remote_extra.reverse()
2369
if local_extra and not theirs_only:
2370
print "You have %d extra revision(s):" % len(local_extra)
2371
for data in iter_log_data(local_extra, local_branch.repository,
2372
verbose):
2373
lf.show(*data)
2374
printed_local = True
2375
else:
2376
printed_local = False
2377
if remote_extra and not mine_only:
2378
if printed_local is True:
2379
print "\n\n"
2380
print "You are missing %d revision(s):" % len(remote_extra)
2381
for data in iter_log_data(remote_extra, remote_branch.repository,
2382
verbose):
2383
lf.show(*data)
2384
if not remote_extra and not local_extra:
2385
status_code = 0
2386
print "Branches are up to date."
2387
else:
2388
status_code = 1
2389
finally:
2390
remote_branch.unlock()
2391
finally:
2392
local_branch.unlock()
4408
2393
if not status_code and parent is None and other_branch is not None:
4409
self.add_cleanup(local_branch.lock_write().unlock)
4410
# handle race conditions - a parent might be set while we run.
4411
if local_branch.get_parent() is None:
4412
local_branch.set_parent(remote_branch.base)
2394
local_branch.lock_write()
2395
try:
2396
# handle race conditions - a parent might be set while we run.
2397
if local_branch.get_parent() is None:
2398
local_branch.set_parent(remote_branch.base)
2399
finally:
2400
local_branch.unlock()
4413
2401
return status_code
4414
2402
4415
2403
4416
class cmd_pack(Command):
4417
__doc__ = """Compress the data within a repository.
4418
4419
This operation compresses the data within a bazaar repository. As
4420
bazaar supports automatic packing of repository, this operation is
4421
normally not required to be done manually.
4422
4423
During the pack operation, bazaar takes a backup of existing repository
4424
data, i.e. pack files. This backup is eventually removed by bazaar
4425
automatically when it is safe to do so. To save disk space by removing
4426
the backed up pack files, the --clean-obsolete-packs option may be
4427
used.
4428
4429
Warning: If you use --clean-obsolete-packs and your machine crashes
4430
during or immediately after repacking, you may be left with a state
4431
where the deletion has been written to disk but the new packs have not
4432
been. In this case the repository may be unusable.
4433
"""
4434
4435
_see_also = ['repositories']
4436
takes_args = ['branch_or_repo?']
4437
takes_options = [
4438
Option('clean-obsolete-packs', 'Delete obsolete packs to save disk space.'),
4439
]
4440
4441
def run(self, branch_or_repo='.', clean_obsolete_packs=False):
4442
dir = bzrdir.BzrDir.open_containing(branch_or_repo)[0]
4443
try:
4444
branch = dir.open_branch()
4445
repository = branch.repository
4446
except errors.NotBranchError:
4447
repository = dir.open_repository()
4448
repository.pack(clean_obsolete_packs=clean_obsolete_packs)
4449
4450
4451
2404
class cmd_plugins(Command):
4452
__doc__ = """List the installed plugins.
4453
4454
This command displays the list of installed plugins including
4455
version of plugin and a short description of each.
4456
4457
--verbose shows the path where each plugin is located.
4458
4459
A plugin is an external component for Bazaar that extends the
4460
revision control system, by adding or replacing code in Bazaar.
4461
Plugins can do a variety of things, including overriding commands,
4462
adding new commands, providing additional network transports and
4463
customizing log output.
4464
4465
See the Bazaar Plugin Guide <http://doc.bazaar.canonical.com/plugins/en/>
4466
for further information on plugins including where to find them and how to
4467
install them. Instructions are also provided there on how to write new
4468
plugins using the Python programming language.
4469
"""
4470
takes_options = ['verbose']
4471
2405
"""List plugins"""
2406
hidden = True
4472
2407
@display_command
4473
def run(self, verbose=False):
2408
def run(self):
4474
2409
import bzrlib.plugin
4475
2410
from inspect import getdoc
4476
result = []
4477
for name, plugin in bzrlib.plugin.plugins().items():
4478
version = plugin.__version__
4479
if version == 'unknown':
4480
version = ''
4481
name_ver = '%s %s' % (name, version)
4482
d = getdoc(plugin.module)
2411
for name, plugin in bzrlib.plugin.all_plugins().items():
2412
if hasattr(plugin, '__path__'):
2413
print plugin.__path__[0]
2414
elif hasattr(plugin, '__file__'):
2415
print plugin.__file__
2416
else:
2417
print `plugin`
2418
2419
d = getdoc(plugin)
4483
2420
if d:
4484
doc = d.split('\n')[0]
4485
else:
4486
doc = '(no description)'
4487
result.append((name_ver, doc, plugin.path()))
4488
for name_ver, doc, path in sorted(result):
4489
self.outf.write("%s\n" % name_ver)
4490
self.outf.write(" %s\n" % doc)
4491
if verbose:
4492
self.outf.write(" %s\n" % path)
4493
self.outf.write("\n")
2421
print '\t', d.split('\n')[0]
4494
2422
4495
2423
4496
2424
class cmd_testament(Command):
4497
__doc__ = """Show testament (signing-form) of a revision."""
4498
takes_options = [
4499
'revision',
4500
Option('long', help='Produce long-format testament.'),
4501
Option('strict',
4502
help='Produce a strict-format testament.')]
2425
"""Show testament (signing-form) of a revision."""
2426
takes_options = ['revision', 'long']
4503
2427
takes_args = ['branch?']
4504
2428
@display_command
4505
def run(self, branch=u'.', revision=None, long=False, strict=False):
4506
from bzrlib.testament import Testament, StrictTestament
4507
if strict is True:
4508
testament_class = StrictTestament
4509
else:
4510
testament_class = Testament
4511
if branch == '.':
4512
b = Branch.open_containing(branch)[0]
4513
else:
4514
b = Branch.open(branch)
4515
self.add_cleanup(b.lock_read().unlock)
4516
if revision is None:
4517
rev_id = b.last_revision()
4518
else:
4519
rev_id = revision[0].as_revision_id(b)
4520
t = testament_class.from_revision(b.repository, rev_id)
4521
if long:
4522
sys.stdout.writelines(t.as_text_lines())
4523
else:
4524
sys.stdout.write(t.as_short_text())
2429
def run(self, branch=u'.', revision=None, long=False):
2430
from bzrlib.testament import Testament
2431
b = WorkingTree.open_containing(branch)[0].branch
2432
b.lock_read()
2433
try:
2434
if revision is None:
2435
rev_id = b.last_revision()
2436
else:
2437
rev_id = revision[0].in_history(b).rev_id
2438
t = Testament.from_revision(b.repository, rev_id)
2439
if long:
2440
sys.stdout.writelines(t.as_text_lines())
2441
else:
2442
sys.stdout.write(t.as_short_text())
2443
finally:
2444
b.unlock()
4525
2445
4526
2446
4527
2447
class cmd_annotate(Command):
4528
__doc__ = """Show the origin of each line in a file.
2448
"""Show the origin of each line in a file.
4529
2449
4530
2450
This prints out the given file with an annotation on the left side
4531
2451
indicating which revision, author and date introduced the change.
4532
2452
4533
If the origin is the same for a run of consecutive lines, it is
2453
If the origin is the same for a run of consecutive lines, it is
4534
2454
shown only at the top, unless the --all option is given.
4535
2455
"""
4536
2456
# TODO: annotate directories; showing when each file was last changed
4537
# TODO: if the working copy is modified, show annotations on that
2457
# TODO: if the working copy is modified, show annotations on that
4538
2458
# with new uncommitted lines marked
4539
aliases = ['ann', 'blame', 'praise']
2459
aliases = ['blame', 'praise']
4540
2460
takes_args = ['filename']
4541
takes_options = [Option('all', help='Show annotations on all lines.'),
4542
Option('long', help='Show commit date in annotations.'),
4543
'revision',
4544
'show-ids',
2461
takes_options = [Option('all', help='show annotations on all lines'),
2462
Option('long', help='show date in annotations'),
2463
'revision'
4545
2464
]
4546
encoding_type = 'exact'
4547
2465
4548
2466
@display_command
4549
def run(self, filename, all=False, long=False, revision=None,
4550
show_ids=False):
4551
from bzrlib.annotate import annotate_file, annotate_file_tree
4552
wt, branch, relpath = \
4553
bzrdir.BzrDir.open_containing_tree_or_branch(filename)
4554
if wt is not None:
4555
self.add_cleanup(wt.lock_read().unlock)
4556
else:
4557
self.add_cleanup(branch.lock_read().unlock)
4558
tree = _get_one_revision_tree('annotate', revision, branch=branch)
4559
self.add_cleanup(tree.lock_read().unlock)
4560
if wt is not None:
4561
file_id = wt.path2id(relpath)
4562
else:
4563
file_id = tree.path2id(relpath)
4564
if file_id is None:
4565
raise errors.NotVersionedError(filename)
4566
file_version = tree.inventory[file_id].revision
4567
if wt is not None and revision is None:
4568
# If there is a tree and we're not annotating historical
4569
# versions, annotate the working tree's content.
4570
annotate_file_tree(wt, file_id, self.outf, long, all,
4571
show_ids=show_ids)
4572
else:
4573
annotate_file(branch, file_version, file_id, long, all, self.outf,
4574
show_ids=show_ids)
2467
def run(self, filename, all=False, long=False, revision=None):
2468
from bzrlib.annotate import annotate_file
2469
tree, relpath = WorkingTree.open_containing(filename)
2470
branch = tree.branch
2471
branch.lock_read()
2472
try:
2473
if revision is None:
2474
revision_id = branch.last_revision()
2475
elif len(revision) != 1:
2476
raise BzrCommandError('bzr annotate --revision takes exactly 1 argument')
2477
else:
2478
revision_id = revision[0].in_history(branch).rev_id
2479
file_id = tree.inventory.path2id(relpath)
2480
tree = branch.repository.revision_tree(revision_id)
2481
file_version = tree.inventory[file_id].revision
2482
annotate_file(branch, file_version, file_id, long, all, sys.stdout)
2483
finally:
2484
branch.unlock()
4575
2485
4576
2486
4577
2487
class cmd_re_sign(Command):
4578
__doc__ = """Create a digital signature for an existing revision."""
2488
"""Create a digital signature for an existing revision."""
4579
2489
# TODO be able to replace existing ones.
4580
2490
4581
2491
hidden = True # is this right ?
4582
2492
takes_args = ['revision_id*']
4583
2493
takes_options = ['revision']
4584
2494
4585
2495
def run(self, revision_id_list=None, revision=None):
2496
import bzrlib.config as config
2497
import bzrlib.gpg as gpg
4586
2498
if revision_id_list is not None and revision is not None:
4587
raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
2499
raise BzrCommandError('You can only supply one of revision_id or --revision')
4588
2500
if revision_id_list is None and revision is None:
4589
raise errors.BzrCommandError('You must supply either --revision or a revision_id')
2501
raise BzrCommandError('You must supply either --revision or a revision_id')
4590
2502
b = WorkingTree.open_containing(u'.')[0].branch
4591
self.add_cleanup(b.lock_write().unlock)
4592
return self._run(b, revision_id_list, revision)
4593
4594
def _run(self, b, revision_id_list, revision):
4595
import bzrlib.gpg as gpg
4596
gpg_strategy = gpg.GPGStrategy(b.get_config())
2503
gpg_strategy = gpg.GPGStrategy(config.BranchConfig(b))
4597
2504
if revision_id_list is not None:
4598
b.repository.start_write_group()
4599
try:
4600
for revision_id in revision_id_list:
4601
b.repository.sign_revision(revision_id, gpg_strategy)
4602
except:
4603
b.repository.abort_write_group()
4604
raise
4605
else:
4606
b.repository.commit_write_group()
2505
for revision_id in revision_id_list:
2506
b.repository.sign_revision(revision_id, gpg_strategy)
4607
2507
elif revision is not None:
4608
2508
if len(revision) == 1:
4609
2509
revno, rev_id = revision[0].in_history(b)
4610
b.repository.start_write_group()
4611
try:
4612
b.repository.sign_revision(rev_id, gpg_strategy)
4613
except:
4614
b.repository.abort_write_group()
4615
raise
4616
else:
4617
b.repository.commit_write_group()
2510
b.repository.sign_revision(rev_id, gpg_strategy)
4618
2511
elif len(revision) == 2:
4619
2512
# are they both on rh- if so we can walk between them
4620
2513
# might be nice to have a range helper for arbitrary
4624
2517
if to_revid is None:
4625
2518
to_revno = b.revno()
4626
2519
if from_revno is None or to_revno is None:
4627
raise errors.BzrCommandError('Cannot sign a range of non-revision-history revisions')
4628
b.repository.start_write_group()
4629
try:
4630
for revno in range(from_revno, to_revno + 1):
4631
b.repository.sign_revision(b.get_rev_id(revno),
4632
gpg_strategy)
4633
except:
4634
b.repository.abort_write_group()
4635
raise
4636
else:
4637
b.repository.commit_write_group()
2520
raise BzrCommandError('Cannot sign a range of non-revision-history revisions')
2521
for revno in range(from_revno, to_revno + 1):
2522
b.repository.sign_revision(b.get_rev_id(revno),
2523
gpg_strategy)
4638
2524
else:
4639
raise errors.BzrCommandError('Please supply either one revision, or a range.')
2525
raise BzrCommandError('Please supply either one revision, or a range.')
4640
2526
4641
2527
4642
2528
class cmd_bind(Command):
4643
__doc__ = """Convert the current branch into a checkout of the supplied branch.
4644
If no branch is supplied, rebind to the last bound location.
4645
4646
Once converted into a checkout, commits must succeed on the master branch
4647
before they will be applied to the local branch.
4648
4649
Bound branches use the nickname of its master branch unless it is set
4650
locally, in which case binding will update the local nickname to be
4651
that of the master.
2529
"""Bind the current branch to a master branch.
2530
2531
After binding, commits must succeed on the master branch
2532
before they are executed on the local one.
4652
2533
"""
4653
2534
4654
_see_also = ['checkouts', 'unbind']
4655
takes_args = ['location?']
2535
takes_args = ['location']
4656
2536
takes_options = []
4657
2537
4658
2538
def run(self, location=None):
4659
2539
b, relpath = Branch.open_containing(u'.')
4660
if location is None:
4661
try:
4662
location = b.get_old_bound_location()
4663
except errors.UpgradeRequired:
4664
raise errors.BzrCommandError('No location supplied. '
4665
'This format does not remember old locations.')
4666
else:
4667
if location is None:
4668
if b.get_bound_location() is not None:
4669
raise errors.BzrCommandError('Branch is already bound')
4670
else:
4671
raise errors.BzrCommandError('No location supplied '
4672
'and no previous location known')
4673
2540
b_other = Branch.open(location)
4674
2541
try:
4675
2542
b.bind(b_other)
4676
except errors.DivergedBranches:
4677
raise errors.BzrCommandError('These branches have diverged.'
4678
' Try merging, and then bind again.')
4679
if b.get_config().has_explicit_nickname():
4680
b.nick = b_other.nick
2543
except DivergedBranches:
2544
raise BzrCommandError('These branches have diverged.'
2545
' Try merging, and then bind again.')
4681
2546
4682
2547
4683
2548
class cmd_unbind(Command):
4684
__doc__ = """Convert the current checkout into a regular branch.
2549
"""Unbind the current branch from its master branch.
4685
2550
4686
After unbinding, the local branch is considered independent and subsequent
4687
commits will be local only.
2551
After unbinding, the local branch is considered independent.
2552
All subsequent commits will be local.
4688
2553
"""
4689
2554
4690
_see_also = ['checkouts', 'bind']
4691
2555
takes_args = []
4692
2556
takes_options = []
4693
2557
4694
2558
def run(self):
4695
2559
b, relpath = Branch.open_containing(u'.')
4696
2560
if not b.unbind():
4697
raise errors.BzrCommandError('Local branch is not bound')
4698
4699
4700
class cmd_uncommit(Command):
4701
__doc__ = """Remove the last committed revision.
2561
raise BzrCommandError('Local branch is not bound')
2562
2563
2564
class cmd_uncommit(bzrlib.commands.Command):
2565
"""Remove the last committed revision.
4702
2566
4703
2567
--verbose will print out what is being removed.
4704
2568
--dry-run will go through all the motions, but not actually
4705
2569
remove anything.
4706
4707
If --revision is specified, uncommit revisions to leave the branch at the
4708
specified revision. For example, "bzr uncommit -r 15" will leave the
4709
branch at revision 15.
4710
4711
Uncommit leaves the working tree ready for a new commit. The only change
4712
it may make is to restore any pending merges that were present before
4713
the commit.
2570
2571
In the future, uncommit will create a revision bundle, which can then
2572
be re-applied.
4714
2573
"""
4715
2574
4716
2575
# TODO: jam 20060108 Add an option to allow uncommit to remove
4717
2576
# unreferenced information in 'branch-as-repository' branches.
4718
2577
# TODO: jam 20060108 Add the ability for uncommit to remove unreferenced
4719
2578
# information in shared branches as well.
4720
_see_also = ['commit']
4721
2579
takes_options = ['verbose', 'revision',
4722
Option('dry-run', help='Don\'t actually make changes.'),
4723
Option('force', help='Say yes to all questions.'),
4724
Option('local',
4725
help="Only remove the commits from the local branch"
4726
" when in a checkout."
4727
),
4728
]
2580
Option('dry-run', help='Don\'t actually make changes'),
2581
Option('force', help='Say yes to all questions.')]
4729
2582
takes_args = ['location?']
4730
2583
aliases = []
4731
encoding_type = 'replace'
4732
2584
4733
def run(self, location=None,
2585
def run(self, location=None,
4734
2586
dry_run=False, verbose=False,
4735
revision=None, force=False, local=False):
2587
revision=None, force=False):
2588
from bzrlib.branch import Branch
2589
from bzrlib.log import log_formatter
2590
import sys
2591
from bzrlib.uncommit import uncommit
2592
4736
2593
if location is None:
4737
2594
location = u'.'
4738
2595
control, relpath = bzrdir.BzrDir.open_containing(location)
4743
2600
tree = None
4744
2601
b = control.open_branch()
4745
2602
4746
if tree is not None:
4747
self.add_cleanup(tree.lock_write().unlock)
4748
else:
4749
self.add_cleanup(b.lock_write().unlock)
4750
return self._run(b, tree, dry_run, verbose, revision, force, local=local)
4751
4752
def _run(self, b, tree, dry_run, verbose, revision, force, local=False):
4753
from bzrlib.log import log_formatter, show_log
4754
from bzrlib.uncommit import uncommit
4755
4756
last_revno, last_rev_id = b.last_revision_info()
4757
4758
rev_id = None
4759
2603
if revision is None:
4760
revno = last_revno
4761
rev_id = last_rev_id
2604
revno = b.revno()
2605
rev_id = b.last_revision()
4762
2606
else:
4763
# 'bzr uncommit -r 10' actually means uncommit
4764
# so that the final tree is at revno 10.
4765
# but bzrlib.uncommit.uncommit() actually uncommits
4766
# the revisions that are supplied.
4767
# So we need to offset it by one
4768
revno = revision[0].in_history(b).revno + 1
4769
if revno <= last_revno:
4770
rev_id = b.get_rev_id(revno)
4771
4772
if rev_id is None or _mod_revision.is_null(rev_id):
4773
self.outf.write('No revisions to uncommit.\n')
4774
return 1
4775
4776
lf = log_formatter('short',
4777
to_file=self.outf,
4778
show_timezone='original')
4779
4780
show_log(b,
4781
lf,
4782
verbose=False,
4783
direction='forward',
4784
start_revision=revno,
4785
end_revision=last_revno)
2607
revno, rev_id = revision[0].in_history(b)
2608
if rev_id is None:
2609
print 'No revisions to uncommit.'
2610
2611
for r in range(revno, b.revno()+1):
2612
rev_id = b.get_rev_id(r)
2613
lf = log_formatter('short', to_file=sys.stdout,show_timezone='original')
2614
lf.show(r, b.repository.get_revision(rev_id), None)
4786
2615
4787
2616
if dry_run:
4788
self.outf.write('Dry-run, pretending to remove'
4789
' the above revisions.\n')
2617
print 'Dry-run, pretending to remove the above revisions.'
2618
if not force:
2619
val = raw_input('Press <enter> to continue')
4790
2620
else:
4791
self.outf.write('The above revision(s) will be removed.\n')
4792
4793
if not force:
4794
if not ui.ui_factory.get_boolean('Are you sure'):
4795
self.outf.write('Canceled')
4796
return 0
4797
4798
mutter('Uncommitting from {%s} to {%s}',
4799
last_rev_id, rev_id)
2621
print 'The above revision(s) will be removed.'
2622
if not force:
2623
val = raw_input('Are you sure [y/N]? ')
2624
if val.lower() not in ('y', 'yes'):
2625
print 'Canceled'
2626
return 0
2627
4800
2628
uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
4801
revno=revno, local=local)
4802
self.outf.write('You can restore the old tip by running:\n'
4803
' bzr pull . -r revid:%s\n' % last_rev_id)
2629
revno=revno)
4804
2630
4805
2631
4806
2632
class cmd_break_lock(Command):
4807
__doc__ = """Break a dead lock on a repository, branch or working directory.
2633
"""Break a dead lock on a repository, branch or working directory.
4808
2634
4809
2635
CAUTION: Locks should only be broken when you are sure that the process
4810
2636
holding the lock has been stopped.
4811
2637
4812
You can get information on what locks are open via the 'bzr info
4813
[location]' command.
4814
4815
:Examples:
2638
You can get information on what locks are open via the 'bzr info' command.
2639
2640
example:
4816
2641
bzr break-lock
4817
bzr break-lock bzr+ssh://example.com/bzr/foo
4818
2642
"""
4819
2643
takes_args = ['location?']
4820
2644
4826
2650
control.break_lock()
4827
2651
except NotImplementedError:
4828
2652
pass
4829
4830
4831
class cmd_wait_until_signalled(Command):
4832
__doc__ = """Test helper for test_start_and_stop_bzr_subprocess_send_signal.
4833
4834
This just prints a line to signal when it is ready, then blocks on stdin.
4835
"""
4836
4837
hidden = True
4838
4839
def run(self):
4840
sys.stdout.write("running\n")
4841
sys.stdout.flush()
4842
sys.stdin.readline()
4843
4844
4845
class cmd_serve(Command):
4846
__doc__ = """Run the bzr server."""
4847
4848
aliases = ['server']
4849
4850
takes_options = [
4851
Option('inet',
4852
help='Serve on stdin/out for use from inetd or sshd.'),
4853
RegistryOption('protocol',
4854
help="Protocol to serve.",
4855
lazy_registry=('bzrlib.transport', 'transport_server_registry'),
4856
value_switches=True),
4857
Option('port',
4858
help='Listen for connections on nominated port of the form '
4859
'[hostname:]portnumber. Passing 0 as the port number will '
4860
'result in a dynamically allocated port. The default port '
4861
'depends on the protocol.',
4862
type=str),
4863
Option('directory',
4864
help='Serve contents of this directory.',
4865
type=unicode),
4866
Option('allow-writes',
4867
help='By default the server is a readonly server. Supplying '
4868
'--allow-writes enables write access to the contents of '
4869
'the served directory and below. Note that ``bzr serve`` '
4870
'does not perform authentication, so unless some form of '
4871
'external authentication is arranged supplying this '
4872
'option leads to global uncontrolled write access to your '
4873
'file system.'
4874
),
4875
]
4876
4877
def get_host_and_port(self, port):
4878
"""Return the host and port to run the smart server on.
4879
4880
If 'port' is None, None will be returned for the host and port.
4881
4882
If 'port' has a colon in it, the string before the colon will be
4883
interpreted as the host.
4884
4885
:param port: A string of the port to run the server on.
4886
:return: A tuple of (host, port), where 'host' is a host name or IP,
4887
and port is an integer TCP/IP port.
4888
"""
4889
host = None
4890
if port is not None:
4891
if ':' in port:
4892
host, port = port.split(':')
4893
port = int(port)
4894
return host, port
4895
4896
def run(self, port=None, inet=False, directory=None, allow_writes=False,
4897
protocol=None):
4898
from bzrlib.transport import get_transport, transport_server_registry
4899
if directory is None:
4900
directory = os.getcwd()
4901
if protocol is None:
4902
protocol = transport_server_registry.get()
4903
host, port = self.get_host_and_port(port)
4904
url = urlutils.local_path_to_url(directory)
4905
if not allow_writes:
4906
url = 'readonly+' + url
4907
transport = get_transport(url)
4908
protocol(transport, host, port, inet)
4909
4910
4911
class cmd_join(Command):
4912
__doc__ = """Combine a tree into its containing tree.
4913
4914
This command requires the target tree to be in a rich-root format.
4915
4916
The TREE argument should be an independent tree, inside another tree, but
4917
not part of it. (Such trees can be produced by "bzr split", but also by
4918
running "bzr branch" with the target inside a tree.)
4919
4920
The result is a combined tree, with the subtree no longer an independant
4921
part. This is marked as a merge of the subtree into the containing tree,
4922
and all history is preserved.
4923
"""
4924
4925
_see_also = ['split']
4926
takes_args = ['tree']
4927
takes_options = [
4928
Option('reference', help='Join by reference.', hidden=True),
4929
]
4930
4931
def run(self, tree, reference=False):
4932
sub_tree = WorkingTree.open(tree)
4933
parent_dir = osutils.dirname(sub_tree.basedir)
4934
containing_tree = WorkingTree.open_containing(parent_dir)[0]
4935
repo = containing_tree.branch.repository
4936
if not repo.supports_rich_root():
4937
raise errors.BzrCommandError(
4938
"Can't join trees because %s doesn't support rich root data.\n"
4939
"You can use bzr upgrade on the repository."
4940
% (repo,))
4941
if reference:
4942
try:
4943
containing_tree.add_reference(sub_tree)
4944
except errors.BadReferenceTarget, e:
4945
# XXX: Would be better to just raise a nicely printable
4946
# exception from the real origin. Also below. mbp 20070306
4947
raise errors.BzrCommandError("Cannot join %s. %s" %
4948
(tree, e.reason))
4949
else:
4950
try:
4951
containing_tree.subsume(sub_tree)
4952
except errors.BadSubsumeSource, e:
4953
raise errors.BzrCommandError("Cannot join %s. %s" %
4954
(tree, e.reason))
4955
4956
4957
class cmd_split(Command):
4958
__doc__ = """Split a subdirectory of a tree into a separate tree.
4959
4960
This command will produce a target tree in a format that supports
4961
rich roots, like 'rich-root' or 'rich-root-pack'. These formats cannot be
4962
converted into earlier formats like 'dirstate-tags'.
4963
4964
The TREE argument should be a subdirectory of a working tree. That
4965
subdirectory will be converted into an independent tree, with its own
4966
branch. Commits in the top-level tree will not apply to the new subtree.
4967
"""
4968
4969
_see_also = ['join']
4970
takes_args = ['tree']
4971
4972
def run(self, tree):
4973
containing_tree, subdir = WorkingTree.open_containing(tree)
4974
sub_id = containing_tree.path2id(subdir)
4975
if sub_id is None:
4976
raise errors.NotVersionedError(subdir)
4977
try:
4978
containing_tree.extract(sub_id)
4979
except errors.RootNotRich:
4980
raise errors.RichRootUpgradeRequired(containing_tree.branch.base)
4981
4982
4983
class cmd_merge_directive(Command):
4984
__doc__ = """Generate a merge directive for auto-merge tools.
4985
4986
A directive requests a merge to be performed, and also provides all the
4987
information necessary to do so. This means it must either include a
4988
revision bundle, or the location of a branch containing the desired
4989
revision.
4990
4991
A submit branch (the location to merge into) must be supplied the first
4992
time the command is issued. After it has been supplied once, it will
4993
be remembered as the default.
4994
4995
A public branch is optional if a revision bundle is supplied, but required
4996
if --diff or --plain is specified. It will be remembered as the default
4997
after the first use.
4998
"""
4999
5000
takes_args = ['submit_branch?', 'public_branch?']
5001
5002
hidden = True
5003
5004
_see_also = ['send']
5005
5006
takes_options = [
5007
RegistryOption.from_kwargs('patch-type',
5008
'The type of patch to include in the directive.',
5009
title='Patch type',
5010
value_switches=True,
5011
enum_switch=False,
5012
bundle='Bazaar revision bundle (default).',
5013
diff='Normal unified diff.',
5014
plain='No patch, just directive.'),
5015
Option('sign', help='GPG-sign the directive.'), 'revision',
5016
Option('mail-to', type=str,
5017
help='Instead of printing the directive, email to this address.'),
5018
Option('message', type=str, short_name='m',
5019
help='Message to use when committing this merge.')
5020
]
5021
5022
encoding_type = 'exact'
5023
5024
def run(self, submit_branch=None, public_branch=None, patch_type='bundle',
5025
sign=False, revision=None, mail_to=None, message=None):
5026
from bzrlib.revision import ensure_null, NULL_REVISION
5027
include_patch, include_bundle = {
5028
'plain': (False, False),
5029
'diff': (True, False),
5030
'bundle': (True, True),
5031
}[patch_type]
5032
branch = Branch.open('.')
5033
stored_submit_branch = branch.get_submit_branch()
5034
if submit_branch is None:
5035
submit_branch = stored_submit_branch
5036
else:
5037
if stored_submit_branch is None:
5038
branch.set_submit_branch(submit_branch)
5039
if submit_branch is None:
5040
submit_branch = branch.get_parent()
5041
if submit_branch is None:
5042
raise errors.BzrCommandError('No submit branch specified or known')
5043
5044
stored_public_branch = branch.get_public_branch()
5045
if public_branch is None:
5046
public_branch = stored_public_branch
5047
elif stored_public_branch is None:
5048
branch.set_public_branch(public_branch)
5049
if not include_bundle and public_branch is None:
5050
raise errors.BzrCommandError('No public branch specified or'
5051
' known')
5052
base_revision_id = None
5053
if revision is not None:
5054
if len(revision) > 2:
5055
raise errors.BzrCommandError('bzr merge-directive takes '
5056
'at most two one revision identifiers')
5057
revision_id = revision[-1].as_revision_id(branch)
5058
if len(revision) == 2:
5059
base_revision_id = revision[0].as_revision_id(branch)
5060
else:
5061
revision_id = branch.last_revision()
5062
revision_id = ensure_null(revision_id)
5063
if revision_id == NULL_REVISION:
5064
raise errors.BzrCommandError('No revisions to bundle.')
5065
directive = merge_directive.MergeDirective2.from_objects(
5066
branch.repository, revision_id, time.time(),
5067
osutils.local_time_offset(), submit_branch,
5068
public_branch=public_branch, include_patch=include_patch,
5069
include_bundle=include_bundle, message=message,
5070
base_revision_id=base_revision_id)
5071
if mail_to is None:
5072
if sign:
5073
self.outf.write(directive.to_signed(branch))
5074
else:
5075
self.outf.writelines(directive.to_lines())
5076
else:
5077
message = directive.to_email(mail_to, branch, sign)
5078
s = SMTPConnection(branch.get_config())
5079
s.send_email(message)
5080
5081
5082
class cmd_send(Command):
5083
__doc__ = """Mail or create a merge-directive for submitting changes.
5084
5085
A merge directive provides many things needed for requesting merges:
5086
5087
* A machine-readable description of the merge to perform
5088
5089
* An optional patch that is a preview of the changes requested
5090
5091
* An optional bundle of revision data, so that the changes can be applied
5092
directly from the merge directive, without retrieving data from a
5093
branch.
5094
5095
`bzr send` creates a compact data set that, when applied using bzr
5096
merge, has the same effect as merging from the source branch.
5097
5098
By default the merge directive is self-contained and can be applied to any
5099
branch containing submit_branch in its ancestory without needing access to
5100
the source branch.
5101
5102
If --no-bundle is specified, then Bazaar doesn't send the contents of the
5103
revisions, but only a structured request to merge from the
5104
public_location. In that case the public_branch is needed and it must be
5105
up-to-date and accessible to the recipient. The public_branch is always
5106
included if known, so that people can check it later.
5107
5108
The submit branch defaults to the parent of the source branch, but can be
5109
overridden. Both submit branch and public branch will be remembered in
5110
branch.conf the first time they are used for a particular branch. The
5111
source branch defaults to that containing the working directory, but can
5112
be changed using --from.
5113
5114
In order to calculate those changes, bzr must analyse the submit branch.
5115
Therefore it is most efficient for the submit branch to be a local mirror.
5116
If a public location is known for the submit_branch, that location is used
5117
in the merge directive.
5118
5119
The default behaviour is to send the merge directive by mail, unless -o is
5120
given, in which case it is sent to a file.
5121
5122
Mail is sent using your preferred mail program. This should be transparent
5123
on Windows (it uses MAPI). On Linux, it requires the xdg-email utility.
5124
If the preferred client can't be found (or used), your editor will be used.
5125
5126
To use a specific mail program, set the mail_client configuration option.
5127
(For Thunderbird 1.5, this works around some bugs.) Supported values for
5128
specific clients are "claws", "evolution", "kmail", "mail.app" (MacOS X's
5129
Mail.app), "mutt", and "thunderbird"; generic options are "default",
5130
"editor", "emacsclient", "mapi", and "xdg-email". Plugins may also add
5131
supported clients.
5132
5133
If mail is being sent, a to address is required. This can be supplied
5134
either on the commandline, by setting the submit_to configuration
5135
option in the branch itself or the child_submit_to configuration option
5136
in the submit branch.
5137
5138
Two formats are currently supported: "4" uses revision bundle format 4 and
5139
merge directive format 2. It is significantly faster and smaller than
5140
older formats. It is compatible with Bazaar 0.19 and later. It is the
5141
default. "0.9" uses revision bundle format 0.9 and merge directive
5142
format 1. It is compatible with Bazaar 0.12 - 0.18.
5143
5144
The merge directives created by bzr send may be applied using bzr merge or
5145
bzr pull by specifying a file containing a merge directive as the location.
5146
5147
bzr send makes extensive use of public locations to map local locations into
5148
URLs that can be used by other people. See `bzr help configuration` to
5149
set them, and use `bzr info` to display them.
5150
"""
5151
5152
encoding_type = 'exact'
5153
5154
_see_also = ['merge', 'pull']
5155
5156
takes_args = ['submit_branch?', 'public_branch?']
5157
5158
takes_options = [
5159
Option('no-bundle',
5160
help='Do not include a bundle in the merge directive.'),
5161
Option('no-patch', help='Do not include a preview patch in the merge'
5162
' directive.'),
5163
Option('remember',
5164
help='Remember submit and public branch.'),
5165
Option('from',
5166
help='Branch to generate the submission from, '
5167
'rather than the one containing the working directory.',
5168
short_name='f',
5169
type=unicode),
5170
Option('output', short_name='o',
5171
help='Write merge directive to this file or directory; '
5172
'use - for stdout.',
5173
type=unicode),
5174
Option('strict',
5175
help='Refuse to send if there are uncommitted changes in'
5176
' the working tree, --no-strict disables the check.'),
5177
Option('mail-to', help='Mail the request to this address.',
5178
type=unicode),
5179
'revision',
5180
'message',
5181
Option('body', help='Body for the email.', type=unicode),
5182
RegistryOption('format',
5183
help='Use the specified output format.',
5184
lazy_registry=('bzrlib.send', 'format_registry')),
5185
]
5186
5187
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
5188
no_patch=False, revision=None, remember=False, output=None,
5189
format=None, mail_to=None, message=None, body=None,
5190
strict=None, **kwargs):
5191
from bzrlib.send import send
5192
return send(submit_branch, revision, public_branch, remember,
5193
format, no_bundle, no_patch, output,
5194
kwargs.get('from', '.'), mail_to, message, body,
5195
self.outf,
5196
strict=strict)
5197
5198
5199
class cmd_bundle_revisions(cmd_send):
5200
__doc__ = """Create a merge-directive for submitting changes.
5201
5202
A merge directive provides many things needed for requesting merges:
5203
5204
* A machine-readable description of the merge to perform
5205
5206
* An optional patch that is a preview of the changes requested
5207
5208
* An optional bundle of revision data, so that the changes can be applied
5209
directly from the merge directive, without retrieving data from a
5210
branch.
5211
5212
If --no-bundle is specified, then public_branch is needed (and must be
5213
up-to-date), so that the receiver can perform the merge using the
5214
public_branch. The public_branch is always included if known, so that
5215
people can check it later.
5216
5217
The submit branch defaults to the parent, but can be overridden. Both
5218
submit branch and public branch will be remembered if supplied.
5219
5220
If a public_branch is known for the submit_branch, that public submit
5221
branch is used in the merge instructions. This means that a local mirror
5222
can be used as your actual submit branch, once you have set public_branch
5223
for that mirror.
5224
5225
Two formats are currently supported: "4" uses revision bundle format 4 and
5226
merge directive format 2. It is significantly faster and smaller than
5227
older formats. It is compatible with Bazaar 0.19 and later. It is the
5228
default. "0.9" uses revision bundle format 0.9 and merge directive
5229
format 1. It is compatible with Bazaar 0.12 - 0.18.
5230
"""
5231
5232
takes_options = [
5233
Option('no-bundle',
5234
help='Do not include a bundle in the merge directive.'),
5235
Option('no-patch', help='Do not include a preview patch in the merge'
5236
' directive.'),
5237
Option('remember',
5238
help='Remember submit and public branch.'),
5239
Option('from',
5240
help='Branch to generate the submission from, '
5241
'rather than the one containing the working directory.',
5242
short_name='f',
5243
type=unicode),
5244
Option('output', short_name='o', help='Write directive to this file.',
5245
type=unicode),
5246
Option('strict',
5247
help='Refuse to bundle revisions if there are uncommitted'
5248
' changes in the working tree, --no-strict disables the check.'),
5249
'revision',
5250
RegistryOption('format',
5251
help='Use the specified output format.',
5252
lazy_registry=('bzrlib.send', 'format_registry')),
5253
]
5254
aliases = ['bundle']
5255
5256
_see_also = ['send', 'merge']
5257
5258
hidden = True
5259
5260
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
5261
no_patch=False, revision=None, remember=False, output=None,
5262
format=None, strict=None, **kwargs):
5263
if output is None:
5264
output = '-'
5265
from bzrlib.send import send
5266
return send(submit_branch, revision, public_branch, remember,
5267
format, no_bundle, no_patch, output,
5268
kwargs.get('from', '.'), None, None, None,
5269
self.outf, strict=strict)
5270
5271
5272
class cmd_tag(Command):
5273
__doc__ = """Create, remove or modify a tag naming a revision.
5274
5275
Tags give human-meaningful names to revisions. Commands that take a -r
5276
(--revision) option can be given -rtag:X, where X is any previously
5277
created tag.
5278
5279
Tags are stored in the branch. Tags are copied from one branch to another
5280
along when you branch, push, pull or merge.
5281
5282
It is an error to give a tag name that already exists unless you pass
5283
--force, in which case the tag is moved to point to the new revision.
5284
5285
To rename a tag (change the name but keep it on the same revsion), run ``bzr
5286
tag new-name -r tag:old-name`` and then ``bzr tag --delete oldname``.
5287
5288
If no tag name is specified it will be determined through the
5289
'automatic_tag_name' hook. This can e.g. be used to automatically tag
5290
upstream releases by reading configure.ac. See ``bzr help hooks`` for
5291
details.
5292
"""
5293
5294
_see_also = ['commit', 'tags']
5295
takes_args = ['tag_name?']
5296
takes_options = [
5297
Option('delete',
5298
help='Delete this tag rather than placing it.',
5299
),
5300
Option('directory',
5301
help='Branch in which to place the tag.',
5302
short_name='d',
5303
type=unicode,
5304
),
5305
Option('force',
5306
help='Replace existing tags.',
5307
),
5308
'revision',
5309
]
5310
5311
def run(self, tag_name=None,
5312
delete=None,
5313
directory='.',
5314
force=None,
5315
revision=None,
5316
):
5317
branch, relpath = Branch.open_containing(directory)
5318
self.add_cleanup(branch.lock_write().unlock)
5319
if delete:
5320
if tag_name is None:
5321
raise errors.BzrCommandError("No tag specified to delete.")
5322
branch.tags.delete_tag(tag_name)
5323
self.outf.write('Deleted tag %s.\n' % tag_name)
5324
else:
5325
if revision:
5326
if len(revision) != 1:
5327
raise errors.BzrCommandError(
5328
"Tags can only be placed on a single revision, "
5329
"not on a range")
5330
revision_id = revision[0].as_revision_id(branch)
5331
else:
5332
revision_id = branch.last_revision()
5333
if tag_name is None:
5334
tag_name = branch.automatic_tag_name(revision_id)
5335
if tag_name is None:
5336
raise errors.BzrCommandError(
5337
"Please specify a tag name.")
5338
if (not force) and branch.tags.has_tag(tag_name):
5339
raise errors.TagAlreadyExists(tag_name)
5340
branch.tags.set_tag(tag_name, revision_id)
5341
self.outf.write('Created tag %s.\n' % tag_name)
5342
5343
5344
class cmd_tags(Command):
5345
__doc__ = """List tags.
5346
5347
This command shows a table of tag names and the revisions they reference.
5348
"""
5349
5350
_see_also = ['tag']
5351
takes_options = [
5352
Option('directory',
5353
help='Branch whose tags should be displayed.',
5354
short_name='d',
5355
type=unicode,
5356
),
5357
RegistryOption.from_kwargs('sort',
5358
'Sort tags by different criteria.', title='Sorting',
5359
alpha='Sort tags lexicographically (default).',
5360
time='Sort tags chronologically.',
5361
),
5362
'show-ids',
5363
'revision',
5364
]
5365
5366
@display_command
5367
def run(self,
5368
directory='.',
5369
sort='alpha',
5370
show_ids=False,
5371
revision=None,
5372
):
5373
branch, relpath = Branch.open_containing(directory)
5374
5375
tags = branch.tags.get_tag_dict().items()
5376
if not tags:
5377
return
5378
5379
self.add_cleanup(branch.lock_read().unlock)
5380
if revision:
5381
graph = branch.repository.get_graph()
5382
rev1, rev2 = _get_revision_range(revision, branch, self.name())
5383
revid1, revid2 = rev1.rev_id, rev2.rev_id
5384
# only show revisions between revid1 and revid2 (inclusive)
5385
tags = [(tag, revid) for tag, revid in tags if
5386
graph.is_between(revid, revid1, revid2)]
5387
if sort == 'alpha':
5388
tags.sort()
5389
elif sort == 'time':
5390
timestamps = {}
5391
for tag, revid in tags:
5392
try:
5393
revobj = branch.repository.get_revision(revid)
5394
except errors.NoSuchRevision:
5395
timestamp = sys.maxint # place them at the end
5396
else:
5397
timestamp = revobj.timestamp
5398
timestamps[revid] = timestamp
5399
tags.sort(key=lambda x: timestamps[x[1]])
5400
if not show_ids:
5401
# [ (tag, revid), ... ] -> [ (tag, dotted_revno), ... ]
5402
for index, (tag, revid) in enumerate(tags):
5403
try:
5404
revno = branch.revision_id_to_dotted_revno(revid)
5405
if isinstance(revno, tuple):
5406
revno = '.'.join(map(str, revno))
5407
except errors.NoSuchRevision:
5408
# Bad tag data/merges can lead to tagged revisions
5409
# which are not in this branch. Fail gracefully ...
5410
revno = '?'
5411
tags[index] = (tag, revno)
5412
self.cleanup_now()
5413
for tag, revspec in tags:
5414
self.outf.write('%-20s %s\n' % (tag, revspec))
5415
5416
5417
class cmd_reconfigure(Command):
5418
__doc__ = """Reconfigure the type of a bzr directory.
5419
5420
A target configuration must be specified.
5421
5422
For checkouts, the bind-to location will be auto-detected if not specified.
5423
The order of preference is
5424
1. For a lightweight checkout, the current bound location.
5425
2. For branches that used to be checkouts, the previously-bound location.
5426
3. The push location.
5427
4. The parent location.
5428
If none of these is available, --bind-to must be specified.
5429
"""
5430
5431
_see_also = ['branches', 'checkouts', 'standalone-trees', 'working-trees']
5432
takes_args = ['location?']
5433
takes_options = [
5434
RegistryOption.from_kwargs(
5435
'target_type',
5436
title='Target type',
5437
help='The type to reconfigure the directory to.',
5438
value_switches=True, enum_switch=False,
5439
branch='Reconfigure to be an unbound branch with no working tree.',
5440
tree='Reconfigure to be an unbound branch with a working tree.',
5441
checkout='Reconfigure to be a bound branch with a working tree.',
5442
lightweight_checkout='Reconfigure to be a lightweight'
5443
' checkout (with no local history).',
5444
standalone='Reconfigure to be a standalone branch '
5445
'(i.e. stop using shared repository).',
5446
use_shared='Reconfigure to use a shared repository.',
5447
with_trees='Reconfigure repository to create '
5448
'working trees on branches by default.',
5449
with_no_trees='Reconfigure repository to not create '
5450
'working trees on branches by default.'
5451
),
5452
Option('bind-to', help='Branch to bind checkout to.', type=str),
5453
Option('force',
5454
help='Perform reconfiguration even if local changes'
5455
' will be lost.'),
5456
Option('stacked-on',
5457
help='Reconfigure a branch to be stacked on another branch.',
5458
type=unicode,
5459
),
5460
Option('unstacked',
5461
help='Reconfigure a branch to be unstacked. This '
5462
'may require copying substantial data into it.',
5463
),
5464
]
5465
5466
def run(self, location=None, target_type=None, bind_to=None, force=False,
5467
stacked_on=None,
5468
unstacked=None):
5469
directory = bzrdir.BzrDir.open(location)
5470
if stacked_on and unstacked:
5471
raise BzrCommandError("Can't use both --stacked-on and --unstacked")
5472
elif stacked_on is not None:
5473
reconfigure.ReconfigureStackedOn().apply(directory, stacked_on)
5474
elif unstacked:
5475
reconfigure.ReconfigureUnstacked().apply(directory)
5476
# At the moment you can use --stacked-on and a different
5477
# reconfiguration shape at the same time; there seems no good reason
5478
# to ban it.
5479
if target_type is None:
5480
if stacked_on or unstacked:
5481
return
5482
else:
5483
raise errors.BzrCommandError('No target configuration '
5484
'specified')
5485
elif target_type == 'branch':
5486
reconfiguration = reconfigure.Reconfigure.to_branch(directory)
5487
elif target_type == 'tree':
5488
reconfiguration = reconfigure.Reconfigure.to_tree(directory)
5489
elif target_type == 'checkout':
5490
reconfiguration = reconfigure.Reconfigure.to_checkout(
5491
directory, bind_to)
5492
elif target_type == 'lightweight-checkout':
5493
reconfiguration = reconfigure.Reconfigure.to_lightweight_checkout(
5494
directory, bind_to)
5495
elif target_type == 'use-shared':
5496
reconfiguration = reconfigure.Reconfigure.to_use_shared(directory)
5497
elif target_type == 'standalone':
5498
reconfiguration = reconfigure.Reconfigure.to_standalone(directory)
5499
elif target_type == 'with-trees':
5500
reconfiguration = reconfigure.Reconfigure.set_repository_trees(
5501
directory, True)
5502
elif target_type == 'with-no-trees':
5503
reconfiguration = reconfigure.Reconfigure.set_repository_trees(
5504
directory, False)
5505
reconfiguration.apply(force)
5506
5507
5508
class cmd_switch(Command):
5509
__doc__ = """Set the branch of a checkout and update.
5510
5511
For lightweight checkouts, this changes the branch being referenced.
5512
For heavyweight checkouts, this checks that there are no local commits
5513
versus the current bound branch, then it makes the local branch a mirror
5514
of the new location and binds to it.
5515
5516
In both cases, the working tree is updated and uncommitted changes
5517
are merged. The user can commit or revert these as they desire.
5518
5519
Pending merges need to be committed or reverted before using switch.
5520
5521
The path to the branch to switch to can be specified relative to the parent
5522
directory of the current branch. For example, if you are currently in a
5523
checkout of /path/to/branch, specifying 'newbranch' will find a branch at
5524
/path/to/newbranch.
5525
5526
Bound branches use the nickname of its master branch unless it is set
5527
locally, in which case switching will update the local nickname to be
5528
that of the master.
5529
"""
5530
5531
takes_args = ['to_location?']
5532
takes_options = [Option('force',
5533
help='Switch even if local commits will be lost.'),
5534
'revision',
5535
Option('create-branch', short_name='b',
5536
help='Create the target branch from this one before'
5537
' switching to it.'),
5538
]
5539
5540
def run(self, to_location=None, force=False, create_branch=False,
5541
revision=None):
5542
from bzrlib import switch
5543
tree_location = '.'
5544
revision = _get_one_revision('switch', revision)
5545
control_dir = bzrdir.BzrDir.open_containing(tree_location)[0]
5546
if to_location is None:
5547
if revision is None:
5548
raise errors.BzrCommandError('You must supply either a'
5549
' revision or a location')
5550
to_location = '.'
5551
try:
5552
branch = control_dir.open_branch()
5553
had_explicit_nick = branch.get_config().has_explicit_nickname()
5554
except errors.NotBranchError:
5555
branch = None
5556
had_explicit_nick = False
5557
if create_branch:
5558
if branch is None:
5559
raise errors.BzrCommandError('cannot create branch without'
5560
' source branch')
5561
to_location = directory_service.directories.dereference(
5562
to_location)
5563
if '/' not in to_location and '\\' not in to_location:
5564
# This path is meant to be relative to the existing branch
5565
this_url = self._get_branch_location(control_dir)
5566
to_location = urlutils.join(this_url, '..', to_location)
5567
to_branch = branch.bzrdir.sprout(to_location,
5568
possible_transports=[branch.bzrdir.root_transport],
5569
source_branch=branch).open_branch()
5570
else:
5571
try:
5572
to_branch = Branch.open(to_location)
5573
except errors.NotBranchError:
5574
this_url = self._get_branch_location(control_dir)
5575
to_branch = Branch.open(
5576
urlutils.join(this_url, '..', to_location))
5577
if revision is not None:
5578
revision = revision.as_revision_id(to_branch)
5579
switch.switch(control_dir, to_branch, force, revision_id=revision)
5580
if had_explicit_nick:
5581
branch = control_dir.open_branch() #get the new branch!
5582
branch.nick = to_branch.nick
5583
note('Switched to branch: %s',
5584
urlutils.unescape_for_display(to_branch.base, 'utf-8'))
5585
5586
def _get_branch_location(self, control_dir):
5587
"""Return location of branch for this control dir."""
5588
try:
5589
this_branch = control_dir.open_branch()
5590
# This may be a heavy checkout, where we want the master branch
5591
master_location = this_branch.get_bound_location()
5592
if master_location is not None:
5593
return master_location
5594
# If not, use a local sibling
5595
return this_branch.base
5596
except errors.NotBranchError:
5597
format = control_dir.find_branch_format()
5598
if getattr(format, 'get_reference', None) is not None:
5599
return format.get_reference(control_dir)
5600
else:
5601
return control_dir.root_transport.base
5602
5603
5604
class cmd_view(Command):
5605
__doc__ = """Manage filtered views.
5606
5607
Views provide a mask over the tree so that users can focus on
5608
a subset of a tree when doing their work. After creating a view,
5609
commands that support a list of files - status, diff, commit, etc -
5610
effectively have that list of files implicitly given each time.
5611
An explicit list of files can still be given but those files
5612
must be within the current view.
5613
5614
In most cases, a view has a short life-span: it is created to make
5615
a selected change and is deleted once that change is committed.
5616
At other times, you may wish to create one or more named views
5617
and switch between them.
5618
5619
To disable the current view without deleting it, you can switch to
5620
the pseudo view called ``off``. This can be useful when you need
5621
to see the whole tree for an operation or two (e.g. merge) but
5622
want to switch back to your view after that.
5623
5624
:Examples:
5625
To define the current view::
5626
5627
bzr view file1 dir1 ...
5628
5629
To list the current view::
5630
5631
bzr view
5632
5633
To delete the current view::
5634
5635
bzr view --delete
5636
5637
To disable the current view without deleting it::
5638
5639
bzr view --switch off
5640
5641
To define a named view and switch to it::
5642
5643
bzr view --name view-name file1 dir1 ...
5644
5645
To list a named view::
5646
5647
bzr view --name view-name
5648
5649
To delete a named view::
5650
5651
bzr view --name view-name --delete
5652
5653
To switch to a named view::
5654
5655
bzr view --switch view-name
5656
5657
To list all views defined::
5658
5659
bzr view --all
5660
5661
To delete all views::
5662
5663
bzr view --delete --all
5664
"""
5665
5666
_see_also = []
5667
takes_args = ['file*']
5668
takes_options = [
5669
Option('all',
5670
help='Apply list or delete action to all views.',
5671
),
5672
Option('delete',
5673
help='Delete the view.',
5674
),
5675
Option('name',
5676
help='Name of the view to define, list or delete.',
5677
type=unicode,
5678
),
5679
Option('switch',
5680
help='Name of the view to switch to.',
5681
type=unicode,
5682
),
5683
]
5684
5685
def run(self, file_list,
5686
all=False,
5687
delete=False,
5688
name=None,
5689
switch=None,
5690
):
5691
tree, file_list = tree_files(file_list, apply_view=False)
5692
current_view, view_dict = tree.views.get_view_info()
5693
if name is None:
5694
name = current_view
5695
if delete:
5696
if file_list:
5697
raise errors.BzrCommandError(
5698
"Both --delete and a file list specified")
5699
elif switch:
5700
raise errors.BzrCommandError(
5701
"Both --delete and --switch specified")
5702
elif all:
5703
tree.views.set_view_info(None, {})
5704
self.outf.write("Deleted all views.\n")
5705
elif name is None:
5706
raise errors.BzrCommandError("No current view to delete")
5707
else:
5708
tree.views.delete_view(name)
5709
self.outf.write("Deleted '%s' view.\n" % name)
5710
elif switch:
5711
if file_list:
5712
raise errors.BzrCommandError(
5713
"Both --switch and a file list specified")
5714
elif all:
5715
raise errors.BzrCommandError(
5716
"Both --switch and --all specified")
5717
elif switch == 'off':
5718
if current_view is None:
5719
raise errors.BzrCommandError("No current view to disable")
5720
tree.views.set_view_info(None, view_dict)
5721
self.outf.write("Disabled '%s' view.\n" % (current_view))
5722
else:
5723
tree.views.set_view_info(switch, view_dict)
5724
view_str = views.view_display_str(tree.views.lookup_view())
5725
self.outf.write("Using '%s' view: %s\n" % (switch, view_str))
5726
elif all:
5727
if view_dict:
5728
self.outf.write('Views defined:\n')
5729
for view in sorted(view_dict):
5730
if view == current_view:
5731
active = "=>"
5732
else:
5733
active = " "
5734
view_str = views.view_display_str(view_dict[view])
5735
self.outf.write('%s %-20s %s\n' % (active, view, view_str))
5736
else:
5737
self.outf.write('No views defined.\n')
5738
elif file_list:
5739
if name is None:
5740
# No name given and no current view set
5741
name = 'my'
5742
elif name == 'off':
5743
raise errors.BzrCommandError(
5744
"Cannot change the 'off' pseudo view")
5745
tree.views.set_view(name, sorted(file_list))
5746
view_str = views.view_display_str(tree.views.lookup_view())
5747
self.outf.write("Using '%s' view: %s\n" % (name, view_str))
5748
else:
5749
# list the files
5750
if name is None:
5751
# No name given and no current view set
5752
self.outf.write('No current view.\n')
5753
else:
5754
view_str = views.view_display_str(tree.views.lookup_view(name))
5755
self.outf.write("'%s' view is: %s\n" % (name, view_str))
5756
5757
5758
class cmd_hooks(Command):
5759
__doc__ = """Show hooks."""
5760
5761
hidden = True
5762
5763
def run(self):
5764
for hook_key in sorted(hooks.known_hooks.keys()):
5765
some_hooks = hooks.known_hooks_key_to_object(hook_key)
5766
self.outf.write("%s:\n" % type(some_hooks).__name__)
5767
for hook_name, hook_point in sorted(some_hooks.items()):
5768
self.outf.write(" %s:\n" % (hook_name,))
5769
found_hooks = list(hook_point)
5770
if found_hooks:
5771
for hook in found_hooks:
5772
self.outf.write(" %s\n" %
5773
(some_hooks.get_hook_name(hook),))
5774
else:
5775
self.outf.write(" <no hooks installed>\n")
5776
5777
5778
class cmd_remove_branch(Command):
5779
__doc__ = """Remove a branch.
5780
5781
This will remove the branch from the specified location but
5782
will keep any working tree or repository in place.
5783
5784
:Examples:
5785
5786
Remove the branch at repo/trunk::
5787
5788
bzr remove-branch repo/trunk
5789
5790
"""
5791
5792
takes_args = ["location?"]
5793
5794
aliases = ["rmbranch"]
5795
5796
def run(self, location=None):
5797
if location is None:
5798
location = "."
5799
branch = Branch.open_containing(location)[0]
5800
branch.bzrdir.destroy_branch()
5801
2653
5802
2654
5803
class cmd_shelve(Command):
5804
__doc__ = """Temporarily set aside some changes from the current tree.
5805
5806
Shelve allows you to temporarily put changes you've made "on the shelf",
5807
ie. out of the way, until a later time when you can bring them back from
5808
the shelf with the 'unshelve' command. The changes are stored alongside
5809
your working tree, and so they aren't propagated along with your branch nor
5810
will they survive its deletion.
5811
5812
If shelve --list is specified, previously-shelved changes are listed.
5813
5814
Shelve is intended to help separate several sets of changes that have
5815
been inappropriately mingled. If you just want to get rid of all changes
5816
and you don't need to restore them later, use revert. If you want to
5817
shelve all text changes at once, use shelve --all.
5818
5819
If filenames are specified, only the changes to those files will be
5820
shelved. Other files will be left untouched.
5821
5822
If a revision is specified, changes since that revision will be shelved.
5823
5824
You can put multiple items on the shelf, and by default, 'unshelve' will
5825
restore the most recently shelved changes.
5826
"""
5827
5828
takes_args = ['file*']
5829
5830
takes_options = [
5831
'revision',
5832
Option('all', help='Shelve all changes.'),
5833
'message',
5834
RegistryOption('writer', 'Method to use for writing diffs.',
5835
bzrlib.option.diff_writer_registry,
5836
value_switches=True, enum_switch=False),
5837
5838
Option('list', help='List shelved changes.'),
5839
Option('destroy',
5840
help='Destroy removed changes instead of shelving them.'),
5841
]
5842
_see_also = ['unshelve']
5843
5844
def run(self, revision=None, all=False, file_list=None, message=None,
5845
writer=None, list=False, destroy=False):
5846
if list:
5847
return self.run_for_list()
5848
from bzrlib.shelf_ui import Shelver
5849
if writer is None:
5850
writer = bzrlib.option.diff_writer_registry.get()
5851
try:
5852
shelver = Shelver.from_args(writer(sys.stdout), revision, all,
5853
file_list, message, destroy=destroy)
5854
try:
5855
shelver.run()
5856
finally:
5857
shelver.finalize()
5858
except errors.UserAbort:
5859
return 0
5860
5861
def run_for_list(self):
5862
tree = WorkingTree.open_containing('.')[0]
5863
self.add_cleanup(tree.lock_read().unlock)
5864
manager = tree.get_shelf_manager()
5865
shelves = manager.active_shelves()
5866
if len(shelves) == 0:
5867
note('No shelved changes.')
5868
return 0
5869
for shelf_id in reversed(shelves):
5870
message = manager.get_metadata(shelf_id).get('message')
5871
if message is None:
5872
message = '<no message>'
5873
self.outf.write('%3d: %s\n' % (shelf_id, message))
5874
return 1
5875
5876
5877
class cmd_unshelve(Command):
5878
__doc__ = """Restore shelved changes.
5879
5880
By default, the most recently shelved changes are restored. However if you
5881
specify a shelf by id those changes will be restored instead. This works
5882
best when the changes don't depend on each other.
5883
"""
5884
5885
takes_args = ['shelf_id?']
5886
takes_options = [
5887
RegistryOption.from_kwargs(
5888
'action', help="The action to perform.",
5889
enum_switch=False, value_switches=True,
5890
apply="Apply changes and remove from the shelf.",
5891
dry_run="Show changes, but do not apply or remove them.",
5892
preview="Instead of unshelving the changes, show the diff that "
5893
"would result from unshelving.",
5894
delete_only="Delete changes without applying them.",
5895
keep="Apply changes but don't delete them.",
5896
)
5897
]
5898
_see_also = ['shelve']
5899
5900
def run(self, shelf_id=None, action='apply'):
5901
from bzrlib.shelf_ui import Unshelver
5902
unshelver = Unshelver.from_args(shelf_id, action)
5903
try:
5904
unshelver.run()
5905
finally:
5906
unshelver.tree.unlock()
5907
5908
5909
class cmd_clean_tree(Command):
5910
__doc__ = """Remove unwanted files from working tree.
5911
5912
By default, only unknown files, not ignored files, are deleted. Versioned
5913
files are never deleted.
5914
5915
Another class is 'detritus', which includes files emitted by bzr during
5916
normal operations and selftests. (The value of these files decreases with
5917
time.)
5918
5919
If no options are specified, unknown files are deleted. Otherwise, option
5920
flags are respected, and may be combined.
5921
5922
To check what clean-tree will do, use --dry-run.
5923
"""
5924
takes_options = [Option('ignored', help='Delete all ignored files.'),
5925
Option('detritus', help='Delete conflict files, merge'
5926
' backups, and failed selftest dirs.'),
5927
Option('unknown',
5928
help='Delete files unknown to bzr (default).'),
5929
Option('dry-run', help='Show files to delete instead of'
5930
' deleting them.'),
5931
Option('force', help='Do not prompt before deleting.')]
5932
def run(self, unknown=False, ignored=False, detritus=False, dry_run=False,
5933
force=False):
5934
from bzrlib.clean_tree import clean_tree
5935
if not (unknown or ignored or detritus):
5936
unknown = True
5937
if dry_run:
5938
force = True
5939
clean_tree('.', unknown=unknown, ignored=ignored, detritus=detritus,
5940
dry_run=dry_run, no_prompt=force)
5941
5942
5943
class cmd_reference(Command):
5944
__doc__ = """list, view and set branch locations for nested trees.
5945
5946
If no arguments are provided, lists the branch locations for nested trees.
5947
If one argument is provided, display the branch location for that tree.
5948
If two arguments are provided, set the branch location for that tree.
5949
"""
5950
5951
hidden = True
5952
5953
takes_args = ['path?', 'location?']
5954
5955
def run(self, path=None, location=None):
5956
branchdir = '.'
5957
if path is not None:
5958
branchdir = path
5959
tree, branch, relpath =(
5960
bzrdir.BzrDir.open_containing_tree_or_branch(branchdir))
5961
if path is not None:
5962
path = relpath
5963
if tree is None:
5964
tree = branch.basis_tree()
5965
if path is None:
5966
info = branch._get_all_reference_info().iteritems()
5967
self._display_reference_info(tree, branch, info)
5968
else:
5969
file_id = tree.path2id(path)
5970
if file_id is None:
5971
raise errors.NotVersionedError(path)
5972
if location is None:
5973
info = [(file_id, branch.get_reference_info(file_id))]
5974
self._display_reference_info(tree, branch, info)
5975
else:
5976
branch.set_reference_info(file_id, path, location)
5977
5978
def _display_reference_info(self, tree, branch, info):
5979
ref_list = []
5980
for file_id, (path, location) in info:
5981
try:
5982
path = tree.id2path(file_id)
5983
except errors.NoSuchId:
5984
pass
5985
ref_list.append((path, location))
5986
for path, location in sorted(ref_list):
5987
self.outf.write('%s %s\n' % (path, location))
5988
5989
5990
def _register_lazy_builtins():
5991
# register lazy builtins from other modules; called at startup and should
5992
# be only called once.
5993
for (name, aliases, module_name) in [
5994
('cmd_bundle_info', [], 'bzrlib.bundle.commands'),
5995
('cmd_dpush', [], 'bzrlib.foreign'),
5996
('cmd_version_info', [], 'bzrlib.cmd_version_info'),
5997
('cmd_resolve', ['resolved'], 'bzrlib.conflicts'),
5998
('cmd_conflicts', [], 'bzrlib.conflicts'),
5999
('cmd_sign_my_commits', [], 'bzrlib.sign_my_commits'),
6000
]:
6001
builtin_command_registry.register_lazy(name, aliases, module_name)
2655
2656
# command-line interpretation helper for merge-related commands
2657
def merge(other_revision, base_revision,
2658
check_clean=True, ignore_zero=False,
2659
this_dir=None, backup_files=False, merge_type=Merge3Merger,
2660
file_list=None, show_base=False, reprocess=False,
2661
pb=DummyProgress()):
2662
"""Merge changes into a tree.
2663
2664
base_revision
2665
list(path, revno) Base for three-way merge.
2666
If [None, None] then a base will be automatically determined.
2667
other_revision
2668
list(path, revno) Other revision for three-way merge.
2669
this_dir
2670
Directory to merge changes into; '.' by default.
2671
check_clean
2672
If true, this_dir must have no uncommitted changes before the
2673
merge begins.
2674
ignore_zero - If true, suppress the "zero conflicts" message when
2675
there are no conflicts; should be set when doing something we expect
2676
to complete perfectly.
2677
file_list - If supplied, merge only changes to selected files.
2678
2679
All available ancestors of other_revision and base_revision are
2680
automatically pulled into the branch.
2681
2682
The revno may be -1 to indicate the last revision on the branch, which is
2683
the typical case.
2684
2685
This function is intended for use from the command line; programmatic
2686
clients might prefer to call merge.merge_inner(), which has less magic
2687
behavior.
2688
"""
2689
from bzrlib.merge import Merger
2690
if this_dir is None:
2691
this_dir = u'.'
2692
this_tree = WorkingTree.open_containing(this_dir)[0]
2693
if show_base and not merge_type is Merge3Merger:
2694
raise BzrCommandError("Show-base is not supported for this merge"
2695
" type. %s" % merge_type)
2696
if reprocess and not merge_type.supports_reprocess:
2697
raise BzrCommandError("Conflict reduction is not supported for merge"
2698
" type %s." % merge_type)
2699
if reprocess and show_base:
2700
raise BzrCommandError("Cannot do conflict reduction and show base.")
2701
try:
2702
merger = Merger(this_tree.branch, this_tree=this_tree, pb=pb)
2703
merger.pp = ProgressPhase("Merge phase", 5, pb)
2704
merger.pp.next_phase()
2705
merger.check_basis(check_clean)
2706
merger.set_other(other_revision)
2707
merger.pp.next_phase()
2708
merger.set_base(base_revision)
2709
if merger.base_rev_id == merger.other_rev_id:
2710
note('Nothing to do.')
2711
return 0
2712
merger.backup_files = backup_files
2713
merger.merge_type = merge_type
2714
merger.set_interesting_files(file_list)
2715
merger.show_base = show_base
2716
merger.reprocess = reprocess
2717
conflicts = merger.do_merge()
2718
if file_list is None:
2719
merger.set_pending()
2720
finally:
2721
pb.clear()
2722
return conflicts
2723
2724
2725
# these get imported and then picked up by the scan for cmd_*
2726
# TODO: Some more consistent way to split command definitions across files;
2727
# we do need to load at least some information about them to know of
2728
# aliases. ideally we would avoid loading the implementation until the
2729
# details were needed.
2730
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore
2731
from bzrlib.bundle.commands import cmd_bundle_revisions
2732
from bzrlib.sign_my_commits import cmd_sign_my_commits
2733
from bzrlib.weave_commands import cmd_weave_list, cmd_weave_join, \
2734
cmd_weave_plan_merge, cmd_weave_merge_text
Loggerhead is a web-based interface for Breezy
Version: 2.0.1