← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/builtins.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2007-03-11 21:12:06 UTC
  • mfrom: (2321.2.6 mergeable)
  • Revision ID: pqm@pqm.ubuntu.com-20070311211206-0fd0176ac1e77ef7
(bialix) 0.15 NEWS cleanup

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/builtins.py
 
1
# Copyright (C) 2004, 2005, 2006, 2007 Canonical Ltd
 
2
#
 
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.
 
7
#
 
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.
 
12
#
 
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
 
16
 
 
17
"""builtin bzr commands"""
 
18
 
 
19
import os
 
20
from StringIO import StringIO
 
21
 
 
22
from bzrlib.lazy_import import lazy_import
 
23
lazy_import(globals(), """
 
24
import codecs
 
25
import errno
 
26
import smtplib
 
27
import sys
 
28
import tempfile
 
29
import time
 
30
 
 
31
import bzrlib
 
32
from bzrlib import (
 
33
    branch,
 
34
    bundle,
 
35
    bzrdir,
 
36
    delta,
 
37
    config,
 
38
    errors,
 
39
    globbing,
 
40
    ignores,
 
41
    log,
 
42
    merge as _mod_merge,
 
43
    merge_directive,
 
44
    osutils,
 
45
    registry,
 
46
    repository,
 
47
    symbol_versioning,
 
48
    transport,
 
49
    tree as _mod_tree,
 
50
    ui,
 
51
    urlutils,
 
52
    )
 
53
from bzrlib.branch import Branch
 
54
from bzrlib.bundle.apply_bundle import install_bundle, merge_bundle
 
55
from bzrlib.conflicts import ConflictList
 
56
from bzrlib.revision import common_ancestor
 
57
from bzrlib.revisionspec import RevisionSpec
 
58
from bzrlib.workingtree import WorkingTree
 
59
""")
 
60
 
 
61
from bzrlib.commands import Command, display_command
 
62
from bzrlib.option import Option, RegistryOption
 
63
from bzrlib.progress import DummyProgress, ProgressPhase
 
64
from bzrlib.trace import mutter, note, log_error, warning, is_quiet, info
 
65
 
 
66
 
 
67
def tree_files(file_list, default_branch=u'.'):
 
68
    try:
 
69
        return internal_tree_files(file_list, default_branch)
 
70
    except errors.FileInWrongBranch, e:
 
71
        raise errors.BzrCommandError("%s is not in the same branch as %s" %
 
72
                                     (e.path, file_list[0]))
 
73
 
 
74
 
 
75
# XXX: Bad function name; should possibly also be a class method of
 
76
# WorkingTree rather than a function.
 
77
def internal_tree_files(file_list, default_branch=u'.'):
 
78
    """Convert command-line paths to a WorkingTree and relative paths.
 
79
 
 
80
    This is typically used for command-line processors that take one or
 
81
    more filenames, and infer the workingtree that contains them.
 
82
 
 
83
    The filenames given are not required to exist.
 
84
 
 
85
    :param file_list: Filenames to convert.  
 
86
 
 
87
    :param default_branch: Fallback tree path to use if file_list is empty or
 
88
        None.
 
89
 
 
90
    :return: workingtree, [relative_paths]
 
91
    """
 
92
    if file_list is None or len(file_list) == 0:
 
93
        return WorkingTree.open_containing(default_branch)[0], file_list
 
94
    tree = WorkingTree.open_containing(osutils.realpath(file_list[0]))[0]
 
95
    new_list = []
 
96
    for filename in file_list:
 
97
        try:
 
98
            new_list.append(tree.relpath(osutils.dereference_path(filename)))
 
99
        except errors.PathNotChild:
 
100
            raise errors.FileInWrongBranch(tree.branch, filename)
 
101
    return tree, new_list
 
102
 
 
103
 
 
104
@symbol_versioning.deprecated_function(symbol_versioning.zero_fifteen)
 
105
def get_format_type(typestring):
 
106
    """Parse and return a format specifier."""
 
107
    # Have to use BzrDirMetaFormat1 directly, so that
 
108
    # RepositoryFormat.set_default_format works
 
109
    if typestring == "default":
 
110
        return bzrdir.BzrDirMetaFormat1()
 
111
    try:
 
112
        return bzrdir.format_registry.make_bzrdir(typestring)
 
113
    except KeyError:
 
114
        msg = 'Unknown bzr format "%s". See "bzr help formats".' % typestring
 
115
        raise errors.BzrCommandError(msg)
 
116
 
 
117
 
 
118
# TODO: Make sure no commands unconditionally use the working directory as a
 
119
# branch.  If a filename argument is used, the first of them should be used to
 
120
# specify the branch.  (Perhaps this can be factored out into some kind of
 
121
# Argument class, representing a file in a branch, where the first occurrence
 
122
# opens the branch?)
 
123
 
 
124
class cmd_status(Command):
 
125
    """Display status summary.
 
126
 
 
127
    This reports on versioned and unknown files, reporting them
 
128
    grouped by state.  Possible states are:
 
129
 
 
130
    added
 
131
        Versioned in the working copy but not in the previous revision.
 
132
 
 
133
    removed
 
134
        Versioned in the previous revision but removed or deleted
 
135
        in the working copy.
 
136
 
 
137
    renamed
 
138
        Path of this file changed from the previous revision;
 
139
        the text may also have changed.  This includes files whose
 
140
        parent directory was renamed.
 
141
 
 
142
    modified
 
143
        Text has changed since the previous revision.
 
144
 
 
145
    kind changed
 
146
        File kind has been changed (e.g. from file to directory).
 
147
 
 
148
    unknown
 
149
        Not versioned and not matching an ignore pattern.
 
150
 
 
151
    To see ignored files use 'bzr ignored'.  For details in the
 
152
    changes to file texts, use 'bzr diff'.
 
153
    
 
154
    --short gives a status flags for each item, similar to the SVN's status
 
155
    command.
 
156
 
 
157
    Column 1: versioning / renames
 
158
      + File versioned
 
159
      - File unversioned
 
160
      R File renamed
 
161
      ? File unknown
 
162
      C File has conflicts
 
163
      P Entry for a pending merge (not a file)
 
164
 
 
165
    Column 2: Contents
 
166
      N File created
 
167
      D File deleted
 
168
      K File kind changed
 
169
      M File modified
 
170
 
 
171
    Column 3: Execute
 
172
      * The execute bit was changed
 
173
 
 
174
    If no arguments are specified, the status of the entire working
 
175
    directory is shown.  Otherwise, only the status of the specified
 
176
    files or directories is reported.  If a directory is given, status
 
177
    is reported for everything inside that directory.
 
178
 
 
179
    If a revision argument is given, the status is calculated against
 
180
    that revision, or between two revisions if two are provided.
 
181
    """
 
182
    
 
183
    # TODO: --no-recurse, --recurse options
 
184
    
 
185
    takes_args = ['file*']
 
186
    takes_options = ['show-ids', 'revision', 'short']
 
187
    aliases = ['st', 'stat']
 
188
 
 
189
    encoding_type = 'replace'
 
190
    
 
191
    @display_command
 
192
    def run(self, show_ids=False, file_list=None, revision=None, short=False):
 
193
        from bzrlib.status import show_tree_status
 
194
 
 
195
        tree, file_list = tree_files(file_list)
 
196
            
 
197
        show_tree_status(tree, show_ids=show_ids,
 
198
                         specific_files=file_list, revision=revision,
 
199
                         to_file=self.outf,
 
200
                         short=short)
 
201
 
 
202
 
 
203
class cmd_cat_revision(Command):
 
204
    """Write out metadata for a revision.
 
205
    
 
206
    The revision to print can either be specified by a specific
 
207
    revision identifier, or you can use --revision.
 
208
    """
 
209
 
 
210
    hidden = True
 
211
    takes_args = ['revision_id?']
 
212
    takes_options = ['revision']
 
213
    # cat-revision is more for frontends so should be exact
 
214
    encoding = 'strict'
 
215
    
 
216
    @display_command
 
217
    def run(self, revision_id=None, revision=None):
 
218
 
 
219
        if revision_id is not None and revision is not None:
 
220
            raise errors.BzrCommandError('You can only supply one of'
 
221
                                         ' revision_id or --revision')
 
222
        if revision_id is None and revision is None:
 
223
            raise errors.BzrCommandError('You must supply either'
 
224
                                         ' --revision or a revision_id')
 
225
        b = WorkingTree.open_containing(u'.')[0].branch
 
226
 
 
227
        # TODO: jam 20060112 should cat-revision always output utf-8?
 
228
        if revision_id is not None:
 
229
            self.outf.write(b.repository.get_revision_xml(revision_id).decode('utf-8'))
 
230
        elif revision is not None:
 
231
            for rev in revision:
 
232
                if rev is None:
 
233
                    raise errors.BzrCommandError('You cannot specify a NULL'
 
234
                                                 ' revision.')
 
235
                revno, rev_id = rev.in_history(b)
 
236
                self.outf.write(b.repository.get_revision_xml(rev_id).decode('utf-8'))
 
237
    
 
238
 
 
239
class cmd_remove_tree(Command):
 
240
    """Remove the working tree from a given branch/checkout.
 
241
 
 
242
    Since a lightweight checkout is little more than a working tree
 
243
    this will refuse to run against one.
 
244
    """
 
245
 
 
246
    takes_args = ['location?']
 
247
 
 
248
    def run(self, location='.'):
 
249
        d = bzrdir.BzrDir.open(location)
 
250
        
 
251
        try:
 
252
            working = d.open_workingtree()
 
253
        except errors.NoWorkingTree:
 
254
            raise errors.BzrCommandError("No working tree to remove")
 
255
        except errors.NotLocalUrl:
 
256
            raise errors.BzrCommandError("You cannot remove the working tree of a "
 
257
                                         "remote path")
 
258
        
 
259
        working_path = working.bzrdir.root_transport.base
 
260
        branch_path = working.branch.bzrdir.root_transport.base
 
261
        if working_path != branch_path:
 
262
            raise errors.BzrCommandError("You cannot remove the working tree from "
 
263
                                         "a lightweight checkout")
 
264
        
 
265
        d.destroy_workingtree()
 
266
        
 
267
 
 
268
class cmd_revno(Command):
 
269
    """Show current revision number.
 
270
 
 
271
    This is equal to the number of revisions on this branch.
 
272
    """
 
273
 
 
274
    takes_args = ['location?']
 
275
 
 
276
    @display_command
 
277
    def run(self, location=u'.'):
 
278
        self.outf.write(str(Branch.open_containing(location)[0].revno()))
 
279
        self.outf.write('\n')
 
280
 
 
281
 
 
282
class cmd_revision_info(Command):
 
283
    """Show revision number and revision id for a given revision identifier.
 
284
    """
 
285
    hidden = True
 
286
    takes_args = ['revision_info*']
 
287
    takes_options = ['revision']
 
288
 
 
289
    @display_command
 
290
    def run(self, revision=None, revision_info_list=[]):
 
291
 
 
292
        revs = []
 
293
        if revision is not None:
 
294
            revs.extend(revision)
 
295
        if revision_info_list is not None:
 
296
            for rev in revision_info_list:
 
297
                revs.append(RevisionSpec.from_string(rev))
 
298
        if len(revs) == 0:
 
299
            raise errors.BzrCommandError('You must supply a revision identifier')
 
300
 
 
301
        b = WorkingTree.open_containing(u'.')[0].branch
 
302
 
 
303
        for rev in revs:
 
304
            revinfo = rev.in_history(b)
 
305
            if revinfo.revno is None:
 
306
                print '     %s' % revinfo.rev_id
 
307
            else:
 
308
                print '%4d %s' % (revinfo.revno, revinfo.rev_id)
 
309
 
 
310
    
 
311
class cmd_add(Command):
 
312
    """Add specified files or directories.
 
313
 
 
314
    In non-recursive mode, all the named items are added, regardless
 
315
    of whether they were previously ignored.  A warning is given if
 
316
    any of the named files are already versioned.
 
317
 
 
318
    In recursive mode (the default), files are treated the same way
 
319
    but the behaviour for directories is different.  Directories that
 
320
    are already versioned do not give a warning.  All directories,
 
321
    whether already versioned or not, are searched for files or
 
322
    subdirectories that are neither versioned or ignored, and these
 
323
    are added.  This search proceeds recursively into versioned
 
324
    directories.  If no names are given '.' is assumed.
 
325
 
 
326
    Therefore simply saying 'bzr add' will version all files that
 
327
    are currently unknown.
 
328
 
 
329
    Adding a file whose parent directory is not versioned will
 
330
    implicitly add the parent, and so on up to the root. This means
 
331
    you should never need to explicitly add a directory, they'll just
 
332
    get added when you add a file in the directory.
 
333
 
 
334
    --dry-run will show which files would be added, but not actually 
 
335
    add them.
 
336
 
 
337
    --file-ids-from will try to use the file ids from the supplied path.
 
338
    It looks up ids trying to find a matching parent directory with the
 
339
    same filename, and then by pure path.
 
340
    """
 
341
    takes_args = ['file*']
 
342
    takes_options = ['no-recurse', 'dry-run', 'verbose',
 
343
                     Option('file-ids-from', type=unicode,
 
344
                            help='Lookup file ids from here')]
 
345
    encoding_type = 'replace'
 
346
 
 
347
    def run(self, file_list, no_recurse=False, dry_run=False, verbose=False,
 
348
            file_ids_from=None):
 
349
        import bzrlib.add
 
350
 
 
351
        base_tree = None
 
352
        if file_ids_from is not None:
 
353
            try:
 
354
                base_tree, base_path = WorkingTree.open_containing(
 
355
                                            file_ids_from)
 
356
            except errors.NoWorkingTree:
 
357
                base_branch, base_path = Branch.open_containing(
 
358
                                            file_ids_from)
 
359
                base_tree = base_branch.basis_tree()
 
360
 
 
361
            action = bzrlib.add.AddFromBaseAction(base_tree, base_path,
 
362
                          to_file=self.outf, should_print=(not is_quiet()))
 
363
        else:
 
364
            action = bzrlib.add.AddAction(to_file=self.outf,
 
365
                should_print=(not is_quiet()))
 
366
 
 
367
        if base_tree:
 
368
            base_tree.lock_read()
 
369
        try:
 
370
            added, ignored = bzrlib.add.smart_add(file_list, not no_recurse,
 
371
                action=action, save=not dry_run)
 
372
        finally:
 
373
            if base_tree is not None:
 
374
                base_tree.unlock()
 
375
        if len(ignored) > 0:
 
376
            if verbose:
 
377
                for glob in sorted(ignored.keys()):
 
378
                    for path in ignored[glob]:
 
379
                        self.outf.write("ignored %s matching \"%s\"\n" 
 
380
                                        % (path, glob))
 
381
            else:
 
382
                match_len = 0
 
383
                for glob, paths in ignored.items():
 
384
                    match_len += len(paths)
 
385
                self.outf.write("ignored %d file(s).\n" % match_len)
 
386
            self.outf.write("If you wish to add some of these files,"
 
387
                            " please add them by name.\n")
 
388
 
 
389
 
 
390
class cmd_mkdir(Command):
 
391
    """Create a new versioned directory.
 
392
 
 
393
    This is equivalent to creating the directory and then adding it.
 
394
    """
 
395
 
 
396
    takes_args = ['dir+']
 
397
    encoding_type = 'replace'
 
398
 
 
399
    def run(self, dir_list):
 
400
        for d in dir_list:
 
401
            os.mkdir(d)
 
402
            wt, dd = WorkingTree.open_containing(d)
 
403
            wt.add([dd])
 
404
            self.outf.write('added %s\n' % d)
 
405
 
 
406
 
 
407
class cmd_relpath(Command):
 
408
    """Show path of a file relative to root"""
 
409
 
 
410
    takes_args = ['filename']
 
411
    hidden = True
 
412
    
 
413
    @display_command
 
414
    def run(self, filename):
 
415
        # TODO: jam 20050106 Can relpath return a munged path if
 
416
        #       sys.stdout encoding cannot represent it?
 
417
        tree, relpath = WorkingTree.open_containing(filename)
 
418
        self.outf.write(relpath)
 
419
        self.outf.write('\n')
 
420
 
 
421
 
 
422
class cmd_inventory(Command):
 
423
    """Show inventory of the current working copy or a revision.
 
424
 
 
425
    It is possible to limit the output to a particular entry
 
426
    type using the --kind option.  For example: --kind file.
 
427
 
 
428
    It is also possible to restrict the list of files to a specific
 
429
    set. For example: bzr inventory --show-ids this/file
 
430
 
 
431
    See also: bzr ls
 
432
    """
 
433
 
 
434
    hidden = True
 
435
 
 
436
    takes_options = ['revision', 'show-ids', 'kind']
 
437
 
 
438
    takes_args = ['file*']
 
439
 
 
440
    @display_command
 
441
    def run(self, revision=None, show_ids=False, kind=None, file_list=None):
 
442
        if kind and kind not in ['file', 'directory', 'symlink']:
 
443
            raise errors.BzrCommandError('invalid kind specified')
 
444
 
 
445
        work_tree, file_list = tree_files(file_list)
 
446
        work_tree.lock_read()
 
447
        try:
 
448
            if revision is not None:
 
449
                if len(revision) > 1:
 
450
                    raise errors.BzrCommandError(
 
451
                        'bzr inventory --revision takes exactly one revision'
 
452
                        ' identifier')
 
453
                revision_id = revision[0].in_history(work_tree.branch).rev_id
 
454
                tree = work_tree.branch.repository.revision_tree(revision_id)
 
455
 
 
456
                extra_trees = [work_tree]
 
457
                tree.lock_read()
 
458
            else:
 
459
                tree = work_tree
 
460
                extra_trees = []
 
461
 
 
462
            if file_list is not None:
 
463
                file_ids = tree.paths2ids(file_list, trees=extra_trees,
 
464
                                          require_versioned=True)
 
465
                # find_ids_across_trees may include some paths that don't
 
466
                # exist in 'tree'.
 
467
                entries = sorted((tree.id2path(file_id), tree.inventory[file_id])
 
468
                                 for file_id in file_ids if file_id in tree)
 
469
            else:
 
470
                entries = tree.inventory.entries()
 
471
        finally:
 
472
            tree.unlock()
 
473
            if tree is not work_tree:
 
474
                work_tree.unlock()
 
475
 
 
476
        for path, entry in entries:
 
477
            if kind and kind != entry.kind:
 
478
                continue
 
479
            if show_ids:
 
480
                self.outf.write('%-50s %s\n' % (path, entry.file_id))
 
481
            else:
 
482
                self.outf.write(path)
 
483
                self.outf.write('\n')
 
484
 
 
485
 
 
486
class cmd_mv(Command):
 
487
    """Move or rename a file.
 
488
 
 
489
    usage:
 
490
        bzr mv OLDNAME NEWNAME
 
491
        bzr mv SOURCE... DESTINATION
 
492
 
 
493
    If the last argument is a versioned directory, all the other names
 
494
    are moved into it.  Otherwise, there must be exactly two arguments
 
495
    and the file is changed to a new name.
 
496
 
 
497
    If OLDNAME does not exist on the filesystem but is versioned and
 
498
    NEWNAME does exist on the filesystem but is not versioned, mv
 
499
    assumes that the file has been manually moved and only updates
 
500
    its internal inventory to reflect that change.
 
501
    The same is valid when moving many SOURCE files to a DESTINATION.
 
502
 
 
503
    Files cannot be moved between branches.
 
504
    """
 
505
 
 
506
    takes_args = ['names*']
 
507
    takes_options = [Option("after", help="move only the bzr identifier"
 
508
        " of the file (file has already been moved). Use this flag if"
 
509
        " bzr is not able to detect this itself.")]
 
510
    aliases = ['move', 'rename']
 
511
    encoding_type = 'replace'
 
512
 
 
513
    def run(self, names_list, after=False):
 
514
        if names_list is None:
 
515
            names_list = []
 
516
 
 
517
        if len(names_list) < 2:
 
518
            raise errors.BzrCommandError("missing file argument")
 
519
        tree, rel_names = tree_files(names_list)
 
520
        
 
521
        if os.path.isdir(names_list[-1]):
 
522
            # move into existing directory
 
523
            for pair in tree.move(rel_names[:-1], rel_names[-1], after=after):
 
524
                self.outf.write("%s => %s\n" % pair)
 
525
        else:
 
526
            if len(names_list) != 2:
 
527
                raise errors.BzrCommandError('to mv multiple files the'
 
528
                                             ' destination must be a versioned'
 
529
                                             ' directory')
 
530
            tree.rename_one(rel_names[0], rel_names[1], after=after)
 
531
            self.outf.write("%s => %s\n" % (rel_names[0], rel_names[1]))
 
532
            
 
533
    
 
534
class cmd_pull(Command):
 
535
    """Turn this branch into a mirror of another branch.
 
536
 
 
537
    This command only works on branches that have not diverged.  Branches are
 
538
    considered diverged if the destination branch's most recent commit is one
 
539
    that has not been merged (directly or indirectly) into the parent.
 
540
 
 
541
    If branches have diverged, you can use 'bzr merge' to integrate the changes
 
542
    from one into the other.  Once one branch has merged, the other should
 
543
    be able to pull it again.
 
544
 
 
545
    If you want to forget your local changes and just update your branch to
 
546
    match the remote one, use pull --overwrite.
 
547
 
 
548
    If there is no default location set, the first pull will set it.  After
 
549
    that, you can omit the location to use the default.  To change the
 
550
    default, use --remember. The value will only be saved if the remote
 
551
    location can be accessed.
 
552
    """
 
553
 
 
554
    takes_options = ['remember', 'overwrite', 'revision', 'verbose',
 
555
        Option('directory',
 
556
            help='branch to pull into, '
 
557
                 'rather than the one containing the working directory',
 
558
            short_name='d',
 
559
            type=unicode,
 
560
            ),
 
561
        ]
 
562
    takes_args = ['location?']
 
563
    encoding_type = 'replace'
 
564
 
 
565
    def run(self, location=None, remember=False, overwrite=False,
 
566
            revision=None, verbose=False,
 
567
            directory=None):
 
568
        from bzrlib.tag import _merge_tags_if_possible
 
569
        # FIXME: too much stuff is in the command class
 
570
        if directory is None:
 
571
            directory = u'.'
 
572
        try:
 
573
            tree_to = WorkingTree.open_containing(directory)[0]
 
574
            branch_to = tree_to.branch
 
575
        except errors.NoWorkingTree:
 
576
            tree_to = None
 
577
            branch_to = Branch.open_containing(directory)[0]
 
578
 
 
579
        reader = None
 
580
        if location is not None:
 
581
            try:
 
582
                reader = bundle.read_bundle_from_url(location)
 
583
            except errors.NotABundle:
 
584
                pass # Continue on considering this url a Branch
 
585
 
 
586
        stored_loc = branch_to.get_parent()
 
587
        if location is None:
 
588
            if stored_loc is None:
 
589
                raise errors.BzrCommandError("No pull location known or"
 
590
                                             " specified.")
 
591
            else:
 
592
                display_url = urlutils.unescape_for_display(stored_loc,
 
593
                        self.outf.encoding)
 
594
                self.outf.write("Using saved location: %s\n" % display_url)
 
595
                location = stored_loc
 
596
 
 
597
        if reader is not None:
 
598
            install_bundle(branch_to.repository, reader)
 
599
            branch_from = branch_to
 
600
        else:
 
601
            branch_from = Branch.open(location)
 
602
 
 
603
            if branch_to.get_parent() is None or remember:
 
604
                branch_to.set_parent(branch_from.base)
 
605
 
 
606
        rev_id = None
 
607
        if revision is None:
 
608
            if reader is not None:
 
609
                rev_id = reader.target
 
610
        elif len(revision) == 1:
 
611
            rev_id = revision[0].in_history(branch_from).rev_id
 
612
        else:
 
613
            raise errors.BzrCommandError('bzr pull --revision takes one value.')
 
614
 
 
615
        old_rh = branch_to.revision_history()
 
616
        if tree_to is not None:
 
617
            result = tree_to.pull(branch_from, overwrite, rev_id,
 
618
                delta._ChangeReporter(unversioned_filter=tree_to.is_ignored))
 
619
        else:
 
620
            result = branch_to.pull(branch_from, overwrite, rev_id)
 
621
 
 
622
        result.report(self.outf)
 
623
        if verbose:
 
624
            from bzrlib.log import show_changed_revisions
 
625
            new_rh = branch_to.revision_history()
 
626
            show_changed_revisions(branch_to, old_rh, new_rh, to_file=self.outf)
 
627
 
 
628
 
 
629
class cmd_push(Command):
 
630
    """Update a mirror of this branch.
 
631
    
 
632
    The target branch will not have its working tree populated because this
 
633
    is both expensive, and is not supported on remote file systems.
 
634
    
 
635
    Some smart servers or protocols *may* put the working tree in place in
 
636
    the future.
 
637
 
 
638
    This command only works on branches that have not diverged.  Branches are
 
639
    considered diverged if the destination branch's most recent commit is one
 
640
    that has not been merged (directly or indirectly) by the source branch.
 
641
 
 
642
    If branches have diverged, you can use 'bzr push --overwrite' to replace
 
643
    the other branch completely, discarding its unmerged changes.
 
644
    
 
645
    If you want to ensure you have the different changes in the other branch,
 
646
    do a merge (see bzr help merge) from the other branch, and commit that.
 
647
    After that you will be able to do a push without '--overwrite'.
 
648
 
 
649
    If there is no default push location set, the first push will set it.
 
650
    After that, you can omit the location to use the default.  To change the
 
651
    default, use --remember. The value will only be saved if the remote
 
652
    location can be accessed.
 
653
    """
 
654
 
 
655
    takes_options = ['remember', 'overwrite', 'verbose',
 
656
        Option('create-prefix',
 
657
               help='Create the path leading up to the branch '
 
658
                    'if it does not already exist'),
 
659
        Option('directory',
 
660
            help='branch to push from, '
 
661
                 'rather than the one containing the working directory',
 
662
            short_name='d',
 
663
            type=unicode,
 
664
            ),
 
665
        Option('use-existing-dir',
 
666
               help='By default push will fail if the target'
 
667
                    ' directory exists, but does not already'
 
668
                    ' have a control directory. This flag will'
 
669
                    ' allow push to proceed.'),
 
670
        ]
 
671
    takes_args = ['location?']
 
672
    encoding_type = 'replace'
 
673
 
 
674
    def run(self, location=None, remember=False, overwrite=False,
 
675
            create_prefix=False, verbose=False,
 
676
            use_existing_dir=False,
 
677
            directory=None):
 
678
        # FIXME: Way too big!  Put this into a function called from the
 
679
        # command.
 
680
        if directory is None:
 
681
            directory = '.'
 
682
        br_from = Branch.open_containing(directory)[0]
 
683
        stored_loc = br_from.get_push_location()
 
684
        if location is None:
 
685
            if stored_loc is None:
 
686
                raise errors.BzrCommandError("No push location known or specified.")
 
687
            else:
 
688
                display_url = urlutils.unescape_for_display(stored_loc,
 
689
                        self.outf.encoding)
 
690
                self.outf.write("Using saved location: %s\n" % display_url)
 
691
                location = stored_loc
 
692
 
 
693
        to_transport = transport.get_transport(location)
 
694
        location_url = to_transport.base
 
695
 
 
696
        br_to = repository_to = dir_to = None
 
697
        try:
 
698
            dir_to = bzrdir.BzrDir.open_from_transport(to_transport)
 
699
        except errors.NotBranchError:
 
700
            pass # Didn't find anything
 
701
        else:
 
702
            # If we can open a branch, use its direct repository, otherwise see
 
703
            # if there is a repository without a branch.
 
704
            try:
 
705
                br_to = dir_to.open_branch()
 
706
            except errors.NotBranchError:
 
707
                # Didn't find a branch, can we find a repository?
 
708
                try:
 
709
                    repository_to = dir_to.find_repository()
 
710
                except errors.NoRepositoryPresent:
 
711
                    pass
 
712
            else:
 
713
                # Found a branch, so we must have found a repository
 
714
                repository_to = br_to.repository
 
715
        push_result = None
 
716
        old_rh = []
 
717
        if dir_to is None:
 
718
            # The destination doesn't exist; create it.
 
719
            # XXX: Refactor the create_prefix/no_create_prefix code into a
 
720
            #      common helper function
 
721
            try:
 
722
                to_transport.mkdir('.')
 
723
            except errors.FileExists:
 
724
                if not use_existing_dir:
 
725
                    raise errors.BzrCommandError("Target directory %s"
 
726
                         " already exists, but does not have a valid .bzr"
 
727
                         " directory. Supply --use-existing-dir to push"
 
728
                         " there anyway." % location)
 
729
            except errors.NoSuchFile:
 
730
                if not create_prefix:
 
731
                    raise errors.BzrCommandError("Parent directory of %s"
 
732
                        " does not exist."
 
733
                        "\nYou may supply --create-prefix to create all"
 
734
                        " leading parent directories."
 
735
                        % location)
 
736
 
 
737
                cur_transport = to_transport
 
738
                needed = [cur_transport]
 
739
                # Recurse upwards until we can create a directory successfully
 
740
                while True:
 
741
                    new_transport = cur_transport.clone('..')
 
742
                    if new_transport.base == cur_transport.base:
 
743
                        raise errors.BzrCommandError("Failed to create path"
 
744
                                                     " prefix for %s."
 
745
                                                     % location)
 
746
                    try:
 
747
                        new_transport.mkdir('.')
 
748
                    except errors.NoSuchFile:
 
749
                        needed.append(new_transport)
 
750
                        cur_transport = new_transport
 
751
                    else:
 
752
                        break
 
753
 
 
754
                # Now we only need to create child directories
 
755
                while needed:
 
756
                    cur_transport = needed.pop()
 
757
                    cur_transport.mkdir('.')
 
758
            
 
759
            # Now the target directory exists, but doesn't have a .bzr
 
760
            # directory. So we need to create it, along with any work to create
 
761
            # all of the dependent branches, etc.
 
762
            dir_to = br_from.bzrdir.clone(location_url,
 
763
                revision_id=br_from.last_revision())
 
764
            br_to = dir_to.open_branch()
 
765
            # TODO: Some more useful message about what was copied
 
766
            note('Created new branch.')
 
767
            # We successfully created the target, remember it
 
768
            if br_from.get_push_location() is None or remember:
 
769
                br_from.set_push_location(br_to.base)
 
770
        elif repository_to is None:
 
771
            # we have a bzrdir but no branch or repository
 
772
            # XXX: Figure out what to do other than complain.
 
773
            raise errors.BzrCommandError("At %s you have a valid .bzr control"
 
774
                " directory, but not a branch or repository. This is an"
 
775
                " unsupported configuration. Please move the target directory"
 
776
                " out of the way and try again."
 
777
                % location)
 
778
        elif br_to is None:
 
779
            # We have a repository but no branch, copy the revisions, and then
 
780
            # create a branch.
 
781
            last_revision_id = br_from.last_revision()
 
782
            repository_to.fetch(br_from.repository,
 
783
                                revision_id=last_revision_id)
 
784
            br_to = br_from.clone(dir_to, revision_id=last_revision_id)
 
785
            note('Created new branch.')
 
786
            if br_from.get_push_location() is None or remember:
 
787
                br_from.set_push_location(br_to.base)
 
788
        else: # We have a valid to branch
 
789
            # We were able to connect to the remote location, so remember it
 
790
            # we don't need to successfully push because of possible divergence.
 
791
            if br_from.get_push_location() is None or remember:
 
792
                br_from.set_push_location(br_to.base)
 
793
            old_rh = br_to.revision_history()
 
794
            try:
 
795
                try:
 
796
                    tree_to = dir_to.open_workingtree()
 
797
                except errors.NotLocalUrl:
 
798
                    warning('This transport does not update the working '
 
799
                            'tree of: %s' % (br_to.base,))
 
800
                    push_result = br_from.push(br_to, overwrite)
 
801
                except errors.NoWorkingTree:
 
802
                    push_result = br_from.push(br_to, overwrite)
 
803
                else:
 
804
                    tree_to.lock_write()
 
805
                    try:
 
806
                        push_result = br_from.push(tree_to.branch, overwrite)
 
807
                        tree_to.update()
 
808
                    finally:
 
809
                        tree_to.unlock()
 
810
            except errors.DivergedBranches:
 
811
                raise errors.BzrCommandError('These branches have diverged.'
 
812
                                        '  Try using "merge" and then "push".')
 
813
        if push_result is not None:
 
814
            push_result.report(self.outf)
 
815
        elif verbose:
 
816
            new_rh = br_to.revision_history()
 
817
            if old_rh != new_rh:
 
818
                # Something changed
 
819
                from bzrlib.log import show_changed_revisions
 
820
                show_changed_revisions(br_to, old_rh, new_rh,
 
821
                                       to_file=self.outf)
 
822
        else:
 
823
            # we probably did a clone rather than a push, so a message was
 
824
            # emitted above
 
825
            pass
 
826
 
 
827
 
 
828
class cmd_branch(Command):
 
829
    """Create a new copy of a branch.
 
830
 
 
831
    If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
 
832
    be used.  In other words, "branch ../foo/bar" will attempt to create ./bar.
 
833
 
 
834
    To retrieve the branch as of a particular revision, supply the --revision
 
835
    parameter, as in "branch foo/bar -r 5".
 
836
 
 
837
    --basis is to speed up branching from remote branches.  When specified, it
 
838
    copies all the file-contents, inventory and revision data from the basis
 
839
    branch before copying anything from the remote branch.
 
840
    """
 
841
    takes_args = ['from_location', 'to_location?']
 
842
    takes_options = ['revision', 'basis']
 
843
    aliases = ['get', 'clone']
 
844
 
 
845
    def run(self, from_location, to_location=None, revision=None, basis=None):
 
846
        from bzrlib.tag import _merge_tags_if_possible
 
847
        if revision is None:
 
848
            revision = [None]
 
849
        elif len(revision) > 1:
 
850
            raise errors.BzrCommandError(
 
851
                'bzr branch --revision takes exactly 1 revision value')
 
852
 
 
853
        br_from = Branch.open(from_location)
 
854
        br_from.lock_read()
 
855
        try:
 
856
            if basis is not None:
 
857
                basis_dir = bzrdir.BzrDir.open_containing(basis)[0]
 
858
            else:
 
859
                basis_dir = None
 
860
            if len(revision) == 1 and revision[0] is not None:
 
861
                revision_id = revision[0].in_history(br_from)[1]
 
862
            else:
 
863
                # FIXME - wt.last_revision, fallback to branch, fall back to
 
864
                # None or perhaps NULL_REVISION to mean copy nothing
 
865
                # RBC 20060209
 
866
                revision_id = br_from.last_revision()
 
867
            if to_location is None:
 
868
                to_location = os.path.basename(from_location.rstrip("/\\"))
 
869
                name = None
 
870
            else:
 
871
                name = os.path.basename(to_location) + '\n'
 
872
 
 
873
            to_transport = transport.get_transport(to_location)
 
874
            try:
 
875
                to_transport.mkdir('.')
 
876
            except errors.FileExists:
 
877
                raise errors.BzrCommandError('Target directory "%s" already'
 
878
                                             ' exists.' % to_location)
 
879
            except errors.NoSuchFile:
 
880
                raise errors.BzrCommandError('Parent of "%s" does not exist.'
 
881
                                             % to_location)
 
882
            try:
 
883
                # preserve whatever source format we have.
 
884
                dir = br_from.bzrdir.sprout(to_transport.base,
 
885
                        revision_id, basis_dir)
 
886
                branch = dir.open_branch()
 
887
            except errors.NoSuchRevision:
 
888
                to_transport.delete_tree('.')
 
889
                msg = "The branch %s has no revision %s." % (from_location, revision[0])
 
890
                raise errors.BzrCommandError(msg)
 
891
            except errors.UnlistableBranch:
 
892
                osutils.rmtree(to_location)
 
893
                msg = "The branch %s cannot be used as a --basis" % (basis,)
 
894
                raise errors.BzrCommandError(msg)
 
895
            if name:
 
896
                branch.control_files.put_utf8('branch-name', name)
 
897
            _merge_tags_if_possible(br_from, branch)
 
898
            note('Branched %d revision(s).' % branch.revno())
 
899
        finally:
 
900
            br_from.unlock()
 
901
 
 
902
 
 
903
class cmd_checkout(Command):
 
904
    """Create a new checkout of an existing branch.
 
905
 
 
906
    If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
 
907
    the branch found in '.'. This is useful if you have removed the working tree
 
908
    or if it was never created - i.e. if you pushed the branch to its current
 
909
    location using SFTP.
 
910
    
 
911
    If the TO_LOCATION is omitted, the last component of the BRANCH_LOCATION will
 
912
    be used.  In other words, "checkout ../foo/bar" will attempt to create ./bar.
 
913
 
 
914
    To retrieve the branch as of a particular revision, supply the --revision
 
915
    parameter, as in "checkout foo/bar -r 5". Note that this will be immediately
 
916
    out of date [so you cannot commit] but it may be useful (i.e. to examine old
 
917
    code.)
 
918
 
 
919
    --basis is to speed up checking out from remote branches.  When specified, it
 
920
    uses the inventory and file contents from the basis branch in preference to the
 
921
    branch being checked out.
 
922
 
 
923
    See "help checkouts" for more information on checkouts.
 
924
    """
 
925
    takes_args = ['branch_location?', 'to_location?']
 
926
    takes_options = ['revision', # , 'basis']
 
927
                     Option('lightweight',
 
928
                            help="perform a lightweight checkout. Lightweight "
 
929
                                 "checkouts depend on access to the branch for "
 
930
                                 "every operation. Normal checkouts can perform "
 
931
                                 "common operations like diff and status without "
 
932
                                 "such access, and also support local commits."
 
933
                            ),
 
934
                     ]
 
935
    aliases = ['co']
 
936
 
 
937
    def run(self, branch_location=None, to_location=None, revision=None, basis=None,
 
938
            lightweight=False):
 
939
        if revision is None:
 
940
            revision = [None]
 
941
        elif len(revision) > 1:
 
942
            raise errors.BzrCommandError(
 
943
                'bzr checkout --revision takes exactly 1 revision value')
 
944
        if branch_location is None:
 
945
            branch_location = osutils.getcwd()
 
946
            to_location = branch_location
 
947
        source = Branch.open(branch_location)
 
948
        if len(revision) == 1 and revision[0] is not None:
 
949
            revision_id = revision[0].in_history(source)[1]
 
950
        else:
 
951
            revision_id = None
 
952
        if to_location is None:
 
953
            to_location = os.path.basename(branch_location.rstrip("/\\"))
 
954
        # if the source and to_location are the same, 
 
955
        # and there is no working tree,
 
956
        # then reconstitute a branch
 
957
        if (osutils.abspath(to_location) ==
 
958
            osutils.abspath(branch_location)):
 
959
            try:
 
960
                source.bzrdir.open_workingtree()
 
961
            except errors.NoWorkingTree:
 
962
                source.bzrdir.create_workingtree()
 
963
                return
 
964
        try:
 
965
            os.mkdir(to_location)
 
966
        except OSError, e:
 
967
            if e.errno == errno.EEXIST:
 
968
                raise errors.BzrCommandError('Target directory "%s" already'
 
969
                                             ' exists.' % to_location)
 
970
            if e.errno == errno.ENOENT:
 
971
                raise errors.BzrCommandError('Parent of "%s" does not exist.'
 
972
                                             % to_location)
 
973
            else:
 
974
                raise
 
975
        source.create_checkout(to_location, revision_id, lightweight)
 
976
 
 
977
 
 
978
class cmd_renames(Command):
 
979
    """Show list of renamed files.
 
980
    """
 
981
    # TODO: Option to show renames between two historical versions.
 
982
 
 
983
    # TODO: Only show renames under dir, rather than in the whole branch.
 
984
    takes_args = ['dir?']
 
985
 
 
986
    @display_command
 
987
    def run(self, dir=u'.'):
 
988
        tree = WorkingTree.open_containing(dir)[0]
 
989
        tree.lock_read()
 
990
        try:
 
991
            new_inv = tree.inventory
 
992
            old_tree = tree.basis_tree()
 
993
            old_tree.lock_read()
 
994
            try:
 
995
                old_inv = old_tree.inventory
 
996
                renames = list(_mod_tree.find_renames(old_inv, new_inv))
 
997
                renames.sort()
 
998
                for old_name, new_name in renames:
 
999
                    self.outf.write("%s => %s\n" % (old_name, new_name))
 
1000
            finally:
 
1001
                old_tree.unlock()
 
1002
        finally:
 
1003
            tree.unlock()
 
1004
 
 
1005
 
 
1006
class cmd_update(Command):
 
1007
    """Update a tree to have the latest code committed to its branch.
 
1008
    
 
1009
    This will perform a merge into the working tree, and may generate
 
1010
    conflicts. If you have any local changes, you will still 
 
1011
    need to commit them after the update for the update to be complete.
 
1012
    
 
1013
    If you want to discard your local changes, you can just do a 
 
1014
    'bzr revert' instead of 'bzr commit' after the update.
 
1015
    """
 
1016
    takes_args = ['dir?']
 
1017
    aliases = ['up']
 
1018
 
 
1019
    def run(self, dir='.'):
 
1020
        tree = WorkingTree.open_containing(dir)[0]
 
1021
        master = tree.branch.get_master_branch()
 
1022
        if master is not None:
 
1023
            tree.lock_write()
 
1024
        else:
 
1025
            tree.lock_tree_write()
 
1026
        try:
 
1027
            existing_pending_merges = tree.get_parent_ids()[1:]
 
1028
            last_rev = tree.last_revision()
 
1029
            if last_rev == tree.branch.last_revision():
 
1030
                # may be up to date, check master too.
 
1031
                master = tree.branch.get_master_branch()
 
1032
                if master is None or last_rev == master.last_revision():
 
1033
                    revno = tree.branch.revision_id_to_revno(last_rev)
 
1034
                    note("Tree is up to date at revision %d." % (revno,))
 
1035
                    return 0
 
1036
            conflicts = tree.update()
 
1037
            revno = tree.branch.revision_id_to_revno(tree.last_revision())
 
1038
            note('Updated to revision %d.' % (revno,))
 
1039
            if tree.get_parent_ids()[1:] != existing_pending_merges:
 
1040
                note('Your local commits will now show as pending merges with '
 
1041
                     "'bzr status', and can be committed with 'bzr commit'.")
 
1042
            if conflicts != 0:
 
1043
                return 1
 
1044
            else:
 
1045
                return 0
 
1046
        finally:
 
1047
            tree.unlock()
 
1048
 
 
1049
 
 
1050
class cmd_info(Command):
 
1051
    """Show information about a working tree, branch or repository.
 
1052
 
 
1053
    This command will show all known locations and formats associated to the
 
1054
    tree, branch or repository.  Statistical information is included with
 
1055
    each report.
 
1056
 
 
1057
    Branches and working trees will also report any missing revisions.
 
1058
    """
 
1059
    takes_args = ['location?']
 
1060
    takes_options = ['verbose']
 
1061
 
 
1062
    @display_command
 
1063
    def run(self, location=None, verbose=False):
 
1064
        from bzrlib.info import show_bzrdir_info
 
1065
        show_bzrdir_info(bzrdir.BzrDir.open_containing(location)[0],
 
1066
                         verbose=verbose)
 
1067
 
 
1068
 
 
1069
class cmd_remove(Command):
 
1070
    """Make a file unversioned.
 
1071
 
 
1072
    This makes bzr stop tracking changes to a versioned file.  It does
 
1073
    not delete the working copy.
 
1074
 
 
1075
    You can specify one or more files, and/or --new.  If you specify --new,
 
1076
    only 'added' files will be removed.  If you specify both, then new files
 
1077
    in the specified directories will be removed.  If the directories are
 
1078
    also new, they will also be removed.
 
1079
    """
 
1080
    takes_args = ['file*']
 
1081
    takes_options = ['verbose', Option('new', help='remove newly-added files')]
 
1082
    aliases = ['rm']
 
1083
    encoding_type = 'replace'
 
1084
    
 
1085
    def run(self, file_list, verbose=False, new=False):
 
1086
        tree, file_list = tree_files(file_list)
 
1087
        if new is False:
 
1088
            if file_list is None:
 
1089
                raise errors.BzrCommandError('Specify one or more files to'
 
1090
                                             ' remove, or use --new.')
 
1091
        else:
 
1092
            added = tree.changes_from(tree.basis_tree(),
 
1093
                specific_files=file_list).added
 
1094
            file_list = sorted([f[0] for f in added], reverse=True)
 
1095
            if len(file_list) == 0:
 
1096
                raise errors.BzrCommandError('No matching files.')
 
1097
        tree.remove(file_list, verbose=verbose, to_file=self.outf)
 
1098
 
 
1099
 
 
1100
class cmd_file_id(Command):
 
1101
    """Print file_id of a particular file or directory.
 
1102
 
 
1103
    The file_id is assigned when the file is first added and remains the
 
1104
    same through all revisions where the file exists, even when it is
 
1105
    moved or renamed.
 
1106
    """
 
1107
 
 
1108
    hidden = True
 
1109
    takes_args = ['filename']
 
1110
 
 
1111
    @display_command
 
1112
    def run(self, filename):
 
1113
        tree, relpath = WorkingTree.open_containing(filename)
 
1114
        i = tree.path2id(relpath)
 
1115
        if i is None:
 
1116
            raise errors.NotVersionedError(filename)
 
1117
        else:
 
1118
            self.outf.write(i + '\n')
 
1119
 
 
1120
 
 
1121
class cmd_file_path(Command):
 
1122
    """Print path of file_ids to a file or directory.
 
1123
 
 
1124
    This prints one line for each directory down to the target,
 
1125
    starting at the branch root.
 
1126
    """
 
1127
 
 
1128
    hidden = True
 
1129
    takes_args = ['filename']
 
1130
 
 
1131
    @display_command
 
1132
    def run(self, filename):
 
1133
        tree, relpath = WorkingTree.open_containing(filename)
 
1134
        fid = tree.path2id(relpath)
 
1135
        if fid is None:
 
1136
            raise errors.NotVersionedError(filename)
 
1137
        segments = osutils.splitpath(relpath)
 
1138
        for pos in range(1, len(segments) + 1):
 
1139
            path = osutils.joinpath(segments[:pos])
 
1140
            self.outf.write("%s\n" % tree.path2id(path))
 
1141
 
 
1142
 
 
1143
class cmd_reconcile(Command):
 
1144
    """Reconcile bzr metadata in a branch.
 
1145
 
 
1146
    This can correct data mismatches that may have been caused by
 
1147
    previous ghost operations or bzr upgrades. You should only
 
1148
    need to run this command if 'bzr check' or a bzr developer 
 
1149
    advises you to run it.
 
1150
 
 
1151
    If a second branch is provided, cross-branch reconciliation is
 
1152
    also attempted, which will check that data like the tree root
 
1153
    id which was not present in very early bzr versions is represented
 
1154
    correctly in both branches.
 
1155
 
 
1156
    At the same time it is run it may recompress data resulting in 
 
1157
    a potential saving in disk space or performance gain.
 
1158
 
 
1159
    The branch *MUST* be on a listable system such as local disk or sftp.
 
1160
    """
 
1161
    takes_args = ['branch?']
 
1162
 
 
1163
    def run(self, branch="."):
 
1164
        from bzrlib.reconcile import reconcile
 
1165
        dir = bzrdir.BzrDir.open(branch)
 
1166
        reconcile(dir)
 
1167
 
 
1168
 
 
1169
class cmd_revision_history(Command):
 
1170
    """Display the list of revision ids on a branch."""
 
1171
    takes_args = ['location?']
 
1172
 
 
1173
    hidden = True
 
1174
 
 
1175
    @display_command
 
1176
    def run(self, location="."):
 
1177
        branch = Branch.open_containing(location)[0]
 
1178
        for revid in branch.revision_history():
 
1179
            self.outf.write(revid)
 
1180
            self.outf.write('\n')
 
1181
 
 
1182
 
 
1183
class cmd_ancestry(Command):
 
1184
    """List all revisions merged into this branch."""
 
1185
    takes_args = ['location?']
 
1186
 
 
1187
    hidden = True
 
1188
 
 
1189
    @display_command
 
1190
    def run(self, location="."):
 
1191
        try:
 
1192
            wt = WorkingTree.open_containing(location)[0]
 
1193
        except errors.NoWorkingTree:
 
1194
            b = Branch.open(location)
 
1195
            last_revision = b.last_revision()
 
1196
        else:
 
1197
            b = wt.branch
 
1198
            last_revision = wt.last_revision()
 
1199
 
 
1200
        revision_ids = b.repository.get_ancestry(last_revision)
 
1201
        assert revision_ids[0] is None
 
1202
        revision_ids.pop(0)
 
1203
        for revision_id in revision_ids:
 
1204
            self.outf.write(revision_id + '\n')
 
1205
 
 
1206
 
 
1207
class cmd_init(Command):
 
1208
    """Make a directory into a versioned branch.
 
1209
 
 
1210
    Use this to create an empty branch, or before importing an
 
1211
    existing project.
 
1212
 
 
1213
    If there is a repository in a parent directory of the location, then 
 
1214
    the history of the branch will be stored in the repository.  Otherwise
 
1215
    init creates a standalone branch which carries its own history in 
 
1216
    .bzr.
 
1217
 
 
1218
    If there is already a branch at the location but it has no working tree,
 
1219
    the tree can be populated with 'bzr checkout'.
 
1220
 
 
1221
    Recipe for importing a tree of files:
 
1222
        cd ~/project
 
1223
        bzr init
 
1224
        bzr add .
 
1225
        bzr status
 
1226
        bzr commit -m 'imported project'
 
1227
    """
 
1228
    takes_args = ['location?']
 
1229
    takes_options = [
 
1230
         RegistryOption('format',
 
1231
                help='Specify a format for this branch. '
 
1232
                'See "help formats".',
 
1233
                registry=bzrdir.format_registry,
 
1234
                converter=bzrdir.format_registry.make_bzrdir,
 
1235
                value_switches=True,
 
1236
                title="Branch Format",
 
1237
                ),
 
1238
         Option('append-revisions-only',
 
1239
                help='Never change revnos or the existing log.'
 
1240
                '  Append revisions to it only.')
 
1241
         ]
 
1242
    def run(self, location=None, format=None, append_revisions_only=False):
 
1243
        if format is None:
 
1244
            format = bzrdir.format_registry.make_bzrdir('default')
 
1245
        if location is None:
 
1246
            location = u'.'
 
1247
 
 
1248
        to_transport = transport.get_transport(location)
 
1249
 
 
1250
        # The path has to exist to initialize a
 
1251
        # branch inside of it.
 
1252
        # Just using os.mkdir, since I don't
 
1253
        # believe that we want to create a bunch of
 
1254
        # locations if the user supplies an extended path
 
1255
        # TODO: create-prefix
 
1256
        try:
 
1257
            to_transport.mkdir('.')
 
1258
        except errors.FileExists:
 
1259
            pass
 
1260
                    
 
1261
        try:
 
1262
            existing_bzrdir = bzrdir.BzrDir.open(location)
 
1263
        except errors.NotBranchError:
 
1264
            # really a NotBzrDir error...
 
1265
            branch = bzrdir.BzrDir.create_branch_convenience(to_transport.base,
 
1266
                                                             format=format)
 
1267
        else:
 
1268
            from bzrlib.transport.local import LocalTransport
 
1269
            if existing_bzrdir.has_branch():
 
1270
                if (isinstance(to_transport, LocalTransport)
 
1271
                    and not existing_bzrdir.has_workingtree()):
 
1272
                        raise errors.BranchExistsWithoutWorkingTree(location)
 
1273
                raise errors.AlreadyBranchError(location)
 
1274
            else:
 
1275
                branch = existing_bzrdir.create_branch()
 
1276
                existing_bzrdir.create_workingtree()
 
1277
        if append_revisions_only:
 
1278
            try:
 
1279
                branch.set_append_revisions_only(True)
 
1280
            except errors.UpgradeRequired:
 
1281
                raise errors.BzrCommandError('This branch format cannot be set'
 
1282
                    ' to append-revisions-only.  Try --experimental-branch6')
 
1283
 
 
1284
 
 
1285
class cmd_init_repository(Command):
 
1286
    """Create a shared repository to hold branches.
 
1287
 
 
1288
    New branches created under the repository directory will store their revisions
 
1289
    in the repository, not in the branch directory, if the branch format supports
 
1290
    shared storage.
 
1291
 
 
1292
    example:
 
1293
        bzr init-repo repo
 
1294
        bzr init repo/trunk
 
1295
        bzr checkout --lightweight repo/trunk trunk-checkout
 
1296
        cd trunk-checkout
 
1297
        (add files here)
 
1298
    """
 
1299
    takes_args = ["location"]
 
1300
    takes_options = [RegistryOption('format',
 
1301
                            help='Specify a format for this repository. See'
 
1302
                                 ' "bzr help formats" for details',
 
1303
                            registry=bzrdir.format_registry,
 
1304
                            converter=bzrdir.format_registry.make_bzrdir,
 
1305
                            value_switches=True, title='Repository format'),
 
1306
                     Option('trees',
 
1307
                             help='Allows branches in repository to have'
 
1308
                             ' a working tree')]
 
1309
    aliases = ["init-repo"]
 
1310
    def run(self, location, format=None, trees=False):
 
1311
        if format is None:
 
1312
            format = bzrdir.format_registry.make_bzrdir('default')
 
1313
 
 
1314
        if location is None:
 
1315
            location = '.'
 
1316
 
 
1317
        to_transport = transport.get_transport(location)
 
1318
        try:
 
1319
            to_transport.mkdir('.')
 
1320
        except errors.FileExists:
 
1321
            pass
 
1322
 
 
1323
        newdir = format.initialize_on_transport(to_transport)
 
1324
        repo = newdir.create_repository(shared=True)
 
1325
        repo.set_make_working_trees(trees)
 
1326
 
 
1327
 
 
1328
class cmd_diff(Command):
 
1329
    """Show differences in the working tree or between revisions.
 
1330
    
 
1331
    If files are listed, only the changes in those files are listed.
 
1332
    Otherwise, all changes for the tree are listed.
 
1333
 
 
1334
    "bzr diff -p1" is equivalent to "bzr diff --prefix old/:new/", and
 
1335
    produces patches suitable for "patch -p1".
 
1336
 
 
1337
    examples:
 
1338
        bzr diff
 
1339
            Shows the difference in the working tree versus the last commit
 
1340
        bzr diff -r1
 
1341
            Difference between the working tree and revision 1
 
1342
        bzr diff -r1..2
 
1343
            Difference between revision 2 and revision 1
 
1344
        bzr diff --prefix old/:new/
 
1345
            Same as 'bzr diff' but prefix paths with old/ and new/
 
1346
        bzr diff bzr.mine bzr.dev
 
1347
            Show the differences between the two working trees
 
1348
        bzr diff foo.c
 
1349
            Show just the differences for 'foo.c'
 
1350
    """
 
1351
    # TODO: Option to use external diff command; could be GNU diff, wdiff,
 
1352
    #       or a graphical diff.
 
1353
 
 
1354
    # TODO: Python difflib is not exactly the same as unidiff; should
 
1355
    #       either fix it up or prefer to use an external diff.
 
1356
 
 
1357
    # TODO: Selected-file diff is inefficient and doesn't show you
 
1358
    #       deleted files.
 
1359
 
 
1360
    # TODO: This probably handles non-Unix newlines poorly.
 
1361
 
 
1362
    takes_args = ['file*']
 
1363
    takes_options = ['revision', 'diff-options',
 
1364
        Option('prefix', type=str,
 
1365
               short_name='p',
 
1366
               help='Set prefixes to added to old and new filenames, as '
 
1367
                    'two values separated by a colon. (eg "old/:new/")'),
 
1368
        ]
 
1369
    aliases = ['di', 'dif']
 
1370
    encoding_type = 'exact'
 
1371
 
 
1372
    @display_command
 
1373
    def run(self, revision=None, file_list=None, diff_options=None,
 
1374
            prefix=None):
 
1375
        from bzrlib.diff import diff_cmd_helper, show_diff_trees
 
1376
 
 
1377
        if (prefix is None) or (prefix == '0'):
 
1378
            # diff -p0 format
 
1379
            old_label = ''
 
1380
            new_label = ''
 
1381
        elif prefix == '1':
 
1382
            old_label = 'old/'
 
1383
            new_label = 'new/'
 
1384
        elif ':' in prefix:
 
1385
            old_label, new_label = prefix.split(":")
 
1386
        else:
 
1387
            raise errors.BzrCommandError(
 
1388
                '--prefix expects two values separated by a colon'
 
1389
                ' (eg "old/:new/")')
 
1390
 
 
1391
        if revision and len(revision) > 2:
 
1392
            raise errors.BzrCommandError('bzr diff --revision takes exactly'
 
1393
                                         ' one or two revision specifiers')
 
1394
 
 
1395
        try:
 
1396
            tree1, file_list = internal_tree_files(file_list)
 
1397
            tree2 = None
 
1398
            b = None
 
1399
            b2 = None
 
1400
        except errors.FileInWrongBranch:
 
1401
            if len(file_list) != 2:
 
1402
                raise errors.BzrCommandError("Files are in different branches")
 
1403
 
 
1404
            tree1, file1 = WorkingTree.open_containing(file_list[0])
 
1405
            tree2, file2 = WorkingTree.open_containing(file_list[1])
 
1406
            if file1 != "" or file2 != "":
 
1407
                # FIXME diff those two files. rbc 20051123
 
1408
                raise errors.BzrCommandError("Files are in different branches")
 
1409
            file_list = None
 
1410
        except errors.NotBranchError:
 
1411
            if (revision is not None and len(revision) == 2
 
1412
                and not revision[0].needs_branch()
 
1413
                and not revision[1].needs_branch()):
 
1414
                # If both revision specs include a branch, we can
 
1415
                # diff them without needing a local working tree
 
1416
                tree1, tree2 = None, None
 
1417
            else:
 
1418
                raise
 
1419
 
 
1420
        if tree2 is not None:
 
1421
            if revision is not None:
 
1422
                # FIXME: but there should be a clean way to diff between
 
1423
                # non-default versions of two trees, it's not hard to do
 
1424
                # internally...
 
1425
                raise errors.BzrCommandError(
 
1426
                        "Sorry, diffing arbitrary revisions across branches "
 
1427
                        "is not implemented yet")
 
1428
            return show_diff_trees(tree1, tree2, sys.stdout, 
 
1429
                                   specific_files=file_list,
 
1430
                                   external_diff_options=diff_options,
 
1431
                                   old_label=old_label, new_label=new_label)
 
1432
 
 
1433
        return diff_cmd_helper(tree1, file_list, diff_options,
 
1434
                               revision_specs=revision,
 
1435
                               old_label=old_label, new_label=new_label)
 
1436
 
 
1437
 
 
1438
class cmd_deleted(Command):
 
1439
    """List files deleted in the working tree.
 
1440
    """
 
1441
    # TODO: Show files deleted since a previous revision, or
 
1442
    # between two revisions.
 
1443
    # TODO: Much more efficient way to do this: read in new
 
1444
    # directories with readdir, rather than stating each one.  Same
 
1445
    # level of effort but possibly much less IO.  (Or possibly not,
 
1446
    # if the directories are very large...)
 
1447
    takes_options = ['show-ids']
 
1448
 
 
1449
    @display_command
 
1450
    def run(self, show_ids=False):
 
1451
        tree = WorkingTree.open_containing(u'.')[0]
 
1452
        tree.lock_read()
 
1453
        try:
 
1454
            old = tree.basis_tree()
 
1455
            old.lock_read()
 
1456
            try:
 
1457
                for path, ie in old.inventory.iter_entries():
 
1458
                    if not tree.has_id(ie.file_id):
 
1459
                        self.outf.write(path)
 
1460
                        if show_ids:
 
1461
                            self.outf.write(' ')
 
1462
                            self.outf.write(ie.file_id)
 
1463
                        self.outf.write('\n')
 
1464
            finally:
 
1465
                old.unlock()
 
1466
        finally:
 
1467
            tree.unlock()
 
1468
 
 
1469
 
 
1470
class cmd_modified(Command):
 
1471
    """List files modified in working tree.
 
1472
 
 
1473
    See also: "bzr status".
 
1474
    """
 
1475
 
 
1476
    hidden = True
 
1477
 
 
1478
    @display_command
 
1479
    def run(self):
 
1480
        tree = WorkingTree.open_containing(u'.')[0]
 
1481
        td = tree.changes_from(tree.basis_tree())
 
1482
        for path, id, kind, text_modified, meta_modified in td.modified:
 
1483
            self.outf.write(path + '\n')
 
1484
 
 
1485
 
 
1486
class cmd_added(Command):
 
1487
    """List files added in working tree.
 
1488
 
 
1489
    See also: "bzr status".
 
1490
    """
 
1491
 
 
1492
    hidden = True
 
1493
 
 
1494
    @display_command
 
1495
    def run(self):
 
1496
        wt = WorkingTree.open_containing(u'.')[0]
 
1497
        wt.lock_read()
 
1498
        try:
 
1499
            basis = wt.basis_tree()
 
1500
            basis.lock_read()
 
1501
            try:
 
1502
                basis_inv = basis.inventory
 
1503
                inv = wt.inventory
 
1504
                for file_id in inv:
 
1505
                    if file_id in basis_inv:
 
1506
                        continue
 
1507
                    if inv.is_root(file_id) and len(basis_inv) == 0:
 
1508
                        continue
 
1509
                    path = inv.id2path(file_id)
 
1510
                    if not os.access(osutils.abspath(path), os.F_OK):
 
1511
                        continue
 
1512
                    self.outf.write(path + '\n')
 
1513
            finally:
 
1514
                basis.unlock()
 
1515
        finally:
 
1516
            wt.unlock()
 
1517
 
 
1518
 
 
1519
class cmd_root(Command):
 
1520
    """Show the tree root directory.
 
1521
 
 
1522
    The root is the nearest enclosing directory with a .bzr control
 
1523
    directory."""
 
1524
    takes_args = ['filename?']
 
1525
    @display_command
 
1526
    def run(self, filename=None):
 
1527
        """Print the branch root."""
 
1528
        tree = WorkingTree.open_containing(filename)[0]
 
1529
        self.outf.write(tree.basedir + '\n')
 
1530
 
 
1531
 
 
1532
class cmd_log(Command):
 
1533
    """Show log of a branch, file, or directory.
 
1534
 
 
1535
    By default show the log of the branch containing the working directory.
 
1536
 
 
1537
    To request a range of logs, you can use the command -r begin..end
 
1538
    -r revision requests a specific revision, -r ..end or -r begin.. are
 
1539
    also valid.
 
1540
 
 
1541
    examples:
 
1542
        bzr log
 
1543
        bzr log foo.c
 
1544
        bzr log -r -10.. http://server/branch
 
1545
    """
 
1546
 
 
1547
    # TODO: Make --revision support uuid: and hash: [future tag:] notation.
 
1548
 
 
1549
    takes_args = ['location?']
 
1550
    takes_options = [Option('forward', 
 
1551
                            help='show from oldest to newest'),
 
1552
                     'timezone', 
 
1553
                     Option('verbose', 
 
1554
                             short_name='v',
 
1555
                             help='show files changed in each revision'),
 
1556
                     'show-ids', 'revision',
 
1557
                     'log-format',
 
1558
                     Option('message',
 
1559
                            short_name='m',
 
1560
                            help='show revisions whose message matches this regexp',
 
1561
                            type=str),
 
1562
                     ]
 
1563
    encoding_type = 'replace'
 
1564
 
 
1565
    @display_command
 
1566
    def run(self, location=None, timezone='original',
 
1567
            verbose=False,
 
1568
            show_ids=False,
 
1569
            forward=False,
 
1570
            revision=None,
 
1571
            log_format=None,
 
1572
            message=None):
 
1573
        from bzrlib.log import show_log
 
1574
        assert message is None or isinstance(message, basestring), \
 
1575
            "invalid message argument %r" % message
 
1576
        direction = (forward and 'forward') or 'reverse'
 
1577
        
 
1578
        # log everything
 
1579
        file_id = None
 
1580
        if location:
 
1581
            # find the file id to log:
 
1582
 
 
1583
            tree, b, fp = bzrdir.BzrDir.open_containing_tree_or_branch(
 
1584
                location)
 
1585
            if fp != '':
 
1586
                if tree is None:
 
1587
                    tree = b.basis_tree()
 
1588
                file_id = tree.path2id(fp)
 
1589
                if file_id is None:
 
1590
                    raise errors.BzrCommandError(
 
1591
                        "Path does not have any revision history: %s" %
 
1592
                        location)
 
1593
        else:
 
1594
            # local dir only
 
1595
            # FIXME ? log the current subdir only RBC 20060203 
 
1596
            if revision is not None \
 
1597
                    and len(revision) > 0 and revision[0].get_branch():
 
1598
                location = revision[0].get_branch()
 
1599
            else:
 
1600
                location = '.'
 
1601
            dir, relpath = bzrdir.BzrDir.open_containing(location)
 
1602
            b = dir.open_branch()
 
1603
 
 
1604
        b.lock_read()
 
1605
        try:
 
1606
            if revision is None:
 
1607
                rev1 = None
 
1608
                rev2 = None
 
1609
            elif len(revision) == 1:
 
1610
                rev1 = rev2 = revision[0].in_history(b).revno
 
1611
            elif len(revision) == 2:
 
1612
                if revision[1].get_branch() != revision[0].get_branch():
 
1613
                    # b is taken from revision[0].get_branch(), and
 
1614
                    # show_log will use its revision_history. Having
 
1615
                    # different branches will lead to weird behaviors.
 
1616
                    raise errors.BzrCommandError(
 
1617
                        "Log doesn't accept two revisions in different"
 
1618
                        " branches.")
 
1619
                if revision[0].spec is None:
 
1620
                    # missing begin-range means first revision
 
1621
                    rev1 = 1
 
1622
                else:
 
1623
                    rev1 = revision[0].in_history(b).revno
 
1624
 
 
1625
                if revision[1].spec is None:
 
1626
                    # missing end-range means last known revision
 
1627
                    rev2 = b.revno()
 
1628
                else:
 
1629
                    rev2 = revision[1].in_history(b).revno
 
1630
            else:
 
1631
                raise errors.BzrCommandError(
 
1632
                    'bzr log --revision takes one or two values.')
 
1633
 
 
1634
            # By this point, the revision numbers are converted to the +ve
 
1635
            # form if they were supplied in the -ve form, so we can do
 
1636
            # this comparison in relative safety
 
1637
            if rev1 > rev2:
 
1638
                (rev2, rev1) = (rev1, rev2)
 
1639
 
 
1640
            if log_format is None:
 
1641
                log_format = log.log_formatter_registry.get_default(b)
 
1642
 
 
1643
            lf = log_format(show_ids=show_ids, to_file=self.outf,
 
1644
                            show_timezone=timezone)
 
1645
 
 
1646
            show_log(b,
 
1647
                     lf,
 
1648
                     file_id,
 
1649
                     verbose=verbose,
 
1650
                     direction=direction,
 
1651
                     start_revision=rev1,
 
1652
                     end_revision=rev2,
 
1653
                     search=message)
 
1654
        finally:
 
1655
            b.unlock()
 
1656
 
 
1657
 
 
1658
def get_log_format(long=False, short=False, line=False, default='long'):
 
1659
    log_format = default
 
1660
    if long:
 
1661
        log_format = 'long'
 
1662
    if short:
 
1663
        log_format = 'short'
 
1664
    if line:
 
1665
        log_format = 'line'
 
1666
    return log_format
 
1667
 
 
1668
 
 
1669
class cmd_touching_revisions(Command):
 
1670
    """Return revision-ids which affected a particular file.
 
1671
 
 
1672
    A more user-friendly interface is "bzr log FILE".
 
1673
    """
 
1674
 
 
1675
    hidden = True
 
1676
    takes_args = ["filename"]
 
1677
 
 
1678
    @display_command
 
1679
    def run(self, filename):
 
1680
        tree, relpath = WorkingTree.open_containing(filename)
 
1681
        b = tree.branch
 
1682
        file_id = tree.path2id(relpath)
 
1683
        for revno, revision_id, what in log.find_touching_revisions(b, file_id):
 
1684
            self.outf.write("%6d %s\n" % (revno, what))
 
1685
 
 
1686
 
 
1687
class cmd_ls(Command):
 
1688
    """List files in a tree.
 
1689
    """
 
1690
 
 
1691
    takes_args = ['path?']
 
1692
    # TODO: Take a revision or remote path and list that tree instead.
 
1693
    takes_options = ['verbose', 'revision',
 
1694
                     Option('non-recursive',
 
1695
                            help='don\'t recurse into sub-directories'),
 
1696
                     Option('from-root',
 
1697
                            help='Print all paths from the root of the branch.'),
 
1698
                     Option('unknown', help='Print unknown files'),
 
1699
                     Option('versioned', help='Print versioned files'),
 
1700
                     Option('ignored', help='Print ignored files'),
 
1701
 
 
1702
                     Option('null', help='Null separate the files'),
 
1703
                     'kind', 'show-ids'
 
1704
                    ]
 
1705
    @display_command
 
1706
    def run(self, revision=None, verbose=False, 
 
1707
            non_recursive=False, from_root=False,
 
1708
            unknown=False, versioned=False, ignored=False,
 
1709
            null=False, kind=None, show_ids=False, path=None):
 
1710
 
 
1711
        if kind and kind not in ('file', 'directory', 'symlink'):
 
1712
            raise errors.BzrCommandError('invalid kind specified')
 
1713
 
 
1714
        if verbose and null:
 
1715
            raise errors.BzrCommandError('Cannot set both --verbose and --null')
 
1716
        all = not (unknown or versioned or ignored)
 
1717
 
 
1718
        selection = {'I':ignored, '?':unknown, 'V':versioned}
 
1719
 
 
1720
        if path is None:
 
1721
            fs_path = '.'
 
1722
            prefix = ''
 
1723
        else:
 
1724
            if from_root:
 
1725
                raise errors.BzrCommandError('cannot specify both --from-root'
 
1726
                                             ' and PATH')
 
1727
            fs_path = path
 
1728
            prefix = path
 
1729
        tree, branch, relpath = bzrdir.BzrDir.open_containing_tree_or_branch(
 
1730
            fs_path)
 
1731
        if from_root:
 
1732
            relpath = u''
 
1733
        elif relpath:
 
1734
            relpath += '/'
 
1735
        if revision is not None:
 
1736
            tree = branch.repository.revision_tree(
 
1737
                revision[0].in_history(branch).rev_id)
 
1738
        elif tree is None:
 
1739
            tree = branch.basis_tree()
 
1740
 
 
1741
        tree.lock_read()
 
1742
        try:
 
1743
            for fp, fc, fkind, fid, entry in tree.list_files(include_root=False):
 
1744
                if fp.startswith(relpath):
 
1745
                    fp = osutils.pathjoin(prefix, fp[len(relpath):])
 
1746
                    if non_recursive and '/' in fp:
 
1747
                        continue
 
1748
                    if not all and not selection[fc]:
 
1749
                        continue
 
1750
                    if kind is not None and fkind != kind:
 
1751
                        continue
 
1752
                    if verbose:
 
1753
                        kindch = entry.kind_character()
 
1754
                        outstring = '%-8s %s%s' % (fc, fp, kindch)
 
1755
                        if show_ids and fid is not None:
 
1756
                            outstring = "%-50s %s" % (outstring, fid)
 
1757
                        self.outf.write(outstring + '\n')
 
1758
                    elif null:
 
1759
                        self.outf.write(fp + '\0')
 
1760
                        if show_ids:
 
1761
                            if fid is not None:
 
1762
                                self.outf.write(fid)
 
1763
                            self.outf.write('\0')
 
1764
                        self.outf.flush()
 
1765
                    else:
 
1766
                        if fid is not None:
 
1767
                            my_id = fid
 
1768
                        else:
 
1769
                            my_id = ''
 
1770
                        if show_ids:
 
1771
                            self.outf.write('%-50s %s\n' % (fp, my_id))
 
1772
                        else:
 
1773
                            self.outf.write(fp + '\n')
 
1774
        finally:
 
1775
            tree.unlock()
 
1776
 
 
1777
 
 
1778
class cmd_unknowns(Command):
 
1779
    """List unknown files.
 
1780
 
 
1781
    See also: "bzr ls --unknown".
 
1782
    """
 
1783
 
 
1784
    hidden = True
 
1785
 
 
1786
    @display_command
 
1787
    def run(self):
 
1788
        for f in WorkingTree.open_containing(u'.')[0].unknowns():
 
1789
            self.outf.write(osutils.quotefn(f) + '\n')
 
1790
 
 
1791
 
 
1792
class cmd_ignore(Command):
 
1793
    """Ignore specified files or patterns.
 
1794
 
 
1795
    To remove patterns from the ignore list, edit the .bzrignore file.
 
1796
 
 
1797
    Trailing slashes on patterns are ignored. 
 
1798
    If the pattern contains a slash or is a regular expression, it is compared 
 
1799
    to the whole path from the branch root.  Otherwise, it is compared to only
 
1800
    the last component of the path.  To match a file only in the root 
 
1801
    directory, prepend './'.
 
1802
 
 
1803
    Ignore patterns specifying absolute paths are not allowed.
 
1804
 
 
1805
    Ignore patterns may include globbing wildcards such as:
 
1806
      ? - Matches any single character except '/'
 
1807
      * - Matches 0 or more characters except '/'
 
1808
      /**/ - Matches 0 or more directories in a path
 
1809
      [a-z] - Matches a single character from within a group of characters
 
1810
 
 
1811
    Ignore patterns may also be Python regular expressions.  
 
1812
    Regular expression ignore patterns are identified by a 'RE:' prefix 
 
1813
    followed by the regular expression.  Regular expression ignore patterns
 
1814
    may not include named or numbered groups.
 
1815
 
 
1816
    Note: ignore patterns containing shell wildcards must be quoted from 
 
1817
    the shell on Unix.
 
1818
 
 
1819
    examples:
 
1820
        bzr ignore ./Makefile
 
1821
        bzr ignore '*.class'
 
1822
        bzr ignore 'lib/**/*.o'
 
1823
        bzr ignore 'RE:lib/.*\.o'
 
1824
    """
 
1825
    takes_args = ['name_pattern*']
 
1826
    takes_options = [
 
1827
                     Option('old-default-rules',
 
1828
                            help='Out the ignore rules bzr < 0.9 always used.')
 
1829
                     ]
 
1830
    
 
1831
    def run(self, name_pattern_list=None, old_default_rules=None):
 
1832
        from bzrlib.atomicfile import AtomicFile
 
1833
        if old_default_rules is not None:
 
1834
            # dump the rules and exit
 
1835
            for pattern in ignores.OLD_DEFAULTS:
 
1836
                print pattern
 
1837
            return
 
1838
        if not name_pattern_list:
 
1839
            raise errors.BzrCommandError("ignore requires at least one "
 
1840
                                  "NAME_PATTERN or --old-default-rules")
 
1841
        name_pattern_list = [globbing.normalize_pattern(p) 
 
1842
                             for p in name_pattern_list]
 
1843
        for name_pattern in name_pattern_list:
 
1844
            if (name_pattern[0] == '/' or 
 
1845
                (len(name_pattern) > 1 and name_pattern[1] == ':')):
 
1846
                raise errors.BzrCommandError(
 
1847
                    "NAME_PATTERN should not be an absolute path")
 
1848
        tree, relpath = WorkingTree.open_containing(u'.')
 
1849
        ifn = tree.abspath('.bzrignore')
 
1850
        if os.path.exists(ifn):
 
1851
            f = open(ifn, 'rt')
 
1852
            try:
 
1853
                igns = f.read().decode('utf-8')
 
1854
            finally:
 
1855
                f.close()
 
1856
        else:
 
1857
            igns = ''
 
1858
 
 
1859
        # TODO: If the file already uses crlf-style termination, maybe
 
1860
        # we should use that for the newly added lines?
 
1861
 
 
1862
        if igns and igns[-1] != '\n':
 
1863
            igns += '\n'
 
1864
        for name_pattern in name_pattern_list:
 
1865
            igns += name_pattern + '\n'
 
1866
 
 
1867
        f = AtomicFile(ifn, 'wb')
 
1868
        try:
 
1869
            f.write(igns.encode('utf-8'))
 
1870
            f.commit()
 
1871
        finally:
 
1872
            f.close()
 
1873
 
 
1874
        if not tree.path2id('.bzrignore'):
 
1875
            tree.add(['.bzrignore'])
 
1876
 
 
1877
 
 
1878
class cmd_ignored(Command):
 
1879
    """List ignored files and the patterns that matched them.
 
1880
 
 
1881
    See also: bzr ignore"""
 
1882
    @display_command
 
1883
    def run(self):
 
1884
        tree = WorkingTree.open_containing(u'.')[0]
 
1885
        tree.lock_read()
 
1886
        try:
 
1887
            for path, file_class, kind, file_id, entry in tree.list_files():
 
1888
                if file_class != 'I':
 
1889
                    continue
 
1890
                ## XXX: Slightly inefficient since this was already calculated
 
1891
                pat = tree.is_ignored(path)
 
1892
                print '%-50s %s' % (path, pat)
 
1893
        finally:
 
1894
            tree.unlock()
 
1895
 
 
1896
 
 
1897
class cmd_lookup_revision(Command):
 
1898
    """Lookup the revision-id from a revision-number
 
1899
 
 
1900
    example:
 
1901
        bzr lookup-revision 33
 
1902
    """
 
1903
    hidden = True
 
1904
    takes_args = ['revno']
 
1905
    
 
1906
    @display_command
 
1907
    def run(self, revno):
 
1908
        try:
 
1909
            revno = int(revno)
 
1910
        except ValueError:
 
1911
            raise errors.BzrCommandError("not a valid revision-number: %r" % revno)
 
1912
 
 
1913
        print WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
 
1914
 
 
1915
 
 
1916
class cmd_export(Command):
 
1917
    """Export past revision to destination directory.
 
1918
 
 
1919
    If no revision is specified this exports the last committed revision.
 
1920
 
 
1921
    Format may be an "exporter" name, such as tar, tgz, tbz2.  If none is
 
1922
    given, try to find the format with the extension. If no extension
 
1923
    is found exports to a directory (equivalent to --format=dir).
 
1924
 
 
1925
    Root may be the top directory for tar, tgz and tbz2 formats. If none
 
1926
    is given, the top directory will be the root name of the file.
 
1927
 
 
1928
    If branch is omitted then the branch containing the CWD will be used.
 
1929
 
 
1930
    Note: export of tree with non-ascii filenames to zip is not supported.
 
1931
 
 
1932
     Supported formats       Autodetected by extension
 
1933
     -----------------       -------------------------
 
1934
         dir                            -
 
1935
         tar                          .tar
 
1936
         tbz2                    .tar.bz2, .tbz2
 
1937
         tgz                      .tar.gz, .tgz
 
1938
         zip                          .zip
 
1939
    """
 
1940
    takes_args = ['dest', 'branch?']
 
1941
    takes_options = ['revision', 'format', 'root']
 
1942
    def run(self, dest, branch=None, revision=None, format=None, root=None):
 
1943
        from bzrlib.export import export
 
1944
 
 
1945
        if branch is None:
 
1946
            tree = WorkingTree.open_containing(u'.')[0]
 
1947
            b = tree.branch
 
1948
        else:
 
1949
            b = Branch.open(branch)
 
1950
            
 
1951
        if revision is None:
 
1952
            # should be tree.last_revision  FIXME
 
1953
            rev_id = b.last_revision()
 
1954
        else:
 
1955
            if len(revision) != 1:
 
1956
                raise errors.BzrCommandError('bzr export --revision takes exactly 1 argument')
 
1957
            rev_id = revision[0].in_history(b).rev_id
 
1958
        t = b.repository.revision_tree(rev_id)
 
1959
        try:
 
1960
            export(t, dest, format, root)
 
1961
        except errors.NoSuchExportFormat, e:
 
1962
            raise errors.BzrCommandError('Unsupported export format: %s' % e.format)
 
1963
 
 
1964
 
 
1965
class cmd_cat(Command):
 
1966
    """Write a file's text from a previous revision."""
 
1967
 
 
1968
    takes_options = ['revision', 'name-from-revision']
 
1969
    takes_args = ['filename']
 
1970
    encoding_type = 'exact'
 
1971
 
 
1972
    @display_command
 
1973
    def run(self, filename, revision=None, name_from_revision=False):
 
1974
        if revision is not None and len(revision) != 1:
 
1975
            raise errors.BzrCommandError("bzr cat --revision takes exactly"
 
1976
                                        " one number")
 
1977
 
 
1978
        tree = None
 
1979
        try:
 
1980
            tree, b, relpath = \
 
1981
                    bzrdir.BzrDir.open_containing_tree_or_branch(filename)
 
1982
        except errors.NotBranchError:
 
1983
            pass
 
1984
 
 
1985
        if revision is not None and revision[0].get_branch() is not None:
 
1986
            b = Branch.open(revision[0].get_branch())
 
1987
        if tree is None:
 
1988
            tree = b.basis_tree()
 
1989
        if revision is None:
 
1990
            revision_id = b.last_revision()
 
1991
        else:
 
1992
            revision_id = revision[0].in_history(b).rev_id
 
1993
 
 
1994
        cur_file_id = tree.path2id(relpath)
 
1995
        rev_tree = b.repository.revision_tree(revision_id)
 
1996
        old_file_id = rev_tree.path2id(relpath)
 
1997
        
 
1998
        if name_from_revision:
 
1999
            if old_file_id is None:
 
2000
                raise errors.BzrCommandError("%r is not present in revision %s"
 
2001
                                                % (filename, revision_id))
 
2002
            else:
 
2003
                rev_tree.print_file(old_file_id)
 
2004
        elif cur_file_id is not None:
 
2005
            rev_tree.print_file(cur_file_id)
 
2006
        elif old_file_id is not None:
 
2007
            rev_tree.print_file(old_file_id)
 
2008
        else:
 
2009
            raise errors.BzrCommandError("%r is not present in revision %s" %
 
2010
                                         (filename, revision_id))
 
2011
 
 
2012
 
 
2013
class cmd_local_time_offset(Command):
 
2014
    """Show the offset in seconds from GMT to local time."""
 
2015
    hidden = True    
 
2016
    @display_command
 
2017
    def run(self):
 
2018
        print osutils.local_time_offset()
 
2019
 
 
2020
 
 
2021
 
 
2022
class cmd_commit(Command):
 
2023
    """Commit changes into a new revision.
 
2024
    
 
2025
    If no arguments are given, the entire tree is committed.
 
2026
 
 
2027
    If selected files are specified, only changes to those files are
 
2028
    committed.  If a directory is specified then the directory and everything 
 
2029
    within it is committed.
 
2030
 
 
2031
    A selected-file commit may fail in some cases where the committed
 
2032
    tree would be invalid, such as trying to commit a file in a
 
2033
    newly-added directory that is not itself committed.
 
2034
    """
 
2035
    # TODO: Run hooks on tree to-be-committed, and after commit.
 
2036
 
 
2037
    # TODO: Strict commit that fails if there are deleted files.
 
2038
    #       (what does "deleted files" mean ??)
 
2039
 
 
2040
    # TODO: Give better message for -s, --summary, used by tla people
 
2041
 
 
2042
    # XXX: verbose currently does nothing
 
2043
 
 
2044
    takes_args = ['selected*']
 
2045
    takes_options = ['message', 'verbose', 
 
2046
                     Option('unchanged',
 
2047
                            help='commit even if nothing has changed'),
 
2048
                     Option('file', type=str, 
 
2049
                            short_name='F',
 
2050
                            argname='msgfile',
 
2051
                            help='file containing commit message'),
 
2052
                     Option('strict',
 
2053
                            help="refuse to commit if there are unknown "
 
2054
                            "files in the working tree."),
 
2055
                     Option('local',
 
2056
                            help="perform a local only commit in a bound "
 
2057
                                 "branch. Such commits are not pushed to "
 
2058
                                 "the master branch until a normal commit "
 
2059
                                 "is performed."
 
2060
                            ),
 
2061
                     ]
 
2062
    aliases = ['ci', 'checkin']
 
2063
 
 
2064
    def run(self, message=None, file=None, verbose=True, selected_list=None,
 
2065
            unchanged=False, strict=False, local=False):
 
2066
        from bzrlib.commit import (NullCommitReporter, ReportCommitToLog)
 
2067
        from bzrlib.errors import (PointlessCommit, ConflictsInTree,
 
2068
                StrictCommitFailed)
 
2069
        from bzrlib.msgeditor import edit_commit_message, \
 
2070
                make_commit_message_template
 
2071
 
 
2072
        # TODO: Need a blackbox test for invoking the external editor; may be
 
2073
        # slightly problematic to run this cross-platform.
 
2074
 
 
2075
        # TODO: do more checks that the commit will succeed before 
 
2076
        # spending the user's valuable time typing a commit message.
 
2077
        tree, selected_list = tree_files(selected_list)
 
2078
        if selected_list == ['']:
 
2079
            # workaround - commit of root of tree should be exactly the same
 
2080
            # as just default commit in that tree, and succeed even though
 
2081
            # selected-file merge commit is not done yet
 
2082
            selected_list = []
 
2083
 
 
2084
        if local and not tree.branch.get_bound_location():
 
2085
            raise errors.LocalRequiresBoundBranch()
 
2086
 
 
2087
        def get_message(commit_obj):
 
2088
            """Callback to get commit message"""
 
2089
            my_message = message
 
2090
            if my_message is None and not file:
 
2091
                template = make_commit_message_template(tree, selected_list)
 
2092
                my_message = edit_commit_message(template)
 
2093
                if my_message is None:
 
2094
                    raise errors.BzrCommandError("please specify a commit"
 
2095
                        " message with either --message or --file")
 
2096
            elif my_message and file:
 
2097
                raise errors.BzrCommandError(
 
2098
                    "please specify either --message or --file")
 
2099
            if file:
 
2100
                my_message = codecs.open(file, 'rt', 
 
2101
                                         bzrlib.user_encoding).read()
 
2102
            if my_message == "":
 
2103
                raise errors.BzrCommandError("empty commit message specified")
 
2104
            return my_message
 
2105
        
 
2106
        if verbose:
 
2107
            reporter = ReportCommitToLog()
 
2108
        else:
 
2109
            reporter = NullCommitReporter()
 
2110
 
 
2111
        try:
 
2112
            tree.commit(message_callback=get_message,
 
2113
                        specific_files=selected_list,
 
2114
                        allow_pointless=unchanged, strict=strict, local=local,
 
2115
                        reporter=reporter)
 
2116
        except PointlessCommit:
 
2117
            # FIXME: This should really happen before the file is read in;
 
2118
            # perhaps prepare the commit; get the message; then actually commit
 
2119
            raise errors.BzrCommandError("no changes to commit."
 
2120
                              " use --unchanged to commit anyhow")
 
2121
        except ConflictsInTree:
 
2122
            raise errors.BzrCommandError('Conflicts detected in working '
 
2123
                'tree.  Use "bzr conflicts" to list, "bzr resolve FILE" to'
 
2124
                ' resolve.')
 
2125
        except StrictCommitFailed:
 
2126
            raise errors.BzrCommandError("Commit refused because there are"
 
2127
                              " unknown files in the working tree.")
 
2128
        except errors.BoundBranchOutOfDate, e:
 
2129
            raise errors.BzrCommandError(str(e) + "\n"
 
2130
            'To commit to master branch, run update and then commit.\n'
 
2131
            'You can also pass --local to commit to continue working '
 
2132
            'disconnected.')
 
2133
 
 
2134
 
 
2135
class cmd_check(Command):
 
2136
    """Validate consistency of branch history.
 
2137
 
 
2138
    This command checks various invariants about the branch storage to
 
2139
    detect data corruption or bzr bugs.
 
2140
    """
 
2141
    takes_args = ['branch?']
 
2142
    takes_options = ['verbose']
 
2143
 
 
2144
    def run(self, branch=None, verbose=False):
 
2145
        from bzrlib.check import check
 
2146
        if branch is None:
 
2147
            tree = WorkingTree.open_containing()[0]
 
2148
            branch = tree.branch
 
2149
        else:
 
2150
            branch = Branch.open(branch)
 
2151
        check(branch, verbose)
 
2152
 
 
2153
 
 
2154
class cmd_upgrade(Command):
 
2155
    """Upgrade branch storage to current format.
 
2156
 
 
2157
    The check command or bzr developers may sometimes advise you to run
 
2158
    this command. When the default format has changed you may also be warned
 
2159
    during other operations to upgrade.
 
2160
    """
 
2161
    takes_args = ['url?']
 
2162
    takes_options = [
 
2163
                    RegistryOption('format',
 
2164
                        help='Upgrade to a specific format.  See "bzr help'
 
2165
                             ' formats" for details',
 
2166
                        registry=bzrdir.format_registry,
 
2167
                        converter=bzrdir.format_registry.make_bzrdir,
 
2168
                        value_switches=True, title='Branch format'),
 
2169
                    ]
 
2170
 
 
2171
    def run(self, url='.', format=None):
 
2172
        from bzrlib.upgrade import upgrade
 
2173
        if format is None:
 
2174
            format = bzrdir.format_registry.make_bzrdir('default')
 
2175
        upgrade(url, format)
 
2176
 
 
2177
 
 
2178
class cmd_whoami(Command):
 
2179
    """Show or set bzr user id.
 
2180
    
 
2181
    examples:
 
2182
        bzr whoami --email
 
2183
        bzr whoami 'Frank Chu <fchu@example.com>'
 
2184
    """
 
2185
    takes_options = [ Option('email',
 
2186
                             help='display email address only'),
 
2187
                      Option('branch',
 
2188
                             help='set identity for the current branch instead of '
 
2189
                                  'globally'),
 
2190
                    ]
 
2191
    takes_args = ['name?']
 
2192
    encoding_type = 'replace'
 
2193
    
 
2194
    @display_command
 
2195
    def run(self, email=False, branch=False, name=None):
 
2196
        if name is None:
 
2197
            # use branch if we're inside one; otherwise global config
 
2198
            try:
 
2199
                c = Branch.open_containing('.')[0].get_config()
 
2200
            except errors.NotBranchError:
 
2201
                c = config.GlobalConfig()
 
2202
            if email:
 
2203
                self.outf.write(c.user_email() + '\n')
 
2204
            else:
 
2205
                self.outf.write(c.username() + '\n')
 
2206
            return
 
2207
 
 
2208
        # display a warning if an email address isn't included in the given name.
 
2209
        try:
 
2210
            config.extract_email_address(name)
 
2211
        except errors.NoEmailInUsername, e:
 
2212
            warning('"%s" does not seem to contain an email address.  '
 
2213
                    'This is allowed, but not recommended.', name)
 
2214
        
 
2215
        # use global config unless --branch given
 
2216
        if branch:
 
2217
            c = Branch.open_containing('.')[0].get_config()
 
2218
        else:
 
2219
            c = config.GlobalConfig()
 
2220
        c.set_user_option('email', name)
 
2221
 
 
2222
 
 
2223
class cmd_nick(Command):
 
2224
    """Print or set the branch nickname.  
 
2225
 
 
2226
    If unset, the tree root directory name is used as the nickname
 
2227
    To print the current nickname, execute with no argument.  
 
2228
    """
 
2229
    takes_args = ['nickname?']
 
2230
    def run(self, nickname=None):
 
2231
        branch = Branch.open_containing(u'.')[0]
 
2232
        if nickname is None:
 
2233
            self.printme(branch)
 
2234
        else:
 
2235
            branch.nick = nickname
 
2236
 
 
2237
    @display_command
 
2238
    def printme(self, branch):
 
2239
        print branch.nick 
 
2240
 
 
2241
 
 
2242
class cmd_selftest(Command):
 
2243
    """Run internal test suite.
 
2244
    
 
2245
    This creates temporary test directories in the working directory, but not
 
2246
    existing data is affected.  These directories are deleted if the tests
 
2247
    pass, or left behind to help in debugging if they fail and --keep-output
 
2248
    is specified.
 
2249
    
 
2250
    If arguments are given, they are regular expressions that say which tests
 
2251
    should run.  Tests matching any expression are run, and other tests are
 
2252
    not run.
 
2253
 
 
2254
    Alternatively if --first is given, matching tests are run first and then
 
2255
    all other tests are run.  This is useful if you have been working in a
 
2256
    particular area, but want to make sure nothing else was broken.
 
2257
 
 
2258
    If the global option '--no-plugins' is given, plugins are not loaded
 
2259
    before running the selftests.  This has two effects: features provided or
 
2260
    modified by plugins will not be tested, and tests provided by plugins will
 
2261
    not be run.
 
2262
 
 
2263
    examples::
 
2264
        bzr selftest ignore
 
2265
            run only tests relating to 'ignore'
 
2266
        bzr --no-plugins selftest -v
 
2267
            disable plugins and list tests as they're run
 
2268
 
 
2269
    For each test, that needs actual disk access, bzr create their own
 
2270
    subdirectory in the temporary testing directory (testXXXX.tmp).
 
2271
    By default the name of such subdirectory is based on the name of the test.
 
2272
    If option '--numbered-dirs' is given, bzr will use sequent numbers
 
2273
    of running tests to create such subdirectories. This is default behavior
 
2274
    on Windows because of path length limitation.
 
2275
    """
 
2276
    # TODO: --list should give a list of all available tests
 
2277
 
 
2278
    # NB: this is used from the class without creating an instance, which is
 
2279
    # why it does not have a self parameter.
 
2280
    def get_transport_type(typestring):
 
2281
        """Parse and return a transport specifier."""
 
2282
        if typestring == "sftp":
 
2283
            from bzrlib.transport.sftp import SFTPAbsoluteServer
 
2284
            return SFTPAbsoluteServer
 
2285
        if typestring == "memory":
 
2286
            from bzrlib.transport.memory import MemoryServer
 
2287
            return MemoryServer
 
2288
        if typestring == "fakenfs":
 
2289
            from bzrlib.transport.fakenfs import FakeNFSServer
 
2290
            return FakeNFSServer
 
2291
        msg = "No known transport type %s. Supported types are: sftp\n" %\
 
2292
            (typestring)
 
2293
        raise errors.BzrCommandError(msg)
 
2294
 
 
2295
    hidden = True
 
2296
    takes_args = ['testspecs*']
 
2297
    takes_options = ['verbose',
 
2298
                     Option('one', help='stop when one test fails'),
 
2299
                     Option('keep-output', 
 
2300
                            help='keep output directories when tests fail'),
 
2301
                     Option('transport', 
 
2302
                            help='Use a different transport by default '
 
2303
                                 'throughout the test suite.',
 
2304
                            type=get_transport_type),
 
2305
                     Option('benchmark', help='run the bzr bencharks.'),
 
2306
                     Option('lsprof-timed',
 
2307
                            help='generate lsprof output for benchmarked'
 
2308
                                 ' sections of code.'),
 
2309
                     Option('cache-dir', type=str,
 
2310
                            help='a directory to cache intermediate'
 
2311
                                 ' benchmark steps'),
 
2312
                     Option('clean-output',
 
2313
                            help='clean temporary tests directories'
 
2314
                                 ' without running tests'),
 
2315
                     Option('first',
 
2316
                            help='run all tests, but run specified tests first',
 
2317
                            ),
 
2318
                     Option('numbered-dirs',
 
2319
                            help='use numbered dirs for TestCaseInTempDir'),
 
2320
                     ]
 
2321
    encoding_type = 'replace'
 
2322
 
 
2323
    def run(self, testspecs_list=None, verbose=None, one=False,
 
2324
            keep_output=False, transport=None, benchmark=None,
 
2325
            lsprof_timed=None, cache_dir=None, clean_output=False,
 
2326
            first=False, numbered_dirs=None):
 
2327
        import bzrlib.ui
 
2328
        from bzrlib.tests import selftest
 
2329
        import bzrlib.benchmarks as benchmarks
 
2330
        from bzrlib.benchmarks import tree_creator
 
2331
 
 
2332
        if clean_output:
 
2333
            from bzrlib.tests import clean_selftest_output
 
2334
            clean_selftest_output()
 
2335
            return 0
 
2336
 
 
2337
        if numbered_dirs is None and sys.platform == 'win32':
 
2338
            numbered_dirs = True
 
2339
 
 
2340
        if cache_dir is not None:
 
2341
            tree_creator.TreeCreator.CACHE_ROOT = osutils.abspath(cache_dir)
 
2342
        print '%10s: %s' % ('bzr', osutils.realpath(sys.argv[0]))
 
2343
        print '%10s: %s' % ('bzrlib', bzrlib.__path__[0])
 
2344
        print
 
2345
        if testspecs_list is not None:
 
2346
            pattern = '|'.join(testspecs_list)
 
2347
        else:
 
2348
            pattern = ".*"
 
2349
        if benchmark:
 
2350
            test_suite_factory = benchmarks.test_suite
 
2351
            if verbose is None:
 
2352
                verbose = True
 
2353
            # TODO: should possibly lock the history file...
 
2354
            benchfile = open(".perf_history", "at", buffering=1)
 
2355
        else:
 
2356
            test_suite_factory = None
 
2357
            if verbose is None:
 
2358
                verbose = False
 
2359
            benchfile = None
 
2360
        try:
 
2361
            result = selftest(verbose=verbose, 
 
2362
                              pattern=pattern,
 
2363
                              stop_on_failure=one, 
 
2364
                              keep_output=keep_output,
 
2365
                              transport=transport,
 
2366
                              test_suite_factory=test_suite_factory,
 
2367
                              lsprof_timed=lsprof_timed,
 
2368
                              bench_history=benchfile,
 
2369
                              matching_tests_first=first,
 
2370
                              numbered_dirs=numbered_dirs,
 
2371
                              )
 
2372
        finally:
 
2373
            if benchfile is not None:
 
2374
                benchfile.close()
 
2375
        if result:
 
2376
            info('tests passed')
 
2377
        else:
 
2378
            info('tests failed')
 
2379
        return int(not result)
 
2380
 
 
2381
 
 
2382
class cmd_version(Command):
 
2383
    """Show version of bzr."""
 
2384
 
 
2385
    @display_command
 
2386
    def run(self):
 
2387
        from bzrlib.version import show_version
 
2388
        show_version()
 
2389
 
 
2390
 
 
2391
class cmd_rocks(Command):
 
2392
    """Statement of optimism."""
 
2393
 
 
2394
    hidden = True
 
2395
 
 
2396
    @display_command
 
2397
    def run(self):
 
2398
        print "It sure does!"
 
2399
 
 
2400
 
 
2401
class cmd_find_merge_base(Command):
 
2402
    """Find and print a base revision for merging two branches."""
 
2403
    # TODO: Options to specify revisions on either side, as if
 
2404
    #       merging only part of the history.
 
2405
    takes_args = ['branch', 'other']
 
2406
    hidden = True
 
2407
    
 
2408
    @display_command
 
2409
    def run(self, branch, other):
 
2410
        from bzrlib.revision import MultipleRevisionSources
 
2411
        
 
2412
        branch1 = Branch.open_containing(branch)[0]
 
2413
        branch2 = Branch.open_containing(other)[0]
 
2414
 
 
2415
        last1 = branch1.last_revision()
 
2416
        last2 = branch2.last_revision()
 
2417
 
 
2418
        source = MultipleRevisionSources(branch1.repository, 
 
2419
                                         branch2.repository)
 
2420
        
 
2421
        base_rev_id = common_ancestor(last1, last2, source)
 
2422
 
 
2423
        print 'merge base is revision %s' % base_rev_id
 
2424
 
 
2425
 
 
2426
class cmd_merge(Command):
 
2427
    """Perform a three-way merge.
 
2428
    
 
2429
    The branch is the branch you will merge from.  By default, it will merge
 
2430
    the latest revision.  If you specify a revision, that revision will be
 
2431
    merged.  If you specify two revisions, the first will be used as a BASE,
 
2432
    and the second one as OTHER.  Revision numbers are always relative to the
 
2433
    specified branch.
 
2434
 
 
2435
    By default, bzr will try to merge in all new work from the other
 
2436
    branch, automatically determining an appropriate base.  If this
 
2437
    fails, you may need to give an explicit base.
 
2438
    
 
2439
    Merge will do its best to combine the changes in two branches, but there
 
2440
    are some kinds of problems only a human can fix.  When it encounters those,
 
2441
    it will mark a conflict.  A conflict means that you need to fix something,
 
2442
    before you should commit.
 
2443
 
 
2444
    Use bzr resolve when you have fixed a problem.  See also bzr conflicts.
 
2445
 
 
2446
    If there is no default branch set, the first merge will set it. After
 
2447
    that, you can omit the branch to use the default.  To change the
 
2448
    default, use --remember. The value will only be saved if the remote
 
2449
    location can be accessed.
 
2450
 
 
2451
    The results of the merge are placed into the destination working
 
2452
    directory, where they can be reviewed (with bzr diff), tested, and then
 
2453
    committed to record the result of the merge.
 
2454
 
 
2455
    Examples:
 
2456
 
 
2457
    To merge the latest revision from bzr.dev
 
2458
    bzr merge ../bzr.dev
 
2459
 
 
2460
    To merge changes up to and including revision 82 from bzr.dev
 
2461
    bzr merge -r 82 ../bzr.dev
 
2462
 
 
2463
    To merge the changes introduced by 82, without previous changes:
 
2464
    bzr merge -r 81..82 ../bzr.dev
 
2465
    
 
2466
    merge refuses to run if there are any uncommitted changes, unless
 
2467
    --force is given.
 
2468
 
 
2469
    The following merge types are available:
 
2470
    """
 
2471
    takes_args = ['branch?']
 
2472
    takes_options = ['revision', 'force', 'merge-type', 'reprocess', 'remember',
 
2473
        Option('show-base', help="Show base revision text in "
 
2474
               "conflicts"),
 
2475
        Option('uncommitted', help='Apply uncommitted changes'
 
2476
               ' from a working copy, instead of branch changes'),
 
2477
        Option('pull', help='If the destination is already'
 
2478
                ' completely merged into the source, pull from the'
 
2479
                ' source rather than merging. When this happens,'
 
2480
                ' you do not need to commit the result.'),
 
2481
        Option('directory',
 
2482
            help='Branch to merge into, '
 
2483
                 'rather than the one containing the working directory',
 
2484
            short_name='d',
 
2485
            type=unicode,
 
2486
            ),
 
2487
    ]
 
2488
 
 
2489
    def run(self, branch=None, revision=None, force=False, merge_type=None,
 
2490
            show_base=False, reprocess=False, remember=False,
 
2491
            uncommitted=False, pull=False,
 
2492
            directory=None,
 
2493
            ):
 
2494
        from bzrlib.tag import _merge_tags_if_possible
 
2495
        if merge_type is None:
 
2496
            merge_type = _mod_merge.Merge3Merger
 
2497
 
 
2498
        if directory is None: directory = u'.'
 
2499
        # XXX: jam 20070225 WorkingTree should be locked before you extract its
 
2500
        #      inventory. Because merge is a mutating operation, it really
 
2501
        #      should be a lock_write() for the whole cmd_merge operation.
 
2502
        #      However, cmd_merge open's its own tree in _merge_helper, which
 
2503
        #      means if we lock here, the later lock_write() will always block.
 
2504
        #      Either the merge helper code should be updated to take a tree,
 
2505
        #      (What about tree.merge_from_branch?)
 
2506
        tree = WorkingTree.open_containing(directory)[0]
 
2507
        change_reporter = delta._ChangeReporter(
 
2508
            unversioned_filter=tree.is_ignored)
 
2509
 
 
2510
        if branch is not None:
 
2511
            try:
 
2512
                reader = bundle.read_bundle_from_url(branch)
 
2513
            except errors.NotABundle:
 
2514
                pass # Continue on considering this url a Branch
 
2515
            else:
 
2516
                conflicts = merge_bundle(reader, tree, not force, merge_type,
 
2517
                                         reprocess, show_base, change_reporter)
 
2518
                if conflicts == 0:
 
2519
                    return 0
 
2520
                else:
 
2521
                    return 1
 
2522
 
 
2523
        if revision is None \
 
2524
                or len(revision) < 1 or revision[0].needs_branch():
 
2525
            branch = self._get_remembered_parent(tree, branch, 'Merging from')
 
2526
 
 
2527
        if revision is None or len(revision) < 1:
 
2528
            if uncommitted:
 
2529
                base = [branch, -1]
 
2530
                other = [branch, None]
 
2531
            else:
 
2532
                base = [None, None]
 
2533
                other = [branch, -1]
 
2534
            other_branch, path = Branch.open_containing(branch)
 
2535
        else:
 
2536
            if uncommitted:
 
2537
                raise errors.BzrCommandError('Cannot use --uncommitted and'
 
2538
                                             ' --revision at the same time.')
 
2539
            branch = revision[0].get_branch() or branch
 
2540
            if len(revision) == 1:
 
2541
                base = [None, None]
 
2542
                other_branch, path = Branch.open_containing(branch)
 
2543
                revno = revision[0].in_history(other_branch).revno
 
2544
                other = [branch, revno]
 
2545
            else:
 
2546
                assert len(revision) == 2
 
2547
                if None in revision:
 
2548
                    raise errors.BzrCommandError(
 
2549
                        "Merge doesn't permit empty revision specifier.")
 
2550
                base_branch, path = Branch.open_containing(branch)
 
2551
                branch1 = revision[1].get_branch() or branch
 
2552
                other_branch, path1 = Branch.open_containing(branch1)
 
2553
                if revision[0].get_branch() is not None:
 
2554
                    # then path was obtained from it, and is None.
 
2555
                    path = path1
 
2556
 
 
2557
                base = [branch, revision[0].in_history(base_branch).revno]
 
2558
                other = [branch1, revision[1].in_history(other_branch).revno]
 
2559
 
 
2560
        if tree.branch.get_parent() is None or remember:
 
2561
            tree.branch.set_parent(other_branch.base)
 
2562
 
 
2563
        # pull tags now... it's a bit inconsistent to do it ahead of copying
 
2564
        # the history but that's done inside the merge code
 
2565
        _merge_tags_if_possible(other_branch, tree.branch)
 
2566
 
 
2567
        if path != "":
 
2568
            interesting_files = [path]
 
2569
        else:
 
2570
            interesting_files = None
 
2571
        pb = ui.ui_factory.nested_progress_bar()
 
2572
        try:
 
2573
            try:
 
2574
                conflict_count = _merge_helper(
 
2575
                    other, base, check_clean=(not force),
 
2576
                    merge_type=merge_type,
 
2577
                    reprocess=reprocess,
 
2578
                    show_base=show_base,
 
2579
                    pull=pull,
 
2580
                    this_dir=directory,
 
2581
                    pb=pb, file_list=interesting_files,
 
2582
                    change_reporter=change_reporter)
 
2583
            finally:
 
2584
                pb.finished()
 
2585
            if conflict_count != 0:
 
2586
                return 1
 
2587
            else:
 
2588
                return 0
 
2589
        except errors.AmbiguousBase, e:
 
2590
            m = ("sorry, bzr can't determine the right merge base yet\n"
 
2591
                 "candidates are:\n  "
 
2592
                 + "\n  ".join(e.bases)
 
2593
                 + "\n"
 
2594
                 "please specify an explicit base with -r,\n"
 
2595
                 "and (if you want) report this to the bzr developers\n")
 
2596
            log_error(m)
 
2597
 
 
2598
    # TODO: move up to common parent; this isn't merge-specific anymore. 
 
2599
    def _get_remembered_parent(self, tree, supplied_location, verb_string):
 
2600
        """Use tree.branch's parent if none was supplied.
 
2601
 
 
2602
        Report if the remembered location was used.
 
2603
        """
 
2604
        if supplied_location is not None:
 
2605
            return supplied_location
 
2606
        stored_location = tree.branch.get_parent()
 
2607
        mutter("%s", stored_location)
 
2608
        if stored_location is None:
 
2609
            raise errors.BzrCommandError("No location specified or remembered")
 
2610
        display_url = urlutils.unescape_for_display(stored_location, self.outf.encoding)
 
2611
        self.outf.write("%s remembered location %s\n" % (verb_string, display_url))
 
2612
        return stored_location
 
2613
 
 
2614
 
 
2615
class cmd_remerge(Command):
 
2616
    """Redo a merge.
 
2617
 
 
2618
    Use this if you want to try a different merge technique while resolving
 
2619
    conflicts.  Some merge techniques are better than others, and remerge 
 
2620
    lets you try different ones on different files.
 
2621
 
 
2622
    The options for remerge have the same meaning and defaults as the ones for
 
2623
    merge.  The difference is that remerge can (only) be run when there is a
 
2624
    pending merge, and it lets you specify particular files.
 
2625
 
 
2626
    Examples:
 
2627
    $ bzr remerge --show-base
 
2628
        Re-do the merge of all conflicted files, and show the base text in
 
2629
        conflict regions, in addition to the usual THIS and OTHER texts.
 
2630
 
 
2631
    $ bzr remerge --merge-type weave --reprocess foobar
 
2632
        Re-do the merge of "foobar", using the weave merge algorithm, with
 
2633
        additional processing to reduce the size of conflict regions.
 
2634
    
 
2635
    The following merge types are available:"""
 
2636
    takes_args = ['file*']
 
2637
    takes_options = ['merge-type', 'reprocess',
 
2638
                     Option('show-base', help="Show base revision text in "
 
2639
                            "conflicts")]
 
2640
 
 
2641
    def run(self, file_list=None, merge_type=None, show_base=False,
 
2642
            reprocess=False):
 
2643
        if merge_type is None:
 
2644
            merge_type = _mod_merge.Merge3Merger
 
2645
        tree, file_list = tree_files(file_list)
 
2646
        tree.lock_write()
 
2647
        try:
 
2648
            parents = tree.get_parent_ids()
 
2649
            if len(parents) != 2:
 
2650
                raise errors.BzrCommandError("Sorry, remerge only works after normal"
 
2651
                                             " merges.  Not cherrypicking or"
 
2652
                                             " multi-merges.")
 
2653
            repository = tree.branch.repository
 
2654
            base_revision = common_ancestor(parents[0],
 
2655
                                            parents[1], repository)
 
2656
            base_tree = repository.revision_tree(base_revision)
 
2657
            other_tree = repository.revision_tree(parents[1])
 
2658
            interesting_ids = None
 
2659
            new_conflicts = []
 
2660
            conflicts = tree.conflicts()
 
2661
            if file_list is not None:
 
2662
                interesting_ids = set()
 
2663
                for filename in file_list:
 
2664
                    file_id = tree.path2id(filename)
 
2665
                    if file_id is None:
 
2666
                        raise errors.NotVersionedError(filename)
 
2667
                    interesting_ids.add(file_id)
 
2668
                    if tree.kind(file_id) != "directory":
 
2669
                        continue
 
2670
                    
 
2671
                    for name, ie in tree.inventory.iter_entries(file_id):
 
2672
                        interesting_ids.add(ie.file_id)
 
2673
                new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
 
2674
            else:
 
2675
                # Remerge only supports resolving contents conflicts
 
2676
                allowed_conflicts = ('text conflict', 'contents conflict')
 
2677
                restore_files = [c.path for c in conflicts
 
2678
                                 if c.typestring in allowed_conflicts]
 
2679
            _mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
 
2680
            tree.set_conflicts(ConflictList(new_conflicts))
 
2681
            if file_list is not None:
 
2682
                restore_files = file_list
 
2683
            for filename in restore_files:
 
2684
                try:
 
2685
                    restore(tree.abspath(filename))
 
2686
                except errors.NotConflicted:
 
2687
                    pass
 
2688
            conflicts = _mod_merge.merge_inner(
 
2689
                                      tree.branch, other_tree, base_tree,
 
2690
                                      this_tree=tree,
 
2691
                                      interesting_ids=interesting_ids,
 
2692
                                      other_rev_id=parents[1],
 
2693
                                      merge_type=merge_type,
 
2694
                                      show_base=show_base,
 
2695
                                      reprocess=reprocess)
 
2696
        finally:
 
2697
            tree.unlock()
 
2698
        if conflicts > 0:
 
2699
            return 1
 
2700
        else:
 
2701
            return 0
 
2702
 
 
2703
 
 
2704
class cmd_revert(Command):
 
2705
    """Revert files to a previous revision.
 
2706
 
 
2707
    Giving a list of files will revert only those files.  Otherwise, all files
 
2708
    will be reverted.  If the revision is not specified with '--revision', the
 
2709
    last committed revision is used.
 
2710
 
 
2711
    To remove only some changes, without reverting to a prior version, use
 
2712
    merge instead.  For example, "merge . --r-2..-3" will remove the changes
 
2713
    introduced by -2, without affecting the changes introduced by -1.  Or
 
2714
    to remove certain changes on a hunk-by-hunk basis, see the Shelf plugin.
 
2715
    
 
2716
    By default, any files that have been manually changed will be backed up
 
2717
    first.  (Files changed only by merge are not backed up.)  Backup files have
 
2718
    '.~#~' appended to their name, where # is a number.
 
2719
 
 
2720
    When you provide files, you can use their current pathname or the pathname
 
2721
    from the target revision.  So you can use revert to "undelete" a file by
 
2722
    name.  If you name a directory, all the contents of that directory will be
 
2723
    reverted.
 
2724
    """
 
2725
    takes_options = ['revision', 'no-backup']
 
2726
    takes_args = ['file*']
 
2727
    aliases = ['merge-revert']
 
2728
 
 
2729
    def run(self, revision=None, no_backup=False, file_list=None):
 
2730
        if file_list is not None:
 
2731
            if len(file_list) == 0:
 
2732
                raise errors.BzrCommandError("No files specified")
 
2733
        else:
 
2734
            file_list = []
 
2735
        
 
2736
        tree, file_list = tree_files(file_list)
 
2737
        if revision is None:
 
2738
            # FIXME should be tree.last_revision
 
2739
            rev_id = tree.last_revision()
 
2740
        elif len(revision) != 1:
 
2741
            raise errors.BzrCommandError('bzr revert --revision takes exactly 1 argument')
 
2742
        else:
 
2743
            rev_id = revision[0].in_history(tree.branch).rev_id
 
2744
        pb = ui.ui_factory.nested_progress_bar()
 
2745
        try:
 
2746
            tree.revert(file_list, 
 
2747
                        tree.branch.repository.revision_tree(rev_id),
 
2748
                        not no_backup, pb, report_changes=True)
 
2749
        finally:
 
2750
            pb.finished()
 
2751
 
 
2752
 
 
2753
class cmd_assert_fail(Command):
 
2754
    """Test reporting of assertion failures"""
 
2755
    # intended just for use in testing
 
2756
 
 
2757
    hidden = True
 
2758
 
 
2759
    def run(self):
 
2760
        raise AssertionError("always fails")
 
2761
 
 
2762
 
 
2763
class cmd_help(Command):
 
2764
    """Show help on a command or other topic.
 
2765
 
 
2766
    For a list of all available commands, say 'bzr help commands'.
 
2767
    """
 
2768
    takes_options = [Option('long', 'show help on all commands')]
 
2769
    takes_args = ['topic?']
 
2770
    aliases = ['?', '--help', '-?', '-h']
 
2771
    
 
2772
    @display_command
 
2773
    def run(self, topic=None, long=False):
 
2774
        import bzrlib.help
 
2775
        if topic is None and long:
 
2776
            topic = "commands"
 
2777
        bzrlib.help.help(topic)
 
2778
 
 
2779
 
 
2780
class cmd_shell_complete(Command):
 
2781
    """Show appropriate completions for context.
 
2782
 
 
2783
    For a list of all available commands, say 'bzr shell-complete'.
 
2784
    """
 
2785
    takes_args = ['context?']
 
2786
    aliases = ['s-c']
 
2787
    hidden = True
 
2788
    
 
2789
    @display_command
 
2790
    def run(self, context=None):
 
2791
        import shellcomplete
 
2792
        shellcomplete.shellcomplete(context)
 
2793
 
 
2794
 
 
2795
class cmd_fetch(Command):
 
2796
    """Copy in history from another branch but don't merge it.
 
2797
 
 
2798
    This is an internal method used for pull and merge.
 
2799
    """
 
2800
    hidden = True
 
2801
    takes_args = ['from_branch', 'to_branch']
 
2802
    def run(self, from_branch, to_branch):
 
2803
        from bzrlib.fetch import Fetcher
 
2804
        from_b = Branch.open(from_branch)
 
2805
        to_b = Branch.open(to_branch)
 
2806
        Fetcher(to_b, from_b)
 
2807
 
 
2808
 
 
2809
class cmd_missing(Command):
 
2810
    """Show unmerged/unpulled revisions between two branches.
 
2811
 
 
2812
    OTHER_BRANCH may be local or remote.
 
2813
    """
 
2814
    takes_args = ['other_branch?']
 
2815
    takes_options = [Option('reverse', 'Reverse the order of revisions'),
 
2816
                     Option('mine-only', 
 
2817
                            'Display changes in the local branch only'),
 
2818
                     Option('theirs-only', 
 
2819
                            'Display changes in the remote branch only'), 
 
2820
                     'log-format',
 
2821
                     'show-ids',
 
2822
                     'verbose'
 
2823
                     ]
 
2824
    encoding_type = 'replace'
 
2825
 
 
2826
    @display_command
 
2827
    def run(self, other_branch=None, reverse=False, mine_only=False,
 
2828
            theirs_only=False, log_format=None, long=False, short=False, line=False, 
 
2829
            show_ids=False, verbose=False):
 
2830
        from bzrlib.missing import find_unmerged, iter_log_data
 
2831
        from bzrlib.log import log_formatter
 
2832
        local_branch = Branch.open_containing(u".")[0]
 
2833
        parent = local_branch.get_parent()
 
2834
        if other_branch is None:
 
2835
            other_branch = parent
 
2836
            if other_branch is None:
 
2837
                raise errors.BzrCommandError("No peer location known or specified.")
 
2838
            display_url = urlutils.unescape_for_display(parent,
 
2839
                                                        self.outf.encoding)
 
2840
            print "Using last location: " + display_url
 
2841
 
 
2842
        remote_branch = Branch.open(other_branch)
 
2843
        if remote_branch.base == local_branch.base:
 
2844
            remote_branch = local_branch
 
2845
        local_branch.lock_read()
 
2846
        try:
 
2847
            remote_branch.lock_read()
 
2848
            try:
 
2849
                local_extra, remote_extra = find_unmerged(local_branch, remote_branch)
 
2850
                if (log_format is None):
 
2851
                    log_format = log.log_formatter_registry.get_default(
 
2852
                        local_branch)
 
2853
                lf = log_format(to_file=self.outf,
 
2854
                                show_ids=show_ids,
 
2855
                                show_timezone='original')
 
2856
                if reverse is False:
 
2857
                    local_extra.reverse()
 
2858
                    remote_extra.reverse()
 
2859
                if local_extra and not theirs_only:
 
2860
                    print "You have %d extra revision(s):" % len(local_extra)
 
2861
                    for data in iter_log_data(local_extra, local_branch.repository,
 
2862
                                              verbose):
 
2863
                        lf.show(*data)
 
2864
                    printed_local = True
 
2865
                else:
 
2866
                    printed_local = False
 
2867
                if remote_extra and not mine_only:
 
2868
                    if printed_local is True:
 
2869
                        print "\n\n"
 
2870
                    print "You are missing %d revision(s):" % len(remote_extra)
 
2871
                    for data in iter_log_data(remote_extra, remote_branch.repository, 
 
2872
                                              verbose):
 
2873
                        lf.show(*data)
 
2874
                if not remote_extra and not local_extra:
 
2875
                    status_code = 0
 
2876
                    print "Branches are up to date."
 
2877
                else:
 
2878
                    status_code = 1
 
2879
            finally:
 
2880
                remote_branch.unlock()
 
2881
        finally:
 
2882
            local_branch.unlock()
 
2883
        if not status_code and parent is None and other_branch is not None:
 
2884
            local_branch.lock_write()
 
2885
            try:
 
2886
                # handle race conditions - a parent might be set while we run.
 
2887
                if local_branch.get_parent() is None:
 
2888
                    local_branch.set_parent(remote_branch.base)
 
2889
            finally:
 
2890
                local_branch.unlock()
 
2891
        return status_code
 
2892
 
 
2893
 
 
2894
class cmd_plugins(Command):
 
2895
    """List plugins"""
 
2896
    hidden = True
 
2897
    @display_command
 
2898
    def run(self):
 
2899
        import bzrlib.plugin
 
2900
        from inspect import getdoc
 
2901
        for name, plugin in bzrlib.plugin.all_plugins().items():
 
2902
            if getattr(plugin, '__path__', None) is not None:
 
2903
                print plugin.__path__[0]
 
2904
            elif getattr(plugin, '__file__', None) is not None:
 
2905
                print plugin.__file__
 
2906
            else:
 
2907
                print repr(plugin)
 
2908
                
 
2909
            d = getdoc(plugin)
 
2910
            if d:
 
2911
                print '\t', d.split('\n')[0]
 
2912
 
 
2913
 
 
2914
class cmd_testament(Command):
 
2915
    """Show testament (signing-form) of a revision."""
 
2916
    takes_options = ['revision', 
 
2917
                     Option('long', help='Produce long-format testament'), 
 
2918
                     Option('strict', help='Produce a strict-format'
 
2919
                            ' testament')]
 
2920
    takes_args = ['branch?']
 
2921
    @display_command
 
2922
    def run(self, branch=u'.', revision=None, long=False, strict=False):
 
2923
        from bzrlib.testament import Testament, StrictTestament
 
2924
        if strict is True:
 
2925
            testament_class = StrictTestament
 
2926
        else:
 
2927
            testament_class = Testament
 
2928
        b = WorkingTree.open_containing(branch)[0].branch
 
2929
        b.lock_read()
 
2930
        try:
 
2931
            if revision is None:
 
2932
                rev_id = b.last_revision()
 
2933
            else:
 
2934
                rev_id = revision[0].in_history(b).rev_id
 
2935
            t = testament_class.from_revision(b.repository, rev_id)
 
2936
            if long:
 
2937
                sys.stdout.writelines(t.as_text_lines())
 
2938
            else:
 
2939
                sys.stdout.write(t.as_short_text())
 
2940
        finally:
 
2941
            b.unlock()
 
2942
 
 
2943
 
 
2944
class cmd_annotate(Command):
 
2945
    """Show the origin of each line in a file.
 
2946
 
 
2947
    This prints out the given file with an annotation on the left side
 
2948
    indicating which revision, author and date introduced the change.
 
2949
 
 
2950
    If the origin is the same for a run of consecutive lines, it is 
 
2951
    shown only at the top, unless the --all option is given.
 
2952
    """
 
2953
    # TODO: annotate directories; showing when each file was last changed
 
2954
    # TODO: if the working copy is modified, show annotations on that 
 
2955
    #       with new uncommitted lines marked
 
2956
    aliases = ['ann', 'blame', 'praise']
 
2957
    takes_args = ['filename']
 
2958
    takes_options = [Option('all', help='show annotations on all lines'),
 
2959
                     Option('long', help='show date in annotations'),
 
2960
                     'revision',
 
2961
                     'show-ids',
 
2962
                     ]
 
2963
 
 
2964
    @display_command
 
2965
    def run(self, filename, all=False, long=False, revision=None,
 
2966
            show_ids=False):
 
2967
        from bzrlib.annotate import annotate_file
 
2968
        tree, relpath = WorkingTree.open_containing(filename)
 
2969
        branch = tree.branch
 
2970
        branch.lock_read()
 
2971
        try:
 
2972
            if revision is None:
 
2973
                revision_id = branch.last_revision()
 
2974
            elif len(revision) != 1:
 
2975
                raise errors.BzrCommandError('bzr annotate --revision takes exactly 1 argument')
 
2976
            else:
 
2977
                revision_id = revision[0].in_history(branch).rev_id
 
2978
            file_id = tree.path2id(relpath)
 
2979
            tree = branch.repository.revision_tree(revision_id)
 
2980
            file_version = tree.inventory[file_id].revision
 
2981
            annotate_file(branch, file_version, file_id, long, all, sys.stdout,
 
2982
                          show_ids=show_ids)
 
2983
        finally:
 
2984
            branch.unlock()
 
2985
 
 
2986
 
 
2987
class cmd_re_sign(Command):
 
2988
    """Create a digital signature for an existing revision."""
 
2989
    # TODO be able to replace existing ones.
 
2990
 
 
2991
    hidden = True # is this right ?
 
2992
    takes_args = ['revision_id*']
 
2993
    takes_options = ['revision']
 
2994
    
 
2995
    def run(self, revision_id_list=None, revision=None):
 
2996
        import bzrlib.gpg as gpg
 
2997
        if revision_id_list is not None and revision is not None:
 
2998
            raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
 
2999
        if revision_id_list is None and revision is None:
 
3000
            raise errors.BzrCommandError('You must supply either --revision or a revision_id')
 
3001
        b = WorkingTree.open_containing(u'.')[0].branch
 
3002
        gpg_strategy = gpg.GPGStrategy(b.get_config())
 
3003
        if revision_id_list is not None:
 
3004
            for revision_id in revision_id_list:
 
3005
                b.repository.sign_revision(revision_id, gpg_strategy)
 
3006
        elif revision is not None:
 
3007
            if len(revision) == 1:
 
3008
                revno, rev_id = revision[0].in_history(b)
 
3009
                b.repository.sign_revision(rev_id, gpg_strategy)
 
3010
            elif len(revision) == 2:
 
3011
                # are they both on rh- if so we can walk between them
 
3012
                # might be nice to have a range helper for arbitrary
 
3013
                # revision paths. hmm.
 
3014
                from_revno, from_revid = revision[0].in_history(b)
 
3015
                to_revno, to_revid = revision[1].in_history(b)
 
3016
                if to_revid is None:
 
3017
                    to_revno = b.revno()
 
3018
                if from_revno is None or to_revno is None:
 
3019
                    raise errors.BzrCommandError('Cannot sign a range of non-revision-history revisions')
 
3020
                for revno in range(from_revno, to_revno + 1):
 
3021
                    b.repository.sign_revision(b.get_rev_id(revno), 
 
3022
                                               gpg_strategy)
 
3023
            else:
 
3024
                raise errors.BzrCommandError('Please supply either one revision, or a range.')
 
3025
 
 
3026
 
 
3027
class cmd_bind(Command):
 
3028
    """Convert the current branch into a checkout of the supplied branch.
 
3029
 
 
3030
    Once converted into a checkout, commits must succeed on the master branch
 
3031
    before they will be applied to the local branch.
 
3032
 
 
3033
    See "help checkouts" for more information on checkouts.
 
3034
    """
 
3035
 
 
3036
    takes_args = ['location?']
 
3037
    takes_options = []
 
3038
 
 
3039
    def run(self, location=None):
 
3040
        b, relpath = Branch.open_containing(u'.')
 
3041
        if location is None:
 
3042
            try:
 
3043
                location = b.get_old_bound_location()
 
3044
            except errors.UpgradeRequired:
 
3045
                raise errors.BzrCommandError('No location supplied.  '
 
3046
                    'This format does not remember old locations.')
 
3047
            else:
 
3048
                if location is None:
 
3049
                    raise errors.BzrCommandError('No location supplied and no '
 
3050
                        'previous location known')
 
3051
        b_other = Branch.open(location)
 
3052
        try:
 
3053
            b.bind(b_other)
 
3054
        except errors.DivergedBranches:
 
3055
            raise errors.BzrCommandError('These branches have diverged.'
 
3056
                                         ' Try merging, and then bind again.')
 
3057
 
 
3058
 
 
3059
class cmd_unbind(Command):
 
3060
    """Convert the current checkout into a regular branch.
 
3061
 
 
3062
    After unbinding, the local branch is considered independent and subsequent
 
3063
    commits will be local only.
 
3064
 
 
3065
    See "help checkouts" for more information on checkouts.
 
3066
    """
 
3067
 
 
3068
    takes_args = []
 
3069
    takes_options = []
 
3070
 
 
3071
    def run(self):
 
3072
        b, relpath = Branch.open_containing(u'.')
 
3073
        if not b.unbind():
 
3074
            raise errors.BzrCommandError('Local branch is not bound')
 
3075
 
 
3076
 
 
3077
class cmd_uncommit(Command):
 
3078
    """Remove the last committed revision.
 
3079
 
 
3080
    --verbose will print out what is being removed.
 
3081
    --dry-run will go through all the motions, but not actually
 
3082
    remove anything.
 
3083
    
 
3084
    In the future, uncommit will create a revision bundle, which can then
 
3085
    be re-applied.
 
3086
    """
 
3087
 
 
3088
    # TODO: jam 20060108 Add an option to allow uncommit to remove
 
3089
    # unreferenced information in 'branch-as-repository' branches.
 
3090
    # TODO: jam 20060108 Add the ability for uncommit to remove unreferenced
 
3091
    # information in shared branches as well.
 
3092
    takes_options = ['verbose', 'revision',
 
3093
                    Option('dry-run', help='Don\'t actually make changes'),
 
3094
                    Option('force', help='Say yes to all questions.')]
 
3095
    takes_args = ['location?']
 
3096
    aliases = []
 
3097
 
 
3098
    def run(self, location=None,
 
3099
            dry_run=False, verbose=False,
 
3100
            revision=None, force=False):
 
3101
        from bzrlib.log import log_formatter, show_log
 
3102
        import sys
 
3103
        from bzrlib.uncommit import uncommit
 
3104
 
 
3105
        if location is None:
 
3106
            location = u'.'
 
3107
        control, relpath = bzrdir.BzrDir.open_containing(location)
 
3108
        try:
 
3109
            tree = control.open_workingtree()
 
3110
            b = tree.branch
 
3111
        except (errors.NoWorkingTree, errors.NotLocalUrl):
 
3112
            tree = None
 
3113
            b = control.open_branch()
 
3114
 
 
3115
        rev_id = None
 
3116
        if revision is None:
 
3117
            revno = b.revno()
 
3118
        else:
 
3119
            # 'bzr uncommit -r 10' actually means uncommit
 
3120
            # so that the final tree is at revno 10.
 
3121
            # but bzrlib.uncommit.uncommit() actually uncommits
 
3122
            # the revisions that are supplied.
 
3123
            # So we need to offset it by one
 
3124
            revno = revision[0].in_history(b).revno+1
 
3125
 
 
3126
        if revno <= b.revno():
 
3127
            rev_id = b.get_rev_id(revno)
 
3128
        if rev_id is None:
 
3129
            self.outf.write('No revisions to uncommit.\n')
 
3130
            return 1
 
3131
 
 
3132
        lf = log_formatter('short',
 
3133
                           to_file=self.outf,
 
3134
                           show_timezone='original')
 
3135
 
 
3136
        show_log(b,
 
3137
                 lf,
 
3138
                 verbose=False,
 
3139
                 direction='forward',
 
3140
                 start_revision=revno,
 
3141
                 end_revision=b.revno())
 
3142
 
 
3143
        if dry_run:
 
3144
            print 'Dry-run, pretending to remove the above revisions.'
 
3145
            if not force:
 
3146
                val = raw_input('Press <enter> to continue')
 
3147
        else:
 
3148
            print 'The above revision(s) will be removed.'
 
3149
            if not force:
 
3150
                val = raw_input('Are you sure [y/N]? ')
 
3151
                if val.lower() not in ('y', 'yes'):
 
3152
                    print 'Canceled'
 
3153
                    return 0
 
3154
 
 
3155
        uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
 
3156
                revno=revno)
 
3157
 
 
3158
 
 
3159
class cmd_break_lock(Command):
 
3160
    """Break a dead lock on a repository, branch or working directory.
 
3161
 
 
3162
    CAUTION: Locks should only be broken when you are sure that the process
 
3163
    holding the lock has been stopped.
 
3164
 
 
3165
    You can get information on what locks are open via the 'bzr info' command.
 
3166
    
 
3167
    example:
 
3168
        bzr break-lock
 
3169
    """
 
3170
    takes_args = ['location?']
 
3171
 
 
3172
    def run(self, location=None, show=False):
 
3173
        if location is None:
 
3174
            location = u'.'
 
3175
        control, relpath = bzrdir.BzrDir.open_containing(location)
 
3176
        try:
 
3177
            control.break_lock()
 
3178
        except NotImplementedError:
 
3179
            pass
 
3180
        
 
3181
 
 
3182
class cmd_wait_until_signalled(Command):
 
3183
    """Test helper for test_start_and_stop_bzr_subprocess_send_signal.
 
3184
 
 
3185
    This just prints a line to signal when it is ready, then blocks on stdin.
 
3186
    """
 
3187
 
 
3188
    hidden = True
 
3189
 
 
3190
    def run(self):
 
3191
        sys.stdout.write("running\n")
 
3192
        sys.stdout.flush()
 
3193
        sys.stdin.readline()
 
3194
 
 
3195
 
 
3196
class cmd_serve(Command):
 
3197
    """Run the bzr server."""
 
3198
 
 
3199
    aliases = ['server']
 
3200
 
 
3201
    takes_options = [
 
3202
        Option('inet',
 
3203
               help='serve on stdin/out for use from inetd or sshd'),
 
3204
        Option('port',
 
3205
               help='listen for connections on nominated port of the form '
 
3206
                    '[hostname:]portnumber. Passing 0 as the port number will '
 
3207
                    'result in a dynamically allocated port. Default port is '
 
3208
                    '4155.',
 
3209
               type=str),
 
3210
        Option('directory',
 
3211
               help='serve contents of directory',
 
3212
               type=unicode),
 
3213
        Option('allow-writes',
 
3214
               help='By default the server is a readonly server. Supplying '
 
3215
                    '--allow-writes enables write access to the contents of '
 
3216
                    'the served directory and below. '
 
3217
                ),
 
3218
        ]
 
3219
 
 
3220
    def run(self, port=None, inet=False, directory=None, allow_writes=False):
 
3221
        from bzrlib.transport import smart
 
3222
        from bzrlib.transport import get_transport
 
3223
        if directory is None:
 
3224
            directory = os.getcwd()
 
3225
        url = urlutils.local_path_to_url(directory)
 
3226
        if not allow_writes:
 
3227
            url = 'readonly+' + url
 
3228
        t = get_transport(url)
 
3229
        if inet:
 
3230
            server = smart.SmartServerPipeStreamMedium(sys.stdin, sys.stdout, t)
 
3231
        else:
 
3232
            if port is None:
 
3233
                port = smart.BZR_DEFAULT_PORT
 
3234
                host = '127.0.0.1'
 
3235
            else:
 
3236
                if ':' in port:
 
3237
                    host, port = port.split(':')
 
3238
                else:
 
3239
                    host = '127.0.0.1'
 
3240
                port = int(port)
 
3241
            server = smart.SmartTCPServer(t, host=host, port=port)
 
3242
            print 'listening on port: ', server.port
 
3243
            sys.stdout.flush()
 
3244
        server.serve()
 
3245
 
 
3246
class cmd_join(Command):
 
3247
    """Combine a subtree into its containing tree.
 
3248
    
 
3249
    This is marked as a merge of the subtree into the containing tree, and all
 
3250
    history is preserved.
 
3251
    """
 
3252
 
 
3253
    takes_args = ['tree']
 
3254
    takes_options = [Option('reference', 'join by reference')]
 
3255
 
 
3256
    def run(self, tree, reference=False):
 
3257
        sub_tree = WorkingTree.open(tree)
 
3258
        parent_dir = osutils.dirname(sub_tree.basedir)
 
3259
        containing_tree = WorkingTree.open_containing(parent_dir)[0]
 
3260
        repo = containing_tree.branch.repository
 
3261
        if not repo.supports_rich_root():
 
3262
            raise errors.BzrCommandError(
 
3263
                "Can't join trees because %s doesn't support rich root data.\n"
 
3264
                "You can use bzr upgrade on the repository."
 
3265
                % (repo,))
 
3266
        if reference:
 
3267
            try:
 
3268
                containing_tree.add_reference(sub_tree)
 
3269
            except errors.BadReferenceTarget, e:
 
3270
                # XXX: Would be better to just raise a nicely printable
 
3271
                # exception from the real origin.  Also below.  mbp 20070306
 
3272
                raise errors.BzrCommandError("Cannot join %s.  %s" %
 
3273
                                             (tree, e.reason))
 
3274
        else:
 
3275
            try:
 
3276
                containing_tree.subsume(sub_tree)
 
3277
            except errors.BadSubsumeSource, e:
 
3278
                raise errors.BzrCommandError("Cannot join %s.  %s" % 
 
3279
                                             (tree, e.reason))
 
3280
 
 
3281
 
 
3282
class cmd_split(Command):
 
3283
    """Split a tree into two trees.
 
3284
    """
 
3285
 
 
3286
    takes_args = ['tree']
 
3287
 
 
3288
    def run(self, tree):
 
3289
        containing_tree, subdir = WorkingTree.open_containing(tree)
 
3290
        sub_id = containing_tree.path2id(subdir)
 
3291
        if sub_id is None:
 
3292
            raise errors.NotVersionedError(subdir)
 
3293
        try:
 
3294
            containing_tree.extract(sub_id)
 
3295
        except errors.RootNotRich:
 
3296
            raise errors.UpgradeRequired(containing_tree.branch.base)
 
3297
 
 
3298
 
 
3299
 
 
3300
class cmd_merge_directive(Command):
 
3301
    """Generate a merge directive for auto-merge tools.
 
3302
 
 
3303
    A directive requests a merge to be performed, and also provides all the
 
3304
    information necessary to do so.  This means it must either include a
 
3305
    revision bundle, or the location of a branch containing the desired
 
3306
    revision.
 
3307
 
 
3308
    A submit branch (the location to merge into) must be supplied the first
 
3309
    time the command is issued.  After it has been supplied once, it will
 
3310
    be remembered as the default.
 
3311
 
 
3312
    A public branch is optional if a revision bundle is supplied, but required
 
3313
    if --diff or --plain is specified.  It will be remembered as the default
 
3314
    after the first use.
 
3315
    """
 
3316
 
 
3317
    takes_args = ['submit_branch?', 'public_branch?']
 
3318
 
 
3319
    takes_options = [
 
3320
        RegistryOption.from_kwargs('patch-type',
 
3321
            'The type of patch to include in the directive',
 
3322
            title='Patch type', value_switches=True, enum_switch=False,
 
3323
            bundle='Bazaar revision bundle (default)',
 
3324
            diff='Normal unified diff',
 
3325
            plain='No patch, just directive'),
 
3326
        Option('sign', help='GPG-sign the directive'), 'revision',
 
3327
        Option('mail-to', type=str,
 
3328
            help='Instead of printing the directive, email to this address'),
 
3329
        Option('message', type=str, short_name='m',
 
3330
            help='Message to use when committing this merge')
 
3331
        ]
 
3332
 
 
3333
    def run(self, submit_branch=None, public_branch=None, patch_type='bundle',
 
3334
            sign=False, revision=None, mail_to=None, message=None):
 
3335
        if patch_type == 'plain':
 
3336
            patch_type = None
 
3337
        branch = Branch.open('.')
 
3338
        stored_submit_branch = branch.get_submit_branch()
 
3339
        if submit_branch is None:
 
3340
            submit_branch = stored_submit_branch
 
3341
        else:
 
3342
            if stored_submit_branch is None:
 
3343
                branch.set_submit_branch(submit_branch)
 
3344
        if submit_branch is None:
 
3345
            submit_branch = branch.get_parent()
 
3346
        if submit_branch is None:
 
3347
            raise errors.BzrCommandError('No submit branch specified or known')
 
3348
 
 
3349
        stored_public_branch = branch.get_public_branch()
 
3350
        if public_branch is None:
 
3351
            public_branch = stored_public_branch
 
3352
        elif stored_public_branch is None:
 
3353
            branch.set_public_branch(public_branch)
 
3354
        if patch_type != "bundle" and public_branch is None:
 
3355
            raise errors.BzrCommandError('No public branch specified or'
 
3356
                                         ' known')
 
3357
        if revision is not None:
 
3358
            if len(revision) != 1:
 
3359
                raise errors.BzrCommandError('bzr merge-directive takes '
 
3360
                    'exactly one revision identifier')
 
3361
            else:
 
3362
                revision_id = revision[0].in_history(branch).rev_id
 
3363
        else:
 
3364
            revision_id = branch.last_revision()
 
3365
        directive = merge_directive.MergeDirective.from_objects(
 
3366
            branch.repository, revision_id, time.time(),
 
3367
            osutils.local_time_offset(), submit_branch,
 
3368
            public_branch=public_branch, patch_type=patch_type,
 
3369
            message=message)
 
3370
        if mail_to is None:
 
3371
            if sign:
 
3372
                self.outf.write(directive.to_signed(branch))
 
3373
            else:
 
3374
                self.outf.writelines(directive.to_lines())
 
3375
        else:
 
3376
            message = directive.to_email(mail_to, branch, sign)
 
3377
            s = smtplib.SMTP()
 
3378
            server = branch.get_config().get_user_option('smtp_server')
 
3379
            if not server:
 
3380
                server = 'localhost'
 
3381
            s.connect()
 
3382
            s.sendmail(message['From'], message['To'], message.as_string())
 
3383
 
 
3384
 
 
3385
class cmd_tag(Command):
 
3386
    """Create a tag naming a revision.
 
3387
    
 
3388
    Tags give human-meaningful names to revisions.  Commands that take a -r
 
3389
    (--revision) option can be given -rtag:X, where X is any previously
 
3390
    created tag.
 
3391
 
 
3392
    Tags are stored in the branch.  Tags are copied from one branch to another
 
3393
    along when you branch, push, pull or merge.
 
3394
 
 
3395
    It is an error to give a tag name that already exists unless you pass 
 
3396
    --force, in which case the tag is moved to point to the new revision.
 
3397
    """
 
3398
 
 
3399
    takes_args = ['tag_name']
 
3400
    takes_options = [
 
3401
        Option('delete',
 
3402
            help='Delete this tag rather than placing it.',
 
3403
            ),
 
3404
        Option('directory',
 
3405
            help='Branch in which to place the tag.',
 
3406
            short_name='d',
 
3407
            type=unicode,
 
3408
            ),
 
3409
        Option('force',
 
3410
            help='Replace existing tags',
 
3411
            ),
 
3412
        'revision',
 
3413
        ]
 
3414
 
 
3415
    def run(self, tag_name,
 
3416
            delete=None,
 
3417
            directory='.',
 
3418
            force=None,
 
3419
            revision=None,
 
3420
            ):
 
3421
        branch, relpath = Branch.open_containing(directory)
 
3422
        branch.lock_write()
 
3423
        try:
 
3424
            if delete:
 
3425
                branch.tags.delete_tag(tag_name)
 
3426
                self.outf.write('Deleted tag %s.\n' % tag_name)
 
3427
            else:
 
3428
                if revision:
 
3429
                    if len(revision) != 1:
 
3430
                        raise errors.BzrCommandError(
 
3431
                            "Tags can only be placed on a single revision, "
 
3432
                            "not on a range")
 
3433
                    revision_id = revision[0].in_history(branch).rev_id
 
3434
                else:
 
3435
                    revision_id = branch.last_revision()
 
3436
                if (not force) and branch.tags.has_tag(tag_name):
 
3437
                    raise errors.TagAlreadyExists(tag_name)
 
3438
                branch.tags.set_tag(tag_name, revision_id)
 
3439
                self.outf.write('Created tag %s.\n' % tag_name)
 
3440
        finally:
 
3441
            branch.unlock()
 
3442
 
 
3443
 
 
3444
class cmd_tags(Command):
 
3445
    """List tags.
 
3446
 
 
3447
    This tag shows a table of tag names and the revisions they reference.
 
3448
    """
 
3449
 
 
3450
    takes_options = [
 
3451
        Option('directory',
 
3452
            help='Branch whose tags should be displayed',
 
3453
            short_name='d',
 
3454
            type=unicode,
 
3455
            ),
 
3456
    ]
 
3457
 
 
3458
    @display_command
 
3459
    def run(self,
 
3460
            directory='.',
 
3461
            ):
 
3462
        branch, relpath = Branch.open_containing(directory)
 
3463
        for tag_name, target in sorted(branch.tags.get_tag_dict().items()):
 
3464
            self.outf.write('%-20s %s\n' % (tag_name, target))
 
3465
 
 
3466
 
 
3467
# command-line interpretation helper for merge-related commands
 
3468
def _merge_helper(other_revision, base_revision,
 
3469
                  check_clean=True, ignore_zero=False,
 
3470
                  this_dir=None, backup_files=False,
 
3471
                  merge_type=None,
 
3472
                  file_list=None, show_base=False, reprocess=False,
 
3473
                  pull=False,
 
3474
                  pb=DummyProgress(),
 
3475
                  change_reporter=None):
 
3476
    """Merge changes into a tree.
 
3477
 
 
3478
    base_revision
 
3479
        list(path, revno) Base for three-way merge.  
 
3480
        If [None, None] then a base will be automatically determined.
 
3481
    other_revision
 
3482
        list(path, revno) Other revision for three-way merge.
 
3483
    this_dir
 
3484
        Directory to merge changes into; '.' by default.
 
3485
    check_clean
 
3486
        If true, this_dir must have no uncommitted changes before the
 
3487
        merge begins.
 
3488
    ignore_zero - If true, suppress the "zero conflicts" message when 
 
3489
        there are no conflicts; should be set when doing something we expect
 
3490
        to complete perfectly.
 
3491
    file_list - If supplied, merge only changes to selected files.
 
3492
 
 
3493
    All available ancestors of other_revision and base_revision are
 
3494
    automatically pulled into the branch.
 
3495
 
 
3496
    The revno may be -1 to indicate the last revision on the branch, which is
 
3497
    the typical case.
 
3498
 
 
3499
    This function is intended for use from the command line; programmatic
 
3500
    clients might prefer to call merge.merge_inner(), which has less magic 
 
3501
    behavior.
 
3502
    """
 
3503
    # Loading it late, so that we don't always have to import bzrlib.merge
 
3504
    if merge_type is None:
 
3505
        merge_type = _mod_merge.Merge3Merger
 
3506
    if this_dir is None:
 
3507
        this_dir = u'.'
 
3508
    this_tree = WorkingTree.open_containing(this_dir)[0]
 
3509
    if show_base and not merge_type is _mod_merge.Merge3Merger:
 
3510
        raise errors.BzrCommandError("Show-base is not supported for this merge"
 
3511
                                     " type. %s" % merge_type)
 
3512
    if reprocess and not merge_type.supports_reprocess:
 
3513
        raise errors.BzrCommandError("Conflict reduction is not supported for merge"
 
3514
                                     " type %s." % merge_type)
 
3515
    if reprocess and show_base:
 
3516
        raise errors.BzrCommandError("Cannot do conflict reduction and show base.")
 
3517
    # TODO: jam 20070226 We should really lock these trees earlier. However, we
 
3518
    #       only want to take out a lock_tree_write() if we don't have to pull
 
3519
    #       any ancestry. But merge might fetch ancestry in the middle, in
 
3520
    #       which case we would need a lock_write().
 
3521
    #       Because we cannot upgrade locks, for now we live with the fact that
 
3522
    #       the tree will be locked multiple times during a merge. (Maybe
 
3523
    #       read-only some of the time, but it means things will get read
 
3524
    #       multiple times.)
 
3525
    try:
 
3526
        merger = _mod_merge.Merger(this_tree.branch, this_tree=this_tree,
 
3527
                                   pb=pb, change_reporter=change_reporter)
 
3528
        merger.pp = ProgressPhase("Merge phase", 5, pb)
 
3529
        merger.pp.next_phase()
 
3530
        merger.check_basis(check_clean)
 
3531
        merger.set_other(other_revision)
 
3532
        merger.pp.next_phase()
 
3533
        merger.set_base(base_revision)
 
3534
        if merger.base_rev_id == merger.other_rev_id:
 
3535
            note('Nothing to do.')
 
3536
            return 0
 
3537
        if file_list is None:
 
3538
            if pull and merger.base_rev_id == merger.this_rev_id:
 
3539
                # FIXME: deduplicate with pull
 
3540
                result = merger.this_tree.pull(merger.this_branch,
 
3541
                        False, merger.other_rev_id)
 
3542
                if result.old_revid == result.new_revid:
 
3543
                    note('No revisions to pull.')
 
3544
                else:
 
3545
                    note('Now on revision %d.' % result.new_revno)
 
3546
                return 0
 
3547
        merger.backup_files = backup_files
 
3548
        merger.merge_type = merge_type 
 
3549
        merger.set_interesting_files(file_list)
 
3550
        merger.show_base = show_base 
 
3551
        merger.reprocess = reprocess
 
3552
        conflicts = merger.do_merge()
 
3553
        if file_list is None:
 
3554
            merger.set_pending()
 
3555
    finally:
 
3556
        pb.clear()
 
3557
    return conflicts
 
3558
 
 
3559
 
 
3560
# Compatibility
 
3561
merge = _merge_helper
 
3562
 
 
3563
 
 
3564
# these get imported and then picked up by the scan for cmd_*
 
3565
# TODO: Some more consistent way to split command definitions across files;
 
3566
# we do need to load at least some information about them to know of 
 
3567
# aliases.  ideally we would avoid loading the implementation until the
 
3568
# details were needed.
 
3569
from bzrlib.cmd_version_info import cmd_version_info
 
3570
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore
 
3571
from bzrlib.bundle.commands import cmd_bundle_revisions
 
3572
from bzrlib.sign_my_commits import cmd_sign_my_commits
 
3573
from bzrlib.weave_commands import cmd_weave_list, cmd_weave_join, \
 
3574
        cmd_weave_plan_merge, cmd_weave_merge_text