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(), """
46
revision as _mod_revision,
55
from bzrlib.branch import Branch
56
from bzrlib.conflicts import ConflictList
57
from bzrlib.transport import memory
58
from bzrlib.revisionspec import RevisionSpec, RevisionInfo
59
from bzrlib.smtp_connection import SMTPConnection
60
from bzrlib.workingtree import WorkingTree
63
from bzrlib.commands import (
65
builtin_command_registry,
68
from bzrlib.option import (
75
from bzrlib.trace import mutter, note, warning, is_quiet, get_verbosity_level
78
def tree_files(file_list, default_branch=u'.', canonicalize=True,
81
return internal_tree_files(file_list, default_branch, canonicalize,
83
except errors.FileInWrongBranch, e:
84
raise errors.BzrCommandError("%s is not in the same branch as %s" %
85
(e.path, file_list[0]))
88
def tree_files_for_add(file_list):
90
Return a tree and list of absolute paths from a file list.
92
Similar to tree_files, but add handles files a bit differently, so it a
93
custom implementation. In particular, MutableTreeTree.smart_add expects
94
absolute paths, which it immediately converts to relative paths.
96
# FIXME Would be nice to just return the relative paths like
97
# internal_tree_files does, but there are a large number of unit tests
98
# that assume the current interface to mutabletree.smart_add
100
tree, relpath = WorkingTree.open_containing(file_list[0])
101
if tree.supports_views():
102
view_files = tree.views.lookup_view()
104
for filename in file_list:
105
if not osutils.is_inside_any(view_files, filename):
106
raise errors.FileOutsideView(filename, view_files)
107
file_list = file_list[:]
108
file_list[0] = tree.abspath(relpath)
110
tree = WorkingTree.open_containing(u'.')[0]
111
if tree.supports_views():
112
view_files = tree.views.lookup_view()
114
file_list = view_files
115
view_str = views.view_display_str(view_files)
116
note("Ignoring files outside view. View is %s" % view_str)
117
return tree, file_list
120
def _get_one_revision(command_name, revisions):
121
if revisions is None:
123
if len(revisions) != 1:
124
raise errors.BzrCommandError(
125
'bzr %s --revision takes exactly one revision identifier' % (
130
def _get_one_revision_tree(command_name, revisions, branch=None, tree=None):
131
"""Get a revision tree. Not suitable for commands that change the tree.
133
Specifically, the basis tree in dirstate trees is coupled to the dirstate
134
and doing a commit/uncommit/pull will at best fail due to changing the
137
If tree is passed in, it should be already locked, for lifetime management
138
of the trees internal cached state.
142
if revisions is None:
144
rev_tree = tree.basis_tree()
146
rev_tree = branch.basis_tree()
148
revision = _get_one_revision(command_name, revisions)
149
rev_tree = revision.as_tree(branch)
153
# XXX: Bad function name; should possibly also be a class method of
154
# WorkingTree rather than a function.
155
def internal_tree_files(file_list, default_branch=u'.', canonicalize=True,
157
"""Convert command-line paths to a WorkingTree and relative paths.
159
This is typically used for command-line processors that take one or
160
more filenames, and infer the workingtree that contains them.
162
The filenames given are not required to exist.
164
:param file_list: Filenames to convert.
166
:param default_branch: Fallback tree path to use if file_list is empty or
169
:param apply_view: if True and a view is set, apply it or check that
170
specified files are within it
172
:return: workingtree, [relative_paths]
174
if file_list is None or len(file_list) == 0:
175
tree = WorkingTree.open_containing(default_branch)[0]
176
if tree.supports_views() and apply_view:
177
view_files = tree.views.lookup_view()
179
file_list = view_files
180
view_str = views.view_display_str(view_files)
181
note("Ignoring files outside view. View is %s" % view_str)
182
return tree, file_list
183
tree = WorkingTree.open_containing(osutils.realpath(file_list[0]))[0]
184
return tree, safe_relpath_files(tree, file_list, canonicalize,
185
apply_view=apply_view)
188
def safe_relpath_files(tree, file_list, canonicalize=True, apply_view=True):
189
"""Convert file_list into a list of relpaths in tree.
191
:param tree: A tree to operate on.
192
:param file_list: A list of user provided paths or None.
193
:param apply_view: if True and a view is set, apply it or check that
194
specified files are within it
195
:return: A list of relative paths.
196
:raises errors.PathNotChild: When a provided path is in a different tree
199
if file_list is None:
201
if tree.supports_views() and apply_view:
202
view_files = tree.views.lookup_view()
206
# tree.relpath exists as a "thunk" to osutils, but canonical_relpath
207
# doesn't - fix that up here before we enter the loop.
209
fixer = lambda p: osutils.canonical_relpath(tree.basedir, p)
212
for filename in file_list:
214
relpath = fixer(osutils.dereference_path(filename))
215
if view_files and not osutils.is_inside_any(view_files, relpath):
216
raise errors.FileOutsideView(filename, view_files)
217
new_list.append(relpath)
218
except errors.PathNotChild:
219
raise errors.FileInWrongBranch(tree.branch, filename)
223
def _get_view_info_for_change_reporter(tree):
224
"""Get the view information from a tree for change reporting."""
227
current_view = tree.views.get_view_info()[0]
228
if current_view is not None:
229
view_info = (current_view, tree.views.lookup_view())
230
except errors.ViewsNotSupported:
235
def _open_directory_or_containing_tree_or_branch(filename, directory):
236
"""Open the tree or branch containing the specified file, unless
237
the --directory option is used to specify a different branch."""
238
if directory is not None:
239
return (None, Branch.open(directory), filename)
240
return bzrdir.BzrDir.open_containing_tree_or_branch(filename)
243
# TODO: Make sure no commands unconditionally use the working directory as a
244
# branch. If a filename argument is used, the first of them should be used to
245
# specify the branch. (Perhaps this can be factored out into some kind of
246
# Argument class, representing a file in a branch, where the first occurrence
249
class cmd_status(Command):
250
__doc__ = """Display status summary.
252
This reports on versioned and unknown files, reporting them
253
grouped by state. Possible states are:
256
Versioned in the working copy but not in the previous revision.
259
Versioned in the previous revision but removed or deleted
263
Path of this file changed from the previous revision;
264
the text may also have changed. This includes files whose
265
parent directory was renamed.
268
Text has changed since the previous revision.
271
File kind has been changed (e.g. from file to directory).
274
Not versioned and not matching an ignore pattern.
276
Additionally for directories, symlinks and files with an executable
277
bit, Bazaar indicates their type using a trailing character: '/', '@'
280
To see ignored files use 'bzr ignored'. For details on the
281
changes to file texts, use 'bzr diff'.
283
Note that --short or -S gives status flags for each item, similar
284
to Subversion's status command. To get output similar to svn -q,
287
If no arguments are specified, the status of the entire working
288
directory is shown. Otherwise, only the status of the specified
289
files or directories is reported. If a directory is given, status
290
is reported for everything inside that directory.
292
Before merges are committed, the pending merge tip revisions are
293
shown. To see all pending merge revisions, use the -v option.
294
To skip the display of pending merge information altogether, use
295
the no-pending option or specify a file/directory.
297
If a revision argument is given, the status is calculated against
298
that revision, or between two revisions if two are provided.
301
# TODO: --no-recurse, --recurse options
303
takes_args = ['file*']
304
takes_options = ['show-ids', 'revision', 'change', 'verbose',
305
Option('short', help='Use short status indicators.',
307
Option('versioned', help='Only show versioned files.',
309
Option('no-pending', help='Don\'t show pending merges.',
312
aliases = ['st', 'stat']
314
encoding_type = 'replace'
315
_see_also = ['diff', 'revert', 'status-flags']
318
def run(self, show_ids=False, file_list=None, revision=None, short=False,
319
versioned=False, no_pending=False, verbose=False):
320
from bzrlib.status import show_tree_status
322
if revision and len(revision) > 2:
323
raise errors.BzrCommandError('bzr status --revision takes exactly'
324
' one or two revision specifiers')
326
tree, relfile_list = tree_files(file_list)
327
# Avoid asking for specific files when that is not needed.
328
if relfile_list == ['']:
330
# Don't disable pending merges for full trees other than '.'.
331
if file_list == ['.']:
333
# A specific path within a tree was given.
334
elif relfile_list is not None:
336
show_tree_status(tree, show_ids=show_ids,
337
specific_files=relfile_list, revision=revision,
338
to_file=self.outf, short=short, versioned=versioned,
339
show_pending=(not no_pending), verbose=verbose)
342
class cmd_cat_revision(Command):
343
__doc__ = """Write out metadata for a revision.
345
The revision to print can either be specified by a specific
346
revision identifier, or you can use --revision.
350
takes_args = ['revision_id?']
351
takes_options = ['directory', 'revision']
352
# cat-revision is more for frontends so should be exact
355
def print_revision(self, revisions, revid):
356
stream = revisions.get_record_stream([(revid,)], 'unordered', True)
357
record = stream.next()
358
if record.storage_kind == 'absent':
359
raise errors.NoSuchRevision(revisions, revid)
360
revtext = record.get_bytes_as('fulltext')
361
self.outf.write(revtext.decode('utf-8'))
364
def run(self, revision_id=None, revision=None, directory=u'.'):
365
if revision_id is not None and revision is not None:
366
raise errors.BzrCommandError('You can only supply one of'
367
' revision_id or --revision')
368
if revision_id is None and revision is None:
369
raise errors.BzrCommandError('You must supply either'
370
' --revision or a revision_id')
371
b = WorkingTree.open_containing(directory)[0].branch
373
revisions = b.repository.revisions
374
if revisions is None:
375
raise errors.BzrCommandError('Repository %r does not support '
376
'access to raw revision texts')
378
b.repository.lock_read()
380
# TODO: jam 20060112 should cat-revision always output utf-8?
381
if revision_id is not None:
382
revision_id = osutils.safe_revision_id(revision_id, warn=False)
384
self.print_revision(revisions, revision_id)
385
except errors.NoSuchRevision:
386
msg = "The repository %s contains no revision %s." % (
387
b.repository.base, revision_id)
388
raise errors.BzrCommandError(msg)
389
elif revision is not None:
392
raise errors.BzrCommandError(
393
'You cannot specify a NULL revision.')
394
rev_id = rev.as_revision_id(b)
395
self.print_revision(revisions, rev_id)
397
b.repository.unlock()
400
class cmd_dump_btree(Command):
401
__doc__ = """Dump the contents of a btree index file to stdout.
403
PATH is a btree index file, it can be any URL. This includes things like
404
.bzr/repository/pack-names, or .bzr/repository/indices/a34b3a...ca4a4.iix
406
By default, the tuples stored in the index file will be displayed. With
407
--raw, we will uncompress the pages, but otherwise display the raw bytes
411
# TODO: Do we want to dump the internal nodes as well?
412
# TODO: It would be nice to be able to dump the un-parsed information,
413
# rather than only going through iter_all_entries. However, this is
414
# good enough for a start
416
encoding_type = 'exact'
417
takes_args = ['path']
418
takes_options = [Option('raw', help='Write the uncompressed bytes out,'
419
' rather than the parsed tuples.'),
422
def run(self, path, raw=False):
423
dirname, basename = osutils.split(path)
424
t = transport.get_transport(dirname)
426
self._dump_raw_bytes(t, basename)
428
self._dump_entries(t, basename)
430
def _get_index_and_bytes(self, trans, basename):
431
"""Create a BTreeGraphIndex and raw bytes."""
432
bt = btree_index.BTreeGraphIndex(trans, basename, None)
433
bytes = trans.get_bytes(basename)
434
bt._file = cStringIO.StringIO(bytes)
435
bt._size = len(bytes)
438
def _dump_raw_bytes(self, trans, basename):
441
# We need to parse at least the root node.
442
# This is because the first page of every row starts with an
443
# uncompressed header.
444
bt, bytes = self._get_index_and_bytes(trans, basename)
445
for page_idx, page_start in enumerate(xrange(0, len(bytes),
446
btree_index._PAGE_SIZE)):
447
page_end = min(page_start + btree_index._PAGE_SIZE, len(bytes))
448
page_bytes = bytes[page_start:page_end]
450
self.outf.write('Root node:\n')
451
header_end, data = bt._parse_header_from_bytes(page_bytes)
452
self.outf.write(page_bytes[:header_end])
454
self.outf.write('\nPage %d\n' % (page_idx,))
455
decomp_bytes = zlib.decompress(page_bytes)
456
self.outf.write(decomp_bytes)
457
self.outf.write('\n')
459
def _dump_entries(self, trans, basename):
461
st = trans.stat(basename)
462
except errors.TransportNotPossible:
463
# We can't stat, so we'll fake it because we have to do the 'get()'
465
bt, _ = self._get_index_and_bytes(trans, basename)
467
bt = btree_index.BTreeGraphIndex(trans, basename, st.st_size)
468
for node in bt.iter_all_entries():
469
# Node is made up of:
470
# (index, key, value, [references])
474
refs_as_tuples = None
476
refs_as_tuples = static_tuple.as_tuples(refs)
477
as_tuple = (tuple(node[1]), node[2], refs_as_tuples)
478
self.outf.write('%s\n' % (as_tuple,))
481
class cmd_remove_tree(Command):
482
__doc__ = """Remove the working tree from a given branch/checkout.
484
Since a lightweight checkout is little more than a working tree
485
this will refuse to run against one.
487
To re-create the working tree, use "bzr checkout".
489
_see_also = ['checkout', 'working-trees']
490
takes_args = ['location*']
493
help='Remove the working tree even if it has '
494
'uncommitted changes.'),
497
def run(self, location_list, force=False):
498
if not location_list:
501
for location in location_list:
502
d = bzrdir.BzrDir.open(location)
505
working = d.open_workingtree()
506
except errors.NoWorkingTree:
507
raise errors.BzrCommandError("No working tree to remove")
508
except errors.NotLocalUrl:
509
raise errors.BzrCommandError("You cannot remove the working tree"
512
if (working.has_changes()):
513
raise errors.UncommittedChanges(working)
515
if working.user_url != working.branch.user_url:
516
raise errors.BzrCommandError("You cannot remove the working tree"
517
" from a lightweight checkout")
519
d.destroy_workingtree()
522
class cmd_revno(Command):
523
__doc__ = """Show current revision number.
525
This is equal to the number of revisions on this branch.
529
takes_args = ['location?']
531
Option('tree', help='Show revno of working tree'),
535
def run(self, tree=False, location=u'.'):
538
wt = WorkingTree.open_containing(location)[0]
539
self.add_cleanup(wt.lock_read().unlock)
540
except (errors.NoWorkingTree, errors.NotLocalUrl):
541
raise errors.NoWorkingTree(location)
542
revid = wt.last_revision()
544
revno_t = wt.branch.revision_id_to_dotted_revno(revid)
545
except errors.NoSuchRevision:
547
revno = ".".join(str(n) for n in revno_t)
549
b = Branch.open_containing(location)[0]
550
self.add_cleanup(b.lock_read().unlock)
553
self.outf.write(str(revno) + '\n')
556
class cmd_revision_info(Command):
557
__doc__ = """Show revision number and revision id for a given revision identifier.
560
takes_args = ['revision_info*']
563
custom_help('directory',
564
help='Branch to examine, '
565
'rather than the one containing the working directory.'),
566
Option('tree', help='Show revno of working tree'),
570
def run(self, revision=None, directory=u'.', tree=False,
571
revision_info_list=[]):
574
wt = WorkingTree.open_containing(directory)[0]
576
self.add_cleanup(wt.lock_read().unlock)
577
except (errors.NoWorkingTree, errors.NotLocalUrl):
579
b = Branch.open_containing(directory)[0]
580
self.add_cleanup(b.lock_read().unlock)
582
if revision is not None:
583
revision_ids.extend(rev.as_revision_id(b) for rev in revision)
584
if revision_info_list is not None:
585
for rev_str in revision_info_list:
586
rev_spec = RevisionSpec.from_string(rev_str)
587
revision_ids.append(rev_spec.as_revision_id(b))
588
# No arguments supplied, default to the last revision
589
if len(revision_ids) == 0:
592
raise errors.NoWorkingTree(directory)
593
revision_ids.append(wt.last_revision())
595
revision_ids.append(b.last_revision())
599
for revision_id in revision_ids:
601
dotted_revno = b.revision_id_to_dotted_revno(revision_id)
602
revno = '.'.join(str(i) for i in dotted_revno)
603
except errors.NoSuchRevision:
605
maxlen = max(maxlen, len(revno))
606
revinfos.append([revno, revision_id])
610
self.outf.write('%*s %s\n' % (maxlen, ri[0], ri[1]))
613
class cmd_add(Command):
614
__doc__ = """Add specified files or directories.
616
In non-recursive mode, all the named items are added, regardless
617
of whether they were previously ignored. A warning is given if
618
any of the named files are already versioned.
620
In recursive mode (the default), files are treated the same way
621
but the behaviour for directories is different. Directories that
622
are already versioned do not give a warning. All directories,
623
whether already versioned or not, are searched for files or
624
subdirectories that are neither versioned or ignored, and these
625
are added. This search proceeds recursively into versioned
626
directories. If no names are given '.' is assumed.
628
Therefore simply saying 'bzr add' will version all files that
629
are currently unknown.
631
Adding a file whose parent directory is not versioned will
632
implicitly add the parent, and so on up to the root. This means
633
you should never need to explicitly add a directory, they'll just
634
get added when you add a file in the directory.
636
--dry-run will show which files would be added, but not actually
639
--file-ids-from will try to use the file ids from the supplied path.
640
It looks up ids trying to find a matching parent directory with the
641
same filename, and then by pure path. This option is rarely needed
642
but can be useful when adding the same logical file into two
643
branches that will be merged later (without showing the two different
644
adds as a conflict). It is also useful when merging another project
645
into a subdirectory of this one.
647
Any files matching patterns in the ignore list will not be added
648
unless they are explicitly mentioned.
650
takes_args = ['file*']
653
help="Don't recursively add the contents of directories."),
655
help="Show what would be done, but don't actually do anything."),
657
Option('file-ids-from',
659
help='Lookup file ids from this tree.'),
661
encoding_type = 'replace'
662
_see_also = ['remove', 'ignore']
664
def run(self, file_list, no_recurse=False, dry_run=False, verbose=False,
669
if file_ids_from is not None:
671
base_tree, base_path = WorkingTree.open_containing(
673
except errors.NoWorkingTree:
674
base_branch, base_path = Branch.open_containing(
676
base_tree = base_branch.basis_tree()
678
action = bzrlib.add.AddFromBaseAction(base_tree, base_path,
679
to_file=self.outf, should_print=(not is_quiet()))
681
action = bzrlib.add.AddAction(to_file=self.outf,
682
should_print=(not is_quiet()))
685
self.add_cleanup(base_tree.lock_read().unlock)
686
tree, file_list = tree_files_for_add(file_list)
687
added, ignored = tree.smart_add(file_list, not
688
no_recurse, action=action, save=not dry_run)
692
for glob in sorted(ignored.keys()):
693
for path in ignored[glob]:
694
self.outf.write("ignored %s matching \"%s\"\n"
698
class cmd_mkdir(Command):
699
__doc__ = """Create a new versioned directory.
701
This is equivalent to creating the directory and then adding it.
704
takes_args = ['dir+']
705
encoding_type = 'replace'
707
def run(self, dir_list):
709
wt, dd = WorkingTree.open_containing(d)
710
base = os.path.dirname(dd)
711
id = wt.path2id(base)
715
self.outf.write('added %s\n' % d)
717
raise errors.NotVersionedError(path=base)
720
class cmd_relpath(Command):
721
__doc__ = """Show path of a file relative to root"""
723
takes_args = ['filename']
727
def run(self, filename):
728
# TODO: jam 20050106 Can relpath return a munged path if
729
# sys.stdout encoding cannot represent it?
730
tree, relpath = WorkingTree.open_containing(filename)
731
self.outf.write(relpath)
732
self.outf.write('\n')
735
class cmd_inventory(Command):
736
__doc__ = """Show inventory of the current working copy or a revision.
738
It is possible to limit the output to a particular entry
739
type using the --kind option. For example: --kind file.
741
It is also possible to restrict the list of files to a specific
742
set. For example: bzr inventory --show-ids this/file
751
help='List entries of a particular kind: file, directory, symlink.',
754
takes_args = ['file*']
757
def run(self, revision=None, show_ids=False, kind=None, file_list=None):
758
if kind and kind not in ['file', 'directory', 'symlink']:
759
raise errors.BzrCommandError('invalid kind %r specified' % (kind,))
761
revision = _get_one_revision('inventory', revision)
762
work_tree, file_list = tree_files(file_list)
763
self.add_cleanup(work_tree.lock_read().unlock)
764
if revision is not None:
765
tree = revision.as_tree(work_tree.branch)
767
extra_trees = [work_tree]
768
self.add_cleanup(tree.lock_read().unlock)
773
if file_list is not None:
774
file_ids = tree.paths2ids(file_list, trees=extra_trees,
775
require_versioned=True)
776
# find_ids_across_trees may include some paths that don't
778
entries = sorted((tree.id2path(file_id), tree.inventory[file_id])
779
for file_id in file_ids if file_id in tree)
781
entries = tree.inventory.entries()
784
for path, entry in entries:
785
if kind and kind != entry.kind:
788
self.outf.write('%-50s %s\n' % (path, entry.file_id))
790
self.outf.write(path)
791
self.outf.write('\n')
794
class cmd_mv(Command):
795
__doc__ = """Move or rename a file.
798
bzr mv OLDNAME NEWNAME
800
bzr mv SOURCE... DESTINATION
802
If the last argument is a versioned directory, all the other names
803
are moved into it. Otherwise, there must be exactly two arguments
804
and the file is changed to a new name.
806
If OLDNAME does not exist on the filesystem but is versioned and
807
NEWNAME does exist on the filesystem but is not versioned, mv
808
assumes that the file has been manually moved and only updates
809
its internal inventory to reflect that change.
810
The same is valid when moving many SOURCE files to a DESTINATION.
812
Files cannot be moved between branches.
815
takes_args = ['names*']
816
takes_options = [Option("after", help="Move only the bzr identifier"
817
" of the file, because the file has already been moved."),
818
Option('auto', help='Automatically guess renames.'),
819
Option('dry-run', help='Avoid making changes when guessing renames.'),
821
aliases = ['move', 'rename']
822
encoding_type = 'replace'
824
def run(self, names_list, after=False, auto=False, dry_run=False):
826
return self.run_auto(names_list, after, dry_run)
828
raise errors.BzrCommandError('--dry-run requires --auto.')
829
if names_list is None:
831
if len(names_list) < 2:
832
raise errors.BzrCommandError("missing file argument")
833
tree, rel_names = tree_files(names_list, canonicalize=False)
834
self.add_cleanup(tree.lock_tree_write().unlock)
835
self._run(tree, names_list, rel_names, after)
837
def run_auto(self, names_list, after, dry_run):
838
if names_list is not None and len(names_list) > 1:
839
raise errors.BzrCommandError('Only one path may be specified to'
842
raise errors.BzrCommandError('--after cannot be specified with'
844
work_tree, file_list = tree_files(names_list, default_branch='.')
845
self.add_cleanup(work_tree.lock_tree_write().unlock)
846
rename_map.RenameMap.guess_renames(work_tree, dry_run)
848
def _run(self, tree, names_list, rel_names, after):
849
into_existing = osutils.isdir(names_list[-1])
850
if into_existing and len(names_list) == 2:
852
# a. case-insensitive filesystem and change case of dir
853
# b. move directory after the fact (if the source used to be
854
# a directory, but now doesn't exist in the working tree
855
# and the target is an existing directory, just rename it)
856
if (not tree.case_sensitive
857
and rel_names[0].lower() == rel_names[1].lower()):
858
into_existing = False
861
# 'fix' the case of a potential 'from'
862
from_id = tree.path2id(
863
tree.get_canonical_inventory_path(rel_names[0]))
864
if (not osutils.lexists(names_list[0]) and
865
from_id and inv.get_file_kind(from_id) == "directory"):
866
into_existing = False
869
# move into existing directory
870
# All entries reference existing inventory items, so fix them up
871
# for cicp file-systems.
872
rel_names = tree.get_canonical_inventory_paths(rel_names)
873
for src, dest in tree.move(rel_names[:-1], rel_names[-1], after=after):
875
self.outf.write("%s => %s\n" % (src, dest))
877
if len(names_list) != 2:
878
raise errors.BzrCommandError('to mv multiple files the'
879
' destination must be a versioned'
882
# for cicp file-systems: the src references an existing inventory
884
src = tree.get_canonical_inventory_path(rel_names[0])
885
# Find the canonical version of the destination: In all cases, the
886
# parent of the target must be in the inventory, so we fetch the
887
# canonical version from there (we do not always *use* the
888
# canonicalized tail portion - we may be attempting to rename the
890
canon_dest = tree.get_canonical_inventory_path(rel_names[1])
891
dest_parent = osutils.dirname(canon_dest)
892
spec_tail = osutils.basename(rel_names[1])
893
# For a CICP file-system, we need to avoid creating 2 inventory
894
# entries that differ only by case. So regardless of the case
895
# we *want* to use (ie, specified by the user or the file-system),
896
# we must always choose to use the case of any existing inventory
897
# items. The only exception to this is when we are attempting a
898
# case-only rename (ie, canonical versions of src and dest are
900
dest_id = tree.path2id(canon_dest)
901
if dest_id is None or tree.path2id(src) == dest_id:
902
# No existing item we care about, so work out what case we
903
# are actually going to use.
905
# If 'after' is specified, the tail must refer to a file on disk.
907
dest_parent_fq = osutils.pathjoin(tree.basedir, dest_parent)
909
# pathjoin with an empty tail adds a slash, which breaks
911
dest_parent_fq = tree.basedir
913
dest_tail = osutils.canonical_relpath(
915
osutils.pathjoin(dest_parent_fq, spec_tail))
917
# not 'after', so case as specified is used
918
dest_tail = spec_tail
920
# Use the existing item so 'mv' fails with AlreadyVersioned.
921
dest_tail = os.path.basename(canon_dest)
922
dest = osutils.pathjoin(dest_parent, dest_tail)
923
mutter("attempting to move %s => %s", src, dest)
924
tree.rename_one(src, dest, after=after)
926
self.outf.write("%s => %s\n" % (src, dest))
929
class cmd_pull(Command):
930
__doc__ = """Turn this branch into a mirror of another branch.
932
By default, this command only works on branches that have not diverged.
933
Branches are considered diverged if the destination branch's most recent
934
commit is one that has not been merged (directly or indirectly) into the
937
If branches have diverged, you can use 'bzr merge' to integrate the changes
938
from one into the other. Once one branch has merged, the other should
939
be able to pull it again.
941
If you want to replace your local changes and just want your branch to
942
match the remote one, use pull --overwrite. This will work even if the two
943
branches have diverged.
945
If there is no default location set, the first pull will set it. After
946
that, you can omit the location to use the default. To change the
947
default, use --remember. The value will only be saved if the remote
948
location can be accessed.
950
Note: The location can be specified either in the form of a branch,
951
or in the form of a path to a file containing a merge directive generated
955
_see_also = ['push', 'update', 'status-flags', 'send']
956
takes_options = ['remember', 'overwrite', 'revision',
957
custom_help('verbose',
958
help='Show logs of pulled revisions.'),
959
custom_help('directory',
960
help='Branch to pull into, '
961
'rather than the one containing the working directory.'),
963
help="Perform a local pull in a bound "
964
"branch. Local pulls are not applied to "
968
takes_args = ['location?']
969
encoding_type = 'replace'
971
def run(self, location=None, remember=False, overwrite=False,
972
revision=None, verbose=False,
973
directory=None, local=False):
974
# FIXME: too much stuff is in the command class
977
if directory is None:
980
tree_to = WorkingTree.open_containing(directory)[0]
981
branch_to = tree_to.branch
982
self.add_cleanup(tree_to.lock_write().unlock)
983
except errors.NoWorkingTree:
985
branch_to = Branch.open_containing(directory)[0]
986
self.add_cleanup(branch_to.lock_write().unlock)
988
if local and not branch_to.get_bound_location():
989
raise errors.LocalRequiresBoundBranch()
991
possible_transports = []
992
if location is not None:
994
mergeable = bundle.read_mergeable_from_url(location,
995
possible_transports=possible_transports)
996
except errors.NotABundle:
999
stored_loc = branch_to.get_parent()
1000
if location is None:
1001
if stored_loc is None:
1002
raise errors.BzrCommandError("No pull location known or"
1005
display_url = urlutils.unescape_for_display(stored_loc,
1008
self.outf.write("Using saved parent location: %s\n" % display_url)
1009
location = stored_loc
1011
revision = _get_one_revision('pull', revision)
1012
if mergeable is not None:
1013
if revision is not None:
1014
raise errors.BzrCommandError(
1015
'Cannot use -r with merge directives or bundles')
1016
mergeable.install_revisions(branch_to.repository)
1017
base_revision_id, revision_id, verified = \
1018
mergeable.get_merge_request(branch_to.repository)
1019
branch_from = branch_to
1021
branch_from = Branch.open(location,
1022
possible_transports=possible_transports)
1023
self.add_cleanup(branch_from.lock_read().unlock)
1025
if branch_to.get_parent() is None or remember:
1026
branch_to.set_parent(branch_from.base)
1028
if revision is not None:
1029
revision_id = revision.as_revision_id(branch_from)
1031
if tree_to is not None:
1032
view_info = _get_view_info_for_change_reporter(tree_to)
1033
change_reporter = delta._ChangeReporter(
1034
unversioned_filter=tree_to.is_ignored,
1035
view_info=view_info)
1036
result = tree_to.pull(
1037
branch_from, overwrite, revision_id, change_reporter,
1038
possible_transports=possible_transports, local=local)
1040
result = branch_to.pull(
1041
branch_from, overwrite, revision_id, local=local)
1043
result.report(self.outf)
1044
if verbose and result.old_revid != result.new_revid:
1045
log.show_branch_change(
1046
branch_to, self.outf, result.old_revno,
1050
class cmd_push(Command):
1051
__doc__ = """Update a mirror of this branch.
1053
The target branch will not have its working tree populated because this
1054
is both expensive, and is not supported on remote file systems.
1056
Some smart servers or protocols *may* put the working tree in place in
1059
This command only works on branches that have not diverged. Branches are
1060
considered diverged if the destination branch's most recent commit is one
1061
that has not been merged (directly or indirectly) by the source branch.
1063
If branches have diverged, you can use 'bzr push --overwrite' to replace
1064
the other branch completely, discarding its unmerged changes.
1066
If you want to ensure you have the different changes in the other branch,
1067
do a merge (see bzr help merge) from the other branch, and commit that.
1068
After that you will be able to do a push without '--overwrite'.
1070
If there is no default push location set, the first push will set it.
1071
After that, you can omit the location to use the default. To change the
1072
default, use --remember. The value will only be saved if the remote
1073
location can be accessed.
1076
_see_also = ['pull', 'update', 'working-trees']
1077
takes_options = ['remember', 'overwrite', 'verbose', 'revision',
1078
Option('create-prefix',
1079
help='Create the path leading up to the branch '
1080
'if it does not already exist.'),
1081
custom_help('directory',
1082
help='Branch to push from, '
1083
'rather than the one containing the working directory.'),
1084
Option('use-existing-dir',
1085
help='By default push will fail if the target'
1086
' directory exists, but does not already'
1087
' have a control directory. This flag will'
1088
' allow push to proceed.'),
1090
help='Create a stacked branch that references the public location '
1091
'of the parent branch.'),
1092
Option('stacked-on',
1093
help='Create a stacked branch that refers to another branch '
1094
'for the commit history. Only the work not present in the '
1095
'referenced branch is included in the branch created.',
1098
help='Refuse to push if there are uncommitted changes in'
1099
' the working tree, --no-strict disables the check.'),
1101
takes_args = ['location?']
1102
encoding_type = 'replace'
1104
def run(self, location=None, remember=False, overwrite=False,
1105
create_prefix=False, verbose=False, revision=None,
1106
use_existing_dir=False, directory=None, stacked_on=None,
1107
stacked=False, strict=None):
1108
from bzrlib.push import _show_push_branch
1110
if directory is None:
1112
# Get the source branch
1114
_unused) = bzrdir.BzrDir.open_containing_tree_or_branch(directory)
1115
# Get the tip's revision_id
1116
revision = _get_one_revision('push', revision)
1117
if revision is not None:
1118
revision_id = revision.in_history(br_from).rev_id
1121
if tree is not None and revision_id is None:
1122
tree.check_changed_or_out_of_date(
1123
strict, 'push_strict',
1124
more_error='Use --no-strict to force the push.',
1125
more_warning='Uncommitted changes will not be pushed.')
1126
# Get the stacked_on branch, if any
1127
if stacked_on is not None:
1128
stacked_on = urlutils.normalize_url(stacked_on)
1130
parent_url = br_from.get_parent()
1132
parent = Branch.open(parent_url)
1133
stacked_on = parent.get_public_branch()
1135
# I considered excluding non-http url's here, thus forcing
1136
# 'public' branches only, but that only works for some
1137
# users, so it's best to just depend on the user spotting an
1138
# error by the feedback given to them. RBC 20080227.
1139
stacked_on = parent_url
1141
raise errors.BzrCommandError(
1142
"Could not determine branch to refer to.")
1144
# Get the destination location
1145
if location is None:
1146
stored_loc = br_from.get_push_location()
1147
if stored_loc is None:
1148
raise errors.BzrCommandError(
1149
"No push location known or specified.")
1151
display_url = urlutils.unescape_for_display(stored_loc,
1153
self.outf.write("Using saved push location: %s\n" % display_url)
1154
location = stored_loc
1156
_show_push_branch(br_from, revision_id, location, self.outf,
1157
verbose=verbose, overwrite=overwrite, remember=remember,
1158
stacked_on=stacked_on, create_prefix=create_prefix,
1159
use_existing_dir=use_existing_dir)
1162
class cmd_branch(Command):
1163
__doc__ = """Create a new branch that is a copy of an existing branch.
1165
If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
1166
be used. In other words, "branch ../foo/bar" will attempt to create ./bar.
1167
If the FROM_LOCATION has no / or path separator embedded, the TO_LOCATION
1168
is derived from the FROM_LOCATION by stripping a leading scheme or drive
1169
identifier, if any. For example, "branch lp:foo-bar" will attempt to
1172
To retrieve the branch as of a particular revision, supply the --revision
1173
parameter, as in "branch foo/bar -r 5".
1176
_see_also = ['checkout']
1177
takes_args = ['from_location', 'to_location?']
1178
takes_options = ['revision', Option('hardlink',
1179
help='Hard-link working tree files where possible.'),
1181
help="Create a branch without a working-tree."),
1183
help="Switch the checkout in the current directory "
1184
"to the new branch."),
1186
help='Create a stacked branch referring to the source branch. '
1187
'The new branch will depend on the availability of the source '
1188
'branch for all operations.'),
1189
Option('standalone',
1190
help='Do not use a shared repository, even if available.'),
1191
Option('use-existing-dir',
1192
help='By default branch will fail if the target'
1193
' directory exists, but does not already'
1194
' have a control directory. This flag will'
1195
' allow branch to proceed.'),
1197
help="Bind new branch to from location."),
1199
aliases = ['get', 'clone']
1201
def run(self, from_location, to_location=None, revision=None,
1202
hardlink=False, stacked=False, standalone=False, no_tree=False,
1203
use_existing_dir=False, switch=False, bind=False):
1204
from bzrlib import switch as _mod_switch
1205
from bzrlib.tag import _merge_tags_if_possible
1206
accelerator_tree, br_from = bzrdir.BzrDir.open_tree_or_branch(
1208
revision = _get_one_revision('branch', revision)
1209
self.add_cleanup(br_from.lock_read().unlock)
1210
if revision is not None:
1211
revision_id = revision.as_revision_id(br_from)
1213
# FIXME - wt.last_revision, fallback to branch, fall back to
1214
# None or perhaps NULL_REVISION to mean copy nothing
1216
revision_id = br_from.last_revision()
1217
if to_location is None:
1218
to_location = urlutils.derive_to_location(from_location)
1219
to_transport = transport.get_transport(to_location)
1221
to_transport.mkdir('.')
1222
except errors.FileExists:
1223
if not use_existing_dir:
1224
raise errors.BzrCommandError('Target directory "%s" '
1225
'already exists.' % to_location)
1228
bzrdir.BzrDir.open_from_transport(to_transport)
1229
except errors.NotBranchError:
1232
raise errors.AlreadyBranchError(to_location)
1233
except errors.NoSuchFile:
1234
raise errors.BzrCommandError('Parent of "%s" does not exist.'
1237
# preserve whatever source format we have.
1238
dir = br_from.bzrdir.sprout(to_transport.base, revision_id,
1239
possible_transports=[to_transport],
1240
accelerator_tree=accelerator_tree,
1241
hardlink=hardlink, stacked=stacked,
1242
force_new_repo=standalone,
1243
create_tree_if_local=not no_tree,
1244
source_branch=br_from)
1245
branch = dir.open_branch()
1246
except errors.NoSuchRevision:
1247
to_transport.delete_tree('.')
1248
msg = "The branch %s has no revision %s." % (from_location,
1250
raise errors.BzrCommandError(msg)
1251
_merge_tags_if_possible(br_from, branch)
1252
# If the source branch is stacked, the new branch may
1253
# be stacked whether we asked for that explicitly or not.
1254
# We therefore need a try/except here and not just 'if stacked:'
1256
note('Created new stacked branch referring to %s.' %
1257
branch.get_stacked_on_url())
1258
except (errors.NotStacked, errors.UnstackableBranchFormat,
1259
errors.UnstackableRepositoryFormat), e:
1260
note('Branched %d revision(s).' % branch.revno())
1262
# Bind to the parent
1263
parent_branch = Branch.open(from_location)
1264
branch.bind(parent_branch)
1265
note('New branch bound to %s' % from_location)
1267
# Switch to the new branch
1268
wt, _ = WorkingTree.open_containing('.')
1269
_mod_switch.switch(wt.bzrdir, branch)
1270
note('Switched to branch: %s',
1271
urlutils.unescape_for_display(branch.base, 'utf-8'))
1274
class cmd_checkout(Command):
1275
__doc__ = """Create a new checkout of an existing branch.
1277
If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
1278
the branch found in '.'. This is useful if you have removed the working tree
1279
or if it was never created - i.e. if you pushed the branch to its current
1280
location using SFTP.
1282
If the TO_LOCATION is omitted, the last component of the BRANCH_LOCATION will
1283
be used. In other words, "checkout ../foo/bar" will attempt to create ./bar.
1284
If the BRANCH_LOCATION has no / or path separator embedded, the TO_LOCATION
1285
is derived from the BRANCH_LOCATION by stripping a leading scheme or drive
1286
identifier, if any. For example, "checkout lp:foo-bar" will attempt to
1289
To retrieve the branch as of a particular revision, supply the --revision
1290
parameter, as in "checkout foo/bar -r 5". Note that this will be immediately
1291
out of date [so you cannot commit] but it may be useful (i.e. to examine old
1295
_see_also = ['checkouts', 'branch']
1296
takes_args = ['branch_location?', 'to_location?']
1297
takes_options = ['revision',
1298
Option('lightweight',
1299
help="Perform a lightweight checkout. Lightweight "
1300
"checkouts depend on access to the branch for "
1301
"every operation. Normal checkouts can perform "
1302
"common operations like diff and status without "
1303
"such access, and also support local commits."
1305
Option('files-from', type=str,
1306
help="Get file contents from this tree."),
1308
help='Hard-link working tree files where possible.'
1313
def run(self, branch_location=None, to_location=None, revision=None,
1314
lightweight=False, files_from=None, hardlink=False):
1315
if branch_location is None:
1316
branch_location = osutils.getcwd()
1317
to_location = branch_location
1318
accelerator_tree, source = bzrdir.BzrDir.open_tree_or_branch(
1320
revision = _get_one_revision('checkout', revision)
1321
if files_from is not None:
1322
accelerator_tree = WorkingTree.open(files_from)
1323
if revision is not None:
1324
revision_id = revision.as_revision_id(source)
1327
if to_location is None:
1328
to_location = urlutils.derive_to_location(branch_location)
1329
# if the source and to_location are the same,
1330
# and there is no working tree,
1331
# then reconstitute a branch
1332
if (osutils.abspath(to_location) ==
1333
osutils.abspath(branch_location)):
1335
source.bzrdir.open_workingtree()
1336
except errors.NoWorkingTree:
1337
source.bzrdir.create_workingtree(revision_id)
1339
source.create_checkout(to_location, revision_id, lightweight,
1340
accelerator_tree, hardlink)
1343
class cmd_renames(Command):
1344
__doc__ = """Show list of renamed files.
1346
# TODO: Option to show renames between two historical versions.
1348
# TODO: Only show renames under dir, rather than in the whole branch.
1349
_see_also = ['status']
1350
takes_args = ['dir?']
1353
def run(self, dir=u'.'):
1354
tree = WorkingTree.open_containing(dir)[0]
1355
self.add_cleanup(tree.lock_read().unlock)
1356
new_inv = tree.inventory
1357
old_tree = tree.basis_tree()
1358
self.add_cleanup(old_tree.lock_read().unlock)
1359
old_inv = old_tree.inventory
1361
iterator = tree.iter_changes(old_tree, include_unchanged=True)
1362
for f, paths, c, v, p, n, k, e in iterator:
1363
if paths[0] == paths[1]:
1367
renames.append(paths)
1369
for old_name, new_name in renames:
1370
self.outf.write("%s => %s\n" % (old_name, new_name))
1373
class cmd_update(Command):
1374
__doc__ = """Update a tree to have the latest code committed to its branch.
1376
This will perform a merge into the working tree, and may generate
1377
conflicts. If you have any local changes, you will still
1378
need to commit them after the update for the update to be complete.
1380
If you want to discard your local changes, you can just do a
1381
'bzr revert' instead of 'bzr commit' after the update.
1383
If the tree's branch is bound to a master branch, it will also update
1384
the branch from the master.
1387
_see_also = ['pull', 'working-trees', 'status-flags']
1388
takes_args = ['dir?']
1389
takes_options = ['revision']
1392
def run(self, dir='.', revision=None):
1393
if revision is not None and len(revision) != 1:
1394
raise errors.BzrCommandError(
1395
"bzr update --revision takes exactly one revision")
1396
tree = WorkingTree.open_containing(dir)[0]
1397
branch = tree.branch
1398
possible_transports = []
1399
master = branch.get_master_branch(
1400
possible_transports=possible_transports)
1401
if master is not None:
1402
branch_location = master.base
1405
branch_location = tree.branch.base
1406
tree.lock_tree_write()
1407
self.add_cleanup(tree.unlock)
1408
# get rid of the final '/' and be ready for display
1409
branch_location = urlutils.unescape_for_display(
1410
branch_location.rstrip('/'),
1412
existing_pending_merges = tree.get_parent_ids()[1:]
1416
# may need to fetch data into a heavyweight checkout
1417
# XXX: this may take some time, maybe we should display a
1419
old_tip = branch.update(possible_transports)
1420
if revision is not None:
1421
revision_id = revision[0].as_revision_id(branch)
1423
revision_id = branch.last_revision()
1424
if revision_id == _mod_revision.ensure_null(tree.last_revision()):
1425
revno = branch.revision_id_to_dotted_revno(revision_id)
1426
note("Tree is up to date at revision %s of branch %s" %
1427
('.'.join(map(str, revno)), branch_location))
1429
view_info = _get_view_info_for_change_reporter(tree)
1430
change_reporter = delta._ChangeReporter(
1431
unversioned_filter=tree.is_ignored,
1432
view_info=view_info)
1434
conflicts = tree.update(
1436
possible_transports=possible_transports,
1437
revision=revision_id,
1439
except errors.NoSuchRevision, e:
1440
raise errors.BzrCommandError(
1441
"branch has no revision %s\n"
1442
"bzr update --revision only works"
1443
" for a revision in the branch history"
1445
revno = tree.branch.revision_id_to_dotted_revno(
1446
_mod_revision.ensure_null(tree.last_revision()))
1447
note('Updated to revision %s of branch %s' %
1448
('.'.join(map(str, revno)), branch_location))
1449
parent_ids = tree.get_parent_ids()
1450
if parent_ids[1:] and parent_ids[1:] != existing_pending_merges:
1451
note('Your local commits will now show as pending merges with '
1452
"'bzr status', and can be committed with 'bzr commit'.")
1459
class cmd_info(Command):
1460
__doc__ = """Show information about a working tree, branch or repository.
1462
This command will show all known locations and formats associated to the
1463
tree, branch or repository.
1465
In verbose mode, statistical information is included with each report.
1466
To see extended statistic information, use a verbosity level of 2 or
1467
higher by specifying the verbose option multiple times, e.g. -vv.
1469
Branches and working trees will also report any missing revisions.
1473
Display information on the format and related locations:
1477
Display the above together with extended format information and
1478
basic statistics (like the number of files in the working tree and
1479
number of revisions in the branch and repository):
1483
Display the above together with number of committers to the branch:
1487
_see_also = ['revno', 'working-trees', 'repositories']
1488
takes_args = ['location?']
1489
takes_options = ['verbose']
1490
encoding_type = 'replace'
1493
def run(self, location=None, verbose=False):
1495
noise_level = get_verbosity_level()
1498
from bzrlib.info import show_bzrdir_info
1499
show_bzrdir_info(bzrdir.BzrDir.open_containing(location)[0],
1500
verbose=noise_level, outfile=self.outf)
1503
class cmd_remove(Command):
1504
__doc__ = """Remove files or directories.
1506
This makes bzr stop tracking changes to the specified files. bzr will delete
1507
them if they can easily be recovered using revert. If no options or
1508
parameters are given bzr will scan for files that are being tracked by bzr
1509
but missing in your tree and stop tracking them for you.
1511
takes_args = ['file*']
1512
takes_options = ['verbose',
1513
Option('new', help='Only remove files that have never been committed.'),
1514
RegistryOption.from_kwargs('file-deletion-strategy',
1515
'The file deletion mode to be used.',
1516
title='Deletion Strategy', value_switches=True, enum_switch=False,
1517
safe='Only delete files if they can be'
1518
' safely recovered (default).',
1519
keep='Delete from bzr but leave the working copy.',
1520
force='Delete all the specified files, even if they can not be '
1521
'recovered and even if they are non-empty directories.')]
1522
aliases = ['rm', 'del']
1523
encoding_type = 'replace'
1525
def run(self, file_list, verbose=False, new=False,
1526
file_deletion_strategy='safe'):
1527
tree, file_list = tree_files(file_list)
1529
if file_list is not None:
1530
file_list = [f for f in file_list]
1532
self.add_cleanup(tree.lock_write().unlock)
1533
# Heuristics should probably all move into tree.remove_smart or
1536
added = tree.changes_from(tree.basis_tree(),
1537
specific_files=file_list).added
1538
file_list = sorted([f[0] for f in added], reverse=True)
1539
if len(file_list) == 0:
1540
raise errors.BzrCommandError('No matching files.')
1541
elif file_list is None:
1542
# missing files show up in iter_changes(basis) as
1543
# versioned-with-no-kind.
1545
for change in tree.iter_changes(tree.basis_tree()):
1546
# Find paths in the working tree that have no kind:
1547
if change[1][1] is not None and change[6][1] is None:
1548
missing.append(change[1][1])
1549
file_list = sorted(missing, reverse=True)
1550
file_deletion_strategy = 'keep'
1551
tree.remove(file_list, verbose=verbose, to_file=self.outf,
1552
keep_files=file_deletion_strategy=='keep',
1553
force=file_deletion_strategy=='force')
1556
class cmd_file_id(Command):
1557
__doc__ = """Print file_id of a particular file or directory.
1559
The file_id is assigned when the file is first added and remains the
1560
same through all revisions where the file exists, even when it is
1565
_see_also = ['inventory', 'ls']
1566
takes_args = ['filename']
1569
def run(self, filename):
1570
tree, relpath = WorkingTree.open_containing(filename)
1571
i = tree.path2id(relpath)
1573
raise errors.NotVersionedError(filename)
1575
self.outf.write(i + '\n')
1578
class cmd_file_path(Command):
1579
__doc__ = """Print path of file_ids to a file or directory.
1581
This prints one line for each directory down to the target,
1582
starting at the branch root.
1586
takes_args = ['filename']
1589
def run(self, filename):
1590
tree, relpath = WorkingTree.open_containing(filename)
1591
fid = tree.path2id(relpath)
1593
raise errors.NotVersionedError(filename)
1594
segments = osutils.splitpath(relpath)
1595
for pos in range(1, len(segments) + 1):
1596
path = osutils.joinpath(segments[:pos])
1597
self.outf.write("%s\n" % tree.path2id(path))
1600
class cmd_reconcile(Command):
1601
__doc__ = """Reconcile bzr metadata in a branch.
1603
This can correct data mismatches that may have been caused by
1604
previous ghost operations or bzr upgrades. You should only
1605
need to run this command if 'bzr check' or a bzr developer
1606
advises you to run it.
1608
If a second branch is provided, cross-branch reconciliation is
1609
also attempted, which will check that data like the tree root
1610
id which was not present in very early bzr versions is represented
1611
correctly in both branches.
1613
At the same time it is run it may recompress data resulting in
1614
a potential saving in disk space or performance gain.
1616
The branch *MUST* be on a listable system such as local disk or sftp.
1619
_see_also = ['check']
1620
takes_args = ['branch?']
1622
def run(self, branch="."):
1623
from bzrlib.reconcile import reconcile
1624
dir = bzrdir.BzrDir.open(branch)
1628
class cmd_revision_history(Command):
1629
__doc__ = """Display the list of revision ids on a branch."""
1632
takes_args = ['location?']
1637
def run(self, location="."):
1638
branch = Branch.open_containing(location)[0]
1639
for revid in branch.revision_history():
1640
self.outf.write(revid)
1641
self.outf.write('\n')
1644
class cmd_ancestry(Command):
1645
__doc__ = """List all revisions merged into this branch."""
1647
_see_also = ['log', 'revision-history']
1648
takes_args = ['location?']
1653
def run(self, location="."):
1655
wt = WorkingTree.open_containing(location)[0]
1656
except errors.NoWorkingTree:
1657
b = Branch.open(location)
1658
last_revision = b.last_revision()
1661
last_revision = wt.last_revision()
1663
revision_ids = b.repository.get_ancestry(last_revision)
1665
for revision_id in revision_ids:
1666
self.outf.write(revision_id + '\n')
1669
class cmd_init(Command):
1670
__doc__ = """Make a directory into a versioned branch.
1672
Use this to create an empty branch, or before importing an
1675
If there is a repository in a parent directory of the location, then
1676
the history of the branch will be stored in the repository. Otherwise
1677
init creates a standalone branch which carries its own history
1678
in the .bzr directory.
1680
If there is already a branch at the location but it has no working tree,
1681
the tree can be populated with 'bzr checkout'.
1683
Recipe for importing a tree of files::
1689
bzr commit -m "imported project"
1692
_see_also = ['init-repository', 'branch', 'checkout']
1693
takes_args = ['location?']
1695
Option('create-prefix',
1696
help='Create the path leading up to the branch '
1697
'if it does not already exist.'),
1698
RegistryOption('format',
1699
help='Specify a format for this branch. '
1700
'See "help formats".',
1701
lazy_registry=('bzrlib.bzrdir', 'format_registry'),
1702
converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
1703
value_switches=True,
1704
title="Branch format",
1706
Option('append-revisions-only',
1707
help='Never change revnos or the existing log.'
1708
' Append revisions to it only.')
1710
def run(self, location=None, format=None, append_revisions_only=False,
1711
create_prefix=False):
1713
format = bzrdir.format_registry.make_bzrdir('default')
1714
if location is None:
1717
to_transport = transport.get_transport(location)
1719
# The path has to exist to initialize a
1720
# branch inside of it.
1721
# Just using os.mkdir, since I don't
1722
# believe that we want to create a bunch of
1723
# locations if the user supplies an extended path
1725
to_transport.ensure_base()
1726
except errors.NoSuchFile:
1727
if not create_prefix:
1728
raise errors.BzrCommandError("Parent directory of %s"
1730
"\nYou may supply --create-prefix to create all"
1731
" leading parent directories."
1733
to_transport.create_prefix()
1736
a_bzrdir = bzrdir.BzrDir.open_from_transport(to_transport)
1737
except errors.NotBranchError:
1738
# really a NotBzrDir error...
1739
create_branch = bzrdir.BzrDir.create_branch_convenience
1740
branch = create_branch(to_transport.base, format=format,
1741
possible_transports=[to_transport])
1742
a_bzrdir = branch.bzrdir
1744
from bzrlib.transport.local import LocalTransport
1745
if a_bzrdir.has_branch():
1746
if (isinstance(to_transport, LocalTransport)
1747
and not a_bzrdir.has_workingtree()):
1748
raise errors.BranchExistsWithoutWorkingTree(location)
1749
raise errors.AlreadyBranchError(location)
1750
branch = a_bzrdir.create_branch()
1751
a_bzrdir.create_workingtree()
1752
if append_revisions_only:
1754
branch.set_append_revisions_only(True)
1755
except errors.UpgradeRequired:
1756
raise errors.BzrCommandError('This branch format cannot be set'
1757
' to append-revisions-only. Try --default.')
1759
from bzrlib.info import describe_layout, describe_format
1761
tree = a_bzrdir.open_workingtree(recommend_upgrade=False)
1762
except (errors.NoWorkingTree, errors.NotLocalUrl):
1764
repository = branch.repository
1765
layout = describe_layout(repository, branch, tree).lower()
1766
format = describe_format(a_bzrdir, repository, branch, tree)
1767
self.outf.write("Created a %s (format: %s)\n" % (layout, format))
1768
if repository.is_shared():
1769
#XXX: maybe this can be refactored into transport.path_or_url()
1770
url = repository.bzrdir.root_transport.external_url()
1772
url = urlutils.local_path_from_url(url)
1773
except errors.InvalidURL:
1775
self.outf.write("Using shared repository: %s\n" % url)
1778
class cmd_init_repository(Command):
1779
__doc__ = """Create a shared repository for branches to share storage space.
1781
New branches created under the repository directory will store their
1782
revisions in the repository, not in the branch directory. For branches
1783
with shared history, this reduces the amount of storage needed and
1784
speeds up the creation of new branches.
1786
If the --no-trees option is given then the branches in the repository
1787
will not have working trees by default. They will still exist as
1788
directories on disk, but they will not have separate copies of the
1789
files at a certain revision. This can be useful for repositories that
1790
store branches which are interacted with through checkouts or remote
1791
branches, such as on a server.
1794
Create a shared repository holding just branches::
1796
bzr init-repo --no-trees repo
1799
Make a lightweight checkout elsewhere::
1801
bzr checkout --lightweight repo/trunk trunk-checkout
1806
_see_also = ['init', 'branch', 'checkout', 'repositories']
1807
takes_args = ["location"]
1808
takes_options = [RegistryOption('format',
1809
help='Specify a format for this repository. See'
1810
' "bzr help formats" for details.',
1811
lazy_registry=('bzrlib.bzrdir', 'format_registry'),
1812
converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
1813
value_switches=True, title='Repository format'),
1815
help='Branches in the repository will default to'
1816
' not having a working tree.'),
1818
aliases = ["init-repo"]
1820
def run(self, location, format=None, no_trees=False):
1822
format = bzrdir.format_registry.make_bzrdir('default')
1824
if location is None:
1827
to_transport = transport.get_transport(location)
1828
to_transport.ensure_base()
1830
newdir = format.initialize_on_transport(to_transport)
1831
repo = newdir.create_repository(shared=True)
1832
repo.set_make_working_trees(not no_trees)
1834
from bzrlib.info import show_bzrdir_info
1835
show_bzrdir_info(repo.bzrdir, verbose=0, outfile=self.outf)
1838
class cmd_diff(Command):
1839
__doc__ = """Show differences in the working tree, between revisions or branches.
1841
If no arguments are given, all changes for the current tree are listed.
1842
If files are given, only the changes in those files are listed.
1843
Remote and multiple branches can be compared by using the --old and
1844
--new options. If not provided, the default for both is derived from
1845
the first argument, if any, or the current tree if no arguments are
1848
"bzr diff -p1" is equivalent to "bzr diff --prefix old/:new/", and
1849
produces patches suitable for "patch -p1".
1853
2 - unrepresentable changes
1858
Shows the difference in the working tree versus the last commit::
1862
Difference between the working tree and revision 1::
1866
Difference between revision 3 and revision 1::
1870
Difference between revision 3 and revision 1 for branch xxx::
1874
To see the changes introduced in revision X::
1878
Note that in the case of a merge, the -c option shows the changes
1879
compared to the left hand parent. To see the changes against
1880
another parent, use::
1882
bzr diff -r<chosen_parent>..X
1884
The changes introduced by revision 2 (equivalent to -r1..2)::
1888
Show just the differences for file NEWS::
1892
Show the differences in working tree xxx for file NEWS::
1896
Show the differences from branch xxx to this working tree:
1900
Show the differences between two branches for file NEWS::
1902
bzr diff --old xxx --new yyy NEWS
1904
Same as 'bzr diff' but prefix paths with old/ and new/::
1906
bzr diff --prefix old/:new/
1908
_see_also = ['status']
1909
takes_args = ['file*']
1911
Option('diff-options', type=str,
1912
help='Pass these options to the external diff program.'),
1913
Option('prefix', type=str,
1915
help='Set prefixes added to old and new filenames, as '
1916
'two values separated by a colon. (eg "old/:new/").'),
1918
help='Branch/tree to compare from.',
1922
help='Branch/tree to compare to.',
1928
help='Use this command to compare files.',
1931
RegistryOption('format',
1932
help='Diff format to use.',
1933
lazy_registry=('bzrlib.diff', 'format_registry'),
1934
value_switches=False, title='Diff format'),
1936
aliases = ['di', 'dif']
1937
encoding_type = 'exact'
1940
def run(self, revision=None, file_list=None, diff_options=None,
1941
prefix=None, old=None, new=None, using=None, format=None):
1942
from bzrlib.diff import (get_trees_and_branches_to_diff_locked,
1945
if (prefix is None) or (prefix == '0'):
1953
old_label, new_label = prefix.split(":")
1955
raise errors.BzrCommandError(
1956
'--prefix expects two values separated by a colon'
1957
' (eg "old/:new/")')
1959
if revision and len(revision) > 2:
1960
raise errors.BzrCommandError('bzr diff --revision takes exactly'
1961
' one or two revision specifiers')
1963
if using is not None and format is not None:
1964
raise errors.BzrCommandError('--using and --format are mutually '
1967
(old_tree, new_tree,
1968
old_branch, new_branch,
1969
specific_files, extra_trees) = get_trees_and_branches_to_diff_locked(
1970
file_list, revision, old, new, self.add_cleanup, apply_view=True)
1971
return show_diff_trees(old_tree, new_tree, sys.stdout,
1972
specific_files=specific_files,
1973
external_diff_options=diff_options,
1974
old_label=old_label, new_label=new_label,
1975
extra_trees=extra_trees, using=using,
1979
class cmd_deleted(Command):
1980
__doc__ = """List files deleted in the working tree.
1982
# TODO: Show files deleted since a previous revision, or
1983
# between two revisions.
1984
# TODO: Much more efficient way to do this: read in new
1985
# directories with readdir, rather than stating each one. Same
1986
# level of effort but possibly much less IO. (Or possibly not,
1987
# if the directories are very large...)
1988
_see_also = ['status', 'ls']
1989
takes_options = ['directory', 'show-ids']
1992
def run(self, show_ids=False, directory=u'.'):
1993
tree = WorkingTree.open_containing(directory)[0]
1994
self.add_cleanup(tree.lock_read().unlock)
1995
old = tree.basis_tree()
1996
self.add_cleanup(old.lock_read().unlock)
1997
for path, ie in old.inventory.iter_entries():
1998
if not tree.has_id(ie.file_id):
1999
self.outf.write(path)
2001
self.outf.write(' ')
2002
self.outf.write(ie.file_id)
2003
self.outf.write('\n')
2006
class cmd_modified(Command):
2007
__doc__ = """List files modified in working tree.
2011
_see_also = ['status', 'ls']
2012
takes_options = ['directory', 'null']
2015
def run(self, null=False, directory=u'.'):
2016
tree = WorkingTree.open_containing(directory)[0]
2017
td = tree.changes_from(tree.basis_tree())
2018
for path, id, kind, text_modified, meta_modified in td.modified:
2020
self.outf.write(path + '\0')
2022
self.outf.write(osutils.quotefn(path) + '\n')
2025
class cmd_added(Command):
2026
__doc__ = """List files added in working tree.
2030
_see_also = ['status', 'ls']
2031
takes_options = ['directory', 'null']
2034
def run(self, null=False, directory=u'.'):
2035
wt = WorkingTree.open_containing(directory)[0]
2036
self.add_cleanup(wt.lock_read().unlock)
2037
basis = wt.basis_tree()
2038
self.add_cleanup(basis.lock_read().unlock)
2039
basis_inv = basis.inventory
2042
if file_id in basis_inv:
2044
if inv.is_root(file_id) and len(basis_inv) == 0:
2046
path = inv.id2path(file_id)
2047
if not os.access(osutils.pathjoin(wt.basedir, path), os.F_OK):
2050
self.outf.write(path + '\0')
2052
self.outf.write(osutils.quotefn(path) + '\n')
2055
class cmd_root(Command):
2056
__doc__ = """Show the tree root directory.
2058
The root is the nearest enclosing directory with a .bzr control
2061
takes_args = ['filename?']
2063
def run(self, filename=None):
2064
"""Print the branch root."""
2065
tree = WorkingTree.open_containing(filename)[0]
2066
self.outf.write(tree.basedir + '\n')
2069
def _parse_limit(limitstring):
2071
return int(limitstring)
2073
msg = "The limit argument must be an integer."
2074
raise errors.BzrCommandError(msg)
2077
def _parse_levels(s):
2081
msg = "The levels argument must be an integer."
2082
raise errors.BzrCommandError(msg)
2085
class cmd_log(Command):
2086
__doc__ = """Show historical log for a branch or subset of a branch.
2088
log is bzr's default tool for exploring the history of a branch.
2089
The branch to use is taken from the first parameter. If no parameters
2090
are given, the branch containing the working directory is logged.
2091
Here are some simple examples::
2093
bzr log log the current branch
2094
bzr log foo.py log a file in its branch
2095
bzr log http://server/branch log a branch on a server
2097
The filtering, ordering and information shown for each revision can
2098
be controlled as explained below. By default, all revisions are
2099
shown sorted (topologically) so that newer revisions appear before
2100
older ones and descendants always appear before ancestors. If displayed,
2101
merged revisions are shown indented under the revision in which they
2106
The log format controls how information about each revision is
2107
displayed. The standard log formats are called ``long``, ``short``
2108
and ``line``. The default is long. See ``bzr help log-formats``
2109
for more details on log formats.
2111
The following options can be used to control what information is
2114
-l N display a maximum of N revisions
2115
-n N display N levels of revisions (0 for all, 1 for collapsed)
2116
-v display a status summary (delta) for each revision
2117
-p display a diff (patch) for each revision
2118
--show-ids display revision-ids (and file-ids), not just revnos
2120
Note that the default number of levels to display is a function of the
2121
log format. If the -n option is not used, the standard log formats show
2122
just the top level (mainline).
2124
Status summaries are shown using status flags like A, M, etc. To see
2125
the changes explained using words like ``added`` and ``modified``
2126
instead, use the -vv option.
2130
To display revisions from oldest to newest, use the --forward option.
2131
In most cases, using this option will have little impact on the total
2132
time taken to produce a log, though --forward does not incrementally
2133
display revisions like --reverse does when it can.
2135
:Revision filtering:
2137
The -r option can be used to specify what revision or range of revisions
2138
to filter against. The various forms are shown below::
2140
-rX display revision X
2141
-rX.. display revision X and later
2142
-r..Y display up to and including revision Y
2143
-rX..Y display from X to Y inclusive
2145
See ``bzr help revisionspec`` for details on how to specify X and Y.
2146
Some common examples are given below::
2148
-r-1 show just the tip
2149
-r-10.. show the last 10 mainline revisions
2150
-rsubmit:.. show what's new on this branch
2151
-rancestor:path.. show changes since the common ancestor of this
2152
branch and the one at location path
2153
-rdate:yesterday.. show changes since yesterday
2155
When logging a range of revisions using -rX..Y, log starts at
2156
revision Y and searches back in history through the primary
2157
("left-hand") parents until it finds X. When logging just the
2158
top level (using -n1), an error is reported if X is not found
2159
along the way. If multi-level logging is used (-n0), X may be
2160
a nested merge revision and the log will be truncated accordingly.
2164
If parameters are given and the first one is not a branch, the log
2165
will be filtered to show only those revisions that changed the
2166
nominated files or directories.
2168
Filenames are interpreted within their historical context. To log a
2169
deleted file, specify a revision range so that the file existed at
2170
the end or start of the range.
2172
Historical context is also important when interpreting pathnames of
2173
renamed files/directories. Consider the following example:
2175
* revision 1: add tutorial.txt
2176
* revision 2: modify tutorial.txt
2177
* revision 3: rename tutorial.txt to guide.txt; add tutorial.txt
2181
* ``bzr log guide.txt`` will log the file added in revision 1
2183
* ``bzr log tutorial.txt`` will log the new file added in revision 3
2185
* ``bzr log -r2 -p tutorial.txt`` will show the changes made to
2186
the original file in revision 2.
2188
* ``bzr log -r2 -p guide.txt`` will display an error message as there
2189
was no file called guide.txt in revision 2.
2191
Renames are always followed by log. By design, there is no need to
2192
explicitly ask for this (and no way to stop logging a file back
2193
until it was last renamed).
2197
The --message option can be used for finding revisions that match a
2198
regular expression in a commit message.
2202
GUI tools and IDEs are often better at exploring history than command
2203
line tools: you may prefer qlog or viz from qbzr or bzr-gtk, the
2204
bzr-explorer shell, or the Loggerhead web interface. See the Plugin
2205
Guide <http://doc.bazaar.canonical.com/plugins/en/> and
2206
<http://wiki.bazaar.canonical.com/IDEIntegration>.
2208
You may find it useful to add the aliases below to ``bazaar.conf``::
2212
top = log -l10 --line
2215
``bzr tip`` will then show the latest revision while ``bzr top``
2216
will show the last 10 mainline revisions. To see the details of a
2217
particular revision X, ``bzr show -rX``.
2219
If you are interested in looking deeper into a particular merge X,
2220
use ``bzr log -n0 -rX``.
2222
``bzr log -v`` on a branch with lots of history is currently
2223
very slow. A fix for this issue is currently under development.
2224
With or without that fix, it is recommended that a revision range
2225
be given when using the -v option.
2227
bzr has a generic full-text matching plugin, bzr-search, that can be
2228
used to find revisions matching user names, commit messages, etc.
2229
Among other features, this plugin can find all revisions containing
2230
a list of words but not others.
2232
When exploring non-mainline history on large projects with deep
2233
history, the performance of log can be greatly improved by installing
2234
the historycache plugin. This plugin buffers historical information
2235
trading disk space for faster speed.
2237
takes_args = ['file*']
2238
_see_also = ['log-formats', 'revisionspec']
2241
help='Show from oldest to newest.'),
2243
custom_help('verbose',
2244
help='Show files changed in each revision.'),
2248
type=bzrlib.option._parse_revision_str,
2250
help='Show just the specified revision.'
2251
' See also "help revisionspec".'),
2253
RegistryOption('authors',
2254
'What names to list as authors - first, all or committer.',
2256
lazy_registry=('bzrlib.log', 'author_list_registry'),
2260
help='Number of levels to display - 0 for all, 1 for flat.',
2262
type=_parse_levels),
2265
help='Show revisions whose message matches this '
2266
'regular expression.',
2270
help='Limit the output to the first N revisions.',
2275
help='Show changes made in each revision as a patch.'),
2276
Option('include-merges',
2277
help='Show merged revisions like --levels 0 does.'),
2278
Option('exclude-common-ancestry',
2279
help='Display only the revisions that are not part'
2280
' of both ancestries (require -rX..Y)'
2283
encoding_type = 'replace'
2286
def run(self, file_list=None, timezone='original',
2297
include_merges=False,
2299
exclude_common_ancestry=False,
2301
from bzrlib.log import (
2303
make_log_request_dict,
2304
_get_info_for_log_files,
2306
direction = (forward and 'forward') or 'reverse'
2307
if (exclude_common_ancestry
2308
and (revision is None or len(revision) != 2)):
2309
raise errors.BzrCommandError(
2310
'--exclude-common-ancestry requires -r with two revisions')
2315
raise errors.BzrCommandError(
2316
'--levels and --include-merges are mutually exclusive')
2318
if change is not None:
2320
raise errors.RangeInChangeOption()
2321
if revision is not None:
2322
raise errors.BzrCommandError(
2323
'--revision and --change are mutually exclusive')
2328
filter_by_dir = False
2330
# find the file ids to log and check for directory filtering
2331
b, file_info_list, rev1, rev2 = _get_info_for_log_files(
2332
revision, file_list, self.add_cleanup)
2333
for relpath, file_id, kind in file_info_list:
2335
raise errors.BzrCommandError(
2336
"Path unknown at end or start of revision range: %s" %
2338
# If the relpath is the top of the tree, we log everything
2343
file_ids.append(file_id)
2344
filter_by_dir = filter_by_dir or (
2345
kind in ['directory', 'tree-reference'])
2348
# FIXME ? log the current subdir only RBC 20060203
2349
if revision is not None \
2350
and len(revision) > 0 and revision[0].get_branch():
2351
location = revision[0].get_branch()
2354
dir, relpath = bzrdir.BzrDir.open_containing(location)
2355
b = dir.open_branch()
2356
self.add_cleanup(b.lock_read().unlock)
2357
rev1, rev2 = _get_revision_range(revision, b, self.name())
2359
# Decide on the type of delta & diff filtering to use
2360
# TODO: add an --all-files option to make this configurable & consistent
2368
diff_type = 'partial'
2372
# Build the log formatter
2373
if log_format is None:
2374
log_format = log.log_formatter_registry.get_default(b)
2375
# Make a non-encoding output to include the diffs - bug 328007
2376
unencoded_output = ui.ui_factory.make_output_stream(encoding_type='exact')
2377
lf = log_format(show_ids=show_ids, to_file=self.outf,
2378
to_exact_file=unencoded_output,
2379
show_timezone=timezone,
2380
delta_format=get_verbosity_level(),
2382
show_advice=levels is None,
2383
author_list_handler=authors)
2385
# Choose the algorithm for doing the logging. It's annoying
2386
# having multiple code paths like this but necessary until
2387
# the underlying repository format is faster at generating
2388
# deltas or can provide everything we need from the indices.
2389
# The default algorithm - match-using-deltas - works for
2390
# multiple files and directories and is faster for small
2391
# amounts of history (200 revisions say). However, it's too
2392
# slow for logging a single file in a repository with deep
2393
# history, i.e. > 10K revisions. In the spirit of "do no
2394
# evil when adding features", we continue to use the
2395
# original algorithm - per-file-graph - for the "single
2396
# file that isn't a directory without showing a delta" case.
2397
partial_history = revision and b.repository._format.supports_chks
2398
match_using_deltas = (len(file_ids) != 1 or filter_by_dir
2399
or delta_type or partial_history)
2401
# Build the LogRequest and execute it
2402
if len(file_ids) == 0:
2404
rqst = make_log_request_dict(
2405
direction=direction, specific_fileids=file_ids,
2406
start_revision=rev1, end_revision=rev2, limit=limit,
2407
message_search=message, delta_type=delta_type,
2408
diff_type=diff_type, _match_using_deltas=match_using_deltas,
2409
exclude_common_ancestry=exclude_common_ancestry,
2411
Logger(b, rqst).show(lf)
2414
def _get_revision_range(revisionspec_list, branch, command_name):
2415
"""Take the input of a revision option and turn it into a revision range.
2417
It returns RevisionInfo objects which can be used to obtain the rev_id's
2418
of the desired revisions. It does some user input validations.
2420
if revisionspec_list is None:
2423
elif len(revisionspec_list) == 1:
2424
rev1 = rev2 = revisionspec_list[0].in_history(branch)
2425
elif len(revisionspec_list) == 2:
2426
start_spec = revisionspec_list[0]
2427
end_spec = revisionspec_list[1]
2428
if end_spec.get_branch() != start_spec.get_branch():
2429
# b is taken from revision[0].get_branch(), and
2430
# show_log will use its revision_history. Having
2431
# different branches will lead to weird behaviors.
2432
raise errors.BzrCommandError(
2433
"bzr %s doesn't accept two revisions in different"
2434
" branches." % command_name)
2435
if start_spec.spec is None:
2436
# Avoid loading all the history.
2437
rev1 = RevisionInfo(branch, None, None)
2439
rev1 = start_spec.in_history(branch)
2440
# Avoid loading all of history when we know a missing
2441
# end of range means the last revision ...
2442
if end_spec.spec is None:
2443
last_revno, last_revision_id = branch.last_revision_info()
2444
rev2 = RevisionInfo(branch, last_revno, last_revision_id)
2446
rev2 = end_spec.in_history(branch)
2448
raise errors.BzrCommandError(
2449
'bzr %s --revision takes one or two values.' % command_name)
2453
def _revision_range_to_revid_range(revision_range):
2456
if revision_range[0] is not None:
2457
rev_id1 = revision_range[0].rev_id
2458
if revision_range[1] is not None:
2459
rev_id2 = revision_range[1].rev_id
2460
return rev_id1, rev_id2
2462
def get_log_format(long=False, short=False, line=False, default='long'):
2463
log_format = default
2467
log_format = 'short'
2473
class cmd_touching_revisions(Command):
2474
__doc__ = """Return revision-ids which affected a particular file.
2476
A more user-friendly interface is "bzr log FILE".
2480
takes_args = ["filename"]
2483
def run(self, filename):
2484
tree, relpath = WorkingTree.open_containing(filename)
2485
file_id = tree.path2id(relpath)
2487
self.add_cleanup(b.lock_read().unlock)
2488
touching_revs = log.find_touching_revisions(b, file_id)
2489
for revno, revision_id, what in touching_revs:
2490
self.outf.write("%6d %s\n" % (revno, what))
2493
class cmd_ls(Command):
2494
__doc__ = """List files in a tree.
2497
_see_also = ['status', 'cat']
2498
takes_args = ['path?']
2502
Option('recursive', short_name='R',
2503
help='Recurse into subdirectories.'),
2505
help='Print paths relative to the root of the branch.'),
2506
Option('unknown', short_name='u',
2507
help='Print unknown files.'),
2508
Option('versioned', help='Print versioned files.',
2510
Option('ignored', short_name='i',
2511
help='Print ignored files.'),
2512
Option('kind', short_name='k',
2513
help='List entries of a particular kind: file, directory, symlink.',
2520
def run(self, revision=None, verbose=False,
2521
recursive=False, from_root=False,
2522
unknown=False, versioned=False, ignored=False,
2523
null=False, kind=None, show_ids=False, path=None, directory=None):
2525
if kind and kind not in ('file', 'directory', 'symlink'):
2526
raise errors.BzrCommandError('invalid kind specified')
2528
if verbose and null:
2529
raise errors.BzrCommandError('Cannot set both --verbose and --null')
2530
all = not (unknown or versioned or ignored)
2532
selection = {'I':ignored, '?':unknown, 'V':versioned}
2538
raise errors.BzrCommandError('cannot specify both --from-root'
2541
tree, branch, relpath = \
2542
_open_directory_or_containing_tree_or_branch(fs_path, directory)
2544
# Calculate the prefix to use
2548
prefix = relpath + '/'
2549
elif fs_path != '.' and not fs_path.endswith('/'):
2550
prefix = fs_path + '/'
2552
if revision is not None or tree is None:
2553
tree = _get_one_revision_tree('ls', revision, branch=branch)
2556
if isinstance(tree, WorkingTree) and tree.supports_views():
2557
view_files = tree.views.lookup_view()
2560
view_str = views.view_display_str(view_files)
2561
note("Ignoring files outside view. View is %s" % view_str)
2563
self.add_cleanup(tree.lock_read().unlock)
2564
for fp, fc, fkind, fid, entry in tree.list_files(include_root=False,
2565
from_dir=relpath, recursive=recursive):
2566
# Apply additional masking
2567
if not all and not selection[fc]:
2569
if kind is not None and fkind != kind:
2574
fullpath = osutils.pathjoin(relpath, fp)
2577
views.check_path_in_view(tree, fullpath)
2578
except errors.FileOutsideView:
2583
fp = osutils.pathjoin(prefix, fp)
2584
kindch = entry.kind_character()
2585
outstring = fp + kindch
2586
ui.ui_factory.clear_term()
2588
outstring = '%-8s %s' % (fc, outstring)
2589
if show_ids and fid is not None:
2590
outstring = "%-50s %s" % (outstring, fid)
2591
self.outf.write(outstring + '\n')
2593
self.outf.write(fp + '\0')
2596
self.outf.write(fid)
2597
self.outf.write('\0')
2605
self.outf.write('%-50s %s\n' % (outstring, my_id))
2607
self.outf.write(outstring + '\n')
2610
class cmd_unknowns(Command):
2611
__doc__ = """List unknown files.
2616
takes_options = ['directory']
2619
def run(self, directory=u'.'):
2620
for f in WorkingTree.open_containing(directory)[0].unknowns():
2621
self.outf.write(osutils.quotefn(f) + '\n')
2624
class cmd_ignore(Command):
2625
__doc__ = """Ignore specified files or patterns.
2627
See ``bzr help patterns`` for details on the syntax of patterns.
2629
If a .bzrignore file does not exist, the ignore command
2630
will create one and add the specified files or patterns to the newly
2631
created file. The ignore command will also automatically add the
2632
.bzrignore file to be versioned. Creating a .bzrignore file without
2633
the use of the ignore command will require an explicit add command.
2635
To remove patterns from the ignore list, edit the .bzrignore file.
2636
After adding, editing or deleting that file either indirectly by
2637
using this command or directly by using an editor, be sure to commit
2640
Bazaar also supports a global ignore file ~/.bazaar/ignore. On Windows
2641
the global ignore file can be found in the application data directory as
2642
C:\\Documents and Settings\\<user>\\Application Data\\Bazaar\\2.0\\ignore.
2643
Global ignores are not touched by this command. The global ignore file
2644
can be edited directly using an editor.
2646
Patterns prefixed with '!' are exceptions to ignore patterns and take
2647
precedence over regular ignores. Such exceptions are used to specify
2648
files that should be versioned which would otherwise be ignored.
2650
Patterns prefixed with '!!' act as regular ignore patterns, but have
2651
precedence over the '!' exception patterns.
2653
Note: ignore patterns containing shell wildcards must be quoted from
2657
Ignore the top level Makefile::
2659
bzr ignore ./Makefile
2661
Ignore .class files in all directories...::
2663
bzr ignore "*.class"
2665
...but do not ignore "special.class"::
2667
bzr ignore "!special.class"
2669
Ignore .o files under the lib directory::
2671
bzr ignore "lib/**/*.o"
2673
Ignore .o files under the lib directory::
2675
bzr ignore "RE:lib/.*\.o"
2677
Ignore everything but the "debian" toplevel directory::
2679
bzr ignore "RE:(?!debian/).*"
2681
Ignore everything except the "local" toplevel directory,
2682
but always ignore "*~" autosave files, even under local/::
2685
bzr ignore "!./local"
2689
_see_also = ['status', 'ignored', 'patterns']
2690
takes_args = ['name_pattern*']
2691
takes_options = ['directory',
2692
Option('default-rules',
2693
help='Display the default ignore rules that bzr uses.')
2696
def run(self, name_pattern_list=None, default_rules=None,
2698
from bzrlib import ignores
2699
if default_rules is not None:
2700
# dump the default rules and exit
2701
for pattern in ignores.USER_DEFAULTS:
2702
self.outf.write("%s\n" % pattern)
2704
if not name_pattern_list:
2705
raise errors.BzrCommandError("ignore requires at least one "
2706
"NAME_PATTERN or --default-rules.")
2707
name_pattern_list = [globbing.normalize_pattern(p)
2708
for p in name_pattern_list]
2709
for name_pattern in name_pattern_list:
2710
if (name_pattern[0] == '/' or
2711
(len(name_pattern) > 1 and name_pattern[1] == ':')):
2712
raise errors.BzrCommandError(
2713
"NAME_PATTERN should not be an absolute path")
2714
tree, relpath = WorkingTree.open_containing(directory)
2715
ignores.tree_ignores_add_patterns(tree, name_pattern_list)
2716
ignored = globbing.Globster(name_pattern_list)
2719
for entry in tree.list_files():
2723
if ignored.match(filename):
2724
matches.append(filename)
2726
if len(matches) > 0:
2727
self.outf.write("Warning: the following files are version controlled and"
2728
" match your ignore pattern:\n%s"
2729
"\nThese files will continue to be version controlled"
2730
" unless you 'bzr remove' them.\n" % ("\n".join(matches),))
2733
class cmd_ignored(Command):
2734
__doc__ = """List ignored files and the patterns that matched them.
2736
List all the ignored files and the ignore pattern that caused the file to
2739
Alternatively, to list just the files::
2744
encoding_type = 'replace'
2745
_see_also = ['ignore', 'ls']
2746
takes_options = ['directory']
2749
def run(self, directory=u'.'):
2750
tree = WorkingTree.open_containing(directory)[0]
2751
self.add_cleanup(tree.lock_read().unlock)
2752
for path, file_class, kind, file_id, entry in tree.list_files():
2753
if file_class != 'I':
2755
## XXX: Slightly inefficient since this was already calculated
2756
pat = tree.is_ignored(path)
2757
self.outf.write('%-50s %s\n' % (path, pat))
2760
class cmd_lookup_revision(Command):
2761
__doc__ = """Lookup the revision-id from a revision-number
2764
bzr lookup-revision 33
2767
takes_args = ['revno']
2768
takes_options = ['directory']
2771
def run(self, revno, directory=u'.'):
2775
raise errors.BzrCommandError("not a valid revision-number: %r"
2777
revid = WorkingTree.open_containing(directory)[0].branch.get_rev_id(revno)
2778
self.outf.write("%s\n" % revid)
2781
class cmd_export(Command):
2782
__doc__ = """Export current or past revision to a destination directory or archive.
2784
If no revision is specified this exports the last committed revision.
2786
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
2787
given, try to find the format with the extension. If no extension
2788
is found exports to a directory (equivalent to --format=dir).
2790
If root is supplied, it will be used as the root directory inside
2791
container formats (tar, zip, etc). If it is not supplied it will default
2792
to the exported filename. The root option has no effect for 'dir' format.
2794
If branch is omitted then the branch containing the current working
2795
directory will be used.
2797
Note: Export of tree with non-ASCII filenames to zip is not supported.
2799
================= =========================
2800
Supported formats Autodetected by extension
2801
================= =========================
2804
tbz2 .tar.bz2, .tbz2
2807
================= =========================
2809
takes_args = ['dest', 'branch_or_subdir?']
2810
takes_options = ['directory',
2812
help="Type of file to export to.",
2815
Option('filters', help='Apply content filters to export the '
2816
'convenient form.'),
2819
help="Name of the root directory inside the exported file."),
2820
Option('per-file-timestamps',
2821
help='Set modification time of files to that of the last '
2822
'revision in which it was changed.'),
2824
def run(self, dest, branch_or_subdir=None, revision=None, format=None,
2825
root=None, filters=False, per_file_timestamps=False, directory=u'.'):
2826
from bzrlib.export import export
2828
if branch_or_subdir is None:
2829
tree = WorkingTree.open_containing(directory)[0]
2833
b, subdir = Branch.open_containing(branch_or_subdir)
2836
rev_tree = _get_one_revision_tree('export', revision, branch=b, tree=tree)
2838
export(rev_tree, dest, format, root, subdir, filtered=filters,
2839
per_file_timestamps=per_file_timestamps)
2840
except errors.NoSuchExportFormat, e:
2841
raise errors.BzrCommandError('Unsupported export format: %s' % e.format)
2844
class cmd_cat(Command):
2845
__doc__ = """Write the contents of a file as of a given revision to standard output.
2847
If no revision is nominated, the last revision is used.
2849
Note: Take care to redirect standard output when using this command on a
2854
takes_options = ['directory',
2855
Option('name-from-revision', help='The path name in the old tree.'),
2856
Option('filters', help='Apply content filters to display the '
2857
'convenience form.'),
2860
takes_args = ['filename']
2861
encoding_type = 'exact'
2864
def run(self, filename, revision=None, name_from_revision=False,
2865
filters=False, directory=None):
2866
if revision is not None and len(revision) != 1:
2867
raise errors.BzrCommandError("bzr cat --revision takes exactly"
2868
" one revision specifier")
2869
tree, branch, relpath = \
2870
_open_directory_or_containing_tree_or_branch(filename, directory)
2871
self.add_cleanup(branch.lock_read().unlock)
2872
return self._run(tree, branch, relpath, filename, revision,
2873
name_from_revision, filters)
2875
def _run(self, tree, b, relpath, filename, revision, name_from_revision,
2878
tree = b.basis_tree()
2879
rev_tree = _get_one_revision_tree('cat', revision, branch=b)
2880
self.add_cleanup(rev_tree.lock_read().unlock)
2882
old_file_id = rev_tree.path2id(relpath)
2884
if name_from_revision:
2885
# Try in revision if requested
2886
if old_file_id is None:
2887
raise errors.BzrCommandError(
2888
"%r is not present in revision %s" % (
2889
filename, rev_tree.get_revision_id()))
2891
content = rev_tree.get_file_text(old_file_id)
2893
cur_file_id = tree.path2id(relpath)
2895
if cur_file_id is not None:
2896
# Then try with the actual file id
2898
content = rev_tree.get_file_text(cur_file_id)
2900
except errors.NoSuchId:
2901
# The actual file id didn't exist at that time
2903
if not found and old_file_id is not None:
2904
# Finally try with the old file id
2905
content = rev_tree.get_file_text(old_file_id)
2908
# Can't be found anywhere
2909
raise errors.BzrCommandError(
2910
"%r is not present in revision %s" % (
2911
filename, rev_tree.get_revision_id()))
2913
from bzrlib.filters import (
2914
ContentFilterContext,
2915
filtered_output_bytes,
2917
filters = rev_tree._content_filter_stack(relpath)
2918
chunks = content.splitlines(True)
2919
content = filtered_output_bytes(chunks, filters,
2920
ContentFilterContext(relpath, rev_tree))
2922
self.outf.writelines(content)
2925
self.outf.write(content)
2928
class cmd_local_time_offset(Command):
2929
__doc__ = """Show the offset in seconds from GMT to local time."""
2933
self.outf.write("%s\n" % osutils.local_time_offset())
2937
class cmd_commit(Command):
2938
__doc__ = """Commit changes into a new revision.
2940
An explanatory message needs to be given for each commit. This is
2941
often done by using the --message option (getting the message from the
2942
command line) or by using the --file option (getting the message from
2943
a file). If neither of these options is given, an editor is opened for
2944
the user to enter the message. To see the changed files in the
2945
boilerplate text loaded into the editor, use the --show-diff option.
2947
By default, the entire tree is committed and the person doing the
2948
commit is assumed to be the author. These defaults can be overridden
2953
If selected files are specified, only changes to those files are
2954
committed. If a directory is specified then the directory and
2955
everything within it is committed.
2957
When excludes are given, they take precedence over selected files.
2958
For example, to commit only changes within foo, but not changes
2961
bzr commit foo -x foo/bar
2963
A selective commit after a merge is not yet supported.
2967
If the author of the change is not the same person as the committer,
2968
you can specify the author's name using the --author option. The
2969
name should be in the same format as a committer-id, e.g.
2970
"John Doe <jdoe@example.com>". If there is more than one author of
2971
the change you can specify the option multiple times, once for each
2976
A common mistake is to forget to add a new file or directory before
2977
running the commit command. The --strict option checks for unknown
2978
files and aborts the commit if any are found. More advanced pre-commit
2979
checks can be implemented by defining hooks. See ``bzr help hooks``
2984
If you accidentially commit the wrong changes or make a spelling
2985
mistake in the commit message say, you can use the uncommit command
2986
to undo it. See ``bzr help uncommit`` for details.
2988
Hooks can also be configured to run after a commit. This allows you
2989
to trigger updates to external systems like bug trackers. The --fixes
2990
option can be used to record the association between a revision and
2991
one or more bugs. See ``bzr help bugs`` for details.
2993
A selective commit may fail in some cases where the committed
2994
tree would be invalid. Consider::
2999
bzr commit foo -m "committing foo"
3000
bzr mv foo/bar foo/baz
3003
bzr commit foo/bar -m "committing bar but not baz"
3005
In the example above, the last commit will fail by design. This gives
3006
the user the opportunity to decide whether they want to commit the
3007
rename at the same time, separately first, or not at all. (As a general
3008
rule, when in doubt, Bazaar has a policy of Doing the Safe Thing.)
3010
# TODO: Run hooks on tree to-be-committed, and after commit.
3012
# TODO: Strict commit that fails if there are deleted files.
3013
# (what does "deleted files" mean ??)
3015
# TODO: Give better message for -s, --summary, used by tla people
3017
# XXX: verbose currently does nothing
3019
_see_also = ['add', 'bugs', 'hooks', 'uncommit']
3020
takes_args = ['selected*']
3022
ListOption('exclude', type=str, short_name='x',
3023
help="Do not consider changes made to a given path."),
3024
Option('message', type=unicode,
3026
help="Description of the new revision."),
3029
help='Commit even if nothing has changed.'),
3030
Option('file', type=str,
3033
help='Take commit message from this file.'),
3035
help="Refuse to commit if there are unknown "
3036
"files in the working tree."),
3037
Option('commit-time', type=str,
3038
help="Manually set a commit time using commit date "
3039
"format, e.g. '2009-10-10 08:00:00 +0100'."),
3040
ListOption('fixes', type=str,
3041
help="Mark a bug as being fixed by this revision "
3042
"(see \"bzr help bugs\")."),
3043
ListOption('author', type=unicode,
3044
help="Set the author's name, if it's different "
3045
"from the committer."),
3047
help="Perform a local commit in a bound "
3048
"branch. Local commits are not pushed to "
3049
"the master branch until a normal commit "
3052
Option('show-diff', short_name='p',
3053
help='When no message is supplied, show the diff along'
3054
' with the status summary in the message editor.'),
3056
aliases = ['ci', 'checkin']
3058
def _iter_bug_fix_urls(self, fixes, branch):
3059
# Configure the properties for bug fixing attributes.
3060
for fixed_bug in fixes:
3061
tokens = fixed_bug.split(':')
3062
if len(tokens) != 2:
3063
raise errors.BzrCommandError(
3064
"Invalid bug %s. Must be in the form of 'tracker:id'. "
3065
"See \"bzr help bugs\" for more information on this "
3066
"feature.\nCommit refused." % fixed_bug)
3067
tag, bug_id = tokens
3069
yield bugtracker.get_bug_url(tag, branch, bug_id)
3070
except errors.UnknownBugTrackerAbbreviation:
3071
raise errors.BzrCommandError(
3072
'Unrecognized bug %s. Commit refused.' % fixed_bug)
3073
except errors.MalformedBugIdentifier, e:
3074
raise errors.BzrCommandError(
3075
"%s\nCommit refused." % (str(e),))
3077
def run(self, message=None, file=None, verbose=False, selected_list=None,
3078
unchanged=False, strict=False, local=False, fixes=None,
3079
author=None, show_diff=False, exclude=None, commit_time=None):
3080
from bzrlib.errors import (
3085
from bzrlib.msgeditor import (
3086
edit_commit_message_encoded,
3087
generate_commit_message_template,
3088
make_commit_message_template_encoded
3091
commit_stamp = offset = None
3092
if commit_time is not None:
3094
commit_stamp, offset = timestamp.parse_patch_date(commit_time)
3095
except ValueError, e:
3096
raise errors.BzrCommandError(
3097
"Could not parse --commit-time: " + str(e))
3099
# TODO: Need a blackbox test for invoking the external editor; may be
3100
# slightly problematic to run this cross-platform.
3102
# TODO: do more checks that the commit will succeed before
3103
# spending the user's valuable time typing a commit message.
3107
tree, selected_list = tree_files(selected_list)
3108
if selected_list == ['']:
3109
# workaround - commit of root of tree should be exactly the same
3110
# as just default commit in that tree, and succeed even though
3111
# selected-file merge commit is not done yet
3116
bug_property = bugtracker.encode_fixes_bug_urls(
3117
self._iter_bug_fix_urls(fixes, tree.branch))
3119
properties['bugs'] = bug_property
3121
if local and not tree.branch.get_bound_location():
3122
raise errors.LocalRequiresBoundBranch()
3124
if message is not None:
3126
file_exists = osutils.lexists(message)
3127
except UnicodeError:
3128
# The commit message contains unicode characters that can't be
3129
# represented in the filesystem encoding, so that can't be a
3134
'The commit message is a file name: "%(f)s".\n'
3135
'(use --file "%(f)s" to take commit message from that file)'
3137
ui.ui_factory.show_warning(warning_msg)
3139
message = message.replace('\r\n', '\n')
3140
message = message.replace('\r', '\n')
3142
raise errors.BzrCommandError(
3143
"please specify either --message or --file")
3145
def get_message(commit_obj):
3146
"""Callback to get commit message"""
3148
my_message = codecs.open(
3149
file, 'rt', osutils.get_user_encoding()).read()
3150
elif message is not None:
3151
my_message = message
3153
# No message supplied: make one up.
3154
# text is the status of the tree
3155
text = make_commit_message_template_encoded(tree,
3156
selected_list, diff=show_diff,
3157
output_encoding=osutils.get_user_encoding())
3158
# start_message is the template generated from hooks
3159
# XXX: Warning - looks like hooks return unicode,
3160
# make_commit_message_template_encoded returns user encoding.
3161
# We probably want to be using edit_commit_message instead to
3163
start_message = generate_commit_message_template(commit_obj)
3164
my_message = edit_commit_message_encoded(text,
3165
start_message=start_message)
3166
if my_message is None:
3167
raise errors.BzrCommandError("please specify a commit"
3168
" message with either --message or --file")
3169
if my_message == "":
3170
raise errors.BzrCommandError("empty commit message specified")
3173
# The API permits a commit with a filter of [] to mean 'select nothing'
3174
# but the command line should not do that.
3175
if not selected_list:
3176
selected_list = None
3178
tree.commit(message_callback=get_message,
3179
specific_files=selected_list,
3180
allow_pointless=unchanged, strict=strict, local=local,
3181
reporter=None, verbose=verbose, revprops=properties,
3182
authors=author, timestamp=commit_stamp,
3184
exclude=safe_relpath_files(tree, exclude))
3185
except PointlessCommit:
3186
raise errors.BzrCommandError("No changes to commit."
3187
" Use --unchanged to commit anyhow.")
3188
except ConflictsInTree:
3189
raise errors.BzrCommandError('Conflicts detected in working '
3190
'tree. Use "bzr conflicts" to list, "bzr resolve FILE" to'
3192
except StrictCommitFailed:
3193
raise errors.BzrCommandError("Commit refused because there are"
3194
" unknown files in the working tree.")
3195
except errors.BoundBranchOutOfDate, e:
3196
e.extra_help = ("\n"
3197
'To commit to master branch, run update and then commit.\n'
3198
'You can also pass --local to commit to continue working '
3203
class cmd_check(Command):
3204
__doc__ = """Validate working tree structure, branch consistency and repository history.
3206
This command checks various invariants about branch and repository storage
3207
to detect data corruption or bzr bugs.
3209
The working tree and branch checks will only give output if a problem is
3210
detected. The output fields of the repository check are:
3213
This is just the number of revisions checked. It doesn't
3217
This is just the number of versionedfiles checked. It
3218
doesn't indicate a problem.
3220
unreferenced ancestors
3221
Texts that are ancestors of other texts, but
3222
are not properly referenced by the revision ancestry. This is a
3223
subtle problem that Bazaar can work around.
3226
This is the total number of unique file contents
3227
seen in the checked revisions. It does not indicate a problem.
3230
This is the total number of repeated texts seen
3231
in the checked revisions. Texts can be repeated when their file
3232
entries are modified, but the file contents are not. It does not
3235
If no restrictions are specified, all Bazaar data that is found at the given
3236
location will be checked.
3240
Check the tree and branch at 'foo'::
3242
bzr check --tree --branch foo
3244
Check only the repository at 'bar'::
3246
bzr check --repo bar
3248
Check everything at 'baz'::
3253
_see_also = ['reconcile']
3254
takes_args = ['path?']
3255
takes_options = ['verbose',
3256
Option('branch', help="Check the branch related to the"
3257
" current directory."),
3258
Option('repo', help="Check the repository related to the"
3259
" current directory."),
3260
Option('tree', help="Check the working tree related to"
3261
" the current directory.")]
3263
def run(self, path=None, verbose=False, branch=False, repo=False,
3265
from bzrlib.check import check_dwim
3268
if not branch and not repo and not tree:
3269
branch = repo = tree = True
3270
check_dwim(path, verbose, do_branch=branch, do_repo=repo, do_tree=tree)
3273
class cmd_upgrade(Command):
3274
__doc__ = """Upgrade branch storage to current format.
3276
The check command or bzr developers may sometimes advise you to run
3277
this command. When the default format has changed you may also be warned
3278
during other operations to upgrade.
3281
_see_also = ['check']
3282
takes_args = ['url?']
3284
RegistryOption('format',
3285
help='Upgrade to a specific format. See "bzr help'
3286
' formats" for details.',
3287
lazy_registry=('bzrlib.bzrdir', 'format_registry'),
3288
converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
3289
value_switches=True, title='Branch format'),
3292
def run(self, url='.', format=None):
3293
from bzrlib.upgrade import upgrade
3294
upgrade(url, format)
3297
class cmd_whoami(Command):
3298
__doc__ = """Show or set bzr user id.
3301
Show the email of the current user::
3305
Set the current user::
3307
bzr whoami "Frank Chu <fchu@example.com>"
3309
takes_options = [ Option('email',
3310
help='Display email address only.'),
3312
help='Set identity for the current branch instead of '
3315
takes_args = ['name?']
3316
encoding_type = 'replace'
3319
def run(self, email=False, branch=False, name=None):
3321
# use branch if we're inside one; otherwise global config
3323
c = Branch.open_containing('.')[0].get_config()
3324
except errors.NotBranchError:
3325
c = config.GlobalConfig()
3327
self.outf.write(c.user_email() + '\n')
3329
self.outf.write(c.username() + '\n')
3332
# display a warning if an email address isn't included in the given name.
3334
config.extract_email_address(name)
3335
except errors.NoEmailInUsername, e:
3336
warning('"%s" does not seem to contain an email address. '
3337
'This is allowed, but not recommended.', name)
3339
# use global config unless --branch given
3341
c = Branch.open_containing('.')[0].get_config()
3343
c = config.GlobalConfig()
3344
c.set_user_option('email', name)
3347
class cmd_nick(Command):
3348
__doc__ = """Print or set the branch nickname.
3350
If unset, the tree root directory name is used as the nickname.
3351
To print the current nickname, execute with no argument.
3353
Bound branches use the nickname of its master branch unless it is set
3357
_see_also = ['info']
3358
takes_args = ['nickname?']
3359
takes_options = ['directory']
3360
def run(self, nickname=None, directory=u'.'):
3361
branch = Branch.open_containing(directory)[0]
3362
if nickname is None:
3363
self.printme(branch)
3365
branch.nick = nickname
3368
def printme(self, branch):
3369
self.outf.write('%s\n' % branch.nick)
3372
class cmd_alias(Command):
3373
__doc__ = """Set/unset and display aliases.
3376
Show the current aliases::
3380
Show the alias specified for 'll'::
3384
Set an alias for 'll'::
3386
bzr alias ll="log --line -r-10..-1"
3388
To remove an alias for 'll'::
3390
bzr alias --remove ll
3393
takes_args = ['name?']
3395
Option('remove', help='Remove the alias.'),
3398
def run(self, name=None, remove=False):
3400
self.remove_alias(name)
3402
self.print_aliases()
3404
equal_pos = name.find('=')
3406
self.print_alias(name)
3408
self.set_alias(name[:equal_pos], name[equal_pos+1:])
3410
def remove_alias(self, alias_name):
3411
if alias_name is None:
3412
raise errors.BzrCommandError(
3413
'bzr alias --remove expects an alias to remove.')
3414
# If alias is not found, print something like:
3415
# unalias: foo: not found
3416
c = config.GlobalConfig()
3417
c.unset_alias(alias_name)
3420
def print_aliases(self):
3421
"""Print out the defined aliases in a similar format to bash."""
3422
aliases = config.GlobalConfig().get_aliases()
3423
for key, value in sorted(aliases.iteritems()):
3424
self.outf.write('bzr alias %s="%s"\n' % (key, value))
3427
def print_alias(self, alias_name):
3428
from bzrlib.commands import get_alias
3429
alias = get_alias(alias_name)
3431
self.outf.write("bzr alias: %s: not found\n" % alias_name)
3434
'bzr alias %s="%s"\n' % (alias_name, ' '.join(alias)))
3436
def set_alias(self, alias_name, alias_command):
3437
"""Save the alias in the global config."""
3438
c = config.GlobalConfig()
3439
c.set_alias(alias_name, alias_command)
3442
class cmd_selftest(Command):
3443
__doc__ = """Run internal test suite.
3445
If arguments are given, they are regular expressions that say which tests
3446
should run. Tests matching any expression are run, and other tests are
3449
Alternatively if --first is given, matching tests are run first and then
3450
all other tests are run. This is useful if you have been working in a
3451
particular area, but want to make sure nothing else was broken.
3453
If --exclude is given, tests that match that regular expression are
3454
excluded, regardless of whether they match --first or not.
3456
To help catch accidential dependencies between tests, the --randomize
3457
option is useful. In most cases, the argument used is the word 'now'.
3458
Note that the seed used for the random number generator is displayed
3459
when this option is used. The seed can be explicitly passed as the
3460
argument to this option if required. This enables reproduction of the
3461
actual ordering used if and when an order sensitive problem is encountered.
3463
If --list-only is given, the tests that would be run are listed. This is
3464
useful when combined with --first, --exclude and/or --randomize to
3465
understand their impact. The test harness reports "Listed nn tests in ..."
3466
instead of "Ran nn tests in ..." when list mode is enabled.
3468
If the global option '--no-plugins' is given, plugins are not loaded
3469
before running the selftests. This has two effects: features provided or
3470
modified by plugins will not be tested, and tests provided by plugins will
3473
Tests that need working space on disk use a common temporary directory,
3474
typically inside $TMPDIR or /tmp.
3476
If you set BZR_TEST_PDB=1 when running selftest, failing tests will drop
3477
into a pdb postmortem session.
3480
Run only tests relating to 'ignore'::
3484
Disable plugins and list tests as they're run::
3486
bzr --no-plugins selftest -v
3488
# NB: this is used from the class without creating an instance, which is
3489
# why it does not have a self parameter.
3490
def get_transport_type(typestring):
3491
"""Parse and return a transport specifier."""
3492
if typestring == "sftp":
3493
from bzrlib.tests import stub_sftp
3494
return stub_sftp.SFTPAbsoluteServer
3495
if typestring == "memory":
3496
from bzrlib.tests import test_server
3497
return memory.MemoryServer
3498
if typestring == "fakenfs":
3499
from bzrlib.tests import test_server
3500
return test_server.FakeNFSServer
3501
msg = "No known transport type %s. Supported types are: sftp\n" %\
3503
raise errors.BzrCommandError(msg)
3506
takes_args = ['testspecs*']
3507
takes_options = ['verbose',
3509
help='Stop when one test fails.',
3513
help='Use a different transport by default '
3514
'throughout the test suite.',
3515
type=get_transport_type),
3517
help='Run the benchmarks rather than selftests.'),
3518
Option('lsprof-timed',
3519
help='Generate lsprof output for benchmarked'
3520
' sections of code.'),
3521
Option('lsprof-tests',
3522
help='Generate lsprof output for each test.'),
3523
Option('cache-dir', type=str,
3524
help='Cache intermediate benchmark output in this '
3527
help='Run all tests, but run specified tests first.',
3531
help='List the tests instead of running them.'),
3532
RegistryOption('parallel',
3533
help="Run the test suite in parallel.",
3534
lazy_registry=('bzrlib.tests', 'parallel_registry'),
3535
value_switches=False,
3537
Option('randomize', type=str, argname="SEED",
3538
help='Randomize the order of tests using the given'
3539
' seed or "now" for the current time.'),
3540
Option('exclude', type=str, argname="PATTERN",
3542
help='Exclude tests that match this regular'
3545
help='Output test progress via subunit.'),
3546
Option('strict', help='Fail on missing dependencies or '
3548
Option('load-list', type=str, argname='TESTLISTFILE',
3549
help='Load a test id list from a text file.'),
3550
ListOption('debugflag', type=str, short_name='E',
3551
help='Turn on a selftest debug flag.'),
3552
ListOption('starting-with', type=str, argname='TESTID',
3553
param_name='starting_with', short_name='s',
3555
'Load only the tests starting with TESTID.'),
3557
encoding_type = 'replace'
3560
Command.__init__(self)
3561
self.additional_selftest_args = {}
3563
def run(self, testspecs_list=None, verbose=False, one=False,
3564
transport=None, benchmark=None,
3565
lsprof_timed=None, cache_dir=None,
3566
first=False, list_only=False,
3567
randomize=None, exclude=None, strict=False,
3568
load_list=None, debugflag=None, starting_with=None, subunit=False,
3569
parallel=None, lsprof_tests=False):
3570
from bzrlib.tests import selftest
3571
import bzrlib.benchmarks as benchmarks
3572
from bzrlib.benchmarks import tree_creator
3574
# Make deprecation warnings visible, unless -Werror is set
3575
symbol_versioning.activate_deprecation_warnings(override=False)
3577
if cache_dir is not None:
3578
tree_creator.TreeCreator.CACHE_ROOT = osutils.abspath(cache_dir)
3579
if testspecs_list is not None:
3580
pattern = '|'.join(testspecs_list)
3585
from bzrlib.tests import SubUnitBzrRunner
3587
raise errors.BzrCommandError("subunit not available. subunit "
3588
"needs to be installed to use --subunit.")
3589
self.additional_selftest_args['runner_class'] = SubUnitBzrRunner
3590
# On Windows, disable automatic conversion of '\n' to '\r\n' in
3591
# stdout, which would corrupt the subunit stream.
3592
# FIXME: This has been fixed in subunit trunk (>0.0.5) so the
3593
# following code can be deleted when it's sufficiently deployed
3594
# -- vila/mgz 20100514
3595
if (sys.platform == "win32"
3596
and getattr(sys.stdout, 'fileno', None) is not None):
3598
msvcrt.setmode(sys.stdout.fileno(), os.O_BINARY)
3600
self.additional_selftest_args.setdefault(
3601
'suite_decorators', []).append(parallel)
3603
test_suite_factory = benchmarks.test_suite
3604
# Unless user explicitly asks for quiet, be verbose in benchmarks
3605
verbose = not is_quiet()
3606
# TODO: should possibly lock the history file...
3607
benchfile = open(".perf_history", "at", buffering=1)
3608
self.add_cleanup(benchfile.close)
3610
test_suite_factory = None
3612
selftest_kwargs = {"verbose": verbose,
3614
"stop_on_failure": one,
3615
"transport": transport,
3616
"test_suite_factory": test_suite_factory,
3617
"lsprof_timed": lsprof_timed,
3618
"lsprof_tests": lsprof_tests,
3619
"bench_history": benchfile,
3620
"matching_tests_first": first,
3621
"list_only": list_only,
3622
"random_seed": randomize,
3623
"exclude_pattern": exclude,
3625
"load_list": load_list,
3626
"debug_flags": debugflag,
3627
"starting_with": starting_with
3629
selftest_kwargs.update(self.additional_selftest_args)
3630
result = selftest(**selftest_kwargs)
3631
return int(not result)
3634
class cmd_version(Command):
3635
__doc__ = """Show version of bzr."""
3637
encoding_type = 'replace'
3639
Option("short", help="Print just the version number."),
3643
def run(self, short=False):
3644
from bzrlib.version import show_version
3646
self.outf.write(bzrlib.version_string + '\n')
3648
show_version(to_file=self.outf)
3651
class cmd_rocks(Command):
3652
__doc__ = """Statement of optimism."""
3658
self.outf.write("It sure does!\n")
3661
class cmd_find_merge_base(Command):
3662
__doc__ = """Find and print a base revision for merging two branches."""
3663
# TODO: Options to specify revisions on either side, as if
3664
# merging only part of the history.
3665
takes_args = ['branch', 'other']
3669
def run(self, branch, other):
3670
from bzrlib.revision import ensure_null
3672
branch1 = Branch.open_containing(branch)[0]
3673
branch2 = Branch.open_containing(other)[0]
3674
self.add_cleanup(branch1.lock_read().unlock)
3675
self.add_cleanup(branch2.lock_read().unlock)
3676
last1 = ensure_null(branch1.last_revision())
3677
last2 = ensure_null(branch2.last_revision())
3679
graph = branch1.repository.get_graph(branch2.repository)
3680
base_rev_id = graph.find_unique_lca(last1, last2)
3682
self.outf.write('merge base is revision %s\n' % base_rev_id)
3685
class cmd_merge(Command):
3686
__doc__ = """Perform a three-way merge.
3688
The source of the merge can be specified either in the form of a branch,
3689
or in the form of a path to a file containing a merge directive generated
3690
with bzr send. If neither is specified, the default is the upstream branch
3691
or the branch most recently merged using --remember.
3693
When merging a branch, by default the tip will be merged. To pick a different
3694
revision, pass --revision. If you specify two values, the first will be used as
3695
BASE and the second one as OTHER. Merging individual revisions, or a subset of
3696
available revisions, like this is commonly referred to as "cherrypicking".
3698
Revision numbers are always relative to the branch being merged.
3700
By default, bzr will try to merge in all new work from the other
3701
branch, automatically determining an appropriate base. If this
3702
fails, you may need to give an explicit base.
3704
Merge will do its best to combine the changes in two branches, but there
3705
are some kinds of problems only a human can fix. When it encounters those,
3706
it will mark a conflict. A conflict means that you need to fix something,
3707
before you should commit.
3709
Use bzr resolve when you have fixed a problem. See also bzr conflicts.
3711
If there is no default branch set, the first merge will set it. After
3712
that, you can omit the branch to use the default. To change the
3713
default, use --remember. The value will only be saved if the remote
3714
location can be accessed.
3716
The results of the merge are placed into the destination working
3717
directory, where they can be reviewed (with bzr diff), tested, and then
3718
committed to record the result of the merge.
3720
merge refuses to run if there are any uncommitted changes, unless
3721
--force is given. The --force option can also be used to create a
3722
merge revision which has more than two parents.
3724
If one would like to merge changes from the working tree of the other
3725
branch without merging any committed revisions, the --uncommitted option
3728
To select only some changes to merge, use "merge -i", which will prompt
3729
you to apply each diff hunk and file change, similar to "shelve".
3732
To merge the latest revision from bzr.dev::
3734
bzr merge ../bzr.dev
3736
To merge changes up to and including revision 82 from bzr.dev::
3738
bzr merge -r 82 ../bzr.dev
3740
To merge the changes introduced by 82, without previous changes::
3742
bzr merge -r 81..82 ../bzr.dev
3744
To apply a merge directive contained in /tmp/merge::
3746
bzr merge /tmp/merge
3748
To create a merge revision with three parents from two branches
3749
feature1a and feature1b:
3751
bzr merge ../feature1a
3752
bzr merge ../feature1b --force
3753
bzr commit -m 'revision with three parents'
3756
encoding_type = 'exact'
3757
_see_also = ['update', 'remerge', 'status-flags', 'send']
3758
takes_args = ['location?']
3763
help='Merge even if the destination tree has uncommitted changes.'),
3767
Option('show-base', help="Show base revision text in "
3769
Option('uncommitted', help='Apply uncommitted changes'
3770
' from a working copy, instead of branch changes.'),
3771
Option('pull', help='If the destination is already'
3772
' completely merged into the source, pull from the'
3773
' source rather than merging. When this happens,'
3774
' you do not need to commit the result.'),
3775
custom_help('directory',
3776
help='Branch to merge into, '
3777
'rather than the one containing the working directory.'),
3778
Option('preview', help='Instead of merging, show a diff of the'
3780
Option('interactive', help='Select changes interactively.',
3784
def run(self, location=None, revision=None, force=False,
3785
merge_type=None, show_base=False, reprocess=None, remember=False,
3786
uncommitted=False, pull=False,
3791
if merge_type is None:
3792
merge_type = _mod_merge.Merge3Merger
3794
if directory is None: directory = u'.'
3795
possible_transports = []
3797
allow_pending = True
3798
verified = 'inapplicable'
3799
tree = WorkingTree.open_containing(directory)[0]
3802
basis_tree = tree.revision_tree(tree.last_revision())
3803
except errors.NoSuchRevision:
3804
basis_tree = tree.basis_tree()
3806
# die as quickly as possible if there are uncommitted changes
3808
if tree.has_changes():
3809
raise errors.UncommittedChanges(tree)
3811
view_info = _get_view_info_for_change_reporter(tree)
3812
change_reporter = delta._ChangeReporter(
3813
unversioned_filter=tree.is_ignored, view_info=view_info)
3814
pb = ui.ui_factory.nested_progress_bar()
3815
self.add_cleanup(pb.finished)
3816
self.add_cleanup(tree.lock_write().unlock)
3817
if location is not None:
3819
mergeable = bundle.read_mergeable_from_url(location,
3820
possible_transports=possible_transports)
3821
except errors.NotABundle:
3825
raise errors.BzrCommandError('Cannot use --uncommitted'
3826
' with bundles or merge directives.')
3828
if revision is not None:
3829
raise errors.BzrCommandError(
3830
'Cannot use -r with merge directives or bundles')
3831
merger, verified = _mod_merge.Merger.from_mergeable(tree,
3834
if merger is None and uncommitted:
3835
if revision is not None and len(revision) > 0:
3836
raise errors.BzrCommandError('Cannot use --uncommitted and'
3837
' --revision at the same time.')
3838
merger = self.get_merger_from_uncommitted(tree, location, None)
3839
allow_pending = False
3842
merger, allow_pending = self._get_merger_from_branch(tree,
3843
location, revision, remember, possible_transports, None)
3845
merger.merge_type = merge_type
3846
merger.reprocess = reprocess
3847
merger.show_base = show_base
3848
self.sanity_check_merger(merger)
3849
if (merger.base_rev_id == merger.other_rev_id and
3850
merger.other_rev_id is not None):
3851
note('Nothing to do.')
3854
if merger.interesting_files is not None:
3855
raise errors.BzrCommandError('Cannot pull individual files')
3856
if (merger.base_rev_id == tree.last_revision()):
3857
result = tree.pull(merger.other_branch, False,
3858
merger.other_rev_id)
3859
result.report(self.outf)
3861
if merger.this_basis is None:
3862
raise errors.BzrCommandError(
3863
"This branch has no commits."
3864
" (perhaps you would prefer 'bzr pull')")
3866
return self._do_preview(merger)
3868
return self._do_interactive(merger)
3870
return self._do_merge(merger, change_reporter, allow_pending,
3873
def _get_preview(self, merger):
3874
tree_merger = merger.make_merger()
3875
tt = tree_merger.make_preview_transform()
3876
self.add_cleanup(tt.finalize)
3877
result_tree = tt.get_preview_tree()
3880
def _do_preview(self, merger):
3881
from bzrlib.diff import show_diff_trees
3882
result_tree = self._get_preview(merger)
3883
show_diff_trees(merger.this_tree, result_tree, self.outf,
3884
old_label='', new_label='')
3886
def _do_merge(self, merger, change_reporter, allow_pending, verified):
3887
merger.change_reporter = change_reporter
3888
conflict_count = merger.do_merge()
3890
merger.set_pending()
3891
if verified == 'failed':
3892
warning('Preview patch does not match changes')
3893
if conflict_count != 0:
3898
def _do_interactive(self, merger):
3899
"""Perform an interactive merge.
3901
This works by generating a preview tree of the merge, then using
3902
Shelver to selectively remove the differences between the working tree
3903
and the preview tree.
3905
from bzrlib import shelf_ui
3906
result_tree = self._get_preview(merger)
3907
writer = bzrlib.option.diff_writer_registry.get()
3908
shelver = shelf_ui.Shelver(merger.this_tree, result_tree, destroy=True,
3909
reporter=shelf_ui.ApplyReporter(),
3910
diff_writer=writer(sys.stdout))
3916
def sanity_check_merger(self, merger):
3917
if (merger.show_base and
3918
not merger.merge_type is _mod_merge.Merge3Merger):
3919
raise errors.BzrCommandError("Show-base is not supported for this"
3920
" merge type. %s" % merger.merge_type)
3921
if merger.reprocess is None:
3922
if merger.show_base:
3923
merger.reprocess = False
3925
# Use reprocess if the merger supports it
3926
merger.reprocess = merger.merge_type.supports_reprocess
3927
if merger.reprocess and not merger.merge_type.supports_reprocess:
3928
raise errors.BzrCommandError("Conflict reduction is not supported"
3929
" for merge type %s." %
3931
if merger.reprocess and merger.show_base:
3932
raise errors.BzrCommandError("Cannot do conflict reduction and"
3935
def _get_merger_from_branch(self, tree, location, revision, remember,
3936
possible_transports, pb):
3937
"""Produce a merger from a location, assuming it refers to a branch."""
3938
from bzrlib.tag import _merge_tags_if_possible
3939
# find the branch locations
3940
other_loc, user_location = self._select_branch_location(tree, location,
3942
if revision is not None and len(revision) == 2:
3943
base_loc, _unused = self._select_branch_location(tree,
3944
location, revision, 0)
3946
base_loc = other_loc
3948
other_branch, other_path = Branch.open_containing(other_loc,
3949
possible_transports)
3950
if base_loc == other_loc:
3951
base_branch = other_branch
3953
base_branch, base_path = Branch.open_containing(base_loc,
3954
possible_transports)
3955
# Find the revision ids
3956
other_revision_id = None
3957
base_revision_id = None
3958
if revision is not None:
3959
if len(revision) >= 1:
3960
other_revision_id = revision[-1].as_revision_id(other_branch)
3961
if len(revision) == 2:
3962
base_revision_id = revision[0].as_revision_id(base_branch)
3963
if other_revision_id is None:
3964
other_revision_id = _mod_revision.ensure_null(
3965
other_branch.last_revision())
3966
# Remember where we merge from
3967
if ((remember or tree.branch.get_submit_branch() is None) and
3968
user_location is not None):
3969
tree.branch.set_submit_branch(other_branch.base)
3970
_merge_tags_if_possible(other_branch, tree.branch)
3971
merger = _mod_merge.Merger.from_revision_ids(pb, tree,
3972
other_revision_id, base_revision_id, other_branch, base_branch)
3973
if other_path != '':
3974
allow_pending = False
3975
merger.interesting_files = [other_path]
3977
allow_pending = True
3978
return merger, allow_pending
3980
def get_merger_from_uncommitted(self, tree, location, pb):
3981
"""Get a merger for uncommitted changes.
3983
:param tree: The tree the merger should apply to.
3984
:param location: The location containing uncommitted changes.
3985
:param pb: The progress bar to use for showing progress.
3987
location = self._select_branch_location(tree, location)[0]
3988
other_tree, other_path = WorkingTree.open_containing(location)
3989
merger = _mod_merge.Merger.from_uncommitted(tree, other_tree, pb)
3990
if other_path != '':
3991
merger.interesting_files = [other_path]
3994
def _select_branch_location(self, tree, user_location, revision=None,
3996
"""Select a branch location, according to possible inputs.
3998
If provided, branches from ``revision`` are preferred. (Both
3999
``revision`` and ``index`` must be supplied.)
4001
Otherwise, the ``location`` parameter is used. If it is None, then the
4002
``submit`` or ``parent`` location is used, and a note is printed.
4004
:param tree: The working tree to select a branch for merging into
4005
:param location: The location entered by the user
4006
:param revision: The revision parameter to the command
4007
:param index: The index to use for the revision parameter. Negative
4008
indices are permitted.
4009
:return: (selected_location, user_location). The default location
4010
will be the user-entered location.
4012
if (revision is not None and index is not None
4013
and revision[index] is not None):
4014
branch = revision[index].get_branch()
4015
if branch is not None:
4016
return branch, branch
4017
if user_location is None:
4018
location = self._get_remembered(tree, 'Merging from')
4020
location = user_location
4021
return location, user_location
4023
def _get_remembered(self, tree, verb_string):
4024
"""Use tree.branch's parent if none was supplied.
4026
Report if the remembered location was used.
4028
stored_location = tree.branch.get_submit_branch()
4029
stored_location_type = "submit"
4030
if stored_location is None:
4031
stored_location = tree.branch.get_parent()
4032
stored_location_type = "parent"
4033
mutter("%s", stored_location)
4034
if stored_location is None:
4035
raise errors.BzrCommandError("No location specified or remembered")
4036
display_url = urlutils.unescape_for_display(stored_location, 'utf-8')
4037
note(u"%s remembered %s location %s", verb_string,
4038
stored_location_type, display_url)
4039
return stored_location
4042
class cmd_remerge(Command):
4043
__doc__ = """Redo a merge.
4045
Use this if you want to try a different merge technique while resolving
4046
conflicts. Some merge techniques are better than others, and remerge
4047
lets you try different ones on different files.
4049
The options for remerge have the same meaning and defaults as the ones for
4050
merge. The difference is that remerge can (only) be run when there is a
4051
pending merge, and it lets you specify particular files.
4054
Re-do the merge of all conflicted files, and show the base text in
4055
conflict regions, in addition to the usual THIS and OTHER texts::
4057
bzr remerge --show-base
4059
Re-do the merge of "foobar", using the weave merge algorithm, with
4060
additional processing to reduce the size of conflict regions::
4062
bzr remerge --merge-type weave --reprocess foobar
4064
takes_args = ['file*']
4069
help="Show base revision text in conflicts."),
4072
def run(self, file_list=None, merge_type=None, show_base=False,
4074
from bzrlib.conflicts import restore
4075
if merge_type is None:
4076
merge_type = _mod_merge.Merge3Merger
4077
tree, file_list = tree_files(file_list)
4078
self.add_cleanup(tree.lock_write().unlock)
4079
parents = tree.get_parent_ids()
4080
if len(parents) != 2:
4081
raise errors.BzrCommandError("Sorry, remerge only works after normal"
4082
" merges. Not cherrypicking or"
4084
repository = tree.branch.repository
4085
interesting_ids = None
4087
conflicts = tree.conflicts()
4088
if file_list is not None:
4089
interesting_ids = set()
4090
for filename in file_list:
4091
file_id = tree.path2id(filename)
4093
raise errors.NotVersionedError(filename)
4094
interesting_ids.add(file_id)
4095
if tree.kind(file_id) != "directory":
4098
for name, ie in tree.inventory.iter_entries(file_id):
4099
interesting_ids.add(ie.file_id)
4100
new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
4102
# Remerge only supports resolving contents conflicts
4103
allowed_conflicts = ('text conflict', 'contents conflict')
4104
restore_files = [c.path for c in conflicts
4105
if c.typestring in allowed_conflicts]
4106
_mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
4107
tree.set_conflicts(ConflictList(new_conflicts))
4108
if file_list is not None:
4109
restore_files = file_list
4110
for filename in restore_files:
4112
restore(tree.abspath(filename))
4113
except errors.NotConflicted:
4115
# Disable pending merges, because the file texts we are remerging
4116
# have not had those merges performed. If we use the wrong parents
4117
# list, we imply that the working tree text has seen and rejected
4118
# all the changes from the other tree, when in fact those changes
4119
# have not yet been seen.
4120
tree.set_parent_ids(parents[:1])
4122
merger = _mod_merge.Merger.from_revision_ids(None, tree, parents[1])
4123
merger.interesting_ids = interesting_ids
4124
merger.merge_type = merge_type
4125
merger.show_base = show_base
4126
merger.reprocess = reprocess
4127
conflicts = merger.do_merge()
4129
tree.set_parent_ids(parents)
4136
class cmd_revert(Command):
4137
__doc__ = """Revert files to a previous revision.
4139
Giving a list of files will revert only those files. Otherwise, all files
4140
will be reverted. If the revision is not specified with '--revision', the
4141
last committed revision is used.
4143
To remove only some changes, without reverting to a prior version, use
4144
merge instead. For example, "merge . --revision -2..-3" will remove the
4145
changes introduced by -2, without affecting the changes introduced by -1.
4146
Or to remove certain changes on a hunk-by-hunk basis, see the Shelf plugin.
4148
By default, any files that have been manually changed will be backed up
4149
first. (Files changed only by merge are not backed up.) Backup files have
4150
'.~#~' appended to their name, where # is a number.
4152
When you provide files, you can use their current pathname or the pathname
4153
from the target revision. So you can use revert to "undelete" a file by
4154
name. If you name a directory, all the contents of that directory will be
4157
If you have newly added files since the target revision, they will be
4158
removed. If the files to be removed have been changed, backups will be
4159
created as above. Directories containing unknown files will not be
4162
The working tree contains a list of revisions that have been merged but
4163
not yet committed. These revisions will be included as additional parents
4164
of the next commit. Normally, using revert clears that list as well as
4165
reverting the files. If any files are specified, revert leaves the list
4166
of uncommitted merges alone and reverts only the files. Use ``bzr revert
4167
.`` in the tree root to revert all files but keep the recorded merges,
4168
and ``bzr revert --forget-merges`` to clear the pending merge list without
4169
reverting any files.
4171
Using "bzr revert --forget-merges", it is possible to apply all of the
4172
changes from a branch in a single revision. To do this, perform the merge
4173
as desired. Then doing revert with the "--forget-merges" option will keep
4174
the content of the tree as it was, but it will clear the list of pending
4175
merges. The next commit will then contain all of the changes that are
4176
present in the other branch, but without any other parent revisions.
4177
Because this technique forgets where these changes originated, it may
4178
cause additional conflicts on later merges involving the same source and
4182
_see_also = ['cat', 'export']
4185
Option('no-backup', "Do not save backups of reverted files."),
4186
Option('forget-merges',
4187
'Remove pending merge marker, without changing any files.'),
4189
takes_args = ['file*']
4191
def run(self, revision=None, no_backup=False, file_list=None,
4192
forget_merges=None):
4193
tree, file_list = tree_files(file_list)
4194
self.add_cleanup(tree.lock_tree_write().unlock)
4196
tree.set_parent_ids(tree.get_parent_ids()[:1])
4198
self._revert_tree_to_revision(tree, revision, file_list, no_backup)
4201
def _revert_tree_to_revision(tree, revision, file_list, no_backup):
4202
rev_tree = _get_one_revision_tree('revert', revision, tree=tree)
4203
tree.revert(file_list, rev_tree, not no_backup, None,
4204
report_changes=True)
4207
class cmd_assert_fail(Command):
4208
__doc__ = """Test reporting of assertion failures"""
4209
# intended just for use in testing
4214
raise AssertionError("always fails")
4217
class cmd_help(Command):
4218
__doc__ = """Show help on a command or other topic.
4221
_see_also = ['topics']
4223
Option('long', 'Show help on all commands.'),
4225
takes_args = ['topic?']
4226
aliases = ['?', '--help', '-?', '-h']
4229
def run(self, topic=None, long=False):
4231
if topic is None and long:
4233
bzrlib.help.help(topic)
4236
class cmd_shell_complete(Command):
4237
__doc__ = """Show appropriate completions for context.
4239
For a list of all available commands, say 'bzr shell-complete'.
4241
takes_args = ['context?']
4246
def run(self, context=None):
4247
import shellcomplete
4248
shellcomplete.shellcomplete(context)
4251
class cmd_missing(Command):
4252
__doc__ = """Show unmerged/unpulled revisions between two branches.
4254
OTHER_BRANCH may be local or remote.
4256
To filter on a range of revisions, you can use the command -r begin..end
4257
-r revision requests a specific revision, -r ..end or -r begin.. are
4261
1 - some missing revisions
4262
0 - no missing revisions
4266
Determine the missing revisions between this and the branch at the
4267
remembered pull location::
4271
Determine the missing revisions between this and another branch::
4273
bzr missing http://server/branch
4275
Determine the missing revisions up to a specific revision on the other
4278
bzr missing -r ..-10
4280
Determine the missing revisions up to a specific revision on this
4283
bzr missing --my-revision ..-10
4286
_see_also = ['merge', 'pull']
4287
takes_args = ['other_branch?']
4289
Option('reverse', 'Reverse the order of revisions.'),
4291
'Display changes in the local branch only.'),
4292
Option('this' , 'Same as --mine-only.'),
4293
Option('theirs-only',
4294
'Display changes in the remote branch only.'),
4295
Option('other', 'Same as --theirs-only.'),
4299
custom_help('revision',
4300
help='Filter on other branch revisions (inclusive). '
4301
'See "help revisionspec" for details.'),
4302
Option('my-revision',
4303
type=_parse_revision_str,
4304
help='Filter on local branch revisions (inclusive). '
4305
'See "help revisionspec" for details.'),
4306
Option('include-merges',
4307
'Show all revisions in addition to the mainline ones.'),
4309
encoding_type = 'replace'
4312
def run(self, other_branch=None, reverse=False, mine_only=False,
4314
log_format=None, long=False, short=False, line=False,
4315
show_ids=False, verbose=False, this=False, other=False,
4316
include_merges=False, revision=None, my_revision=None):
4317
from bzrlib.missing import find_unmerged, iter_log_revisions
4326
# TODO: We should probably check that we don't have mine-only and
4327
# theirs-only set, but it gets complicated because we also have
4328
# this and other which could be used.
4335
local_branch = Branch.open_containing(u".")[0]
4336
self.add_cleanup(local_branch.lock_read().unlock)
4338
parent = local_branch.get_parent()
4339
if other_branch is None:
4340
other_branch = parent
4341
if other_branch is None:
4342
raise errors.BzrCommandError("No peer location known"
4344
display_url = urlutils.unescape_for_display(parent,
4346
message("Using saved parent location: "
4347
+ display_url + "\n")
4349
remote_branch = Branch.open(other_branch)
4350
if remote_branch.base == local_branch.base:
4351
remote_branch = local_branch
4353
self.add_cleanup(remote_branch.lock_read().unlock)
4355
local_revid_range = _revision_range_to_revid_range(
4356
_get_revision_range(my_revision, local_branch,
4359
remote_revid_range = _revision_range_to_revid_range(
4360
_get_revision_range(revision,
4361
remote_branch, self.name()))
4363
local_extra, remote_extra = find_unmerged(
4364
local_branch, remote_branch, restrict,
4365
backward=not reverse,
4366
include_merges=include_merges,
4367
local_revid_range=local_revid_range,
4368
remote_revid_range=remote_revid_range)
4370
if log_format is None:
4371
registry = log.log_formatter_registry
4372
log_format = registry.get_default(local_branch)
4373
lf = log_format(to_file=self.outf,
4375
show_timezone='original')
4378
if local_extra and not theirs_only:
4379
message("You have %d extra revision(s):\n" %
4381
for revision in iter_log_revisions(local_extra,
4382
local_branch.repository,
4384
lf.log_revision(revision)
4385
printed_local = True
4388
printed_local = False
4390
if remote_extra and not mine_only:
4391
if printed_local is True:
4393
message("You are missing %d revision(s):\n" %
4395
for revision in iter_log_revisions(remote_extra,
4396
remote_branch.repository,
4398
lf.log_revision(revision)
4401
if mine_only and not local_extra:
4402
# We checked local, and found nothing extra
4403
message('This branch is up to date.\n')
4404
elif theirs_only and not remote_extra:
4405
# We checked remote, and found nothing extra
4406
message('Other branch is up to date.\n')
4407
elif not (mine_only or theirs_only or local_extra or
4409
# We checked both branches, and neither one had extra
4411
message("Branches are up to date.\n")
4413
if not status_code and parent is None and other_branch is not None:
4414
self.add_cleanup(local_branch.lock_write().unlock)
4415
# handle race conditions - a parent might be set while we run.
4416
if local_branch.get_parent() is None:
4417
local_branch.set_parent(remote_branch.base)
4421
class cmd_pack(Command):
4422
__doc__ = """Compress the data within a repository.
4424
This operation compresses the data within a bazaar repository. As
4425
bazaar supports automatic packing of repository, this operation is
4426
normally not required to be done manually.
4428
During the pack operation, bazaar takes a backup of existing repository
4429
data, i.e. pack files. This backup is eventually removed by bazaar
4430
automatically when it is safe to do so. To save disk space by removing
4431
the backed up pack files, the --clean-obsolete-packs option may be
4434
Warning: If you use --clean-obsolete-packs and your machine crashes
4435
during or immediately after repacking, you may be left with a state
4436
where the deletion has been written to disk but the new packs have not
4437
been. In this case the repository may be unusable.
4440
_see_also = ['repositories']
4441
takes_args = ['branch_or_repo?']
4443
Option('clean-obsolete-packs', 'Delete obsolete packs to save disk space.'),
4446
def run(self, branch_or_repo='.', clean_obsolete_packs=False):
4447
dir = bzrdir.BzrDir.open_containing(branch_or_repo)[0]
4449
branch = dir.open_branch()
4450
repository = branch.repository
4451
except errors.NotBranchError:
4452
repository = dir.open_repository()
4453
repository.pack(clean_obsolete_packs=clean_obsolete_packs)
4456
class cmd_plugins(Command):
4457
__doc__ = """List the installed plugins.
4459
This command displays the list of installed plugins including
4460
version of plugin and a short description of each.
4462
--verbose shows the path where each plugin is located.
4464
A plugin is an external component for Bazaar that extends the
4465
revision control system, by adding or replacing code in Bazaar.
4466
Plugins can do a variety of things, including overriding commands,
4467
adding new commands, providing additional network transports and
4468
customizing log output.
4470
See the Bazaar Plugin Guide <http://doc.bazaar.canonical.com/plugins/en/>
4471
for further information on plugins including where to find them and how to
4472
install them. Instructions are also provided there on how to write new
4473
plugins using the Python programming language.
4475
takes_options = ['verbose']
4478
def run(self, verbose=False):
4479
import bzrlib.plugin
4480
from inspect import getdoc
4482
for name, plugin in bzrlib.plugin.plugins().items():
4483
version = plugin.__version__
4484
if version == 'unknown':
4486
name_ver = '%s %s' % (name, version)
4487
d = getdoc(plugin.module)
4489
doc = d.split('\n')[0]
4491
doc = '(no description)'
4492
result.append((name_ver, doc, plugin.path()))
4493
for name_ver, doc, path in sorted(result):
4494
self.outf.write("%s\n" % name_ver)
4495
self.outf.write(" %s\n" % doc)
4497
self.outf.write(" %s\n" % path)
4498
self.outf.write("\n")
4501
class cmd_testament(Command):
4502
__doc__ = """Show testament (signing-form) of a revision."""
4505
Option('long', help='Produce long-format testament.'),
4507
help='Produce a strict-format testament.')]
4508
takes_args = ['branch?']
4510
def run(self, branch=u'.', revision=None, long=False, strict=False):
4511
from bzrlib.testament import Testament, StrictTestament
4513
testament_class = StrictTestament
4515
testament_class = Testament
4517
b = Branch.open_containing(branch)[0]
4519
b = Branch.open(branch)
4520
self.add_cleanup(b.lock_read().unlock)
4521
if revision is None:
4522
rev_id = b.last_revision()
4524
rev_id = revision[0].as_revision_id(b)
4525
t = testament_class.from_revision(b.repository, rev_id)
4527
sys.stdout.writelines(t.as_text_lines())
4529
sys.stdout.write(t.as_short_text())
4532
class cmd_annotate(Command):
4533
__doc__ = """Show the origin of each line in a file.
4535
This prints out the given file with an annotation on the left side
4536
indicating which revision, author and date introduced the change.
4538
If the origin is the same for a run of consecutive lines, it is
4539
shown only at the top, unless the --all option is given.
4541
# TODO: annotate directories; showing when each file was last changed
4542
# TODO: if the working copy is modified, show annotations on that
4543
# with new uncommitted lines marked
4544
aliases = ['ann', 'blame', 'praise']
4545
takes_args = ['filename']
4546
takes_options = [Option('all', help='Show annotations on all lines.'),
4547
Option('long', help='Show commit date in annotations.'),
4552
encoding_type = 'exact'
4555
def run(self, filename, all=False, long=False, revision=None,
4556
show_ids=False, directory=None):
4557
from bzrlib.annotate import annotate_file, annotate_file_tree
4558
wt, branch, relpath = \
4559
_open_directory_or_containing_tree_or_branch(filename, directory)
4561
self.add_cleanup(wt.lock_read().unlock)
4563
self.add_cleanup(branch.lock_read().unlock)
4564
tree = _get_one_revision_tree('annotate', revision, branch=branch)
4565
self.add_cleanup(tree.lock_read().unlock)
4567
file_id = wt.path2id(relpath)
4569
file_id = tree.path2id(relpath)
4571
raise errors.NotVersionedError(filename)
4572
file_version = tree.inventory[file_id].revision
4573
if wt is not None and revision is None:
4574
# If there is a tree and we're not annotating historical
4575
# versions, annotate the working tree's content.
4576
annotate_file_tree(wt, file_id, self.outf, long, all,
4579
annotate_file(branch, file_version, file_id, long, all, self.outf,
4583
class cmd_re_sign(Command):
4584
__doc__ = """Create a digital signature for an existing revision."""
4585
# TODO be able to replace existing ones.
4587
hidden = True # is this right ?
4588
takes_args = ['revision_id*']
4589
takes_options = ['directory', 'revision']
4591
def run(self, revision_id_list=None, revision=None, directory=u'.'):
4592
if revision_id_list is not None and revision is not None:
4593
raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
4594
if revision_id_list is None and revision is None:
4595
raise errors.BzrCommandError('You must supply either --revision or a revision_id')
4596
b = WorkingTree.open_containing(directory)[0].branch
4597
self.add_cleanup(b.lock_write().unlock)
4598
return self._run(b, revision_id_list, revision)
4600
def _run(self, b, revision_id_list, revision):
4601
import bzrlib.gpg as gpg
4602
gpg_strategy = gpg.GPGStrategy(b.get_config())
4603
if revision_id_list is not None:
4604
b.repository.start_write_group()
4606
for revision_id in revision_id_list:
4607
b.repository.sign_revision(revision_id, gpg_strategy)
4609
b.repository.abort_write_group()
4612
b.repository.commit_write_group()
4613
elif revision is not None:
4614
if len(revision) == 1:
4615
revno, rev_id = revision[0].in_history(b)
4616
b.repository.start_write_group()
4618
b.repository.sign_revision(rev_id, gpg_strategy)
4620
b.repository.abort_write_group()
4623
b.repository.commit_write_group()
4624
elif len(revision) == 2:
4625
# are they both on rh- if so we can walk between them
4626
# might be nice to have a range helper for arbitrary
4627
# revision paths. hmm.
4628
from_revno, from_revid = revision[0].in_history(b)
4629
to_revno, to_revid = revision[1].in_history(b)
4630
if to_revid is None:
4631
to_revno = b.revno()
4632
if from_revno is None or to_revno is None:
4633
raise errors.BzrCommandError('Cannot sign a range of non-revision-history revisions')
4634
b.repository.start_write_group()
4636
for revno in range(from_revno, to_revno + 1):
4637
b.repository.sign_revision(b.get_rev_id(revno),
4640
b.repository.abort_write_group()
4643
b.repository.commit_write_group()
4645
raise errors.BzrCommandError('Please supply either one revision, or a range.')
4648
class cmd_bind(Command):
4649
__doc__ = """Convert the current branch into a checkout of the supplied branch.
4650
If no branch is supplied, rebind to the last bound location.
4652
Once converted into a checkout, commits must succeed on the master branch
4653
before they will be applied to the local branch.
4655
Bound branches use the nickname of its master branch unless it is set
4656
locally, in which case binding will update the local nickname to be
4660
_see_also = ['checkouts', 'unbind']
4661
takes_args = ['location?']
4662
takes_options = ['directory']
4664
def run(self, location=None, directory=u'.'):
4665
b, relpath = Branch.open_containing(directory)
4666
if location is None:
4668
location = b.get_old_bound_location()
4669
except errors.UpgradeRequired:
4670
raise errors.BzrCommandError('No location supplied. '
4671
'This format does not remember old locations.')
4673
if location is None:
4674
if b.get_bound_location() is not None:
4675
raise errors.BzrCommandError('Branch is already bound')
4677
raise errors.BzrCommandError('No location supplied '
4678
'and no previous location known')
4679
b_other = Branch.open(location)
4682
except errors.DivergedBranches:
4683
raise errors.BzrCommandError('These branches have diverged.'
4684
' Try merging, and then bind again.')
4685
if b.get_config().has_explicit_nickname():
4686
b.nick = b_other.nick
4689
class cmd_unbind(Command):
4690
__doc__ = """Convert the current checkout into a regular branch.
4692
After unbinding, the local branch is considered independent and subsequent
4693
commits will be local only.
4696
_see_also = ['checkouts', 'bind']
4698
takes_options = ['directory']
4700
def run(self, directory=u'.'):
4701
b, relpath = Branch.open_containing(directory)
4703
raise errors.BzrCommandError('Local branch is not bound')
4706
class cmd_uncommit(Command):
4707
__doc__ = """Remove the last committed revision.
4709
--verbose will print out what is being removed.
4710
--dry-run will go through all the motions, but not actually
4713
If --revision is specified, uncommit revisions to leave the branch at the
4714
specified revision. For example, "bzr uncommit -r 15" will leave the
4715
branch at revision 15.
4717
Uncommit leaves the working tree ready for a new commit. The only change
4718
it may make is to restore any pending merges that were present before
4722
# TODO: jam 20060108 Add an option to allow uncommit to remove
4723
# unreferenced information in 'branch-as-repository' branches.
4724
# TODO: jam 20060108 Add the ability for uncommit to remove unreferenced
4725
# information in shared branches as well.
4726
_see_also = ['commit']
4727
takes_options = ['verbose', 'revision',
4728
Option('dry-run', help='Don\'t actually make changes.'),
4729
Option('force', help='Say yes to all questions.'),
4731
help="Only remove the commits from the local branch"
4732
" when in a checkout."
4735
takes_args = ['location?']
4737
encoding_type = 'replace'
4739
def run(self, location=None,
4740
dry_run=False, verbose=False,
4741
revision=None, force=False, local=False):
4742
if location is None:
4744
control, relpath = bzrdir.BzrDir.open_containing(location)
4746
tree = control.open_workingtree()
4748
except (errors.NoWorkingTree, errors.NotLocalUrl):
4750
b = control.open_branch()
4752
if tree is not None:
4753
self.add_cleanup(tree.lock_write().unlock)
4755
self.add_cleanup(b.lock_write().unlock)
4756
return self._run(b, tree, dry_run, verbose, revision, force, local=local)
4758
def _run(self, b, tree, dry_run, verbose, revision, force, local=False):
4759
from bzrlib.log import log_formatter, show_log
4760
from bzrlib.uncommit import uncommit
4762
last_revno, last_rev_id = b.last_revision_info()
4765
if revision is None:
4767
rev_id = last_rev_id
4769
# 'bzr uncommit -r 10' actually means uncommit
4770
# so that the final tree is at revno 10.
4771
# but bzrlib.uncommit.uncommit() actually uncommits
4772
# the revisions that are supplied.
4773
# So we need to offset it by one
4774
revno = revision[0].in_history(b).revno + 1
4775
if revno <= last_revno:
4776
rev_id = b.get_rev_id(revno)
4778
if rev_id is None or _mod_revision.is_null(rev_id):
4779
self.outf.write('No revisions to uncommit.\n')
4782
lf = log_formatter('short',
4784
show_timezone='original')
4789
direction='forward',
4790
start_revision=revno,
4791
end_revision=last_revno)
4794
self.outf.write('Dry-run, pretending to remove'
4795
' the above revisions.\n')
4797
self.outf.write('The above revision(s) will be removed.\n')
4800
if not ui.ui_factory.get_boolean('Are you sure'):
4801
self.outf.write('Canceled')
4804
mutter('Uncommitting from {%s} to {%s}',
4805
last_rev_id, rev_id)
4806
uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
4807
revno=revno, local=local)
4808
self.outf.write('You can restore the old tip by running:\n'
4809
' bzr pull . -r revid:%s\n' % last_rev_id)
4812
class cmd_break_lock(Command):
4813
__doc__ = """Break a dead lock on a repository, branch or working directory.
4815
CAUTION: Locks should only be broken when you are sure that the process
4816
holding the lock has been stopped.
4818
You can get information on what locks are open via the 'bzr info
4819
[location]' command.
4823
bzr break-lock bzr+ssh://example.com/bzr/foo
4825
takes_args = ['location?']
4827
def run(self, location=None, show=False):
4828
if location is None:
4830
control, relpath = bzrdir.BzrDir.open_containing(location)
4832
control.break_lock()
4833
except NotImplementedError:
4837
class cmd_wait_until_signalled(Command):
4838
__doc__ = """Test helper for test_start_and_stop_bzr_subprocess_send_signal.
4840
This just prints a line to signal when it is ready, then blocks on stdin.
4846
sys.stdout.write("running\n")
4848
sys.stdin.readline()
4851
class cmd_serve(Command):
4852
__doc__ = """Run the bzr server."""
4854
aliases = ['server']
4858
help='Serve on stdin/out for use from inetd or sshd.'),
4859
RegistryOption('protocol',
4860
help="Protocol to serve.",
4861
lazy_registry=('bzrlib.transport', 'transport_server_registry'),
4862
value_switches=True),
4864
help='Listen for connections on nominated port of the form '
4865
'[hostname:]portnumber. Passing 0 as the port number will '
4866
'result in a dynamically allocated port. The default port '
4867
'depends on the protocol.',
4869
custom_help('directory',
4870
help='Serve contents of this directory.'),
4871
Option('allow-writes',
4872
help='By default the server is a readonly server. Supplying '
4873
'--allow-writes enables write access to the contents of '
4874
'the served directory and below. Note that ``bzr serve`` '
4875
'does not perform authentication, so unless some form of '
4876
'external authentication is arranged supplying this '
4877
'option leads to global uncontrolled write access to your '
4882
def get_host_and_port(self, port):
4883
"""Return the host and port to run the smart server on.
4885
If 'port' is None, None will be returned for the host and port.
4887
If 'port' has a colon in it, the string before the colon will be
4888
interpreted as the host.
4890
:param port: A string of the port to run the server on.
4891
:return: A tuple of (host, port), where 'host' is a host name or IP,
4892
and port is an integer TCP/IP port.
4895
if port is not None:
4897
host, port = port.split(':')
4901
def run(self, port=None, inet=False, directory=None, allow_writes=False,
4903
from bzrlib.transport import get_transport, transport_server_registry
4904
if directory is None:
4905
directory = os.getcwd()
4906
if protocol is None:
4907
protocol = transport_server_registry.get()
4908
host, port = self.get_host_and_port(port)
4909
url = urlutils.local_path_to_url(directory)
4910
if not allow_writes:
4911
url = 'readonly+' + url
4912
transport = get_transport(url)
4913
protocol(transport, host, port, inet)
4916
class cmd_join(Command):
4917
__doc__ = """Combine a tree into its containing tree.
4919
This command requires the target tree to be in a rich-root format.
4921
The TREE argument should be an independent tree, inside another tree, but
4922
not part of it. (Such trees can be produced by "bzr split", but also by
4923
running "bzr branch" with the target inside a tree.)
4925
The result is a combined tree, with the subtree no longer an independant
4926
part. This is marked as a merge of the subtree into the containing tree,
4927
and all history is preserved.
4930
_see_also = ['split']
4931
takes_args = ['tree']
4933
Option('reference', help='Join by reference.', hidden=True),
4936
def run(self, tree, reference=False):
4937
sub_tree = WorkingTree.open(tree)
4938
parent_dir = osutils.dirname(sub_tree.basedir)
4939
containing_tree = WorkingTree.open_containing(parent_dir)[0]
4940
repo = containing_tree.branch.repository
4941
if not repo.supports_rich_root():
4942
raise errors.BzrCommandError(
4943
"Can't join trees because %s doesn't support rich root data.\n"
4944
"You can use bzr upgrade on the repository."
4948
containing_tree.add_reference(sub_tree)
4949
except errors.BadReferenceTarget, e:
4950
# XXX: Would be better to just raise a nicely printable
4951
# exception from the real origin. Also below. mbp 20070306
4952
raise errors.BzrCommandError("Cannot join %s. %s" %
4956
containing_tree.subsume(sub_tree)
4957
except errors.BadSubsumeSource, e:
4958
raise errors.BzrCommandError("Cannot join %s. %s" %
4962
class cmd_split(Command):
4963
__doc__ = """Split a subdirectory of a tree into a separate tree.
4965
This command will produce a target tree in a format that supports
4966
rich roots, like 'rich-root' or 'rich-root-pack'. These formats cannot be
4967
converted into earlier formats like 'dirstate-tags'.
4969
The TREE argument should be a subdirectory of a working tree. That
4970
subdirectory will be converted into an independent tree, with its own
4971
branch. Commits in the top-level tree will not apply to the new subtree.
4974
_see_also = ['join']
4975
takes_args = ['tree']
4977
def run(self, tree):
4978
containing_tree, subdir = WorkingTree.open_containing(tree)
4979
sub_id = containing_tree.path2id(subdir)
4981
raise errors.NotVersionedError(subdir)
4983
containing_tree.extract(sub_id)
4984
except errors.RootNotRich:
4985
raise errors.RichRootUpgradeRequired(containing_tree.branch.base)
4988
class cmd_merge_directive(Command):
4989
__doc__ = """Generate a merge directive for auto-merge tools.
4991
A directive requests a merge to be performed, and also provides all the
4992
information necessary to do so. This means it must either include a
4993
revision bundle, or the location of a branch containing the desired
4996
A submit branch (the location to merge into) must be supplied the first
4997
time the command is issued. After it has been supplied once, it will
4998
be remembered as the default.
5000
A public branch is optional if a revision bundle is supplied, but required
5001
if --diff or --plain is specified. It will be remembered as the default
5002
after the first use.
5005
takes_args = ['submit_branch?', 'public_branch?']
5009
_see_also = ['send']
5012
RegistryOption.from_kwargs('patch-type',
5013
'The type of patch to include in the directive.',
5015
value_switches=True,
5017
bundle='Bazaar revision bundle (default).',
5018
diff='Normal unified diff.',
5019
plain='No patch, just directive.'),
5020
Option('sign', help='GPG-sign the directive.'), 'revision',
5021
Option('mail-to', type=str,
5022
help='Instead of printing the directive, email to this address.'),
5023
Option('message', type=str, short_name='m',
5024
help='Message to use when committing this merge.')
5027
encoding_type = 'exact'
5029
def run(self, submit_branch=None, public_branch=None, patch_type='bundle',
5030
sign=False, revision=None, mail_to=None, message=None):
5031
from bzrlib.revision import ensure_null, NULL_REVISION
5032
include_patch, include_bundle = {
5033
'plain': (False, False),
5034
'diff': (True, False),
5035
'bundle': (True, True),
5037
branch = Branch.open('.')
5038
stored_submit_branch = branch.get_submit_branch()
5039
if submit_branch is None:
5040
submit_branch = stored_submit_branch
5042
if stored_submit_branch is None:
5043
branch.set_submit_branch(submit_branch)
5044
if submit_branch is None:
5045
submit_branch = branch.get_parent()
5046
if submit_branch is None:
5047
raise errors.BzrCommandError('No submit branch specified or known')
5049
stored_public_branch = branch.get_public_branch()
5050
if public_branch is None:
5051
public_branch = stored_public_branch
5052
elif stored_public_branch is None:
5053
branch.set_public_branch(public_branch)
5054
if not include_bundle and public_branch is None:
5055
raise errors.BzrCommandError('No public branch specified or'
5057
base_revision_id = None
5058
if revision is not None:
5059
if len(revision) > 2:
5060
raise errors.BzrCommandError('bzr merge-directive takes '
5061
'at most two one revision identifiers')
5062
revision_id = revision[-1].as_revision_id(branch)
5063
if len(revision) == 2:
5064
base_revision_id = revision[0].as_revision_id(branch)
5066
revision_id = branch.last_revision()
5067
revision_id = ensure_null(revision_id)
5068
if revision_id == NULL_REVISION:
5069
raise errors.BzrCommandError('No revisions to bundle.')
5070
directive = merge_directive.MergeDirective2.from_objects(
5071
branch.repository, revision_id, time.time(),
5072
osutils.local_time_offset(), submit_branch,
5073
public_branch=public_branch, include_patch=include_patch,
5074
include_bundle=include_bundle, message=message,
5075
base_revision_id=base_revision_id)
5078
self.outf.write(directive.to_signed(branch))
5080
self.outf.writelines(directive.to_lines())
5082
message = directive.to_email(mail_to, branch, sign)
5083
s = SMTPConnection(branch.get_config())
5084
s.send_email(message)
5087
class cmd_send(Command):
5088
__doc__ = """Mail or create a merge-directive for submitting changes.
5090
A merge directive provides many things needed for requesting merges:
5092
* A machine-readable description of the merge to perform
5094
* An optional patch that is a preview of the changes requested
5096
* An optional bundle of revision data, so that the changes can be applied
5097
directly from the merge directive, without retrieving data from a
5100
`bzr send` creates a compact data set that, when applied using bzr
5101
merge, has the same effect as merging from the source branch.
5103
By default the merge directive is self-contained and can be applied to any
5104
branch containing submit_branch in its ancestory without needing access to
5107
If --no-bundle is specified, then Bazaar doesn't send the contents of the
5108
revisions, but only a structured request to merge from the
5109
public_location. In that case the public_branch is needed and it must be
5110
up-to-date and accessible to the recipient. The public_branch is always
5111
included if known, so that people can check it later.
5113
The submit branch defaults to the parent of the source branch, but can be
5114
overridden. Both submit branch and public branch will be remembered in
5115
branch.conf the first time they are used for a particular branch. The
5116
source branch defaults to that containing the working directory, but can
5117
be changed using --from.
5119
In order to calculate those changes, bzr must analyse the submit branch.
5120
Therefore it is most efficient for the submit branch to be a local mirror.
5121
If a public location is known for the submit_branch, that location is used
5122
in the merge directive.
5124
The default behaviour is to send the merge directive by mail, unless -o is
5125
given, in which case it is sent to a file.
5127
Mail is sent using your preferred mail program. This should be transparent
5128
on Windows (it uses MAPI). On Linux, it requires the xdg-email utility.
5129
If the preferred client can't be found (or used), your editor will be used.
5131
To use a specific mail program, set the mail_client configuration option.
5132
(For Thunderbird 1.5, this works around some bugs.) Supported values for
5133
specific clients are "claws", "evolution", "kmail", "mail.app" (MacOS X's
5134
Mail.app), "mutt", and "thunderbird"; generic options are "default",
5135
"editor", "emacsclient", "mapi", and "xdg-email". Plugins may also add
5138
If mail is being sent, a to address is required. This can be supplied
5139
either on the commandline, by setting the submit_to configuration
5140
option in the branch itself or the child_submit_to configuration option
5141
in the submit branch.
5143
Two formats are currently supported: "4" uses revision bundle format 4 and
5144
merge directive format 2. It is significantly faster and smaller than
5145
older formats. It is compatible with Bazaar 0.19 and later. It is the
5146
default. "0.9" uses revision bundle format 0.9 and merge directive
5147
format 1. It is compatible with Bazaar 0.12 - 0.18.
5149
The merge directives created by bzr send may be applied using bzr merge or
5150
bzr pull by specifying a file containing a merge directive as the location.
5152
bzr send makes extensive use of public locations to map local locations into
5153
URLs that can be used by other people. See `bzr help configuration` to
5154
set them, and use `bzr info` to display them.
5157
encoding_type = 'exact'
5159
_see_also = ['merge', 'pull']
5161
takes_args = ['submit_branch?', 'public_branch?']
5165
help='Do not include a bundle in the merge directive.'),
5166
Option('no-patch', help='Do not include a preview patch in the merge'
5169
help='Remember submit and public branch.'),
5171
help='Branch to generate the submission from, '
5172
'rather than the one containing the working directory.',
5175
Option('output', short_name='o',
5176
help='Write merge directive to this file or directory; '
5177
'use - for stdout.',
5180
help='Refuse to send if there are uncommitted changes in'
5181
' the working tree, --no-strict disables the check.'),
5182
Option('mail-to', help='Mail the request to this address.',
5186
Option('body', help='Body for the email.', type=unicode),
5187
RegistryOption('format',
5188
help='Use the specified output format.',
5189
lazy_registry=('bzrlib.send', 'format_registry')),
5192
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
5193
no_patch=False, revision=None, remember=False, output=None,
5194
format=None, mail_to=None, message=None, body=None,
5195
strict=None, **kwargs):
5196
from bzrlib.send import send
5197
return send(submit_branch, revision, public_branch, remember,
5198
format, no_bundle, no_patch, output,
5199
kwargs.get('from', '.'), mail_to, message, body,
5204
class cmd_bundle_revisions(cmd_send):
5205
__doc__ = """Create a merge-directive for submitting changes.
5207
A merge directive provides many things needed for requesting merges:
5209
* A machine-readable description of the merge to perform
5211
* An optional patch that is a preview of the changes requested
5213
* An optional bundle of revision data, so that the changes can be applied
5214
directly from the merge directive, without retrieving data from a
5217
If --no-bundle is specified, then public_branch is needed (and must be
5218
up-to-date), so that the receiver can perform the merge using the
5219
public_branch. The public_branch is always included if known, so that
5220
people can check it later.
5222
The submit branch defaults to the parent, but can be overridden. Both
5223
submit branch and public branch will be remembered if supplied.
5225
If a public_branch is known for the submit_branch, that public submit
5226
branch is used in the merge instructions. This means that a local mirror
5227
can be used as your actual submit branch, once you have set public_branch
5230
Two formats are currently supported: "4" uses revision bundle format 4 and
5231
merge directive format 2. It is significantly faster and smaller than
5232
older formats. It is compatible with Bazaar 0.19 and later. It is the
5233
default. "0.9" uses revision bundle format 0.9 and merge directive
5234
format 1. It is compatible with Bazaar 0.12 - 0.18.
5239
help='Do not include a bundle in the merge directive.'),
5240
Option('no-patch', help='Do not include a preview patch in the merge'
5243
help='Remember submit and public branch.'),
5245
help='Branch to generate the submission from, '
5246
'rather than the one containing the working directory.',
5249
Option('output', short_name='o', help='Write directive to this file.',
5252
help='Refuse to bundle revisions if there are uncommitted'
5253
' changes in the working tree, --no-strict disables the check.'),
5255
RegistryOption('format',
5256
help='Use the specified output format.',
5257
lazy_registry=('bzrlib.send', 'format_registry')),
5259
aliases = ['bundle']
5261
_see_also = ['send', 'merge']
5265
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
5266
no_patch=False, revision=None, remember=False, output=None,
5267
format=None, strict=None, **kwargs):
5270
from bzrlib.send import send
5271
return send(submit_branch, revision, public_branch, remember,
5272
format, no_bundle, no_patch, output,
5273
kwargs.get('from', '.'), None, None, None,
5274
self.outf, strict=strict)
5277
class cmd_tag(Command):
5278
__doc__ = """Create, remove or modify a tag naming a revision.
5280
Tags give human-meaningful names to revisions. Commands that take a -r
5281
(--revision) option can be given -rtag:X, where X is any previously
5284
Tags are stored in the branch. Tags are copied from one branch to another
5285
along when you branch, push, pull or merge.
5287
It is an error to give a tag name that already exists unless you pass
5288
--force, in which case the tag is moved to point to the new revision.
5290
To rename a tag (change the name but keep it on the same revsion), run ``bzr
5291
tag new-name -r tag:old-name`` and then ``bzr tag --delete oldname``.
5293
If no tag name is specified it will be determined through the
5294
'automatic_tag_name' hook. This can e.g. be used to automatically tag
5295
upstream releases by reading configure.ac. See ``bzr help hooks`` for
5299
_see_also = ['commit', 'tags']
5300
takes_args = ['tag_name?']
5303
help='Delete this tag rather than placing it.',
5305
custom_help('directory',
5306
help='Branch in which to place the tag.'),
5308
help='Replace existing tags.',
5313
def run(self, tag_name=None,
5319
branch, relpath = Branch.open_containing(directory)
5320
self.add_cleanup(branch.lock_write().unlock)
5322
if tag_name is None:
5323
raise errors.BzrCommandError("No tag specified to delete.")
5324
branch.tags.delete_tag(tag_name)
5325
self.outf.write('Deleted tag %s.\n' % tag_name)
5328
if len(revision) != 1:
5329
raise errors.BzrCommandError(
5330
"Tags can only be placed on a single revision, "
5332
revision_id = revision[0].as_revision_id(branch)
5334
revision_id = branch.last_revision()
5335
if tag_name is None:
5336
tag_name = branch.automatic_tag_name(revision_id)
5337
if tag_name is None:
5338
raise errors.BzrCommandError(
5339
"Please specify a tag name.")
5340
if (not force) and branch.tags.has_tag(tag_name):
5341
raise errors.TagAlreadyExists(tag_name)
5342
branch.tags.set_tag(tag_name, revision_id)
5343
self.outf.write('Created tag %s.\n' % tag_name)
5346
class cmd_tags(Command):
5347
__doc__ = """List tags.
5349
This command shows a table of tag names and the revisions they reference.
5354
custom_help('directory',
5355
help='Branch whose tags should be displayed.'),
5356
RegistryOption.from_kwargs('sort',
5357
'Sort tags by different criteria.', title='Sorting',
5358
alpha='Sort tags lexicographically (default).',
5359
time='Sort tags chronologically.',
5372
branch, relpath = Branch.open_containing(directory)
5374
tags = branch.tags.get_tag_dict().items()
5378
self.add_cleanup(branch.lock_read().unlock)
5380
graph = branch.repository.get_graph()
5381
rev1, rev2 = _get_revision_range(revision, branch, self.name())
5382
revid1, revid2 = rev1.rev_id, rev2.rev_id
5383
# only show revisions between revid1 and revid2 (inclusive)
5384
tags = [(tag, revid) for tag, revid in tags if
5385
graph.is_between(revid, revid1, revid2)]
5388
elif sort == 'time':
5390
for tag, revid in tags:
5392
revobj = branch.repository.get_revision(revid)
5393
except errors.NoSuchRevision:
5394
timestamp = sys.maxint # place them at the end
5396
timestamp = revobj.timestamp
5397
timestamps[revid] = timestamp
5398
tags.sort(key=lambda x: timestamps[x[1]])
5400
# [ (tag, revid), ... ] -> [ (tag, dotted_revno), ... ]
5401
for index, (tag, revid) in enumerate(tags):
5403
revno = branch.revision_id_to_dotted_revno(revid)
5404
if isinstance(revno, tuple):
5405
revno = '.'.join(map(str, revno))
5406
except errors.NoSuchRevision:
5407
# Bad tag data/merges can lead to tagged revisions
5408
# which are not in this branch. Fail gracefully ...
5410
tags[index] = (tag, revno)
5412
for tag, revspec in tags:
5413
self.outf.write('%-20s %s\n' % (tag, revspec))
5416
class cmd_reconfigure(Command):
5417
__doc__ = """Reconfigure the type of a bzr directory.
5419
A target configuration must be specified.
5421
For checkouts, the bind-to location will be auto-detected if not specified.
5422
The order of preference is
5423
1. For a lightweight checkout, the current bound location.
5424
2. For branches that used to be checkouts, the previously-bound location.
5425
3. The push location.
5426
4. The parent location.
5427
If none of these is available, --bind-to must be specified.
5430
_see_also = ['branches', 'checkouts', 'standalone-trees', 'working-trees']
5431
takes_args = ['location?']
5433
RegistryOption.from_kwargs(
5435
title='Target type',
5436
help='The type to reconfigure the directory to.',
5437
value_switches=True, enum_switch=False,
5438
branch='Reconfigure to be an unbound branch with no working tree.',
5439
tree='Reconfigure to be an unbound branch with a working tree.',
5440
checkout='Reconfigure to be a bound branch with a working tree.',
5441
lightweight_checkout='Reconfigure to be a lightweight'
5442
' checkout (with no local history).',
5443
standalone='Reconfigure to be a standalone branch '
5444
'(i.e. stop using shared repository).',
5445
use_shared='Reconfigure to use a shared repository.',
5446
with_trees='Reconfigure repository to create '
5447
'working trees on branches by default.',
5448
with_no_trees='Reconfigure repository to not create '
5449
'working trees on branches by default.'
5451
Option('bind-to', help='Branch to bind checkout to.', type=str),
5453
help='Perform reconfiguration even if local changes'
5455
Option('stacked-on',
5456
help='Reconfigure a branch to be stacked on another branch.',
5460
help='Reconfigure a branch to be unstacked. This '
5461
'may require copying substantial data into it.',
5465
def run(self, location=None, target_type=None, bind_to=None, force=False,
5468
directory = bzrdir.BzrDir.open(location)
5469
if stacked_on and unstacked:
5470
raise BzrCommandError("Can't use both --stacked-on and --unstacked")
5471
elif stacked_on is not None:
5472
reconfigure.ReconfigureStackedOn().apply(directory, stacked_on)
5474
reconfigure.ReconfigureUnstacked().apply(directory)
5475
# At the moment you can use --stacked-on and a different
5476
# reconfiguration shape at the same time; there seems no good reason
5478
if target_type is None:
5479
if stacked_on or unstacked:
5482
raise errors.BzrCommandError('No target configuration '
5484
elif target_type == 'branch':
5485
reconfiguration = reconfigure.Reconfigure.to_branch(directory)
5486
elif target_type == 'tree':
5487
reconfiguration = reconfigure.Reconfigure.to_tree(directory)
5488
elif target_type == 'checkout':
5489
reconfiguration = reconfigure.Reconfigure.to_checkout(
5491
elif target_type == 'lightweight-checkout':
5492
reconfiguration = reconfigure.Reconfigure.to_lightweight_checkout(
5494
elif target_type == 'use-shared':
5495
reconfiguration = reconfigure.Reconfigure.to_use_shared(directory)
5496
elif target_type == 'standalone':
5497
reconfiguration = reconfigure.Reconfigure.to_standalone(directory)
5498
elif target_type == 'with-trees':
5499
reconfiguration = reconfigure.Reconfigure.set_repository_trees(
5501
elif target_type == 'with-no-trees':
5502
reconfiguration = reconfigure.Reconfigure.set_repository_trees(
5504
reconfiguration.apply(force)
5507
class cmd_switch(Command):
5508
__doc__ = """Set the branch of a checkout and update.
5510
For lightweight checkouts, this changes the branch being referenced.
5511
For heavyweight checkouts, this checks that there are no local commits
5512
versus the current bound branch, then it makes the local branch a mirror
5513
of the new location and binds to it.
5515
In both cases, the working tree is updated and uncommitted changes
5516
are merged. The user can commit or revert these as they desire.
5518
Pending merges need to be committed or reverted before using switch.
5520
The path to the branch to switch to can be specified relative to the parent
5521
directory of the current branch. For example, if you are currently in a
5522
checkout of /path/to/branch, specifying 'newbranch' will find a branch at
5525
Bound branches use the nickname of its master branch unless it is set
5526
locally, in which case switching will update the local nickname to be
5530
takes_args = ['to_location?']
5531
takes_options = [Option('force',
5532
help='Switch even if local commits will be lost.'),
5534
Option('create-branch', short_name='b',
5535
help='Create the target branch from this one before'
5536
' switching to it.'),
5539
def run(self, to_location=None, force=False, create_branch=False,
5541
from bzrlib import switch
5543
revision = _get_one_revision('switch', revision)
5544
control_dir = bzrdir.BzrDir.open_containing(tree_location)[0]
5545
if to_location is None:
5546
if revision is None:
5547
raise errors.BzrCommandError('You must supply either a'
5548
' revision or a location')
5551
branch = control_dir.open_branch()
5552
had_explicit_nick = branch.get_config().has_explicit_nickname()
5553
except errors.NotBranchError:
5555
had_explicit_nick = False
5558
raise errors.BzrCommandError('cannot create branch without'
5560
to_location = directory_service.directories.dereference(
5562
if '/' not in to_location and '\\' not in to_location:
5563
# This path is meant to be relative to the existing branch
5564
this_url = self._get_branch_location(control_dir)
5565
to_location = urlutils.join(this_url, '..', to_location)
5566
to_branch = branch.bzrdir.sprout(to_location,
5567
possible_transports=[branch.bzrdir.root_transport],
5568
source_branch=branch).open_branch()
5571
to_branch = Branch.open(to_location)
5572
except errors.NotBranchError:
5573
this_url = self._get_branch_location(control_dir)
5574
to_branch = Branch.open(
5575
urlutils.join(this_url, '..', to_location))
5576
if revision is not None:
5577
revision = revision.as_revision_id(to_branch)
5578
switch.switch(control_dir, to_branch, force, revision_id=revision)
5579
if had_explicit_nick:
5580
branch = control_dir.open_branch() #get the new branch!
5581
branch.nick = to_branch.nick
5582
note('Switched to branch: %s',
5583
urlutils.unescape_for_display(to_branch.base, 'utf-8'))
5585
def _get_branch_location(self, control_dir):
5586
"""Return location of branch for this control dir."""
5588
this_branch = control_dir.open_branch()
5589
# This may be a heavy checkout, where we want the master branch
5590
master_location = this_branch.get_bound_location()
5591
if master_location is not None:
5592
return master_location
5593
# If not, use a local sibling
5594
return this_branch.base
5595
except errors.NotBranchError:
5596
format = control_dir.find_branch_format()
5597
if getattr(format, 'get_reference', None) is not None:
5598
return format.get_reference(control_dir)
5600
return control_dir.root_transport.base
5603
class cmd_view(Command):
5604
__doc__ = """Manage filtered views.
5606
Views provide a mask over the tree so that users can focus on
5607
a subset of a tree when doing their work. After creating a view,
5608
commands that support a list of files - status, diff, commit, etc -
5609
effectively have that list of files implicitly given each time.
5610
An explicit list of files can still be given but those files
5611
must be within the current view.
5613
In most cases, a view has a short life-span: it is created to make
5614
a selected change and is deleted once that change is committed.
5615
At other times, you may wish to create one or more named views
5616
and switch between them.
5618
To disable the current view without deleting it, you can switch to
5619
the pseudo view called ``off``. This can be useful when you need
5620
to see the whole tree for an operation or two (e.g. merge) but
5621
want to switch back to your view after that.
5624
To define the current view::
5626
bzr view file1 dir1 ...
5628
To list the current view::
5632
To delete the current view::
5636
To disable the current view without deleting it::
5638
bzr view --switch off
5640
To define a named view and switch to it::
5642
bzr view --name view-name file1 dir1 ...
5644
To list a named view::
5646
bzr view --name view-name
5648
To delete a named view::
5650
bzr view --name view-name --delete
5652
To switch to a named view::
5654
bzr view --switch view-name
5656
To list all views defined::
5660
To delete all views::
5662
bzr view --delete --all
5666
takes_args = ['file*']
5669
help='Apply list or delete action to all views.',
5672
help='Delete the view.',
5675
help='Name of the view to define, list or delete.',
5679
help='Name of the view to switch to.',
5684
def run(self, file_list,
5690
tree, file_list = tree_files(file_list, apply_view=False)
5691
current_view, view_dict = tree.views.get_view_info()
5696
raise errors.BzrCommandError(
5697
"Both --delete and a file list specified")
5699
raise errors.BzrCommandError(
5700
"Both --delete and --switch specified")
5702
tree.views.set_view_info(None, {})
5703
self.outf.write("Deleted all views.\n")
5705
raise errors.BzrCommandError("No current view to delete")
5707
tree.views.delete_view(name)
5708
self.outf.write("Deleted '%s' view.\n" % name)
5711
raise errors.BzrCommandError(
5712
"Both --switch and a file list specified")
5714
raise errors.BzrCommandError(
5715
"Both --switch and --all specified")
5716
elif switch == 'off':
5717
if current_view is None:
5718
raise errors.BzrCommandError("No current view to disable")
5719
tree.views.set_view_info(None, view_dict)
5720
self.outf.write("Disabled '%s' view.\n" % (current_view))
5722
tree.views.set_view_info(switch, view_dict)
5723
view_str = views.view_display_str(tree.views.lookup_view())
5724
self.outf.write("Using '%s' view: %s\n" % (switch, view_str))
5727
self.outf.write('Views defined:\n')
5728
for view in sorted(view_dict):
5729
if view == current_view:
5733
view_str = views.view_display_str(view_dict[view])
5734
self.outf.write('%s %-20s %s\n' % (active, view, view_str))
5736
self.outf.write('No views defined.\n')
5739
# No name given and no current view set
5742
raise errors.BzrCommandError(
5743
"Cannot change the 'off' pseudo view")
5744
tree.views.set_view(name, sorted(file_list))
5745
view_str = views.view_display_str(tree.views.lookup_view())
5746
self.outf.write("Using '%s' view: %s\n" % (name, view_str))
5750
# No name given and no current view set
5751
self.outf.write('No current view.\n')
5753
view_str = views.view_display_str(tree.views.lookup_view(name))
5754
self.outf.write("'%s' view is: %s\n" % (name, view_str))
5757
class cmd_hooks(Command):
5758
__doc__ = """Show hooks."""
5763
for hook_key in sorted(hooks.known_hooks.keys()):
5764
some_hooks = hooks.known_hooks_key_to_object(hook_key)
5765
self.outf.write("%s:\n" % type(some_hooks).__name__)
5766
for hook_name, hook_point in sorted(some_hooks.items()):
5767
self.outf.write(" %s:\n" % (hook_name,))
5768
found_hooks = list(hook_point)
5770
for hook in found_hooks:
5771
self.outf.write(" %s\n" %
5772
(some_hooks.get_hook_name(hook),))
5774
self.outf.write(" <no hooks installed>\n")
5777
class cmd_remove_branch(Command):
5778
__doc__ = """Remove a branch.
5780
This will remove the branch from the specified location but
5781
will keep any working tree or repository in place.
5785
Remove the branch at repo/trunk::
5787
bzr remove-branch repo/trunk
5791
takes_args = ["location?"]
5793
aliases = ["rmbranch"]
5795
def run(self, location=None):
5796
if location is None:
5798
branch = Branch.open_containing(location)[0]
5799
branch.bzrdir.destroy_branch()
5802
class cmd_shelve(Command):
5803
__doc__ = """Temporarily set aside some changes from the current tree.
5805
Shelve allows you to temporarily put changes you've made "on the shelf",
5806
ie. out of the way, until a later time when you can bring them back from
5807
the shelf with the 'unshelve' command. The changes are stored alongside
5808
your working tree, and so they aren't propagated along with your branch nor
5809
will they survive its deletion.
5811
If shelve --list is specified, previously-shelved changes are listed.
5813
Shelve is intended to help separate several sets of changes that have
5814
been inappropriately mingled. If you just want to get rid of all changes
5815
and you don't need to restore them later, use revert. If you want to
5816
shelve all text changes at once, use shelve --all.
5818
If filenames are specified, only the changes to those files will be
5819
shelved. Other files will be left untouched.
5821
If a revision is specified, changes since that revision will be shelved.
5823
You can put multiple items on the shelf, and by default, 'unshelve' will
5824
restore the most recently shelved changes.
5827
takes_args = ['file*']
5831
Option('all', help='Shelve all changes.'),
5833
RegistryOption('writer', 'Method to use for writing diffs.',
5834
bzrlib.option.diff_writer_registry,
5835
value_switches=True, enum_switch=False),
5837
Option('list', help='List shelved changes.'),
5839
help='Destroy removed changes instead of shelving them.'),
5841
_see_also = ['unshelve']
5843
def run(self, revision=None, all=False, file_list=None, message=None,
5844
writer=None, list=False, destroy=False):
5846
return self.run_for_list()
5847
from bzrlib.shelf_ui import Shelver
5849
writer = bzrlib.option.diff_writer_registry.get()
5851
shelver = Shelver.from_args(writer(sys.stdout), revision, all,
5852
file_list, message, destroy=destroy)
5857
except errors.UserAbort:
5860
def run_for_list(self):
5861
tree = WorkingTree.open_containing('.')[0]
5862
self.add_cleanup(tree.lock_read().unlock)
5863
manager = tree.get_shelf_manager()
5864
shelves = manager.active_shelves()
5865
if len(shelves) == 0:
5866
note('No shelved changes.')
5868
for shelf_id in reversed(shelves):
5869
message = manager.get_metadata(shelf_id).get('message')
5871
message = '<no message>'
5872
self.outf.write('%3d: %s\n' % (shelf_id, message))
5876
class cmd_unshelve(Command):
5877
__doc__ = """Restore shelved changes.
5879
By default, the most recently shelved changes are restored. However if you
5880
specify a shelf by id those changes will be restored instead. This works
5881
best when the changes don't depend on each other.
5884
takes_args = ['shelf_id?']
5886
RegistryOption.from_kwargs(
5887
'action', help="The action to perform.",
5888
enum_switch=False, value_switches=True,
5889
apply="Apply changes and remove from the shelf.",
5890
dry_run="Show changes, but do not apply or remove them.",
5891
preview="Instead of unshelving the changes, show the diff that "
5892
"would result from unshelving.",
5893
delete_only="Delete changes without applying them.",
5894
keep="Apply changes but don't delete them.",
5897
_see_also = ['shelve']
5899
def run(self, shelf_id=None, action='apply'):
5900
from bzrlib.shelf_ui import Unshelver
5901
unshelver = Unshelver.from_args(shelf_id, action)
5905
unshelver.tree.unlock()
5908
class cmd_clean_tree(Command):
5909
__doc__ = """Remove unwanted files from working tree.
5911
By default, only unknown files, not ignored files, are deleted. Versioned
5912
files are never deleted.
5914
Another class is 'detritus', which includes files emitted by bzr during
5915
normal operations and selftests. (The value of these files decreases with
5918
If no options are specified, unknown files are deleted. Otherwise, option
5919
flags are respected, and may be combined.
5921
To check what clean-tree will do, use --dry-run.
5923
takes_options = ['directory',
5924
Option('ignored', help='Delete all ignored files.'),
5925
Option('detritus', help='Delete conflict files, merge'
5926
' backups, and failed selftest dirs.'),
5928
help='Delete files unknown to bzr (default).'),
5929
Option('dry-run', help='Show files to delete instead of'
5931
Option('force', help='Do not prompt before deleting.')]
5932
def run(self, unknown=False, ignored=False, detritus=False, dry_run=False,
5933
force=False, directory=u'.'):
5934
from bzrlib.clean_tree import clean_tree
5935
if not (unknown or ignored or detritus):
5939
clean_tree(directory, unknown=unknown, ignored=ignored,
5940
detritus=detritus, dry_run=dry_run, no_prompt=force)
5943
class cmd_reference(Command):
5944
__doc__ = """list, view and set branch locations for nested trees.
5946
If no arguments are provided, lists the branch locations for nested trees.
5947
If one argument is provided, display the branch location for that tree.
5948
If two arguments are provided, set the branch location for that tree.
5953
takes_args = ['path?', 'location?']
5955
def run(self, path=None, location=None):
5957
if path is not None:
5959
tree, branch, relpath =(
5960
bzrdir.BzrDir.open_containing_tree_or_branch(branchdir))
5961
if path is not None:
5964
tree = branch.basis_tree()
5966
info = branch._get_all_reference_info().iteritems()
5967
self._display_reference_info(tree, branch, info)
5969
file_id = tree.path2id(path)
5971
raise errors.NotVersionedError(path)
5972
if location is None:
5973
info = [(file_id, branch.get_reference_info(file_id))]
5974
self._display_reference_info(tree, branch, info)
5976
branch.set_reference_info(file_id, path, location)
5978
def _display_reference_info(self, tree, branch, info):
5980
for file_id, (path, location) in info:
5982
path = tree.id2path(file_id)
5983
except errors.NoSuchId:
5985
ref_list.append((path, location))
5986
for path, location in sorted(ref_list):
5987
self.outf.write('%s %s\n' % (path, location))
5990
def _register_lazy_builtins():
5991
# register lazy builtins from other modules; called at startup and should
5992
# be only called once.
5993
for (name, aliases, module_name) in [
5994
('cmd_bundle_info', [], 'bzrlib.bundle.commands'),
5995
('cmd_dpush', [], 'bzrlib.foreign'),
5996
('cmd_version_info', [], 'bzrlib.cmd_version_info'),
5997
('cmd_resolve', ['resolved'], 'bzrlib.conflicts'),
5998
('cmd_conflicts', [], 'bzrlib.conflicts'),
5999
('cmd_sign_my_commits', [], 'bzrlib.sign_my_commits'),
6001
builtin_command_registry.register_lazy(name, aliases, module_name)
added
removed
bzrlib/builtins.py
