/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: Robert Collins
  • Date: 2007-03-30 02:36:36 UTC
  • mto: This revision was merged to the branch mainline in revision 2388.
  • Revision ID: robertc@robertcollins.net-20070330023636-v6k82rwz5isl6k3a
Remove the --basis parameter to clone etc. (Robert Collins)

Show diffs side-by-side

added added

removed removed

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