~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/builtins.py

  • Committer: Robert Collins
  • Date: 2007-03-21 04:28:02 UTC
  • mfrom: (2323.3.4 0.15)
  • mto: (2378.1.1 integration)
  • mto: This revision was merged to the branch mainline in revision 2368.
  • Revision ID: robertc@robertcollins.net-20070321042802-1bxr1t97046woojb
Update NEWS to match bzr 0.15.

Show diffs side-by-side

added added

removed removed

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