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
# GNU diff on Windows uses ANSI encoding for filenames
1974
path_encoding = osutils.get_diff_header_encoding()
1975
return show_diff_trees(old_tree, new_tree, sys.stdout,
1976
specific_files=specific_files,
1977
external_diff_options=diff_options,
1978
old_label=old_label, new_label=new_label,
1979
extra_trees=extra_trees,
1980
path_encoding=path_encoding,
1985
class cmd_deleted(Command):
1986
__doc__ = """List files deleted in the working tree.
1988
# TODO: Show files deleted since a previous revision, or
1989
# between two revisions.
1990
# TODO: Much more efficient way to do this: read in new
1991
# directories with readdir, rather than stating each one. Same
1992
# level of effort but possibly much less IO. (Or possibly not,
1993
# if the directories are very large...)
1994
_see_also = ['status', 'ls']
1995
takes_options = ['directory', 'show-ids']
1998
def run(self, show_ids=False, directory=u'.'):
1999
tree = WorkingTree.open_containing(directory)[0]
2000
self.add_cleanup(tree.lock_read().unlock)
2001
old = tree.basis_tree()
2002
self.add_cleanup(old.lock_read().unlock)
2003
for path, ie in old.inventory.iter_entries():
2004
if not tree.has_id(ie.file_id):
2005
self.outf.write(path)
2007
self.outf.write(' ')
2008
self.outf.write(ie.file_id)
2009
self.outf.write('\n')
2012
class cmd_modified(Command):
2013
__doc__ = """List files modified in working tree.
2017
_see_also = ['status', 'ls']
2018
takes_options = ['directory', 'null']
2021
def run(self, null=False, directory=u'.'):
2022
tree = WorkingTree.open_containing(directory)[0]
2023
td = tree.changes_from(tree.basis_tree())
2024
for path, id, kind, text_modified, meta_modified in td.modified:
2026
self.outf.write(path + '\0')
2028
self.outf.write(osutils.quotefn(path) + '\n')
2031
class cmd_added(Command):
2032
__doc__ = """List files added in working tree.
2036
_see_also = ['status', 'ls']
2037
takes_options = ['directory', 'null']
2040
def run(self, null=False, directory=u'.'):
2041
wt = WorkingTree.open_containing(directory)[0]
2042
self.add_cleanup(wt.lock_read().unlock)
2043
basis = wt.basis_tree()
2044
self.add_cleanup(basis.lock_read().unlock)
2045
basis_inv = basis.inventory
2048
if file_id in basis_inv:
2050
if inv.is_root(file_id) and len(basis_inv) == 0:
2052
path = inv.id2path(file_id)
2053
if not os.access(osutils.pathjoin(wt.basedir, path), os.F_OK):
2056
self.outf.write(path + '\0')
2058
self.outf.write(osutils.quotefn(path) + '\n')
2061
class cmd_root(Command):
2062
__doc__ = """Show the tree root directory.
2064
The root is the nearest enclosing directory with a .bzr control
2067
takes_args = ['filename?']
2069
def run(self, filename=None):
2070
"""Print the branch root."""
2071
tree = WorkingTree.open_containing(filename)[0]
2072
self.outf.write(tree.basedir + '\n')
2075
def _parse_limit(limitstring):
2077
return int(limitstring)
2079
msg = "The limit argument must be an integer."
2080
raise errors.BzrCommandError(msg)
2083
def _parse_levels(s):
2087
msg = "The levels argument must be an integer."
2088
raise errors.BzrCommandError(msg)
2091
class cmd_log(Command):
2092
__doc__ = """Show historical log for a branch or subset of a branch.
2094
log is bzr's default tool for exploring the history of a branch.
2095
The branch to use is taken from the first parameter. If no parameters
2096
are given, the branch containing the working directory is logged.
2097
Here are some simple examples::
2099
bzr log log the current branch
2100
bzr log foo.py log a file in its branch
2101
bzr log http://server/branch log a branch on a server
2103
The filtering, ordering and information shown for each revision can
2104
be controlled as explained below. By default, all revisions are
2105
shown sorted (topologically) so that newer revisions appear before
2106
older ones and descendants always appear before ancestors. If displayed,
2107
merged revisions are shown indented under the revision in which they
2112
The log format controls how information about each revision is
2113
displayed. The standard log formats are called ``long``, ``short``
2114
and ``line``. The default is long. See ``bzr help log-formats``
2115
for more details on log formats.
2117
The following options can be used to control what information is
2120
-l N display a maximum of N revisions
2121
-n N display N levels of revisions (0 for all, 1 for collapsed)
2122
-v display a status summary (delta) for each revision
2123
-p display a diff (patch) for each revision
2124
--show-ids display revision-ids (and file-ids), not just revnos
2126
Note that the default number of levels to display is a function of the
2127
log format. If the -n option is not used, the standard log formats show
2128
just the top level (mainline).
2130
Status summaries are shown using status flags like A, M, etc. To see
2131
the changes explained using words like ``added`` and ``modified``
2132
instead, use the -vv option.
2136
To display revisions from oldest to newest, use the --forward option.
2137
In most cases, using this option will have little impact on the total
2138
time taken to produce a log, though --forward does not incrementally
2139
display revisions like --reverse does when it can.
2141
:Revision filtering:
2143
The -r option can be used to specify what revision or range of revisions
2144
to filter against. The various forms are shown below::
2146
-rX display revision X
2147
-rX.. display revision X and later
2148
-r..Y display up to and including revision Y
2149
-rX..Y display from X to Y inclusive
2151
See ``bzr help revisionspec`` for details on how to specify X and Y.
2152
Some common examples are given below::
2154
-r-1 show just the tip
2155
-r-10.. show the last 10 mainline revisions
2156
-rsubmit:.. show what's new on this branch
2157
-rancestor:path.. show changes since the common ancestor of this
2158
branch and the one at location path
2159
-rdate:yesterday.. show changes since yesterday
2161
When logging a range of revisions using -rX..Y, log starts at
2162
revision Y and searches back in history through the primary
2163
("left-hand") parents until it finds X. When logging just the
2164
top level (using -n1), an error is reported if X is not found
2165
along the way. If multi-level logging is used (-n0), X may be
2166
a nested merge revision and the log will be truncated accordingly.
2170
If parameters are given and the first one is not a branch, the log
2171
will be filtered to show only those revisions that changed the
2172
nominated files or directories.
2174
Filenames are interpreted within their historical context. To log a
2175
deleted file, specify a revision range so that the file existed at
2176
the end or start of the range.
2178
Historical context is also important when interpreting pathnames of
2179
renamed files/directories. Consider the following example:
2181
* revision 1: add tutorial.txt
2182
* revision 2: modify tutorial.txt
2183
* revision 3: rename tutorial.txt to guide.txt; add tutorial.txt
2187
* ``bzr log guide.txt`` will log the file added in revision 1
2189
* ``bzr log tutorial.txt`` will log the new file added in revision 3
2191
* ``bzr log -r2 -p tutorial.txt`` will show the changes made to
2192
the original file in revision 2.
2194
* ``bzr log -r2 -p guide.txt`` will display an error message as there
2195
was no file called guide.txt in revision 2.
2197
Renames are always followed by log. By design, there is no need to
2198
explicitly ask for this (and no way to stop logging a file back
2199
until it was last renamed).
2203
The --message option can be used for finding revisions that match a
2204
regular expression in a commit message.
2208
GUI tools and IDEs are often better at exploring history than command
2209
line tools: you may prefer qlog or viz from qbzr or bzr-gtk, the
2210
bzr-explorer shell, or the Loggerhead web interface. See the Plugin
2211
Guide <http://doc.bazaar.canonical.com/plugins/en/> and
2212
<http://wiki.bazaar.canonical.com/IDEIntegration>.
2214
You may find it useful to add the aliases below to ``bazaar.conf``::
2218
top = log -l10 --line
2221
``bzr tip`` will then show the latest revision while ``bzr top``
2222
will show the last 10 mainline revisions. To see the details of a
2223
particular revision X, ``bzr show -rX``.
2225
If you are interested in looking deeper into a particular merge X,
2226
use ``bzr log -n0 -rX``.
2228
``bzr log -v`` on a branch with lots of history is currently
2229
very slow. A fix for this issue is currently under development.
2230
With or without that fix, it is recommended that a revision range
2231
be given when using the -v option.
2233
bzr has a generic full-text matching plugin, bzr-search, that can be
2234
used to find revisions matching user names, commit messages, etc.
2235
Among other features, this plugin can find all revisions containing
2236
a list of words but not others.
2238
When exploring non-mainline history on large projects with deep
2239
history, the performance of log can be greatly improved by installing
2240
the historycache plugin. This plugin buffers historical information
2241
trading disk space for faster speed.
2243
takes_args = ['file*']
2244
_see_also = ['log-formats', 'revisionspec']
2247
help='Show from oldest to newest.'),
2249
custom_help('verbose',
2250
help='Show files changed in each revision.'),
2254
type=bzrlib.option._parse_revision_str,
2256
help='Show just the specified revision.'
2257
' See also "help revisionspec".'),
2259
RegistryOption('authors',
2260
'What names to list as authors - first, all or committer.',
2262
lazy_registry=('bzrlib.log', 'author_list_registry'),
2266
help='Number of levels to display - 0 for all, 1 for flat.',
2268
type=_parse_levels),
2271
help='Show revisions whose message matches this '
2272
'regular expression.',
2276
help='Limit the output to the first N revisions.',
2281
help='Show changes made in each revision as a patch.'),
2282
Option('include-merges',
2283
help='Show merged revisions like --levels 0 does.'),
2284
Option('exclude-common-ancestry',
2285
help='Display only the revisions that are not part'
2286
' of both ancestries (require -rX..Y)'
2289
encoding_type = 'replace'
2292
def run(self, file_list=None, timezone='original',
2303
include_merges=False,
2305
exclude_common_ancestry=False,
2307
from bzrlib.log import (
2309
make_log_request_dict,
2310
_get_info_for_log_files,
2312
direction = (forward and 'forward') or 'reverse'
2313
if (exclude_common_ancestry
2314
and (revision is None or len(revision) != 2)):
2315
raise errors.BzrCommandError(
2316
'--exclude-common-ancestry requires -r with two revisions')
2321
raise errors.BzrCommandError(
2322
'--levels and --include-merges are mutually exclusive')
2324
if change is not None:
2326
raise errors.RangeInChangeOption()
2327
if revision is not None:
2328
raise errors.BzrCommandError(
2329
'--revision and --change are mutually exclusive')
2334
filter_by_dir = False
2336
# find the file ids to log and check for directory filtering
2337
b, file_info_list, rev1, rev2 = _get_info_for_log_files(
2338
revision, file_list, self.add_cleanup)
2339
for relpath, file_id, kind in file_info_list:
2341
raise errors.BzrCommandError(
2342
"Path unknown at end or start of revision range: %s" %
2344
# If the relpath is the top of the tree, we log everything
2349
file_ids.append(file_id)
2350
filter_by_dir = filter_by_dir or (
2351
kind in ['directory', 'tree-reference'])
2354
# FIXME ? log the current subdir only RBC 20060203
2355
if revision is not None \
2356
and len(revision) > 0 and revision[0].get_branch():
2357
location = revision[0].get_branch()
2360
dir, relpath = bzrdir.BzrDir.open_containing(location)
2361
b = dir.open_branch()
2362
self.add_cleanup(b.lock_read().unlock)
2363
rev1, rev2 = _get_revision_range(revision, b, self.name())
2365
# Decide on the type of delta & diff filtering to use
2366
# TODO: add an --all-files option to make this configurable & consistent
2374
diff_type = 'partial'
2378
# Build the log formatter
2379
if log_format is None:
2380
log_format = log.log_formatter_registry.get_default(b)
2381
# Make a non-encoding output to include the diffs - bug 328007
2382
unencoded_output = ui.ui_factory.make_output_stream(encoding_type='exact')
2383
lf = log_format(show_ids=show_ids, to_file=self.outf,
2384
to_exact_file=unencoded_output,
2385
show_timezone=timezone,
2386
delta_format=get_verbosity_level(),
2388
show_advice=levels is None,
2389
author_list_handler=authors)
2391
# Choose the algorithm for doing the logging. It's annoying
2392
# having multiple code paths like this but necessary until
2393
# the underlying repository format is faster at generating
2394
# deltas or can provide everything we need from the indices.
2395
# The default algorithm - match-using-deltas - works for
2396
# multiple files and directories and is faster for small
2397
# amounts of history (200 revisions say). However, it's too
2398
# slow for logging a single file in a repository with deep
2399
# history, i.e. > 10K revisions. In the spirit of "do no
2400
# evil when adding features", we continue to use the
2401
# original algorithm - per-file-graph - for the "single
2402
# file that isn't a directory without showing a delta" case.
2403
partial_history = revision and b.repository._format.supports_chks
2404
match_using_deltas = (len(file_ids) != 1 or filter_by_dir
2405
or delta_type or partial_history)
2407
# Build the LogRequest and execute it
2408
if len(file_ids) == 0:
2410
rqst = make_log_request_dict(
2411
direction=direction, specific_fileids=file_ids,
2412
start_revision=rev1, end_revision=rev2, limit=limit,
2413
message_search=message, delta_type=delta_type,
2414
diff_type=diff_type, _match_using_deltas=match_using_deltas,
2415
exclude_common_ancestry=exclude_common_ancestry,
2417
Logger(b, rqst).show(lf)
2420
def _get_revision_range(revisionspec_list, branch, command_name):
2421
"""Take the input of a revision option and turn it into a revision range.
2423
It returns RevisionInfo objects which can be used to obtain the rev_id's
2424
of the desired revisions. It does some user input validations.
2426
if revisionspec_list is None:
2429
elif len(revisionspec_list) == 1:
2430
rev1 = rev2 = revisionspec_list[0].in_history(branch)
2431
elif len(revisionspec_list) == 2:
2432
start_spec = revisionspec_list[0]
2433
end_spec = revisionspec_list[1]
2434
if end_spec.get_branch() != start_spec.get_branch():
2435
# b is taken from revision[0].get_branch(), and
2436
# show_log will use its revision_history. Having
2437
# different branches will lead to weird behaviors.
2438
raise errors.BzrCommandError(
2439
"bzr %s doesn't accept two revisions in different"
2440
" branches." % command_name)
2441
if start_spec.spec is None:
2442
# Avoid loading all the history.
2443
rev1 = RevisionInfo(branch, None, None)
2445
rev1 = start_spec.in_history(branch)
2446
# Avoid loading all of history when we know a missing
2447
# end of range means the last revision ...
2448
if end_spec.spec is None:
2449
last_revno, last_revision_id = branch.last_revision_info()
2450
rev2 = RevisionInfo(branch, last_revno, last_revision_id)
2452
rev2 = end_spec.in_history(branch)
2454
raise errors.BzrCommandError(
2455
'bzr %s --revision takes one or two values.' % command_name)
2459
def _revision_range_to_revid_range(revision_range):
2462
if revision_range[0] is not None:
2463
rev_id1 = revision_range[0].rev_id
2464
if revision_range[1] is not None:
2465
rev_id2 = revision_range[1].rev_id
2466
return rev_id1, rev_id2
2468
def get_log_format(long=False, short=False, line=False, default='long'):
2469
log_format = default
2473
log_format = 'short'
2479
class cmd_touching_revisions(Command):
2480
__doc__ = """Return revision-ids which affected a particular file.
2482
A more user-friendly interface is "bzr log FILE".
2486
takes_args = ["filename"]
2489
def run(self, filename):
2490
tree, relpath = WorkingTree.open_containing(filename)
2491
file_id = tree.path2id(relpath)
2493
self.add_cleanup(b.lock_read().unlock)
2494
touching_revs = log.find_touching_revisions(b, file_id)
2495
for revno, revision_id, what in touching_revs:
2496
self.outf.write("%6d %s\n" % (revno, what))
2499
class cmd_ls(Command):
2500
__doc__ = """List files in a tree.
2503
_see_also = ['status', 'cat']
2504
takes_args = ['path?']
2508
Option('recursive', short_name='R',
2509
help='Recurse into subdirectories.'),
2511
help='Print paths relative to the root of the branch.'),
2512
Option('unknown', short_name='u',
2513
help='Print unknown files.'),
2514
Option('versioned', help='Print versioned files.',
2516
Option('ignored', short_name='i',
2517
help='Print ignored files.'),
2518
Option('kind', short_name='k',
2519
help='List entries of a particular kind: file, directory, symlink.',
2526
def run(self, revision=None, verbose=False,
2527
recursive=False, from_root=False,
2528
unknown=False, versioned=False, ignored=False,
2529
null=False, kind=None, show_ids=False, path=None, directory=None):
2531
if kind and kind not in ('file', 'directory', 'symlink'):
2532
raise errors.BzrCommandError('invalid kind specified')
2534
if verbose and null:
2535
raise errors.BzrCommandError('Cannot set both --verbose and --null')
2536
all = not (unknown or versioned or ignored)
2538
selection = {'I':ignored, '?':unknown, 'V':versioned}
2544
raise errors.BzrCommandError('cannot specify both --from-root'
2547
tree, branch, relpath = \
2548
_open_directory_or_containing_tree_or_branch(fs_path, directory)
2550
# Calculate the prefix to use
2554
prefix = relpath + '/'
2555
elif fs_path != '.' and not fs_path.endswith('/'):
2556
prefix = fs_path + '/'
2558
if revision is not None or tree is None:
2559
tree = _get_one_revision_tree('ls', revision, branch=branch)
2562
if isinstance(tree, WorkingTree) and tree.supports_views():
2563
view_files = tree.views.lookup_view()
2566
view_str = views.view_display_str(view_files)
2567
note("Ignoring files outside view. View is %s" % view_str)
2569
self.add_cleanup(tree.lock_read().unlock)
2570
for fp, fc, fkind, fid, entry in tree.list_files(include_root=False,
2571
from_dir=relpath, recursive=recursive):
2572
# Apply additional masking
2573
if not all and not selection[fc]:
2575
if kind is not None and fkind != kind:
2580
fullpath = osutils.pathjoin(relpath, fp)
2583
views.check_path_in_view(tree, fullpath)
2584
except errors.FileOutsideView:
2589
fp = osutils.pathjoin(prefix, fp)
2590
kindch = entry.kind_character()
2591
outstring = fp + kindch
2592
ui.ui_factory.clear_term()
2594
outstring = '%-8s %s' % (fc, outstring)
2595
if show_ids and fid is not None:
2596
outstring = "%-50s %s" % (outstring, fid)
2597
self.outf.write(outstring + '\n')
2599
self.outf.write(fp + '\0')
2602
self.outf.write(fid)
2603
self.outf.write('\0')
2611
self.outf.write('%-50s %s\n' % (outstring, my_id))
2613
self.outf.write(outstring + '\n')
2616
class cmd_unknowns(Command):
2617
__doc__ = """List unknown files.
2622
takes_options = ['directory']
2625
def run(self, directory=u'.'):
2626
for f in WorkingTree.open_containing(directory)[0].unknowns():
2627
self.outf.write(osutils.quotefn(f) + '\n')
2630
class cmd_ignore(Command):
2631
__doc__ = """Ignore specified files or patterns.
2633
See ``bzr help patterns`` for details on the syntax of patterns.
2635
If a .bzrignore file does not exist, the ignore command
2636
will create one and add the specified files or patterns to the newly
2637
created file. The ignore command will also automatically add the
2638
.bzrignore file to be versioned. Creating a .bzrignore file without
2639
the use of the ignore command will require an explicit add command.
2641
To remove patterns from the ignore list, edit the .bzrignore file.
2642
After adding, editing or deleting that file either indirectly by
2643
using this command or directly by using an editor, be sure to commit
2646
Bazaar also supports a global ignore file ~/.bazaar/ignore. On Windows
2647
the global ignore file can be found in the application data directory as
2648
C:\\Documents and Settings\\<user>\\Application Data\\Bazaar\\2.0\\ignore.
2649
Global ignores are not touched by this command. The global ignore file
2650
can be edited directly using an editor.
2652
Patterns prefixed with '!' are exceptions to ignore patterns and take
2653
precedence over regular ignores. Such exceptions are used to specify
2654
files that should be versioned which would otherwise be ignored.
2656
Patterns prefixed with '!!' act as regular ignore patterns, but have
2657
precedence over the '!' exception patterns.
2659
Note: ignore patterns containing shell wildcards must be quoted from
2663
Ignore the top level Makefile::
2665
bzr ignore ./Makefile
2667
Ignore .class files in all directories...::
2669
bzr ignore "*.class"
2671
...but do not ignore "special.class"::
2673
bzr ignore "!special.class"
2675
Ignore .o files under the lib directory::
2677
bzr ignore "lib/**/*.o"
2679
Ignore .o files under the lib directory::
2681
bzr ignore "RE:lib/.*\.o"
2683
Ignore everything but the "debian" toplevel directory::
2685
bzr ignore "RE:(?!debian/).*"
2687
Ignore everything except the "local" toplevel directory,
2688
but always ignore "*~" autosave files, even under local/::
2691
bzr ignore "!./local"
2695
_see_also = ['status', 'ignored', 'patterns']
2696
takes_args = ['name_pattern*']
2697
takes_options = ['directory',
2698
Option('default-rules',
2699
help='Display the default ignore rules that bzr uses.')
2702
def run(self, name_pattern_list=None, default_rules=None,
2704
from bzrlib import ignores
2705
if default_rules is not None:
2706
# dump the default rules and exit
2707
for pattern in ignores.USER_DEFAULTS:
2708
self.outf.write("%s\n" % pattern)
2710
if not name_pattern_list:
2711
raise errors.BzrCommandError("ignore requires at least one "
2712
"NAME_PATTERN or --default-rules.")
2713
name_pattern_list = [globbing.normalize_pattern(p)
2714
for p in name_pattern_list]
2716
for p in name_pattern_list:
2717
if not globbing.Globster.is_pattern_valid(p):
2718
bad_patterns.append(p)
2720
msg = 'Invalid ignore pattern(s) found.'
2722
for p in bad_patterns:
2723
pats += ('\n %s' % p)
2724
ui.ui_factory.show_error(msg + pats)
2725
raise errors.InvalidPattern('')
2726
for name_pattern in name_pattern_list:
2727
if (name_pattern[0] == '/' or
2728
(len(name_pattern) > 1 and name_pattern[1] == ':')):
2729
raise errors.BzrCommandError(
2730
"NAME_PATTERN should not be an absolute path")
2731
tree, relpath = WorkingTree.open_containing(directory)
2732
ignores.tree_ignores_add_patterns(tree, name_pattern_list)
2733
ignored = globbing.Globster(name_pattern_list)
2735
self.add_cleanup(tree.lock_read().unlock)
2736
for entry in tree.list_files():
2740
if ignored.match(filename):
2741
matches.append(filename)
2742
if len(matches) > 0:
2743
self.outf.write("Warning: the following files are version controlled and"
2744
" match your ignore pattern:\n%s"
2745
"\nThese files will continue to be version controlled"
2746
" unless you 'bzr remove' them.\n" % ("\n".join(matches),))
2749
class cmd_ignored(Command):
2750
__doc__ = """List ignored files and the patterns that matched them.
2752
List all the ignored files and the ignore pattern that caused the file to
2755
Alternatively, to list just the files::
2760
encoding_type = 'replace'
2761
_see_also = ['ignore', 'ls']
2762
takes_options = ['directory']
2765
def run(self, directory=u'.'):
2766
tree = WorkingTree.open_containing(directory)[0]
2767
self.add_cleanup(tree.lock_read().unlock)
2768
for path, file_class, kind, file_id, entry in tree.list_files():
2769
if file_class != 'I':
2771
## XXX: Slightly inefficient since this was already calculated
2772
pat = tree.is_ignored(path)
2773
self.outf.write('%-50s %s\n' % (path, pat))
2776
class cmd_lookup_revision(Command):
2777
__doc__ = """Lookup the revision-id from a revision-number
2780
bzr lookup-revision 33
2783
takes_args = ['revno']
2784
takes_options = ['directory']
2787
def run(self, revno, directory=u'.'):
2791
raise errors.BzrCommandError("not a valid revision-number: %r"
2793
revid = WorkingTree.open_containing(directory)[0].branch.get_rev_id(revno)
2794
self.outf.write("%s\n" % revid)
2797
class cmd_export(Command):
2798
__doc__ = """Export current or past revision to a destination directory or archive.
2800
If no revision is specified this exports the last committed revision.
2802
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
2803
given, try to find the format with the extension. If no extension
2804
is found exports to a directory (equivalent to --format=dir).
2806
If root is supplied, it will be used as the root directory inside
2807
container formats (tar, zip, etc). If it is not supplied it will default
2808
to the exported filename. The root option has no effect for 'dir' format.
2810
If branch is omitted then the branch containing the current working
2811
directory will be used.
2813
Note: Export of tree with non-ASCII filenames to zip is not supported.
2815
================= =========================
2816
Supported formats Autodetected by extension
2817
================= =========================
2820
tbz2 .tar.bz2, .tbz2
2823
================= =========================
2825
takes_args = ['dest', 'branch_or_subdir?']
2826
takes_options = ['directory',
2828
help="Type of file to export to.",
2831
Option('filters', help='Apply content filters to export the '
2832
'convenient form.'),
2835
help="Name of the root directory inside the exported file."),
2836
Option('per-file-timestamps',
2837
help='Set modification time of files to that of the last '
2838
'revision in which it was changed.'),
2840
def run(self, dest, branch_or_subdir=None, revision=None, format=None,
2841
root=None, filters=False, per_file_timestamps=False, directory=u'.'):
2842
from bzrlib.export import export
2844
if branch_or_subdir is None:
2845
tree = WorkingTree.open_containing(directory)[0]
2849
b, subdir = Branch.open_containing(branch_or_subdir)
2852
rev_tree = _get_one_revision_tree('export', revision, branch=b, tree=tree)
2854
export(rev_tree, dest, format, root, subdir, filtered=filters,
2855
per_file_timestamps=per_file_timestamps)
2856
except errors.NoSuchExportFormat, e:
2857
raise errors.BzrCommandError('Unsupported export format: %s' % e.format)
2860
class cmd_cat(Command):
2861
__doc__ = """Write the contents of a file as of a given revision to standard output.
2863
If no revision is nominated, the last revision is used.
2865
Note: Take care to redirect standard output when using this command on a
2870
takes_options = ['directory',
2871
Option('name-from-revision', help='The path name in the old tree.'),
2872
Option('filters', help='Apply content filters to display the '
2873
'convenience form.'),
2876
takes_args = ['filename']
2877
encoding_type = 'exact'
2880
def run(self, filename, revision=None, name_from_revision=False,
2881
filters=False, directory=None):
2882
if revision is not None and len(revision) != 1:
2883
raise errors.BzrCommandError("bzr cat --revision takes exactly"
2884
" one revision specifier")
2885
tree, branch, relpath = \
2886
_open_directory_or_containing_tree_or_branch(filename, directory)
2887
self.add_cleanup(branch.lock_read().unlock)
2888
return self._run(tree, branch, relpath, filename, revision,
2889
name_from_revision, filters)
2891
def _run(self, tree, b, relpath, filename, revision, name_from_revision,
2894
tree = b.basis_tree()
2895
rev_tree = _get_one_revision_tree('cat', revision, branch=b)
2896
self.add_cleanup(rev_tree.lock_read().unlock)
2898
old_file_id = rev_tree.path2id(relpath)
2900
if name_from_revision:
2901
# Try in revision if requested
2902
if old_file_id is None:
2903
raise errors.BzrCommandError(
2904
"%r is not present in revision %s" % (
2905
filename, rev_tree.get_revision_id()))
2907
content = rev_tree.get_file_text(old_file_id)
2909
cur_file_id = tree.path2id(relpath)
2911
if cur_file_id is not None:
2912
# Then try with the actual file id
2914
content = rev_tree.get_file_text(cur_file_id)
2916
except errors.NoSuchId:
2917
# The actual file id didn't exist at that time
2919
if not found and old_file_id is not None:
2920
# Finally try with the old file id
2921
content = rev_tree.get_file_text(old_file_id)
2924
# Can't be found anywhere
2925
raise errors.BzrCommandError(
2926
"%r is not present in revision %s" % (
2927
filename, rev_tree.get_revision_id()))
2929
from bzrlib.filters import (
2930
ContentFilterContext,
2931
filtered_output_bytes,
2933
filters = rev_tree._content_filter_stack(relpath)
2934
chunks = content.splitlines(True)
2935
content = filtered_output_bytes(chunks, filters,
2936
ContentFilterContext(relpath, rev_tree))
2938
self.outf.writelines(content)
2941
self.outf.write(content)
2944
class cmd_local_time_offset(Command):
2945
__doc__ = """Show the offset in seconds from GMT to local time."""
2949
self.outf.write("%s\n" % osutils.local_time_offset())
2953
class cmd_commit(Command):
2954
__doc__ = """Commit changes into a new revision.
2956
An explanatory message needs to be given for each commit. This is
2957
often done by using the --message option (getting the message from the
2958
command line) or by using the --file option (getting the message from
2959
a file). If neither of these options is given, an editor is opened for
2960
the user to enter the message. To see the changed files in the
2961
boilerplate text loaded into the editor, use the --show-diff option.
2963
By default, the entire tree is committed and the person doing the
2964
commit is assumed to be the author. These defaults can be overridden
2969
If selected files are specified, only changes to those files are
2970
committed. If a directory is specified then the directory and
2971
everything within it is committed.
2973
When excludes are given, they take precedence over selected files.
2974
For example, to commit only changes within foo, but not changes
2977
bzr commit foo -x foo/bar
2979
A selective commit after a merge is not yet supported.
2983
If the author of the change is not the same person as the committer,
2984
you can specify the author's name using the --author option. The
2985
name should be in the same format as a committer-id, e.g.
2986
"John Doe <jdoe@example.com>". If there is more than one author of
2987
the change you can specify the option multiple times, once for each
2992
A common mistake is to forget to add a new file or directory before
2993
running the commit command. The --strict option checks for unknown
2994
files and aborts the commit if any are found. More advanced pre-commit
2995
checks can be implemented by defining hooks. See ``bzr help hooks``
3000
If you accidentially commit the wrong changes or make a spelling
3001
mistake in the commit message say, you can use the uncommit command
3002
to undo it. See ``bzr help uncommit`` for details.
3004
Hooks can also be configured to run after a commit. This allows you
3005
to trigger updates to external systems like bug trackers. The --fixes
3006
option can be used to record the association between a revision and
3007
one or more bugs. See ``bzr help bugs`` for details.
3009
A selective commit may fail in some cases where the committed
3010
tree would be invalid. Consider::
3015
bzr commit foo -m "committing foo"
3016
bzr mv foo/bar foo/baz
3019
bzr commit foo/bar -m "committing bar but not baz"
3021
In the example above, the last commit will fail by design. This gives
3022
the user the opportunity to decide whether they want to commit the
3023
rename at the same time, separately first, or not at all. (As a general
3024
rule, when in doubt, Bazaar has a policy of Doing the Safe Thing.)
3026
# TODO: Run hooks on tree to-be-committed, and after commit.
3028
# TODO: Strict commit that fails if there are deleted files.
3029
# (what does "deleted files" mean ??)
3031
# TODO: Give better message for -s, --summary, used by tla people
3033
# XXX: verbose currently does nothing
3035
_see_also = ['add', 'bugs', 'hooks', 'uncommit']
3036
takes_args = ['selected*']
3038
ListOption('exclude', type=str, short_name='x',
3039
help="Do not consider changes made to a given path."),
3040
Option('message', type=unicode,
3042
help="Description of the new revision."),
3045
help='Commit even if nothing has changed.'),
3046
Option('file', type=str,
3049
help='Take commit message from this file.'),
3051
help="Refuse to commit if there are unknown "
3052
"files in the working tree."),
3053
Option('commit-time', type=str,
3054
help="Manually set a commit time using commit date "
3055
"format, e.g. '2009-10-10 08:00:00 +0100'."),
3056
ListOption('fixes', type=str,
3057
help="Mark a bug as being fixed by this revision "
3058
"(see \"bzr help bugs\")."),
3059
ListOption('author', type=unicode,
3060
help="Set the author's name, if it's different "
3061
"from the committer."),
3063
help="Perform a local commit in a bound "
3064
"branch. Local commits are not pushed to "
3065
"the master branch until a normal commit "
3068
Option('show-diff', short_name='p',
3069
help='When no message is supplied, show the diff along'
3070
' with the status summary in the message editor.'),
3072
aliases = ['ci', 'checkin']
3074
def _iter_bug_fix_urls(self, fixes, branch):
3075
# Configure the properties for bug fixing attributes.
3076
for fixed_bug in fixes:
3077
tokens = fixed_bug.split(':')
3078
if len(tokens) != 2:
3079
raise errors.BzrCommandError(
3080
"Invalid bug %s. Must be in the form of 'tracker:id'. "
3081
"See \"bzr help bugs\" for more information on this "
3082
"feature.\nCommit refused." % fixed_bug)
3083
tag, bug_id = tokens
3085
yield bugtracker.get_bug_url(tag, branch, bug_id)
3086
except errors.UnknownBugTrackerAbbreviation:
3087
raise errors.BzrCommandError(
3088
'Unrecognized bug %s. Commit refused.' % fixed_bug)
3089
except errors.MalformedBugIdentifier, e:
3090
raise errors.BzrCommandError(
3091
"%s\nCommit refused." % (str(e),))
3093
def run(self, message=None, file=None, verbose=False, selected_list=None,
3094
unchanged=False, strict=False, local=False, fixes=None,
3095
author=None, show_diff=False, exclude=None, commit_time=None):
3096
from bzrlib.errors import (
3101
from bzrlib.msgeditor import (
3102
edit_commit_message_encoded,
3103
generate_commit_message_template,
3104
make_commit_message_template_encoded
3107
commit_stamp = offset = None
3108
if commit_time is not None:
3110
commit_stamp, offset = timestamp.parse_patch_date(commit_time)
3111
except ValueError, e:
3112
raise errors.BzrCommandError(
3113
"Could not parse --commit-time: " + str(e))
3115
# TODO: Need a blackbox test for invoking the external editor; may be
3116
# slightly problematic to run this cross-platform.
3118
# TODO: do more checks that the commit will succeed before
3119
# spending the user's valuable time typing a commit message.
3123
tree, selected_list = tree_files(selected_list)
3124
if selected_list == ['']:
3125
# workaround - commit of root of tree should be exactly the same
3126
# as just default commit in that tree, and succeed even though
3127
# selected-file merge commit is not done yet
3132
bug_property = bugtracker.encode_fixes_bug_urls(
3133
self._iter_bug_fix_urls(fixes, tree.branch))
3135
properties['bugs'] = bug_property
3137
if local and not tree.branch.get_bound_location():
3138
raise errors.LocalRequiresBoundBranch()
3140
if message is not None:
3142
file_exists = osutils.lexists(message)
3143
except UnicodeError:
3144
# The commit message contains unicode characters that can't be
3145
# represented in the filesystem encoding, so that can't be a
3150
'The commit message is a file name: "%(f)s".\n'
3151
'(use --file "%(f)s" to take commit message from that file)'
3153
ui.ui_factory.show_warning(warning_msg)
3155
message = message.replace('\r\n', '\n')
3156
message = message.replace('\r', '\n')
3158
raise errors.BzrCommandError(
3159
"please specify either --message or --file")
3161
def get_message(commit_obj):
3162
"""Callback to get commit message"""
3164
f = codecs.open(file, 'rt', osutils.get_user_encoding())
3166
my_message = f.read()
3169
elif message is not None:
3170
my_message = message
3172
# No message supplied: make one up.
3173
# text is the status of the tree
3174
text = make_commit_message_template_encoded(tree,
3175
selected_list, diff=show_diff,
3176
output_encoding=osutils.get_user_encoding())
3177
# start_message is the template generated from hooks
3178
# XXX: Warning - looks like hooks return unicode,
3179
# make_commit_message_template_encoded returns user encoding.
3180
# We probably want to be using edit_commit_message instead to
3182
start_message = generate_commit_message_template(commit_obj)
3183
my_message = edit_commit_message_encoded(text,
3184
start_message=start_message)
3185
if my_message is None:
3186
raise errors.BzrCommandError("please specify a commit"
3187
" message with either --message or --file")
3188
if my_message == "":
3189
raise errors.BzrCommandError("empty commit message specified")
3192
# The API permits a commit with a filter of [] to mean 'select nothing'
3193
# but the command line should not do that.
3194
if not selected_list:
3195
selected_list = None
3197
tree.commit(message_callback=get_message,
3198
specific_files=selected_list,
3199
allow_pointless=unchanged, strict=strict, local=local,
3200
reporter=None, verbose=verbose, revprops=properties,
3201
authors=author, timestamp=commit_stamp,
3203
exclude=safe_relpath_files(tree, exclude))
3204
except PointlessCommit:
3205
raise errors.BzrCommandError("No changes to commit."
3206
" Use --unchanged to commit anyhow.")
3207
except ConflictsInTree:
3208
raise errors.BzrCommandError('Conflicts detected in working '
3209
'tree. Use "bzr conflicts" to list, "bzr resolve FILE" to'
3211
except StrictCommitFailed:
3212
raise errors.BzrCommandError("Commit refused because there are"
3213
" unknown files in the working tree.")
3214
except errors.BoundBranchOutOfDate, e:
3215
e.extra_help = ("\n"
3216
'To commit to master branch, run update and then commit.\n'
3217
'You can also pass --local to commit to continue working '
3222
class cmd_check(Command):
3223
__doc__ = """Validate working tree structure, branch consistency and repository history.
3225
This command checks various invariants about branch and repository storage
3226
to detect data corruption or bzr bugs.
3228
The working tree and branch checks will only give output if a problem is
3229
detected. The output fields of the repository check are:
3232
This is just the number of revisions checked. It doesn't
3236
This is just the number of versionedfiles checked. It
3237
doesn't indicate a problem.
3239
unreferenced ancestors
3240
Texts that are ancestors of other texts, but
3241
are not properly referenced by the revision ancestry. This is a
3242
subtle problem that Bazaar can work around.
3245
This is the total number of unique file contents
3246
seen in the checked revisions. It does not indicate a problem.
3249
This is the total number of repeated texts seen
3250
in the checked revisions. Texts can be repeated when their file
3251
entries are modified, but the file contents are not. It does not
3254
If no restrictions are specified, all Bazaar data that is found at the given
3255
location will be checked.
3259
Check the tree and branch at 'foo'::
3261
bzr check --tree --branch foo
3263
Check only the repository at 'bar'::
3265
bzr check --repo bar
3267
Check everything at 'baz'::
3272
_see_also = ['reconcile']
3273
takes_args = ['path?']
3274
takes_options = ['verbose',
3275
Option('branch', help="Check the branch related to the"
3276
" current directory."),
3277
Option('repo', help="Check the repository related to the"
3278
" current directory."),
3279
Option('tree', help="Check the working tree related to"
3280
" the current directory.")]
3282
def run(self, path=None, verbose=False, branch=False, repo=False,
3284
from bzrlib.check import check_dwim
3287
if not branch and not repo and not tree:
3288
branch = repo = tree = True
3289
check_dwim(path, verbose, do_branch=branch, do_repo=repo, do_tree=tree)
3292
class cmd_upgrade(Command):
3293
__doc__ = """Upgrade branch storage to current format.
3295
The check command or bzr developers may sometimes advise you to run
3296
this command. When the default format has changed you may also be warned
3297
during other operations to upgrade.
3300
_see_also = ['check']
3301
takes_args = ['url?']
3303
RegistryOption('format',
3304
help='Upgrade to a specific format. See "bzr help'
3305
' formats" for details.',
3306
lazy_registry=('bzrlib.bzrdir', 'format_registry'),
3307
converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
3308
value_switches=True, title='Branch format'),
3311
def run(self, url='.', format=None):
3312
from bzrlib.upgrade import upgrade
3313
upgrade(url, format)
3316
class cmd_whoami(Command):
3317
__doc__ = """Show or set bzr user id.
3320
Show the email of the current user::
3324
Set the current user::
3326
bzr whoami "Frank Chu <fchu@example.com>"
3328
takes_options = [ 'directory',
3330
help='Display email address only.'),
3332
help='Set identity for the current branch instead of '
3335
takes_args = ['name?']
3336
encoding_type = 'replace'
3339
def run(self, email=False, branch=False, name=None, directory=None):
3341
if directory is None:
3342
# use branch if we're inside one; otherwise global config
3344
c = Branch.open_containing(u'.')[0].get_config()
3345
except errors.NotBranchError:
3346
c = config.GlobalConfig()
3348
c = Branch.open(directory).get_config()
3350
self.outf.write(c.user_email() + '\n')
3352
self.outf.write(c.username() + '\n')
3355
# display a warning if an email address isn't included in the given name.
3357
config.extract_email_address(name)
3358
except errors.NoEmailInUsername, e:
3359
warning('"%s" does not seem to contain an email address. '
3360
'This is allowed, but not recommended.', name)
3362
# use global config unless --branch given
3364
if directory is None:
3365
c = Branch.open_containing(u'.')[0].get_config()
3367
c = Branch.open(directory).get_config()
3369
c = config.GlobalConfig()
3370
c.set_user_option('email', name)
3373
class cmd_nick(Command):
3374
__doc__ = """Print or set the branch nickname.
3376
If unset, the tree root directory name is used as the nickname.
3377
To print the current nickname, execute with no argument.
3379
Bound branches use the nickname of its master branch unless it is set
3383
_see_also = ['info']
3384
takes_args = ['nickname?']
3385
takes_options = ['directory']
3386
def run(self, nickname=None, directory=u'.'):
3387
branch = Branch.open_containing(directory)[0]
3388
if nickname is None:
3389
self.printme(branch)
3391
branch.nick = nickname
3394
def printme(self, branch):
3395
self.outf.write('%s\n' % branch.nick)
3398
class cmd_alias(Command):
3399
__doc__ = """Set/unset and display aliases.
3402
Show the current aliases::
3406
Show the alias specified for 'll'::
3410
Set an alias for 'll'::
3412
bzr alias ll="log --line -r-10..-1"
3414
To remove an alias for 'll'::
3416
bzr alias --remove ll
3419
takes_args = ['name?']
3421
Option('remove', help='Remove the alias.'),
3424
def run(self, name=None, remove=False):
3426
self.remove_alias(name)
3428
self.print_aliases()
3430
equal_pos = name.find('=')
3432
self.print_alias(name)
3434
self.set_alias(name[:equal_pos], name[equal_pos+1:])
3436
def remove_alias(self, alias_name):
3437
if alias_name is None:
3438
raise errors.BzrCommandError(
3439
'bzr alias --remove expects an alias to remove.')
3440
# If alias is not found, print something like:
3441
# unalias: foo: not found
3442
c = config.GlobalConfig()
3443
c.unset_alias(alias_name)
3446
def print_aliases(self):
3447
"""Print out the defined aliases in a similar format to bash."""
3448
aliases = config.GlobalConfig().get_aliases()
3449
for key, value in sorted(aliases.iteritems()):
3450
self.outf.write('bzr alias %s="%s"\n' % (key, value))
3453
def print_alias(self, alias_name):
3454
from bzrlib.commands import get_alias
3455
alias = get_alias(alias_name)
3457
self.outf.write("bzr alias: %s: not found\n" % alias_name)
3460
'bzr alias %s="%s"\n' % (alias_name, ' '.join(alias)))
3462
def set_alias(self, alias_name, alias_command):
3463
"""Save the alias in the global config."""
3464
c = config.GlobalConfig()
3465
c.set_alias(alias_name, alias_command)
3468
class cmd_selftest(Command):
3469
__doc__ = """Run internal test suite.
3471
If arguments are given, they are regular expressions that say which tests
3472
should run. Tests matching any expression are run, and other tests are
3475
Alternatively if --first is given, matching tests are run first and then
3476
all other tests are run. This is useful if you have been working in a
3477
particular area, but want to make sure nothing else was broken.
3479
If --exclude is given, tests that match that regular expression are
3480
excluded, regardless of whether they match --first or not.
3482
To help catch accidential dependencies between tests, the --randomize
3483
option is useful. In most cases, the argument used is the word 'now'.
3484
Note that the seed used for the random number generator is displayed
3485
when this option is used. The seed can be explicitly passed as the
3486
argument to this option if required. This enables reproduction of the
3487
actual ordering used if and when an order sensitive problem is encountered.
3489
If --list-only is given, the tests that would be run are listed. This is
3490
useful when combined with --first, --exclude and/or --randomize to
3491
understand their impact. The test harness reports "Listed nn tests in ..."
3492
instead of "Ran nn tests in ..." when list mode is enabled.
3494
If the global option '--no-plugins' is given, plugins are not loaded
3495
before running the selftests. This has two effects: features provided or
3496
modified by plugins will not be tested, and tests provided by plugins will
3499
Tests that need working space on disk use a common temporary directory,
3500
typically inside $TMPDIR or /tmp.
3502
If you set BZR_TEST_PDB=1 when running selftest, failing tests will drop
3503
into a pdb postmortem session.
3506
Run only tests relating to 'ignore'::
3510
Disable plugins and list tests as they're run::
3512
bzr --no-plugins selftest -v
3514
# NB: this is used from the class without creating an instance, which is
3515
# why it does not have a self parameter.
3516
def get_transport_type(typestring):
3517
"""Parse and return a transport specifier."""
3518
if typestring == "sftp":
3519
from bzrlib.tests import stub_sftp
3520
return stub_sftp.SFTPAbsoluteServer
3521
if typestring == "memory":
3522
from bzrlib.tests import test_server
3523
return memory.MemoryServer
3524
if typestring == "fakenfs":
3525
from bzrlib.tests import test_server
3526
return test_server.FakeNFSServer
3527
msg = "No known transport type %s. Supported types are: sftp\n" %\
3529
raise errors.BzrCommandError(msg)
3532
takes_args = ['testspecs*']
3533
takes_options = ['verbose',
3535
help='Stop when one test fails.',
3539
help='Use a different transport by default '
3540
'throughout the test suite.',
3541
type=get_transport_type),
3543
help='Run the benchmarks rather than selftests.'),
3544
Option('lsprof-timed',
3545
help='Generate lsprof output for benchmarked'
3546
' sections of code.'),
3547
Option('lsprof-tests',
3548
help='Generate lsprof output for each test.'),
3549
Option('cache-dir', type=str,
3550
help='Cache intermediate benchmark output in this '
3553
help='Run all tests, but run specified tests first.',
3557
help='List the tests instead of running them.'),
3558
RegistryOption('parallel',
3559
help="Run the test suite in parallel.",
3560
lazy_registry=('bzrlib.tests', 'parallel_registry'),
3561
value_switches=False,
3563
Option('randomize', type=str, argname="SEED",
3564
help='Randomize the order of tests using the given'
3565
' seed or "now" for the current time.'),
3566
Option('exclude', type=str, argname="PATTERN",
3568
help='Exclude tests that match this regular'
3571
help='Output test progress via subunit.'),
3572
Option('strict', help='Fail on missing dependencies or '
3574
Option('load-list', type=str, argname='TESTLISTFILE',
3575
help='Load a test id list from a text file.'),
3576
ListOption('debugflag', type=str, short_name='E',
3577
help='Turn on a selftest debug flag.'),
3578
ListOption('starting-with', type=str, argname='TESTID',
3579
param_name='starting_with', short_name='s',
3581
'Load only the tests starting with TESTID.'),
3583
encoding_type = 'replace'
3586
Command.__init__(self)
3587
self.additional_selftest_args = {}
3589
def run(self, testspecs_list=None, verbose=False, one=False,
3590
transport=None, benchmark=None,
3591
lsprof_timed=None, cache_dir=None,
3592
first=False, list_only=False,
3593
randomize=None, exclude=None, strict=False,
3594
load_list=None, debugflag=None, starting_with=None, subunit=False,
3595
parallel=None, lsprof_tests=False):
3596
from bzrlib.tests import selftest
3597
import bzrlib.benchmarks as benchmarks
3598
from bzrlib.benchmarks import tree_creator
3600
# Make deprecation warnings visible, unless -Werror is set
3601
symbol_versioning.activate_deprecation_warnings(override=False)
3603
if cache_dir is not None:
3604
tree_creator.TreeCreator.CACHE_ROOT = osutils.abspath(cache_dir)
3605
if testspecs_list is not None:
3606
pattern = '|'.join(testspecs_list)
3611
from bzrlib.tests import SubUnitBzrRunner
3613
raise errors.BzrCommandError("subunit not available. subunit "
3614
"needs to be installed to use --subunit.")
3615
self.additional_selftest_args['runner_class'] = SubUnitBzrRunner
3616
# On Windows, disable automatic conversion of '\n' to '\r\n' in
3617
# stdout, which would corrupt the subunit stream.
3618
# FIXME: This has been fixed in subunit trunk (>0.0.5) so the
3619
# following code can be deleted when it's sufficiently deployed
3620
# -- vila/mgz 20100514
3621
if (sys.platform == "win32"
3622
and getattr(sys.stdout, 'fileno', None) is not None):
3624
msvcrt.setmode(sys.stdout.fileno(), os.O_BINARY)
3626
self.additional_selftest_args.setdefault(
3627
'suite_decorators', []).append(parallel)
3629
test_suite_factory = benchmarks.test_suite
3630
# Unless user explicitly asks for quiet, be verbose in benchmarks
3631
verbose = not is_quiet()
3632
# TODO: should possibly lock the history file...
3633
benchfile = open(".perf_history", "at", buffering=1)
3634
self.add_cleanup(benchfile.close)
3636
test_suite_factory = None
3638
selftest_kwargs = {"verbose": verbose,
3640
"stop_on_failure": one,
3641
"transport": transport,
3642
"test_suite_factory": test_suite_factory,
3643
"lsprof_timed": lsprof_timed,
3644
"lsprof_tests": lsprof_tests,
3645
"bench_history": benchfile,
3646
"matching_tests_first": first,
3647
"list_only": list_only,
3648
"random_seed": randomize,
3649
"exclude_pattern": exclude,
3651
"load_list": load_list,
3652
"debug_flags": debugflag,
3653
"starting_with": starting_with
3655
selftest_kwargs.update(self.additional_selftest_args)
3656
result = selftest(**selftest_kwargs)
3657
return int(not result)
3660
class cmd_version(Command):
3661
__doc__ = """Show version of bzr."""
3663
encoding_type = 'replace'
3665
Option("short", help="Print just the version number."),
3669
def run(self, short=False):
3670
from bzrlib.version import show_version
3672
self.outf.write(bzrlib.version_string + '\n')
3674
show_version(to_file=self.outf)
3677
class cmd_rocks(Command):
3678
__doc__ = """Statement of optimism."""
3684
self.outf.write("It sure does!\n")
3687
class cmd_find_merge_base(Command):
3688
__doc__ = """Find and print a base revision for merging two branches."""
3689
# TODO: Options to specify revisions on either side, as if
3690
# merging only part of the history.
3691
takes_args = ['branch', 'other']
3695
def run(self, branch, other):
3696
from bzrlib.revision import ensure_null
3698
branch1 = Branch.open_containing(branch)[0]
3699
branch2 = Branch.open_containing(other)[0]
3700
self.add_cleanup(branch1.lock_read().unlock)
3701
self.add_cleanup(branch2.lock_read().unlock)
3702
last1 = ensure_null(branch1.last_revision())
3703
last2 = ensure_null(branch2.last_revision())
3705
graph = branch1.repository.get_graph(branch2.repository)
3706
base_rev_id = graph.find_unique_lca(last1, last2)
3708
self.outf.write('merge base is revision %s\n' % base_rev_id)
3711
class cmd_merge(Command):
3712
__doc__ = """Perform a three-way merge.
3714
The source of the merge can be specified either in the form of a branch,
3715
or in the form of a path to a file containing a merge directive generated
3716
with bzr send. If neither is specified, the default is the upstream branch
3717
or the branch most recently merged using --remember.
3719
When merging a branch, by default the tip will be merged. To pick a different
3720
revision, pass --revision. If you specify two values, the first will be used as
3721
BASE and the second one as OTHER. Merging individual revisions, or a subset of
3722
available revisions, like this is commonly referred to as "cherrypicking".
3724
Revision numbers are always relative to the branch being merged.
3726
By default, bzr will try to merge in all new work from the other
3727
branch, automatically determining an appropriate base. If this
3728
fails, you may need to give an explicit base.
3730
Merge will do its best to combine the changes in two branches, but there
3731
are some kinds of problems only a human can fix. When it encounters those,
3732
it will mark a conflict. A conflict means that you need to fix something,
3733
before you should commit.
3735
Use bzr resolve when you have fixed a problem. See also bzr conflicts.
3737
If there is no default branch set, the first merge will set it. After
3738
that, you can omit the branch to use the default. To change the
3739
default, use --remember. The value will only be saved if the remote
3740
location can be accessed.
3742
The results of the merge are placed into the destination working
3743
directory, where they can be reviewed (with bzr diff), tested, and then
3744
committed to record the result of the merge.
3746
merge refuses to run if there are any uncommitted changes, unless
3747
--force is given. The --force option can also be used to create a
3748
merge revision which has more than two parents.
3750
If one would like to merge changes from the working tree of the other
3751
branch without merging any committed revisions, the --uncommitted option
3754
To select only some changes to merge, use "merge -i", which will prompt
3755
you to apply each diff hunk and file change, similar to "shelve".
3758
To merge the latest revision from bzr.dev::
3760
bzr merge ../bzr.dev
3762
To merge changes up to and including revision 82 from bzr.dev::
3764
bzr merge -r 82 ../bzr.dev
3766
To merge the changes introduced by 82, without previous changes::
3768
bzr merge -r 81..82 ../bzr.dev
3770
To apply a merge directive contained in /tmp/merge::
3772
bzr merge /tmp/merge
3774
To create a merge revision with three parents from two branches
3775
feature1a and feature1b:
3777
bzr merge ../feature1a
3778
bzr merge ../feature1b --force
3779
bzr commit -m 'revision with three parents'
3782
encoding_type = 'exact'
3783
_see_also = ['update', 'remerge', 'status-flags', 'send']
3784
takes_args = ['location?']
3789
help='Merge even if the destination tree has uncommitted changes.'),
3793
Option('show-base', help="Show base revision text in "
3795
Option('uncommitted', help='Apply uncommitted changes'
3796
' from a working copy, instead of branch changes.'),
3797
Option('pull', help='If the destination is already'
3798
' completely merged into the source, pull from the'
3799
' source rather than merging. When this happens,'
3800
' you do not need to commit the result.'),
3801
custom_help('directory',
3802
help='Branch to merge into, '
3803
'rather than the one containing the working directory.'),
3804
Option('preview', help='Instead of merging, show a diff of the'
3806
Option('interactive', help='Select changes interactively.',
3810
def run(self, location=None, revision=None, force=False,
3811
merge_type=None, show_base=False, reprocess=None, remember=False,
3812
uncommitted=False, pull=False,
3817
if merge_type is None:
3818
merge_type = _mod_merge.Merge3Merger
3820
if directory is None: directory = u'.'
3821
possible_transports = []
3823
allow_pending = True
3824
verified = 'inapplicable'
3825
tree = WorkingTree.open_containing(directory)[0]
3828
basis_tree = tree.revision_tree(tree.last_revision())
3829
except errors.NoSuchRevision:
3830
basis_tree = tree.basis_tree()
3832
# die as quickly as possible if there are uncommitted changes
3834
if tree.has_changes():
3835
raise errors.UncommittedChanges(tree)
3837
view_info = _get_view_info_for_change_reporter(tree)
3838
change_reporter = delta._ChangeReporter(
3839
unversioned_filter=tree.is_ignored, view_info=view_info)
3840
pb = ui.ui_factory.nested_progress_bar()
3841
self.add_cleanup(pb.finished)
3842
self.add_cleanup(tree.lock_write().unlock)
3843
if location is not None:
3845
mergeable = bundle.read_mergeable_from_url(location,
3846
possible_transports=possible_transports)
3847
except errors.NotABundle:
3851
raise errors.BzrCommandError('Cannot use --uncommitted'
3852
' with bundles or merge directives.')
3854
if revision is not None:
3855
raise errors.BzrCommandError(
3856
'Cannot use -r with merge directives or bundles')
3857
merger, verified = _mod_merge.Merger.from_mergeable(tree,
3860
if merger is None and uncommitted:
3861
if revision is not None and len(revision) > 0:
3862
raise errors.BzrCommandError('Cannot use --uncommitted and'
3863
' --revision at the same time.')
3864
merger = self.get_merger_from_uncommitted(tree, location, None)
3865
allow_pending = False
3868
merger, allow_pending = self._get_merger_from_branch(tree,
3869
location, revision, remember, possible_transports, None)
3871
merger.merge_type = merge_type
3872
merger.reprocess = reprocess
3873
merger.show_base = show_base
3874
self.sanity_check_merger(merger)
3875
if (merger.base_rev_id == merger.other_rev_id and
3876
merger.other_rev_id is not None):
3877
note('Nothing to do.')
3880
if merger.interesting_files is not None:
3881
raise errors.BzrCommandError('Cannot pull individual files')
3882
if (merger.base_rev_id == tree.last_revision()):
3883
result = tree.pull(merger.other_branch, False,
3884
merger.other_rev_id)
3885
result.report(self.outf)
3887
if merger.this_basis is None:
3888
raise errors.BzrCommandError(
3889
"This branch has no commits."
3890
" (perhaps you would prefer 'bzr pull')")
3892
return self._do_preview(merger)
3894
return self._do_interactive(merger)
3896
return self._do_merge(merger, change_reporter, allow_pending,
3899
def _get_preview(self, merger):
3900
tree_merger = merger.make_merger()
3901
tt = tree_merger.make_preview_transform()
3902
self.add_cleanup(tt.finalize)
3903
result_tree = tt.get_preview_tree()
3906
def _do_preview(self, merger):
3907
from bzrlib.diff import show_diff_trees
3908
result_tree = self._get_preview(merger)
3909
path_encoding = osutils.get_diff_header_encoding()
3910
show_diff_trees(merger.this_tree, result_tree, self.outf,
3911
old_label='', new_label='',
3912
path_encoding=path_encoding)
3914
def _do_merge(self, merger, change_reporter, allow_pending, verified):
3915
merger.change_reporter = change_reporter
3916
conflict_count = merger.do_merge()
3918
merger.set_pending()
3919
if verified == 'failed':
3920
warning('Preview patch does not match changes')
3921
if conflict_count != 0:
3926
def _do_interactive(self, merger):
3927
"""Perform an interactive merge.
3929
This works by generating a preview tree of the merge, then using
3930
Shelver to selectively remove the differences between the working tree
3931
and the preview tree.
3933
from bzrlib import shelf_ui
3934
result_tree = self._get_preview(merger)
3935
writer = bzrlib.option.diff_writer_registry.get()
3936
shelver = shelf_ui.Shelver(merger.this_tree, result_tree, destroy=True,
3937
reporter=shelf_ui.ApplyReporter(),
3938
diff_writer=writer(sys.stdout))
3944
def sanity_check_merger(self, merger):
3945
if (merger.show_base and
3946
not merger.merge_type is _mod_merge.Merge3Merger):
3947
raise errors.BzrCommandError("Show-base is not supported for this"
3948
" merge type. %s" % merger.merge_type)
3949
if merger.reprocess is None:
3950
if merger.show_base:
3951
merger.reprocess = False
3953
# Use reprocess if the merger supports it
3954
merger.reprocess = merger.merge_type.supports_reprocess
3955
if merger.reprocess and not merger.merge_type.supports_reprocess:
3956
raise errors.BzrCommandError("Conflict reduction is not supported"
3957
" for merge type %s." %
3959
if merger.reprocess and merger.show_base:
3960
raise errors.BzrCommandError("Cannot do conflict reduction and"
3963
def _get_merger_from_branch(self, tree, location, revision, remember,
3964
possible_transports, pb):
3965
"""Produce a merger from a location, assuming it refers to a branch."""
3966
from bzrlib.tag import _merge_tags_if_possible
3967
# find the branch locations
3968
other_loc, user_location = self._select_branch_location(tree, location,
3970
if revision is not None and len(revision) == 2:
3971
base_loc, _unused = self._select_branch_location(tree,
3972
location, revision, 0)
3974
base_loc = other_loc
3976
other_branch, other_path = Branch.open_containing(other_loc,
3977
possible_transports)
3978
if base_loc == other_loc:
3979
base_branch = other_branch
3981
base_branch, base_path = Branch.open_containing(base_loc,
3982
possible_transports)
3983
# Find the revision ids
3984
other_revision_id = None
3985
base_revision_id = None
3986
if revision is not None:
3987
if len(revision) >= 1:
3988
other_revision_id = revision[-1].as_revision_id(other_branch)
3989
if len(revision) == 2:
3990
base_revision_id = revision[0].as_revision_id(base_branch)
3991
if other_revision_id is None:
3992
other_revision_id = _mod_revision.ensure_null(
3993
other_branch.last_revision())
3994
# Remember where we merge from
3995
if ((remember or tree.branch.get_submit_branch() is None) and
3996
user_location is not None):
3997
tree.branch.set_submit_branch(other_branch.base)
3998
_merge_tags_if_possible(other_branch, tree.branch)
3999
merger = _mod_merge.Merger.from_revision_ids(pb, tree,
4000
other_revision_id, base_revision_id, other_branch, base_branch)
4001
if other_path != '':
4002
allow_pending = False
4003
merger.interesting_files = [other_path]
4005
allow_pending = True
4006
return merger, allow_pending
4008
def get_merger_from_uncommitted(self, tree, location, pb):
4009
"""Get a merger for uncommitted changes.
4011
:param tree: The tree the merger should apply to.
4012
:param location: The location containing uncommitted changes.
4013
:param pb: The progress bar to use for showing progress.
4015
location = self._select_branch_location(tree, location)[0]
4016
other_tree, other_path = WorkingTree.open_containing(location)
4017
merger = _mod_merge.Merger.from_uncommitted(tree, other_tree, pb)
4018
if other_path != '':
4019
merger.interesting_files = [other_path]
4022
def _select_branch_location(self, tree, user_location, revision=None,
4024
"""Select a branch location, according to possible inputs.
4026
If provided, branches from ``revision`` are preferred. (Both
4027
``revision`` and ``index`` must be supplied.)
4029
Otherwise, the ``location`` parameter is used. If it is None, then the
4030
``submit`` or ``parent`` location is used, and a note is printed.
4032
:param tree: The working tree to select a branch for merging into
4033
:param location: The location entered by the user
4034
:param revision: The revision parameter to the command
4035
:param index: The index to use for the revision parameter. Negative
4036
indices are permitted.
4037
:return: (selected_location, user_location). The default location
4038
will be the user-entered location.
4040
if (revision is not None and index is not None
4041
and revision[index] is not None):
4042
branch = revision[index].get_branch()
4043
if branch is not None:
4044
return branch, branch
4045
if user_location is None:
4046
location = self._get_remembered(tree, 'Merging from')
4048
location = user_location
4049
return location, user_location
4051
def _get_remembered(self, tree, verb_string):
4052
"""Use tree.branch's parent if none was supplied.
4054
Report if the remembered location was used.
4056
stored_location = tree.branch.get_submit_branch()
4057
stored_location_type = "submit"
4058
if stored_location is None:
4059
stored_location = tree.branch.get_parent()
4060
stored_location_type = "parent"
4061
mutter("%s", stored_location)
4062
if stored_location is None:
4063
raise errors.BzrCommandError("No location specified or remembered")
4064
display_url = urlutils.unescape_for_display(stored_location, 'utf-8')
4065
note(u"%s remembered %s location %s", verb_string,
4066
stored_location_type, display_url)
4067
return stored_location
4070
class cmd_remerge(Command):
4071
__doc__ = """Redo a merge.
4073
Use this if you want to try a different merge technique while resolving
4074
conflicts. Some merge techniques are better than others, and remerge
4075
lets you try different ones on different files.
4077
The options for remerge have the same meaning and defaults as the ones for
4078
merge. The difference is that remerge can (only) be run when there is a
4079
pending merge, and it lets you specify particular files.
4082
Re-do the merge of all conflicted files, and show the base text in
4083
conflict regions, in addition to the usual THIS and OTHER texts::
4085
bzr remerge --show-base
4087
Re-do the merge of "foobar", using the weave merge algorithm, with
4088
additional processing to reduce the size of conflict regions::
4090
bzr remerge --merge-type weave --reprocess foobar
4092
takes_args = ['file*']
4097
help="Show base revision text in conflicts."),
4100
def run(self, file_list=None, merge_type=None, show_base=False,
4102
from bzrlib.conflicts import restore
4103
if merge_type is None:
4104
merge_type = _mod_merge.Merge3Merger
4105
tree, file_list = tree_files(file_list)
4106
self.add_cleanup(tree.lock_write().unlock)
4107
parents = tree.get_parent_ids()
4108
if len(parents) != 2:
4109
raise errors.BzrCommandError("Sorry, remerge only works after normal"
4110
" merges. Not cherrypicking or"
4112
repository = tree.branch.repository
4113
interesting_ids = None
4115
conflicts = tree.conflicts()
4116
if file_list is not None:
4117
interesting_ids = set()
4118
for filename in file_list:
4119
file_id = tree.path2id(filename)
4121
raise errors.NotVersionedError(filename)
4122
interesting_ids.add(file_id)
4123
if tree.kind(file_id) != "directory":
4126
for name, ie in tree.inventory.iter_entries(file_id):
4127
interesting_ids.add(ie.file_id)
4128
new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
4130
# Remerge only supports resolving contents conflicts
4131
allowed_conflicts = ('text conflict', 'contents conflict')
4132
restore_files = [c.path for c in conflicts
4133
if c.typestring in allowed_conflicts]
4134
_mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
4135
tree.set_conflicts(ConflictList(new_conflicts))
4136
if file_list is not None:
4137
restore_files = file_list
4138
for filename in restore_files:
4140
restore(tree.abspath(filename))
4141
except errors.NotConflicted:
4143
# Disable pending merges, because the file texts we are remerging
4144
# have not had those merges performed. If we use the wrong parents
4145
# list, we imply that the working tree text has seen and rejected
4146
# all the changes from the other tree, when in fact those changes
4147
# have not yet been seen.
4148
tree.set_parent_ids(parents[:1])
4150
merger = _mod_merge.Merger.from_revision_ids(None, tree, parents[1])
4151
merger.interesting_ids = interesting_ids
4152
merger.merge_type = merge_type
4153
merger.show_base = show_base
4154
merger.reprocess = reprocess
4155
conflicts = merger.do_merge()
4157
tree.set_parent_ids(parents)
4164
class cmd_revert(Command):
4165
__doc__ = """Revert files to a previous revision.
4167
Giving a list of files will revert only those files. Otherwise, all files
4168
will be reverted. If the revision is not specified with '--revision', the
4169
last committed revision is used.
4171
To remove only some changes, without reverting to a prior version, use
4172
merge instead. For example, "merge . --revision -2..-3" will remove the
4173
changes introduced by -2, without affecting the changes introduced by -1.
4174
Or to remove certain changes on a hunk-by-hunk basis, see the Shelf plugin.
4176
By default, any files that have been manually changed will be backed up
4177
first. (Files changed only by merge are not backed up.) Backup files have
4178
'.~#~' appended to their name, where # is a number.
4180
When you provide files, you can use their current pathname or the pathname
4181
from the target revision. So you can use revert to "undelete" a file by
4182
name. If you name a directory, all the contents of that directory will be
4185
If you have newly added files since the target revision, they will be
4186
removed. If the files to be removed have been changed, backups will be
4187
created as above. Directories containing unknown files will not be
4190
The working tree contains a list of revisions that have been merged but
4191
not yet committed. These revisions will be included as additional parents
4192
of the next commit. Normally, using revert clears that list as well as
4193
reverting the files. If any files are specified, revert leaves the list
4194
of uncommitted merges alone and reverts only the files. Use ``bzr revert
4195
.`` in the tree root to revert all files but keep the recorded merges,
4196
and ``bzr revert --forget-merges`` to clear the pending merge list without
4197
reverting any files.
4199
Using "bzr revert --forget-merges", it is possible to apply all of the
4200
changes from a branch in a single revision. To do this, perform the merge
4201
as desired. Then doing revert with the "--forget-merges" option will keep
4202
the content of the tree as it was, but it will clear the list of pending
4203
merges. The next commit will then contain all of the changes that are
4204
present in the other branch, but without any other parent revisions.
4205
Because this technique forgets where these changes originated, it may
4206
cause additional conflicts on later merges involving the same source and
4210
_see_also = ['cat', 'export']
4213
Option('no-backup', "Do not save backups of reverted files."),
4214
Option('forget-merges',
4215
'Remove pending merge marker, without changing any files.'),
4217
takes_args = ['file*']
4219
def run(self, revision=None, no_backup=False, file_list=None,
4220
forget_merges=None):
4221
tree, file_list = tree_files(file_list)
4222
self.add_cleanup(tree.lock_tree_write().unlock)
4224
tree.set_parent_ids(tree.get_parent_ids()[:1])
4226
self._revert_tree_to_revision(tree, revision, file_list, no_backup)
4229
def _revert_tree_to_revision(tree, revision, file_list, no_backup):
4230
rev_tree = _get_one_revision_tree('revert', revision, tree=tree)
4231
tree.revert(file_list, rev_tree, not no_backup, None,
4232
report_changes=True)
4235
class cmd_assert_fail(Command):
4236
__doc__ = """Test reporting of assertion failures"""
4237
# intended just for use in testing
4242
raise AssertionError("always fails")
4245
class cmd_help(Command):
4246
__doc__ = """Show help on a command or other topic.
4249
_see_also = ['topics']
4251
Option('long', 'Show help on all commands.'),
4253
takes_args = ['topic?']
4254
aliases = ['?', '--help', '-?', '-h']
4257
def run(self, topic=None, long=False):
4259
if topic is None and long:
4261
bzrlib.help.help(topic)
4264
class cmd_shell_complete(Command):
4265
__doc__ = """Show appropriate completions for context.
4267
For a list of all available commands, say 'bzr shell-complete'.
4269
takes_args = ['context?']
4274
def run(self, context=None):
4275
import shellcomplete
4276
shellcomplete.shellcomplete(context)
4279
class cmd_missing(Command):
4280
__doc__ = """Show unmerged/unpulled revisions between two branches.
4282
OTHER_BRANCH may be local or remote.
4284
To filter on a range of revisions, you can use the command -r begin..end
4285
-r revision requests a specific revision, -r ..end or -r begin.. are
4289
1 - some missing revisions
4290
0 - no missing revisions
4294
Determine the missing revisions between this and the branch at the
4295
remembered pull location::
4299
Determine the missing revisions between this and another branch::
4301
bzr missing http://server/branch
4303
Determine the missing revisions up to a specific revision on the other
4306
bzr missing -r ..-10
4308
Determine the missing revisions up to a specific revision on this
4311
bzr missing --my-revision ..-10
4314
_see_also = ['merge', 'pull']
4315
takes_args = ['other_branch?']
4318
Option('reverse', 'Reverse the order of revisions.'),
4320
'Display changes in the local branch only.'),
4321
Option('this' , 'Same as --mine-only.'),
4322
Option('theirs-only',
4323
'Display changes in the remote branch only.'),
4324
Option('other', 'Same as --theirs-only.'),
4328
custom_help('revision',
4329
help='Filter on other branch revisions (inclusive). '
4330
'See "help revisionspec" for details.'),
4331
Option('my-revision',
4332
type=_parse_revision_str,
4333
help='Filter on local branch revisions (inclusive). '
4334
'See "help revisionspec" for details.'),
4335
Option('include-merges',
4336
'Show all revisions in addition to the mainline ones.'),
4338
encoding_type = 'replace'
4341
def run(self, other_branch=None, reverse=False, mine_only=False,
4343
log_format=None, long=False, short=False, line=False,
4344
show_ids=False, verbose=False, this=False, other=False,
4345
include_merges=False, revision=None, my_revision=None,
4347
from bzrlib.missing import find_unmerged, iter_log_revisions
4356
# TODO: We should probably check that we don't have mine-only and
4357
# theirs-only set, but it gets complicated because we also have
4358
# this and other which could be used.
4365
local_branch = Branch.open_containing(directory)[0]
4366
self.add_cleanup(local_branch.lock_read().unlock)
4368
parent = local_branch.get_parent()
4369
if other_branch is None:
4370
other_branch = parent
4371
if other_branch is None:
4372
raise errors.BzrCommandError("No peer location known"
4374
display_url = urlutils.unescape_for_display(parent,
4376
message("Using saved parent location: "
4377
+ display_url + "\n")
4379
remote_branch = Branch.open(other_branch)
4380
if remote_branch.base == local_branch.base:
4381
remote_branch = local_branch
4383
self.add_cleanup(remote_branch.lock_read().unlock)
4385
local_revid_range = _revision_range_to_revid_range(
4386
_get_revision_range(my_revision, local_branch,
4389
remote_revid_range = _revision_range_to_revid_range(
4390
_get_revision_range(revision,
4391
remote_branch, self.name()))
4393
local_extra, remote_extra = find_unmerged(
4394
local_branch, remote_branch, restrict,
4395
backward=not reverse,
4396
include_merges=include_merges,
4397
local_revid_range=local_revid_range,
4398
remote_revid_range=remote_revid_range)
4400
if log_format is None:
4401
registry = log.log_formatter_registry
4402
log_format = registry.get_default(local_branch)
4403
lf = log_format(to_file=self.outf,
4405
show_timezone='original')
4408
if local_extra and not theirs_only:
4409
message("You have %d extra revision(s):\n" %
4411
for revision in iter_log_revisions(local_extra,
4412
local_branch.repository,
4414
lf.log_revision(revision)
4415
printed_local = True
4418
printed_local = False
4420
if remote_extra and not mine_only:
4421
if printed_local is True:
4423
message("You are missing %d revision(s):\n" %
4425
for revision in iter_log_revisions(remote_extra,
4426
remote_branch.repository,
4428
lf.log_revision(revision)
4431
if mine_only and not local_extra:
4432
# We checked local, and found nothing extra
4433
message('This branch is up to date.\n')
4434
elif theirs_only and not remote_extra:
4435
# We checked remote, and found nothing extra
4436
message('Other branch is up to date.\n')
4437
elif not (mine_only or theirs_only or local_extra or
4439
# We checked both branches, and neither one had extra
4441
message("Branches are up to date.\n")
4443
if not status_code and parent is None and other_branch is not None:
4444
self.add_cleanup(local_branch.lock_write().unlock)
4445
# handle race conditions - a parent might be set while we run.
4446
if local_branch.get_parent() is None:
4447
local_branch.set_parent(remote_branch.base)
4451
class cmd_pack(Command):
4452
__doc__ = """Compress the data within a repository.
4454
This operation compresses the data within a bazaar repository. As
4455
bazaar supports automatic packing of repository, this operation is
4456
normally not required to be done manually.
4458
During the pack operation, bazaar takes a backup of existing repository
4459
data, i.e. pack files. This backup is eventually removed by bazaar
4460
automatically when it is safe to do so. To save disk space by removing
4461
the backed up pack files, the --clean-obsolete-packs option may be
4464
Warning: If you use --clean-obsolete-packs and your machine crashes
4465
during or immediately after repacking, you may be left with a state
4466
where the deletion has been written to disk but the new packs have not
4467
been. In this case the repository may be unusable.
4470
_see_also = ['repositories']
4471
takes_args = ['branch_or_repo?']
4473
Option('clean-obsolete-packs', 'Delete obsolete packs to save disk space.'),
4476
def run(self, branch_or_repo='.', clean_obsolete_packs=False):
4477
dir = bzrdir.BzrDir.open_containing(branch_or_repo)[0]
4479
branch = dir.open_branch()
4480
repository = branch.repository
4481
except errors.NotBranchError:
4482
repository = dir.open_repository()
4483
repository.pack(clean_obsolete_packs=clean_obsolete_packs)
4486
class cmd_plugins(Command):
4487
__doc__ = """List the installed plugins.
4489
This command displays the list of installed plugins including
4490
version of plugin and a short description of each.
4492
--verbose shows the path where each plugin is located.
4494
A plugin is an external component for Bazaar that extends the
4495
revision control system, by adding or replacing code in Bazaar.
4496
Plugins can do a variety of things, including overriding commands,
4497
adding new commands, providing additional network transports and
4498
customizing log output.
4500
See the Bazaar Plugin Guide <http://doc.bazaar.canonical.com/plugins/en/>
4501
for further information on plugins including where to find them and how to
4502
install them. Instructions are also provided there on how to write new
4503
plugins using the Python programming language.
4505
takes_options = ['verbose']
4508
def run(self, verbose=False):
4509
import bzrlib.plugin
4510
from inspect import getdoc
4512
for name, plugin in bzrlib.plugin.plugins().items():
4513
version = plugin.__version__
4514
if version == 'unknown':
4516
name_ver = '%s %s' % (name, version)
4517
d = getdoc(plugin.module)
4519
doc = d.split('\n')[0]
4521
doc = '(no description)'
4522
result.append((name_ver, doc, plugin.path()))
4523
for name_ver, doc, path in sorted(result):
4524
self.outf.write("%s\n" % name_ver)
4525
self.outf.write(" %s\n" % doc)
4527
self.outf.write(" %s\n" % path)
4528
self.outf.write("\n")
4531
class cmd_testament(Command):
4532
__doc__ = """Show testament (signing-form) of a revision."""
4535
Option('long', help='Produce long-format testament.'),
4537
help='Produce a strict-format testament.')]
4538
takes_args = ['branch?']
4540
def run(self, branch=u'.', revision=None, long=False, strict=False):
4541
from bzrlib.testament import Testament, StrictTestament
4543
testament_class = StrictTestament
4545
testament_class = Testament
4547
b = Branch.open_containing(branch)[0]
4549
b = Branch.open(branch)
4550
self.add_cleanup(b.lock_read().unlock)
4551
if revision is None:
4552
rev_id = b.last_revision()
4554
rev_id = revision[0].as_revision_id(b)
4555
t = testament_class.from_revision(b.repository, rev_id)
4557
sys.stdout.writelines(t.as_text_lines())
4559
sys.stdout.write(t.as_short_text())
4562
class cmd_annotate(Command):
4563
__doc__ = """Show the origin of each line in a file.
4565
This prints out the given file with an annotation on the left side
4566
indicating which revision, author and date introduced the change.
4568
If the origin is the same for a run of consecutive lines, it is
4569
shown only at the top, unless the --all option is given.
4571
# TODO: annotate directories; showing when each file was last changed
4572
# TODO: if the working copy is modified, show annotations on that
4573
# with new uncommitted lines marked
4574
aliases = ['ann', 'blame', 'praise']
4575
takes_args = ['filename']
4576
takes_options = [Option('all', help='Show annotations on all lines.'),
4577
Option('long', help='Show commit date in annotations.'),
4582
encoding_type = 'exact'
4585
def run(self, filename, all=False, long=False, revision=None,
4586
show_ids=False, directory=None):
4587
from bzrlib.annotate import annotate_file, annotate_file_tree
4588
wt, branch, relpath = \
4589
_open_directory_or_containing_tree_or_branch(filename, directory)
4591
self.add_cleanup(wt.lock_read().unlock)
4593
self.add_cleanup(branch.lock_read().unlock)
4594
tree = _get_one_revision_tree('annotate', revision, branch=branch)
4595
self.add_cleanup(tree.lock_read().unlock)
4597
file_id = wt.path2id(relpath)
4599
file_id = tree.path2id(relpath)
4601
raise errors.NotVersionedError(filename)
4602
file_version = tree.inventory[file_id].revision
4603
if wt is not None and revision is None:
4604
# If there is a tree and we're not annotating historical
4605
# versions, annotate the working tree's content.
4606
annotate_file_tree(wt, file_id, self.outf, long, all,
4609
annotate_file(branch, file_version, file_id, long, all, self.outf,
4613
class cmd_re_sign(Command):
4614
__doc__ = """Create a digital signature for an existing revision."""
4615
# TODO be able to replace existing ones.
4617
hidden = True # is this right ?
4618
takes_args = ['revision_id*']
4619
takes_options = ['directory', 'revision']
4621
def run(self, revision_id_list=None, revision=None, directory=u'.'):
4622
if revision_id_list is not None and revision is not None:
4623
raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
4624
if revision_id_list is None and revision is None:
4625
raise errors.BzrCommandError('You must supply either --revision or a revision_id')
4626
b = WorkingTree.open_containing(directory)[0].branch
4627
self.add_cleanup(b.lock_write().unlock)
4628
return self._run(b, revision_id_list, revision)
4630
def _run(self, b, revision_id_list, revision):
4631
import bzrlib.gpg as gpg
4632
gpg_strategy = gpg.GPGStrategy(b.get_config())
4633
if revision_id_list is not None:
4634
b.repository.start_write_group()
4636
for revision_id in revision_id_list:
4637
b.repository.sign_revision(revision_id, gpg_strategy)
4639
b.repository.abort_write_group()
4642
b.repository.commit_write_group()
4643
elif revision is not None:
4644
if len(revision) == 1:
4645
revno, rev_id = revision[0].in_history(b)
4646
b.repository.start_write_group()
4648
b.repository.sign_revision(rev_id, gpg_strategy)
4650
b.repository.abort_write_group()
4653
b.repository.commit_write_group()
4654
elif len(revision) == 2:
4655
# are they both on rh- if so we can walk between them
4656
# might be nice to have a range helper for arbitrary
4657
# revision paths. hmm.
4658
from_revno, from_revid = revision[0].in_history(b)
4659
to_revno, to_revid = revision[1].in_history(b)
4660
if to_revid is None:
4661
to_revno = b.revno()
4662
if from_revno is None or to_revno is None:
4663
raise errors.BzrCommandError('Cannot sign a range of non-revision-history revisions')
4664
b.repository.start_write_group()
4666
for revno in range(from_revno, to_revno + 1):
4667
b.repository.sign_revision(b.get_rev_id(revno),
4670
b.repository.abort_write_group()
4673
b.repository.commit_write_group()
4675
raise errors.BzrCommandError('Please supply either one revision, or a range.')
4678
class cmd_bind(Command):
4679
__doc__ = """Convert the current branch into a checkout of the supplied branch.
4680
If no branch is supplied, rebind to the last bound location.
4682
Once converted into a checkout, commits must succeed on the master branch
4683
before they will be applied to the local branch.
4685
Bound branches use the nickname of its master branch unless it is set
4686
locally, in which case binding will update the local nickname to be
4690
_see_also = ['checkouts', 'unbind']
4691
takes_args = ['location?']
4692
takes_options = ['directory']
4694
def run(self, location=None, directory=u'.'):
4695
b, relpath = Branch.open_containing(directory)
4696
if location is None:
4698
location = b.get_old_bound_location()
4699
except errors.UpgradeRequired:
4700
raise errors.BzrCommandError('No location supplied. '
4701
'This format does not remember old locations.')
4703
if location is None:
4704
if b.get_bound_location() is not None:
4705
raise errors.BzrCommandError('Branch is already bound')
4707
raise errors.BzrCommandError('No location supplied '
4708
'and no previous location known')
4709
b_other = Branch.open(location)
4712
except errors.DivergedBranches:
4713
raise errors.BzrCommandError('These branches have diverged.'
4714
' Try merging, and then bind again.')
4715
if b.get_config().has_explicit_nickname():
4716
b.nick = b_other.nick
4719
class cmd_unbind(Command):
4720
__doc__ = """Convert the current checkout into a regular branch.
4722
After unbinding, the local branch is considered independent and subsequent
4723
commits will be local only.
4726
_see_also = ['checkouts', 'bind']
4728
takes_options = ['directory']
4730
def run(self, directory=u'.'):
4731
b, relpath = Branch.open_containing(directory)
4733
raise errors.BzrCommandError('Local branch is not bound')
4736
class cmd_uncommit(Command):
4737
__doc__ = """Remove the last committed revision.
4739
--verbose will print out what is being removed.
4740
--dry-run will go through all the motions, but not actually
4743
If --revision is specified, uncommit revisions to leave the branch at the
4744
specified revision. For example, "bzr uncommit -r 15" will leave the
4745
branch at revision 15.
4747
Uncommit leaves the working tree ready for a new commit. The only change
4748
it may make is to restore any pending merges that were present before
4752
# TODO: jam 20060108 Add an option to allow uncommit to remove
4753
# unreferenced information in 'branch-as-repository' branches.
4754
# TODO: jam 20060108 Add the ability for uncommit to remove unreferenced
4755
# information in shared branches as well.
4756
_see_also = ['commit']
4757
takes_options = ['verbose', 'revision',
4758
Option('dry-run', help='Don\'t actually make changes.'),
4759
Option('force', help='Say yes to all questions.'),
4761
help="Only remove the commits from the local branch"
4762
" when in a checkout."
4765
takes_args = ['location?']
4767
encoding_type = 'replace'
4769
def run(self, location=None,
4770
dry_run=False, verbose=False,
4771
revision=None, force=False, local=False):
4772
if location is None:
4774
control, relpath = bzrdir.BzrDir.open_containing(location)
4776
tree = control.open_workingtree()
4778
except (errors.NoWorkingTree, errors.NotLocalUrl):
4780
b = control.open_branch()
4782
if tree is not None:
4783
self.add_cleanup(tree.lock_write().unlock)
4785
self.add_cleanup(b.lock_write().unlock)
4786
return self._run(b, tree, dry_run, verbose, revision, force, local=local)
4788
def _run(self, b, tree, dry_run, verbose, revision, force, local=False):
4789
from bzrlib.log import log_formatter, show_log
4790
from bzrlib.uncommit import uncommit
4792
last_revno, last_rev_id = b.last_revision_info()
4795
if revision is None:
4797
rev_id = last_rev_id
4799
# 'bzr uncommit -r 10' actually means uncommit
4800
# so that the final tree is at revno 10.
4801
# but bzrlib.uncommit.uncommit() actually uncommits
4802
# the revisions that are supplied.
4803
# So we need to offset it by one
4804
revno = revision[0].in_history(b).revno + 1
4805
if revno <= last_revno:
4806
rev_id = b.get_rev_id(revno)
4808
if rev_id is None or _mod_revision.is_null(rev_id):
4809
self.outf.write('No revisions to uncommit.\n')
4812
lf = log_formatter('short',
4814
show_timezone='original')
4819
direction='forward',
4820
start_revision=revno,
4821
end_revision=last_revno)
4824
self.outf.write('Dry-run, pretending to remove'
4825
' the above revisions.\n')
4827
self.outf.write('The above revision(s) will be removed.\n')
4830
if not ui.ui_factory.get_boolean('Are you sure'):
4831
self.outf.write('Canceled')
4834
mutter('Uncommitting from {%s} to {%s}',
4835
last_rev_id, rev_id)
4836
uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
4837
revno=revno, local=local)
4838
self.outf.write('You can restore the old tip by running:\n'
4839
' bzr pull . -r revid:%s\n' % last_rev_id)
4842
class cmd_break_lock(Command):
4843
__doc__ = """Break a dead lock on a repository, branch or working directory.
4845
CAUTION: Locks should only be broken when you are sure that the process
4846
holding the lock has been stopped.
4848
You can get information on what locks are open via the 'bzr info
4849
[location]' command.
4853
bzr break-lock bzr+ssh://example.com/bzr/foo
4855
takes_args = ['location?']
4857
def run(self, location=None, show=False):
4858
if location is None:
4860
control, relpath = bzrdir.BzrDir.open_containing(location)
4862
control.break_lock()
4863
except NotImplementedError:
4867
class cmd_wait_until_signalled(Command):
4868
__doc__ = """Test helper for test_start_and_stop_bzr_subprocess_send_signal.
4870
This just prints a line to signal when it is ready, then blocks on stdin.
4876
sys.stdout.write("running\n")
4878
sys.stdin.readline()
4881
class cmd_serve(Command):
4882
__doc__ = """Run the bzr server."""
4884
aliases = ['server']
4888
help='Serve on stdin/out for use from inetd or sshd.'),
4889
RegistryOption('protocol',
4890
help="Protocol to serve.",
4891
lazy_registry=('bzrlib.transport', 'transport_server_registry'),
4892
value_switches=True),
4894
help='Listen for connections on nominated port of the form '
4895
'[hostname:]portnumber. Passing 0 as the port number will '
4896
'result in a dynamically allocated port. The default port '
4897
'depends on the protocol.',
4899
custom_help('directory',
4900
help='Serve contents of this directory.'),
4901
Option('allow-writes',
4902
help='By default the server is a readonly server. Supplying '
4903
'--allow-writes enables write access to the contents of '
4904
'the served directory and below. Note that ``bzr serve`` '
4905
'does not perform authentication, so unless some form of '
4906
'external authentication is arranged supplying this '
4907
'option leads to global uncontrolled write access to your '
4912
def get_host_and_port(self, port):
4913
"""Return the host and port to run the smart server on.
4915
If 'port' is None, None will be returned for the host and port.
4917
If 'port' has a colon in it, the string before the colon will be
4918
interpreted as the host.
4920
:param port: A string of the port to run the server on.
4921
:return: A tuple of (host, port), where 'host' is a host name or IP,
4922
and port is an integer TCP/IP port.
4925
if port is not None:
4927
host, port = port.split(':')
4931
def run(self, port=None, inet=False, directory=None, allow_writes=False,
4933
from bzrlib import transport
4934
if directory is None:
4935
directory = os.getcwd()
4936
if protocol is None:
4937
protocol = transport.transport_server_registry.get()
4938
host, port = self.get_host_and_port(port)
4939
url = urlutils.local_path_to_url(directory)
4940
if not allow_writes:
4941
url = 'readonly+' + url
4942
t = transport.get_transport(url)
4943
protocol(t, host, port, inet)
4946
class cmd_join(Command):
4947
__doc__ = """Combine a tree into its containing tree.
4949
This command requires the target tree to be in a rich-root format.
4951
The TREE argument should be an independent tree, inside another tree, but
4952
not part of it. (Such trees can be produced by "bzr split", but also by
4953
running "bzr branch" with the target inside a tree.)
4955
The result is a combined tree, with the subtree no longer an independant
4956
part. This is marked as a merge of the subtree into the containing tree,
4957
and all history is preserved.
4960
_see_also = ['split']
4961
takes_args = ['tree']
4963
Option('reference', help='Join by reference.', hidden=True),
4966
def run(self, tree, reference=False):
4967
sub_tree = WorkingTree.open(tree)
4968
parent_dir = osutils.dirname(sub_tree.basedir)
4969
containing_tree = WorkingTree.open_containing(parent_dir)[0]
4970
repo = containing_tree.branch.repository
4971
if not repo.supports_rich_root():
4972
raise errors.BzrCommandError(
4973
"Can't join trees because %s doesn't support rich root data.\n"
4974
"You can use bzr upgrade on the repository."
4978
containing_tree.add_reference(sub_tree)
4979
except errors.BadReferenceTarget, e:
4980
# XXX: Would be better to just raise a nicely printable
4981
# exception from the real origin. Also below. mbp 20070306
4982
raise errors.BzrCommandError("Cannot join %s. %s" %
4986
containing_tree.subsume(sub_tree)
4987
except errors.BadSubsumeSource, e:
4988
raise errors.BzrCommandError("Cannot join %s. %s" %
4992
class cmd_split(Command):
4993
__doc__ = """Split a subdirectory of a tree into a separate tree.
4995
This command will produce a target tree in a format that supports
4996
rich roots, like 'rich-root' or 'rich-root-pack'. These formats cannot be
4997
converted into earlier formats like 'dirstate-tags'.
4999
The TREE argument should be a subdirectory of a working tree. That
5000
subdirectory will be converted into an independent tree, with its own
5001
branch. Commits in the top-level tree will not apply to the new subtree.
5004
_see_also = ['join']
5005
takes_args = ['tree']
5007
def run(self, tree):
5008
containing_tree, subdir = WorkingTree.open_containing(tree)
5009
sub_id = containing_tree.path2id(subdir)
5011
raise errors.NotVersionedError(subdir)
5013
containing_tree.extract(sub_id)
5014
except errors.RootNotRich:
5015
raise errors.RichRootUpgradeRequired(containing_tree.branch.base)
5018
class cmd_merge_directive(Command):
5019
__doc__ = """Generate a merge directive for auto-merge tools.
5021
A directive requests a merge to be performed, and also provides all the
5022
information necessary to do so. This means it must either include a
5023
revision bundle, or the location of a branch containing the desired
5026
A submit branch (the location to merge into) must be supplied the first
5027
time the command is issued. After it has been supplied once, it will
5028
be remembered as the default.
5030
A public branch is optional if a revision bundle is supplied, but required
5031
if --diff or --plain is specified. It will be remembered as the default
5032
after the first use.
5035
takes_args = ['submit_branch?', 'public_branch?']
5039
_see_also = ['send']
5043
RegistryOption.from_kwargs('patch-type',
5044
'The type of patch to include in the directive.',
5046
value_switches=True,
5048
bundle='Bazaar revision bundle (default).',
5049
diff='Normal unified diff.',
5050
plain='No patch, just directive.'),
5051
Option('sign', help='GPG-sign the directive.'), 'revision',
5052
Option('mail-to', type=str,
5053
help='Instead of printing the directive, email to this address.'),
5054
Option('message', type=str, short_name='m',
5055
help='Message to use when committing this merge.')
5058
encoding_type = 'exact'
5060
def run(self, submit_branch=None, public_branch=None, patch_type='bundle',
5061
sign=False, revision=None, mail_to=None, message=None,
5063
from bzrlib.revision import ensure_null, NULL_REVISION
5064
include_patch, include_bundle = {
5065
'plain': (False, False),
5066
'diff': (True, False),
5067
'bundle': (True, True),
5069
branch = Branch.open(directory)
5070
stored_submit_branch = branch.get_submit_branch()
5071
if submit_branch is None:
5072
submit_branch = stored_submit_branch
5074
if stored_submit_branch is None:
5075
branch.set_submit_branch(submit_branch)
5076
if submit_branch is None:
5077
submit_branch = branch.get_parent()
5078
if submit_branch is None:
5079
raise errors.BzrCommandError('No submit branch specified or known')
5081
stored_public_branch = branch.get_public_branch()
5082
if public_branch is None:
5083
public_branch = stored_public_branch
5084
elif stored_public_branch is None:
5085
branch.set_public_branch(public_branch)
5086
if not include_bundle and public_branch is None:
5087
raise errors.BzrCommandError('No public branch specified or'
5089
base_revision_id = None
5090
if revision is not None:
5091
if len(revision) > 2:
5092
raise errors.BzrCommandError('bzr merge-directive takes '
5093
'at most two one revision identifiers')
5094
revision_id = revision[-1].as_revision_id(branch)
5095
if len(revision) == 2:
5096
base_revision_id = revision[0].as_revision_id(branch)
5098
revision_id = branch.last_revision()
5099
revision_id = ensure_null(revision_id)
5100
if revision_id == NULL_REVISION:
5101
raise errors.BzrCommandError('No revisions to bundle.')
5102
directive = merge_directive.MergeDirective2.from_objects(
5103
branch.repository, revision_id, time.time(),
5104
osutils.local_time_offset(), submit_branch,
5105
public_branch=public_branch, include_patch=include_patch,
5106
include_bundle=include_bundle, message=message,
5107
base_revision_id=base_revision_id)
5110
self.outf.write(directive.to_signed(branch))
5112
self.outf.writelines(directive.to_lines())
5114
message = directive.to_email(mail_to, branch, sign)
5115
s = SMTPConnection(branch.get_config())
5116
s.send_email(message)
5119
class cmd_send(Command):
5120
__doc__ = """Mail or create a merge-directive for submitting changes.
5122
A merge directive provides many things needed for requesting merges:
5124
* A machine-readable description of the merge to perform
5126
* An optional patch that is a preview of the changes requested
5128
* An optional bundle of revision data, so that the changes can be applied
5129
directly from the merge directive, without retrieving data from a
5132
`bzr send` creates a compact data set that, when applied using bzr
5133
merge, has the same effect as merging from the source branch.
5135
By default the merge directive is self-contained and can be applied to any
5136
branch containing submit_branch in its ancestory without needing access to
5139
If --no-bundle is specified, then Bazaar doesn't send the contents of the
5140
revisions, but only a structured request to merge from the
5141
public_location. In that case the public_branch is needed and it must be
5142
up-to-date and accessible to the recipient. The public_branch is always
5143
included if known, so that people can check it later.
5145
The submit branch defaults to the parent of the source branch, but can be
5146
overridden. Both submit branch and public branch will be remembered in
5147
branch.conf the first time they are used for a particular branch. The
5148
source branch defaults to that containing the working directory, but can
5149
be changed using --from.
5151
In order to calculate those changes, bzr must analyse the submit branch.
5152
Therefore it is most efficient for the submit branch to be a local mirror.
5153
If a public location is known for the submit_branch, that location is used
5154
in the merge directive.
5156
The default behaviour is to send the merge directive by mail, unless -o is
5157
given, in which case it is sent to a file.
5159
Mail is sent using your preferred mail program. This should be transparent
5160
on Windows (it uses MAPI). On Unix, it requires the xdg-email utility.
5161
If the preferred client can't be found (or used), your editor will be used.
5163
To use a specific mail program, set the mail_client configuration option.
5164
(For Thunderbird 1.5, this works around some bugs.) Supported values for
5165
specific clients are "claws", "evolution", "kmail", "mail.app" (MacOS X's
5166
Mail.app), "mutt", and "thunderbird"; generic options are "default",
5167
"editor", "emacsclient", "mapi", and "xdg-email". Plugins may also add
5170
If mail is being sent, a to address is required. This can be supplied
5171
either on the commandline, by setting the submit_to configuration
5172
option in the branch itself or the child_submit_to configuration option
5173
in the submit branch.
5175
Two formats are currently supported: "4" uses revision bundle format 4 and
5176
merge directive format 2. It is significantly faster and smaller than
5177
older formats. It is compatible with Bazaar 0.19 and later. It is the
5178
default. "0.9" uses revision bundle format 0.9 and merge directive
5179
format 1. It is compatible with Bazaar 0.12 - 0.18.
5181
The merge directives created by bzr send may be applied using bzr merge or
5182
bzr pull by specifying a file containing a merge directive as the location.
5184
bzr send makes extensive use of public locations to map local locations into
5185
URLs that can be used by other people. See `bzr help configuration` to
5186
set them, and use `bzr info` to display them.
5189
encoding_type = 'exact'
5191
_see_also = ['merge', 'pull']
5193
takes_args = ['submit_branch?', 'public_branch?']
5197
help='Do not include a bundle in the merge directive.'),
5198
Option('no-patch', help='Do not include a preview patch in the merge'
5201
help='Remember submit and public branch.'),
5203
help='Branch to generate the submission from, '
5204
'rather than the one containing the working directory.',
5207
Option('output', short_name='o',
5208
help='Write merge directive to this file or directory; '
5209
'use - for stdout.',
5212
help='Refuse to send if there are uncommitted changes in'
5213
' the working tree, --no-strict disables the check.'),
5214
Option('mail-to', help='Mail the request to this address.',
5218
Option('body', help='Body for the email.', type=unicode),
5219
RegistryOption('format',
5220
help='Use the specified output format.',
5221
lazy_registry=('bzrlib.send', 'format_registry')),
5224
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
5225
no_patch=False, revision=None, remember=False, output=None,
5226
format=None, mail_to=None, message=None, body=None,
5227
strict=None, **kwargs):
5228
from bzrlib.send import send
5229
return send(submit_branch, revision, public_branch, remember,
5230
format, no_bundle, no_patch, output,
5231
kwargs.get('from', '.'), mail_to, message, body,
5236
class cmd_bundle_revisions(cmd_send):
5237
__doc__ = """Create a merge-directive for submitting changes.
5239
A merge directive provides many things needed for requesting merges:
5241
* A machine-readable description of the merge to perform
5243
* An optional patch that is a preview of the changes requested
5245
* An optional bundle of revision data, so that the changes can be applied
5246
directly from the merge directive, without retrieving data from a
5249
If --no-bundle is specified, then public_branch is needed (and must be
5250
up-to-date), so that the receiver can perform the merge using the
5251
public_branch. The public_branch is always included if known, so that
5252
people can check it later.
5254
The submit branch defaults to the parent, but can be overridden. Both
5255
submit branch and public branch will be remembered if supplied.
5257
If a public_branch is known for the submit_branch, that public submit
5258
branch is used in the merge instructions. This means that a local mirror
5259
can be used as your actual submit branch, once you have set public_branch
5262
Two formats are currently supported: "4" uses revision bundle format 4 and
5263
merge directive format 2. It is significantly faster and smaller than
5264
older formats. It is compatible with Bazaar 0.19 and later. It is the
5265
default. "0.9" uses revision bundle format 0.9 and merge directive
5266
format 1. It is compatible with Bazaar 0.12 - 0.18.
5271
help='Do not include a bundle in the merge directive.'),
5272
Option('no-patch', help='Do not include a preview patch in the merge'
5275
help='Remember submit and public branch.'),
5277
help='Branch to generate the submission from, '
5278
'rather than the one containing the working directory.',
5281
Option('output', short_name='o', help='Write directive to this file.',
5284
help='Refuse to bundle revisions if there are uncommitted'
5285
' changes in the working tree, --no-strict disables the check.'),
5287
RegistryOption('format',
5288
help='Use the specified output format.',
5289
lazy_registry=('bzrlib.send', 'format_registry')),
5291
aliases = ['bundle']
5293
_see_also = ['send', 'merge']
5297
def run(self, submit_branch=None, public_branch=None, no_bundle=False,
5298
no_patch=False, revision=None, remember=False, output=None,
5299
format=None, strict=None, **kwargs):
5302
from bzrlib.send import send
5303
return send(submit_branch, revision, public_branch, remember,
5304
format, no_bundle, no_patch, output,
5305
kwargs.get('from', '.'), None, None, None,
5306
self.outf, strict=strict)
5309
class cmd_tag(Command):
5310
__doc__ = """Create, remove or modify a tag naming a revision.
5312
Tags give human-meaningful names to revisions. Commands that take a -r
5313
(--revision) option can be given -rtag:X, where X is any previously
5316
Tags are stored in the branch. Tags are copied from one branch to another
5317
along when you branch, push, pull or merge.
5319
It is an error to give a tag name that already exists unless you pass
5320
--force, in which case the tag is moved to point to the new revision.
5322
To rename a tag (change the name but keep it on the same revsion), run ``bzr
5323
tag new-name -r tag:old-name`` and then ``bzr tag --delete oldname``.
5325
If no tag name is specified it will be determined through the
5326
'automatic_tag_name' hook. This can e.g. be used to automatically tag
5327
upstream releases by reading configure.ac. See ``bzr help hooks`` for
5331
_see_also = ['commit', 'tags']
5332
takes_args = ['tag_name?']
5335
help='Delete this tag rather than placing it.',
5337
custom_help('directory',
5338
help='Branch in which to place the tag.'),
5340
help='Replace existing tags.',
5345
def run(self, tag_name=None,
5351
branch, relpath = Branch.open_containing(directory)
5352
self.add_cleanup(branch.lock_write().unlock)
5354
if tag_name is None:
5355
raise errors.BzrCommandError("No tag specified to delete.")
5356
branch.tags.delete_tag(tag_name)
5357
self.outf.write('Deleted tag %s.\n' % tag_name)
5360
if len(revision) != 1:
5361
raise errors.BzrCommandError(
5362
"Tags can only be placed on a single revision, "
5364
revision_id = revision[0].as_revision_id(branch)
5366
revision_id = branch.last_revision()
5367
if tag_name is None:
5368
tag_name = branch.automatic_tag_name(revision_id)
5369
if tag_name is None:
5370
raise errors.BzrCommandError(
5371
"Please specify a tag name.")
5372
if (not force) and branch.tags.has_tag(tag_name):
5373
raise errors.TagAlreadyExists(tag_name)
5374
branch.tags.set_tag(tag_name, revision_id)
5375
self.outf.write('Created tag %s.\n' % tag_name)
5378
class cmd_tags(Command):
5379
__doc__ = """List tags.
5381
This command shows a table of tag names and the revisions they reference.
5386
custom_help('directory',
5387
help='Branch whose tags should be displayed.'),
5388
RegistryOption.from_kwargs('sort',
5389
'Sort tags by different criteria.', title='Sorting',
5390
alpha='Sort tags lexicographically (default).',
5391
time='Sort tags chronologically.',
5404
branch, relpath = Branch.open_containing(directory)
5406
tags = branch.tags.get_tag_dict().items()
5410
self.add_cleanup(branch.lock_read().unlock)
5412
graph = branch.repository.get_graph()
5413
rev1, rev2 = _get_revision_range(revision, branch, self.name())
5414
revid1, revid2 = rev1.rev_id, rev2.rev_id
5415
# only show revisions between revid1 and revid2 (inclusive)
5416
tags = [(tag, revid) for tag, revid in tags if
5417
graph.is_between(revid, revid1, revid2)]
5420
elif sort == 'time':
5422
for tag, revid in tags:
5424
revobj = branch.repository.get_revision(revid)
5425
except errors.NoSuchRevision:
5426
timestamp = sys.maxint # place them at the end
5428
timestamp = revobj.timestamp
5429
timestamps[revid] = timestamp
5430
tags.sort(key=lambda x: timestamps[x[1]])
5432
# [ (tag, revid), ... ] -> [ (tag, dotted_revno), ... ]
5433
for index, (tag, revid) in enumerate(tags):
5435
revno = branch.revision_id_to_dotted_revno(revid)
5436
if isinstance(revno, tuple):
5437
revno = '.'.join(map(str, revno))
5438
except errors.NoSuchRevision:
5439
# Bad tag data/merges can lead to tagged revisions
5440
# which are not in this branch. Fail gracefully ...
5442
tags[index] = (tag, revno)
5444
for tag, revspec in tags:
5445
self.outf.write('%-20s %s\n' % (tag, revspec))
5448
class cmd_reconfigure(Command):
5449
__doc__ = """Reconfigure the type of a bzr directory.
5451
A target configuration must be specified.
5453
For checkouts, the bind-to location will be auto-detected if not specified.
5454
The order of preference is
5455
1. For a lightweight checkout, the current bound location.
5456
2. For branches that used to be checkouts, the previously-bound location.
5457
3. The push location.
5458
4. The parent location.
5459
If none of these is available, --bind-to must be specified.
5462
_see_also = ['branches', 'checkouts', 'standalone-trees', 'working-trees']
5463
takes_args = ['location?']
5465
RegistryOption.from_kwargs(
5467
title='Target type',
5468
help='The type to reconfigure the directory to.',
5469
value_switches=True, enum_switch=False,
5470
branch='Reconfigure to be an unbound branch with no working tree.',
5471
tree='Reconfigure to be an unbound branch with a working tree.',
5472
checkout='Reconfigure to be a bound branch with a working tree.',
5473
lightweight_checkout='Reconfigure to be a lightweight'
5474
' checkout (with no local history).',
5475
standalone='Reconfigure to be a standalone branch '
5476
'(i.e. stop using shared repository).',
5477
use_shared='Reconfigure to use a shared repository.',
5478
with_trees='Reconfigure repository to create '
5479
'working trees on branches by default.',
5480
with_no_trees='Reconfigure repository to not create '
5481
'working trees on branches by default.'
5483
Option('bind-to', help='Branch to bind checkout to.', type=str),
5485
help='Perform reconfiguration even if local changes'
5487
Option('stacked-on',
5488
help='Reconfigure a branch to be stacked on another branch.',
5492
help='Reconfigure a branch to be unstacked. This '
5493
'may require copying substantial data into it.',
5497
def run(self, location=None, target_type=None, bind_to=None, force=False,
5500
directory = bzrdir.BzrDir.open(location)
5501
if stacked_on and unstacked:
5502
raise BzrCommandError("Can't use both --stacked-on and --unstacked")
5503
elif stacked_on is not None:
5504
reconfigure.ReconfigureStackedOn().apply(directory, stacked_on)
5506
reconfigure.ReconfigureUnstacked().apply(directory)
5507
# At the moment you can use --stacked-on and a different
5508
# reconfiguration shape at the same time; there seems no good reason
5510
if target_type is None:
5511
if stacked_on or unstacked:
5514
raise errors.BzrCommandError('No target configuration '
5516
elif target_type == 'branch':
5517
reconfiguration = reconfigure.Reconfigure.to_branch(directory)
5518
elif target_type == 'tree':
5519
reconfiguration = reconfigure.Reconfigure.to_tree(directory)
5520
elif target_type == 'checkout':
5521
reconfiguration = reconfigure.Reconfigure.to_checkout(
5523
elif target_type == 'lightweight-checkout':
5524
reconfiguration = reconfigure.Reconfigure.to_lightweight_checkout(
5526
elif target_type == 'use-shared':
5527
reconfiguration = reconfigure.Reconfigure.to_use_shared(directory)
5528
elif target_type == 'standalone':
5529
reconfiguration = reconfigure.Reconfigure.to_standalone(directory)
5530
elif target_type == 'with-trees':
5531
reconfiguration = reconfigure.Reconfigure.set_repository_trees(
5533
elif target_type == 'with-no-trees':
5534
reconfiguration = reconfigure.Reconfigure.set_repository_trees(
5536
reconfiguration.apply(force)
5539
class cmd_switch(Command):
5540
__doc__ = """Set the branch of a checkout and update.
5542
For lightweight checkouts, this changes the branch being referenced.
5543
For heavyweight checkouts, this checks that there are no local commits
5544
versus the current bound branch, then it makes the local branch a mirror
5545
of the new location and binds to it.
5547
In both cases, the working tree is updated and uncommitted changes
5548
are merged. The user can commit or revert these as they desire.
5550
Pending merges need to be committed or reverted before using switch.
5552
The path to the branch to switch to can be specified relative to the parent
5553
directory of the current branch. For example, if you are currently in a
5554
checkout of /path/to/branch, specifying 'newbranch' will find a branch at
5557
Bound branches use the nickname of its master branch unless it is set
5558
locally, in which case switching will update the local nickname to be
5562
takes_args = ['to_location?']
5563
takes_options = ['directory',
5565
help='Switch even if local commits will be lost.'),
5567
Option('create-branch', short_name='b',
5568
help='Create the target branch from this one before'
5569
' switching to it.'),
5572
def run(self, to_location=None, force=False, create_branch=False,
5573
revision=None, directory=u'.'):
5574
from bzrlib import switch
5575
tree_location = directory
5576
revision = _get_one_revision('switch', revision)
5577
control_dir = bzrdir.BzrDir.open_containing(tree_location)[0]
5578
if to_location is None:
5579
if revision is None:
5580
raise errors.BzrCommandError('You must supply either a'
5581
' revision or a location')
5582
to_location = tree_location
5584
branch = control_dir.open_branch()
5585
had_explicit_nick = branch.get_config().has_explicit_nickname()
5586
except errors.NotBranchError:
5588
had_explicit_nick = False
5591
raise errors.BzrCommandError('cannot create branch without'
5593
to_location = directory_service.directories.dereference(
5595
if '/' not in to_location and '\\' not in to_location:
5596
# This path is meant to be relative to the existing branch
5597
this_url = self._get_branch_location(control_dir)
5598
to_location = urlutils.join(this_url, '..', to_location)
5599
to_branch = branch.bzrdir.sprout(to_location,
5600
possible_transports=[branch.bzrdir.root_transport],
5601
source_branch=branch).open_branch()
5604
to_branch = Branch.open(to_location)
5605
except errors.NotBranchError:
5606
this_url = self._get_branch_location(control_dir)
5607
to_branch = Branch.open(
5608
urlutils.join(this_url, '..', to_location))
5609
if revision is not None:
5610
revision = revision.as_revision_id(to_branch)
5611
switch.switch(control_dir, to_branch, force, revision_id=revision)
5612
if had_explicit_nick:
5613
branch = control_dir.open_branch() #get the new branch!
5614
branch.nick = to_branch.nick
5615
note('Switched to branch: %s',
5616
urlutils.unescape_for_display(to_branch.base, 'utf-8'))
5618
def _get_branch_location(self, control_dir):
5619
"""Return location of branch for this control dir."""
5621
this_branch = control_dir.open_branch()
5622
# This may be a heavy checkout, where we want the master branch
5623
master_location = this_branch.get_bound_location()
5624
if master_location is not None:
5625
return master_location
5626
# If not, use a local sibling
5627
return this_branch.base
5628
except errors.NotBranchError:
5629
format = control_dir.find_branch_format()
5630
if getattr(format, 'get_reference', None) is not None:
5631
return format.get_reference(control_dir)
5633
return control_dir.root_transport.base
5636
class cmd_view(Command):
5637
__doc__ = """Manage filtered views.
5639
Views provide a mask over the tree so that users can focus on
5640
a subset of a tree when doing their work. After creating a view,
5641
commands that support a list of files - status, diff, commit, etc -
5642
effectively have that list of files implicitly given each time.
5643
An explicit list of files can still be given but those files
5644
must be within the current view.
5646
In most cases, a view has a short life-span: it is created to make
5647
a selected change and is deleted once that change is committed.
5648
At other times, you may wish to create one or more named views
5649
and switch between them.
5651
To disable the current view without deleting it, you can switch to
5652
the pseudo view called ``off``. This can be useful when you need
5653
to see the whole tree for an operation or two (e.g. merge) but
5654
want to switch back to your view after that.
5657
To define the current view::
5659
bzr view file1 dir1 ...
5661
To list the current view::
5665
To delete the current view::
5669
To disable the current view without deleting it::
5671
bzr view --switch off
5673
To define a named view and switch to it::
5675
bzr view --name view-name file1 dir1 ...
5677
To list a named view::
5679
bzr view --name view-name
5681
To delete a named view::
5683
bzr view --name view-name --delete
5685
To switch to a named view::
5687
bzr view --switch view-name
5689
To list all views defined::
5693
To delete all views::
5695
bzr view --delete --all
5699
takes_args = ['file*']
5702
help='Apply list or delete action to all views.',
5705
help='Delete the view.',
5708
help='Name of the view to define, list or delete.',
5712
help='Name of the view to switch to.',
5717
def run(self, file_list,
5723
tree, file_list = tree_files(file_list, apply_view=False)
5724
current_view, view_dict = tree.views.get_view_info()
5729
raise errors.BzrCommandError(
5730
"Both --delete and a file list specified")
5732
raise errors.BzrCommandError(
5733
"Both --delete and --switch specified")
5735
tree.views.set_view_info(None, {})
5736
self.outf.write("Deleted all views.\n")
5738
raise errors.BzrCommandError("No current view to delete")
5740
tree.views.delete_view(name)
5741
self.outf.write("Deleted '%s' view.\n" % name)
5744
raise errors.BzrCommandError(
5745
"Both --switch and a file list specified")
5747
raise errors.BzrCommandError(
5748
"Both --switch and --all specified")
5749
elif switch == 'off':
5750
if current_view is None:
5751
raise errors.BzrCommandError("No current view to disable")
5752
tree.views.set_view_info(None, view_dict)
5753
self.outf.write("Disabled '%s' view.\n" % (current_view))
5755
tree.views.set_view_info(switch, view_dict)
5756
view_str = views.view_display_str(tree.views.lookup_view())
5757
self.outf.write("Using '%s' view: %s\n" % (switch, view_str))
5760
self.outf.write('Views defined:\n')
5761
for view in sorted(view_dict):
5762
if view == current_view:
5766
view_str = views.view_display_str(view_dict[view])
5767
self.outf.write('%s %-20s %s\n' % (active, view, view_str))
5769
self.outf.write('No views defined.\n')
5772
# No name given and no current view set
5775
raise errors.BzrCommandError(
5776
"Cannot change the 'off' pseudo view")
5777
tree.views.set_view(name, sorted(file_list))
5778
view_str = views.view_display_str(tree.views.lookup_view())
5779
self.outf.write("Using '%s' view: %s\n" % (name, view_str))
5783
# No name given and no current view set
5784
self.outf.write('No current view.\n')
5786
view_str = views.view_display_str(tree.views.lookup_view(name))
5787
self.outf.write("'%s' view is: %s\n" % (name, view_str))
5790
class cmd_hooks(Command):
5791
__doc__ = """Show hooks."""
5796
for hook_key in sorted(hooks.known_hooks.keys()):
5797
some_hooks = hooks.known_hooks_key_to_object(hook_key)
5798
self.outf.write("%s:\n" % type(some_hooks).__name__)
5799
for hook_name, hook_point in sorted(some_hooks.items()):
5800
self.outf.write(" %s:\n" % (hook_name,))
5801
found_hooks = list(hook_point)
5803
for hook in found_hooks:
5804
self.outf.write(" %s\n" %
5805
(some_hooks.get_hook_name(hook),))
5807
self.outf.write(" <no hooks installed>\n")
5810
class cmd_remove_branch(Command):
5811
__doc__ = """Remove a branch.
5813
This will remove the branch from the specified location but
5814
will keep any working tree or repository in place.
5818
Remove the branch at repo/trunk::
5820
bzr remove-branch repo/trunk
5824
takes_args = ["location?"]
5826
aliases = ["rmbranch"]
5828
def run(self, location=None):
5829
if location is None:
5831
branch = Branch.open_containing(location)[0]
5832
branch.bzrdir.destroy_branch()
5835
class cmd_shelve(Command):
5836
__doc__ = """Temporarily set aside some changes from the current tree.
5838
Shelve allows you to temporarily put changes you've made "on the shelf",
5839
ie. out of the way, until a later time when you can bring them back from
5840
the shelf with the 'unshelve' command. The changes are stored alongside
5841
your working tree, and so they aren't propagated along with your branch nor
5842
will they survive its deletion.
5844
If shelve --list is specified, previously-shelved changes are listed.
5846
Shelve is intended to help separate several sets of changes that have
5847
been inappropriately mingled. If you just want to get rid of all changes
5848
and you don't need to restore them later, use revert. If you want to
5849
shelve all text changes at once, use shelve --all.
5851
If filenames are specified, only the changes to those files will be
5852
shelved. Other files will be left untouched.
5854
If a revision is specified, changes since that revision will be shelved.
5856
You can put multiple items on the shelf, and by default, 'unshelve' will
5857
restore the most recently shelved changes.
5860
takes_args = ['file*']
5865
Option('all', help='Shelve all changes.'),
5867
RegistryOption('writer', 'Method to use for writing diffs.',
5868
bzrlib.option.diff_writer_registry,
5869
value_switches=True, enum_switch=False),
5871
Option('list', help='List shelved changes.'),
5873
help='Destroy removed changes instead of shelving them.'),
5875
_see_also = ['unshelve']
5877
def run(self, revision=None, all=False, file_list=None, message=None,
5878
writer=None, list=False, destroy=False, directory=u'.'):
5880
return self.run_for_list()
5881
from bzrlib.shelf_ui import Shelver
5883
writer = bzrlib.option.diff_writer_registry.get()
5885
shelver = Shelver.from_args(writer(sys.stdout), revision, all,
5886
file_list, message, destroy=destroy, directory=directory)
5891
except errors.UserAbort:
5894
def run_for_list(self):
5895
tree = WorkingTree.open_containing('.')[0]
5896
self.add_cleanup(tree.lock_read().unlock)
5897
manager = tree.get_shelf_manager()
5898
shelves = manager.active_shelves()
5899
if len(shelves) == 0:
5900
note('No shelved changes.')
5902
for shelf_id in reversed(shelves):
5903
message = manager.get_metadata(shelf_id).get('message')
5905
message = '<no message>'
5906
self.outf.write('%3d: %s\n' % (shelf_id, message))
5910
class cmd_unshelve(Command):
5911
__doc__ = """Restore shelved changes.
5913
By default, the most recently shelved changes are restored. However if you
5914
specify a shelf by id those changes will be restored instead. This works
5915
best when the changes don't depend on each other.
5918
takes_args = ['shelf_id?']
5921
RegistryOption.from_kwargs(
5922
'action', help="The action to perform.",
5923
enum_switch=False, value_switches=True,
5924
apply="Apply changes and remove from the shelf.",
5925
dry_run="Show changes, but do not apply or remove them.",
5926
preview="Instead of unshelving the changes, show the diff that "
5927
"would result from unshelving.",
5928
delete_only="Delete changes without applying them.",
5929
keep="Apply changes but don't delete them.",
5932
_see_also = ['shelve']
5934
def run(self, shelf_id=None, action='apply', directory=u'.'):
5935
from bzrlib.shelf_ui import Unshelver
5936
unshelver = Unshelver.from_args(shelf_id, action, directory=directory)
5940
unshelver.tree.unlock()
5943
class cmd_clean_tree(Command):
5944
__doc__ = """Remove unwanted files from working tree.
5946
By default, only unknown files, not ignored files, are deleted. Versioned
5947
files are never deleted.
5949
Another class is 'detritus', which includes files emitted by bzr during
5950
normal operations and selftests. (The value of these files decreases with
5953
If no options are specified, unknown files are deleted. Otherwise, option
5954
flags are respected, and may be combined.
5956
To check what clean-tree will do, use --dry-run.
5958
takes_options = ['directory',
5959
Option('ignored', help='Delete all ignored files.'),
5960
Option('detritus', help='Delete conflict files, merge'
5961
' backups, and failed selftest dirs.'),
5963
help='Delete files unknown to bzr (default).'),
5964
Option('dry-run', help='Show files to delete instead of'
5966
Option('force', help='Do not prompt before deleting.')]
5967
def run(self, unknown=False, ignored=False, detritus=False, dry_run=False,
5968
force=False, directory=u'.'):
5969
from bzrlib.clean_tree import clean_tree
5970
if not (unknown or ignored or detritus):
5974
clean_tree(directory, unknown=unknown, ignored=ignored,
5975
detritus=detritus, dry_run=dry_run, no_prompt=force)
5978
class cmd_reference(Command):
5979
__doc__ = """list, view and set branch locations for nested trees.
5981
If no arguments are provided, lists the branch locations for nested trees.
5982
If one argument is provided, display the branch location for that tree.
5983
If two arguments are provided, set the branch location for that tree.
5988
takes_args = ['path?', 'location?']
5990
def run(self, path=None, location=None):
5992
if path is not None:
5994
tree, branch, relpath =(
5995
bzrdir.BzrDir.open_containing_tree_or_branch(branchdir))
5996
if path is not None:
5999
tree = branch.basis_tree()
6001
info = branch._get_all_reference_info().iteritems()
6002
self._display_reference_info(tree, branch, info)
6004
file_id = tree.path2id(path)
6006
raise errors.NotVersionedError(path)
6007
if location is None:
6008
info = [(file_id, branch.get_reference_info(file_id))]
6009
self._display_reference_info(tree, branch, info)
6011
branch.set_reference_info(file_id, path, location)
6013
def _display_reference_info(self, tree, branch, info):
6015
for file_id, (path, location) in info:
6017
path = tree.id2path(file_id)
6018
except errors.NoSuchId:
6020
ref_list.append((path, location))
6021
for path, location in sorted(ref_list):
6022
self.outf.write('%s %s\n' % (path, location))
6025
def _register_lazy_builtins():
6026
# register lazy builtins from other modules; called at startup and should
6027
# be only called once.
6028
for (name, aliases, module_name) in [
6029
('cmd_bundle_info', [], 'bzrlib.bundle.commands'),
6030
('cmd_dpush', [], 'bzrlib.foreign'),
6031
('cmd_version_info', [], 'bzrlib.cmd_version_info'),
6032
('cmd_resolve', ['resolved'], 'bzrlib.conflicts'),
6033
('cmd_conflicts', [], 'bzrlib.conflicts'),
6034
('cmd_sign_my_commits', [], 'bzrlib.sign_my_commits'),
6036
builtin_command_registry.register_lazy(name, aliases, module_name)
added
removed
bzrlib/builtins.py
