1
# Copyright (C) 2005-2010 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
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
17
"""builtin bzr commands"""
21
from bzrlib.lazy_import import lazy_import
22
lazy_import(globals(), """
37
config as _mod_config,
47
revision as _mod_revision,
56
from bzrlib.branch import Branch
57
from bzrlib.conflicts import ConflictList
58
from bzrlib.transport import memory
59
from bzrlib.revisionspec import RevisionSpec, RevisionInfo
60
from bzrlib.smtp_connection import SMTPConnection
61
from bzrlib.workingtree import WorkingTree
64
from bzrlib.commands import (
66
builtin_command_registry,
69
from bzrlib.option import (
76
from bzrlib.trace import mutter, note, warning, is_quiet, get_verbosity_level
79
@symbol_versioning.deprecated_function(symbol_versioning.deprecated_in((2, 3, 0)))
80
def tree_files(file_list, default_branch=u'.', canonicalize=True,
82
return internal_tree_files(file_list, default_branch, canonicalize,
86
def tree_files_for_add(file_list):
88
Return a tree and list of absolute paths from a file list.
90
Similar to tree_files, but add handles files a bit differently, so it a
91
custom implementation. In particular, MutableTreeTree.smart_add expects
92
absolute paths, which it immediately converts to relative paths.
94
# FIXME Would be nice to just return the relative paths like
95
# internal_tree_files does, but there are a large number of unit tests
96
# that assume the current interface to mutabletree.smart_add
98
tree, relpath = WorkingTree.open_containing(file_list[0])
99
if tree.supports_views():
100
view_files = tree.views.lookup_view()
102
for filename in file_list:
103
if not osutils.is_inside_any(view_files, filename):
104
raise errors.FileOutsideView(filename, view_files)
105
file_list = file_list[:]
106
file_list[0] = tree.abspath(relpath)
108
tree = WorkingTree.open_containing(u'.')[0]
109
if tree.supports_views():
110
view_files = tree.views.lookup_view()
112
file_list = view_files
113
view_str = views.view_display_str(view_files)
114
note("Ignoring files outside view. View is %s" % view_str)
115
return tree, file_list
118
def _get_one_revision(command_name, revisions):
119
if revisions is None:
121
if len(revisions) != 1:
122
raise errors.BzrCommandError(
123
'bzr %s --revision takes exactly one revision identifier' % (
128
def _get_one_revision_tree(command_name, revisions, branch=None, tree=None):
129
"""Get a revision tree. Not suitable for commands that change the tree.
131
Specifically, the basis tree in dirstate trees is coupled to the dirstate
132
and doing a commit/uncommit/pull will at best fail due to changing the
135
If tree is passed in, it should be already locked, for lifetime management
136
of the trees internal cached state.
140
if revisions is None:
142
rev_tree = tree.basis_tree()
144
rev_tree = branch.basis_tree()
146
revision = _get_one_revision(command_name, revisions)
147
rev_tree = revision.as_tree(branch)
151
# XXX: Bad function name; should possibly also be a class method of
152
# WorkingTree rather than a function.
153
@symbol_versioning.deprecated_function(symbol_versioning.deprecated_in((2, 3, 0)))
154
def internal_tree_files(file_list, default_branch=u'.', canonicalize=True,
156
"""Convert command-line paths to a WorkingTree and relative paths.
158
Deprecated: use WorkingTree.open_containing_paths instead.
160
This is typically used for command-line processors that take one or
161
more filenames, and infer the workingtree that contains them.
163
The filenames given are not required to exist.
165
:param file_list: Filenames to convert.
167
:param default_branch: Fallback tree path to use if file_list is empty or
170
:param apply_view: if True and a view is set, apply it or check that
171
specified files are within it
173
:return: workingtree, [relative_paths]
175
return WorkingTree.open_containing_paths(
176
file_list, default_directory='.',
181
def _get_view_info_for_change_reporter(tree):
182
"""Get the view information from a tree for change reporting."""
185
current_view = tree.views.get_view_info()[0]
186
if current_view is not None:
187
view_info = (current_view, tree.views.lookup_view())
188
except errors.ViewsNotSupported:
193
def _open_directory_or_containing_tree_or_branch(filename, directory):
194
"""Open the tree or branch containing the specified file, unless
195
the --directory option is used to specify a different branch."""
196
if directory is not None:
197
return (None, Branch.open(directory), filename)
198
return bzrdir.BzrDir.open_containing_tree_or_branch(filename)
201
# TODO: Make sure no commands unconditionally use the working directory as a
202
# branch. If a filename argument is used, the first of them should be used to
203
# specify the branch. (Perhaps this can be factored out into some kind of
204
# Argument class, representing a file in a branch, where the first occurrence
207
class cmd_status(Command):
208
__doc__ = """Display status summary.
210
This reports on versioned and unknown files, reporting them
211
grouped by state. Possible states are:
214
Versioned in the working copy but not in the previous revision.
217
Versioned in the previous revision but removed or deleted
221
Path of this file changed from the previous revision;
222
the text may also have changed. This includes files whose
223
parent directory was renamed.
226
Text has changed since the previous revision.
229
File kind has been changed (e.g. from file to directory).
232
Not versioned and not matching an ignore pattern.
234
Additionally for directories, symlinks and files with an executable
235
bit, Bazaar indicates their type using a trailing character: '/', '@'
238
To see ignored files use 'bzr ignored'. For details on the
239
changes to file texts, use 'bzr diff'.
241
Note that --short or -S gives status flags for each item, similar
242
to Subversion's status command. To get output similar to svn -q,
245
If no arguments are specified, the status of the entire working
246
directory is shown. Otherwise, only the status of the specified
247
files or directories is reported. If a directory is given, status
248
is reported for everything inside that directory.
250
Before merges are committed, the pending merge tip revisions are
251
shown. To see all pending merge revisions, use the -v option.
252
To skip the display of pending merge information altogether, use
253
the no-pending option or specify a file/directory.
255
If a revision argument is given, the status is calculated against
256
that revision, or between two revisions if two are provided.
259
# TODO: --no-recurse, --recurse options
261
takes_args = ['file*']
262
takes_options = ['show-ids', 'revision', 'change', 'verbose',
263
Option('short', help='Use short status indicators.',
265
Option('versioned', help='Only show versioned files.',
267
Option('no-pending', help='Don\'t show pending merges.',
270
aliases = ['st', 'stat']
272
encoding_type = 'replace'
273
_see_also = ['diff', 'revert', 'status-flags']
276
def run(self, show_ids=False, file_list=None, revision=None, short=False,
277
versioned=False, no_pending=False, verbose=False):
278
from bzrlib.status import show_tree_status
280
if revision and len(revision) > 2:
281
raise errors.BzrCommandError('bzr status --revision takes exactly'
282
' one or two revision specifiers')
284
tree, relfile_list = WorkingTree.open_containing_paths(file_list)
285
# Avoid asking for specific files when that is not needed.
286
if relfile_list == ['']:
288
# Don't disable pending merges for full trees other than '.'.
289
if file_list == ['.']:
291
# A specific path within a tree was given.
292
elif relfile_list is not None:
294
show_tree_status(tree, show_ids=show_ids,
295
specific_files=relfile_list, revision=revision,
296
to_file=self.outf, short=short, versioned=versioned,
297
show_pending=(not no_pending), verbose=verbose)
300
class cmd_cat_revision(Command):
301
__doc__ = """Write out metadata for a revision.
303
The revision to print can either be specified by a specific
304
revision identifier, or you can use --revision.
308
takes_args = ['revision_id?']
309
takes_options = ['directory', 'revision']
310
# cat-revision is more for frontends so should be exact
313
def print_revision(self, revisions, revid):
314
stream = revisions.get_record_stream([(revid,)], 'unordered', True)
315
record = stream.next()
316
if record.storage_kind == 'absent':
317
raise errors.NoSuchRevision(revisions, revid)
318
revtext = record.get_bytes_as('fulltext')
319
self.outf.write(revtext.decode('utf-8'))
322
def run(self, revision_id=None, revision=None, directory=u'.'):
323
if revision_id is not None and revision is not None:
324
raise errors.BzrCommandError('You can only supply one of'
325
' revision_id or --revision')
326
if revision_id is None and revision is None:
327
raise errors.BzrCommandError('You must supply either'
328
' --revision or a revision_id')
329
b = WorkingTree.open_containing(directory)[0].branch
331
revisions = b.repository.revisions
332
if revisions is None:
333
raise errors.BzrCommandError('Repository %r does not support '
334
'access to raw revision texts')
336
b.repository.lock_read()
338
# TODO: jam 20060112 should cat-revision always output utf-8?
339
if revision_id is not None:
340
revision_id = osutils.safe_revision_id(revision_id, warn=False)
342
self.print_revision(revisions, revision_id)
343
except errors.NoSuchRevision:
344
msg = "The repository %s contains no revision %s." % (
345
b.repository.base, revision_id)
346
raise errors.BzrCommandError(msg)
347
elif revision is not None:
350
raise errors.BzrCommandError(
351
'You cannot specify a NULL revision.')
352
rev_id = rev.as_revision_id(b)
353
self.print_revision(revisions, rev_id)
355
b.repository.unlock()
358
class cmd_dump_btree(Command):
359
__doc__ = """Dump the contents of a btree index file to stdout.
361
PATH is a btree index file, it can be any URL. This includes things like
362
.bzr/repository/pack-names, or .bzr/repository/indices/a34b3a...ca4a4.iix
364
By default, the tuples stored in the index file will be displayed. With
365
--raw, we will uncompress the pages, but otherwise display the raw bytes
369
# TODO: Do we want to dump the internal nodes as well?
370
# TODO: It would be nice to be able to dump the un-parsed information,
371
# rather than only going through iter_all_entries. However, this is
372
# good enough for a start
374
encoding_type = 'exact'
375
takes_args = ['path']
376
takes_options = [Option('raw', help='Write the uncompressed bytes out,'
377
' rather than the parsed tuples.'),
380
def run(self, path, raw=False):
381
dirname, basename = osutils.split(path)
382
t = transport.get_transport(dirname)
384
self._dump_raw_bytes(t, basename)
386
self._dump_entries(t, basename)
388
def _get_index_and_bytes(self, trans, basename):
389
"""Create a BTreeGraphIndex and raw bytes."""
390
bt = btree_index.BTreeGraphIndex(trans, basename, None)
391
bytes = trans.get_bytes(basename)
392
bt._file = cStringIO.StringIO(bytes)
393
bt._size = len(bytes)
396
def _dump_raw_bytes(self, trans, basename):
399
# We need to parse at least the root node.
400
# This is because the first page of every row starts with an
401
# uncompressed header.
402
bt, bytes = self._get_index_and_bytes(trans, basename)
403
for page_idx, page_start in enumerate(xrange(0, len(bytes),
404
btree_index._PAGE_SIZE)):
405
page_end = min(page_start + btree_index._PAGE_SIZE, len(bytes))
406
page_bytes = bytes[page_start:page_end]
408
self.outf.write('Root node:\n')
409
header_end, data = bt._parse_header_from_bytes(page_bytes)
410
self.outf.write(page_bytes[:header_end])
412
self.outf.write('\nPage %d\n' % (page_idx,))
413
decomp_bytes = zlib.decompress(page_bytes)
414
self.outf.write(decomp_bytes)
415
self.outf.write('\n')
417
def _dump_entries(self, trans, basename):
419
st = trans.stat(basename)
420
except errors.TransportNotPossible:
421
# We can't stat, so we'll fake it because we have to do the 'get()'
423
bt, _ = self._get_index_and_bytes(trans, basename)
425
bt = btree_index.BTreeGraphIndex(trans, basename, st.st_size)
426
for node in bt.iter_all_entries():
427
# Node is made up of:
428
# (index, key, value, [references])
432
refs_as_tuples = None
434
refs_as_tuples = static_tuple.as_tuples(refs)
435
as_tuple = (tuple(node[1]), node[2], refs_as_tuples)
436
self.outf.write('%s\n' % (as_tuple,))
439
class cmd_remove_tree(Command):
440
__doc__ = """Remove the working tree from a given branch/checkout.
442
Since a lightweight checkout is little more than a working tree
443
this will refuse to run against one.
445
To re-create the working tree, use "bzr checkout".
447
_see_also = ['checkout', 'working-trees']
448
takes_args = ['location*']
451
help='Remove the working tree even if it has '
452
'uncommitted or shelved changes.'),
455
def run(self, location_list, force=False):
456
if not location_list:
459
for location in location_list:
460
d = bzrdir.BzrDir.open(location)
463
working = d.open_workingtree()
464
except errors.NoWorkingTree:
465
raise errors.BzrCommandError("No working tree to remove")
466
except errors.NotLocalUrl:
467
raise errors.BzrCommandError("You cannot remove the working tree"
470
if (working.has_changes()):
471
raise errors.UncommittedChanges(working)
472
if working.get_shelf_manager().last_shelf() is not None:
473
raise errors.ShelvedChanges(working)
475
if working.user_url != working.branch.user_url:
476
raise errors.BzrCommandError("You cannot remove the working tree"
477
" from a lightweight checkout")
479
d.destroy_workingtree()
482
class cmd_revno(Command):
483
__doc__ = """Show current revision number.
485
This is equal to the number of revisions on this branch.
489
takes_args = ['location?']
491
Option('tree', help='Show revno of working tree'),
495
def run(self, tree=False, location=u'.'):
498
wt = WorkingTree.open_containing(location)[0]
499
self.add_cleanup(wt.lock_read().unlock)
500
except (errors.NoWorkingTree, errors.NotLocalUrl):
501
raise errors.NoWorkingTree(location)
502
revid = wt.last_revision()
504
revno_t = wt.branch.revision_id_to_dotted_revno(revid)
505
except errors.NoSuchRevision:
507
revno = ".".join(str(n) for n in revno_t)
509
b = Branch.open_containing(location)[0]
510
self.add_cleanup(b.lock_read().unlock)
513
self.outf.write(str(revno) + '\n')
516
class cmd_revision_info(Command):
517
__doc__ = """Show revision number and revision id for a given revision identifier.
520
takes_args = ['revision_info*']
523
custom_help('directory',
524
help='Branch to examine, '
525
'rather than the one containing the working directory.'),
526
Option('tree', help='Show revno of working tree'),
530
def run(self, revision=None, directory=u'.', tree=False,
531
revision_info_list=[]):
534
wt = WorkingTree.open_containing(directory)[0]
536
self.add_cleanup(wt.lock_read().unlock)
537
except (errors.NoWorkingTree, errors.NotLocalUrl):
539
b = Branch.open_containing(directory)[0]
540
self.add_cleanup(b.lock_read().unlock)
542
if revision is not None:
543
revision_ids.extend(rev.as_revision_id(b) for rev in revision)
544
if revision_info_list is not None:
545
for rev_str in revision_info_list:
546
rev_spec = RevisionSpec.from_string(rev_str)
547
revision_ids.append(rev_spec.as_revision_id(b))
548
# No arguments supplied, default to the last revision
549
if len(revision_ids) == 0:
552
raise errors.NoWorkingTree(directory)
553
revision_ids.append(wt.last_revision())
555
revision_ids.append(b.last_revision())
559
for revision_id in revision_ids:
561
dotted_revno = b.revision_id_to_dotted_revno(revision_id)
562
revno = '.'.join(str(i) for i in dotted_revno)
563
except errors.NoSuchRevision:
565
maxlen = max(maxlen, len(revno))
566
revinfos.append([revno, revision_id])
570
self.outf.write('%*s %s\n' % (maxlen, ri[0], ri[1]))
573
class cmd_add(Command):
574
__doc__ = """Add specified files or directories.
576
In non-recursive mode, all the named items are added, regardless
577
of whether they were previously ignored. A warning is given if
578
any of the named files are already versioned.
580
In recursive mode (the default), files are treated the same way
581
but the behaviour for directories is different. Directories that
582
are already versioned do not give a warning. All directories,
583
whether already versioned or not, are searched for files or
584
subdirectories that are neither versioned or ignored, and these
585
are added. This search proceeds recursively into versioned
586
directories. If no names are given '.' is assumed.
588
Therefore simply saying 'bzr add' will version all files that
589
are currently unknown.
591
Adding a file whose parent directory is not versioned will
592
implicitly add the parent, and so on up to the root. This means
593
you should never need to explicitly add a directory, they'll just
594
get added when you add a file in the directory.
596
--dry-run will show which files would be added, but not actually
599
--file-ids-from will try to use the file ids from the supplied path.
600
It looks up ids trying to find a matching parent directory with the
601
same filename, and then by pure path. This option is rarely needed
602
but can be useful when adding the same logical file into two
603
branches that will be merged later (without showing the two different
604
adds as a conflict). It is also useful when merging another project
605
into a subdirectory of this one.
607
Any files matching patterns in the ignore list will not be added
608
unless they are explicitly mentioned.
610
takes_args = ['file*']
613
help="Don't recursively add the contents of directories."),
615
help="Show what would be done, but don't actually do anything."),
617
Option('file-ids-from',
619
help='Lookup file ids from this tree.'),
621
encoding_type = 'replace'
622
_see_also = ['remove', 'ignore']
624
def run(self, file_list, no_recurse=False, dry_run=False, verbose=False,
629
if file_ids_from is not None:
631
base_tree, base_path = WorkingTree.open_containing(
633
except errors.NoWorkingTree:
634
base_branch, base_path = Branch.open_containing(
636
base_tree = base_branch.basis_tree()
638
action = bzrlib.add.AddFromBaseAction(base_tree, base_path,
639
to_file=self.outf, should_print=(not is_quiet()))
641
action = bzrlib.add.AddAction(to_file=self.outf,
642
should_print=(not is_quiet()))
645
self.add_cleanup(base_tree.lock_read().unlock)
646
tree, file_list = tree_files_for_add(file_list)
647
added, ignored = tree.smart_add(file_list, not
648
no_recurse, action=action, save=not dry_run)
652
for glob in sorted(ignored.keys()):
653
for path in ignored[glob]:
654
self.outf.write("ignored %s matching \"%s\"\n"
658
class cmd_mkdir(Command):
659
__doc__ = """Create a new versioned directory.
661
This is equivalent to creating the directory and then adding it.
664
takes_args = ['dir+']
665
encoding_type = 'replace'
667
def run(self, dir_list):
669
wt, dd = WorkingTree.open_containing(d)
670
base = os.path.dirname(dd)
671
id = wt.path2id(base)
675
self.outf.write('added %s\n' % d)
677
raise errors.NotVersionedError(path=base)
680
class cmd_relpath(Command):
681
__doc__ = """Show path of a file relative to root"""
683
takes_args = ['filename']
687
def run(self, filename):
688
# TODO: jam 20050106 Can relpath return a munged path if
689
# sys.stdout encoding cannot represent it?
690
tree, relpath = WorkingTree.open_containing(filename)
691
self.outf.write(relpath)
692
self.outf.write('\n')
695
class cmd_inventory(Command):
696
__doc__ = """Show inventory of the current working copy or a revision.
698
It is possible to limit the output to a particular entry
699
type using the --kind option. For example: --kind file.
701
It is also possible to restrict the list of files to a specific
702
set. For example: bzr inventory --show-ids this/file
711
help='List entries of a particular kind: file, directory, symlink.',
714
takes_args = ['file*']
717
def run(self, revision=None, show_ids=False, kind=None, file_list=None):
718
if kind and kind not in ['file', 'directory', 'symlink']:
719
raise errors.BzrCommandError('invalid kind %r specified' % (kind,))
721
revision = _get_one_revision('inventory', revision)
722
work_tree, file_list = WorkingTree.open_containing_paths(file_list)
723
self.add_cleanup(work_tree.lock_read().unlock)
724
if revision is not None:
725
tree = revision.as_tree(work_tree.branch)
727
extra_trees = [work_tree]
728
self.add_cleanup(tree.lock_read().unlock)
733
if file_list is not None:
734
file_ids = tree.paths2ids(file_list, trees=extra_trees,
735
require_versioned=True)
736
# find_ids_across_trees may include some paths that don't
738
entries = sorted((tree.id2path(file_id), tree.inventory[file_id])
739
for file_id in file_ids if file_id in tree)
741
entries = tree.inventory.entries()
744
for path, entry in entries:
745
if kind and kind != entry.kind:
748
self.outf.write('%-50s %s\n' % (path, entry.file_id))
750
self.outf.write(path)
751
self.outf.write('\n')
754
class cmd_mv(Command):
755
__doc__ = """Move or rename a file.
758
bzr mv OLDNAME NEWNAME
760
bzr mv SOURCE... DESTINATION
762
If the last argument is a versioned directory, all the other names
763
are moved into it. Otherwise, there must be exactly two arguments
764
and the file is changed to a new name.
766
If OLDNAME does not exist on the filesystem but is versioned and
767
NEWNAME does exist on the filesystem but is not versioned, mv
768
assumes that the file has been manually moved and only updates
769
its internal inventory to reflect that change.
770
The same is valid when moving many SOURCE files to a DESTINATION.
772
Files cannot be moved between branches.
775
takes_args = ['names*']
776
takes_options = [Option("after", help="Move only the bzr identifier"
777
" of the file, because the file has already been moved."),
778
Option('auto', help='Automatically guess renames.'),
779
Option('dry-run', help='Avoid making changes when guessing renames.'),
781
aliases = ['move', 'rename']
782
encoding_type = 'replace'
784
def run(self, names_list, after=False, auto=False, dry_run=False):
786
return self.run_auto(names_list, after, dry_run)
788
raise errors.BzrCommandError('--dry-run requires --auto.')
789
if names_list is None:
791
if len(names_list) < 2:
792
raise errors.BzrCommandError("missing file argument")
793
tree, rel_names = WorkingTree.open_containing_paths(names_list, canonicalize=False)
794
self.add_cleanup(tree.lock_tree_write().unlock)
795
self._run(tree, names_list, rel_names, after)
797
def run_auto(self, names_list, after, dry_run):
798
if names_list is not None and len(names_list) > 1:
799
raise errors.BzrCommandError('Only one path may be specified to'
802
raise errors.BzrCommandError('--after cannot be specified with'
804
work_tree, file_list = WorkingTree.open_containing_paths(
805
names_list, default_directory='.')
806
self.add_cleanup(work_tree.lock_tree_write().unlock)
807
rename_map.RenameMap.guess_renames(work_tree, dry_run)
809
def _run(self, tree, names_list, rel_names, after):
810
into_existing = osutils.isdir(names_list[-1])
811
if into_existing and len(names_list) == 2:
813
# a. case-insensitive filesystem and change case of dir
814
# b. move directory after the fact (if the source used to be
815
# a directory, but now doesn't exist in the working tree
816
# and the target is an existing directory, just rename it)
817
if (not tree.case_sensitive
818
and rel_names[0].lower() == rel_names[1].lower()):
819
into_existing = False
822
# 'fix' the case of a potential 'from'
823
from_id = tree.path2id(
824
tree.get_canonical_inventory_path(rel_names[0]))
825
if (not osutils.lexists(names_list[0]) and
826
from_id and inv.get_file_kind(from_id) == "directory"):
827
into_existing = False
830
# move into existing directory
831
# All entries reference existing inventory items, so fix them up
832
# for cicp file-systems.
833
rel_names = tree.get_canonical_inventory_paths(rel_names)
834
for src, dest in tree.move(rel_names[:-1], rel_names[-1], after=after):
836
self.outf.write("%s => %s\n" % (src, dest))
838
if len(names_list) != 2:
839
raise errors.BzrCommandError('to mv multiple files the'
840
' destination must be a versioned'
843
# for cicp file-systems: the src references an existing inventory
845
src = tree.get_canonical_inventory_path(rel_names[0])
846
# Find the canonical version of the destination: In all cases, the
847
# parent of the target must be in the inventory, so we fetch the
848
# canonical version from there (we do not always *use* the
849
# canonicalized tail portion - we may be attempting to rename the
851
canon_dest = tree.get_canonical_inventory_path(rel_names[1])
852
dest_parent = osutils.dirname(canon_dest)
853
spec_tail = osutils.basename(rel_names[1])
854
# For a CICP file-system, we need to avoid creating 2 inventory
855
# entries that differ only by case. So regardless of the case
856
# we *want* to use (ie, specified by the user or the file-system),
857
# we must always choose to use the case of any existing inventory
858
# items. The only exception to this is when we are attempting a
859
# case-only rename (ie, canonical versions of src and dest are
861
dest_id = tree.path2id(canon_dest)
862
if dest_id is None or tree.path2id(src) == dest_id:
863
# No existing item we care about, so work out what case we
864
# are actually going to use.
866
# If 'after' is specified, the tail must refer to a file on disk.
868
dest_parent_fq = osutils.pathjoin(tree.basedir, dest_parent)
870
# pathjoin with an empty tail adds a slash, which breaks
872
dest_parent_fq = tree.basedir
874
dest_tail = osutils.canonical_relpath(
876
osutils.pathjoin(dest_parent_fq, spec_tail))
878
# not 'after', so case as specified is used
879
dest_tail = spec_tail
881
# Use the existing item so 'mv' fails with AlreadyVersioned.
882
dest_tail = os.path.basename(canon_dest)
883
dest = osutils.pathjoin(dest_parent, dest_tail)
884
mutter("attempting to move %s => %s", src, dest)
885
tree.rename_one(src, dest, after=after)
887
self.outf.write("%s => %s\n" % (src, dest))
890
class cmd_pull(Command):
891
__doc__ = """Turn this branch into a mirror of another branch.
893
By default, this command only works on branches that have not diverged.
894
Branches are considered diverged if the destination branch's most recent
895
commit is one that has not been merged (directly or indirectly) into the
898
If branches have diverged, you can use 'bzr merge' to integrate the changes
899
from one into the other. Once one branch has merged, the other should
900
be able to pull it again.
902
If you want to replace your local changes and just want your branch to
903
match the remote one, use pull --overwrite. This will work even if the two
904
branches have diverged.
906
If there is no default location set, the first pull will set it. After
907
that, you can omit the location to use the default. To change the
908
default, use --remember. The value will only be saved if the remote
909
location can be accessed.
911
Note: The location can be specified either in the form of a branch,
912
or in the form of a path to a file containing a merge directive generated
916
_see_also = ['push', 'update', 'status-flags', 'send']
917
takes_options = ['remember', 'overwrite', 'revision',
918
custom_help('verbose',
919
help='Show logs of pulled revisions.'),
920
custom_help('directory',
921
help='Branch to pull into, '
922
'rather than the one containing the working directory.'),
924
help="Perform a local pull in a bound "
925
"branch. Local pulls are not applied to "
929
help="Show base revision text in conflicts.")
931
takes_args = ['location?']
932
encoding_type = 'replace'
934
def run(self, location=None, remember=False, overwrite=False,
935
revision=None, verbose=False,
936
directory=None, local=False,
938
# FIXME: too much stuff is in the command class
941
if directory is None:
944
tree_to = WorkingTree.open_containing(directory)[0]
945
branch_to = tree_to.branch
946
self.add_cleanup(tree_to.lock_write().unlock)
947
except errors.NoWorkingTree:
949
branch_to = Branch.open_containing(directory)[0]
950
self.add_cleanup(branch_to.lock_write().unlock)
952
if tree_to is None and show_base:
953
raise errors.BzrCommandError("Need working tree for --show-base.")
955
if local and not branch_to.get_bound_location():
956
raise errors.LocalRequiresBoundBranch()
958
possible_transports = []
959
if location is not None:
961
mergeable = bundle.read_mergeable_from_url(location,
962
possible_transports=possible_transports)
963
except errors.NotABundle:
966
stored_loc = branch_to.get_parent()
968
if stored_loc is None:
969
raise errors.BzrCommandError("No pull location known or"
972
display_url = urlutils.unescape_for_display(stored_loc,
975
self.outf.write("Using saved parent location: %s\n" % display_url)
976
location = stored_loc
978
revision = _get_one_revision('pull', revision)
979
if mergeable is not None:
980
if revision is not None:
981
raise errors.BzrCommandError(
982
'Cannot use -r with merge directives or bundles')
983
mergeable.install_revisions(branch_to.repository)
984
base_revision_id, revision_id, verified = \
985
mergeable.get_merge_request(branch_to.repository)
986
branch_from = branch_to
988
branch_from = Branch.open(location,
989
possible_transports=possible_transports)
990
self.add_cleanup(branch_from.lock_read().unlock)
992
if branch_to.get_parent() is None or remember:
993
branch_to.set_parent(branch_from.base)
995
if revision is not None:
996
revision_id = revision.as_revision_id(branch_from)
998
if tree_to is not None:
999
view_info = _get_view_info_for_change_reporter(tree_to)
1000
change_reporter = delta._ChangeReporter(
1001
unversioned_filter=tree_to.is_ignored,
1002
view_info=view_info)
1003
result = tree_to.pull(
1004
branch_from, overwrite, revision_id, change_reporter,
1005
possible_transports=possible_transports, local=local,
1006
show_base=show_base)
1008
result = branch_to.pull(
1009
branch_from, overwrite, revision_id, local=local)
1011
result.report(self.outf)
1012
if verbose and result.old_revid != result.new_revid:
1013
log.show_branch_change(
1014
branch_to, self.outf, result.old_revno,
1018
class cmd_push(Command):
1019
__doc__ = """Update a mirror of this branch.
1021
The target branch will not have its working tree populated because this
1022
is both expensive, and is not supported on remote file systems.
1024
Some smart servers or protocols *may* put the working tree in place in
1027
This command only works on branches that have not diverged. Branches are
1028
considered diverged if the destination branch's most recent commit is one
1029
that has not been merged (directly or indirectly) by the source branch.
1031
If branches have diverged, you can use 'bzr push --overwrite' to replace
1032
the other branch completely, discarding its unmerged changes.
1034
If you want to ensure you have the different changes in the other branch,
1035
do a merge (see bzr help merge) from the other branch, and commit that.
1036
After that you will be able to do a push without '--overwrite'.
1038
If there is no default push location set, the first push will set it.
1039
After that, you can omit the location to use the default. To change the
1040
default, use --remember. The value will only be saved if the remote
1041
location can be accessed.
1044
_see_also = ['pull', 'update', 'working-trees']
1045
takes_options = ['remember', 'overwrite', 'verbose', 'revision',
1046
Option('create-prefix',
1047
help='Create the path leading up to the branch '
1048
'if it does not already exist.'),
1049
custom_help('directory',
1050
help='Branch to push from, '
1051
'rather than the one containing the working directory.'),
1052
Option('use-existing-dir',
1053
help='By default push will fail if the target'
1054
' directory exists, but does not already'
1055
' have a control directory. This flag will'
1056
' allow push to proceed.'),
1058
help='Create a stacked branch that references the public location '
1059
'of the parent branch.'),
1060
Option('stacked-on',
1061
help='Create a stacked branch that refers to another branch '
1062
'for the commit history. Only the work not present in the '
1063
'referenced branch is included in the branch created.',
1066
help='Refuse to push if there are uncommitted changes in'
1067
' the working tree, --no-strict disables the check.'),
1069
takes_args = ['location?']
1070
encoding_type = 'replace'
1072
def run(self, location=None, remember=False, overwrite=False,
1073
create_prefix=False, verbose=False, revision=None,
1074
use_existing_dir=False, directory=None, stacked_on=None,
1075
stacked=False, strict=None):
1076
from bzrlib.push import _show_push_branch
1078
if directory is None:
1080
# Get the source branch
1082
_unused) = bzrdir.BzrDir.open_containing_tree_or_branch(directory)
1083
# Get the tip's revision_id
1084
revision = _get_one_revision('push', revision)
1085
if revision is not None:
1086
revision_id = revision.in_history(br_from).rev_id
1089
if tree is not None and revision_id is None:
1090
tree.check_changed_or_out_of_date(
1091
strict, 'push_strict',
1092
more_error='Use --no-strict to force the push.',
1093
more_warning='Uncommitted changes will not be pushed.')
1094
# Get the stacked_on branch, if any
1095
if stacked_on is not None:
1096
stacked_on = urlutils.normalize_url(stacked_on)
1098
parent_url = br_from.get_parent()
1100
parent = Branch.open(parent_url)
1101
stacked_on = parent.get_public_branch()
1103
# I considered excluding non-http url's here, thus forcing
1104
# 'public' branches only, but that only works for some
1105
# users, so it's best to just depend on the user spotting an
1106
# error by the feedback given to them. RBC 20080227.
1107
stacked_on = parent_url
1109
raise errors.BzrCommandError(
1110
"Could not determine branch to refer to.")
1112
# Get the destination location
1113
if location is None:
1114
stored_loc = br_from.get_push_location()
1115
if stored_loc is None:
1116
raise errors.BzrCommandError(
1117
"No push location known or specified.")
1119
display_url = urlutils.unescape_for_display(stored_loc,
1121
self.outf.write("Using saved push location: %s\n" % display_url)
1122
location = stored_loc
1124
_show_push_branch(br_from, revision_id, location, self.outf,
1125
verbose=verbose, overwrite=overwrite, remember=remember,
1126
stacked_on=stacked_on, create_prefix=create_prefix,
1127
use_existing_dir=use_existing_dir)
1130
class cmd_branch(Command):
1131
__doc__ = """Create a new branch that is a copy of an existing branch.
1133
If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
1134
be used. In other words, "branch ../foo/bar" will attempt to create ./bar.
1135
If the FROM_LOCATION has no / or path separator embedded, the TO_LOCATION
1136
is derived from the FROM_LOCATION by stripping a leading scheme or drive
1137
identifier, if any. For example, "branch lp:foo-bar" will attempt to
1140
To retrieve the branch as of a particular revision, supply the --revision
1141
parameter, as in "branch foo/bar -r 5".
1144
_see_also = ['checkout']
1145
takes_args = ['from_location', 'to_location?']
1146
takes_options = ['revision',
1147
Option('hardlink', help='Hard-link working tree files where possible.'),
1148
Option('files-from', type=str,
1149
help="Get file contents from this tree."),
1151
help="Create a branch without a working-tree."),
1153
help="Switch the checkout in the current directory "
1154
"to the new branch."),
1156
help='Create a stacked branch referring to the source branch. '
1157
'The new branch will depend on the availability of the source '
1158
'branch for all operations.'),
1159
Option('standalone',
1160
help='Do not use a shared repository, even if available.'),
1161
Option('use-existing-dir',
1162
help='By default branch will fail if the target'
1163
' directory exists, but does not already'
1164
' have a control directory. This flag will'
1165
' allow branch to proceed.'),
1167
help="Bind new branch to from location."),
1169
aliases = ['get', 'clone']
1171
def run(self, from_location, to_location=None, revision=None,
1172
hardlink=False, stacked=False, standalone=False, no_tree=False,
1173
use_existing_dir=False, switch=False, bind=False,
1175
from bzrlib import switch as _mod_switch
1176
from bzrlib.tag import _merge_tags_if_possible
1177
accelerator_tree, br_from = bzrdir.BzrDir.open_tree_or_branch(
1179
if not (hardlink or files_from):
1180
# accelerator_tree is usually slower because you have to read N
1181
# files (no readahead, lots of seeks, etc), but allow the user to
1182
# explicitly request it
1183
accelerator_tree = None
1184
if files_from is not None and files_from != from_location:
1185
accelerator_tree = WorkingTree.open(files_from)
1186
revision = _get_one_revision('branch', revision)
1187
self.add_cleanup(br_from.lock_read().unlock)
1188
if revision is not None:
1189
revision_id = revision.as_revision_id(br_from)
1191
# FIXME - wt.last_revision, fallback to branch, fall back to
1192
# None or perhaps NULL_REVISION to mean copy nothing
1194
revision_id = br_from.last_revision()
1195
if to_location is None:
1196
to_location = urlutils.derive_to_location(from_location)
1197
to_transport = transport.get_transport(to_location)
1199
to_transport.mkdir('.')
1200
except errors.FileExists:
1201
if not use_existing_dir:
1202
raise errors.BzrCommandError('Target directory "%s" '
1203
'already exists.' % to_location)
1206
bzrdir.BzrDir.open_from_transport(to_transport)
1207
except errors.NotBranchError:
1210
raise errors.AlreadyBranchError(to_location)
1211
except errors.NoSuchFile:
1212
raise errors.BzrCommandError('Parent of "%s" does not exist.'
1215
# preserve whatever source format we have.
1216
dir = br_from.bzrdir.sprout(to_transport.base, revision_id,
1217
possible_transports=[to_transport],
1218
accelerator_tree=accelerator_tree,
1219
hardlink=hardlink, stacked=stacked,
1220
force_new_repo=standalone,
1221
create_tree_if_local=not no_tree,
1222
source_branch=br_from)
1223
branch = dir.open_branch()
1224
except errors.NoSuchRevision:
1225
to_transport.delete_tree('.')
1226
msg = "The branch %s has no revision %s." % (from_location,
1228
raise errors.BzrCommandError(msg)
1229
_merge_tags_if_possible(br_from, branch)
1230
# If the source branch is stacked, the new branch may
1231
# be stacked whether we asked for that explicitly or not.
1232
# We therefore need a try/except here and not just 'if stacked:'
1234
note('Created new stacked branch referring to %s.' %
1235
branch.get_stacked_on_url())
1236
except (errors.NotStacked, errors.UnstackableBranchFormat,
1237
errors.UnstackableRepositoryFormat), e:
1238
note('Branched %d revision(s).' % branch.revno())
1240
# Bind to the parent
1241
parent_branch = Branch.open(from_location)
1242
branch.bind(parent_branch)
1243
note('New branch bound to %s' % from_location)
1245
# Switch to the new branch
1246
wt, _ = WorkingTree.open_containing('.')
1247
_mod_switch.switch(wt.bzrdir, branch)
1248
note('Switched to branch: %s',
1249
urlutils.unescape_for_display(branch.base, 'utf-8'))
1252
class cmd_checkout(Command):
1253
__doc__ = """Create a new checkout of an existing branch.
1255
If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
1256
the branch found in '.'. This is useful if you have removed the working tree
1257
or if it was never created - i.e. if you pushed the branch to its current
1258
location using SFTP.
1260
If the TO_LOCATION is omitted, the last component of the BRANCH_LOCATION will
1261
be used. In other words, "checkout ../foo/bar" will attempt to create ./bar.
1262
If the BRANCH_LOCATION has no / or path separator embedded, the TO_LOCATION
1263
is derived from the BRANCH_LOCATION by stripping a leading scheme or drive
1264
identifier, if any. For example, "checkout lp:foo-bar" will attempt to
1267
To retrieve the branch as of a particular revision, supply the --revision
1268
parameter, as in "checkout foo/bar -r 5". Note that this will be immediately
1269
out of date [so you cannot commit] but it may be useful (i.e. to examine old
1273
_see_also = ['checkouts', 'branch']
1274
takes_args = ['branch_location?', 'to_location?']
1275
takes_options = ['revision',
1276
Option('lightweight',
1277
help="Perform a lightweight checkout. Lightweight "
1278
"checkouts depend on access to the branch for "
1279
"every operation. Normal checkouts can perform "
1280
"common operations like diff and status without "
1281
"such access, and also support local commits."
1283
Option('files-from', type=str,
1284
help="Get file contents from this tree."),
1286
help='Hard-link working tree files where possible.'
1291
def run(self, branch_location=None, to_location=None, revision=None,
1292
lightweight=False, files_from=None, hardlink=False):
1293
if branch_location is None:
1294
branch_location = osutils.getcwd()
1295
to_location = branch_location
1296
accelerator_tree, source = bzrdir.BzrDir.open_tree_or_branch(
1298
if not (hardlink or files_from):
1299
# accelerator_tree is usually slower because you have to read N
1300
# files (no readahead, lots of seeks, etc), but allow the user to
1301
# explicitly request it
1302
accelerator_tree = None
1303
revision = _get_one_revision('checkout', revision)
1304
if files_from is not None and files_from != branch_location:
1305
accelerator_tree = WorkingTree.open(files_from)
1306
if revision is not None:
1307
revision_id = revision.as_revision_id(source)
1310
if to_location is None:
1311
to_location = urlutils.derive_to_location(branch_location)
1312
# if the source and to_location are the same,
1313
# and there is no working tree,
1314
# then reconstitute a branch
1315
if (osutils.abspath(to_location) ==
1316
osutils.abspath(branch_location)):
1318
source.bzrdir.open_workingtree()
1319
except errors.NoWorkingTree:
1320
source.bzrdir.create_workingtree(revision_id)
1322
source.create_checkout(to_location, revision_id, lightweight,
1323
accelerator_tree, hardlink)
1326
class cmd_renames(Command):
1327
__doc__ = """Show list of renamed files.
1329
# TODO: Option to show renames between two historical versions.
1331
# TODO: Only show renames under dir, rather than in the whole branch.
1332
_see_also = ['status']
1333
takes_args = ['dir?']
1336
def run(self, dir=u'.'):
1337
tree = WorkingTree.open_containing(dir)[0]
1338
self.add_cleanup(tree.lock_read().unlock)
1339
new_inv = tree.inventory
1340
old_tree = tree.basis_tree()
1341
self.add_cleanup(old_tree.lock_read().unlock)
1342
old_inv = old_tree.inventory
1344
iterator = tree.iter_changes(old_tree, include_unchanged=True)
1345
for f, paths, c, v, p, n, k, e in iterator:
1346
if paths[0] == paths[1]:
1350
renames.append(paths)
1352
for old_name, new_name in renames:
1353
self.outf.write("%s => %s\n" % (old_name, new_name))
1356
class cmd_update(Command):
1357
__doc__ = """Update a tree to have the latest code committed to its branch.
1359
This will perform a merge into the working tree, and may generate
1360
conflicts. If you have any local changes, you will still
1361
need to commit them after the update for the update to be complete.
1363
If you want to discard your local changes, you can just do a
1364
'bzr revert' instead of 'bzr commit' after the update.
1366
If you want to restore a file that has been removed locally, use
1367
'bzr revert' instead of 'bzr update'.
1369
If the tree's branch is bound to a master branch, it will also update
1370
the branch from the master.
1373
_see_also = ['pull', 'working-trees', 'status-flags']
1374
takes_args = ['dir?']
1375
takes_options = ['revision',
1377
help="Show base revision text in conflicts."),
1381
def run(self, dir='.', revision=None, show_base=None):
1382
if revision is not None and len(revision) != 1:
1383
raise errors.BzrCommandError(
1384
"bzr update --revision takes exactly one revision")
1385
tree = WorkingTree.open_containing(dir)[0]
1386
branch = tree.branch
1387
possible_transports = []
1388
master = branch.get_master_branch(
1389
possible_transports=possible_transports)
1390
if master is not None:
1391
branch_location = master.base
1394
branch_location = tree.branch.base
1395
tree.lock_tree_write()
1396
self.add_cleanup(tree.unlock)
1397
# get rid of the final '/' and be ready for display
1398
branch_location = urlutils.unescape_for_display(
1399
branch_location.rstrip('/'),
1401
existing_pending_merges = tree.get_parent_ids()[1:]
1405
# may need to fetch data into a heavyweight checkout
1406
# XXX: this may take some time, maybe we should display a
1408
old_tip = branch.update(possible_transports)
1409
if revision is not None:
1410
revision_id = revision[0].as_revision_id(branch)
1412
revision_id = branch.last_revision()
1413
if revision_id == _mod_revision.ensure_null(tree.last_revision()):
1414
revno = branch.revision_id_to_dotted_revno(revision_id)
1415
note("Tree is up to date at revision %s of branch %s" %
1416
('.'.join(map(str, revno)), branch_location))
1418
view_info = _get_view_info_for_change_reporter(tree)
1419
change_reporter = delta._ChangeReporter(
1420
unversioned_filter=tree.is_ignored,
1421
view_info=view_info)
1423
conflicts = tree.update(
1425
possible_transports=possible_transports,
1426
revision=revision_id,
1428
show_base=show_base)
1429
except errors.NoSuchRevision, e:
1430
raise errors.BzrCommandError(
1431
"branch has no revision %s\n"
1432
"bzr update --revision only works"
1433
" for a revision in the branch history"
1435
revno = tree.branch.revision_id_to_dotted_revno(
1436
_mod_revision.ensure_null(tree.last_revision()))
1437
note('Updated to revision %s of branch %s' %
1438
('.'.join(map(str, revno)), branch_location))
1439
parent_ids = tree.get_parent_ids()
1440
if parent_ids[1:] and parent_ids[1:] != existing_pending_merges:
1441
note('Your local commits will now show as pending merges with '
1442
"'bzr status', and can be committed with 'bzr commit'.")
1449
class cmd_info(Command):
1450
__doc__ = """Show information about a working tree, branch or repository.
1452
This command will show all known locations and formats associated to the
1453
tree, branch or repository.
1455
In verbose mode, statistical information is included with each report.
1456
To see extended statistic information, use a verbosity level of 2 or
1457
higher by specifying the verbose option multiple times, e.g. -vv.
1459
Branches and working trees will also report any missing revisions.
1463
Display information on the format and related locations:
1467
Display the above together with extended format information and
1468
basic statistics (like the number of files in the working tree and
1469
number of revisions in the branch and repository):
1473
Display the above together with number of committers to the branch:
1477
_see_also = ['revno', 'working-trees', 'repositories']
1478
takes_args = ['location?']
1479
takes_options = ['verbose']
1480
encoding_type = 'replace'
1483
def run(self, location=None, verbose=False):
1485
noise_level = get_verbosity_level()
1488
from bzrlib.info import show_bzrdir_info
1489
show_bzrdir_info(bzrdir.BzrDir.open_containing(location)[0],
1490
verbose=noise_level, outfile=self.outf)
1493
class cmd_remove(Command):
1494
__doc__ = """Remove files or directories.
1496
This makes Bazaar stop tracking changes to the specified files. Bazaar will
1497
delete them if they can easily be recovered using revert otherwise they
1498
will be backed up (adding an extention of the form .~#~). If no options or
1499
parameters are given Bazaar will scan for files that are being tracked by
1500
Bazaar but missing in your tree and stop tracking them for you.
1502
takes_args = ['file*']
1503
takes_options = ['verbose',
1504
Option('new', help='Only remove files that have never been committed.'),
1505
RegistryOption.from_kwargs('file-deletion-strategy',
1506
'The file deletion mode to be used.',
1507
title='Deletion Strategy', value_switches=True, enum_switch=False,
1508
safe='Backup changed files (default).',
1509
keep='Delete from bzr but leave the working copy.',
1510
no_backup='Don\'t backup changed files.',
1511
force='Delete all the specified files, even if they can not be '
1512
'recovered and even if they are non-empty directories. '
1513
'(deprecated, use no-backup)')]
1514
aliases = ['rm', 'del']
1515
encoding_type = 'replace'
1517
def run(self, file_list, verbose=False, new=False,
1518
file_deletion_strategy='safe'):
1519
if file_deletion_strategy == 'force':
1520
note("(The --force option is deprecated, rather use --no-backup "
1522
file_deletion_strategy = 'no-backup'
1524
tree, file_list = WorkingTree.open_containing_paths(file_list)
1526
if file_list is not None:
1527
file_list = [f for f in file_list]
1529
self.add_cleanup(tree.lock_write().unlock)
1530
# Heuristics should probably all move into tree.remove_smart or
1533
added = tree.changes_from(tree.basis_tree(),
1534
specific_files=file_list).added
1535
file_list = sorted([f[0] for f in added], reverse=True)
1536
if len(file_list) == 0:
1537
raise errors.BzrCommandError('No matching files.')
1538
elif file_list is None:
1539
# missing files show up in iter_changes(basis) as
1540
# versioned-with-no-kind.
1542
for change in tree.iter_changes(tree.basis_tree()):
1543
# Find paths in the working tree that have no kind:
1544
if change[1][1] is not None and change[6][1] is None:
1545
missing.append(change[1][1])
1546
file_list = sorted(missing, reverse=True)
1547
file_deletion_strategy = 'keep'
1548
tree.remove(file_list, verbose=verbose, to_file=self.outf,
1549
keep_files=file_deletion_strategy=='keep',
1550
force=(file_deletion_strategy=='no-backup'))
1553
class cmd_file_id(Command):
1554
__doc__ = """Print file_id of a particular file or directory.
1556
The file_id is assigned when the file is first added and remains the
1557
same through all revisions where the file exists, even when it is
1562
_see_also = ['inventory', 'ls']
1563
takes_args = ['filename']
1566
def run(self, filename):
1567
tree, relpath = WorkingTree.open_containing(filename)
1568
i = tree.path2id(relpath)
1570
raise errors.NotVersionedError(filename)
1572
self.outf.write(i + '\n')
1575
class cmd_file_path(Command):
1576
__doc__ = """Print path of file_ids to a file or directory.
1578
This prints one line for each directory down to the target,
1579
starting at the branch root.
1583
takes_args = ['filename']
1586
def run(self, filename):
1587
tree, relpath = WorkingTree.open_containing(filename)
1588
fid = tree.path2id(relpath)
1590
raise errors.NotVersionedError(filename)
1591
segments = osutils.splitpath(relpath)
1592
for pos in range(1, len(segments) + 1):
1593
path = osutils.joinpath(segments[:pos])
1594
self.outf.write("%s\n" % tree.path2id(path))
1597
class cmd_reconcile(Command):
1598
__doc__ = """Reconcile bzr metadata in a branch.
1600
This can correct data mismatches that may have been caused by
1601
previous ghost operations or bzr upgrades. You should only
1602
need to run this command if 'bzr check' or a bzr developer
1603
advises you to run it.
1605
If a second branch is provided, cross-branch reconciliation is
1606
also attempted, which will check that data like the tree root
1607
id which was not present in very early bzr versions is represented
1608
correctly in both branches.
1610
At the same time it is run it may recompress data resulting in
1611
a potential saving in disk space or performance gain.
1613
The branch *MUST* be on a listable system such as local disk or sftp.
1616
_see_also = ['check']
1617
takes_args = ['branch?']
1619
Option('canonicalize-chks',
1620
help='Make sure CHKs are in canonical form (repairs '
1625
def run(self, branch=".", canonicalize_chks=False):
1626
from bzrlib.reconcile import reconcile
1627
dir = bzrdir.BzrDir.open(branch)
1628
reconcile(dir, canonicalize_chks=canonicalize_chks)
1631
class cmd_revision_history(Command):
1632
__doc__ = """Display the list of revision ids on a branch."""
1635
takes_args = ['location?']
1640
def run(self, location="."):
1641
branch = Branch.open_containing(location)[0]
1642
for revid in branch.revision_history():
1643
self.outf.write(revid)
1644
self.outf.write('\n')
1647
class cmd_ancestry(Command):
1648
__doc__ = """List all revisions merged into this branch."""
1650
_see_also = ['log', 'revision-history']
1651
takes_args = ['location?']
1656
def run(self, location="."):
1658
wt = WorkingTree.open_containing(location)[0]
1659
except errors.NoWorkingTree:
1660
b = Branch.open(location)
1661
last_revision = b.last_revision()
1664
last_revision = wt.last_revision()
1666
revision_ids = b.repository.get_ancestry(last_revision)
1668
for revision_id in revision_ids:
1669
self.outf.write(revision_id + '\n')
1672
class cmd_init(Command):
1673
__doc__ = """Make a directory into a versioned branch.
1675
Use this to create an empty branch, or before importing an
1678
If there is a repository in a parent directory of the location, then
1679
the history of the branch will be stored in the repository. Otherwise
1680
init creates a standalone branch which carries its own history
1681
in the .bzr directory.
1683
If there is already a branch at the location but it has no working tree,
1684
the tree can be populated with 'bzr checkout'.
1686
Recipe for importing a tree of files::
1692
bzr commit -m "imported project"
1695
_see_also = ['init-repository', 'branch', 'checkout']
1696
takes_args = ['location?']
1698
Option('create-prefix',
1699
help='Create the path leading up to the branch '
1700
'if it does not already exist.'),
1701
RegistryOption('format',
1702
help='Specify a format for this branch. '
1703
'See "help formats".',
1704
lazy_registry=('bzrlib.bzrdir', 'format_registry'),
1705
converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
1706
value_switches=True,
1707
title="Branch format",
1709
Option('append-revisions-only',
1710
help='Never change revnos or the existing log.'
1711
' Append revisions to it only.')
1713
def run(self, location=None, format=None, append_revisions_only=False,
1714
create_prefix=False):
1716
format = bzrdir.format_registry.make_bzrdir('default')
1717
if location is None:
1720
to_transport = transport.get_transport(location)
1722
# The path has to exist to initialize a
1723
# branch inside of it.
1724
# Just using os.mkdir, since I don't
1725
# believe that we want to create a bunch of
1726
# locations if the user supplies an extended path
1728
to_transport.ensure_base()
1729
except errors.NoSuchFile:
1730
if not create_prefix:
1731
raise errors.BzrCommandError("Parent directory of %s"
1733
"\nYou may supply --create-prefix to create all"
1734
" leading parent directories."
1736
to_transport.create_prefix()
1739
a_bzrdir = bzrdir.BzrDir.open_from_transport(to_transport)
1740
except errors.NotBranchError:
1741
# really a NotBzrDir error...
1742
create_branch = bzrdir.BzrDir.create_branch_convenience
1743
branch = create_branch(to_transport.base, format=format,
1744
possible_transports=[to_transport])
1745
a_bzrdir = branch.bzrdir
1747
from bzrlib.transport.local import LocalTransport
1748
if a_bzrdir.has_branch():
1749
if (isinstance(to_transport, LocalTransport)
1750
and not a_bzrdir.has_workingtree()):
1751
raise errors.BranchExistsWithoutWorkingTree(location)
1752
raise errors.AlreadyBranchError(location)
1753
branch = a_bzrdir.create_branch()
1754
a_bzrdir.create_workingtree()
1755
if append_revisions_only:
1757
branch.set_append_revisions_only(True)
1758
except errors.UpgradeRequired:
1759
raise errors.BzrCommandError('This branch format cannot be set'
1760
' to append-revisions-only. Try --default.')
1762
from bzrlib.info import describe_layout, describe_format
1764
tree = a_bzrdir.open_workingtree(recommend_upgrade=False)
1765
except (errors.NoWorkingTree, errors.NotLocalUrl):
1767
repository = branch.repository
1768
layout = describe_layout(repository, branch, tree).lower()
1769
format = describe_format(a_bzrdir, repository, branch, tree)
1770
self.outf.write("Created a %s (format: %s)\n" % (layout, format))
1771
if repository.is_shared():
1772
#XXX: maybe this can be refactored into transport.path_or_url()
1773
url = repository.bzrdir.root_transport.external_url()
1775
url = urlutils.local_path_from_url(url)
1776
except errors.InvalidURL:
1778
self.outf.write("Using shared repository: %s\n" % url)
1781
class cmd_init_repository(Command):
1782
__doc__ = """Create a shared repository for branches to share storage space.
1784
New branches created under the repository directory will store their
1785
revisions in the repository, not in the branch directory. For branches
1786
with shared history, this reduces the amount of storage needed and
1787
speeds up the creation of new branches.
1789
If the --no-trees option is given then the branches in the repository
1790
will not have working trees by default. They will still exist as
1791
directories on disk, but they will not have separate copies of the
1792
files at a certain revision. This can be useful for repositories that
1793
store branches which are interacted with through checkouts or remote
1794
branches, such as on a server.
1797
Create a shared repository holding just branches::
1799
bzr init-repo --no-trees repo
1802
Make a lightweight checkout elsewhere::
1804
bzr checkout --lightweight repo/trunk trunk-checkout
1809
_see_also = ['init', 'branch', 'checkout', 'repositories']
1810
takes_args = ["location"]
1811
takes_options = [RegistryOption('format',
1812
help='Specify a format for this repository. See'
1813
' "bzr help formats" for details.',
1814
lazy_registry=('bzrlib.bzrdir', 'format_registry'),
1815
converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
1816
value_switches=True, title='Repository format'),
1818
help='Branches in the repository will default to'
1819
' not having a working tree.'),
1821
aliases = ["init-repo"]
1823
def run(self, location, format=None, no_trees=False):
1825
format = bzrdir.format_registry.make_bzrdir('default')
1827
if location is None:
1830
to_transport = transport.get_transport(location)
1831
to_transport.ensure_base()
1833
newdir = format.initialize_on_transport(to_transport)
1834
repo = newdir.create_repository(shared=True)
1835
repo.set_make_working_trees(not no_trees)
1837
from bzrlib.info import show_bzrdir_info
1838
show_bzrdir_info(repo.bzrdir, verbose=0, outfile=self.outf)
1841
class cmd_diff(Command):
1842
__doc__ = """Show differences in the working tree, between revisions or branches.
1844
If no arguments are given, all changes for the current tree are listed.
1845
If files are given, only the changes in those files are listed.
1846
Remote and multiple branches can be compared by using the --old and
1847
--new options. If not provided, the default for both is derived from
1848
the first argument, if any, or the current tree if no arguments are
1851
"bzr diff -p1" is equivalent to "bzr diff --prefix old/:new/", and
1852
produces patches suitable for "patch -p1".
1856
2 - unrepresentable changes
1861
Shows the difference in the working tree versus the last commit::
1865
Difference between the working tree and revision 1::
1869
Difference between revision 3 and revision 1::
1873
Difference between revision 3 and revision 1 for branch xxx::
1877
To see the changes introduced in revision X::
1881
Note that in the case of a merge, the -c option shows the changes
1882
compared to the left hand parent. To see the changes against
1883
another parent, use::
1885
bzr diff -r<chosen_parent>..X
1887
The changes introduced by revision 2 (equivalent to -r1..2)::
1891
Show just the differences for file NEWS::
1895
Show the differences in working tree xxx for file NEWS::
1899
Show the differences from branch xxx to this working tree:
1903
Show the differences between two branches for file NEWS::
1905
bzr diff --old xxx --new yyy NEWS
1907
Same as 'bzr diff' but prefix paths with old/ and new/::
1909
bzr diff --prefix old/:new/
1911
Show the differences using a custom diff program with options::
1913
bzr diff --using /usr/bin/diff --diff-options -wu
1915
_see_also = ['status']
1916
takes_args = ['file*']
1918
Option('diff-options', type=str,
1919
help='Pass these options to the external diff program.'),
1920
Option('prefix', type=str,
1922
help='Set prefixes added to old and new filenames, as '
1923
'two values separated by a colon. (eg "old/:new/").'),
1925
help='Branch/tree to compare from.',
1929
help='Branch/tree to compare to.',
1935
help='Use this command to compare files.',
1938
RegistryOption('format',
1939
help='Diff format to use.',
1940
lazy_registry=('bzrlib.diff', 'format_registry'),
1941
value_switches=False, title='Diff format'),
1943
aliases = ['di', 'dif']
1944
encoding_type = 'exact'
1947
def run(self, revision=None, file_list=None, diff_options=None,
1948
prefix=None, old=None, new=None, using=None, format=None):
1949
from bzrlib.diff import (get_trees_and_branches_to_diff_locked,
1952
if (prefix is None) or (prefix == '0'):
1960
old_label, new_label = prefix.split(":")
1962
raise errors.BzrCommandError(
1963
'--prefix expects two values separated by a colon'
1964
' (eg "old/:new/")')
1966
if revision and len(revision) > 2:
1967
raise errors.BzrCommandError('bzr diff --revision takes exactly'
1968
' one or two revision specifiers')
1970
if using is not None and format is not None:
1971
raise errors.BzrCommandError('--using and --format are mutually '
1974
(old_tree, new_tree,
1975
old_branch, new_branch,
1976
specific_files, extra_trees) = get_trees_and_branches_to_diff_locked(
1977
file_list, revision, old, new, self.add_cleanup, apply_view=True)
1978
# GNU diff on Windows uses ANSI encoding for filenames
1979
path_encoding = osutils.get_diff_header_encoding()
1980
return show_diff_trees(old_tree, new_tree, sys.stdout,
1981
specific_files=specific_files,
1982
external_diff_options=diff_options,
1983
old_label=old_label, new_label=new_label,
1984
extra_trees=extra_trees,
1985
path_encoding=path_encoding,
1990
class cmd_deleted(Command):
1991
__doc__ = """List files deleted in the working tree.
1993
# TODO: Show files deleted since a previous revision, or
1994
# between two revisions.
1995
# TODO: Much more efficient way to do this: read in new
1996
# directories with readdir, rather than stating each one. Same
1997
# level of effort but possibly much less IO. (Or possibly not,
1998
# if the directories are very large...)
1999
_see_also = ['status', 'ls']
2000
takes_options = ['directory', 'show-ids']
2003
def run(self, show_ids=False, directory=u'.'):
2004
tree = WorkingTree.open_containing(directory)[0]
2005
self.add_cleanup(tree.lock_read().unlock)
2006
old = tree.basis_tree()
2007
self.add_cleanup(old.lock_read().unlock)
2008
for path, ie in old.inventory.iter_entries():
2009
if not tree.has_id(ie.file_id):
2010
self.outf.write(path)
2012
self.outf.write(' ')
2013
self.outf.write(ie.file_id)
2014
self.outf.write('\n')
2017
class cmd_modified(Command):
2018
__doc__ = """List files modified in working tree.
2022
_see_also = ['status', 'ls']
2023
takes_options = ['directory', 'null']
2026
def run(self, null=False, directory=u'.'):
2027
tree = WorkingTree.open_containing(directory)[0]
2028
td = tree.changes_from(tree.basis_tree())
2029
for path, id, kind, text_modified, meta_modified in td.modified:
2031
self.outf.write(path + '\0')
2033
self.outf.write(osutils.quotefn(path) + '\n')
2036
class cmd_added(Command):
2037
__doc__ = """List files added in working tree.
2041
_see_also = ['status', 'ls']
2042
takes_options = ['directory', 'null']
2045
def run(self, null=False, directory=u'.'):
2046
wt = WorkingTree.open_containing(directory)[0]
2047
self.add_cleanup(wt.lock_read().unlock)
2048
basis = wt.basis_tree()
2049
self.add_cleanup(basis.lock_read().unlock)
2050
basis_inv = basis.inventory
2053
if file_id in basis_inv:
2055
if inv.is_root(file_id) and len(basis_inv) == 0:
2057
path = inv.id2path(file_id)
2058
if not os.access(osutils.pathjoin(wt.basedir, path), os.F_OK):
2061
self.outf.write(path + '\0')
2063
self.outf.write(osutils.quotefn(path) + '\n')
2066
class cmd_root(Command):
2067
__doc__ = """Show the tree root directory.
2069
The root is the nearest enclosing directory with a .bzr control
2072
takes_args = ['filename?']
2074
def run(self, filename=None):
2075
"""Print the branch root."""
2076
tree = WorkingTree.open_containing(filename)[0]
2077
self.outf.write(tree.basedir + '\n')
2080
def _parse_limit(limitstring):
2082
return int(limitstring)
2084
msg = "The limit argument must be an integer."
2085
raise errors.BzrCommandError(msg)
2088
def _parse_levels(s):
2092
msg = "The levels argument must be an integer."
2093
raise errors.BzrCommandError(msg)
2096
class cmd_log(Command):
2097
__doc__ = """Show historical log for a branch or subset of a branch.
2099
log is bzr's default tool for exploring the history of a branch.
2100
The branch to use is taken from the first parameter. If no parameters
2101
are given, the branch containing the working directory is logged.
2102
Here are some simple examples::
2104
bzr log log the current branch
2105
bzr log foo.py log a file in its branch
2106
bzr log http://server/branch log a branch on a server
2108
The filtering, ordering and information shown for each revision can
2109
be controlled as explained below. By default, all revisions are
2110
shown sorted (topologically) so that newer revisions appear before
2111
older ones and descendants always appear before ancestors. If displayed,
2112
merged revisions are shown indented under the revision in which they
2117
The log format controls how information about each revision is
2118
displayed. The standard log formats are called ``long``, ``short``
2119
and ``line``. The default is long. See ``bzr help log-formats``
2120
for more details on log formats.
2122
The following options can be used to control what information is
2125
-l N display a maximum of N revisions
2126
-n N display N levels of revisions (0 for all, 1 for collapsed)
2127
-v display a status summary (delta) for each revision
2128
-p display a diff (patch) for each revision
2129
--show-ids display revision-ids (and file-ids), not just revnos
2131
Note that the default number of levels to display is a function of the
2132
log format. If the -n option is not used, the standard log formats show
2133
just the top level (mainline).
2135
Status summaries are shown using status flags like A, M, etc. To see
2136
the changes explained using words like ``added`` and ``modified``
2137
instead, use the -vv option.
2141
To display revisions from oldest to newest, use the --forward option.
2142
In most cases, using this option will have little impact on the total
2143
time taken to produce a log, though --forward does not incrementally
2144
display revisions like --reverse does when it can.
2146
:Revision filtering:
2148
The -r option can be used to specify what revision or range of revisions
2149
to filter against. The various forms are shown below::
2151
-rX display revision X
2152
-rX.. display revision X and later
2153
-r..Y display up to and including revision Y
2154
-rX..Y display from X to Y inclusive
2156
See ``bzr help revisionspec`` for details on how to specify X and Y.
2157
Some common examples are given below::
2159
-r-1 show just the tip
2160
-r-10.. show the last 10 mainline revisions
2161
-rsubmit:.. show what's new on this branch
2162
-rancestor:path.. show changes since the common ancestor of this
2163
branch and the one at location path
2164
-rdate:yesterday.. show changes since yesterday
2166
When logging a range of revisions using -rX..Y, log starts at
2167
revision Y and searches back in history through the primary
2168
("left-hand") parents until it finds X. When logging just the
2169
top level (using -n1), an error is reported if X is not found
2170
along the way. If multi-level logging is used (-n0), X may be
2171
a nested merge revision and the log will be truncated accordingly.
2175
If parameters are given and the first one is not a branch, the log
2176
will be filtered to show only those revisions that changed the
2177
nominated files or directories.
2179
Filenames are interpreted within their historical context. To log a
2180
deleted file, specify a revision range so that the file existed at
2181
the end or start of the range.
2183
Historical context is also important when interpreting pathnames of
2184
renamed files/directories. Consider the following example:
2186
* revision 1: add tutorial.txt
2187
* revision 2: modify tutorial.txt
2188
* revision 3: rename tutorial.txt to guide.txt; add tutorial.txt
2192
* ``bzr log guide.txt`` will log the file added in revision 1
2194
* ``bzr log tutorial.txt`` will log the new file added in revision 3
2196
* ``bzr log -r2 -p tutorial.txt`` will show the changes made to
2197
the original file in revision 2.
2199
* ``bzr log -r2 -p guide.txt`` will display an error message as there
2200
was no file called guide.txt in revision 2.
2202
Renames are always followed by log. By design, there is no need to
2203
explicitly ask for this (and no way to stop logging a file back
2204
until it was last renamed).
2208
The --message option can be used for finding revisions that match a
2209
regular expression in a commit message.
2213
GUI tools and IDEs are often better at exploring history than command
2214
line tools: you may prefer qlog or viz from qbzr or bzr-gtk, the
2215
bzr-explorer shell, or the Loggerhead web interface. See the Plugin
2216
Guide <http://doc.bazaar.canonical.com/plugins/en/> and
2217
<http://wiki.bazaar.canonical.com/IDEIntegration>.
2219
You may find it useful to add the aliases below to ``bazaar.conf``::
2223
top = log -l10 --line
2226
``bzr tip`` will then show the latest revision while ``bzr top``
2227
will show the last 10 mainline revisions. To see the details of a
2228
particular revision X, ``bzr show -rX``.
2230
If you are interested in looking deeper into a particular merge X,
2231
use ``bzr log -n0 -rX``.
2233
``bzr log -v`` on a branch with lots of history is currently
2234
very slow. A fix for this issue is currently under development.
2235
With or without that fix, it is recommended that a revision range
2236
be given when using the -v option.
2238
bzr has a generic full-text matching plugin, bzr-search, that can be
2239
used to find revisions matching user names, commit messages, etc.
2240
Among other features, this plugin can find all revisions containing
2241
a list of words but not others.
2243
When exploring non-mainline history on large projects with deep
2244
history, the performance of log can be greatly improved by installing
2245
the historycache plugin. This plugin buffers historical information
2246
trading disk space for faster speed.
2248
takes_args = ['file*']
2249
_see_also = ['log-formats', 'revisionspec']
2252
help='Show from oldest to newest.'),
2254
custom_help('verbose',
2255
help='Show files changed in each revision.'),
2259
type=bzrlib.option._parse_revision_str,
2261
help='Show just the specified revision.'
2262
' See also "help revisionspec".'),
2264
RegistryOption('authors',
2265
'What names to list as authors - first, all or committer.',
2267
lazy_registry=('bzrlib.log', 'author_list_registry'),
2271
help='Number of levels to display - 0 for all, 1 for flat.',
2273
type=_parse_levels),
2276
help='Show revisions whose message matches this '
2277
'regular expression.',
2281
help='Limit the output to the first N revisions.',
2286
help='Show changes made in each revision as a patch.'),
2287
Option('include-merges',
2288
help='Show merged revisions like --levels 0 does.'),
2289
Option('exclude-common-ancestry',
2290
help='Display only the revisions that are not part'
2291
' of both ancestries (require -rX..Y)'
2294
encoding_type = 'replace'
2297
def run(self, file_list=None, timezone='original',
2308
include_merges=False,
2310
exclude_common_ancestry=False,
2312
from bzrlib.log import (
2314
make_log_request_dict,
2315
_get_info_for_log_files,
2317
direction = (forward and 'forward') or 'reverse'
2318
if (exclude_common_ancestry
2319
and (revision is None or len(revision) != 2)):
2320
raise errors.BzrCommandError(
2321
'--exclude-common-ancestry requires -r with two revisions')
2326
raise errors.BzrCommandError(
2327
'--levels and --include-merges are mutually exclusive')
2329
if change is not None:
2331
raise errors.RangeInChangeOption()
2332
if revision is not None:
2333
raise errors.BzrCommandError(
2334
'--revision and --change are mutually exclusive')
2339
filter_by_dir = False
2341
# find the file ids to log and check for directory filtering
2342
b, file_info_list, rev1, rev2 = _get_info_for_log_files(
2343
revision, file_list, self.add_cleanup)
2344
for relpath, file_id, kind in file_info_list:
2346
raise errors.BzrCommandError(
2347
"Path unknown at end or start of revision range: %s" %
2349
# If the relpath is the top of the tree, we log everything
2354
file_ids.append(file_id)
2355
filter_by_dir = filter_by_dir or (
2356
kind in ['directory', 'tree-reference'])
2359
# FIXME ? log the current subdir only RBC 20060203
2360
if revision is not None \
2361
and len(revision) > 0 and revision[0].get_branch():
2362
location = revision[0].get_branch()
2365
dir, relpath = bzrdir.BzrDir.open_containing(location)
2366
b = dir.open_branch()
2367
self.add_cleanup(b.lock_read().unlock)
2368
rev1, rev2 = _get_revision_range(revision, b, self.name())
2370
# Decide on the type of delta & diff filtering to use
2371
# TODO: add an --all-files option to make this configurable & consistent
2379
diff_type = 'partial'
2383
# Build the log formatter
2384
if log_format is None:
2385
log_format = log.log_formatter_registry.get_default(b)
2386
# Make a non-encoding output to include the diffs - bug 328007
2387
unencoded_output = ui.ui_factory.make_output_stream(encoding_type='exact')
2388
lf = log_format(show_ids=show_ids, to_file=self.outf,
2389
to_exact_file=unencoded_output,
2390
show_timezone=timezone,
2391
delta_format=get_verbosity_level(),
2393
show_advice=levels is None,
2394
author_list_handler=authors)
2396
# Choose the algorithm for doing the logging. It's annoying
2397
# having multiple code paths like this but necessary until
2398
# the underlying repository format is faster at generating
2399
# deltas or can provide everything we need from the indices.
2400
# The default algorithm - match-using-deltas - works for
2401
# multiple files and directories and is faster for small
2402
# amounts of history (200 revisions say). However, it's too
2403
# slow for logging a single file in a repository with deep
2404
# history, i.e. > 10K revisions. In the spirit of "do no
2405
# evil when adding features", we continue to use the
2406
# original algorithm - per-file-graph - for the "single
2407
# file that isn't a directory without showing a delta" case.
2408
partial_history = revision and b.repository._format.supports_chks
2409
match_using_deltas = (len(file_ids) != 1 or filter_by_dir
2410
or delta_type or partial_history)
2412
# Build the LogRequest and execute it
2413
if len(file_ids) == 0:
2415
rqst = make_log_request_dict(
2416
direction=direction, specific_fileids=file_ids,
2417
start_revision=rev1, end_revision=rev2, limit=limit,
2418
message_search=message, delta_type=delta_type,
2419
diff_type=diff_type, _match_using_deltas=match_using_deltas,
2420
exclude_common_ancestry=exclude_common_ancestry,
2422
Logger(b, rqst).show(lf)
2425
def _get_revision_range(revisionspec_list, branch, command_name):
2426
"""Take the input of a revision option and turn it into a revision range.
2428
It returns RevisionInfo objects which can be used to obtain the rev_id's
2429
of the desired revisions. It does some user input validations.
2431
if revisionspec_list is None:
2434
elif len(revisionspec_list) == 1:
2435
rev1 = rev2 = revisionspec_list[0].in_history(branch)
2436
elif len(revisionspec_list) == 2:
2437
start_spec = revisionspec_list[0]
2438
end_spec = revisionspec_list[1]
2439
if end_spec.get_branch() != start_spec.get_branch():
2440
# b is taken from revision[0].get_branch(), and
2441
# show_log will use its revision_history. Having
2442
# different branches will lead to weird behaviors.
2443
raise errors.BzrCommandError(
2444
"bzr %s doesn't accept two revisions in different"
2445
" branches." % command_name)
2446
if start_spec.spec is None:
2447
# Avoid loading all the history.
2448
rev1 = RevisionInfo(branch, None, None)
2450
rev1 = start_spec.in_history(branch)
2451
# Avoid loading all of history when we know a missing
2452
# end of range means the last revision ...
2453
if end_spec.spec is None:
2454
last_revno, last_revision_id = branch.last_revision_info()
2455
rev2 = RevisionInfo(branch, last_revno, last_revision_id)
2457
rev2 = end_spec.in_history(branch)
2459
raise errors.BzrCommandError(
2460
'bzr %s --revision takes one or two values.' % command_name)
2464
def _revision_range_to_revid_range(revision_range):
2467
if revision_range[0] is not None:
2468
rev_id1 = revision_range[0].rev_id
2469
if revision_range[1] is not None:
2470
rev_id2 = revision_range[1].rev_id
2471
return rev_id1, rev_id2
2473
def get_log_format(long=False, short=False, line=False, default='long'):
2474
log_format = default
2478
log_format = 'short'
2484
class cmd_touching_revisions(Command):
2485
__doc__ = """Return revision-ids which affected a particular file.
2487
A more user-friendly interface is "bzr log FILE".
2491
takes_args = ["filename"]
2494
def run(self, filename):
2495
tree, relpath = WorkingTree.open_containing(filename)
2496
file_id = tree.path2id(relpath)
2498
self.add_cleanup(b.lock_read().unlock)
2499
touching_revs = log.find_touching_revisions(b, file_id)
2500
for revno, revision_id, what in touching_revs:
2501
self.outf.write("%6d %s\n" % (revno, what))
2504
class cmd_ls(Command):
2505
__doc__ = """List files in a tree.
2508
_see_also = ['status', 'cat']
2509
takes_args = ['path?']
2513
Option('recursive', short_name='R',
2514
help='Recurse into subdirectories.'),
2516
help='Print paths relative to the root of the branch.'),
2517
Option('unknown', short_name='u',
2518
help='Print unknown files.'),
2519
Option('versioned', help='Print versioned files.',
2521
Option('ignored', short_name='i',
2522
help='Print ignored files.'),
2523
Option('kind', short_name='k',
2524
help='List entries of a particular kind: file, directory, symlink.',
2531
def run(self, revision=None, verbose=False,
2532
recursive=False, from_root=False,
2533
unknown=False, versioned=False, ignored=False,
2534
null=False, kind=None, show_ids=False, path=None, directory=None):
2536
if kind and kind not in ('file', 'directory', 'symlink'):
2537
raise errors.BzrCommandError('invalid kind specified')
2539
if verbose and null:
2540
raise errors.BzrCommandError('Cannot set both --verbose and --null')
2541
all = not (unknown or versioned or ignored)
2543
selection = {'I':ignored, '?':unknown, 'V':versioned}
2549
raise errors.BzrCommandError('cannot specify both --from-root'
2552
tree, branch, relpath = \
2553
_open_directory_or_containing_tree_or_branch(fs_path, directory)
2555
# Calculate the prefix to use
2559
prefix = relpath + '/'
2560
elif fs_path != '.' and not fs_path.endswith('/'):
2561
prefix = fs_path + '/'
2563
if revision is not None or tree is None:
2564
tree = _get_one_revision_tree('ls', revision, branch=branch)
2567
if isinstance(tree, WorkingTree) and tree.supports_views():
2568
view_files = tree.views.lookup_view()
2571
view_str = views.view_display_str(view_files)
2572
note("Ignoring files outside view. View is %s" % view_str)
2574
self.add_cleanup(tree.lock_read().unlock)
2575
for fp, fc, fkind, fid, entry in tree.list_files(include_root=False,
2576
from_dir=relpath, recursive=recursive):
2577
# Apply additional masking
2578
if not all and not selection[fc]:
2580
if kind is not None and fkind != kind:
2585
fullpath = osutils.pathjoin(relpath, fp)
2588
views.check_path_in_view(tree, fullpath)
2589
except errors.FileOutsideView:
2594
fp = osutils.pathjoin(prefix, fp)
2595
kindch = entry.kind_character()
2596
outstring = fp + kindch
2597
ui.ui_factory.clear_term()
2599
outstring = '%-8s %s' % (fc, outstring)
2600
if show_ids and fid is not None:
2601
outstring = "%-50s %s" % (outstring, fid)
2602
self.outf.write(outstring + '\n')
2604
self.outf.write(fp + '\0')
2607
self.outf.write(fid)
2608
self.outf.write('\0')
2616
self.outf.write('%-50s %s\n' % (outstring, my_id))
2618
self.outf.write(outstring + '\n')
2621
class cmd_unknowns(Command):
2622
__doc__ = """List unknown files.
2627
takes_options = ['directory']
2630
def run(self, directory=u'.'):
2631
for f in WorkingTree.open_containing(directory)[0].unknowns():
2632
self.outf.write(osutils.quotefn(f) + '\n')
2635
class cmd_ignore(Command):
2636
__doc__ = """Ignore specified files or patterns.
2638
See ``bzr help patterns`` for details on the syntax of patterns.
2640
If a .bzrignore file does not exist, the ignore command
2641
will create one and add the specified files or patterns to the newly
2642
created file. The ignore command will also automatically add the
2643
.bzrignore file to be versioned. Creating a .bzrignore file without
2644
the use of the ignore command will require an explicit add command.
2646
To remove patterns from the ignore list, edit the .bzrignore file.
2647
After adding, editing or deleting that file either indirectly by
2648
using this command or directly by using an editor, be sure to commit
2651
Bazaar also supports a global ignore file ~/.bazaar/ignore. On Windows
2652
the global ignore file can be found in the application data directory as
2653
C:\\Documents and Settings\\<user>\\Application Data\\Bazaar\\2.0\\ignore.
2654
Global ignores are not touched by this command. The global ignore file
2655
can be edited directly using an editor.
2657
Patterns prefixed with '!' are exceptions to ignore patterns and take
2658
precedence over regular ignores. Such exceptions are used to specify
2659
files that should be versioned which would otherwise be ignored.
2661
Patterns prefixed with '!!' act as regular ignore patterns, but have
2662
precedence over the '!' exception patterns.
2664
Note: ignore patterns containing shell wildcards must be quoted from
2668
Ignore the top level Makefile::
2670
bzr ignore ./Makefile
2672
Ignore .class files in all directories...::
2674
bzr ignore "*.class"
2676
...but do not ignore "special.class"::
2678
bzr ignore "!special.class"
2680
Ignore .o files under the lib directory::
2682
bzr ignore "lib/**/*.o"
2684
Ignore .o files under the lib directory::
2686
bzr ignore "RE:lib/.*\.o"
2688
Ignore everything but the "debian" toplevel directory::
2690
bzr ignore "RE:(?!debian/).*"
2692
Ignore everything except the "local" toplevel directory,
2693
but always ignore "*~" autosave files, even under local/::
2696
bzr ignore "!./local"
2700
_see_also = ['status', 'ignored', 'patterns']
2701
takes_args = ['name_pattern*']
2702
takes_options = ['directory',
2703
Option('default-rules',
2704
help='Display the default ignore rules that bzr uses.')
2707
def run(self, name_pattern_list=None, default_rules=None,
2709
from bzrlib import ignores
2710
if default_rules is not None:
2711
# dump the default rules and exit
2712
for pattern in ignores.USER_DEFAULTS:
2713
self.outf.write("%s\n" % pattern)
2715
if not name_pattern_list:
2716
raise errors.BzrCommandError("ignore requires at least one "
2717
"NAME_PATTERN or --default-rules.")
2718
name_pattern_list = [globbing.normalize_pattern(p)
2719
for p in name_pattern_list]
2721
for p in name_pattern_list:
2722
if not globbing.Globster.is_pattern_valid(p):
2723
bad_patterns += ('\n %s' % p)
2725
msg = ('Invalid ignore pattern(s) found. %s' % bad_patterns)
2726
ui.ui_factory.show_error(msg)
2727
raise errors.InvalidPattern('')
2728
for name_pattern in name_pattern_list:
2729
if (name_pattern[0] == '/' or
2730
(len(name_pattern) > 1 and name_pattern[1] == ':')):
2731
raise errors.BzrCommandError(
2732
"NAME_PATTERN should not be an absolute path")
2733
tree, relpath = WorkingTree.open_containing(directory)
2734
ignores.tree_ignores_add_patterns(tree, name_pattern_list)
2735
ignored = globbing.Globster(name_pattern_list)
2737
self.add_cleanup(tree.lock_read().unlock)
2738
for entry in tree.list_files():
2742
if ignored.match(filename):
2743
matches.append(filename)
2744
if len(matches) > 0:
2745
self.outf.write("Warning: the following files are version controlled and"
2746
" match your ignore pattern:\n%s"
2747
"\nThese files will continue to be version controlled"
2748
" unless you 'bzr remove' them.\n" % ("\n".join(matches),))
2751
class cmd_ignored(Command):
2752
__doc__ = """List ignored files and the patterns that matched them.
2754
List all the ignored files and the ignore pattern that caused the file to
2757
Alternatively, to list just the files::
2762
encoding_type = 'replace'
2763
_see_also = ['ignore', 'ls']
2764
takes_options = ['directory']
2767
def run(self, directory=u'.'):
2768
tree = WorkingTree.open_containing(directory)[0]
2769
self.add_cleanup(tree.lock_read().unlock)
2770
for path, file_class, kind, file_id, entry in tree.list_files():
2771
if file_class != 'I':
2773
## XXX: Slightly inefficient since this was already calculated
2774
pat = tree.is_ignored(path)
2775
self.outf.write('%-50s %s\n' % (path, pat))
2778
class cmd_lookup_revision(Command):
2779
__doc__ = """Lookup the revision-id from a revision-number
2782
bzr lookup-revision 33
2785
takes_args = ['revno']
2786
takes_options = ['directory']
2789
def run(self, revno, directory=u'.'):
2793
raise errors.BzrCommandError("not a valid revision-number: %r"
2795
revid = WorkingTree.open_containing(directory)[0].branch.get_rev_id(revno)
2796
self.outf.write("%s\n" % revid)
2799
class cmd_export(Command):
2800
__doc__ = """Export current or past revision to a destination directory or archive.
2802
If no revision is specified this exports the last committed revision.
2804
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
2805
given, try to find the format with the extension. If no extension
2806
is found exports to a directory (equivalent to --format=dir).
2808
If root is supplied, it will be used as the root directory inside
2809
container formats (tar, zip, etc). If it is not supplied it will default
2810
to the exported filename. The root option has no effect for 'dir' format.
2812
If branch is omitted then the branch containing the current working
2813
directory will be used.
2815
Note: Export of tree with non-ASCII filenames to zip is not supported.
2817
================= =========================
2818
Supported formats Autodetected by extension
2819
================= =========================
2822
tbz2 .tar.bz2, .tbz2
2825
================= =========================
2827
takes_args = ['dest', 'branch_or_subdir?']
2828
takes_options = ['directory',
2830
help="Type of file to export to.",
2833
Option('filters', help='Apply content filters to export the '
2834
'convenient form.'),
2837
help="Name of the root directory inside the exported file."),
2838
Option('per-file-timestamps',
2839
help='Set modification time of files to that of the last '
2840
'revision in which it was changed.'),
2842
def run(self, dest, branch_or_subdir=None, revision=None, format=None,
2843
root=None, filters=False, per_file_timestamps=False, directory=u'.'):
2844
from bzrlib.export import export
2846
if branch_or_subdir is None:
2847
tree = WorkingTree.open_containing(directory)[0]
2851
b, subdir = Branch.open_containing(branch_or_subdir)
2854
rev_tree = _get_one_revision_tree('export', revision, branch=b, tree=tree)
2856
export(rev_tree, dest, format, root, subdir, filtered=filters,
2857
per_file_timestamps=per_file_timestamps)
2858
except errors.NoSuchExportFormat, e:
2859
raise errors.BzrCommandError('Unsupported export format: %s' % e.format)
2862
class cmd_cat(Command):
2863
__doc__ = """Write the contents of a file as of a given revision to standard output.
2865
If no revision is nominated, the last revision is used.
2867
Note: Take care to redirect standard output when using this command on a
2872
takes_options = ['directory',
2873
Option('name-from-revision', help='The path name in the old tree.'),
2874
Option('filters', help='Apply content filters to display the '
2875
'convenience form.'),
2878
takes_args = ['filename']
2879
encoding_type = 'exact'
2882
def run(self, filename, revision=None, name_from_revision=False,
2883
filters=False, directory=None):
2884
if revision is not None and len(revision) != 1:
2885
raise errors.BzrCommandError("bzr cat --revision takes exactly"
2886
" one revision specifier")
2887
tree, branch, relpath = \
2888
_open_directory_or_containing_tree_or_branch(filename, directory)
2889
self.add_cleanup(branch.lock_read().unlock)
2890
return self._run(tree, branch, relpath, filename, revision,
2891
name_from_revision, filters)
2893
def _run(self, tree, b, relpath, filename, revision, name_from_revision,
2896
tree = b.basis_tree()
2897
rev_tree = _get_one_revision_tree('cat', revision, branch=b)
2898
self.add_cleanup(rev_tree.lock_read().unlock)
2900
old_file_id = rev_tree.path2id(relpath)
2902
if name_from_revision:
2903
# Try in revision if requested
2904
if old_file_id is None:
2905
raise errors.BzrCommandError(
2906
"%r is not present in revision %s" % (
2907
filename, rev_tree.get_revision_id()))
2909
content = rev_tree.get_file_text(old_file_id)
2911
cur_file_id = tree.path2id(relpath)
2913
if cur_file_id is not None:
2914
# Then try with the actual file id
2916
content = rev_tree.get_file_text(cur_file_id)
2918
except errors.NoSuchId:
2919
# The actual file id didn't exist at that time
2921
if not found and old_file_id is not None:
2922
# Finally try with the old file id
2923
content = rev_tree.get_file_text(old_file_id)
2926
# Can't be found anywhere
2927
raise errors.BzrCommandError(
2928
"%r is not present in revision %s" % (
2929
filename, rev_tree.get_revision_id()))
2931
from bzrlib.filters import (
2932
ContentFilterContext,
2933
filtered_output_bytes,
2935
filters = rev_tree._content_filter_stack(relpath)
2936
chunks = content.splitlines(True)
2937
content = filtered_output_bytes(chunks, filters,
2938
ContentFilterContext(relpath, rev_tree))
2940
self.outf.writelines(content)
2943
self.outf.write(content)
2946
class cmd_local_time_offset(Command):
2947
__doc__ = """Show the offset in seconds from GMT to local time."""
2951
self.outf.write("%s\n" % osutils.local_time_offset())
2955
class cmd_commit(Command):
2956
__doc__ = """Commit changes into a new revision.
2958
An explanatory message needs to be given for each commit. This is
2959
often done by using the --message option (getting the message from the
2960
command line) or by using the --file option (getting the message from
2961
a file). If neither of these options is given, an editor is opened for
2962
the user to enter the message. To see the changed files in the
2963
boilerplate text loaded into the editor, use the --show-diff option.
2965
By default, the entire tree is committed and the person doing the
2966
commit is assumed to be the author. These defaults can be overridden
2971
If selected files are specified, only changes to those files are
2972
committed. If a directory is specified then the directory and
2973
everything within it is committed.
2975
When excludes are given, they take precedence over selected files.
2976
For example, to commit only changes within foo, but not changes
2979
bzr commit foo -x foo/bar
2981
A selective commit after a merge is not yet supported.
2985
If the author of the change is not the same person as the committer,
2986
you can specify the author's name using the --author option. The
2987
name should be in the same format as a committer-id, e.g.
2988
"John Doe <jdoe@example.com>". If there is more than one author of
2989
the change you can specify the option multiple times, once for each
2994
A common mistake is to forget to add a new file or directory before
2995
running the commit command. The --strict option checks for unknown
2996
files and aborts the commit if any are found. More advanced pre-commit
2997
checks can be implemented by defining hooks. See ``bzr help hooks``
3002
If you accidentially commit the wrong changes or make a spelling
3003
mistake in the commit message say, you can use the uncommit command
3004
to undo it. See ``bzr help uncommit`` for details.
3006
Hooks can also be configured to run after a commit. This allows you
3007
to trigger updates to external systems like bug trackers. The --fixes
3008
option can be used to record the association between a revision and
3009
one or more bugs. See ``bzr help bugs`` for details.
3011
A selective commit may fail in some cases where the committed
3012
tree would be invalid. Consider::
3017
bzr commit foo -m "committing foo"
3018
bzr mv foo/bar foo/baz
3021
bzr commit foo/bar -m "committing bar but not baz"
3023
In the example above, the last commit will fail by design. This gives
3024
the user the opportunity to decide whether they want to commit the
3025
rename at the same time, separately first, or not at all. (As a general
3026
rule, when in doubt, Bazaar has a policy of Doing the Safe Thing.)
3028
# TODO: Run hooks on tree to-be-committed, and after commit.
3030
# TODO: Strict commit that fails if there are deleted files.
3031
# (what does "deleted files" mean ??)
3033
# TODO: Give better message for -s, --summary, used by tla people
3035
# XXX: verbose currently does nothing
3037
_see_also = ['add', 'bugs', 'hooks', 'uncommit']
3038
takes_args = ['selected*']
3040
ListOption('exclude', type=str, short_name='x',
3041
help="Do not consider changes made to a given path."),
3042
Option('message', type=unicode,
3044
help="Description of the new revision."),
3047
help='Commit even if nothing has changed.'),
3048
Option('file', type=str,
3051
help='Take commit message from this file.'),
3053
help="Refuse to commit if there are unknown "
3054
"files in the working tree."),
3055
Option('commit-time', type=str,
3056
help="Manually set a commit time using commit date "
3057
"format, e.g. '2009-10-10 08:00:00 +0100'."),
3058
ListOption('fixes', type=str,
3059
help="Mark a bug as being fixed by this revision "
3060
"(see \"bzr help bugs\")."),
3061
ListOption('author', type=unicode,
3062
help="Set the author's name, if it's different "
3063
"from the committer."),
3065
help="Perform a local commit in a bound "
3066
"branch. Local commits are not pushed to "
3067
"the master branch until a normal commit "
3070
Option('show-diff', short_name='p',
3071
help='When no message is supplied, show the diff along'
3072
' with the status summary in the message editor.'),
3074
aliases = ['ci', 'checkin']
3076
def _iter_bug_fix_urls(self, fixes, branch):
3077
# Configure the properties for bug fixing attributes.
3078
for fixed_bug in fixes:
3079
tokens = fixed_bug.split(':')
3080
if len(tokens) != 2:
3081
raise errors.BzrCommandError(
3082
"Invalid bug %s. Must be in the form of 'tracker:id'. "
3083
"See \"bzr help bugs\" for more information on this "
3084
"feature.\nCommit refused." % fixed_bug)
3085
tag, bug_id = tokens
3087
yield bugtracker.get_bug_url(tag, branch, bug_id)
3088
except errors.UnknownBugTrackerAbbreviation:
3089
raise errors.BzrCommandError(
3090
'Unrecognized bug %s. Commit refused.' % fixed_bug)
3091
except errors.MalformedBugIdentifier, e:
3092
raise errors.BzrCommandError(
3093
"%s\nCommit refused." % (str(e),))
3095
def run(self, message=None, file=None, verbose=False, selected_list=None,
3096
unchanged=False, strict=False, local=False, fixes=None,
3097
author=None, show_diff=False, exclude=None, commit_time=None):
3098
from bzrlib.errors import (
3103
from bzrlib.msgeditor import (
3104
edit_commit_message_encoded,
3105
generate_commit_message_template,
3106
make_commit_message_template_encoded
3109
commit_stamp = offset = None
3110
if commit_time is not None:
3112
commit_stamp, offset = timestamp.parse_patch_date(commit_time)
3113
except ValueError, e:
3114
raise errors.BzrCommandError(
3115
"Could not parse --commit-time: " + str(e))
3117
# TODO: Need a blackbox test for invoking the external editor; may be
3118
# slightly problematic to run this cross-platform.
3120
# TODO: do more checks that the commit will succeed before
3121
# spending the user's valuable time typing a commit message.
3125
tree, selected_list = WorkingTree.open_containing_paths(selected_list)
3126
if selected_list == ['']:
3127
# workaround - commit of root of tree should be exactly the same
3128
# as just default commit in that tree, and succeed even though
3129
# selected-file merge commit is not done yet
3134
bug_property = bugtracker.encode_fixes_bug_urls(
3135
self._iter_bug_fix_urls(fixes, tree.branch))
3137
properties['bugs'] = bug_property
3139
if local and not tree.branch.get_bound_location():
3140
raise errors.LocalRequiresBoundBranch()
3142
if message is not None:
3144
file_exists = osutils.lexists(message)
3145
except UnicodeError:
3146
# The commit message contains unicode characters that can't be
3147
# represented in the filesystem encoding, so that can't be a
3152
'The commit message is a file name: "%(f)s".\n'
3153
'(use --file "%(f)s" to take commit message from that file)'
3155
ui.ui_factory.show_warning(warning_msg)
3157
message = message.replace('\r\n', '\n')
3158
message = message.replace('\r', '\n')
3160
raise errors.BzrCommandError(
3161
"please specify either --message or --file")
3163
def get_message(commit_obj):
3164
"""Callback to get commit message"""
3168
my_message = f.read().decode(osutils.get_user_encoding())
3171
elif message is not None:
3172
my_message = message
3174
# No message supplied: make one up.
3175
# text is the status of the tree
3176
text = make_commit_message_template_encoded(tree,
3177
selected_list, diff=show_diff,
3178
output_encoding=osutils.get_user_encoding())
3179
# start_message is the template generated from hooks
3180
# XXX: Warning - looks like hooks return unicode,
3181
# make_commit_message_template_encoded returns user encoding.
3182
# We probably want to be using edit_commit_message instead to
3184
start_message = generate_commit_message_template(commit_obj)
3185
my_message = edit_commit_message_encoded(text,
3186
start_message=start_message)
3187
if my_message is None:
3188
raise errors.BzrCommandError("please specify a commit"
3189
" message with either --message or --file")
3190
if my_message == "":
3191
raise errors.BzrCommandError("empty commit message specified")
3194
# The API permits a commit with a filter of [] to mean 'select nothing'
3195
# but the command line should not do that.
3196
if not selected_list:
3197
selected_list = None
3199
tree.commit(message_callback=get_message,
3200
specific_files=selected_list,
3201
allow_pointless=unchanged, strict=strict, local=local,
3202
reporter=None, verbose=verbose, revprops=properties,
3203
authors=author, timestamp=commit_stamp,
3205
exclude=tree.safe_relpath_files(exclude))
3206
except PointlessCommit:
3207
raise errors.BzrCommandError("No changes to commit."
3208
" Use --unchanged to commit anyhow.")
3209
except ConflictsInTree:
3210
raise errors.BzrCommandError('Conflicts detected in working '
3211
'tree. Use "bzr conflicts" to list, "bzr resolve FILE" to'
3213
except StrictCommitFailed:
3214
raise errors.BzrCommandError("Commit refused because there are"
3215
" unknown files in the working tree.")
3216
except errors.BoundBranchOutOfDate, e:
3217
e.extra_help = ("\n"
3218
'To commit to master branch, run update and then commit.\n'
3219
'You can also pass --local to commit to continue working '
3224
class cmd_check(Command):
3225
__doc__ = """Validate working tree structure, branch consistency and repository history.
3227
This command checks various invariants about branch and repository storage
3228
to detect data corruption or bzr bugs.
3230
The working tree and branch checks will only give output if a problem is
3231
detected. The output fields of the repository check are:
3234
This is just the number of revisions checked. It doesn't
3238
This is just the number of versionedfiles checked. It
3239
doesn't indicate a problem.
3241
unreferenced ancestors
3242
Texts that are ancestors of other texts, but
3243
are not properly referenced by the revision ancestry. This is a
3244
subtle problem that Bazaar can work around.
3247
This is the total number of unique file contents
3248
seen in the checked revisions. It does not indicate a problem.
3251
This is the total number of repeated texts seen
3252
in the checked revisions. Texts can be repeated when their file
3253
entries are modified, but the file contents are not. It does not
3256
If no restrictions are specified, all Bazaar data that is found at the given
3257
location will be checked.
3261
Check the tree and branch at 'foo'::
3263
bzr check --tree --branch foo
3265
Check only the repository at 'bar'::
3267
bzr check --repo bar
3269
Check everything at 'baz'::
3274
_see_also = ['reconcile']
3275
takes_args = ['path?']
3276
takes_options = ['verbose',
3277
Option('branch', help="Check the branch related to the"
3278
" current directory."),
3279
Option('repo', help="Check the repository related to the"
3280
" current directory."),
3281
Option('tree', help="Check the working tree related to"
3282
" the current directory.")]
3284
def run(self, path=None, verbose=False, branch=False, repo=False,
3286
from bzrlib.check import check_dwim
3289
if not branch and not repo and not tree:
3290
branch = repo = tree = True
3291
check_dwim(path, verbose, do_branch=branch, do_repo=repo, do_tree=tree)
3294
class cmd_upgrade(Command):
3295
__doc__ = """Upgrade branch storage to current format.
3297
The check command or bzr developers may sometimes advise you to run
3298
this command. When the default format has changed you may also be warned
3299
during other operations to upgrade.
3302
_see_also = ['check']
3303
takes_args = ['url?']
3305
RegistryOption('format',
3306
help='Upgrade to a specific format. See "bzr help'
3307
' formats" for details.',
3308
lazy_registry=('bzrlib.bzrdir', 'format_registry'),
3309
converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
3310
value_switches=True, title='Branch format'),
3313
def run(self, url='.', format=None):
3314
from bzrlib.upgrade import upgrade
3315
upgrade(url, format)
3318
class cmd_whoami(Command):
3319
__doc__ = """Show or set bzr user id.
3322
Show the email of the current user::
3326
Set the current user::
3328
bzr whoami "Frank Chu <fchu@example.com>"
3330
takes_options = [ 'directory',
3332
help='Display email address only.'),
3334
help='Set identity for the current branch instead of '
3337
takes_args = ['name?']
3338
encoding_type = 'replace'
3341
def run(self, email=False, branch=False, name=None, directory=None):
3343
if directory is None:
3344
# use branch if we're inside one; otherwise global config
3346
c = Branch.open_containing(u'.')[0].get_config()
3347
except errors.NotBranchError:
3348
c = _mod_config.GlobalConfig()
3350
c = Branch.open(directory).get_config()
3352
self.outf.write(c.user_email() + '\n')
3354
self.outf.write(c.username() + '\n')
3357
# display a warning if an email address isn't included in the given name.
3359
_mod_config.extract_email_address(name)
3360
except errors.NoEmailInUsername, e:
3361
warning('"%s" does not seem to contain an email address. '
3362
'This is allowed, but not recommended.', name)
3364
# use global config unless --branch given
3366
if directory is None:
3367
c = Branch.open_containing(u'.')[0].get_config()
3369
c = Branch.open(directory).get_config()
3371
c = _mod_config.GlobalConfig()
3372
c.set_user_option('email', name)
3375
class cmd_nick(Command):
3376
__doc__ = """Print or set the branch nickname.
3378
If unset, the tree root directory name is used as the nickname.
3379
To print the current nickname, execute with no argument.
3381
Bound branches use the nickname of its master branch unless it is set
3385
_see_also = ['info']
3386
takes_args = ['nickname?']
3387
takes_options = ['directory']
3388
def run(self, nickname=None, directory=u'.'):
3389
branch = Branch.open_containing(directory)[0]
3390
if nickname is None:
3391
self.printme(branch)
3393
branch.nick = nickname
3396
def printme(self, branch):
3397
self.outf.write('%s\n' % branch.nick)
3400
class cmd_alias(Command):
3401
__doc__ = """Set/unset and display aliases.
3404
Show the current aliases::
3408
Show the alias specified for 'll'::
3412
Set an alias for 'll'::
3414
bzr alias ll="log --line -r-10..-1"
3416
To remove an alias for 'll'::
3418
bzr alias --remove ll
3421
takes_args = ['name?']
3423
Option('remove', help='Remove the alias.'),
3426
def run(self, name=None, remove=False):
3428
self.remove_alias(name)
3430
self.print_aliases()
3432
equal_pos = name.find('=')
3434
self.print_alias(name)
3436
self.set_alias(name[:equal_pos], name[equal_pos+1:])
3438
def remove_alias(self, alias_name):
3439
if alias_name is None:
3440
raise errors.BzrCommandError(
3441
'bzr alias --remove expects an alias to remove.')
3442
# If alias is not found, print something like:
3443
# unalias: foo: not found
3444
c = _mod_config.GlobalConfig()
3445
c.unset_alias(alias_name)
3448
def print_aliases(self):
3449
"""Print out the defined aliases in a similar format to bash."""
3450
aliases = _mod_config.GlobalConfig().get_aliases()
3451
for key, value in sorted(aliases.iteritems()):
3452
self.outf.write('bzr alias %s="%s"\n' % (key, value))
3455
def print_alias(self, alias_name):
3456
from bzrlib.commands import get_alias
3457
alias = get_alias(alias_name)
3459
self.outf.write("bzr alias: %s: not found\n" % alias_name)
3462
'bzr alias %s="%s"\n' % (alias_name, ' '.join(alias)))
3464
def set_alias(self, alias_name, alias_command):
3465
"""Save the alias in the global config."""
3466
c = _mod_config.GlobalConfig()
3467
c.set_alias(alias_name, alias_command)
3470
class cmd_selftest(Command):
3471
__doc__ = """Run internal test suite.
3473
If arguments are given, they are regular expressions that say which tests
3474
should run. Tests matching any expression are run, and other tests are
3477
Alternatively if --first is given, matching tests are run first and then
3478
all other tests are run. This is useful if you have been working in a
3479
particular area, but want to make sure nothing else was broken.
3481
If --exclude is given, tests that match that regular expression are
3482
excluded, regardless of whether they match --first or not.
3484
To help catch accidential dependencies between tests, the --randomize
3485
option is useful. In most cases, the argument used is the word 'now'.
3486
Note that the seed used for the random number generator is displayed
3487
when this option is used. The seed can be explicitly passed as the
3488
argument to this option if required. This enables reproduction of the
3489
actual ordering used if and when an order sensitive problem is encountered.
3491
If --list-only is given, the tests that would be run are listed. This is
3492
useful when combined with --first, --exclude and/or --randomize to
3493
understand their impact. The test harness reports "Listed nn tests in ..."
3494
instead of "Ran nn tests in ..." when list mode is enabled.
3496
If the global option '--no-plugins' is given, plugins are not loaded
3497
before running the selftests. This has two effects: features provided or
3498
modified by plugins will not be tested, and tests provided by plugins will
3501
Tests that need working space on disk use a common temporary directory,
3502
typically inside $TMPDIR or /tmp.
3504
If you set BZR_TEST_PDB=1 when running selftest, failing tests will drop
3505
into a pdb postmortem session.
3507
The --coverage=DIRNAME global option produces a report with covered code
3511
Run only tests relating to 'ignore'::
3515
Disable plugins and list tests as they're run::
3517
bzr --no-plugins selftest -v
3519
# NB: this is used from the class without creating an instance, which is
3520
# why it does not have a self parameter.
3521
def get_transport_type(typestring):
3522
"""Parse and return a transport specifier."""
3523
if typestring == "sftp":
3524
from bzrlib.tests import stub_sftp
3525
return stub_sftp.SFTPAbsoluteServer
3526
if typestring == "memory":
3527
from bzrlib.tests import test_server
3528
return memory.MemoryServer
3529
if typestring == "fakenfs":
3530
from bzrlib.tests import test_server
3531
return test_server.FakeNFSServer
3532
msg = "No known transport type %s. Supported types are: sftp\n" %\
3534
raise errors.BzrCommandError(msg)
3537
takes_args = ['testspecs*']
3538
takes_options = ['verbose',
3540
help='Stop when one test fails.',
3544
help='Use a different transport by default '
3545
'throughout the test suite.',
3546
type=get_transport_type),
3548
help='Run the benchmarks rather than selftests.',
3550
Option('lsprof-timed',
3551
help='Generate lsprof output for benchmarked'
3552
' sections of code.'),
3553
Option('lsprof-tests',
3554
help='Generate lsprof output for each test.'),
3556
help='Run all tests, but run specified tests first.',
3560
help='List the tests instead of running them.'),
3561
RegistryOption('parallel',
3562
help="Run the test suite in parallel.",
3563
lazy_registry=('bzrlib.tests', 'parallel_registry'),
3564
value_switches=False,
3566
Option('randomize', type=str, argname="SEED",
3567
help='Randomize the order of tests using the given'
3568
' seed or "now" for the current time.'),
3569
Option('exclude', type=str, argname="PATTERN",
3571
help='Exclude tests that match this regular'
3574
help='Output test progress via subunit.'),
3575
Option('strict', help='Fail on missing dependencies or '
3577
Option('load-list', type=str, argname='TESTLISTFILE',
3578
help='Load a test id list from a text file.'),
3579
ListOption('debugflag', type=str, short_name='E',
3580
help='Turn on a selftest debug flag.'),
3581
ListOption('starting-with', type=str, argname='TESTID',
3582
param_name='starting_with', short_name='s',
3584
'Load only the tests starting with TESTID.'),
3586
encoding_type = 'replace'
3589
Command.__init__(self)
3590
self.additional_selftest_args = {}
3592
def run(self, testspecs_list=None, verbose=False, one=False,
3593
transport=None, benchmark=None,
3595
first=False, list_only=False,
3596
randomize=None, exclude=None, strict=False,
3597
load_list=None, debugflag=None, starting_with=None, subunit=False,
3598
parallel=None, lsprof_tests=False):
3599
from bzrlib import tests
3601
if testspecs_list is not None:
3602
pattern = '|'.join(testspecs_list)
3607
from bzrlib.tests import SubUnitBzrRunner
3609
raise errors.BzrCommandError("subunit not available. subunit "
3610
"needs to be installed to use --subunit.")
3611
self.additional_selftest_args['runner_class'] = SubUnitBzrRunner
3612
# On Windows, disable automatic conversion of '\n' to '\r\n' in
3613
# stdout, which would corrupt the subunit stream.
3614
# FIXME: This has been fixed in subunit trunk (>0.0.5) so the
3615
# following code can be deleted when it's sufficiently deployed
3616
# -- vila/mgz 20100514
3617
if (sys.platform == "win32"
3618
and getattr(sys.stdout, 'fileno', None) is not None):
3620
msvcrt.setmode(sys.stdout.fileno(), os.O_BINARY)
3622
self.additional_selftest_args.setdefault(
3623
'suite_decorators', []).append(parallel)
3625
raise errors.BzrCommandError(
3626
"--benchmark is no longer supported from bzr 2.2; "
3627
"use bzr-usertest instead")
3628
test_suite_factory = None
3629
selftest_kwargs = {"verbose": verbose,
3631
"stop_on_failure": one,
3632
"transport": transport,
3633
"test_suite_factory": test_suite_factory,
3634
"lsprof_timed": lsprof_timed,
3635
"lsprof_tests": lsprof_tests,
3636
"matching_tests_first": first,
3637
"list_only": list_only,
3638
"random_seed": randomize,
3639
"exclude_pattern": exclude,
3641
"load_list": load_list,
3642
"debug_flags": debugflag,
3643
"starting_with": starting_with
3645
selftest_kwargs.update(self.additional_selftest_args)
3647
# Make deprecation warnings visible, unless -Werror is set
3648
cleanup = symbol_versioning.activate_deprecation_warnings(
3651
result = tests.selftest(**selftest_kwargs)
3654
return int(not result)
3657
class cmd_version(Command):
3658
__doc__ = """Show version of bzr."""
3660
encoding_type = 'replace'
3662
Option("short", help="Print just the version number."),
3666
def run(self, short=False):
3667
from bzrlib.version import show_version
3669
self.outf.write(bzrlib.version_string + '\n')
3671
show_version(to_file=self.outf)
3674
class cmd_rocks(Command):
3675
__doc__ = """Statement of optimism."""
3681
self.outf.write("It sure does!\n")
3684
class cmd_find_merge_base(Command):
3685
__doc__ = """Find and print a base revision for merging two branches."""
3686
# TODO: Options to specify revisions on either side, as if
3687
# merging only part of the history.
3688
takes_args = ['branch', 'other']
3692
def run(self, branch, other):
3693
from bzrlib.revision import ensure_null
3695
branch1 = Branch.open_containing(branch)[0]
3696
branch2 = Branch.open_containing(other)[0]
3697
self.add_cleanup(branch1.lock_read().unlock)
3698
self.add_cleanup(branch2.lock_read().unlock)
3699
last1 = ensure_null(branch1.last_revision())
3700
last2 = ensure_null(branch2.last_revision())
3702
graph = branch1.repository.get_graph(branch2.repository)
3703
base_rev_id = graph.find_unique_lca(last1, last2)
3705
self.outf.write('merge base is revision %s\n' % base_rev_id)
3708
class cmd_merge(Command):
3709
__doc__ = """Perform a three-way merge.
3711
The source of the merge can be specified either in the form of a branch,
3712
or in the form of a path to a file containing a merge directive generated
3713
with bzr send. If neither is specified, the default is the upstream branch
3714
or the branch most recently merged using --remember.
3716
When merging a branch, by default the tip will be merged. To pick a different
3717
revision, pass --revision. If you specify two values, the first will be used as
3718
BASE and the second one as OTHER. Merging individual revisions, or a subset of
3719
available revisions, like this is commonly referred to as "cherrypicking".
3721
Revision numbers are always relative to the branch being merged.
3723
By default, bzr will try to merge in all new work from the other
3724
branch, automatically determining an appropriate base. If this
3725
fails, you may need to give an explicit base.
3727
Merge will do its best to combine the changes in two branches, but there
3728
are some kinds of problems only a human can fix. When it encounters those,
3729
it will mark a conflict. A conflict means that you need to fix something,
3730
before you should commit.
3732
Use bzr resolve when you have fixed a problem. See also bzr conflicts.
3734
If there is no default branch set, the first merge will set it. After
3735
that, you can omit the branch to use the default. To change the
3736
default, use --remember. The value will only be saved if the remote
3737
location can be accessed.
3739
The results of the merge are placed into the destination working
3740
directory, where they can be reviewed (with bzr diff), tested, and then
3741
committed to record the result of the merge.
3743
merge refuses to run if there are any uncommitted changes, unless
3744
--force is given. The --force option can also be used to create a
3745
merge revision which has more than two parents.
3747
If one would like to merge changes from the working tree of the other
3748
branch without merging any committed revisions, the --uncommitted option
3751
To select only some changes to merge, use "merge -i", which will prompt
3752
you to apply each diff hunk and file change, similar to "shelve".
3755
To merge the latest revision from bzr.dev::
3757
bzr merge ../bzr.dev
3759
To merge changes up to and including revision 82 from bzr.dev::
3761
bzr merge -r 82 ../bzr.dev
3763
To merge the changes introduced by 82, without previous changes::
3765
bzr merge -r 81..82 ../bzr.dev
3767
To apply a merge directive contained in /tmp/merge::
3769
bzr merge /tmp/merge
3771
To create a merge revision with three parents from two branches
3772
feature1a and feature1b:
3774
bzr merge ../feature1a
3775
bzr merge ../feature1b --force
3776
bzr commit -m 'revision with three parents'
3779
encoding_type = 'exact'
3780
_see_also = ['update', 'remerge', 'status-flags', 'send']
3781
takes_args = ['location?']
3786
help='Merge even if the destination tree has uncommitted changes.'),
3790
Option('show-base', help="Show base revision text in "
3792
Option('uncommitted', help='Apply uncommitted changes'
3793
' from a working copy, instead of branch changes.'),
3794
Option('pull', help='If the destination is already'
3795
' completely merged into the source, pull from the'
3796
' source rather than merging. When this happens,'
3797
' you do not need to commit the result.'),
3798
custom_help('directory',
3799
help='Branch to merge into, '
3800
'rather than the one containing the working directory.'),
3801
Option('preview', help='Instead of merging, show a diff of the'
3803
Option('interactive', help='Select changes interactively.',
3807
def run(self, location=None, revision=None, force=False,
3808
merge_type=None, show_base=False, reprocess=None, remember=False,
3809
uncommitted=False, pull=False,
3814
if merge_type is None:
3815
merge_type = _mod_merge.Merge3Merger
3817
if directory is None: directory = u'.'
3818
possible_transports = []
3820
allow_pending = True
3821
verified = 'inapplicable'
3822
tree = WorkingTree.open_containing(directory)[0]
3825
basis_tree = tree.revision_tree(tree.last_revision())
3826
except errors.NoSuchRevision:
3827
basis_tree = tree.basis_tree()
3829
# die as quickly as possible if there are uncommitted changes
3831
if tree.has_changes():
3832
raise errors.UncommittedChanges(tree)
3834
view_info = _get_view_info_for_change_reporter(tree)
3835
change_reporter = delta._ChangeReporter(
3836
unversioned_filter=tree.is_ignored, view_info=view_info)
3837
pb = ui.ui_factory.nested_progress_bar()
3838
self.add_cleanup(pb.finished)
3839
self.add_cleanup(tree.lock_write().unlock)
3840
if location is not None:
3842
mergeable = bundle.read_mergeable_from_url(location,
3843
possible_transports=possible_transports)
3844
except errors.NotABundle:
3848
raise errors.BzrCommandError('Cannot use --uncommitted'
3849
' with bundles or merge directives.')
3851
if revision is not None:
3852
raise errors.BzrCommandError(
3853
'Cannot use -r with merge directives or bundles')
3854
merger, verified = _mod_merge.Merger.from_mergeable(tree,
3857
if merger is None and uncommitted:
3858
if revision is not None and len(revision) > 0:
3859
raise errors.BzrCommandError('Cannot use --uncommitted and'
3860
' --revision at the same time.')
3861
merger = self.get_merger_from_uncommitted(tree, location, None)
3862
allow_pending = False
3865
merger, allow_pending = self._get_merger_from_branch(tree,
3866
location, revision, remember, possible_transports, None)
3868
merger.merge_type = merge_type
3869
merger.reprocess = reprocess
3870
merger.show_base = show_base
3871
self.sanity_check_merger(merger)
3872
if (merger.base_rev_id == merger.other_rev_id and
3873
merger.other_rev_id is not None):
3874
note('Nothing to do.')
3877
if merger.interesting_files is not None:
3878
raise errors.BzrCommandError('Cannot pull individual files')
3879
if (merger.base_rev_id == tree.last_revision()):
3880
result = tree.pull(merger.other_branch, False,
3881
merger.other_rev_id)
3882
result.report(self.outf)
3884
if merger.this_basis is None:
3885
raise errors.BzrCommandError(
3886
"This branch has no commits."
3887
" (perhaps you would prefer 'bzr pull')")
3889
return self._do_preview(merger)
3891
return self._do_interactive(merger)
3893
return self._do_merge(merger, change_reporter, allow_pending,
3896
def _get_preview(self, merger):
3897
tree_merger = merger.make_merger()
3898
tt = tree_merger.make_preview_transform()
3899
self.add_cleanup(tt.finalize)
3900
result_tree = tt.get_preview_tree()
3903
def _do_preview(self, merger):
3904
from bzrlib.diff import show_diff_trees
3905
result_tree = self._get_preview(merger)
3906
path_encoding = osutils.get_diff_header_encoding()
3907
show_diff_trees(merger.this_tree, result_tree, self.outf,
3908
old_label='', new_label='',
3909
path_encoding=path_encoding)
3911
def _do_merge(self, merger, change_reporter, allow_pending, verified):
3912
merger.change_reporter = change_reporter
3913
conflict_count = merger.do_merge()
3915
merger.set_pending()
3916
if verified == 'failed':
3917
warning('Preview patch does not match changes')
3918
if conflict_count != 0:
3923
def _do_interactive(self, merger):
3924
"""Perform an interactive merge.
3926
This works by generating a preview tree of the merge, then using
3927
Shelver to selectively remove the differences between the working tree
3928
and the preview tree.
3930
from bzrlib import shelf_ui
3931
result_tree = self._get_preview(merger)
3932
writer = bzrlib.option.diff_writer_registry.get()
3933
shelver = shelf_ui.Shelver(merger.this_tree, result_tree, destroy=True,
3934
reporter=shelf_ui.ApplyReporter(),
3935
diff_writer=writer(sys.stdout))
3941
def sanity_check_merger(self, merger):
3942
if (merger.show_base and
3943
not merger.merge_type is _mod_merge.Merge3Merger):
3944
raise errors.BzrCommandError("Show-base is not supported for this"
3945
" merge type. %s" % merger.merge_type)
3946
if merger.reprocess is None:
3947
if merger.show_base:
3948
merger.reprocess = False
3950
# Use reprocess if the merger supports it
3951
merger.reprocess = merger.merge_type.supports_reprocess
3952
if merger.reprocess and not merger.merge_type.supports_reprocess:
3953
raise errors.BzrCommandError("Conflict reduction is not supported"
3954
" for merge type %s." %
3956
if merger.reprocess and merger.show_base:
3957
raise errors.BzrCommandError("Cannot do conflict reduction and"
3960
def _get_merger_from_branch(self, tree, location, revision, remember,
3961
possible_transports, pb):
3962
"""Produce a merger from a location, assuming it refers to a branch."""
3963
from bzrlib.tag import _merge_tags_if_possible
3964
# find the branch locations
3965
other_loc, user_location = self._select_branch_location(tree, location,
3967
if revision is not None and len(revision) == 2:
3968
base_loc, _unused = self._select_branch_location(tree,
3969
location, revision, 0)
3971
base_loc = other_loc
3973
other_branch, other_path = Branch.open_containing(other_loc,
3974
possible_transports)
3975
if base_loc == other_loc:
3976
base_branch = other_branch
3978
base_branch, base_path = Branch.open_containing(base_loc,
3979
possible_transports)
3980
# Find the revision ids
3981
other_revision_id = None
3982
base_revision_id = None
3983
if revision is not None:
3984
if len(revision) >= 1:
3985
other_revision_id = revision[-1].as_revision_id(other_branch)
3986
if len(revision) == 2:
3987
base_revision_id = revision[0].as_revision_id(base_branch)
3988
if other_revision_id is None:
3989
other_revision_id = _mod_revision.ensure_null(
3990
other_branch.last_revision())
3991
# Remember where we merge from
3992
if ((remember or tree.branch.get_submit_branch() is None) and
3993
user_location is not None):
3994
tree.branch.set_submit_branch(other_branch.base)
3995
_merge_tags_if_possible(other_branch, tree.branch)
3996
merger = _mod_merge.Merger.from_revision_ids(pb, tree,
3997
other_revision_id, base_revision_id, other_branch, base_branch)
3998
if other_path != '':
3999
allow_pending = False
4000
merger.interesting_files = [other_path]
4002
allow_pending = True
4003
return merger, allow_pending
4005
def get_merger_from_uncommitted(self, tree, location, pb):
4006
"""Get a merger for uncommitted changes.
4008
:param tree: The tree the merger should apply to.
4009
:param location: The location containing uncommitted changes.
4010
:param pb: The progress bar to use for showing progress.
4012
location = self._select_branch_location(tree, location)[0]
4013
other_tree, other_path = WorkingTree.open_containing(location)
4014
merger = _mod_merge.Merger.from_uncommitted(tree, other_tree, pb)
4015
if other_path != '':
4016
merger.interesting_files = [other_path]
4019
def _select_branch_location(self, tree, user_location, revision=None,
4021
"""Select a branch location, according to possible inputs.
4023
If provided, branches from ``revision`` are preferred. (Both
4024
``revision`` and ``index`` must be supplied.)
4026
Otherwise, the ``location`` parameter is used. If it is None, then the
4027
``submit`` or ``parent`` location is used, and a note is printed.
4029
:param tree: The working tree to select a branch for merging into
4030
:param location: The location entered by the user
4031
:param revision: The revision parameter to the command
4032
:param index: The index to use for the revision parameter. Negative
4033
indices are permitted.
4034
:return: (selected_location, user_location). The default location
4035
will be the user-entered location.
4037
if (revision is not None and index is not None
4038
and revision[index] is not None):
4039
branch = revision[index].get_branch()
4040
if branch is not None:
4041
return branch, branch
4042
if user_location is None:
4043
location = self._get_remembered(tree, 'Merging from')
4045
location = user_location
4046
return location, user_location
4048
def _get_remembered(self, tree, verb_string):
4049
"""Use tree.branch's parent if none was supplied.
4051
Report if the remembered location was used.
4053
stored_location = tree.branch.get_submit_branch()
4054
stored_location_type = "submit"
4055
if stored_location is None:
4056
stored_location = tree.branch.get_parent()
4057
stored_location_type = "parent"
4058
mutter("%s", stored_location)
4059
if stored_location is None:
4060
raise errors.BzrCommandError("No location specified or remembered")
4061
display_url = urlutils.unescape_for_display(stored_location, 'utf-8')
4062
note(u"%s remembered %s location %s", verb_string,
4063
stored_location_type, display_url)
4064
return stored_location
4067
class cmd_remerge(Command):
4068
__doc__ = """Redo a merge.
4070
Use this if you want to try a different merge technique while resolving
4071
conflicts. Some merge techniques are better than others, and remerge
4072
lets you try different ones on different files.
4074
The options for remerge have the same meaning and defaults as the ones for
4075
merge. The difference is that remerge can (only) be run when there is a
4076
pending merge, and it lets you specify particular files.
4079
Re-do the merge of all conflicted files, and show the base text in
4080
conflict regions, in addition to the usual THIS and OTHER texts::
4082
bzr remerge --show-base
4084
Re-do the merge of "foobar", using the weave merge algorithm, with
4085
additional processing to reduce the size of conflict regions::
4087
bzr remerge --merge-type weave --reprocess foobar
4089
takes_args = ['file*']
4094
help="Show base revision text in conflicts."),
4097
def run(self, file_list=None, merge_type=None, show_base=False,
4099
from bzrlib.conflicts import restore
4100
if merge_type is None:
4101
merge_type = _mod_merge.Merge3Merger
4102
tree, file_list = WorkingTree.open_containing_paths(file_list)
4103
self.add_cleanup(tree.lock_write().unlock)
4104
parents = tree.get_parent_ids()
4105
if len(parents) != 2:
4106
raise errors.BzrCommandError("Sorry, remerge only works after normal"
4107
" merges. Not cherrypicking or"
4109
repository = tree.branch.repository
4110
interesting_ids = None
4112
conflicts = tree.conflicts()
4113
if file_list is not None:
4114
interesting_ids = set()
4115
for filename in file_list:
4116
file_id = tree.path2id(filename)
4118
raise errors.NotVersionedError(filename)
4119
interesting_ids.add(file_id)
4120
if tree.kind(file_id) != "directory":
4123
for name, ie in tree.inventory.iter_entries(file_id):
4124
interesting_ids.add(ie.file_id)
4125
new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
4127
# Remerge only supports resolving contents conflicts
4128
allowed_conflicts = ('text conflict', 'contents conflict')
4129
restore_files = [c.path for c in conflicts
4130
if c.typestring in allowed_conflicts]
4131
_mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
4132
tree.set_conflicts(ConflictList(new_conflicts))
4133
if file_list is not None:
4134
restore_files = file_list
4135
for filename in restore_files:
4137
restore(tree.abspath(filename))
4138
except errors.NotConflicted:
4140
# Disable pending merges, because the file texts we are remerging
4141
# have not had those merges performed. If we use the wrong parents
4142
# list, we imply that the working tree text has seen and rejected
4143
# all the changes from the other tree, when in fact those changes
4144
# have not yet been seen.
4145
tree.set_parent_ids(parents[:1])
4147
merger = _mod_merge.Merger.from_revision_ids(None, tree, parents[1])
4148
merger.interesting_ids = interesting_ids
4149
merger.merge_type = merge_type
4150
merger.show_base = show_base
4151
merger.reprocess = reprocess
4152
conflicts = merger.do_merge()
4154
tree.set_parent_ids(parents)
4161
class cmd_revert(Command):
4162
__doc__ = """Revert files to a previous revision.
4164
Giving a list of files will revert only those files. Otherwise, all files
4165
will be reverted. If the revision is not specified with '--revision', the
4166
last committed revision is used.
4168
To remove only some changes, without reverting to a prior version, use
4169
merge instead. For example, "merge . --revision -2..-3" will remove the
4170
changes introduced by -2, without affecting the changes introduced by -1.
4171
Or to remove certain changes on a hunk-by-hunk basis, see the Shelf plugin.
4173
By default, any files that have been manually changed will be backed up
4174
first. (Files changed only by merge are not backed up.) Backup files have
4175
'.~#~' appended to their name, where # is a number.
4177
When you provide files, you can use their current pathname or the pathname
4178
from the target revision. So you can use revert to "undelete" a file by
4179
name. If you name a directory, all the contents of that directory will be
4182
If you have newly added files since the target revision, they will be
4183
removed. If the files to be removed have been changed, backups will be
4184
created as above. Directories containing unknown files will not be
4187
The working tree contains a list of revisions that have been merged but
4188
not yet committed. These revisions will be included as additional parents
4189
of the next commit. Normally, using revert clears that list as well as
4190
reverting the files. If any files are specified, revert leaves the list
4191
of uncommitted merges alone and reverts only the files. Use ``bzr revert
4192
.`` in the tree root to revert all files but keep the recorded merges,
4193
and ``bzr revert --forget-merges`` to clear the pending merge list without
4194
reverting any files.
4196
Using "bzr revert --forget-merges", it is possible to apply all of the
4197
changes from a branch in a single revision. To do this, perform the merge
4198
as desired. Then doing revert with the "--forget-merges" option will keep
4199
the content of the tree as it was, but it will clear the list of pending
4200
merges. The next commit will then contain all of the changes that are
4201
present in the other branch, but without any other parent revisions.
4202
Because this technique forgets where these changes originated, it may
4203
cause additional conflicts on later merges involving the same source and
4207
_see_also = ['cat', 'export']
4210
Option('no-backup', "Do not save backups of reverted files."),
4211
Option('forget-merges',
4212
'Remove pending merge marker, without changing any files.'),
4214
takes_args = ['file*']
4216
def run(self, revision=None, no_backup=False, file_list=None,
4217
forget_merges=None):
4218
tree, file_list = WorkingTree.open_containing_paths(file_list)
4219
self.add_cleanup(tree.lock_tree_write().unlock)
4221
tree.set_parent_ids(tree.get_parent_ids()[:1])
4223
self._revert_tree_to_revision(tree, revision, file_list, no_backup)
4226
def _revert_tree_to_revision(tree, revision, file_list, no_backup):
4227
rev_tree = _get_one_revision_tree('revert', revision, tree=tree)
4228
tree.revert(file_list, rev_tree, not no_backup, None,
4229
report_changes=True)
4232
class cmd_assert_fail(Command):
4233
__doc__ = """Test reporting of assertion failures"""
4234
# intended just for use in testing
4239
raise AssertionError("always fails")
4242
class cmd_help(Command):
4243
__doc__ = """Show help on a command or other topic.
4246
_see_also = ['topics']
4248
Option('long', 'Show help on all commands.'),
4250
takes_args = ['topic?']
4251
aliases = ['?', '--help', '-?', '-h']
4254
def run(self, topic=None, long=False):
4256
if topic is None and long:
4258
bzrlib.help.help(topic)
4261
class cmd_shell_complete(Command):
4262
__doc__ = """Show appropriate completions for context.
4264
For a list of all available commands, say 'bzr shell-complete'.
4266
takes_args = ['context?']
4271
def run(self, context=None):
4272
import shellcomplete
4273
shellcomplete.shellcomplete(context)
4276
class cmd_missing(Command):
4277
__doc__ = """Show unmerged/unpulled revisions between two branches.
4279
OTHER_BRANCH may be local or remote.
4281
To filter on a range of revisions, you can use the command -r begin..end
4282
-r revision requests a specific revision, -r ..end or -r begin.. are
4286
1 - some missing revisions
4287
0 - no missing revisions
4291
Determine the missing revisions between this and the branch at the
4292
remembered pull location::
4296
Determine the missing revisions between this and another branch::
4298
bzr missing http://server/branch
4300
Determine the missing revisions up to a specific revision on the other
4303
bzr missing -r ..-10
4305
Determine the missing revisions up to a specific revision on this
4308
bzr missing --my-revision ..-10
4311
_see_also = ['merge', 'pull']
4312
takes_args = ['other_branch?']
4315
Option('reverse', 'Reverse the order of revisions.'),
4317
'Display changes in the local branch only.'),
4318
Option('this' , 'Same as --mine-only.'),
4319
Option('theirs-only',
4320
'Display changes in the remote branch only.'),
4321
Option('other', 'Same as --theirs-only.'),
4325
custom_help('revision',
4326
help='Filter on other branch revisions (inclusive). '
4327
'See "help revisionspec" for details.'),
4328
Option('my-revision',
4329
type=_parse_revision_str,
4330
help='Filter on local branch revisions (inclusive). '
4331
'See "help revisionspec" for details.'),
4332
Option('include-merges',
4333
'Show all revisions in addition to the mainline ones.'),
4335
encoding_type = 'replace'
4338
def run(self, other_branch=None, reverse=False, mine_only=False,
4340
log_format=None, long=False, short=False, line=False,
4341
show_ids=False, verbose=False, this=False, other=False,
4342
include_merges=False, revision=None, my_revision=None,
4344
from bzrlib.missing import find_unmerged, iter_log_revisions
4353
# TODO: We should probably check that we don't have mine-only and
4354
# theirs-only set, but it gets complicated because we also have
4355
# this and other which could be used.
4362
local_branch = Branch.open_containing(directory)[0]
4363
self.add_cleanup(local_branch.lock_read().unlock)
4365
parent = local_branch.get_parent()
4366
if other_branch is None:
4367
other_branch = parent
4368
if other_branch is None:
4369
raise errors.BzrCommandError("No peer location known"
4371
display_url = urlutils.unescape_for_display(parent,
4373
message("Using saved parent location: "
4374
+ display_url + "\n")
4376
remote_branch = Branch.open(other_branch)
4377
if remote_branch.base == local_branch.base:
4378
remote_branch = local_branch
4380
self.add_cleanup(remote_branch.lock_read().unlock)
4382
local_revid_range = _revision_range_to_revid_range(
4383
_get_revision_range(my_revision, local_branch,
4386
remote_revid_range = _revision_range_to_revid_range(
4387
_get_revision_range(revision,
4388
remote_branch, self.name()))
4390
local_extra, remote_extra = find_unmerged(
4391
local_branch, remote_branch, restrict,
4392
backward=not reverse,
4393
include_merges=include_merges,
4394
local_revid_range=local_revid_range,
4395
remote_revid_range=remote_revid_range)
4397
if log_format is None:
4398
registry = log.log_formatter_registry
4399
log_format = registry.get_default(local_branch)
4400
lf = log_format(to_file=self.outf,
4402
show_timezone='original')
4405
if local_extra and not theirs_only:
4406
message("You have %d extra revision(s):\n" %
4408
for revision in iter_log_revisions(local_extra,
4409
local_branch.repository,
4411
lf.log_revision(revision)
4412
printed_local = True
4415
printed_local = False
4417
if remote_extra and not mine_only:
4418
if printed_local is True:
4420
message("You are missing %d revision(s):\n" %
4422
for revision in iter_log_revisions(remote_extra,
4423
remote_branch.repository,
4425
lf.log_revision(revision)
4428
if mine_only and not local_extra:
4429
# We checked local, and found nothing extra
4430
message('This branch is up to date.\n')
4431
elif theirs_only and not remote_extra:
4432
# We checked remote, and found nothing extra
4433
message('Other branch is up to date.\n')
4434
elif not (mine_only or theirs_only or local_extra or
4436
# We checked both branches, and neither one had extra
4438
message("Branches are up to date.\n")
4440
if not status_code and parent is None and other_branch is not None:
4441
self.add_cleanup(local_branch.lock_write().unlock)
4442
# handle race conditions - a parent might be set while we run.
4443
if local_branch.get_parent() is None:
4444
local_branch.set_parent(remote_branch.base)
4448
class cmd_pack(Command):
4449
__doc__ = """Compress the data within a repository.
4451
This operation compresses the data within a bazaar repository. As
4452
bazaar supports automatic packing of repository, this operation is
4453
normally not required to be done manually.
4455
During the pack operation, bazaar takes a backup of existing repository
4456
data, i.e. pack files. This backup is eventually removed by bazaar
4457
automatically when it is safe to do so. To save disk space by removing
4458
the backed up pack files, the --clean-obsolete-packs option may be
4461
Warning: If you use --clean-obsolete-packs and your machine crashes
4462
during or immediately after repacking, you may be left with a state
4463
where the deletion has been written to disk but the new packs have not
4464
been. In this case the repository may be unusable.
4467
_see_also = ['repositories']
4468
takes_args = ['branch_or_repo?']
4470
Option('clean-obsolete-packs', 'Delete obsolete packs to save disk space.'),
4473
def run(self, branch_or_repo='.', clean_obsolete_packs=False):
4474
dir = bzrdir.BzrDir.open_containing(branch_or_repo)[0]
4476
branch = dir.open_branch()
4477
repository = branch.repository
4478
except errors.NotBranchError:
4479
repository = dir.open_repository()
4480
repository.pack(clean_obsolete_packs=clean_obsolete_packs)
4483
class cmd_plugins(Command):
4484
__doc__ = """List the installed plugins.
4486
This command displays the list of installed plugins including
4487
version of plugin and a short description of each.
4489
--verbose shows the path where each plugin is located.
4491
A plugin is an external component for Bazaar that extends the
4492
revision control system, by adding or replacing code in Bazaar.
4493
Plugins can do a variety of things, including overriding commands,
4494
adding new commands, providing additional network transports and
4495
customizing log output.
4497
See the Bazaar Plugin Guide <http://doc.bazaar.canonical.com/plugins/en/>
4498
for further information on plugins including where to find them and how to
4499
install them. Instructions are also provided there on how to write new
4500
plugins using the Python programming language.
4502
takes_options = ['verbose']
4505
def run(self, verbose=False):
4506
import bzrlib.plugin
4507
from inspect import getdoc
4509
for name, plugin in bzrlib.plugin.plugins().items():
4510
version = plugin.__version__
4511
if version == 'unknown':
4513
name_ver = '%s %s' % (name, version)
4514
d = getdoc(plugin.module)
4516
doc = d.split('\n')[0]
4518
doc = '(no description)'
4519
result.append((name_ver, doc, plugin.path()))
4520
for name_ver, doc, path in sorted(result):
4521
self.outf.write("%s\n" % name_ver)
4522
self.outf.write(" %s\n" % doc)
4524
self.outf.write(" %s\n" % path)
4525
self.outf.write("\n")
4528
class cmd_testament(Command):
4529
__doc__ = """Show testament (signing-form) of a revision."""
4532
Option('long', help='Produce long-format testament.'),
4534
help='Produce a strict-format testament.')]
4535
takes_args = ['branch?']
4537
def run(self, branch=u'.', revision=None, long=False, strict=False):
4538
from bzrlib.testament import Testament, StrictTestament
4540
testament_class = StrictTestament
4542
testament_class = Testament
4544
b = Branch.open_containing(branch)[0]
4546
b = Branch.open(branch)
4547
self.add_cleanup(b.lock_read().unlock)
4548
if revision is None:
4549
rev_id = b.last_revision()
4551
rev_id = revision[0].as_revision_id(b)
4552
t = testament_class.from_revision(b.repository, rev_id)
4554
sys.stdout.writelines(t.as_text_lines())
4556
sys.stdout.write(t.as_short_text())
4559
class cmd_annotate(Command):
4560
__doc__ = """Show the origin of each line in a file.
4562
This prints out the given file with an annotation on the left side
4563
indicating which revision, author and date introduced the change.
4565
If the origin is the same for a run of consecutive lines, it is
4566
shown only at the top, unless the --all option is given.
4568
# TODO: annotate directories; showing when each file was last changed
4569
# TODO: if the working copy is modified, show annotations on that
4570
# with new uncommitted lines marked
4571
aliases = ['ann', 'blame', 'praise']
4572
takes_args = ['filename']
4573
takes_options = [Option('all', help='Show annotations on all lines.'),
4574
Option('long', help='Show commit date in annotations.'),
4579
encoding_type = 'exact'
4582
def run(self, filename, all=False, long=False, revision=None,
4583
show_ids=False, directory=None):
4584
from bzrlib.annotate import annotate_file, annotate_file_tree
4585
wt, branch, relpath = \
4586
_open_directory_or_containing_tree_or_branch(filename, directory)
4588
self.add_cleanup(wt.lock_read().unlock)
4590
self.add_cleanup(branch.lock_read().unlock)
4591
tree = _get_one_revision_tree('annotate', revision, branch=branch)
4592
self.add_cleanup(tree.lock_read().unlock)
4594
file_id = wt.path2id(relpath)
4596
file_id = tree.path2id(relpath)
4598
raise errors.NotVersionedError(filename)
4599
file_version = tree.inventory[file_id].revision
4600
if wt is not None and revision is None:
4601
# If there is a tree and we're not annotating historical
4602
# versions, annotate the working tree's content.
4603
annotate_file_tree(wt, file_id, self.outf, long, all,
4606
annotate_file(branch, file_version, file_id, long, all, self.outf,
4610
class cmd_re_sign(Command):
4611
__doc__ = """Create a digital signature for an existing revision."""
4612
# TODO be able to replace existing ones.
4614
hidden = True # is this right ?
4615
takes_args = ['revision_id*']
4616
takes_options = ['directory', 'revision']
4618
def run(self, revision_id_list=None, revision=None, directory=u'.'):
4619
if revision_id_list is not None and revision is not None:
4620
raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
4621
if revision_id_list is None and revision is None:
4622
raise errors.BzrCommandError('You must supply either --revision or a revision_id')
4623
b = WorkingTree.open_containing(directory)[0].branch
4624
self.add_cleanup(b.lock_write().unlock)
4625
return self._run(b, revision_id_list, revision)
4627
def _run(self, b, revision_id_list, revision):
4628
import bzrlib.gpg as gpg
4629
gpg_strategy = gpg.GPGStrategy(b.get_config())
4630
if revision_id_list is not None:
4631
b.repository.start_write_group()
4633
for revision_id in revision_id_list:
4634
b.repository.sign_revision(revision_id, gpg_strategy)
4636
b.repository.abort_write_group()
4639
b.repository.commit_write_group()
4640
elif revision is not None:
4641
if len(revision) == 1:
4642
revno, rev_id = revision[0].in_history(b)
4643
b.repository.start_write_group()
4645
b.repository.sign_revision(rev_id, gpg_strategy)
4647
b.repository.abort_write_group()
4650
b.repository.commit_write_group()
4651
elif len(revision) == 2:
4652
# are they both on rh- if so we can walk between them
4653
# might be nice to have a range helper for arbitrary
4654
# revision paths. hmm.
4655
from_revno, from_revid = revision[0].in_history(b)
4656
to_revno, to_revid = revision[1].in_history(b)
4657
if to_revid is None:
4658
to_revno = b.revno()
4659
if from_revno is None or to_revno is None:
4660
raise errors.BzrCommandError('Cannot sign a range of non-revision-history revisions')
4661
b.repository.start_write_group()
4663
for revno in range(from_revno, to_revno + 1):
4664
b.repository.sign_revision(b.get_rev_id(revno),
4667
b.repository.abort_write_group()
4670
b.repository.commit_write_group()
4672
raise errors.BzrCommandError('Please supply either one revision, or a range.')
4675
class cmd_bind(Command):
4676
__doc__ = """Convert the current branch into a checkout of the supplied branch.
4677
If no branch is supplied, rebind to the last bound location.
4679
Once converted into a checkout, commits must succeed on the master branch
4680
before they will be applied to the local branch.
4682
Bound branches use the nickname of its master branch unless it is set
4683
locally, in which case binding will update the local nickname to be
4687
_see_also = ['checkouts', 'unbind']
4688
takes_args = ['location?']
4689
takes_options = ['directory']
4691
def run(self, location=None, directory=u'.'):
4692
b, relpath = Branch.open_containing(directory)
4693
if location is None:
4695
location = b.get_old_bound_location()
4696
except errors.UpgradeRequired:
4697
raise errors.BzrCommandError('No location supplied. '
4698
'This format does not remember old locations.')
4700
if location is None:
4701
if b.get_bound_location() is not None:
4702
raise errors.BzrCommandError('Branch is already bound')
4704
raise errors.BzrCommandError('No location supplied '
4705
'and no previous location known')
4706
b_other = Branch.open(location)
4709
except errors.DivergedBranches:
4710
raise errors.BzrCommandError('These branches have diverged.'
4711
' Try merging, and then bind again.')
4712
if b.get_config().has_explicit_nickname():
4713
b.nick = b_other.nick
4716
class cmd_unbind(Command):
4717
__doc__ = """Convert the current checkout into a regular branch.
4719
After unbinding, the local branch is considered independent and subsequent
4720
commits will be local only.
4723
_see_also = ['checkouts', 'bind']
4725
takes_options = ['directory']
4727
def run(self, directory=u'.'):
4728
b, relpath = Branch.open_containing(directory)
4730
raise errors.BzrCommandError('Local branch is not bound')
4733
class cmd_uncommit(Command):
4734
__doc__ = """Remove the last committed revision.
4736
--verbose will print out what is being removed.
4737
--dry-run will go through all the motions, but not actually
4740
If --revision is specified, uncommit revisions to leave the branch at the
4741
specified revision. For example, "bzr uncommit -r 15" will leave the
4742
branch at revision 15.
4744
Uncommit leaves the working tree ready for a new commit. The only change
4745
it may make is to restore any pending merges that were present before
4749
# TODO: jam 20060108 Add an option to allow uncommit to remove
4750
# unreferenced information in 'branch-as-repository' branches.
4751
# TODO: jam 20060108 Add the ability for uncommit to remove unreferenced
4752
# information in shared branches as well.
4753
_see_also = ['commit']
4754
takes_options = ['verbose', 'revision',
4755
Option('dry-run', help='Don\'t actually make changes.'),
4756
Option('force', help='Say yes to all questions.'),
4758
help="Only remove the commits from the local branch"
4759
" when in a checkout."
4762
takes_args = ['location?']
4764
encoding_type = 'replace'
4766
def run(self, location=None,
4767
dry_run=False, verbose=False,
4768
revision=None, force=False, local=False):
4769
if location is None:
4771
control, relpath = bzrdir.BzrDir.open_containing(location)
4773
tree = control.open_workingtree()
4775
except (errors.NoWorkingTree, errors.NotLocalUrl):
4777
b = control.open_branch()
4779
if tree is not None:
4780
self.add_cleanup(tree.lock_write().unlock)
4782
self.add_cleanup(b.lock_write().unlock)
4783
return self._run(b, tree, dry_run, verbose, revision, force, local=local)
4785
def _run(self, b, tree, dry_run, verbose, revision, force, local=False):
4786
from bzrlib.log import log_formatter, show_log
4787
from bzrlib.uncommit import uncommit
4789
last_revno, last_rev_id = b.last_revision_info()
4792
if revision is None:
4794
rev_id = last_rev_id
4796
# 'bzr uncommit -r 10' actually means uncommit
4797
# so that the final tree is at revno 10.
4798
# but bzrlib.uncommit.uncommit() actually uncommits
4799
# the revisions that are supplied.
4800
# So we need to offset it by one
4801
revno = revision[0].in_history(b).revno + 1
4802
if revno <= last_revno:
4803
rev_id = b.get_rev_id(revno)
4805
if rev_id is None or _mod_revision.is_null(rev_id):
4806
self.outf.write('No revisions to uncommit.\n')
4809
lf = log_formatter('short',
4811
show_timezone='original')
4816
direction='forward',
4817
start_revision=revno,
4818
end_revision=last_revno)
4821
self.outf.write('Dry-run, pretending to remove'
4822
' the above revisions.\n')
4824
self.outf.write('The above revision(s) will be removed.\n')
4827
if not ui.ui_factory.confirm_action(
4828
'Uncommit these revisions',
4829
'bzrlib.builtins.uncommit',
4831
self.outf.write('Canceled\n')
4834
mutter('Uncommitting from {%s} to {%s}',
4835
last_rev_id, rev_id)
4836
uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
4837
revno=revno, local=local)
4838
self.outf.write('You can restore the old tip by running:\n'
4839
' bzr pull . -r revid:%s\n' % last_rev_id)
4842
class cmd_break_lock(Command):
4843
__doc__ = """Break a dead lock.
4845
This command breaks a lock on a repository, branch, working directory or
4848
CAUTION: Locks should only be broken when you are sure that the process
4849
holding the lock has been stopped.
4851
You can get information on what locks are open via the 'bzr info
4852
[location]' command.
4856
bzr break-lock bzr+ssh://example.com/bzr/foo
4857
bzr break-lock --conf ~/.bazaar
4860
takes_args = ['location?']
4863
help='LOCATION is the directory where the config lock is.'),
4865
help='Do not ask for confirmation before breaking the lock.'),
4868
def run(self, location=None, config=False, force=False):
4869
if location is None:
4872
ui.ui_factory = ui.ConfirmationUserInterfacePolicy(ui.ui_factory,
4874
{'bzrlib.lockdir.break': True})
4876
conf = _mod_config.LockableConfig(file_name=location)
4879
control, relpath = bzrdir.BzrDir.open_containing(location)
4881
control.break_lock()
4882
except NotImplementedError:
4886
class cmd_wait_until_signalled(Command):
4887
__doc__ = """Test helper for test_start_and_stop_bzr_subprocess_send_signal.
4889
This just prints a line to signal when it is ready, then blocks on stdin.
4895
sys.stdout.write("running\n")
4897
sys.stdin.readline()
4900
class cmd_serve(Command):
4901
__doc__ = """Run the bzr server."""
4903
aliases = ['server']
4907
help='Serve on stdin/out for use from inetd or sshd.'),
4908
RegistryOption('protocol',
4909
help="Protocol to serve.",
4910
lazy_registry=('bzrlib.transport', 'transport_server_registry'),
4911
value_switches=True),
4913
help='Listen for connections on nominated port of the form '
4914
'[hostname:]portnumber. Passing 0 as the port number will '
4915
'result in a dynamically allocated port. The default port '
4916
'depends on the protocol.',
4918
custom_help('directory',
4919
help='Serve contents of this directory.'),
4920
Option('allow-writes',
4921
help='By default the server is a readonly server. Supplying '
4922
'--allow-writes enables write access to the contents of '
4923
'the served directory and below. Note that ``bzr serve`` '
4924
'does not perform authentication, so unless some form of '
4925
'external authentication is arranged supplying this '
4926
'option leads to global uncontrolled write access to your '
4931
def get_host_and_port(self, port):
4932
"""Return the host and port to run the smart server on.
4934
If 'port' is None, None will be returned for the host and port.
4936
If 'port' has a colon in it, the string before the colon will be
4937
interpreted as the host.
4939
:param port: A string of the port to run the server on.
4940
:return: A tuple of (host, port), where 'host' is a host name or IP,
4941
and port is an integer TCP/IP port.
4944
if port is not None:
4946
host, port = port.split(':')
4950
def run(self, port=None, inet=False, directory=None, allow_writes=False,
4952
from bzrlib import transport
4953
if directory is None:
4954
directory = os.getcwd()
4955
if protocol is None:
4956
protocol = transport.transport_server_registry.get()
4957
host, port = self.get_host_and_port(port)
4958
url = urlutils.local_path_to_url(directory)
4959
if not allow_writes:
4960
url = 'readonly+' + url
4961
t = transport.get_transport(url)
4962
protocol(t, host, port, inet)
4965
class cmd_join(Command):
4966
__doc__ = """Combine a tree into its containing tree.
4968
This command requires the target tree to be in a rich-root format.
4970
The TREE argument should be an independent tree, inside another tree, but
4971
not part of it. (Such trees can be produced by "bzr split", but also by
4972
running "bzr branch" with the target inside a tree.)
4974
The result is a combined tree, with the subtree no longer an independent
4975
part. This is marked as a merge of the subtree into the containing tree,
4976
and all history is preserved.
4979
_see_also = ['split']
4980
takes_args = ['tree']
4982
Option('reference', help='Join by reference.', hidden=True),
4985
def run(self, tree, reference=False):
4986
sub_tree = WorkingTree.open(tree)
4987
parent_dir = osutils.dirname(sub_tree.basedir)
4988
containing_tree = WorkingTree.open_containing(parent_dir)[0]
4989
repo = containing_tree.branch.repository
4990
if not repo.supports_rich_root():
4991
raise errors.BzrCommandError(
4992
"Can't join trees because %s doesn't support rich root data.\n"
4993
"You can use bzr upgrade on the repository."
4997
containing_tree.add_reference(sub_tree)
4998
except errors.BadReferenceTarget, e:
4999
# XXX: Would be better to just raise a nicely printable
5000
# exception from the real origin. Also below. mbp 20070306
5001
raise errors.BzrCommandError("Cannot join %s. %s" %
5005
containing_tree.subsume(sub_tree)
5006
except errors.BadSubsumeSource, e:
5007
raise errors.BzrCommandError("Cannot join %s. %s" %
5011
class cmd_split(Command):
5012
__doc__ = """Split a subdirectory of a tree into a separate tree.
5014
This command will produce a target tree in a format that supports
5015
rich roots, like 'rich-root' or 'rich-root-pack'. These formats cannot be
5016
converted into earlier formats like 'dirstate-tags'.
5018
The TREE argument should be a subdirectory of a working tree. That
5019
subdirectory will be converted into an independent tree, with its own
5020
branch. Commits in the top-level tree will not apply to the new subtree.
5023
_see_also = ['join']
5024
takes_args = ['tree']
5026
def run(self, tree):
5027
containing_tree, subdir = WorkingTree.open_containing(tree)
5028
sub_id = containing_tree.path2id(subdir)
5030
raise errors.NotVersionedError(subdir)
5032
containing_tree.extract(sub_id)
5033
except errors.RootNotRich:
5034
raise errors.RichRootUpgradeRequired(containing_tree.branch.base)
5037
class cmd_merge_directive(Command):
5038
__doc__ = """Generate a merge directive for auto-merge tools.
5040
A directive requests a merge to be performed, and also provides all the
5041
information necessary to do so. This means it must either include a
5042
revision bundle, or the location of a branch containing the desired
5045
A submit branch (the location to merge into) must be supplied the first
5046
time the command is issued. After it has been supplied once, it will
5047
be remembered as the default.
5049
A public branch is optional if a revision bundle is supplied, but required
5050
if --diff or --plain is specified. It will be remembered as the default
5051
after the first use.
5054
takes_args = ['submit_branch?', 'public_branch?']
5058
_see_also = ['send']
5062
RegistryOption.from_kwargs('patch-type',
5063
'The type of patch to include in the directive.',
5065
value_switches=True,
5067
bundle='Bazaar revision bundle (default).',
5068
diff='Normal unified diff.',
5069
plain='No patch, just directive.'),
5070
Option('sign', help='GPG-sign the directive.'), 'revision',
5071
Option('mail-to', type=str,
5072
help='Instead of printing the directive, email to this address.'),
5073
Option('message', type=str, short_name='m',
5074
help='Message to use when committing this merge.')
5077
encoding_type = 'exact'
5079
def run(self, submit_branch=None, public_branch=None, patch_type='bundle',
5080
sign=False, revision=None, mail_to=None, message=None,
5082
from bzrlib.revision import ensure_null, NULL_REVISION
5083
include_patch, include_bundle = {
5084
'plain': (False, False),
5085
'diff': (True, False),
5086
'bundle': (True, True),
5088
branch = Branch.open(directory)
5089
stored_submit_branch = branch.get_submit_branch()
5090
if submit_branch is None:
5091
submit_branch = stored_submit_branch
5093
if stored_submit_branch is None:
5094
branch.set_submit_branch(submit_branch)
5095
if submit_branch is None:
5096
submit_branch = branch.get_parent()
5097
if submit_branch is None:
5098
raise errors.BzrCommandError('No submit branch specified or known')
5100
stored_public_branch = branch.get_public_branch()
5101
if public_branch is None:
5102
public_branch = stored_public_branch
5103
elif stored_public_branch is None:
5104
branch.set_public_branch(public_branch)
5105
if not include_bundle and public_branch is None:
5106
raise errors.BzrCommandError('No public branch specified or'
5108
base_revision_id = None
5109
if revision is not None:
5110
if len(revision) > 2:
5111
raise errors.BzrCommandError('bzr merge-directive takes '
5112
'at most two one revision identifiers')
5113
revision_id = revision[-1].as_revision_id(branch)
5114
if len(revision) == 2:
5115
base_revision_id = revision[0].as_revision_id(branch)
5117
revision_id = branch.last_revision()
5118
revision_id = ensure_null(revision_id)
5119
if revision_id == NULL_REVISION:
5120
raise errors.BzrCommandError('No revisions to bundle.')
5121
directive = merge_directive.MergeDirective2.from_objects(
5122
branch.repository, revision_id, time.time(),
5123
osutils.local_time_offset(), submit_branch,
5124
public_branch=public_branch, include_patch=include_patch,
5125
include_bundle=include_bundle, message=message,
5126
base_revision_id=base_revision_id)
5129
self.outf.write(directive.to_signed(branch))
5131
self.outf.writelines(directive.to_lines())
5133
message = directive.to_email(mail_to, branch, sign)
5134
s = SMTPConnection(branch.get_config())
5135
s.send_email(message)
5138
class cmd_send(Command):
5139
__doc__ = """Mail or create a merge-directive for submitting changes.
5141
A merge directive provides many things needed for requesting merges:
5143
* A machine-readable description of the merge to perform
5145
* An optional patch that is a preview of the changes requested
5147
* An optional bundle of revision data, so that the changes can be applied
5148
directly from the merge directive, without retrieving data from a
5151
`bzr send` creates a compact data set that, when applied using bzr
5152
merge, has the same effect as merging from the source branch.
5154
By default the merge directive is self-contained and can be applied to any
5155
branch containing submit_branch in its ancestory without needing access to
5158
If --no-bundle is specified, then Bazaar doesn't send the contents of the
5159
revisions, but only a structured request to merge from the
5160
public_location. In that case the public_branch is needed and it must be
5161
up-to-date and accessible to the recipient. The public_branch is always
5162
included if known, so that people can check it later.
5164
The submit branch defaults to the parent of the source branch, but can be
5165
overridden. Both submit branch and public branch will be remembered in
5166
branch.conf the first time they are used for a particular branch. The
5167
source branch defaults to that containing the working directory, but can
5168
be changed using --from.
5170
In order to calculate those changes, bzr must analyse the submit branch.
5171
Therefore it is most efficient for the submit branch to be a local mirror.
5172
If a public location is known for the submit_branch, that location is used
5173
in the merge directive.
5175
The default behaviour is to send the merge directive by mail, unless -o is
5176
given, in which case it is sent to a file.
5178
Mail is sent using your preferred mail program. This should be transparent
5179
on Windows (it uses MAPI). On Unix, it requires the xdg-email utility.
5180
If the preferred client can't be found (or used), your editor will be used.
5182
To use a specific mail program, set the mail_client configuration option.
5183
(For Thunderbird 1.5, this works around some bugs.) Supported values for
5184
specific clients are "claws", "evolution", "kmail", "mail.app" (MacOS X's
5185
Mail.app), "mutt", and "thunderbird"; generic options are "default",
5186
"editor", "emacsclient", "mapi", and "xdg-email". Plugins may also add
5189
If mail is being sent, a to address is required. This can be supplied
5190
either on the commandline, by setting the submit_to configuration
5191
option in the branch itself or the child_submit_to configuration option
5192
in the submit branch.
5194
Two formats are currently supported: "4" uses revision bundle format 4 and
5195
merge directive format 2. It is significantly faster and smaller than
5196
older formats. It is compatible with Bazaar 0.19 and later. It is the
5197
default. "0.9" uses revision bundle format 0.9 and merge directive
5198
format 1. It is compatible with Bazaar 0.12 - 0.18.
5200
The merge directives created by bzr send may be applied using bzr merge or
5201
bzr pull by specifying a file containing a merge directive as the location.
5203
bzr send makes extensive use of public locations to map local locations into
5204
URLs that can be used by other people. See `bzr help configuration` to
5205
set them, and use `bzr info` to display them.
5208
encoding_type = 'exact'
5210
_see_also = ['merge', 'pull']
5212
takes_args = ['submit_branch?', 'public_branch?']
5216
help='Do not include a bundle in the merge directive.'),
5217
Option('no-patch', help='Do not include a preview patch in the merge'
5220
help='Remember submit and public branch.'),
5222
help='Branch to generate the submission from, '
5223
'rather than the one containing the working directory.',
5226
Option('output', short_name='o',
5227
help='Write merge directive to this file or directory; '
5228
'use - for stdout.',
5231
help='Refuse to send if there are uncommitted changes in'
5232
' the working tree, --no-strict disables the check.'),
5233
Option('mail-to', help='Mail the request to this address.',
5237
Option('body', help='Body for the email.', type=unicode),
5238
RegistryOption('format',
5239
help='Use the specified output format.',
5240
lazy_registry=('bzrlib.send', 'format_registry')),
5243
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
5244
no_patch=False, revision=None, remember=False, output=None,
5245
format=None, mail_to=None, message=None, body=None,
5246
strict=None, **kwargs):
5247
from bzrlib.send import send
5248
return send(submit_branch, revision, public_branch, remember,
5249
format, no_bundle, no_patch, output,
5250
kwargs.get('from', '.'), mail_to, message, body,
5255
class cmd_bundle_revisions(cmd_send):
5256
__doc__ = """Create a merge-directive for submitting changes.
5258
A merge directive provides many things needed for requesting merges:
5260
* A machine-readable description of the merge to perform
5262
* An optional patch that is a preview of the changes requested
5264
* An optional bundle of revision data, so that the changes can be applied
5265
directly from the merge directive, without retrieving data from a
5268
If --no-bundle is specified, then public_branch is needed (and must be
5269
up-to-date), so that the receiver can perform the merge using the
5270
public_branch. The public_branch is always included if known, so that
5271
people can check it later.
5273
The submit branch defaults to the parent, but can be overridden. Both
5274
submit branch and public branch will be remembered if supplied.
5276
If a public_branch is known for the submit_branch, that public submit
5277
branch is used in the merge instructions. This means that a local mirror
5278
can be used as your actual submit branch, once you have set public_branch
5281
Two formats are currently supported: "4" uses revision bundle format 4 and
5282
merge directive format 2. It is significantly faster and smaller than
5283
older formats. It is compatible with Bazaar 0.19 and later. It is the
5284
default. "0.9" uses revision bundle format 0.9 and merge directive
5285
format 1. It is compatible with Bazaar 0.12 - 0.18.
5290
help='Do not include a bundle in the merge directive.'),
5291
Option('no-patch', help='Do not include a preview patch in the merge'
5294
help='Remember submit and public branch.'),
5296
help='Branch to generate the submission from, '
5297
'rather than the one containing the working directory.',
5300
Option('output', short_name='o', help='Write directive to this file.',
5303
help='Refuse to bundle revisions if there are uncommitted'
5304
' changes in the working tree, --no-strict disables the check.'),
5306
RegistryOption('format',
5307
help='Use the specified output format.',
5308
lazy_registry=('bzrlib.send', 'format_registry')),
5310
aliases = ['bundle']
5312
_see_also = ['send', 'merge']
5316
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
5317
no_patch=False, revision=None, remember=False, output=None,
5318
format=None, strict=None, **kwargs):
5321
from bzrlib.send import send
5322
return send(submit_branch, revision, public_branch, remember,
5323
format, no_bundle, no_patch, output,
5324
kwargs.get('from', '.'), None, None, None,
5325
self.outf, strict=strict)
5328
class cmd_tag(Command):
5329
__doc__ = """Create, remove or modify a tag naming a revision.
5331
Tags give human-meaningful names to revisions. Commands that take a -r
5332
(--revision) option can be given -rtag:X, where X is any previously
5335
Tags are stored in the branch. Tags are copied from one branch to another
5336
along when you branch, push, pull or merge.
5338
It is an error to give a tag name that already exists unless you pass
5339
--force, in which case the tag is moved to point to the new revision.
5341
To rename a tag (change the name but keep it on the same revsion), run ``bzr
5342
tag new-name -r tag:old-name`` and then ``bzr tag --delete oldname``.
5344
If no tag name is specified it will be determined through the
5345
'automatic_tag_name' hook. This can e.g. be used to automatically tag
5346
upstream releases by reading configure.ac. See ``bzr help hooks`` for
5350
_see_also = ['commit', 'tags']
5351
takes_args = ['tag_name?']
5354
help='Delete this tag rather than placing it.',
5356
custom_help('directory',
5357
help='Branch in which to place the tag.'),
5359
help='Replace existing tags.',
5364
def run(self, tag_name=None,
5370
branch, relpath = Branch.open_containing(directory)
5371
self.add_cleanup(branch.lock_write().unlock)
5373
if tag_name is None:
5374
raise errors.BzrCommandError("No tag specified to delete.")
5375
branch.tags.delete_tag(tag_name)
5376
self.outf.write('Deleted tag %s.\n' % tag_name)
5379
if len(revision) != 1:
5380
raise errors.BzrCommandError(
5381
"Tags can only be placed on a single revision, "
5383
revision_id = revision[0].as_revision_id(branch)
5385
revision_id = branch.last_revision()
5386
if tag_name is None:
5387
tag_name = branch.automatic_tag_name(revision_id)
5388
if tag_name is None:
5389
raise errors.BzrCommandError(
5390
"Please specify a tag name.")
5391
if (not force) and branch.tags.has_tag(tag_name):
5392
raise errors.TagAlreadyExists(tag_name)
5393
branch.tags.set_tag(tag_name, revision_id)
5394
self.outf.write('Created tag %s.\n' % tag_name)
5397
class cmd_tags(Command):
5398
__doc__ = """List tags.
5400
This command shows a table of tag names and the revisions they reference.
5405
custom_help('directory',
5406
help='Branch whose tags should be displayed.'),
5407
RegistryOption.from_kwargs('sort',
5408
'Sort tags by different criteria.', title='Sorting',
5409
natural='Sort numeric substrings as numbers:'
5410
' suitable for version numbers. (default)',
5411
alpha='Sort tags lexicographically.',
5412
time='Sort tags chronologically.',
5425
branch, relpath = Branch.open_containing(directory)
5427
tags = branch.tags.get_tag_dict().items()
5431
self.add_cleanup(branch.lock_read().unlock)
5433
graph = branch.repository.get_graph()
5434
rev1, rev2 = _get_revision_range(revision, branch, self.name())
5435
revid1, revid2 = rev1.rev_id, rev2.rev_id
5436
# only show revisions between revid1 and revid2 (inclusive)
5437
tags = [(tag, revid) for tag, revid in tags if
5438
graph.is_between(revid, revid1, revid2)]
5439
if sort == 'natural':
5440
def natural_sort_key(tag):
5441
return [f(s) for f,s in
5442
zip(itertools.cycle((unicode.lower,int)),
5443
re.split('([0-9]+)', tag[0]))]
5444
tags.sort(key=natural_sort_key)
5445
elif sort == 'alpha':
5447
elif sort == 'time':
5449
for tag, revid in tags:
5451
revobj = branch.repository.get_revision(revid)
5452
except errors.NoSuchRevision:
5453
timestamp = sys.maxint # place them at the end
5455
timestamp = revobj.timestamp
5456
timestamps[revid] = timestamp
5457
tags.sort(key=lambda x: timestamps[x[1]])
5459
# [ (tag, revid), ... ] -> [ (tag, dotted_revno), ... ]
5460
for index, (tag, revid) in enumerate(tags):
5462
revno = branch.revision_id_to_dotted_revno(revid)
5463
if isinstance(revno, tuple):
5464
revno = '.'.join(map(str, revno))
5465
except errors.NoSuchRevision:
5466
# Bad tag data/merges can lead to tagged revisions
5467
# which are not in this branch. Fail gracefully ...
5469
tags[index] = (tag, revno)
5471
for tag, revspec in tags:
5472
self.outf.write('%-20s %s\n' % (tag, revspec))
5475
class cmd_reconfigure(Command):
5476
__doc__ = """Reconfigure the type of a bzr directory.
5478
A target configuration must be specified.
5480
For checkouts, the bind-to location will be auto-detected if not specified.
5481
The order of preference is
5482
1. For a lightweight checkout, the current bound location.
5483
2. For branches that used to be checkouts, the previously-bound location.
5484
3. The push location.
5485
4. The parent location.
5486
If none of these is available, --bind-to must be specified.
5489
_see_also = ['branches', 'checkouts', 'standalone-trees', 'working-trees']
5490
takes_args = ['location?']
5492
RegistryOption.from_kwargs(
5494
title='Target type',
5495
help='The type to reconfigure the directory to.',
5496
value_switches=True, enum_switch=False,
5497
branch='Reconfigure to be an unbound branch with no working tree.',
5498
tree='Reconfigure to be an unbound branch with a working tree.',
5499
checkout='Reconfigure to be a bound branch with a working tree.',
5500
lightweight_checkout='Reconfigure to be a lightweight'
5501
' checkout (with no local history).',
5502
standalone='Reconfigure to be a standalone branch '
5503
'(i.e. stop using shared repository).',
5504
use_shared='Reconfigure to use a shared repository.',
5505
with_trees='Reconfigure repository to create '
5506
'working trees on branches by default.',
5507
with_no_trees='Reconfigure repository to not create '
5508
'working trees on branches by default.'
5510
Option('bind-to', help='Branch to bind checkout to.', type=str),
5512
help='Perform reconfiguration even if local changes'
5514
Option('stacked-on',
5515
help='Reconfigure a branch to be stacked on another branch.',
5519
help='Reconfigure a branch to be unstacked. This '
5520
'may require copying substantial data into it.',
5524
def run(self, location=None, target_type=None, bind_to=None, force=False,
5527
directory = bzrdir.BzrDir.open(location)
5528
if stacked_on and unstacked:
5529
raise BzrCommandError("Can't use both --stacked-on and --unstacked")
5530
elif stacked_on is not None:
5531
reconfigure.ReconfigureStackedOn().apply(directory, stacked_on)
5533
reconfigure.ReconfigureUnstacked().apply(directory)
5534
# At the moment you can use --stacked-on and a different
5535
# reconfiguration shape at the same time; there seems no good reason
5537
if target_type is None:
5538
if stacked_on or unstacked:
5541
raise errors.BzrCommandError('No target configuration '
5543
elif target_type == 'branch':
5544
reconfiguration = reconfigure.Reconfigure.to_branch(directory)
5545
elif target_type == 'tree':
5546
reconfiguration = reconfigure.Reconfigure.to_tree(directory)
5547
elif target_type == 'checkout':
5548
reconfiguration = reconfigure.Reconfigure.to_checkout(
5550
elif target_type == 'lightweight-checkout':
5551
reconfiguration = reconfigure.Reconfigure.to_lightweight_checkout(
5553
elif target_type == 'use-shared':
5554
reconfiguration = reconfigure.Reconfigure.to_use_shared(directory)
5555
elif target_type == 'standalone':
5556
reconfiguration = reconfigure.Reconfigure.to_standalone(directory)
5557
elif target_type == 'with-trees':
5558
reconfiguration = reconfigure.Reconfigure.set_repository_trees(
5560
elif target_type == 'with-no-trees':
5561
reconfiguration = reconfigure.Reconfigure.set_repository_trees(
5563
reconfiguration.apply(force)
5566
class cmd_switch(Command):
5567
__doc__ = """Set the branch of a checkout and update.
5569
For lightweight checkouts, this changes the branch being referenced.
5570
For heavyweight checkouts, this checks that there are no local commits
5571
versus the current bound branch, then it makes the local branch a mirror
5572
of the new location and binds to it.
5574
In both cases, the working tree is updated and uncommitted changes
5575
are merged. The user can commit or revert these as they desire.
5577
Pending merges need to be committed or reverted before using switch.
5579
The path to the branch to switch to can be specified relative to the parent
5580
directory of the current branch. For example, if you are currently in a
5581
checkout of /path/to/branch, specifying 'newbranch' will find a branch at
5584
Bound branches use the nickname of its master branch unless it is set
5585
locally, in which case switching will update the local nickname to be
5589
takes_args = ['to_location?']
5590
takes_options = ['directory',
5592
help='Switch even if local commits will be lost.'),
5594
Option('create-branch', short_name='b',
5595
help='Create the target branch from this one before'
5596
' switching to it.'),
5599
def run(self, to_location=None, force=False, create_branch=False,
5600
revision=None, directory=u'.'):
5601
from bzrlib import switch
5602
tree_location = directory
5603
revision = _get_one_revision('switch', revision)
5604
control_dir = bzrdir.BzrDir.open_containing(tree_location)[0]
5605
if to_location is None:
5606
if revision is None:
5607
raise errors.BzrCommandError('You must supply either a'
5608
' revision or a location')
5609
to_location = tree_location
5611
branch = control_dir.open_branch()
5612
had_explicit_nick = branch.get_config().has_explicit_nickname()
5613
except errors.NotBranchError:
5615
had_explicit_nick = False
5618
raise errors.BzrCommandError('cannot create branch without'
5620
to_location = directory_service.directories.dereference(
5622
if '/' not in to_location and '\\' not in to_location:
5623
# This path is meant to be relative to the existing branch
5624
this_url = self._get_branch_location(control_dir)
5625
to_location = urlutils.join(this_url, '..', to_location)
5626
to_branch = branch.bzrdir.sprout(to_location,
5627
possible_transports=[branch.bzrdir.root_transport],
5628
source_branch=branch).open_branch()
5631
to_branch = Branch.open(to_location)
5632
except errors.NotBranchError:
5633
this_url = self._get_branch_location(control_dir)
5634
to_branch = Branch.open(
5635
urlutils.join(this_url, '..', to_location))
5636
if revision is not None:
5637
revision = revision.as_revision_id(to_branch)
5638
switch.switch(control_dir, to_branch, force, revision_id=revision)
5639
if had_explicit_nick:
5640
branch = control_dir.open_branch() #get the new branch!
5641
branch.nick = to_branch.nick
5642
note('Switched to branch: %s',
5643
urlutils.unescape_for_display(to_branch.base, 'utf-8'))
5645
def _get_branch_location(self, control_dir):
5646
"""Return location of branch for this control dir."""
5648
this_branch = control_dir.open_branch()
5649
# This may be a heavy checkout, where we want the master branch
5650
master_location = this_branch.get_bound_location()
5651
if master_location is not None:
5652
return master_location
5653
# If not, use a local sibling
5654
return this_branch.base
5655
except errors.NotBranchError:
5656
format = control_dir.find_branch_format()
5657
if getattr(format, 'get_reference', None) is not None:
5658
return format.get_reference(control_dir)
5660
return control_dir.root_transport.base
5663
class cmd_view(Command):
5664
__doc__ = """Manage filtered views.
5666
Views provide a mask over the tree so that users can focus on
5667
a subset of a tree when doing their work. After creating a view,
5668
commands that support a list of files - status, diff, commit, etc -
5669
effectively have that list of files implicitly given each time.
5670
An explicit list of files can still be given but those files
5671
must be within the current view.
5673
In most cases, a view has a short life-span: it is created to make
5674
a selected change and is deleted once that change is committed.
5675
At other times, you may wish to create one or more named views
5676
and switch between them.
5678
To disable the current view without deleting it, you can switch to
5679
the pseudo view called ``off``. This can be useful when you need
5680
to see the whole tree for an operation or two (e.g. merge) but
5681
want to switch back to your view after that.
5684
To define the current view::
5686
bzr view file1 dir1 ...
5688
To list the current view::
5692
To delete the current view::
5696
To disable the current view without deleting it::
5698
bzr view --switch off
5700
To define a named view and switch to it::
5702
bzr view --name view-name file1 dir1 ...
5704
To list a named view::
5706
bzr view --name view-name
5708
To delete a named view::
5710
bzr view --name view-name --delete
5712
To switch to a named view::
5714
bzr view --switch view-name
5716
To list all views defined::
5720
To delete all views::
5722
bzr view --delete --all
5726
takes_args = ['file*']
5729
help='Apply list or delete action to all views.',
5732
help='Delete the view.',
5735
help='Name of the view to define, list or delete.',
5739
help='Name of the view to switch to.',
5744
def run(self, file_list,
5750
tree, file_list = WorkingTree.open_containing_paths(file_list,
5752
current_view, view_dict = tree.views.get_view_info()
5757
raise errors.BzrCommandError(
5758
"Both --delete and a file list specified")
5760
raise errors.BzrCommandError(
5761
"Both --delete and --switch specified")
5763
tree.views.set_view_info(None, {})
5764
self.outf.write("Deleted all views.\n")
5766
raise errors.BzrCommandError("No current view to delete")
5768
tree.views.delete_view(name)
5769
self.outf.write("Deleted '%s' view.\n" % name)
5772
raise errors.BzrCommandError(
5773
"Both --switch and a file list specified")
5775
raise errors.BzrCommandError(
5776
"Both --switch and --all specified")
5777
elif switch == 'off':
5778
if current_view is None:
5779
raise errors.BzrCommandError("No current view to disable")
5780
tree.views.set_view_info(None, view_dict)
5781
self.outf.write("Disabled '%s' view.\n" % (current_view))
5783
tree.views.set_view_info(switch, view_dict)
5784
view_str = views.view_display_str(tree.views.lookup_view())
5785
self.outf.write("Using '%s' view: %s\n" % (switch, view_str))
5788
self.outf.write('Views defined:\n')
5789
for view in sorted(view_dict):
5790
if view == current_view:
5794
view_str = views.view_display_str(view_dict[view])
5795
self.outf.write('%s %-20s %s\n' % (active, view, view_str))
5797
self.outf.write('No views defined.\n')
5800
# No name given and no current view set
5803
raise errors.BzrCommandError(
5804
"Cannot change the 'off' pseudo view")
5805
tree.views.set_view(name, sorted(file_list))
5806
view_str = views.view_display_str(tree.views.lookup_view())
5807
self.outf.write("Using '%s' view: %s\n" % (name, view_str))
5811
# No name given and no current view set
5812
self.outf.write('No current view.\n')
5814
view_str = views.view_display_str(tree.views.lookup_view(name))
5815
self.outf.write("'%s' view is: %s\n" % (name, view_str))
5818
class cmd_hooks(Command):
5819
__doc__ = """Show hooks."""
5824
for hook_key in sorted(hooks.known_hooks.keys()):
5825
some_hooks = hooks.known_hooks_key_to_object(hook_key)
5826
self.outf.write("%s:\n" % type(some_hooks).__name__)
5827
for hook_name, hook_point in sorted(some_hooks.items()):
5828
self.outf.write(" %s:\n" % (hook_name,))
5829
found_hooks = list(hook_point)
5831
for hook in found_hooks:
5832
self.outf.write(" %s\n" %
5833
(some_hooks.get_hook_name(hook),))
5835
self.outf.write(" <no hooks installed>\n")
5838
class cmd_remove_branch(Command):
5839
__doc__ = """Remove a branch.
5841
This will remove the branch from the specified location but
5842
will keep any working tree or repository in place.
5846
Remove the branch at repo/trunk::
5848
bzr remove-branch repo/trunk
5852
takes_args = ["location?"]
5854
aliases = ["rmbranch"]
5856
def run(self, location=None):
5857
if location is None:
5859
branch = Branch.open_containing(location)[0]
5860
branch.bzrdir.destroy_branch()
5863
class cmd_shelve(Command):
5864
__doc__ = """Temporarily set aside some changes from the current tree.
5866
Shelve allows you to temporarily put changes you've made "on the shelf",
5867
ie. out of the way, until a later time when you can bring them back from
5868
the shelf with the 'unshelve' command. The changes are stored alongside
5869
your working tree, and so they aren't propagated along with your branch nor
5870
will they survive its deletion.
5872
If shelve --list is specified, previously-shelved changes are listed.
5874
Shelve is intended to help separate several sets of changes that have
5875
been inappropriately mingled. If you just want to get rid of all changes
5876
and you don't need to restore them later, use revert. If you want to
5877
shelve all text changes at once, use shelve --all.
5879
If filenames are specified, only the changes to those files will be
5880
shelved. Other files will be left untouched.
5882
If a revision is specified, changes since that revision will be shelved.
5884
You can put multiple items on the shelf, and by default, 'unshelve' will
5885
restore the most recently shelved changes.
5888
takes_args = ['file*']
5893
Option('all', help='Shelve all changes.'),
5895
RegistryOption('writer', 'Method to use for writing diffs.',
5896
bzrlib.option.diff_writer_registry,
5897
value_switches=True, enum_switch=False),
5899
Option('list', help='List shelved changes.'),
5901
help='Destroy removed changes instead of shelving them.'),
5903
_see_also = ['unshelve']
5905
def run(self, revision=None, all=False, file_list=None, message=None,
5906
writer=None, list=False, destroy=False, directory=u'.'):
5908
return self.run_for_list()
5909
from bzrlib.shelf_ui import Shelver
5911
writer = bzrlib.option.diff_writer_registry.get()
5913
shelver = Shelver.from_args(writer(sys.stdout), revision, all,
5914
file_list, message, destroy=destroy, directory=directory)
5919
except errors.UserAbort:
5922
def run_for_list(self):
5923
tree = WorkingTree.open_containing('.')[0]
5924
self.add_cleanup(tree.lock_read().unlock)
5925
manager = tree.get_shelf_manager()
5926
shelves = manager.active_shelves()
5927
if len(shelves) == 0:
5928
note('No shelved changes.')
5930
for shelf_id in reversed(shelves):
5931
message = manager.get_metadata(shelf_id).get('message')
5933
message = '<no message>'
5934
self.outf.write('%3d: %s\n' % (shelf_id, message))
5938
class cmd_unshelve(Command):
5939
__doc__ = """Restore shelved changes.
5941
By default, the most recently shelved changes are restored. However if you
5942
specify a shelf by id those changes will be restored instead. This works
5943
best when the changes don't depend on each other.
5946
takes_args = ['shelf_id?']
5949
RegistryOption.from_kwargs(
5950
'action', help="The action to perform.",
5951
enum_switch=False, value_switches=True,
5952
apply="Apply changes and remove from the shelf.",
5953
dry_run="Show changes, but do not apply or remove them.",
5954
preview="Instead of unshelving the changes, show the diff that "
5955
"would result from unshelving.",
5956
delete_only="Delete changes without applying them.",
5957
keep="Apply changes but don't delete them.",
5960
_see_also = ['shelve']
5962
def run(self, shelf_id=None, action='apply', directory=u'.'):
5963
from bzrlib.shelf_ui import Unshelver
5964
unshelver = Unshelver.from_args(shelf_id, action, directory=directory)
5968
unshelver.tree.unlock()
5971
class cmd_clean_tree(Command):
5972
__doc__ = """Remove unwanted files from working tree.
5974
By default, only unknown files, not ignored files, are deleted. Versioned
5975
files are never deleted.
5977
Another class is 'detritus', which includes files emitted by bzr during
5978
normal operations and selftests. (The value of these files decreases with
5981
If no options are specified, unknown files are deleted. Otherwise, option
5982
flags are respected, and may be combined.
5984
To check what clean-tree will do, use --dry-run.
5986
takes_options = ['directory',
5987
Option('ignored', help='Delete all ignored files.'),
5988
Option('detritus', help='Delete conflict files, merge'
5989
' backups, and failed selftest dirs.'),
5991
help='Delete files unknown to bzr (default).'),
5992
Option('dry-run', help='Show files to delete instead of'
5994
Option('force', help='Do not prompt before deleting.')]
5995
def run(self, unknown=False, ignored=False, detritus=False, dry_run=False,
5996
force=False, directory=u'.'):
5997
from bzrlib.clean_tree import clean_tree
5998
if not (unknown or ignored or detritus):
6002
clean_tree(directory, unknown=unknown, ignored=ignored,
6003
detritus=detritus, dry_run=dry_run, no_prompt=force)
6006
class cmd_reference(Command):
6007
__doc__ = """list, view and set branch locations for nested trees.
6009
If no arguments are provided, lists the branch locations for nested trees.
6010
If one argument is provided, display the branch location for that tree.
6011
If two arguments are provided, set the branch location for that tree.
6016
takes_args = ['path?', 'location?']
6018
def run(self, path=None, location=None):
6020
if path is not None:
6022
tree, branch, relpath =(
6023
bzrdir.BzrDir.open_containing_tree_or_branch(branchdir))
6024
if path is not None:
6027
tree = branch.basis_tree()
6029
info = branch._get_all_reference_info().iteritems()
6030
self._display_reference_info(tree, branch, info)
6032
file_id = tree.path2id(path)
6034
raise errors.NotVersionedError(path)
6035
if location is None:
6036
info = [(file_id, branch.get_reference_info(file_id))]
6037
self._display_reference_info(tree, branch, info)
6039
branch.set_reference_info(file_id, path, location)
6041
def _display_reference_info(self, tree, branch, info):
6043
for file_id, (path, location) in info:
6045
path = tree.id2path(file_id)
6046
except errors.NoSuchId:
6048
ref_list.append((path, location))
6049
for path, location in sorted(ref_list):
6050
self.outf.write('%s %s\n' % (path, location))
6053
def _register_lazy_builtins():
6054
# register lazy builtins from other modules; called at startup and should
6055
# be only called once.
6056
for (name, aliases, module_name) in [
6057
('cmd_bundle_info', [], 'bzrlib.bundle.commands'),
6058
('cmd_dpush', [], 'bzrlib.foreign'),
6059
('cmd_version_info', [], 'bzrlib.cmd_version_info'),
6060
('cmd_resolve', ['resolved'], 'bzrlib.conflicts'),
6061
('cmd_conflicts', [], 'bzrlib.conflicts'),
6062
('cmd_sign_my_commits', [], 'bzrlib.sign_my_commits'),
6064
builtin_command_registry.register_lazy(name, aliases, module_name)
added
removed
bzrlib/builtins.py
