~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/builtins.py

  • Committer: Andrew Bennetts
  • Date: 2009-02-11 09:45:27 UTC
  • mto: This revision was merged to the branch mainline in revision 4002.
  • Revision ID: andrew.bennetts@canonical.com-20090211094527-pdtj25e4748c2h67
Fix the do_body NotImplementedError log spam.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005-2010 Canonical Ltd
 
1
# Copyright (C) 2004, 2005, 2006, 2007, 2008, 2009 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
17
17
"""builtin bzr commands"""
18
18
 
31
31
    bundle,
32
32
    btree_index,
33
33
    bzrdir,
34
 
    directory_service,
35
34
    delta,
36
35
    config,
37
36
    errors,
38
37
    globbing,
39
 
    hooks,
40
38
    log,
41
39
    merge as _mod_merge,
42
40
    merge_directive,
43
41
    osutils,
44
42
    reconfigure,
45
 
    rename_map,
46
43
    revision as _mod_revision,
47
 
    static_tuple,
48
44
    symbol_versioning,
49
 
    timestamp,
50
45
    transport,
 
46
    tree as _mod_tree,
51
47
    ui,
52
48
    urlutils,
53
 
    views,
54
49
    )
55
50
from bzrlib.branch import Branch
56
51
from bzrlib.conflicts import ConflictList
57
 
from bzrlib.transport import memory
58
52
from bzrlib.revisionspec import RevisionSpec, RevisionInfo
59
53
from bzrlib.smtp_connection import SMTPConnection
60
54
from bzrlib.workingtree import WorkingTree
61
55
""")
62
56
 
63
 
from bzrlib.commands import (
64
 
    Command,
65
 
    builtin_command_registry,
66
 
    display_command,
67
 
    )
 
57
from bzrlib.commands import Command, display_command
68
58
from bzrlib.option import (
69
59
    ListOption,
70
60
    Option,
75
65
from bzrlib.trace import mutter, note, warning, is_quiet, get_verbosity_level
76
66
 
77
67
 
78
 
def tree_files(file_list, default_branch=u'.', canonicalize=True,
79
 
    apply_view=True):
 
68
def tree_files(file_list, default_branch=u'.', canonicalize=True):
80
69
    try:
81
 
        return internal_tree_files(file_list, default_branch, canonicalize,
82
 
            apply_view)
 
70
        return internal_tree_files(file_list, default_branch, canonicalize)
83
71
    except errors.FileInWrongBranch, e:
84
72
        raise errors.BzrCommandError("%s is not in the same branch as %s" %
85
73
                                     (e.path, file_list[0]))
86
74
 
87
75
 
88
 
def tree_files_for_add(file_list):
89
 
    """
90
 
    Return a tree and list of absolute paths from a file list.
91
 
 
92
 
    Similar to tree_files, but add handles files a bit differently, so it a
93
 
    custom implementation.  In particular, MutableTreeTree.smart_add expects
94
 
    absolute paths, which it immediately converts to relative paths.
95
 
    """
96
 
    # FIXME Would be nice to just return the relative paths like
97
 
    # internal_tree_files does, but there are a large number of unit tests
98
 
    # that assume the current interface to mutabletree.smart_add
99
 
    if file_list:
100
 
        tree, relpath = WorkingTree.open_containing(file_list[0])
101
 
        if tree.supports_views():
102
 
            view_files = tree.views.lookup_view()
103
 
            if view_files:
104
 
                for filename in file_list:
105
 
                    if not osutils.is_inside_any(view_files, filename):
106
 
                        raise errors.FileOutsideView(filename, view_files)
107
 
        file_list = file_list[:]
108
 
        file_list[0] = tree.abspath(relpath)
109
 
    else:
110
 
        tree = WorkingTree.open_containing(u'.')[0]
111
 
        if tree.supports_views():
112
 
            view_files = tree.views.lookup_view()
113
 
            if view_files:
114
 
                file_list = view_files
115
 
                view_str = views.view_display_str(view_files)
116
 
                note("Ignoring files outside view. View is %s" % view_str)
117
 
    return tree, file_list
118
 
 
119
 
 
120
 
def _get_one_revision(command_name, revisions):
121
 
    if revisions is None:
122
 
        return None
123
 
    if len(revisions) != 1:
124
 
        raise errors.BzrCommandError(
125
 
            'bzr %s --revision takes exactly one revision identifier' % (
126
 
                command_name,))
127
 
    return revisions[0]
128
 
 
129
 
 
130
76
def _get_one_revision_tree(command_name, revisions, branch=None, tree=None):
131
 
    """Get a revision tree. Not suitable for commands that change the tree.
132
 
    
133
 
    Specifically, the basis tree in dirstate trees is coupled to the dirstate
134
 
    and doing a commit/uncommit/pull will at best fail due to changing the
135
 
    basis revision data.
136
 
 
137
 
    If tree is passed in, it should be already locked, for lifetime management
138
 
    of the trees internal cached state.
139
 
    """
140
77
    if branch is None:
141
78
        branch = tree.branch
142
79
    if revisions is None:
145
82
        else:
146
83
            rev_tree = branch.basis_tree()
147
84
    else:
148
 
        revision = _get_one_revision(command_name, revisions)
149
 
        rev_tree = revision.as_tree(branch)
 
85
        if len(revisions) != 1:
 
86
            raise errors.BzrCommandError(
 
87
                'bzr %s --revision takes exactly one revision identifier' % (
 
88
                    command_name,))
 
89
        rev_tree = revisions[0].as_tree(branch)
150
90
    return rev_tree
151
91
 
152
92
 
153
93
# XXX: Bad function name; should possibly also be a class method of
154
94
# WorkingTree rather than a function.
155
 
def internal_tree_files(file_list, default_branch=u'.', canonicalize=True,
156
 
    apply_view=True):
 
95
def internal_tree_files(file_list, default_branch=u'.', canonicalize=True):
157
96
    """Convert command-line paths to a WorkingTree and relative paths.
158
97
 
159
98
    This is typically used for command-line processors that take one or
161
100
 
162
101
    The filenames given are not required to exist.
163
102
 
164
 
    :param file_list: Filenames to convert.
 
103
    :param file_list: Filenames to convert.  
165
104
 
166
105
    :param default_branch: Fallback tree path to use if file_list is empty or
167
106
        None.
168
107
 
169
 
    :param apply_view: if True and a view is set, apply it or check that
170
 
        specified files are within it
171
 
 
172
108
    :return: workingtree, [relative_paths]
173
109
    """
174
110
    if file_list is None or len(file_list) == 0:
175
 
        tree = WorkingTree.open_containing(default_branch)[0]
176
 
        if tree.supports_views() and apply_view:
177
 
            view_files = tree.views.lookup_view()
178
 
            if view_files:
179
 
                file_list = view_files
180
 
                view_str = views.view_display_str(view_files)
181
 
                note("Ignoring files outside view. View is %s" % view_str)
182
 
        return tree, file_list
 
111
        return WorkingTree.open_containing(default_branch)[0], file_list
183
112
    tree = WorkingTree.open_containing(osutils.realpath(file_list[0]))[0]
184
 
    return tree, safe_relpath_files(tree, file_list, canonicalize,
185
 
        apply_view=apply_view)
186
 
 
187
 
 
188
 
def safe_relpath_files(tree, file_list, canonicalize=True, apply_view=True):
 
113
    return tree, safe_relpath_files(tree, file_list, canonicalize)
 
114
 
 
115
 
 
116
def safe_relpath_files(tree, file_list, canonicalize=True):
189
117
    """Convert file_list into a list of relpaths in tree.
190
118
 
191
119
    :param tree: A tree to operate on.
192
120
    :param file_list: A list of user provided paths or None.
193
 
    :param apply_view: if True and a view is set, apply it or check that
194
 
        specified files are within it
195
121
    :return: A list of relative paths.
196
122
    :raises errors.PathNotChild: When a provided path is in a different tree
197
123
        than tree.
198
124
    """
199
125
    if file_list is None:
200
126
        return None
201
 
    if tree.supports_views() and apply_view:
202
 
        view_files = tree.views.lookup_view()
203
 
    else:
204
 
        view_files = []
205
127
    new_list = []
206
128
    # tree.relpath exists as a "thunk" to osutils, but canonical_relpath
207
129
    # doesn't - fix that up here before we enter the loop.
211
133
        fixer = tree.relpath
212
134
    for filename in file_list:
213
135
        try:
214
 
            relpath = fixer(osutils.dereference_path(filename))
215
 
            if  view_files and not osutils.is_inside_any(view_files, relpath):
216
 
                raise errors.FileOutsideView(filename, view_files)
217
 
            new_list.append(relpath)
 
136
            new_list.append(fixer(osutils.dereference_path(filename)))
218
137
        except errors.PathNotChild:
219
138
            raise errors.FileInWrongBranch(tree.branch, filename)
220
139
    return new_list
221
140
 
222
141
 
223
 
def _get_view_info_for_change_reporter(tree):
224
 
    """Get the view information from a tree for change reporting."""
225
 
    view_info = None
226
 
    try:
227
 
        current_view = tree.views.get_view_info()[0]
228
 
        if current_view is not None:
229
 
            view_info = (current_view, tree.views.lookup_view())
230
 
    except errors.ViewsNotSupported:
231
 
        pass
232
 
    return view_info
233
 
 
234
 
 
235
142
# TODO: Make sure no commands unconditionally use the working directory as a
236
143
# branch.  If a filename argument is used, the first of them should be used to
237
144
# specify the branch.  (Perhaps this can be factored out into some kind of
239
146
# opens the branch?)
240
147
 
241
148
class cmd_status(Command):
242
 
    __doc__ = """Display status summary.
 
149
    """Display status summary.
243
150
 
244
151
    This reports on versioned and unknown files, reporting them
245
152
    grouped by state.  Possible states are:
265
172
    unknown
266
173
        Not versioned and not matching an ignore pattern.
267
174
 
268
 
    Additionally for directories, symlinks and files with an executable
269
 
    bit, Bazaar indicates their type using a trailing character: '/', '@'
270
 
    or '*' respectively.
271
 
 
272
175
    To see ignored files use 'bzr ignored'.  For details on the
273
176
    changes to file texts, use 'bzr diff'.
274
 
 
 
177
    
275
178
    Note that --short or -S gives status flags for each item, similar
276
179
    to Subversion's status command. To get output similar to svn -q,
277
180
    use bzr status -SV.
289
192
    If a revision argument is given, the status is calculated against
290
193
    that revision, or between two revisions if two are provided.
291
194
    """
292
 
 
 
195
    
293
196
    # TODO: --no-recurse, --recurse options
294
 
 
 
197
    
295
198
    takes_args = ['file*']
296
199
    takes_options = ['show-ids', 'revision', 'change', 'verbose',
297
200
                     Option('short', help='Use short status indicators.',
305
208
 
306
209
    encoding_type = 'replace'
307
210
    _see_also = ['diff', 'revert', 'status-flags']
308
 
 
 
211
    
309
212
    @display_command
310
213
    def run(self, show_ids=False, file_list=None, revision=None, short=False,
311
214
            versioned=False, no_pending=False, verbose=False):
332
235
 
333
236
 
334
237
class cmd_cat_revision(Command):
335
 
    __doc__ = """Write out metadata for a revision.
336
 
 
 
238
    """Write out metadata for a revision.
 
239
    
337
240
    The revision to print can either be specified by a specific
338
241
    revision identifier, or you can use --revision.
339
242
    """
343
246
    takes_options = ['revision']
344
247
    # cat-revision is more for frontends so should be exact
345
248
    encoding = 'strict'
346
 
 
347
 
    def print_revision(self, revisions, revid):
348
 
        stream = revisions.get_record_stream([(revid,)], 'unordered', True)
349
 
        record = stream.next()
350
 
        if record.storage_kind == 'absent':
351
 
            raise errors.NoSuchRevision(revisions, revid)
352
 
        revtext = record.get_bytes_as('fulltext')
353
 
        self.outf.write(revtext.decode('utf-8'))
354
 
 
 
249
    
355
250
    @display_command
356
251
    def run(self, revision_id=None, revision=None):
357
252
        if revision_id is not None and revision is not None:
362
257
                                         ' --revision or a revision_id')
363
258
        b = WorkingTree.open_containing(u'.')[0].branch
364
259
 
365
 
        revisions = b.repository.revisions
366
 
        if revisions is None:
367
 
            raise errors.BzrCommandError('Repository %r does not support '
368
 
                'access to raw revision texts')
 
260
        # TODO: jam 20060112 should cat-revision always output utf-8?
 
261
        if revision_id is not None:
 
262
            revision_id = osutils.safe_revision_id(revision_id, warn=False)
 
263
            try:
 
264
                self.outf.write(b.repository.get_revision_xml(revision_id).decode('utf-8'))
 
265
            except errors.NoSuchRevision:
 
266
                msg = "The repository %s contains no revision %s." % (b.repository.base,
 
267
                    revision_id)
 
268
                raise errors.BzrCommandError(msg)
 
269
        elif revision is not None:
 
270
            for rev in revision:
 
271
                if rev is None:
 
272
                    raise errors.BzrCommandError('You cannot specify a NULL'
 
273
                                                 ' revision.')
 
274
                rev_id = rev.as_revision_id(b)
 
275
                self.outf.write(b.repository.get_revision_xml(rev_id).decode('utf-8'))
369
276
 
370
 
        b.repository.lock_read()
371
 
        try:
372
 
            # TODO: jam 20060112 should cat-revision always output utf-8?
373
 
            if revision_id is not None:
374
 
                revision_id = osutils.safe_revision_id(revision_id, warn=False)
375
 
                try:
376
 
                    self.print_revision(revisions, revision_id)
377
 
                except errors.NoSuchRevision:
378
 
                    msg = "The repository %s contains no revision %s." % (
379
 
                        b.repository.base, revision_id)
380
 
                    raise errors.BzrCommandError(msg)
381
 
            elif revision is not None:
382
 
                for rev in revision:
383
 
                    if rev is None:
384
 
                        raise errors.BzrCommandError(
385
 
                            'You cannot specify a NULL revision.')
386
 
                    rev_id = rev.as_revision_id(b)
387
 
                    self.print_revision(revisions, rev_id)
388
 
        finally:
389
 
            b.repository.unlock()
390
 
        
391
277
 
392
278
class cmd_dump_btree(Command):
393
 
    __doc__ = """Dump the contents of a btree index file to stdout.
 
279
    """Dump the contents of a btree index file to stdout.
394
280
 
395
281
    PATH is a btree index file, it can be any URL. This includes things like
396
282
    .bzr/repository/pack-names, or .bzr/repository/indices/a34b3a...ca4a4.iix
460
346
        for node in bt.iter_all_entries():
461
347
            # Node is made up of:
462
348
            # (index, key, value, [references])
463
 
            try:
464
 
                refs = node[3]
465
 
            except IndexError:
466
 
                refs_as_tuples = None
467
 
            else:
468
 
                refs_as_tuples = static_tuple.as_tuples(refs)
469
 
            as_tuple = (tuple(node[1]), node[2], refs_as_tuples)
470
 
            self.outf.write('%s\n' % (as_tuple,))
 
349
            self.outf.write('%s\n' % (node[1:],))
471
350
 
472
351
 
473
352
class cmd_remove_tree(Command):
474
 
    __doc__ = """Remove the working tree from a given branch/checkout.
 
353
    """Remove the working tree from a given branch/checkout.
475
354
 
476
355
    Since a lightweight checkout is little more than a working tree
477
356
    this will refuse to run against one.
479
358
    To re-create the working tree, use "bzr checkout".
480
359
    """
481
360
    _see_also = ['checkout', 'working-trees']
482
 
    takes_args = ['location*']
 
361
    takes_args = ['location?']
483
362
    takes_options = [
484
363
        Option('force',
485
364
               help='Remove the working tree even if it has '
486
365
                    'uncommitted changes.'),
487
366
        ]
488
367
 
489
 
    def run(self, location_list, force=False):
490
 
        if not location_list:
491
 
            location_list=['.']
492
 
 
493
 
        for location in location_list:
494
 
            d = bzrdir.BzrDir.open(location)
495
 
            
496
 
            try:
497
 
                working = d.open_workingtree()
498
 
            except errors.NoWorkingTree:
499
 
                raise errors.BzrCommandError("No working tree to remove")
500
 
            except errors.NotLocalUrl:
501
 
                raise errors.BzrCommandError("You cannot remove the working tree"
502
 
                                             " of a remote path")
503
 
            if not force:
504
 
                if (working.has_changes()):
505
 
                    raise errors.UncommittedChanges(working)
506
 
 
507
 
            if working.user_url != working.branch.user_url:
508
 
                raise errors.BzrCommandError("You cannot remove the working tree"
509
 
                                             " from a lightweight checkout")
510
 
 
511
 
            d.destroy_workingtree()
512
 
 
 
368
    def run(self, location='.', force=False):
 
369
        d = bzrdir.BzrDir.open(location)
 
370
        
 
371
        try:
 
372
            working = d.open_workingtree()
 
373
        except errors.NoWorkingTree:
 
374
            raise errors.BzrCommandError("No working tree to remove")
 
375
        except errors.NotLocalUrl:
 
376
            raise errors.BzrCommandError("You cannot remove the working tree of a "
 
377
                                         "remote path")
 
378
        if not force:
 
379
            changes = working.changes_from(working.basis_tree())
 
380
            if changes.has_changed():
 
381
                raise errors.UncommittedChanges(working)
 
382
 
 
383
        working_path = working.bzrdir.root_transport.base
 
384
        branch_path = working.branch.bzrdir.root_transport.base
 
385
        if working_path != branch_path:
 
386
            raise errors.BzrCommandError("You cannot remove the working tree from "
 
387
                                         "a lightweight checkout")
 
388
        
 
389
        d.destroy_workingtree()
 
390
        
513
391
 
514
392
class cmd_revno(Command):
515
 
    __doc__ = """Show current revision number.
 
393
    """Show current revision number.
516
394
 
517
395
    This is equal to the number of revisions on this branch.
518
396
    """
519
397
 
520
398
    _see_also = ['info']
521
399
    takes_args = ['location?']
522
 
    takes_options = [
523
 
        Option('tree', help='Show revno of working tree'),
524
 
        ]
525
400
 
526
401
    @display_command
527
 
    def run(self, tree=False, location=u'.'):
528
 
        if tree:
529
 
            try:
530
 
                wt = WorkingTree.open_containing(location)[0]
531
 
                wt.lock_read()
532
 
            except (errors.NoWorkingTree, errors.NotLocalUrl):
533
 
                raise errors.NoWorkingTree(location)
534
 
            self.add_cleanup(wt.unlock)
535
 
            revid = wt.last_revision()
536
 
            try:
537
 
                revno_t = wt.branch.revision_id_to_dotted_revno(revid)
538
 
            except errors.NoSuchRevision:
539
 
                revno_t = ('???',)
540
 
            revno = ".".join(str(n) for n in revno_t)
541
 
        else:
542
 
            b = Branch.open_containing(location)[0]
543
 
            b.lock_read()
544
 
            self.add_cleanup(b.unlock)
545
 
            revno = b.revno()
546
 
        self.cleanup_now()
547
 
        self.outf.write(str(revno) + '\n')
 
402
    def run(self, location=u'.'):
 
403
        self.outf.write(str(Branch.open_containing(location)[0].revno()))
 
404
        self.outf.write('\n')
548
405
 
549
406
 
550
407
class cmd_revision_info(Command):
551
 
    __doc__ = """Show revision number and revision id for a given revision identifier.
 
408
    """Show revision number and revision id for a given revision identifier.
552
409
    """
553
410
    hidden = True
554
411
    takes_args = ['revision_info*']
560
417
            short_name='d',
561
418
            type=unicode,
562
419
            ),
563
 
        Option('tree', help='Show revno of working tree'),
564
420
        ]
565
421
 
566
422
    @display_command
567
 
    def run(self, revision=None, directory=u'.', tree=False,
568
 
            revision_info_list=[]):
 
423
    def run(self, revision=None, directory=u'.', revision_info_list=[]):
569
424
 
570
 
        try:
571
 
            wt = WorkingTree.open_containing(directory)[0]
572
 
            b = wt.branch
573
 
            wt.lock_read()
574
 
            self.add_cleanup(wt.unlock)
575
 
        except (errors.NoWorkingTree, errors.NotLocalUrl):
576
 
            wt = None
577
 
            b = Branch.open_containing(directory)[0]
578
 
            b.lock_read()
579
 
            self.add_cleanup(b.unlock)
580
 
        revision_ids = []
 
425
        revs = []
581
426
        if revision is not None:
582
 
            revision_ids.extend(rev.as_revision_id(b) for rev in revision)
 
427
            revs.extend(revision)
583
428
        if revision_info_list is not None:
584
 
            for rev_str in revision_info_list:
585
 
                rev_spec = RevisionSpec.from_string(rev_str)
586
 
                revision_ids.append(rev_spec.as_revision_id(b))
587
 
        # No arguments supplied, default to the last revision
588
 
        if len(revision_ids) == 0:
589
 
            if tree:
590
 
                if wt is None:
591
 
                    raise errors.NoWorkingTree(directory)
592
 
                revision_ids.append(wt.last_revision())
593
 
            else:
594
 
                revision_ids.append(b.last_revision())
595
 
 
596
 
        revinfos = []
597
 
        maxlen = 0
598
 
        for revision_id in revision_ids:
 
429
            for rev in revision_info_list:
 
430
                revs.append(RevisionSpec.from_string(rev))
 
431
 
 
432
        b = Branch.open_containing(directory)[0]
 
433
 
 
434
        if len(revs) == 0:
 
435
            revs.append(RevisionSpec.from_string('-1'))
 
436
 
 
437
        for rev in revs:
 
438
            revision_id = rev.as_revision_id(b)
599
439
            try:
600
 
                dotted_revno = b.revision_id_to_dotted_revno(revision_id)
601
 
                revno = '.'.join(str(i) for i in dotted_revno)
 
440
                revno = '%4d' % (b.revision_id_to_revno(revision_id))
602
441
            except errors.NoSuchRevision:
603
 
                revno = '???'
604
 
            maxlen = max(maxlen, len(revno))
605
 
            revinfos.append([revno, revision_id])
606
 
 
607
 
        self.cleanup_now()
608
 
        for ri in revinfos:
609
 
            self.outf.write('%*s %s\n' % (maxlen, ri[0], ri[1]))
610
 
 
611
 
 
 
442
                dotted_map = b.get_revision_id_to_revno_map()
 
443
                revno = '.'.join(str(i) for i in dotted_map[revision_id])
 
444
            print '%s %s' % (revno, revision_id)
 
445
 
 
446
    
612
447
class cmd_add(Command):
613
 
    __doc__ = """Add specified files or directories.
 
448
    """Add specified files or directories.
614
449
 
615
450
    In non-recursive mode, all the named items are added, regardless
616
451
    of whether they were previously ignored.  A warning is given if
632
467
    you should never need to explicitly add a directory, they'll just
633
468
    get added when you add a file in the directory.
634
469
 
635
 
    --dry-run will show which files would be added, but not actually
 
470
    --dry-run will show which files would be added, but not actually 
636
471
    add them.
637
472
 
638
473
    --file-ids-from will try to use the file ids from the supplied path.
642
477
    branches that will be merged later (without showing the two different
643
478
    adds as a conflict). It is also useful when merging another project
644
479
    into a subdirectory of this one.
645
 
    
646
 
    Any files matching patterns in the ignore list will not be added
647
 
    unless they are explicitly mentioned.
648
480
    """
649
481
    takes_args = ['file*']
650
482
    takes_options = [
658
490
               help='Lookup file ids from this tree.'),
659
491
        ]
660
492
    encoding_type = 'replace'
661
 
    _see_also = ['remove', 'ignore']
 
493
    _see_also = ['remove']
662
494
 
663
495
    def run(self, file_list, no_recurse=False, dry_run=False, verbose=False,
664
496
            file_ids_from=None):
682
514
 
683
515
        if base_tree:
684
516
            base_tree.lock_read()
685
 
            self.add_cleanup(base_tree.unlock)
686
 
        tree, file_list = tree_files_for_add(file_list)
687
 
        added, ignored = tree.smart_add(file_list, not
688
 
            no_recurse, action=action, save=not dry_run)
689
 
        self.cleanup_now()
 
517
        try:
 
518
            file_list = self._maybe_expand_globs(file_list)
 
519
            if file_list:
 
520
                tree = WorkingTree.open_containing(file_list[0])[0]
 
521
            else:
 
522
                tree = WorkingTree.open_containing(u'.')[0]
 
523
            added, ignored = tree.smart_add(file_list, not
 
524
                no_recurse, action=action, save=not dry_run)
 
525
        finally:
 
526
            if base_tree is not None:
 
527
                base_tree.unlock()
 
528
        if not is_quiet() and len(added) > 0:
 
529
            self.outf.write('add completed\n')
690
530
        if len(ignored) > 0:
691
531
            if verbose:
692
532
                for glob in sorted(ignored.keys()):
693
533
                    for path in ignored[glob]:
694
 
                        self.outf.write("ignored %s matching \"%s\"\n"
 
534
                        self.outf.write("ignored %s matching \"%s\"\n" 
695
535
                                        % (path, glob))
 
536
            else:
 
537
                match_len = 0
 
538
                for glob, paths in ignored.items():
 
539
                    match_len += len(paths)
 
540
                self.outf.write("ignored %d file(s).\n" % match_len)
 
541
            self.outf.write("If you wish to add some of these files,"
 
542
                            " please add them by name.\n")
696
543
 
697
544
 
698
545
class cmd_mkdir(Command):
699
 
    __doc__ = """Create a new versioned directory.
 
546
    """Create a new versioned directory.
700
547
 
701
548
    This is equivalent to creating the directory and then adding it.
702
549
    """
706
553
 
707
554
    def run(self, dir_list):
708
555
        for d in dir_list:
 
556
            os.mkdir(d)
709
557
            wt, dd = WorkingTree.open_containing(d)
710
 
            base = os.path.dirname(dd)
711
 
            id = wt.path2id(base)
712
 
            if id != None:
713
 
                os.mkdir(d)
714
 
                wt.add([dd])
715
 
                self.outf.write('added %s\n' % d)
716
 
            else:
717
 
                raise errors.NotVersionedError(path=base)
 
558
            wt.add([dd])
 
559
            self.outf.write('added %s\n' % d)
718
560
 
719
561
 
720
562
class cmd_relpath(Command):
721
 
    __doc__ = """Show path of a file relative to root"""
 
563
    """Show path of a file relative to root"""
722
564
 
723
565
    takes_args = ['filename']
724
566
    hidden = True
725
 
 
 
567
    
726
568
    @display_command
727
569
    def run(self, filename):
728
570
        # TODO: jam 20050106 Can relpath return a munged path if
733
575
 
734
576
 
735
577
class cmd_inventory(Command):
736
 
    __doc__ = """Show inventory of the current working copy or a revision.
 
578
    """Show inventory of the current working copy or a revision.
737
579
 
738
580
    It is possible to limit the output to a particular entry
739
581
    type using the --kind option.  For example: --kind file.
758
600
        if kind and kind not in ['file', 'directory', 'symlink']:
759
601
            raise errors.BzrCommandError('invalid kind %r specified' % (kind,))
760
602
 
761
 
        revision = _get_one_revision('inventory', revision)
762
603
        work_tree, file_list = tree_files(file_list)
763
604
        work_tree.lock_read()
764
 
        self.add_cleanup(work_tree.unlock)
765
 
        if revision is not None:
766
 
            tree = revision.as_tree(work_tree.branch)
767
 
 
768
 
            extra_trees = [work_tree]
769
 
            tree.lock_read()
770
 
            self.add_cleanup(tree.unlock)
771
 
        else:
772
 
            tree = work_tree
773
 
            extra_trees = []
774
 
 
775
 
        if file_list is not None:
776
 
            file_ids = tree.paths2ids(file_list, trees=extra_trees,
777
 
                                      require_versioned=True)
778
 
            # find_ids_across_trees may include some paths that don't
779
 
            # exist in 'tree'.
780
 
            entries = sorted((tree.id2path(file_id), tree.inventory[file_id])
781
 
                             for file_id in file_ids if file_id in tree)
782
 
        else:
783
 
            entries = tree.inventory.entries()
784
 
 
785
 
        self.cleanup_now()
 
605
        try:
 
606
            if revision is not None:
 
607
                if len(revision) > 1:
 
608
                    raise errors.BzrCommandError(
 
609
                        'bzr inventory --revision takes exactly one revision'
 
610
                        ' identifier')
 
611
                tree = revision[0].as_tree(work_tree.branch)
 
612
 
 
613
                extra_trees = [work_tree]
 
614
                tree.lock_read()
 
615
            else:
 
616
                tree = work_tree
 
617
                extra_trees = []
 
618
 
 
619
            if file_list is not None:
 
620
                file_ids = tree.paths2ids(file_list, trees=extra_trees,
 
621
                                          require_versioned=True)
 
622
                # find_ids_across_trees may include some paths that don't
 
623
                # exist in 'tree'.
 
624
                entries = sorted((tree.id2path(file_id), tree.inventory[file_id])
 
625
                                 for file_id in file_ids if file_id in tree)
 
626
            else:
 
627
                entries = tree.inventory.entries()
 
628
        finally:
 
629
            tree.unlock()
 
630
            if tree is not work_tree:
 
631
                work_tree.unlock()
 
632
 
786
633
        for path, entry in entries:
787
634
            if kind and kind != entry.kind:
788
635
                continue
794
641
 
795
642
 
796
643
class cmd_mv(Command):
797
 
    __doc__ = """Move or rename a file.
 
644
    """Move or rename a file.
798
645
 
799
646
    :Usage:
800
647
        bzr mv OLDNAME NEWNAME
817
664
    takes_args = ['names*']
818
665
    takes_options = [Option("after", help="Move only the bzr identifier"
819
666
        " of the file, because the file has already been moved."),
820
 
        Option('auto', help='Automatically guess renames.'),
821
 
        Option('dry-run', help='Avoid making changes when guessing renames.'),
822
667
        ]
823
668
    aliases = ['move', 'rename']
824
669
    encoding_type = 'replace'
825
670
 
826
 
    def run(self, names_list, after=False, auto=False, dry_run=False):
827
 
        if auto:
828
 
            return self.run_auto(names_list, after, dry_run)
829
 
        elif dry_run:
830
 
            raise errors.BzrCommandError('--dry-run requires --auto.')
 
671
    def run(self, names_list, after=False):
831
672
        if names_list is None:
832
673
            names_list = []
 
674
 
833
675
        if len(names_list) < 2:
834
676
            raise errors.BzrCommandError("missing file argument")
835
677
        tree, rel_names = tree_files(names_list, canonicalize=False)
836
 
        tree.lock_tree_write()
837
 
        self.add_cleanup(tree.unlock)
838
 
        self._run(tree, names_list, rel_names, after)
839
 
 
840
 
    def run_auto(self, names_list, after, dry_run):
841
 
        if names_list is not None and len(names_list) > 1:
842
 
            raise errors.BzrCommandError('Only one path may be specified to'
843
 
                                         ' --auto.')
844
 
        if after:
845
 
            raise errors.BzrCommandError('--after cannot be specified with'
846
 
                                         ' --auto.')
847
 
        work_tree, file_list = tree_files(names_list, default_branch='.')
848
 
        work_tree.lock_tree_write()
849
 
        self.add_cleanup(work_tree.unlock)
850
 
        rename_map.RenameMap.guess_renames(work_tree, dry_run)
 
678
        tree.lock_write()
 
679
        try:
 
680
            self._run(tree, names_list, rel_names, after)
 
681
        finally:
 
682
            tree.unlock()
851
683
 
852
684
    def _run(self, tree, names_list, rel_names, after):
853
685
        into_existing = osutils.isdir(names_list[-1])
874
706
            # All entries reference existing inventory items, so fix them up
875
707
            # for cicp file-systems.
876
708
            rel_names = tree.get_canonical_inventory_paths(rel_names)
877
 
            for src, dest in tree.move(rel_names[:-1], rel_names[-1], after=after):
878
 
                if not is_quiet():
879
 
                    self.outf.write("%s => %s\n" % (src, dest))
 
709
            for pair in tree.move(rel_names[:-1], rel_names[-1], after=after):
 
710
                self.outf.write("%s => %s\n" % pair)
880
711
        else:
881
712
            if len(names_list) != 2:
882
713
                raise errors.BzrCommandError('to mv multiple files the'
913
744
                        # pathjoin with an empty tail adds a slash, which breaks
914
745
                        # relpath :(
915
746
                        dest_parent_fq = tree.basedir
916
 
 
 
747
    
917
748
                    dest_tail = osutils.canonical_relpath(
918
749
                                    dest_parent_fq,
919
750
                                    osutils.pathjoin(dest_parent_fq, spec_tail))
926
757
            dest = osutils.pathjoin(dest_parent, dest_tail)
927
758
            mutter("attempting to move %s => %s", src, dest)
928
759
            tree.rename_one(src, dest, after=after)
929
 
            if not is_quiet():
930
 
                self.outf.write("%s => %s\n" % (src, dest))
 
760
            self.outf.write("%s => %s\n" % (src, dest))
931
761
 
932
762
 
933
763
class cmd_pull(Command):
934
 
    __doc__ = """Turn this branch into a mirror of another branch.
 
764
    """Turn this branch into a mirror of another branch.
935
765
 
936
 
    By default, this command only works on branches that have not diverged.
937
 
    Branches are considered diverged if the destination branch's most recent 
938
 
    commit is one that has not been merged (directly or indirectly) into the 
939
 
    parent.
 
766
    This command only works on branches that have not diverged.  Branches are
 
767
    considered diverged if the destination branch's most recent commit is one
 
768
    that has not been merged (directly or indirectly) into the parent.
940
769
 
941
770
    If branches have diverged, you can use 'bzr merge' to integrate the changes
942
771
    from one into the other.  Once one branch has merged, the other should
943
772
    be able to pull it again.
944
773
 
945
 
    If you want to replace your local changes and just want your branch to
946
 
    match the remote one, use pull --overwrite. This will work even if the two
947
 
    branches have diverged.
 
774
    If you want to forget your local changes and just update your branch to
 
775
    match the remote one, use pull --overwrite.
948
776
 
949
777
    If there is no default location set, the first pull will set it.  After
950
778
    that, you can omit the location to use the default.  To change the
956
784
    with bzr send.
957
785
    """
958
786
 
959
 
    _see_also = ['push', 'update', 'status-flags', 'send']
 
787
    _see_also = ['push', 'update', 'status-flags']
960
788
    takes_options = ['remember', 'overwrite', 'revision',
961
789
        custom_help('verbose',
962
790
            help='Show logs of pulled revisions.'),
966
794
            short_name='d',
967
795
            type=unicode,
968
796
            ),
969
 
        Option('local',
970
 
            help="Perform a local pull in a bound "
971
 
                 "branch.  Local pulls are not applied to "
972
 
                 "the master branch."
973
 
            ),
974
797
        ]
975
798
    takes_args = ['location?']
976
799
    encoding_type = 'replace'
977
800
 
978
801
    def run(self, location=None, remember=False, overwrite=False,
979
802
            revision=None, verbose=False,
980
 
            directory=None, local=False):
 
803
            directory=None):
981
804
        # FIXME: too much stuff is in the command class
982
805
        revision_id = None
983
806
        mergeable = None
986
809
        try:
987
810
            tree_to = WorkingTree.open_containing(directory)[0]
988
811
            branch_to = tree_to.branch
989
 
            tree_to.lock_write()
990
 
            self.add_cleanup(tree_to.unlock)
991
812
        except errors.NoWorkingTree:
992
813
            tree_to = None
993
814
            branch_to = Branch.open_containing(directory)[0]
994
 
            branch_to.lock_write()
995
 
            self.add_cleanup(branch_to.unlock)
996
 
 
997
 
        if local and not branch_to.get_bound_location():
998
 
            raise errors.LocalRequiresBoundBranch()
999
815
 
1000
816
        possible_transports = []
1001
817
        if location is not None:
1017
833
                    self.outf.write("Using saved parent location: %s\n" % display_url)
1018
834
                location = stored_loc
1019
835
 
1020
 
        revision = _get_one_revision('pull', revision)
1021
836
        if mergeable is not None:
1022
837
            if revision is not None:
1023
838
                raise errors.BzrCommandError(
1029
844
        else:
1030
845
            branch_from = Branch.open(location,
1031
846
                possible_transports=possible_transports)
1032
 
            branch_from.lock_read()
1033
 
            self.add_cleanup(branch_from.unlock)
1034
847
 
1035
848
            if branch_to.get_parent() is None or remember:
1036
849
                branch_to.set_parent(branch_from.base)
1037
850
 
1038
851
        if revision is not None:
1039
 
            revision_id = revision.as_revision_id(branch_from)
1040
 
 
1041
 
        if tree_to is not None:
1042
 
            view_info = _get_view_info_for_change_reporter(tree_to)
1043
 
            change_reporter = delta._ChangeReporter(
1044
 
                unversioned_filter=tree_to.is_ignored,
1045
 
                view_info=view_info)
1046
 
            result = tree_to.pull(
1047
 
                branch_from, overwrite, revision_id, change_reporter,
1048
 
                possible_transports=possible_transports, local=local)
1049
 
        else:
1050
 
            result = branch_to.pull(
1051
 
                branch_from, overwrite, revision_id, local=local)
1052
 
 
1053
 
        result.report(self.outf)
1054
 
        if verbose and result.old_revid != result.new_revid:
1055
 
            log.show_branch_change(
1056
 
                branch_to, self.outf, result.old_revno,
1057
 
                result.old_revid)
 
852
            if len(revision) == 1:
 
853
                revision_id = revision[0].as_revision_id(branch_from)
 
854
            else:
 
855
                raise errors.BzrCommandError(
 
856
                    'bzr pull --revision takes one value.')
 
857
 
 
858
        branch_to.lock_write()
 
859
        try:
 
860
            if tree_to is not None:
 
861
                change_reporter = delta._ChangeReporter(
 
862
                    unversioned_filter=tree_to.is_ignored)
 
863
                result = tree_to.pull(branch_from, overwrite, revision_id,
 
864
                                      change_reporter,
 
865
                                      possible_transports=possible_transports)
 
866
            else:
 
867
                result = branch_to.pull(branch_from, overwrite, revision_id)
 
868
 
 
869
            result.report(self.outf)
 
870
            if verbose and result.old_revid != result.new_revid:
 
871
                log.show_branch_change(branch_to, self.outf, result.old_revno,
 
872
                                       result.old_revid)
 
873
        finally:
 
874
            branch_to.unlock()
1058
875
 
1059
876
 
1060
877
class cmd_push(Command):
1061
 
    __doc__ = """Update a mirror of this branch.
1062
 
 
 
878
    """Update a mirror of this branch.
 
879
    
1063
880
    The target branch will not have its working tree populated because this
1064
881
    is both expensive, and is not supported on remote file systems.
1065
 
 
 
882
    
1066
883
    Some smart servers or protocols *may* put the working tree in place in
1067
884
    the future.
1068
885
 
1072
889
 
1073
890
    If branches have diverged, you can use 'bzr push --overwrite' to replace
1074
891
    the other branch completely, discarding its unmerged changes.
1075
 
 
 
892
    
1076
893
    If you want to ensure you have the different changes in the other branch,
1077
894
    do a merge (see bzr help merge) from the other branch, and commit that.
1078
895
    After that you will be able to do a push without '--overwrite'.
1107
924
                'for the commit history. Only the work not present in the '
1108
925
                'referenced branch is included in the branch created.',
1109
926
            type=unicode),
1110
 
        Option('strict',
1111
 
               help='Refuse to push if there are uncommitted changes in'
1112
 
               ' the working tree, --no-strict disables the check.'),
1113
927
        ]
1114
928
    takes_args = ['location?']
1115
929
    encoding_type = 'replace'
1117
931
    def run(self, location=None, remember=False, overwrite=False,
1118
932
        create_prefix=False, verbose=False, revision=None,
1119
933
        use_existing_dir=False, directory=None, stacked_on=None,
1120
 
        stacked=False, strict=None):
 
934
        stacked=False):
1121
935
        from bzrlib.push import _show_push_branch
1122
936
 
 
937
        # Get the source branch and revision_id
1123
938
        if directory is None:
1124
939
            directory = '.'
1125
 
        # Get the source branch
1126
 
        (tree, br_from,
1127
 
         _unused) = bzrdir.BzrDir.open_containing_tree_or_branch(directory)
1128
 
        # Get the tip's revision_id
1129
 
        revision = _get_one_revision('push', revision)
 
940
        br_from = Branch.open_containing(directory)[0]
1130
941
        if revision is not None:
1131
 
            revision_id = revision.in_history(br_from).rev_id
 
942
            if len(revision) == 1:
 
943
                revision_id = revision[0].in_history(br_from).rev_id
 
944
            else:
 
945
                raise errors.BzrCommandError(
 
946
                    'bzr push --revision takes one value.')
1132
947
        else:
1133
 
            revision_id = None
1134
 
        if tree is not None and revision_id is None:
1135
 
            tree.check_changed_or_out_of_date(
1136
 
                strict, 'push_strict',
1137
 
                more_error='Use --no-strict to force the push.',
1138
 
                more_warning='Uncommitted changes will not be pushed.')
 
948
            revision_id = br_from.last_revision()
 
949
 
1139
950
        # Get the stacked_on branch, if any
1140
951
        if stacked_on is not None:
1141
952
            stacked_on = urlutils.normalize_url(stacked_on)
1173
984
 
1174
985
 
1175
986
class cmd_branch(Command):
1176
 
    __doc__ = """Create a new branch that is a copy of an existing branch.
 
987
    """Create a new copy of a branch.
1177
988
 
1178
989
    If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
1179
990
    be used.  In other words, "branch ../foo/bar" will attempt to create ./bar.
1190
1001
    takes_args = ['from_location', 'to_location?']
1191
1002
    takes_options = ['revision', Option('hardlink',
1192
1003
        help='Hard-link working tree files where possible.'),
1193
 
        Option('no-tree',
1194
 
            help="Create a branch without a working-tree."),
1195
 
        Option('switch',
1196
 
            help="Switch the checkout in the current directory "
1197
 
                 "to the new branch."),
1198
1004
        Option('stacked',
1199
1005
            help='Create a stacked branch referring to the source branch. '
1200
1006
                'The new branch will depend on the availability of the source '
1201
1007
                'branch for all operations.'),
1202
1008
        Option('standalone',
1203
1009
               help='Do not use a shared repository, even if available.'),
1204
 
        Option('use-existing-dir',
1205
 
               help='By default branch will fail if the target'
1206
 
                    ' directory exists, but does not already'
1207
 
                    ' have a control directory.  This flag will'
1208
 
                    ' allow branch to proceed.'),
1209
 
        Option('bind',
1210
 
            help="Bind new branch to from location."),
1211
1010
        ]
1212
1011
    aliases = ['get', 'clone']
1213
1012
 
1214
1013
    def run(self, from_location, to_location=None, revision=None,
1215
 
            hardlink=False, stacked=False, standalone=False, no_tree=False,
1216
 
            use_existing_dir=False, switch=False, bind=False):
1217
 
        from bzrlib import switch as _mod_switch
 
1014
            hardlink=False, stacked=False, standalone=False):
1218
1015
        from bzrlib.tag import _merge_tags_if_possible
 
1016
        if revision is None:
 
1017
            revision = [None]
 
1018
        elif len(revision) > 1:
 
1019
            raise errors.BzrCommandError(
 
1020
                'bzr branch --revision takes exactly 1 revision value')
 
1021
 
1219
1022
        accelerator_tree, br_from = bzrdir.BzrDir.open_tree_or_branch(
1220
1023
            from_location)
1221
 
        revision = _get_one_revision('branch', revision)
1222
1024
        br_from.lock_read()
1223
 
        self.add_cleanup(br_from.unlock)
1224
 
        if revision is not None:
1225
 
            revision_id = revision.as_revision_id(br_from)
1226
 
        else:
1227
 
            # FIXME - wt.last_revision, fallback to branch, fall back to
1228
 
            # None or perhaps NULL_REVISION to mean copy nothing
1229
 
            # RBC 20060209
1230
 
            revision_id = br_from.last_revision()
1231
 
        if to_location is None:
1232
 
            to_location = urlutils.derive_to_location(from_location)
1233
 
        to_transport = transport.get_transport(to_location)
1234
1025
        try:
1235
 
            to_transport.mkdir('.')
1236
 
        except errors.FileExists:
1237
 
            if not use_existing_dir:
1238
 
                raise errors.BzrCommandError('Target directory "%s" '
1239
 
                    'already exists.' % to_location)
 
1026
            if len(revision) == 1 and revision[0] is not None:
 
1027
                revision_id = revision[0].as_revision_id(br_from)
1240
1028
            else:
1241
 
                try:
1242
 
                    bzrdir.BzrDir.open_from_transport(to_transport)
1243
 
                except errors.NotBranchError:
1244
 
                    pass
1245
 
                else:
1246
 
                    raise errors.AlreadyBranchError(to_location)
1247
 
        except errors.NoSuchFile:
1248
 
            raise errors.BzrCommandError('Parent of "%s" does not exist.'
1249
 
                                         % to_location)
1250
 
        try:
1251
 
            # preserve whatever source format we have.
1252
 
            dir = br_from.bzrdir.sprout(to_transport.base, revision_id,
1253
 
                                        possible_transports=[to_transport],
1254
 
                                        accelerator_tree=accelerator_tree,
1255
 
                                        hardlink=hardlink, stacked=stacked,
1256
 
                                        force_new_repo=standalone,
1257
 
                                        create_tree_if_local=not no_tree,
1258
 
                                        source_branch=br_from)
1259
 
            branch = dir.open_branch()
1260
 
        except errors.NoSuchRevision:
1261
 
            to_transport.delete_tree('.')
1262
 
            msg = "The branch %s has no revision %s." % (from_location,
1263
 
                revision)
1264
 
            raise errors.BzrCommandError(msg)
1265
 
        _merge_tags_if_possible(br_from, branch)
1266
 
        # If the source branch is stacked, the new branch may
1267
 
        # be stacked whether we asked for that explicitly or not.
1268
 
        # We therefore need a try/except here and not just 'if stacked:'
1269
 
        try:
1270
 
            note('Created new stacked branch referring to %s.' %
1271
 
                branch.get_stacked_on_url())
1272
 
        except (errors.NotStacked, errors.UnstackableBranchFormat,
1273
 
            errors.UnstackableRepositoryFormat), e:
1274
 
            note('Branched %d revision(s).' % branch.revno())
1275
 
        if bind:
1276
 
            # Bind to the parent
1277
 
            parent_branch = Branch.open(from_location)
1278
 
            branch.bind(parent_branch)
1279
 
            note('New branch bound to %s' % from_location)
1280
 
        if switch:
1281
 
            # Switch to the new branch
1282
 
            wt, _ = WorkingTree.open_containing('.')
1283
 
            _mod_switch.switch(wt.bzrdir, branch)
1284
 
            note('Switched to branch: %s',
1285
 
                urlutils.unescape_for_display(branch.base, 'utf-8'))
 
1029
                # FIXME - wt.last_revision, fallback to branch, fall back to
 
1030
                # None or perhaps NULL_REVISION to mean copy nothing
 
1031
                # RBC 20060209
 
1032
                revision_id = br_from.last_revision()
 
1033
            if to_location is None:
 
1034
                to_location = urlutils.derive_to_location(from_location)
 
1035
            to_transport = transport.get_transport(to_location)
 
1036
            try:
 
1037
                to_transport.mkdir('.')
 
1038
            except errors.FileExists:
 
1039
                raise errors.BzrCommandError('Target directory "%s" already'
 
1040
                                             ' exists.' % to_location)
 
1041
            except errors.NoSuchFile:
 
1042
                raise errors.BzrCommandError('Parent of "%s" does not exist.'
 
1043
                                             % to_location)
 
1044
            try:
 
1045
                # preserve whatever source format we have.
 
1046
                dir = br_from.bzrdir.sprout(to_transport.base, revision_id,
 
1047
                                            possible_transports=[to_transport],
 
1048
                                            accelerator_tree=accelerator_tree,
 
1049
                                            hardlink=hardlink, stacked=stacked,
 
1050
                                            force_new_repo=standalone,
 
1051
                                            source_branch=br_from)
 
1052
                branch = dir.open_branch()
 
1053
            except errors.NoSuchRevision:
 
1054
                to_transport.delete_tree('.')
 
1055
                msg = "The branch %s has no revision %s." % (from_location,
 
1056
                    revision[0])
 
1057
                raise errors.BzrCommandError(msg)
 
1058
            _merge_tags_if_possible(br_from, branch)
 
1059
            # If the source branch is stacked, the new branch may
 
1060
            # be stacked whether we asked for that explicitly or not.
 
1061
            # We therefore need a try/except here and not just 'if stacked:'
 
1062
            try:
 
1063
                note('Created new stacked branch referring to %s.' %
 
1064
                    branch.get_stacked_on_url())
 
1065
            except (errors.NotStacked, errors.UnstackableBranchFormat,
 
1066
                errors.UnstackableRepositoryFormat), e:
 
1067
                note('Branched %d revision(s).' % branch.revno())
 
1068
        finally:
 
1069
            br_from.unlock()
1286
1070
 
1287
1071
 
1288
1072
class cmd_checkout(Command):
1289
 
    __doc__ = """Create a new checkout of an existing branch.
 
1073
    """Create a new checkout of an existing branch.
1290
1074
 
1291
1075
    If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
1292
1076
    the branch found in '.'. This is useful if you have removed the working tree
1293
1077
    or if it was never created - i.e. if you pushed the branch to its current
1294
1078
    location using SFTP.
1295
 
 
 
1079
    
1296
1080
    If the TO_LOCATION is omitted, the last component of the BRANCH_LOCATION will
1297
1081
    be used.  In other words, "checkout ../foo/bar" will attempt to create ./bar.
1298
1082
    If the BRANCH_LOCATION has no / or path separator embedded, the TO_LOCATION
1326
1110
 
1327
1111
    def run(self, branch_location=None, to_location=None, revision=None,
1328
1112
            lightweight=False, files_from=None, hardlink=False):
 
1113
        if revision is None:
 
1114
            revision = [None]
 
1115
        elif len(revision) > 1:
 
1116
            raise errors.BzrCommandError(
 
1117
                'bzr checkout --revision takes exactly 1 revision value')
1329
1118
        if branch_location is None:
1330
1119
            branch_location = osutils.getcwd()
1331
1120
            to_location = branch_location
1332
1121
        accelerator_tree, source = bzrdir.BzrDir.open_tree_or_branch(
1333
1122
            branch_location)
1334
 
        revision = _get_one_revision('checkout', revision)
1335
1123
        if files_from is not None:
1336
1124
            accelerator_tree = WorkingTree.open(files_from)
1337
 
        if revision is not None:
1338
 
            revision_id = revision.as_revision_id(source)
 
1125
        if len(revision) == 1 and revision[0] is not None:
 
1126
            revision_id = revision[0].as_revision_id(source)
1339
1127
        else:
1340
1128
            revision_id = None
1341
1129
        if to_location is None:
1342
1130
            to_location = urlutils.derive_to_location(branch_location)
1343
 
        # if the source and to_location are the same,
 
1131
        # if the source and to_location are the same, 
1344
1132
        # and there is no working tree,
1345
1133
        # then reconstitute a branch
1346
1134
        if (osutils.abspath(to_location) ==
1355
1143
 
1356
1144
 
1357
1145
class cmd_renames(Command):
1358
 
    __doc__ = """Show list of renamed files.
 
1146
    """Show list of renamed files.
1359
1147
    """
1360
1148
    # TODO: Option to show renames between two historical versions.
1361
1149
 
1367
1155
    def run(self, dir=u'.'):
1368
1156
        tree = WorkingTree.open_containing(dir)[0]
1369
1157
        tree.lock_read()
1370
 
        self.add_cleanup(tree.unlock)
1371
 
        new_inv = tree.inventory
1372
 
        old_tree = tree.basis_tree()
1373
 
        old_tree.lock_read()
1374
 
        self.add_cleanup(old_tree.unlock)
1375
 
        old_inv = old_tree.inventory
1376
 
        renames = []
1377
 
        iterator = tree.iter_changes(old_tree, include_unchanged=True)
1378
 
        for f, paths, c, v, p, n, k, e in iterator:
1379
 
            if paths[0] == paths[1]:
1380
 
                continue
1381
 
            if None in (paths):
1382
 
                continue
1383
 
            renames.append(paths)
1384
 
        renames.sort()
1385
 
        for old_name, new_name in renames:
1386
 
            self.outf.write("%s => %s\n" % (old_name, new_name))
 
1158
        try:
 
1159
            new_inv = tree.inventory
 
1160
            old_tree = tree.basis_tree()
 
1161
            old_tree.lock_read()
 
1162
            try:
 
1163
                old_inv = old_tree.inventory
 
1164
                renames = []
 
1165
                iterator = tree.iter_changes(old_tree, include_unchanged=True)
 
1166
                for f, paths, c, v, p, n, k, e in iterator:
 
1167
                    if paths[0] == paths[1]:
 
1168
                        continue
 
1169
                    if None in (paths):
 
1170
                        continue
 
1171
                    renames.append(paths)
 
1172
                renames.sort()
 
1173
                for old_name, new_name in renames:
 
1174
                    self.outf.write("%s => %s\n" % (old_name, new_name))
 
1175
            finally:
 
1176
                old_tree.unlock()
 
1177
        finally:
 
1178
            tree.unlock()
1387
1179
 
1388
1180
 
1389
1181
class cmd_update(Command):
1390
 
    __doc__ = """Update a tree to have the latest code committed to its branch.
1391
 
 
 
1182
    """Update a tree to have the latest code committed to its branch.
 
1183
    
1392
1184
    This will perform a merge into the working tree, and may generate
1393
 
    conflicts. If you have any local changes, you will still
 
1185
    conflicts. If you have any local changes, you will still 
1394
1186
    need to commit them after the update for the update to be complete.
1395
 
 
1396
 
    If you want to discard your local changes, you can just do a
 
1187
    
 
1188
    If you want to discard your local changes, you can just do a 
1397
1189
    'bzr revert' instead of 'bzr commit' after the update.
1398
 
 
1399
 
    If the tree's branch is bound to a master branch, it will also update
1400
 
    the branch from the master.
1401
1190
    """
1402
1191
 
1403
1192
    _see_also = ['pull', 'working-trees', 'status-flags']
1404
1193
    takes_args = ['dir?']
1405
 
    takes_options = ['revision']
1406
1194
    aliases = ['up']
1407
1195
 
1408
 
    def run(self, dir='.', revision=None):
1409
 
        if revision is not None and len(revision) != 1:
1410
 
            raise errors.BzrCommandError(
1411
 
                        "bzr update --revision takes exactly one revision")
 
1196
    def run(self, dir='.'):
1412
1197
        tree = WorkingTree.open_containing(dir)[0]
1413
 
        branch = tree.branch
1414
1198
        possible_transports = []
1415
 
        master = branch.get_master_branch(
 
1199
        master = tree.branch.get_master_branch(
1416
1200
            possible_transports=possible_transports)
1417
1201
        if master is not None:
1418
1202
            tree.lock_write()
1419
 
            branch_location = master.base
1420
1203
        else:
1421
1204
            tree.lock_tree_write()
1422
 
            branch_location = tree.branch.base
1423
 
        self.add_cleanup(tree.unlock)
1424
 
        # get rid of the final '/' and be ready for display
1425
 
        branch_location = urlutils.unescape_for_display(
1426
 
            branch_location.rstrip('/'),
1427
 
            self.outf.encoding)
1428
 
        existing_pending_merges = tree.get_parent_ids()[1:]
1429
 
        if master is None:
1430
 
            old_tip = None
1431
 
        else:
1432
 
            # may need to fetch data into a heavyweight checkout
1433
 
            # XXX: this may take some time, maybe we should display a
1434
 
            # message
1435
 
            old_tip = branch.update(possible_transports)
1436
 
        if revision is not None:
1437
 
            revision_id = revision[0].as_revision_id(branch)
1438
 
        else:
1439
 
            revision_id = branch.last_revision()
1440
 
        if revision_id == _mod_revision.ensure_null(tree.last_revision()):
1441
 
            revno = branch.revision_id_to_dotted_revno(revision_id)
1442
 
            note("Tree is up to date at revision %s of branch %s" %
1443
 
                ('.'.join(map(str, revno)), branch_location))
1444
 
            return 0
1445
 
        view_info = _get_view_info_for_change_reporter(tree)
1446
 
        change_reporter = delta._ChangeReporter(
1447
 
            unversioned_filter=tree.is_ignored,
1448
 
            view_info=view_info)
1449
1205
        try:
 
1206
            existing_pending_merges = tree.get_parent_ids()[1:]
 
1207
            last_rev = _mod_revision.ensure_null(tree.last_revision())
 
1208
            if last_rev == _mod_revision.ensure_null(
 
1209
                tree.branch.last_revision()):
 
1210
                # may be up to date, check master too.
 
1211
                if master is None or last_rev == _mod_revision.ensure_null(
 
1212
                    master.last_revision()):
 
1213
                    revno = tree.branch.revision_id_to_revno(last_rev)
 
1214
                    note("Tree is up to date at revision %d." % (revno,))
 
1215
                    return 0
1450
1216
            conflicts = tree.update(
1451
 
                change_reporter,
1452
 
                possible_transports=possible_transports,
1453
 
                revision=revision_id,
1454
 
                old_tip=old_tip)
1455
 
        except errors.NoSuchRevision, e:
1456
 
            raise errors.BzrCommandError(
1457
 
                                  "branch has no revision %s\n"
1458
 
                                  "bzr update --revision only works"
1459
 
                                  " for a revision in the branch history"
1460
 
                                  % (e.revision))
1461
 
        revno = tree.branch.revision_id_to_dotted_revno(
1462
 
            _mod_revision.ensure_null(tree.last_revision()))
1463
 
        note('Updated to revision %s of branch %s' %
1464
 
             ('.'.join(map(str, revno)), branch_location))
1465
 
        parent_ids = tree.get_parent_ids()
1466
 
        if parent_ids[1:] and parent_ids[1:] != existing_pending_merges:
1467
 
            note('Your local commits will now show as pending merges with '
1468
 
                 "'bzr status', and can be committed with 'bzr commit'.")
1469
 
        if conflicts != 0:
1470
 
            return 1
1471
 
        else:
1472
 
            return 0
 
1217
                delta._ChangeReporter(unversioned_filter=tree.is_ignored),
 
1218
                possible_transports=possible_transports)
 
1219
            revno = tree.branch.revision_id_to_revno(
 
1220
                _mod_revision.ensure_null(tree.last_revision()))
 
1221
            note('Updated to revision %d.' % (revno,))
 
1222
            if tree.get_parent_ids()[1:] != existing_pending_merges:
 
1223
                note('Your local commits will now show as pending merges with '
 
1224
                     "'bzr status', and can be committed with 'bzr commit'.")
 
1225
            if conflicts != 0:
 
1226
                return 1
 
1227
            else:
 
1228
                return 0
 
1229
        finally:
 
1230
            tree.unlock()
1473
1231
 
1474
1232
 
1475
1233
class cmd_info(Command):
1476
 
    __doc__ = """Show information about a working tree, branch or repository.
 
1234
    """Show information about a working tree, branch or repository.
1477
1235
 
1478
1236
    This command will show all known locations and formats associated to the
1479
 
    tree, branch or repository.
1480
 
 
1481
 
    In verbose mode, statistical information is included with each report.
1482
 
    To see extended statistic information, use a verbosity level of 2 or
1483
 
    higher by specifying the verbose option multiple times, e.g. -vv.
 
1237
    tree, branch or repository.  Statistical information is included with
 
1238
    each report.
1484
1239
 
1485
1240
    Branches and working trees will also report any missing revisions.
1486
 
 
1487
 
    :Examples:
1488
 
 
1489
 
      Display information on the format and related locations:
1490
 
 
1491
 
        bzr info
1492
 
 
1493
 
      Display the above together with extended format information and
1494
 
      basic statistics (like the number of files in the working tree and
1495
 
      number of revisions in the branch and repository):
1496
 
 
1497
 
        bzr info -v
1498
 
 
1499
 
      Display the above together with number of committers to the branch:
1500
 
 
1501
 
        bzr info -vv
1502
1241
    """
1503
1242
    _see_also = ['revno', 'working-trees', 'repositories']
1504
1243
    takes_args = ['location?']
1508
1247
    @display_command
1509
1248
    def run(self, location=None, verbose=False):
1510
1249
        if verbose:
1511
 
            noise_level = get_verbosity_level()
 
1250
            noise_level = 2
1512
1251
        else:
1513
1252
            noise_level = 0
1514
1253
        from bzrlib.info import show_bzrdir_info
1517
1256
 
1518
1257
 
1519
1258
class cmd_remove(Command):
1520
 
    __doc__ = """Remove files or directories.
 
1259
    """Remove files or directories.
1521
1260
 
1522
1261
    This makes bzr stop tracking changes to the specified files. bzr will delete
1523
1262
    them if they can easily be recovered using revert. If no options or
1532
1271
            title='Deletion Strategy', value_switches=True, enum_switch=False,
1533
1272
            safe='Only delete files if they can be'
1534
1273
                 ' safely recovered (default).',
1535
 
            keep='Delete from bzr but leave the working copy.',
 
1274
            keep="Don't delete any files.",
1536
1275
            force='Delete all the specified files, even if they can not be '
1537
1276
                'recovered and even if they are non-empty directories.')]
1538
1277
    aliases = ['rm', 'del']
1546
1285
            file_list = [f for f in file_list]
1547
1286
 
1548
1287
        tree.lock_write()
1549
 
        self.add_cleanup(tree.unlock)
1550
 
        # Heuristics should probably all move into tree.remove_smart or
1551
 
        # some such?
1552
 
        if new:
1553
 
            added = tree.changes_from(tree.basis_tree(),
1554
 
                specific_files=file_list).added
1555
 
            file_list = sorted([f[0] for f in added], reverse=True)
1556
 
            if len(file_list) == 0:
1557
 
                raise errors.BzrCommandError('No matching files.')
1558
 
        elif file_list is None:
1559
 
            # missing files show up in iter_changes(basis) as
1560
 
            # versioned-with-no-kind.
1561
 
            missing = []
1562
 
            for change in tree.iter_changes(tree.basis_tree()):
1563
 
                # Find paths in the working tree that have no kind:
1564
 
                if change[1][1] is not None and change[6][1] is None:
1565
 
                    missing.append(change[1][1])
1566
 
            file_list = sorted(missing, reverse=True)
1567
 
            file_deletion_strategy = 'keep'
1568
 
        tree.remove(file_list, verbose=verbose, to_file=self.outf,
1569
 
            keep_files=file_deletion_strategy=='keep',
1570
 
            force=file_deletion_strategy=='force')
 
1288
        try:
 
1289
            # Heuristics should probably all move into tree.remove_smart or
 
1290
            # some such?
 
1291
            if new:
 
1292
                added = tree.changes_from(tree.basis_tree(),
 
1293
                    specific_files=file_list).added
 
1294
                file_list = sorted([f[0] for f in added], reverse=True)
 
1295
                if len(file_list) == 0:
 
1296
                    raise errors.BzrCommandError('No matching files.')
 
1297
            elif file_list is None:
 
1298
                # missing files show up in iter_changes(basis) as
 
1299
                # versioned-with-no-kind.
 
1300
                missing = []
 
1301
                for change in tree.iter_changes(tree.basis_tree()):
 
1302
                    # Find paths in the working tree that have no kind:
 
1303
                    if change[1][1] is not None and change[6][1] is None:
 
1304
                        missing.append(change[1][1])
 
1305
                file_list = sorted(missing, reverse=True)
 
1306
                file_deletion_strategy = 'keep'
 
1307
            tree.remove(file_list, verbose=verbose, to_file=self.outf,
 
1308
                keep_files=file_deletion_strategy=='keep',
 
1309
                force=file_deletion_strategy=='force')
 
1310
        finally:
 
1311
            tree.unlock()
1571
1312
 
1572
1313
 
1573
1314
class cmd_file_id(Command):
1574
 
    __doc__ = """Print file_id of a particular file or directory.
 
1315
    """Print file_id of a particular file or directory.
1575
1316
 
1576
1317
    The file_id is assigned when the file is first added and remains the
1577
1318
    same through all revisions where the file exists, even when it is
1593
1334
 
1594
1335
 
1595
1336
class cmd_file_path(Command):
1596
 
    __doc__ = """Print path of file_ids to a file or directory.
 
1337
    """Print path of file_ids to a file or directory.
1597
1338
 
1598
1339
    This prints one line for each directory down to the target,
1599
1340
    starting at the branch root.
1615
1356
 
1616
1357
 
1617
1358
class cmd_reconcile(Command):
1618
 
    __doc__ = """Reconcile bzr metadata in a branch.
 
1359
    """Reconcile bzr metadata in a branch.
1619
1360
 
1620
1361
    This can correct data mismatches that may have been caused by
1621
1362
    previous ghost operations or bzr upgrades. You should only
1622
 
    need to run this command if 'bzr check' or a bzr developer
 
1363
    need to run this command if 'bzr check' or a bzr developer 
1623
1364
    advises you to run it.
1624
1365
 
1625
1366
    If a second branch is provided, cross-branch reconciliation is
1627
1368
    id which was not present in very early bzr versions is represented
1628
1369
    correctly in both branches.
1629
1370
 
1630
 
    At the same time it is run it may recompress data resulting in
 
1371
    At the same time it is run it may recompress data resulting in 
1631
1372
    a potential saving in disk space or performance gain.
1632
1373
 
1633
1374
    The branch *MUST* be on a listable system such as local disk or sftp.
1643
1384
 
1644
1385
 
1645
1386
class cmd_revision_history(Command):
1646
 
    __doc__ = """Display the list of revision ids on a branch."""
 
1387
    """Display the list of revision ids on a branch."""
1647
1388
 
1648
1389
    _see_also = ['log']
1649
1390
    takes_args = ['location?']
1659
1400
 
1660
1401
 
1661
1402
class cmd_ancestry(Command):
1662
 
    __doc__ = """List all revisions merged into this branch."""
 
1403
    """List all revisions merged into this branch."""
1663
1404
 
1664
1405
    _see_also = ['log', 'revision-history']
1665
1406
    takes_args = ['location?']
1684
1425
 
1685
1426
 
1686
1427
class cmd_init(Command):
1687
 
    __doc__ = """Make a directory into a versioned branch.
 
1428
    """Make a directory into a versioned branch.
1688
1429
 
1689
1430
    Use this to create an empty branch, or before importing an
1690
1431
    existing project.
1691
1432
 
1692
 
    If there is a repository in a parent directory of the location, then
 
1433
    If there is a repository in a parent directory of the location, then 
1693
1434
    the history of the branch will be stored in the repository.  Otherwise
1694
1435
    init creates a standalone branch which carries its own history
1695
1436
    in the .bzr directory.
1718
1459
                lazy_registry=('bzrlib.bzrdir', 'format_registry'),
1719
1460
                converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
1720
1461
                value_switches=True,
1721
 
                title="Branch format",
 
1462
                title="Branch Format",
1722
1463
                ),
1723
1464
         Option('append-revisions-only',
1724
1465
                help='Never change revnos or the existing log.'
1747
1488
                    "\nYou may supply --create-prefix to create all"
1748
1489
                    " leading parent directories."
1749
1490
                    % location)
1750
 
            to_transport.create_prefix()
 
1491
            _create_prefix(to_transport)
1751
1492
 
1752
1493
        try:
1753
1494
            a_bzrdir = bzrdir.BzrDir.open_from_transport(to_transport)
1771
1512
                branch.set_append_revisions_only(True)
1772
1513
            except errors.UpgradeRequired:
1773
1514
                raise errors.BzrCommandError('This branch format cannot be set'
1774
 
                    ' to append-revisions-only.  Try --default.')
 
1515
                    ' to append-revisions-only.  Try --experimental-branch6')
1775
1516
        if not is_quiet():
1776
1517
            from bzrlib.info import describe_layout, describe_format
1777
1518
            try:
1793
1534
 
1794
1535
 
1795
1536
class cmd_init_repository(Command):
1796
 
    __doc__ = """Create a shared repository for branches to share storage space.
 
1537
    """Create a shared repository to hold branches.
1797
1538
 
1798
1539
    New branches created under the repository directory will store their
1799
 
    revisions in the repository, not in the branch directory.  For branches
1800
 
    with shared history, this reduces the amount of storage needed and 
1801
 
    speeds up the creation of new branches.
 
1540
    revisions in the repository, not in the branch directory.
1802
1541
 
1803
 
    If the --no-trees option is given then the branches in the repository
1804
 
    will not have working trees by default.  They will still exist as 
1805
 
    directories on disk, but they will not have separate copies of the 
1806
 
    files at a certain revision.  This can be useful for repositories that
1807
 
    store branches which are interacted with through checkouts or remote
1808
 
    branches, such as on a server.
 
1542
    If the --no-trees option is used then the branches in the repository
 
1543
    will not have working trees by default.
1809
1544
 
1810
1545
    :Examples:
1811
 
        Create a shared repository holding just branches::
 
1546
        Create a shared repositories holding just branches::
1812
1547
 
1813
1548
            bzr init-repo --no-trees repo
1814
1549
            bzr init repo/trunk
1853
1588
 
1854
1589
 
1855
1590
class cmd_diff(Command):
1856
 
    __doc__ = """Show differences in the working tree, between revisions or branches.
1857
 
 
 
1591
    """Show differences in the working tree, between revisions or branches.
 
1592
    
1858
1593
    If no arguments are given, all changes for the current tree are listed.
1859
1594
    If files are given, only the changes in those files are listed.
1860
1595
    Remote and multiple branches can be compared by using the --old and
1880
1615
 
1881
1616
            bzr diff -r1
1882
1617
 
1883
 
        Difference between revision 3 and revision 1::
1884
 
 
1885
 
            bzr diff -r1..3
1886
 
 
1887
 
        Difference between revision 3 and revision 1 for branch xxx::
1888
 
 
1889
 
            bzr diff -r1..3 xxx
1890
 
 
1891
 
        To see the changes introduced in revision X::
1892
 
        
1893
 
            bzr diff -cX
1894
 
 
1895
 
        Note that in the case of a merge, the -c option shows the changes
1896
 
        compared to the left hand parent. To see the changes against
1897
 
        another parent, use::
1898
 
 
1899
 
            bzr diff -r<chosen_parent>..X
1900
 
 
1901
 
        The changes introduced by revision 2 (equivalent to -r1..2)::
1902
 
 
1903
 
            bzr diff -c2
 
1618
        Difference between revision 2 and revision 1::
 
1619
 
 
1620
            bzr diff -r1..2
 
1621
 
 
1622
        Difference between revision 2 and revision 1 for branch xxx::
 
1623
 
 
1624
            bzr diff -r1..2 xxx
1904
1625
 
1905
1626
        Show just the differences for file NEWS::
1906
1627
 
1945
1666
            help='Use this command to compare files.',
1946
1667
            type=unicode,
1947
1668
            ),
1948
 
        RegistryOption('format',
1949
 
            help='Diff format to use.',
1950
 
            lazy_registry=('bzrlib.diff', 'format_registry'),
1951
 
            value_switches=False, title='Diff format'),
1952
1669
        ]
1953
1670
    aliases = ['di', 'dif']
1954
1671
    encoding_type = 'exact'
1955
1672
 
1956
1673
    @display_command
1957
1674
    def run(self, revision=None, file_list=None, diff_options=None,
1958
 
            prefix=None, old=None, new=None, using=None, format=None):
1959
 
        from bzrlib.diff import (get_trees_and_branches_to_diff_locked,
1960
 
            show_diff_trees)
 
1675
            prefix=None, old=None, new=None, using=None):
 
1676
        from bzrlib.diff import _get_trees_to_diff, show_diff_trees
1961
1677
 
1962
1678
        if (prefix is None) or (prefix == '0'):
1963
1679
            # diff -p0 format
1977
1693
            raise errors.BzrCommandError('bzr diff --revision takes exactly'
1978
1694
                                         ' one or two revision specifiers')
1979
1695
 
1980
 
        if using is not None and format is not None:
1981
 
            raise errors.BzrCommandError('--using and --format are mutually '
1982
 
                'exclusive.')
1983
 
 
1984
 
        (old_tree, new_tree,
1985
 
         old_branch, new_branch,
1986
 
         specific_files, extra_trees) = get_trees_and_branches_to_diff_locked(
1987
 
            file_list, revision, old, new, self.add_cleanup, apply_view=True)
1988
 
        return show_diff_trees(old_tree, new_tree, sys.stdout,
 
1696
        old_tree, new_tree, specific_files, extra_trees = \
 
1697
                _get_trees_to_diff(file_list, revision, old, new)
 
1698
        return show_diff_trees(old_tree, new_tree, sys.stdout, 
1989
1699
                               specific_files=specific_files,
1990
1700
                               external_diff_options=diff_options,
1991
1701
                               old_label=old_label, new_label=new_label,
1992
 
                               extra_trees=extra_trees, using=using,
1993
 
                               format_cls=format)
 
1702
                               extra_trees=extra_trees, using=using)
1994
1703
 
1995
1704
 
1996
1705
class cmd_deleted(Command):
1997
 
    __doc__ = """List files deleted in the working tree.
 
1706
    """List files deleted in the working tree.
1998
1707
    """
1999
1708
    # TODO: Show files deleted since a previous revision, or
2000
1709
    # between two revisions.
2009
1718
    def run(self, show_ids=False):
2010
1719
        tree = WorkingTree.open_containing(u'.')[0]
2011
1720
        tree.lock_read()
2012
 
        self.add_cleanup(tree.unlock)
2013
 
        old = tree.basis_tree()
2014
 
        old.lock_read()
2015
 
        self.add_cleanup(old.unlock)
2016
 
        for path, ie in old.inventory.iter_entries():
2017
 
            if not tree.has_id(ie.file_id):
2018
 
                self.outf.write(path)
2019
 
                if show_ids:
2020
 
                    self.outf.write(' ')
2021
 
                    self.outf.write(ie.file_id)
2022
 
                self.outf.write('\n')
 
1721
        try:
 
1722
            old = tree.basis_tree()
 
1723
            old.lock_read()
 
1724
            try:
 
1725
                for path, ie in old.inventory.iter_entries():
 
1726
                    if not tree.has_id(ie.file_id):
 
1727
                        self.outf.write(path)
 
1728
                        if show_ids:
 
1729
                            self.outf.write(' ')
 
1730
                            self.outf.write(ie.file_id)
 
1731
                        self.outf.write('\n')
 
1732
            finally:
 
1733
                old.unlock()
 
1734
        finally:
 
1735
            tree.unlock()
2023
1736
 
2024
1737
 
2025
1738
class cmd_modified(Command):
2026
 
    __doc__ = """List files modified in working tree.
 
1739
    """List files modified in working tree.
2027
1740
    """
2028
1741
 
2029
1742
    hidden = True
2046
1759
 
2047
1760
 
2048
1761
class cmd_added(Command):
2049
 
    __doc__ = """List files added in working tree.
 
1762
    """List files added in working tree.
2050
1763
    """
2051
1764
 
2052
1765
    hidden = True
2061
1774
    def run(self, null=False):
2062
1775
        wt = WorkingTree.open_containing(u'.')[0]
2063
1776
        wt.lock_read()
2064
 
        self.add_cleanup(wt.unlock)
2065
 
        basis = wt.basis_tree()
2066
 
        basis.lock_read()
2067
 
        self.add_cleanup(basis.unlock)
2068
 
        basis_inv = basis.inventory
2069
 
        inv = wt.inventory
2070
 
        for file_id in inv:
2071
 
            if file_id in basis_inv:
2072
 
                continue
2073
 
            if inv.is_root(file_id) and len(basis_inv) == 0:
2074
 
                continue
2075
 
            path = inv.id2path(file_id)
2076
 
            if not os.access(osutils.abspath(path), os.F_OK):
2077
 
                continue
2078
 
            if null:
2079
 
                self.outf.write(path + '\0')
2080
 
            else:
2081
 
                self.outf.write(osutils.quotefn(path) + '\n')
 
1777
        try:
 
1778
            basis = wt.basis_tree()
 
1779
            basis.lock_read()
 
1780
            try:
 
1781
                basis_inv = basis.inventory
 
1782
                inv = wt.inventory
 
1783
                for file_id in inv:
 
1784
                    if file_id in basis_inv:
 
1785
                        continue
 
1786
                    if inv.is_root(file_id) and len(basis_inv) == 0:
 
1787
                        continue
 
1788
                    path = inv.id2path(file_id)
 
1789
                    if not os.access(osutils.abspath(path), os.F_OK):
 
1790
                        continue
 
1791
                    if null:
 
1792
                        self.outf.write(path + '\0')
 
1793
                    else:
 
1794
                        self.outf.write(osutils.quotefn(path) + '\n')
 
1795
            finally:
 
1796
                basis.unlock()
 
1797
        finally:
 
1798
            wt.unlock()
2082
1799
 
2083
1800
 
2084
1801
class cmd_root(Command):
2085
 
    __doc__ = """Show the tree root directory.
 
1802
    """Show the tree root directory.
2086
1803
 
2087
1804
    The root is the nearest enclosing directory with a .bzr control
2088
1805
    directory."""
2112
1829
 
2113
1830
 
2114
1831
class cmd_log(Command):
2115
 
    __doc__ = """Show historical log for a branch or subset of a branch.
2116
 
 
2117
 
    log is bzr's default tool for exploring the history of a branch.
2118
 
    The branch to use is taken from the first parameter. If no parameters
2119
 
    are given, the branch containing the working directory is logged.
2120
 
    Here are some simple examples::
2121
 
 
2122
 
      bzr log                       log the current branch
2123
 
      bzr log foo.py                log a file in its branch
2124
 
      bzr log http://server/branch  log a branch on a server
2125
 
 
2126
 
    The filtering, ordering and information shown for each revision can
2127
 
    be controlled as explained below. By default, all revisions are
2128
 
    shown sorted (topologically) so that newer revisions appear before
2129
 
    older ones and descendants always appear before ancestors. If displayed,
2130
 
    merged revisions are shown indented under the revision in which they
2131
 
    were merged.
2132
 
 
2133
 
    :Output control:
2134
 
 
2135
 
      The log format controls how information about each revision is
2136
 
      displayed. The standard log formats are called ``long``, ``short``
2137
 
      and ``line``. The default is long. See ``bzr help log-formats``
2138
 
      for more details on log formats.
2139
 
 
2140
 
      The following options can be used to control what information is
2141
 
      displayed::
2142
 
 
2143
 
        -l N        display a maximum of N revisions
2144
 
        -n N        display N levels of revisions (0 for all, 1 for collapsed)
2145
 
        -v          display a status summary (delta) for each revision
2146
 
        -p          display a diff (patch) for each revision
2147
 
        --show-ids  display revision-ids (and file-ids), not just revnos
2148
 
 
2149
 
      Note that the default number of levels to display is a function of the
2150
 
      log format. If the -n option is not used, the standard log formats show
2151
 
      just the top level (mainline).
2152
 
 
2153
 
      Status summaries are shown using status flags like A, M, etc. To see
2154
 
      the changes explained using words like ``added`` and ``modified``
2155
 
      instead, use the -vv option.
2156
 
 
2157
 
    :Ordering control:
2158
 
 
2159
 
      To display revisions from oldest to newest, use the --forward option.
2160
 
      In most cases, using this option will have little impact on the total
2161
 
      time taken to produce a log, though --forward does not incrementally
2162
 
      display revisions like --reverse does when it can.
2163
 
 
2164
 
    :Revision filtering:
2165
 
 
2166
 
      The -r option can be used to specify what revision or range of revisions
2167
 
      to filter against. The various forms are shown below::
2168
 
 
2169
 
        -rX      display revision X
2170
 
        -rX..    display revision X and later
2171
 
        -r..Y    display up to and including revision Y
2172
 
        -rX..Y   display from X to Y inclusive
2173
 
 
2174
 
      See ``bzr help revisionspec`` for details on how to specify X and Y.
2175
 
      Some common examples are given below::
2176
 
 
2177
 
        -r-1                show just the tip
2178
 
        -r-10..             show the last 10 mainline revisions
2179
 
        -rsubmit:..         show what's new on this branch
2180
 
        -rancestor:path..   show changes since the common ancestor of this
2181
 
                            branch and the one at location path
2182
 
        -rdate:yesterday..  show changes since yesterday
2183
 
 
2184
 
      When logging a range of revisions using -rX..Y, log starts at
2185
 
      revision Y and searches back in history through the primary
2186
 
      ("left-hand") parents until it finds X. When logging just the
2187
 
      top level (using -n1), an error is reported if X is not found
2188
 
      along the way. If multi-level logging is used (-n0), X may be
2189
 
      a nested merge revision and the log will be truncated accordingly.
2190
 
 
2191
 
    :Path filtering:
2192
 
 
2193
 
      If parameters are given and the first one is not a branch, the log
2194
 
      will be filtered to show only those revisions that changed the
2195
 
      nominated files or directories.
2196
 
 
2197
 
      Filenames are interpreted within their historical context. To log a
2198
 
      deleted file, specify a revision range so that the file existed at
2199
 
      the end or start of the range.
2200
 
 
2201
 
      Historical context is also important when interpreting pathnames of
2202
 
      renamed files/directories. Consider the following example:
2203
 
 
2204
 
      * revision 1: add tutorial.txt
2205
 
      * revision 2: modify tutorial.txt
2206
 
      * revision 3: rename tutorial.txt to guide.txt; add tutorial.txt
2207
 
 
2208
 
      In this case:
2209
 
 
2210
 
      * ``bzr log guide.txt`` will log the file added in revision 1
2211
 
 
2212
 
      * ``bzr log tutorial.txt`` will log the new file added in revision 3
2213
 
 
2214
 
      * ``bzr log -r2 -p tutorial.txt`` will show the changes made to
2215
 
        the original file in revision 2.
2216
 
 
2217
 
      * ``bzr log -r2 -p guide.txt`` will display an error message as there
2218
 
        was no file called guide.txt in revision 2.
2219
 
 
2220
 
      Renames are always followed by log. By design, there is no need to
2221
 
      explicitly ask for this (and no way to stop logging a file back
2222
 
      until it was last renamed).
2223
 
 
2224
 
    :Other filtering:
2225
 
 
2226
 
      The --message option can be used for finding revisions that match a
2227
 
      regular expression in a commit message.
2228
 
 
2229
 
    :Tips & tricks:
2230
 
 
2231
 
      GUI tools and IDEs are often better at exploring history than command
2232
 
      line tools: you may prefer qlog or viz from qbzr or bzr-gtk, the
2233
 
      bzr-explorer shell, or the Loggerhead web interface.  See the Plugin
2234
 
      Guide <http://doc.bazaar.canonical.com/plugins/en/> and
2235
 
      <http://wiki.bazaar.canonical.com/IDEIntegration>.  
2236
 
 
2237
 
      You may find it useful to add the aliases below to ``bazaar.conf``::
2238
 
 
2239
 
        [ALIASES]
2240
 
        tip = log -r-1
2241
 
        top = log -l10 --line
2242
 
        show = log -v -p
2243
 
 
2244
 
      ``bzr tip`` will then show the latest revision while ``bzr top``
2245
 
      will show the last 10 mainline revisions. To see the details of a
2246
 
      particular revision X,  ``bzr show -rX``.
2247
 
 
2248
 
      If you are interested in looking deeper into a particular merge X,
2249
 
      use ``bzr log -n0 -rX``.
2250
 
 
2251
 
      ``bzr log -v`` on a branch with lots of history is currently
2252
 
      very slow. A fix for this issue is currently under development.
2253
 
      With or without that fix, it is recommended that a revision range
2254
 
      be given when using the -v option.
2255
 
 
2256
 
      bzr has a generic full-text matching plugin, bzr-search, that can be
2257
 
      used to find revisions matching user names, commit messages, etc.
2258
 
      Among other features, this plugin can find all revisions containing
2259
 
      a list of words but not others.
2260
 
 
2261
 
      When exploring non-mainline history on large projects with deep
2262
 
      history, the performance of log can be greatly improved by installing
2263
 
      the historycache plugin. This plugin buffers historical information
2264
 
      trading disk space for faster speed.
 
1832
    """Show log of a branch, file, or directory.
 
1833
 
 
1834
    By default show the log of the branch containing the working directory.
 
1835
 
 
1836
    To request a range of logs, you can use the command -r begin..end
 
1837
    -r revision requests a specific revision, -r ..end or -r begin.. are
 
1838
    also valid.
 
1839
 
 
1840
    :Examples:
 
1841
        Log the current branch::
 
1842
 
 
1843
            bzr log
 
1844
 
 
1845
        Log a file::
 
1846
 
 
1847
            bzr log foo.c
 
1848
 
 
1849
        Log the last 10 revisions of a branch::
 
1850
 
 
1851
            bzr log -r -10.. http://server/branch
2265
1852
    """
2266
 
    takes_args = ['file*']
2267
 
    _see_also = ['log-formats', 'revisionspec']
 
1853
 
 
1854
    # TODO: Make --revision support uuid: and hash: [future tag:] notation.
 
1855
 
 
1856
    takes_args = ['location?']
2268
1857
    takes_options = [
2269
1858
            Option('forward',
2270
1859
                   help='Show from oldest to newest.'),
2297
1886
            Option('show-diff',
2298
1887
                   short_name='p',
2299
1888
                   help='Show changes made in each revision as a patch.'),
2300
 
            Option('include-merges',
2301
 
                   help='Show merged revisions like --levels 0 does.'),
2302
 
            Option('exclude-common-ancestry',
2303
 
                   help='Display only the revisions that are not part'
2304
 
                   ' of both ancestries (require -rX..Y)'
2305
 
                   )
2306
1889
            ]
2307
1890
    encoding_type = 'replace'
2308
1891
 
2309
1892
    @display_command
2310
 
    def run(self, file_list=None, timezone='original',
 
1893
    def run(self, location=None, timezone='original',
2311
1894
            verbose=False,
2312
1895
            show_ids=False,
2313
1896
            forward=False,
2317
1900
            levels=None,
2318
1901
            message=None,
2319
1902
            limit=None,
2320
 
            show_diff=False,
2321
 
            include_merges=False,
2322
 
            exclude_common_ancestry=False,
2323
 
            ):
2324
 
        from bzrlib.log import (
2325
 
            Logger,
2326
 
            make_log_request_dict,
2327
 
            _get_info_for_log_files,
2328
 
            )
 
1903
            show_diff=False):
 
1904
        from bzrlib.log import show_log, _get_fileid_to_log
2329
1905
        direction = (forward and 'forward') or 'reverse'
2330
 
        if (exclude_common_ancestry
2331
 
            and (revision is None or len(revision) != 2)):
2332
 
            raise errors.BzrCommandError(
2333
 
                '--exclude-common-ancestry requires -r with two revisions')
2334
 
        if include_merges:
2335
 
            if levels is None:
2336
 
                levels = 0
2337
 
            else:
2338
 
                raise errors.BzrCommandError(
2339
 
                    '--levels and --include-merges are mutually exclusive')
2340
1906
 
2341
1907
        if change is not None:
2342
1908
            if len(change) > 1:
2347
1913
            else:
2348
1914
                revision = change
2349
1915
 
2350
 
        file_ids = []
2351
 
        filter_by_dir = False
2352
 
        if file_list:
2353
 
            # find the file ids to log and check for directory filtering
2354
 
            b, file_info_list, rev1, rev2 = _get_info_for_log_files(
2355
 
                revision, file_list)
2356
 
            self.add_cleanup(b.unlock)
2357
 
            for relpath, file_id, kind in file_info_list:
 
1916
        # log everything
 
1917
        file_id = None
 
1918
        if location:
 
1919
            # find the file id to log:
 
1920
 
 
1921
            tree, b, fp = bzrdir.BzrDir.open_containing_tree_or_branch(
 
1922
                location)
 
1923
            if fp != '':
 
1924
                file_id = _get_fileid_to_log(revision, tree, b, fp)
2358
1925
                if file_id is None:
2359
1926
                    raise errors.BzrCommandError(
2360
1927
                        "Path unknown at end or start of revision range: %s" %
2361
 
                        relpath)
2362
 
                # If the relpath is the top of the tree, we log everything
2363
 
                if relpath == '':
2364
 
                    file_ids = []
2365
 
                    break
2366
 
                else:
2367
 
                    file_ids.append(file_id)
2368
 
                filter_by_dir = filter_by_dir or (
2369
 
                    kind in ['directory', 'tree-reference'])
 
1928
                        location)
2370
1929
        else:
2371
 
            # log everything
2372
 
            # FIXME ? log the current subdir only RBC 20060203
 
1930
            # local dir only
 
1931
            # FIXME ? log the current subdir only RBC 20060203 
2373
1932
            if revision is not None \
2374
1933
                    and len(revision) > 0 and revision[0].get_branch():
2375
1934
                location = revision[0].get_branch()
2377
1936
                location = '.'
2378
1937
            dir, relpath = bzrdir.BzrDir.open_containing(location)
2379
1938
            b = dir.open_branch()
2380
 
            b.lock_read()
2381
 
            self.add_cleanup(b.unlock)
 
1939
 
 
1940
        b.lock_read()
 
1941
        try:
2382
1942
            rev1, rev2 = _get_revision_range(revision, b, self.name())
2383
 
 
2384
 
        # Decide on the type of delta & diff filtering to use
2385
 
        # TODO: add an --all-files option to make this configurable & consistent
2386
 
        if not verbose:
2387
 
            delta_type = None
2388
 
        else:
2389
 
            delta_type = 'full'
2390
 
        if not show_diff:
2391
 
            diff_type = None
2392
 
        elif file_ids:
2393
 
            diff_type = 'partial'
2394
 
        else:
2395
 
            diff_type = 'full'
2396
 
 
2397
 
        # Build the log formatter
2398
 
        if log_format is None:
2399
 
            log_format = log.log_formatter_registry.get_default(b)
2400
 
        # Make a non-encoding output to include the diffs - bug 328007
2401
 
        unencoded_output = ui.ui_factory.make_output_stream(encoding_type='exact')
2402
 
        lf = log_format(show_ids=show_ids, to_file=self.outf,
2403
 
                        to_exact_file=unencoded_output,
2404
 
                        show_timezone=timezone,
2405
 
                        delta_format=get_verbosity_level(),
2406
 
                        levels=levels,
2407
 
                        show_advice=levels is None)
2408
 
 
2409
 
        # Choose the algorithm for doing the logging. It's annoying
2410
 
        # having multiple code paths like this but necessary until
2411
 
        # the underlying repository format is faster at generating
2412
 
        # deltas or can provide everything we need from the indices.
2413
 
        # The default algorithm - match-using-deltas - works for
2414
 
        # multiple files and directories and is faster for small
2415
 
        # amounts of history (200 revisions say). However, it's too
2416
 
        # slow for logging a single file in a repository with deep
2417
 
        # history, i.e. > 10K revisions. In the spirit of "do no
2418
 
        # evil when adding features", we continue to use the
2419
 
        # original algorithm - per-file-graph - for the "single
2420
 
        # file that isn't a directory without showing a delta" case.
2421
 
        partial_history = revision and b.repository._format.supports_chks
2422
 
        match_using_deltas = (len(file_ids) != 1 or filter_by_dir
2423
 
            or delta_type or partial_history)
2424
 
 
2425
 
        # Build the LogRequest and execute it
2426
 
        if len(file_ids) == 0:
2427
 
            file_ids = None
2428
 
        rqst = make_log_request_dict(
2429
 
            direction=direction, specific_fileids=file_ids,
2430
 
            start_revision=rev1, end_revision=rev2, limit=limit,
2431
 
            message_search=message, delta_type=delta_type,
2432
 
            diff_type=diff_type, _match_using_deltas=match_using_deltas,
2433
 
            exclude_common_ancestry=exclude_common_ancestry,
2434
 
            )
2435
 
        Logger(b, rqst).show(lf)
 
1943
            if log_format is None:
 
1944
                log_format = log.log_formatter_registry.get_default(b)
 
1945
 
 
1946
            lf = log_format(show_ids=show_ids, to_file=self.outf,
 
1947
                            show_timezone=timezone,
 
1948
                            delta_format=get_verbosity_level(),
 
1949
                            levels=levels)
 
1950
 
 
1951
            show_log(b,
 
1952
                     lf,
 
1953
                     file_id,
 
1954
                     verbose=verbose,
 
1955
                     direction=direction,
 
1956
                     start_revision=rev1,
 
1957
                     end_revision=rev2,
 
1958
                     search=message,
 
1959
                     limit=limit,
 
1960
                     show_diff=show_diff)
 
1961
        finally:
 
1962
            b.unlock()
2436
1963
 
2437
1964
 
2438
1965
def _get_revision_range(revisionspec_list, branch, command_name):
2439
1966
    """Take the input of a revision option and turn it into a revision range.
2440
1967
 
2441
1968
    It returns RevisionInfo objects which can be used to obtain the rev_id's
2442
 
    of the desired revisions. It does some user input validations.
 
1969
    of the desired revisons. It does some user input validations.
2443
1970
    """
2444
1971
    if revisionspec_list is None:
2445
1972
        rev1 = None
2456
1983
            raise errors.BzrCommandError(
2457
1984
                "bzr %s doesn't accept two revisions in different"
2458
1985
                " branches." % command_name)
2459
 
        if start_spec.spec is None:
2460
 
            # Avoid loading all the history.
2461
 
            rev1 = RevisionInfo(branch, None, None)
2462
 
        else:
2463
 
            rev1 = start_spec.in_history(branch)
 
1986
        rev1 = start_spec.in_history(branch)
2464
1987
        # Avoid loading all of history when we know a missing
2465
1988
        # end of range means the last revision ...
2466
1989
        if end_spec.spec is None:
2495
2018
 
2496
2019
 
2497
2020
class cmd_touching_revisions(Command):
2498
 
    __doc__ = """Return revision-ids which affected a particular file.
 
2021
    """Return revision-ids which affected a particular file.
2499
2022
 
2500
2023
    A more user-friendly interface is "bzr log FILE".
2501
2024
    """
2506
2029
    @display_command
2507
2030
    def run(self, filename):
2508
2031
        tree, relpath = WorkingTree.open_containing(filename)
 
2032
        b = tree.branch
2509
2033
        file_id = tree.path2id(relpath)
2510
 
        b = tree.branch
2511
 
        b.lock_read()
2512
 
        self.add_cleanup(b.unlock)
2513
 
        touching_revs = log.find_touching_revisions(b, file_id)
2514
 
        for revno, revision_id, what in touching_revs:
 
2034
        for revno, revision_id, what in log.find_touching_revisions(b, file_id):
2515
2035
            self.outf.write("%6d %s\n" % (revno, what))
2516
2036
 
2517
2037
 
2518
2038
class cmd_ls(Command):
2519
 
    __doc__ = """List files in a tree.
 
2039
    """List files in a tree.
2520
2040
    """
2521
2041
 
2522
2042
    _see_also = ['status', 'cat']
2523
2043
    takes_args = ['path?']
 
2044
    # TODO: Take a revision or remote path and list that tree instead.
2524
2045
    takes_options = [
2525
2046
            'verbose',
2526
2047
            'revision',
2527
 
            Option('recursive', short_name='R',
2528
 
                   help='Recurse into subdirectories.'),
 
2048
            Option('non-recursive',
 
2049
                   help='Don\'t recurse into subdirectories.'),
2529
2050
            Option('from-root',
2530
2051
                   help='Print paths relative to the root of the branch.'),
2531
2052
            Option('unknown', help='Print unknown files.'),
2542
2063
            ]
2543
2064
    @display_command
2544
2065
    def run(self, revision=None, verbose=False,
2545
 
            recursive=False, from_root=False,
 
2066
            non_recursive=False, from_root=False,
2546
2067
            unknown=False, versioned=False, ignored=False,
2547
2068
            null=False, kind=None, show_ids=False, path=None):
2548
2069
 
2557
2078
 
2558
2079
        if path is None:
2559
2080
            fs_path = '.'
 
2081
            prefix = ''
2560
2082
        else:
2561
2083
            if from_root:
2562
2084
                raise errors.BzrCommandError('cannot specify both --from-root'
2563
2085
                                             ' and PATH')
2564
2086
            fs_path = path
 
2087
            prefix = path
2565
2088
        tree, branch, relpath = bzrdir.BzrDir.open_containing_tree_or_branch(
2566
2089
            fs_path)
2567
 
 
2568
 
        # Calculate the prefix to use
2569
 
        prefix = None
2570
2090
        if from_root:
2571
 
            if relpath:
2572
 
                prefix = relpath + '/'
2573
 
        elif fs_path != '.' and not fs_path.endswith('/'):
2574
 
            prefix = fs_path + '/'
2575
 
 
 
2091
            relpath = u''
 
2092
        elif relpath:
 
2093
            relpath += '/'
2576
2094
        if revision is not None or tree is None:
2577
2095
            tree = _get_one_revision_tree('ls', revision, branch=branch)
2578
2096
 
2579
 
        apply_view = False
2580
 
        if isinstance(tree, WorkingTree) and tree.supports_views():
2581
 
            view_files = tree.views.lookup_view()
2582
 
            if view_files:
2583
 
                apply_view = True
2584
 
                view_str = views.view_display_str(view_files)
2585
 
                note("Ignoring files outside view. View is %s" % view_str)
2586
 
 
2587
2097
        tree.lock_read()
2588
 
        self.add_cleanup(tree.unlock)
2589
 
        for fp, fc, fkind, fid, entry in tree.list_files(include_root=False,
2590
 
            from_dir=relpath, recursive=recursive):
2591
 
            # Apply additional masking
2592
 
            if not all and not selection[fc]:
2593
 
                continue
2594
 
            if kind is not None and fkind != kind:
2595
 
                continue
2596
 
            if apply_view:
2597
 
                try:
2598
 
                    if relpath:
2599
 
                        fullpath = osutils.pathjoin(relpath, fp)
2600
 
                    else:
2601
 
                        fullpath = fp
2602
 
                    views.check_path_in_view(tree, fullpath)
2603
 
                except errors.FileOutsideView:
2604
 
                    continue
2605
 
 
2606
 
            # Output the entry
2607
 
            if prefix:
2608
 
                fp = osutils.pathjoin(prefix, fp)
2609
 
            kindch = entry.kind_character()
2610
 
            outstring = fp + kindch
2611
 
            ui.ui_factory.clear_term()
2612
 
            if verbose:
2613
 
                outstring = '%-8s %s' % (fc, outstring)
2614
 
                if show_ids and fid is not None:
2615
 
                    outstring = "%-50s %s" % (outstring, fid)
2616
 
                self.outf.write(outstring + '\n')
2617
 
            elif null:
2618
 
                self.outf.write(fp + '\0')
2619
 
                if show_ids:
2620
 
                    if fid is not None:
2621
 
                        self.outf.write(fid)
2622
 
                    self.outf.write('\0')
2623
 
                self.outf.flush()
2624
 
            else:
2625
 
                if show_ids:
2626
 
                    if fid is not None:
2627
 
                        my_id = fid
2628
 
                    else:
2629
 
                        my_id = ''
2630
 
                    self.outf.write('%-50s %s\n' % (outstring, my_id))
2631
 
                else:
2632
 
                    self.outf.write(outstring + '\n')
 
2098
        try:
 
2099
            for fp, fc, fkind, fid, entry in tree.list_files(include_root=False):
 
2100
                if fp.startswith(relpath):
 
2101
                    fp = osutils.pathjoin(prefix, fp[len(relpath):])
 
2102
                    if non_recursive and '/' in fp:
 
2103
                        continue
 
2104
                    if not all and not selection[fc]:
 
2105
                        continue
 
2106
                    if kind is not None and fkind != kind:
 
2107
                        continue
 
2108
                    kindch = entry.kind_character()
 
2109
                    outstring = fp + kindch
 
2110
                    if verbose:
 
2111
                        outstring = '%-8s %s' % (fc, outstring)
 
2112
                        if show_ids and fid is not None:
 
2113
                            outstring = "%-50s %s" % (outstring, fid)
 
2114
                        self.outf.write(outstring + '\n')
 
2115
                    elif null:
 
2116
                        self.outf.write(fp + '\0')
 
2117
                        if show_ids:
 
2118
                            if fid is not None:
 
2119
                                self.outf.write(fid)
 
2120
                            self.outf.write('\0')
 
2121
                        self.outf.flush()
 
2122
                    else:
 
2123
                        if fid is not None:
 
2124
                            my_id = fid
 
2125
                        else:
 
2126
                            my_id = ''
 
2127
                        if show_ids:
 
2128
                            self.outf.write('%-50s %s\n' % (outstring, my_id))
 
2129
                        else:
 
2130
                            self.outf.write(outstring + '\n')
 
2131
        finally:
 
2132
            tree.unlock()
2633
2133
 
2634
2134
 
2635
2135
class cmd_unknowns(Command):
2636
 
    __doc__ = """List unknown files.
 
2136
    """List unknown files.
2637
2137
    """
2638
2138
 
2639
2139
    hidden = True
2646
2146
 
2647
2147
 
2648
2148
class cmd_ignore(Command):
2649
 
    __doc__ = """Ignore specified files or patterns.
 
2149
    """Ignore specified files or patterns.
2650
2150
 
2651
2151
    See ``bzr help patterns`` for details on the syntax of patterns.
2652
2152
 
2653
 
    If a .bzrignore file does not exist, the ignore command
2654
 
    will create one and add the specified files or patterns to the newly
2655
 
    created file. The ignore command will also automatically add the 
2656
 
    .bzrignore file to be versioned. Creating a .bzrignore file without
2657
 
    the use of the ignore command will require an explicit add command.
2658
 
 
2659
2153
    To remove patterns from the ignore list, edit the .bzrignore file.
2660
2154
    After adding, editing or deleting that file either indirectly by
2661
2155
    using this command or directly by using an editor, be sure to commit
2662
2156
    it.
2663
 
    
2664
 
    Bazaar also supports a global ignore file ~/.bazaar/ignore. On Windows
2665
 
    the global ignore file can be found in the application data directory as
2666
 
    C:\\Documents and Settings\\<user>\\Application Data\\Bazaar\\2.0\\ignore.
2667
 
    Global ignores are not touched by this command. The global ignore file
2668
 
    can be edited directly using an editor.
2669
 
 
2670
 
    Patterns prefixed with '!' are exceptions to ignore patterns and take
2671
 
    precedence over regular ignores.  Such exceptions are used to specify
2672
 
    files that should be versioned which would otherwise be ignored.
2673
 
    
2674
 
    Patterns prefixed with '!!' act as regular ignore patterns, but have
2675
 
    precedence over the '!' exception patterns.
2676
 
 
2677
 
    Note: ignore patterns containing shell wildcards must be quoted from
 
2157
 
 
2158
    Note: ignore patterns containing shell wildcards must be quoted from 
2678
2159
    the shell on Unix.
2679
2160
 
2680
2161
    :Examples:
2682
2163
 
2683
2164
            bzr ignore ./Makefile
2684
2165
 
2685
 
        Ignore .class files in all directories...::
 
2166
        Ignore class files in all directories::
2686
2167
 
2687
2168
            bzr ignore "*.class"
2688
2169
 
2689
 
        ...but do not ignore "special.class"::
2690
 
 
2691
 
            bzr ignore "!special.class"
2692
 
 
2693
2170
        Ignore .o files under the lib directory::
2694
2171
 
2695
2172
            bzr ignore "lib/**/*.o"
2701
2178
        Ignore everything but the "debian" toplevel directory::
2702
2179
 
2703
2180
            bzr ignore "RE:(?!debian/).*"
2704
 
        
2705
 
        Ignore everything except the "local" toplevel directory,
2706
 
        but always ignore "*~" autosave files, even under local/::
2707
 
        
2708
 
            bzr ignore "*"
2709
 
            bzr ignore "!./local"
2710
 
            bzr ignore "!!*~"
2711
2181
    """
2712
2182
 
2713
2183
    _see_also = ['status', 'ignored', 'patterns']
2714
2184
    takes_args = ['name_pattern*']
2715
2185
    takes_options = [
2716
 
        Option('default-rules',
2717
 
               help='Display the default ignore rules that bzr uses.')
 
2186
        Option('old-default-rules',
 
2187
               help='Write out the ignore rules bzr < 0.9 always used.')
2718
2188
        ]
2719
 
 
2720
 
    def run(self, name_pattern_list=None, default_rules=None):
 
2189
    
 
2190
    def run(self, name_pattern_list=None, old_default_rules=None):
2721
2191
        from bzrlib import ignores
2722
 
        if default_rules is not None:
2723
 
            # dump the default rules and exit
2724
 
            for pattern in ignores.USER_DEFAULTS:
2725
 
                self.outf.write("%s\n" % pattern)
 
2192
        if old_default_rules is not None:
 
2193
            # dump the rules and exit
 
2194
            for pattern in ignores.OLD_DEFAULTS:
 
2195
                print pattern
2726
2196
            return
2727
2197
        if not name_pattern_list:
2728
2198
            raise errors.BzrCommandError("ignore requires at least one "
2729
 
                "NAME_PATTERN or --default-rules.")
2730
 
        name_pattern_list = [globbing.normalize_pattern(p)
 
2199
                                  "NAME_PATTERN or --old-default-rules")
 
2200
        name_pattern_list = [globbing.normalize_pattern(p) 
2731
2201
                             for p in name_pattern_list]
2732
2202
        for name_pattern in name_pattern_list:
2733
 
            if (name_pattern[0] == '/' or
 
2203
            if (name_pattern[0] == '/' or 
2734
2204
                (len(name_pattern) > 1 and name_pattern[1] == ':')):
2735
2205
                raise errors.BzrCommandError(
2736
2206
                    "NAME_PATTERN should not be an absolute path")
2744
2214
            if id is not None:
2745
2215
                filename = entry[0]
2746
2216
                if ignored.match(filename):
2747
 
                    matches.append(filename)
 
2217
                    matches.append(filename.encode('utf-8'))
2748
2218
        tree.unlock()
2749
2219
        if len(matches) > 0:
2750
 
            self.outf.write("Warning: the following files are version controlled and"
2751
 
                  " match your ignore pattern:\n%s"
2752
 
                  "\nThese files will continue to be version controlled"
2753
 
                  " unless you 'bzr remove' them.\n" % ("\n".join(matches),))
 
2220
            print "Warning: the following files are version controlled and" \
 
2221
                  " match your ignore pattern:\n%s" % ("\n".join(matches),)
2754
2222
 
2755
2223
 
2756
2224
class cmd_ignored(Command):
2757
 
    __doc__ = """List ignored files and the patterns that matched them.
 
2225
    """List ignored files and the patterns that matched them.
2758
2226
 
2759
2227
    List all the ignored files and the ignore pattern that caused the file to
2760
2228
    be ignored.
2771
2239
    def run(self):
2772
2240
        tree = WorkingTree.open_containing(u'.')[0]
2773
2241
        tree.lock_read()
2774
 
        self.add_cleanup(tree.unlock)
2775
 
        for path, file_class, kind, file_id, entry in tree.list_files():
2776
 
            if file_class != 'I':
2777
 
                continue
2778
 
            ## XXX: Slightly inefficient since this was already calculated
2779
 
            pat = tree.is_ignored(path)
2780
 
            self.outf.write('%-50s %s\n' % (path, pat))
 
2242
        try:
 
2243
            for path, file_class, kind, file_id, entry in tree.list_files():
 
2244
                if file_class != 'I':
 
2245
                    continue
 
2246
                ## XXX: Slightly inefficient since this was already calculated
 
2247
                pat = tree.is_ignored(path)
 
2248
                self.outf.write('%-50s %s\n' % (path, pat))
 
2249
        finally:
 
2250
            tree.unlock()
2781
2251
 
2782
2252
 
2783
2253
class cmd_lookup_revision(Command):
2784
 
    __doc__ = """Lookup the revision-id from a revision-number
 
2254
    """Lookup the revision-id from a revision-number
2785
2255
 
2786
2256
    :Examples:
2787
2257
        bzr lookup-revision 33
2788
2258
    """
2789
2259
    hidden = True
2790
2260
    takes_args = ['revno']
2791
 
 
 
2261
    
2792
2262
    @display_command
2793
2263
    def run(self, revno):
2794
2264
        try:
2795
2265
            revno = int(revno)
2796
2266
        except ValueError:
2797
 
            raise errors.BzrCommandError("not a valid revision-number: %r"
2798
 
                                         % revno)
2799
 
        revid = WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
2800
 
        self.outf.write("%s\n" % revid)
 
2267
            raise errors.BzrCommandError("not a valid revision-number: %r" % revno)
 
2268
 
 
2269
        print WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
2801
2270
 
2802
2271
 
2803
2272
class cmd_export(Command):
2804
 
    __doc__ = """Export current or past revision to a destination directory or archive.
 
2273
    """Export current or past revision to a destination directory or archive.
2805
2274
 
2806
2275
    If no revision is specified this exports the last committed revision.
2807
2276
 
2834
2303
               help="Type of file to export to.",
2835
2304
               type=unicode),
2836
2305
        'revision',
2837
 
        Option('filters', help='Apply content filters to export the '
2838
 
                'convenient form.'),
2839
2306
        Option('root',
2840
2307
               type=str,
2841
2308
               help="Name of the root directory inside the exported file."),
2842
 
        Option('per-file-timestamps',
2843
 
               help='Set modification time of files to that of the last '
2844
 
                    'revision in which it was changed.'),
2845
2309
        ]
2846
2310
    def run(self, dest, branch_or_subdir=None, revision=None, format=None,
2847
 
        root=None, filters=False, per_file_timestamps=False):
 
2311
        root=None):
2848
2312
        from bzrlib.export import export
2849
2313
 
2850
2314
        if branch_or_subdir is None:
2857
2321
 
2858
2322
        rev_tree = _get_one_revision_tree('export', revision, branch=b, tree=tree)
2859
2323
        try:
2860
 
            export(rev_tree, dest, format, root, subdir, filtered=filters,
2861
 
                   per_file_timestamps=per_file_timestamps)
 
2324
            export(rev_tree, dest, format, root, subdir)
2862
2325
        except errors.NoSuchExportFormat, e:
2863
2326
            raise errors.BzrCommandError('Unsupported export format: %s' % e.format)
2864
2327
 
2865
2328
 
2866
2329
class cmd_cat(Command):
2867
 
    __doc__ = """Write the contents of a file as of a given revision to standard output.
 
2330
    """Write the contents of a file as of a given revision to standard output.
2868
2331
 
2869
2332
    If no revision is nominated, the last revision is used.
2870
2333
 
2871
2334
    Note: Take care to redirect standard output when using this command on a
2872
 
    binary file.
 
2335
    binary file. 
2873
2336
    """
2874
2337
 
2875
2338
    _see_also = ['ls']
2876
2339
    takes_options = [
2877
2340
        Option('name-from-revision', help='The path name in the old tree.'),
2878
 
        Option('filters', help='Apply content filters to display the '
2879
 
                'convenience form.'),
2880
2341
        'revision',
2881
2342
        ]
2882
2343
    takes_args = ['filename']
2883
2344
    encoding_type = 'exact'
2884
2345
 
2885
2346
    @display_command
2886
 
    def run(self, filename, revision=None, name_from_revision=False,
2887
 
            filters=False):
 
2347
    def run(self, filename, revision=None, name_from_revision=False):
2888
2348
        if revision is not None and len(revision) != 1:
2889
2349
            raise errors.BzrCommandError("bzr cat --revision takes exactly"
2890
2350
                                         " one revision specifier")
2891
2351
        tree, branch, relpath = \
2892
2352
            bzrdir.BzrDir.open_containing_tree_or_branch(filename)
2893
2353
        branch.lock_read()
2894
 
        self.add_cleanup(branch.unlock)
2895
 
        return self._run(tree, branch, relpath, filename, revision,
2896
 
                         name_from_revision, filters)
 
2354
        try:
 
2355
            return self._run(tree, branch, relpath, filename, revision,
 
2356
                             name_from_revision)
 
2357
        finally:
 
2358
            branch.unlock()
2897
2359
 
2898
 
    def _run(self, tree, b, relpath, filename, revision, name_from_revision,
2899
 
        filtered):
 
2360
    def _run(self, tree, b, relpath, filename, revision, name_from_revision):
2900
2361
        if tree is None:
2901
2362
            tree = b.basis_tree()
2902
2363
        rev_tree = _get_one_revision_tree('cat', revision, branch=b)
2903
 
        rev_tree.lock_read()
2904
 
        self.add_cleanup(rev_tree.unlock)
2905
2364
 
 
2365
        cur_file_id = tree.path2id(relpath)
2906
2366
        old_file_id = rev_tree.path2id(relpath)
2907
2367
 
2908
2368
        if name_from_revision:
2909
 
            # Try in revision if requested
2910
2369
            if old_file_id is None:
2911
2370
                raise errors.BzrCommandError(
2912
2371
                    "%r is not present in revision %s" % (
2913
2372
                        filename, rev_tree.get_revision_id()))
2914
2373
            else:
2915
2374
                content = rev_tree.get_file_text(old_file_id)
2916
 
        else:
2917
 
            cur_file_id = tree.path2id(relpath)
2918
 
            found = False
2919
 
            if cur_file_id is not None:
2920
 
                # Then try with the actual file id
2921
 
                try:
2922
 
                    content = rev_tree.get_file_text(cur_file_id)
2923
 
                    found = True
2924
 
                except errors.NoSuchId:
2925
 
                    # The actual file id didn't exist at that time
2926
 
                    pass
2927
 
            if not found and old_file_id is not None:
2928
 
                # Finally try with the old file id
2929
 
                content = rev_tree.get_file_text(old_file_id)
2930
 
                found = True
2931
 
            if not found:
2932
 
                # Can't be found anywhere
2933
 
                raise errors.BzrCommandError(
2934
 
                    "%r is not present in revision %s" % (
2935
 
                        filename, rev_tree.get_revision_id()))
2936
 
        if filtered:
2937
 
            from bzrlib.filters import (
2938
 
                ContentFilterContext,
2939
 
                filtered_output_bytes,
2940
 
                )
2941
 
            filters = rev_tree._content_filter_stack(relpath)
2942
 
            chunks = content.splitlines(True)
2943
 
            content = filtered_output_bytes(chunks, filters,
2944
 
                ContentFilterContext(relpath, rev_tree))
2945
 
            self.cleanup_now()
2946
 
            self.outf.writelines(content)
2947
 
        else:
2948
 
            self.cleanup_now()
2949
 
            self.outf.write(content)
 
2375
        elif cur_file_id is not None:
 
2376
            content = rev_tree.get_file_text(cur_file_id)
 
2377
        elif old_file_id is not None:
 
2378
            content = rev_tree.get_file_text(old_file_id)
 
2379
        else:
 
2380
            raise errors.BzrCommandError(
 
2381
                "%r is not present in revision %s" % (
 
2382
                    filename, rev_tree.get_revision_id()))
 
2383
        self.outf.write(content)
2950
2384
 
2951
2385
 
2952
2386
class cmd_local_time_offset(Command):
2953
 
    __doc__ = """Show the offset in seconds from GMT to local time."""
2954
 
    hidden = True
 
2387
    """Show the offset in seconds from GMT to local time."""
 
2388
    hidden = True    
2955
2389
    @display_command
2956
2390
    def run(self):
2957
 
        self.outf.write("%s\n" % osutils.local_time_offset())
 
2391
        print osutils.local_time_offset()
2958
2392
 
2959
2393
 
2960
2394
 
2961
2395
class cmd_commit(Command):
2962
 
    __doc__ = """Commit changes into a new revision.
2963
 
 
2964
 
    An explanatory message needs to be given for each commit. This is
2965
 
    often done by using the --message option (getting the message from the
2966
 
    command line) or by using the --file option (getting the message from
2967
 
    a file). If neither of these options is given, an editor is opened for
2968
 
    the user to enter the message. To see the changed files in the
2969
 
    boilerplate text loaded into the editor, use the --show-diff option.
2970
 
 
2971
 
    By default, the entire tree is committed and the person doing the
2972
 
    commit is assumed to be the author. These defaults can be overridden
2973
 
    as explained below.
2974
 
 
2975
 
    :Selective commits:
2976
 
 
2977
 
      If selected files are specified, only changes to those files are
2978
 
      committed.  If a directory is specified then the directory and
2979
 
      everything within it is committed.
2980
 
  
2981
 
      When excludes are given, they take precedence over selected files.
2982
 
      For example, to commit only changes within foo, but not changes
2983
 
      within foo/bar::
2984
 
  
2985
 
        bzr commit foo -x foo/bar
2986
 
  
2987
 
      A selective commit after a merge is not yet supported.
2988
 
 
2989
 
    :Custom authors:
2990
 
 
2991
 
      If the author of the change is not the same person as the committer,
2992
 
      you can specify the author's name using the --author option. The
2993
 
      name should be in the same format as a committer-id, e.g.
2994
 
      "John Doe <jdoe@example.com>". If there is more than one author of
2995
 
      the change you can specify the option multiple times, once for each
2996
 
      author.
2997
 
  
2998
 
    :Checks:
2999
 
 
3000
 
      A common mistake is to forget to add a new file or directory before
3001
 
      running the commit command. The --strict option checks for unknown
3002
 
      files and aborts the commit if any are found. More advanced pre-commit
3003
 
      checks can be implemented by defining hooks. See ``bzr help hooks``
3004
 
      for details.
3005
 
 
3006
 
    :Things to note:
3007
 
 
3008
 
      If you accidentially commit the wrong changes or make a spelling
3009
 
      mistake in the commit message say, you can use the uncommit command
3010
 
      to undo it. See ``bzr help uncommit`` for details.
3011
 
 
3012
 
      Hooks can also be configured to run after a commit. This allows you
3013
 
      to trigger updates to external systems like bug trackers. The --fixes
3014
 
      option can be used to record the association between a revision and
3015
 
      one or more bugs. See ``bzr help bugs`` for details.
3016
 
 
3017
 
      A selective commit may fail in some cases where the committed
3018
 
      tree would be invalid. Consider::
3019
 
  
3020
 
        bzr init foo
3021
 
        mkdir foo/bar
3022
 
        bzr add foo/bar
3023
 
        bzr commit foo -m "committing foo"
3024
 
        bzr mv foo/bar foo/baz
3025
 
        mkdir foo/bar
3026
 
        bzr add foo/bar
3027
 
        bzr commit foo/bar -m "committing bar but not baz"
3028
 
  
3029
 
      In the example above, the last commit will fail by design. This gives
3030
 
      the user the opportunity to decide whether they want to commit the
3031
 
      rename at the same time, separately first, or not at all. (As a general
3032
 
      rule, when in doubt, Bazaar has a policy of Doing the Safe Thing.)
 
2396
    """Commit changes into a new revision.
 
2397
    
 
2398
    If no arguments are given, the entire tree is committed.
 
2399
 
 
2400
    If selected files are specified, only changes to those files are
 
2401
    committed.  If a directory is specified then the directory and everything 
 
2402
    within it is committed.
 
2403
 
 
2404
    When excludes are given, they take precedence over selected files.
 
2405
    For example, too commit only changes within foo, but not changes within
 
2406
    foo/bar::
 
2407
 
 
2408
      bzr commit foo -x foo/bar
 
2409
 
 
2410
    If author of the change is not the same person as the committer, you can
 
2411
    specify the author's name using the --author option. The name should be
 
2412
    in the same format as a committer-id, e.g. "John Doe <jdoe@example.com>".
 
2413
 
 
2414
    A selected-file commit may fail in some cases where the committed
 
2415
    tree would be invalid. Consider::
 
2416
 
 
2417
      bzr init foo
 
2418
      mkdir foo/bar
 
2419
      bzr add foo/bar
 
2420
      bzr commit foo -m "committing foo"
 
2421
      bzr mv foo/bar foo/baz
 
2422
      mkdir foo/bar
 
2423
      bzr add foo/bar
 
2424
      bzr commit foo/bar -m "committing bar but not baz"
 
2425
 
 
2426
    In the example above, the last commit will fail by design. This gives
 
2427
    the user the opportunity to decide whether they want to commit the
 
2428
    rename at the same time, separately first, or not at all. (As a general
 
2429
    rule, when in doubt, Bazaar has a policy of Doing the Safe Thing.)
 
2430
 
 
2431
    Note: A selected-file commit after a merge is not yet supported.
3033
2432
    """
3034
2433
    # TODO: Run hooks on tree to-be-committed, and after commit.
3035
2434
 
3040
2439
 
3041
2440
    # XXX: verbose currently does nothing
3042
2441
 
3043
 
    _see_also = ['add', 'bugs', 'hooks', 'uncommit']
 
2442
    _see_also = ['bugs', 'uncommit']
3044
2443
    takes_args = ['selected*']
3045
2444
    takes_options = [
3046
2445
            ListOption('exclude', type=str, short_name='x',
3058
2457
             Option('strict',
3059
2458
                    help="Refuse to commit if there are unknown "
3060
2459
                    "files in the working tree."),
3061
 
             Option('commit-time', type=str,
3062
 
                    help="Manually set a commit time using commit date "
3063
 
                    "format, e.g. '2009-10-10 08:00:00 +0100'."),
3064
2460
             ListOption('fixes', type=str,
3065
 
                    help="Mark a bug as being fixed by this revision "
3066
 
                         "(see \"bzr help bugs\")."),
3067
 
             ListOption('author', type=unicode,
 
2461
                    help="Mark a bug as being fixed by this revision."),
 
2462
             Option('author', type=unicode,
3068
2463
                    help="Set the author's name, if it's different "
3069
2464
                         "from the committer."),
3070
2465
             Option('local',
3073
2468
                         "the master branch until a normal commit "
3074
2469
                         "is performed."
3075
2470
                    ),
3076
 
             Option('show-diff', short_name='p',
3077
 
                    help='When no message is supplied, show the diff along'
3078
 
                    ' with the status summary in the message editor.'),
 
2471
              Option('show-diff',
 
2472
                     help='When no message is supplied, show the diff along'
 
2473
                     ' with the status summary in the message editor.'),
3079
2474
             ]
3080
2475
    aliases = ['ci', 'checkin']
3081
2476
 
3082
 
    def _iter_bug_fix_urls(self, fixes, branch):
 
2477
    def _get_bug_fix_properties(self, fixes, branch):
 
2478
        properties = []
3083
2479
        # Configure the properties for bug fixing attributes.
3084
2480
        for fixed_bug in fixes:
3085
2481
            tokens = fixed_bug.split(':')
3086
2482
            if len(tokens) != 2:
3087
2483
                raise errors.BzrCommandError(
3088
 
                    "Invalid bug %s. Must be in the form of 'tracker:id'. "
3089
 
                    "See \"bzr help bugs\" for more information on this "
3090
 
                    "feature.\nCommit refused." % fixed_bug)
 
2484
                    "Invalid bug %s. Must be in the form of 'tag:id'. "
 
2485
                    "Commit refused." % fixed_bug)
3091
2486
            tag, bug_id = tokens
3092
2487
            try:
3093
 
                yield bugtracker.get_bug_url(tag, branch, bug_id)
 
2488
                bug_url = bugtracker.get_bug_url(tag, branch, bug_id)
3094
2489
            except errors.UnknownBugTrackerAbbreviation:
3095
2490
                raise errors.BzrCommandError(
3096
2491
                    'Unrecognized bug %s. Commit refused.' % fixed_bug)
3097
 
            except errors.MalformedBugIdentifier, e:
 
2492
            except errors.MalformedBugIdentifier:
3098
2493
                raise errors.BzrCommandError(
3099
 
                    "%s\nCommit refused." % (str(e),))
 
2494
                    "Invalid bug identifier for %s. Commit refused."
 
2495
                    % fixed_bug)
 
2496
            properties.append('%s fixed' % bug_url)
 
2497
        return '\n'.join(properties)
3100
2498
 
3101
2499
    def run(self, message=None, file=None, verbose=False, selected_list=None,
3102
2500
            unchanged=False, strict=False, local=False, fixes=None,
3103
 
            author=None, show_diff=False, exclude=None, commit_time=None):
 
2501
            author=None, show_diff=False, exclude=None):
3104
2502
        from bzrlib.errors import (
3105
2503
            PointlessCommit,
3106
2504
            ConflictsInTree,
3112
2510
            make_commit_message_template_encoded
3113
2511
        )
3114
2512
 
3115
 
        commit_stamp = offset = None
3116
 
        if commit_time is not None:
3117
 
            try:
3118
 
                commit_stamp, offset = timestamp.parse_patch_date(commit_time)
3119
 
            except ValueError, e:
3120
 
                raise errors.BzrCommandError(
3121
 
                    "Could not parse --commit-time: " + str(e))
3122
 
 
3123
2513
        # TODO: Need a blackbox test for invoking the external editor; may be
3124
2514
        # slightly problematic to run this cross-platform.
3125
2515
 
3126
 
        # TODO: do more checks that the commit will succeed before
 
2516
        # TODO: do more checks that the commit will succeed before 
3127
2517
        # spending the user's valuable time typing a commit message.
3128
2518
 
3129
2519
        properties = {}
3137
2527
 
3138
2528
        if fixes is None:
3139
2529
            fixes = []
3140
 
        bug_property = bugtracker.encode_fixes_bug_urls(
3141
 
            self._iter_bug_fix_urls(fixes, tree.branch))
 
2530
        bug_property = self._get_bug_fix_properties(fixes, tree.branch)
3142
2531
        if bug_property:
3143
2532
            properties['bugs'] = bug_property
3144
2533
 
3145
2534
        if local and not tree.branch.get_bound_location():
3146
2535
            raise errors.LocalRequiresBoundBranch()
3147
2536
 
3148
 
        if message is not None:
3149
 
            try:
3150
 
                file_exists = osutils.lexists(message)
3151
 
            except UnicodeError:
3152
 
                # The commit message contains unicode characters that can't be
3153
 
                # represented in the filesystem encoding, so that can't be a
3154
 
                # file.
3155
 
                file_exists = False
3156
 
            if file_exists:
3157
 
                warning_msg = (
3158
 
                    'The commit message is a file name: "%(f)s".\n'
3159
 
                    '(use --file "%(f)s" to take commit message from that file)'
3160
 
                    % { 'f': message })
3161
 
                ui.ui_factory.show_warning(warning_msg)
3162
 
            if '\r' in message:
3163
 
                message = message.replace('\r\n', '\n')
3164
 
                message = message.replace('\r', '\n')
3165
 
            if file:
3166
 
                raise errors.BzrCommandError(
3167
 
                    "please specify either --message or --file")
3168
 
 
3169
2537
        def get_message(commit_obj):
3170
2538
            """Callback to get commit message"""
3171
 
            if file:
3172
 
                my_message = codecs.open(
3173
 
                    file, 'rt', osutils.get_user_encoding()).read()
3174
 
            elif message is not None:
3175
 
                my_message = message
3176
 
            else:
3177
 
                # No message supplied: make one up.
3178
 
                # text is the status of the tree
3179
 
                text = make_commit_message_template_encoded(tree,
 
2539
            my_message = message
 
2540
            if my_message is None and not file:
 
2541
                t = make_commit_message_template_encoded(tree,
3180
2542
                        selected_list, diff=show_diff,
3181
2543
                        output_encoding=osutils.get_user_encoding())
3182
 
                # start_message is the template generated from hooks
3183
 
                # XXX: Warning - looks like hooks return unicode,
3184
 
                # make_commit_message_template_encoded returns user encoding.
3185
 
                # We probably want to be using edit_commit_message instead to
3186
 
                # avoid this.
3187
2544
                start_message = generate_commit_message_template(commit_obj)
3188
 
                my_message = edit_commit_message_encoded(text,
 
2545
                my_message = edit_commit_message_encoded(t, 
3189
2546
                    start_message=start_message)
3190
2547
                if my_message is None:
3191
2548
                    raise errors.BzrCommandError("please specify a commit"
3192
2549
                        " message with either --message or --file")
 
2550
            elif my_message and file:
 
2551
                raise errors.BzrCommandError(
 
2552
                    "please specify either --message or --file")
 
2553
            if file:
 
2554
                my_message = codecs.open(file, 'rt',
 
2555
                                         osutils.get_user_encoding()).read()
3193
2556
            if my_message == "":
3194
2557
                raise errors.BzrCommandError("empty commit message specified")
3195
2558
            return my_message
3196
2559
 
3197
 
        # The API permits a commit with a filter of [] to mean 'select nothing'
3198
 
        # but the command line should not do that.
3199
 
        if not selected_list:
3200
 
            selected_list = None
3201
2560
        try:
3202
2561
            tree.commit(message_callback=get_message,
3203
2562
                        specific_files=selected_list,
3204
2563
                        allow_pointless=unchanged, strict=strict, local=local,
3205
2564
                        reporter=None, verbose=verbose, revprops=properties,
3206
 
                        authors=author, timestamp=commit_stamp,
3207
 
                        timezone=offset,
 
2565
                        author=author,
3208
2566
                        exclude=safe_relpath_files(tree, exclude))
3209
2567
        except PointlessCommit:
3210
 
            raise errors.BzrCommandError("No changes to commit."
3211
 
                              " Use --unchanged to commit anyhow.")
 
2568
            # FIXME: This should really happen before the file is read in;
 
2569
            # perhaps prepare the commit; get the message; then actually commit
 
2570
            raise errors.BzrCommandError("no changes to commit."
 
2571
                              " use --unchanged to commit anyhow")
3212
2572
        except ConflictsInTree:
3213
2573
            raise errors.BzrCommandError('Conflicts detected in working '
3214
2574
                'tree.  Use "bzr conflicts" to list, "bzr resolve FILE" to'
3217
2577
            raise errors.BzrCommandError("Commit refused because there are"
3218
2578
                              " unknown files in the working tree.")
3219
2579
        except errors.BoundBranchOutOfDate, e:
3220
 
            e.extra_help = ("\n"
3221
 
                'To commit to master branch, run update and then commit.\n'
3222
 
                'You can also pass --local to commit to continue working '
3223
 
                'disconnected.')
3224
 
            raise
 
2580
            raise errors.BzrCommandError(str(e) + "\n"
 
2581
            'To commit to master branch, run update and then commit.\n'
 
2582
            'You can also pass --local to commit to continue working '
 
2583
            'disconnected.')
3225
2584
 
3226
2585
 
3227
2586
class cmd_check(Command):
3228
 
    __doc__ = """Validate working tree structure, branch consistency and repository history.
 
2587
    """Validate working tree structure, branch consistency and repository history.
3229
2588
 
3230
2589
    This command checks various invariants about branch and repository storage
3231
2590
    to detect data corruption or bzr bugs.
3233
2592
    The working tree and branch checks will only give output if a problem is
3234
2593
    detected. The output fields of the repository check are:
3235
2594
 
3236
 
    revisions
3237
 
        This is just the number of revisions checked.  It doesn't
3238
 
        indicate a problem.
3239
 
 
3240
 
    versionedfiles
3241
 
        This is just the number of versionedfiles checked.  It
3242
 
        doesn't indicate a problem.
3243
 
 
3244
 
    unreferenced ancestors
3245
 
        Texts that are ancestors of other texts, but
3246
 
        are not properly referenced by the revision ancestry.  This is a
3247
 
        subtle problem that Bazaar can work around.
3248
 
 
3249
 
    unique file texts
3250
 
        This is the total number of unique file contents
3251
 
        seen in the checked revisions.  It does not indicate a problem.
3252
 
 
3253
 
    repeated file texts
3254
 
        This is the total number of repeated texts seen
3255
 
        in the checked revisions.  Texts can be repeated when their file
3256
 
        entries are modified, but the file contents are not.  It does not
3257
 
        indicate a problem.
 
2595
        revisions: This is just the number of revisions checked.  It doesn't
 
2596
            indicate a problem.
 
2597
        versionedfiles: This is just the number of versionedfiles checked.  It
 
2598
            doesn't indicate a problem.
 
2599
        unreferenced ancestors: Texts that are ancestors of other texts, but
 
2600
            are not properly referenced by the revision ancestry.  This is a
 
2601
            subtle problem that Bazaar can work around.
 
2602
        unique file texts: This is the total number of unique file contents
 
2603
            seen in the checked revisions.  It does not indicate a problem.
 
2604
        repeated file texts: This is the total number of repeated texts seen
 
2605
            in the checked revisions.  Texts can be repeated when their file
 
2606
            entries are modified, but the file contents are not.  It does not
 
2607
            indicate a problem.
3258
2608
 
3259
2609
    If no restrictions are specified, all Bazaar data that is found at the given
3260
2610
    location will be checked.
3295
2645
 
3296
2646
 
3297
2647
class cmd_upgrade(Command):
3298
 
    __doc__ = """Upgrade branch storage to current format.
 
2648
    """Upgrade branch storage to current format.
3299
2649
 
3300
2650
    The check command or bzr developers may sometimes advise you to run
3301
2651
    this command. When the default format has changed you may also be warned
3315
2665
 
3316
2666
    def run(self, url='.', format=None):
3317
2667
        from bzrlib.upgrade import upgrade
 
2668
        if format is None:
 
2669
            format = bzrdir.format_registry.make_bzrdir('default')
3318
2670
        upgrade(url, format)
3319
2671
 
3320
2672
 
3321
2673
class cmd_whoami(Command):
3322
 
    __doc__ = """Show or set bzr user id.
3323
 
 
 
2674
    """Show or set bzr user id.
 
2675
    
3324
2676
    :Examples:
3325
2677
        Show the email of the current user::
3326
2678
 
3338
2690
                    ]
3339
2691
    takes_args = ['name?']
3340
2692
    encoding_type = 'replace'
3341
 
 
 
2693
    
3342
2694
    @display_command
3343
2695
    def run(self, email=False, branch=False, name=None):
3344
2696
        if name is None:
3359
2711
        except errors.NoEmailInUsername, e:
3360
2712
            warning('"%s" does not seem to contain an email address.  '
3361
2713
                    'This is allowed, but not recommended.', name)
3362
 
 
 
2714
        
3363
2715
        # use global config unless --branch given
3364
2716
        if branch:
3365
2717
            c = Branch.open_containing('.')[0].get_config()
3369
2721
 
3370
2722
 
3371
2723
class cmd_nick(Command):
3372
 
    __doc__ = """Print or set the branch nickname.
 
2724
    """Print or set the branch nickname.
3373
2725
 
3374
2726
    If unset, the tree root directory name is used as the nickname.
3375
2727
    To print the current nickname, execute with no argument.
3389
2741
 
3390
2742
    @display_command
3391
2743
    def printme(self, branch):
3392
 
        self.outf.write('%s\n' % branch.nick)
 
2744
        print branch.nick
3393
2745
 
3394
2746
 
3395
2747
class cmd_alias(Command):
3396
 
    __doc__ = """Set/unset and display aliases.
 
2748
    """Set/unset and display aliases.
3397
2749
 
3398
2750
    :Examples:
3399
2751
        Show the current aliases::
3463
2815
 
3464
2816
 
3465
2817
class cmd_selftest(Command):
3466
 
    __doc__ = """Run internal test suite.
3467
 
 
 
2818
    """Run internal test suite.
 
2819
    
3468
2820
    If arguments are given, they are regular expressions that say which tests
3469
2821
    should run.  Tests matching any expression are run, and other tests are
3470
2822
    not run.
3493
2845
    modified by plugins will not be tested, and tests provided by plugins will
3494
2846
    not be run.
3495
2847
 
3496
 
    Tests that need working space on disk use a common temporary directory,
 
2848
    Tests that need working space on disk use a common temporary directory, 
3497
2849
    typically inside $TMPDIR or /tmp.
3498
2850
 
3499
 
    If you set BZR_TEST_PDB=1 when running selftest, failing tests will drop
3500
 
    into a pdb postmortem session.
3501
 
 
3502
2851
    :Examples:
3503
2852
        Run only tests relating to 'ignore'::
3504
2853
 
3513
2862
    def get_transport_type(typestring):
3514
2863
        """Parse and return a transport specifier."""
3515
2864
        if typestring == "sftp":
3516
 
            from bzrlib.tests import stub_sftp
3517
 
            return stub_sftp.SFTPAbsoluteServer
 
2865
            from bzrlib.transport.sftp import SFTPAbsoluteServer
 
2866
            return SFTPAbsoluteServer
3518
2867
        if typestring == "memory":
3519
 
            from bzrlib.tests import test_server
3520
 
            return memory.MemoryServer
 
2868
            from bzrlib.transport.memory import MemoryServer
 
2869
            return MemoryServer
3521
2870
        if typestring == "fakenfs":
3522
 
            from bzrlib.tests import test_server
3523
 
            return test_server.FakeNFSServer
 
2871
            from bzrlib.transport.fakenfs import FakeNFSServer
 
2872
            return FakeNFSServer
3524
2873
        msg = "No known transport type %s. Supported types are: sftp\n" %\
3525
2874
            (typestring)
3526
2875
        raise errors.BzrCommandError(msg)
3541
2890
                     Option('lsprof-timed',
3542
2891
                            help='Generate lsprof output for benchmarked'
3543
2892
                                 ' sections of code.'),
3544
 
                     Option('lsprof-tests',
3545
 
                            help='Generate lsprof output for each test.'),
3546
2893
                     Option('cache-dir', type=str,
3547
2894
                            help='Cache intermediate benchmark output in this '
3548
2895
                                 'directory.'),
3552
2899
                            ),
3553
2900
                     Option('list-only',
3554
2901
                            help='List the tests instead of running them.'),
3555
 
                     RegistryOption('parallel',
3556
 
                        help="Run the test suite in parallel.",
3557
 
                        lazy_registry=('bzrlib.tests', 'parallel_registry'),
3558
 
                        value_switches=False,
3559
 
                        ),
3560
2902
                     Option('randomize', type=str, argname="SEED",
3561
2903
                            help='Randomize the order of tests using the given'
3562
2904
                                 ' seed or "now" for the current time.'),
3564
2906
                            short_name='x',
3565
2907
                            help='Exclude tests that match this regular'
3566
2908
                                 ' expression.'),
3567
 
                     Option('subunit',
3568
 
                        help='Output test progress via subunit.'),
3569
2909
                     Option('strict', help='Fail on missing dependencies or '
3570
2910
                            'known failures.'),
3571
2911
                     Option('load-list', type=str, argname='TESTLISTFILE',
3579
2919
                     ]
3580
2920
    encoding_type = 'replace'
3581
2921
 
3582
 
    def __init__(self):
3583
 
        Command.__init__(self)
3584
 
        self.additional_selftest_args = {}
3585
 
 
3586
2922
    def run(self, testspecs_list=None, verbose=False, one=False,
3587
2923
            transport=None, benchmark=None,
3588
2924
            lsprof_timed=None, cache_dir=None,
3589
2925
            first=False, list_only=False,
3590
2926
            randomize=None, exclude=None, strict=False,
3591
 
            load_list=None, debugflag=None, starting_with=None, subunit=False,
3592
 
            parallel=None, lsprof_tests=False):
 
2927
            load_list=None, debugflag=None, starting_with=None):
3593
2928
        from bzrlib.tests import selftest
3594
2929
        import bzrlib.benchmarks as benchmarks
3595
2930
        from bzrlib.benchmarks import tree_creator
3599
2934
 
3600
2935
        if cache_dir is not None:
3601
2936
            tree_creator.TreeCreator.CACHE_ROOT = osutils.abspath(cache_dir)
 
2937
        if not list_only:
 
2938
            print 'testing: %s' % (osutils.realpath(sys.argv[0]),)
 
2939
            print '   %s (%s python%s)' % (
 
2940
                    bzrlib.__path__[0],
 
2941
                    bzrlib.version_string,
 
2942
                    bzrlib._format_version_tuple(sys.version_info),
 
2943
                    )
 
2944
        print
3602
2945
        if testspecs_list is not None:
3603
2946
            pattern = '|'.join(testspecs_list)
3604
2947
        else:
3605
2948
            pattern = ".*"
3606
 
        if subunit:
3607
 
            try:
3608
 
                from bzrlib.tests import SubUnitBzrRunner
3609
 
            except ImportError:
3610
 
                raise errors.BzrCommandError("subunit not available. subunit "
3611
 
                    "needs to be installed to use --subunit.")
3612
 
            self.additional_selftest_args['runner_class'] = SubUnitBzrRunner
3613
 
            # On Windows, disable automatic conversion of '\n' to '\r\n' in
3614
 
            # stdout, which would corrupt the subunit stream. 
3615
 
            if sys.platform == "win32" and sys.stdout.fileno() >= 0:
3616
 
                import msvcrt
3617
 
                msvcrt.setmode(sys.stdout.fileno(), os.O_BINARY)
3618
 
        if parallel:
3619
 
            self.additional_selftest_args.setdefault(
3620
 
                'suite_decorators', []).append(parallel)
3621
2949
        if benchmark:
3622
2950
            test_suite_factory = benchmarks.test_suite
3623
2951
            # Unless user explicitly asks for quiet, be verbose in benchmarks
3624
2952
            verbose = not is_quiet()
3625
2953
            # TODO: should possibly lock the history file...
3626
2954
            benchfile = open(".perf_history", "at", buffering=1)
3627
 
            self.add_cleanup(benchfile.close)
3628
2955
        else:
3629
2956
            test_suite_factory = None
3630
2957
            benchfile = None
3631
 
        selftest_kwargs = {"verbose": verbose,
3632
 
                          "pattern": pattern,
3633
 
                          "stop_on_failure": one,
3634
 
                          "transport": transport,
3635
 
                          "test_suite_factory": test_suite_factory,
3636
 
                          "lsprof_timed": lsprof_timed,
3637
 
                          "lsprof_tests": lsprof_tests,
3638
 
                          "bench_history": benchfile,
3639
 
                          "matching_tests_first": first,
3640
 
                          "list_only": list_only,
3641
 
                          "random_seed": randomize,
3642
 
                          "exclude_pattern": exclude,
3643
 
                          "strict": strict,
3644
 
                          "load_list": load_list,
3645
 
                          "debug_flags": debugflag,
3646
 
                          "starting_with": starting_with
3647
 
                          }
3648
 
        selftest_kwargs.update(self.additional_selftest_args)
3649
 
        result = selftest(**selftest_kwargs)
 
2958
        try:
 
2959
            result = selftest(verbose=verbose,
 
2960
                              pattern=pattern,
 
2961
                              stop_on_failure=one,
 
2962
                              transport=transport,
 
2963
                              test_suite_factory=test_suite_factory,
 
2964
                              lsprof_timed=lsprof_timed,
 
2965
                              bench_history=benchfile,
 
2966
                              matching_tests_first=first,
 
2967
                              list_only=list_only,
 
2968
                              random_seed=randomize,
 
2969
                              exclude_pattern=exclude,
 
2970
                              strict=strict,
 
2971
                              load_list=load_list,
 
2972
                              debug_flags=debugflag,
 
2973
                              starting_with=starting_with,
 
2974
                              )
 
2975
        finally:
 
2976
            if benchfile is not None:
 
2977
                benchfile.close()
 
2978
        if result:
 
2979
            note('tests passed')
 
2980
        else:
 
2981
            note('tests failed')
3650
2982
        return int(not result)
3651
2983
 
3652
2984
 
3653
2985
class cmd_version(Command):
3654
 
    __doc__ = """Show version of bzr."""
 
2986
    """Show version of bzr."""
3655
2987
 
3656
2988
    encoding_type = 'replace'
3657
2989
    takes_options = [
3668
3000
 
3669
3001
 
3670
3002
class cmd_rocks(Command):
3671
 
    __doc__ = """Statement of optimism."""
 
3003
    """Statement of optimism."""
3672
3004
 
3673
3005
    hidden = True
3674
3006
 
3675
3007
    @display_command
3676
3008
    def run(self):
3677
 
        self.outf.write("It sure does!\n")
 
3009
        print "It sure does!"
3678
3010
 
3679
3011
 
3680
3012
class cmd_find_merge_base(Command):
3681
 
    __doc__ = """Find and print a base revision for merging two branches."""
 
3013
    """Find and print a base revision for merging two branches."""
3682
3014
    # TODO: Options to specify revisions on either side, as if
3683
3015
    #       merging only part of the history.
3684
3016
    takes_args = ['branch', 'other']
3685
3017
    hidden = True
3686
 
 
 
3018
    
3687
3019
    @display_command
3688
3020
    def run(self, branch, other):
3689
3021
        from bzrlib.revision import ensure_null
3690
 
 
 
3022
        
3691
3023
        branch1 = Branch.open_containing(branch)[0]
3692
3024
        branch2 = Branch.open_containing(other)[0]
3693
3025
        branch1.lock_read()
3694
 
        self.add_cleanup(branch1.unlock)
3695
 
        branch2.lock_read()
3696
 
        self.add_cleanup(branch2.unlock)
3697
 
        last1 = ensure_null(branch1.last_revision())
3698
 
        last2 = ensure_null(branch2.last_revision())
3699
 
 
3700
 
        graph = branch1.repository.get_graph(branch2.repository)
3701
 
        base_rev_id = graph.find_unique_lca(last1, last2)
3702
 
 
3703
 
        self.outf.write('merge base is revision %s\n' % base_rev_id)
 
3026
        try:
 
3027
            branch2.lock_read()
 
3028
            try:
 
3029
                last1 = ensure_null(branch1.last_revision())
 
3030
                last2 = ensure_null(branch2.last_revision())
 
3031
 
 
3032
                graph = branch1.repository.get_graph(branch2.repository)
 
3033
                base_rev_id = graph.find_unique_lca(last1, last2)
 
3034
 
 
3035
                print 'merge base is revision %s' % base_rev_id
 
3036
            finally:
 
3037
                branch2.unlock()
 
3038
        finally:
 
3039
            branch1.unlock()
3704
3040
 
3705
3041
 
3706
3042
class cmd_merge(Command):
3707
 
    __doc__ = """Perform a three-way merge.
3708
 
 
 
3043
    """Perform a three-way merge.
 
3044
    
3709
3045
    The source of the merge can be specified either in the form of a branch,
3710
3046
    or in the form of a path to a file containing a merge directive generated
3711
3047
    with bzr send. If neither is specified, the default is the upstream branch
3721
3057
    By default, bzr will try to merge in all new work from the other
3722
3058
    branch, automatically determining an appropriate base.  If this
3723
3059
    fails, you may need to give an explicit base.
3724
 
 
 
3060
    
3725
3061
    Merge will do its best to combine the changes in two branches, but there
3726
3062
    are some kinds of problems only a human can fix.  When it encounters those,
3727
3063
    it will mark a conflict.  A conflict means that you need to fix something,
3737
3073
    The results of the merge are placed into the destination working
3738
3074
    directory, where they can be reviewed (with bzr diff), tested, and then
3739
3075
    committed to record the result of the merge.
3740
 
 
 
3076
    
3741
3077
    merge refuses to run if there are any uncommitted changes, unless
3742
 
    --force is given. The --force option can also be used to create a
3743
 
    merge revision which has more than two parents.
3744
 
 
3745
 
    If one would like to merge changes from the working tree of the other
3746
 
    branch without merging any committed revisions, the --uncommitted option
3747
 
    can be given.
3748
 
 
3749
 
    To select only some changes to merge, use "merge -i", which will prompt
3750
 
    you to apply each diff hunk and file change, similar to "shelve".
 
3078
    --force is given.
3751
3079
 
3752
3080
    :Examples:
3753
3081
        To merge the latest revision from bzr.dev::
3762
3090
 
3763
3091
            bzr merge -r 81..82 ../bzr.dev
3764
3092
 
3765
 
        To apply a merge directive contained in /tmp/merge::
 
3093
        To apply a merge directive contained in in /tmp/merge:
3766
3094
 
3767
3095
            bzr merge /tmp/merge
3768
 
 
3769
 
        To create a merge revision with three parents from two branches
3770
 
        feature1a and feature1b:
3771
 
 
3772
 
            bzr merge ../feature1a
3773
 
            bzr merge ../feature1b --force
3774
 
            bzr commit -m 'revision with three parents'
3775
3096
    """
3776
3097
 
3777
3098
    encoding_type = 'exact'
3778
 
    _see_also = ['update', 'remerge', 'status-flags', 'send']
 
3099
    _see_also = ['update', 'remerge', 'status-flags']
3779
3100
    takes_args = ['location?']
3780
3101
    takes_options = [
3781
3102
        'change',
3799
3120
               short_name='d',
3800
3121
               type=unicode,
3801
3122
               ),
3802
 
        Option('preview', help='Instead of merging, show a diff of the'
3803
 
               ' merge.'),
3804
 
        Option('interactive', help='Select changes interactively.',
3805
 
            short_name='i')
 
3123
        Option('preview', help='Instead of merging, show a diff of the merge.')
3806
3124
    ]
3807
3125
 
3808
3126
    def run(self, location=None, revision=None, force=False,
3810
3128
            uncommitted=False, pull=False,
3811
3129
            directory=None,
3812
3130
            preview=False,
3813
 
            interactive=False,
3814
3131
            ):
3815
3132
        if merge_type is None:
3816
3133
            merge_type = _mod_merge.Merge3Merger
3821
3138
        allow_pending = True
3822
3139
        verified = 'inapplicable'
3823
3140
        tree = WorkingTree.open_containing(directory)[0]
3824
 
 
 
3141
        change_reporter = delta._ChangeReporter(
 
3142
            unversioned_filter=tree.is_ignored)
 
3143
        cleanups = []
3825
3144
        try:
3826
 
            basis_tree = tree.revision_tree(tree.last_revision())
3827
 
        except errors.NoSuchRevision:
3828
 
            basis_tree = tree.basis_tree()
3829
 
 
3830
 
        # die as quickly as possible if there are uncommitted changes
3831
 
        if not force:
3832
 
            if tree.has_changes():
3833
 
                raise errors.UncommittedChanges(tree)
3834
 
 
3835
 
        view_info = _get_view_info_for_change_reporter(tree)
3836
 
        change_reporter = delta._ChangeReporter(
3837
 
            unversioned_filter=tree.is_ignored, view_info=view_info)
3838
 
        pb = ui.ui_factory.nested_progress_bar()
3839
 
        self.add_cleanup(pb.finished)
3840
 
        tree.lock_write()
3841
 
        self.add_cleanup(tree.unlock)
3842
 
        if location is not None:
3843
 
            try:
3844
 
                mergeable = bundle.read_mergeable_from_url(location,
3845
 
                    possible_transports=possible_transports)
3846
 
            except errors.NotABundle:
3847
 
                mergeable = None
 
3145
            pb = ui.ui_factory.nested_progress_bar()
 
3146
            cleanups.append(pb.finished)
 
3147
            tree.lock_write()
 
3148
            cleanups.append(tree.unlock)
 
3149
            if location is not None:
 
3150
                try:
 
3151
                    mergeable = bundle.read_mergeable_from_url(location,
 
3152
                        possible_transports=possible_transports)
 
3153
                except errors.NotABundle:
 
3154
                    mergeable = None
 
3155
                else:
 
3156
                    if uncommitted:
 
3157
                        raise errors.BzrCommandError('Cannot use --uncommitted'
 
3158
                            ' with bundles or merge directives.')
 
3159
 
 
3160
                    if revision is not None:
 
3161
                        raise errors.BzrCommandError(
 
3162
                            'Cannot use -r with merge directives or bundles')
 
3163
                    merger, verified = _mod_merge.Merger.from_mergeable(tree,
 
3164
                       mergeable, pb)
 
3165
 
 
3166
            if merger is None and uncommitted:
 
3167
                if revision is not None and len(revision) > 0:
 
3168
                    raise errors.BzrCommandError('Cannot use --uncommitted and'
 
3169
                        ' --revision at the same time.')
 
3170
                location = self._select_branch_location(tree, location)[0]
 
3171
                other_tree, other_path = WorkingTree.open_containing(location)
 
3172
                merger = _mod_merge.Merger.from_uncommitted(tree, other_tree,
 
3173
                    pb)
 
3174
                allow_pending = False
 
3175
                if other_path != '':
 
3176
                    merger.interesting_files = [other_path]
 
3177
 
 
3178
            if merger is None:
 
3179
                merger, allow_pending = self._get_merger_from_branch(tree,
 
3180
                    location, revision, remember, possible_transports, pb)
 
3181
 
 
3182
            merger.merge_type = merge_type
 
3183
            merger.reprocess = reprocess
 
3184
            merger.show_base = show_base
 
3185
            self.sanity_check_merger(merger)
 
3186
            if (merger.base_rev_id == merger.other_rev_id and
 
3187
                merger.other_rev_id is not None):
 
3188
                note('Nothing to do.')
 
3189
                return 0
 
3190
            if pull:
 
3191
                if merger.interesting_files is not None:
 
3192
                    raise errors.BzrCommandError('Cannot pull individual files')
 
3193
                if (merger.base_rev_id == tree.last_revision()):
 
3194
                    result = tree.pull(merger.other_branch, False,
 
3195
                                       merger.other_rev_id)
 
3196
                    result.report(self.outf)
 
3197
                    return 0
 
3198
            merger.check_basis(not force)
 
3199
            if preview:
 
3200
                return self._do_preview(merger)
3848
3201
            else:
3849
 
                if uncommitted:
3850
 
                    raise errors.BzrCommandError('Cannot use --uncommitted'
3851
 
                        ' with bundles or merge directives.')
3852
 
 
3853
 
                if revision is not None:
3854
 
                    raise errors.BzrCommandError(
3855
 
                        'Cannot use -r with merge directives or bundles')
3856
 
                merger, verified = _mod_merge.Merger.from_mergeable(tree,
3857
 
                   mergeable, None)
3858
 
 
3859
 
        if merger is None and uncommitted:
3860
 
            if revision is not None and len(revision) > 0:
3861
 
                raise errors.BzrCommandError('Cannot use --uncommitted and'
3862
 
                    ' --revision at the same time.')
3863
 
            merger = self.get_merger_from_uncommitted(tree, location, None)
3864
 
            allow_pending = False
3865
 
 
3866
 
        if merger is None:
3867
 
            merger, allow_pending = self._get_merger_from_branch(tree,
3868
 
                location, revision, remember, possible_transports, None)
3869
 
 
3870
 
        merger.merge_type = merge_type
3871
 
        merger.reprocess = reprocess
3872
 
        merger.show_base = show_base
3873
 
        self.sanity_check_merger(merger)
3874
 
        if (merger.base_rev_id == merger.other_rev_id and
3875
 
            merger.other_rev_id is not None):
3876
 
            note('Nothing to do.')
3877
 
            return 0
3878
 
        if pull:
3879
 
            if merger.interesting_files is not None:
3880
 
                raise errors.BzrCommandError('Cannot pull individual files')
3881
 
            if (merger.base_rev_id == tree.last_revision()):
3882
 
                result = tree.pull(merger.other_branch, False,
3883
 
                                   merger.other_rev_id)
3884
 
                result.report(self.outf)
3885
 
                return 0
3886
 
        if merger.this_basis is None:
3887
 
            raise errors.BzrCommandError(
3888
 
                "This branch has no commits."
3889
 
                " (perhaps you would prefer 'bzr pull')")
3890
 
        if preview:
3891
 
            return self._do_preview(merger)
3892
 
        elif interactive:
3893
 
            return self._do_interactive(merger)
3894
 
        else:
3895
 
            return self._do_merge(merger, change_reporter, allow_pending,
3896
 
                                  verified)
3897
 
 
3898
 
    def _get_preview(self, merger):
 
3202
                return self._do_merge(merger, change_reporter, allow_pending,
 
3203
                                      verified)
 
3204
        finally:
 
3205
            for cleanup in reversed(cleanups):
 
3206
                cleanup()
 
3207
 
 
3208
    def _do_preview(self, merger):
 
3209
        from bzrlib.diff import show_diff_trees
3899
3210
        tree_merger = merger.make_merger()
3900
3211
        tt = tree_merger.make_preview_transform()
3901
 
        self.add_cleanup(tt.finalize)
3902
 
        result_tree = tt.get_preview_tree()
3903
 
        return result_tree
3904
 
 
3905
 
    def _do_preview(self, merger):
3906
 
        from bzrlib.diff import show_diff_trees
3907
 
        result_tree = self._get_preview(merger)
3908
 
        show_diff_trees(merger.this_tree, result_tree, self.outf,
3909
 
                        old_label='', new_label='')
 
3212
        try:
 
3213
            result_tree = tt.get_preview_tree()
 
3214
            show_diff_trees(merger.this_tree, result_tree, self.outf,
 
3215
                            old_label='', new_label='')
 
3216
        finally:
 
3217
            tt.finalize()
3910
3218
 
3911
3219
    def _do_merge(self, merger, change_reporter, allow_pending, verified):
3912
3220
        merger.change_reporter = change_reporter
3920
3228
        else:
3921
3229
            return 0
3922
3230
 
3923
 
    def _do_interactive(self, merger):
3924
 
        """Perform an interactive merge.
3925
 
 
3926
 
        This works by generating a preview tree of the merge, then using
3927
 
        Shelver to selectively remove the differences between the working tree
3928
 
        and the preview tree.
3929
 
        """
3930
 
        from bzrlib import shelf_ui
3931
 
        result_tree = self._get_preview(merger)
3932
 
        writer = bzrlib.option.diff_writer_registry.get()
3933
 
        shelver = shelf_ui.Shelver(merger.this_tree, result_tree, destroy=True,
3934
 
                                   reporter=shelf_ui.ApplyReporter(),
3935
 
                                   diff_writer=writer(sys.stdout))
3936
 
        try:
3937
 
            shelver.run()
3938
 
        finally:
3939
 
            shelver.finalize()
3940
 
 
3941
3231
    def sanity_check_merger(self, merger):
3942
3232
        if (merger.show_base and
3943
3233
            not merger.merge_type is _mod_merge.Merge3Merger):
3978
3268
            base_branch, base_path = Branch.open_containing(base_loc,
3979
3269
                possible_transports)
3980
3270
        # Find the revision ids
3981
 
        other_revision_id = None
3982
 
        base_revision_id = None
3983
 
        if revision is not None:
3984
 
            if len(revision) >= 1:
3985
 
                other_revision_id = revision[-1].as_revision_id(other_branch)
3986
 
            if len(revision) == 2:
3987
 
                base_revision_id = revision[0].as_revision_id(base_branch)
3988
 
        if other_revision_id is None:
 
3271
        if revision is None or len(revision) < 1 or revision[-1] is None:
3989
3272
            other_revision_id = _mod_revision.ensure_null(
3990
3273
                other_branch.last_revision())
 
3274
        else:
 
3275
            other_revision_id = revision[-1].as_revision_id(other_branch)
 
3276
        if (revision is not None and len(revision) == 2
 
3277
            and revision[0] is not None):
 
3278
            base_revision_id = revision[0].as_revision_id(base_branch)
 
3279
        else:
 
3280
            base_revision_id = None
3991
3281
        # Remember where we merge from
3992
3282
        if ((remember or tree.branch.get_submit_branch() is None) and
3993
3283
             user_location is not None):
4002
3292
            allow_pending = True
4003
3293
        return merger, allow_pending
4004
3294
 
4005
 
    def get_merger_from_uncommitted(self, tree, location, pb):
4006
 
        """Get a merger for uncommitted changes.
4007
 
 
4008
 
        :param tree: The tree the merger should apply to.
4009
 
        :param location: The location containing uncommitted changes.
4010
 
        :param pb: The progress bar to use for showing progress.
4011
 
        """
4012
 
        location = self._select_branch_location(tree, location)[0]
4013
 
        other_tree, other_path = WorkingTree.open_containing(location)
4014
 
        merger = _mod_merge.Merger.from_uncommitted(tree, other_tree, pb)
4015
 
        if other_path != '':
4016
 
            merger.interesting_files = [other_path]
4017
 
        return merger
4018
 
 
4019
3295
    def _select_branch_location(self, tree, user_location, revision=None,
4020
3296
                                index=None):
4021
3297
        """Select a branch location, according to possible inputs.
4065
3341
 
4066
3342
 
4067
3343
class cmd_remerge(Command):
4068
 
    __doc__ = """Redo a merge.
 
3344
    """Redo a merge.
4069
3345
 
4070
3346
    Use this if you want to try a different merge technique while resolving
4071
 
    conflicts.  Some merge techniques are better than others, and remerge
 
3347
    conflicts.  Some merge techniques are better than others, and remerge 
4072
3348
    lets you try different ones on different files.
4073
3349
 
4074
3350
    The options for remerge have the same meaning and defaults as the ones for
4078
3354
    :Examples:
4079
3355
        Re-do the merge of all conflicted files, and show the base text in
4080
3356
        conflict regions, in addition to the usual THIS and OTHER texts::
4081
 
 
 
3357
      
4082
3358
            bzr remerge --show-base
4083
3359
 
4084
3360
        Re-do the merge of "foobar", using the weave merge algorithm, with
4085
3361
        additional processing to reduce the size of conflict regions::
4086
 
 
 
3362
      
4087
3363
            bzr remerge --merge-type weave --reprocess foobar
4088
3364
    """
4089
3365
    takes_args = ['file*']
4096
3372
 
4097
3373
    def run(self, file_list=None, merge_type=None, show_base=False,
4098
3374
            reprocess=False):
4099
 
        from bzrlib.conflicts import restore
4100
3375
        if merge_type is None:
4101
3376
            merge_type = _mod_merge.Merge3Merger
4102
3377
        tree, file_list = tree_files(file_list)
4103
3378
        tree.lock_write()
4104
 
        self.add_cleanup(tree.unlock)
4105
 
        parents = tree.get_parent_ids()
4106
 
        if len(parents) != 2:
4107
 
            raise errors.BzrCommandError("Sorry, remerge only works after normal"
4108
 
                                         " merges.  Not cherrypicking or"
4109
 
                                         " multi-merges.")
4110
 
        repository = tree.branch.repository
4111
 
        interesting_ids = None
4112
 
        new_conflicts = []
4113
 
        conflicts = tree.conflicts()
4114
 
        if file_list is not None:
4115
 
            interesting_ids = set()
4116
 
            for filename in file_list:
4117
 
                file_id = tree.path2id(filename)
4118
 
                if file_id is None:
4119
 
                    raise errors.NotVersionedError(filename)
4120
 
                interesting_ids.add(file_id)
4121
 
                if tree.kind(file_id) != "directory":
4122
 
                    continue
4123
 
 
4124
 
                for name, ie in tree.inventory.iter_entries(file_id):
4125
 
                    interesting_ids.add(ie.file_id)
4126
 
            new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
4127
 
        else:
4128
 
            # Remerge only supports resolving contents conflicts
4129
 
            allowed_conflicts = ('text conflict', 'contents conflict')
4130
 
            restore_files = [c.path for c in conflicts
4131
 
                             if c.typestring in allowed_conflicts]
4132
 
        _mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
4133
 
        tree.set_conflicts(ConflictList(new_conflicts))
4134
 
        if file_list is not None:
4135
 
            restore_files = file_list
4136
 
        for filename in restore_files:
 
3379
        try:
 
3380
            parents = tree.get_parent_ids()
 
3381
            if len(parents) != 2:
 
3382
                raise errors.BzrCommandError("Sorry, remerge only works after normal"
 
3383
                                             " merges.  Not cherrypicking or"
 
3384
                                             " multi-merges.")
 
3385
            repository = tree.branch.repository
 
3386
            interesting_ids = None
 
3387
            new_conflicts = []
 
3388
            conflicts = tree.conflicts()
 
3389
            if file_list is not None:
 
3390
                interesting_ids = set()
 
3391
                for filename in file_list:
 
3392
                    file_id = tree.path2id(filename)
 
3393
                    if file_id is None:
 
3394
                        raise errors.NotVersionedError(filename)
 
3395
                    interesting_ids.add(file_id)
 
3396
                    if tree.kind(file_id) != "directory":
 
3397
                        continue
 
3398
                    
 
3399
                    for name, ie in tree.inventory.iter_entries(file_id):
 
3400
                        interesting_ids.add(ie.file_id)
 
3401
                new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
 
3402
            else:
 
3403
                # Remerge only supports resolving contents conflicts
 
3404
                allowed_conflicts = ('text conflict', 'contents conflict')
 
3405
                restore_files = [c.path for c in conflicts
 
3406
                                 if c.typestring in allowed_conflicts]
 
3407
            _mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
 
3408
            tree.set_conflicts(ConflictList(new_conflicts))
 
3409
            if file_list is not None:
 
3410
                restore_files = file_list
 
3411
            for filename in restore_files:
 
3412
                try:
 
3413
                    restore(tree.abspath(filename))
 
3414
                except errors.NotConflicted:
 
3415
                    pass
 
3416
            # Disable pending merges, because the file texts we are remerging
 
3417
            # have not had those merges performed.  If we use the wrong parents
 
3418
            # list, we imply that the working tree text has seen and rejected
 
3419
            # all the changes from the other tree, when in fact those changes
 
3420
            # have not yet been seen.
 
3421
            pb = ui.ui_factory.nested_progress_bar()
 
3422
            tree.set_parent_ids(parents[:1])
4137
3423
            try:
4138
 
                restore(tree.abspath(filename))
4139
 
            except errors.NotConflicted:
4140
 
                pass
4141
 
        # Disable pending merges, because the file texts we are remerging
4142
 
        # have not had those merges performed.  If we use the wrong parents
4143
 
        # list, we imply that the working tree text has seen and rejected
4144
 
        # all the changes from the other tree, when in fact those changes
4145
 
        # have not yet been seen.
4146
 
        tree.set_parent_ids(parents[:1])
4147
 
        try:
4148
 
            merger = _mod_merge.Merger.from_revision_ids(None, tree, parents[1])
4149
 
            merger.interesting_ids = interesting_ids
4150
 
            merger.merge_type = merge_type
4151
 
            merger.show_base = show_base
4152
 
            merger.reprocess = reprocess
4153
 
            conflicts = merger.do_merge()
 
3424
                merger = _mod_merge.Merger.from_revision_ids(pb,
 
3425
                                                             tree, parents[1])
 
3426
                merger.interesting_ids = interesting_ids
 
3427
                merger.merge_type = merge_type
 
3428
                merger.show_base = show_base
 
3429
                merger.reprocess = reprocess
 
3430
                conflicts = merger.do_merge()
 
3431
            finally:
 
3432
                tree.set_parent_ids(parents)
 
3433
                pb.finished()
4154
3434
        finally:
4155
 
            tree.set_parent_ids(parents)
 
3435
            tree.unlock()
4156
3436
        if conflicts > 0:
4157
3437
            return 1
4158
3438
        else:
4160
3440
 
4161
3441
 
4162
3442
class cmd_revert(Command):
4163
 
    __doc__ = """Revert files to a previous revision.
 
3443
    """Revert files to a previous revision.
4164
3444
 
4165
3445
    Giving a list of files will revert only those files.  Otherwise, all files
4166
3446
    will be reverted.  If the revision is not specified with '--revision', the
4170
3450
    merge instead.  For example, "merge . --revision -2..-3" will remove the
4171
3451
    changes introduced by -2, without affecting the changes introduced by -1.
4172
3452
    Or to remove certain changes on a hunk-by-hunk basis, see the Shelf plugin.
4173
 
 
 
3453
    
4174
3454
    By default, any files that have been manually changed will be backed up
4175
3455
    first.  (Files changed only by merge are not backed up.)  Backup files have
4176
3456
    '.~#~' appended to their name, where # is a number.
4180
3460
    name.  If you name a directory, all the contents of that directory will be
4181
3461
    reverted.
4182
3462
 
4183
 
    If you have newly added files since the target revision, they will be
4184
 
    removed.  If the files to be removed have been changed, backups will be
4185
 
    created as above.  Directories containing unknown files will not be
4186
 
    deleted.
 
3463
    Any files that have been newly added since that revision will be deleted,
 
3464
    with a backup kept if appropriate.  Directories containing unknown files
 
3465
    will not be deleted.
4187
3466
 
4188
 
    The working tree contains a list of revisions that have been merged but
4189
 
    not yet committed. These revisions will be included as additional parents
4190
 
    of the next commit.  Normally, using revert clears that list as well as
4191
 
    reverting the files.  If any files are specified, revert leaves the list
4192
 
    of uncommitted merges alone and reverts only the files.  Use ``bzr revert
4193
 
    .`` in the tree root to revert all files but keep the recorded merges,
4194
 
    and ``bzr revert --forget-merges`` to clear the pending merge list without
 
3467
    The working tree contains a list of pending merged revisions, which will
 
3468
    be included as parents in the next commit.  Normally, revert clears that
 
3469
    list as well as reverting the files.  If any files are specified, revert
 
3470
    leaves the pending merge list alone and reverts only the files.  Use "bzr
 
3471
    revert ." in the tree root to revert all files but keep the merge record,
 
3472
    and "bzr revert --forget-merges" to clear the pending merge list without
4195
3473
    reverting any files.
4196
 
 
4197
 
    Using "bzr revert --forget-merges", it is possible to apply all of the
4198
 
    changes from a branch in a single revision.  To do this, perform the merge
4199
 
    as desired.  Then doing revert with the "--forget-merges" option will keep
4200
 
    the content of the tree as it was, but it will clear the list of pending
4201
 
    merges.  The next commit will then contain all of the changes that are
4202
 
    present in the other branch, but without any other parent revisions.
4203
 
    Because this technique forgets where these changes originated, it may
4204
 
    cause additional conflicts on later merges involving the same source and
4205
 
    target branches.
4206
3474
    """
4207
3475
 
4208
3476
    _see_also = ['cat', 'export']
4217
3485
    def run(self, revision=None, no_backup=False, file_list=None,
4218
3486
            forget_merges=None):
4219
3487
        tree, file_list = tree_files(file_list)
4220
 
        tree.lock_tree_write()
4221
 
        self.add_cleanup(tree.unlock)
4222
 
        if forget_merges:
4223
 
            tree.set_parent_ids(tree.get_parent_ids()[:1])
4224
 
        else:
4225
 
            self._revert_tree_to_revision(tree, revision, file_list, no_backup)
 
3488
        tree.lock_write()
 
3489
        try:
 
3490
            if forget_merges:
 
3491
                tree.set_parent_ids(tree.get_parent_ids()[:1])
 
3492
            else:
 
3493
                self._revert_tree_to_revision(tree, revision, file_list, no_backup)
 
3494
        finally:
 
3495
            tree.unlock()
4226
3496
 
4227
3497
    @staticmethod
4228
3498
    def _revert_tree_to_revision(tree, revision, file_list, no_backup):
4229
3499
        rev_tree = _get_one_revision_tree('revert', revision, tree=tree)
4230
 
        tree.revert(file_list, rev_tree, not no_backup, None,
4231
 
            report_changes=True)
 
3500
        pb = ui.ui_factory.nested_progress_bar()
 
3501
        try:
 
3502
            tree.revert(file_list, rev_tree, not no_backup, pb,
 
3503
                report_changes=True)
 
3504
        finally:
 
3505
            pb.finished()
4232
3506
 
4233
3507
 
4234
3508
class cmd_assert_fail(Command):
4235
 
    __doc__ = """Test reporting of assertion failures"""
 
3509
    """Test reporting of assertion failures"""
4236
3510
    # intended just for use in testing
4237
3511
 
4238
3512
    hidden = True
4242
3516
 
4243
3517
 
4244
3518
class cmd_help(Command):
4245
 
    __doc__ = """Show help on a command or other topic.
 
3519
    """Show help on a command or other topic.
4246
3520
    """
4247
3521
 
4248
3522
    _see_also = ['topics']
4251
3525
            ]
4252
3526
    takes_args = ['topic?']
4253
3527
    aliases = ['?', '--help', '-?', '-h']
4254
 
 
 
3528
    
4255
3529
    @display_command
4256
3530
    def run(self, topic=None, long=False):
4257
3531
        import bzrlib.help
4261
3535
 
4262
3536
 
4263
3537
class cmd_shell_complete(Command):
4264
 
    __doc__ = """Show appropriate completions for context.
 
3538
    """Show appropriate completions for context.
4265
3539
 
4266
3540
    For a list of all available commands, say 'bzr shell-complete'.
4267
3541
    """
4268
3542
    takes_args = ['context?']
4269
3543
    aliases = ['s-c']
4270
3544
    hidden = True
4271
 
 
 
3545
    
4272
3546
    @display_command
4273
3547
    def run(self, context=None):
4274
3548
        import shellcomplete
4276
3550
 
4277
3551
 
4278
3552
class cmd_missing(Command):
4279
 
    __doc__ = """Show unmerged/unpulled revisions between two branches.
 
3553
    """Show unmerged/unpulled revisions between two branches.
4280
3554
 
4281
3555
    OTHER_BRANCH may be local or remote.
4282
3556
 
4283
 
    To filter on a range of revisions, you can use the command -r begin..end
 
3557
    To filter on a range of revirions, you can use the command -r begin..end
4284
3558
    -r revision requests a specific revision, -r ..end or -r begin.. are
4285
3559
    also valid.
4286
 
            
4287
 
    :Exit values:
4288
 
        1 - some missing revisions
4289
 
        0 - no missing revisions
4290
3560
 
4291
3561
    :Examples:
4292
3562
 
4330
3600
            type=_parse_revision_str,
4331
3601
            help='Filter on local branch revisions (inclusive). '
4332
3602
                'See "help revisionspec" for details.'),
4333
 
        Option('include-merges',
4334
 
               'Show all revisions in addition to the mainline ones.'),
 
3603
        Option('include-merges', 'Show merged revisions.'),
4335
3604
        ]
4336
3605
    encoding_type = 'replace'
4337
3606
 
4360
3629
            restrict = 'remote'
4361
3630
 
4362
3631
        local_branch = Branch.open_containing(u".")[0]
4363
 
        local_branch.lock_read()
4364
 
        self.add_cleanup(local_branch.unlock)
4365
 
 
4366
3632
        parent = local_branch.get_parent()
4367
3633
        if other_branch is None:
4368
3634
            other_branch = parent
4377
3643
        remote_branch = Branch.open(other_branch)
4378
3644
        if remote_branch.base == local_branch.base:
4379
3645
            remote_branch = local_branch
4380
 
        else:
4381
 
            remote_branch.lock_read()
4382
 
            self.add_cleanup(remote_branch.unlock)
4383
3646
 
4384
3647
        local_revid_range = _revision_range_to_revid_range(
4385
3648
            _get_revision_range(my_revision, local_branch,
4389
3652
            _get_revision_range(revision,
4390
3653
                remote_branch, self.name()))
4391
3654
 
4392
 
        local_extra, remote_extra = find_unmerged(
4393
 
            local_branch, remote_branch, restrict,
4394
 
            backward=not reverse,
4395
 
            include_merges=include_merges,
4396
 
            local_revid_range=local_revid_range,
4397
 
            remote_revid_range=remote_revid_range)
4398
 
 
4399
 
        if log_format is None:
4400
 
            registry = log.log_formatter_registry
4401
 
            log_format = registry.get_default(local_branch)
4402
 
        lf = log_format(to_file=self.outf,
4403
 
                        show_ids=show_ids,
4404
 
                        show_timezone='original')
4405
 
 
4406
 
        status_code = 0
4407
 
        if local_extra and not theirs_only:
4408
 
            message("You have %d extra revision(s):\n" %
4409
 
                len(local_extra))
4410
 
            for revision in iter_log_revisions(local_extra,
4411
 
                                local_branch.repository,
4412
 
                                verbose):
4413
 
                lf.log_revision(revision)
4414
 
            printed_local = True
4415
 
            status_code = 1
4416
 
        else:
4417
 
            printed_local = False
4418
 
 
4419
 
        if remote_extra and not mine_only:
4420
 
            if printed_local is True:
4421
 
                message("\n\n\n")
4422
 
            message("You are missing %d revision(s):\n" %
4423
 
                len(remote_extra))
4424
 
            for revision in iter_log_revisions(remote_extra,
4425
 
                                remote_branch.repository,
4426
 
                                verbose):
4427
 
                lf.log_revision(revision)
4428
 
            status_code = 1
4429
 
 
4430
 
        if mine_only and not local_extra:
4431
 
            # We checked local, and found nothing extra
4432
 
            message('This branch is up to date.\n')
4433
 
        elif theirs_only and not remote_extra:
4434
 
            # We checked remote, and found nothing extra
4435
 
            message('Other branch is up to date.\n')
4436
 
        elif not (mine_only or theirs_only or local_extra or
4437
 
                  remote_extra):
4438
 
            # We checked both branches, and neither one had extra
4439
 
            # revisions
4440
 
            message("Branches are up to date.\n")
4441
 
        self.cleanup_now()
 
3655
        local_branch.lock_read()
 
3656
        try:
 
3657
            remote_branch.lock_read()
 
3658
            try:
 
3659
                local_extra, remote_extra = find_unmerged(
 
3660
                    local_branch, remote_branch, restrict,
 
3661
                    backward=not reverse,
 
3662
                    include_merges=include_merges,
 
3663
                    local_revid_range=local_revid_range,
 
3664
                    remote_revid_range=remote_revid_range)
 
3665
 
 
3666
                if log_format is None:
 
3667
                    registry = log.log_formatter_registry
 
3668
                    log_format = registry.get_default(local_branch)
 
3669
                lf = log_format(to_file=self.outf,
 
3670
                                show_ids=show_ids,
 
3671
                                show_timezone='original')
 
3672
 
 
3673
                status_code = 0
 
3674
                if local_extra and not theirs_only:
 
3675
                    message("You have %d extra revision(s):\n" %
 
3676
                        len(local_extra))
 
3677
                    for revision in iter_log_revisions(local_extra,
 
3678
                                        local_branch.repository,
 
3679
                                        verbose):
 
3680
                        lf.log_revision(revision)
 
3681
                    printed_local = True
 
3682
                    status_code = 1
 
3683
                else:
 
3684
                    printed_local = False
 
3685
 
 
3686
                if remote_extra and not mine_only:
 
3687
                    if printed_local is True:
 
3688
                        message("\n\n\n")
 
3689
                    message("You are missing %d revision(s):\n" %
 
3690
                        len(remote_extra))
 
3691
                    for revision in iter_log_revisions(remote_extra,
 
3692
                                        remote_branch.repository,
 
3693
                                        verbose):
 
3694
                        lf.log_revision(revision)
 
3695
                    status_code = 1
 
3696
 
 
3697
                if mine_only and not local_extra:
 
3698
                    # We checked local, and found nothing extra
 
3699
                    message('This branch is up to date.\n')
 
3700
                elif theirs_only and not remote_extra:
 
3701
                    # We checked remote, and found nothing extra
 
3702
                    message('Other branch is up to date.\n')
 
3703
                elif not (mine_only or theirs_only or local_extra or
 
3704
                          remote_extra):
 
3705
                    # We checked both branches, and neither one had extra
 
3706
                    # revisions
 
3707
                    message("Branches are up to date.\n")
 
3708
            finally:
 
3709
                remote_branch.unlock()
 
3710
        finally:
 
3711
            local_branch.unlock()
4442
3712
        if not status_code and parent is None and other_branch is not None:
4443
3713
            local_branch.lock_write()
4444
 
            self.add_cleanup(local_branch.unlock)
4445
 
            # handle race conditions - a parent might be set while we run.
4446
 
            if local_branch.get_parent() is None:
4447
 
                local_branch.set_parent(remote_branch.base)
 
3714
            try:
 
3715
                # handle race conditions - a parent might be set while we run.
 
3716
                if local_branch.get_parent() is None:
 
3717
                    local_branch.set_parent(remote_branch.base)
 
3718
            finally:
 
3719
                local_branch.unlock()
4448
3720
        return status_code
4449
3721
 
4450
3722
 
4451
3723
class cmd_pack(Command):
4452
 
    __doc__ = """Compress the data within a repository.
4453
 
 
4454
 
    This operation compresses the data within a bazaar repository. As
4455
 
    bazaar supports automatic packing of repository, this operation is
4456
 
    normally not required to be done manually.
4457
 
 
4458
 
    During the pack operation, bazaar takes a backup of existing repository
4459
 
    data, i.e. pack files. This backup is eventually removed by bazaar
4460
 
    automatically when it is safe to do so. To save disk space by removing
4461
 
    the backed up pack files, the --clean-obsolete-packs option may be
4462
 
    used.
4463
 
 
4464
 
    Warning: If you use --clean-obsolete-packs and your machine crashes
4465
 
    during or immediately after repacking, you may be left with a state
4466
 
    where the deletion has been written to disk but the new packs have not
4467
 
    been. In this case the repository may be unusable.
4468
 
    """
 
3724
    """Compress the data within a repository."""
4469
3725
 
4470
3726
    _see_also = ['repositories']
4471
3727
    takes_args = ['branch_or_repo?']
4472
 
    takes_options = [
4473
 
        Option('clean-obsolete-packs', 'Delete obsolete packs to save disk space.'),
4474
 
        ]
4475
3728
 
4476
 
    def run(self, branch_or_repo='.', clean_obsolete_packs=False):
 
3729
    def run(self, branch_or_repo='.'):
4477
3730
        dir = bzrdir.BzrDir.open_containing(branch_or_repo)[0]
4478
3731
        try:
4479
3732
            branch = dir.open_branch()
4480
3733
            repository = branch.repository
4481
3734
        except errors.NotBranchError:
4482
3735
            repository = dir.open_repository()
4483
 
        repository.pack(clean_obsolete_packs=clean_obsolete_packs)
 
3736
        repository.pack()
4484
3737
 
4485
3738
 
4486
3739
class cmd_plugins(Command):
4487
 
    __doc__ = """List the installed plugins.
4488
 
 
 
3740
    """List the installed plugins.
 
3741
    
4489
3742
    This command displays the list of installed plugins including
4490
3743
    version of plugin and a short description of each.
4491
3744
 
4497
3750
    adding new commands, providing additional network transports and
4498
3751
    customizing log output.
4499
3752
 
4500
 
    See the Bazaar Plugin Guide <http://doc.bazaar.canonical.com/plugins/en/>
4501
 
    for further information on plugins including where to find them and how to
4502
 
    install them. Instructions are also provided there on how to write new
4503
 
    plugins using the Python programming language.
 
3753
    See the Bazaar web site, http://bazaar-vcs.org, for further
 
3754
    information on plugins including where to find them and how to
 
3755
    install them. Instructions are also provided there on how to
 
3756
    write new plugins using the Python programming language.
4504
3757
    """
4505
3758
    takes_options = ['verbose']
4506
3759
 
4521
3774
                doc = '(no description)'
4522
3775
            result.append((name_ver, doc, plugin.path()))
4523
3776
        for name_ver, doc, path in sorted(result):
4524
 
            self.outf.write("%s\n" % name_ver)
4525
 
            self.outf.write("   %s\n" % doc)
 
3777
            print name_ver
 
3778
            print '   ', doc
4526
3779
            if verbose:
4527
 
                self.outf.write("   %s\n" % path)
4528
 
            self.outf.write("\n")
 
3780
                print '   ', path
 
3781
            print
4529
3782
 
4530
3783
 
4531
3784
class cmd_testament(Command):
4532
 
    __doc__ = """Show testament (signing-form) of a revision."""
 
3785
    """Show testament (signing-form) of a revision."""
4533
3786
    takes_options = [
4534
3787
            'revision',
4535
3788
            Option('long', help='Produce long-format testament.'),
4548
3801
        else:
4549
3802
            b = Branch.open(branch)
4550
3803
        b.lock_read()
4551
 
        self.add_cleanup(b.unlock)
4552
 
        if revision is None:
4553
 
            rev_id = b.last_revision()
4554
 
        else:
4555
 
            rev_id = revision[0].as_revision_id(b)
4556
 
        t = testament_class.from_revision(b.repository, rev_id)
4557
 
        if long:
4558
 
            sys.stdout.writelines(t.as_text_lines())
4559
 
        else:
4560
 
            sys.stdout.write(t.as_short_text())
 
3804
        try:
 
3805
            if revision is None:
 
3806
                rev_id = b.last_revision()
 
3807
            else:
 
3808
                rev_id = revision[0].as_revision_id(b)
 
3809
            t = testament_class.from_revision(b.repository, rev_id)
 
3810
            if long:
 
3811
                sys.stdout.writelines(t.as_text_lines())
 
3812
            else:
 
3813
                sys.stdout.write(t.as_short_text())
 
3814
        finally:
 
3815
            b.unlock()
4561
3816
 
4562
3817
 
4563
3818
class cmd_annotate(Command):
4564
 
    __doc__ = """Show the origin of each line in a file.
 
3819
    """Show the origin of each line in a file.
4565
3820
 
4566
3821
    This prints out the given file with an annotation on the left side
4567
3822
    indicating which revision, author and date introduced the change.
4568
3823
 
4569
 
    If the origin is the same for a run of consecutive lines, it is
 
3824
    If the origin is the same for a run of consecutive lines, it is 
4570
3825
    shown only at the top, unless the --all option is given.
4571
3826
    """
4572
3827
    # TODO: annotate directories; showing when each file was last changed
4573
 
    # TODO: if the working copy is modified, show annotations on that
 
3828
    # TODO: if the working copy is modified, show annotations on that 
4574
3829
    #       with new uncommitted lines marked
4575
3830
    aliases = ['ann', 'blame', 'praise']
4576
3831
    takes_args = ['filename']
4589
3844
            bzrdir.BzrDir.open_containing_tree_or_branch(filename)
4590
3845
        if wt is not None:
4591
3846
            wt.lock_read()
4592
 
            self.add_cleanup(wt.unlock)
4593
3847
        else:
4594
3848
            branch.lock_read()
4595
 
            self.add_cleanup(branch.unlock)
4596
 
        tree = _get_one_revision_tree('annotate', revision, branch=branch)
4597
 
        tree.lock_read()
4598
 
        self.add_cleanup(tree.unlock)
4599
 
        if wt is not None:
4600
 
            file_id = wt.path2id(relpath)
4601
 
        else:
4602
 
            file_id = tree.path2id(relpath)
4603
 
        if file_id is None:
4604
 
            raise errors.NotVersionedError(filename)
4605
 
        file_version = tree.inventory[file_id].revision
4606
 
        if wt is not None and revision is None:
4607
 
            # If there is a tree and we're not annotating historical
4608
 
            # versions, annotate the working tree's content.
4609
 
            annotate_file_tree(wt, file_id, self.outf, long, all,
4610
 
                show_ids=show_ids)
4611
 
        else:
4612
 
            annotate_file(branch, file_version, file_id, long, all, self.outf,
4613
 
                          show_ids=show_ids)
 
3849
        try:
 
3850
            tree = _get_one_revision_tree('annotate', revision, branch=branch)
 
3851
            if wt is not None:
 
3852
                file_id = wt.path2id(relpath)
 
3853
            else:
 
3854
                file_id = tree.path2id(relpath)
 
3855
            if file_id is None:
 
3856
                raise errors.NotVersionedError(filename)
 
3857
            file_version = tree.inventory[file_id].revision
 
3858
            if wt is not None and revision is None:
 
3859
                # If there is a tree and we're not annotating historical
 
3860
                # versions, annotate the working tree's content.
 
3861
                annotate_file_tree(wt, file_id, self.outf, long, all,
 
3862
                    show_ids=show_ids)
 
3863
            else:
 
3864
                annotate_file(branch, file_version, file_id, long, all, self.outf,
 
3865
                              show_ids=show_ids)
 
3866
        finally:
 
3867
            if wt is not None:
 
3868
                wt.unlock()
 
3869
            else:
 
3870
                branch.unlock()
4614
3871
 
4615
3872
 
4616
3873
class cmd_re_sign(Command):
4617
 
    __doc__ = """Create a digital signature for an existing revision."""
 
3874
    """Create a digital signature for an existing revision."""
4618
3875
    # TODO be able to replace existing ones.
4619
3876
 
4620
3877
    hidden = True # is this right ?
4621
3878
    takes_args = ['revision_id*']
4622
3879
    takes_options = ['revision']
4623
 
 
 
3880
    
4624
3881
    def run(self, revision_id_list=None, revision=None):
4625
3882
        if revision_id_list is not None and revision is not None:
4626
3883
            raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
4628
3885
            raise errors.BzrCommandError('You must supply either --revision or a revision_id')
4629
3886
        b = WorkingTree.open_containing(u'.')[0].branch
4630
3887
        b.lock_write()
4631
 
        self.add_cleanup(b.unlock)
4632
 
        return self._run(b, revision_id_list, revision)
 
3888
        try:
 
3889
            return self._run(b, revision_id_list, revision)
 
3890
        finally:
 
3891
            b.unlock()
4633
3892
 
4634
3893
    def _run(self, b, revision_id_list, revision):
4635
3894
        import bzrlib.gpg as gpg
4680
3939
 
4681
3940
 
4682
3941
class cmd_bind(Command):
4683
 
    __doc__ = """Convert the current branch into a checkout of the supplied branch.
4684
 
    If no branch is supplied, rebind to the last bound location.
 
3942
    """Convert the current branch into a checkout of the supplied branch.
4685
3943
 
4686
3944
    Once converted into a checkout, commits must succeed on the master branch
4687
3945
    before they will be applied to the local branch.
4688
3946
 
4689
3947
    Bound branches use the nickname of its master branch unless it is set
4690
 
    locally, in which case binding will update the local nickname to be
 
3948
    locally, in which case binding will update the the local nickname to be
4691
3949
    that of the master.
4692
3950
    """
4693
3951
 
4705
3963
                    'This format does not remember old locations.')
4706
3964
            else:
4707
3965
                if location is None:
4708
 
                    if b.get_bound_location() is not None:
4709
 
                        raise errors.BzrCommandError('Branch is already bound')
4710
 
                    else:
4711
 
                        raise errors.BzrCommandError('No location supplied '
4712
 
                            'and no previous location known')
 
3966
                    raise errors.BzrCommandError('No location supplied and no '
 
3967
                        'previous location known')
4713
3968
        b_other = Branch.open(location)
4714
3969
        try:
4715
3970
            b.bind(b_other)
4721
3976
 
4722
3977
 
4723
3978
class cmd_unbind(Command):
4724
 
    __doc__ = """Convert the current checkout into a regular branch.
 
3979
    """Convert the current checkout into a regular branch.
4725
3980
 
4726
3981
    After unbinding, the local branch is considered independent and subsequent
4727
3982
    commits will be local only.
4738
3993
 
4739
3994
 
4740
3995
class cmd_uncommit(Command):
4741
 
    __doc__ = """Remove the last committed revision.
 
3996
    """Remove the last committed revision.
4742
3997
 
4743
3998
    --verbose will print out what is being removed.
4744
3999
    --dry-run will go through all the motions, but not actually
4785
4040
 
4786
4041
        if tree is not None:
4787
4042
            tree.lock_write()
4788
 
            self.add_cleanup(tree.unlock)
4789
4043
        else:
4790
4044
            b.lock_write()
4791
 
            self.add_cleanup(b.unlock)
4792
 
        return self._run(b, tree, dry_run, verbose, revision, force, local=local)
 
4045
        try:
 
4046
            return self._run(b, tree, dry_run, verbose, revision, force,
 
4047
                             local=local)
 
4048
        finally:
 
4049
            if tree is not None:
 
4050
                tree.unlock()
 
4051
            else:
 
4052
                b.unlock()
4793
4053
 
4794
4054
    def _run(self, b, tree, dry_run, verbose, revision, force, local=False):
4795
4055
        from bzrlib.log import log_formatter, show_log
4827
4087
                 end_revision=last_revno)
4828
4088
 
4829
4089
        if dry_run:
4830
 
            self.outf.write('Dry-run, pretending to remove'
4831
 
                            ' the above revisions.\n')
 
4090
            print 'Dry-run, pretending to remove the above revisions.'
 
4091
            if not force:
 
4092
                val = raw_input('Press <enter> to continue')
4832
4093
        else:
4833
 
            self.outf.write('The above revision(s) will be removed.\n')
4834
 
 
4835
 
        if not force:
4836
 
            if not ui.ui_factory.get_boolean('Are you sure'):
4837
 
                self.outf.write('Canceled')
4838
 
                return 0
 
4094
            print 'The above revision(s) will be removed.'
 
4095
            if not force:
 
4096
                val = raw_input('Are you sure [y/N]? ')
 
4097
                if val.lower() not in ('y', 'yes'):
 
4098
                    print 'Canceled'
 
4099
                    return 0
4839
4100
 
4840
4101
        mutter('Uncommitting from {%s} to {%s}',
4841
4102
               last_rev_id, rev_id)
4842
4103
        uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
4843
4104
                 revno=revno, local=local)
4844
 
        self.outf.write('You can restore the old tip by running:\n'
4845
 
             '  bzr pull . -r revid:%s\n' % last_rev_id)
 
4105
        note('You can restore the old tip by running:\n'
 
4106
             '  bzr pull . -r revid:%s', last_rev_id)
4846
4107
 
4847
4108
 
4848
4109
class cmd_break_lock(Command):
4849
 
    __doc__ = """Break a dead lock on a repository, branch or working directory.
 
4110
    """Break a dead lock on a repository, branch or working directory.
4850
4111
 
4851
4112
    CAUTION: Locks should only be broken when you are sure that the process
4852
4113
    holding the lock has been stopped.
4853
4114
 
4854
 
    You can get information on what locks are open via the 'bzr info
4855
 
    [location]' command.
4856
 
 
 
4115
    You can get information on what locks are open via the 'bzr info' command.
 
4116
    
4857
4117
    :Examples:
4858
4118
        bzr break-lock
4859
 
        bzr break-lock bzr+ssh://example.com/bzr/foo
4860
4119
    """
4861
4120
    takes_args = ['location?']
4862
4121
 
4868
4127
            control.break_lock()
4869
4128
        except NotImplementedError:
4870
4129
            pass
4871
 
 
 
4130
        
4872
4131
 
4873
4132
class cmd_wait_until_signalled(Command):
4874
 
    __doc__ = """Test helper for test_start_and_stop_bzr_subprocess_send_signal.
 
4133
    """Test helper for test_start_and_stop_bzr_subprocess_send_signal.
4875
4134
 
4876
4135
    This just prints a line to signal when it is ready, then blocks on stdin.
4877
4136
    """
4885
4144
 
4886
4145
 
4887
4146
class cmd_serve(Command):
4888
 
    __doc__ = """Run the bzr server."""
 
4147
    """Run the bzr server."""
4889
4148
 
4890
4149
    aliases = ['server']
4891
4150
 
4892
4151
    takes_options = [
4893
4152
        Option('inet',
4894
4153
               help='Serve on stdin/out for use from inetd or sshd.'),
4895
 
        RegistryOption('protocol',
4896
 
               help="Protocol to serve.",
4897
 
               lazy_registry=('bzrlib.transport', 'transport_server_registry'),
4898
 
               value_switches=True),
4899
4154
        Option('port',
4900
4155
               help='Listen for connections on nominated port of the form '
4901
4156
                    '[hostname:]portnumber.  Passing 0 as the port number will '
4902
 
                    'result in a dynamically allocated port.  The default port '
4903
 
                    'depends on the protocol.',
 
4157
                    'result in a dynamically allocated port.  The default port is '
 
4158
                    '4155.',
4904
4159
               type=str),
4905
4160
        Option('directory',
4906
4161
               help='Serve contents of this directory.',
4908
4163
        Option('allow-writes',
4909
4164
               help='By default the server is a readonly server.  Supplying '
4910
4165
                    '--allow-writes enables write access to the contents of '
4911
 
                    'the served directory and below.  Note that ``bzr serve`` '
4912
 
                    'does not perform authentication, so unless some form of '
4913
 
                    'external authentication is arranged supplying this '
4914
 
                    'option leads to global uncontrolled write access to your '
4915
 
                    'file system.'
 
4166
                    'the served directory and below.'
4916
4167
                ),
4917
4168
        ]
4918
4169
 
 
4170
    def run_smart_server(self, smart_server):
 
4171
        """Run 'smart_server' forever, with no UI output at all."""
 
4172
        # For the duration of this server, no UI output is permitted. note
 
4173
        # that this may cause problems with blackbox tests. This should be
 
4174
        # changed with care though, as we dont want to use bandwidth sending
 
4175
        # progress over stderr to smart server clients!
 
4176
        from bzrlib import lockdir
 
4177
        old_factory = ui.ui_factory
 
4178
        old_lockdir_timeout = lockdir._DEFAULT_TIMEOUT_SECONDS
 
4179
        try:
 
4180
            ui.ui_factory = ui.SilentUIFactory()
 
4181
            lockdir._DEFAULT_TIMEOUT_SECONDS = 0
 
4182
            smart_server.serve()
 
4183
        finally:
 
4184
            ui.ui_factory = old_factory
 
4185
            lockdir._DEFAULT_TIMEOUT_SECONDS = old_lockdir_timeout
 
4186
 
4919
4187
    def get_host_and_port(self, port):
4920
4188
        """Return the host and port to run the smart server on.
4921
4189
 
4922
 
        If 'port' is None, None will be returned for the host and port.
 
4190
        If 'port' is None, the default host (`medium.BZR_DEFAULT_INTERFACE`)
 
4191
        and port (`medium.BZR_DEFAULT_PORT`) will be used.
4923
4192
 
4924
4193
        If 'port' has a colon in it, the string before the colon will be
4925
4194
        interpreted as the host.
4928
4197
        :return: A tuple of (host, port), where 'host' is a host name or IP,
4929
4198
            and port is an integer TCP/IP port.
4930
4199
        """
4931
 
        host = None
4932
 
        if port is not None:
 
4200
        from bzrlib.smart import medium
 
4201
        host = medium.BZR_DEFAULT_INTERFACE
 
4202
        if port is None:
 
4203
            port = medium.BZR_DEFAULT_PORT
 
4204
        else:
4933
4205
            if ':' in port:
4934
4206
                host, port = port.split(':')
4935
4207
            port = int(port)
4936
4208
        return host, port
4937
4209
 
4938
 
    def run(self, port=None, inet=False, directory=None, allow_writes=False,
4939
 
            protocol=None):
4940
 
        from bzrlib.transport import get_transport, transport_server_registry
 
4210
    def get_smart_server(self, transport, inet, port):
 
4211
        """Construct a smart server.
 
4212
 
 
4213
        :param transport: The base transport from which branches will be
 
4214
            served.
 
4215
        :param inet: If True, serve over stdin and stdout. Used for running
 
4216
            from inet.
 
4217
        :param port: The port to listen on. By default, it's `
 
4218
            medium.BZR_DEFAULT_PORT`. See `get_host_and_port` for more
 
4219
            information.
 
4220
        :return: A smart server.
 
4221
        """
 
4222
        from bzrlib.smart import medium, server
 
4223
        if inet:
 
4224
            smart_server = medium.SmartServerPipeStreamMedium(
 
4225
                sys.stdin, sys.stdout, transport)
 
4226
        else:
 
4227
            host, port = self.get_host_and_port(port)
 
4228
            smart_server = server.SmartTCPServer(
 
4229
                transport, host=host, port=port)
 
4230
            note('listening on port: %s' % smart_server.port)
 
4231
        return smart_server
 
4232
 
 
4233
    def run(self, port=None, inet=False, directory=None, allow_writes=False):
 
4234
        from bzrlib.transport import get_transport
 
4235
        from bzrlib.transport.chroot import ChrootServer
4941
4236
        if directory is None:
4942
4237
            directory = os.getcwd()
4943
 
        if protocol is None:
4944
 
            protocol = transport_server_registry.get()
4945
 
        host, port = self.get_host_and_port(port)
4946
4238
        url = urlutils.local_path_to_url(directory)
4947
4239
        if not allow_writes:
4948
4240
            url = 'readonly+' + url
4949
 
        transport = get_transport(url)
4950
 
        protocol(transport, host, port, inet)
 
4241
        chroot_server = ChrootServer(get_transport(url))
 
4242
        chroot_server.setUp()
 
4243
        t = get_transport(chroot_server.get_url())
 
4244
        smart_server = self.get_smart_server(t, inet, port)
 
4245
        self.run_smart_server(smart_server)
4951
4246
 
4952
4247
 
4953
4248
class cmd_join(Command):
4954
 
    __doc__ = """Combine a tree into its containing tree.
4955
 
 
4956
 
    This command requires the target tree to be in a rich-root format.
 
4249
    """Combine a subtree into its containing tree.
 
4250
    
 
4251
    This command is for experimental use only.  It requires the target tree
 
4252
    to be in dirstate-with-subtree format, which cannot be converted into
 
4253
    earlier formats.
4957
4254
 
4958
4255
    The TREE argument should be an independent tree, inside another tree, but
4959
4256
    not part of it.  (Such trees can be produced by "bzr split", but also by
4962
4259
    The result is a combined tree, with the subtree no longer an independant
4963
4260
    part.  This is marked as a merge of the subtree into the containing tree,
4964
4261
    and all history is preserved.
 
4262
 
 
4263
    If --reference is specified, the subtree retains its independence.  It can
 
4264
    be branched by itself, and can be part of multiple projects at the same
 
4265
    time.  But operations performed in the containing tree, such as commit
 
4266
    and merge, will recurse into the subtree.
4965
4267
    """
4966
4268
 
4967
4269
    _see_also = ['split']
4968
4270
    takes_args = ['tree']
4969
4271
    takes_options = [
4970
 
            Option('reference', help='Join by reference.', hidden=True),
 
4272
            Option('reference', help='Join by reference.'),
4971
4273
            ]
 
4274
    hidden = True
4972
4275
 
4973
4276
    def run(self, tree, reference=False):
4974
4277
        sub_tree = WorkingTree.open(tree)
4992
4295
            try:
4993
4296
                containing_tree.subsume(sub_tree)
4994
4297
            except errors.BadSubsumeSource, e:
4995
 
                raise errors.BzrCommandError("Cannot join %s.  %s" %
 
4298
                raise errors.BzrCommandError("Cannot join %s.  %s" % 
4996
4299
                                             (tree, e.reason))
4997
4300
 
4998
4301
 
4999
4302
class cmd_split(Command):
5000
 
    __doc__ = """Split a subdirectory of a tree into a separate tree.
 
4303
    """Split a subdirectory of a tree into a separate tree.
5001
4304
 
5002
4305
    This command will produce a target tree in a format that supports
5003
4306
    rich roots, like 'rich-root' or 'rich-root-pack'.  These formats cannot be
5008
4311
    branch.  Commits in the top-level tree will not apply to the new subtree.
5009
4312
    """
5010
4313
 
5011
 
    _see_also = ['join']
 
4314
    # join is not un-hidden yet
 
4315
    #_see_also = ['join']
5012
4316
    takes_args = ['tree']
5013
4317
 
5014
4318
    def run(self, tree):
5019
4323
        try:
5020
4324
            containing_tree.extract(sub_id)
5021
4325
        except errors.RootNotRich:
5022
 
            raise errors.RichRootUpgradeRequired(containing_tree.branch.base)
 
4326
            raise errors.UpgradeRequired(containing_tree.branch.base)
5023
4327
 
5024
4328
 
5025
4329
class cmd_merge_directive(Command):
5026
 
    __doc__ = """Generate a merge directive for auto-merge tools.
 
4330
    """Generate a merge directive for auto-merge tools.
5027
4331
 
5028
4332
    A directive requests a merge to be performed, and also provides all the
5029
4333
    information necessary to do so.  This means it must either include a
5122
4426
 
5123
4427
 
5124
4428
class cmd_send(Command):
5125
 
    __doc__ = """Mail or create a merge-directive for submitting changes.
 
4429
    """Mail or create a merge-directive for submitting changes.
5126
4430
 
5127
4431
    A merge directive provides many things needed for requesting merges:
5128
4432
 
5134
4438
      directly from the merge directive, without retrieving data from a
5135
4439
      branch.
5136
4440
 
5137
 
    `bzr send` creates a compact data set that, when applied using bzr
5138
 
    merge, has the same effect as merging from the source branch.  
5139
 
    
5140
 
    By default the merge directive is self-contained and can be applied to any
5141
 
    branch containing submit_branch in its ancestory without needing access to
5142
 
    the source branch.
5143
 
    
5144
 
    If --no-bundle is specified, then Bazaar doesn't send the contents of the
5145
 
    revisions, but only a structured request to merge from the
5146
 
    public_location.  In that case the public_branch is needed and it must be
5147
 
    up-to-date and accessible to the recipient.  The public_branch is always
5148
 
    included if known, so that people can check it later.
5149
 
 
5150
 
    The submit branch defaults to the parent of the source branch, but can be
5151
 
    overridden.  Both submit branch and public branch will be remembered in
5152
 
    branch.conf the first time they are used for a particular branch.  The
5153
 
    source branch defaults to that containing the working directory, but can
5154
 
    be changed using --from.
5155
 
 
5156
 
    In order to calculate those changes, bzr must analyse the submit branch.
5157
 
    Therefore it is most efficient for the submit branch to be a local mirror.
5158
 
    If a public location is known for the submit_branch, that location is used
5159
 
    in the merge directive.
5160
 
 
5161
 
    The default behaviour is to send the merge directive by mail, unless -o is
5162
 
    given, in which case it is sent to a file.
 
4441
    If --no-bundle is specified, then public_branch is needed (and must be
 
4442
    up-to-date), so that the receiver can perform the merge using the
 
4443
    public_branch.  The public_branch is always included if known, so that
 
4444
    people can check it later.
 
4445
 
 
4446
    The submit branch defaults to the parent, but can be overridden.  Both
 
4447
    submit branch and public branch will be remembered if supplied.
 
4448
 
 
4449
    If a public_branch is known for the submit_branch, that public submit
 
4450
    branch is used in the merge instructions.  This means that a local mirror
 
4451
    can be used as your actual submit branch, once you have set public_branch
 
4452
    for that mirror.
5163
4453
 
5164
4454
    Mail is sent using your preferred mail program.  This should be transparent
5165
4455
    on Windows (it uses MAPI).  On Linux, it requires the xdg-email utility.
5166
4456
    If the preferred client can't be found (or used), your editor will be used.
5167
 
 
 
4457
    
5168
4458
    To use a specific mail program, set the mail_client configuration option.
5169
4459
    (For Thunderbird 1.5, this works around some bugs.)  Supported values for
5170
 
    specific clients are "claws", "evolution", "kmail", "mail.app" (MacOS X's
5171
 
    Mail.app), "mutt", and "thunderbird"; generic options are "default",
5172
 
    "editor", "emacsclient", "mapi", and "xdg-email".  Plugins may also add
5173
 
    supported clients.
 
4460
    specific clients are "claws", "evolution", "kmail", "mutt", and
 
4461
    "thunderbird"; generic options are "default", "editor", "emacsclient",
 
4462
    "mapi", and "xdg-email".  Plugins may also add supported clients.
5174
4463
 
5175
4464
    If mail is being sent, a to address is required.  This can be supplied
5176
4465
    either on the commandline, by setting the submit_to configuration
5177
 
    option in the branch itself or the child_submit_to configuration option
 
4466
    option in the branch itself or the child_submit_to configuration option 
5178
4467
    in the submit branch.
5179
4468
 
5180
4469
    Two formats are currently supported: "4" uses revision bundle format 4 and
5182
4471
    older formats.  It is compatible with Bazaar 0.19 and later.  It is the
5183
4472
    default.  "0.9" uses revision bundle format 0.9 and merge directive
5184
4473
    format 1.  It is compatible with Bazaar 0.12 - 0.18.
5185
 
 
5186
 
    The merge directives created by bzr send may be applied using bzr merge or
5187
 
    bzr pull by specifying a file containing a merge directive as the location.
5188
 
 
5189
 
    bzr send makes extensive use of public locations to map local locations into
5190
 
    URLs that can be used by other people.  See `bzr help configuration` to
5191
 
    set them, and use `bzr info` to display them.
 
4474
    
 
4475
    Merge directives are applied using the merge command or the pull command.
5192
4476
    """
5193
4477
 
5194
4478
    encoding_type = 'exact'
5210
4494
               short_name='f',
5211
4495
               type=unicode),
5212
4496
        Option('output', short_name='o',
5213
 
               help='Write merge directive to this file or directory; '
 
4497
               help='Write merge directive to this file; '
5214
4498
                    'use - for stdout.',
5215
4499
               type=unicode),
5216
 
        Option('strict',
5217
 
               help='Refuse to send if there are uncommitted changes in'
5218
 
               ' the working tree, --no-strict disables the check.'),
5219
4500
        Option('mail-to', help='Mail the request to this address.',
5220
4501
               type=unicode),
5221
4502
        'revision',
5222
4503
        'message',
5223
 
        Option('body', help='Body for the email.', type=unicode),
5224
 
        RegistryOption('format',
5225
 
                       help='Use the specified output format.',
5226
 
                       lazy_registry=('bzrlib.send', 'format_registry')),
 
4504
        RegistryOption.from_kwargs('format',
 
4505
        'Use the specified output format.',
 
4506
        **{'4': 'Bundle format 4, Merge Directive 2 (default)',
 
4507
           '0.9': 'Bundle format 0.9, Merge Directive 1',})
5227
4508
        ]
5228
4509
 
5229
4510
    def run(self, submit_branch=None, public_branch=None, no_bundle=False,
5230
4511
            no_patch=False, revision=None, remember=False, output=None,
5231
 
            format=None, mail_to=None, message=None, body=None,
5232
 
            strict=None, **kwargs):
5233
 
        from bzrlib.send import send
5234
 
        return send(submit_branch, revision, public_branch, remember,
5235
 
                    format, no_bundle, no_patch, output,
5236
 
                    kwargs.get('from', '.'), mail_to, message, body,
5237
 
                    self.outf,
5238
 
                    strict=strict)
 
4512
            format='4', mail_to=None, message=None, **kwargs):
 
4513
        return self._run(submit_branch, revision, public_branch, remember,
 
4514
                         format, no_bundle, no_patch, output,
 
4515
                         kwargs.get('from', '.'), mail_to, message)
 
4516
 
 
4517
    def _run(self, submit_branch, revision, public_branch, remember, format,
 
4518
             no_bundle, no_patch, output, from_, mail_to, message):
 
4519
        from bzrlib.revision import NULL_REVISION
 
4520
        branch = Branch.open_containing(from_)[0]
 
4521
        if output is None:
 
4522
            outfile = cStringIO.StringIO()
 
4523
        elif output == '-':
 
4524
            outfile = self.outf
 
4525
        else:
 
4526
            outfile = open(output, 'wb')
 
4527
        # we may need to write data into branch's repository to calculate
 
4528
        # the data to send.
 
4529
        branch.lock_write()
 
4530
        try:
 
4531
            if output is None:
 
4532
                config = branch.get_config()
 
4533
                if mail_to is None:
 
4534
                    mail_to = config.get_user_option('submit_to')
 
4535
                mail_client = config.get_mail_client()
 
4536
            if remember and submit_branch is None:
 
4537
                raise errors.BzrCommandError(
 
4538
                    '--remember requires a branch to be specified.')
 
4539
            stored_submit_branch = branch.get_submit_branch()
 
4540
            remembered_submit_branch = None
 
4541
            if submit_branch is None:
 
4542
                submit_branch = stored_submit_branch
 
4543
                remembered_submit_branch = "submit"
 
4544
            else:
 
4545
                if stored_submit_branch is None or remember:
 
4546
                    branch.set_submit_branch(submit_branch)
 
4547
            if submit_branch is None:
 
4548
                submit_branch = branch.get_parent()
 
4549
                remembered_submit_branch = "parent"
 
4550
            if submit_branch is None:
 
4551
                raise errors.BzrCommandError('No submit branch known or'
 
4552
                                             ' specified')
 
4553
            if remembered_submit_branch is not None:
 
4554
                note('Using saved %s location "%s" to determine what '
 
4555
                        'changes to submit.', remembered_submit_branch,
 
4556
                        submit_branch)
 
4557
 
 
4558
            if mail_to is None:
 
4559
                submit_config = Branch.open(submit_branch).get_config()
 
4560
                mail_to = submit_config.get_user_option("child_submit_to")
 
4561
 
 
4562
            stored_public_branch = branch.get_public_branch()
 
4563
            if public_branch is None:
 
4564
                public_branch = stored_public_branch
 
4565
            elif stored_public_branch is None or remember:
 
4566
                branch.set_public_branch(public_branch)
 
4567
            if no_bundle and public_branch is None:
 
4568
                raise errors.BzrCommandError('No public branch specified or'
 
4569
                                             ' known')
 
4570
            base_revision_id = None
 
4571
            revision_id = None
 
4572
            if revision is not None:
 
4573
                if len(revision) > 2:
 
4574
                    raise errors.BzrCommandError('bzr send takes '
 
4575
                        'at most two one revision identifiers')
 
4576
                revision_id = revision[-1].as_revision_id(branch)
 
4577
                if len(revision) == 2:
 
4578
                    base_revision_id = revision[0].as_revision_id(branch)
 
4579
            if revision_id is None:
 
4580
                revision_id = branch.last_revision()
 
4581
            if revision_id == NULL_REVISION:
 
4582
                raise errors.BzrCommandError('No revisions to submit.')
 
4583
            if format == '4':
 
4584
                directive = merge_directive.MergeDirective2.from_objects(
 
4585
                    branch.repository, revision_id, time.time(),
 
4586
                    osutils.local_time_offset(), submit_branch,
 
4587
                    public_branch=public_branch, include_patch=not no_patch,
 
4588
                    include_bundle=not no_bundle, message=message,
 
4589
                    base_revision_id=base_revision_id)
 
4590
            elif format == '0.9':
 
4591
                if not no_bundle:
 
4592
                    if not no_patch:
 
4593
                        patch_type = 'bundle'
 
4594
                    else:
 
4595
                        raise errors.BzrCommandError('Format 0.9 does not'
 
4596
                            ' permit bundle with no patch')
 
4597
                else:
 
4598
                    if not no_patch:
 
4599
                        patch_type = 'diff'
 
4600
                    else:
 
4601
                        patch_type = None
 
4602
                directive = merge_directive.MergeDirective.from_objects(
 
4603
                    branch.repository, revision_id, time.time(),
 
4604
                    osutils.local_time_offset(), submit_branch,
 
4605
                    public_branch=public_branch, patch_type=patch_type,
 
4606
                    message=message)
 
4607
 
 
4608
            outfile.writelines(directive.to_lines())
 
4609
            if output is None:
 
4610
                subject = '[MERGE] '
 
4611
                if message is not None:
 
4612
                    subject += message
 
4613
                else:
 
4614
                    revision = branch.repository.get_revision(revision_id)
 
4615
                    subject += revision.get_summary()
 
4616
                basename = directive.get_disk_name(branch)
 
4617
                mail_client.compose_merge_request(mail_to, subject,
 
4618
                                                  outfile.getvalue(), basename)
 
4619
        finally:
 
4620
            if output != '-':
 
4621
                outfile.close()
 
4622
            branch.unlock()
5239
4623
 
5240
4624
 
5241
4625
class cmd_bundle_revisions(cmd_send):
5242
 
    __doc__ = """Create a merge-directive for submitting changes.
 
4626
 
 
4627
    """Create a merge-directive for submitting changes.
5243
4628
 
5244
4629
    A merge directive provides many things needed for requesting merges:
5245
4630
 
5285
4670
               type=unicode),
5286
4671
        Option('output', short_name='o', help='Write directive to this file.',
5287
4672
               type=unicode),
5288
 
        Option('strict',
5289
 
               help='Refuse to bundle revisions if there are uncommitted'
5290
 
               ' changes in the working tree, --no-strict disables the check.'),
5291
4673
        'revision',
5292
 
        RegistryOption('format',
5293
 
                       help='Use the specified output format.',
5294
 
                       lazy_registry=('bzrlib.send', 'format_registry')),
 
4674
        RegistryOption.from_kwargs('format',
 
4675
        'Use the specified output format.',
 
4676
        **{'4': 'Bundle format 4, Merge Directive 2 (default)',
 
4677
           '0.9': 'Bundle format 0.9, Merge Directive 1',})
5295
4678
        ]
5296
4679
    aliases = ['bundle']
5297
4680
 
5301
4684
 
5302
4685
    def run(self, submit_branch=None, public_branch=None, no_bundle=False,
5303
4686
            no_patch=False, revision=None, remember=False, output=None,
5304
 
            format=None, strict=None, **kwargs):
 
4687
            format='4', **kwargs):
5305
4688
        if output is None:
5306
4689
            output = '-'
5307
 
        from bzrlib.send import send
5308
 
        return send(submit_branch, revision, public_branch, remember,
 
4690
        return self._run(submit_branch, revision, public_branch, remember,
5309
4691
                         format, no_bundle, no_patch, output,
5310
 
                         kwargs.get('from', '.'), None, None, None,
5311
 
                         self.outf, strict=strict)
 
4692
                         kwargs.get('from', '.'), None, None)
5312
4693
 
5313
4694
 
5314
4695
class cmd_tag(Command):
5315
 
    __doc__ = """Create, remove or modify a tag naming a revision.
5316
 
 
 
4696
    """Create, remove or modify a tag naming a revision.
 
4697
    
5317
4698
    Tags give human-meaningful names to revisions.  Commands that take a -r
5318
4699
    (--revision) option can be given -rtag:X, where X is any previously
5319
4700
    created tag.
5321
4702
    Tags are stored in the branch.  Tags are copied from one branch to another
5322
4703
    along when you branch, push, pull or merge.
5323
4704
 
5324
 
    It is an error to give a tag name that already exists unless you pass
 
4705
    It is an error to give a tag name that already exists unless you pass 
5325
4706
    --force, in which case the tag is moved to point to the new revision.
5326
4707
 
5327
4708
    To rename a tag (change the name but keep it on the same revsion), run ``bzr
5328
4709
    tag new-name -r tag:old-name`` and then ``bzr tag --delete oldname``.
5329
 
 
5330
 
    If no tag name is specified it will be determined through the 
5331
 
    'automatic_tag_name' hook. This can e.g. be used to automatically tag
5332
 
    upstream releases by reading configure.ac. See ``bzr help hooks`` for
5333
 
    details.
5334
4710
    """
5335
4711
 
5336
4712
    _see_also = ['commit', 'tags']
5337
 
    takes_args = ['tag_name?']
 
4713
    takes_args = ['tag_name']
5338
4714
    takes_options = [
5339
4715
        Option('delete',
5340
4716
            help='Delete this tag rather than placing it.',
5350
4726
        'revision',
5351
4727
        ]
5352
4728
 
5353
 
    def run(self, tag_name=None,
 
4729
    def run(self, tag_name,
5354
4730
            delete=None,
5355
4731
            directory='.',
5356
4732
            force=None,
5358
4734
            ):
5359
4735
        branch, relpath = Branch.open_containing(directory)
5360
4736
        branch.lock_write()
5361
 
        self.add_cleanup(branch.unlock)
5362
 
        if delete:
5363
 
            if tag_name is None:
5364
 
                raise errors.BzrCommandError("No tag specified to delete.")
5365
 
            branch.tags.delete_tag(tag_name)
5366
 
            self.outf.write('Deleted tag %s.\n' % tag_name)
5367
 
        else:
5368
 
            if revision:
5369
 
                if len(revision) != 1:
5370
 
                    raise errors.BzrCommandError(
5371
 
                        "Tags can only be placed on a single revision, "
5372
 
                        "not on a range")
5373
 
                revision_id = revision[0].as_revision_id(branch)
 
4737
        try:
 
4738
            if delete:
 
4739
                branch.tags.delete_tag(tag_name)
 
4740
                self.outf.write('Deleted tag %s.\n' % tag_name)
5374
4741
            else:
5375
 
                revision_id = branch.last_revision()
5376
 
            if tag_name is None:
5377
 
                tag_name = branch.automatic_tag_name(revision_id)
5378
 
                if tag_name is None:
5379
 
                    raise errors.BzrCommandError(
5380
 
                        "Please specify a tag name.")
5381
 
            if (not force) and branch.tags.has_tag(tag_name):
5382
 
                raise errors.TagAlreadyExists(tag_name)
5383
 
            branch.tags.set_tag(tag_name, revision_id)
5384
 
            self.outf.write('Created tag %s.\n' % tag_name)
 
4742
                if revision:
 
4743
                    if len(revision) != 1:
 
4744
                        raise errors.BzrCommandError(
 
4745
                            "Tags can only be placed on a single revision, "
 
4746
                            "not on a range")
 
4747
                    revision_id = revision[0].as_revision_id(branch)
 
4748
                else:
 
4749
                    revision_id = branch.last_revision()
 
4750
                if (not force) and branch.tags.has_tag(tag_name):
 
4751
                    raise errors.TagAlreadyExists(tag_name)
 
4752
                branch.tags.set_tag(tag_name, revision_id)
 
4753
                self.outf.write('Created tag %s.\n' % tag_name)
 
4754
        finally:
 
4755
            branch.unlock()
5385
4756
 
5386
4757
 
5387
4758
class cmd_tags(Command):
5388
 
    __doc__ = """List tags.
 
4759
    """List tags.
5389
4760
 
5390
4761
    This command shows a table of tag names and the revisions they reference.
5391
4762
    """
5419
4790
        if not tags:
5420
4791
            return
5421
4792
 
5422
 
        branch.lock_read()
5423
 
        self.add_cleanup(branch.unlock)
5424
4793
        if revision:
5425
 
            graph = branch.repository.get_graph()
5426
 
            rev1, rev2 = _get_revision_range(revision, branch, self.name())
5427
 
            revid1, revid2 = rev1.rev_id, rev2.rev_id
5428
 
            # only show revisions between revid1 and revid2 (inclusive)
5429
 
            tags = [(tag, revid) for tag, revid in tags if
5430
 
                graph.is_between(revid, revid1, revid2)]
 
4794
            branch.lock_read()
 
4795
            try:
 
4796
                graph = branch.repository.get_graph()
 
4797
                rev1, rev2 = _get_revision_range(revision, branch, self.name())
 
4798
                revid1, revid2 = rev1.rev_id, rev2.rev_id
 
4799
                # only show revisions between revid1 and revid2 (inclusive)
 
4800
                tags = [(tag, revid) for tag, revid in tags if
 
4801
                    graph.is_between(revid, revid1, revid2)]
 
4802
            finally:
 
4803
                branch.unlock()
5431
4804
        if sort == 'alpha':
5432
4805
            tags.sort()
5433
4806
        elif sort == 'time':
5443
4816
            tags.sort(key=lambda x: timestamps[x[1]])
5444
4817
        if not show_ids:
5445
4818
            # [ (tag, revid), ... ] -> [ (tag, dotted_revno), ... ]
5446
 
            for index, (tag, revid) in enumerate(tags):
5447
 
                try:
5448
 
                    revno = branch.revision_id_to_dotted_revno(revid)
5449
 
                    if isinstance(revno, tuple):
5450
 
                        revno = '.'.join(map(str, revno))
5451
 
                except errors.NoSuchRevision:
5452
 
                    # Bad tag data/merges can lead to tagged revisions
5453
 
                    # which are not in this branch. Fail gracefully ...
5454
 
                    revno = '?'
5455
 
                tags[index] = (tag, revno)
5456
 
        self.cleanup_now()
 
4819
            revno_map = branch.get_revision_id_to_revno_map()
 
4820
            tags = [ (tag, '.'.join(map(str, revno_map.get(revid, ('?',)))))
 
4821
                        for tag, revid in tags ]
5457
4822
        for tag, revspec in tags:
5458
4823
            self.outf.write('%-20s %s\n' % (tag, revspec))
5459
4824
 
5460
4825
 
5461
4826
class cmd_reconfigure(Command):
5462
 
    __doc__ = """Reconfigure the type of a bzr directory.
 
4827
    """Reconfigure the type of a bzr directory.
5463
4828
 
5464
4829
    A target configuration must be specified.
5465
4830
 
5474
4839
 
5475
4840
    _see_also = ['branches', 'checkouts', 'standalone-trees', 'working-trees']
5476
4841
    takes_args = ['location?']
5477
 
    takes_options = [
5478
 
        RegistryOption.from_kwargs(
5479
 
            'target_type',
5480
 
            title='Target type',
5481
 
            help='The type to reconfigure the directory to.',
5482
 
            value_switches=True, enum_switch=False,
5483
 
            branch='Reconfigure to be an unbound branch with no working tree.',
5484
 
            tree='Reconfigure to be an unbound branch with a working tree.',
5485
 
            checkout='Reconfigure to be a bound branch with a working tree.',
5486
 
            lightweight_checkout='Reconfigure to be a lightweight'
5487
 
                ' checkout (with no local history).',
5488
 
            standalone='Reconfigure to be a standalone branch '
5489
 
                '(i.e. stop using shared repository).',
5490
 
            use_shared='Reconfigure to use a shared repository.',
5491
 
            with_trees='Reconfigure repository to create '
5492
 
                'working trees on branches by default.',
5493
 
            with_no_trees='Reconfigure repository to not create '
5494
 
                'working trees on branches by default.'
5495
 
            ),
5496
 
        Option('bind-to', help='Branch to bind checkout to.', type=str),
5497
 
        Option('force',
5498
 
            help='Perform reconfiguration even if local changes'
5499
 
            ' will be lost.'),
5500
 
        Option('stacked-on',
5501
 
            help='Reconfigure a branch to be stacked on another branch.',
5502
 
            type=unicode,
5503
 
            ),
5504
 
        Option('unstacked',
5505
 
            help='Reconfigure a branch to be unstacked.  This '
5506
 
                'may require copying substantial data into it.',
5507
 
            ),
5508
 
        ]
 
4842
    takes_options = [RegistryOption.from_kwargs('target_type',
 
4843
                     title='Target type',
 
4844
                     help='The type to reconfigure the directory to.',
 
4845
                     value_switches=True, enum_switch=False,
 
4846
                     branch='Reconfigure to be an unbound branch '
 
4847
                        'with no working tree.',
 
4848
                     tree='Reconfigure to be an unbound branch '
 
4849
                        'with a working tree.',
 
4850
                     checkout='Reconfigure to be a bound branch '
 
4851
                        'with a working tree.',
 
4852
                     lightweight_checkout='Reconfigure to be a lightweight'
 
4853
                     ' checkout (with no local history).',
 
4854
                     standalone='Reconfigure to be a standalone branch '
 
4855
                        '(i.e. stop using shared repository).',
 
4856
                     use_shared='Reconfigure to use a shared repository.'),
 
4857
                     Option('bind-to', help='Branch to bind checkout to.',
 
4858
                            type=str),
 
4859
                     Option('force',
 
4860
                        help='Perform reconfiguration even if local changes'
 
4861
                        ' will be lost.')
 
4862
                     ]
5509
4863
 
5510
 
    def run(self, location=None, target_type=None, bind_to=None, force=False,
5511
 
            stacked_on=None,
5512
 
            unstacked=None):
 
4864
    def run(self, location=None, target_type=None, bind_to=None, force=False):
5513
4865
        directory = bzrdir.BzrDir.open(location)
5514
 
        if stacked_on and unstacked:
5515
 
            raise BzrCommandError("Can't use both --stacked-on and --unstacked")
5516
 
        elif stacked_on is not None:
5517
 
            reconfigure.ReconfigureStackedOn().apply(directory, stacked_on)
5518
 
        elif unstacked:
5519
 
            reconfigure.ReconfigureUnstacked().apply(directory)
5520
 
        # At the moment you can use --stacked-on and a different
5521
 
        # reconfiguration shape at the same time; there seems no good reason
5522
 
        # to ban it.
5523
4866
        if target_type is None:
5524
 
            if stacked_on or unstacked:
5525
 
                return
5526
 
            else:
5527
 
                raise errors.BzrCommandError('No target configuration '
5528
 
                    'specified')
 
4867
            raise errors.BzrCommandError('No target configuration specified')
5529
4868
        elif target_type == 'branch':
5530
4869
            reconfiguration = reconfigure.Reconfigure.to_branch(directory)
5531
4870
        elif target_type == 'tree':
5532
4871
            reconfiguration = reconfigure.Reconfigure.to_tree(directory)
5533
4872
        elif target_type == 'checkout':
5534
 
            reconfiguration = reconfigure.Reconfigure.to_checkout(
5535
 
                directory, bind_to)
 
4873
            reconfiguration = reconfigure.Reconfigure.to_checkout(directory,
 
4874
                                                                  bind_to)
5536
4875
        elif target_type == 'lightweight-checkout':
5537
4876
            reconfiguration = reconfigure.Reconfigure.to_lightweight_checkout(
5538
4877
                directory, bind_to)
5540
4879
            reconfiguration = reconfigure.Reconfigure.to_use_shared(directory)
5541
4880
        elif target_type == 'standalone':
5542
4881
            reconfiguration = reconfigure.Reconfigure.to_standalone(directory)
5543
 
        elif target_type == 'with-trees':
5544
 
            reconfiguration = reconfigure.Reconfigure.set_repository_trees(
5545
 
                directory, True)
5546
 
        elif target_type == 'with-no-trees':
5547
 
            reconfiguration = reconfigure.Reconfigure.set_repository_trees(
5548
 
                directory, False)
5549
4882
        reconfiguration.apply(force)
5550
4883
 
5551
4884
 
5552
4885
class cmd_switch(Command):
5553
 
    __doc__ = """Set the branch of a checkout and update.
5554
 
 
 
4886
    """Set the branch of a checkout and update.
 
4887
    
5555
4888
    For lightweight checkouts, this changes the branch being referenced.
5556
4889
    For heavyweight checkouts, this checks that there are no local commits
5557
4890
    versus the current bound branch, then it makes the local branch a mirror
5568
4901
    /path/to/newbranch.
5569
4902
 
5570
4903
    Bound branches use the nickname of its master branch unless it is set
5571
 
    locally, in which case switching will update the local nickname to be
 
4904
    locally, in which case switching will update the the local nickname to be
5572
4905
    that of the master.
5573
4906
    """
5574
4907
 
5575
 
    takes_args = ['to_location?']
 
4908
    takes_args = ['to_location']
5576
4909
    takes_options = [Option('force',
5577
 
                        help='Switch even if local commits will be lost.'),
5578
 
                     'revision',
5579
 
                     Option('create-branch', short_name='b',
5580
 
                        help='Create the target branch from this one before'
5581
 
                             ' switching to it.'),
5582
 
                    ]
 
4910
                        help='Switch even if local commits will be lost.')
 
4911
                     ]
5583
4912
 
5584
 
    def run(self, to_location=None, force=False, create_branch=False,
5585
 
            revision=None):
 
4913
    def run(self, to_location, force=False):
5586
4914
        from bzrlib import switch
5587
4915
        tree_location = '.'
5588
 
        revision = _get_one_revision('switch', revision)
5589
4916
        control_dir = bzrdir.BzrDir.open_containing(tree_location)[0]
5590
 
        if to_location is None:
5591
 
            if revision is None:
5592
 
                raise errors.BzrCommandError('You must supply either a'
5593
 
                                             ' revision or a location')
5594
 
            to_location = '.'
 
4917
        branch = control_dir.open_branch()
5595
4918
        try:
5596
 
            branch = control_dir.open_branch()
5597
 
            had_explicit_nick = branch.get_config().has_explicit_nickname()
 
4919
            to_branch = Branch.open(to_location)
5598
4920
        except errors.NotBranchError:
5599
 
            branch = None
5600
 
            had_explicit_nick = False
5601
 
        if create_branch:
5602
 
            if branch is None:
5603
 
                raise errors.BzrCommandError('cannot create branch without'
5604
 
                                             ' source branch')
5605
 
            to_location = directory_service.directories.dereference(
5606
 
                              to_location)
5607
 
            if '/' not in to_location and '\\' not in to_location:
5608
 
                # This path is meant to be relative to the existing branch
5609
 
                this_url = self._get_branch_location(control_dir)
5610
 
                to_location = urlutils.join(this_url, '..', to_location)
5611
 
            to_branch = branch.bzrdir.sprout(to_location,
5612
 
                                 possible_transports=[branch.bzrdir.root_transport],
5613
 
                                 source_branch=branch).open_branch()
5614
 
        else:
5615
 
            try:
5616
 
                to_branch = Branch.open(to_location)
5617
 
            except errors.NotBranchError:
5618
 
                this_url = self._get_branch_location(control_dir)
5619
 
                to_branch = Branch.open(
5620
 
                    urlutils.join(this_url, '..', to_location))
5621
 
        if revision is not None:
5622
 
            revision = revision.as_revision_id(to_branch)
5623
 
        switch.switch(control_dir, to_branch, force, revision_id=revision)
5624
 
        if had_explicit_nick:
 
4921
            this_branch = control_dir.open_branch()
 
4922
            # This may be a heavy checkout, where we want the master branch
 
4923
            this_url = this_branch.get_bound_location()
 
4924
            # If not, use a local sibling
 
4925
            if this_url is None:
 
4926
                this_url = this_branch.base
 
4927
            to_branch = Branch.open(
 
4928
                urlutils.join(this_url, '..', to_location))
 
4929
        switch.switch(control_dir, to_branch, force)
 
4930
        if branch.get_config().has_explicit_nickname():
5625
4931
            branch = control_dir.open_branch() #get the new branch!
5626
4932
            branch.nick = to_branch.nick
5627
4933
        note('Switched to branch: %s',
5628
4934
            urlutils.unescape_for_display(to_branch.base, 'utf-8'))
5629
4935
 
5630
 
    def _get_branch_location(self, control_dir):
5631
 
        """Return location of branch for this control dir."""
5632
 
        try:
5633
 
            this_branch = control_dir.open_branch()
5634
 
            # This may be a heavy checkout, where we want the master branch
5635
 
            master_location = this_branch.get_bound_location()
5636
 
            if master_location is not None:
5637
 
                return master_location
5638
 
            # If not, use a local sibling
5639
 
            return this_branch.base
5640
 
        except errors.NotBranchError:
5641
 
            format = control_dir.find_branch_format()
5642
 
            if getattr(format, 'get_reference', None) is not None:
5643
 
                return format.get_reference(control_dir)
5644
 
            else:
5645
 
                return control_dir.root_transport.base
5646
 
 
5647
 
 
5648
 
class cmd_view(Command):
5649
 
    __doc__ = """Manage filtered views.
5650
 
 
5651
 
    Views provide a mask over the tree so that users can focus on
5652
 
    a subset of a tree when doing their work. After creating a view,
5653
 
    commands that support a list of files - status, diff, commit, etc -
5654
 
    effectively have that list of files implicitly given each time.
5655
 
    An explicit list of files can still be given but those files
5656
 
    must be within the current view.
5657
 
 
5658
 
    In most cases, a view has a short life-span: it is created to make
5659
 
    a selected change and is deleted once that change is committed.
5660
 
    At other times, you may wish to create one or more named views
5661
 
    and switch between them.
5662
 
 
5663
 
    To disable the current view without deleting it, you can switch to
5664
 
    the pseudo view called ``off``. This can be useful when you need
5665
 
    to see the whole tree for an operation or two (e.g. merge) but
5666
 
    want to switch back to your view after that.
5667
 
 
5668
 
    :Examples:
5669
 
      To define the current view::
5670
 
 
5671
 
        bzr view file1 dir1 ...
5672
 
 
5673
 
      To list the current view::
5674
 
 
5675
 
        bzr view
5676
 
 
5677
 
      To delete the current view::
5678
 
 
5679
 
        bzr view --delete
5680
 
 
5681
 
      To disable the current view without deleting it::
5682
 
 
5683
 
        bzr view --switch off
5684
 
 
5685
 
      To define a named view and switch to it::
5686
 
 
5687
 
        bzr view --name view-name file1 dir1 ...
5688
 
 
5689
 
      To list a named view::
5690
 
 
5691
 
        bzr view --name view-name
5692
 
 
5693
 
      To delete a named view::
5694
 
 
5695
 
        bzr view --name view-name --delete
5696
 
 
5697
 
      To switch to a named view::
5698
 
 
5699
 
        bzr view --switch view-name
5700
 
 
5701
 
      To list all views defined::
5702
 
 
5703
 
        bzr view --all
5704
 
 
5705
 
      To delete all views::
5706
 
 
5707
 
        bzr view --delete --all
5708
 
    """
5709
 
 
5710
 
    _see_also = []
5711
 
    takes_args = ['file*']
5712
 
    takes_options = [
5713
 
        Option('all',
5714
 
            help='Apply list or delete action to all views.',
5715
 
            ),
5716
 
        Option('delete',
5717
 
            help='Delete the view.',
5718
 
            ),
5719
 
        Option('name',
5720
 
            help='Name of the view to define, list or delete.',
5721
 
            type=unicode,
5722
 
            ),
5723
 
        Option('switch',
5724
 
            help='Name of the view to switch to.',
5725
 
            type=unicode,
5726
 
            ),
5727
 
        ]
5728
 
 
5729
 
    def run(self, file_list,
5730
 
            all=False,
5731
 
            delete=False,
5732
 
            name=None,
5733
 
            switch=None,
5734
 
            ):
5735
 
        tree, file_list = tree_files(file_list, apply_view=False)
5736
 
        current_view, view_dict = tree.views.get_view_info()
5737
 
        if name is None:
5738
 
            name = current_view
5739
 
        if delete:
5740
 
            if file_list:
5741
 
                raise errors.BzrCommandError(
5742
 
                    "Both --delete and a file list specified")
5743
 
            elif switch:
5744
 
                raise errors.BzrCommandError(
5745
 
                    "Both --delete and --switch specified")
5746
 
            elif all:
5747
 
                tree.views.set_view_info(None, {})
5748
 
                self.outf.write("Deleted all views.\n")
5749
 
            elif name is None:
5750
 
                raise errors.BzrCommandError("No current view to delete")
5751
 
            else:
5752
 
                tree.views.delete_view(name)
5753
 
                self.outf.write("Deleted '%s' view.\n" % name)
5754
 
        elif switch:
5755
 
            if file_list:
5756
 
                raise errors.BzrCommandError(
5757
 
                    "Both --switch and a file list specified")
5758
 
            elif all:
5759
 
                raise errors.BzrCommandError(
5760
 
                    "Both --switch and --all specified")
5761
 
            elif switch == 'off':
5762
 
                if current_view is None:
5763
 
                    raise errors.BzrCommandError("No current view to disable")
5764
 
                tree.views.set_view_info(None, view_dict)
5765
 
                self.outf.write("Disabled '%s' view.\n" % (current_view))
5766
 
            else:
5767
 
                tree.views.set_view_info(switch, view_dict)
5768
 
                view_str = views.view_display_str(tree.views.lookup_view())
5769
 
                self.outf.write("Using '%s' view: %s\n" % (switch, view_str))
5770
 
        elif all:
5771
 
            if view_dict:
5772
 
                self.outf.write('Views defined:\n')
5773
 
                for view in sorted(view_dict):
5774
 
                    if view == current_view:
5775
 
                        active = "=>"
5776
 
                    else:
5777
 
                        active = "  "
5778
 
                    view_str = views.view_display_str(view_dict[view])
5779
 
                    self.outf.write('%s %-20s %s\n' % (active, view, view_str))
5780
 
            else:
5781
 
                self.outf.write('No views defined.\n')
5782
 
        elif file_list:
5783
 
            if name is None:
5784
 
                # No name given and no current view set
5785
 
                name = 'my'
5786
 
            elif name == 'off':
5787
 
                raise errors.BzrCommandError(
5788
 
                    "Cannot change the 'off' pseudo view")
5789
 
            tree.views.set_view(name, sorted(file_list))
5790
 
            view_str = views.view_display_str(tree.views.lookup_view())
5791
 
            self.outf.write("Using '%s' view: %s\n" % (name, view_str))
5792
 
        else:
5793
 
            # list the files
5794
 
            if name is None:
5795
 
                # No name given and no current view set
5796
 
                self.outf.write('No current view.\n')
5797
 
            else:
5798
 
                view_str = views.view_display_str(tree.views.lookup_view(name))
5799
 
                self.outf.write("'%s' view is: %s\n" % (name, view_str))
5800
 
 
5801
4936
 
5802
4937
class cmd_hooks(Command):
5803
 
    __doc__ = """Show hooks."""
 
4938
    """Show a branch's currently registered hooks.
 
4939
    """
5804
4940
 
5805
4941
    hidden = True
5806
 
 
5807
 
    def run(self):
5808
 
        for hook_key in sorted(hooks.known_hooks.keys()):
5809
 
            some_hooks = hooks.known_hooks_key_to_object(hook_key)
5810
 
            self.outf.write("%s:\n" % type(some_hooks).__name__)
5811
 
            for hook_name, hook_point in sorted(some_hooks.items()):
5812
 
                self.outf.write("  %s:\n" % (hook_name,))
5813
 
                found_hooks = list(hook_point)
5814
 
                if found_hooks:
5815
 
                    for hook in found_hooks:
5816
 
                        self.outf.write("    %s\n" %
5817
 
                                        (some_hooks.get_hook_name(hook),))
5818
 
                else:
5819
 
                    self.outf.write("    <no hooks installed>\n")
5820
 
 
5821
 
 
5822
 
class cmd_remove_branch(Command):
5823
 
    __doc__ = """Remove a branch.
5824
 
 
5825
 
    This will remove the branch from the specified location but 
5826
 
    will keep any working tree or repository in place.
5827
 
 
5828
 
    :Examples:
5829
 
 
5830
 
      Remove the branch at repo/trunk::
5831
 
 
5832
 
        bzr remove-branch repo/trunk
5833
 
 
5834
 
    """
5835
 
 
5836
 
    takes_args = ["location?"]
5837
 
 
5838
 
    aliases = ["rmbranch"]
5839
 
 
5840
 
    def run(self, location=None):
5841
 
        if location is None:
5842
 
            location = "."
5843
 
        branch = Branch.open_containing(location)[0]
5844
 
        branch.bzrdir.destroy_branch()
5845
 
        
 
4942
    takes_args = ['path?']
 
4943
 
 
4944
    def run(self, path=None):
 
4945
        if path is None:
 
4946
            path = '.'
 
4947
        branch_hooks = Branch.open(path).hooks
 
4948
        for hook_type in branch_hooks:
 
4949
            hooks = branch_hooks[hook_type]
 
4950
            self.outf.write("%s:\n" % (hook_type,))
 
4951
            if hooks:
 
4952
                for hook in hooks:
 
4953
                    self.outf.write("  %s\n" %
 
4954
                                    (branch_hooks.get_hook_name(hook),))
 
4955
            else:
 
4956
                self.outf.write("  <no hooks installed>\n")
 
4957
 
5846
4958
 
5847
4959
class cmd_shelve(Command):
5848
 
    __doc__ = """Temporarily set aside some changes from the current tree.
 
4960
    """Temporarily set aside some changes from the current tree.
5849
4961
 
5850
4962
    Shelve allows you to temporarily put changes you've made "on the shelf",
5851
4963
    ie. out of the way, until a later time when you can bring them back from
5852
 
    the shelf with the 'unshelve' command.  The changes are stored alongside
5853
 
    your working tree, and so they aren't propagated along with your branch nor
5854
 
    will they survive its deletion.
 
4964
    the shelf with the 'unshelve' command.
5855
4965
 
5856
4966
    If shelve --list is specified, previously-shelved changes are listed.
5857
4967
 
5880
4990
                       value_switches=True, enum_switch=False),
5881
4991
 
5882
4992
        Option('list', help='List shelved changes.'),
5883
 
        Option('destroy',
5884
 
               help='Destroy removed changes instead of shelving them.'),
5885
4993
    ]
5886
4994
    _see_also = ['unshelve']
5887
4995
 
5888
4996
    def run(self, revision=None, all=False, file_list=None, message=None,
5889
 
            writer=None, list=False, destroy=False):
 
4997
            writer=None, list=False):
5890
4998
        if list:
5891
4999
            return self.run_for_list()
5892
5000
        from bzrlib.shelf_ui import Shelver
5893
5001
        if writer is None:
5894
5002
            writer = bzrlib.option.diff_writer_registry.get()
5895
5003
        try:
5896
 
            shelver = Shelver.from_args(writer(sys.stdout), revision, all,
5897
 
                file_list, message, destroy=destroy)
5898
 
            try:
5899
 
                shelver.run()
5900
 
            finally:
5901
 
                shelver.finalize()
 
5004
            Shelver.from_args(writer(sys.stdout), revision, all, file_list,
 
5005
                              message).run()
5902
5006
        except errors.UserAbort:
5903
5007
            return 0
5904
5008
 
5905
5009
    def run_for_list(self):
5906
5010
        tree = WorkingTree.open_containing('.')[0]
5907
5011
        tree.lock_read()
5908
 
        self.add_cleanup(tree.unlock)
5909
 
        manager = tree.get_shelf_manager()
5910
 
        shelves = manager.active_shelves()
5911
 
        if len(shelves) == 0:
5912
 
            note('No shelved changes.')
5913
 
            return 0
5914
 
        for shelf_id in reversed(shelves):
5915
 
            message = manager.get_metadata(shelf_id).get('message')
5916
 
            if message is None:
5917
 
                message = '<no message>'
5918
 
            self.outf.write('%3d: %s\n' % (shelf_id, message))
5919
 
        return 1
 
5012
        try:
 
5013
            manager = tree.get_shelf_manager()
 
5014
            shelves = manager.active_shelves()
 
5015
            if len(shelves) == 0:
 
5016
                note('No shelved changes.')
 
5017
                return 0
 
5018
            for shelf_id in reversed(shelves):
 
5019
                message = manager.get_metadata(shelf_id).get('message')
 
5020
                if message is None:
 
5021
                    message = '<no message>'
 
5022
                self.outf.write('%3d: %s\n' % (shelf_id, message))
 
5023
            return 1
 
5024
        finally:
 
5025
            tree.unlock()
5920
5026
 
5921
5027
 
5922
5028
class cmd_unshelve(Command):
5923
 
    __doc__ = """Restore shelved changes.
 
5029
    """Restore shelved changes.
5924
5030
 
5925
5031
    By default, the most recently shelved changes are restored. However if you
5926
 
    specify a shelf by id those changes will be restored instead.  This works
5927
 
    best when the changes don't depend on each other.
 
5032
    specify a patch by name those changes will be restored instead.  This
 
5033
    works best when the changes don't depend on each other.
5928
5034
    """
5929
5035
 
5930
5036
    takes_args = ['shelf_id?']
5934
5040
            enum_switch=False, value_switches=True,
5935
5041
            apply="Apply changes and remove from the shelf.",
5936
5042
            dry_run="Show changes, but do not apply or remove them.",
5937
 
            preview="Instead of unshelving the changes, show the diff that "
5938
 
                    "would result from unshelving.",
5939
 
            delete_only="Delete changes without applying them.",
5940
 
            keep="Apply changes but don't delete them.",
 
5043
            delete_only="Delete changes without applying them."
5941
5044
        )
5942
5045
    ]
5943
5046
    _see_also = ['shelve']
5944
5047
 
5945
5048
    def run(self, shelf_id=None, action='apply'):
5946
5049
        from bzrlib.shelf_ui import Unshelver
5947
 
        unshelver = Unshelver.from_args(shelf_id, action)
 
5050
        Unshelver.from_args(shelf_id, action).run()
 
5051
 
 
5052
 
 
5053
def _create_prefix(cur_transport):
 
5054
    needed = [cur_transport]
 
5055
    # Recurse upwards until we can create a directory successfully
 
5056
    while True:
 
5057
        new_transport = cur_transport.clone('..')
 
5058
        if new_transport.base == cur_transport.base:
 
5059
            raise errors.BzrCommandError(
 
5060
                "Failed to create path prefix for %s."
 
5061
                % cur_transport.base)
5948
5062
        try:
5949
 
            unshelver.run()
5950
 
        finally:
5951
 
            unshelver.tree.unlock()
5952
 
 
5953
 
 
5954
 
class cmd_clean_tree(Command):
5955
 
    __doc__ = """Remove unwanted files from working tree.
5956
 
 
5957
 
    By default, only unknown files, not ignored files, are deleted.  Versioned
5958
 
    files are never deleted.
5959
 
 
5960
 
    Another class is 'detritus', which includes files emitted by bzr during
5961
 
    normal operations and selftests.  (The value of these files decreases with
5962
 
    time.)
5963
 
 
5964
 
    If no options are specified, unknown files are deleted.  Otherwise, option
5965
 
    flags are respected, and may be combined.
5966
 
 
5967
 
    To check what clean-tree will do, use --dry-run.
5968
 
    """
5969
 
    takes_options = [Option('ignored', help='Delete all ignored files.'),
5970
 
                     Option('detritus', help='Delete conflict files, merge'
5971
 
                            ' backups, and failed selftest dirs.'),
5972
 
                     Option('unknown',
5973
 
                            help='Delete files unknown to bzr (default).'),
5974
 
                     Option('dry-run', help='Show files to delete instead of'
5975
 
                            ' deleting them.'),
5976
 
                     Option('force', help='Do not prompt before deleting.')]
5977
 
    def run(self, unknown=False, ignored=False, detritus=False, dry_run=False,
5978
 
            force=False):
5979
 
        from bzrlib.clean_tree import clean_tree
5980
 
        if not (unknown or ignored or detritus):
5981
 
            unknown = True
5982
 
        if dry_run:
5983
 
            force = True
5984
 
        clean_tree('.', unknown=unknown, ignored=ignored, detritus=detritus,
5985
 
                   dry_run=dry_run, no_prompt=force)
5986
 
 
5987
 
 
5988
 
class cmd_reference(Command):
5989
 
    __doc__ = """list, view and set branch locations for nested trees.
5990
 
 
5991
 
    If no arguments are provided, lists the branch locations for nested trees.
5992
 
    If one argument is provided, display the branch location for that tree.
5993
 
    If two arguments are provided, set the branch location for that tree.
5994
 
    """
5995
 
 
5996
 
    hidden = True
5997
 
 
5998
 
    takes_args = ['path?', 'location?']
5999
 
 
6000
 
    def run(self, path=None, location=None):
6001
 
        branchdir = '.'
6002
 
        if path is not None:
6003
 
            branchdir = path
6004
 
        tree, branch, relpath =(
6005
 
            bzrdir.BzrDir.open_containing_tree_or_branch(branchdir))
6006
 
        if path is not None:
6007
 
            path = relpath
6008
 
        if tree is None:
6009
 
            tree = branch.basis_tree()
6010
 
        if path is None:
6011
 
            info = branch._get_all_reference_info().iteritems()
6012
 
            self._display_reference_info(tree, branch, info)
 
5063
            new_transport.mkdir('.')
 
5064
        except errors.NoSuchFile:
 
5065
            needed.append(new_transport)
 
5066
            cur_transport = new_transport
6013
5067
        else:
6014
 
            file_id = tree.path2id(path)
6015
 
            if file_id is None:
6016
 
                raise errors.NotVersionedError(path)
6017
 
            if location is None:
6018
 
                info = [(file_id, branch.get_reference_info(file_id))]
6019
 
                self._display_reference_info(tree, branch, info)
6020
 
            else:
6021
 
                branch.set_reference_info(file_id, path, location)
6022
 
 
6023
 
    def _display_reference_info(self, tree, branch, info):
6024
 
        ref_list = []
6025
 
        for file_id, (path, location) in info:
6026
 
            try:
6027
 
                path = tree.id2path(file_id)
6028
 
            except errors.NoSuchId:
6029
 
                pass
6030
 
            ref_list.append((path, location))
6031
 
        for path, location in sorted(ref_list):
6032
 
            self.outf.write('%s %s\n' % (path, location))
6033
 
 
6034
 
 
6035
 
def _register_lazy_builtins():
6036
 
    # register lazy builtins from other modules; called at startup and should
6037
 
    # be only called once.
6038
 
    for (name, aliases, module_name) in [
6039
 
        ('cmd_bundle_info', [], 'bzrlib.bundle.commands'),
6040
 
        ('cmd_dpush', [], 'bzrlib.foreign'),
6041
 
        ('cmd_version_info', [], 'bzrlib.cmd_version_info'),
6042
 
        ('cmd_resolve', ['resolved'], 'bzrlib.conflicts'),
6043
 
        ('cmd_conflicts', [], 'bzrlib.conflicts'),
6044
 
        ('cmd_sign_my_commits', [], 'bzrlib.sign_my_commits'),
6045
 
        ]:
6046
 
        builtin_command_registry.register_lazy(name, aliases, module_name)
 
5068
            break
 
5069
    # Now we only need to create child directories
 
5070
    while needed:
 
5071
        cur_transport = needed.pop()
 
5072
        cur_transport.ensure_base()
 
5073
 
 
5074
 
 
5075
# these get imported and then picked up by the scan for cmd_*
 
5076
# TODO: Some more consistent way to split command definitions across files;
 
5077
# we do need to load at least some information about them to know of 
 
5078
# aliases.  ideally we would avoid loading the implementation until the
 
5079
# details were needed.
 
5080
from bzrlib.cmd_version_info import cmd_version_info
 
5081
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore
 
5082
from bzrlib.bundle.commands import (
 
5083
    cmd_bundle_info,
 
5084
    )
 
5085
from bzrlib.sign_my_commits import cmd_sign_my_commits
 
5086
from bzrlib.weave_commands import cmd_versionedfile_list, \
 
5087
        cmd_weave_plan_merge, cmd_weave_merge_text