/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: 2006-11-28 06:26:25 UTC
  • mto: This revision was merged to the branch mainline in revision 2162.
  • Revision ID: aaron.bentley@utoronto.ca-20061128062625-qht3d2a686fzo7xc
Use inventory for comparison, to avoid unwanted stats

Show diffs side-by-side

added added

removed removed

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