1
# Copyright (C) 2004, 2005, 2006, 2007 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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
 
17
"""builtin bzr commands"""
 
 
20
from StringIO import StringIO
 
 
22
from bzrlib.lazy_import import lazy_import
 
 
23
lazy_import(globals(), """
 
 
43
    revision as _mod_revision,
 
 
50
from bzrlib.branch import Branch
 
 
51
from bzrlib.conflicts import ConflictList
 
 
52
from bzrlib.revisionspec import RevisionSpec
 
 
53
from bzrlib.smtp_connection import SMTPConnection
 
 
54
from bzrlib.workingtree import WorkingTree
 
 
57
from bzrlib.commands import Command, display_command
 
 
58
from bzrlib.option import ListOption, Option, RegistryOption, custom_help
 
 
59
from bzrlib.trace import mutter, note, warning, is_quiet, info
 
 
62
def tree_files(file_list, default_branch=u'.'):
 
 
64
        return internal_tree_files(file_list, default_branch)
 
 
65
    except errors.FileInWrongBranch, e:
 
 
66
        raise errors.BzrCommandError("%s is not in the same branch as %s" %
 
 
67
                                     (e.path, file_list[0]))
 
 
70
# XXX: Bad function name; should possibly also be a class method of
 
 
71
# WorkingTree rather than a function.
 
 
72
def internal_tree_files(file_list, default_branch=u'.'):
 
 
73
    """Convert command-line paths to a WorkingTree and relative paths.
 
 
75
    This is typically used for command-line processors that take one or
 
 
76
    more filenames, and infer the workingtree that contains them.
 
 
78
    The filenames given are not required to exist.
 
 
80
    :param file_list: Filenames to convert.  
 
 
82
    :param default_branch: Fallback tree path to use if file_list is empty or
 
 
85
    :return: workingtree, [relative_paths]
 
 
87
    if file_list is None or len(file_list) == 0:
 
 
88
        return WorkingTree.open_containing(default_branch)[0], file_list
 
 
89
    tree = WorkingTree.open_containing(osutils.realpath(file_list[0]))[0]
 
 
91
    for filename in file_list:
 
 
93
            new_list.append(tree.relpath(osutils.dereference_path(filename)))
 
 
94
        except errors.PathNotChild:
 
 
95
            raise errors.FileInWrongBranch(tree.branch, filename)
 
 
99
# TODO: Make sure no commands unconditionally use the working directory as a
 
 
100
# branch.  If a filename argument is used, the first of them should be used to
 
 
101
# specify the branch.  (Perhaps this can be factored out into some kind of
 
 
102
# Argument class, representing a file in a branch, where the first occurrence
 
 
105
class cmd_status(Command):
 
 
106
    """Display status summary.
 
 
108
    This reports on versioned and unknown files, reporting them
 
 
109
    grouped by state.  Possible states are:
 
 
112
        Versioned in the working copy but not in the previous revision.
 
 
115
        Versioned in the previous revision but removed or deleted
 
 
119
        Path of this file changed from the previous revision;
 
 
120
        the text may also have changed.  This includes files whose
 
 
121
        parent directory was renamed.
 
 
124
        Text has changed since the previous revision.
 
 
127
        File kind has been changed (e.g. from file to directory).
 
 
130
        Not versioned and not matching an ignore pattern.
 
 
132
    To see ignored files use 'bzr ignored'.  For details on the
 
 
133
    changes to file texts, use 'bzr diff'.
 
 
135
    Note that --short or -S gives status flags for each item, similar
 
 
136
    to Subversion's status command. To get output similar to svn -q,
 
 
139
    If no arguments are specified, the status of the entire working
 
 
140
    directory is shown.  Otherwise, only the status of the specified
 
 
141
    files or directories is reported.  If a directory is given, status
 
 
142
    is reported for everything inside that directory.
 
 
144
    If a revision argument is given, the status is calculated against
 
 
145
    that revision, or between two revisions if two are provided.
 
 
148
    # TODO: --no-recurse, --recurse options
 
 
150
    takes_args = ['file*']
 
 
151
    takes_options = ['show-ids', 'revision', 'change',
 
 
152
                     Option('short', help='Use short status indicators.',
 
 
154
                     Option('versioned', help='Only show versioned files.',
 
 
156
                     Option('no-pending', help='Don\'t show pending merges.',
 
 
159
    aliases = ['st', 'stat']
 
 
161
    encoding_type = 'replace'
 
 
162
    _see_also = ['diff', 'revert', 'status-flags']
 
 
165
    def run(self, show_ids=False, file_list=None, revision=None, short=False,
 
 
166
            versioned=False, no_pending=False):
 
 
167
        from bzrlib.status import show_tree_status
 
 
169
        if revision and len(revision) > 2:
 
 
170
            raise errors.BzrCommandError('bzr status --revision takes exactly'
 
 
171
                                         ' one or two revision specifiers')
 
 
173
        tree, file_list = tree_files(file_list)
 
 
175
        show_tree_status(tree, show_ids=show_ids,
 
 
176
                         specific_files=file_list, revision=revision,
 
 
177
                         to_file=self.outf, short=short, versioned=versioned,
 
 
178
                         show_pending=not no_pending)
 
 
181
class cmd_cat_revision(Command):
 
 
182
    """Write out metadata for a revision.
 
 
184
    The revision to print can either be specified by a specific
 
 
185
    revision identifier, or you can use --revision.
 
 
189
    takes_args = ['revision_id?']
 
 
190
    takes_options = ['revision']
 
 
191
    # cat-revision is more for frontends so should be exact
 
 
195
    def run(self, revision_id=None, revision=None):
 
 
196
        if revision_id is not None and revision is not None:
 
 
197
            raise errors.BzrCommandError('You can only supply one of'
 
 
198
                                         ' revision_id or --revision')
 
 
199
        if revision_id is None and revision is None:
 
 
200
            raise errors.BzrCommandError('You must supply either'
 
 
201
                                         ' --revision or a revision_id')
 
 
202
        b = WorkingTree.open_containing(u'.')[0].branch
 
 
204
        # TODO: jam 20060112 should cat-revision always output utf-8?
 
 
205
        if revision_id is not None:
 
 
206
            revision_id = osutils.safe_revision_id(revision_id, warn=False)
 
 
207
            self.outf.write(b.repository.get_revision_xml(revision_id).decode('utf-8'))
 
 
208
        elif revision is not None:
 
 
211
                    raise errors.BzrCommandError('You cannot specify a NULL'
 
 
213
                rev_id = rev.as_revision_id(b)
 
 
214
                self.outf.write(b.repository.get_revision_xml(rev_id).decode('utf-8'))
 
 
217
class cmd_remove_tree(Command):
 
 
218
    """Remove the working tree from a given branch/checkout.
 
 
220
    Since a lightweight checkout is little more than a working tree
 
 
221
    this will refuse to run against one.
 
 
223
    To re-create the working tree, use "bzr checkout".
 
 
225
    _see_also = ['checkout', 'working-trees']
 
 
227
    takes_args = ['location?']
 
 
229
    def run(self, location='.'):
 
 
230
        d = bzrdir.BzrDir.open(location)
 
 
233
            working = d.open_workingtree()
 
 
234
        except errors.NoWorkingTree:
 
 
235
            raise errors.BzrCommandError("No working tree to remove")
 
 
236
        except errors.NotLocalUrl:
 
 
237
            raise errors.BzrCommandError("You cannot remove the working tree of a "
 
 
240
        working_path = working.bzrdir.root_transport.base
 
 
241
        branch_path = working.branch.bzrdir.root_transport.base
 
 
242
        if working_path != branch_path:
 
 
243
            raise errors.BzrCommandError("You cannot remove the working tree from "
 
 
244
                                         "a lightweight checkout")
 
 
246
        d.destroy_workingtree()
 
 
249
class cmd_revno(Command):
 
 
250
    """Show current revision number.
 
 
252
    This is equal to the number of revisions on this branch.
 
 
256
    takes_args = ['location?']
 
 
259
    def run(self, location=u'.'):
 
 
260
        self.outf.write(str(Branch.open_containing(location)[0].revno()))
 
 
261
        self.outf.write('\n')
 
 
264
class cmd_revision_info(Command):
 
 
265
    """Show revision number and revision id for a given revision identifier.
 
 
268
    takes_args = ['revision_info*']
 
 
269
    takes_options = ['revision']
 
 
272
    def run(self, revision=None, revision_info_list=[]):
 
 
275
        if revision is not None:
 
 
276
            revs.extend(revision)
 
 
277
        if revision_info_list is not None:
 
 
278
            for rev in revision_info_list:
 
 
279
                revs.append(RevisionSpec.from_string(rev))
 
 
281
        b = Branch.open_containing(u'.')[0]
 
 
284
            revs.append(RevisionSpec.from_string('-1'))
 
 
287
            revision_id = rev.as_revision_id(b)
 
 
289
                revno = '%4d' % (b.revision_id_to_revno(revision_id))
 
 
290
            except errors.NoSuchRevision:
 
 
291
                dotted_map = b.get_revision_id_to_revno_map()
 
 
292
                revno = '.'.join(str(i) for i in dotted_map[revision_id])
 
 
293
            print '%s %s' % (revno, revision_id)
 
 
296
class cmd_add(Command):
 
 
297
    """Add specified files or directories.
 
 
299
    In non-recursive mode, all the named items are added, regardless
 
 
300
    of whether they were previously ignored.  A warning is given if
 
 
301
    any of the named files are already versioned.
 
 
303
    In recursive mode (the default), files are treated the same way
 
 
304
    but the behaviour for directories is different.  Directories that
 
 
305
    are already versioned do not give a warning.  All directories,
 
 
306
    whether already versioned or not, are searched for files or
 
 
307
    subdirectories that are neither versioned or ignored, and these
 
 
308
    are added.  This search proceeds recursively into versioned
 
 
309
    directories.  If no names are given '.' is assumed.
 
 
311
    Therefore simply saying 'bzr add' will version all files that
 
 
312
    are currently unknown.
 
 
314
    Adding a file whose parent directory is not versioned will
 
 
315
    implicitly add the parent, and so on up to the root. This means
 
 
316
    you should never need to explicitly add a directory, they'll just
 
 
317
    get added when you add a file in the directory.
 
 
319
    --dry-run will show which files would be added, but not actually 
 
 
322
    --file-ids-from will try to use the file ids from the supplied path.
 
 
323
    It looks up ids trying to find a matching parent directory with the
 
 
324
    same filename, and then by pure path. This option is rarely needed
 
 
325
    but can be useful when adding the same logical file into two
 
 
326
    branches that will be merged later (without showing the two different
 
 
327
    adds as a conflict). It is also useful when merging another project
 
 
328
    into a subdirectory of this one.
 
 
330
    takes_args = ['file*']
 
 
333
               help="Don't recursively add the contents of directories."),
 
 
335
               help="Show what would be done, but don't actually do anything."),
 
 
337
        Option('file-ids-from',
 
 
339
               help='Lookup file ids from this tree.'),
 
 
341
    encoding_type = 'replace'
 
 
342
    _see_also = ['remove']
 
 
344
    def run(self, file_list, no_recurse=False, dry_run=False, verbose=False,
 
 
349
        if file_ids_from is not None:
 
 
351
                base_tree, base_path = WorkingTree.open_containing(
 
 
353
            except errors.NoWorkingTree:
 
 
354
                base_branch, base_path = Branch.open_containing(
 
 
356
                base_tree = base_branch.basis_tree()
 
 
358
            action = bzrlib.add.AddFromBaseAction(base_tree, base_path,
 
 
359
                          to_file=self.outf, should_print=(not is_quiet()))
 
 
361
            action = bzrlib.add.AddAction(to_file=self.outf,
 
 
362
                should_print=(not is_quiet()))
 
 
365
            base_tree.lock_read()
 
 
367
            file_list = self._maybe_expand_globs(file_list)
 
 
369
                tree = WorkingTree.open_containing(file_list[0])[0]
 
 
371
                tree = WorkingTree.open_containing(u'.')[0]
 
 
372
            added, ignored = tree.smart_add(file_list, not
 
 
373
                no_recurse, action=action, save=not dry_run)
 
 
375
            if base_tree is not None:
 
 
379
                for glob in sorted(ignored.keys()):
 
 
380
                    for path in ignored[glob]:
 
 
381
                        self.outf.write("ignored %s matching \"%s\"\n" 
 
 
385
                for glob, paths in ignored.items():
 
 
386
                    match_len += len(paths)
 
 
387
                self.outf.write("ignored %d file(s).\n" % match_len)
 
 
388
            self.outf.write("If you wish to add some of these files,"
 
 
389
                            " please add them by name.\n")
 
 
392
class cmd_mkdir(Command):
 
 
393
    """Create a new versioned directory.
 
 
395
    This is equivalent to creating the directory and then adding it.
 
 
398
    takes_args = ['dir+']
 
 
399
    encoding_type = 'replace'
 
 
401
    def run(self, dir_list):
 
 
404
            wt, dd = WorkingTree.open_containing(d)
 
 
406
            self.outf.write('added %s\n' % d)
 
 
409
class cmd_relpath(Command):
 
 
410
    """Show path of a file relative to root"""
 
 
412
    takes_args = ['filename']
 
 
416
    def run(self, filename):
 
 
417
        # TODO: jam 20050106 Can relpath return a munged path if
 
 
418
        #       sys.stdout encoding cannot represent it?
 
 
419
        tree, relpath = WorkingTree.open_containing(filename)
 
 
420
        self.outf.write(relpath)
 
 
421
        self.outf.write('\n')
 
 
424
class cmd_inventory(Command):
 
 
425
    """Show inventory of the current working copy or a revision.
 
 
427
    It is possible to limit the output to a particular entry
 
 
428
    type using the --kind option.  For example: --kind file.
 
 
430
    It is also possible to restrict the list of files to a specific
 
 
431
    set. For example: bzr inventory --show-ids this/file
 
 
440
               help='List entries of a particular kind: file, directory, symlink.',
 
 
443
    takes_args = ['file*']
 
 
446
    def run(self, revision=None, show_ids=False, kind=None, file_list=None):
 
 
447
        if kind and kind not in ['file', 'directory', 'symlink']:
 
 
448
            raise errors.BzrCommandError('invalid kind %r specified' % (kind,))
 
 
450
        work_tree, file_list = tree_files(file_list)
 
 
451
        work_tree.lock_read()
 
 
453
            if revision is not None:
 
 
454
                if len(revision) > 1:
 
 
455
                    raise errors.BzrCommandError(
 
 
456
                        'bzr inventory --revision takes exactly one revision'
 
 
458
                revision_id = revision[0].as_revision_id(work_tree.branch)
 
 
459
                tree = work_tree.branch.repository.revision_tree(revision_id)
 
 
461
                extra_trees = [work_tree]
 
 
467
            if file_list is not None:
 
 
468
                file_ids = tree.paths2ids(file_list, trees=extra_trees,
 
 
469
                                          require_versioned=True)
 
 
470
                # find_ids_across_trees may include some paths that don't
 
 
472
                entries = sorted((tree.id2path(file_id), tree.inventory[file_id])
 
 
473
                                 for file_id in file_ids if file_id in tree)
 
 
475
                entries = tree.inventory.entries()
 
 
478
            if tree is not work_tree:
 
 
481
        for path, entry in entries:
 
 
482
            if kind and kind != entry.kind:
 
 
485
                self.outf.write('%-50s %s\n' % (path, entry.file_id))
 
 
487
                self.outf.write(path)
 
 
488
                self.outf.write('\n')
 
 
491
class cmd_mv(Command):
 
 
492
    """Move or rename a file.
 
 
495
        bzr mv OLDNAME NEWNAME
 
 
497
        bzr mv SOURCE... DESTINATION
 
 
499
    If the last argument is a versioned directory, all the other names
 
 
500
    are moved into it.  Otherwise, there must be exactly two arguments
 
 
501
    and the file is changed to a new name.
 
 
503
    If OLDNAME does not exist on the filesystem but is versioned and
 
 
504
    NEWNAME does exist on the filesystem but is not versioned, mv
 
 
505
    assumes that the file has been manually moved and only updates
 
 
506
    its internal inventory to reflect that change.
 
 
507
    The same is valid when moving many SOURCE files to a DESTINATION.
 
 
509
    Files cannot be moved between branches.
 
 
512
    takes_args = ['names*']
 
 
513
    takes_options = [Option("after", help="Move only the bzr identifier"
 
 
514
        " of the file, because the file has already been moved."),
 
 
516
    aliases = ['move', 'rename']
 
 
517
    encoding_type = 'replace'
 
 
519
    def run(self, names_list, after=False):
 
 
520
        if names_list is None:
 
 
523
        if len(names_list) < 2:
 
 
524
            raise errors.BzrCommandError("missing file argument")
 
 
525
        tree, rel_names = tree_files(names_list)
 
 
528
            self._run(tree, names_list, rel_names, after)
 
 
532
    def _run(self, tree, names_list, rel_names, after):
 
 
533
        into_existing = osutils.isdir(names_list[-1])
 
 
534
        if into_existing and len(names_list) == 2:
 
 
536
            # a. case-insensitive filesystem and change case of dir
 
 
537
            # b. move directory after the fact (if the source used to be
 
 
538
            #    a directory, but now doesn't exist in the working tree
 
 
539
            #    and the target is an existing directory, just rename it)
 
 
540
            if (not tree.case_sensitive
 
 
541
                and rel_names[0].lower() == rel_names[1].lower()):
 
 
542
                into_existing = False
 
 
545
                from_id = tree.path2id(rel_names[0])
 
 
546
                if (not osutils.lexists(names_list[0]) and
 
 
547
                    from_id and inv.get_file_kind(from_id) == "directory"):
 
 
548
                    into_existing = False
 
 
551
            # move into existing directory
 
 
552
            for pair in tree.move(rel_names[:-1], rel_names[-1], after=after):
 
 
553
                self.outf.write("%s => %s\n" % pair)
 
 
555
            if len(names_list) != 2:
 
 
556
                raise errors.BzrCommandError('to mv multiple files the'
 
 
557
                                             ' destination must be a versioned'
 
 
559
            tree.rename_one(rel_names[0], rel_names[1], after=after)
 
 
560
            self.outf.write("%s => %s\n" % (rel_names[0], rel_names[1]))
 
 
563
class cmd_pull(Command):
 
 
564
    """Turn this branch into a mirror of another branch.
 
 
566
    This command only works on branches that have not diverged.  Branches are
 
 
567
    considered diverged if the destination branch's most recent commit is one
 
 
568
    that has not been merged (directly or indirectly) into the parent.
 
 
570
    If branches have diverged, you can use 'bzr merge' to integrate the changes
 
 
571
    from one into the other.  Once one branch has merged, the other should
 
 
572
    be able to pull it again.
 
 
574
    If you want to forget your local changes and just update your branch to
 
 
575
    match the remote one, use pull --overwrite.
 
 
577
    If there is no default location set, the first pull will set it.  After
 
 
578
    that, you can omit the location to use the default.  To change the
 
 
579
    default, use --remember. The value will only be saved if the remote
 
 
580
    location can be accessed.
 
 
582
    Note: The location can be specified either in the form of a branch,
 
 
583
    or in the form of a path to a file containing a merge directive generated
 
 
587
    _see_also = ['push', 'update', 'status-flags']
 
 
588
    takes_options = ['remember', 'overwrite', 'revision',
 
 
589
        custom_help('verbose',
 
 
590
            help='Show logs of pulled revisions.'),
 
 
592
            help='Branch to pull into, '
 
 
593
                 'rather than the one containing the working directory.',
 
 
598
    takes_args = ['location?']
 
 
599
    encoding_type = 'replace'
 
 
601
    def run(self, location=None, remember=False, overwrite=False,
 
 
602
            revision=None, verbose=False,
 
 
604
        # FIXME: too much stuff is in the command class
 
 
607
        if directory is None:
 
 
610
            tree_to = WorkingTree.open_containing(directory)[0]
 
 
611
            branch_to = tree_to.branch
 
 
612
        except errors.NoWorkingTree:
 
 
614
            branch_to = Branch.open_containing(directory)[0]
 
 
616
        possible_transports = []
 
 
617
        if location is not None:
 
 
619
                mergeable = bundle.read_mergeable_from_url(location,
 
 
620
                    possible_transports=possible_transports)
 
 
621
            except errors.NotABundle:
 
 
624
        stored_loc = branch_to.get_parent()
 
 
626
            if stored_loc is None:
 
 
627
                raise errors.BzrCommandError("No pull location known or"
 
 
630
                display_url = urlutils.unescape_for_display(stored_loc,
 
 
633
                    self.outf.write("Using saved location: %s\n" % display_url)
 
 
634
                location = stored_loc
 
 
636
        if mergeable is not None:
 
 
637
            if revision is not None:
 
 
638
                raise errors.BzrCommandError(
 
 
639
                    'Cannot use -r with merge directives or bundles')
 
 
640
            mergeable.install_revisions(branch_to.repository)
 
 
641
            base_revision_id, revision_id, verified = \
 
 
642
                mergeable.get_merge_request(branch_to.repository)
 
 
643
            branch_from = branch_to
 
 
645
            branch_from = Branch.open(location,
 
 
646
                possible_transports=possible_transports)
 
 
648
            if branch_to.get_parent() is None or remember:
 
 
649
                branch_to.set_parent(branch_from.base)
 
 
651
        if revision is not None:
 
 
652
            if len(revision) == 1:
 
 
653
                revision_id = revision[0].as_revision_id(branch_from)
 
 
655
                raise errors.BzrCommandError(
 
 
656
                    'bzr pull --revision takes one value.')
 
 
658
        branch_to.lock_write()
 
 
660
            if tree_to is not None:
 
 
661
                change_reporter = delta._ChangeReporter(
 
 
662
                    unversioned_filter=tree_to.is_ignored)
 
 
663
                result = tree_to.pull(branch_from, overwrite, revision_id,
 
 
665
                                      possible_transports=possible_transports)
 
 
667
                result = branch_to.pull(branch_from, overwrite, revision_id)
 
 
669
            result.report(self.outf)
 
 
670
            if verbose and result.old_revid != result.new_revid:
 
 
672
                    branch_to.repository.iter_reverse_revision_history(
 
 
675
                new_rh = branch_to.revision_history()
 
 
676
                log.show_changed_revisions(branch_to, old_rh, new_rh,
 
 
682
class cmd_push(Command):
 
 
683
    """Update a mirror of this branch.
 
 
685
    The target branch will not have its working tree populated because this
 
 
686
    is both expensive, and is not supported on remote file systems.
 
 
688
    Some smart servers or protocols *may* put the working tree in place in
 
 
691
    This command only works on branches that have not diverged.  Branches are
 
 
692
    considered diverged if the destination branch's most recent commit is one
 
 
693
    that has not been merged (directly or indirectly) by the source branch.
 
 
695
    If branches have diverged, you can use 'bzr push --overwrite' to replace
 
 
696
    the other branch completely, discarding its unmerged changes.
 
 
698
    If you want to ensure you have the different changes in the other branch,
 
 
699
    do a merge (see bzr help merge) from the other branch, and commit that.
 
 
700
    After that you will be able to do a push without '--overwrite'.
 
 
702
    If there is no default push location set, the first push will set it.
 
 
703
    After that, you can omit the location to use the default.  To change the
 
 
704
    default, use --remember. The value will only be saved if the remote
 
 
705
    location can be accessed.
 
 
708
    _see_also = ['pull', 'update', 'working-trees']
 
 
709
    takes_options = ['remember', 'overwrite', 'verbose', 'revision',
 
 
710
        Option('create-prefix',
 
 
711
               help='Create the path leading up to the branch '
 
 
712
                    'if it does not already exist.'),
 
 
714
            help='Branch to push from, '
 
 
715
                 'rather than the one containing the working directory.',
 
 
719
        Option('use-existing-dir',
 
 
720
               help='By default push will fail if the target'
 
 
721
                    ' directory exists, but does not already'
 
 
722
                    ' have a control directory.  This flag will'
 
 
723
                    ' allow push to proceed.'),
 
 
725
    takes_args = ['location?']
 
 
726
    encoding_type = 'replace'
 
 
728
    def run(self, location=None, remember=False, overwrite=False,
 
 
729
            create_prefix=False, verbose=False, revision=None,
 
 
730
            use_existing_dir=False,
 
 
732
        # FIXME: Way too big!  Put this into a function called from the
 
 
734
        if directory is None:
 
 
736
        br_from = Branch.open_containing(directory)[0]
 
 
737
        stored_loc = br_from.get_push_location()
 
 
739
            if stored_loc is None:
 
 
740
                raise errors.BzrCommandError("No push location known or specified.")
 
 
742
                display_url = urlutils.unescape_for_display(stored_loc,
 
 
744
                self.outf.write("Using saved location: %s\n" % display_url)
 
 
745
                location = stored_loc
 
 
747
        to_transport = transport.get_transport(location)
 
 
749
        br_to = repository_to = dir_to = None
 
 
751
            dir_to = bzrdir.BzrDir.open_from_transport(to_transport)
 
 
752
        except errors.NotBranchError:
 
 
753
            pass # Didn't find anything
 
 
755
            # If we can open a branch, use its direct repository, otherwise see
 
 
756
            # if there is a repository without a branch.
 
 
758
                br_to = dir_to.open_branch()
 
 
759
            except errors.NotBranchError:
 
 
760
                # Didn't find a branch, can we find a repository?
 
 
762
                    repository_to = dir_to.find_repository()
 
 
763
                except errors.NoRepositoryPresent:
 
 
766
                # Found a branch, so we must have found a repository
 
 
767
                repository_to = br_to.repository
 
 
769
        if revision is not None:
 
 
770
            if len(revision) == 1:
 
 
771
                revision_id = revision[0].in_history(br_from).rev_id
 
 
773
                raise errors.BzrCommandError(
 
 
774
                    'bzr push --revision takes one value.')
 
 
776
            revision_id = br_from.last_revision()
 
 
782
            # The destination doesn't exist; create it.
 
 
783
            # XXX: Refactor the create_prefix/no_create_prefix code into a
 
 
784
            #      common helper function
 
 
786
            def make_directory(transport):
 
 
790
            def redirected(redirected_transport, e, redirection_notice):
 
 
791
                return transport.get_transport(e.get_target_url())
 
 
794
                to_transport = transport.do_catching_redirections(
 
 
795
                    make_directory, to_transport, redirected)
 
 
796
            except errors.FileExists:
 
 
797
                if not use_existing_dir:
 
 
798
                    raise errors.BzrCommandError("Target directory %s"
 
 
799
                         " already exists, but does not have a valid .bzr"
 
 
800
                         " directory. Supply --use-existing-dir to push"
 
 
801
                         " there anyway." % location)
 
 
802
            except errors.NoSuchFile:
 
 
803
                if not create_prefix:
 
 
804
                    raise errors.BzrCommandError("Parent directory of %s"
 
 
806
                        "\nYou may supply --create-prefix to create all"
 
 
807
                        " leading parent directories."
 
 
809
                _create_prefix(to_transport)
 
 
810
            except errors.TooManyRedirections:
 
 
811
                raise errors.BzrCommandError("Too many redirections trying "
 
 
812
                                             "to make %s." % location)
 
 
814
            # Now the target directory exists, but doesn't have a .bzr
 
 
815
            # directory. So we need to create it, along with any work to create
 
 
816
            # all of the dependent branches, etc.
 
 
817
            dir_to = br_from.bzrdir.clone_on_transport(to_transport,
 
 
818
                                                       revision_id=revision_id)
 
 
819
            br_to = dir_to.open_branch()
 
 
820
            # TODO: Some more useful message about what was copied
 
 
821
            note('Created new branch.')
 
 
822
            # We successfully created the target, remember it
 
 
823
            if br_from.get_push_location() is None or remember:
 
 
824
                br_from.set_push_location(br_to.base)
 
 
825
        elif repository_to is None:
 
 
826
            # we have a bzrdir but no branch or repository
 
 
827
            # XXX: Figure out what to do other than complain.
 
 
828
            raise errors.BzrCommandError("At %s you have a valid .bzr control"
 
 
829
                " directory, but not a branch or repository. This is an"
 
 
830
                " unsupported configuration. Please move the target directory"
 
 
831
                " out of the way and try again."
 
 
834
            # We have a repository but no branch, copy the revisions, and then
 
 
836
            repository_to.fetch(br_from.repository, revision_id=revision_id)
 
 
837
            br_to = br_from.clone(dir_to, revision_id=revision_id)
 
 
838
            note('Created new branch.')
 
 
839
            if br_from.get_push_location() is None or remember:
 
 
840
                br_from.set_push_location(br_to.base)
 
 
841
        else: # We have a valid to branch
 
 
842
            # We were able to connect to the remote location, so remember it
 
 
843
            # we don't need to successfully push because of possible divergence.
 
 
844
            if br_from.get_push_location() is None or remember:
 
 
845
                br_from.set_push_location(br_to.base)
 
 
847
                old_rh = br_to.revision_history()
 
 
850
                    tree_to = dir_to.open_workingtree()
 
 
851
                except errors.NotLocalUrl:
 
 
852
                    warning("This transport does not update the working " 
 
 
853
                            "tree of: %s. See 'bzr help working-trees' for "
 
 
854
                            "more information." % br_to.base)
 
 
855
                    push_result = br_from.push(br_to, overwrite,
 
 
856
                                               stop_revision=revision_id)
 
 
857
                except errors.NoWorkingTree:
 
 
858
                    push_result = br_from.push(br_to, overwrite,
 
 
859
                                               stop_revision=revision_id)
 
 
863
                        push_result = br_from.push(tree_to.branch, overwrite,
 
 
864
                                                   stop_revision=revision_id)
 
 
868
            except errors.DivergedBranches:
 
 
869
                raise errors.BzrCommandError('These branches have diverged.'
 
 
870
                                        '  Try using "merge" and then "push".')
 
 
871
        if push_result is not None:
 
 
872
            push_result.report(self.outf)
 
 
874
            new_rh = br_to.revision_history()
 
 
877
                from bzrlib.log import show_changed_revisions
 
 
878
                show_changed_revisions(br_to, old_rh, new_rh,
 
 
881
            # we probably did a clone rather than a push, so a message was
 
 
886
class cmd_branch(Command):
 
 
887
    """Create a new copy of a branch.
 
 
889
    If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
 
 
890
    be used.  In other words, "branch ../foo/bar" will attempt to create ./bar.
 
 
891
    If the FROM_LOCATION has no / or path separator embedded, the TO_LOCATION
 
 
892
    is derived from the FROM_LOCATION by stripping a leading scheme or drive
 
 
893
    identifier, if any. For example, "branch lp:foo-bar" will attempt to
 
 
896
    To retrieve the branch as of a particular revision, supply the --revision
 
 
897
    parameter, as in "branch foo/bar -r 5".
 
 
900
    _see_also = ['checkout']
 
 
901
    takes_args = ['from_location', 'to_location?']
 
 
902
    takes_options = ['revision', Option('hardlink',
 
 
903
        help='Hard-link working tree files where possible.')]
 
 
904
    aliases = ['get', 'clone']
 
 
906
    def run(self, from_location, to_location=None, revision=None,
 
 
908
        from bzrlib.tag import _merge_tags_if_possible
 
 
911
        elif len(revision) > 1:
 
 
912
            raise errors.BzrCommandError(
 
 
913
                'bzr branch --revision takes exactly 1 revision value')
 
 
915
        accelerator_tree, br_from = bzrdir.BzrDir.open_tree_or_branch(
 
 
919
            if len(revision) == 1 and revision[0] is not None:
 
 
920
                revision_id = revision[0].as_revision_id(br_from)
 
 
922
                # FIXME - wt.last_revision, fallback to branch, fall back to
 
 
923
                # None or perhaps NULL_REVISION to mean copy nothing
 
 
925
                revision_id = br_from.last_revision()
 
 
926
            if to_location is None:
 
 
927
                to_location = urlutils.derive_to_location(from_location)
 
 
928
            to_transport = transport.get_transport(to_location)
 
 
930
                to_transport.mkdir('.')
 
 
931
            except errors.FileExists:
 
 
932
                raise errors.BzrCommandError('Target directory "%s" already'
 
 
933
                                             ' exists.' % to_location)
 
 
934
            except errors.NoSuchFile:
 
 
935
                raise errors.BzrCommandError('Parent of "%s" does not exist.'
 
 
938
                # preserve whatever source format we have.
 
 
939
                dir = br_from.bzrdir.sprout(to_transport.base, revision_id,
 
 
940
                                            possible_transports=[to_transport],
 
 
941
                                            accelerator_tree=accelerator_tree,
 
 
943
                branch = dir.open_branch()
 
 
944
            except errors.NoSuchRevision:
 
 
945
                to_transport.delete_tree('.')
 
 
946
                msg = "The branch %s has no revision %s." % (from_location, revision[0])
 
 
947
                raise errors.BzrCommandError(msg)
 
 
948
            _merge_tags_if_possible(br_from, branch)
 
 
949
            note('Branched %d revision(s).' % branch.revno())
 
 
954
class cmd_checkout(Command):
 
 
955
    """Create a new checkout of an existing branch.
 
 
957
    If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
 
 
958
    the branch found in '.'. This is useful if you have removed the working tree
 
 
959
    or if it was never created - i.e. if you pushed the branch to its current
 
 
962
    If the TO_LOCATION is omitted, the last component of the BRANCH_LOCATION will
 
 
963
    be used.  In other words, "checkout ../foo/bar" will attempt to create ./bar.
 
 
964
    If the BRANCH_LOCATION has no / or path separator embedded, the TO_LOCATION
 
 
965
    is derived from the BRANCH_LOCATION by stripping a leading scheme or drive
 
 
966
    identifier, if any. For example, "checkout lp:foo-bar" will attempt to
 
 
969
    To retrieve the branch as of a particular revision, supply the --revision
 
 
970
    parameter, as in "checkout foo/bar -r 5". Note that this will be immediately
 
 
971
    out of date [so you cannot commit] but it may be useful (i.e. to examine old
 
 
975
    _see_also = ['checkouts', 'branch']
 
 
976
    takes_args = ['branch_location?', 'to_location?']
 
 
977
    takes_options = ['revision',
 
 
978
                     Option('lightweight',
 
 
979
                            help="Perform a lightweight checkout.  Lightweight "
 
 
980
                                 "checkouts depend on access to the branch for "
 
 
981
                                 "every operation.  Normal checkouts can perform "
 
 
982
                                 "common operations like diff and status without "
 
 
983
                                 "such access, and also support local commits."
 
 
985
                     Option('files-from', type=str,
 
 
986
                            help="Get file contents from this tree."),
 
 
988
                            help='Hard-link working tree files where possible.'
 
 
993
    def run(self, branch_location=None, to_location=None, revision=None,
 
 
994
            lightweight=False, files_from=None, hardlink=False):
 
 
997
        elif len(revision) > 1:
 
 
998
            raise errors.BzrCommandError(
 
 
999
                'bzr checkout --revision takes exactly 1 revision value')
 
 
1000
        if branch_location is None:
 
 
1001
            branch_location = osutils.getcwd()
 
 
1002
            to_location = branch_location
 
 
1003
        accelerator_tree, source = bzrdir.BzrDir.open_tree_or_branch(
 
 
1005
        if files_from is not None:
 
 
1006
            accelerator_tree = WorkingTree.open(files_from)
 
 
1007
        if len(revision) == 1 and revision[0] is not None:
 
 
1008
            revision_id = revision[0].as_revision_id(source)
 
 
1011
        if to_location is None:
 
 
1012
            to_location = urlutils.derive_to_location(branch_location)
 
 
1013
        # if the source and to_location are the same, 
 
 
1014
        # and there is no working tree,
 
 
1015
        # then reconstitute a branch
 
 
1016
        if (osutils.abspath(to_location) ==
 
 
1017
            osutils.abspath(branch_location)):
 
 
1019
                source.bzrdir.open_workingtree()
 
 
1020
            except errors.NoWorkingTree:
 
 
1021
                source.bzrdir.create_workingtree(revision_id)
 
 
1023
        source.create_checkout(to_location, revision_id, lightweight,
 
 
1024
                               accelerator_tree, hardlink)
 
 
1027
class cmd_renames(Command):
 
 
1028
    """Show list of renamed files.
 
 
1030
    # TODO: Option to show renames between two historical versions.
 
 
1032
    # TODO: Only show renames under dir, rather than in the whole branch.
 
 
1033
    _see_also = ['status']
 
 
1034
    takes_args = ['dir?']
 
 
1037
    def run(self, dir=u'.'):
 
 
1038
        tree = WorkingTree.open_containing(dir)[0]
 
 
1041
            new_inv = tree.inventory
 
 
1042
            old_tree = tree.basis_tree()
 
 
1043
            old_tree.lock_read()
 
 
1045
                old_inv = old_tree.inventory
 
 
1046
                renames = list(_mod_tree.find_renames(old_inv, new_inv))
 
 
1048
                for old_name, new_name in renames:
 
 
1049
                    self.outf.write("%s => %s\n" % (old_name, new_name))
 
 
1056
class cmd_update(Command):
 
 
1057
    """Update a tree to have the latest code committed to its branch.
 
 
1059
    This will perform a merge into the working tree, and may generate
 
 
1060
    conflicts. If you have any local changes, you will still 
 
 
1061
    need to commit them after the update for the update to be complete.
 
 
1063
    If you want to discard your local changes, you can just do a 
 
 
1064
    'bzr revert' instead of 'bzr commit' after the update.
 
 
1067
    _see_also = ['pull', 'working-trees', 'status-flags']
 
 
1068
    takes_args = ['dir?']
 
 
1071
    def run(self, dir='.'):
 
 
1072
        tree = WorkingTree.open_containing(dir)[0]
 
 
1073
        possible_transports = []
 
 
1074
        master = tree.branch.get_master_branch(
 
 
1075
            possible_transports=possible_transports)
 
 
1076
        if master is not None:
 
 
1079
            tree.lock_tree_write()
 
 
1081
            existing_pending_merges = tree.get_parent_ids()[1:]
 
 
1082
            last_rev = _mod_revision.ensure_null(tree.last_revision())
 
 
1083
            if last_rev == _mod_revision.ensure_null(
 
 
1084
                tree.branch.last_revision()):
 
 
1085
                # may be up to date, check master too.
 
 
1086
                if master is None or last_rev == _mod_revision.ensure_null(
 
 
1087
                    master.last_revision()):
 
 
1088
                    revno = tree.branch.revision_id_to_revno(last_rev)
 
 
1089
                    note("Tree is up to date at revision %d." % (revno,))
 
 
1091
            conflicts = tree.update(
 
 
1092
                delta._ChangeReporter(unversioned_filter=tree.is_ignored),
 
 
1093
                possible_transports=possible_transports)
 
 
1094
            revno = tree.branch.revision_id_to_revno(
 
 
1095
                _mod_revision.ensure_null(tree.last_revision()))
 
 
1096
            note('Updated to revision %d.' % (revno,))
 
 
1097
            if tree.get_parent_ids()[1:] != existing_pending_merges:
 
 
1098
                note('Your local commits will now show as pending merges with '
 
 
1099
                     "'bzr status', and can be committed with 'bzr commit'.")
 
 
1108
class cmd_info(Command):
 
 
1109
    """Show information about a working tree, branch or repository.
 
 
1111
    This command will show all known locations and formats associated to the
 
 
1112
    tree, branch or repository.  Statistical information is included with
 
 
1115
    Branches and working trees will also report any missing revisions.
 
 
1117
    _see_also = ['revno', 'working-trees', 'repositories']
 
 
1118
    takes_args = ['location?']
 
 
1119
    takes_options = ['verbose']
 
 
1120
    encoding_type = 'replace'
 
 
1123
    def run(self, location=None, verbose=False):
 
 
1128
        from bzrlib.info import show_bzrdir_info
 
 
1129
        show_bzrdir_info(bzrdir.BzrDir.open_containing(location)[0],
 
 
1130
                         verbose=noise_level, outfile=self.outf)
 
 
1133
class cmd_remove(Command):
 
 
1134
    """Remove files or directories.
 
 
1136
    This makes bzr stop tracking changes to the specified files and
 
 
1137
    delete them if they can easily be recovered using revert.
 
 
1139
    You can specify one or more files, and/or --new.  If you specify --new,
 
 
1140
    only 'added' files will be removed.  If you specify both, then new files
 
 
1141
    in the specified directories will be removed.  If the directories are
 
 
1142
    also new, they will also be removed.
 
 
1144
    takes_args = ['file*']
 
 
1145
    takes_options = ['verbose',
 
 
1146
        Option('new', help='Remove newly-added files.'),
 
 
1147
        RegistryOption.from_kwargs('file-deletion-strategy',
 
 
1148
            'The file deletion mode to be used.',
 
 
1149
            title='Deletion Strategy', value_switches=True, enum_switch=False,
 
 
1150
            safe='Only delete files if they can be'
 
 
1151
                 ' safely recovered (default).',
 
 
1152
            keep="Don't delete any files.",
 
 
1153
            force='Delete all the specified files, even if they can not be '
 
 
1154
                'recovered and even if they are non-empty directories.')]
 
 
1156
    encoding_type = 'replace'
 
 
1158
    def run(self, file_list, verbose=False, new=False,
 
 
1159
        file_deletion_strategy='safe'):
 
 
1160
        tree, file_list = tree_files(file_list)
 
 
1162
        if file_list is not None:
 
 
1163
            file_list = [f for f in file_list]
 
 
1165
            raise errors.BzrCommandError('Specify one or more files to'
 
 
1166
            ' remove, or use --new.')
 
 
1169
            added = tree.changes_from(tree.basis_tree(),
 
 
1170
                specific_files=file_list).added
 
 
1171
            file_list = sorted([f[0] for f in added], reverse=True)
 
 
1172
            if len(file_list) == 0:
 
 
1173
                raise errors.BzrCommandError('No matching files.')
 
 
1174
        tree.remove(file_list, verbose=verbose, to_file=self.outf,
 
 
1175
            keep_files=file_deletion_strategy=='keep',
 
 
1176
            force=file_deletion_strategy=='force')
 
 
1179
class cmd_file_id(Command):
 
 
1180
    """Print file_id of a particular file or directory.
 
 
1182
    The file_id is assigned when the file is first added and remains the
 
 
1183
    same through all revisions where the file exists, even when it is
 
 
1188
    _see_also = ['inventory', 'ls']
 
 
1189
    takes_args = ['filename']
 
 
1192
    def run(self, filename):
 
 
1193
        tree, relpath = WorkingTree.open_containing(filename)
 
 
1194
        i = tree.path2id(relpath)
 
 
1196
            raise errors.NotVersionedError(filename)
 
 
1198
            self.outf.write(i + '\n')
 
 
1201
class cmd_file_path(Command):
 
 
1202
    """Print path of file_ids to a file or directory.
 
 
1204
    This prints one line for each directory down to the target,
 
 
1205
    starting at the branch root.
 
 
1209
    takes_args = ['filename']
 
 
1212
    def run(self, filename):
 
 
1213
        tree, relpath = WorkingTree.open_containing(filename)
 
 
1214
        fid = tree.path2id(relpath)
 
 
1216
            raise errors.NotVersionedError(filename)
 
 
1217
        segments = osutils.splitpath(relpath)
 
 
1218
        for pos in range(1, len(segments) + 1):
 
 
1219
            path = osutils.joinpath(segments[:pos])
 
 
1220
            self.outf.write("%s\n" % tree.path2id(path))
 
 
1223
class cmd_reconcile(Command):
 
 
1224
    """Reconcile bzr metadata in a branch.
 
 
1226
    This can correct data mismatches that may have been caused by
 
 
1227
    previous ghost operations or bzr upgrades. You should only
 
 
1228
    need to run this command if 'bzr check' or a bzr developer 
 
 
1229
    advises you to run it.
 
 
1231
    If a second branch is provided, cross-branch reconciliation is
 
 
1232
    also attempted, which will check that data like the tree root
 
 
1233
    id which was not present in very early bzr versions is represented
 
 
1234
    correctly in both branches.
 
 
1236
    At the same time it is run it may recompress data resulting in 
 
 
1237
    a potential saving in disk space or performance gain.
 
 
1239
    The branch *MUST* be on a listable system such as local disk or sftp.
 
 
1242
    _see_also = ['check']
 
 
1243
    takes_args = ['branch?']
 
 
1245
    def run(self, branch="."):
 
 
1246
        from bzrlib.reconcile import reconcile
 
 
1247
        dir = bzrdir.BzrDir.open(branch)
 
 
1251
class cmd_revision_history(Command):
 
 
1252
    """Display the list of revision ids on a branch."""
 
 
1255
    takes_args = ['location?']
 
 
1260
    def run(self, location="."):
 
 
1261
        branch = Branch.open_containing(location)[0]
 
 
1262
        for revid in branch.revision_history():
 
 
1263
            self.outf.write(revid)
 
 
1264
            self.outf.write('\n')
 
 
1267
class cmd_ancestry(Command):
 
 
1268
    """List all revisions merged into this branch."""
 
 
1270
    _see_also = ['log', 'revision-history']
 
 
1271
    takes_args = ['location?']
 
 
1276
    def run(self, location="."):
 
 
1278
            wt = WorkingTree.open_containing(location)[0]
 
 
1279
        except errors.NoWorkingTree:
 
 
1280
            b = Branch.open(location)
 
 
1281
            last_revision = b.last_revision()
 
 
1284
            last_revision = wt.last_revision()
 
 
1286
        revision_ids = b.repository.get_ancestry(last_revision)
 
 
1288
        for revision_id in revision_ids:
 
 
1289
            self.outf.write(revision_id + '\n')
 
 
1292
class cmd_init(Command):
 
 
1293
    """Make a directory into a versioned branch.
 
 
1295
    Use this to create an empty branch, or before importing an
 
 
1298
    If there is a repository in a parent directory of the location, then 
 
 
1299
    the history of the branch will be stored in the repository.  Otherwise
 
 
1300
    init creates a standalone branch which carries its own history
 
 
1301
    in the .bzr directory.
 
 
1303
    If there is already a branch at the location but it has no working tree,
 
 
1304
    the tree can be populated with 'bzr checkout'.
 
 
1306
    Recipe for importing a tree of files::
 
 
1312
        bzr commit -m "imported project"
 
 
1315
    _see_also = ['init-repository', 'branch', 'checkout']
 
 
1316
    takes_args = ['location?']
 
 
1318
        Option('create-prefix',
 
 
1319
               help='Create the path leading up to the branch '
 
 
1320
                    'if it does not already exist.'),
 
 
1321
         RegistryOption('format',
 
 
1322
                help='Specify a format for this branch. '
 
 
1323
                'See "help formats".',
 
 
1324
                registry=bzrdir.format_registry,
 
 
1325
                converter=bzrdir.format_registry.make_bzrdir,
 
 
1326
                value_switches=True,
 
 
1327
                title="Branch Format",
 
 
1329
         Option('append-revisions-only',
 
 
1330
                help='Never change revnos or the existing log.'
 
 
1331
                '  Append revisions to it only.')
 
 
1333
    def run(self, location=None, format=None, append_revisions_only=False,
 
 
1334
            create_prefix=False):
 
 
1336
            format = bzrdir.format_registry.make_bzrdir('default')
 
 
1337
        if location is None:
 
 
1340
        to_transport = transport.get_transport(location)
 
 
1342
        # The path has to exist to initialize a
 
 
1343
        # branch inside of it.
 
 
1344
        # Just using os.mkdir, since I don't
 
 
1345
        # believe that we want to create a bunch of
 
 
1346
        # locations if the user supplies an extended path
 
 
1348
            to_transport.ensure_base()
 
 
1349
        except errors.NoSuchFile:
 
 
1350
            if not create_prefix:
 
 
1351
                raise errors.BzrCommandError("Parent directory of %s"
 
 
1353
                    "\nYou may supply --create-prefix to create all"
 
 
1354
                    " leading parent directories."
 
 
1356
            _create_prefix(to_transport)
 
 
1359
            existing_bzrdir = bzrdir.BzrDir.open_from_transport(to_transport)
 
 
1360
        except errors.NotBranchError:
 
 
1361
            # really a NotBzrDir error...
 
 
1362
            create_branch = bzrdir.BzrDir.create_branch_convenience
 
 
1363
            branch = create_branch(to_transport.base, format=format,
 
 
1364
                                   possible_transports=[to_transport])
 
 
1366
            from bzrlib.transport.local import LocalTransport
 
 
1367
            if existing_bzrdir.has_branch():
 
 
1368
                if (isinstance(to_transport, LocalTransport)
 
 
1369
                    and not existing_bzrdir.has_workingtree()):
 
 
1370
                        raise errors.BranchExistsWithoutWorkingTree(location)
 
 
1371
                raise errors.AlreadyBranchError(location)
 
 
1373
                branch = existing_bzrdir.create_branch()
 
 
1374
                existing_bzrdir.create_workingtree()
 
 
1375
        if append_revisions_only:
 
 
1377
                branch.set_append_revisions_only(True)
 
 
1378
            except errors.UpgradeRequired:
 
 
1379
                raise errors.BzrCommandError('This branch format cannot be set'
 
 
1380
                    ' to append-revisions-only.  Try --experimental-branch6')
 
 
1383
class cmd_init_repository(Command):
 
 
1384
    """Create a shared repository to hold branches.
 
 
1386
    New branches created under the repository directory will store their
 
 
1387
    revisions in the repository, not in the branch directory.
 
 
1389
    If the --no-trees option is used then the branches in the repository
 
 
1390
    will not have working trees by default.
 
 
1393
        Create a shared repositories holding just branches::
 
 
1395
            bzr init-repo --no-trees repo
 
 
1398
        Make a lightweight checkout elsewhere::
 
 
1400
            bzr checkout --lightweight repo/trunk trunk-checkout
 
 
1405
    _see_also = ['init', 'branch', 'checkout', 'repositories']
 
 
1406
    takes_args = ["location"]
 
 
1407
    takes_options = [RegistryOption('format',
 
 
1408
                            help='Specify a format for this repository. See'
 
 
1409
                                 ' "bzr help formats" for details.',
 
 
1410
                            registry=bzrdir.format_registry,
 
 
1411
                            converter=bzrdir.format_registry.make_bzrdir,
 
 
1412
                            value_switches=True, title='Repository format'),
 
 
1414
                             help='Branches in the repository will default to'
 
 
1415
                                  ' not having a working tree.'),
 
 
1417
    aliases = ["init-repo"]
 
 
1419
    def run(self, location, format=None, no_trees=False):
 
 
1421
            format = bzrdir.format_registry.make_bzrdir('default')
 
 
1423
        if location is None:
 
 
1426
        to_transport = transport.get_transport(location)
 
 
1427
        to_transport.ensure_base()
 
 
1429
        newdir = format.initialize_on_transport(to_transport)
 
 
1430
        repo = newdir.create_repository(shared=True)
 
 
1431
        repo.set_make_working_trees(not no_trees)
 
 
1434
class cmd_diff(Command):
 
 
1435
    """Show differences in the working tree, between revisions or branches.
 
 
1437
    If no arguments are given, all changes for the current tree are listed.
 
 
1438
    If files are given, only the changes in those files are listed.
 
 
1439
    Remote and multiple branches can be compared by using the --old and
 
 
1440
    --new options. If not provided, the default for both is derived from
 
 
1441
    the first argument, if any, or the current tree if no arguments are
 
 
1444
    "bzr diff -p1" is equivalent to "bzr diff --prefix old/:new/", and
 
 
1445
    produces patches suitable for "patch -p1".
 
 
1449
        2 - unrepresentable changes
 
 
1454
        Shows the difference in the working tree versus the last commit::
 
 
1458
        Difference between the working tree and revision 1::
 
 
1462
        Difference between revision 2 and revision 1::
 
 
1466
        Difference between revision 2 and revision 1 for branch xxx::
 
 
1470
        Show just the differences for file NEWS::
 
 
1474
        Show the differences in working tree xxx for file NEWS::
 
 
1478
        Show the differences from branch xxx to this working tree:
 
 
1482
        Show the differences between two branches for file NEWS::
 
 
1484
            bzr diff --old xxx --new yyy NEWS
 
 
1486
        Same as 'bzr diff' but prefix paths with old/ and new/::
 
 
1488
            bzr diff --prefix old/:new/
 
 
1490
    _see_also = ['status']
 
 
1491
    takes_args = ['file*']
 
 
1493
        Option('diff-options', type=str,
 
 
1494
               help='Pass these options to the external diff program.'),
 
 
1495
        Option('prefix', type=str,
 
 
1497
               help='Set prefixes added to old and new filenames, as '
 
 
1498
                    'two values separated by a colon. (eg "old/:new/").'),
 
 
1500
            help='Branch/tree to compare from.',
 
 
1504
            help='Branch/tree to compare to.',
 
 
1510
            help='Use this command to compare files.',
 
 
1514
    aliases = ['di', 'dif']
 
 
1515
    encoding_type = 'exact'
 
 
1518
    def run(self, revision=None, file_list=None, diff_options=None,
 
 
1519
            prefix=None, old=None, new=None, using=None):
 
 
1520
        from bzrlib.diff import _get_trees_to_diff, show_diff_trees
 
 
1522
        if (prefix is None) or (prefix == '0'):
 
 
1530
            old_label, new_label = prefix.split(":")
 
 
1532
            raise errors.BzrCommandError(
 
 
1533
                '--prefix expects two values separated by a colon'
 
 
1534
                ' (eg "old/:new/")')
 
 
1536
        if revision and len(revision) > 2:
 
 
1537
            raise errors.BzrCommandError('bzr diff --revision takes exactly'
 
 
1538
                                         ' one or two revision specifiers')
 
 
1540
        old_tree, new_tree, specific_files, extra_trees = \
 
 
1541
                _get_trees_to_diff(file_list, revision, old, new)
 
 
1542
        return show_diff_trees(old_tree, new_tree, sys.stdout, 
 
 
1543
                               specific_files=specific_files,
 
 
1544
                               external_diff_options=diff_options,
 
 
1545
                               old_label=old_label, new_label=new_label,
 
 
1546
                               extra_trees=extra_trees, using=using)
 
 
1549
class cmd_deleted(Command):
 
 
1550
    """List files deleted in the working tree.
 
 
1552
    # TODO: Show files deleted since a previous revision, or
 
 
1553
    # between two revisions.
 
 
1554
    # TODO: Much more efficient way to do this: read in new
 
 
1555
    # directories with readdir, rather than stating each one.  Same
 
 
1556
    # level of effort but possibly much less IO.  (Or possibly not,
 
 
1557
    # if the directories are very large...)
 
 
1558
    _see_also = ['status', 'ls']
 
 
1559
    takes_options = ['show-ids']
 
 
1562
    def run(self, show_ids=False):
 
 
1563
        tree = WorkingTree.open_containing(u'.')[0]
 
 
1566
            old = tree.basis_tree()
 
 
1569
                for path, ie in old.inventory.iter_entries():
 
 
1570
                    if not tree.has_id(ie.file_id):
 
 
1571
                        self.outf.write(path)
 
 
1573
                            self.outf.write(' ')
 
 
1574
                            self.outf.write(ie.file_id)
 
 
1575
                        self.outf.write('\n')
 
 
1582
class cmd_modified(Command):
 
 
1583
    """List files modified in working tree.
 
 
1587
    _see_also = ['status', 'ls']
 
 
1590
                   help='Write an ascii NUL (\\0) separator '
 
 
1591
                   'between files rather than a newline.')
 
 
1595
    def run(self, null=False):
 
 
1596
        tree = WorkingTree.open_containing(u'.')[0]
 
 
1597
        td = tree.changes_from(tree.basis_tree())
 
 
1598
        for path, id, kind, text_modified, meta_modified in td.modified:
 
 
1600
                self.outf.write(path + '\0')
 
 
1602
                self.outf.write(osutils.quotefn(path) + '\n')
 
 
1605
class cmd_added(Command):
 
 
1606
    """List files added in working tree.
 
 
1610
    _see_also = ['status', 'ls']
 
 
1613
                   help='Write an ascii NUL (\\0) separator '
 
 
1614
                   'between files rather than a newline.')
 
 
1618
    def run(self, null=False):
 
 
1619
        wt = WorkingTree.open_containing(u'.')[0]
 
 
1622
            basis = wt.basis_tree()
 
 
1625
                basis_inv = basis.inventory
 
 
1628
                    if file_id in basis_inv:
 
 
1630
                    if inv.is_root(file_id) and len(basis_inv) == 0:
 
 
1632
                    path = inv.id2path(file_id)
 
 
1633
                    if not os.access(osutils.abspath(path), os.F_OK):
 
 
1636
                        self.outf.write(path + '\0')
 
 
1638
                        self.outf.write(osutils.quotefn(path) + '\n')
 
 
1645
class cmd_root(Command):
 
 
1646
    """Show the tree root directory.
 
 
1648
    The root is the nearest enclosing directory with a .bzr control
 
 
1651
    takes_args = ['filename?']
 
 
1653
    def run(self, filename=None):
 
 
1654
        """Print the branch root."""
 
 
1655
        tree = WorkingTree.open_containing(filename)[0]
 
 
1656
        self.outf.write(tree.basedir + '\n')
 
 
1659
def _parse_limit(limitstring):
 
 
1661
        return int(limitstring)
 
 
1663
        msg = "The limit argument must be an integer."
 
 
1664
        raise errors.BzrCommandError(msg)
 
 
1667
class cmd_log(Command):
 
 
1668
    """Show log of a branch, file, or directory.
 
 
1670
    By default show the log of the branch containing the working directory.
 
 
1672
    To request a range of logs, you can use the command -r begin..end
 
 
1673
    -r revision requests a specific revision, -r ..end or -r begin.. are
 
 
1677
        Log the current branch::
 
 
1685
        Log the last 10 revisions of a branch::
 
 
1687
            bzr log -r -10.. http://server/branch
 
 
1690
    # TODO: Make --revision support uuid: and hash: [future tag:] notation.
 
 
1692
    takes_args = ['location?']
 
 
1695
                   help='Show from oldest to newest.'),
 
 
1698
                   help='Display timezone as local, original, or utc.'),
 
 
1699
            custom_help('verbose',
 
 
1700
                   help='Show files changed in each revision.'),
 
 
1706
                   help='Show revisions whose message matches this '
 
 
1707
                        'regular expression.',
 
 
1711
                   help='Limit the output to the first N revisions.',
 
 
1715
    encoding_type = 'replace'
 
 
1718
    def run(self, location=None, timezone='original',
 
 
1726
        from bzrlib.log import show_log
 
 
1727
        direction = (forward and 'forward') or 'reverse'
 
 
1732
            # find the file id to log:
 
 
1734
            tree, b, fp = bzrdir.BzrDir.open_containing_tree_or_branch(
 
 
1738
                    tree = b.basis_tree()
 
 
1739
                file_id = tree.path2id(fp)
 
 
1741
                    raise errors.BzrCommandError(
 
 
1742
                        "Path does not have any revision history: %s" %
 
 
1746
            # FIXME ? log the current subdir only RBC 20060203 
 
 
1747
            if revision is not None \
 
 
1748
                    and len(revision) > 0 and revision[0].get_branch():
 
 
1749
                location = revision[0].get_branch()
 
 
1752
            dir, relpath = bzrdir.BzrDir.open_containing(location)
 
 
1753
            b = dir.open_branch()
 
 
1757
            if revision is None:
 
 
1760
            elif len(revision) == 1:
 
 
1761
                rev1 = rev2 = revision[0].in_history(b)
 
 
1762
            elif len(revision) == 2:
 
 
1763
                if revision[1].get_branch() != revision[0].get_branch():
 
 
1764
                    # b is taken from revision[0].get_branch(), and
 
 
1765
                    # show_log will use its revision_history. Having
 
 
1766
                    # different branches will lead to weird behaviors.
 
 
1767
                    raise errors.BzrCommandError(
 
 
1768
                        "Log doesn't accept two revisions in different"
 
 
1770
                rev1 = revision[0].in_history(b)
 
 
1771
                rev2 = revision[1].in_history(b)
 
 
1773
                raise errors.BzrCommandError(
 
 
1774
                    'bzr log --revision takes one or two values.')
 
 
1776
            if log_format is None:
 
 
1777
                log_format = log.log_formatter_registry.get_default(b)
 
 
1779
            lf = log_format(show_ids=show_ids, to_file=self.outf,
 
 
1780
                            show_timezone=timezone)
 
 
1786
                     direction=direction,
 
 
1787
                     start_revision=rev1,
 
 
1795
def get_log_format(long=False, short=False, line=False, default='long'):
 
 
1796
    log_format = default
 
 
1800
        log_format = 'short'
 
 
1806
class cmd_touching_revisions(Command):
 
 
1807
    """Return revision-ids which affected a particular file.
 
 
1809
    A more user-friendly interface is "bzr log FILE".
 
 
1813
    takes_args = ["filename"]
 
 
1816
    def run(self, filename):
 
 
1817
        tree, relpath = WorkingTree.open_containing(filename)
 
 
1819
        file_id = tree.path2id(relpath)
 
 
1820
        for revno, revision_id, what in log.find_touching_revisions(b, file_id):
 
 
1821
            self.outf.write("%6d %s\n" % (revno, what))
 
 
1824
class cmd_ls(Command):
 
 
1825
    """List files in a tree.
 
 
1828
    _see_also = ['status', 'cat']
 
 
1829
    takes_args = ['path?']
 
 
1830
    # TODO: Take a revision or remote path and list that tree instead.
 
 
1834
            Option('non-recursive',
 
 
1835
                   help='Don\'t recurse into subdirectories.'),
 
 
1837
                   help='Print paths relative to the root of the branch.'),
 
 
1838
            Option('unknown', help='Print unknown files.'),
 
 
1839
            Option('versioned', help='Print versioned files.',
 
 
1841
            Option('ignored', help='Print ignored files.'),
 
 
1843
                   help='Write an ascii NUL (\\0) separator '
 
 
1844
                   'between files rather than a newline.'),
 
 
1846
                   help='List entries of a particular kind: file, directory, symlink.',
 
 
1851
    def run(self, revision=None, verbose=False,
 
 
1852
            non_recursive=False, from_root=False,
 
 
1853
            unknown=False, versioned=False, ignored=False,
 
 
1854
            null=False, kind=None, show_ids=False, path=None):
 
 
1856
        if kind and kind not in ('file', 'directory', 'symlink'):
 
 
1857
            raise errors.BzrCommandError('invalid kind specified')
 
 
1859
        if verbose and null:
 
 
1860
            raise errors.BzrCommandError('Cannot set both --verbose and --null')
 
 
1861
        all = not (unknown or versioned or ignored)
 
 
1863
        selection = {'I':ignored, '?':unknown, 'V':versioned}
 
 
1870
                raise errors.BzrCommandError('cannot specify both --from-root'
 
 
1874
        tree, branch, relpath = bzrdir.BzrDir.open_containing_tree_or_branch(
 
 
1880
        if revision is not None:
 
 
1881
            tree = branch.repository.revision_tree(
 
 
1882
                revision[0].as_revision_id(branch))
 
 
1884
            tree = branch.basis_tree()
 
 
1888
            for fp, fc, fkind, fid, entry in tree.list_files(include_root=False):
 
 
1889
                if fp.startswith(relpath):
 
 
1890
                    fp = osutils.pathjoin(prefix, fp[len(relpath):])
 
 
1891
                    if non_recursive and '/' in fp:
 
 
1893
                    if not all and not selection[fc]:
 
 
1895
                    if kind is not None and fkind != kind:
 
 
1898
                        kindch = entry.kind_character()
 
 
1899
                        outstring = '%-8s %s%s' % (fc, fp, kindch)
 
 
1900
                        if show_ids and fid is not None:
 
 
1901
                            outstring = "%-50s %s" % (outstring, fid)
 
 
1902
                        self.outf.write(outstring + '\n')
 
 
1904
                        self.outf.write(fp + '\0')
 
 
1907
                                self.outf.write(fid)
 
 
1908
                            self.outf.write('\0')
 
 
1916
                            self.outf.write('%-50s %s\n' % (fp, my_id))
 
 
1918
                            self.outf.write(fp + '\n')
 
 
1923
class cmd_unknowns(Command):
 
 
1924
    """List unknown files.
 
 
1932
        for f in WorkingTree.open_containing(u'.')[0].unknowns():
 
 
1933
            self.outf.write(osutils.quotefn(f) + '\n')
 
 
1936
class cmd_ignore(Command):
 
 
1937
    """Ignore specified files or patterns.
 
 
1939
    To remove patterns from the ignore list, edit the .bzrignore file.
 
 
1941
    Trailing slashes on patterns are ignored. 
 
 
1942
    If the pattern contains a slash or is a regular expression, it is compared 
 
 
1943
    to the whole path from the branch root.  Otherwise, it is compared to only
 
 
1944
    the last component of the path.  To match a file only in the root 
 
 
1945
    directory, prepend './'.
 
 
1947
    Ignore patterns specifying absolute paths are not allowed.
 
 
1949
    Ignore patterns may include globbing wildcards such as::
 
 
1951
      ? - Matches any single character except '/'
 
 
1952
      * - Matches 0 or more characters except '/'
 
 
1953
      /**/ - Matches 0 or more directories in a path
 
 
1954
      [a-z] - Matches a single character from within a group of characters
 
 
1956
    Ignore patterns may also be Python regular expressions.  
 
 
1957
    Regular expression ignore patterns are identified by a 'RE:' prefix 
 
 
1958
    followed by the regular expression.  Regular expression ignore patterns
 
 
1959
    may not include named or numbered groups.
 
 
1961
    Note: ignore patterns containing shell wildcards must be quoted from 
 
 
1965
        Ignore the top level Makefile::
 
 
1967
            bzr ignore ./Makefile
 
 
1969
        Ignore class files in all directories::
 
 
1971
            bzr ignore "*.class"
 
 
1973
        Ignore .o files under the lib directory::
 
 
1975
            bzr ignore "lib/**/*.o"
 
 
1977
        Ignore .o files under the lib directory::
 
 
1979
            bzr ignore "RE:lib/.*\.o"
 
 
1981
        Ignore everything but the "debian" toplevel directory::
 
 
1983
            bzr ignore "RE:(?!debian/).*"
 
 
1986
    _see_also = ['status', 'ignored']
 
 
1987
    takes_args = ['name_pattern*']
 
 
1989
        Option('old-default-rules',
 
 
1990
               help='Write out the ignore rules bzr < 0.9 always used.')
 
 
1993
    def run(self, name_pattern_list=None, old_default_rules=None):
 
 
1994
        from bzrlib.atomicfile import AtomicFile
 
 
1995
        if old_default_rules is not None:
 
 
1996
            # dump the rules and exit
 
 
1997
            for pattern in ignores.OLD_DEFAULTS:
 
 
2000
        if not name_pattern_list:
 
 
2001
            raise errors.BzrCommandError("ignore requires at least one "
 
 
2002
                                  "NAME_PATTERN or --old-default-rules")
 
 
2003
        name_pattern_list = [globbing.normalize_pattern(p) 
 
 
2004
                             for p in name_pattern_list]
 
 
2005
        for name_pattern in name_pattern_list:
 
 
2006
            if (name_pattern[0] == '/' or 
 
 
2007
                (len(name_pattern) > 1 and name_pattern[1] == ':')):
 
 
2008
                raise errors.BzrCommandError(
 
 
2009
                    "NAME_PATTERN should not be an absolute path")
 
 
2010
        tree, relpath = WorkingTree.open_containing(u'.')
 
 
2011
        ifn = tree.abspath('.bzrignore')
 
 
2012
        if os.path.exists(ifn):
 
 
2015
                igns = f.read().decode('utf-8')
 
 
2021
        # TODO: If the file already uses crlf-style termination, maybe
 
 
2022
        # we should use that for the newly added lines?
 
 
2024
        if igns and igns[-1] != '\n':
 
 
2026
        for name_pattern in name_pattern_list:
 
 
2027
            igns += name_pattern + '\n'
 
 
2029
        f = AtomicFile(ifn, 'wb')
 
 
2031
            f.write(igns.encode('utf-8'))
 
 
2036
        if not tree.path2id('.bzrignore'):
 
 
2037
            tree.add(['.bzrignore'])
 
 
2039
        ignored = globbing.Globster(name_pattern_list)
 
 
2042
        for entry in tree.list_files():
 
 
2046
                if ignored.match(filename):
 
 
2047
                    matches.append(filename.encode('utf-8'))
 
 
2049
        if len(matches) > 0:
 
 
2050
            print "Warning: the following files are version controlled and" \
 
 
2051
                  " match your ignore pattern:\n%s" % ("\n".join(matches),)
 
 
2053
class cmd_ignored(Command):
 
 
2054
    """List ignored files and the patterns that matched them.
 
 
2057
    encoding_type = 'replace'
 
 
2058
    _see_also = ['ignore']
 
 
2062
        tree = WorkingTree.open_containing(u'.')[0]
 
 
2065
            for path, file_class, kind, file_id, entry in tree.list_files():
 
 
2066
                if file_class != 'I':
 
 
2068
                ## XXX: Slightly inefficient since this was already calculated
 
 
2069
                pat = tree.is_ignored(path)
 
 
2070
                self.outf.write('%-50s %s\n' % (path, pat))
 
 
2075
class cmd_lookup_revision(Command):
 
 
2076
    """Lookup the revision-id from a revision-number
 
 
2079
        bzr lookup-revision 33
 
 
2082
    takes_args = ['revno']
 
 
2085
    def run(self, revno):
 
 
2089
            raise errors.BzrCommandError("not a valid revision-number: %r" % revno)
 
 
2091
        print WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
 
 
2094
class cmd_export(Command):
 
 
2095
    """Export current or past revision to a destination directory or archive.
 
 
2097
    If no revision is specified this exports the last committed revision.
 
 
2099
    Format may be an "exporter" name, such as tar, tgz, tbz2.  If none is
 
 
2100
    given, try to find the format with the extension. If no extension
 
 
2101
    is found exports to a directory (equivalent to --format=dir).
 
 
2103
    If root is supplied, it will be used as the root directory inside
 
 
2104
    container formats (tar, zip, etc). If it is not supplied it will default
 
 
2105
    to the exported filename. The root option has no effect for 'dir' format.
 
 
2107
    If branch is omitted then the branch containing the current working
 
 
2108
    directory will be used.
 
 
2110
    Note: Export of tree with non-ASCII filenames to zip is not supported.
 
 
2112
      =================       =========================
 
 
2113
      Supported formats       Autodetected by extension
 
 
2114
      =================       =========================
 
 
2117
         tbz2                    .tar.bz2, .tbz2
 
 
2120
      =================       =========================
 
 
2122
    takes_args = ['dest', 'branch?']
 
 
2125
               help="Type of file to export to.",
 
 
2130
               help="Name of the root directory inside the exported file."),
 
 
2132
    def run(self, dest, branch=None, revision=None, format=None, root=None):
 
 
2133
        from bzrlib.export import export
 
 
2136
            tree = WorkingTree.open_containing(u'.')[0]
 
 
2139
            b = Branch.open(branch)
 
 
2141
        if revision is None:
 
 
2142
            # should be tree.last_revision  FIXME
 
 
2143
            rev_id = b.last_revision()
 
 
2145
            if len(revision) != 1:
 
 
2146
                raise errors.BzrCommandError('bzr export --revision takes exactly 1 argument')
 
 
2147
            rev_id = revision[0].as_revision_id(b)
 
 
2148
        t = b.repository.revision_tree(rev_id)
 
 
2150
            export(t, dest, format, root)
 
 
2151
        except errors.NoSuchExportFormat, e:
 
 
2152
            raise errors.BzrCommandError('Unsupported export format: %s' % e.format)
 
 
2155
class cmd_cat(Command):
 
 
2156
    """Write the contents of a file as of a given revision to standard output.
 
 
2158
    If no revision is nominated, the last revision is used.
 
 
2160
    Note: Take care to redirect standard output when using this command on a
 
 
2166
        Option('name-from-revision', help='The path name in the old tree.'),
 
 
2169
    takes_args = ['filename']
 
 
2170
    encoding_type = 'exact'
 
 
2173
    def run(self, filename, revision=None, name_from_revision=False):
 
 
2174
        if revision is not None and len(revision) != 1:
 
 
2175
            raise errors.BzrCommandError("bzr cat --revision takes exactly"
 
 
2176
                                         " one revision specifier")
 
 
2177
        tree, branch, relpath = \
 
 
2178
            bzrdir.BzrDir.open_containing_tree_or_branch(filename)
 
 
2181
            return self._run(tree, branch, relpath, filename, revision,
 
 
2186
    def _run(self, tree, b, relpath, filename, revision, name_from_revision):
 
 
2188
            tree = b.basis_tree()
 
 
2189
        if revision is None:
 
 
2190
            revision_id = b.last_revision()
 
 
2192
            revision_id = revision[0].as_revision_id(b)
 
 
2194
        cur_file_id = tree.path2id(relpath)
 
 
2195
        rev_tree = b.repository.revision_tree(revision_id)
 
 
2196
        old_file_id = rev_tree.path2id(relpath)
 
 
2198
        if name_from_revision:
 
 
2199
            if old_file_id is None:
 
 
2200
                raise errors.BzrCommandError("%r is not present in revision %s"
 
 
2201
                                                % (filename, revision_id))
 
 
2203
                content = rev_tree.get_file_text(old_file_id)
 
 
2204
        elif cur_file_id is not None:
 
 
2205
            content = rev_tree.get_file_text(cur_file_id)
 
 
2206
        elif old_file_id is not None:
 
 
2207
            content = rev_tree.get_file_text(old_file_id)
 
 
2209
            raise errors.BzrCommandError("%r is not present in revision %s" %
 
 
2210
                                         (filename, revision_id))
 
 
2211
        self.outf.write(content)
 
 
2214
class cmd_local_time_offset(Command):
 
 
2215
    """Show the offset in seconds from GMT to local time."""
 
 
2219
        print osutils.local_time_offset()
 
 
2223
class cmd_commit(Command):
 
 
2224
    """Commit changes into a new revision.
 
 
2226
    If no arguments are given, the entire tree is committed.
 
 
2228
    If selected files are specified, only changes to those files are
 
 
2229
    committed.  If a directory is specified then the directory and everything 
 
 
2230
    within it is committed.
 
 
2232
    If author of the change is not the same person as the committer, you can
 
 
2233
    specify the author's name using the --author option. The name should be
 
 
2234
    in the same format as a committer-id, e.g. "John Doe <jdoe@example.com>".
 
 
2236
    A selected-file commit may fail in some cases where the committed
 
 
2237
    tree would be invalid. Consider::
 
 
2242
      bzr commit foo -m "committing foo"
 
 
2243
      bzr mv foo/bar foo/baz
 
 
2246
      bzr commit foo/bar -m "committing bar but not baz"
 
 
2248
    In the example above, the last commit will fail by design. This gives
 
 
2249
    the user the opportunity to decide whether they want to commit the
 
 
2250
    rename at the same time, separately first, or not at all. (As a general
 
 
2251
    rule, when in doubt, Bazaar has a policy of Doing the Safe Thing.)
 
 
2253
    Note: A selected-file commit after a merge is not yet supported.
 
 
2255
    # TODO: Run hooks on tree to-be-committed, and after commit.
 
 
2257
    # TODO: Strict commit that fails if there are deleted files.
 
 
2258
    #       (what does "deleted files" mean ??)
 
 
2260
    # TODO: Give better message for -s, --summary, used by tla people
 
 
2262
    # XXX: verbose currently does nothing
 
 
2264
    _see_also = ['bugs', 'uncommit']
 
 
2265
    takes_args = ['selected*']
 
 
2267
            Option('message', type=unicode,
 
 
2269
                   help="Description of the new revision."),
 
 
2272
                    help='Commit even if nothing has changed.'),
 
 
2273
             Option('file', type=str,
 
 
2276
                    help='Take commit message from this file.'),
 
 
2278
                    help="Refuse to commit if there are unknown "
 
 
2279
                    "files in the working tree."),
 
 
2280
             ListOption('fixes', type=str,
 
 
2281
                    help="Mark a bug as being fixed by this revision."),
 
 
2282
             Option('author', type=unicode,
 
 
2283
                    help="Set the author's name, if it's different "
 
 
2284
                         "from the committer."),
 
 
2286
                    help="Perform a local commit in a bound "
 
 
2287
                         "branch.  Local commits are not pushed to "
 
 
2288
                         "the master branch until a normal commit "
 
 
2292
                     help='When no message is supplied, show the diff along'
 
 
2293
                     ' with the status summary in the message editor.'),
 
 
2295
    aliases = ['ci', 'checkin']
 
 
2297
    def _get_bug_fix_properties(self, fixes, branch):
 
 
2299
        # Configure the properties for bug fixing attributes.
 
 
2300
        for fixed_bug in fixes:
 
 
2301
            tokens = fixed_bug.split(':')
 
 
2302
            if len(tokens) != 2:
 
 
2303
                raise errors.BzrCommandError(
 
 
2304
                    "Invalid bug %s. Must be in the form of 'tag:id'. "
 
 
2305
                    "Commit refused." % fixed_bug)
 
 
2306
            tag, bug_id = tokens
 
 
2308
                bug_url = bugtracker.get_bug_url(tag, branch, bug_id)
 
 
2309
            except errors.UnknownBugTrackerAbbreviation:
 
 
2310
                raise errors.BzrCommandError(
 
 
2311
                    'Unrecognized bug %s. Commit refused.' % fixed_bug)
 
 
2312
            except errors.MalformedBugIdentifier:
 
 
2313
                raise errors.BzrCommandError(
 
 
2314
                    "Invalid bug identifier for %s. Commit refused."
 
 
2316
            properties.append('%s fixed' % bug_url)
 
 
2317
        return '\n'.join(properties)
 
 
2319
    def run(self, message=None, file=None, verbose=False, selected_list=None,
 
 
2320
            unchanged=False, strict=False, local=False, fixes=None,
 
 
2321
            author=None, show_diff=False):
 
 
2322
        from bzrlib.errors import (
 
 
2327
        from bzrlib.msgeditor import (
 
 
2328
            edit_commit_message_encoded,
 
 
2329
            make_commit_message_template_encoded
 
 
2332
        # TODO: Need a blackbox test for invoking the external editor; may be
 
 
2333
        # slightly problematic to run this cross-platform.
 
 
2335
        # TODO: do more checks that the commit will succeed before 
 
 
2336
        # spending the user's valuable time typing a commit message.
 
 
2340
        tree, selected_list = tree_files(selected_list)
 
 
2341
        if selected_list == ['']:
 
 
2342
            # workaround - commit of root of tree should be exactly the same
 
 
2343
            # as just default commit in that tree, and succeed even though
 
 
2344
            # selected-file merge commit is not done yet
 
 
2349
        bug_property = self._get_bug_fix_properties(fixes, tree.branch)
 
 
2351
            properties['bugs'] = bug_property
 
 
2353
        if local and not tree.branch.get_bound_location():
 
 
2354
            raise errors.LocalRequiresBoundBranch()
 
 
2356
        def get_message(commit_obj):
 
 
2357
            """Callback to get commit message"""
 
 
2358
            my_message = message
 
 
2359
            if my_message is None and not file:
 
 
2360
                t = make_commit_message_template_encoded(tree,
 
 
2361
                        selected_list, diff=show_diff,
 
 
2362
                        output_encoding=bzrlib.user_encoding)
 
 
2363
                my_message = edit_commit_message_encoded(t)
 
 
2364
                if my_message is None:
 
 
2365
                    raise errors.BzrCommandError("please specify a commit"
 
 
2366
                        " message with either --message or --file")
 
 
2367
            elif my_message and file:
 
 
2368
                raise errors.BzrCommandError(
 
 
2369
                    "please specify either --message or --file")
 
 
2371
                my_message = codecs.open(file, 'rt', 
 
 
2372
                                         bzrlib.user_encoding).read()
 
 
2373
            if my_message == "":
 
 
2374
                raise errors.BzrCommandError("empty commit message specified")
 
 
2378
            tree.commit(message_callback=get_message,
 
 
2379
                        specific_files=selected_list,
 
 
2380
                        allow_pointless=unchanged, strict=strict, local=local,
 
 
2381
                        reporter=None, verbose=verbose, revprops=properties,
 
 
2383
        except PointlessCommit:
 
 
2384
            # FIXME: This should really happen before the file is read in;
 
 
2385
            # perhaps prepare the commit; get the message; then actually commit
 
 
2386
            raise errors.BzrCommandError("no changes to commit."
 
 
2387
                              " use --unchanged to commit anyhow")
 
 
2388
        except ConflictsInTree:
 
 
2389
            raise errors.BzrCommandError('Conflicts detected in working '
 
 
2390
                'tree.  Use "bzr conflicts" to list, "bzr resolve FILE" to'
 
 
2392
        except StrictCommitFailed:
 
 
2393
            raise errors.BzrCommandError("Commit refused because there are"
 
 
2394
                              " unknown files in the working tree.")
 
 
2395
        except errors.BoundBranchOutOfDate, e:
 
 
2396
            raise errors.BzrCommandError(str(e) + "\n"
 
 
2397
            'To commit to master branch, run update and then commit.\n'
 
 
2398
            'You can also pass --local to commit to continue working '
 
 
2402
class cmd_check(Command):
 
 
2403
    """Validate working tree structure, branch consistency and repository
 
 
2406
    This command checks various invariants about branch and repository storage
 
 
2407
    to detect data corruption or bzr bugs.
 
 
2409
    The working tree and branch checks will only give output if a problem is
 
 
2410
    detected. The output fields of the repository check are:
 
 
2412
        revisions: This is just the number of revisions checked.  It doesn't
 
 
2414
        versionedfiles: This is just the number of versionedfiles checked.  It
 
 
2415
            doesn't indicate a problem.
 
 
2416
        unreferenced ancestors: Texts that are ancestors of other texts, but
 
 
2417
            are not properly referenced by the revision ancestry.  This is a
 
 
2418
            subtle problem that Bazaar can work around.
 
 
2419
        unique file texts: This is the total number of unique file contents
 
 
2420
            seen in the checked revisions.  It does not indicate a problem.
 
 
2421
        repeated file texts: This is the total number of repeated texts seen
 
 
2422
            in the checked revisions.  Texts can be repeated when their file
 
 
2423
            entries are modified, but the file contents are not.  It does not
 
 
2427
    _see_also = ['reconcile']
 
 
2428
    takes_args = ['path?']
 
 
2429
    takes_options = ['verbose',
 
 
2430
                     Option('branch', help="Check the branch related to the"
 
 
2431
                                           " current directory."),
 
 
2432
                     Option('repo', help="Check the repository related to the"
 
 
2433
                                         " current directory."),
 
 
2434
                     Option('tree', help="Check the working tree related to"
 
 
2435
                                         " the current directory.")]
 
 
2437
    def run(self, path=None, verbose=False, branch=False, repo=False,
 
 
2439
        from bzrlib.check import check_dwim
 
 
2442
        if not branch and not repo and not tree:
 
 
2443
            branch = repo = tree = True
 
 
2444
        check_dwim(path, verbose, do_branch=branch, do_repo=repo, do_tree=tree)
 
 
2447
class cmd_upgrade(Command):
 
 
2448
    """Upgrade branch storage to current format.
 
 
2450
    The check command or bzr developers may sometimes advise you to run
 
 
2451
    this command. When the default format has changed you may also be warned
 
 
2452
    during other operations to upgrade.
 
 
2455
    _see_also = ['check']
 
 
2456
    takes_args = ['url?']
 
 
2458
                    RegistryOption('format',
 
 
2459
                        help='Upgrade to a specific format.  See "bzr help'
 
 
2460
                             ' formats" for details.',
 
 
2461
                        registry=bzrdir.format_registry,
 
 
2462
                        converter=bzrdir.format_registry.make_bzrdir,
 
 
2463
                        value_switches=True, title='Branch format'),
 
 
2466
    def run(self, url='.', format=None):
 
 
2467
        from bzrlib.upgrade import upgrade
 
 
2469
            format = bzrdir.format_registry.make_bzrdir('default')
 
 
2470
        upgrade(url, format)
 
 
2473
class cmd_whoami(Command):
 
 
2474
    """Show or set bzr user id.
 
 
2477
        Show the email of the current user::
 
 
2481
        Set the current user::
 
 
2483
            bzr whoami "Frank Chu <fchu@example.com>"
 
 
2485
    takes_options = [ Option('email',
 
 
2486
                             help='Display email address only.'),
 
 
2488
                             help='Set identity for the current branch instead of '
 
 
2491
    takes_args = ['name?']
 
 
2492
    encoding_type = 'replace'
 
 
2495
    def run(self, email=False, branch=False, name=None):
 
 
2497
            # use branch if we're inside one; otherwise global config
 
 
2499
                c = Branch.open_containing('.')[0].get_config()
 
 
2500
            except errors.NotBranchError:
 
 
2501
                c = config.GlobalConfig()
 
 
2503
                self.outf.write(c.user_email() + '\n')
 
 
2505
                self.outf.write(c.username() + '\n')
 
 
2508
        # display a warning if an email address isn't included in the given name.
 
 
2510
            config.extract_email_address(name)
 
 
2511
        except errors.NoEmailInUsername, e:
 
 
2512
            warning('"%s" does not seem to contain an email address.  '
 
 
2513
                    'This is allowed, but not recommended.', name)
 
 
2515
        # use global config unless --branch given
 
 
2517
            c = Branch.open_containing('.')[0].get_config()
 
 
2519
            c = config.GlobalConfig()
 
 
2520
        c.set_user_option('email', name)
 
 
2523
class cmd_nick(Command):
 
 
2524
    """Print or set the branch nickname.  
 
 
2526
    If unset, the tree root directory name is used as the nickname
 
 
2527
    To print the current nickname, execute with no argument.  
 
 
2530
    _see_also = ['info']
 
 
2531
    takes_args = ['nickname?']
 
 
2532
    def run(self, nickname=None):
 
 
2533
        branch = Branch.open_containing(u'.')[0]
 
 
2534
        if nickname is None:
 
 
2535
            self.printme(branch)
 
 
2537
            branch.nick = nickname
 
 
2540
    def printme(self, branch):
 
 
2544
class cmd_alias(Command):
 
 
2545
    """Set/unset and display aliases.
 
 
2548
        Show the current aliases::
 
 
2552
        Show the alias specified for 'll'::
 
 
2556
        Set an alias for 'll'::
 
 
2558
            bzr alias ll="log --line -r-10..-1"
 
 
2560
        To remove an alias for 'll'::
 
 
2562
            bzr alias --remove ll
 
 
2565
    takes_args = ['name?']
 
 
2567
        Option('remove', help='Remove the alias.'),
 
 
2570
    def run(self, name=None, remove=False):
 
 
2572
            self.remove_alias(name)
 
 
2574
            self.print_aliases()
 
 
2576
            equal_pos = name.find('=')
 
 
2578
                self.print_alias(name)
 
 
2580
                self.set_alias(name[:equal_pos], name[equal_pos+1:])
 
 
2582
    def remove_alias(self, alias_name):
 
 
2583
        if alias_name is None:
 
 
2584
            raise errors.BzrCommandError(
 
 
2585
                'bzr alias --remove expects an alias to remove.')
 
 
2586
        # If alias is not found, print something like:
 
 
2587
        # unalias: foo: not found
 
 
2588
        c = config.GlobalConfig()
 
 
2589
        c.unset_alias(alias_name)
 
 
2592
    def print_aliases(self):
 
 
2593
        """Print out the defined aliases in a similar format to bash."""
 
 
2594
        aliases = config.GlobalConfig().get_aliases()
 
 
2595
        for key, value in sorted(aliases.iteritems()):
 
 
2596
            self.outf.write('bzr alias %s="%s"\n' % (key, value))
 
 
2599
    def print_alias(self, alias_name):
 
 
2600
        from bzrlib.commands import get_alias
 
 
2601
        alias = get_alias(alias_name)
 
 
2603
            self.outf.write("bzr alias: %s: not found\n" % alias_name)
 
 
2606
                'bzr alias %s="%s"\n' % (alias_name, ' '.join(alias)))
 
 
2608
    def set_alias(self, alias_name, alias_command):
 
 
2609
        """Save the alias in the global config."""
 
 
2610
        c = config.GlobalConfig()
 
 
2611
        c.set_alias(alias_name, alias_command)
 
 
2614
class cmd_selftest(Command):
 
 
2615
    """Run internal test suite.
 
 
2617
    If arguments are given, they are regular expressions that say which tests
 
 
2618
    should run.  Tests matching any expression are run, and other tests are
 
 
2621
    Alternatively if --first is given, matching tests are run first and then
 
 
2622
    all other tests are run.  This is useful if you have been working in a
 
 
2623
    particular area, but want to make sure nothing else was broken.
 
 
2625
    If --exclude is given, tests that match that regular expression are
 
 
2626
    excluded, regardless of whether they match --first or not.
 
 
2628
    To help catch accidential dependencies between tests, the --randomize
 
 
2629
    option is useful. In most cases, the argument used is the word 'now'.
 
 
2630
    Note that the seed used for the random number generator is displayed
 
 
2631
    when this option is used. The seed can be explicitly passed as the
 
 
2632
    argument to this option if required. This enables reproduction of the
 
 
2633
    actual ordering used if and when an order sensitive problem is encountered.
 
 
2635
    If --list-only is given, the tests that would be run are listed. This is
 
 
2636
    useful when combined with --first, --exclude and/or --randomize to
 
 
2637
    understand their impact. The test harness reports "Listed nn tests in ..."
 
 
2638
    instead of "Ran nn tests in ..." when list mode is enabled.
 
 
2640
    If the global option '--no-plugins' is given, plugins are not loaded
 
 
2641
    before running the selftests.  This has two effects: features provided or
 
 
2642
    modified by plugins will not be tested, and tests provided by plugins will
 
 
2645
    Tests that need working space on disk use a common temporary directory, 
 
 
2646
    typically inside $TMPDIR or /tmp.
 
 
2649
        Run only tests relating to 'ignore'::
 
 
2653
        Disable plugins and list tests as they're run::
 
 
2655
            bzr --no-plugins selftest -v
 
 
2657
    # NB: this is used from the class without creating an instance, which is
 
 
2658
    # why it does not have a self parameter.
 
 
2659
    def get_transport_type(typestring):
 
 
2660
        """Parse and return a transport specifier."""
 
 
2661
        if typestring == "sftp":
 
 
2662
            from bzrlib.transport.sftp import SFTPAbsoluteServer
 
 
2663
            return SFTPAbsoluteServer
 
 
2664
        if typestring == "memory":
 
 
2665
            from bzrlib.transport.memory import MemoryServer
 
 
2667
        if typestring == "fakenfs":
 
 
2668
            from bzrlib.transport.fakenfs import FakeNFSServer
 
 
2669
            return FakeNFSServer
 
 
2670
        msg = "No known transport type %s. Supported types are: sftp\n" %\
 
 
2672
        raise errors.BzrCommandError(msg)
 
 
2675
    takes_args = ['testspecs*']
 
 
2676
    takes_options = ['verbose',
 
 
2678
                             help='Stop when one test fails.',
 
 
2682
                            help='Use a different transport by default '
 
 
2683
                                 'throughout the test suite.',
 
 
2684
                            type=get_transport_type),
 
 
2686
                            help='Run the benchmarks rather than selftests.'),
 
 
2687
                     Option('lsprof-timed',
 
 
2688
                            help='Generate lsprof output for benchmarked'
 
 
2689
                                 ' sections of code.'),
 
 
2690
                     Option('cache-dir', type=str,
 
 
2691
                            help='Cache intermediate benchmark output in this '
 
 
2694
                            help='Run all tests, but run specified tests first.',
 
 
2698
                            help='List the tests instead of running them.'),
 
 
2699
                     Option('randomize', type=str, argname="SEED",
 
 
2700
                            help='Randomize the order of tests using the given'
 
 
2701
                                 ' seed or "now" for the current time.'),
 
 
2702
                     Option('exclude', type=str, argname="PATTERN",
 
 
2704
                            help='Exclude tests that match this regular'
 
 
2706
                     Option('strict', help='Fail on missing dependencies or '
 
 
2708
                     Option('load-list', type=str, argname='TESTLISTFILE',
 
 
2709
                            help='Load a test id list from a text file.'),
 
 
2710
                     ListOption('debugflag', type=str, short_name='E',
 
 
2711
                                help='Turn on a selftest debug flag.'),
 
 
2712
                     Option('starting-with', type=str, argname='TESTID',
 
 
2714
                            help='Load only the tests starting with TESTID.'),
 
 
2716
    encoding_type = 'replace'
 
 
2718
    def run(self, testspecs_list=None, verbose=False, one=False,
 
 
2719
            transport=None, benchmark=None,
 
 
2720
            lsprof_timed=None, cache_dir=None,
 
 
2721
            first=False, list_only=False,
 
 
2722
            randomize=None, exclude=None, strict=False,
 
 
2723
            load_list=None, debugflag=None, starting_with=None):
 
 
2725
        from bzrlib.tests import selftest
 
 
2726
        import bzrlib.benchmarks as benchmarks
 
 
2727
        from bzrlib.benchmarks import tree_creator
 
 
2729
        # Make deprecation warnings visible, unless -Werror is set
 
 
2730
        symbol_versioning.activate_deprecation_warnings(override=False)
 
 
2732
        if cache_dir is not None:
 
 
2733
            tree_creator.TreeCreator.CACHE_ROOT = osutils.abspath(cache_dir)
 
 
2735
            print 'testing: %s' % (osutils.realpath(sys.argv[0]),)
 
 
2736
            print '   %s (%s python%s)' % (
 
 
2738
                    bzrlib.version_string,
 
 
2739
                    bzrlib._format_version_tuple(sys.version_info),
 
 
2742
        if testspecs_list is not None:
 
 
2743
            pattern = '|'.join(testspecs_list)
 
 
2747
            test_suite_factory = benchmarks.test_suite
 
 
2748
            # Unless user explicitly asks for quiet, be verbose in benchmarks
 
 
2749
            verbose = not is_quiet()
 
 
2750
            # TODO: should possibly lock the history file...
 
 
2751
            benchfile = open(".perf_history", "at", buffering=1)
 
 
2753
            test_suite_factory = None
 
 
2756
            result = selftest(verbose=verbose,
 
 
2758
                              stop_on_failure=one,
 
 
2759
                              transport=transport,
 
 
2760
                              test_suite_factory=test_suite_factory,
 
 
2761
                              lsprof_timed=lsprof_timed,
 
 
2762
                              bench_history=benchfile,
 
 
2763
                              matching_tests_first=first,
 
 
2764
                              list_only=list_only,
 
 
2765
                              random_seed=randomize,
 
 
2766
                              exclude_pattern=exclude,
 
 
2768
                              load_list=load_list,
 
 
2769
                              debug_flags=debugflag,
 
 
2770
                              starting_with=starting_with,
 
 
2773
            if benchfile is not None:
 
 
2776
            note('tests passed')
 
 
2778
            note('tests failed')
 
 
2779
        return int(not result)
 
 
2782
class cmd_version(Command):
 
 
2783
    """Show version of bzr."""
 
 
2785
    encoding_type = 'replace'
 
 
2787
        Option("short", help="Print just the version number."),
 
 
2791
    def run(self, short=False):
 
 
2792
        from bzrlib.version import show_version
 
 
2794
            self.outf.write(bzrlib.version_string + '\n')
 
 
2796
            show_version(to_file=self.outf)
 
 
2799
class cmd_rocks(Command):
 
 
2800
    """Statement of optimism."""
 
 
2806
        print "It sure does!"
 
 
2809
class cmd_find_merge_base(Command):
 
 
2810
    """Find and print a base revision for merging two branches."""
 
 
2811
    # TODO: Options to specify revisions on either side, as if
 
 
2812
    #       merging only part of the history.
 
 
2813
    takes_args = ['branch', 'other']
 
 
2817
    def run(self, branch, other):
 
 
2818
        from bzrlib.revision import ensure_null
 
 
2820
        branch1 = Branch.open_containing(branch)[0]
 
 
2821
        branch2 = Branch.open_containing(other)[0]
 
 
2826
                last1 = ensure_null(branch1.last_revision())
 
 
2827
                last2 = ensure_null(branch2.last_revision())
 
 
2829
                graph = branch1.repository.get_graph(branch2.repository)
 
 
2830
                base_rev_id = graph.find_unique_lca(last1, last2)
 
 
2832
                print 'merge base is revision %s' % base_rev_id
 
 
2839
class cmd_merge(Command):
 
 
2840
    """Perform a three-way merge.
 
 
2842
    The source of the merge can be specified either in the form of a branch,
 
 
2843
    or in the form of a path to a file containing a merge directive generated
 
 
2844
    with bzr send. If neither is specified, the default is the upstream branch
 
 
2845
    or the branch most recently merged using --remember.
 
 
2847
    When merging a branch, by default the tip will be merged. To pick a different
 
 
2848
    revision, pass --revision. If you specify two values, the first will be used as
 
 
2849
    BASE and the second one as OTHER. Merging individual revisions, or a subset of
 
 
2850
    available revisions, like this is commonly referred to as "cherrypicking".
 
 
2852
    Revision numbers are always relative to the branch being merged.
 
 
2854
    By default, bzr will try to merge in all new work from the other
 
 
2855
    branch, automatically determining an appropriate base.  If this
 
 
2856
    fails, you may need to give an explicit base.
 
 
2858
    Merge will do its best to combine the changes in two branches, but there
 
 
2859
    are some kinds of problems only a human can fix.  When it encounters those,
 
 
2860
    it will mark a conflict.  A conflict means that you need to fix something,
 
 
2861
    before you should commit.
 
 
2863
    Use bzr resolve when you have fixed a problem.  See also bzr conflicts.
 
 
2865
    If there is no default branch set, the first merge will set it. After
 
 
2866
    that, you can omit the branch to use the default.  To change the
 
 
2867
    default, use --remember. The value will only be saved if the remote
 
 
2868
    location can be accessed.
 
 
2870
    The results of the merge are placed into the destination working
 
 
2871
    directory, where they can be reviewed (with bzr diff), tested, and then
 
 
2872
    committed to record the result of the merge.
 
 
2874
    merge refuses to run if there are any uncommitted changes, unless
 
 
2878
        To merge the latest revision from bzr.dev::
 
 
2880
            bzr merge ../bzr.dev
 
 
2882
        To merge changes up to and including revision 82 from bzr.dev::
 
 
2884
            bzr merge -r 82 ../bzr.dev
 
 
2886
        To merge the changes introduced by 82, without previous changes::
 
 
2888
            bzr merge -r 81..82 ../bzr.dev
 
 
2890
        To apply a merge directive contained in in /tmp/merge:
 
 
2892
            bzr merge /tmp/merge
 
 
2895
    encoding_type = 'exact'
 
 
2896
    _see_also = ['update', 'remerge', 'status-flags']
 
 
2897
    takes_args = ['location?']
 
 
2902
               help='Merge even if the destination tree has uncommitted changes.'),
 
 
2906
        Option('show-base', help="Show base revision text in "
 
 
2908
        Option('uncommitted', help='Apply uncommitted changes'
 
 
2909
               ' from a working copy, instead of branch changes.'),
 
 
2910
        Option('pull', help='If the destination is already'
 
 
2911
                ' completely merged into the source, pull from the'
 
 
2912
                ' source rather than merging.  When this happens,'
 
 
2913
                ' you do not need to commit the result.'),
 
 
2915
               help='Branch to merge into, '
 
 
2916
                    'rather than the one containing the working directory.',
 
 
2920
        Option('preview', help='Instead of merging, show a diff of the merge.')
 
 
2923
    def run(self, location=None, revision=None, force=False,
 
 
2924
            merge_type=None, show_base=False, reprocess=False, remember=False,
 
 
2925
            uncommitted=False, pull=False,
 
 
2929
        if merge_type is None:
 
 
2930
            merge_type = _mod_merge.Merge3Merger
 
 
2932
        if directory is None: directory = u'.'
 
 
2933
        possible_transports = []
 
 
2935
        allow_pending = True
 
 
2936
        verified = 'inapplicable'
 
 
2937
        tree = WorkingTree.open_containing(directory)[0]
 
 
2938
        change_reporter = delta._ChangeReporter(
 
 
2939
            unversioned_filter=tree.is_ignored)
 
 
2942
            pb = ui.ui_factory.nested_progress_bar()
 
 
2943
            cleanups.append(pb.finished)
 
 
2945
            cleanups.append(tree.unlock)
 
 
2946
            if location is not None:
 
 
2948
                    mergeable = bundle.read_mergeable_from_url(location,
 
 
2949
                        possible_transports=possible_transports)
 
 
2950
                except errors.NotABundle:
 
 
2954
                        raise errors.BzrCommandError('Cannot use --uncommitted'
 
 
2955
                            ' with bundles or merge directives.')
 
 
2957
                    if revision is not None:
 
 
2958
                        raise errors.BzrCommandError(
 
 
2959
                            'Cannot use -r with merge directives or bundles')
 
 
2960
                    merger, verified = _mod_merge.Merger.from_mergeable(tree,
 
 
2963
            if merger is None and uncommitted:
 
 
2964
                if revision is not None and len(revision) > 0:
 
 
2965
                    raise errors.BzrCommandError('Cannot use --uncommitted and'
 
 
2966
                        ' --revision at the same time.')
 
 
2967
                location = self._select_branch_location(tree, location)[0]
 
 
2968
                other_tree, other_path = WorkingTree.open_containing(location)
 
 
2969
                merger = _mod_merge.Merger.from_uncommitted(tree, other_tree,
 
 
2971
                allow_pending = False
 
 
2972
                if other_path != '':
 
 
2973
                    merger.interesting_files = [other_path]
 
 
2976
                merger, allow_pending = self._get_merger_from_branch(tree,
 
 
2977
                    location, revision, remember, possible_transports, pb)
 
 
2979
            merger.merge_type = merge_type
 
 
2980
            merger.reprocess = reprocess
 
 
2981
            merger.show_base = show_base
 
 
2982
            self.sanity_check_merger(merger)
 
 
2983
            if (merger.base_rev_id == merger.other_rev_id and
 
 
2984
                merger.other_rev_id is not None):
 
 
2985
                note('Nothing to do.')
 
 
2988
                if merger.interesting_files is not None:
 
 
2989
                    raise errors.BzrCommandError('Cannot pull individual files')
 
 
2990
                if (merger.base_rev_id == tree.last_revision()):
 
 
2991
                    result = tree.pull(merger.other_branch, False,
 
 
2992
                                       merger.other_rev_id)
 
 
2993
                    result.report(self.outf)
 
 
2995
            merger.check_basis(not force)
 
 
2997
                return self._do_preview(merger)
 
 
2999
                return self._do_merge(merger, change_reporter, allow_pending,
 
 
3002
            for cleanup in reversed(cleanups):
 
 
3005
    def _do_preview(self, merger):
 
 
3006
        from bzrlib.diff import show_diff_trees
 
 
3007
        tree_merger = merger.make_merger()
 
 
3008
        tt = tree_merger.make_preview_transform()
 
 
3010
            result_tree = tt.get_preview_tree()
 
 
3011
            show_diff_trees(merger.this_tree, result_tree, self.outf,
 
 
3012
                            old_label='', new_label='')
 
 
3016
    def _do_merge(self, merger, change_reporter, allow_pending, verified):
 
 
3017
        merger.change_reporter = change_reporter
 
 
3018
        conflict_count = merger.do_merge()
 
 
3020
            merger.set_pending()
 
 
3021
        if verified == 'failed':
 
 
3022
            warning('Preview patch does not match changes')
 
 
3023
        if conflict_count != 0:
 
 
3028
    def sanity_check_merger(self, merger):
 
 
3029
        if (merger.show_base and
 
 
3030
            not merger.merge_type is _mod_merge.Merge3Merger):
 
 
3031
            raise errors.BzrCommandError("Show-base is not supported for this"
 
 
3032
                                         " merge type. %s" % merger.merge_type)
 
 
3033
        if merger.reprocess and not merger.merge_type.supports_reprocess:
 
 
3034
            raise errors.BzrCommandError("Conflict reduction is not supported"
 
 
3035
                                         " for merge type %s." %
 
 
3037
        if merger.reprocess and merger.show_base:
 
 
3038
            raise errors.BzrCommandError("Cannot do conflict reduction and"
 
 
3041
    def _get_merger_from_branch(self, tree, location, revision, remember,
 
 
3042
                                possible_transports, pb):
 
 
3043
        """Produce a merger from a location, assuming it refers to a branch."""
 
 
3044
        from bzrlib.tag import _merge_tags_if_possible
 
 
3045
        # find the branch locations
 
 
3046
        other_loc, user_location = self._select_branch_location(tree, location,
 
 
3048
        if revision is not None and len(revision) == 2:
 
 
3049
            base_loc, _unused = self._select_branch_location(tree,
 
 
3050
                location, revision, 0)
 
 
3052
            base_loc = other_loc
 
 
3054
        other_branch, other_path = Branch.open_containing(other_loc,
 
 
3055
            possible_transports)
 
 
3056
        if base_loc == other_loc:
 
 
3057
            base_branch = other_branch
 
 
3059
            base_branch, base_path = Branch.open_containing(base_loc,
 
 
3060
                possible_transports)
 
 
3061
        # Find the revision ids
 
 
3062
        if revision is None or len(revision) < 1 or revision[-1] is None:
 
 
3063
            other_revision_id = _mod_revision.ensure_null(
 
 
3064
                other_branch.last_revision())
 
 
3066
            other_revision_id = revision[-1].as_revision_id(other_branch)
 
 
3067
        if (revision is not None and len(revision) == 2
 
 
3068
            and revision[0] is not None):
 
 
3069
            base_revision_id = revision[0].as_revision_id(base_branch)
 
 
3071
            base_revision_id = None
 
 
3072
        # Remember where we merge from
 
 
3073
        if ((remember or tree.branch.get_submit_branch() is None) and
 
 
3074
             user_location is not None):
 
 
3075
            tree.branch.set_submit_branch(other_branch.base)
 
 
3076
        _merge_tags_if_possible(other_branch, tree.branch)
 
 
3077
        merger = _mod_merge.Merger.from_revision_ids(pb, tree,
 
 
3078
            other_revision_id, base_revision_id, other_branch, base_branch)
 
 
3079
        if other_path != '':
 
 
3080
            allow_pending = False
 
 
3081
            merger.interesting_files = [other_path]
 
 
3083
            allow_pending = True
 
 
3084
        return merger, allow_pending
 
 
3086
    def _select_branch_location(self, tree, user_location, revision=None,
 
 
3088
        """Select a branch location, according to possible inputs.
 
 
3090
        If provided, branches from ``revision`` are preferred.  (Both
 
 
3091
        ``revision`` and ``index`` must be supplied.)
 
 
3093
        Otherwise, the ``location`` parameter is used.  If it is None, then the
 
 
3094
        ``submit`` or ``parent`` location is used, and a note is printed.
 
 
3096
        :param tree: The working tree to select a branch for merging into
 
 
3097
        :param location: The location entered by the user
 
 
3098
        :param revision: The revision parameter to the command
 
 
3099
        :param index: The index to use for the revision parameter.  Negative
 
 
3100
            indices are permitted.
 
 
3101
        :return: (selected_location, user_location).  The default location
 
 
3102
            will be the user-entered location.
 
 
3104
        if (revision is not None and index is not None
 
 
3105
            and revision[index] is not None):
 
 
3106
            branch = revision[index].get_branch()
 
 
3107
            if branch is not None:
 
 
3108
                return branch, branch
 
 
3109
        if user_location is None:
 
 
3110
            location = self._get_remembered(tree, 'Merging from')
 
 
3112
            location = user_location
 
 
3113
        return location, user_location
 
 
3115
    def _get_remembered(self, tree, verb_string):
 
 
3116
        """Use tree.branch's parent if none was supplied.
 
 
3118
        Report if the remembered location was used.
 
 
3120
        stored_location = tree.branch.get_submit_branch()
 
 
3121
        if stored_location is None:
 
 
3122
            stored_location = tree.branch.get_parent()
 
 
3123
        mutter("%s", stored_location)
 
 
3124
        if stored_location is None:
 
 
3125
            raise errors.BzrCommandError("No location specified or remembered")
 
 
3126
        display_url = urlutils.unescape_for_display(stored_location, 'utf-8')
 
 
3127
        note(u"%s remembered location %s", verb_string, display_url)
 
 
3128
        return stored_location
 
 
3131
class cmd_remerge(Command):
 
 
3134
    Use this if you want to try a different merge technique while resolving
 
 
3135
    conflicts.  Some merge techniques are better than others, and remerge 
 
 
3136
    lets you try different ones on different files.
 
 
3138
    The options for remerge have the same meaning and defaults as the ones for
 
 
3139
    merge.  The difference is that remerge can (only) be run when there is a
 
 
3140
    pending merge, and it lets you specify particular files.
 
 
3143
        Re-do the merge of all conflicted files, and show the base text in
 
 
3144
        conflict regions, in addition to the usual THIS and OTHER texts::
 
 
3146
            bzr remerge --show-base
 
 
3148
        Re-do the merge of "foobar", using the weave merge algorithm, with
 
 
3149
        additional processing to reduce the size of conflict regions::
 
 
3151
            bzr remerge --merge-type weave --reprocess foobar
 
 
3153
    takes_args = ['file*']
 
 
3158
                   help="Show base revision text in conflicts."),
 
 
3161
    def run(self, file_list=None, merge_type=None, show_base=False,
 
 
3163
        if merge_type is None:
 
 
3164
            merge_type = _mod_merge.Merge3Merger
 
 
3165
        tree, file_list = tree_files(file_list)
 
 
3168
            parents = tree.get_parent_ids()
 
 
3169
            if len(parents) != 2:
 
 
3170
                raise errors.BzrCommandError("Sorry, remerge only works after normal"
 
 
3171
                                             " merges.  Not cherrypicking or"
 
 
3173
            repository = tree.branch.repository
 
 
3174
            interesting_ids = None
 
 
3176
            conflicts = tree.conflicts()
 
 
3177
            if file_list is not None:
 
 
3178
                interesting_ids = set()
 
 
3179
                for filename in file_list:
 
 
3180
                    file_id = tree.path2id(filename)
 
 
3182
                        raise errors.NotVersionedError(filename)
 
 
3183
                    interesting_ids.add(file_id)
 
 
3184
                    if tree.kind(file_id) != "directory":
 
 
3187
                    for name, ie in tree.inventory.iter_entries(file_id):
 
 
3188
                        interesting_ids.add(ie.file_id)
 
 
3189
                new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
 
 
3191
                # Remerge only supports resolving contents conflicts
 
 
3192
                allowed_conflicts = ('text conflict', 'contents conflict')
 
 
3193
                restore_files = [c.path for c in conflicts
 
 
3194
                                 if c.typestring in allowed_conflicts]
 
 
3195
            _mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
 
 
3196
            tree.set_conflicts(ConflictList(new_conflicts))
 
 
3197
            if file_list is not None:
 
 
3198
                restore_files = file_list
 
 
3199
            for filename in restore_files:
 
 
3201
                    restore(tree.abspath(filename))
 
 
3202
                except errors.NotConflicted:
 
 
3204
            # Disable pending merges, because the file texts we are remerging
 
 
3205
            # have not had those merges performed.  If we use the wrong parents
 
 
3206
            # list, we imply that the working tree text has seen and rejected
 
 
3207
            # all the changes from the other tree, when in fact those changes
 
 
3208
            # have not yet been seen.
 
 
3209
            pb = ui.ui_factory.nested_progress_bar()
 
 
3210
            tree.set_parent_ids(parents[:1])
 
 
3212
                merger = _mod_merge.Merger.from_revision_ids(pb,
 
 
3214
                merger.interesting_ids = interesting_ids
 
 
3215
                merger.merge_type = merge_type
 
 
3216
                merger.show_base = show_base
 
 
3217
                merger.reprocess = reprocess
 
 
3218
                conflicts = merger.do_merge()
 
 
3220
                tree.set_parent_ids(parents)
 
 
3230
class cmd_revert(Command):
 
 
3231
    """Revert files to a previous revision.
 
 
3233
    Giving a list of files will revert only those files.  Otherwise, all files
 
 
3234
    will be reverted.  If the revision is not specified with '--revision', the
 
 
3235
    last committed revision is used.
 
 
3237
    To remove only some changes, without reverting to a prior version, use
 
 
3238
    merge instead.  For example, "merge . --revision -2..-3" will remove the
 
 
3239
    changes introduced by -2, without affecting the changes introduced by -1.
 
 
3240
    Or to remove certain changes on a hunk-by-hunk basis, see the Shelf plugin.
 
 
3242
    By default, any files that have been manually changed will be backed up
 
 
3243
    first.  (Files changed only by merge are not backed up.)  Backup files have
 
 
3244
    '.~#~' appended to their name, where # is a number.
 
 
3246
    When you provide files, you can use their current pathname or the pathname
 
 
3247
    from the target revision.  So you can use revert to "undelete" a file by
 
 
3248
    name.  If you name a directory, all the contents of that directory will be
 
 
3251
    Any files that have been newly added since that revision will be deleted,
 
 
3252
    with a backup kept if appropriate.  Directories containing unknown files
 
 
3253
    will not be deleted.
 
 
3255
    The working tree contains a list of pending merged revisions, which will
 
 
3256
    be included as parents in the next commit.  Normally, revert clears that
 
 
3257
    list as well as reverting the files.  If any files are specified, revert
 
 
3258
    leaves the pending merge list alone and reverts only the files.  Use "bzr
 
 
3259
    revert ." in the tree root to revert all files but keep the merge record,
 
 
3260
    and "bzr revert --forget-merges" to clear the pending merge list without
 
 
3261
    reverting any files.
 
 
3264
    _see_also = ['cat', 'export']
 
 
3267
        Option('no-backup', "Do not save backups of reverted files."),
 
 
3268
        Option('forget-merges',
 
 
3269
               'Remove pending merge marker, without changing any files.'),
 
 
3271
    takes_args = ['file*']
 
 
3273
    def run(self, revision=None, no_backup=False, file_list=None,
 
 
3274
            forget_merges=None):
 
 
3275
        tree, file_list = tree_files(file_list)
 
 
3277
            tree.set_parent_ids(tree.get_parent_ids()[:1])
 
 
3279
            self._revert_tree_to_revision(tree, revision, file_list, no_backup)
 
 
3282
    def _revert_tree_to_revision(tree, revision, file_list, no_backup):
 
 
3283
        if revision is None:
 
 
3284
            rev_id = tree.last_revision()
 
 
3285
        elif len(revision) != 1:
 
 
3286
            raise errors.BzrCommandError('bzr revert --revision takes exactly 1 argument')
 
 
3288
            rev_id = revision[0].as_revision_id(tree.branch)
 
 
3289
        pb = ui.ui_factory.nested_progress_bar()
 
 
3291
            tree.revert(file_list,
 
 
3292
                        tree.branch.repository.revision_tree(rev_id),
 
 
3293
                        not no_backup, pb, report_changes=True)
 
 
3298
class cmd_assert_fail(Command):
 
 
3299
    """Test reporting of assertion failures"""
 
 
3300
    # intended just for use in testing
 
 
3305
        raise AssertionError("always fails")
 
 
3308
class cmd_help(Command):
 
 
3309
    """Show help on a command or other topic.
 
 
3312
    _see_also = ['topics']
 
 
3314
            Option('long', 'Show help on all commands.'),
 
 
3316
    takes_args = ['topic?']
 
 
3317
    aliases = ['?', '--help', '-?', '-h']
 
 
3320
    def run(self, topic=None, long=False):
 
 
3322
        if topic is None and long:
 
 
3324
        bzrlib.help.help(topic)
 
 
3327
class cmd_shell_complete(Command):
 
 
3328
    """Show appropriate completions for context.
 
 
3330
    For a list of all available commands, say 'bzr shell-complete'.
 
 
3332
    takes_args = ['context?']
 
 
3337
    def run(self, context=None):
 
 
3338
        import shellcomplete
 
 
3339
        shellcomplete.shellcomplete(context)
 
 
3342
class cmd_missing(Command):
 
 
3343
    """Show unmerged/unpulled revisions between two branches.
 
 
3345
    OTHER_BRANCH may be local or remote.
 
 
3348
    _see_also = ['merge', 'pull']
 
 
3349
    takes_args = ['other_branch?']
 
 
3351
            Option('reverse', 'Reverse the order of revisions.'),
 
 
3353
                   'Display changes in the local branch only.'),
 
 
3354
            Option('this' , 'Same as --mine-only.'),
 
 
3355
            Option('theirs-only',
 
 
3356
                   'Display changes in the remote branch only.'),
 
 
3357
            Option('other', 'Same as --theirs-only.'),
 
 
3362
    encoding_type = 'replace'
 
 
3365
    def run(self, other_branch=None, reverse=False, mine_only=False,
 
 
3366
            theirs_only=False, log_format=None, long=False, short=False, line=False, 
 
 
3367
            show_ids=False, verbose=False, this=False, other=False):
 
 
3368
        from bzrlib.missing import find_unmerged, iter_log_revisions
 
 
3374
        # TODO: We should probably check that we don't have mine-only and
 
 
3375
        #       theirs-only set, but it gets complicated because we also have
 
 
3376
        #       this and other which could be used.
 
 
3383
        local_branch = Branch.open_containing(u".")[0]
 
 
3384
        parent = local_branch.get_parent()
 
 
3385
        if other_branch is None:
 
 
3386
            other_branch = parent
 
 
3387
            if other_branch is None:
 
 
3388
                raise errors.BzrCommandError("No peer location known"
 
 
3390
            display_url = urlutils.unescape_for_display(parent,
 
 
3392
            self.outf.write("Using last location: " + display_url + "\n")
 
 
3394
        remote_branch = Branch.open(other_branch)
 
 
3395
        if remote_branch.base == local_branch.base:
 
 
3396
            remote_branch = local_branch
 
 
3397
        local_branch.lock_read()
 
 
3399
            remote_branch.lock_read()
 
 
3401
                local_extra, remote_extra = find_unmerged(
 
 
3402
                    local_branch, remote_branch, restrict)
 
 
3404
                if log_format is None:
 
 
3405
                    registry = log.log_formatter_registry
 
 
3406
                    log_format = registry.get_default(local_branch)
 
 
3407
                lf = log_format(to_file=self.outf,
 
 
3409
                                show_timezone='original')
 
 
3410
                if reverse is False:
 
 
3411
                    if local_extra is not None:
 
 
3412
                        local_extra.reverse()
 
 
3413
                    if remote_extra is not None:
 
 
3414
                        remote_extra.reverse()
 
 
3417
                if local_extra and not theirs_only:
 
 
3418
                    self.outf.write("You have %d extra revision(s):\n" %
 
 
3420
                    for revision in iter_log_revisions(local_extra,
 
 
3421
                                        local_branch.repository,
 
 
3423
                        lf.log_revision(revision)
 
 
3424
                    printed_local = True
 
 
3427
                    printed_local = False
 
 
3429
                if remote_extra and not mine_only:
 
 
3430
                    if printed_local is True:
 
 
3431
                        self.outf.write("\n\n\n")
 
 
3432
                    self.outf.write("You are missing %d revision(s):\n" %
 
 
3434
                    for revision in iter_log_revisions(remote_extra,
 
 
3435
                                        remote_branch.repository,
 
 
3437
                        lf.log_revision(revision)
 
 
3440
                if mine_only and not local_extra:
 
 
3441
                    # We checked local, and found nothing extra
 
 
3442
                    self.outf.write('This branch is up to date.\n')
 
 
3443
                elif theirs_only and not remote_extra:
 
 
3444
                    # We checked remote, and found nothing extra
 
 
3445
                    self.outf.write('Other branch is up to date.\n')
 
 
3446
                elif not (mine_only or theirs_only or local_extra or
 
 
3448
                    # We checked both branches, and neither one had extra
 
 
3450
                    self.outf.write("Branches are up to date.\n")
 
 
3452
                remote_branch.unlock()
 
 
3454
            local_branch.unlock()
 
 
3455
        if not status_code and parent is None and other_branch is not None:
 
 
3456
            local_branch.lock_write()
 
 
3458
                # handle race conditions - a parent might be set while we run.
 
 
3459
                if local_branch.get_parent() is None:
 
 
3460
                    local_branch.set_parent(remote_branch.base)
 
 
3462
                local_branch.unlock()
 
 
3466
class cmd_pack(Command):
 
 
3467
    """Compress the data within a repository."""
 
 
3469
    _see_also = ['repositories']
 
 
3470
    takes_args = ['branch_or_repo?']
 
 
3472
    def run(self, branch_or_repo='.'):
 
 
3473
        dir = bzrdir.BzrDir.open_containing(branch_or_repo)[0]
 
 
3475
            branch = dir.open_branch()
 
 
3476
            repository = branch.repository
 
 
3477
        except errors.NotBranchError:
 
 
3478
            repository = dir.open_repository()
 
 
3482
class cmd_plugins(Command):
 
 
3483
    """List the installed plugins.
 
 
3485
    This command displays the list of installed plugins including
 
 
3486
    version of plugin and a short description of each.
 
 
3488
    --verbose shows the path where each plugin is located.
 
 
3490
    A plugin is an external component for Bazaar that extends the
 
 
3491
    revision control system, by adding or replacing code in Bazaar.
 
 
3492
    Plugins can do a variety of things, including overriding commands,
 
 
3493
    adding new commands, providing additional network transports and
 
 
3494
    customizing log output.
 
 
3496
    See the Bazaar web site, http://bazaar-vcs.org, for further
 
 
3497
    information on plugins including where to find them and how to
 
 
3498
    install them. Instructions are also provided there on how to
 
 
3499
    write new plugins using the Python programming language.
 
 
3501
    takes_options = ['verbose']
 
 
3504
    def run(self, verbose=False):
 
 
3505
        import bzrlib.plugin
 
 
3506
        from inspect import getdoc
 
 
3508
        for name, plugin in bzrlib.plugin.plugins().items():
 
 
3509
            version = plugin.__version__
 
 
3510
            if version == 'unknown':
 
 
3512
            name_ver = '%s %s' % (name, version)
 
 
3513
            d = getdoc(plugin.module)
 
 
3515
                doc = d.split('\n')[0]
 
 
3517
                doc = '(no description)'
 
 
3518
            result.append((name_ver, doc, plugin.path()))
 
 
3519
        for name_ver, doc, path in sorted(result):
 
 
3527
class cmd_testament(Command):
 
 
3528
    """Show testament (signing-form) of a revision."""
 
 
3531
            Option('long', help='Produce long-format testament.'),
 
 
3533
                   help='Produce a strict-format testament.')]
 
 
3534
    takes_args = ['branch?']
 
 
3536
    def run(self, branch=u'.', revision=None, long=False, strict=False):
 
 
3537
        from bzrlib.testament import Testament, StrictTestament
 
 
3539
            testament_class = StrictTestament
 
 
3541
            testament_class = Testament
 
 
3542
        b = WorkingTree.open_containing(branch)[0].branch
 
 
3545
            if revision is None:
 
 
3546
                rev_id = b.last_revision()
 
 
3548
                rev_id = revision[0].as_revision_id(b)
 
 
3549
            t = testament_class.from_revision(b.repository, rev_id)
 
 
3551
                sys.stdout.writelines(t.as_text_lines())
 
 
3553
                sys.stdout.write(t.as_short_text())
 
 
3558
class cmd_annotate(Command):
 
 
3559
    """Show the origin of each line in a file.
 
 
3561
    This prints out the given file with an annotation on the left side
 
 
3562
    indicating which revision, author and date introduced the change.
 
 
3564
    If the origin is the same for a run of consecutive lines, it is 
 
 
3565
    shown only at the top, unless the --all option is given.
 
 
3567
    # TODO: annotate directories; showing when each file was last changed
 
 
3568
    # TODO: if the working copy is modified, show annotations on that 
 
 
3569
    #       with new uncommitted lines marked
 
 
3570
    aliases = ['ann', 'blame', 'praise']
 
 
3571
    takes_args = ['filename']
 
 
3572
    takes_options = [Option('all', help='Show annotations on all lines.'),
 
 
3573
                     Option('long', help='Show commit date in annotations.'),
 
 
3577
    encoding_type = 'exact'
 
 
3580
    def run(self, filename, all=False, long=False, revision=None,
 
 
3582
        from bzrlib.annotate import annotate_file
 
 
3583
        wt, branch, relpath = \
 
 
3584
            bzrdir.BzrDir.open_containing_tree_or_branch(filename)
 
 
3590
            if revision is None:
 
 
3591
                revision_id = branch.last_revision()
 
 
3592
            elif len(revision) != 1:
 
 
3593
                raise errors.BzrCommandError('bzr annotate --revision takes exactly 1 argument')
 
 
3595
                revision_id = revision[0].as_revision_id(branch)
 
 
3596
            tree = branch.repository.revision_tree(revision_id)
 
 
3598
                file_id = wt.path2id(relpath)
 
 
3600
                file_id = tree.path2id(relpath)
 
 
3602
                raise errors.NotVersionedError(filename)
 
 
3603
            file_version = tree.inventory[file_id].revision
 
 
3604
            annotate_file(branch, file_version, file_id, long, all, self.outf,
 
 
3613
class cmd_re_sign(Command):
 
 
3614
    """Create a digital signature for an existing revision."""
 
 
3615
    # TODO be able to replace existing ones.
 
 
3617
    hidden = True # is this right ?
 
 
3618
    takes_args = ['revision_id*']
 
 
3619
    takes_options = ['revision']
 
 
3621
    def run(self, revision_id_list=None, revision=None):
 
 
3622
        if revision_id_list is not None and revision is not None:
 
 
3623
            raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
 
 
3624
        if revision_id_list is None and revision is None:
 
 
3625
            raise errors.BzrCommandError('You must supply either --revision or a revision_id')
 
 
3626
        b = WorkingTree.open_containing(u'.')[0].branch
 
 
3629
            return self._run(b, revision_id_list, revision)
 
 
3633
    def _run(self, b, revision_id_list, revision):
 
 
3634
        import bzrlib.gpg as gpg
 
 
3635
        gpg_strategy = gpg.GPGStrategy(b.get_config())
 
 
3636
        if revision_id_list is not None:
 
 
3637
            b.repository.start_write_group()
 
 
3639
                for revision_id in revision_id_list:
 
 
3640
                    b.repository.sign_revision(revision_id, gpg_strategy)
 
 
3642
                b.repository.abort_write_group()
 
 
3645
                b.repository.commit_write_group()
 
 
3646
        elif revision is not None:
 
 
3647
            if len(revision) == 1:
 
 
3648
                revno, rev_id = revision[0].in_history(b)
 
 
3649
                b.repository.start_write_group()
 
 
3651
                    b.repository.sign_revision(rev_id, gpg_strategy)
 
 
3653
                    b.repository.abort_write_group()
 
 
3656
                    b.repository.commit_write_group()
 
 
3657
            elif len(revision) == 2:
 
 
3658
                # are they both on rh- if so we can walk between them
 
 
3659
                # might be nice to have a range helper for arbitrary
 
 
3660
                # revision paths. hmm.
 
 
3661
                from_revno, from_revid = revision[0].in_history(b)
 
 
3662
                to_revno, to_revid = revision[1].in_history(b)
 
 
3663
                if to_revid is None:
 
 
3664
                    to_revno = b.revno()
 
 
3665
                if from_revno is None or to_revno is None:
 
 
3666
                    raise errors.BzrCommandError('Cannot sign a range of non-revision-history revisions')
 
 
3667
                b.repository.start_write_group()
 
 
3669
                    for revno in range(from_revno, to_revno + 1):
 
 
3670
                        b.repository.sign_revision(b.get_rev_id(revno),
 
 
3673
                    b.repository.abort_write_group()
 
 
3676
                    b.repository.commit_write_group()
 
 
3678
                raise errors.BzrCommandError('Please supply either one revision, or a range.')
 
 
3681
class cmd_bind(Command):
 
 
3682
    """Convert the current branch into a checkout of the supplied branch.
 
 
3684
    Once converted into a checkout, commits must succeed on the master branch
 
 
3685
    before they will be applied to the local branch.
 
 
3688
    _see_also = ['checkouts', 'unbind']
 
 
3689
    takes_args = ['location?']
 
 
3692
    def run(self, location=None):
 
 
3693
        b, relpath = Branch.open_containing(u'.')
 
 
3694
        if location is None:
 
 
3696
                location = b.get_old_bound_location()
 
 
3697
            except errors.UpgradeRequired:
 
 
3698
                raise errors.BzrCommandError('No location supplied.  '
 
 
3699
                    'This format does not remember old locations.')
 
 
3701
                if location is None:
 
 
3702
                    raise errors.BzrCommandError('No location supplied and no '
 
 
3703
                        'previous location known')
 
 
3704
        b_other = Branch.open(location)
 
 
3707
        except errors.DivergedBranches:
 
 
3708
            raise errors.BzrCommandError('These branches have diverged.'
 
 
3709
                                         ' Try merging, and then bind again.')
 
 
3712
class cmd_unbind(Command):
 
 
3713
    """Convert the current checkout into a regular branch.
 
 
3715
    After unbinding, the local branch is considered independent and subsequent
 
 
3716
    commits will be local only.
 
 
3719
    _see_also = ['checkouts', 'bind']
 
 
3724
        b, relpath = Branch.open_containing(u'.')
 
 
3726
            raise errors.BzrCommandError('Local branch is not bound')
 
 
3729
class cmd_uncommit(Command):
 
 
3730
    """Remove the last committed revision.
 
 
3732
    --verbose will print out what is being removed.
 
 
3733
    --dry-run will go through all the motions, but not actually
 
 
3736
    If --revision is specified, uncommit revisions to leave the branch at the
 
 
3737
    specified revision.  For example, "bzr uncommit -r 15" will leave the
 
 
3738
    branch at revision 15.
 
 
3740
    Uncommit leaves the working tree ready for a new commit.  The only change
 
 
3741
    it may make is to restore any pending merges that were present before
 
 
3745
    # TODO: jam 20060108 Add an option to allow uncommit to remove
 
 
3746
    # unreferenced information in 'branch-as-repository' branches.
 
 
3747
    # TODO: jam 20060108 Add the ability for uncommit to remove unreferenced
 
 
3748
    # information in shared branches as well.
 
 
3749
    _see_also = ['commit']
 
 
3750
    takes_options = ['verbose', 'revision',
 
 
3751
                    Option('dry-run', help='Don\'t actually make changes.'),
 
 
3752
                    Option('force', help='Say yes to all questions.'),
 
 
3754
                           help="Only remove the commits from the local branch"
 
 
3755
                                " when in a checkout."
 
 
3758
    takes_args = ['location?']
 
 
3760
    encoding_type = 'replace'
 
 
3762
    def run(self, location=None,
 
 
3763
            dry_run=False, verbose=False,
 
 
3764
            revision=None, force=False, local=False):
 
 
3765
        if location is None:
 
 
3767
        control, relpath = bzrdir.BzrDir.open_containing(location)
 
 
3769
            tree = control.open_workingtree()
 
 
3771
        except (errors.NoWorkingTree, errors.NotLocalUrl):
 
 
3773
            b = control.open_branch()
 
 
3775
        if tree is not None:
 
 
3780
            return self._run(b, tree, dry_run, verbose, revision, force,
 
 
3783
            if tree is not None:
 
 
3788
    def _run(self, b, tree, dry_run, verbose, revision, force, local=False):
 
 
3789
        from bzrlib.log import log_formatter, show_log
 
 
3790
        from bzrlib.uncommit import uncommit
 
 
3792
        last_revno, last_rev_id = b.last_revision_info()
 
 
3795
        if revision is None:
 
 
3797
            rev_id = last_rev_id
 
 
3799
            # 'bzr uncommit -r 10' actually means uncommit
 
 
3800
            # so that the final tree is at revno 10.
 
 
3801
            # but bzrlib.uncommit.uncommit() actually uncommits
 
 
3802
            # the revisions that are supplied.
 
 
3803
            # So we need to offset it by one
 
 
3804
            revno = revision[0].in_history(b).revno + 1
 
 
3805
            if revno <= last_revno:
 
 
3806
                rev_id = b.get_rev_id(revno)
 
 
3808
        if rev_id is None or _mod_revision.is_null(rev_id):
 
 
3809
            self.outf.write('No revisions to uncommit.\n')
 
 
3812
        lf = log_formatter('short',
 
 
3814
                           show_timezone='original')
 
 
3819
                 direction='forward',
 
 
3820
                 start_revision=revno,
 
 
3821
                 end_revision=last_revno)
 
 
3824
            print 'Dry-run, pretending to remove the above revisions.'
 
 
3826
                val = raw_input('Press <enter> to continue')
 
 
3828
            print 'The above revision(s) will be removed.'
 
 
3830
                val = raw_input('Are you sure [y/N]? ')
 
 
3831
                if val.lower() not in ('y', 'yes'):
 
 
3835
        uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
 
 
3836
                 revno=revno, local=local)
 
 
3839
class cmd_break_lock(Command):
 
 
3840
    """Break a dead lock on a repository, branch or working directory.
 
 
3842
    CAUTION: Locks should only be broken when you are sure that the process
 
 
3843
    holding the lock has been stopped.
 
 
3845
    You can get information on what locks are open via the 'bzr info' command.
 
 
3850
    takes_args = ['location?']
 
 
3852
    def run(self, location=None, show=False):
 
 
3853
        if location is None:
 
 
3855
        control, relpath = bzrdir.BzrDir.open_containing(location)
 
 
3857
            control.break_lock()
 
 
3858
        except NotImplementedError:
 
 
3862
class cmd_wait_until_signalled(Command):
 
 
3863
    """Test helper for test_start_and_stop_bzr_subprocess_send_signal.
 
 
3865
    This just prints a line to signal when it is ready, then blocks on stdin.
 
 
3871
        sys.stdout.write("running\n")
 
 
3873
        sys.stdin.readline()
 
 
3876
class cmd_serve(Command):
 
 
3877
    """Run the bzr server."""
 
 
3879
    aliases = ['server']
 
 
3883
               help='Serve on stdin/out for use from inetd or sshd.'),
 
 
3885
               help='Listen for connections on nominated port of the form '
 
 
3886
                    '[hostname:]portnumber.  Passing 0 as the port number will '
 
 
3887
                    'result in a dynamically allocated port.  The default port is '
 
 
3891
               help='Serve contents of this directory.',
 
 
3893
        Option('allow-writes',
 
 
3894
               help='By default the server is a readonly server.  Supplying '
 
 
3895
                    '--allow-writes enables write access to the contents of '
 
 
3896
                    'the served directory and below.'
 
 
3900
    def run(self, port=None, inet=False, directory=None, allow_writes=False):
 
 
3901
        from bzrlib import lockdir
 
 
3902
        from bzrlib.smart import medium, server
 
 
3903
        from bzrlib.transport import get_transport
 
 
3904
        from bzrlib.transport.chroot import ChrootServer
 
 
3905
        if directory is None:
 
 
3906
            directory = os.getcwd()
 
 
3907
        url = urlutils.local_path_to_url(directory)
 
 
3908
        if not allow_writes:
 
 
3909
            url = 'readonly+' + url
 
 
3910
        chroot_server = ChrootServer(get_transport(url))
 
 
3911
        chroot_server.setUp()
 
 
3912
        t = get_transport(chroot_server.get_url())
 
 
3914
            smart_server = medium.SmartServerPipeStreamMedium(
 
 
3915
                sys.stdin, sys.stdout, t)
 
 
3917
            host = medium.BZR_DEFAULT_INTERFACE
 
 
3919
                port = medium.BZR_DEFAULT_PORT
 
 
3922
                    host, port = port.split(':')
 
 
3924
            smart_server = server.SmartTCPServer(t, host=host, port=port)
 
 
3925
            print 'listening on port: ', smart_server.port
 
 
3927
        # for the duration of this server, no UI output is permitted.
 
 
3928
        # note that this may cause problems with blackbox tests. This should
 
 
3929
        # be changed with care though, as we dont want to use bandwidth sending
 
 
3930
        # progress over stderr to smart server clients!
 
 
3931
        old_factory = ui.ui_factory
 
 
3932
        old_lockdir_timeout = lockdir._DEFAULT_TIMEOUT_SECONDS
 
 
3934
            ui.ui_factory = ui.SilentUIFactory()
 
 
3935
            lockdir._DEFAULT_TIMEOUT_SECONDS = 0
 
 
3936
            smart_server.serve()
 
 
3938
            ui.ui_factory = old_factory
 
 
3939
            lockdir._DEFAULT_TIMEOUT_SECONDS = old_lockdir_timeout
 
 
3942
class cmd_join(Command):
 
 
3943
    """Combine a subtree into its containing tree.
 
 
3945
    This command is for experimental use only.  It requires the target tree
 
 
3946
    to be in dirstate-with-subtree format, which cannot be converted into
 
 
3949
    The TREE argument should be an independent tree, inside another tree, but
 
 
3950
    not part of it.  (Such trees can be produced by "bzr split", but also by
 
 
3951
    running "bzr branch" with the target inside a tree.)
 
 
3953
    The result is a combined tree, with the subtree no longer an independant
 
 
3954
    part.  This is marked as a merge of the subtree into the containing tree,
 
 
3955
    and all history is preserved.
 
 
3957
    If --reference is specified, the subtree retains its independence.  It can
 
 
3958
    be branched by itself, and can be part of multiple projects at the same
 
 
3959
    time.  But operations performed in the containing tree, such as commit
 
 
3960
    and merge, will recurse into the subtree.
 
 
3963
    _see_also = ['split']
 
 
3964
    takes_args = ['tree']
 
 
3966
            Option('reference', help='Join by reference.'),
 
 
3970
    def run(self, tree, reference=False):
 
 
3971
        sub_tree = WorkingTree.open(tree)
 
 
3972
        parent_dir = osutils.dirname(sub_tree.basedir)
 
 
3973
        containing_tree = WorkingTree.open_containing(parent_dir)[0]
 
 
3974
        repo = containing_tree.branch.repository
 
 
3975
        if not repo.supports_rich_root():
 
 
3976
            raise errors.BzrCommandError(
 
 
3977
                "Can't join trees because %s doesn't support rich root data.\n"
 
 
3978
                "You can use bzr upgrade on the repository."
 
 
3982
                containing_tree.add_reference(sub_tree)
 
 
3983
            except errors.BadReferenceTarget, e:
 
 
3984
                # XXX: Would be better to just raise a nicely printable
 
 
3985
                # exception from the real origin.  Also below.  mbp 20070306
 
 
3986
                raise errors.BzrCommandError("Cannot join %s.  %s" %
 
 
3990
                containing_tree.subsume(sub_tree)
 
 
3991
            except errors.BadSubsumeSource, e:
 
 
3992
                raise errors.BzrCommandError("Cannot join %s.  %s" % 
 
 
3996
class cmd_split(Command):
 
 
3997
    """Split a subdirectory of a tree into a separate tree.
 
 
3999
    This command will produce a target tree in a format that supports
 
 
4000
    rich roots, like 'rich-root' or 'rich-root-pack'.  These formats cannot be
 
 
4001
    converted into earlier formats like 'dirstate-tags'.
 
 
4003
    The TREE argument should be a subdirectory of a working tree.  That
 
 
4004
    subdirectory will be converted into an independent tree, with its own
 
 
4005
    branch.  Commits in the top-level tree will not apply to the new subtree.
 
 
4008
    # join is not un-hidden yet
 
 
4009
    #_see_also = ['join']
 
 
4010
    takes_args = ['tree']
 
 
4012
    def run(self, tree):
 
 
4013
        containing_tree, subdir = WorkingTree.open_containing(tree)
 
 
4014
        sub_id = containing_tree.path2id(subdir)
 
 
4016
            raise errors.NotVersionedError(subdir)
 
 
4018
            containing_tree.extract(sub_id)
 
 
4019
        except errors.RootNotRich:
 
 
4020
            raise errors.UpgradeRequired(containing_tree.branch.base)
 
 
4023
class cmd_merge_directive(Command):
 
 
4024
    """Generate a merge directive for auto-merge tools.
 
 
4026
    A directive requests a merge to be performed, and also provides all the
 
 
4027
    information necessary to do so.  This means it must either include a
 
 
4028
    revision bundle, or the location of a branch containing the desired
 
 
4031
    A submit branch (the location to merge into) must be supplied the first
 
 
4032
    time the command is issued.  After it has been supplied once, it will
 
 
4033
    be remembered as the default.
 
 
4035
    A public branch is optional if a revision bundle is supplied, but required
 
 
4036
    if --diff or --plain is specified.  It will be remembered as the default
 
 
4037
    after the first use.
 
 
4040
    takes_args = ['submit_branch?', 'public_branch?']
 
 
4044
    _see_also = ['send']
 
 
4047
        RegistryOption.from_kwargs('patch-type',
 
 
4048
            'The type of patch to include in the directive.',
 
 
4050
            value_switches=True,
 
 
4052
            bundle='Bazaar revision bundle (default).',
 
 
4053
            diff='Normal unified diff.',
 
 
4054
            plain='No patch, just directive.'),
 
 
4055
        Option('sign', help='GPG-sign the directive.'), 'revision',
 
 
4056
        Option('mail-to', type=str,
 
 
4057
            help='Instead of printing the directive, email to this address.'),
 
 
4058
        Option('message', type=str, short_name='m',
 
 
4059
            help='Message to use when committing this merge.')
 
 
4062
    encoding_type = 'exact'
 
 
4064
    def run(self, submit_branch=None, public_branch=None, patch_type='bundle',
 
 
4065
            sign=False, revision=None, mail_to=None, message=None):
 
 
4066
        from bzrlib.revision import ensure_null, NULL_REVISION
 
 
4067
        include_patch, include_bundle = {
 
 
4068
            'plain': (False, False),
 
 
4069
            'diff': (True, False),
 
 
4070
            'bundle': (True, True),
 
 
4072
        branch = Branch.open('.')
 
 
4073
        stored_submit_branch = branch.get_submit_branch()
 
 
4074
        if submit_branch is None:
 
 
4075
            submit_branch = stored_submit_branch
 
 
4077
            if stored_submit_branch is None:
 
 
4078
                branch.set_submit_branch(submit_branch)
 
 
4079
        if submit_branch is None:
 
 
4080
            submit_branch = branch.get_parent()
 
 
4081
        if submit_branch is None:
 
 
4082
            raise errors.BzrCommandError('No submit branch specified or known')
 
 
4084
        stored_public_branch = branch.get_public_branch()
 
 
4085
        if public_branch is None:
 
 
4086
            public_branch = stored_public_branch
 
 
4087
        elif stored_public_branch is None:
 
 
4088
            branch.set_public_branch(public_branch)
 
 
4089
        if not include_bundle and public_branch is None:
 
 
4090
            raise errors.BzrCommandError('No public branch specified or'
 
 
4092
        base_revision_id = None
 
 
4093
        if revision is not None:
 
 
4094
            if len(revision) > 2:
 
 
4095
                raise errors.BzrCommandError('bzr merge-directive takes '
 
 
4096
                    'at most two one revision identifiers')
 
 
4097
            revision_id = revision[-1].as_revision_id(branch)
 
 
4098
            if len(revision) == 2:
 
 
4099
                base_revision_id = revision[0].as_revision_id(branch)
 
 
4101
            revision_id = branch.last_revision()
 
 
4102
        revision_id = ensure_null(revision_id)
 
 
4103
        if revision_id == NULL_REVISION:
 
 
4104
            raise errors.BzrCommandError('No revisions to bundle.')
 
 
4105
        directive = merge_directive.MergeDirective2.from_objects(
 
 
4106
            branch.repository, revision_id, time.time(),
 
 
4107
            osutils.local_time_offset(), submit_branch,
 
 
4108
            public_branch=public_branch, include_patch=include_patch,
 
 
4109
            include_bundle=include_bundle, message=message,
 
 
4110
            base_revision_id=base_revision_id)
 
 
4113
                self.outf.write(directive.to_signed(branch))
 
 
4115
                self.outf.writelines(directive.to_lines())
 
 
4117
            message = directive.to_email(mail_to, branch, sign)
 
 
4118
            s = SMTPConnection(branch.get_config())
 
 
4119
            s.send_email(message)
 
 
4122
class cmd_send(Command):
 
 
4123
    """Mail or create a merge-directive for submiting changes.
 
 
4125
    A merge directive provides many things needed for requesting merges:
 
 
4127
    * A machine-readable description of the merge to perform
 
 
4129
    * An optional patch that is a preview of the changes requested
 
 
4131
    * An optional bundle of revision data, so that the changes can be applied
 
 
4132
      directly from the merge directive, without retrieving data from a
 
 
4135
    If --no-bundle is specified, then public_branch is needed (and must be
 
 
4136
    up-to-date), so that the receiver can perform the merge using the
 
 
4137
    public_branch.  The public_branch is always included if known, so that
 
 
4138
    people can check it later.
 
 
4140
    The submit branch defaults to the parent, but can be overridden.  Both
 
 
4141
    submit branch and public branch will be remembered if supplied.
 
 
4143
    If a public_branch is known for the submit_branch, that public submit
 
 
4144
    branch is used in the merge instructions.  This means that a local mirror
 
 
4145
    can be used as your actual submit branch, once you have set public_branch
 
 
4148
    Mail is sent using your preferred mail program.  This should be transparent
 
 
4149
    on Windows (it uses MAPI).  On Linux, it requires the xdg-email utility.
 
 
4150
    If the preferred client can't be found (or used), your editor will be used.
 
 
4152
    To use a specific mail program, set the mail_client configuration option.
 
 
4153
    (For Thunderbird 1.5, this works around some bugs.)  Supported values for
 
 
4154
    specific clients are "evolution", "kmail", "mutt", and "thunderbird";
 
 
4155
    generic options are "default", "editor", "mapi", and "xdg-email".
 
 
4157
    If mail is being sent, a to address is required.  This can be supplied
 
 
4158
    either on the commandline, by setting the submit_to configuration
 
 
4159
    option in the branch itself or the child_submit_to configuration option 
 
 
4160
    in the submit branch.
 
 
4162
    Two formats are currently supported: "4" uses revision bundle format 4 and
 
 
4163
    merge directive format 2.  It is significantly faster and smaller than
 
 
4164
    older formats.  It is compatible with Bazaar 0.19 and later.  It is the
 
 
4165
    default.  "0.9" uses revision bundle format 0.9 and merge directive
 
 
4166
    format 1.  It is compatible with Bazaar 0.12 - 0.18.
 
 
4168
    Merge directives are applied using the merge command or the pull command.
 
 
4171
    encoding_type = 'exact'
 
 
4173
    _see_also = ['merge', 'pull']
 
 
4175
    takes_args = ['submit_branch?', 'public_branch?']
 
 
4179
               help='Do not include a bundle in the merge directive.'),
 
 
4180
        Option('no-patch', help='Do not include a preview patch in the merge'
 
 
4183
               help='Remember submit and public branch.'),
 
 
4185
               help='Branch to generate the submission from, '
 
 
4186
               'rather than the one containing the working directory.',
 
 
4189
        Option('output', short_name='o',
 
 
4190
               help='Write merge directive to this file; '
 
 
4191
                    'use - for stdout.',
 
 
4193
        Option('mail-to', help='Mail the request to this address.',
 
 
4197
        RegistryOption.from_kwargs('format',
 
 
4198
        'Use the specified output format.',
 
 
4199
        **{'4': 'Bundle format 4, Merge Directive 2 (default)',
 
 
4200
           '0.9': 'Bundle format 0.9, Merge Directive 1',})
 
 
4203
    def run(self, submit_branch=None, public_branch=None, no_bundle=False,
 
 
4204
            no_patch=False, revision=None, remember=False, output=None,
 
 
4205
            format='4', mail_to=None, message=None, **kwargs):
 
 
4206
        return self._run(submit_branch, revision, public_branch, remember,
 
 
4207
                         format, no_bundle, no_patch, output,
 
 
4208
                         kwargs.get('from', '.'), mail_to, message)
 
 
4210
    def _run(self, submit_branch, revision, public_branch, remember, format,
 
 
4211
             no_bundle, no_patch, output, from_, mail_to, message):
 
 
4212
        from bzrlib.revision import NULL_REVISION
 
 
4213
        branch = Branch.open_containing(from_)[0]
 
 
4215
            outfile = StringIO()
 
 
4219
            outfile = open(output, 'wb')
 
 
4220
        # we may need to write data into branch's repository to calculate
 
 
4225
                config = branch.get_config()
 
 
4227
                    mail_to = config.get_user_option('submit_to')
 
 
4228
                mail_client = config.get_mail_client()
 
 
4229
            if remember and submit_branch is None:
 
 
4230
                raise errors.BzrCommandError(
 
 
4231
                    '--remember requires a branch to be specified.')
 
 
4232
            stored_submit_branch = branch.get_submit_branch()
 
 
4233
            remembered_submit_branch = False
 
 
4234
            if submit_branch is None:
 
 
4235
                submit_branch = stored_submit_branch
 
 
4236
                remembered_submit_branch = True
 
 
4238
                if stored_submit_branch is None or remember:
 
 
4239
                    branch.set_submit_branch(submit_branch)
 
 
4240
            if submit_branch is None:
 
 
4241
                submit_branch = branch.get_parent()
 
 
4242
                remembered_submit_branch = True
 
 
4243
            if submit_branch is None:
 
 
4244
                raise errors.BzrCommandError('No submit branch known or'
 
 
4246
            if remembered_submit_branch:
 
 
4247
                note('Using saved location: %s', submit_branch)
 
 
4250
                submit_config = Branch.open(submit_branch).get_config()
 
 
4251
                mail_to = submit_config.get_user_option("child_submit_to")
 
 
4253
            stored_public_branch = branch.get_public_branch()
 
 
4254
            if public_branch is None:
 
 
4255
                public_branch = stored_public_branch
 
 
4256
            elif stored_public_branch is None or remember:
 
 
4257
                branch.set_public_branch(public_branch)
 
 
4258
            if no_bundle and public_branch is None:
 
 
4259
                raise errors.BzrCommandError('No public branch specified or'
 
 
4261
            base_revision_id = None
 
 
4263
            if revision is not None:
 
 
4264
                if len(revision) > 2:
 
 
4265
                    raise errors.BzrCommandError('bzr send takes '
 
 
4266
                        'at most two one revision identifiers')
 
 
4267
                revision_id = revision[-1].as_revision_id(branch)
 
 
4268
                if len(revision) == 2:
 
 
4269
                    base_revision_id = revision[0].as_revision_id(branch)
 
 
4270
            if revision_id is None:
 
 
4271
                revision_id = branch.last_revision()
 
 
4272
            if revision_id == NULL_REVISION:
 
 
4273
                raise errors.BzrCommandError('No revisions to submit.')
 
 
4275
                directive = merge_directive.MergeDirective2.from_objects(
 
 
4276
                    branch.repository, revision_id, time.time(),
 
 
4277
                    osutils.local_time_offset(), submit_branch,
 
 
4278
                    public_branch=public_branch, include_patch=not no_patch,
 
 
4279
                    include_bundle=not no_bundle, message=message,
 
 
4280
                    base_revision_id=base_revision_id)
 
 
4281
            elif format == '0.9':
 
 
4284
                        patch_type = 'bundle'
 
 
4286
                        raise errors.BzrCommandError('Format 0.9 does not'
 
 
4287
                            ' permit bundle with no patch')
 
 
4293
                directive = merge_directive.MergeDirective.from_objects(
 
 
4294
                    branch.repository, revision_id, time.time(),
 
 
4295
                    osutils.local_time_offset(), submit_branch,
 
 
4296
                    public_branch=public_branch, patch_type=patch_type,
 
 
4299
            outfile.writelines(directive.to_lines())
 
 
4301
                subject = '[MERGE] '
 
 
4302
                if message is not None:
 
 
4305
                    revision = branch.repository.get_revision(revision_id)
 
 
4306
                    subject += revision.get_summary()
 
 
4307
                basename = directive.get_disk_name(branch)
 
 
4308
                mail_client.compose_merge_request(mail_to, subject,
 
 
4309
                                                  outfile.getvalue(), basename)
 
 
4316
class cmd_bundle_revisions(cmd_send):
 
 
4318
    """Create a merge-directive for submiting changes.
 
 
4320
    A merge directive provides many things needed for requesting merges:
 
 
4322
    * A machine-readable description of the merge to perform
 
 
4324
    * An optional patch that is a preview of the changes requested
 
 
4326
    * An optional bundle of revision data, so that the changes can be applied
 
 
4327
      directly from the merge directive, without retrieving data from a
 
 
4330
    If --no-bundle is specified, then public_branch is needed (and must be
 
 
4331
    up-to-date), so that the receiver can perform the merge using the
 
 
4332
    public_branch.  The public_branch is always included if known, so that
 
 
4333
    people can check it later.
 
 
4335
    The submit branch defaults to the parent, but can be overridden.  Both
 
 
4336
    submit branch and public branch will be remembered if supplied.
 
 
4338
    If a public_branch is known for the submit_branch, that public submit
 
 
4339
    branch is used in the merge instructions.  This means that a local mirror
 
 
4340
    can be used as your actual submit branch, once you have set public_branch
 
 
4343
    Two formats are currently supported: "4" uses revision bundle format 4 and
 
 
4344
    merge directive format 2.  It is significantly faster and smaller than
 
 
4345
    older formats.  It is compatible with Bazaar 0.19 and later.  It is the
 
 
4346
    default.  "0.9" uses revision bundle format 0.9 and merge directive
 
 
4347
    format 1.  It is compatible with Bazaar 0.12 - 0.18.
 
 
4352
               help='Do not include a bundle in the merge directive.'),
 
 
4353
        Option('no-patch', help='Do not include a preview patch in the merge'
 
 
4356
               help='Remember submit and public branch.'),
 
 
4358
               help='Branch to generate the submission from, '
 
 
4359
               'rather than the one containing the working directory.',
 
 
4362
        Option('output', short_name='o', help='Write directive to this file.',
 
 
4365
        RegistryOption.from_kwargs('format',
 
 
4366
        'Use the specified output format.',
 
 
4367
        **{'4': 'Bundle format 4, Merge Directive 2 (default)',
 
 
4368
           '0.9': 'Bundle format 0.9, Merge Directive 1',})
 
 
4370
    aliases = ['bundle']
 
 
4372
    _see_also = ['send', 'merge']
 
 
4376
    def run(self, submit_branch=None, public_branch=None, no_bundle=False,
 
 
4377
            no_patch=False, revision=None, remember=False, output=None,
 
 
4378
            format='4', **kwargs):
 
 
4381
        return self._run(submit_branch, revision, public_branch, remember,
 
 
4382
                         format, no_bundle, no_patch, output,
 
 
4383
                         kwargs.get('from', '.'), None, None)
 
 
4386
class cmd_tag(Command):
 
 
4387
    """Create, remove or modify a tag naming a revision.
 
 
4389
    Tags give human-meaningful names to revisions.  Commands that take a -r
 
 
4390
    (--revision) option can be given -rtag:X, where X is any previously
 
 
4393
    Tags are stored in the branch.  Tags are copied from one branch to another
 
 
4394
    along when you branch, push, pull or merge.
 
 
4396
    It is an error to give a tag name that already exists unless you pass 
 
 
4397
    --force, in which case the tag is moved to point to the new revision.
 
 
4400
    _see_also = ['commit', 'tags']
 
 
4401
    takes_args = ['tag_name']
 
 
4404
            help='Delete this tag rather than placing it.',
 
 
4407
            help='Branch in which to place the tag.',
 
 
4412
            help='Replace existing tags.',
 
 
4417
    def run(self, tag_name,
 
 
4423
        branch, relpath = Branch.open_containing(directory)
 
 
4427
                branch.tags.delete_tag(tag_name)
 
 
4428
                self.outf.write('Deleted tag %s.\n' % tag_name)
 
 
4431
                    if len(revision) != 1:
 
 
4432
                        raise errors.BzrCommandError(
 
 
4433
                            "Tags can only be placed on a single revision, "
 
 
4435
                    revision_id = revision[0].as_revision_id(branch)
 
 
4437
                    revision_id = branch.last_revision()
 
 
4438
                if (not force) and branch.tags.has_tag(tag_name):
 
 
4439
                    raise errors.TagAlreadyExists(tag_name)
 
 
4440
                branch.tags.set_tag(tag_name, revision_id)
 
 
4441
                self.outf.write('Created tag %s.\n' % tag_name)
 
 
4446
class cmd_tags(Command):
 
 
4449
    This command shows a table of tag names and the revisions they reference.
 
 
4455
            help='Branch whose tags should be displayed.',
 
 
4459
        RegistryOption.from_kwargs('sort',
 
 
4460
            'Sort tags by different criteria.', title='Sorting',
 
 
4461
            alpha='Sort tags lexicographically (default).',
 
 
4462
            time='Sort tags chronologically.',
 
 
4473
        branch, relpath = Branch.open_containing(directory)
 
 
4474
        tags = branch.tags.get_tag_dict().items()
 
 
4477
        elif sort == 'time':
 
 
4479
            for tag, revid in tags:
 
 
4481
                    revobj = branch.repository.get_revision(revid)
 
 
4482
                except errors.NoSuchRevision:
 
 
4483
                    timestamp = sys.maxint # place them at the end
 
 
4485
                    timestamp = revobj.timestamp
 
 
4486
                timestamps[revid] = timestamp
 
 
4487
            tags.sort(key=lambda x: timestamps[x[1]])
 
 
4489
            # [ (tag, revid), ... ] -> [ (tag, dotted_revno), ... ]
 
 
4490
            revno_map = branch.get_revision_id_to_revno_map()
 
 
4491
            tags = [ (tag, '.'.join(map(str, revno_map.get(revid, ('?',)))))
 
 
4492
                        for tag, revid in tags ]
 
 
4493
        for tag, revspec in tags:
 
 
4494
            self.outf.write('%-20s %s\n' % (tag, revspec))
 
 
4497
class cmd_reconfigure(Command):
 
 
4498
    """Reconfigure the type of a bzr directory.
 
 
4500
    A target configuration must be specified.
 
 
4502
    For checkouts, the bind-to location will be auto-detected if not specified.
 
 
4503
    The order of preference is
 
 
4504
    1. For a lightweight checkout, the current bound location.
 
 
4505
    2. For branches that used to be checkouts, the previously-bound location.
 
 
4506
    3. The push location.
 
 
4507
    4. The parent location.
 
 
4508
    If none of these is available, --bind-to must be specified.
 
 
4511
    takes_args = ['location?']
 
 
4512
    takes_options = [RegistryOption.from_kwargs('target_type',
 
 
4513
                     title='Target type',
 
 
4514
                     help='The type to reconfigure the directory to.',
 
 
4515
                     value_switches=True, enum_switch=False,
 
 
4516
                     branch='Reconfigure to a branch.',
 
 
4517
                     tree='Reconfigure to a tree.',
 
 
4518
                     checkout='Reconfigure to a checkout.',
 
 
4519
                     lightweight_checkout='Reconfigure to a lightweight'
 
 
4521
                     standalone='Reconfigure to be standalone.',
 
 
4522
                     use_shared='Reconfigure to use a shared repository.'),
 
 
4523
                     Option('bind-to', help='Branch to bind checkout to.',
 
 
4526
                        help='Perform reconfiguration even if local changes'
 
 
4530
    def run(self, location=None, target_type=None, bind_to=None, force=False):
 
 
4531
        directory = bzrdir.BzrDir.open(location)
 
 
4532
        if target_type is None:
 
 
4533
            raise errors.BzrCommandError('No target configuration specified')
 
 
4534
        elif target_type == 'branch':
 
 
4535
            reconfiguration = reconfigure.Reconfigure.to_branch(directory)
 
 
4536
        elif target_type == 'tree':
 
 
4537
            reconfiguration = reconfigure.Reconfigure.to_tree(directory)
 
 
4538
        elif target_type == 'checkout':
 
 
4539
            reconfiguration = reconfigure.Reconfigure.to_checkout(directory,
 
 
4541
        elif target_type == 'lightweight-checkout':
 
 
4542
            reconfiguration = reconfigure.Reconfigure.to_lightweight_checkout(
 
 
4544
        elif target_type == 'use-shared':
 
 
4545
            reconfiguration = reconfigure.Reconfigure.to_use_shared(directory)
 
 
4546
        elif target_type == 'standalone':
 
 
4547
            reconfiguration = reconfigure.Reconfigure.to_standalone(directory)
 
 
4548
        reconfiguration.apply(force)
 
 
4551
class cmd_switch(Command):
 
 
4552
    """Set the branch of a checkout and update.
 
 
4554
    For lightweight checkouts, this changes the branch being referenced.
 
 
4555
    For heavyweight checkouts, this checks that there are no local commits
 
 
4556
    versus the current bound branch, then it makes the local branch a mirror
 
 
4557
    of the new location and binds to it.
 
 
4559
    In both cases, the working tree is updated and uncommitted changes
 
 
4560
    are merged. The user can commit or revert these as they desire.
 
 
4562
    Pending merges need to be committed or reverted before using switch.
 
 
4564
    The path to the branch to switch to can be specified relative to the parent
 
 
4565
    directory of the current branch. For example, if you are currently in a
 
 
4566
    checkout of /path/to/branch, specifying 'newbranch' will find a branch at
 
 
4570
    takes_args = ['to_location']
 
 
4571
    takes_options = [Option('force',
 
 
4572
                        help='Switch even if local commits will be lost.')
 
 
4575
    def run(self, to_location, force=False):
 
 
4576
        from bzrlib import switch
 
 
4578
        control_dir = bzrdir.BzrDir.open_containing(tree_location)[0]
 
 
4580
            to_branch = Branch.open(to_location)
 
 
4581
        except errors.NotBranchError:
 
 
4582
            to_branch = Branch.open(
 
 
4583
                control_dir.open_branch().base + '../' + to_location)
 
 
4584
        switch.switch(control_dir, to_branch, force)
 
 
4585
        note('Switched to branch: %s',
 
 
4586
            urlutils.unescape_for_display(to_branch.base, 'utf-8'))
 
 
4589
class cmd_hooks(Command):
 
 
4590
    """Show a branch's currently registered hooks.
 
 
4594
    takes_args = ['path?']
 
 
4596
    def run(self, path=None):
 
 
4599
        branch_hooks = Branch.open(path).hooks
 
 
4600
        for hook_type in branch_hooks:
 
 
4601
            hooks = branch_hooks[hook_type]
 
 
4602
            self.outf.write("%s:\n" % (hook_type,))
 
 
4605
                    self.outf.write("  %s\n" %
 
 
4606
                                    (branch_hooks.get_hook_name(hook),))
 
 
4608
                self.outf.write("  <no hooks installed>\n")
 
 
4611
def _create_prefix(cur_transport):
 
 
4612
    needed = [cur_transport]
 
 
4613
    # Recurse upwards until we can create a directory successfully
 
 
4615
        new_transport = cur_transport.clone('..')
 
 
4616
        if new_transport.base == cur_transport.base:
 
 
4617
            raise errors.BzrCommandError(
 
 
4618
                "Failed to create path prefix for %s."
 
 
4619
                % cur_transport.base)
 
 
4621
            new_transport.mkdir('.')
 
 
4622
        except errors.NoSuchFile:
 
 
4623
            needed.append(new_transport)
 
 
4624
            cur_transport = new_transport
 
 
4627
    # Now we only need to create child directories
 
 
4629
        cur_transport = needed.pop()
 
 
4630
        cur_transport.ensure_base()
 
 
4633
# these get imported and then picked up by the scan for cmd_*
 
 
4634
# TODO: Some more consistent way to split command definitions across files;
 
 
4635
# we do need to load at least some information about them to know of 
 
 
4636
# aliases.  ideally we would avoid loading the implementation until the
 
 
4637
# details were needed.
 
 
4638
from bzrlib.cmd_version_info import cmd_version_info
 
 
4639
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore
 
 
4640
from bzrlib.bundle.commands import (
 
 
4643
from bzrlib.sign_my_commits import cmd_sign_my_commits
 
 
4644
from bzrlib.weave_commands import cmd_versionedfile_list, \
 
 
4645
        cmd_weave_plan_merge, cmd_weave_merge_text