/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/builtins.py

  • Committer: John Arbash Meinel
  • Date: 2007-03-14 20:15:52 UTC
  • mto: (2353.4.2 locking)
  • mto: This revision was merged to the branch mainline in revision 2360.
  • Revision ID: john@arbash-meinel.com-20070314201552-bjtfua57456dviep
Update the lock code and test code so that if more than one
lock implementation is available, they will both be tested.

It is quite a bit of overhead, for a case where we are likely to only have 1
real lock implementation per platform, but hey, for now we have 2.

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 repo
 
1295
        bzr init repo/trunk
 
1296
        bzr checkout --lightweight repo/trunk trunk-checkout
 
1297
        cd trunk-checkout
 
1298
        (add files here)
 
1299
    """
 
1300
    takes_args = ["location"]
 
1301
    takes_options = [RegistryOption('format',
 
1302
                            help='Specify a format for this repository. See'
 
1303
                                 ' "bzr help formats" for details',
 
1304
                            registry=bzrdir.format_registry,
 
1305
                            converter=bzrdir.format_registry.make_bzrdir,
 
1306
                            value_switches=True, title='Repository format'),
 
1307
                     Option('trees',
 
1308
                             help='Allows branches in repository to have'
 
1309
                             ' a working tree')]
 
1310
    aliases = ["init-repo"]
 
1311
    def run(self, location, format=None, trees=False):
 
1312
        if format is None:
 
1313
            format = bzrdir.format_registry.make_bzrdir('default')
 
1314
 
 
1315
        if location is None:
 
1316
            location = '.'
 
1317
 
 
1318
        to_transport = transport.get_transport(location)
 
1319
        try:
 
1320
            to_transport.mkdir('.')
 
1321
        except errors.FileExists:
 
1322
            pass
 
1323
 
 
1324
        newdir = format.initialize_on_transport(to_transport)
 
1325
        repo = newdir.create_repository(shared=True)
 
1326
        repo.set_make_working_trees(trees)
 
1327
 
 
1328
 
 
1329
class cmd_diff(Command):
 
1330
    """Show differences in the working tree or between revisions.
 
1331
    
 
1332
    If files are listed, only the changes in those files are listed.
 
1333
    Otherwise, all changes for the tree are listed.
 
1334
 
 
1335
    "bzr diff -p1" is equivalent to "bzr diff --prefix old/:new/", and
 
1336
    produces patches suitable for "patch -p1".
 
1337
 
 
1338
    examples:
 
1339
        bzr diff
 
1340
            Shows the difference in the working tree versus the last commit
 
1341
        bzr diff -r1
 
1342
            Difference between the working tree and revision 1
 
1343
        bzr diff -r1..2
 
1344
            Difference between revision 2 and revision 1
 
1345
        bzr diff --prefix old/:new/
 
1346
            Same as 'bzr diff' but prefix paths with old/ and new/
 
1347
        bzr diff bzr.mine bzr.dev
 
1348
            Show the differences between the two working trees
 
1349
        bzr diff foo.c
 
1350
            Show just the differences for 'foo.c'
 
1351
    """
 
1352
    # TODO: Option to use external diff command; could be GNU diff, wdiff,
 
1353
    #       or a graphical diff.
 
1354
 
 
1355
    # TODO: Python difflib is not exactly the same as unidiff; should
 
1356
    #       either fix it up or prefer to use an external diff.
 
1357
 
 
1358
    # TODO: Selected-file diff is inefficient and doesn't show you
 
1359
    #       deleted files.
 
1360
 
 
1361
    # TODO: This probably handles non-Unix newlines poorly.
 
1362
 
 
1363
    takes_args = ['file*']
 
1364
    takes_options = ['revision', 'diff-options',
 
1365
        Option('prefix', type=str,
 
1366
               short_name='p',
 
1367
               help='Set prefixes to added to old and new filenames, as '
 
1368
                    'two values separated by a colon. (eg "old/:new/")'),
 
1369
        ]
 
1370
    aliases = ['di', 'dif']
 
1371
    encoding_type = 'exact'
 
1372
 
 
1373
    @display_command
 
1374
    def run(self, revision=None, file_list=None, diff_options=None,
 
1375
            prefix=None):
 
1376
        from bzrlib.diff import diff_cmd_helper, show_diff_trees
 
1377
 
 
1378
        if (prefix is None) or (prefix == '0'):
 
1379
            # diff -p0 format
 
1380
            old_label = ''
 
1381
            new_label = ''
 
1382
        elif prefix == '1':
 
1383
            old_label = 'old/'
 
1384
            new_label = 'new/'
 
1385
        elif ':' in prefix:
 
1386
            old_label, new_label = prefix.split(":")
 
1387
        else:
 
1388
            raise errors.BzrCommandError(
 
1389
                '--prefix expects two values separated by a colon'
 
1390
                ' (eg "old/:new/")')
 
1391
 
 
1392
        if revision and len(revision) > 2:
 
1393
            raise errors.BzrCommandError('bzr diff --revision takes exactly'
 
1394
                                         ' one or two revision specifiers')
 
1395
 
 
1396
        try:
 
1397
            tree1, file_list = internal_tree_files(file_list)
 
1398
            tree2 = None
 
1399
            b = None
 
1400
            b2 = None
 
1401
        except errors.FileInWrongBranch:
 
1402
            if len(file_list) != 2:
 
1403
                raise errors.BzrCommandError("Files are in different branches")
 
1404
 
 
1405
            tree1, file1 = WorkingTree.open_containing(file_list[0])
 
1406
            tree2, file2 = WorkingTree.open_containing(file_list[1])
 
1407
            if file1 != "" or file2 != "":
 
1408
                # FIXME diff those two files. rbc 20051123
 
1409
                raise errors.BzrCommandError("Files are in different branches")
 
1410
            file_list = None
 
1411
        except errors.NotBranchError:
 
1412
            if (revision is not None and len(revision) == 2
 
1413
                and not revision[0].needs_branch()
 
1414
                and not revision[1].needs_branch()):
 
1415
                # If both revision specs include a branch, we can
 
1416
                # diff them without needing a local working tree
 
1417
                tree1, tree2 = None, None
 
1418
            else:
 
1419
                raise
 
1420
 
 
1421
        if tree2 is not None:
 
1422
            if revision is not None:
 
1423
                # FIXME: but there should be a clean way to diff between
 
1424
                # non-default versions of two trees, it's not hard to do
 
1425
                # internally...
 
1426
                raise errors.BzrCommandError(
 
1427
                        "Sorry, diffing arbitrary revisions across branches "
 
1428
                        "is not implemented yet")
 
1429
            return show_diff_trees(tree1, tree2, sys.stdout, 
 
1430
                                   specific_files=file_list,
 
1431
                                   external_diff_options=diff_options,
 
1432
                                   old_label=old_label, new_label=new_label)
 
1433
 
 
1434
        return diff_cmd_helper(tree1, file_list, diff_options,
 
1435
                               revision_specs=revision,
 
1436
                               old_label=old_label, new_label=new_label)
 
1437
 
 
1438
 
 
1439
class cmd_deleted(Command):
 
1440
    """List files deleted in the working tree.
 
1441
    """
 
1442
    # TODO: Show files deleted since a previous revision, or
 
1443
    # between two revisions.
 
1444
    # TODO: Much more efficient way to do this: read in new
 
1445
    # directories with readdir, rather than stating each one.  Same
 
1446
    # level of effort but possibly much less IO.  (Or possibly not,
 
1447
    # if the directories are very large...)
 
1448
    takes_options = ['show-ids']
 
1449
 
 
1450
    @display_command
 
1451
    def run(self, show_ids=False):
 
1452
        tree = WorkingTree.open_containing(u'.')[0]
 
1453
        tree.lock_read()
 
1454
        try:
 
1455
            old = tree.basis_tree()
 
1456
            old.lock_read()
 
1457
            try:
 
1458
                for path, ie in old.inventory.iter_entries():
 
1459
                    if not tree.has_id(ie.file_id):
 
1460
                        self.outf.write(path)
 
1461
                        if show_ids:
 
1462
                            self.outf.write(' ')
 
1463
                            self.outf.write(ie.file_id)
 
1464
                        self.outf.write('\n')
 
1465
            finally:
 
1466
                old.unlock()
 
1467
        finally:
 
1468
            tree.unlock()
 
1469
 
 
1470
 
 
1471
class cmd_modified(Command):
 
1472
    """List files modified in working tree.
 
1473
 
 
1474
    See also: "bzr status".
 
1475
    """
 
1476
 
 
1477
    hidden = True
 
1478
 
 
1479
    @display_command
 
1480
    def run(self):
 
1481
        tree = WorkingTree.open_containing(u'.')[0]
 
1482
        td = tree.changes_from(tree.basis_tree())
 
1483
        for path, id, kind, text_modified, meta_modified in td.modified:
 
1484
            self.outf.write(path + '\n')
 
1485
 
 
1486
 
 
1487
class cmd_added(Command):
 
1488
    """List files added in working tree.
 
1489
 
 
1490
    See also: "bzr status".
 
1491
    """
 
1492
 
 
1493
    hidden = True
 
1494
 
 
1495
    @display_command
 
1496
    def run(self):
 
1497
        wt = WorkingTree.open_containing(u'.')[0]
 
1498
        wt.lock_read()
 
1499
        try:
 
1500
            basis = wt.basis_tree()
 
1501
            basis.lock_read()
 
1502
            try:
 
1503
                basis_inv = basis.inventory
 
1504
                inv = wt.inventory
 
1505
                for file_id in inv:
 
1506
                    if file_id in basis_inv:
 
1507
                        continue
 
1508
                    if inv.is_root(file_id) and len(basis_inv) == 0:
 
1509
                        continue
 
1510
                    path = inv.id2path(file_id)
 
1511
                    if not os.access(osutils.abspath(path), os.F_OK):
 
1512
                        continue
 
1513
                    self.outf.write(path + '\n')
 
1514
            finally:
 
1515
                basis.unlock()
 
1516
        finally:
 
1517
            wt.unlock()
 
1518
 
 
1519
 
 
1520
class cmd_root(Command):
 
1521
    """Show the tree root directory.
 
1522
 
 
1523
    The root is the nearest enclosing directory with a .bzr control
 
1524
    directory."""
 
1525
    takes_args = ['filename?']
 
1526
    @display_command
 
1527
    def run(self, filename=None):
 
1528
        """Print the branch root."""
 
1529
        tree = WorkingTree.open_containing(filename)[0]
 
1530
        self.outf.write(tree.basedir + '\n')
 
1531
 
 
1532
 
 
1533
class cmd_log(Command):
 
1534
    """Show log of a branch, file, or directory.
 
1535
 
 
1536
    By default show the log of the branch containing the working directory.
 
1537
 
 
1538
    To request a range of logs, you can use the command -r begin..end
 
1539
    -r revision requests a specific revision, -r ..end or -r begin.. are
 
1540
    also valid.
 
1541
 
 
1542
    examples:
 
1543
        bzr log
 
1544
        bzr log foo.c
 
1545
        bzr log -r -10.. http://server/branch
 
1546
    """
 
1547
 
 
1548
    # TODO: Make --revision support uuid: and hash: [future tag:] notation.
 
1549
 
 
1550
    takes_args = ['location?']
 
1551
    takes_options = [Option('forward', 
 
1552
                            help='show from oldest to newest'),
 
1553
                     'timezone', 
 
1554
                     Option('verbose', 
 
1555
                             short_name='v',
 
1556
                             help='show files changed in each revision'),
 
1557
                     'show-ids', 'revision',
 
1558
                     'log-format',
 
1559
                     Option('message',
 
1560
                            short_name='m',
 
1561
                            help='show revisions whose message matches this regexp',
 
1562
                            type=str),
 
1563
                     ]
 
1564
    encoding_type = 'replace'
 
1565
 
 
1566
    @display_command
 
1567
    def run(self, location=None, timezone='original',
 
1568
            verbose=False,
 
1569
            show_ids=False,
 
1570
            forward=False,
 
1571
            revision=None,
 
1572
            log_format=None,
 
1573
            message=None):
 
1574
        from bzrlib.log import show_log
 
1575
        assert message is None or isinstance(message, basestring), \
 
1576
            "invalid message argument %r" % message
 
1577
        direction = (forward and 'forward') or 'reverse'
 
1578
        
 
1579
        # log everything
 
1580
        file_id = None
 
1581
        if location:
 
1582
            # find the file id to log:
 
1583
 
 
1584
            tree, b, fp = bzrdir.BzrDir.open_containing_tree_or_branch(
 
1585
                location)
 
1586
            if fp != '':
 
1587
                if tree is None:
 
1588
                    tree = b.basis_tree()
 
1589
                file_id = tree.path2id(fp)
 
1590
                if file_id is None:
 
1591
                    raise errors.BzrCommandError(
 
1592
                        "Path does not have any revision history: %s" %
 
1593
                        location)
 
1594
        else:
 
1595
            # local dir only
 
1596
            # FIXME ? log the current subdir only RBC 20060203 
 
1597
            if revision is not None \
 
1598
                    and len(revision) > 0 and revision[0].get_branch():
 
1599
                location = revision[0].get_branch()
 
1600
            else:
 
1601
                location = '.'
 
1602
            dir, relpath = bzrdir.BzrDir.open_containing(location)
 
1603
            b = dir.open_branch()
 
1604
 
 
1605
        b.lock_read()
 
1606
        try:
 
1607
            if revision is None:
 
1608
                rev1 = None
 
1609
                rev2 = None
 
1610
            elif len(revision) == 1:
 
1611
                rev1 = rev2 = revision[0].in_history(b).revno
 
1612
            elif len(revision) == 2:
 
1613
                if revision[1].get_branch() != revision[0].get_branch():
 
1614
                    # b is taken from revision[0].get_branch(), and
 
1615
                    # show_log will use its revision_history. Having
 
1616
                    # different branches will lead to weird behaviors.
 
1617
                    raise errors.BzrCommandError(
 
1618
                        "Log doesn't accept two revisions in different"
 
1619
                        " branches.")
 
1620
                if revision[0].spec is None:
 
1621
                    # missing begin-range means first revision
 
1622
                    rev1 = 1
 
1623
                else:
 
1624
                    rev1 = revision[0].in_history(b).revno
 
1625
 
 
1626
                if revision[1].spec is None:
 
1627
                    # missing end-range means last known revision
 
1628
                    rev2 = b.revno()
 
1629
                else:
 
1630
                    rev2 = revision[1].in_history(b).revno
 
1631
            else:
 
1632
                raise errors.BzrCommandError(
 
1633
                    'bzr log --revision takes one or two values.')
 
1634
 
 
1635
            # By this point, the revision numbers are converted to the +ve
 
1636
            # form if they were supplied in the -ve form, so we can do
 
1637
            # this comparison in relative safety
 
1638
            if rev1 > rev2:
 
1639
                (rev2, rev1) = (rev1, rev2)
 
1640
 
 
1641
            if log_format is None:
 
1642
                log_format = log.log_formatter_registry.get_default(b)
 
1643
 
 
1644
            lf = log_format(show_ids=show_ids, to_file=self.outf,
 
1645
                            show_timezone=timezone)
 
1646
 
 
1647
            show_log(b,
 
1648
                     lf,
 
1649
                     file_id,
 
1650
                     verbose=verbose,
 
1651
                     direction=direction,
 
1652
                     start_revision=rev1,
 
1653
                     end_revision=rev2,
 
1654
                     search=message)
 
1655
        finally:
 
1656
            b.unlock()
 
1657
 
 
1658
 
 
1659
def get_log_format(long=False, short=False, line=False, default='long'):
 
1660
    log_format = default
 
1661
    if long:
 
1662
        log_format = 'long'
 
1663
    if short:
 
1664
        log_format = 'short'
 
1665
    if line:
 
1666
        log_format = 'line'
 
1667
    return log_format
 
1668
 
 
1669
 
 
1670
class cmd_touching_revisions(Command):
 
1671
    """Return revision-ids which affected a particular file.
 
1672
 
 
1673
    A more user-friendly interface is "bzr log FILE".
 
1674
    """
 
1675
 
 
1676
    hidden = True
 
1677
    takes_args = ["filename"]
 
1678
 
 
1679
    @display_command
 
1680
    def run(self, filename):
 
1681
        tree, relpath = WorkingTree.open_containing(filename)
 
1682
        b = tree.branch
 
1683
        file_id = tree.path2id(relpath)
 
1684
        for revno, revision_id, what in log.find_touching_revisions(b, file_id):
 
1685
            self.outf.write("%6d %s\n" % (revno, what))
 
1686
 
 
1687
 
 
1688
class cmd_ls(Command):
 
1689
    """List files in a tree.
 
1690
    """
 
1691
 
 
1692
    takes_args = ['path?']
 
1693
    # TODO: Take a revision or remote path and list that tree instead.
 
1694
    takes_options = ['verbose', 'revision',
 
1695
                     Option('non-recursive',
 
1696
                            help='don\'t recurse into sub-directories'),
 
1697
                     Option('from-root',
 
1698
                            help='Print all paths from the root of the branch.'),
 
1699
                     Option('unknown', help='Print unknown files'),
 
1700
                     Option('versioned', help='Print versioned files'),
 
1701
                     Option('ignored', help='Print ignored files'),
 
1702
 
 
1703
                     Option('null', help='Null separate the files'),
 
1704
                     'kind', 'show-ids'
 
1705
                    ]
 
1706
    @display_command
 
1707
    def run(self, revision=None, verbose=False, 
 
1708
            non_recursive=False, from_root=False,
 
1709
            unknown=False, versioned=False, ignored=False,
 
1710
            null=False, kind=None, show_ids=False, path=None):
 
1711
 
 
1712
        if kind and kind not in ('file', 'directory', 'symlink'):
 
1713
            raise errors.BzrCommandError('invalid kind specified')
 
1714
 
 
1715
        if verbose and null:
 
1716
            raise errors.BzrCommandError('Cannot set both --verbose and --null')
 
1717
        all = not (unknown or versioned or ignored)
 
1718
 
 
1719
        selection = {'I':ignored, '?':unknown, 'V':versioned}
 
1720
 
 
1721
        if path is None:
 
1722
            fs_path = '.'
 
1723
            prefix = ''
 
1724
        else:
 
1725
            if from_root:
 
1726
                raise errors.BzrCommandError('cannot specify both --from-root'
 
1727
                                             ' and PATH')
 
1728
            fs_path = path
 
1729
            prefix = path
 
1730
        tree, branch, relpath = bzrdir.BzrDir.open_containing_tree_or_branch(
 
1731
            fs_path)
 
1732
        if from_root:
 
1733
            relpath = u''
 
1734
        elif relpath:
 
1735
            relpath += '/'
 
1736
        if revision is not None:
 
1737
            tree = branch.repository.revision_tree(
 
1738
                revision[0].in_history(branch).rev_id)
 
1739
        elif tree is None:
 
1740
            tree = branch.basis_tree()
 
1741
 
 
1742
        tree.lock_read()
 
1743
        try:
 
1744
            for fp, fc, fkind, fid, entry in tree.list_files(include_root=False):
 
1745
                if fp.startswith(relpath):
 
1746
                    fp = osutils.pathjoin(prefix, fp[len(relpath):])
 
1747
                    if non_recursive and '/' in fp:
 
1748
                        continue
 
1749
                    if not all and not selection[fc]:
 
1750
                        continue
 
1751
                    if kind is not None and fkind != kind:
 
1752
                        continue
 
1753
                    if verbose:
 
1754
                        kindch = entry.kind_character()
 
1755
                        outstring = '%-8s %s%s' % (fc, fp, kindch)
 
1756
                        if show_ids and fid is not None:
 
1757
                            outstring = "%-50s %s" % (outstring, fid)
 
1758
                        self.outf.write(outstring + '\n')
 
1759
                    elif null:
 
1760
                        self.outf.write(fp + '\0')
 
1761
                        if show_ids:
 
1762
                            if fid is not None:
 
1763
                                self.outf.write(fid)
 
1764
                            self.outf.write('\0')
 
1765
                        self.outf.flush()
 
1766
                    else:
 
1767
                        if fid is not None:
 
1768
                            my_id = fid
 
1769
                        else:
 
1770
                            my_id = ''
 
1771
                        if show_ids:
 
1772
                            self.outf.write('%-50s %s\n' % (fp, my_id))
 
1773
                        else:
 
1774
                            self.outf.write(fp + '\n')
 
1775
        finally:
 
1776
            tree.unlock()
 
1777
 
 
1778
 
 
1779
class cmd_unknowns(Command):
 
1780
    """List unknown files.
 
1781
 
 
1782
    See also: "bzr ls --unknown".
 
1783
    """
 
1784
 
 
1785
    hidden = True
 
1786
 
 
1787
    @display_command
 
1788
    def run(self):
 
1789
        for f in WorkingTree.open_containing(u'.')[0].unknowns():
 
1790
            self.outf.write(osutils.quotefn(f) + '\n')
 
1791
 
 
1792
 
 
1793
class cmd_ignore(Command):
 
1794
    """Ignore specified files or patterns.
 
1795
 
 
1796
    To remove patterns from the ignore list, edit the .bzrignore file.
 
1797
 
 
1798
    Trailing slashes on patterns are ignored. 
 
1799
    If the pattern contains a slash or is a regular expression, it is compared 
 
1800
    to the whole path from the branch root.  Otherwise, it is compared to only
 
1801
    the last component of the path.  To match a file only in the root 
 
1802
    directory, prepend './'.
 
1803
 
 
1804
    Ignore patterns specifying absolute paths are not allowed.
 
1805
 
 
1806
    Ignore patterns may include globbing wildcards such as:
 
1807
      ? - Matches any single character except '/'
 
1808
      * - Matches 0 or more characters except '/'
 
1809
      /**/ - Matches 0 or more directories in a path
 
1810
      [a-z] - Matches a single character from within a group of characters
 
1811
 
 
1812
    Ignore patterns may also be Python regular expressions.  
 
1813
    Regular expression ignore patterns are identified by a 'RE:' prefix 
 
1814
    followed by the regular expression.  Regular expression ignore patterns
 
1815
    may not include named or numbered groups.
 
1816
 
 
1817
    Note: ignore patterns containing shell wildcards must be quoted from 
 
1818
    the shell on Unix.
 
1819
 
 
1820
    examples:
 
1821
        bzr ignore ./Makefile
 
1822
        bzr ignore '*.class'
 
1823
        bzr ignore 'lib/**/*.o'
 
1824
        bzr ignore 'RE:lib/.*\.o'
 
1825
    """
 
1826
    takes_args = ['name_pattern*']
 
1827
    takes_options = [
 
1828
                     Option('old-default-rules',
 
1829
                            help='Out the ignore rules bzr < 0.9 always used.')
 
1830
                     ]
 
1831
    
 
1832
    def run(self, name_pattern_list=None, old_default_rules=None):
 
1833
        from bzrlib.atomicfile import AtomicFile
 
1834
        if old_default_rules is not None:
 
1835
            # dump the rules and exit
 
1836
            for pattern in ignores.OLD_DEFAULTS:
 
1837
                print pattern
 
1838
            return
 
1839
        if not name_pattern_list:
 
1840
            raise errors.BzrCommandError("ignore requires at least one "
 
1841
                                  "NAME_PATTERN or --old-default-rules")
 
1842
        name_pattern_list = [globbing.normalize_pattern(p) 
 
1843
                             for p in name_pattern_list]
 
1844
        for name_pattern in name_pattern_list:
 
1845
            if (name_pattern[0] == '/' or 
 
1846
                (len(name_pattern) > 1 and name_pattern[1] == ':')):
 
1847
                raise errors.BzrCommandError(
 
1848
                    "NAME_PATTERN should not be an absolute path")
 
1849
        tree, relpath = WorkingTree.open_containing(u'.')
 
1850
        ifn = tree.abspath('.bzrignore')
 
1851
        if os.path.exists(ifn):
 
1852
            f = open(ifn, 'rt')
 
1853
            try:
 
1854
                igns = f.read().decode('utf-8')
 
1855
            finally:
 
1856
                f.close()
 
1857
        else:
 
1858
            igns = ''
 
1859
 
 
1860
        # TODO: If the file already uses crlf-style termination, maybe
 
1861
        # we should use that for the newly added lines?
 
1862
 
 
1863
        if igns and igns[-1] != '\n':
 
1864
            igns += '\n'
 
1865
        for name_pattern in name_pattern_list:
 
1866
            igns += name_pattern + '\n'
 
1867
 
 
1868
        f = AtomicFile(ifn, 'wb')
 
1869
        try:
 
1870
            f.write(igns.encode('utf-8'))
 
1871
            f.commit()
 
1872
        finally:
 
1873
            f.close()
 
1874
 
 
1875
        if not tree.path2id('.bzrignore'):
 
1876
            tree.add(['.bzrignore'])
 
1877
 
 
1878
 
 
1879
class cmd_ignored(Command):
 
1880
    """List ignored files and the patterns that matched them.
 
1881
 
 
1882
    See also: bzr ignore"""
 
1883
    @display_command
 
1884
    def run(self):
 
1885
        tree = WorkingTree.open_containing(u'.')[0]
 
1886
        tree.lock_read()
 
1887
        try:
 
1888
            for path, file_class, kind, file_id, entry in tree.list_files():
 
1889
                if file_class != 'I':
 
1890
                    continue
 
1891
                ## XXX: Slightly inefficient since this was already calculated
 
1892
                pat = tree.is_ignored(path)
 
1893
                print '%-50s %s' % (path, pat)
 
1894
        finally:
 
1895
            tree.unlock()
 
1896
 
 
1897
 
 
1898
class cmd_lookup_revision(Command):
 
1899
    """Lookup the revision-id from a revision-number
 
1900
 
 
1901
    example:
 
1902
        bzr lookup-revision 33
 
1903
    """
 
1904
    hidden = True
 
1905
    takes_args = ['revno']
 
1906
    
 
1907
    @display_command
 
1908
    def run(self, revno):
 
1909
        try:
 
1910
            revno = int(revno)
 
1911
        except ValueError:
 
1912
            raise errors.BzrCommandError("not a valid revision-number: %r" % revno)
 
1913
 
 
1914
        print WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
 
1915
 
 
1916
 
 
1917
class cmd_export(Command):
 
1918
    """Export past revision to destination directory.
 
1919
 
 
1920
    If no revision is specified this exports the last committed revision.
 
1921
 
 
1922
    Format may be an "exporter" name, such as tar, tgz, tbz2.  If none is
 
1923
    given, try to find the format with the extension. If no extension
 
1924
    is found exports to a directory (equivalent to --format=dir).
 
1925
 
 
1926
    Root may be the top directory for tar, tgz and tbz2 formats. If none
 
1927
    is given, the top directory will be the root name of the file.
 
1928
 
 
1929
    If branch is omitted then the branch containing the CWD will be used.
 
1930
 
 
1931
    Note: export of tree with non-ascii filenames to zip is not supported.
 
1932
 
 
1933
     Supported formats       Autodetected by extension
 
1934
     -----------------       -------------------------
 
1935
         dir                            -
 
1936
         tar                          .tar
 
1937
         tbz2                    .tar.bz2, .tbz2
 
1938
         tgz                      .tar.gz, .tgz
 
1939
         zip                          .zip
 
1940
    """
 
1941
    takes_args = ['dest', 'branch?']
 
1942
    takes_options = ['revision', 'format', 'root']
 
1943
    def run(self, dest, branch=None, revision=None, format=None, root=None):
 
1944
        from bzrlib.export import export
 
1945
 
 
1946
        if branch is None:
 
1947
            tree = WorkingTree.open_containing(u'.')[0]
 
1948
            b = tree.branch
 
1949
        else:
 
1950
            b = Branch.open(branch)
 
1951
            
 
1952
        if revision is None:
 
1953
            # should be tree.last_revision  FIXME
 
1954
            rev_id = b.last_revision()
 
1955
        else:
 
1956
            if len(revision) != 1:
 
1957
                raise errors.BzrCommandError('bzr export --revision takes exactly 1 argument')
 
1958
            rev_id = revision[0].in_history(b).rev_id
 
1959
        t = b.repository.revision_tree(rev_id)
 
1960
        try:
 
1961
            export(t, dest, format, root)
 
1962
        except errors.NoSuchExportFormat, e:
 
1963
            raise errors.BzrCommandError('Unsupported export format: %s' % e.format)
 
1964
 
 
1965
 
 
1966
class cmd_cat(Command):
 
1967
    """Write a file's text from a previous revision."""
 
1968
 
 
1969
    takes_options = ['revision', 'name-from-revision']
 
1970
    takes_args = ['filename']
 
1971
    encoding_type = 'exact'
 
1972
 
 
1973
    @display_command
 
1974
    def run(self, filename, revision=None, name_from_revision=False):
 
1975
        if revision is not None and len(revision) != 1:
 
1976
            raise errors.BzrCommandError("bzr cat --revision takes exactly"
 
1977
                                        " one number")
 
1978
 
 
1979
        tree = None
 
1980
        try:
 
1981
            tree, b, relpath = \
 
1982
                    bzrdir.BzrDir.open_containing_tree_or_branch(filename)
 
1983
        except errors.NotBranchError:
 
1984
            pass
 
1985
 
 
1986
        if revision is not None and revision[0].get_branch() is not None:
 
1987
            b = Branch.open(revision[0].get_branch())
 
1988
        if tree is None:
 
1989
            tree = b.basis_tree()
 
1990
        if revision is None:
 
1991
            revision_id = b.last_revision()
 
1992
        else:
 
1993
            revision_id = revision[0].in_history(b).rev_id
 
1994
 
 
1995
        cur_file_id = tree.path2id(relpath)
 
1996
        rev_tree = b.repository.revision_tree(revision_id)
 
1997
        old_file_id = rev_tree.path2id(relpath)
 
1998
        
 
1999
        if name_from_revision:
 
2000
            if old_file_id is None:
 
2001
                raise errors.BzrCommandError("%r is not present in revision %s"
 
2002
                                                % (filename, revision_id))
 
2003
            else:
 
2004
                rev_tree.print_file(old_file_id)
 
2005
        elif cur_file_id is not None:
 
2006
            rev_tree.print_file(cur_file_id)
 
2007
        elif old_file_id is not None:
 
2008
            rev_tree.print_file(old_file_id)
 
2009
        else:
 
2010
            raise errors.BzrCommandError("%r is not present in revision %s" %
 
2011
                                         (filename, revision_id))
 
2012
 
 
2013
 
 
2014
class cmd_local_time_offset(Command):
 
2015
    """Show the offset in seconds from GMT to local time."""
 
2016
    hidden = True    
 
2017
    @display_command
 
2018
    def run(self):
 
2019
        print osutils.local_time_offset()
 
2020
 
 
2021
 
 
2022
 
 
2023
class cmd_commit(Command):
 
2024
    """Commit changes into a new revision.
 
2025
    
 
2026
    If no arguments are given, the entire tree is committed.
 
2027
 
 
2028
    If selected files are specified, only changes to those files are
 
2029
    committed.  If a directory is specified then the directory and everything 
 
2030
    within it is committed.
 
2031
 
 
2032
    A selected-file commit may fail in some cases where the committed
 
2033
    tree would be invalid, such as trying to commit a file in a
 
2034
    newly-added directory that is not itself committed.
 
2035
    """
 
2036
    # TODO: Run hooks on tree to-be-committed, and after commit.
 
2037
 
 
2038
    # TODO: Strict commit that fails if there are deleted files.
 
2039
    #       (what does "deleted files" mean ??)
 
2040
 
 
2041
    # TODO: Give better message for -s, --summary, used by tla people
 
2042
 
 
2043
    # XXX: verbose currently does nothing
 
2044
 
 
2045
    takes_args = ['selected*']
 
2046
    takes_options = ['message', 'verbose', 
 
2047
                     Option('unchanged',
 
2048
                            help='commit even if nothing has changed'),
 
2049
                     Option('file', type=str, 
 
2050
                            short_name='F',
 
2051
                            argname='msgfile',
 
2052
                            help='file containing commit message'),
 
2053
                     Option('strict',
 
2054
                            help="refuse to commit if there are unknown "
 
2055
                            "files in the working tree."),
 
2056
                     Option('local',
 
2057
                            help="perform a local only commit in a bound "
 
2058
                                 "branch. Such commits are not pushed to "
 
2059
                                 "the master branch until a normal commit "
 
2060
                                 "is performed."
 
2061
                            ),
 
2062
                     ]
 
2063
    aliases = ['ci', 'checkin']
 
2064
 
 
2065
    def run(self, message=None, file=None, verbose=True, selected_list=None,
 
2066
            unchanged=False, strict=False, local=False):
 
2067
        from bzrlib.commit import (NullCommitReporter, ReportCommitToLog)
 
2068
        from bzrlib.errors import (PointlessCommit, ConflictsInTree,
 
2069
                StrictCommitFailed)
 
2070
        from bzrlib.msgeditor import edit_commit_message, \
 
2071
                make_commit_message_template
 
2072
 
 
2073
        # TODO: Need a blackbox test for invoking the external editor; may be
 
2074
        # slightly problematic to run this cross-platform.
 
2075
 
 
2076
        # TODO: do more checks that the commit will succeed before 
 
2077
        # spending the user's valuable time typing a commit message.
 
2078
        tree, selected_list = tree_files(selected_list)
 
2079
        if selected_list == ['']:
 
2080
            # workaround - commit of root of tree should be exactly the same
 
2081
            # as just default commit in that tree, and succeed even though
 
2082
            # selected-file merge commit is not done yet
 
2083
            selected_list = []
 
2084
 
 
2085
        if local and not tree.branch.get_bound_location():
 
2086
            raise errors.LocalRequiresBoundBranch()
 
2087
 
 
2088
        def get_message(commit_obj):
 
2089
            """Callback to get commit message"""
 
2090
            my_message = message
 
2091
            if my_message is None and not file:
 
2092
                template = make_commit_message_template(tree, selected_list)
 
2093
                my_message = edit_commit_message(template)
 
2094
                if my_message is None:
 
2095
                    raise errors.BzrCommandError("please specify a commit"
 
2096
                        " message with either --message or --file")
 
2097
            elif my_message and file:
 
2098
                raise errors.BzrCommandError(
 
2099
                    "please specify either --message or --file")
 
2100
            if file:
 
2101
                my_message = codecs.open(file, 'rt', 
 
2102
                                         bzrlib.user_encoding).read()
 
2103
            if my_message == "":
 
2104
                raise errors.BzrCommandError("empty commit message specified")
 
2105
            return my_message
 
2106
        
 
2107
        if verbose:
 
2108
            reporter = ReportCommitToLog()
 
2109
        else:
 
2110
            reporter = NullCommitReporter()
 
2111
 
 
2112
        try:
 
2113
            tree.commit(message_callback=get_message,
 
2114
                        specific_files=selected_list,
 
2115
                        allow_pointless=unchanged, strict=strict, local=local,
 
2116
                        reporter=reporter)
 
2117
        except PointlessCommit:
 
2118
            # FIXME: This should really happen before the file is read in;
 
2119
            # perhaps prepare the commit; get the message; then actually commit
 
2120
            raise errors.BzrCommandError("no changes to commit."
 
2121
                              " use --unchanged to commit anyhow")
 
2122
        except ConflictsInTree:
 
2123
            raise errors.BzrCommandError('Conflicts detected in working '
 
2124
                'tree.  Use "bzr conflicts" to list, "bzr resolve FILE" to'
 
2125
                ' resolve.')
 
2126
        except StrictCommitFailed:
 
2127
            raise errors.BzrCommandError("Commit refused because there are"
 
2128
                              " unknown files in the working tree.")
 
2129
        except errors.BoundBranchOutOfDate, e:
 
2130
            raise errors.BzrCommandError(str(e) + "\n"
 
2131
            'To commit to master branch, run update and then commit.\n'
 
2132
            'You can also pass --local to commit to continue working '
 
2133
            'disconnected.')
 
2134
 
 
2135
 
 
2136
class cmd_check(Command):
 
2137
    """Validate consistency of branch history.
 
2138
 
 
2139
    This command checks various invariants about the branch storage to
 
2140
    detect data corruption or bzr bugs.
 
2141
    """
 
2142
    takes_args = ['branch?']
 
2143
    takes_options = ['verbose']
 
2144
 
 
2145
    def run(self, branch=None, verbose=False):
 
2146
        from bzrlib.check import check
 
2147
        if branch is None:
 
2148
            tree = WorkingTree.open_containing()[0]
 
2149
            branch = tree.branch
 
2150
        else:
 
2151
            branch = Branch.open(branch)
 
2152
        check(branch, verbose)
 
2153
 
 
2154
 
 
2155
class cmd_upgrade(Command):
 
2156
    """Upgrade branch storage to current format.
 
2157
 
 
2158
    The check command or bzr developers may sometimes advise you to run
 
2159
    this command. When the default format has changed you may also be warned
 
2160
    during other operations to upgrade.
 
2161
    """
 
2162
    takes_args = ['url?']
 
2163
    takes_options = [
 
2164
                    RegistryOption('format',
 
2165
                        help='Upgrade to a specific format.  See "bzr help'
 
2166
                             ' formats" for details',
 
2167
                        registry=bzrdir.format_registry,
 
2168
                        converter=bzrdir.format_registry.make_bzrdir,
 
2169
                        value_switches=True, title='Branch format'),
 
2170
                    ]
 
2171
 
 
2172
    def run(self, url='.', format=None):
 
2173
        from bzrlib.upgrade import upgrade
 
2174
        if format is None:
 
2175
            format = bzrdir.format_registry.make_bzrdir('default')
 
2176
        upgrade(url, format)
 
2177
 
 
2178
 
 
2179
class cmd_whoami(Command):
 
2180
    """Show or set bzr user id.
 
2181
    
 
2182
    examples:
 
2183
        bzr whoami --email
 
2184
        bzr whoami 'Frank Chu <fchu@example.com>'
 
2185
    """
 
2186
    takes_options = [ Option('email',
 
2187
                             help='display email address only'),
 
2188
                      Option('branch',
 
2189
                             help='set identity for the current branch instead of '
 
2190
                                  'globally'),
 
2191
                    ]
 
2192
    takes_args = ['name?']
 
2193
    encoding_type = 'replace'
 
2194
    
 
2195
    @display_command
 
2196
    def run(self, email=False, branch=False, name=None):
 
2197
        if name is None:
 
2198
            # use branch if we're inside one; otherwise global config
 
2199
            try:
 
2200
                c = Branch.open_containing('.')[0].get_config()
 
2201
            except errors.NotBranchError:
 
2202
                c = config.GlobalConfig()
 
2203
            if email:
 
2204
                self.outf.write(c.user_email() + '\n')
 
2205
            else:
 
2206
                self.outf.write(c.username() + '\n')
 
2207
            return
 
2208
 
 
2209
        # display a warning if an email address isn't included in the given name.
 
2210
        try:
 
2211
            config.extract_email_address(name)
 
2212
        except errors.NoEmailInUsername, e:
 
2213
            warning('"%s" does not seem to contain an email address.  '
 
2214
                    'This is allowed, but not recommended.', name)
 
2215
        
 
2216
        # use global config unless --branch given
 
2217
        if branch:
 
2218
            c = Branch.open_containing('.')[0].get_config()
 
2219
        else:
 
2220
            c = config.GlobalConfig()
 
2221
        c.set_user_option('email', name)
 
2222
 
 
2223
 
 
2224
class cmd_nick(Command):
 
2225
    """Print or set the branch nickname.  
 
2226
 
 
2227
    If unset, the tree root directory name is used as the nickname
 
2228
    To print the current nickname, execute with no argument.  
 
2229
    """
 
2230
    takes_args = ['nickname?']
 
2231
    def run(self, nickname=None):
 
2232
        branch = Branch.open_containing(u'.')[0]
 
2233
        if nickname is None:
 
2234
            self.printme(branch)
 
2235
        else:
 
2236
            branch.nick = nickname
 
2237
 
 
2238
    @display_command
 
2239
    def printme(self, branch):
 
2240
        print branch.nick 
 
2241
 
 
2242
 
 
2243
class cmd_selftest(Command):
 
2244
    """Run internal test suite.
 
2245
    
 
2246
    This creates temporary test directories in the working directory, but not
 
2247
    existing data is affected.  These directories are deleted if the tests
 
2248
    pass, or left behind to help in debugging if they fail and --keep-output
 
2249
    is specified.
 
2250
    
 
2251
    If arguments are given, they are regular expressions that say which tests
 
2252
    should run.  Tests matching any expression are run, and other tests are
 
2253
    not run.
 
2254
 
 
2255
    Alternatively if --first is given, matching tests are run first and then
 
2256
    all other tests are run.  This is useful if you have been working in a
 
2257
    particular area, but want to make sure nothing else was broken.
 
2258
 
 
2259
    If the global option '--no-plugins' is given, plugins are not loaded
 
2260
    before running the selftests.  This has two effects: features provided or
 
2261
    modified by plugins will not be tested, and tests provided by plugins will
 
2262
    not be run.
 
2263
 
 
2264
    examples::
 
2265
        bzr selftest ignore
 
2266
            run only tests relating to 'ignore'
 
2267
        bzr --no-plugins selftest -v
 
2268
            disable plugins and list tests as they're run
 
2269
 
 
2270
    For each test, that needs actual disk access, bzr create their own
 
2271
    subdirectory in the temporary testing directory (testXXXX.tmp).
 
2272
    By default the name of such subdirectory is based on the name of the test.
 
2273
    If option '--numbered-dirs' is given, bzr will use sequent numbers
 
2274
    of running tests to create such subdirectories. This is default behavior
 
2275
    on Windows because of path length limitation.
 
2276
    """
 
2277
    # TODO: --list should give a list of all available tests
 
2278
 
 
2279
    # NB: this is used from the class without creating an instance, which is
 
2280
    # why it does not have a self parameter.
 
2281
    def get_transport_type(typestring):
 
2282
        """Parse and return a transport specifier."""
 
2283
        if typestring == "sftp":
 
2284
            from bzrlib.transport.sftp import SFTPAbsoluteServer
 
2285
            return SFTPAbsoluteServer
 
2286
        if typestring == "memory":
 
2287
            from bzrlib.transport.memory import MemoryServer
 
2288
            return MemoryServer
 
2289
        if typestring == "fakenfs":
 
2290
            from bzrlib.transport.fakenfs import FakeNFSServer
 
2291
            return FakeNFSServer
 
2292
        msg = "No known transport type %s. Supported types are: sftp\n" %\
 
2293
            (typestring)
 
2294
        raise errors.BzrCommandError(msg)
 
2295
 
 
2296
    hidden = True
 
2297
    takes_args = ['testspecs*']
 
2298
    takes_options = ['verbose',
 
2299
                     Option('one', help='stop when one test fails'),
 
2300
                     Option('keep-output',
 
2301
                            help='keep output directories when tests fail'),
 
2302
                     Option('transport',
 
2303
                            help='Use a different transport by default '
 
2304
                                 'throughout the test suite.',
 
2305
                            type=get_transport_type),
 
2306
                     Option('benchmark', help='run the bzr benchmarks.'),
 
2307
                     Option('lsprof-timed',
 
2308
                            help='generate lsprof output for benchmarked'
 
2309
                                 ' sections of code.'),
 
2310
                     Option('cache-dir', type=str,
 
2311
                            help='a directory to cache intermediate'
 
2312
                                 ' benchmark steps'),
 
2313
                     Option('clean-output',
 
2314
                            help='clean temporary tests directories'
 
2315
                                 ' without running tests'),
 
2316
                     Option('first',
 
2317
                            help='run all tests, but run specified tests first'
 
2318
                            ),
 
2319
                     Option('numbered-dirs',
 
2320
                            help='use numbered dirs for TestCaseInTempDir'),
 
2321
                     ]
 
2322
    encoding_type = 'replace'
 
2323
 
 
2324
    def run(self, testspecs_list=None, verbose=None, one=False,
 
2325
            keep_output=False, transport=None, benchmark=None,
 
2326
            lsprof_timed=None, cache_dir=None, clean_output=False,
 
2327
            first=False, numbered_dirs=None):
 
2328
        import bzrlib.ui
 
2329
        from bzrlib.tests import selftest
 
2330
        import bzrlib.benchmarks as benchmarks
 
2331
        from bzrlib.benchmarks import tree_creator
 
2332
 
 
2333
        if clean_output:
 
2334
            from bzrlib.tests import clean_selftest_output
 
2335
            clean_selftest_output()
 
2336
            return 0
 
2337
 
 
2338
        if numbered_dirs is None and sys.platform == 'win32':
 
2339
            numbered_dirs = True
 
2340
 
 
2341
        if cache_dir is not None:
 
2342
            tree_creator.TreeCreator.CACHE_ROOT = osutils.abspath(cache_dir)
 
2343
        print '%10s: %s' % ('bzr', osutils.realpath(sys.argv[0]))
 
2344
        print '%10s: %s' % ('bzrlib', bzrlib.__path__[0])
 
2345
        print
 
2346
        if testspecs_list is not None:
 
2347
            pattern = '|'.join(testspecs_list)
 
2348
        else:
 
2349
            pattern = ".*"
 
2350
        if benchmark:
 
2351
            test_suite_factory = benchmarks.test_suite
 
2352
            if verbose is None:
 
2353
                verbose = True
 
2354
            # TODO: should possibly lock the history file...
 
2355
            benchfile = open(".perf_history", "at", buffering=1)
 
2356
        else:
 
2357
            test_suite_factory = None
 
2358
            if verbose is None:
 
2359
                verbose = False
 
2360
            benchfile = None
 
2361
        try:
 
2362
            result = selftest(verbose=verbose, 
 
2363
                              pattern=pattern,
 
2364
                              stop_on_failure=one, 
 
2365
                              keep_output=keep_output,
 
2366
                              transport=transport,
 
2367
                              test_suite_factory=test_suite_factory,
 
2368
                              lsprof_timed=lsprof_timed,
 
2369
                              bench_history=benchfile,
 
2370
                              matching_tests_first=first,
 
2371
                              numbered_dirs=numbered_dirs,
 
2372
                              )
 
2373
        finally:
 
2374
            if benchfile is not None:
 
2375
                benchfile.close()
 
2376
        if result:
 
2377
            info('tests passed')
 
2378
        else:
 
2379
            info('tests failed')
 
2380
        return int(not result)
 
2381
 
 
2382
 
 
2383
class cmd_version(Command):
 
2384
    """Show version of bzr."""
 
2385
 
 
2386
    @display_command
 
2387
    def run(self):
 
2388
        from bzrlib.version import show_version
 
2389
        show_version()
 
2390
 
 
2391
 
 
2392
class cmd_rocks(Command):
 
2393
    """Statement of optimism."""
 
2394
 
 
2395
    hidden = True
 
2396
 
 
2397
    @display_command
 
2398
    def run(self):
 
2399
        print "It sure does!"
 
2400
 
 
2401
 
 
2402
class cmd_find_merge_base(Command):
 
2403
    """Find and print a base revision for merging two branches."""
 
2404
    # TODO: Options to specify revisions on either side, as if
 
2405
    #       merging only part of the history.
 
2406
    takes_args = ['branch', 'other']
 
2407
    hidden = True
 
2408
    
 
2409
    @display_command
 
2410
    def run(self, branch, other):
 
2411
        from bzrlib.revision import MultipleRevisionSources
 
2412
        
 
2413
        branch1 = Branch.open_containing(branch)[0]
 
2414
        branch2 = Branch.open_containing(other)[0]
 
2415
 
 
2416
        last1 = branch1.last_revision()
 
2417
        last2 = branch2.last_revision()
 
2418
 
 
2419
        source = MultipleRevisionSources(branch1.repository, 
 
2420
                                         branch2.repository)
 
2421
        
 
2422
        base_rev_id = common_ancestor(last1, last2, source)
 
2423
 
 
2424
        print 'merge base is revision %s' % base_rev_id
 
2425
 
 
2426
 
 
2427
class cmd_merge(Command):
 
2428
    """Perform a three-way merge.
 
2429
    
 
2430
    The branch is the branch you will merge from.  By default, it will merge
 
2431
    the latest revision.  If you specify a revision, that revision will be
 
2432
    merged.  If you specify two revisions, the first will be used as a BASE,
 
2433
    and the second one as OTHER.  Revision numbers are always relative to the
 
2434
    specified branch.
 
2435
 
 
2436
    By default, bzr will try to merge in all new work from the other
 
2437
    branch, automatically determining an appropriate base.  If this
 
2438
    fails, you may need to give an explicit base.
 
2439
    
 
2440
    Merge will do its best to combine the changes in two branches, but there
 
2441
    are some kinds of problems only a human can fix.  When it encounters those,
 
2442
    it will mark a conflict.  A conflict means that you need to fix something,
 
2443
    before you should commit.
 
2444
 
 
2445
    Use bzr resolve when you have fixed a problem.  See also bzr conflicts.
 
2446
 
 
2447
    If there is no default branch set, the first merge will set it. After
 
2448
    that, you can omit the branch to use the default.  To change the
 
2449
    default, use --remember. The value will only be saved if the remote
 
2450
    location can be accessed.
 
2451
 
 
2452
    The results of the merge are placed into the destination working
 
2453
    directory, where they can be reviewed (with bzr diff), tested, and then
 
2454
    committed to record the result of the merge.
 
2455
 
 
2456
    Examples:
 
2457
 
 
2458
    To merge the latest revision from bzr.dev
 
2459
    bzr merge ../bzr.dev
 
2460
 
 
2461
    To merge changes up to and including revision 82 from bzr.dev
 
2462
    bzr merge -r 82 ../bzr.dev
 
2463
 
 
2464
    To merge the changes introduced by 82, without previous changes:
 
2465
    bzr merge -r 81..82 ../bzr.dev
 
2466
    
 
2467
    merge refuses to run if there are any uncommitted changes, unless
 
2468
    --force is given.
 
2469
 
 
2470
    The following merge types are available:
 
2471
    """
 
2472
    takes_args = ['branch?']
 
2473
    takes_options = ['revision', 'force', 'merge-type', 'reprocess', 'remember',
 
2474
        Option('show-base', help="Show base revision text in "
 
2475
               "conflicts"),
 
2476
        Option('uncommitted', help='Apply uncommitted changes'
 
2477
               ' from a working copy, instead of branch changes'),
 
2478
        Option('pull', help='If the destination is already'
 
2479
                ' completely merged into the source, pull from the'
 
2480
                ' source rather than merging. When this happens,'
 
2481
                ' you do not need to commit the result.'),
 
2482
        Option('directory',
 
2483
            help='Branch to merge into, '
 
2484
                 'rather than the one containing the working directory',
 
2485
            short_name='d',
 
2486
            type=unicode,
 
2487
            ),
 
2488
    ]
 
2489
 
 
2490
    def run(self, branch=None, revision=None, force=False, merge_type=None,
 
2491
            show_base=False, reprocess=False, remember=False,
 
2492
            uncommitted=False, pull=False,
 
2493
            directory=None,
 
2494
            ):
 
2495
        from bzrlib.tag import _merge_tags_if_possible
 
2496
        if merge_type is None:
 
2497
            merge_type = _mod_merge.Merge3Merger
 
2498
 
 
2499
        if directory is None: directory = u'.'
 
2500
        # XXX: jam 20070225 WorkingTree should be locked before you extract its
 
2501
        #      inventory. Because merge is a mutating operation, it really
 
2502
        #      should be a lock_write() for the whole cmd_merge operation.
 
2503
        #      However, cmd_merge open's its own tree in _merge_helper, which
 
2504
        #      means if we lock here, the later lock_write() will always block.
 
2505
        #      Either the merge helper code should be updated to take a tree,
 
2506
        #      (What about tree.merge_from_branch?)
 
2507
        tree = WorkingTree.open_containing(directory)[0]
 
2508
        change_reporter = delta._ChangeReporter(
 
2509
            unversioned_filter=tree.is_ignored)
 
2510
 
 
2511
        if branch is not None:
 
2512
            try:
 
2513
                reader = bundle.read_bundle_from_url(branch)
 
2514
            except errors.NotABundle:
 
2515
                pass # Continue on considering this url a Branch
 
2516
            else:
 
2517
                conflicts = merge_bundle(reader, tree, not force, merge_type,
 
2518
                                         reprocess, show_base, change_reporter)
 
2519
                if conflicts == 0:
 
2520
                    return 0
 
2521
                else:
 
2522
                    return 1
 
2523
 
 
2524
        if revision is None \
 
2525
                or len(revision) < 1 or revision[0].needs_branch():
 
2526
            branch = self._get_remembered_parent(tree, branch, 'Merging from')
 
2527
 
 
2528
        if revision is None or len(revision) < 1:
 
2529
            if uncommitted:
 
2530
                base = [branch, -1]
 
2531
                other = [branch, None]
 
2532
            else:
 
2533
                base = [None, None]
 
2534
                other = [branch, -1]
 
2535
            other_branch, path = Branch.open_containing(branch)
 
2536
        else:
 
2537
            if uncommitted:
 
2538
                raise errors.BzrCommandError('Cannot use --uncommitted and'
 
2539
                                             ' --revision at the same time.')
 
2540
            branch = revision[0].get_branch() or branch
 
2541
            if len(revision) == 1:
 
2542
                base = [None, None]
 
2543
                other_branch, path = Branch.open_containing(branch)
 
2544
                revno = revision[0].in_history(other_branch).revno
 
2545
                other = [branch, revno]
 
2546
            else:
 
2547
                assert len(revision) == 2
 
2548
                if None in revision:
 
2549
                    raise errors.BzrCommandError(
 
2550
                        "Merge doesn't permit empty revision specifier.")
 
2551
                base_branch, path = Branch.open_containing(branch)
 
2552
                branch1 = revision[1].get_branch() or branch
 
2553
                other_branch, path1 = Branch.open_containing(branch1)
 
2554
                if revision[0].get_branch() is not None:
 
2555
                    # then path was obtained from it, and is None.
 
2556
                    path = path1
 
2557
 
 
2558
                base = [branch, revision[0].in_history(base_branch).revno]
 
2559
                other = [branch1, revision[1].in_history(other_branch).revno]
 
2560
 
 
2561
        if tree.branch.get_parent() is None or remember:
 
2562
            tree.branch.set_parent(other_branch.base)
 
2563
 
 
2564
        # pull tags now... it's a bit inconsistent to do it ahead of copying
 
2565
        # the history but that's done inside the merge code
 
2566
        _merge_tags_if_possible(other_branch, tree.branch)
 
2567
 
 
2568
        if path != "":
 
2569
            interesting_files = [path]
 
2570
        else:
 
2571
            interesting_files = None
 
2572
        pb = ui.ui_factory.nested_progress_bar()
 
2573
        try:
 
2574
            try:
 
2575
                conflict_count = _merge_helper(
 
2576
                    other, base, check_clean=(not force),
 
2577
                    merge_type=merge_type,
 
2578
                    reprocess=reprocess,
 
2579
                    show_base=show_base,
 
2580
                    pull=pull,
 
2581
                    this_dir=directory,
 
2582
                    pb=pb, file_list=interesting_files,
 
2583
                    change_reporter=change_reporter)
 
2584
            finally:
 
2585
                pb.finished()
 
2586
            if conflict_count != 0:
 
2587
                return 1
 
2588
            else:
 
2589
                return 0
 
2590
        except errors.AmbiguousBase, e:
 
2591
            m = ("sorry, bzr can't determine the right merge base yet\n"
 
2592
                 "candidates are:\n  "
 
2593
                 + "\n  ".join(e.bases)
 
2594
                 + "\n"
 
2595
                 "please specify an explicit base with -r,\n"
 
2596
                 "and (if you want) report this to the bzr developers\n")
 
2597
            log_error(m)
 
2598
 
 
2599
    # TODO: move up to common parent; this isn't merge-specific anymore. 
 
2600
    def _get_remembered_parent(self, tree, supplied_location, verb_string):
 
2601
        """Use tree.branch's parent if none was supplied.
 
2602
 
 
2603
        Report if the remembered location was used.
 
2604
        """
 
2605
        if supplied_location is not None:
 
2606
            return supplied_location
 
2607
        stored_location = tree.branch.get_parent()
 
2608
        mutter("%s", stored_location)
 
2609
        if stored_location is None:
 
2610
            raise errors.BzrCommandError("No location specified or remembered")
 
2611
        display_url = urlutils.unescape_for_display(stored_location, self.outf.encoding)
 
2612
        self.outf.write("%s remembered location %s\n" % (verb_string, display_url))
 
2613
        return stored_location
 
2614
 
 
2615
 
 
2616
class cmd_remerge(Command):
 
2617
    """Redo a merge.
 
2618
 
 
2619
    Use this if you want to try a different merge technique while resolving
 
2620
    conflicts.  Some merge techniques are better than others, and remerge 
 
2621
    lets you try different ones on different files.
 
2622
 
 
2623
    The options for remerge have the same meaning and defaults as the ones for
 
2624
    merge.  The difference is that remerge can (only) be run when there is a
 
2625
    pending merge, and it lets you specify particular files.
 
2626
 
 
2627
    Examples:
 
2628
    $ bzr remerge --show-base
 
2629
        Re-do the merge of all conflicted files, and show the base text in
 
2630
        conflict regions, in addition to the usual THIS and OTHER texts.
 
2631
 
 
2632
    $ bzr remerge --merge-type weave --reprocess foobar
 
2633
        Re-do the merge of "foobar", using the weave merge algorithm, with
 
2634
        additional processing to reduce the size of conflict regions.
 
2635
    
 
2636
    The following merge types are available:"""
 
2637
    takes_args = ['file*']
 
2638
    takes_options = ['merge-type', 'reprocess',
 
2639
                     Option('show-base', help="Show base revision text in "
 
2640
                            "conflicts")]
 
2641
 
 
2642
    def run(self, file_list=None, merge_type=None, show_base=False,
 
2643
            reprocess=False):
 
2644
        if merge_type is None:
 
2645
            merge_type = _mod_merge.Merge3Merger
 
2646
        tree, file_list = tree_files(file_list)
 
2647
        tree.lock_write()
 
2648
        try:
 
2649
            parents = tree.get_parent_ids()
 
2650
            if len(parents) != 2:
 
2651
                raise errors.BzrCommandError("Sorry, remerge only works after normal"
 
2652
                                             " merges.  Not cherrypicking or"
 
2653
                                             " multi-merges.")
 
2654
            repository = tree.branch.repository
 
2655
            base_revision = common_ancestor(parents[0],
 
2656
                                            parents[1], repository)
 
2657
            base_tree = repository.revision_tree(base_revision)
 
2658
            other_tree = repository.revision_tree(parents[1])
 
2659
            interesting_ids = None
 
2660
            new_conflicts = []
 
2661
            conflicts = tree.conflicts()
 
2662
            if file_list is not None:
 
2663
                interesting_ids = set()
 
2664
                for filename in file_list:
 
2665
                    file_id = tree.path2id(filename)
 
2666
                    if file_id is None:
 
2667
                        raise errors.NotVersionedError(filename)
 
2668
                    interesting_ids.add(file_id)
 
2669
                    if tree.kind(file_id) != "directory":
 
2670
                        continue
 
2671
                    
 
2672
                    for name, ie in tree.inventory.iter_entries(file_id):
 
2673
                        interesting_ids.add(ie.file_id)
 
2674
                new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
 
2675
            else:
 
2676
                # Remerge only supports resolving contents conflicts
 
2677
                allowed_conflicts = ('text conflict', 'contents conflict')
 
2678
                restore_files = [c.path for c in conflicts
 
2679
                                 if c.typestring in allowed_conflicts]
 
2680
            _mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
 
2681
            tree.set_conflicts(ConflictList(new_conflicts))
 
2682
            if file_list is not None:
 
2683
                restore_files = file_list
 
2684
            for filename in restore_files:
 
2685
                try:
 
2686
                    restore(tree.abspath(filename))
 
2687
                except errors.NotConflicted:
 
2688
                    pass
 
2689
            conflicts = _mod_merge.merge_inner(
 
2690
                                      tree.branch, other_tree, base_tree,
 
2691
                                      this_tree=tree,
 
2692
                                      interesting_ids=interesting_ids,
 
2693
                                      other_rev_id=parents[1],
 
2694
                                      merge_type=merge_type,
 
2695
                                      show_base=show_base,
 
2696
                                      reprocess=reprocess)
 
2697
        finally:
 
2698
            tree.unlock()
 
2699
        if conflicts > 0:
 
2700
            return 1
 
2701
        else:
 
2702
            return 0
 
2703
 
 
2704
 
 
2705
class cmd_revert(Command):
 
2706
    """Revert files to a previous revision.
 
2707
 
 
2708
    Giving a list of files will revert only those files.  Otherwise, all files
 
2709
    will be reverted.  If the revision is not specified with '--revision', the
 
2710
    last committed revision is used.
 
2711
 
 
2712
    To remove only some changes, without reverting to a prior version, use
 
2713
    merge instead.  For example, "merge . --r-2..-3" will remove the changes
 
2714
    introduced by -2, without affecting the changes introduced by -1.  Or
 
2715
    to remove certain changes on a hunk-by-hunk basis, see the Shelf plugin.
 
2716
    
 
2717
    By default, any files that have been manually changed will be backed up
 
2718
    first.  (Files changed only by merge are not backed up.)  Backup files have
 
2719
    '.~#~' appended to their name, where # is a number.
 
2720
 
 
2721
    When you provide files, you can use their current pathname or the pathname
 
2722
    from the target revision.  So you can use revert to "undelete" a file by
 
2723
    name.  If you name a directory, all the contents of that directory will be
 
2724
    reverted.
 
2725
    """
 
2726
    takes_options = ['revision', 'no-backup']
 
2727
    takes_args = ['file*']
 
2728
    aliases = ['merge-revert']
 
2729
 
 
2730
    def run(self, revision=None, no_backup=False, file_list=None):
 
2731
        if file_list is not None:
 
2732
            if len(file_list) == 0:
 
2733
                raise errors.BzrCommandError("No files specified")
 
2734
        else:
 
2735
            file_list = []
 
2736
        
 
2737
        tree, file_list = tree_files(file_list)
 
2738
        if revision is None:
 
2739
            # FIXME should be tree.last_revision
 
2740
            rev_id = tree.last_revision()
 
2741
        elif len(revision) != 1:
 
2742
            raise errors.BzrCommandError('bzr revert --revision takes exactly 1 argument')
 
2743
        else:
 
2744
            rev_id = revision[0].in_history(tree.branch).rev_id
 
2745
        pb = ui.ui_factory.nested_progress_bar()
 
2746
        try:
 
2747
            tree.revert(file_list, 
 
2748
                        tree.branch.repository.revision_tree(rev_id),
 
2749
                        not no_backup, pb, report_changes=True)
 
2750
        finally:
 
2751
            pb.finished()
 
2752
 
 
2753
 
 
2754
class cmd_assert_fail(Command):
 
2755
    """Test reporting of assertion failures"""
 
2756
    # intended just for use in testing
 
2757
 
 
2758
    hidden = True
 
2759
 
 
2760
    def run(self):
 
2761
        raise AssertionError("always fails")
 
2762
 
 
2763
 
 
2764
class cmd_help(Command):
 
2765
    """Show help on a command or other topic.
 
2766
 
 
2767
    For a list of all available commands, say 'bzr help commands'.
 
2768
    """
 
2769
    takes_options = [Option('long', 'show help on all commands')]
 
2770
    takes_args = ['topic?']
 
2771
    aliases = ['?', '--help', '-?', '-h']
 
2772
    
 
2773
    @display_command
 
2774
    def run(self, topic=None, long=False):
 
2775
        import bzrlib.help
 
2776
        if topic is None and long:
 
2777
            topic = "commands"
 
2778
        bzrlib.help.help(topic)
 
2779
 
 
2780
 
 
2781
class cmd_shell_complete(Command):
 
2782
    """Show appropriate completions for context.
 
2783
 
 
2784
    For a list of all available commands, say 'bzr shell-complete'.
 
2785
    """
 
2786
    takes_args = ['context?']
 
2787
    aliases = ['s-c']
 
2788
    hidden = True
 
2789
    
 
2790
    @display_command
 
2791
    def run(self, context=None):
 
2792
        import shellcomplete
 
2793
        shellcomplete.shellcomplete(context)
 
2794
 
 
2795
 
 
2796
class cmd_fetch(Command):
 
2797
    """Copy in history from another branch but don't merge it.
 
2798
 
 
2799
    This is an internal method used for pull and merge.
 
2800
    """
 
2801
    hidden = True
 
2802
    takes_args = ['from_branch', 'to_branch']
 
2803
    def run(self, from_branch, to_branch):
 
2804
        from bzrlib.fetch import Fetcher
 
2805
        from_b = Branch.open(from_branch)
 
2806
        to_b = Branch.open(to_branch)
 
2807
        Fetcher(to_b, from_b)
 
2808
 
 
2809
 
 
2810
class cmd_missing(Command):
 
2811
    """Show unmerged/unpulled revisions between two branches.
 
2812
 
 
2813
    OTHER_BRANCH may be local or remote.
 
2814
    """
 
2815
    takes_args = ['other_branch?']
 
2816
    takes_options = [Option('reverse', 'Reverse the order of revisions'),
 
2817
                     Option('mine-only', 
 
2818
                            'Display changes in the local branch only'),
 
2819
                     Option('theirs-only', 
 
2820
                            'Display changes in the remote branch only'), 
 
2821
                     'log-format',
 
2822
                     'show-ids',
 
2823
                     'verbose'
 
2824
                     ]
 
2825
    encoding_type = 'replace'
 
2826
 
 
2827
    @display_command
 
2828
    def run(self, other_branch=None, reverse=False, mine_only=False,
 
2829
            theirs_only=False, log_format=None, long=False, short=False, line=False, 
 
2830
            show_ids=False, verbose=False):
 
2831
        from bzrlib.missing import find_unmerged, iter_log_data
 
2832
        from bzrlib.log import log_formatter
 
2833
        local_branch = Branch.open_containing(u".")[0]
 
2834
        parent = local_branch.get_parent()
 
2835
        if other_branch is None:
 
2836
            other_branch = parent
 
2837
            if other_branch is None:
 
2838
                raise errors.BzrCommandError("No peer location known or specified.")
 
2839
            display_url = urlutils.unescape_for_display(parent,
 
2840
                                                        self.outf.encoding)
 
2841
            print "Using last location: " + display_url
 
2842
 
 
2843
        remote_branch = Branch.open(other_branch)
 
2844
        if remote_branch.base == local_branch.base:
 
2845
            remote_branch = local_branch
 
2846
        local_branch.lock_read()
 
2847
        try:
 
2848
            remote_branch.lock_read()
 
2849
            try:
 
2850
                local_extra, remote_extra = find_unmerged(local_branch, remote_branch)
 
2851
                if (log_format is None):
 
2852
                    log_format = log.log_formatter_registry.get_default(
 
2853
                        local_branch)
 
2854
                lf = log_format(to_file=self.outf,
 
2855
                                show_ids=show_ids,
 
2856
                                show_timezone='original')
 
2857
                if reverse is False:
 
2858
                    local_extra.reverse()
 
2859
                    remote_extra.reverse()
 
2860
                if local_extra and not theirs_only:
 
2861
                    print "You have %d extra revision(s):" % len(local_extra)
 
2862
                    for data in iter_log_data(local_extra, local_branch.repository,
 
2863
                                              verbose):
 
2864
                        lf.show(*data)
 
2865
                    printed_local = True
 
2866
                else:
 
2867
                    printed_local = False
 
2868
                if remote_extra and not mine_only:
 
2869
                    if printed_local is True:
 
2870
                        print "\n\n"
 
2871
                    print "You are missing %d revision(s):" % len(remote_extra)
 
2872
                    for data in iter_log_data(remote_extra, remote_branch.repository, 
 
2873
                                              verbose):
 
2874
                        lf.show(*data)
 
2875
                if not remote_extra and not local_extra:
 
2876
                    status_code = 0
 
2877
                    print "Branches are up to date."
 
2878
                else:
 
2879
                    status_code = 1
 
2880
            finally:
 
2881
                remote_branch.unlock()
 
2882
        finally:
 
2883
            local_branch.unlock()
 
2884
        if not status_code and parent is None and other_branch is not None:
 
2885
            local_branch.lock_write()
 
2886
            try:
 
2887
                # handle race conditions - a parent might be set while we run.
 
2888
                if local_branch.get_parent() is None:
 
2889
                    local_branch.set_parent(remote_branch.base)
 
2890
            finally:
 
2891
                local_branch.unlock()
 
2892
        return status_code
 
2893
 
 
2894
 
 
2895
class cmd_plugins(Command):
 
2896
    """List plugins"""
 
2897
    hidden = True
 
2898
    @display_command
 
2899
    def run(self):
 
2900
        import bzrlib.plugin
 
2901
        from inspect import getdoc
 
2902
        for name, plugin in bzrlib.plugin.all_plugins().items():
 
2903
            if getattr(plugin, '__path__', None) is not None:
 
2904
                print plugin.__path__[0]
 
2905
            elif getattr(plugin, '__file__', None) is not None:
 
2906
                print plugin.__file__
 
2907
            else:
 
2908
                print repr(plugin)
 
2909
                
 
2910
            d = getdoc(plugin)
 
2911
            if d:
 
2912
                print '\t', d.split('\n')[0]
 
2913
 
 
2914
 
 
2915
class cmd_testament(Command):
 
2916
    """Show testament (signing-form) of a revision."""
 
2917
    takes_options = ['revision', 
 
2918
                     Option('long', help='Produce long-format testament'), 
 
2919
                     Option('strict', help='Produce a strict-format'
 
2920
                            ' testament')]
 
2921
    takes_args = ['branch?']
 
2922
    @display_command
 
2923
    def run(self, branch=u'.', revision=None, long=False, strict=False):
 
2924
        from bzrlib.testament import Testament, StrictTestament
 
2925
        if strict is True:
 
2926
            testament_class = StrictTestament
 
2927
        else:
 
2928
            testament_class = Testament
 
2929
        b = WorkingTree.open_containing(branch)[0].branch
 
2930
        b.lock_read()
 
2931
        try:
 
2932
            if revision is None:
 
2933
                rev_id = b.last_revision()
 
2934
            else:
 
2935
                rev_id = revision[0].in_history(b).rev_id
 
2936
            t = testament_class.from_revision(b.repository, rev_id)
 
2937
            if long:
 
2938
                sys.stdout.writelines(t.as_text_lines())
 
2939
            else:
 
2940
                sys.stdout.write(t.as_short_text())
 
2941
        finally:
 
2942
            b.unlock()
 
2943
 
 
2944
 
 
2945
class cmd_annotate(Command):
 
2946
    """Show the origin of each line in a file.
 
2947
 
 
2948
    This prints out the given file with an annotation on the left side
 
2949
    indicating which revision, author and date introduced the change.
 
2950
 
 
2951
    If the origin is the same for a run of consecutive lines, it is 
 
2952
    shown only at the top, unless the --all option is given.
 
2953
    """
 
2954
    # TODO: annotate directories; showing when each file was last changed
 
2955
    # TODO: if the working copy is modified, show annotations on that 
 
2956
    #       with new uncommitted lines marked
 
2957
    aliases = ['ann', 'blame', 'praise']
 
2958
    takes_args = ['filename']
 
2959
    takes_options = [Option('all', help='show annotations on all lines'),
 
2960
                     Option('long', help='show date in annotations'),
 
2961
                     'revision',
 
2962
                     'show-ids',
 
2963
                     ]
 
2964
 
 
2965
    @display_command
 
2966
    def run(self, filename, all=False, long=False, revision=None,
 
2967
            show_ids=False):
 
2968
        from bzrlib.annotate import annotate_file
 
2969
        tree, relpath = WorkingTree.open_containing(filename)
 
2970
        branch = tree.branch
 
2971
        branch.lock_read()
 
2972
        try:
 
2973
            if revision is None:
 
2974
                revision_id = branch.last_revision()
 
2975
            elif len(revision) != 1:
 
2976
                raise errors.BzrCommandError('bzr annotate --revision takes exactly 1 argument')
 
2977
            else:
 
2978
                revision_id = revision[0].in_history(branch).rev_id
 
2979
            file_id = tree.path2id(relpath)
 
2980
            tree = branch.repository.revision_tree(revision_id)
 
2981
            file_version = tree.inventory[file_id].revision
 
2982
            annotate_file(branch, file_version, file_id, long, all, sys.stdout,
 
2983
                          show_ids=show_ids)
 
2984
        finally:
 
2985
            branch.unlock()
 
2986
 
 
2987
 
 
2988
class cmd_re_sign(Command):
 
2989
    """Create a digital signature for an existing revision."""
 
2990
    # TODO be able to replace existing ones.
 
2991
 
 
2992
    hidden = True # is this right ?
 
2993
    takes_args = ['revision_id*']
 
2994
    takes_options = ['revision']
 
2995
    
 
2996
    def run(self, revision_id_list=None, revision=None):
 
2997
        import bzrlib.gpg as gpg
 
2998
        if revision_id_list is not None and revision is not None:
 
2999
            raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
 
3000
        if revision_id_list is None and revision is None:
 
3001
            raise errors.BzrCommandError('You must supply either --revision or a revision_id')
 
3002
        b = WorkingTree.open_containing(u'.')[0].branch
 
3003
        gpg_strategy = gpg.GPGStrategy(b.get_config())
 
3004
        if revision_id_list is not None:
 
3005
            for revision_id in revision_id_list:
 
3006
                b.repository.sign_revision(revision_id, gpg_strategy)
 
3007
        elif revision is not None:
 
3008
            if len(revision) == 1:
 
3009
                revno, rev_id = revision[0].in_history(b)
 
3010
                b.repository.sign_revision(rev_id, gpg_strategy)
 
3011
            elif len(revision) == 2:
 
3012
                # are they both on rh- if so we can walk between them
 
3013
                # might be nice to have a range helper for arbitrary
 
3014
                # revision paths. hmm.
 
3015
                from_revno, from_revid = revision[0].in_history(b)
 
3016
                to_revno, to_revid = revision[1].in_history(b)
 
3017
                if to_revid is None:
 
3018
                    to_revno = b.revno()
 
3019
                if from_revno is None or to_revno is None:
 
3020
                    raise errors.BzrCommandError('Cannot sign a range of non-revision-history revisions')
 
3021
                for revno in range(from_revno, to_revno + 1):
 
3022
                    b.repository.sign_revision(b.get_rev_id(revno), 
 
3023
                                               gpg_strategy)
 
3024
            else:
 
3025
                raise errors.BzrCommandError('Please supply either one revision, or a range.')
 
3026
 
 
3027
 
 
3028
class cmd_bind(Command):
 
3029
    """Convert the current branch into a checkout of the supplied branch.
 
3030
 
 
3031
    Once converted into a checkout, commits must succeed on the master branch
 
3032
    before they will be applied to the local branch.
 
3033
 
 
3034
    See "help checkouts" for more information on checkouts.
 
3035
    """
 
3036
 
 
3037
    takes_args = ['location?']
 
3038
    takes_options = []
 
3039
 
 
3040
    def run(self, location=None):
 
3041
        b, relpath = Branch.open_containing(u'.')
 
3042
        if location is None:
 
3043
            try:
 
3044
                location = b.get_old_bound_location()
 
3045
            except errors.UpgradeRequired:
 
3046
                raise errors.BzrCommandError('No location supplied.  '
 
3047
                    'This format does not remember old locations.')
 
3048
            else:
 
3049
                if location is None:
 
3050
                    raise errors.BzrCommandError('No location supplied and no '
 
3051
                        'previous location known')
 
3052
        b_other = Branch.open(location)
 
3053
        try:
 
3054
            b.bind(b_other)
 
3055
        except errors.DivergedBranches:
 
3056
            raise errors.BzrCommandError('These branches have diverged.'
 
3057
                                         ' Try merging, and then bind again.')
 
3058
 
 
3059
 
 
3060
class cmd_unbind(Command):
 
3061
    """Convert the current checkout into a regular branch.
 
3062
 
 
3063
    After unbinding, the local branch is considered independent and subsequent
 
3064
    commits will be local only.
 
3065
 
 
3066
    See "help checkouts" for more information on checkouts.
 
3067
    """
 
3068
 
 
3069
    takes_args = []
 
3070
    takes_options = []
 
3071
 
 
3072
    def run(self):
 
3073
        b, relpath = Branch.open_containing(u'.')
 
3074
        if not b.unbind():
 
3075
            raise errors.BzrCommandError('Local branch is not bound')
 
3076
 
 
3077
 
 
3078
class cmd_uncommit(Command):
 
3079
    """Remove the last committed revision.
 
3080
 
 
3081
    --verbose will print out what is being removed.
 
3082
    --dry-run will go through all the motions, but not actually
 
3083
    remove anything.
 
3084
    
 
3085
    In the future, uncommit will create a revision bundle, which can then
 
3086
    be re-applied.
 
3087
    """
 
3088
 
 
3089
    # TODO: jam 20060108 Add an option to allow uncommit to remove
 
3090
    # unreferenced information in 'branch-as-repository' branches.
 
3091
    # TODO: jam 20060108 Add the ability for uncommit to remove unreferenced
 
3092
    # information in shared branches as well.
 
3093
    takes_options = ['verbose', 'revision',
 
3094
                    Option('dry-run', help='Don\'t actually make changes'),
 
3095
                    Option('force', help='Say yes to all questions.')]
 
3096
    takes_args = ['location?']
 
3097
    aliases = []
 
3098
 
 
3099
    def run(self, location=None,
 
3100
            dry_run=False, verbose=False,
 
3101
            revision=None, force=False):
 
3102
        from bzrlib.log import log_formatter, show_log
 
3103
        import sys
 
3104
        from bzrlib.uncommit import uncommit
 
3105
 
 
3106
        if location is None:
 
3107
            location = u'.'
 
3108
        control, relpath = bzrdir.BzrDir.open_containing(location)
 
3109
        try:
 
3110
            tree = control.open_workingtree()
 
3111
            b = tree.branch
 
3112
        except (errors.NoWorkingTree, errors.NotLocalUrl):
 
3113
            tree = None
 
3114
            b = control.open_branch()
 
3115
 
 
3116
        rev_id = None
 
3117
        if revision is None:
 
3118
            revno = b.revno()
 
3119
        else:
 
3120
            # 'bzr uncommit -r 10' actually means uncommit
 
3121
            # so that the final tree is at revno 10.
 
3122
            # but bzrlib.uncommit.uncommit() actually uncommits
 
3123
            # the revisions that are supplied.
 
3124
            # So we need to offset it by one
 
3125
            revno = revision[0].in_history(b).revno+1
 
3126
 
 
3127
        if revno <= b.revno():
 
3128
            rev_id = b.get_rev_id(revno)
 
3129
        if rev_id is None:
 
3130
            self.outf.write('No revisions to uncommit.\n')
 
3131
            return 1
 
3132
 
 
3133
        lf = log_formatter('short',
 
3134
                           to_file=self.outf,
 
3135
                           show_timezone='original')
 
3136
 
 
3137
        show_log(b,
 
3138
                 lf,
 
3139
                 verbose=False,
 
3140
                 direction='forward',
 
3141
                 start_revision=revno,
 
3142
                 end_revision=b.revno())
 
3143
 
 
3144
        if dry_run:
 
3145
            print 'Dry-run, pretending to remove the above revisions.'
 
3146
            if not force:
 
3147
                val = raw_input('Press <enter> to continue')
 
3148
        else:
 
3149
            print 'The above revision(s) will be removed.'
 
3150
            if not force:
 
3151
                val = raw_input('Are you sure [y/N]? ')
 
3152
                if val.lower() not in ('y', 'yes'):
 
3153
                    print 'Canceled'
 
3154
                    return 0
 
3155
 
 
3156
        uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
 
3157
                revno=revno)
 
3158
 
 
3159
 
 
3160
class cmd_break_lock(Command):
 
3161
    """Break a dead lock on a repository, branch or working directory.
 
3162
 
 
3163
    CAUTION: Locks should only be broken when you are sure that the process
 
3164
    holding the lock has been stopped.
 
3165
 
 
3166
    You can get information on what locks are open via the 'bzr info' command.
 
3167
    
 
3168
    example:
 
3169
        bzr break-lock
 
3170
    """
 
3171
    takes_args = ['location?']
 
3172
 
 
3173
    def run(self, location=None, show=False):
 
3174
        if location is None:
 
3175
            location = u'.'
 
3176
        control, relpath = bzrdir.BzrDir.open_containing(location)
 
3177
        try:
 
3178
            control.break_lock()
 
3179
        except NotImplementedError:
 
3180
            pass
 
3181
        
 
3182
 
 
3183
class cmd_wait_until_signalled(Command):
 
3184
    """Test helper for test_start_and_stop_bzr_subprocess_send_signal.
 
3185
 
 
3186
    This just prints a line to signal when it is ready, then blocks on stdin.
 
3187
    """
 
3188
 
 
3189
    hidden = True
 
3190
 
 
3191
    def run(self):
 
3192
        sys.stdout.write("running\n")
 
3193
        sys.stdout.flush()
 
3194
        sys.stdin.readline()
 
3195
 
 
3196
 
 
3197
class cmd_serve(Command):
 
3198
    """Run the bzr server."""
 
3199
 
 
3200
    aliases = ['server']
 
3201
 
 
3202
    takes_options = [
 
3203
        Option('inet',
 
3204
               help='serve on stdin/out for use from inetd or sshd'),
 
3205
        Option('port',
 
3206
               help='listen for connections on nominated port of the form '
 
3207
                    '[hostname:]portnumber. Passing 0 as the port number will '
 
3208
                    'result in a dynamically allocated port. Default port is '
 
3209
                    '4155.',
 
3210
               type=str),
 
3211
        Option('directory',
 
3212
               help='serve contents of directory',
 
3213
               type=unicode),
 
3214
        Option('allow-writes',
 
3215
               help='By default the server is a readonly server. Supplying '
 
3216
                    '--allow-writes enables write access to the contents of '
 
3217
                    'the served directory and below. '
 
3218
                ),
 
3219
        ]
 
3220
 
 
3221
    def run(self, port=None, inet=False, directory=None, allow_writes=False):
 
3222
        from bzrlib.transport import smart
 
3223
        from bzrlib.transport import get_transport
 
3224
        if directory is None:
 
3225
            directory = os.getcwd()
 
3226
        url = urlutils.local_path_to_url(directory)
 
3227
        if not allow_writes:
 
3228
            url = 'readonly+' + url
 
3229
        t = get_transport(url)
 
3230
        if inet:
 
3231
            server = smart.SmartServerPipeStreamMedium(sys.stdin, sys.stdout, t)
 
3232
        else:
 
3233
            if port is None:
 
3234
                port = smart.BZR_DEFAULT_PORT
 
3235
                host = '127.0.0.1'
 
3236
            else:
 
3237
                if ':' in port:
 
3238
                    host, port = port.split(':')
 
3239
                else:
 
3240
                    host = '127.0.0.1'
 
3241
                port = int(port)
 
3242
            server = smart.SmartTCPServer(t, host=host, port=port)
 
3243
            print 'listening on port: ', server.port
 
3244
            sys.stdout.flush()
 
3245
        server.serve()
 
3246
 
 
3247
class cmd_join(Command):
 
3248
    """Combine a subtree into its containing tree.
 
3249
    
 
3250
    This command is for experimental use only.  It requires the target tree
 
3251
    to be in dirstate-with-subtree format, which cannot be converted into
 
3252
    earlier formats.
 
3253
 
 
3254
    The TREE argument should be an independent tree, inside another tree, but
 
3255
    not part of it.  (Such trees can be produced by "bzr split", but also by
 
3256
    running "bzr branch" with the target inside a tree.)
 
3257
 
 
3258
    The result is a combined tree, with the subtree no longer an independant
 
3259
    part.  This is marked as a merge of the subtree into the containing tree,
 
3260
    and all history is preserved.
 
3261
 
 
3262
    If --reference is specified, the subtree retains its independence.  It can
 
3263
    be branched by itself, and can be part of multiple projects at the same
 
3264
    time.  But operations performed in the containing tree, such as commit
 
3265
    and merge, will recurse into the subtree.
 
3266
    """
 
3267
 
 
3268
    takes_args = ['tree']
 
3269
    takes_options = [Option('reference', 'join by reference')]
 
3270
    hidden = True
 
3271
 
 
3272
    def run(self, tree, reference=False):
 
3273
        sub_tree = WorkingTree.open(tree)
 
3274
        parent_dir = osutils.dirname(sub_tree.basedir)
 
3275
        containing_tree = WorkingTree.open_containing(parent_dir)[0]
 
3276
        repo = containing_tree.branch.repository
 
3277
        if not repo.supports_rich_root():
 
3278
            raise errors.BzrCommandError(
 
3279
                "Can't join trees because %s doesn't support rich root data.\n"
 
3280
                "You can use bzr upgrade on the repository."
 
3281
                % (repo,))
 
3282
        if reference:
 
3283
            try:
 
3284
                containing_tree.add_reference(sub_tree)
 
3285
            except errors.BadReferenceTarget, e:
 
3286
                # XXX: Would be better to just raise a nicely printable
 
3287
                # exception from the real origin.  Also below.  mbp 20070306
 
3288
                raise errors.BzrCommandError("Cannot join %s.  %s" %
 
3289
                                             (tree, e.reason))
 
3290
        else:
 
3291
            try:
 
3292
                containing_tree.subsume(sub_tree)
 
3293
            except errors.BadSubsumeSource, e:
 
3294
                raise errors.BzrCommandError("Cannot join %s.  %s" % 
 
3295
                                             (tree, e.reason))
 
3296
 
 
3297
 
 
3298
class cmd_split(Command):
 
3299
    """Split a tree into two trees.
 
3300
 
 
3301
    This command is for experimental use only.  It requires the target tree
 
3302
    to be in dirstate-with-subtree format, which cannot be converted into
 
3303
    earlier formats.
 
3304
 
 
3305
    The TREE argument should be a subdirectory of a working tree.  That
 
3306
    subdirectory will be converted into an independent tree, with its own
 
3307
    branch.  Commits in the top-level tree will not apply to the new subtree.
 
3308
    If you want that behavior, do "bzr join --reference TREE".
 
3309
 
 
3310
    To undo this operation, do "bzr join TREE".
 
3311
    """
 
3312
 
 
3313
    takes_args = ['tree']
 
3314
 
 
3315
    hidden = True
 
3316
 
 
3317
    def run(self, tree):
 
3318
        containing_tree, subdir = WorkingTree.open_containing(tree)
 
3319
        sub_id = containing_tree.path2id(subdir)
 
3320
        if sub_id is None:
 
3321
            raise errors.NotVersionedError(subdir)
 
3322
        try:
 
3323
            containing_tree.extract(sub_id)
 
3324
        except errors.RootNotRich:
 
3325
            raise errors.UpgradeRequired(containing_tree.branch.base)
 
3326
 
 
3327
 
 
3328
 
 
3329
class cmd_merge_directive(Command):
 
3330
    """Generate a merge directive for auto-merge tools.
 
3331
 
 
3332
    A directive requests a merge to be performed, and also provides all the
 
3333
    information necessary to do so.  This means it must either include a
 
3334
    revision bundle, or the location of a branch containing the desired
 
3335
    revision.
 
3336
 
 
3337
    A submit branch (the location to merge into) must be supplied the first
 
3338
    time the command is issued.  After it has been supplied once, it will
 
3339
    be remembered as the default.
 
3340
 
 
3341
    A public branch is optional if a revision bundle is supplied, but required
 
3342
    if --diff or --plain is specified.  It will be remembered as the default
 
3343
    after the first use.
 
3344
    """
 
3345
 
 
3346
    takes_args = ['submit_branch?', 'public_branch?']
 
3347
 
 
3348
    takes_options = [
 
3349
        RegistryOption.from_kwargs('patch-type',
 
3350
            'The type of patch to include in the directive',
 
3351
            title='Patch type', value_switches=True, enum_switch=False,
 
3352
            bundle='Bazaar revision bundle (default)',
 
3353
            diff='Normal unified diff',
 
3354
            plain='No patch, just directive'),
 
3355
        Option('sign', help='GPG-sign the directive'), 'revision',
 
3356
        Option('mail-to', type=str,
 
3357
            help='Instead of printing the directive, email to this address'),
 
3358
        Option('message', type=str, short_name='m',
 
3359
            help='Message to use when committing this merge')
 
3360
        ]
 
3361
 
 
3362
    def run(self, submit_branch=None, public_branch=None, patch_type='bundle',
 
3363
            sign=False, revision=None, mail_to=None, message=None):
 
3364
        if patch_type == 'plain':
 
3365
            patch_type = None
 
3366
        branch = Branch.open('.')
 
3367
        stored_submit_branch = branch.get_submit_branch()
 
3368
        if submit_branch is None:
 
3369
            submit_branch = stored_submit_branch
 
3370
        else:
 
3371
            if stored_submit_branch is None:
 
3372
                branch.set_submit_branch(submit_branch)
 
3373
        if submit_branch is None:
 
3374
            submit_branch = branch.get_parent()
 
3375
        if submit_branch is None:
 
3376
            raise errors.BzrCommandError('No submit branch specified or known')
 
3377
 
 
3378
        stored_public_branch = branch.get_public_branch()
 
3379
        if public_branch is None:
 
3380
            public_branch = stored_public_branch
 
3381
        elif stored_public_branch is None:
 
3382
            branch.set_public_branch(public_branch)
 
3383
        if patch_type != "bundle" and public_branch is None:
 
3384
            raise errors.BzrCommandError('No public branch specified or'
 
3385
                                         ' known')
 
3386
        if revision is not None:
 
3387
            if len(revision) != 1:
 
3388
                raise errors.BzrCommandError('bzr merge-directive takes '
 
3389
                    'exactly one revision identifier')
 
3390
            else:
 
3391
                revision_id = revision[0].in_history(branch).rev_id
 
3392
        else:
 
3393
            revision_id = branch.last_revision()
 
3394
        directive = merge_directive.MergeDirective.from_objects(
 
3395
            branch.repository, revision_id, time.time(),
 
3396
            osutils.local_time_offset(), submit_branch,
 
3397
            public_branch=public_branch, patch_type=patch_type,
 
3398
            message=message)
 
3399
        if mail_to is None:
 
3400
            if sign:
 
3401
                self.outf.write(directive.to_signed(branch))
 
3402
            else:
 
3403
                self.outf.writelines(directive.to_lines())
 
3404
        else:
 
3405
            message = directive.to_email(mail_to, branch, sign)
 
3406
            s = smtplib.SMTP()
 
3407
            server = branch.get_config().get_user_option('smtp_server')
 
3408
            if not server:
 
3409
                server = 'localhost'
 
3410
            s.connect()
 
3411
            s.sendmail(message['From'], message['To'], message.as_string())
 
3412
 
 
3413
 
 
3414
class cmd_tag(Command):
 
3415
    """Create a tag naming a revision.
 
3416
    
 
3417
    Tags give human-meaningful names to revisions.  Commands that take a -r
 
3418
    (--revision) option can be given -rtag:X, where X is any previously
 
3419
    created tag.
 
3420
 
 
3421
    Tags are stored in the branch.  Tags are copied from one branch to another
 
3422
    along when you branch, push, pull or merge.
 
3423
 
 
3424
    It is an error to give a tag name that already exists unless you pass 
 
3425
    --force, in which case the tag is moved to point to the new revision.
 
3426
    """
 
3427
 
 
3428
    takes_args = ['tag_name']
 
3429
    takes_options = [
 
3430
        Option('delete',
 
3431
            help='Delete this tag rather than placing it.',
 
3432
            ),
 
3433
        Option('directory',
 
3434
            help='Branch in which to place the tag.',
 
3435
            short_name='d',
 
3436
            type=unicode,
 
3437
            ),
 
3438
        Option('force',
 
3439
            help='Replace existing tags',
 
3440
            ),
 
3441
        'revision',
 
3442
        ]
 
3443
 
 
3444
    def run(self, tag_name,
 
3445
            delete=None,
 
3446
            directory='.',
 
3447
            force=None,
 
3448
            revision=None,
 
3449
            ):
 
3450
        branch, relpath = Branch.open_containing(directory)
 
3451
        branch.lock_write()
 
3452
        try:
 
3453
            if delete:
 
3454
                branch.tags.delete_tag(tag_name)
 
3455
                self.outf.write('Deleted tag %s.\n' % tag_name)
 
3456
            else:
 
3457
                if revision:
 
3458
                    if len(revision) != 1:
 
3459
                        raise errors.BzrCommandError(
 
3460
                            "Tags can only be placed on a single revision, "
 
3461
                            "not on a range")
 
3462
                    revision_id = revision[0].in_history(branch).rev_id
 
3463
                else:
 
3464
                    revision_id = branch.last_revision()
 
3465
                if (not force) and branch.tags.has_tag(tag_name):
 
3466
                    raise errors.TagAlreadyExists(tag_name)
 
3467
                branch.tags.set_tag(tag_name, revision_id)
 
3468
                self.outf.write('Created tag %s.\n' % tag_name)
 
3469
        finally:
 
3470
            branch.unlock()
 
3471
 
 
3472
 
 
3473
class cmd_tags(Command):
 
3474
    """List tags.
 
3475
 
 
3476
    This tag shows a table of tag names and the revisions they reference.
 
3477
    """
 
3478
 
 
3479
    takes_options = [
 
3480
        Option('directory',
 
3481
            help='Branch whose tags should be displayed',
 
3482
            short_name='d',
 
3483
            type=unicode,
 
3484
            ),
 
3485
    ]
 
3486
 
 
3487
    @display_command
 
3488
    def run(self,
 
3489
            directory='.',
 
3490
            ):
 
3491
        branch, relpath = Branch.open_containing(directory)
 
3492
        for tag_name, target in sorted(branch.tags.get_tag_dict().items()):
 
3493
            self.outf.write('%-20s %s\n' % (tag_name, target))
 
3494
 
 
3495
 
 
3496
# command-line interpretation helper for merge-related commands
 
3497
def _merge_helper(other_revision, base_revision,
 
3498
                  check_clean=True, ignore_zero=False,
 
3499
                  this_dir=None, backup_files=False,
 
3500
                  merge_type=None,
 
3501
                  file_list=None, show_base=False, reprocess=False,
 
3502
                  pull=False,
 
3503
                  pb=DummyProgress(),
 
3504
                  change_reporter=None):
 
3505
    """Merge changes into a tree.
 
3506
 
 
3507
    base_revision
 
3508
        list(path, revno) Base for three-way merge.  
 
3509
        If [None, None] then a base will be automatically determined.
 
3510
    other_revision
 
3511
        list(path, revno) Other revision for three-way merge.
 
3512
    this_dir
 
3513
        Directory to merge changes into; '.' by default.
 
3514
    check_clean
 
3515
        If true, this_dir must have no uncommitted changes before the
 
3516
        merge begins.
 
3517
    ignore_zero - If true, suppress the "zero conflicts" message when 
 
3518
        there are no conflicts; should be set when doing something we expect
 
3519
        to complete perfectly.
 
3520
    file_list - If supplied, merge only changes to selected files.
 
3521
 
 
3522
    All available ancestors of other_revision and base_revision are
 
3523
    automatically pulled into the branch.
 
3524
 
 
3525
    The revno may be -1 to indicate the last revision on the branch, which is
 
3526
    the typical case.
 
3527
 
 
3528
    This function is intended for use from the command line; programmatic
 
3529
    clients might prefer to call merge.merge_inner(), which has less magic 
 
3530
    behavior.
 
3531
    """
 
3532
    # Loading it late, so that we don't always have to import bzrlib.merge
 
3533
    if merge_type is None:
 
3534
        merge_type = _mod_merge.Merge3Merger
 
3535
    if this_dir is None:
 
3536
        this_dir = u'.'
 
3537
    this_tree = WorkingTree.open_containing(this_dir)[0]
 
3538
    if show_base and not merge_type is _mod_merge.Merge3Merger:
 
3539
        raise errors.BzrCommandError("Show-base is not supported for this merge"
 
3540
                                     " type. %s" % merge_type)
 
3541
    if reprocess and not merge_type.supports_reprocess:
 
3542
        raise errors.BzrCommandError("Conflict reduction is not supported for merge"
 
3543
                                     " type %s." % merge_type)
 
3544
    if reprocess and show_base:
 
3545
        raise errors.BzrCommandError("Cannot do conflict reduction and show base.")
 
3546
    # TODO: jam 20070226 We should really lock these trees earlier. However, we
 
3547
    #       only want to take out a lock_tree_write() if we don't have to pull
 
3548
    #       any ancestry. But merge might fetch ancestry in the middle, in
 
3549
    #       which case we would need a lock_write().
 
3550
    #       Because we cannot upgrade locks, for now we live with the fact that
 
3551
    #       the tree will be locked multiple times during a merge. (Maybe
 
3552
    #       read-only some of the time, but it means things will get read
 
3553
    #       multiple times.)
 
3554
    try:
 
3555
        merger = _mod_merge.Merger(this_tree.branch, this_tree=this_tree,
 
3556
                                   pb=pb, change_reporter=change_reporter)
 
3557
        merger.pp = ProgressPhase("Merge phase", 5, pb)
 
3558
        merger.pp.next_phase()
 
3559
        merger.check_basis(check_clean)
 
3560
        merger.set_other(other_revision)
 
3561
        merger.pp.next_phase()
 
3562
        merger.set_base(base_revision)
 
3563
        if merger.base_rev_id == merger.other_rev_id:
 
3564
            note('Nothing to do.')
 
3565
            return 0
 
3566
        if file_list is None:
 
3567
            if pull and merger.base_rev_id == merger.this_rev_id:
 
3568
                # FIXME: deduplicate with pull
 
3569
                result = merger.this_tree.pull(merger.this_branch,
 
3570
                        False, merger.other_rev_id)
 
3571
                if result.old_revid == result.new_revid:
 
3572
                    note('No revisions to pull.')
 
3573
                else:
 
3574
                    note('Now on revision %d.' % result.new_revno)
 
3575
                return 0
 
3576
        merger.backup_files = backup_files
 
3577
        merger.merge_type = merge_type 
 
3578
        merger.set_interesting_files(file_list)
 
3579
        merger.show_base = show_base 
 
3580
        merger.reprocess = reprocess
 
3581
        conflicts = merger.do_merge()
 
3582
        if file_list is None:
 
3583
            merger.set_pending()
 
3584
    finally:
 
3585
        pb.clear()
 
3586
    return conflicts
 
3587
 
 
3588
 
 
3589
# Compatibility
 
3590
merge = _merge_helper
 
3591
 
 
3592
 
 
3593
# these get imported and then picked up by the scan for cmd_*
 
3594
# TODO: Some more consistent way to split command definitions across files;
 
3595
# we do need to load at least some information about them to know of 
 
3596
# aliases.  ideally we would avoid loading the implementation until the
 
3597
# details were needed.
 
3598
from bzrlib.cmd_version_info import cmd_version_info
 
3599
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore
 
3600
from bzrlib.bundle.commands import cmd_bundle_revisions
 
3601
from bzrlib.sign_my_commits import cmd_sign_my_commits
 
3602
from bzrlib.weave_commands import cmd_weave_list, cmd_weave_join, \
 
3603
        cmd_weave_plan_merge, cmd_weave_merge_text