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 or shelved 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)
514
if working.get_shelf_manager().last_shelf() is not None:
515
raise errors.ShelvedChanges(working)
517
if working.user_url != working.branch.user_url:
518
raise errors.BzrCommandError("You cannot remove the working tree"
519
" from a lightweight checkout")
521
d.destroy_workingtree()
524
class cmd_revno(Command):
525
__doc__ = """Show current revision number.
527
This is equal to the number of revisions on this branch.
531
takes_args = ['location?']
533
Option('tree', help='Show revno of working tree'),
537
def run(self, tree=False, location=u'.'):
540
wt = WorkingTree.open_containing(location)[0]
541
self.add_cleanup(wt.lock_read().unlock)
542
except (errors.NoWorkingTree, errors.NotLocalUrl):
543
raise errors.NoWorkingTree(location)
544
revid = wt.last_revision()
546
revno_t = wt.branch.revision_id_to_dotted_revno(revid)
547
except errors.NoSuchRevision:
549
revno = ".".join(str(n) for n in revno_t)
551
b = Branch.open_containing(location)[0]
552
self.add_cleanup(b.lock_read().unlock)
555
self.outf.write(str(revno) + '\n')
558
class cmd_revision_info(Command):
559
__doc__ = """Show revision number and revision id for a given revision identifier.
562
takes_args = ['revision_info*']
565
custom_help('directory',
566
help='Branch to examine, '
567
'rather than the one containing the working directory.'),
568
Option('tree', help='Show revno of working tree'),
572
def run(self, revision=None, directory=u'.', tree=False,
573
revision_info_list=[]):
576
wt = WorkingTree.open_containing(directory)[0]
578
self.add_cleanup(wt.lock_read().unlock)
579
except (errors.NoWorkingTree, errors.NotLocalUrl):
581
b = Branch.open_containing(directory)[0]
582
self.add_cleanup(b.lock_read().unlock)
584
if revision is not None:
585
revision_ids.extend(rev.as_revision_id(b) for rev in revision)
586
if revision_info_list is not None:
587
for rev_str in revision_info_list:
588
rev_spec = RevisionSpec.from_string(rev_str)
589
revision_ids.append(rev_spec.as_revision_id(b))
590
# No arguments supplied, default to the last revision
591
if len(revision_ids) == 0:
594
raise errors.NoWorkingTree(directory)
595
revision_ids.append(wt.last_revision())
597
revision_ids.append(b.last_revision())
601
for revision_id in revision_ids:
603
dotted_revno = b.revision_id_to_dotted_revno(revision_id)
604
revno = '.'.join(str(i) for i in dotted_revno)
605
except errors.NoSuchRevision:
607
maxlen = max(maxlen, len(revno))
608
revinfos.append([revno, revision_id])
612
self.outf.write('%*s %s\n' % (maxlen, ri[0], ri[1]))
615
class cmd_add(Command):
616
__doc__ = """Add specified files or directories.
618
In non-recursive mode, all the named items are added, regardless
619
of whether they were previously ignored. A warning is given if
620
any of the named files are already versioned.
622
In recursive mode (the default), files are treated the same way
623
but the behaviour for directories is different. Directories that
624
are already versioned do not give a warning. All directories,
625
whether already versioned or not, are searched for files or
626
subdirectories that are neither versioned or ignored, and these
627
are added. This search proceeds recursively into versioned
628
directories. If no names are given '.' is assumed.
630
Therefore simply saying 'bzr add' will version all files that
631
are currently unknown.
633
Adding a file whose parent directory is not versioned will
634
implicitly add the parent, and so on up to the root. This means
635
you should never need to explicitly add a directory, they'll just
636
get added when you add a file in the directory.
638
--dry-run will show which files would be added, but not actually
641
--file-ids-from will try to use the file ids from the supplied path.
642
It looks up ids trying to find a matching parent directory with the
643
same filename, and then by pure path. This option is rarely needed
644
but can be useful when adding the same logical file into two
645
branches that will be merged later (without showing the two different
646
adds as a conflict). It is also useful when merging another project
647
into a subdirectory of this one.
649
Any files matching patterns in the ignore list will not be added
650
unless they are explicitly mentioned.
652
takes_args = ['file*']
655
help="Don't recursively add the contents of directories."),
657
help="Show what would be done, but don't actually do anything."),
659
Option('file-ids-from',
661
help='Lookup file ids from this tree.'),
663
encoding_type = 'replace'
664
_see_also = ['remove', 'ignore']
666
def run(self, file_list, no_recurse=False, dry_run=False, verbose=False,
671
if file_ids_from is not None:
673
base_tree, base_path = WorkingTree.open_containing(
675
except errors.NoWorkingTree:
676
base_branch, base_path = Branch.open_containing(
678
base_tree = base_branch.basis_tree()
680
action = bzrlib.add.AddFromBaseAction(base_tree, base_path,
681
to_file=self.outf, should_print=(not is_quiet()))
683
action = bzrlib.add.AddAction(to_file=self.outf,
684
should_print=(not is_quiet()))
687
self.add_cleanup(base_tree.lock_read().unlock)
688
tree, file_list = tree_files_for_add(file_list)
689
added, ignored = tree.smart_add(file_list, not
690
no_recurse, action=action, save=not dry_run)
694
for glob in sorted(ignored.keys()):
695
for path in ignored[glob]:
696
self.outf.write("ignored %s matching \"%s\"\n"
700
class cmd_mkdir(Command):
701
__doc__ = """Create a new versioned directory.
703
This is equivalent to creating the directory and then adding it.
706
takes_args = ['dir+']
707
encoding_type = 'replace'
709
def run(self, dir_list):
711
wt, dd = WorkingTree.open_containing(d)
712
base = os.path.dirname(dd)
713
id = wt.path2id(base)
717
self.outf.write('added %s\n' % d)
719
raise errors.NotVersionedError(path=base)
722
class cmd_relpath(Command):
723
__doc__ = """Show path of a file relative to root"""
725
takes_args = ['filename']
729
def run(self, filename):
730
# TODO: jam 20050106 Can relpath return a munged path if
731
# sys.stdout encoding cannot represent it?
732
tree, relpath = WorkingTree.open_containing(filename)
733
self.outf.write(relpath)
734
self.outf.write('\n')
737
class cmd_inventory(Command):
738
__doc__ = """Show inventory of the current working copy or a revision.
740
It is possible to limit the output to a particular entry
741
type using the --kind option. For example: --kind file.
743
It is also possible to restrict the list of files to a specific
744
set. For example: bzr inventory --show-ids this/file
753
help='List entries of a particular kind: file, directory, symlink.',
756
takes_args = ['file*']
759
def run(self, revision=None, show_ids=False, kind=None, file_list=None):
760
if kind and kind not in ['file', 'directory', 'symlink']:
761
raise errors.BzrCommandError('invalid kind %r specified' % (kind,))
763
revision = _get_one_revision('inventory', revision)
764
work_tree, file_list = tree_files(file_list)
765
self.add_cleanup(work_tree.lock_read().unlock)
766
if revision is not None:
767
tree = revision.as_tree(work_tree.branch)
769
extra_trees = [work_tree]
770
self.add_cleanup(tree.lock_read().unlock)
775
if file_list is not None:
776
file_ids = tree.paths2ids(file_list, trees=extra_trees,
777
require_versioned=True)
778
# find_ids_across_trees may include some paths that don't
780
entries = sorted((tree.id2path(file_id), tree.inventory[file_id])
781
for file_id in file_ids if file_id in tree)
783
entries = tree.inventory.entries()
786
for path, entry in entries:
787
if kind and kind != entry.kind:
790
self.outf.write('%-50s %s\n' % (path, entry.file_id))
792
self.outf.write(path)
793
self.outf.write('\n')
796
class cmd_mv(Command):
797
__doc__ = """Move or rename a file.
800
bzr mv OLDNAME NEWNAME
802
bzr mv SOURCE... DESTINATION
804
If the last argument is a versioned directory, all the other names
805
are moved into it. Otherwise, there must be exactly two arguments
806
and the file is changed to a new name.
808
If OLDNAME does not exist on the filesystem but is versioned and
809
NEWNAME does exist on the filesystem but is not versioned, mv
810
assumes that the file has been manually moved and only updates
811
its internal inventory to reflect that change.
812
The same is valid when moving many SOURCE files to a DESTINATION.
814
Files cannot be moved between branches.
817
takes_args = ['names*']
818
takes_options = [Option("after", help="Move only the bzr identifier"
819
" of the file, because the file has already been moved."),
820
Option('auto', help='Automatically guess renames.'),
821
Option('dry-run', help='Avoid making changes when guessing renames.'),
823
aliases = ['move', 'rename']
824
encoding_type = 'replace'
826
def run(self, names_list, after=False, auto=False, dry_run=False):
828
return self.run_auto(names_list, after, dry_run)
830
raise errors.BzrCommandError('--dry-run requires --auto.')
831
if names_list is None:
833
if len(names_list) < 2:
834
raise errors.BzrCommandError("missing file argument")
835
tree, rel_names = tree_files(names_list, canonicalize=False)
836
self.add_cleanup(tree.lock_tree_write().unlock)
837
self._run(tree, names_list, rel_names, after)
839
def run_auto(self, names_list, after, dry_run):
840
if names_list is not None and len(names_list) > 1:
841
raise errors.BzrCommandError('Only one path may be specified to'
844
raise errors.BzrCommandError('--after cannot be specified with'
846
work_tree, file_list = tree_files(names_list, default_branch='.')
847
self.add_cleanup(work_tree.lock_tree_write().unlock)
848
rename_map.RenameMap.guess_renames(work_tree, dry_run)
850
def _run(self, tree, names_list, rel_names, after):
851
into_existing = osutils.isdir(names_list[-1])
852
if into_existing and len(names_list) == 2:
854
# a. case-insensitive filesystem and change case of dir
855
# b. move directory after the fact (if the source used to be
856
# a directory, but now doesn't exist in the working tree
857
# and the target is an existing directory, just rename it)
858
if (not tree.case_sensitive
859
and rel_names[0].lower() == rel_names[1].lower()):
860
into_existing = False
863
# 'fix' the case of a potential 'from'
864
from_id = tree.path2id(
865
tree.get_canonical_inventory_path(rel_names[0]))
866
if (not osutils.lexists(names_list[0]) and
867
from_id and inv.get_file_kind(from_id) == "directory"):
868
into_existing = False
871
# move into existing directory
872
# All entries reference existing inventory items, so fix them up
873
# for cicp file-systems.
874
rel_names = tree.get_canonical_inventory_paths(rel_names)
875
for src, dest in tree.move(rel_names[:-1], rel_names[-1], after=after):
877
self.outf.write("%s => %s\n" % (src, dest))
879
if len(names_list) != 2:
880
raise errors.BzrCommandError('to mv multiple files the'
881
' destination must be a versioned'
884
# for cicp file-systems: the src references an existing inventory
886
src = tree.get_canonical_inventory_path(rel_names[0])
887
# Find the canonical version of the destination: In all cases, the
888
# parent of the target must be in the inventory, so we fetch the
889
# canonical version from there (we do not always *use* the
890
# canonicalized tail portion - we may be attempting to rename the
892
canon_dest = tree.get_canonical_inventory_path(rel_names[1])
893
dest_parent = osutils.dirname(canon_dest)
894
spec_tail = osutils.basename(rel_names[1])
895
# For a CICP file-system, we need to avoid creating 2 inventory
896
# entries that differ only by case. So regardless of the case
897
# we *want* to use (ie, specified by the user or the file-system),
898
# we must always choose to use the case of any existing inventory
899
# items. The only exception to this is when we are attempting a
900
# case-only rename (ie, canonical versions of src and dest are
902
dest_id = tree.path2id(canon_dest)
903
if dest_id is None or tree.path2id(src) == dest_id:
904
# No existing item we care about, so work out what case we
905
# are actually going to use.
907
# If 'after' is specified, the tail must refer to a file on disk.
909
dest_parent_fq = osutils.pathjoin(tree.basedir, dest_parent)
911
# pathjoin with an empty tail adds a slash, which breaks
913
dest_parent_fq = tree.basedir
915
dest_tail = osutils.canonical_relpath(
917
osutils.pathjoin(dest_parent_fq, spec_tail))
919
# not 'after', so case as specified is used
920
dest_tail = spec_tail
922
# Use the existing item so 'mv' fails with AlreadyVersioned.
923
dest_tail = os.path.basename(canon_dest)
924
dest = osutils.pathjoin(dest_parent, dest_tail)
925
mutter("attempting to move %s => %s", src, dest)
926
tree.rename_one(src, dest, after=after)
928
self.outf.write("%s => %s\n" % (src, dest))
931
class cmd_pull(Command):
932
__doc__ = """Turn this branch into a mirror of another branch.
934
By default, this command only works on branches that have not diverged.
935
Branches are considered diverged if the destination branch's most recent
936
commit is one that has not been merged (directly or indirectly) into the
939
If branches have diverged, you can use 'bzr merge' to integrate the changes
940
from one into the other. Once one branch has merged, the other should
941
be able to pull it again.
943
If you want to replace your local changes and just want your branch to
944
match the remote one, use pull --overwrite. This will work even if the two
945
branches have diverged.
947
If there is no default location set, the first pull will set it. After
948
that, you can omit the location to use the default. To change the
949
default, use --remember. The value will only be saved if the remote
950
location can be accessed.
952
Note: The location can be specified either in the form of a branch,
953
or in the form of a path to a file containing a merge directive generated
957
_see_also = ['push', 'update', 'status-flags', 'send']
958
takes_options = ['remember', 'overwrite', 'revision',
959
custom_help('verbose',
960
help='Show logs of pulled revisions.'),
961
custom_help('directory',
962
help='Branch to pull into, '
963
'rather than the one containing the working directory.'),
965
help="Perform a local pull in a bound "
966
"branch. Local pulls are not applied to "
970
takes_args = ['location?']
971
encoding_type = 'replace'
973
def run(self, location=None, remember=False, overwrite=False,
974
revision=None, verbose=False,
975
directory=None, local=False):
976
# FIXME: too much stuff is in the command class
979
if directory is None:
982
tree_to = WorkingTree.open_containing(directory)[0]
983
branch_to = tree_to.branch
984
self.add_cleanup(tree_to.lock_write().unlock)
985
except errors.NoWorkingTree:
987
branch_to = Branch.open_containing(directory)[0]
988
self.add_cleanup(branch_to.lock_write().unlock)
990
if local and not branch_to.get_bound_location():
991
raise errors.LocalRequiresBoundBranch()
993
possible_transports = []
994
if location is not None:
996
mergeable = bundle.read_mergeable_from_url(location,
997
possible_transports=possible_transports)
998
except errors.NotABundle:
1001
stored_loc = branch_to.get_parent()
1002
if location is None:
1003
if stored_loc is None:
1004
raise errors.BzrCommandError("No pull location known or"
1007
display_url = urlutils.unescape_for_display(stored_loc,
1010
self.outf.write("Using saved parent location: %s\n" % display_url)
1011
location = stored_loc
1013
revision = _get_one_revision('pull', revision)
1014
if mergeable is not None:
1015
if revision is not None:
1016
raise errors.BzrCommandError(
1017
'Cannot use -r with merge directives or bundles')
1018
mergeable.install_revisions(branch_to.repository)
1019
base_revision_id, revision_id, verified = \
1020
mergeable.get_merge_request(branch_to.repository)
1021
branch_from = branch_to
1023
branch_from = Branch.open(location,
1024
possible_transports=possible_transports)
1025
self.add_cleanup(branch_from.lock_read().unlock)
1027
if branch_to.get_parent() is None or remember:
1028
branch_to.set_parent(branch_from.base)
1030
if revision is not None:
1031
revision_id = revision.as_revision_id(branch_from)
1033
if tree_to is not None:
1034
view_info = _get_view_info_for_change_reporter(tree_to)
1035
change_reporter = delta._ChangeReporter(
1036
unversioned_filter=tree_to.is_ignored,
1037
view_info=view_info)
1038
result = tree_to.pull(
1039
branch_from, overwrite, revision_id, change_reporter,
1040
possible_transports=possible_transports, local=local)
1042
result = branch_to.pull(
1043
branch_from, overwrite, revision_id, local=local)
1045
result.report(self.outf)
1046
if verbose and result.old_revid != result.new_revid:
1047
log.show_branch_change(
1048
branch_to, self.outf, result.old_revno,
1052
class cmd_push(Command):
1053
__doc__ = """Update a mirror of this branch.
1055
The target branch will not have its working tree populated because this
1056
is both expensive, and is not supported on remote file systems.
1058
Some smart servers or protocols *may* put the working tree in place in
1061
This command only works on branches that have not diverged. Branches are
1062
considered diverged if the destination branch's most recent commit is one
1063
that has not been merged (directly or indirectly) by the source branch.
1065
If branches have diverged, you can use 'bzr push --overwrite' to replace
1066
the other branch completely, discarding its unmerged changes.
1068
If you want to ensure you have the different changes in the other branch,
1069
do a merge (see bzr help merge) from the other branch, and commit that.
1070
After that you will be able to do a push without '--overwrite'.
1072
If there is no default push location set, the first push will set it.
1073
After that, you can omit the location to use the default. To change the
1074
default, use --remember. The value will only be saved if the remote
1075
location can be accessed.
1078
_see_also = ['pull', 'update', 'working-trees']
1079
takes_options = ['remember', 'overwrite', 'verbose', 'revision',
1080
Option('create-prefix',
1081
help='Create the path leading up to the branch '
1082
'if it does not already exist.'),
1083
custom_help('directory',
1084
help='Branch to push from, '
1085
'rather than the one containing the working directory.'),
1086
Option('use-existing-dir',
1087
help='By default push will fail if the target'
1088
' directory exists, but does not already'
1089
' have a control directory. This flag will'
1090
' allow push to proceed.'),
1092
help='Create a stacked branch that references the public location '
1093
'of the parent branch.'),
1094
Option('stacked-on',
1095
help='Create a stacked branch that refers to another branch '
1096
'for the commit history. Only the work not present in the '
1097
'referenced branch is included in the branch created.',
1100
help='Refuse to push if there are uncommitted changes in'
1101
' the working tree, --no-strict disables the check.'),
1103
takes_args = ['location?']
1104
encoding_type = 'replace'
1106
def run(self, location=None, remember=False, overwrite=False,
1107
create_prefix=False, verbose=False, revision=None,
1108
use_existing_dir=False, directory=None, stacked_on=None,
1109
stacked=False, strict=None):
1110
from bzrlib.push import _show_push_branch
1112
if directory is None:
1114
# Get the source branch
1116
_unused) = bzrdir.BzrDir.open_containing_tree_or_branch(directory)
1117
# Get the tip's revision_id
1118
revision = _get_one_revision('push', revision)
1119
if revision is not None:
1120
revision_id = revision.in_history(br_from).rev_id
1123
if tree is not None and revision_id is None:
1124
tree.check_changed_or_out_of_date(
1125
strict, 'push_strict',
1126
more_error='Use --no-strict to force the push.',
1127
more_warning='Uncommitted changes will not be pushed.')
1128
# Get the stacked_on branch, if any
1129
if stacked_on is not None:
1130
stacked_on = urlutils.normalize_url(stacked_on)
1132
parent_url = br_from.get_parent()
1134
parent = Branch.open(parent_url)
1135
stacked_on = parent.get_public_branch()
1137
# I considered excluding non-http url's here, thus forcing
1138
# 'public' branches only, but that only works for some
1139
# users, so it's best to just depend on the user spotting an
1140
# error by the feedback given to them. RBC 20080227.
1141
stacked_on = parent_url
1143
raise errors.BzrCommandError(
1144
"Could not determine branch to refer to.")
1146
# Get the destination location
1147
if location is None:
1148
stored_loc = br_from.get_push_location()
1149
if stored_loc is None:
1150
raise errors.BzrCommandError(
1151
"No push location known or specified.")
1153
display_url = urlutils.unescape_for_display(stored_loc,
1155
self.outf.write("Using saved push location: %s\n" % display_url)
1156
location = stored_loc
1158
_show_push_branch(br_from, revision_id, location, self.outf,
1159
verbose=verbose, overwrite=overwrite, remember=remember,
1160
stacked_on=stacked_on, create_prefix=create_prefix,
1161
use_existing_dir=use_existing_dir)
1164
class cmd_branch(Command):
1165
__doc__ = """Create a new branch that is a copy of an existing branch.
1167
If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
1168
be used. In other words, "branch ../foo/bar" will attempt to create ./bar.
1169
If the FROM_LOCATION has no / or path separator embedded, the TO_LOCATION
1170
is derived from the FROM_LOCATION by stripping a leading scheme or drive
1171
identifier, if any. For example, "branch lp:foo-bar" will attempt to
1174
To retrieve the branch as of a particular revision, supply the --revision
1175
parameter, as in "branch foo/bar -r 5".
1178
_see_also = ['checkout']
1179
takes_args = ['from_location', 'to_location?']
1180
takes_options = ['revision', Option('hardlink',
1181
help='Hard-link working tree files where possible.'),
1183
help="Create a branch without a working-tree."),
1185
help="Switch the checkout in the current directory "
1186
"to the new branch."),
1188
help='Create a stacked branch referring to the source branch. '
1189
'The new branch will depend on the availability of the source '
1190
'branch for all operations.'),
1191
Option('standalone',
1192
help='Do not use a shared repository, even if available.'),
1193
Option('use-existing-dir',
1194
help='By default branch will fail if the target'
1195
' directory exists, but does not already'
1196
' have a control directory. This flag will'
1197
' allow branch to proceed.'),
1199
help="Bind new branch to from location."),
1201
aliases = ['get', 'clone']
1203
def run(self, from_location, to_location=None, revision=None,
1204
hardlink=False, stacked=False, standalone=False, no_tree=False,
1205
use_existing_dir=False, switch=False, bind=False):
1206
from bzrlib import switch as _mod_switch
1207
from bzrlib.tag import _merge_tags_if_possible
1208
accelerator_tree, br_from = bzrdir.BzrDir.open_tree_or_branch(
1210
revision = _get_one_revision('branch', revision)
1211
self.add_cleanup(br_from.lock_read().unlock)
1212
if revision is not None:
1213
revision_id = revision.as_revision_id(br_from)
1215
# FIXME - wt.last_revision, fallback to branch, fall back to
1216
# None or perhaps NULL_REVISION to mean copy nothing
1218
revision_id = br_from.last_revision()
1219
if to_location is None:
1220
to_location = urlutils.derive_to_location(from_location)
1221
to_transport = transport.get_transport(to_location)
1223
to_transport.mkdir('.')
1224
except errors.FileExists:
1225
if not use_existing_dir:
1226
raise errors.BzrCommandError('Target directory "%s" '
1227
'already exists.' % to_location)
1230
bzrdir.BzrDir.open_from_transport(to_transport)
1231
except errors.NotBranchError:
1234
raise errors.AlreadyBranchError(to_location)
1235
except errors.NoSuchFile:
1236
raise errors.BzrCommandError('Parent of "%s" does not exist.'
1239
# preserve whatever source format we have.
1240
dir = br_from.bzrdir.sprout(to_transport.base, revision_id,
1241
possible_transports=[to_transport],
1242
accelerator_tree=accelerator_tree,
1243
hardlink=hardlink, stacked=stacked,
1244
force_new_repo=standalone,
1245
create_tree_if_local=not no_tree,
1246
source_branch=br_from)
1247
branch = dir.open_branch()
1248
except errors.NoSuchRevision:
1249
to_transport.delete_tree('.')
1250
msg = "The branch %s has no revision %s." % (from_location,
1252
raise errors.BzrCommandError(msg)
1253
_merge_tags_if_possible(br_from, branch)
1254
# If the source branch is stacked, the new branch may
1255
# be stacked whether we asked for that explicitly or not.
1256
# We therefore need a try/except here and not just 'if stacked:'
1258
note('Created new stacked branch referring to %s.' %
1259
branch.get_stacked_on_url())
1260
except (errors.NotStacked, errors.UnstackableBranchFormat,
1261
errors.UnstackableRepositoryFormat), e:
1262
note('Branched %d revision(s).' % branch.revno())
1264
# Bind to the parent
1265
parent_branch = Branch.open(from_location)
1266
branch.bind(parent_branch)
1267
note('New branch bound to %s' % from_location)
1269
# Switch to the new branch
1270
wt, _ = WorkingTree.open_containing('.')
1271
_mod_switch.switch(wt.bzrdir, branch)
1272
note('Switched to branch: %s',
1273
urlutils.unescape_for_display(branch.base, 'utf-8'))
1276
class cmd_checkout(Command):
1277
__doc__ = """Create a new checkout of an existing branch.
1279
If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
1280
the branch found in '.'. This is useful if you have removed the working tree
1281
or if it was never created - i.e. if you pushed the branch to its current
1282
location using SFTP.
1284
If the TO_LOCATION is omitted, the last component of the BRANCH_LOCATION will
1285
be used. In other words, "checkout ../foo/bar" will attempt to create ./bar.
1286
If the BRANCH_LOCATION has no / or path separator embedded, the TO_LOCATION
1287
is derived from the BRANCH_LOCATION by stripping a leading scheme or drive
1288
identifier, if any. For example, "checkout lp:foo-bar" will attempt to
1291
To retrieve the branch as of a particular revision, supply the --revision
1292
parameter, as in "checkout foo/bar -r 5". Note that this will be immediately
1293
out of date [so you cannot commit] but it may be useful (i.e. to examine old
1297
_see_also = ['checkouts', 'branch']
1298
takes_args = ['branch_location?', 'to_location?']
1299
takes_options = ['revision',
1300
Option('lightweight',
1301
help="Perform a lightweight checkout. Lightweight "
1302
"checkouts depend on access to the branch for "
1303
"every operation. Normal checkouts can perform "
1304
"common operations like diff and status without "
1305
"such access, and also support local commits."
1307
Option('files-from', type=str,
1308
help="Get file contents from this tree."),
1310
help='Hard-link working tree files where possible.'
1315
def run(self, branch_location=None, to_location=None, revision=None,
1316
lightweight=False, files_from=None, hardlink=False):
1317
if branch_location is None:
1318
branch_location = osutils.getcwd()
1319
to_location = branch_location
1320
accelerator_tree, source = bzrdir.BzrDir.open_tree_or_branch(
1322
revision = _get_one_revision('checkout', revision)
1323
if files_from is not None:
1324
accelerator_tree = WorkingTree.open(files_from)
1325
if revision is not None:
1326
revision_id = revision.as_revision_id(source)
1329
if to_location is None:
1330
to_location = urlutils.derive_to_location(branch_location)
1331
# if the source and to_location are the same,
1332
# and there is no working tree,
1333
# then reconstitute a branch
1334
if (osutils.abspath(to_location) ==
1335
osutils.abspath(branch_location)):
1337
source.bzrdir.open_workingtree()
1338
except errors.NoWorkingTree:
1339
source.bzrdir.create_workingtree(revision_id)
1341
source.create_checkout(to_location, revision_id, lightweight,
1342
accelerator_tree, hardlink)
1345
class cmd_renames(Command):
1346
__doc__ = """Show list of renamed files.
1348
# TODO: Option to show renames between two historical versions.
1350
# TODO: Only show renames under dir, rather than in the whole branch.
1351
_see_also = ['status']
1352
takes_args = ['dir?']
1355
def run(self, dir=u'.'):
1356
tree = WorkingTree.open_containing(dir)[0]
1357
self.add_cleanup(tree.lock_read().unlock)
1358
new_inv = tree.inventory
1359
old_tree = tree.basis_tree()
1360
self.add_cleanup(old_tree.lock_read().unlock)
1361
old_inv = old_tree.inventory
1363
iterator = tree.iter_changes(old_tree, include_unchanged=True)
1364
for f, paths, c, v, p, n, k, e in iterator:
1365
if paths[0] == paths[1]:
1369
renames.append(paths)
1371
for old_name, new_name in renames:
1372
self.outf.write("%s => %s\n" % (old_name, new_name))
1375
class cmd_update(Command):
1376
__doc__ = """Update a tree to have the latest code committed to its branch.
1378
This will perform a merge into the working tree, and may generate
1379
conflicts. If you have any local changes, you will still
1380
need to commit them after the update for the update to be complete.
1382
If you want to discard your local changes, you can just do a
1383
'bzr revert' instead of 'bzr commit' after the update.
1385
If the tree's branch is bound to a master branch, it will also update
1386
the branch from the master.
1389
_see_also = ['pull', 'working-trees', 'status-flags']
1390
takes_args = ['dir?']
1391
takes_options = ['revision']
1394
def run(self, dir='.', revision=None):
1395
if revision is not None and len(revision) != 1:
1396
raise errors.BzrCommandError(
1397
"bzr update --revision takes exactly one revision")
1398
tree = WorkingTree.open_containing(dir)[0]
1399
branch = tree.branch
1400
possible_transports = []
1401
master = branch.get_master_branch(
1402
possible_transports=possible_transports)
1403
if master is not None:
1404
branch_location = master.base
1407
branch_location = tree.branch.base
1408
tree.lock_tree_write()
1409
self.add_cleanup(tree.unlock)
1410
# get rid of the final '/' and be ready for display
1411
branch_location = urlutils.unescape_for_display(
1412
branch_location.rstrip('/'),
1414
existing_pending_merges = tree.get_parent_ids()[1:]
1418
# may need to fetch data into a heavyweight checkout
1419
# XXX: this may take some time, maybe we should display a
1421
old_tip = branch.update(possible_transports)
1422
if revision is not None:
1423
revision_id = revision[0].as_revision_id(branch)
1425
revision_id = branch.last_revision()
1426
if revision_id == _mod_revision.ensure_null(tree.last_revision()):
1427
revno = branch.revision_id_to_dotted_revno(revision_id)
1428
note("Tree is up to date at revision %s of branch %s" %
1429
('.'.join(map(str, revno)), branch_location))
1431
view_info = _get_view_info_for_change_reporter(tree)
1432
change_reporter = delta._ChangeReporter(
1433
unversioned_filter=tree.is_ignored,
1434
view_info=view_info)
1436
conflicts = tree.update(
1438
possible_transports=possible_transports,
1439
revision=revision_id,
1441
except errors.NoSuchRevision, e:
1442
raise errors.BzrCommandError(
1443
"branch has no revision %s\n"
1444
"bzr update --revision only works"
1445
" for a revision in the branch history"
1447
revno = tree.branch.revision_id_to_dotted_revno(
1448
_mod_revision.ensure_null(tree.last_revision()))
1449
note('Updated to revision %s of branch %s' %
1450
('.'.join(map(str, revno)), branch_location))
1451
parent_ids = tree.get_parent_ids()
1452
if parent_ids[1:] and parent_ids[1:] != existing_pending_merges:
1453
note('Your local commits will now show as pending merges with '
1454
"'bzr status', and can be committed with 'bzr commit'.")
1461
class cmd_info(Command):
1462
__doc__ = """Show information about a working tree, branch or repository.
1464
This command will show all known locations and formats associated to the
1465
tree, branch or repository.
1467
In verbose mode, statistical information is included with each report.
1468
To see extended statistic information, use a verbosity level of 2 or
1469
higher by specifying the verbose option multiple times, e.g. -vv.
1471
Branches and working trees will also report any missing revisions.
1475
Display information on the format and related locations:
1479
Display the above together with extended format information and
1480
basic statistics (like the number of files in the working tree and
1481
number of revisions in the branch and repository):
1485
Display the above together with number of committers to the branch:
1489
_see_also = ['revno', 'working-trees', 'repositories']
1490
takes_args = ['location?']
1491
takes_options = ['verbose']
1492
encoding_type = 'replace'
1495
def run(self, location=None, verbose=False):
1497
noise_level = get_verbosity_level()
1500
from bzrlib.info import show_bzrdir_info
1501
show_bzrdir_info(bzrdir.BzrDir.open_containing(location)[0],
1502
verbose=noise_level, outfile=self.outf)
1505
class cmd_remove(Command):
1506
__doc__ = """Remove files or directories.
1508
This makes bzr stop tracking changes to the specified files. bzr will delete
1509
them if they can easily be recovered using revert. If no options or
1510
parameters are given bzr will scan for files that are being tracked by bzr
1511
but missing in your tree and stop tracking them for you.
1513
takes_args = ['file*']
1514
takes_options = ['verbose',
1515
Option('new', help='Only remove files that have never been committed.'),
1516
RegistryOption.from_kwargs('file-deletion-strategy',
1517
'The file deletion mode to be used.',
1518
title='Deletion Strategy', value_switches=True, enum_switch=False,
1519
safe='Only delete files if they can be'
1520
' safely recovered (default).',
1521
keep='Delete from bzr but leave the working copy.',
1522
force='Delete all the specified files, even if they can not be '
1523
'recovered and even if they are non-empty directories.')]
1524
aliases = ['rm', 'del']
1525
encoding_type = 'replace'
1527
def run(self, file_list, verbose=False, new=False,
1528
file_deletion_strategy='safe'):
1529
tree, file_list = tree_files(file_list)
1531
if file_list is not None:
1532
file_list = [f for f in file_list]
1534
self.add_cleanup(tree.lock_write().unlock)
1535
# Heuristics should probably all move into tree.remove_smart or
1538
added = tree.changes_from(tree.basis_tree(),
1539
specific_files=file_list).added
1540
file_list = sorted([f[0] for f in added], reverse=True)
1541
if len(file_list) == 0:
1542
raise errors.BzrCommandError('No matching files.')
1543
elif file_list is None:
1544
# missing files show up in iter_changes(basis) as
1545
# versioned-with-no-kind.
1547
for change in tree.iter_changes(tree.basis_tree()):
1548
# Find paths in the working tree that have no kind:
1549
if change[1][1] is not None and change[6][1] is None:
1550
missing.append(change[1][1])
1551
file_list = sorted(missing, reverse=True)
1552
file_deletion_strategy = 'keep'
1553
tree.remove(file_list, verbose=verbose, to_file=self.outf,
1554
keep_files=file_deletion_strategy=='keep',
1555
force=file_deletion_strategy=='force')
1558
class cmd_file_id(Command):
1559
__doc__ = """Print file_id of a particular file or directory.
1561
The file_id is assigned when the file is first added and remains the
1562
same through all revisions where the file exists, even when it is
1567
_see_also = ['inventory', 'ls']
1568
takes_args = ['filename']
1571
def run(self, filename):
1572
tree, relpath = WorkingTree.open_containing(filename)
1573
i = tree.path2id(relpath)
1575
raise errors.NotVersionedError(filename)
1577
self.outf.write(i + '\n')
1580
class cmd_file_path(Command):
1581
__doc__ = """Print path of file_ids to a file or directory.
1583
This prints one line for each directory down to the target,
1584
starting at the branch root.
1588
takes_args = ['filename']
1591
def run(self, filename):
1592
tree, relpath = WorkingTree.open_containing(filename)
1593
fid = tree.path2id(relpath)
1595
raise errors.NotVersionedError(filename)
1596
segments = osutils.splitpath(relpath)
1597
for pos in range(1, len(segments) + 1):
1598
path = osutils.joinpath(segments[:pos])
1599
self.outf.write("%s\n" % tree.path2id(path))
1602
class cmd_reconcile(Command):
1603
__doc__ = """Reconcile bzr metadata in a branch.
1605
This can correct data mismatches that may have been caused by
1606
previous ghost operations or bzr upgrades. You should only
1607
need to run this command if 'bzr check' or a bzr developer
1608
advises you to run it.
1610
If a second branch is provided, cross-branch reconciliation is
1611
also attempted, which will check that data like the tree root
1612
id which was not present in very early bzr versions is represented
1613
correctly in both branches.
1615
At the same time it is run it may recompress data resulting in
1616
a potential saving in disk space or performance gain.
1618
The branch *MUST* be on a listable system such as local disk or sftp.
1621
_see_also = ['check']
1622
takes_args = ['branch?']
1624
def run(self, branch="."):
1625
from bzrlib.reconcile import reconcile
1626
dir = bzrdir.BzrDir.open(branch)
1630
class cmd_revision_history(Command):
1631
__doc__ = """Display the list of revision ids on a branch."""
1634
takes_args = ['location?']
1639
def run(self, location="."):
1640
branch = Branch.open_containing(location)[0]
1641
for revid in branch.revision_history():
1642
self.outf.write(revid)
1643
self.outf.write('\n')
1646
class cmd_ancestry(Command):
1647
__doc__ = """List all revisions merged into this branch."""
1649
_see_also = ['log', 'revision-history']
1650
takes_args = ['location?']
1655
def run(self, location="."):
1657
wt = WorkingTree.open_containing(location)[0]
1658
except errors.NoWorkingTree:
1659
b = Branch.open(location)
1660
last_revision = b.last_revision()
1663
last_revision = wt.last_revision()
1665
revision_ids = b.repository.get_ancestry(last_revision)
1667
for revision_id in revision_ids:
1668
self.outf.write(revision_id + '\n')
1671
class cmd_init(Command):
1672
__doc__ = """Make a directory into a versioned branch.
1674
Use this to create an empty branch, or before importing an
1677
If there is a repository in a parent directory of the location, then
1678
the history of the branch will be stored in the repository. Otherwise
1679
init creates a standalone branch which carries its own history
1680
in the .bzr directory.
1682
If there is already a branch at the location but it has no working tree,
1683
the tree can be populated with 'bzr checkout'.
1685
Recipe for importing a tree of files::
1691
bzr commit -m "imported project"
1694
_see_also = ['init-repository', 'branch', 'checkout']
1695
takes_args = ['location?']
1697
Option('create-prefix',
1698
help='Create the path leading up to the branch '
1699
'if it does not already exist.'),
1700
RegistryOption('format',
1701
help='Specify a format for this branch. '
1702
'See "help formats".',
1703
lazy_registry=('bzrlib.bzrdir', 'format_registry'),
1704
converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
1705
value_switches=True,
1706
title="Branch format",
1708
Option('append-revisions-only',
1709
help='Never change revnos or the existing log.'
1710
' Append revisions to it only.')
1712
def run(self, location=None, format=None, append_revisions_only=False,
1713
create_prefix=False):
1715
format = bzrdir.format_registry.make_bzrdir('default')
1716
if location is None:
1719
to_transport = transport.get_transport(location)
1721
# The path has to exist to initialize a
1722
# branch inside of it.
1723
# Just using os.mkdir, since I don't
1724
# believe that we want to create a bunch of
1725
# locations if the user supplies an extended path
1727
to_transport.ensure_base()
1728
except errors.NoSuchFile:
1729
if not create_prefix:
1730
raise errors.BzrCommandError("Parent directory of %s"
1732
"\nYou may supply --create-prefix to create all"
1733
" leading parent directories."
1735
to_transport.create_prefix()
1738
a_bzrdir = bzrdir.BzrDir.open_from_transport(to_transport)
1739
except errors.NotBranchError:
1740
# really a NotBzrDir error...
1741
create_branch = bzrdir.BzrDir.create_branch_convenience
1742
branch = create_branch(to_transport.base, format=format,
1743
possible_transports=[to_transport])
1744
a_bzrdir = branch.bzrdir
1746
from bzrlib.transport.local import LocalTransport
1747
if a_bzrdir.has_branch():
1748
if (isinstance(to_transport, LocalTransport)
1749
and not a_bzrdir.has_workingtree()):
1750
raise errors.BranchExistsWithoutWorkingTree(location)
1751
raise errors.AlreadyBranchError(location)
1752
branch = a_bzrdir.create_branch()
1753
a_bzrdir.create_workingtree()
1754
if append_revisions_only:
1756
branch.set_append_revisions_only(True)
1757
except errors.UpgradeRequired:
1758
raise errors.BzrCommandError('This branch format cannot be set'
1759
' to append-revisions-only. Try --default.')
1761
from bzrlib.info import describe_layout, describe_format
1763
tree = a_bzrdir.open_workingtree(recommend_upgrade=False)
1764
except (errors.NoWorkingTree, errors.NotLocalUrl):
1766
repository = branch.repository
1767
layout = describe_layout(repository, branch, tree).lower()
1768
format = describe_format(a_bzrdir, repository, branch, tree)
1769
self.outf.write("Created a %s (format: %s)\n" % (layout, format))
1770
if repository.is_shared():
1771
#XXX: maybe this can be refactored into transport.path_or_url()
1772
url = repository.bzrdir.root_transport.external_url()
1774
url = urlutils.local_path_from_url(url)
1775
except errors.InvalidURL:
1777
self.outf.write("Using shared repository: %s\n" % url)
1780
class cmd_init_repository(Command):
1781
__doc__ = """Create a shared repository for branches to share storage space.
1783
New branches created under the repository directory will store their
1784
revisions in the repository, not in the branch directory. For branches
1785
with shared history, this reduces the amount of storage needed and
1786
speeds up the creation of new branches.
1788
If the --no-trees option is given then the branches in the repository
1789
will not have working trees by default. They will still exist as
1790
directories on disk, but they will not have separate copies of the
1791
files at a certain revision. This can be useful for repositories that
1792
store branches which are interacted with through checkouts or remote
1793
branches, such as on a server.
1796
Create a shared repository holding just branches::
1798
bzr init-repo --no-trees repo
1801
Make a lightweight checkout elsewhere::
1803
bzr checkout --lightweight repo/trunk trunk-checkout
1808
_see_also = ['init', 'branch', 'checkout', 'repositories']
1809
takes_args = ["location"]
1810
takes_options = [RegistryOption('format',
1811
help='Specify a format for this repository. See'
1812
' "bzr help formats" for details.',
1813
lazy_registry=('bzrlib.bzrdir', 'format_registry'),
1814
converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
1815
value_switches=True, title='Repository format'),
1817
help='Branches in the repository will default to'
1818
' not having a working tree.'),
1820
aliases = ["init-repo"]
1822
def run(self, location, format=None, no_trees=False):
1824
format = bzrdir.format_registry.make_bzrdir('default')
1826
if location is None:
1829
to_transport = transport.get_transport(location)
1830
to_transport.ensure_base()
1832
newdir = format.initialize_on_transport(to_transport)
1833
repo = newdir.create_repository(shared=True)
1834
repo.set_make_working_trees(not no_trees)
1836
from bzrlib.info import show_bzrdir_info
1837
show_bzrdir_info(repo.bzrdir, verbose=0, outfile=self.outf)
1840
class cmd_diff(Command):
1841
__doc__ = """Show differences in the working tree, between revisions or branches.
1843
If no arguments are given, all changes for the current tree are listed.
1844
If files are given, only the changes in those files are listed.
1845
Remote and multiple branches can be compared by using the --old and
1846
--new options. If not provided, the default for both is derived from
1847
the first argument, if any, or the current tree if no arguments are
1850
"bzr diff -p1" is equivalent to "bzr diff --prefix old/:new/", and
1851
produces patches suitable for "patch -p1".
1855
2 - unrepresentable changes
1860
Shows the difference in the working tree versus the last commit::
1864
Difference between the working tree and revision 1::
1868
Difference between revision 3 and revision 1::
1872
Difference between revision 3 and revision 1 for branch xxx::
1876
To see the changes introduced in revision X::
1880
Note that in the case of a merge, the -c option shows the changes
1881
compared to the left hand parent. To see the changes against
1882
another parent, use::
1884
bzr diff -r<chosen_parent>..X
1886
The changes introduced by revision 2 (equivalent to -r1..2)::
1890
Show just the differences for file NEWS::
1894
Show the differences in working tree xxx for file NEWS::
1898
Show the differences from branch xxx to this working tree:
1902
Show the differences between two branches for file NEWS::
1904
bzr diff --old xxx --new yyy NEWS
1906
Same as 'bzr diff' but prefix paths with old/ and new/::
1908
bzr diff --prefix old/:new/
1910
_see_also = ['status']
1911
takes_args = ['file*']
1913
Option('diff-options', type=str,
1914
help='Pass these options to the external diff program.'),
1915
Option('prefix', type=str,
1917
help='Set prefixes added to old and new filenames, as '
1918
'two values separated by a colon. (eg "old/:new/").'),
1920
help='Branch/tree to compare from.',
1924
help='Branch/tree to compare to.',
1930
help='Use this command to compare files.',
1933
RegistryOption('format',
1934
help='Diff format to use.',
1935
lazy_registry=('bzrlib.diff', 'format_registry'),
1936
value_switches=False, title='Diff format'),
1938
aliases = ['di', 'dif']
1939
encoding_type = 'exact'
1942
def run(self, revision=None, file_list=None, diff_options=None,
1943
prefix=None, old=None, new=None, using=None, format=None):
1944
from bzrlib.diff import (get_trees_and_branches_to_diff_locked,
1947
if (prefix is None) or (prefix == '0'):
1955
old_label, new_label = prefix.split(":")
1957
raise errors.BzrCommandError(
1958
'--prefix expects two values separated by a colon'
1959
' (eg "old/:new/")')
1961
if revision and len(revision) > 2:
1962
raise errors.BzrCommandError('bzr diff --revision takes exactly'
1963
' one or two revision specifiers')
1965
if using is not None and format is not None:
1966
raise errors.BzrCommandError('--using and --format are mutually '
1969
(old_tree, new_tree,
1970
old_branch, new_branch,
1971
specific_files, extra_trees) = get_trees_and_branches_to_diff_locked(
1972
file_list, revision, old, new, self.add_cleanup, apply_view=True)
1973
return show_diff_trees(old_tree, new_tree, sys.stdout,
1974
specific_files=specific_files,
1975
external_diff_options=diff_options,
1976
old_label=old_label, new_label=new_label,
1977
extra_trees=extra_trees, using=using,
1981
class cmd_deleted(Command):
1982
__doc__ = """List files deleted in the working tree.
1984
# TODO: Show files deleted since a previous revision, or
1985
# between two revisions.
1986
# TODO: Much more efficient way to do this: read in new
1987
# directories with readdir, rather than stating each one. Same
1988
# level of effort but possibly much less IO. (Or possibly not,
1989
# if the directories are very large...)
1990
_see_also = ['status', 'ls']
1991
takes_options = ['directory', 'show-ids']
1994
def run(self, show_ids=False, directory=u'.'):
1995
tree = WorkingTree.open_containing(directory)[0]
1996
self.add_cleanup(tree.lock_read().unlock)
1997
old = tree.basis_tree()
1998
self.add_cleanup(old.lock_read().unlock)
1999
for path, ie in old.inventory.iter_entries():
2000
if not tree.has_id(ie.file_id):
2001
self.outf.write(path)
2003
self.outf.write(' ')
2004
self.outf.write(ie.file_id)
2005
self.outf.write('\n')
2008
class cmd_modified(Command):
2009
__doc__ = """List files modified in working tree.
2013
_see_also = ['status', 'ls']
2014
takes_options = ['directory', 'null']
2017
def run(self, null=False, directory=u'.'):
2018
tree = WorkingTree.open_containing(directory)[0]
2019
td = tree.changes_from(tree.basis_tree())
2020
for path, id, kind, text_modified, meta_modified in td.modified:
2022
self.outf.write(path + '\0')
2024
self.outf.write(osutils.quotefn(path) + '\n')
2027
class cmd_added(Command):
2028
__doc__ = """List files added in working tree.
2032
_see_also = ['status', 'ls']
2033
takes_options = ['directory', 'null']
2036
def run(self, null=False, directory=u'.'):
2037
wt = WorkingTree.open_containing(directory)[0]
2038
self.add_cleanup(wt.lock_read().unlock)
2039
basis = wt.basis_tree()
2040
self.add_cleanup(basis.lock_read().unlock)
2041
basis_inv = basis.inventory
2044
if file_id in basis_inv:
2046
if inv.is_root(file_id) and len(basis_inv) == 0:
2048
path = inv.id2path(file_id)
2049
if not os.access(osutils.pathjoin(wt.basedir, path), os.F_OK):
2052
self.outf.write(path + '\0')
2054
self.outf.write(osutils.quotefn(path) + '\n')
2057
class cmd_root(Command):
2058
__doc__ = """Show the tree root directory.
2060
The root is the nearest enclosing directory with a .bzr control
2063
takes_args = ['filename?']
2065
def run(self, filename=None):
2066
"""Print the branch root."""
2067
tree = WorkingTree.open_containing(filename)[0]
2068
self.outf.write(tree.basedir + '\n')
2071
def _parse_limit(limitstring):
2073
return int(limitstring)
2075
msg = "The limit argument must be an integer."
2076
raise errors.BzrCommandError(msg)
2079
def _parse_levels(s):
2083
msg = "The levels argument must be an integer."
2084
raise errors.BzrCommandError(msg)
2087
class cmd_log(Command):
2088
__doc__ = """Show historical log for a branch or subset of a branch.
2090
log is bzr's default tool for exploring the history of a branch.
2091
The branch to use is taken from the first parameter. If no parameters
2092
are given, the branch containing the working directory is logged.
2093
Here are some simple examples::
2095
bzr log log the current branch
2096
bzr log foo.py log a file in its branch
2097
bzr log http://server/branch log a branch on a server
2099
The filtering, ordering and information shown for each revision can
2100
be controlled as explained below. By default, all revisions are
2101
shown sorted (topologically) so that newer revisions appear before
2102
older ones and descendants always appear before ancestors. If displayed,
2103
merged revisions are shown indented under the revision in which they
2108
The log format controls how information about each revision is
2109
displayed. The standard log formats are called ``long``, ``short``
2110
and ``line``. The default is long. See ``bzr help log-formats``
2111
for more details on log formats.
2113
The following options can be used to control what information is
2116
-l N display a maximum of N revisions
2117
-n N display N levels of revisions (0 for all, 1 for collapsed)
2118
-v display a status summary (delta) for each revision
2119
-p display a diff (patch) for each revision
2120
--show-ids display revision-ids (and file-ids), not just revnos
2122
Note that the default number of levels to display is a function of the
2123
log format. If the -n option is not used, the standard log formats show
2124
just the top level (mainline).
2126
Status summaries are shown using status flags like A, M, etc. To see
2127
the changes explained using words like ``added`` and ``modified``
2128
instead, use the -vv option.
2132
To display revisions from oldest to newest, use the --forward option.
2133
In most cases, using this option will have little impact on the total
2134
time taken to produce a log, though --forward does not incrementally
2135
display revisions like --reverse does when it can.
2137
:Revision filtering:
2139
The -r option can be used to specify what revision or range of revisions
2140
to filter against. The various forms are shown below::
2142
-rX display revision X
2143
-rX.. display revision X and later
2144
-r..Y display up to and including revision Y
2145
-rX..Y display from X to Y inclusive
2147
See ``bzr help revisionspec`` for details on how to specify X and Y.
2148
Some common examples are given below::
2150
-r-1 show just the tip
2151
-r-10.. show the last 10 mainline revisions
2152
-rsubmit:.. show what's new on this branch
2153
-rancestor:path.. show changes since the common ancestor of this
2154
branch and the one at location path
2155
-rdate:yesterday.. show changes since yesterday
2157
When logging a range of revisions using -rX..Y, log starts at
2158
revision Y and searches back in history through the primary
2159
("left-hand") parents until it finds X. When logging just the
2160
top level (using -n1), an error is reported if X is not found
2161
along the way. If multi-level logging is used (-n0), X may be
2162
a nested merge revision and the log will be truncated accordingly.
2166
If parameters are given and the first one is not a branch, the log
2167
will be filtered to show only those revisions that changed the
2168
nominated files or directories.
2170
Filenames are interpreted within their historical context. To log a
2171
deleted file, specify a revision range so that the file existed at
2172
the end or start of the range.
2174
Historical context is also important when interpreting pathnames of
2175
renamed files/directories. Consider the following example:
2177
* revision 1: add tutorial.txt
2178
* revision 2: modify tutorial.txt
2179
* revision 3: rename tutorial.txt to guide.txt; add tutorial.txt
2183
* ``bzr log guide.txt`` will log the file added in revision 1
2185
* ``bzr log tutorial.txt`` will log the new file added in revision 3
2187
* ``bzr log -r2 -p tutorial.txt`` will show the changes made to
2188
the original file in revision 2.
2190
* ``bzr log -r2 -p guide.txt`` will display an error message as there
2191
was no file called guide.txt in revision 2.
2193
Renames are always followed by log. By design, there is no need to
2194
explicitly ask for this (and no way to stop logging a file back
2195
until it was last renamed).
2199
The --message option can be used for finding revisions that match a
2200
regular expression in a commit message.
2204
GUI tools and IDEs are often better at exploring history than command
2205
line tools: you may prefer qlog or viz from qbzr or bzr-gtk, the
2206
bzr-explorer shell, or the Loggerhead web interface. See the Plugin
2207
Guide <http://doc.bazaar.canonical.com/plugins/en/> and
2208
<http://wiki.bazaar.canonical.com/IDEIntegration>.
2210
You may find it useful to add the aliases below to ``bazaar.conf``::
2214
top = log -l10 --line
2217
``bzr tip`` will then show the latest revision while ``bzr top``
2218
will show the last 10 mainline revisions. To see the details of a
2219
particular revision X, ``bzr show -rX``.
2221
If you are interested in looking deeper into a particular merge X,
2222
use ``bzr log -n0 -rX``.
2224
``bzr log -v`` on a branch with lots of history is currently
2225
very slow. A fix for this issue is currently under development.
2226
With or without that fix, it is recommended that a revision range
2227
be given when using the -v option.
2229
bzr has a generic full-text matching plugin, bzr-search, that can be
2230
used to find revisions matching user names, commit messages, etc.
2231
Among other features, this plugin can find all revisions containing
2232
a list of words but not others.
2234
When exploring non-mainline history on large projects with deep
2235
history, the performance of log can be greatly improved by installing
2236
the historycache plugin. This plugin buffers historical information
2237
trading disk space for faster speed.
2239
takes_args = ['file*']
2240
_see_also = ['log-formats', 'revisionspec']
2243
help='Show from oldest to newest.'),
2245
custom_help('verbose',
2246
help='Show files changed in each revision.'),
2250
type=bzrlib.option._parse_revision_str,
2252
help='Show just the specified revision.'
2253
' See also "help revisionspec".'),
2255
RegistryOption('authors',
2256
'What names to list as authors - first, all or committer.',
2258
lazy_registry=('bzrlib.log', 'author_list_registry'),
2262
help='Number of levels to display - 0 for all, 1 for flat.',
2264
type=_parse_levels),
2267
help='Show revisions whose message matches this '
2268
'regular expression.',
2272
help='Limit the output to the first N revisions.',
2277
help='Show changes made in each revision as a patch.'),
2278
Option('include-merges',
2279
help='Show merged revisions like --levels 0 does.'),
2280
Option('exclude-common-ancestry',
2281
help='Display only the revisions that are not part'
2282
' of both ancestries (require -rX..Y)'
2285
encoding_type = 'replace'
2288
def run(self, file_list=None, timezone='original',
2299
include_merges=False,
2301
exclude_common_ancestry=False,
2303
from bzrlib.log import (
2305
make_log_request_dict,
2306
_get_info_for_log_files,
2308
direction = (forward and 'forward') or 'reverse'
2309
if (exclude_common_ancestry
2310
and (revision is None or len(revision) != 2)):
2311
raise errors.BzrCommandError(
2312
'--exclude-common-ancestry requires -r with two revisions')
2317
raise errors.BzrCommandError(
2318
'--levels and --include-merges are mutually exclusive')
2320
if change is not None:
2322
raise errors.RangeInChangeOption()
2323
if revision is not None:
2324
raise errors.BzrCommandError(
2325
'--revision and --change are mutually exclusive')
2330
filter_by_dir = False
2332
# find the file ids to log and check for directory filtering
2333
b, file_info_list, rev1, rev2 = _get_info_for_log_files(
2334
revision, file_list, self.add_cleanup)
2335
for relpath, file_id, kind in file_info_list:
2337
raise errors.BzrCommandError(
2338
"Path unknown at end or start of revision range: %s" %
2340
# If the relpath is the top of the tree, we log everything
2345
file_ids.append(file_id)
2346
filter_by_dir = filter_by_dir or (
2347
kind in ['directory', 'tree-reference'])
2350
# FIXME ? log the current subdir only RBC 20060203
2351
if revision is not None \
2352
and len(revision) > 0 and revision[0].get_branch():
2353
location = revision[0].get_branch()
2356
dir, relpath = bzrdir.BzrDir.open_containing(location)
2357
b = dir.open_branch()
2358
self.add_cleanup(b.lock_read().unlock)
2359
rev1, rev2 = _get_revision_range(revision, b, self.name())
2361
# Decide on the type of delta & diff filtering to use
2362
# TODO: add an --all-files option to make this configurable & consistent
2370
diff_type = 'partial'
2374
# Build the log formatter
2375
if log_format is None:
2376
log_format = log.log_formatter_registry.get_default(b)
2377
# Make a non-encoding output to include the diffs - bug 328007
2378
unencoded_output = ui.ui_factory.make_output_stream(encoding_type='exact')
2379
lf = log_format(show_ids=show_ids, to_file=self.outf,
2380
to_exact_file=unencoded_output,
2381
show_timezone=timezone,
2382
delta_format=get_verbosity_level(),
2384
show_advice=levels is None,
2385
author_list_handler=authors)
2387
# Choose the algorithm for doing the logging. It's annoying
2388
# having multiple code paths like this but necessary until
2389
# the underlying repository format is faster at generating
2390
# deltas or can provide everything we need from the indices.
2391
# The default algorithm - match-using-deltas - works for
2392
# multiple files and directories and is faster for small
2393
# amounts of history (200 revisions say). However, it's too
2394
# slow for logging a single file in a repository with deep
2395
# history, i.e. > 10K revisions. In the spirit of "do no
2396
# evil when adding features", we continue to use the
2397
# original algorithm - per-file-graph - for the "single
2398
# file that isn't a directory without showing a delta" case.
2399
partial_history = revision and b.repository._format.supports_chks
2400
match_using_deltas = (len(file_ids) != 1 or filter_by_dir
2401
or delta_type or partial_history)
2403
# Build the LogRequest and execute it
2404
if len(file_ids) == 0:
2406
rqst = make_log_request_dict(
2407
direction=direction, specific_fileids=file_ids,
2408
start_revision=rev1, end_revision=rev2, limit=limit,
2409
message_search=message, delta_type=delta_type,
2410
diff_type=diff_type, _match_using_deltas=match_using_deltas,
2411
exclude_common_ancestry=exclude_common_ancestry,
2413
Logger(b, rqst).show(lf)
2416
def _get_revision_range(revisionspec_list, branch, command_name):
2417
"""Take the input of a revision option and turn it into a revision range.
2419
It returns RevisionInfo objects which can be used to obtain the rev_id's
2420
of the desired revisions. It does some user input validations.
2422
if revisionspec_list is None:
2425
elif len(revisionspec_list) == 1:
2426
rev1 = rev2 = revisionspec_list[0].in_history(branch)
2427
elif len(revisionspec_list) == 2:
2428
start_spec = revisionspec_list[0]
2429
end_spec = revisionspec_list[1]
2430
if end_spec.get_branch() != start_spec.get_branch():
2431
# b is taken from revision[0].get_branch(), and
2432
# show_log will use its revision_history. Having
2433
# different branches will lead to weird behaviors.
2434
raise errors.BzrCommandError(
2435
"bzr %s doesn't accept two revisions in different"
2436
" branches." % command_name)
2437
if start_spec.spec is None:
2438
# Avoid loading all the history.
2439
rev1 = RevisionInfo(branch, None, None)
2441
rev1 = start_spec.in_history(branch)
2442
# Avoid loading all of history when we know a missing
2443
# end of range means the last revision ...
2444
if end_spec.spec is None:
2445
last_revno, last_revision_id = branch.last_revision_info()
2446
rev2 = RevisionInfo(branch, last_revno, last_revision_id)
2448
rev2 = end_spec.in_history(branch)
2450
raise errors.BzrCommandError(
2451
'bzr %s --revision takes one or two values.' % command_name)
2455
def _revision_range_to_revid_range(revision_range):
2458
if revision_range[0] is not None:
2459
rev_id1 = revision_range[0].rev_id
2460
if revision_range[1] is not None:
2461
rev_id2 = revision_range[1].rev_id
2462
return rev_id1, rev_id2
2464
def get_log_format(long=False, short=False, line=False, default='long'):
2465
log_format = default
2469
log_format = 'short'
2475
class cmd_touching_revisions(Command):
2476
__doc__ = """Return revision-ids which affected a particular file.
2478
A more user-friendly interface is "bzr log FILE".
2482
takes_args = ["filename"]
2485
def run(self, filename):
2486
tree, relpath = WorkingTree.open_containing(filename)
2487
file_id = tree.path2id(relpath)
2489
self.add_cleanup(b.lock_read().unlock)
2490
touching_revs = log.find_touching_revisions(b, file_id)
2491
for revno, revision_id, what in touching_revs:
2492
self.outf.write("%6d %s\n" % (revno, what))
2495
class cmd_ls(Command):
2496
__doc__ = """List files in a tree.
2499
_see_also = ['status', 'cat']
2500
takes_args = ['path?']
2504
Option('recursive', short_name='R',
2505
help='Recurse into subdirectories.'),
2507
help='Print paths relative to the root of the branch.'),
2508
Option('unknown', short_name='u',
2509
help='Print unknown files.'),
2510
Option('versioned', help='Print versioned files.',
2512
Option('ignored', short_name='i',
2513
help='Print ignored files.'),
2514
Option('kind', short_name='k',
2515
help='List entries of a particular kind: file, directory, symlink.',
2522
def run(self, revision=None, verbose=False,
2523
recursive=False, from_root=False,
2524
unknown=False, versioned=False, ignored=False,
2525
null=False, kind=None, show_ids=False, path=None, directory=None):
2527
if kind and kind not in ('file', 'directory', 'symlink'):
2528
raise errors.BzrCommandError('invalid kind specified')
2530
if verbose and null:
2531
raise errors.BzrCommandError('Cannot set both --verbose and --null')
2532
all = not (unknown or versioned or ignored)
2534
selection = {'I':ignored, '?':unknown, 'V':versioned}
2540
raise errors.BzrCommandError('cannot specify both --from-root'
2543
tree, branch, relpath = \
2544
_open_directory_or_containing_tree_or_branch(fs_path, directory)
2546
# Calculate the prefix to use
2550
prefix = relpath + '/'
2551
elif fs_path != '.' and not fs_path.endswith('/'):
2552
prefix = fs_path + '/'
2554
if revision is not None or tree is None:
2555
tree = _get_one_revision_tree('ls', revision, branch=branch)
2558
if isinstance(tree, WorkingTree) and tree.supports_views():
2559
view_files = tree.views.lookup_view()
2562
view_str = views.view_display_str(view_files)
2563
note("Ignoring files outside view. View is %s" % view_str)
2565
self.add_cleanup(tree.lock_read().unlock)
2566
for fp, fc, fkind, fid, entry in tree.list_files(include_root=False,
2567
from_dir=relpath, recursive=recursive):
2568
# Apply additional masking
2569
if not all and not selection[fc]:
2571
if kind is not None and fkind != kind:
2576
fullpath = osutils.pathjoin(relpath, fp)
2579
views.check_path_in_view(tree, fullpath)
2580
except errors.FileOutsideView:
2585
fp = osutils.pathjoin(prefix, fp)
2586
kindch = entry.kind_character()
2587
outstring = fp + kindch
2588
ui.ui_factory.clear_term()
2590
outstring = '%-8s %s' % (fc, outstring)
2591
if show_ids and fid is not None:
2592
outstring = "%-50s %s" % (outstring, fid)
2593
self.outf.write(outstring + '\n')
2595
self.outf.write(fp + '\0')
2598
self.outf.write(fid)
2599
self.outf.write('\0')
2607
self.outf.write('%-50s %s\n' % (outstring, my_id))
2609
self.outf.write(outstring + '\n')
2612
class cmd_unknowns(Command):
2613
__doc__ = """List unknown files.
2618
takes_options = ['directory']
2621
def run(self, directory=u'.'):
2622
for f in WorkingTree.open_containing(directory)[0].unknowns():
2623
self.outf.write(osutils.quotefn(f) + '\n')
2626
class cmd_ignore(Command):
2627
__doc__ = """Ignore specified files or patterns.
2629
See ``bzr help patterns`` for details on the syntax of patterns.
2631
If a .bzrignore file does not exist, the ignore command
2632
will create one and add the specified files or patterns to the newly
2633
created file. The ignore command will also automatically add the
2634
.bzrignore file to be versioned. Creating a .bzrignore file without
2635
the use of the ignore command will require an explicit add command.
2637
To remove patterns from the ignore list, edit the .bzrignore file.
2638
After adding, editing or deleting that file either indirectly by
2639
using this command or directly by using an editor, be sure to commit
2642
Bazaar also supports a global ignore file ~/.bazaar/ignore. On Windows
2643
the global ignore file can be found in the application data directory as
2644
C:\\Documents and Settings\\<user>\\Application Data\\Bazaar\\2.0\\ignore.
2645
Global ignores are not touched by this command. The global ignore file
2646
can be edited directly using an editor.
2648
Patterns prefixed with '!' are exceptions to ignore patterns and take
2649
precedence over regular ignores. Such exceptions are used to specify
2650
files that should be versioned which would otherwise be ignored.
2652
Patterns prefixed with '!!' act as regular ignore patterns, but have
2653
precedence over the '!' exception patterns.
2655
Note: ignore patterns containing shell wildcards must be quoted from
2659
Ignore the top level Makefile::
2661
bzr ignore ./Makefile
2663
Ignore .class files in all directories...::
2665
bzr ignore "*.class"
2667
...but do not ignore "special.class"::
2669
bzr ignore "!special.class"
2671
Ignore .o files under the lib directory::
2673
bzr ignore "lib/**/*.o"
2675
Ignore .o files under the lib directory::
2677
bzr ignore "RE:lib/.*\.o"
2679
Ignore everything but the "debian" toplevel directory::
2681
bzr ignore "RE:(?!debian/).*"
2683
Ignore everything except the "local" toplevel directory,
2684
but always ignore "*~" autosave files, even under local/::
2687
bzr ignore "!./local"
2691
_see_also = ['status', 'ignored', 'patterns']
2692
takes_args = ['name_pattern*']
2693
takes_options = ['directory',
2694
Option('default-rules',
2695
help='Display the default ignore rules that bzr uses.')
2698
def run(self, name_pattern_list=None, default_rules=None,
2700
from bzrlib import ignores
2701
if default_rules is not None:
2702
# dump the default rules and exit
2703
for pattern in ignores.USER_DEFAULTS:
2704
self.outf.write("%s\n" % pattern)
2706
if not name_pattern_list:
2707
raise errors.BzrCommandError("ignore requires at least one "
2708
"NAME_PATTERN or --default-rules.")
2709
name_pattern_list = [globbing.normalize_pattern(p)
2710
for p in name_pattern_list]
2711
for name_pattern in name_pattern_list:
2712
if (name_pattern[0] == '/' or
2713
(len(name_pattern) > 1 and name_pattern[1] == ':')):
2714
raise errors.BzrCommandError(
2715
"NAME_PATTERN should not be an absolute path")
2716
tree, relpath = WorkingTree.open_containing(directory)
2717
ignores.tree_ignores_add_patterns(tree, name_pattern_list)
2718
ignored = globbing.Globster(name_pattern_list)
2721
for entry in tree.list_files():
2725
if ignored.match(filename):
2726
matches.append(filename)
2728
if len(matches) > 0:
2729
self.outf.write("Warning: the following files are version controlled and"
2730
" match your ignore pattern:\n%s"
2731
"\nThese files will continue to be version controlled"
2732
" unless you 'bzr remove' them.\n" % ("\n".join(matches),))
2735
class cmd_ignored(Command):
2736
__doc__ = """List ignored files and the patterns that matched them.
2738
List all the ignored files and the ignore pattern that caused the file to
2741
Alternatively, to list just the files::
2746
encoding_type = 'replace'
2747
_see_also = ['ignore', 'ls']
2748
takes_options = ['directory']
2751
def run(self, directory=u'.'):
2752
tree = WorkingTree.open_containing(directory)[0]
2753
self.add_cleanup(tree.lock_read().unlock)
2754
for path, file_class, kind, file_id, entry in tree.list_files():
2755
if file_class != 'I':
2757
## XXX: Slightly inefficient since this was already calculated
2758
pat = tree.is_ignored(path)
2759
self.outf.write('%-50s %s\n' % (path, pat))
2762
class cmd_lookup_revision(Command):
2763
__doc__ = """Lookup the revision-id from a revision-number
2766
bzr lookup-revision 33
2769
takes_args = ['revno']
2770
takes_options = ['directory']
2773
def run(self, revno, directory=u'.'):
2777
raise errors.BzrCommandError("not a valid revision-number: %r"
2779
revid = WorkingTree.open_containing(directory)[0].branch.get_rev_id(revno)
2780
self.outf.write("%s\n" % revid)
2783
class cmd_export(Command):
2784
__doc__ = """Export current or past revision to a destination directory or archive.
2786
If no revision is specified this exports the last committed revision.
2788
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
2789
given, try to find the format with the extension. If no extension
2790
is found exports to a directory (equivalent to --format=dir).
2792
If root is supplied, it will be used as the root directory inside
2793
container formats (tar, zip, etc). If it is not supplied it will default
2794
to the exported filename. The root option has no effect for 'dir' format.
2796
If branch is omitted then the branch containing the current working
2797
directory will be used.
2799
Note: Export of tree with non-ASCII filenames to zip is not supported.
2801
================= =========================
2802
Supported formats Autodetected by extension
2803
================= =========================
2806
tbz2 .tar.bz2, .tbz2
2809
================= =========================
2811
takes_args = ['dest', 'branch_or_subdir?']
2812
takes_options = ['directory',
2814
help="Type of file to export to.",
2817
Option('filters', help='Apply content filters to export the '
2818
'convenient form.'),
2821
help="Name of the root directory inside the exported file."),
2822
Option('per-file-timestamps',
2823
help='Set modification time of files to that of the last '
2824
'revision in which it was changed.'),
2826
def run(self, dest, branch_or_subdir=None, revision=None, format=None,
2827
root=None, filters=False, per_file_timestamps=False, directory=u'.'):
2828
from bzrlib.export import export
2830
if branch_or_subdir is None:
2831
tree = WorkingTree.open_containing(directory)[0]
2835
b, subdir = Branch.open_containing(branch_or_subdir)
2838
rev_tree = _get_one_revision_tree('export', revision, branch=b, tree=tree)
2840
export(rev_tree, dest, format, root, subdir, filtered=filters,
2841
per_file_timestamps=per_file_timestamps)
2842
except errors.NoSuchExportFormat, e:
2843
raise errors.BzrCommandError('Unsupported export format: %s' % e.format)
2846
class cmd_cat(Command):
2847
__doc__ = """Write the contents of a file as of a given revision to standard output.
2849
If no revision is nominated, the last revision is used.
2851
Note: Take care to redirect standard output when using this command on a
2856
takes_options = ['directory',
2857
Option('name-from-revision', help='The path name in the old tree.'),
2858
Option('filters', help='Apply content filters to display the '
2859
'convenience form.'),
2862
takes_args = ['filename']
2863
encoding_type = 'exact'
2866
def run(self, filename, revision=None, name_from_revision=False,
2867
filters=False, directory=None):
2868
if revision is not None and len(revision) != 1:
2869
raise errors.BzrCommandError("bzr cat --revision takes exactly"
2870
" one revision specifier")
2871
tree, branch, relpath = \
2872
_open_directory_or_containing_tree_or_branch(filename, directory)
2873
self.add_cleanup(branch.lock_read().unlock)
2874
return self._run(tree, branch, relpath, filename, revision,
2875
name_from_revision, filters)
2877
def _run(self, tree, b, relpath, filename, revision, name_from_revision,
2880
tree = b.basis_tree()
2881
rev_tree = _get_one_revision_tree('cat', revision, branch=b)
2882
self.add_cleanup(rev_tree.lock_read().unlock)
2884
old_file_id = rev_tree.path2id(relpath)
2886
if name_from_revision:
2887
# Try in revision if requested
2888
if old_file_id is None:
2889
raise errors.BzrCommandError(
2890
"%r is not present in revision %s" % (
2891
filename, rev_tree.get_revision_id()))
2893
content = rev_tree.get_file_text(old_file_id)
2895
cur_file_id = tree.path2id(relpath)
2897
if cur_file_id is not None:
2898
# Then try with the actual file id
2900
content = rev_tree.get_file_text(cur_file_id)
2902
except errors.NoSuchId:
2903
# The actual file id didn't exist at that time
2905
if not found and old_file_id is not None:
2906
# Finally try with the old file id
2907
content = rev_tree.get_file_text(old_file_id)
2910
# Can't be found anywhere
2911
raise errors.BzrCommandError(
2912
"%r is not present in revision %s" % (
2913
filename, rev_tree.get_revision_id()))
2915
from bzrlib.filters import (
2916
ContentFilterContext,
2917
filtered_output_bytes,
2919
filters = rev_tree._content_filter_stack(relpath)
2920
chunks = content.splitlines(True)
2921
content = filtered_output_bytes(chunks, filters,
2922
ContentFilterContext(relpath, rev_tree))
2924
self.outf.writelines(content)
2927
self.outf.write(content)
2930
class cmd_local_time_offset(Command):
2931
__doc__ = """Show the offset in seconds from GMT to local time."""
2935
self.outf.write("%s\n" % osutils.local_time_offset())
2939
class cmd_commit(Command):
2940
__doc__ = """Commit changes into a new revision.
2942
An explanatory message needs to be given for each commit. This is
2943
often done by using the --message option (getting the message from the
2944
command line) or by using the --file option (getting the message from
2945
a file). If neither of these options is given, an editor is opened for
2946
the user to enter the message. To see the changed files in the
2947
boilerplate text loaded into the editor, use the --show-diff option.
2949
By default, the entire tree is committed and the person doing the
2950
commit is assumed to be the author. These defaults can be overridden
2955
If selected files are specified, only changes to those files are
2956
committed. If a directory is specified then the directory and
2957
everything within it is committed.
2959
When excludes are given, they take precedence over selected files.
2960
For example, to commit only changes within foo, but not changes
2963
bzr commit foo -x foo/bar
2965
A selective commit after a merge is not yet supported.
2969
If the author of the change is not the same person as the committer,
2970
you can specify the author's name using the --author option. The
2971
name should be in the same format as a committer-id, e.g.
2972
"John Doe <jdoe@example.com>". If there is more than one author of
2973
the change you can specify the option multiple times, once for each
2978
A common mistake is to forget to add a new file or directory before
2979
running the commit command. The --strict option checks for unknown
2980
files and aborts the commit if any are found. More advanced pre-commit
2981
checks can be implemented by defining hooks. See ``bzr help hooks``
2986
If you accidentially commit the wrong changes or make a spelling
2987
mistake in the commit message say, you can use the uncommit command
2988
to undo it. See ``bzr help uncommit`` for details.
2990
Hooks can also be configured to run after a commit. This allows you
2991
to trigger updates to external systems like bug trackers. The --fixes
2992
option can be used to record the association between a revision and
2993
one or more bugs. See ``bzr help bugs`` for details.
2995
A selective commit may fail in some cases where the committed
2996
tree would be invalid. Consider::
3001
bzr commit foo -m "committing foo"
3002
bzr mv foo/bar foo/baz
3005
bzr commit foo/bar -m "committing bar but not baz"
3007
In the example above, the last commit will fail by design. This gives
3008
the user the opportunity to decide whether they want to commit the
3009
rename at the same time, separately first, or not at all. (As a general
3010
rule, when in doubt, Bazaar has a policy of Doing the Safe Thing.)
3012
# TODO: Run hooks on tree to-be-committed, and after commit.
3014
# TODO: Strict commit that fails if there are deleted files.
3015
# (what does "deleted files" mean ??)
3017
# TODO: Give better message for -s, --summary, used by tla people
3019
# XXX: verbose currently does nothing
3021
_see_also = ['add', 'bugs', 'hooks', 'uncommit']
3022
takes_args = ['selected*']
3024
ListOption('exclude', type=str, short_name='x',
3025
help="Do not consider changes made to a given path."),
3026
Option('message', type=unicode,
3028
help="Description of the new revision."),
3031
help='Commit even if nothing has changed.'),
3032
Option('file', type=str,
3035
help='Take commit message from this file.'),
3037
help="Refuse to commit if there are unknown "
3038
"files in the working tree."),
3039
Option('commit-time', type=str,
3040
help="Manually set a commit time using commit date "
3041
"format, e.g. '2009-10-10 08:00:00 +0100'."),
3042
ListOption('fixes', type=str,
3043
help="Mark a bug as being fixed by this revision "
3044
"(see \"bzr help bugs\")."),
3045
ListOption('author', type=unicode,
3046
help="Set the author's name, if it's different "
3047
"from the committer."),
3049
help="Perform a local commit in a bound "
3050
"branch. Local commits are not pushed to "
3051
"the master branch until a normal commit "
3054
Option('show-diff', short_name='p',
3055
help='When no message is supplied, show the diff along'
3056
' with the status summary in the message editor.'),
3058
aliases = ['ci', 'checkin']
3060
def _iter_bug_fix_urls(self, fixes, branch):
3061
# Configure the properties for bug fixing attributes.
3062
for fixed_bug in fixes:
3063
tokens = fixed_bug.split(':')
3064
if len(tokens) != 2:
3065
raise errors.BzrCommandError(
3066
"Invalid bug %s. Must be in the form of 'tracker:id'. "
3067
"See \"bzr help bugs\" for more information on this "
3068
"feature.\nCommit refused." % fixed_bug)
3069
tag, bug_id = tokens
3071
yield bugtracker.get_bug_url(tag, branch, bug_id)
3072
except errors.UnknownBugTrackerAbbreviation:
3073
raise errors.BzrCommandError(
3074
'Unrecognized bug %s. Commit refused.' % fixed_bug)
3075
except errors.MalformedBugIdentifier, e:
3076
raise errors.BzrCommandError(
3077
"%s\nCommit refused." % (str(e),))
3079
def run(self, message=None, file=None, verbose=False, selected_list=None,
3080
unchanged=False, strict=False, local=False, fixes=None,
3081
author=None, show_diff=False, exclude=None, commit_time=None):
3082
from bzrlib.errors import (
3087
from bzrlib.msgeditor import (
3088
edit_commit_message_encoded,
3089
generate_commit_message_template,
3090
make_commit_message_template_encoded
3093
commit_stamp = offset = None
3094
if commit_time is not None:
3096
commit_stamp, offset = timestamp.parse_patch_date(commit_time)
3097
except ValueError, e:
3098
raise errors.BzrCommandError(
3099
"Could not parse --commit-time: " + str(e))
3101
# TODO: Need a blackbox test for invoking the external editor; may be
3102
# slightly problematic to run this cross-platform.
3104
# TODO: do more checks that the commit will succeed before
3105
# spending the user's valuable time typing a commit message.
3109
tree, selected_list = tree_files(selected_list)
3110
if selected_list == ['']:
3111
# workaround - commit of root of tree should be exactly the same
3112
# as just default commit in that tree, and succeed even though
3113
# selected-file merge commit is not done yet
3118
bug_property = bugtracker.encode_fixes_bug_urls(
3119
self._iter_bug_fix_urls(fixes, tree.branch))
3121
properties['bugs'] = bug_property
3123
if local and not tree.branch.get_bound_location():
3124
raise errors.LocalRequiresBoundBranch()
3126
if message is not None:
3128
file_exists = osutils.lexists(message)
3129
except UnicodeError:
3130
# The commit message contains unicode characters that can't be
3131
# represented in the filesystem encoding, so that can't be a
3136
'The commit message is a file name: "%(f)s".\n'
3137
'(use --file "%(f)s" to take commit message from that file)'
3139
ui.ui_factory.show_warning(warning_msg)
3141
message = message.replace('\r\n', '\n')
3142
message = message.replace('\r', '\n')
3144
raise errors.BzrCommandError(
3145
"please specify either --message or --file")
3147
def get_message(commit_obj):
3148
"""Callback to get commit message"""
3150
f = codecs.open(file, 'rt', osutils.get_user_encoding())
3152
my_message = f.read()
3155
elif message is not None:
3156
my_message = message
3158
# No message supplied: make one up.
3159
# text is the status of the tree
3160
text = make_commit_message_template_encoded(tree,
3161
selected_list, diff=show_diff,
3162
output_encoding=osutils.get_user_encoding())
3163
# start_message is the template generated from hooks
3164
# XXX: Warning - looks like hooks return unicode,
3165
# make_commit_message_template_encoded returns user encoding.
3166
# We probably want to be using edit_commit_message instead to
3168
start_message = generate_commit_message_template(commit_obj)
3169
my_message = edit_commit_message_encoded(text,
3170
start_message=start_message)
3171
if my_message is None:
3172
raise errors.BzrCommandError("please specify a commit"
3173
" message with either --message or --file")
3174
if my_message == "":
3175
raise errors.BzrCommandError("empty commit message specified")
3178
# The API permits a commit with a filter of [] to mean 'select nothing'
3179
# but the command line should not do that.
3180
if not selected_list:
3181
selected_list = None
3183
tree.commit(message_callback=get_message,
3184
specific_files=selected_list,
3185
allow_pointless=unchanged, strict=strict, local=local,
3186
reporter=None, verbose=verbose, revprops=properties,
3187
authors=author, timestamp=commit_stamp,
3189
exclude=safe_relpath_files(tree, exclude))
3190
except PointlessCommit:
3191
raise errors.BzrCommandError("No changes to commit."
3192
" Use --unchanged to commit anyhow.")
3193
except ConflictsInTree:
3194
raise errors.BzrCommandError('Conflicts detected in working '
3195
'tree. Use "bzr conflicts" to list, "bzr resolve FILE" to'
3197
except StrictCommitFailed:
3198
raise errors.BzrCommandError("Commit refused because there are"
3199
" unknown files in the working tree.")
3200
except errors.BoundBranchOutOfDate, e:
3201
e.extra_help = ("\n"
3202
'To commit to master branch, run update and then commit.\n'
3203
'You can also pass --local to commit to continue working '
3208
class cmd_check(Command):
3209
__doc__ = """Validate working tree structure, branch consistency and repository history.
3211
This command checks various invariants about branch and repository storage
3212
to detect data corruption or bzr bugs.
3214
The working tree and branch checks will only give output if a problem is
3215
detected. The output fields of the repository check are:
3218
This is just the number of revisions checked. It doesn't
3222
This is just the number of versionedfiles checked. It
3223
doesn't indicate a problem.
3225
unreferenced ancestors
3226
Texts that are ancestors of other texts, but
3227
are not properly referenced by the revision ancestry. This is a
3228
subtle problem that Bazaar can work around.
3231
This is the total number of unique file contents
3232
seen in the checked revisions. It does not indicate a problem.
3235
This is the total number of repeated texts seen
3236
in the checked revisions. Texts can be repeated when their file
3237
entries are modified, but the file contents are not. It does not
3240
If no restrictions are specified, all Bazaar data that is found at the given
3241
location will be checked.
3245
Check the tree and branch at 'foo'::
3247
bzr check --tree --branch foo
3249
Check only the repository at 'bar'::
3251
bzr check --repo bar
3253
Check everything at 'baz'::
3258
_see_also = ['reconcile']
3259
takes_args = ['path?']
3260
takes_options = ['verbose',
3261
Option('branch', help="Check the branch related to the"
3262
" current directory."),
3263
Option('repo', help="Check the repository related to the"
3264
" current directory."),
3265
Option('tree', help="Check the working tree related to"
3266
" the current directory.")]
3268
def run(self, path=None, verbose=False, branch=False, repo=False,
3270
from bzrlib.check import check_dwim
3273
if not branch and not repo and not tree:
3274
branch = repo = tree = True
3275
check_dwim(path, verbose, do_branch=branch, do_repo=repo, do_tree=tree)
3278
class cmd_upgrade(Command):
3279
__doc__ = """Upgrade branch storage to current format.
3281
The check command or bzr developers may sometimes advise you to run
3282
this command. When the default format has changed you may also be warned
3283
during other operations to upgrade.
3286
_see_also = ['check']
3287
takes_args = ['url?']
3289
RegistryOption('format',
3290
help='Upgrade to a specific format. See "bzr help'
3291
' formats" for details.',
3292
lazy_registry=('bzrlib.bzrdir', 'format_registry'),
3293
converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
3294
value_switches=True, title='Branch format'),
3297
def run(self, url='.', format=None):
3298
from bzrlib.upgrade import upgrade
3299
upgrade(url, format)
3302
class cmd_whoami(Command):
3303
__doc__ = """Show or set bzr user id.
3306
Show the email of the current user::
3310
Set the current user::
3312
bzr whoami "Frank Chu <fchu@example.com>"
3314
takes_options = [ Option('email',
3315
help='Display email address only.'),
3317
help='Set identity for the current branch instead of '
3320
takes_args = ['name?']
3321
encoding_type = 'replace'
3324
def run(self, email=False, branch=False, name=None):
3326
# use branch if we're inside one; otherwise global config
3328
c = Branch.open_containing('.')[0].get_config()
3329
except errors.NotBranchError:
3330
c = config.GlobalConfig()
3332
self.outf.write(c.user_email() + '\n')
3334
self.outf.write(c.username() + '\n')
3337
# display a warning if an email address isn't included in the given name.
3339
config.extract_email_address(name)
3340
except errors.NoEmailInUsername, e:
3341
warning('"%s" does not seem to contain an email address. '
3342
'This is allowed, but not recommended.', name)
3344
# use global config unless --branch given
3346
c = Branch.open_containing('.')[0].get_config()
3348
c = config.GlobalConfig()
3349
c.set_user_option('email', name)
3352
class cmd_nick(Command):
3353
__doc__ = """Print or set the branch nickname.
3355
If unset, the tree root directory name is used as the nickname.
3356
To print the current nickname, execute with no argument.
3358
Bound branches use the nickname of its master branch unless it is set
3362
_see_also = ['info']
3363
takes_args = ['nickname?']
3364
takes_options = ['directory']
3365
def run(self, nickname=None, directory=u'.'):
3366
branch = Branch.open_containing(directory)[0]
3367
if nickname is None:
3368
self.printme(branch)
3370
branch.nick = nickname
3373
def printme(self, branch):
3374
self.outf.write('%s\n' % branch.nick)
3377
class cmd_alias(Command):
3378
__doc__ = """Set/unset and display aliases.
3381
Show the current aliases::
3385
Show the alias specified for 'll'::
3389
Set an alias for 'll'::
3391
bzr alias ll="log --line -r-10..-1"
3393
To remove an alias for 'll'::
3395
bzr alias --remove ll
3398
takes_args = ['name?']
3400
Option('remove', help='Remove the alias.'),
3403
def run(self, name=None, remove=False):
3405
self.remove_alias(name)
3407
self.print_aliases()
3409
equal_pos = name.find('=')
3411
self.print_alias(name)
3413
self.set_alias(name[:equal_pos], name[equal_pos+1:])
3415
def remove_alias(self, alias_name):
3416
if alias_name is None:
3417
raise errors.BzrCommandError(
3418
'bzr alias --remove expects an alias to remove.')
3419
# If alias is not found, print something like:
3420
# unalias: foo: not found
3421
c = config.GlobalConfig()
3422
c.unset_alias(alias_name)
3425
def print_aliases(self):
3426
"""Print out the defined aliases in a similar format to bash."""
3427
aliases = config.GlobalConfig().get_aliases()
3428
for key, value in sorted(aliases.iteritems()):
3429
self.outf.write('bzr alias %s="%s"\n' % (key, value))
3432
def print_alias(self, alias_name):
3433
from bzrlib.commands import get_alias
3434
alias = get_alias(alias_name)
3436
self.outf.write("bzr alias: %s: not found\n" % alias_name)
3439
'bzr alias %s="%s"\n' % (alias_name, ' '.join(alias)))
3441
def set_alias(self, alias_name, alias_command):
3442
"""Save the alias in the global config."""
3443
c = config.GlobalConfig()
3444
c.set_alias(alias_name, alias_command)
3447
class cmd_selftest(Command):
3448
__doc__ = """Run internal test suite.
3450
If arguments are given, they are regular expressions that say which tests
3451
should run. Tests matching any expression are run, and other tests are
3454
Alternatively if --first is given, matching tests are run first and then
3455
all other tests are run. This is useful if you have been working in a
3456
particular area, but want to make sure nothing else was broken.
3458
If --exclude is given, tests that match that regular expression are
3459
excluded, regardless of whether they match --first or not.
3461
To help catch accidential dependencies between tests, the --randomize
3462
option is useful. In most cases, the argument used is the word 'now'.
3463
Note that the seed used for the random number generator is displayed
3464
when this option is used. The seed can be explicitly passed as the
3465
argument to this option if required. This enables reproduction of the
3466
actual ordering used if and when an order sensitive problem is encountered.
3468
If --list-only is given, the tests that would be run are listed. This is
3469
useful when combined with --first, --exclude and/or --randomize to
3470
understand their impact. The test harness reports "Listed nn tests in ..."
3471
instead of "Ran nn tests in ..." when list mode is enabled.
3473
If the global option '--no-plugins' is given, plugins are not loaded
3474
before running the selftests. This has two effects: features provided or
3475
modified by plugins will not be tested, and tests provided by plugins will
3478
Tests that need working space on disk use a common temporary directory,
3479
typically inside $TMPDIR or /tmp.
3481
If you set BZR_TEST_PDB=1 when running selftest, failing tests will drop
3482
into a pdb postmortem session.
3485
Run only tests relating to 'ignore'::
3489
Disable plugins and list tests as they're run::
3491
bzr --no-plugins selftest -v
3493
# NB: this is used from the class without creating an instance, which is
3494
# why it does not have a self parameter.
3495
def get_transport_type(typestring):
3496
"""Parse and return a transport specifier."""
3497
if typestring == "sftp":
3498
from bzrlib.tests import stub_sftp
3499
return stub_sftp.SFTPAbsoluteServer
3500
if typestring == "memory":
3501
from bzrlib.tests import test_server
3502
return memory.MemoryServer
3503
if typestring == "fakenfs":
3504
from bzrlib.tests import test_server
3505
return test_server.FakeNFSServer
3506
msg = "No known transport type %s. Supported types are: sftp\n" %\
3508
raise errors.BzrCommandError(msg)
3511
takes_args = ['testspecs*']
3512
takes_options = ['verbose',
3514
help='Stop when one test fails.',
3518
help='Use a different transport by default '
3519
'throughout the test suite.',
3520
type=get_transport_type),
3522
help='Run the benchmarks rather than selftests.'),
3523
Option('lsprof-timed',
3524
help='Generate lsprof output for benchmarked'
3525
' sections of code.'),
3526
Option('lsprof-tests',
3527
help='Generate lsprof output for each test.'),
3528
Option('cache-dir', type=str,
3529
help='Cache intermediate benchmark output in this '
3532
help='Run all tests, but run specified tests first.',
3536
help='List the tests instead of running them.'),
3537
RegistryOption('parallel',
3538
help="Run the test suite in parallel.",
3539
lazy_registry=('bzrlib.tests', 'parallel_registry'),
3540
value_switches=False,
3542
Option('randomize', type=str, argname="SEED",
3543
help='Randomize the order of tests using the given'
3544
' seed or "now" for the current time.'),
3545
Option('exclude', type=str, argname="PATTERN",
3547
help='Exclude tests that match this regular'
3550
help='Output test progress via subunit.'),
3551
Option('strict', help='Fail on missing dependencies or '
3553
Option('load-list', type=str, argname='TESTLISTFILE',
3554
help='Load a test id list from a text file.'),
3555
ListOption('debugflag', type=str, short_name='E',
3556
help='Turn on a selftest debug flag.'),
3557
ListOption('starting-with', type=str, argname='TESTID',
3558
param_name='starting_with', short_name='s',
3560
'Load only the tests starting with TESTID.'),
3562
encoding_type = 'replace'
3565
Command.__init__(self)
3566
self.additional_selftest_args = {}
3568
def run(self, testspecs_list=None, verbose=False, one=False,
3569
transport=None, benchmark=None,
3570
lsprof_timed=None, cache_dir=None,
3571
first=False, list_only=False,
3572
randomize=None, exclude=None, strict=False,
3573
load_list=None, debugflag=None, starting_with=None, subunit=False,
3574
parallel=None, lsprof_tests=False):
3575
from bzrlib.tests import selftest
3576
import bzrlib.benchmarks as benchmarks
3577
from bzrlib.benchmarks import tree_creator
3579
# Make deprecation warnings visible, unless -Werror is set
3580
symbol_versioning.activate_deprecation_warnings(override=False)
3582
if cache_dir is not None:
3583
tree_creator.TreeCreator.CACHE_ROOT = osutils.abspath(cache_dir)
3584
if testspecs_list is not None:
3585
pattern = '|'.join(testspecs_list)
3590
from bzrlib.tests import SubUnitBzrRunner
3592
raise errors.BzrCommandError("subunit not available. subunit "
3593
"needs to be installed to use --subunit.")
3594
self.additional_selftest_args['runner_class'] = SubUnitBzrRunner
3595
# On Windows, disable automatic conversion of '\n' to '\r\n' in
3596
# stdout, which would corrupt the subunit stream.
3597
# FIXME: This has been fixed in subunit trunk (>0.0.5) so the
3598
# following code can be deleted when it's sufficiently deployed
3599
# -- vila/mgz 20100514
3600
if (sys.platform == "win32"
3601
and getattr(sys.stdout, 'fileno', None) is not None):
3603
msvcrt.setmode(sys.stdout.fileno(), os.O_BINARY)
3605
self.additional_selftest_args.setdefault(
3606
'suite_decorators', []).append(parallel)
3608
test_suite_factory = benchmarks.test_suite
3609
# Unless user explicitly asks for quiet, be verbose in benchmarks
3610
verbose = not is_quiet()
3611
# TODO: should possibly lock the history file...
3612
benchfile = open(".perf_history", "at", buffering=1)
3613
self.add_cleanup(benchfile.close)
3615
test_suite_factory = None
3617
selftest_kwargs = {"verbose": verbose,
3619
"stop_on_failure": one,
3620
"transport": transport,
3621
"test_suite_factory": test_suite_factory,
3622
"lsprof_timed": lsprof_timed,
3623
"lsprof_tests": lsprof_tests,
3624
"bench_history": benchfile,
3625
"matching_tests_first": first,
3626
"list_only": list_only,
3627
"random_seed": randomize,
3628
"exclude_pattern": exclude,
3630
"load_list": load_list,
3631
"debug_flags": debugflag,
3632
"starting_with": starting_with
3634
selftest_kwargs.update(self.additional_selftest_args)
3635
result = selftest(**selftest_kwargs)
3636
return int(not result)
3639
class cmd_version(Command):
3640
__doc__ = """Show version of bzr."""
3642
encoding_type = 'replace'
3644
Option("short", help="Print just the version number."),
3648
def run(self, short=False):
3649
from bzrlib.version import show_version
3651
self.outf.write(bzrlib.version_string + '\n')
3653
show_version(to_file=self.outf)
3656
class cmd_rocks(Command):
3657
__doc__ = """Statement of optimism."""
3663
self.outf.write("It sure does!\n")
3666
class cmd_find_merge_base(Command):
3667
__doc__ = """Find and print a base revision for merging two branches."""
3668
# TODO: Options to specify revisions on either side, as if
3669
# merging only part of the history.
3670
takes_args = ['branch', 'other']
3674
def run(self, branch, other):
3675
from bzrlib.revision import ensure_null
3677
branch1 = Branch.open_containing(branch)[0]
3678
branch2 = Branch.open_containing(other)[0]
3679
self.add_cleanup(branch1.lock_read().unlock)
3680
self.add_cleanup(branch2.lock_read().unlock)
3681
last1 = ensure_null(branch1.last_revision())
3682
last2 = ensure_null(branch2.last_revision())
3684
graph = branch1.repository.get_graph(branch2.repository)
3685
base_rev_id = graph.find_unique_lca(last1, last2)
3687
self.outf.write('merge base is revision %s\n' % base_rev_id)
3690
class cmd_merge(Command):
3691
__doc__ = """Perform a three-way merge.
3693
The source of the merge can be specified either in the form of a branch,
3694
or in the form of a path to a file containing a merge directive generated
3695
with bzr send. If neither is specified, the default is the upstream branch
3696
or the branch most recently merged using --remember.
3698
When merging a branch, by default the tip will be merged. To pick a different
3699
revision, pass --revision. If you specify two values, the first will be used as
3700
BASE and the second one as OTHER. Merging individual revisions, or a subset of
3701
available revisions, like this is commonly referred to as "cherrypicking".
3703
Revision numbers are always relative to the branch being merged.
3705
By default, bzr will try to merge in all new work from the other
3706
branch, automatically determining an appropriate base. If this
3707
fails, you may need to give an explicit base.
3709
Merge will do its best to combine the changes in two branches, but there
3710
are some kinds of problems only a human can fix. When it encounters those,
3711
it will mark a conflict. A conflict means that you need to fix something,
3712
before you should commit.
3714
Use bzr resolve when you have fixed a problem. See also bzr conflicts.
3716
If there is no default branch set, the first merge will set it. After
3717
that, you can omit the branch to use the default. To change the
3718
default, use --remember. The value will only be saved if the remote
3719
location can be accessed.
3721
The results of the merge are placed into the destination working
3722
directory, where they can be reviewed (with bzr diff), tested, and then
3723
committed to record the result of the merge.
3725
merge refuses to run if there are any uncommitted changes, unless
3726
--force is given. The --force option can also be used to create a
3727
merge revision which has more than two parents.
3729
If one would like to merge changes from the working tree of the other
3730
branch without merging any committed revisions, the --uncommitted option
3733
To select only some changes to merge, use "merge -i", which will prompt
3734
you to apply each diff hunk and file change, similar to "shelve".
3737
To merge the latest revision from bzr.dev::
3739
bzr merge ../bzr.dev
3741
To merge changes up to and including revision 82 from bzr.dev::
3743
bzr merge -r 82 ../bzr.dev
3745
To merge the changes introduced by 82, without previous changes::
3747
bzr merge -r 81..82 ../bzr.dev
3749
To apply a merge directive contained in /tmp/merge::
3751
bzr merge /tmp/merge
3753
To create a merge revision with three parents from two branches
3754
feature1a and feature1b:
3756
bzr merge ../feature1a
3757
bzr merge ../feature1b --force
3758
bzr commit -m 'revision with three parents'
3761
encoding_type = 'exact'
3762
_see_also = ['update', 'remerge', 'status-flags', 'send']
3763
takes_args = ['location?']
3768
help='Merge even if the destination tree has uncommitted changes.'),
3772
Option('show-base', help="Show base revision text in "
3774
Option('uncommitted', help='Apply uncommitted changes'
3775
' from a working copy, instead of branch changes.'),
3776
Option('pull', help='If the destination is already'
3777
' completely merged into the source, pull from the'
3778
' source rather than merging. When this happens,'
3779
' you do not need to commit the result.'),
3780
custom_help('directory',
3781
help='Branch to merge into, '
3782
'rather than the one containing the working directory.'),
3783
Option('preview', help='Instead of merging, show a diff of the'
3785
Option('interactive', help='Select changes interactively.',
3789
def run(self, location=None, revision=None, force=False,
3790
merge_type=None, show_base=False, reprocess=None, remember=False,
3791
uncommitted=False, pull=False,
3796
if merge_type is None:
3797
merge_type = _mod_merge.Merge3Merger
3799
if directory is None: directory = u'.'
3800
possible_transports = []
3802
allow_pending = True
3803
verified = 'inapplicable'
3804
tree = WorkingTree.open_containing(directory)[0]
3807
basis_tree = tree.revision_tree(tree.last_revision())
3808
except errors.NoSuchRevision:
3809
basis_tree = tree.basis_tree()
3811
# die as quickly as possible if there are uncommitted changes
3813
if tree.has_changes():
3814
raise errors.UncommittedChanges(tree)
3816
view_info = _get_view_info_for_change_reporter(tree)
3817
change_reporter = delta._ChangeReporter(
3818
unversioned_filter=tree.is_ignored, view_info=view_info)
3819
pb = ui.ui_factory.nested_progress_bar()
3820
self.add_cleanup(pb.finished)
3821
self.add_cleanup(tree.lock_write().unlock)
3822
if location is not None:
3824
mergeable = bundle.read_mergeable_from_url(location,
3825
possible_transports=possible_transports)
3826
except errors.NotABundle:
3830
raise errors.BzrCommandError('Cannot use --uncommitted'
3831
' with bundles or merge directives.')
3833
if revision is not None:
3834
raise errors.BzrCommandError(
3835
'Cannot use -r with merge directives or bundles')
3836
merger, verified = _mod_merge.Merger.from_mergeable(tree,
3839
if merger is None and uncommitted:
3840
if revision is not None and len(revision) > 0:
3841
raise errors.BzrCommandError('Cannot use --uncommitted and'
3842
' --revision at the same time.')
3843
merger = self.get_merger_from_uncommitted(tree, location, None)
3844
allow_pending = False
3847
merger, allow_pending = self._get_merger_from_branch(tree,
3848
location, revision, remember, possible_transports, None)
3850
merger.merge_type = merge_type
3851
merger.reprocess = reprocess
3852
merger.show_base = show_base
3853
self.sanity_check_merger(merger)
3854
if (merger.base_rev_id == merger.other_rev_id and
3855
merger.other_rev_id is not None):
3856
note('Nothing to do.')
3859
if merger.interesting_files is not None:
3860
raise errors.BzrCommandError('Cannot pull individual files')
3861
if (merger.base_rev_id == tree.last_revision()):
3862
result = tree.pull(merger.other_branch, False,
3863
merger.other_rev_id)
3864
result.report(self.outf)
3866
if merger.this_basis is None:
3867
raise errors.BzrCommandError(
3868
"This branch has no commits."
3869
" (perhaps you would prefer 'bzr pull')")
3871
return self._do_preview(merger)
3873
return self._do_interactive(merger)
3875
return self._do_merge(merger, change_reporter, allow_pending,
3878
def _get_preview(self, merger):
3879
tree_merger = merger.make_merger()
3880
tt = tree_merger.make_preview_transform()
3881
self.add_cleanup(tt.finalize)
3882
result_tree = tt.get_preview_tree()
3885
def _do_preview(self, merger):
3886
from bzrlib.diff import show_diff_trees
3887
result_tree = self._get_preview(merger)
3888
show_diff_trees(merger.this_tree, result_tree, self.outf,
3889
old_label='', new_label='')
3891
def _do_merge(self, merger, change_reporter, allow_pending, verified):
3892
merger.change_reporter = change_reporter
3893
conflict_count = merger.do_merge()
3895
merger.set_pending()
3896
if verified == 'failed':
3897
warning('Preview patch does not match changes')
3898
if conflict_count != 0:
3903
def _do_interactive(self, merger):
3904
"""Perform an interactive merge.
3906
This works by generating a preview tree of the merge, then using
3907
Shelver to selectively remove the differences between the working tree
3908
and the preview tree.
3910
from bzrlib import shelf_ui
3911
result_tree = self._get_preview(merger)
3912
writer = bzrlib.option.diff_writer_registry.get()
3913
shelver = shelf_ui.Shelver(merger.this_tree, result_tree, destroy=True,
3914
reporter=shelf_ui.ApplyReporter(),
3915
diff_writer=writer(sys.stdout))
3921
def sanity_check_merger(self, merger):
3922
if (merger.show_base and
3923
not merger.merge_type is _mod_merge.Merge3Merger):
3924
raise errors.BzrCommandError("Show-base is not supported for this"
3925
" merge type. %s" % merger.merge_type)
3926
if merger.reprocess is None:
3927
if merger.show_base:
3928
merger.reprocess = False
3930
# Use reprocess if the merger supports it
3931
merger.reprocess = merger.merge_type.supports_reprocess
3932
if merger.reprocess and not merger.merge_type.supports_reprocess:
3933
raise errors.BzrCommandError("Conflict reduction is not supported"
3934
" for merge type %s." %
3936
if merger.reprocess and merger.show_base:
3937
raise errors.BzrCommandError("Cannot do conflict reduction and"
3940
def _get_merger_from_branch(self, tree, location, revision, remember,
3941
possible_transports, pb):
3942
"""Produce a merger from a location, assuming it refers to a branch."""
3943
from bzrlib.tag import _merge_tags_if_possible
3944
# find the branch locations
3945
other_loc, user_location = self._select_branch_location(tree, location,
3947
if revision is not None and len(revision) == 2:
3948
base_loc, _unused = self._select_branch_location(tree,
3949
location, revision, 0)
3951
base_loc = other_loc
3953
other_branch, other_path = Branch.open_containing(other_loc,
3954
possible_transports)
3955
if base_loc == other_loc:
3956
base_branch = other_branch
3958
base_branch, base_path = Branch.open_containing(base_loc,
3959
possible_transports)
3960
# Find the revision ids
3961
other_revision_id = None
3962
base_revision_id = None
3963
if revision is not None:
3964
if len(revision) >= 1:
3965
other_revision_id = revision[-1].as_revision_id(other_branch)
3966
if len(revision) == 2:
3967
base_revision_id = revision[0].as_revision_id(base_branch)
3968
if other_revision_id is None:
3969
other_revision_id = _mod_revision.ensure_null(
3970
other_branch.last_revision())
3971
# Remember where we merge from
3972
if ((remember or tree.branch.get_submit_branch() is None) and
3973
user_location is not None):
3974
tree.branch.set_submit_branch(other_branch.base)
3975
_merge_tags_if_possible(other_branch, tree.branch)
3976
merger = _mod_merge.Merger.from_revision_ids(pb, tree,
3977
other_revision_id, base_revision_id, other_branch, base_branch)
3978
if other_path != '':
3979
allow_pending = False
3980
merger.interesting_files = [other_path]
3982
allow_pending = True
3983
return merger, allow_pending
3985
def get_merger_from_uncommitted(self, tree, location, pb):
3986
"""Get a merger for uncommitted changes.
3988
:param tree: The tree the merger should apply to.
3989
:param location: The location containing uncommitted changes.
3990
:param pb: The progress bar to use for showing progress.
3992
location = self._select_branch_location(tree, location)[0]
3993
other_tree, other_path = WorkingTree.open_containing(location)
3994
merger = _mod_merge.Merger.from_uncommitted(tree, other_tree, pb)
3995
if other_path != '':
3996
merger.interesting_files = [other_path]
3999
def _select_branch_location(self, tree, user_location, revision=None,
4001
"""Select a branch location, according to possible inputs.
4003
If provided, branches from ``revision`` are preferred. (Both
4004
``revision`` and ``index`` must be supplied.)
4006
Otherwise, the ``location`` parameter is used. If it is None, then the
4007
``submit`` or ``parent`` location is used, and a note is printed.
4009
:param tree: The working tree to select a branch for merging into
4010
:param location: The location entered by the user
4011
:param revision: The revision parameter to the command
4012
:param index: The index to use for the revision parameter. Negative
4013
indices are permitted.
4014
:return: (selected_location, user_location). The default location
4015
will be the user-entered location.
4017
if (revision is not None and index is not None
4018
and revision[index] is not None):
4019
branch = revision[index].get_branch()
4020
if branch is not None:
4021
return branch, branch
4022
if user_location is None:
4023
location = self._get_remembered(tree, 'Merging from')
4025
location = user_location
4026
return location, user_location
4028
def _get_remembered(self, tree, verb_string):
4029
"""Use tree.branch's parent if none was supplied.
4031
Report if the remembered location was used.
4033
stored_location = tree.branch.get_submit_branch()
4034
stored_location_type = "submit"
4035
if stored_location is None:
4036
stored_location = tree.branch.get_parent()
4037
stored_location_type = "parent"
4038
mutter("%s", stored_location)
4039
if stored_location is None:
4040
raise errors.BzrCommandError("No location specified or remembered")
4041
display_url = urlutils.unescape_for_display(stored_location, 'utf-8')
4042
note(u"%s remembered %s location %s", verb_string,
4043
stored_location_type, display_url)
4044
return stored_location
4047
class cmd_remerge(Command):
4048
__doc__ = """Redo a merge.
4050
Use this if you want to try a different merge technique while resolving
4051
conflicts. Some merge techniques are better than others, and remerge
4052
lets you try different ones on different files.
4054
The options for remerge have the same meaning and defaults as the ones for
4055
merge. The difference is that remerge can (only) be run when there is a
4056
pending merge, and it lets you specify particular files.
4059
Re-do the merge of all conflicted files, and show the base text in
4060
conflict regions, in addition to the usual THIS and OTHER texts::
4062
bzr remerge --show-base
4064
Re-do the merge of "foobar", using the weave merge algorithm, with
4065
additional processing to reduce the size of conflict regions::
4067
bzr remerge --merge-type weave --reprocess foobar
4069
takes_args = ['file*']
4074
help="Show base revision text in conflicts."),
4077
def run(self, file_list=None, merge_type=None, show_base=False,
4079
from bzrlib.conflicts import restore
4080
if merge_type is None:
4081
merge_type = _mod_merge.Merge3Merger
4082
tree, file_list = tree_files(file_list)
4083
self.add_cleanup(tree.lock_write().unlock)
4084
parents = tree.get_parent_ids()
4085
if len(parents) != 2:
4086
raise errors.BzrCommandError("Sorry, remerge only works after normal"
4087
" merges. Not cherrypicking or"
4089
repository = tree.branch.repository
4090
interesting_ids = None
4092
conflicts = tree.conflicts()
4093
if file_list is not None:
4094
interesting_ids = set()
4095
for filename in file_list:
4096
file_id = tree.path2id(filename)
4098
raise errors.NotVersionedError(filename)
4099
interesting_ids.add(file_id)
4100
if tree.kind(file_id) != "directory":
4103
for name, ie in tree.inventory.iter_entries(file_id):
4104
interesting_ids.add(ie.file_id)
4105
new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
4107
# Remerge only supports resolving contents conflicts
4108
allowed_conflicts = ('text conflict', 'contents conflict')
4109
restore_files = [c.path for c in conflicts
4110
if c.typestring in allowed_conflicts]
4111
_mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
4112
tree.set_conflicts(ConflictList(new_conflicts))
4113
if file_list is not None:
4114
restore_files = file_list
4115
for filename in restore_files:
4117
restore(tree.abspath(filename))
4118
except errors.NotConflicted:
4120
# Disable pending merges, because the file texts we are remerging
4121
# have not had those merges performed. If we use the wrong parents
4122
# list, we imply that the working tree text has seen and rejected
4123
# all the changes from the other tree, when in fact those changes
4124
# have not yet been seen.
4125
tree.set_parent_ids(parents[:1])
4127
merger = _mod_merge.Merger.from_revision_ids(None, tree, parents[1])
4128
merger.interesting_ids = interesting_ids
4129
merger.merge_type = merge_type
4130
merger.show_base = show_base
4131
merger.reprocess = reprocess
4132
conflicts = merger.do_merge()
4134
tree.set_parent_ids(parents)
4141
class cmd_revert(Command):
4142
__doc__ = """Revert files to a previous revision.
4144
Giving a list of files will revert only those files. Otherwise, all files
4145
will be reverted. If the revision is not specified with '--revision', the
4146
last committed revision is used.
4148
To remove only some changes, without reverting to a prior version, use
4149
merge instead. For example, "merge . --revision -2..-3" will remove the
4150
changes introduced by -2, without affecting the changes introduced by -1.
4151
Or to remove certain changes on a hunk-by-hunk basis, see the Shelf plugin.
4153
By default, any files that have been manually changed will be backed up
4154
first. (Files changed only by merge are not backed up.) Backup files have
4155
'.~#~' appended to their name, where # is a number.
4157
When you provide files, you can use their current pathname or the pathname
4158
from the target revision. So you can use revert to "undelete" a file by
4159
name. If you name a directory, all the contents of that directory will be
4162
If you have newly added files since the target revision, they will be
4163
removed. If the files to be removed have been changed, backups will be
4164
created as above. Directories containing unknown files will not be
4167
The working tree contains a list of revisions that have been merged but
4168
not yet committed. These revisions will be included as additional parents
4169
of the next commit. Normally, using revert clears that list as well as
4170
reverting the files. If any files are specified, revert leaves the list
4171
of uncommitted merges alone and reverts only the files. Use ``bzr revert
4172
.`` in the tree root to revert all files but keep the recorded merges,
4173
and ``bzr revert --forget-merges`` to clear the pending merge list without
4174
reverting any files.
4176
Using "bzr revert --forget-merges", it is possible to apply all of the
4177
changes from a branch in a single revision. To do this, perform the merge
4178
as desired. Then doing revert with the "--forget-merges" option will keep
4179
the content of the tree as it was, but it will clear the list of pending
4180
merges. The next commit will then contain all of the changes that are
4181
present in the other branch, but without any other parent revisions.
4182
Because this technique forgets where these changes originated, it may
4183
cause additional conflicts on later merges involving the same source and
4187
_see_also = ['cat', 'export']
4190
Option('no-backup', "Do not save backups of reverted files."),
4191
Option('forget-merges',
4192
'Remove pending merge marker, without changing any files.'),
4194
takes_args = ['file*']
4196
def run(self, revision=None, no_backup=False, file_list=None,
4197
forget_merges=None):
4198
tree, file_list = tree_files(file_list)
4199
self.add_cleanup(tree.lock_tree_write().unlock)
4201
tree.set_parent_ids(tree.get_parent_ids()[:1])
4203
self._revert_tree_to_revision(tree, revision, file_list, no_backup)
4206
def _revert_tree_to_revision(tree, revision, file_list, no_backup):
4207
rev_tree = _get_one_revision_tree('revert', revision, tree=tree)
4208
tree.revert(file_list, rev_tree, not no_backup, None,
4209
report_changes=True)
4212
class cmd_assert_fail(Command):
4213
__doc__ = """Test reporting of assertion failures"""
4214
# intended just for use in testing
4219
raise AssertionError("always fails")
4222
class cmd_help(Command):
4223
__doc__ = """Show help on a command or other topic.
4226
_see_also = ['topics']
4228
Option('long', 'Show help on all commands.'),
4230
takes_args = ['topic?']
4231
aliases = ['?', '--help', '-?', '-h']
4234
def run(self, topic=None, long=False):
4236
if topic is None and long:
4238
bzrlib.help.help(topic)
4241
class cmd_shell_complete(Command):
4242
__doc__ = """Show appropriate completions for context.
4244
For a list of all available commands, say 'bzr shell-complete'.
4246
takes_args = ['context?']
4251
def run(self, context=None):
4252
import shellcomplete
4253
shellcomplete.shellcomplete(context)
4256
class cmd_missing(Command):
4257
__doc__ = """Show unmerged/unpulled revisions between two branches.
4259
OTHER_BRANCH may be local or remote.
4261
To filter on a range of revisions, you can use the command -r begin..end
4262
-r revision requests a specific revision, -r ..end or -r begin.. are
4266
1 - some missing revisions
4267
0 - no missing revisions
4271
Determine the missing revisions between this and the branch at the
4272
remembered pull location::
4276
Determine the missing revisions between this and another branch::
4278
bzr missing http://server/branch
4280
Determine the missing revisions up to a specific revision on the other
4283
bzr missing -r ..-10
4285
Determine the missing revisions up to a specific revision on this
4288
bzr missing --my-revision ..-10
4291
_see_also = ['merge', 'pull']
4292
takes_args = ['other_branch?']
4294
Option('reverse', 'Reverse the order of revisions.'),
4296
'Display changes in the local branch only.'),
4297
Option('this' , 'Same as --mine-only.'),
4298
Option('theirs-only',
4299
'Display changes in the remote branch only.'),
4300
Option('other', 'Same as --theirs-only.'),
4304
custom_help('revision',
4305
help='Filter on other branch revisions (inclusive). '
4306
'See "help revisionspec" for details.'),
4307
Option('my-revision',
4308
type=_parse_revision_str,
4309
help='Filter on local branch revisions (inclusive). '
4310
'See "help revisionspec" for details.'),
4311
Option('include-merges',
4312
'Show all revisions in addition to the mainline ones.'),
4314
encoding_type = 'replace'
4317
def run(self, other_branch=None, reverse=False, mine_only=False,
4319
log_format=None, long=False, short=False, line=False,
4320
show_ids=False, verbose=False, this=False, other=False,
4321
include_merges=False, revision=None, my_revision=None):
4322
from bzrlib.missing import find_unmerged, iter_log_revisions
4331
# TODO: We should probably check that we don't have mine-only and
4332
# theirs-only set, but it gets complicated because we also have
4333
# this and other which could be used.
4340
local_branch = Branch.open_containing(u".")[0]
4341
self.add_cleanup(local_branch.lock_read().unlock)
4343
parent = local_branch.get_parent()
4344
if other_branch is None:
4345
other_branch = parent
4346
if other_branch is None:
4347
raise errors.BzrCommandError("No peer location known"
4349
display_url = urlutils.unescape_for_display(parent,
4351
message("Using saved parent location: "
4352
+ display_url + "\n")
4354
remote_branch = Branch.open(other_branch)
4355
if remote_branch.base == local_branch.base:
4356
remote_branch = local_branch
4358
self.add_cleanup(remote_branch.lock_read().unlock)
4360
local_revid_range = _revision_range_to_revid_range(
4361
_get_revision_range(my_revision, local_branch,
4364
remote_revid_range = _revision_range_to_revid_range(
4365
_get_revision_range(revision,
4366
remote_branch, self.name()))
4368
local_extra, remote_extra = find_unmerged(
4369
local_branch, remote_branch, restrict,
4370
backward=not reverse,
4371
include_merges=include_merges,
4372
local_revid_range=local_revid_range,
4373
remote_revid_range=remote_revid_range)
4375
if log_format is None:
4376
registry = log.log_formatter_registry
4377
log_format = registry.get_default(local_branch)
4378
lf = log_format(to_file=self.outf,
4380
show_timezone='original')
4383
if local_extra and not theirs_only:
4384
message("You have %d extra revision(s):\n" %
4386
for revision in iter_log_revisions(local_extra,
4387
local_branch.repository,
4389
lf.log_revision(revision)
4390
printed_local = True
4393
printed_local = False
4395
if remote_extra and not mine_only:
4396
if printed_local is True:
4398
message("You are missing %d revision(s):\n" %
4400
for revision in iter_log_revisions(remote_extra,
4401
remote_branch.repository,
4403
lf.log_revision(revision)
4406
if mine_only and not local_extra:
4407
# We checked local, and found nothing extra
4408
message('This branch is up to date.\n')
4409
elif theirs_only and not remote_extra:
4410
# We checked remote, and found nothing extra
4411
message('Other branch is up to date.\n')
4412
elif not (mine_only or theirs_only or local_extra or
4414
# We checked both branches, and neither one had extra
4416
message("Branches are up to date.\n")
4418
if not status_code and parent is None and other_branch is not None:
4419
self.add_cleanup(local_branch.lock_write().unlock)
4420
# handle race conditions - a parent might be set while we run.
4421
if local_branch.get_parent() is None:
4422
local_branch.set_parent(remote_branch.base)
4426
class cmd_pack(Command):
4427
__doc__ = """Compress the data within a repository.
4429
This operation compresses the data within a bazaar repository. As
4430
bazaar supports automatic packing of repository, this operation is
4431
normally not required to be done manually.
4433
During the pack operation, bazaar takes a backup of existing repository
4434
data, i.e. pack files. This backup is eventually removed by bazaar
4435
automatically when it is safe to do so. To save disk space by removing
4436
the backed up pack files, the --clean-obsolete-packs option may be
4439
Warning: If you use --clean-obsolete-packs and your machine crashes
4440
during or immediately after repacking, you may be left with a state
4441
where the deletion has been written to disk but the new packs have not
4442
been. In this case the repository may be unusable.
4445
_see_also = ['repositories']
4446
takes_args = ['branch_or_repo?']
4448
Option('clean-obsolete-packs', 'Delete obsolete packs to save disk space.'),
4451
def run(self, branch_or_repo='.', clean_obsolete_packs=False):
4452
dir = bzrdir.BzrDir.open_containing(branch_or_repo)[0]
4454
branch = dir.open_branch()
4455
repository = branch.repository
4456
except errors.NotBranchError:
4457
repository = dir.open_repository()
4458
repository.pack(clean_obsolete_packs=clean_obsolete_packs)
4461
class cmd_plugins(Command):
4462
__doc__ = """List the installed plugins.
4464
This command displays the list of installed plugins including
4465
version of plugin and a short description of each.
4467
--verbose shows the path where each plugin is located.
4469
A plugin is an external component for Bazaar that extends the
4470
revision control system, by adding or replacing code in Bazaar.
4471
Plugins can do a variety of things, including overriding commands,
4472
adding new commands, providing additional network transports and
4473
customizing log output.
4475
See the Bazaar Plugin Guide <http://doc.bazaar.canonical.com/plugins/en/>
4476
for further information on plugins including where to find them and how to
4477
install them. Instructions are also provided there on how to write new
4478
plugins using the Python programming language.
4480
takes_options = ['verbose']
4483
def run(self, verbose=False):
4484
import bzrlib.plugin
4485
from inspect import getdoc
4487
for name, plugin in bzrlib.plugin.plugins().items():
4488
version = plugin.__version__
4489
if version == 'unknown':
4491
name_ver = '%s %s' % (name, version)
4492
d = getdoc(plugin.module)
4494
doc = d.split('\n')[0]
4496
doc = '(no description)'
4497
result.append((name_ver, doc, plugin.path()))
4498
for name_ver, doc, path in sorted(result):
4499
self.outf.write("%s\n" % name_ver)
4500
self.outf.write(" %s\n" % doc)
4502
self.outf.write(" %s\n" % path)
4503
self.outf.write("\n")
4506
class cmd_testament(Command):
4507
__doc__ = """Show testament (signing-form) of a revision."""
4510
Option('long', help='Produce long-format testament.'),
4512
help='Produce a strict-format testament.')]
4513
takes_args = ['branch?']
4515
def run(self, branch=u'.', revision=None, long=False, strict=False):
4516
from bzrlib.testament import Testament, StrictTestament
4518
testament_class = StrictTestament
4520
testament_class = Testament
4522
b = Branch.open_containing(branch)[0]
4524
b = Branch.open(branch)
4525
self.add_cleanup(b.lock_read().unlock)
4526
if revision is None:
4527
rev_id = b.last_revision()
4529
rev_id = revision[0].as_revision_id(b)
4530
t = testament_class.from_revision(b.repository, rev_id)
4532
sys.stdout.writelines(t.as_text_lines())
4534
sys.stdout.write(t.as_short_text())
4537
class cmd_annotate(Command):
4538
__doc__ = """Show the origin of each line in a file.
4540
This prints out the given file with an annotation on the left side
4541
indicating which revision, author and date introduced the change.
4543
If the origin is the same for a run of consecutive lines, it is
4544
shown only at the top, unless the --all option is given.
4546
# TODO: annotate directories; showing when each file was last changed
4547
# TODO: if the working copy is modified, show annotations on that
4548
# with new uncommitted lines marked
4549
aliases = ['ann', 'blame', 'praise']
4550
takes_args = ['filename']
4551
takes_options = [Option('all', help='Show annotations on all lines.'),
4552
Option('long', help='Show commit date in annotations.'),
4557
encoding_type = 'exact'
4560
def run(self, filename, all=False, long=False, revision=None,
4561
show_ids=False, directory=None):
4562
from bzrlib.annotate import annotate_file, annotate_file_tree
4563
wt, branch, relpath = \
4564
_open_directory_or_containing_tree_or_branch(filename, directory)
4566
self.add_cleanup(wt.lock_read().unlock)
4568
self.add_cleanup(branch.lock_read().unlock)
4569
tree = _get_one_revision_tree('annotate', revision, branch=branch)
4570
self.add_cleanup(tree.lock_read().unlock)
4572
file_id = wt.path2id(relpath)
4574
file_id = tree.path2id(relpath)
4576
raise errors.NotVersionedError(filename)
4577
file_version = tree.inventory[file_id].revision
4578
if wt is not None and revision is None:
4579
# If there is a tree and we're not annotating historical
4580
# versions, annotate the working tree's content.
4581
annotate_file_tree(wt, file_id, self.outf, long, all,
4584
annotate_file(branch, file_version, file_id, long, all, self.outf,
4588
class cmd_re_sign(Command):
4589
__doc__ = """Create a digital signature for an existing revision."""
4590
# TODO be able to replace existing ones.
4592
hidden = True # is this right ?
4593
takes_args = ['revision_id*']
4594
takes_options = ['directory', 'revision']
4596
def run(self, revision_id_list=None, revision=None, directory=u'.'):
4597
if revision_id_list is not None and revision is not None:
4598
raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
4599
if revision_id_list is None and revision is None:
4600
raise errors.BzrCommandError('You must supply either --revision or a revision_id')
4601
b = WorkingTree.open_containing(directory)[0].branch
4602
self.add_cleanup(b.lock_write().unlock)
4603
return self._run(b, revision_id_list, revision)
4605
def _run(self, b, revision_id_list, revision):
4606
import bzrlib.gpg as gpg
4607
gpg_strategy = gpg.GPGStrategy(b.get_config())
4608
if revision_id_list is not None:
4609
b.repository.start_write_group()
4611
for revision_id in revision_id_list:
4612
b.repository.sign_revision(revision_id, gpg_strategy)
4614
b.repository.abort_write_group()
4617
b.repository.commit_write_group()
4618
elif revision is not None:
4619
if len(revision) == 1:
4620
revno, rev_id = revision[0].in_history(b)
4621
b.repository.start_write_group()
4623
b.repository.sign_revision(rev_id, gpg_strategy)
4625
b.repository.abort_write_group()
4628
b.repository.commit_write_group()
4629
elif len(revision) == 2:
4630
# are they both on rh- if so we can walk between them
4631
# might be nice to have a range helper for arbitrary
4632
# revision paths. hmm.
4633
from_revno, from_revid = revision[0].in_history(b)
4634
to_revno, to_revid = revision[1].in_history(b)
4635
if to_revid is None:
4636
to_revno = b.revno()
4637
if from_revno is None or to_revno is None:
4638
raise errors.BzrCommandError('Cannot sign a range of non-revision-history revisions')
4639
b.repository.start_write_group()
4641
for revno in range(from_revno, to_revno + 1):
4642
b.repository.sign_revision(b.get_rev_id(revno),
4645
b.repository.abort_write_group()
4648
b.repository.commit_write_group()
4650
raise errors.BzrCommandError('Please supply either one revision, or a range.')
4653
class cmd_bind(Command):
4654
__doc__ = """Convert the current branch into a checkout of the supplied branch.
4655
If no branch is supplied, rebind to the last bound location.
4657
Once converted into a checkout, commits must succeed on the master branch
4658
before they will be applied to the local branch.
4660
Bound branches use the nickname of its master branch unless it is set
4661
locally, in which case binding will update the local nickname to be
4665
_see_also = ['checkouts', 'unbind']
4666
takes_args = ['location?']
4667
takes_options = ['directory']
4669
def run(self, location=None, directory=u'.'):
4670
b, relpath = Branch.open_containing(directory)
4671
if location is None:
4673
location = b.get_old_bound_location()
4674
except errors.UpgradeRequired:
4675
raise errors.BzrCommandError('No location supplied. '
4676
'This format does not remember old locations.')
4678
if location is None:
4679
if b.get_bound_location() is not None:
4680
raise errors.BzrCommandError('Branch is already bound')
4682
raise errors.BzrCommandError('No location supplied '
4683
'and no previous location known')
4684
b_other = Branch.open(location)
4687
except errors.DivergedBranches:
4688
raise errors.BzrCommandError('These branches have diverged.'
4689
' Try merging, and then bind again.')
4690
if b.get_config().has_explicit_nickname():
4691
b.nick = b_other.nick
4694
class cmd_unbind(Command):
4695
__doc__ = """Convert the current checkout into a regular branch.
4697
After unbinding, the local branch is considered independent and subsequent
4698
commits will be local only.
4701
_see_also = ['checkouts', 'bind']
4703
takes_options = ['directory']
4705
def run(self, directory=u'.'):
4706
b, relpath = Branch.open_containing(directory)
4708
raise errors.BzrCommandError('Local branch is not bound')
4711
class cmd_uncommit(Command):
4712
__doc__ = """Remove the last committed revision.
4714
--verbose will print out what is being removed.
4715
--dry-run will go through all the motions, but not actually
4718
If --revision is specified, uncommit revisions to leave the branch at the
4719
specified revision. For example, "bzr uncommit -r 15" will leave the
4720
branch at revision 15.
4722
Uncommit leaves the working tree ready for a new commit. The only change
4723
it may make is to restore any pending merges that were present before
4727
# TODO: jam 20060108 Add an option to allow uncommit to remove
4728
# unreferenced information in 'branch-as-repository' branches.
4729
# TODO: jam 20060108 Add the ability for uncommit to remove unreferenced
4730
# information in shared branches as well.
4731
_see_also = ['commit']
4732
takes_options = ['verbose', 'revision',
4733
Option('dry-run', help='Don\'t actually make changes.'),
4734
Option('force', help='Say yes to all questions.'),
4736
help="Only remove the commits from the local branch"
4737
" when in a checkout."
4740
takes_args = ['location?']
4742
encoding_type = 'replace'
4744
def run(self, location=None,
4745
dry_run=False, verbose=False,
4746
revision=None, force=False, local=False):
4747
if location is None:
4749
control, relpath = bzrdir.BzrDir.open_containing(location)
4751
tree = control.open_workingtree()
4753
except (errors.NoWorkingTree, errors.NotLocalUrl):
4755
b = control.open_branch()
4757
if tree is not None:
4758
self.add_cleanup(tree.lock_write().unlock)
4760
self.add_cleanup(b.lock_write().unlock)
4761
return self._run(b, tree, dry_run, verbose, revision, force, local=local)
4763
def _run(self, b, tree, dry_run, verbose, revision, force, local=False):
4764
from bzrlib.log import log_formatter, show_log
4765
from bzrlib.uncommit import uncommit
4767
last_revno, last_rev_id = b.last_revision_info()
4770
if revision is None:
4772
rev_id = last_rev_id
4774
# 'bzr uncommit -r 10' actually means uncommit
4775
# so that the final tree is at revno 10.
4776
# but bzrlib.uncommit.uncommit() actually uncommits
4777
# the revisions that are supplied.
4778
# So we need to offset it by one
4779
revno = revision[0].in_history(b).revno + 1
4780
if revno <= last_revno:
4781
rev_id = b.get_rev_id(revno)
4783
if rev_id is None or _mod_revision.is_null(rev_id):
4784
self.outf.write('No revisions to uncommit.\n')
4787
lf = log_formatter('short',
4789
show_timezone='original')
4794
direction='forward',
4795
start_revision=revno,
4796
end_revision=last_revno)
4799
self.outf.write('Dry-run, pretending to remove'
4800
' the above revisions.\n')
4802
self.outf.write('The above revision(s) will be removed.\n')
4805
if not ui.ui_factory.get_boolean('Are you sure'):
4806
self.outf.write('Canceled')
4809
mutter('Uncommitting from {%s} to {%s}',
4810
last_rev_id, rev_id)
4811
uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
4812
revno=revno, local=local)
4813
self.outf.write('You can restore the old tip by running:\n'
4814
' bzr pull . -r revid:%s\n' % last_rev_id)
4817
class cmd_break_lock(Command):
4818
__doc__ = """Break a dead lock on a repository, branch or working directory.
4820
CAUTION: Locks should only be broken when you are sure that the process
4821
holding the lock has been stopped.
4823
You can get information on what locks are open via the 'bzr info
4824
[location]' command.
4828
bzr break-lock bzr+ssh://example.com/bzr/foo
4830
takes_args = ['location?']
4832
def run(self, location=None, show=False):
4833
if location is None:
4835
control, relpath = bzrdir.BzrDir.open_containing(location)
4837
control.break_lock()
4838
except NotImplementedError:
4842
class cmd_wait_until_signalled(Command):
4843
__doc__ = """Test helper for test_start_and_stop_bzr_subprocess_send_signal.
4845
This just prints a line to signal when it is ready, then blocks on stdin.
4851
sys.stdout.write("running\n")
4853
sys.stdin.readline()
4856
class cmd_serve(Command):
4857
__doc__ = """Run the bzr server."""
4859
aliases = ['server']
4863
help='Serve on stdin/out for use from inetd or sshd.'),
4864
RegistryOption('protocol',
4865
help="Protocol to serve.",
4866
lazy_registry=('bzrlib.transport', 'transport_server_registry'),
4867
value_switches=True),
4869
help='Listen for connections on nominated port of the form '
4870
'[hostname:]portnumber. Passing 0 as the port number will '
4871
'result in a dynamically allocated port. The default port '
4872
'depends on the protocol.',
4874
custom_help('directory',
4875
help='Serve contents of this directory.'),
4876
Option('allow-writes',
4877
help='By default the server is a readonly server. Supplying '
4878
'--allow-writes enables write access to the contents of '
4879
'the served directory and below. Note that ``bzr serve`` '
4880
'does not perform authentication, so unless some form of '
4881
'external authentication is arranged supplying this '
4882
'option leads to global uncontrolled write access to your '
4887
def get_host_and_port(self, port):
4888
"""Return the host and port to run the smart server on.
4890
If 'port' is None, None will be returned for the host and port.
4892
If 'port' has a colon in it, the string before the colon will be
4893
interpreted as the host.
4895
:param port: A string of the port to run the server on.
4896
:return: A tuple of (host, port), where 'host' is a host name or IP,
4897
and port is an integer TCP/IP port.
4900
if port is not None:
4902
host, port = port.split(':')
4906
def run(self, port=None, inet=False, directory=None, allow_writes=False,
4908
from bzrlib.transport import get_transport, transport_server_registry
4909
if directory is None:
4910
directory = os.getcwd()
4911
if protocol is None:
4912
protocol = transport_server_registry.get()
4913
host, port = self.get_host_and_port(port)
4914
url = urlutils.local_path_to_url(directory)
4915
if not allow_writes:
4916
url = 'readonly+' + url
4917
transport = get_transport(url)
4918
protocol(transport, host, port, inet)
4921
class cmd_join(Command):
4922
__doc__ = """Combine a tree into its containing tree.
4924
This command requires the target tree to be in a rich-root format.
4926
The TREE argument should be an independent tree, inside another tree, but
4927
not part of it. (Such trees can be produced by "bzr split", but also by
4928
running "bzr branch" with the target inside a tree.)
4930
The result is a combined tree, with the subtree no longer an independant
4931
part. This is marked as a merge of the subtree into the containing tree,
4932
and all history is preserved.
4935
_see_also = ['split']
4936
takes_args = ['tree']
4938
Option('reference', help='Join by reference.', hidden=True),
4941
def run(self, tree, reference=False):
4942
sub_tree = WorkingTree.open(tree)
4943
parent_dir = osutils.dirname(sub_tree.basedir)
4944
containing_tree = WorkingTree.open_containing(parent_dir)[0]
4945
repo = containing_tree.branch.repository
4946
if not repo.supports_rich_root():
4947
raise errors.BzrCommandError(
4948
"Can't join trees because %s doesn't support rich root data.\n"
4949
"You can use bzr upgrade on the repository."
4953
containing_tree.add_reference(sub_tree)
4954
except errors.BadReferenceTarget, e:
4955
# XXX: Would be better to just raise a nicely printable
4956
# exception from the real origin. Also below. mbp 20070306
4957
raise errors.BzrCommandError("Cannot join %s. %s" %
4961
containing_tree.subsume(sub_tree)
4962
except errors.BadSubsumeSource, e:
4963
raise errors.BzrCommandError("Cannot join %s. %s" %
4967
class cmd_split(Command):
4968
__doc__ = """Split a subdirectory of a tree into a separate tree.
4970
This command will produce a target tree in a format that supports
4971
rich roots, like 'rich-root' or 'rich-root-pack'. These formats cannot be
4972
converted into earlier formats like 'dirstate-tags'.
4974
The TREE argument should be a subdirectory of a working tree. That
4975
subdirectory will be converted into an independent tree, with its own
4976
branch. Commits in the top-level tree will not apply to the new subtree.
4979
_see_also = ['join']
4980
takes_args = ['tree']
4982
def run(self, tree):
4983
containing_tree, subdir = WorkingTree.open_containing(tree)
4984
sub_id = containing_tree.path2id(subdir)
4986
raise errors.NotVersionedError(subdir)
4988
containing_tree.extract(sub_id)
4989
except errors.RootNotRich:
4990
raise errors.RichRootUpgradeRequired(containing_tree.branch.base)
4993
class cmd_merge_directive(Command):
4994
__doc__ = """Generate a merge directive for auto-merge tools.
4996
A directive requests a merge to be performed, and also provides all the
4997
information necessary to do so. This means it must either include a
4998
revision bundle, or the location of a branch containing the desired
5001
A submit branch (the location to merge into) must be supplied the first
5002
time the command is issued. After it has been supplied once, it will
5003
be remembered as the default.
5005
A public branch is optional if a revision bundle is supplied, but required
5006
if --diff or --plain is specified. It will be remembered as the default
5007
after the first use.
5010
takes_args = ['submit_branch?', 'public_branch?']
5014
_see_also = ['send']
5017
RegistryOption.from_kwargs('patch-type',
5018
'The type of patch to include in the directive.',
5020
value_switches=True,
5022
bundle='Bazaar revision bundle (default).',
5023
diff='Normal unified diff.',
5024
plain='No patch, just directive.'),
5025
Option('sign', help='GPG-sign the directive.'), 'revision',
5026
Option('mail-to', type=str,
5027
help='Instead of printing the directive, email to this address.'),
5028
Option('message', type=str, short_name='m',
5029
help='Message to use when committing this merge.')
5032
encoding_type = 'exact'
5034
def run(self, submit_branch=None, public_branch=None, patch_type='bundle',
5035
sign=False, revision=None, mail_to=None, message=None):
5036
from bzrlib.revision import ensure_null, NULL_REVISION
5037
include_patch, include_bundle = {
5038
'plain': (False, False),
5039
'diff': (True, False),
5040
'bundle': (True, True),
5042
branch = Branch.open('.')
5043
stored_submit_branch = branch.get_submit_branch()
5044
if submit_branch is None:
5045
submit_branch = stored_submit_branch
5047
if stored_submit_branch is None:
5048
branch.set_submit_branch(submit_branch)
5049
if submit_branch is None:
5050
submit_branch = branch.get_parent()
5051
if submit_branch is None:
5052
raise errors.BzrCommandError('No submit branch specified or known')
5054
stored_public_branch = branch.get_public_branch()
5055
if public_branch is None:
5056
public_branch = stored_public_branch
5057
elif stored_public_branch is None:
5058
branch.set_public_branch(public_branch)
5059
if not include_bundle and public_branch is None:
5060
raise errors.BzrCommandError('No public branch specified or'
5062
base_revision_id = None
5063
if revision is not None:
5064
if len(revision) > 2:
5065
raise errors.BzrCommandError('bzr merge-directive takes '
5066
'at most two one revision identifiers')
5067
revision_id = revision[-1].as_revision_id(branch)
5068
if len(revision) == 2:
5069
base_revision_id = revision[0].as_revision_id(branch)
5071
revision_id = branch.last_revision()
5072
revision_id = ensure_null(revision_id)
5073
if revision_id == NULL_REVISION:
5074
raise errors.BzrCommandError('No revisions to bundle.')
5075
directive = merge_directive.MergeDirective2.from_objects(
5076
branch.repository, revision_id, time.time(),
5077
osutils.local_time_offset(), submit_branch,
5078
public_branch=public_branch, include_patch=include_patch,
5079
include_bundle=include_bundle, message=message,
5080
base_revision_id=base_revision_id)
5083
self.outf.write(directive.to_signed(branch))
5085
self.outf.writelines(directive.to_lines())
5087
message = directive.to_email(mail_to, branch, sign)
5088
s = SMTPConnection(branch.get_config())
5089
s.send_email(message)
5092
class cmd_send(Command):
5093
__doc__ = """Mail or create a merge-directive for submitting changes.
5095
A merge directive provides many things needed for requesting merges:
5097
* A machine-readable description of the merge to perform
5099
* An optional patch that is a preview of the changes requested
5101
* An optional bundle of revision data, so that the changes can be applied
5102
directly from the merge directive, without retrieving data from a
5105
`bzr send` creates a compact data set that, when applied using bzr
5106
merge, has the same effect as merging from the source branch.
5108
By default the merge directive is self-contained and can be applied to any
5109
branch containing submit_branch in its ancestory without needing access to
5112
If --no-bundle is specified, then Bazaar doesn't send the contents of the
5113
revisions, but only a structured request to merge from the
5114
public_location. In that case the public_branch is needed and it must be
5115
up-to-date and accessible to the recipient. The public_branch is always
5116
included if known, so that people can check it later.
5118
The submit branch defaults to the parent of the source branch, but can be
5119
overridden. Both submit branch and public branch will be remembered in
5120
branch.conf the first time they are used for a particular branch. The
5121
source branch defaults to that containing the working directory, but can
5122
be changed using --from.
5124
In order to calculate those changes, bzr must analyse the submit branch.
5125
Therefore it is most efficient for the submit branch to be a local mirror.
5126
If a public location is known for the submit_branch, that location is used
5127
in the merge directive.
5129
The default behaviour is to send the merge directive by mail, unless -o is
5130
given, in which case it is sent to a file.
5132
Mail is sent using your preferred mail program. This should be transparent
5133
on Windows (it uses MAPI). On Unix, it requires the xdg-email utility.
5134
If the preferred client can't be found (or used), your editor will be used.
5136
To use a specific mail program, set the mail_client configuration option.
5137
(For Thunderbird 1.5, this works around some bugs.) Supported values for
5138
specific clients are "claws", "evolution", "kmail", "mail.app" (MacOS X's
5139
Mail.app), "mutt", and "thunderbird"; generic options are "default",
5140
"editor", "emacsclient", "mapi", and "xdg-email". Plugins may also add
5143
If mail is being sent, a to address is required. This can be supplied
5144
either on the commandline, by setting the submit_to configuration
5145
option in the branch itself or the child_submit_to configuration option
5146
in the submit branch.
5148
Two formats are currently supported: "4" uses revision bundle format 4 and
5149
merge directive format 2. It is significantly faster and smaller than
5150
older formats. It is compatible with Bazaar 0.19 and later. It is the
5151
default. "0.9" uses revision bundle format 0.9 and merge directive
5152
format 1. It is compatible with Bazaar 0.12 - 0.18.
5154
The merge directives created by bzr send may be applied using bzr merge or
5155
bzr pull by specifying a file containing a merge directive as the location.
5157
bzr send makes extensive use of public locations to map local locations into
5158
URLs that can be used by other people. See `bzr help configuration` to
5159
set them, and use `bzr info` to display them.
5162
encoding_type = 'exact'
5164
_see_also = ['merge', 'pull']
5166
takes_args = ['submit_branch?', 'public_branch?']
5170
help='Do not include a bundle in the merge directive.'),
5171
Option('no-patch', help='Do not include a preview patch in the merge'
5174
help='Remember submit and public branch.'),
5176
help='Branch to generate the submission from, '
5177
'rather than the one containing the working directory.',
5180
Option('output', short_name='o',
5181
help='Write merge directive to this file or directory; '
5182
'use - for stdout.',
5185
help='Refuse to send if there are uncommitted changes in'
5186
' the working tree, --no-strict disables the check.'),
5187
Option('mail-to', help='Mail the request to this address.',
5191
Option('body', help='Body for the email.', type=unicode),
5192
RegistryOption('format',
5193
help='Use the specified output format.',
5194
lazy_registry=('bzrlib.send', 'format_registry')),
5197
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
5198
no_patch=False, revision=None, remember=False, output=None,
5199
format=None, mail_to=None, message=None, body=None,
5200
strict=None, **kwargs):
5201
from bzrlib.send import send
5202
return send(submit_branch, revision, public_branch, remember,
5203
format, no_bundle, no_patch, output,
5204
kwargs.get('from', '.'), mail_to, message, body,
5209
class cmd_bundle_revisions(cmd_send):
5210
__doc__ = """Create a merge-directive for submitting changes.
5212
A merge directive provides many things needed for requesting merges:
5214
* A machine-readable description of the merge to perform
5216
* An optional patch that is a preview of the changes requested
5218
* An optional bundle of revision data, so that the changes can be applied
5219
directly from the merge directive, without retrieving data from a
5222
If --no-bundle is specified, then public_branch is needed (and must be
5223
up-to-date), so that the receiver can perform the merge using the
5224
public_branch. The public_branch is always included if known, so that
5225
people can check it later.
5227
The submit branch defaults to the parent, but can be overridden. Both
5228
submit branch and public branch will be remembered if supplied.
5230
If a public_branch is known for the submit_branch, that public submit
5231
branch is used in the merge instructions. This means that a local mirror
5232
can be used as your actual submit branch, once you have set public_branch
5235
Two formats are currently supported: "4" uses revision bundle format 4 and
5236
merge directive format 2. It is significantly faster and smaller than
5237
older formats. It is compatible with Bazaar 0.19 and later. It is the
5238
default. "0.9" uses revision bundle format 0.9 and merge directive
5239
format 1. It is compatible with Bazaar 0.12 - 0.18.
5244
help='Do not include a bundle in the merge directive.'),
5245
Option('no-patch', help='Do not include a preview patch in the merge'
5248
help='Remember submit and public branch.'),
5250
help='Branch to generate the submission from, '
5251
'rather than the one containing the working directory.',
5254
Option('output', short_name='o', help='Write directive to this file.',
5257
help='Refuse to bundle revisions if there are uncommitted'
5258
' changes in the working tree, --no-strict disables the check.'),
5260
RegistryOption('format',
5261
help='Use the specified output format.',
5262
lazy_registry=('bzrlib.send', 'format_registry')),
5264
aliases = ['bundle']
5266
_see_also = ['send', 'merge']
5270
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
5271
no_patch=False, revision=None, remember=False, output=None,
5272
format=None, strict=None, **kwargs):
5275
from bzrlib.send import send
5276
return send(submit_branch, revision, public_branch, remember,
5277
format, no_bundle, no_patch, output,
5278
kwargs.get('from', '.'), None, None, None,
5279
self.outf, strict=strict)
5282
class cmd_tag(Command):
5283
__doc__ = """Create, remove or modify a tag naming a revision.
5285
Tags give human-meaningful names to revisions. Commands that take a -r
5286
(--revision) option can be given -rtag:X, where X is any previously
5289
Tags are stored in the branch. Tags are copied from one branch to another
5290
along when you branch, push, pull or merge.
5292
It is an error to give a tag name that already exists unless you pass
5293
--force, in which case the tag is moved to point to the new revision.
5295
To rename a tag (change the name but keep it on the same revsion), run ``bzr
5296
tag new-name -r tag:old-name`` and then ``bzr tag --delete oldname``.
5298
If no tag name is specified it will be determined through the
5299
'automatic_tag_name' hook. This can e.g. be used to automatically tag
5300
upstream releases by reading configure.ac. See ``bzr help hooks`` for
5304
_see_also = ['commit', 'tags']
5305
takes_args = ['tag_name?']
5308
help='Delete this tag rather than placing it.',
5310
custom_help('directory',
5311
help='Branch in which to place the tag.'),
5313
help='Replace existing tags.',
5318
def run(self, tag_name=None,
5324
branch, relpath = Branch.open_containing(directory)
5325
self.add_cleanup(branch.lock_write().unlock)
5327
if tag_name is None:
5328
raise errors.BzrCommandError("No tag specified to delete.")
5329
branch.tags.delete_tag(tag_name)
5330
self.outf.write('Deleted tag %s.\n' % tag_name)
5333
if len(revision) != 1:
5334
raise errors.BzrCommandError(
5335
"Tags can only be placed on a single revision, "
5337
revision_id = revision[0].as_revision_id(branch)
5339
revision_id = branch.last_revision()
5340
if tag_name is None:
5341
tag_name = branch.automatic_tag_name(revision_id)
5342
if tag_name is None:
5343
raise errors.BzrCommandError(
5344
"Please specify a tag name.")
5345
if (not force) and branch.tags.has_tag(tag_name):
5346
raise errors.TagAlreadyExists(tag_name)
5347
branch.tags.set_tag(tag_name, revision_id)
5348
self.outf.write('Created tag %s.\n' % tag_name)
5351
class cmd_tags(Command):
5352
__doc__ = """List tags.
5354
This command shows a table of tag names and the revisions they reference.
5359
custom_help('directory',
5360
help='Branch whose tags should be displayed.'),
5361
RegistryOption.from_kwargs('sort',
5362
'Sort tags by different criteria.', title='Sorting',
5363
alpha='Sort tags lexicographically (default).',
5364
time='Sort tags chronologically.',
5377
branch, relpath = Branch.open_containing(directory)
5379
tags = branch.tags.get_tag_dict().items()
5383
self.add_cleanup(branch.lock_read().unlock)
5385
graph = branch.repository.get_graph()
5386
rev1, rev2 = _get_revision_range(revision, branch, self.name())
5387
revid1, revid2 = rev1.rev_id, rev2.rev_id
5388
# only show revisions between revid1 and revid2 (inclusive)
5389
tags = [(tag, revid) for tag, revid in tags if
5390
graph.is_between(revid, revid1, revid2)]
5393
elif sort == 'time':
5395
for tag, revid in tags:
5397
revobj = branch.repository.get_revision(revid)
5398
except errors.NoSuchRevision:
5399
timestamp = sys.maxint # place them at the end
5401
timestamp = revobj.timestamp
5402
timestamps[revid] = timestamp
5403
tags.sort(key=lambda x: timestamps[x[1]])
5405
# [ (tag, revid), ... ] -> [ (tag, dotted_revno), ... ]
5406
for index, (tag, revid) in enumerate(tags):
5408
revno = branch.revision_id_to_dotted_revno(revid)
5409
if isinstance(revno, tuple):
5410
revno = '.'.join(map(str, revno))
5411
except errors.NoSuchRevision:
5412
# Bad tag data/merges can lead to tagged revisions
5413
# which are not in this branch. Fail gracefully ...
5415
tags[index] = (tag, revno)
5417
for tag, revspec in tags:
5418
self.outf.write('%-20s %s\n' % (tag, revspec))
5421
class cmd_reconfigure(Command):
5422
__doc__ = """Reconfigure the type of a bzr directory.
5424
A target configuration must be specified.
5426
For checkouts, the bind-to location will be auto-detected if not specified.
5427
The order of preference is
5428
1. For a lightweight checkout, the current bound location.
5429
2. For branches that used to be checkouts, the previously-bound location.
5430
3. The push location.
5431
4. The parent location.
5432
If none of these is available, --bind-to must be specified.
5435
_see_also = ['branches', 'checkouts', 'standalone-trees', 'working-trees']
5436
takes_args = ['location?']
5438
RegistryOption.from_kwargs(
5440
title='Target type',
5441
help='The type to reconfigure the directory to.',
5442
value_switches=True, enum_switch=False,
5443
branch='Reconfigure to be an unbound branch with no working tree.',
5444
tree='Reconfigure to be an unbound branch with a working tree.',
5445
checkout='Reconfigure to be a bound branch with a working tree.',
5446
lightweight_checkout='Reconfigure to be a lightweight'
5447
' checkout (with no local history).',
5448
standalone='Reconfigure to be a standalone branch '
5449
'(i.e. stop using shared repository).',
5450
use_shared='Reconfigure to use a shared repository.',
5451
with_trees='Reconfigure repository to create '
5452
'working trees on branches by default.',
5453
with_no_trees='Reconfigure repository to not create '
5454
'working trees on branches by default.'
5456
Option('bind-to', help='Branch to bind checkout to.', type=str),
5458
help='Perform reconfiguration even if local changes'
5460
Option('stacked-on',
5461
help='Reconfigure a branch to be stacked on another branch.',
5465
help='Reconfigure a branch to be unstacked. This '
5466
'may require copying substantial data into it.',
5470
def run(self, location=None, target_type=None, bind_to=None, force=False,
5473
directory = bzrdir.BzrDir.open(location)
5474
if stacked_on and unstacked:
5475
raise BzrCommandError("Can't use both --stacked-on and --unstacked")
5476
elif stacked_on is not None:
5477
reconfigure.ReconfigureStackedOn().apply(directory, stacked_on)
5479
reconfigure.ReconfigureUnstacked().apply(directory)
5480
# At the moment you can use --stacked-on and a different
5481
# reconfiguration shape at the same time; there seems no good reason
5483
if target_type is None:
5484
if stacked_on or unstacked:
5487
raise errors.BzrCommandError('No target configuration '
5489
elif target_type == 'branch':
5490
reconfiguration = reconfigure.Reconfigure.to_branch(directory)
5491
elif target_type == 'tree':
5492
reconfiguration = reconfigure.Reconfigure.to_tree(directory)
5493
elif target_type == 'checkout':
5494
reconfiguration = reconfigure.Reconfigure.to_checkout(
5496
elif target_type == 'lightweight-checkout':
5497
reconfiguration = reconfigure.Reconfigure.to_lightweight_checkout(
5499
elif target_type == 'use-shared':
5500
reconfiguration = reconfigure.Reconfigure.to_use_shared(directory)
5501
elif target_type == 'standalone':
5502
reconfiguration = reconfigure.Reconfigure.to_standalone(directory)
5503
elif target_type == 'with-trees':
5504
reconfiguration = reconfigure.Reconfigure.set_repository_trees(
5506
elif target_type == 'with-no-trees':
5507
reconfiguration = reconfigure.Reconfigure.set_repository_trees(
5509
reconfiguration.apply(force)
5512
class cmd_switch(Command):
5513
__doc__ = """Set the branch of a checkout and update.
5515
For lightweight checkouts, this changes the branch being referenced.
5516
For heavyweight checkouts, this checks that there are no local commits
5517
versus the current bound branch, then it makes the local branch a mirror
5518
of the new location and binds to it.
5520
In both cases, the working tree is updated and uncommitted changes
5521
are merged. The user can commit or revert these as they desire.
5523
Pending merges need to be committed or reverted before using switch.
5525
The path to the branch to switch to can be specified relative to the parent
5526
directory of the current branch. For example, if you are currently in a
5527
checkout of /path/to/branch, specifying 'newbranch' will find a branch at
5530
Bound branches use the nickname of its master branch unless it is set
5531
locally, in which case switching will update the local nickname to be
5535
takes_args = ['to_location?']
5536
takes_options = [Option('force',
5537
help='Switch even if local commits will be lost.'),
5539
Option('create-branch', short_name='b',
5540
help='Create the target branch from this one before'
5541
' switching to it.'),
5544
def run(self, to_location=None, force=False, create_branch=False,
5546
from bzrlib import switch
5548
revision = _get_one_revision('switch', revision)
5549
control_dir = bzrdir.BzrDir.open_containing(tree_location)[0]
5550
if to_location is None:
5551
if revision is None:
5552
raise errors.BzrCommandError('You must supply either a'
5553
' revision or a location')
5556
branch = control_dir.open_branch()
5557
had_explicit_nick = branch.get_config().has_explicit_nickname()
5558
except errors.NotBranchError:
5560
had_explicit_nick = False
5563
raise errors.BzrCommandError('cannot create branch without'
5565
to_location = directory_service.directories.dereference(
5567
if '/' not in to_location and '\\' not in to_location:
5568
# This path is meant to be relative to the existing branch
5569
this_url = self._get_branch_location(control_dir)
5570
to_location = urlutils.join(this_url, '..', to_location)
5571
to_branch = branch.bzrdir.sprout(to_location,
5572
possible_transports=[branch.bzrdir.root_transport],
5573
source_branch=branch).open_branch()
5576
to_branch = Branch.open(to_location)
5577
except errors.NotBranchError:
5578
this_url = self._get_branch_location(control_dir)
5579
to_branch = Branch.open(
5580
urlutils.join(this_url, '..', to_location))
5581
if revision is not None:
5582
revision = revision.as_revision_id(to_branch)
5583
switch.switch(control_dir, to_branch, force, revision_id=revision)
5584
if had_explicit_nick:
5585
branch = control_dir.open_branch() #get the new branch!
5586
branch.nick = to_branch.nick
5587
note('Switched to branch: %s',
5588
urlutils.unescape_for_display(to_branch.base, 'utf-8'))
5590
def _get_branch_location(self, control_dir):
5591
"""Return location of branch for this control dir."""
5593
this_branch = control_dir.open_branch()
5594
# This may be a heavy checkout, where we want the master branch
5595
master_location = this_branch.get_bound_location()
5596
if master_location is not None:
5597
return master_location
5598
# If not, use a local sibling
5599
return this_branch.base
5600
except errors.NotBranchError:
5601
format = control_dir.find_branch_format()
5602
if getattr(format, 'get_reference', None) is not None:
5603
return format.get_reference(control_dir)
5605
return control_dir.root_transport.base
5608
class cmd_view(Command):
5609
__doc__ = """Manage filtered views.
5611
Views provide a mask over the tree so that users can focus on
5612
a subset of a tree when doing their work. After creating a view,
5613
commands that support a list of files - status, diff, commit, etc -
5614
effectively have that list of files implicitly given each time.
5615
An explicit list of files can still be given but those files
5616
must be within the current view.
5618
In most cases, a view has a short life-span: it is created to make
5619
a selected change and is deleted once that change is committed.
5620
At other times, you may wish to create one or more named views
5621
and switch between them.
5623
To disable the current view without deleting it, you can switch to
5624
the pseudo view called ``off``. This can be useful when you need
5625
to see the whole tree for an operation or two (e.g. merge) but
5626
want to switch back to your view after that.
5629
To define the current view::
5631
bzr view file1 dir1 ...
5633
To list the current view::
5637
To delete the current view::
5641
To disable the current view without deleting it::
5643
bzr view --switch off
5645
To define a named view and switch to it::
5647
bzr view --name view-name file1 dir1 ...
5649
To list a named view::
5651
bzr view --name view-name
5653
To delete a named view::
5655
bzr view --name view-name --delete
5657
To switch to a named view::
5659
bzr view --switch view-name
5661
To list all views defined::
5665
To delete all views::
5667
bzr view --delete --all
5671
takes_args = ['file*']
5674
help='Apply list or delete action to all views.',
5677
help='Delete the view.',
5680
help='Name of the view to define, list or delete.',
5684
help='Name of the view to switch to.',
5689
def run(self, file_list,
5695
tree, file_list = tree_files(file_list, apply_view=False)
5696
current_view, view_dict = tree.views.get_view_info()
5701
raise errors.BzrCommandError(
5702
"Both --delete and a file list specified")
5704
raise errors.BzrCommandError(
5705
"Both --delete and --switch specified")
5707
tree.views.set_view_info(None, {})
5708
self.outf.write("Deleted all views.\n")
5710
raise errors.BzrCommandError("No current view to delete")
5712
tree.views.delete_view(name)
5713
self.outf.write("Deleted '%s' view.\n" % name)
5716
raise errors.BzrCommandError(
5717
"Both --switch and a file list specified")
5719
raise errors.BzrCommandError(
5720
"Both --switch and --all specified")
5721
elif switch == 'off':
5722
if current_view is None:
5723
raise errors.BzrCommandError("No current view to disable")
5724
tree.views.set_view_info(None, view_dict)
5725
self.outf.write("Disabled '%s' view.\n" % (current_view))
5727
tree.views.set_view_info(switch, view_dict)
5728
view_str = views.view_display_str(tree.views.lookup_view())
5729
self.outf.write("Using '%s' view: %s\n" % (switch, view_str))
5732
self.outf.write('Views defined:\n')
5733
for view in sorted(view_dict):
5734
if view == current_view:
5738
view_str = views.view_display_str(view_dict[view])
5739
self.outf.write('%s %-20s %s\n' % (active, view, view_str))
5741
self.outf.write('No views defined.\n')
5744
# No name given and no current view set
5747
raise errors.BzrCommandError(
5748
"Cannot change the 'off' pseudo view")
5749
tree.views.set_view(name, sorted(file_list))
5750
view_str = views.view_display_str(tree.views.lookup_view())
5751
self.outf.write("Using '%s' view: %s\n" % (name, view_str))
5755
# No name given and no current view set
5756
self.outf.write('No current view.\n')
5758
view_str = views.view_display_str(tree.views.lookup_view(name))
5759
self.outf.write("'%s' view is: %s\n" % (name, view_str))
5762
class cmd_hooks(Command):
5763
__doc__ = """Show hooks."""
5768
for hook_key in sorted(hooks.known_hooks.keys()):
5769
some_hooks = hooks.known_hooks_key_to_object(hook_key)
5770
self.outf.write("%s:\n" % type(some_hooks).__name__)
5771
for hook_name, hook_point in sorted(some_hooks.items()):
5772
self.outf.write(" %s:\n" % (hook_name,))
5773
found_hooks = list(hook_point)
5775
for hook in found_hooks:
5776
self.outf.write(" %s\n" %
5777
(some_hooks.get_hook_name(hook),))
5779
self.outf.write(" <no hooks installed>\n")
5782
class cmd_remove_branch(Command):
5783
__doc__ = """Remove a branch.
5785
This will remove the branch from the specified location but
5786
will keep any working tree or repository in place.
5790
Remove the branch at repo/trunk::
5792
bzr remove-branch repo/trunk
5796
takes_args = ["location?"]
5798
aliases = ["rmbranch"]
5800
def run(self, location=None):
5801
if location is None:
5803
branch = Branch.open_containing(location)[0]
5804
branch.bzrdir.destroy_branch()
5807
class cmd_shelve(Command):
5808
__doc__ = """Temporarily set aside some changes from the current tree.
5810
Shelve allows you to temporarily put changes you've made "on the shelf",
5811
ie. out of the way, until a later time when you can bring them back from
5812
the shelf with the 'unshelve' command. The changes are stored alongside
5813
your working tree, and so they aren't propagated along with your branch nor
5814
will they survive its deletion.
5816
If shelve --list is specified, previously-shelved changes are listed.
5818
Shelve is intended to help separate several sets of changes that have
5819
been inappropriately mingled. If you just want to get rid of all changes
5820
and you don't need to restore them later, use revert. If you want to
5821
shelve all text changes at once, use shelve --all.
5823
If filenames are specified, only the changes to those files will be
5824
shelved. Other files will be left untouched.
5826
If a revision is specified, changes since that revision will be shelved.
5828
You can put multiple items on the shelf, and by default, 'unshelve' will
5829
restore the most recently shelved changes.
5832
takes_args = ['file*']
5836
Option('all', help='Shelve all changes.'),
5838
RegistryOption('writer', 'Method to use for writing diffs.',
5839
bzrlib.option.diff_writer_registry,
5840
value_switches=True, enum_switch=False),
5842
Option('list', help='List shelved changes.'),
5844
help='Destroy removed changes instead of shelving them.'),
5846
_see_also = ['unshelve']
5848
def run(self, revision=None, all=False, file_list=None, message=None,
5849
writer=None, list=False, destroy=False):
5851
return self.run_for_list()
5852
from bzrlib.shelf_ui import Shelver
5854
writer = bzrlib.option.diff_writer_registry.get()
5856
shelver = Shelver.from_args(writer(sys.stdout), revision, all,
5857
file_list, message, destroy=destroy)
5862
except errors.UserAbort:
5865
def run_for_list(self):
5866
tree = WorkingTree.open_containing('.')[0]
5867
self.add_cleanup(tree.lock_read().unlock)
5868
manager = tree.get_shelf_manager()
5869
shelves = manager.active_shelves()
5870
if len(shelves) == 0:
5871
note('No shelved changes.')
5873
for shelf_id in reversed(shelves):
5874
message = manager.get_metadata(shelf_id).get('message')
5876
message = '<no message>'
5877
self.outf.write('%3d: %s\n' % (shelf_id, message))
5881
class cmd_unshelve(Command):
5882
__doc__ = """Restore shelved changes.
5884
By default, the most recently shelved changes are restored. However if you
5885
specify a shelf by id those changes will be restored instead. This works
5886
best when the changes don't depend on each other.
5889
takes_args = ['shelf_id?']
5891
RegistryOption.from_kwargs(
5892
'action', help="The action to perform.",
5893
enum_switch=False, value_switches=True,
5894
apply="Apply changes and remove from the shelf.",
5895
dry_run="Show changes, but do not apply or remove them.",
5896
preview="Instead of unshelving the changes, show the diff that "
5897
"would result from unshelving.",
5898
delete_only="Delete changes without applying them.",
5899
keep="Apply changes but don't delete them.",
5902
_see_also = ['shelve']
5904
def run(self, shelf_id=None, action='apply'):
5905
from bzrlib.shelf_ui import Unshelver
5906
unshelver = Unshelver.from_args(shelf_id, action)
5910
unshelver.tree.unlock()
5913
class cmd_clean_tree(Command):
5914
__doc__ = """Remove unwanted files from working tree.
5916
By default, only unknown files, not ignored files, are deleted. Versioned
5917
files are never deleted.
5919
Another class is 'detritus', which includes files emitted by bzr during
5920
normal operations and selftests. (The value of these files decreases with
5923
If no options are specified, unknown files are deleted. Otherwise, option
5924
flags are respected, and may be combined.
5926
To check what clean-tree will do, use --dry-run.
5928
takes_options = ['directory',
5929
Option('ignored', help='Delete all ignored files.'),
5930
Option('detritus', help='Delete conflict files, merge'
5931
' backups, and failed selftest dirs.'),
5933
help='Delete files unknown to bzr (default).'),
5934
Option('dry-run', help='Show files to delete instead of'
5936
Option('force', help='Do not prompt before deleting.')]
5937
def run(self, unknown=False, ignored=False, detritus=False, dry_run=False,
5938
force=False, directory=u'.'):
5939
from bzrlib.clean_tree import clean_tree
5940
if not (unknown or ignored or detritus):
5944
clean_tree(directory, unknown=unknown, ignored=ignored,
5945
detritus=detritus, dry_run=dry_run, no_prompt=force)
5948
class cmd_reference(Command):
5949
__doc__ = """list, view and set branch locations for nested trees.
5951
If no arguments are provided, lists the branch locations for nested trees.
5952
If one argument is provided, display the branch location for that tree.
5953
If two arguments are provided, set the branch location for that tree.
5958
takes_args = ['path?', 'location?']
5960
def run(self, path=None, location=None):
5962
if path is not None:
5964
tree, branch, relpath =(
5965
bzrdir.BzrDir.open_containing_tree_or_branch(branchdir))
5966
if path is not None:
5969
tree = branch.basis_tree()
5971
info = branch._get_all_reference_info().iteritems()
5972
self._display_reference_info(tree, branch, info)
5974
file_id = tree.path2id(path)
5976
raise errors.NotVersionedError(path)
5977
if location is None:
5978
info = [(file_id, branch.get_reference_info(file_id))]
5979
self._display_reference_info(tree, branch, info)
5981
branch.set_reference_info(file_id, path, location)
5983
def _display_reference_info(self, tree, branch, info):
5985
for file_id, (path, location) in info:
5987
path = tree.id2path(file_id)
5988
except errors.NoSuchId:
5990
ref_list.append((path, location))
5991
for path, location in sorted(ref_list):
5992
self.outf.write('%s %s\n' % (path, location))
5995
def _register_lazy_builtins():
5996
# register lazy builtins from other modules; called at startup and should
5997
# be only called once.
5998
for (name, aliases, module_name) in [
5999
('cmd_bundle_info', [], 'bzrlib.bundle.commands'),
6000
('cmd_dpush', [], 'bzrlib.foreign'),
6001
('cmd_version_info', [], 'bzrlib.cmd_version_info'),
6002
('cmd_resolve', ['resolved'], 'bzrlib.conflicts'),
6003
('cmd_conflicts', [], 'bzrlib.conflicts'),
6004
('cmd_sign_my_commits', [], 'bzrlib.sign_my_commits'),
6006
builtin_command_registry.register_lazy(name, aliases, module_name)
added
removed
bzrlib/builtins.py
