/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: Ian Clatworthy
  • Date: 2007-06-06 14:06:14 UTC
  • mto: This revision was merged to the branch mainline in revision 2520.
  • Revision ID: ian.clatworthy@internode.on.net-20070606140614-yp66v5i1gm5kruqp
Fixes #115491 - 'branch lp:projname' now creates ./projname as exected

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