/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: Aaron Bentley
  • Date: 2007-03-16 17:47:16 UTC
  • mto: This revision was merged to the branch mainline in revision 2389.
  • Revision ID: abentley@panoramicfeedback.com-20070316174716-0se6k7b4sqr9t12d
test suite fixes

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