~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/builtins.py

  • Committer: John Arbash Meinel
  • Date: 2009-10-02 20:32:50 UTC
  • mto: (4679.6.1 2.1-export-c-api)
  • mto: This revision was merged to the branch mainline in revision 4735.
  • Revision ID: john@arbash-meinel.com-20091002203250-q6iv6o2mwjqp4g53
Add __iter__ support.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2004, 2005, 2006 by 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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
16
 
17
17
"""builtin bzr commands"""
18
18
 
 
19
import os
19
20
 
 
21
from bzrlib.lazy_import import lazy_import
 
22
lazy_import(globals(), """
20
23
import codecs
21
 
import errno
22
 
import os
23
 
import os.path
 
24
import cStringIO
24
25
import sys
 
26
import time
25
27
 
26
28
import bzrlib
27
29
from bzrlib import (
28
 
    branch,
 
30
    bugtracker,
29
31
    bundle,
 
32
    btree_index,
30
33
    bzrdir,
 
34
    delta,
31
35
    config,
32
36
    errors,
33
 
    ignores,
 
37
    globbing,
 
38
    hooks,
34
39
    log,
 
40
    merge as _mod_merge,
 
41
    merge_directive,
35
42
    osutils,
36
 
    repository,
 
43
    reconfigure,
 
44
    rename_map,
 
45
    revision as _mod_revision,
 
46
    symbol_versioning,
37
47
    transport,
38
48
    ui,
39
49
    urlutils,
 
50
    views,
40
51
    )
41
 
from bzrlib.branch import Branch, BranchReferenceFormat
42
 
from bzrlib.bundle import read_bundle_from_url
43
 
from bzrlib.bundle.apply_bundle import install_bundle, merge_bundle
 
52
from bzrlib.branch import Branch
44
53
from bzrlib.conflicts import ConflictList
 
54
from bzrlib.revisionspec import RevisionSpec, RevisionInfo
 
55
from bzrlib.smtp_connection import SMTPConnection
 
56
from bzrlib.workingtree import WorkingTree
 
57
""")
 
58
 
45
59
from bzrlib.commands import Command, display_command
46
 
from bzrlib.errors import (BzrError, BzrCheckError, BzrCommandError, 
47
 
                           NotBranchError, DivergedBranches, NotConflicted,
48
 
                           NoSuchFile, NoWorkingTree, FileInWrongBranch,
49
 
                           NotVersionedError, NotABundle)
50
 
from bzrlib.merge import Merge3Merger
51
 
from bzrlib.option import Option
52
 
from bzrlib.progress import DummyProgress, ProgressPhase
53
 
from bzrlib.revision import common_ancestor
54
 
from bzrlib.revisionspec import RevisionSpec
55
 
from bzrlib.trace import mutter, note, log_error, warning, is_quiet, info
56
 
from bzrlib.transport.local import LocalTransport
57
 
from bzrlib.workingtree import WorkingTree
58
 
 
59
 
 
60
 
def tree_files(file_list, default_branch=u'.'):
 
60
from bzrlib.option import (
 
61
    ListOption,
 
62
    Option,
 
63
    RegistryOption,
 
64
    custom_help,
 
65
    _parse_revision_str,
 
66
    )
 
67
from bzrlib.trace import mutter, note, warning, is_quiet, get_verbosity_level
 
68
 
 
69
 
 
70
def tree_files(file_list, default_branch=u'.', canonicalize=True,
 
71
    apply_view=True):
61
72
    try:
62
 
        return internal_tree_files(file_list, default_branch)
63
 
    except FileInWrongBranch, e:
64
 
        raise BzrCommandError("%s is not in the same branch as %s" %
65
 
                             (e.path, file_list[0]))
 
73
        return internal_tree_files(file_list, default_branch, canonicalize,
 
74
            apply_view)
 
75
    except errors.FileInWrongBranch, e:
 
76
        raise errors.BzrCommandError("%s is not in the same branch as %s" %
 
77
                                     (e.path, file_list[0]))
 
78
 
 
79
 
 
80
def tree_files_for_add(file_list):
 
81
    """
 
82
    Return a tree and list of absolute paths from a file list.
 
83
 
 
84
    Similar to tree_files, but add handles files a bit differently, so it a
 
85
    custom implementation.  In particular, MutableTreeTree.smart_add expects
 
86
    absolute paths, which it immediately converts to relative paths.
 
87
    """
 
88
    # FIXME Would be nice to just return the relative paths like
 
89
    # internal_tree_files does, but there are a large number of unit tests
 
90
    # that assume the current interface to mutabletree.smart_add
 
91
    if file_list:
 
92
        tree, relpath = WorkingTree.open_containing(file_list[0])
 
93
        if tree.supports_views():
 
94
            view_files = tree.views.lookup_view()
 
95
            if view_files:
 
96
                for filename in file_list:
 
97
                    if not osutils.is_inside_any(view_files, filename):
 
98
                        raise errors.FileOutsideView(filename, view_files)
 
99
        file_list = file_list[:]
 
100
        file_list[0] = tree.abspath(relpath)
 
101
    else:
 
102
        tree = WorkingTree.open_containing(u'.')[0]
 
103
        if tree.supports_views():
 
104
            view_files = tree.views.lookup_view()
 
105
            if view_files:
 
106
                file_list = view_files
 
107
                view_str = views.view_display_str(view_files)
 
108
                note("Ignoring files outside view. View is %s" % view_str)
 
109
    return tree, file_list
 
110
 
 
111
 
 
112
def _get_one_revision(command_name, revisions):
 
113
    if revisions is None:
 
114
        return None
 
115
    if len(revisions) != 1:
 
116
        raise errors.BzrCommandError(
 
117
            'bzr %s --revision takes exactly one revision identifier' % (
 
118
                command_name,))
 
119
    return revisions[0]
 
120
 
 
121
 
 
122
def _get_one_revision_tree(command_name, revisions, branch=None, tree=None):
 
123
    """Get a revision tree. Not suitable for commands that change the tree.
 
124
    
 
125
    Specifically, the basis tree in dirstate trees is coupled to the dirstate
 
126
    and doing a commit/uncommit/pull will at best fail due to changing the
 
127
    basis revision data.
 
128
 
 
129
    If tree is passed in, it should be already locked, for lifetime management
 
130
    of the trees internal cached state.
 
131
    """
 
132
    if branch is None:
 
133
        branch = tree.branch
 
134
    if revisions is None:
 
135
        if tree is not None:
 
136
            rev_tree = tree.basis_tree()
 
137
        else:
 
138
            rev_tree = branch.basis_tree()
 
139
    else:
 
140
        revision = _get_one_revision(command_name, revisions)
 
141
        rev_tree = revision.as_tree(branch)
 
142
    return rev_tree
66
143
 
67
144
 
68
145
# XXX: Bad function name; should possibly also be a class method of
69
146
# WorkingTree rather than a function.
70
 
def internal_tree_files(file_list, default_branch=u'.'):
 
147
def internal_tree_files(file_list, default_branch=u'.', canonicalize=True,
 
148
    apply_view=True):
71
149
    """Convert command-line paths to a WorkingTree and relative paths.
72
150
 
73
151
    This is typically used for command-line processors that take one or
75
153
 
76
154
    The filenames given are not required to exist.
77
155
 
78
 
    :param file_list: Filenames to convert.  
79
 
 
80
 
    :param default_branch: Fallback tree path to use if file_list is empty or None.
 
156
    :param file_list: Filenames to convert.
 
157
 
 
158
    :param default_branch: Fallback tree path to use if file_list is empty or
 
159
        None.
 
160
 
 
161
    :param apply_view: if True and a view is set, apply it or check that
 
162
        specified files are within it
81
163
 
82
164
    :return: workingtree, [relative_paths]
83
165
    """
84
166
    if file_list is None or len(file_list) == 0:
85
 
        return WorkingTree.open_containing(default_branch)[0], file_list
86
 
    tree = WorkingTree.open_containing(file_list[0])[0]
 
167
        tree = WorkingTree.open_containing(default_branch)[0]
 
168
        if tree.supports_views() and apply_view:
 
169
            view_files = tree.views.lookup_view()
 
170
            if view_files:
 
171
                file_list = view_files
 
172
                view_str = views.view_display_str(view_files)
 
173
                note("Ignoring files outside view. View is %s" % view_str)
 
174
        return tree, file_list
 
175
    tree = WorkingTree.open_containing(osutils.realpath(file_list[0]))[0]
 
176
    return tree, safe_relpath_files(tree, file_list, canonicalize,
 
177
        apply_view=apply_view)
 
178
 
 
179
 
 
180
def safe_relpath_files(tree, file_list, canonicalize=True, apply_view=True):
 
181
    """Convert file_list into a list of relpaths in tree.
 
182
 
 
183
    :param tree: A tree to operate on.
 
184
    :param file_list: A list of user provided paths or None.
 
185
    :param apply_view: if True and a view is set, apply it or check that
 
186
        specified files are within it
 
187
    :return: A list of relative paths.
 
188
    :raises errors.PathNotChild: When a provided path is in a different tree
 
189
        than tree.
 
190
    """
 
191
    if file_list is None:
 
192
        return None
 
193
    if tree.supports_views() and apply_view:
 
194
        view_files = tree.views.lookup_view()
 
195
    else:
 
196
        view_files = []
87
197
    new_list = []
 
198
    # tree.relpath exists as a "thunk" to osutils, but canonical_relpath
 
199
    # doesn't - fix that up here before we enter the loop.
 
200
    if canonicalize:
 
201
        fixer = lambda p: osutils.canonical_relpath(tree.basedir, p)
 
202
    else:
 
203
        fixer = tree.relpath
88
204
    for filename in file_list:
89
205
        try:
90
 
            new_list.append(tree.relpath(filename))
 
206
            relpath = fixer(osutils.dereference_path(filename))
 
207
            if  view_files and not osutils.is_inside_any(view_files, relpath):
 
208
                raise errors.FileOutsideView(filename, view_files)
 
209
            new_list.append(relpath)
91
210
        except errors.PathNotChild:
92
 
            raise FileInWrongBranch(tree.branch, filename)
93
 
    return tree, new_list
94
 
 
95
 
 
96
 
def get_format_type(typestring):
97
 
    """Parse and return a format specifier."""
98
 
    if typestring == "weave":
99
 
        return bzrdir.BzrDirFormat6()
100
 
    if typestring == "default":
101
 
        return bzrdir.BzrDirMetaFormat1()
102
 
    if typestring == "metaweave":
103
 
        format = bzrdir.BzrDirMetaFormat1()
104
 
        format.repository_format = repository.RepositoryFormat7()
105
 
        return format
106
 
    if typestring == "knit":
107
 
        format = bzrdir.BzrDirMetaFormat1()
108
 
        format.repository_format = repository.RepositoryFormatKnit1()
109
 
        return format
110
 
    msg = "Unknown bzr format %s. Current formats are: default, knit,\n" \
111
 
          "metaweave and weave" % typestring
112
 
    raise BzrCommandError(msg)
 
211
            raise errors.FileInWrongBranch(tree.branch, filename)
 
212
    return new_list
 
213
 
 
214
 
 
215
def _get_view_info_for_change_reporter(tree):
 
216
    """Get the view information from a tree for change reporting."""
 
217
    view_info = None
 
218
    try:
 
219
        current_view = tree.views.get_view_info()[0]
 
220
        if current_view is not None:
 
221
            view_info = (current_view, tree.views.lookup_view())
 
222
    except errors.ViewsNotSupported:
 
223
        pass
 
224
    return view_info
113
225
 
114
226
 
115
227
# TODO: Make sure no commands unconditionally use the working directory as a
139
251
    modified
140
252
        Text has changed since the previous revision.
141
253
 
 
254
    kind changed
 
255
        File kind has been changed (e.g. from file to directory).
 
256
 
142
257
    unknown
143
258
        Not versioned and not matching an ignore pattern.
144
259
 
145
 
    To see ignored files use 'bzr ignored'.  For details in the
 
260
    To see ignored files use 'bzr ignored'.  For details on the
146
261
    changes to file texts, use 'bzr diff'.
147
262
 
 
263
    Note that --short or -S gives status flags for each item, similar
 
264
    to Subversion's status command. To get output similar to svn -q,
 
265
    use bzr status -SV.
 
266
 
148
267
    If no arguments are specified, the status of the entire working
149
268
    directory is shown.  Otherwise, only the status of the specified
150
269
    files or directories is reported.  If a directory is given, status
151
270
    is reported for everything inside that directory.
152
271
 
 
272
    Before merges are committed, the pending merge tip revisions are
 
273
    shown. To see all pending merge revisions, use the -v option.
 
274
    To skip the display of pending merge information altogether, use
 
275
    the no-pending option or specify a file/directory.
 
276
 
153
277
    If a revision argument is given, the status is calculated against
154
278
    that revision, or between two revisions if two are provided.
155
279
    """
156
 
    
 
280
 
157
281
    # TODO: --no-recurse, --recurse options
158
 
    
 
282
 
159
283
    takes_args = ['file*']
160
 
    takes_options = ['show-ids', 'revision']
 
284
    takes_options = ['show-ids', 'revision', 'change', 'verbose',
 
285
                     Option('short', help='Use short status indicators.',
 
286
                            short_name='S'),
 
287
                     Option('versioned', help='Only show versioned files.',
 
288
                            short_name='V'),
 
289
                     Option('no-pending', help='Don\'t show pending merges.',
 
290
                           ),
 
291
                     ]
161
292
    aliases = ['st', 'stat']
162
293
 
163
294
    encoding_type = 'replace'
164
 
    
 
295
    _see_also = ['diff', 'revert', 'status-flags']
 
296
 
165
297
    @display_command
166
 
    def run(self, show_ids=False, file_list=None, revision=None):
 
298
    def run(self, show_ids=False, file_list=None, revision=None, short=False,
 
299
            versioned=False, no_pending=False, verbose=False):
167
300
        from bzrlib.status import show_tree_status
168
301
 
169
 
        tree, file_list = tree_files(file_list)
170
 
            
 
302
        if revision and len(revision) > 2:
 
303
            raise errors.BzrCommandError('bzr status --revision takes exactly'
 
304
                                         ' one or two revision specifiers')
 
305
 
 
306
        tree, relfile_list = tree_files(file_list)
 
307
        # Avoid asking for specific files when that is not needed.
 
308
        if relfile_list == ['']:
 
309
            relfile_list = None
 
310
            # Don't disable pending merges for full trees other than '.'.
 
311
            if file_list == ['.']:
 
312
                no_pending = True
 
313
        # A specific path within a tree was given.
 
314
        elif relfile_list is not None:
 
315
            no_pending = True
171
316
        show_tree_status(tree, show_ids=show_ids,
172
 
                         specific_files=file_list, revision=revision,
173
 
                         to_file=self.outf)
 
317
                         specific_files=relfile_list, revision=revision,
 
318
                         to_file=self.outf, short=short, versioned=versioned,
 
319
                         show_pending=(not no_pending), verbose=verbose)
174
320
 
175
321
 
176
322
class cmd_cat_revision(Command):
177
323
    """Write out metadata for a revision.
178
 
    
 
324
 
179
325
    The revision to print can either be specified by a specific
180
326
    revision identifier, or you can use --revision.
181
327
    """
185
331
    takes_options = ['revision']
186
332
    # cat-revision is more for frontends so should be exact
187
333
    encoding = 'strict'
188
 
    
 
334
 
189
335
    @display_command
190
336
    def run(self, revision_id=None, revision=None):
191
 
 
192
337
        if revision_id is not None and revision is not None:
193
 
            raise BzrCommandError('You can only supply one of revision_id or --revision')
 
338
            raise errors.BzrCommandError('You can only supply one of'
 
339
                                         ' revision_id or --revision')
194
340
        if revision_id is None and revision is None:
195
 
            raise BzrCommandError('You must supply either --revision or a revision_id')
 
341
            raise errors.BzrCommandError('You must supply either'
 
342
                                         ' --revision or a revision_id')
196
343
        b = WorkingTree.open_containing(u'.')[0].branch
197
344
 
198
345
        # TODO: jam 20060112 should cat-revision always output utf-8?
199
346
        if revision_id is not None:
200
 
            self.outf.write(b.repository.get_revision_xml(revision_id).decode('utf-8'))
 
347
            revision_id = osutils.safe_revision_id(revision_id, warn=False)
 
348
            try:
 
349
                self.outf.write(b.repository.get_revision_xml(revision_id).decode('utf-8'))
 
350
            except errors.NoSuchRevision:
 
351
                msg = "The repository %s contains no revision %s." % (b.repository.base,
 
352
                    revision_id)
 
353
                raise errors.BzrCommandError(msg)
201
354
        elif revision is not None:
202
355
            for rev in revision:
203
356
                if rev is None:
204
 
                    raise BzrCommandError('You cannot specify a NULL revision.')
205
 
                revno, rev_id = rev.in_history(b)
 
357
                    raise errors.BzrCommandError('You cannot specify a NULL'
 
358
                                                 ' revision.')
 
359
                rev_id = rev.as_revision_id(b)
206
360
                self.outf.write(b.repository.get_revision_xml(rev_id).decode('utf-8'))
207
 
    
 
361
 
 
362
 
 
363
class cmd_dump_btree(Command):
 
364
    """Dump the contents of a btree index file to stdout.
 
365
 
 
366
    PATH is a btree index file, it can be any URL. This includes things like
 
367
    .bzr/repository/pack-names, or .bzr/repository/indices/a34b3a...ca4a4.iix
 
368
 
 
369
    By default, the tuples stored in the index file will be displayed. With
 
370
    --raw, we will uncompress the pages, but otherwise display the raw bytes
 
371
    stored in the index.
 
372
    """
 
373
 
 
374
    # TODO: Do we want to dump the internal nodes as well?
 
375
    # TODO: It would be nice to be able to dump the un-parsed information,
 
376
    #       rather than only going through iter_all_entries. However, this is
 
377
    #       good enough for a start
 
378
    hidden = True
 
379
    encoding_type = 'exact'
 
380
    takes_args = ['path']
 
381
    takes_options = [Option('raw', help='Write the uncompressed bytes out,'
 
382
                                        ' rather than the parsed tuples.'),
 
383
                    ]
 
384
 
 
385
    def run(self, path, raw=False):
 
386
        dirname, basename = osutils.split(path)
 
387
        t = transport.get_transport(dirname)
 
388
        if raw:
 
389
            self._dump_raw_bytes(t, basename)
 
390
        else:
 
391
            self._dump_entries(t, basename)
 
392
 
 
393
    def _get_index_and_bytes(self, trans, basename):
 
394
        """Create a BTreeGraphIndex and raw bytes."""
 
395
        bt = btree_index.BTreeGraphIndex(trans, basename, None)
 
396
        bytes = trans.get_bytes(basename)
 
397
        bt._file = cStringIO.StringIO(bytes)
 
398
        bt._size = len(bytes)
 
399
        return bt, bytes
 
400
 
 
401
    def _dump_raw_bytes(self, trans, basename):
 
402
        import zlib
 
403
 
 
404
        # We need to parse at least the root node.
 
405
        # This is because the first page of every row starts with an
 
406
        # uncompressed header.
 
407
        bt, bytes = self._get_index_and_bytes(trans, basename)
 
408
        for page_idx, page_start in enumerate(xrange(0, len(bytes),
 
409
                                                     btree_index._PAGE_SIZE)):
 
410
            page_end = min(page_start + btree_index._PAGE_SIZE, len(bytes))
 
411
            page_bytes = bytes[page_start:page_end]
 
412
            if page_idx == 0:
 
413
                self.outf.write('Root node:\n')
 
414
                header_end, data = bt._parse_header_from_bytes(page_bytes)
 
415
                self.outf.write(page_bytes[:header_end])
 
416
                page_bytes = data
 
417
            self.outf.write('\nPage %d\n' % (page_idx,))
 
418
            decomp_bytes = zlib.decompress(page_bytes)
 
419
            self.outf.write(decomp_bytes)
 
420
            self.outf.write('\n')
 
421
 
 
422
    def _dump_entries(self, trans, basename):
 
423
        try:
 
424
            st = trans.stat(basename)
 
425
        except errors.TransportNotPossible:
 
426
            # We can't stat, so we'll fake it because we have to do the 'get()'
 
427
            # anyway.
 
428
            bt, _ = self._get_index_and_bytes(trans, basename)
 
429
        else:
 
430
            bt = btree_index.BTreeGraphIndex(trans, basename, st.st_size)
 
431
        for node in bt.iter_all_entries():
 
432
            # Node is made up of:
 
433
            # (index, key, value, [references])
 
434
            self.outf.write('%s\n' % (node[1:],))
 
435
 
 
436
 
 
437
class cmd_remove_tree(Command):
 
438
    """Remove the working tree from a given branch/checkout.
 
439
 
 
440
    Since a lightweight checkout is little more than a working tree
 
441
    this will refuse to run against one.
 
442
 
 
443
    To re-create the working tree, use "bzr checkout".
 
444
    """
 
445
    _see_also = ['checkout', 'working-trees']
 
446
    takes_args = ['location?']
 
447
    takes_options = [
 
448
        Option('force',
 
449
               help='Remove the working tree even if it has '
 
450
                    'uncommitted changes.'),
 
451
        ]
 
452
 
 
453
    def run(self, location='.', force=False):
 
454
        d = bzrdir.BzrDir.open(location)
 
455
 
 
456
        try:
 
457
            working = d.open_workingtree()
 
458
        except errors.NoWorkingTree:
 
459
            raise errors.BzrCommandError("No working tree to remove")
 
460
        except errors.NotLocalUrl:
 
461
            raise errors.BzrCommandError("You cannot remove the working tree"
 
462
                                         " of a remote path")
 
463
        if not force:
 
464
            # XXX: What about pending merges ? -- vila 20090629
 
465
            if working.has_changes(working.basis_tree()):
 
466
                raise errors.UncommittedChanges(working)
 
467
 
 
468
        working_path = working.bzrdir.root_transport.base
 
469
        branch_path = working.branch.bzrdir.root_transport.base
 
470
        if working_path != branch_path:
 
471
            raise errors.BzrCommandError("You cannot remove the working tree"
 
472
                                         " from a lightweight checkout")
 
473
 
 
474
        d.destroy_workingtree()
 
475
 
208
476
 
209
477
class cmd_revno(Command):
210
478
    """Show current revision number.
212
480
    This is equal to the number of revisions on this branch.
213
481
    """
214
482
 
 
483
    _see_also = ['info']
215
484
    takes_args = ['location?']
 
485
    takes_options = [
 
486
        Option('tree', help='Show revno of working tree'),
 
487
        ]
216
488
 
217
489
    @display_command
218
 
    def run(self, location=u'.'):
219
 
        self.outf.write(str(Branch.open_containing(location)[0].revno()))
220
 
        self.outf.write('\n')
 
490
    def run(self, tree=False, location=u'.'):
 
491
        if tree:
 
492
            try:
 
493
                wt = WorkingTree.open_containing(location)[0]
 
494
                wt.lock_read()
 
495
            except (errors.NoWorkingTree, errors.NotLocalUrl):
 
496
                raise errors.NoWorkingTree(location)
 
497
            try:
 
498
                revid = wt.last_revision()
 
499
                try:
 
500
                    revno_t = wt.branch.revision_id_to_dotted_revno(revid)
 
501
                except errors.NoSuchRevision:
 
502
                    revno_t = ('???',)
 
503
                revno = ".".join(str(n) for n in revno_t)
 
504
            finally:
 
505
                wt.unlock()
 
506
        else:
 
507
            b = Branch.open_containing(location)[0]
 
508
            b.lock_read()
 
509
            try:
 
510
                revno = b.revno()
 
511
            finally:
 
512
                b.unlock()
 
513
 
 
514
        self.outf.write(str(revno) + '\n')
221
515
 
222
516
 
223
517
class cmd_revision_info(Command):
225
519
    """
226
520
    hidden = True
227
521
    takes_args = ['revision_info*']
228
 
    takes_options = ['revision']
 
522
    takes_options = [
 
523
        'revision',
 
524
        Option('directory',
 
525
            help='Branch to examine, '
 
526
                 'rather than the one containing the working directory.',
 
527
            short_name='d',
 
528
            type=unicode,
 
529
            ),
 
530
        Option('tree', help='Show revno of working tree'),
 
531
        ]
229
532
 
230
533
    @display_command
231
 
    def run(self, revision=None, revision_info_list=[]):
232
 
 
233
 
        revs = []
234
 
        if revision is not None:
235
 
            revs.extend(revision)
236
 
        if revision_info_list is not None:
237
 
            for rev in revision_info_list:
238
 
                revs.append(RevisionSpec(rev))
239
 
        if len(revs) == 0:
240
 
            raise BzrCommandError('You must supply a revision identifier')
241
 
 
242
 
        b = WorkingTree.open_containing(u'.')[0].branch
243
 
 
244
 
        for rev in revs:
245
 
            revinfo = rev.in_history(b)
246
 
            if revinfo.revno is None:
247
 
                print '     %s' % revinfo.rev_id
 
534
    def run(self, revision=None, directory=u'.', tree=False,
 
535
            revision_info_list=[]):
 
536
 
 
537
        try:
 
538
            wt = WorkingTree.open_containing(directory)[0]
 
539
            b = wt.branch
 
540
            wt.lock_read()
 
541
        except (errors.NoWorkingTree, errors.NotLocalUrl):
 
542
            wt = None
 
543
            b = Branch.open_containing(directory)[0]
 
544
            b.lock_read()
 
545
        try:
 
546
            revision_ids = []
 
547
            if revision is not None:
 
548
                revision_ids.extend(rev.as_revision_id(b) for rev in revision)
 
549
            if revision_info_list is not None:
 
550
                for rev_str in revision_info_list:
 
551
                    rev_spec = RevisionSpec.from_string(rev_str)
 
552
                    revision_ids.append(rev_spec.as_revision_id(b))
 
553
            # No arguments supplied, default to the last revision
 
554
            if len(revision_ids) == 0:
 
555
                if tree:
 
556
                    if wt is None:
 
557
                        raise errors.NoWorkingTree(directory)
 
558
                    revision_ids.append(wt.last_revision())
 
559
                else:
 
560
                    revision_ids.append(b.last_revision())
 
561
 
 
562
            revinfos = []
 
563
            maxlen = 0
 
564
            for revision_id in revision_ids:
 
565
                try:
 
566
                    dotted_revno = b.revision_id_to_dotted_revno(revision_id)
 
567
                    revno = '.'.join(str(i) for i in dotted_revno)
 
568
                except errors.NoSuchRevision:
 
569
                    revno = '???'
 
570
                maxlen = max(maxlen, len(revno))
 
571
                revinfos.append([revno, revision_id])
 
572
        finally:
 
573
            if wt is None:
 
574
                b.unlock()
248
575
            else:
249
 
                print '%4d %s' % (revinfo.revno, revinfo.rev_id)
250
 
 
251
 
    
 
576
                wt.unlock()
 
577
 
 
578
        for ri in revinfos:
 
579
            self.outf.write('%*s %s\n' % (maxlen, ri[0], ri[1]))
 
580
 
 
581
 
252
582
class cmd_add(Command):
253
583
    """Add specified files or directories.
254
584
 
272
602
    you should never need to explicitly add a directory, they'll just
273
603
    get added when you add a file in the directory.
274
604
 
275
 
    --dry-run will show which files would be added, but not actually 
 
605
    --dry-run will show which files would be added, but not actually
276
606
    add them.
 
607
 
 
608
    --file-ids-from will try to use the file ids from the supplied path.
 
609
    It looks up ids trying to find a matching parent directory with the
 
610
    same filename, and then by pure path. This option is rarely needed
 
611
    but can be useful when adding the same logical file into two
 
612
    branches that will be merged later (without showing the two different
 
613
    adds as a conflict). It is also useful when merging another project
 
614
    into a subdirectory of this one.
 
615
    
 
616
    Any files matching patterns in the ignore list will not be added
 
617
    unless they are explicitly mentioned.
277
618
    """
278
619
    takes_args = ['file*']
279
 
    takes_options = ['no-recurse', 'dry-run', 'verbose']
 
620
    takes_options = [
 
621
        Option('no-recurse',
 
622
               help="Don't recursively add the contents of directories."),
 
623
        Option('dry-run',
 
624
               help="Show what would be done, but don't actually do anything."),
 
625
        'verbose',
 
626
        Option('file-ids-from',
 
627
               type=unicode,
 
628
               help='Lookup file ids from this tree.'),
 
629
        ]
280
630
    encoding_type = 'replace'
 
631
    _see_also = ['remove', 'ignore']
281
632
 
282
 
    def run(self, file_list, no_recurse=False, dry_run=False, verbose=False):
 
633
    def run(self, file_list, no_recurse=False, dry_run=False, verbose=False,
 
634
            file_ids_from=None):
283
635
        import bzrlib.add
284
636
 
285
 
        action = bzrlib.add.AddAction(to_file=self.outf,
286
 
            should_print=(not is_quiet()))
287
 
 
288
 
        added, ignored = bzrlib.add.smart_add(file_list, not no_recurse, 
289
 
                                              action=action, save=not dry_run)
 
637
        base_tree = None
 
638
        if file_ids_from is not None:
 
639
            try:
 
640
                base_tree, base_path = WorkingTree.open_containing(
 
641
                                            file_ids_from)
 
642
            except errors.NoWorkingTree:
 
643
                base_branch, base_path = Branch.open_containing(
 
644
                                            file_ids_from)
 
645
                base_tree = base_branch.basis_tree()
 
646
 
 
647
            action = bzrlib.add.AddFromBaseAction(base_tree, base_path,
 
648
                          to_file=self.outf, should_print=(not is_quiet()))
 
649
        else:
 
650
            action = bzrlib.add.AddAction(to_file=self.outf,
 
651
                should_print=(not is_quiet()))
 
652
 
 
653
        if base_tree:
 
654
            base_tree.lock_read()
 
655
        try:
 
656
            file_list = self._maybe_expand_globs(file_list)
 
657
            tree, file_list = tree_files_for_add(file_list)
 
658
            added, ignored = tree.smart_add(file_list, not
 
659
                no_recurse, action=action, save=not dry_run)
 
660
        finally:
 
661
            if base_tree is not None:
 
662
                base_tree.unlock()
290
663
        if len(ignored) > 0:
291
664
            if verbose:
292
665
                for glob in sorted(ignored.keys()):
293
666
                    for path in ignored[glob]:
294
 
                        self.outf.write("ignored %s matching \"%s\"\n" 
 
667
                        self.outf.write("ignored %s matching \"%s\"\n"
295
668
                                        % (path, glob))
296
 
            else:
297
 
                match_len = 0
298
 
                for glob, paths in ignored.items():
299
 
                    match_len += len(paths)
300
 
                self.outf.write("ignored %d file(s).\n" % match_len)
301
 
            self.outf.write("If you wish to add some of these files,"
302
 
                            " please add them by name.\n")
303
669
 
304
670
 
305
671
class cmd_mkdir(Command):
324
690
 
325
691
    takes_args = ['filename']
326
692
    hidden = True
327
 
    
 
693
 
328
694
    @display_command
329
695
    def run(self, filename):
330
696
        # TODO: jam 20050106 Can relpath return a munged path if
338
704
    """Show inventory of the current working copy or a revision.
339
705
 
340
706
    It is possible to limit the output to a particular entry
341
 
    type using the --kind option.  For example; --kind file.
 
707
    type using the --kind option.  For example: --kind file.
 
708
 
 
709
    It is also possible to restrict the list of files to a specific
 
710
    set. For example: bzr inventory --show-ids this/file
342
711
    """
343
712
 
344
 
    takes_options = ['revision', 'show-ids', 'kind']
345
 
    
 
713
    hidden = True
 
714
    _see_also = ['ls']
 
715
    takes_options = [
 
716
        'revision',
 
717
        'show-ids',
 
718
        Option('kind',
 
719
               help='List entries of a particular kind: file, directory, symlink.',
 
720
               type=unicode),
 
721
        ]
 
722
    takes_args = ['file*']
 
723
 
346
724
    @display_command
347
 
    def run(self, revision=None, show_ids=False, kind=None):
 
725
    def run(self, revision=None, show_ids=False, kind=None, file_list=None):
348
726
        if kind and kind not in ['file', 'directory', 'symlink']:
349
 
            raise BzrCommandError('invalid kind specified')
350
 
        tree = WorkingTree.open_containing(u'.')[0]
351
 
        if revision is None:
352
 
            inv = tree.read_working_inventory()
353
 
        else:
354
 
            if len(revision) > 1:
355
 
                raise BzrCommandError('bzr inventory --revision takes'
356
 
                    ' exactly one revision identifier')
357
 
            inv = tree.branch.repository.get_revision_inventory(
358
 
                revision[0].in_history(tree.branch).rev_id)
359
 
 
360
 
        for path, entry in inv.entries():
 
727
            raise errors.BzrCommandError('invalid kind %r specified' % (kind,))
 
728
 
 
729
        revision = _get_one_revision('inventory', revision)
 
730
        work_tree, file_list = tree_files(file_list)
 
731
        work_tree.lock_read()
 
732
        try:
 
733
            if revision is not None:
 
734
                tree = revision.as_tree(work_tree.branch)
 
735
 
 
736
                extra_trees = [work_tree]
 
737
                tree.lock_read()
 
738
            else:
 
739
                tree = work_tree
 
740
                extra_trees = []
 
741
 
 
742
            if file_list is not None:
 
743
                file_ids = tree.paths2ids(file_list, trees=extra_trees,
 
744
                                          require_versioned=True)
 
745
                # find_ids_across_trees may include some paths that don't
 
746
                # exist in 'tree'.
 
747
                entries = sorted((tree.id2path(file_id), tree.inventory[file_id])
 
748
                                 for file_id in file_ids if file_id in tree)
 
749
            else:
 
750
                entries = tree.inventory.entries()
 
751
        finally:
 
752
            tree.unlock()
 
753
            if tree is not work_tree:
 
754
                work_tree.unlock()
 
755
 
 
756
        for path, entry in entries:
361
757
            if kind and kind != entry.kind:
362
758
                continue
363
759
            if show_ids:
370
766
class cmd_mv(Command):
371
767
    """Move or rename a file.
372
768
 
373
 
    usage:
 
769
    :Usage:
374
770
        bzr mv OLDNAME NEWNAME
 
771
 
375
772
        bzr mv SOURCE... DESTINATION
376
773
 
377
774
    If the last argument is a versioned directory, all the other names
378
775
    are moved into it.  Otherwise, there must be exactly two arguments
379
 
    and the file is changed to a new name, which must not already exist.
 
776
    and the file is changed to a new name.
 
777
 
 
778
    If OLDNAME does not exist on the filesystem but is versioned and
 
779
    NEWNAME does exist on the filesystem but is not versioned, mv
 
780
    assumes that the file has been manually moved and only updates
 
781
    its internal inventory to reflect that change.
 
782
    The same is valid when moving many SOURCE files to a DESTINATION.
380
783
 
381
784
    Files cannot be moved between branches.
382
785
    """
383
786
 
384
787
    takes_args = ['names*']
 
788
    takes_options = [Option("after", help="Move only the bzr identifier"
 
789
        " of the file, because the file has already been moved."),
 
790
        Option('auto', help='Automatically guess renames.'),
 
791
        Option('dry-run', help='Avoid making changes when guessing renames.'),
 
792
        ]
385
793
    aliases = ['move', 'rename']
386
794
    encoding_type = 'replace'
387
795
 
388
 
    def run(self, names_list):
 
796
    def run(self, names_list, after=False, auto=False, dry_run=False):
 
797
        if auto:
 
798
            return self.run_auto(names_list, after, dry_run)
 
799
        elif dry_run:
 
800
            raise errors.BzrCommandError('--dry-run requires --auto.')
389
801
        if names_list is None:
390
802
            names_list = []
391
 
 
392
803
        if len(names_list) < 2:
393
 
            raise BzrCommandError("missing file argument")
394
 
        tree, rel_names = tree_files(names_list)
395
 
        
396
 
        if os.path.isdir(names_list[-1]):
 
804
            raise errors.BzrCommandError("missing file argument")
 
805
        tree, rel_names = tree_files(names_list, canonicalize=False)
 
806
        tree.lock_tree_write()
 
807
        try:
 
808
            self._run(tree, names_list, rel_names, after)
 
809
        finally:
 
810
            tree.unlock()
 
811
 
 
812
    def run_auto(self, names_list, after, dry_run):
 
813
        if names_list is not None and len(names_list) > 1:
 
814
            raise errors.BzrCommandError('Only one path may be specified to'
 
815
                                         ' --auto.')
 
816
        if after:
 
817
            raise errors.BzrCommandError('--after cannot be specified with'
 
818
                                         ' --auto.')
 
819
        work_tree, file_list = tree_files(names_list, default_branch='.')
 
820
        work_tree.lock_tree_write()
 
821
        try:
 
822
            rename_map.RenameMap.guess_renames(work_tree, dry_run)
 
823
        finally:
 
824
            work_tree.unlock()
 
825
 
 
826
    def _run(self, tree, names_list, rel_names, after):
 
827
        into_existing = osutils.isdir(names_list[-1])
 
828
        if into_existing and len(names_list) == 2:
 
829
            # special cases:
 
830
            # a. case-insensitive filesystem and change case of dir
 
831
            # b. move directory after the fact (if the source used to be
 
832
            #    a directory, but now doesn't exist in the working tree
 
833
            #    and the target is an existing directory, just rename it)
 
834
            if (not tree.case_sensitive
 
835
                and rel_names[0].lower() == rel_names[1].lower()):
 
836
                into_existing = False
 
837
            else:
 
838
                inv = tree.inventory
 
839
                # 'fix' the case of a potential 'from'
 
840
                from_id = tree.path2id(
 
841
                            tree.get_canonical_inventory_path(rel_names[0]))
 
842
                if (not osutils.lexists(names_list[0]) and
 
843
                    from_id and inv.get_file_kind(from_id) == "directory"):
 
844
                    into_existing = False
 
845
        # move/rename
 
846
        if into_existing:
397
847
            # move into existing directory
398
 
            for pair in tree.move(rel_names[:-1], rel_names[-1]):
 
848
            # All entries reference existing inventory items, so fix them up
 
849
            # for cicp file-systems.
 
850
            rel_names = tree.get_canonical_inventory_paths(rel_names)
 
851
            for pair in tree.move(rel_names[:-1], rel_names[-1], after=after):
399
852
                self.outf.write("%s => %s\n" % pair)
400
853
        else:
401
854
            if len(names_list) != 2:
402
 
                raise BzrCommandError('to mv multiple files the destination '
403
 
                                      'must be a versioned directory')
404
 
            tree.rename_one(rel_names[0], rel_names[1])
405
 
            self.outf.write("%s => %s\n" % (rel_names[0], rel_names[1]))
406
 
            
407
 
    
 
855
                raise errors.BzrCommandError('to mv multiple files the'
 
856
                                             ' destination must be a versioned'
 
857
                                             ' directory')
 
858
 
 
859
            # for cicp file-systems: the src references an existing inventory
 
860
            # item:
 
861
            src = tree.get_canonical_inventory_path(rel_names[0])
 
862
            # Find the canonical version of the destination:  In all cases, the
 
863
            # parent of the target must be in the inventory, so we fetch the
 
864
            # canonical version from there (we do not always *use* the
 
865
            # canonicalized tail portion - we may be attempting to rename the
 
866
            # case of the tail)
 
867
            canon_dest = tree.get_canonical_inventory_path(rel_names[1])
 
868
            dest_parent = osutils.dirname(canon_dest)
 
869
            spec_tail = osutils.basename(rel_names[1])
 
870
            # For a CICP file-system, we need to avoid creating 2 inventory
 
871
            # entries that differ only by case.  So regardless of the case
 
872
            # we *want* to use (ie, specified by the user or the file-system),
 
873
            # we must always choose to use the case of any existing inventory
 
874
            # items.  The only exception to this is when we are attempting a
 
875
            # case-only rename (ie, canonical versions of src and dest are
 
876
            # the same)
 
877
            dest_id = tree.path2id(canon_dest)
 
878
            if dest_id is None or tree.path2id(src) == dest_id:
 
879
                # No existing item we care about, so work out what case we
 
880
                # are actually going to use.
 
881
                if after:
 
882
                    # If 'after' is specified, the tail must refer to a file on disk.
 
883
                    if dest_parent:
 
884
                        dest_parent_fq = osutils.pathjoin(tree.basedir, dest_parent)
 
885
                    else:
 
886
                        # pathjoin with an empty tail adds a slash, which breaks
 
887
                        # relpath :(
 
888
                        dest_parent_fq = tree.basedir
 
889
 
 
890
                    dest_tail = osutils.canonical_relpath(
 
891
                                    dest_parent_fq,
 
892
                                    osutils.pathjoin(dest_parent_fq, spec_tail))
 
893
                else:
 
894
                    # not 'after', so case as specified is used
 
895
                    dest_tail = spec_tail
 
896
            else:
 
897
                # Use the existing item so 'mv' fails with AlreadyVersioned.
 
898
                dest_tail = os.path.basename(canon_dest)
 
899
            dest = osutils.pathjoin(dest_parent, dest_tail)
 
900
            mutter("attempting to move %s => %s", src, dest)
 
901
            tree.rename_one(src, dest, after=after)
 
902
            self.outf.write("%s => %s\n" % (src, dest))
 
903
 
 
904
 
408
905
class cmd_pull(Command):
409
906
    """Turn this branch into a mirror of another branch.
410
907
 
423
920
    that, you can omit the location to use the default.  To change the
424
921
    default, use --remember. The value will only be saved if the remote
425
922
    location can be accessed.
 
923
 
 
924
    Note: The location can be specified either in the form of a branch,
 
925
    or in the form of a path to a file containing a merge directive generated
 
926
    with bzr send.
426
927
    """
427
928
 
428
 
    takes_options = ['remember', 'overwrite', 'revision', 'verbose']
 
929
    _see_also = ['push', 'update', 'status-flags', 'send']
 
930
    takes_options = ['remember', 'overwrite', 'revision',
 
931
        custom_help('verbose',
 
932
            help='Show logs of pulled revisions.'),
 
933
        Option('directory',
 
934
            help='Branch to pull into, '
 
935
                 'rather than the one containing the working directory.',
 
936
            short_name='d',
 
937
            type=unicode,
 
938
            ),
 
939
        Option('local',
 
940
            help="Perform a local pull in a bound "
 
941
                 "branch.  Local pulls are not applied to "
 
942
                 "the master branch."
 
943
            ),
 
944
        ]
429
945
    takes_args = ['location?']
430
946
    encoding_type = 'replace'
431
947
 
432
 
    def run(self, location=None, remember=False, overwrite=False, revision=None, verbose=False):
 
948
    def run(self, location=None, remember=False, overwrite=False,
 
949
            revision=None, verbose=False,
 
950
            directory=None, local=False):
433
951
        # FIXME: too much stuff is in the command class
 
952
        revision_id = None
 
953
        mergeable = None
 
954
        if directory is None:
 
955
            directory = u'.'
434
956
        try:
435
 
            tree_to = WorkingTree.open_containing(u'.')[0]
 
957
            tree_to = WorkingTree.open_containing(directory)[0]
436
958
            branch_to = tree_to.branch
437
 
        except NoWorkingTree:
 
959
        except errors.NoWorkingTree:
438
960
            tree_to = None
439
 
            branch_to = Branch.open_containing(u'.')[0]
 
961
            branch_to = Branch.open_containing(directory)[0]
 
962
        
 
963
        if local and not branch_to.get_bound_location():
 
964
            raise errors.LocalRequiresBoundBranch()
440
965
 
441
 
        reader = None
 
966
        possible_transports = []
442
967
        if location is not None:
443
968
            try:
444
 
                reader = bundle.read_bundle_from_url(location)
445
 
            except NotABundle:
446
 
                pass # Continue on considering this url a Branch
 
969
                mergeable = bundle.read_mergeable_from_url(location,
 
970
                    possible_transports=possible_transports)
 
971
            except errors.NotABundle:
 
972
                mergeable = None
447
973
 
448
974
        stored_loc = branch_to.get_parent()
449
975
        if location is None:
450
976
            if stored_loc is None:
451
 
                raise BzrCommandError("No pull location known or specified.")
 
977
                raise errors.BzrCommandError("No pull location known or"
 
978
                                             " specified.")
452
979
            else:
453
980
                display_url = urlutils.unescape_for_display(stored_loc,
454
981
                        self.outf.encoding)
455
 
                self.outf.write("Using saved location: %s\n" % display_url)
 
982
                if not is_quiet():
 
983
                    self.outf.write("Using saved parent location: %s\n" % display_url)
456
984
                location = stored_loc
457
985
 
458
 
 
459
 
        if reader is not None:
460
 
            install_bundle(branch_to.repository, reader)
 
986
        revision = _get_one_revision('pull', revision)
 
987
        if mergeable is not None:
 
988
            if revision is not None:
 
989
                raise errors.BzrCommandError(
 
990
                    'Cannot use -r with merge directives or bundles')
 
991
            mergeable.install_revisions(branch_to.repository)
 
992
            base_revision_id, revision_id, verified = \
 
993
                mergeable.get_merge_request(branch_to.repository)
461
994
            branch_from = branch_to
462
995
        else:
463
 
            branch_from = Branch.open(location)
 
996
            branch_from = Branch.open(location,
 
997
                possible_transports=possible_transports)
464
998
 
465
999
            if branch_to.get_parent() is None or remember:
466
1000
                branch_to.set_parent(branch_from.base)
467
1001
 
468
 
        rev_id = None
469
 
        if revision is None:
470
 
            if reader is not None:
471
 
                rev_id = reader.target
472
 
        elif len(revision) == 1:
473
 
            rev_id = revision[0].in_history(branch_from).rev_id
474
 
        else:
475
 
            raise BzrCommandError('bzr pull --revision takes one value.')
476
 
 
477
 
        old_rh = branch_to.revision_history()
478
 
        if tree_to is not None:
479
 
            count = tree_to.pull(branch_from, overwrite, rev_id)
480
 
        else:
481
 
            count = branch_to.pull(branch_from, overwrite, rev_id)
482
 
        note('%d revision(s) pulled.' % (count,))
483
 
 
484
 
        if verbose:
485
 
            new_rh = branch_to.revision_history()
486
 
            if old_rh != new_rh:
487
 
                # Something changed
488
 
                from bzrlib.log import show_changed_revisions
489
 
                show_changed_revisions(branch_to, old_rh, new_rh,
490
 
                                       to_file=self.outf)
 
1002
        if branch_from is not branch_to:
 
1003
            branch_from.lock_read()
 
1004
        try:
 
1005
            if revision is not None:
 
1006
                revision_id = revision.as_revision_id(branch_from)
 
1007
 
 
1008
            branch_to.lock_write()
 
1009
            try:
 
1010
                if tree_to is not None:
 
1011
                    view_info = _get_view_info_for_change_reporter(tree_to)
 
1012
                    change_reporter = delta._ChangeReporter(
 
1013
                        unversioned_filter=tree_to.is_ignored,
 
1014
                        view_info=view_info)
 
1015
                    result = tree_to.pull(
 
1016
                        branch_from, overwrite, revision_id, change_reporter,
 
1017
                        possible_transports=possible_transports, local=local)
 
1018
                else:
 
1019
                    result = branch_to.pull(
 
1020
                        branch_from, overwrite, revision_id, local=local)
 
1021
 
 
1022
                result.report(self.outf)
 
1023
                if verbose and result.old_revid != result.new_revid:
 
1024
                    log.show_branch_change(
 
1025
                        branch_to, self.outf, result.old_revno,
 
1026
                        result.old_revid)
 
1027
            finally:
 
1028
                branch_to.unlock()
 
1029
        finally:
 
1030
            if branch_from is not branch_to:
 
1031
                branch_from.unlock()
491
1032
 
492
1033
 
493
1034
class cmd_push(Command):
494
1035
    """Update a mirror of this branch.
495
 
    
 
1036
 
496
1037
    The target branch will not have its working tree populated because this
497
1038
    is both expensive, and is not supported on remote file systems.
498
 
    
 
1039
 
499
1040
    Some smart servers or protocols *may* put the working tree in place in
500
1041
    the future.
501
1042
 
505
1046
 
506
1047
    If branches have diverged, you can use 'bzr push --overwrite' to replace
507
1048
    the other branch completely, discarding its unmerged changes.
508
 
    
 
1049
 
509
1050
    If you want to ensure you have the different changes in the other branch,
510
1051
    do a merge (see bzr help merge) from the other branch, and commit that.
511
1052
    After that you will be able to do a push without '--overwrite'.
516
1057
    location can be accessed.
517
1058
    """
518
1059
 
519
 
    takes_options = ['remember', 'overwrite', 'verbose',
520
 
                     Option('create-prefix', 
521
 
                            help='Create the path leading up to the branch '
522
 
                                 'if it does not already exist')]
 
1060
    _see_also = ['pull', 'update', 'working-trees']
 
1061
    takes_options = ['remember', 'overwrite', 'verbose', 'revision',
 
1062
        Option('create-prefix',
 
1063
               help='Create the path leading up to the branch '
 
1064
                    'if it does not already exist.'),
 
1065
        Option('directory',
 
1066
            help='Branch to push from, '
 
1067
                 'rather than the one containing the working directory.',
 
1068
            short_name='d',
 
1069
            type=unicode,
 
1070
            ),
 
1071
        Option('use-existing-dir',
 
1072
               help='By default push will fail if the target'
 
1073
                    ' directory exists, but does not already'
 
1074
                    ' have a control directory.  This flag will'
 
1075
                    ' allow push to proceed.'),
 
1076
        Option('stacked',
 
1077
            help='Create a stacked branch that references the public location '
 
1078
                'of the parent branch.'),
 
1079
        Option('stacked-on',
 
1080
            help='Create a stacked branch that refers to another branch '
 
1081
                'for the commit history. Only the work not present in the '
 
1082
                'referenced branch is included in the branch created.',
 
1083
            type=unicode),
 
1084
        Option('strict',
 
1085
               help='Refuse to push if there are uncommitted changes in'
 
1086
               ' the working tree, --no-strict disables the check.'),
 
1087
        ]
523
1088
    takes_args = ['location?']
524
1089
    encoding_type = 'replace'
525
1090
 
526
1091
    def run(self, location=None, remember=False, overwrite=False,
527
 
            create_prefix=False, verbose=False):
528
 
        # FIXME: Way too big!  Put this into a function called from the
529
 
        # command.
530
 
        
531
 
        br_from = Branch.open_containing('.')[0]
532
 
        stored_loc = br_from.get_push_location()
 
1092
        create_prefix=False, verbose=False, revision=None,
 
1093
        use_existing_dir=False, directory=None, stacked_on=None,
 
1094
        stacked=False, strict=None):
 
1095
        from bzrlib.push import _show_push_branch
 
1096
 
 
1097
        if directory is None:
 
1098
            directory = '.'
 
1099
        # Get the source branch
 
1100
        (tree, br_from,
 
1101
         _unused) = bzrdir.BzrDir.open_containing_tree_or_branch(directory)
 
1102
        if strict is None:
 
1103
            strict = br_from.get_config().get_user_option_as_bool('push_strict')
 
1104
        if strict is None: strict = True # default value
 
1105
        # Get the tip's revision_id
 
1106
        revision = _get_one_revision('push', revision)
 
1107
        if revision is not None:
 
1108
            revision_id = revision.in_history(br_from).rev_id
 
1109
        else:
 
1110
            revision_id = None
 
1111
        if strict and tree is not None and revision_id is None:
 
1112
            if (tree.has_changes(tree.basis_tree())
 
1113
                or len(tree.get_parent_ids()) > 1):
 
1114
                raise errors.UncommittedChanges(
 
1115
                    tree, more='Use --no-strict to force the push.')
 
1116
            if tree.last_revision() != tree.branch.last_revision():
 
1117
                # The tree has lost sync with its branch, there is little
 
1118
                # chance that the user is aware of it but he can still force
 
1119
                # the push with --no-strict
 
1120
                raise errors.OutOfDateTree(
 
1121
                    tree, more='Use --no-strict to force the push.')
 
1122
 
 
1123
        # Get the stacked_on branch, if any
 
1124
        if stacked_on is not None:
 
1125
            stacked_on = urlutils.normalize_url(stacked_on)
 
1126
        elif stacked:
 
1127
            parent_url = br_from.get_parent()
 
1128
            if parent_url:
 
1129
                parent = Branch.open(parent_url)
 
1130
                stacked_on = parent.get_public_branch()
 
1131
                if not stacked_on:
 
1132
                    # I considered excluding non-http url's here, thus forcing
 
1133
                    # 'public' branches only, but that only works for some
 
1134
                    # users, so it's best to just depend on the user spotting an
 
1135
                    # error by the feedback given to them. RBC 20080227.
 
1136
                    stacked_on = parent_url
 
1137
            if not stacked_on:
 
1138
                raise errors.BzrCommandError(
 
1139
                    "Could not determine branch to refer to.")
 
1140
 
 
1141
        # Get the destination location
533
1142
        if location is None:
 
1143
            stored_loc = br_from.get_push_location()
534
1144
            if stored_loc is None:
535
 
                raise BzrCommandError("No push location known or specified.")
 
1145
                raise errors.BzrCommandError(
 
1146
                    "No push location known or specified.")
536
1147
            else:
537
1148
                display_url = urlutils.unescape_for_display(stored_loc,
538
1149
                        self.outf.encoding)
539
 
                self.outf.write("Using saved location: %s\n" % display_url)
 
1150
                self.outf.write("Using saved push location: %s\n" % display_url)
540
1151
                location = stored_loc
541
1152
 
542
 
        to_transport = transport.get_transport(location)
543
 
        location_url = to_transport.base
544
 
 
545
 
        old_rh = []
546
 
        try:
547
 
            dir_to = bzrdir.BzrDir.open(location_url)
548
 
            br_to = dir_to.open_branch()
549
 
        except NotBranchError:
550
 
            # create a branch.
551
 
            to_transport = to_transport.clone('..')
552
 
            if not create_prefix:
553
 
                try:
554
 
                    relurl = to_transport.relpath(location_url)
555
 
                    mutter('creating directory %s => %s', location_url, relurl)
556
 
                    to_transport.mkdir(relurl)
557
 
                except NoSuchFile:
558
 
                    raise BzrCommandError("Parent directory of %s "
559
 
                                          "does not exist." % location)
560
 
            else:
561
 
                current = to_transport.base
562
 
                needed = [(to_transport, to_transport.relpath(location_url))]
563
 
                while needed:
564
 
                    try:
565
 
                        to_transport, relpath = needed[-1]
566
 
                        to_transport.mkdir(relpath)
567
 
                        needed.pop()
568
 
                    except NoSuchFile:
569
 
                        new_transport = to_transport.clone('..')
570
 
                        needed.append((new_transport,
571
 
                                       new_transport.relpath(to_transport.base)))
572
 
                        if new_transport.base == to_transport.base:
573
 
                            raise BzrCommandError("Could not create "
574
 
                                                  "path prefix.")
575
 
            dir_to = br_from.bzrdir.clone(location_url,
576
 
                revision_id=br_from.last_revision())
577
 
            br_to = dir_to.open_branch()
578
 
            count = len(br_to.revision_history())
579
 
            # We successfully created the target, remember it
580
 
            if br_from.get_push_location() is None or remember:
581
 
                br_from.set_push_location(br_to.base)
582
 
        else:
583
 
            # We were able to connect to the remote location, so remember it
584
 
            # we don't need to successfully push because of possible divergence.
585
 
            if br_from.get_push_location() is None or remember:
586
 
                br_from.set_push_location(br_to.base)
587
 
            old_rh = br_to.revision_history()
588
 
            try:
589
 
                try:
590
 
                    tree_to = dir_to.open_workingtree()
591
 
                except errors.NotLocalUrl:
592
 
                    warning('This transport does not update the working '
593
 
                            'tree of: %s' % (br_to.base,))
594
 
                    count = br_to.pull(br_from, overwrite)
595
 
                except NoWorkingTree:
596
 
                    count = br_to.pull(br_from, overwrite)
597
 
                else:
598
 
                    count = tree_to.pull(br_from, overwrite)
599
 
            except DivergedBranches:
600
 
                raise BzrCommandError("These branches have diverged."
601
 
                                      "  Try a merge then push with overwrite.")
602
 
        note('%d revision(s) pushed.' % (count,))
603
 
 
604
 
        if verbose:
605
 
            new_rh = br_to.revision_history()
606
 
            if old_rh != new_rh:
607
 
                # Something changed
608
 
                from bzrlib.log import show_changed_revisions
609
 
                show_changed_revisions(br_to, old_rh, new_rh,
610
 
                                       to_file=self.outf)
 
1153
        _show_push_branch(br_from, revision_id, location, self.outf,
 
1154
            verbose=verbose, overwrite=overwrite, remember=remember,
 
1155
            stacked_on=stacked_on, create_prefix=create_prefix,
 
1156
            use_existing_dir=use_existing_dir)
611
1157
 
612
1158
 
613
1159
class cmd_branch(Command):
614
 
    """Create a new copy of a branch.
 
1160
    """Create a new branch that is a copy of an existing branch.
615
1161
 
616
1162
    If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
617
1163
    be used.  In other words, "branch ../foo/bar" will attempt to create ./bar.
 
1164
    If the FROM_LOCATION has no / or path separator embedded, the TO_LOCATION
 
1165
    is derived from the FROM_LOCATION by stripping a leading scheme or drive
 
1166
    identifier, if any. For example, "branch lp:foo-bar" will attempt to
 
1167
    create ./foo-bar.
618
1168
 
619
1169
    To retrieve the branch as of a particular revision, supply the --revision
620
1170
    parameter, as in "branch foo/bar -r 5".
 
1171
    """
621
1172
 
622
 
    --basis is to speed up branching from remote branches.  When specified, it
623
 
    copies all the file-contents, inventory and revision data from the basis
624
 
    branch before copying anything from the remote branch.
625
 
    """
 
1173
    _see_also = ['checkout']
626
1174
    takes_args = ['from_location', 'to_location?']
627
 
    takes_options = ['revision', 'basis']
 
1175
    takes_options = ['revision', Option('hardlink',
 
1176
        help='Hard-link working tree files where possible.'),
 
1177
        Option('no-tree',
 
1178
            help="Create a branch without a working-tree."),
 
1179
        Option('switch',
 
1180
            help="Switch the checkout in the current directory "
 
1181
                 "to the new branch."),
 
1182
        Option('stacked',
 
1183
            help='Create a stacked branch referring to the source branch. '
 
1184
                'The new branch will depend on the availability of the source '
 
1185
                'branch for all operations.'),
 
1186
        Option('standalone',
 
1187
               help='Do not use a shared repository, even if available.'),
 
1188
        Option('use-existing-dir',
 
1189
               help='By default branch will fail if the target'
 
1190
                    ' directory exists, but does not already'
 
1191
                    ' have a control directory.  This flag will'
 
1192
                    ' allow branch to proceed.'),
 
1193
        ]
628
1194
    aliases = ['get', 'clone']
629
1195
 
630
 
    def run(self, from_location, to_location=None, revision=None, basis=None):
631
 
        if revision is None:
632
 
            revision = [None]
633
 
        elif len(revision) > 1:
634
 
            raise BzrCommandError(
635
 
                'bzr branch --revision takes exactly 1 revision value')
636
 
        try:
637
 
            br_from = Branch.open(from_location)
638
 
        except OSError, e:
639
 
            if e.errno == errno.ENOENT:
640
 
                raise BzrCommandError('Source location "%s" does not'
641
 
                                      ' exist.' % to_location)
642
 
            else:
643
 
                raise
 
1196
    def run(self, from_location, to_location=None, revision=None,
 
1197
            hardlink=False, stacked=False, standalone=False, no_tree=False,
 
1198
            use_existing_dir=False, switch=False):
 
1199
        from bzrlib import switch as _mod_switch
 
1200
        from bzrlib.tag import _merge_tags_if_possible
 
1201
        accelerator_tree, br_from = bzrdir.BzrDir.open_tree_or_branch(
 
1202
            from_location)
 
1203
        if (accelerator_tree is not None and
 
1204
            accelerator_tree.supports_content_filtering()):
 
1205
            accelerator_tree = None
 
1206
        revision = _get_one_revision('branch', revision)
644
1207
        br_from.lock_read()
645
1208
        try:
646
 
            if basis is not None:
647
 
                basis_dir = bzrdir.BzrDir.open_containing(basis)[0]
648
 
            else:
649
 
                basis_dir = None
650
 
            if len(revision) == 1 and revision[0] is not None:
651
 
                revision_id = revision[0].in_history(br_from)[1]
 
1209
            if revision is not None:
 
1210
                revision_id = revision.as_revision_id(br_from)
652
1211
            else:
653
1212
                # FIXME - wt.last_revision, fallback to branch, fall back to
654
1213
                # None or perhaps NULL_REVISION to mean copy nothing
655
1214
                # RBC 20060209
656
1215
                revision_id = br_from.last_revision()
657
1216
            if to_location is None:
658
 
                to_location = os.path.basename(from_location.rstrip("/\\"))
659
 
                name = None
660
 
            else:
661
 
                name = os.path.basename(to_location) + '\n'
662
 
 
 
1217
                to_location = urlutils.derive_to_location(from_location)
663
1218
            to_transport = transport.get_transport(to_location)
664
1219
            try:
665
1220
                to_transport.mkdir('.')
666
1221
            except errors.FileExists:
667
 
                raise BzrCommandError('Target directory "%s" already'
668
 
                                      ' exists.' % to_location)
 
1222
                if not use_existing_dir:
 
1223
                    raise errors.BzrCommandError('Target directory "%s" '
 
1224
                        'already exists.' % to_location)
 
1225
                else:
 
1226
                    try:
 
1227
                        bzrdir.BzrDir.open_from_transport(to_transport)
 
1228
                    except errors.NotBranchError:
 
1229
                        pass
 
1230
                    else:
 
1231
                        raise errors.AlreadyBranchError(to_location)
669
1232
            except errors.NoSuchFile:
670
 
                raise BzrCommandError('Parent of "%s" does not exist.' %
671
 
                                      to_location)
 
1233
                raise errors.BzrCommandError('Parent of "%s" does not exist.'
 
1234
                                             % to_location)
672
1235
            try:
673
1236
                # preserve whatever source format we have.
674
 
                dir = br_from.bzrdir.sprout(to_transport.base,
675
 
                        revision_id, basis_dir)
 
1237
                dir = br_from.bzrdir.sprout(to_transport.base, revision_id,
 
1238
                                            possible_transports=[to_transport],
 
1239
                                            accelerator_tree=accelerator_tree,
 
1240
                                            hardlink=hardlink, stacked=stacked,
 
1241
                                            force_new_repo=standalone,
 
1242
                                            create_tree_if_local=not no_tree,
 
1243
                                            source_branch=br_from)
676
1244
                branch = dir.open_branch()
677
1245
            except errors.NoSuchRevision:
678
1246
                to_transport.delete_tree('.')
679
 
                msg = "The branch %s has no revision %s." % (from_location, revision[0])
680
 
                raise BzrCommandError(msg)
681
 
            except errors.UnlistableBranch:
682
 
                osutils.rmtree(to_location)
683
 
                msg = "The branch %s cannot be used as a --basis" % (basis,)
684
 
                raise BzrCommandError(msg)
685
 
            if name:
686
 
                branch.control_files.put_utf8('branch-name', name)
687
 
            note('Branched %d revision(s).' % branch.revno())
 
1247
                msg = "The branch %s has no revision %s." % (from_location,
 
1248
                    revision)
 
1249
                raise errors.BzrCommandError(msg)
 
1250
            _merge_tags_if_possible(br_from, branch)
 
1251
            # If the source branch is stacked, the new branch may
 
1252
            # be stacked whether we asked for that explicitly or not.
 
1253
            # We therefore need a try/except here and not just 'if stacked:'
 
1254
            try:
 
1255
                note('Created new stacked branch referring to %s.' %
 
1256
                    branch.get_stacked_on_url())
 
1257
            except (errors.NotStacked, errors.UnstackableBranchFormat,
 
1258
                errors.UnstackableRepositoryFormat), e:
 
1259
                note('Branched %d revision(s).' % branch.revno())
 
1260
            if switch:
 
1261
                # Switch to the new branch
 
1262
                wt, _ = WorkingTree.open_containing('.')
 
1263
                _mod_switch.switch(wt.bzrdir, branch)
 
1264
                note('Switched to branch: %s',
 
1265
                    urlutils.unescape_for_display(branch.base, 'utf-8'))
688
1266
        finally:
689
1267
            br_from.unlock()
690
1268
 
696
1274
    the branch found in '.'. This is useful if you have removed the working tree
697
1275
    or if it was never created - i.e. if you pushed the branch to its current
698
1276
    location using SFTP.
699
 
    
 
1277
 
700
1278
    If the TO_LOCATION is omitted, the last component of the BRANCH_LOCATION will
701
1279
    be used.  In other words, "checkout ../foo/bar" will attempt to create ./bar.
 
1280
    If the BRANCH_LOCATION has no / or path separator embedded, the TO_LOCATION
 
1281
    is derived from the BRANCH_LOCATION by stripping a leading scheme or drive
 
1282
    identifier, if any. For example, "checkout lp:foo-bar" will attempt to
 
1283
    create ./foo-bar.
702
1284
 
703
1285
    To retrieve the branch as of a particular revision, supply the --revision
704
1286
    parameter, as in "checkout foo/bar -r 5". Note that this will be immediately
705
1287
    out of date [so you cannot commit] but it may be useful (i.e. to examine old
706
1288
    code.)
 
1289
    """
707
1290
 
708
 
    --basis is to speed up checking out from remote branches.  When specified, it
709
 
    uses the inventory and file contents from the basis branch in preference to the
710
 
    branch being checked out.
711
 
    """
 
1291
    _see_also = ['checkouts', 'branch']
712
1292
    takes_args = ['branch_location?', 'to_location?']
713
 
    takes_options = ['revision', # , 'basis']
 
1293
    takes_options = ['revision',
714
1294
                     Option('lightweight',
715
 
                            help="perform a lightweight checkout. Lightweight "
 
1295
                            help="Perform a lightweight checkout.  Lightweight "
716
1296
                                 "checkouts depend on access to the branch for "
717
 
                                 "every operation. Normal checkouts can perform "
 
1297
                                 "every operation.  Normal checkouts can perform "
718
1298
                                 "common operations like diff and status without "
719
1299
                                 "such access, and also support local commits."
720
1300
                            ),
 
1301
                     Option('files-from', type=str,
 
1302
                            help="Get file contents from this tree."),
 
1303
                     Option('hardlink',
 
1304
                            help='Hard-link working tree files where possible.'
 
1305
                            ),
721
1306
                     ]
722
1307
    aliases = ['co']
723
1308
 
724
 
    def run(self, branch_location=None, to_location=None, revision=None, basis=None,
725
 
            lightweight=False):
726
 
        if revision is None:
727
 
            revision = [None]
728
 
        elif len(revision) > 1:
729
 
            raise BzrCommandError(
730
 
                'bzr checkout --revision takes exactly 1 revision value')
 
1309
    def run(self, branch_location=None, to_location=None, revision=None,
 
1310
            lightweight=False, files_from=None, hardlink=False):
731
1311
        if branch_location is None:
732
1312
            branch_location = osutils.getcwd()
733
1313
            to_location = branch_location
734
 
        source = Branch.open(branch_location)
735
 
        if len(revision) == 1 and revision[0] is not None:
736
 
            revision_id = revision[0].in_history(source)[1]
 
1314
        accelerator_tree, source = bzrdir.BzrDir.open_tree_or_branch(
 
1315
            branch_location)
 
1316
        revision = _get_one_revision('checkout', revision)
 
1317
        if files_from is not None:
 
1318
            accelerator_tree = WorkingTree.open(files_from)
 
1319
        if revision is not None:
 
1320
            revision_id = revision.as_revision_id(source)
737
1321
        else:
738
1322
            revision_id = None
739
1323
        if to_location is None:
740
 
            to_location = os.path.basename(branch_location.rstrip("/\\"))
741
 
        # if the source and to_location are the same, 
 
1324
            to_location = urlutils.derive_to_location(branch_location)
 
1325
        # if the source and to_location are the same,
742
1326
        # and there is no working tree,
743
1327
        # then reconstitute a branch
744
 
        if (osutils.abspath(to_location) == 
 
1328
        if (osutils.abspath(to_location) ==
745
1329
            osutils.abspath(branch_location)):
746
1330
            try:
747
1331
                source.bzrdir.open_workingtree()
748
1332
            except errors.NoWorkingTree:
749
 
                source.bzrdir.create_workingtree()
 
1333
                source.bzrdir.create_workingtree(revision_id)
750
1334
                return
751
 
        try:
752
 
            os.mkdir(to_location)
753
 
        except OSError, e:
754
 
            if e.errno == errno.EEXIST:
755
 
                raise BzrCommandError('Target directory "%s" already'
756
 
                                      ' exists.' % to_location)
757
 
            if e.errno == errno.ENOENT:
758
 
                raise BzrCommandError('Parent of "%s" does not exist.' %
759
 
                                      to_location)
760
 
            else:
761
 
                raise
762
 
        old_format = bzrdir.BzrDirFormat.get_default_format()
763
 
        bzrdir.BzrDirFormat.set_default_format(bzrdir.BzrDirMetaFormat1())
764
 
        try:
765
 
            source.create_checkout(to_location, revision_id, lightweight)
766
 
        finally:
767
 
            bzrdir.BzrDirFormat.set_default_format(old_format)
 
1335
        source.create_checkout(to_location, revision_id, lightweight,
 
1336
                               accelerator_tree, hardlink)
768
1337
 
769
1338
 
770
1339
class cmd_renames(Command):
773
1342
    # TODO: Option to show renames between two historical versions.
774
1343
 
775
1344
    # TODO: Only show renames under dir, rather than in the whole branch.
 
1345
    _see_also = ['status']
776
1346
    takes_args = ['dir?']
777
1347
 
778
1348
    @display_command
779
1349
    def run(self, dir=u'.'):
780
 
        from bzrlib.tree import find_renames
781
1350
        tree = WorkingTree.open_containing(dir)[0]
782
 
        old_inv = tree.basis_tree().inventory
783
 
        new_inv = tree.read_working_inventory()
784
 
        renames = list(find_renames(old_inv, new_inv))
785
 
        renames.sort()
786
 
        for old_name, new_name in renames:
787
 
            self.outf.write("%s => %s\n" % (old_name, new_name))
 
1351
        tree.lock_read()
 
1352
        try:
 
1353
            new_inv = tree.inventory
 
1354
            old_tree = tree.basis_tree()
 
1355
            old_tree.lock_read()
 
1356
            try:
 
1357
                old_inv = old_tree.inventory
 
1358
                renames = []
 
1359
                iterator = tree.iter_changes(old_tree, include_unchanged=True)
 
1360
                for f, paths, c, v, p, n, k, e in iterator:
 
1361
                    if paths[0] == paths[1]:
 
1362
                        continue
 
1363
                    if None in (paths):
 
1364
                        continue
 
1365
                    renames.append(paths)
 
1366
                renames.sort()
 
1367
                for old_name, new_name in renames:
 
1368
                    self.outf.write("%s => %s\n" % (old_name, new_name))
 
1369
            finally:
 
1370
                old_tree.unlock()
 
1371
        finally:
 
1372
            tree.unlock()
788
1373
 
789
1374
 
790
1375
class cmd_update(Command):
791
1376
    """Update a tree to have the latest code committed to its branch.
792
 
    
 
1377
 
793
1378
    This will perform a merge into the working tree, and may generate
794
 
    conflicts. If you have any local changes, you will still 
 
1379
    conflicts. If you have any local changes, you will still
795
1380
    need to commit them after the update for the update to be complete.
796
 
    
797
 
    If you want to discard your local changes, you can just do a 
 
1381
 
 
1382
    If you want to discard your local changes, you can just do a
798
1383
    'bzr revert' instead of 'bzr commit' after the update.
799
1384
    """
 
1385
 
 
1386
    _see_also = ['pull', 'working-trees', 'status-flags']
800
1387
    takes_args = ['dir?']
801
1388
    aliases = ['up']
802
1389
 
803
1390
    def run(self, dir='.'):
804
1391
        tree = WorkingTree.open_containing(dir)[0]
805
 
        tree.lock_write()
806
 
        existing_pending_merges = tree.pending_merges()
 
1392
        possible_transports = []
 
1393
        master = tree.branch.get_master_branch(
 
1394
            possible_transports=possible_transports)
 
1395
        if master is not None:
 
1396
            tree.lock_write()
 
1397
        else:
 
1398
            tree.lock_tree_write()
807
1399
        try:
808
 
            last_rev = tree.last_revision() 
809
 
            if last_rev == tree.branch.last_revision():
 
1400
            existing_pending_merges = tree.get_parent_ids()[1:]
 
1401
            last_rev = _mod_revision.ensure_null(tree.last_revision())
 
1402
            if last_rev == _mod_revision.ensure_null(
 
1403
                tree.branch.last_revision()):
810
1404
                # may be up to date, check master too.
811
 
                master = tree.branch.get_master_branch()
812
 
                if master is None or last_rev == master.last_revision():
 
1405
                if master is None or last_rev == _mod_revision.ensure_null(
 
1406
                    master.last_revision()):
813
1407
                    revno = tree.branch.revision_id_to_revno(last_rev)
814
1408
                    note("Tree is up to date at revision %d." % (revno,))
815
1409
                    return 0
816
 
            conflicts = tree.update()
817
 
            revno = tree.branch.revision_id_to_revno(tree.last_revision())
 
1410
            view_info = _get_view_info_for_change_reporter(tree)
 
1411
            conflicts = tree.update(
 
1412
                delta._ChangeReporter(unversioned_filter=tree.is_ignored,
 
1413
                view_info=view_info), possible_transports=possible_transports)
 
1414
            revno = tree.branch.revision_id_to_revno(
 
1415
                _mod_revision.ensure_null(tree.last_revision()))
818
1416
            note('Updated to revision %d.' % (revno,))
819
 
            if tree.pending_merges() != existing_pending_merges:
 
1417
            if tree.get_parent_ids()[1:] != existing_pending_merges:
820
1418
                note('Your local commits will now show as pending merges with '
821
1419
                     "'bzr status', and can be committed with 'bzr commit'.")
822
1420
            if conflicts != 0:
831
1429
    """Show information about a working tree, branch or repository.
832
1430
 
833
1431
    This command will show all known locations and formats associated to the
834
 
    tree, branch or repository.  Statistical information is included with
835
 
    each report.
 
1432
    tree, branch or repository.
 
1433
 
 
1434
    In verbose mode, statistical information is included with each report.
 
1435
    To see extended statistic information, use a verbosity level of 2 or
 
1436
    higher by specifying the verbose option multiple times, e.g. -vv.
836
1437
 
837
1438
    Branches and working trees will also report any missing revisions.
 
1439
 
 
1440
    :Examples:
 
1441
 
 
1442
      Display information on the format and related locations:
 
1443
 
 
1444
        bzr info
 
1445
 
 
1446
      Display the above together with extended format information and
 
1447
      basic statistics (like the number of files in the working tree and
 
1448
      number of revisions in the branch and repository):
 
1449
 
 
1450
        bzr info -v
 
1451
 
 
1452
      Display the above together with number of committers to the branch:
 
1453
 
 
1454
        bzr info -vv
838
1455
    """
 
1456
    _see_also = ['revno', 'working-trees', 'repositories']
839
1457
    takes_args = ['location?']
840
1458
    takes_options = ['verbose']
 
1459
    encoding_type = 'replace'
841
1460
 
842
1461
    @display_command
843
1462
    def run(self, location=None, verbose=False):
 
1463
        if verbose:
 
1464
            noise_level = get_verbosity_level()
 
1465
        else:
 
1466
            noise_level = 0
844
1467
        from bzrlib.info import show_bzrdir_info
845
1468
        show_bzrdir_info(bzrdir.BzrDir.open_containing(location)[0],
846
 
                         verbose=verbose)
 
1469
                         verbose=noise_level, outfile=self.outf)
847
1470
 
848
1471
 
849
1472
class cmd_remove(Command):
850
 
    """Make a file unversioned.
851
 
 
852
 
    This makes bzr stop tracking changes to a versioned file.  It does
853
 
    not delete the working copy.
854
 
 
855
 
    You can specify one or more files, and/or --new.  If you specify --new,
856
 
    only 'added' files will be removed.  If you specify both, then new files
857
 
    in the specified directories will be removed.  If the directories are
858
 
    also new, they will also be removed.
 
1473
    """Remove files or directories.
 
1474
 
 
1475
    This makes bzr stop tracking changes to the specified files. bzr will delete
 
1476
    them if they can easily be recovered using revert. If no options or
 
1477
    parameters are given bzr will scan for files that are being tracked by bzr
 
1478
    but missing in your tree and stop tracking them for you.
859
1479
    """
860
1480
    takes_args = ['file*']
861
 
    takes_options = ['verbose', Option('new', help='remove newly-added files')]
862
 
    aliases = ['rm']
 
1481
    takes_options = ['verbose',
 
1482
        Option('new', help='Only remove files that have never been committed.'),
 
1483
        RegistryOption.from_kwargs('file-deletion-strategy',
 
1484
            'The file deletion mode to be used.',
 
1485
            title='Deletion Strategy', value_switches=True, enum_switch=False,
 
1486
            safe='Only delete files if they can be'
 
1487
                 ' safely recovered (default).',
 
1488
            keep='Delete from bzr but leave the working copy.',
 
1489
            force='Delete all the specified files, even if they can not be '
 
1490
                'recovered and even if they are non-empty directories.')]
 
1491
    aliases = ['rm', 'del']
863
1492
    encoding_type = 'replace'
864
 
    
865
 
    def run(self, file_list, verbose=False, new=False):
 
1493
 
 
1494
    def run(self, file_list, verbose=False, new=False,
 
1495
        file_deletion_strategy='safe'):
866
1496
        tree, file_list = tree_files(file_list)
867
 
        if new is False:
868
 
            if file_list is None:
869
 
                raise BzrCommandError('Specify one or more files to remove, or'
870
 
                                      ' use --new.')
871
 
        else:
872
 
            added = tree.changes_from(tree.basis_tree(),
873
 
                specific_files=file_list).added
874
 
            file_list = sorted([f[0] for f in added], reverse=True)
875
 
            if len(file_list) == 0:
876
 
                raise BzrCommandError('No matching files.')
877
 
        tree.remove(file_list, verbose=verbose, to_file=self.outf)
 
1497
 
 
1498
        if file_list is not None:
 
1499
            file_list = [f for f in file_list]
 
1500
 
 
1501
        tree.lock_write()
 
1502
        try:
 
1503
            # Heuristics should probably all move into tree.remove_smart or
 
1504
            # some such?
 
1505
            if new:
 
1506
                added = tree.changes_from(tree.basis_tree(),
 
1507
                    specific_files=file_list).added
 
1508
                file_list = sorted([f[0] for f in added], reverse=True)
 
1509
                if len(file_list) == 0:
 
1510
                    raise errors.BzrCommandError('No matching files.')
 
1511
            elif file_list is None:
 
1512
                # missing files show up in iter_changes(basis) as
 
1513
                # versioned-with-no-kind.
 
1514
                missing = []
 
1515
                for change in tree.iter_changes(tree.basis_tree()):
 
1516
                    # Find paths in the working tree that have no kind:
 
1517
                    if change[1][1] is not None and change[6][1] is None:
 
1518
                        missing.append(change[1][1])
 
1519
                file_list = sorted(missing, reverse=True)
 
1520
                file_deletion_strategy = 'keep'
 
1521
            tree.remove(file_list, verbose=verbose, to_file=self.outf,
 
1522
                keep_files=file_deletion_strategy=='keep',
 
1523
                force=file_deletion_strategy=='force')
 
1524
        finally:
 
1525
            tree.unlock()
878
1526
 
879
1527
 
880
1528
class cmd_file_id(Command):
886
1534
    """
887
1535
 
888
1536
    hidden = True
 
1537
    _see_also = ['inventory', 'ls']
889
1538
    takes_args = ['filename']
890
1539
 
891
1540
    @display_command
892
1541
    def run(self, filename):
893
1542
        tree, relpath = WorkingTree.open_containing(filename)
894
 
        i = tree.inventory.path2id(relpath)
895
 
        if i == None:
896
 
            raise BzrError("%r is not a versioned file" % filename)
 
1543
        i = tree.path2id(relpath)
 
1544
        if i is None:
 
1545
            raise errors.NotVersionedError(filename)
897
1546
        else:
898
1547
            self.outf.write(i + '\n')
899
1548
 
911
1560
    @display_command
912
1561
    def run(self, filename):
913
1562
        tree, relpath = WorkingTree.open_containing(filename)
914
 
        inv = tree.inventory
915
 
        fid = inv.path2id(relpath)
916
 
        if fid == None:
917
 
            raise BzrError("%r is not a versioned file" % filename)
918
 
        for fip in inv.get_idpath(fid):
919
 
            self.outf.write(fip + '\n')
 
1563
        fid = tree.path2id(relpath)
 
1564
        if fid is None:
 
1565
            raise errors.NotVersionedError(filename)
 
1566
        segments = osutils.splitpath(relpath)
 
1567
        for pos in range(1, len(segments) + 1):
 
1568
            path = osutils.joinpath(segments[:pos])
 
1569
            self.outf.write("%s\n" % tree.path2id(path))
920
1570
 
921
1571
 
922
1572
class cmd_reconcile(Command):
924
1574
 
925
1575
    This can correct data mismatches that may have been caused by
926
1576
    previous ghost operations or bzr upgrades. You should only
927
 
    need to run this command if 'bzr check' or a bzr developer 
 
1577
    need to run this command if 'bzr check' or a bzr developer
928
1578
    advises you to run it.
929
1579
 
930
1580
    If a second branch is provided, cross-branch reconciliation is
932
1582
    id which was not present in very early bzr versions is represented
933
1583
    correctly in both branches.
934
1584
 
935
 
    At the same time it is run it may recompress data resulting in 
 
1585
    At the same time it is run it may recompress data resulting in
936
1586
    a potential saving in disk space or performance gain.
937
1587
 
938
1588
    The branch *MUST* be on a listable system such as local disk or sftp.
939
1589
    """
 
1590
 
 
1591
    _see_also = ['check']
940
1592
    takes_args = ['branch?']
941
1593
 
942
1594
    def run(self, branch="."):
947
1599
 
948
1600
class cmd_revision_history(Command):
949
1601
    """Display the list of revision ids on a branch."""
 
1602
 
 
1603
    _see_also = ['log']
950
1604
    takes_args = ['location?']
951
1605
 
952
1606
    hidden = True
961
1615
 
962
1616
class cmd_ancestry(Command):
963
1617
    """List all revisions merged into this branch."""
 
1618
 
 
1619
    _see_also = ['log', 'revision-history']
964
1620
    takes_args = ['location?']
965
1621
 
966
1622
    hidden = True
977
1633
            last_revision = wt.last_revision()
978
1634
 
979
1635
        revision_ids = b.repository.get_ancestry(last_revision)
980
 
        assert revision_ids[0] == None
981
1636
        revision_ids.pop(0)
982
1637
        for revision_id in revision_ids:
983
1638
            self.outf.write(revision_id + '\n')
989
1644
    Use this to create an empty branch, or before importing an
990
1645
    existing project.
991
1646
 
992
 
    If there is a repository in a parent directory of the location, then 
 
1647
    If there is a repository in a parent directory of the location, then
993
1648
    the history of the branch will be stored in the repository.  Otherwise
994
 
    init creates a standalone branch which carries its own history in 
995
 
    .bzr.
 
1649
    init creates a standalone branch which carries its own history
 
1650
    in the .bzr directory.
996
1651
 
997
1652
    If there is already a branch at the location but it has no working tree,
998
1653
    the tree can be populated with 'bzr checkout'.
999
1654
 
1000
 
    Recipe for importing a tree of files:
 
1655
    Recipe for importing a tree of files::
 
1656
 
1001
1657
        cd ~/project
1002
1658
        bzr init
1003
1659
        bzr add .
1004
1660
        bzr status
1005
 
        bzr commit -m 'imported project'
 
1661
        bzr commit -m "imported project"
1006
1662
    """
 
1663
 
 
1664
    _see_also = ['init-repository', 'branch', 'checkout']
1007
1665
    takes_args = ['location?']
1008
1666
    takes_options = [
1009
 
                     Option('format', 
1010
 
                            help='Specify a format for this branch. Current'
1011
 
                                 ' formats are: default, knit, metaweave and'
1012
 
                                 ' weave. Default is knit; metaweave and'
1013
 
                                 ' weave are deprecated',
1014
 
                            type=get_format_type),
1015
 
                     ]
1016
 
    def run(self, location=None, format=None):
 
1667
        Option('create-prefix',
 
1668
               help='Create the path leading up to the branch '
 
1669
                    'if it does not already exist.'),
 
1670
         RegistryOption('format',
 
1671
                help='Specify a format for this branch. '
 
1672
                'See "help formats".',
 
1673
                lazy_registry=('bzrlib.bzrdir', 'format_registry'),
 
1674
                converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
 
1675
                value_switches=True,
 
1676
                title="Branch Format",
 
1677
                ),
 
1678
         Option('append-revisions-only',
 
1679
                help='Never change revnos or the existing log.'
 
1680
                '  Append revisions to it only.')
 
1681
         ]
 
1682
    def run(self, location=None, format=None, append_revisions_only=False,
 
1683
            create_prefix=False):
1017
1684
        if format is None:
1018
 
            format = get_format_type('default')
 
1685
            format = bzrdir.format_registry.make_bzrdir('default')
1019
1686
        if location is None:
1020
1687
            location = u'.'
1021
1688
 
1026
1693
        # Just using os.mkdir, since I don't
1027
1694
        # believe that we want to create a bunch of
1028
1695
        # locations if the user supplies an extended path
1029
 
        # TODO: create-prefix
1030
 
        try:
1031
 
            to_transport.mkdir('.')
1032
 
        except errors.FileExists:
1033
 
            pass
1034
 
                    
1035
 
        try:
1036
 
            existing_bzrdir = bzrdir.BzrDir.open(location)
1037
 
        except NotBranchError:
 
1696
        try:
 
1697
            to_transport.ensure_base()
 
1698
        except errors.NoSuchFile:
 
1699
            if not create_prefix:
 
1700
                raise errors.BzrCommandError("Parent directory of %s"
 
1701
                    " does not exist."
 
1702
                    "\nYou may supply --create-prefix to create all"
 
1703
                    " leading parent directories."
 
1704
                    % location)
 
1705
            to_transport.create_prefix()
 
1706
 
 
1707
        try:
 
1708
            a_bzrdir = bzrdir.BzrDir.open_from_transport(to_transport)
 
1709
        except errors.NotBranchError:
1038
1710
            # really a NotBzrDir error...
1039
 
            bzrdir.BzrDir.create_branch_convenience(location, format=format)
 
1711
            create_branch = bzrdir.BzrDir.create_branch_convenience
 
1712
            branch = create_branch(to_transport.base, format=format,
 
1713
                                   possible_transports=[to_transport])
 
1714
            a_bzrdir = branch.bzrdir
1040
1715
        else:
1041
 
            if existing_bzrdir.has_branch():
 
1716
            from bzrlib.transport.local import LocalTransport
 
1717
            if a_bzrdir.has_branch():
1042
1718
                if (isinstance(to_transport, LocalTransport)
1043
 
                    and not existing_bzrdir.has_workingtree()):
 
1719
                    and not a_bzrdir.has_workingtree()):
1044
1720
                        raise errors.BranchExistsWithoutWorkingTree(location)
1045
1721
                raise errors.AlreadyBranchError(location)
1046
 
            else:
1047
 
                existing_bzrdir.create_branch()
1048
 
                existing_bzrdir.create_workingtree()
 
1722
            branch = a_bzrdir.create_branch()
 
1723
            a_bzrdir.create_workingtree()
 
1724
        if append_revisions_only:
 
1725
            try:
 
1726
                branch.set_append_revisions_only(True)
 
1727
            except errors.UpgradeRequired:
 
1728
                raise errors.BzrCommandError('This branch format cannot be set'
 
1729
                    ' to append-revisions-only.  Try --default.')
 
1730
        if not is_quiet():
 
1731
            from bzrlib.info import describe_layout, describe_format
 
1732
            try:
 
1733
                tree = a_bzrdir.open_workingtree(recommend_upgrade=False)
 
1734
            except (errors.NoWorkingTree, errors.NotLocalUrl):
 
1735
                tree = None
 
1736
            repository = branch.repository
 
1737
            layout = describe_layout(repository, branch, tree).lower()
 
1738
            format = describe_format(a_bzrdir, repository, branch, tree)
 
1739
            self.outf.write("Created a %s (format: %s)\n" % (layout, format))
 
1740
            if repository.is_shared():
 
1741
                #XXX: maybe this can be refactored into transport.path_or_url()
 
1742
                url = repository.bzrdir.root_transport.external_url()
 
1743
                try:
 
1744
                    url = urlutils.local_path_from_url(url)
 
1745
                except errors.InvalidURL:
 
1746
                    pass
 
1747
                self.outf.write("Using shared repository: %s\n" % url)
1049
1748
 
1050
1749
 
1051
1750
class cmd_init_repository(Command):
1052
1751
    """Create a shared repository to hold branches.
1053
1752
 
1054
 
    New branches created under the repository directory will store their revisions
1055
 
    in the repository, not in the branch directory, if the branch format supports
1056
 
    shared storage.
1057
 
 
1058
 
    example:
1059
 
        bzr init-repo repo
1060
 
        bzr init repo/trunk
1061
 
        bzr checkout --lightweight repo/trunk trunk-checkout
1062
 
        cd trunk-checkout
1063
 
        (add files here)
 
1753
    New branches created under the repository directory will store their
 
1754
    revisions in the repository, not in the branch directory.
 
1755
 
 
1756
    If the --no-trees option is used then the branches in the repository
 
1757
    will not have working trees by default.
 
1758
 
 
1759
    :Examples:
 
1760
        Create a shared repositories holding just branches::
 
1761
 
 
1762
            bzr init-repo --no-trees repo
 
1763
            bzr init repo/trunk
 
1764
 
 
1765
        Make a lightweight checkout elsewhere::
 
1766
 
 
1767
            bzr checkout --lightweight repo/trunk trunk-checkout
 
1768
            cd trunk-checkout
 
1769
            (add files here)
1064
1770
    """
1065
 
    takes_args = ["location"] 
1066
 
    takes_options = [Option('format', 
1067
 
                            help='Specify a format for this repository.'
1068
 
                                 ' Current formats are: default, knit,'
1069
 
                                 ' metaweave and weave. Default is knit;'
1070
 
                                 ' metaweave and weave are deprecated',
1071
 
                            type=get_format_type),
1072
 
                     Option('trees',
1073
 
                             help='Allows branches in repository to have'
1074
 
                             ' a working tree')]
 
1771
 
 
1772
    _see_also = ['init', 'branch', 'checkout', 'repositories']
 
1773
    takes_args = ["location"]
 
1774
    takes_options = [RegistryOption('format',
 
1775
                            help='Specify a format for this repository. See'
 
1776
                                 ' "bzr help formats" for details.',
 
1777
                            lazy_registry=('bzrlib.bzrdir', 'format_registry'),
 
1778
                            converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
 
1779
                            value_switches=True, title='Repository format'),
 
1780
                     Option('no-trees',
 
1781
                             help='Branches in the repository will default to'
 
1782
                                  ' not having a working tree.'),
 
1783
                    ]
1075
1784
    aliases = ["init-repo"]
1076
 
    def run(self, location, format=None, trees=False):
 
1785
 
 
1786
    def run(self, location, format=None, no_trees=False):
1077
1787
        if format is None:
1078
 
            format = get_format_type('default')
 
1788
            format = bzrdir.format_registry.make_bzrdir('default')
1079
1789
 
1080
1790
        if location is None:
1081
1791
            location = '.'
1082
1792
 
1083
1793
        to_transport = transport.get_transport(location)
1084
 
        try:
1085
 
            to_transport.mkdir('.')
1086
 
        except errors.FileExists:
1087
 
            pass
 
1794
        to_transport.ensure_base()
1088
1795
 
1089
1796
        newdir = format.initialize_on_transport(to_transport)
1090
1797
        repo = newdir.create_repository(shared=True)
1091
 
        repo.set_make_working_trees(trees)
 
1798
        repo.set_make_working_trees(not no_trees)
 
1799
        if not is_quiet():
 
1800
            from bzrlib.info import show_bzrdir_info
 
1801
            show_bzrdir_info(repo.bzrdir, verbose=0, outfile=self.outf)
1092
1802
 
1093
1803
 
1094
1804
class cmd_diff(Command):
1095
 
    """Show differences in the working tree or between revisions.
1096
 
    
1097
 
    If files are listed, only the changes in those files are listed.
1098
 
    Otherwise, all changes for the tree are listed.
 
1805
    """Show differences in the working tree, between revisions or branches.
 
1806
 
 
1807
    If no arguments are given, all changes for the current tree are listed.
 
1808
    If files are given, only the changes in those files are listed.
 
1809
    Remote and multiple branches can be compared by using the --old and
 
1810
    --new options. If not provided, the default for both is derived from
 
1811
    the first argument, if any, or the current tree if no arguments are
 
1812
    given.
1099
1813
 
1100
1814
    "bzr diff -p1" is equivalent to "bzr diff --prefix old/:new/", and
1101
1815
    produces patches suitable for "patch -p1".
1102
1816
 
1103
 
    examples:
1104
 
        bzr diff
1105
 
            Shows the difference in the working tree versus the last commit
1106
 
        bzr diff -r1
1107
 
            Difference between the working tree and revision 1
1108
 
        bzr diff -r1..2
1109
 
            Difference between revision 2 and revision 1
1110
 
        bzr diff --diff-prefix old/:new/
1111
 
            Same as 'bzr diff' but prefix paths with old/ and new/
1112
 
        bzr diff bzr.mine bzr.dev
1113
 
            Show the differences between the two working trees
1114
 
        bzr diff foo.c
1115
 
            Show just the differences for 'foo.c'
 
1817
    :Exit values:
 
1818
        1 - changed
 
1819
        2 - unrepresentable changes
 
1820
        3 - error
 
1821
        0 - no change
 
1822
 
 
1823
    :Examples:
 
1824
        Shows the difference in the working tree versus the last commit::
 
1825
 
 
1826
            bzr diff
 
1827
 
 
1828
        Difference between the working tree and revision 1::
 
1829
 
 
1830
            bzr diff -r1
 
1831
 
 
1832
        Difference between revision 2 and revision 1::
 
1833
 
 
1834
            bzr diff -r1..2
 
1835
 
 
1836
        Difference between revision 2 and revision 1 for branch xxx::
 
1837
 
 
1838
            bzr diff -r1..2 xxx
 
1839
 
 
1840
        Show just the differences for file NEWS::
 
1841
 
 
1842
            bzr diff NEWS
 
1843
 
 
1844
        Show the differences in working tree xxx for file NEWS::
 
1845
 
 
1846
            bzr diff xxx/NEWS
 
1847
 
 
1848
        Show the differences from branch xxx to this working tree:
 
1849
 
 
1850
            bzr diff --old xxx
 
1851
 
 
1852
        Show the differences between two branches for file NEWS::
 
1853
 
 
1854
            bzr diff --old xxx --new yyy NEWS
 
1855
 
 
1856
        Same as 'bzr diff' but prefix paths with old/ and new/::
 
1857
 
 
1858
            bzr diff --prefix old/:new/
1116
1859
    """
1117
 
    # TODO: Option to use external diff command; could be GNU diff, wdiff,
1118
 
    #       or a graphical diff.
1119
 
 
1120
 
    # TODO: Python difflib is not exactly the same as unidiff; should
1121
 
    #       either fix it up or prefer to use an external diff.
1122
 
 
1123
 
    # TODO: Selected-file diff is inefficient and doesn't show you
1124
 
    #       deleted files.
1125
 
 
1126
 
    # TODO: This probably handles non-Unix newlines poorly.
1127
 
    
 
1860
    _see_also = ['status']
1128
1861
    takes_args = ['file*']
1129
 
    takes_options = ['revision', 'diff-options', 'prefix']
 
1862
    takes_options = [
 
1863
        Option('diff-options', type=str,
 
1864
               help='Pass these options to the external diff program.'),
 
1865
        Option('prefix', type=str,
 
1866
               short_name='p',
 
1867
               help='Set prefixes added to old and new filenames, as '
 
1868
                    'two values separated by a colon. (eg "old/:new/").'),
 
1869
        Option('old',
 
1870
            help='Branch/tree to compare from.',
 
1871
            type=unicode,
 
1872
            ),
 
1873
        Option('new',
 
1874
            help='Branch/tree to compare to.',
 
1875
            type=unicode,
 
1876
            ),
 
1877
        'revision',
 
1878
        'change',
 
1879
        Option('using',
 
1880
            help='Use this command to compare files.',
 
1881
            type=unicode,
 
1882
            ),
 
1883
        ]
1130
1884
    aliases = ['di', 'dif']
1131
1885
    encoding_type = 'exact'
1132
1886
 
1133
1887
    @display_command
1134
1888
    def run(self, revision=None, file_list=None, diff_options=None,
1135
 
            prefix=None):
1136
 
        from bzrlib.diff import diff_cmd_helper, show_diff_trees
 
1889
            prefix=None, old=None, new=None, using=None):
 
1890
        from bzrlib.diff import _get_trees_to_diff, show_diff_trees
1137
1891
 
1138
1892
        if (prefix is None) or (prefix == '0'):
1139
1893
            # diff -p0 format
1142
1896
        elif prefix == '1':
1143
1897
            old_label = 'old/'
1144
1898
            new_label = 'new/'
1145
 
        else:
1146
 
            if not ':' in prefix:
1147
 
                 raise BzrError("--diff-prefix expects two values separated by a colon")
 
1899
        elif ':' in prefix:
1148
1900
            old_label, new_label = prefix.split(":")
1149
 
        
1150
 
        try:
1151
 
            tree1, file_list = internal_tree_files(file_list)
1152
 
            tree2 = None
1153
 
            b = None
1154
 
            b2 = None
1155
 
        except FileInWrongBranch:
1156
 
            if len(file_list) != 2:
1157
 
                raise BzrCommandError("Files are in different branches")
1158
 
 
1159
 
            tree1, file1 = WorkingTree.open_containing(file_list[0])
1160
 
            tree2, file2 = WorkingTree.open_containing(file_list[1])
1161
 
            if file1 != "" or file2 != "":
1162
 
                # FIXME diff those two files. rbc 20051123
1163
 
                raise BzrCommandError("Files are in different branches")
1164
 
            file_list = None
1165
 
        except NotBranchError:
1166
 
            if (revision is not None and len(revision) == 2
1167
 
                and not revision[0].needs_branch()
1168
 
                and not revision[1].needs_branch()):
1169
 
                # If both revision specs include a branch, we can
1170
 
                # diff them without needing a local working tree
1171
 
                tree1, tree2 = None, None
1172
 
            else:
1173
 
                raise
1174
 
        if revision is not None:
1175
 
            if tree2 is not None:
1176
 
                raise BzrCommandError("Can't specify -r with two branches")
1177
 
            if (len(revision) == 1) or (revision[1].spec is None):
1178
 
                return diff_cmd_helper(tree1, file_list, diff_options,
1179
 
                                       revision[0], 
1180
 
                                       old_label=old_label, new_label=new_label)
1181
 
            elif len(revision) == 2:
1182
 
                return diff_cmd_helper(tree1, file_list, diff_options,
1183
 
                                       revision[0], revision[1],
1184
 
                                       old_label=old_label, new_label=new_label)
1185
 
            else:
1186
 
                raise BzrCommandError('bzr diff --revision takes exactly one or two revision identifiers')
1187
1901
        else:
1188
 
            if tree2 is not None:
1189
 
                return show_diff_trees(tree1, tree2, sys.stdout, 
1190
 
                                       specific_files=file_list,
1191
 
                                       external_diff_options=diff_options,
1192
 
                                       old_label=old_label, new_label=new_label)
1193
 
            else:
1194
 
                return diff_cmd_helper(tree1, file_list, diff_options,
1195
 
                                       old_label=old_label, new_label=new_label)
 
1902
            raise errors.BzrCommandError(
 
1903
                '--prefix expects two values separated by a colon'
 
1904
                ' (eg "old/:new/")')
 
1905
 
 
1906
        if revision and len(revision) > 2:
 
1907
            raise errors.BzrCommandError('bzr diff --revision takes exactly'
 
1908
                                         ' one or two revision specifiers')
 
1909
 
 
1910
        old_tree, new_tree, specific_files, extra_trees = \
 
1911
                _get_trees_to_diff(file_list, revision, old, new,
 
1912
                apply_view=True)
 
1913
        return show_diff_trees(old_tree, new_tree, sys.stdout,
 
1914
                               specific_files=specific_files,
 
1915
                               external_diff_options=diff_options,
 
1916
                               old_label=old_label, new_label=new_label,
 
1917
                               extra_trees=extra_trees, using=using)
1196
1918
 
1197
1919
 
1198
1920
class cmd_deleted(Command):
1204
1926
    # directories with readdir, rather than stating each one.  Same
1205
1927
    # level of effort but possibly much less IO.  (Or possibly not,
1206
1928
    # if the directories are very large...)
 
1929
    _see_also = ['status', 'ls']
1207
1930
    takes_options = ['show-ids']
1208
1931
 
1209
1932
    @display_command
1210
1933
    def run(self, show_ids=False):
1211
1934
        tree = WorkingTree.open_containing(u'.')[0]
1212
 
        old = tree.basis_tree()
1213
 
        for path, ie in old.inventory.iter_entries():
1214
 
            if not tree.has_id(ie.file_id):
1215
 
                self.outf.write(path)
1216
 
                if show_ids:
1217
 
                    self.outf.write(' ')
1218
 
                    self.outf.write(ie.file_id)
1219
 
                self.outf.write('\n')
 
1935
        tree.lock_read()
 
1936
        try:
 
1937
            old = tree.basis_tree()
 
1938
            old.lock_read()
 
1939
            try:
 
1940
                for path, ie in old.inventory.iter_entries():
 
1941
                    if not tree.has_id(ie.file_id):
 
1942
                        self.outf.write(path)
 
1943
                        if show_ids:
 
1944
                            self.outf.write(' ')
 
1945
                            self.outf.write(ie.file_id)
 
1946
                        self.outf.write('\n')
 
1947
            finally:
 
1948
                old.unlock()
 
1949
        finally:
 
1950
            tree.unlock()
1220
1951
 
1221
1952
 
1222
1953
class cmd_modified(Command):
1223
 
    """List files modified in working tree."""
 
1954
    """List files modified in working tree.
 
1955
    """
 
1956
 
1224
1957
    hidden = True
 
1958
    _see_also = ['status', 'ls']
 
1959
    takes_options = [
 
1960
            Option('null',
 
1961
                   help='Write an ascii NUL (\\0) separator '
 
1962
                   'between files rather than a newline.')
 
1963
            ]
 
1964
 
1225
1965
    @display_command
1226
 
    def run(self):
 
1966
    def run(self, null=False):
1227
1967
        tree = WorkingTree.open_containing(u'.')[0]
1228
1968
        td = tree.changes_from(tree.basis_tree())
1229
1969
        for path, id, kind, text_modified, meta_modified in td.modified:
1230
 
            self.outf.write(path + '\n')
 
1970
            if null:
 
1971
                self.outf.write(path + '\0')
 
1972
            else:
 
1973
                self.outf.write(osutils.quotefn(path) + '\n')
1231
1974
 
1232
1975
 
1233
1976
class cmd_added(Command):
1234
 
    """List files added in working tree."""
 
1977
    """List files added in working tree.
 
1978
    """
 
1979
 
1235
1980
    hidden = True
 
1981
    _see_also = ['status', 'ls']
 
1982
    takes_options = [
 
1983
            Option('null',
 
1984
                   help='Write an ascii NUL (\\0) separator '
 
1985
                   'between files rather than a newline.')
 
1986
            ]
 
1987
 
1236
1988
    @display_command
1237
 
    def run(self):
 
1989
    def run(self, null=False):
1238
1990
        wt = WorkingTree.open_containing(u'.')[0]
1239
 
        basis_inv = wt.basis_tree().inventory
1240
 
        inv = wt.inventory
1241
 
        for file_id in inv:
1242
 
            if file_id in basis_inv:
1243
 
                continue
1244
 
            path = inv.id2path(file_id)
1245
 
            if not os.access(osutils.abspath(path), os.F_OK):
1246
 
                continue
1247
 
            self.outf.write(path + '\n')
 
1991
        wt.lock_read()
 
1992
        try:
 
1993
            basis = wt.basis_tree()
 
1994
            basis.lock_read()
 
1995
            try:
 
1996
                basis_inv = basis.inventory
 
1997
                inv = wt.inventory
 
1998
                for file_id in inv:
 
1999
                    if file_id in basis_inv:
 
2000
                        continue
 
2001
                    if inv.is_root(file_id) and len(basis_inv) == 0:
 
2002
                        continue
 
2003
                    path = inv.id2path(file_id)
 
2004
                    if not os.access(osutils.abspath(path), os.F_OK):
 
2005
                        continue
 
2006
                    if null:
 
2007
                        self.outf.write(path + '\0')
 
2008
                    else:
 
2009
                        self.outf.write(osutils.quotefn(path) + '\n')
 
2010
            finally:
 
2011
                basis.unlock()
 
2012
        finally:
 
2013
            wt.unlock()
1248
2014
 
1249
2015
 
1250
2016
class cmd_root(Command):
1252
2018
 
1253
2019
    The root is the nearest enclosing directory with a .bzr control
1254
2020
    directory."""
 
2021
 
1255
2022
    takes_args = ['filename?']
1256
2023
    @display_command
1257
2024
    def run(self, filename=None):
1260
2027
        self.outf.write(tree.basedir + '\n')
1261
2028
 
1262
2029
 
 
2030
def _parse_limit(limitstring):
 
2031
    try:
 
2032
        return int(limitstring)
 
2033
    except ValueError:
 
2034
        msg = "The limit argument must be an integer."
 
2035
        raise errors.BzrCommandError(msg)
 
2036
 
 
2037
 
 
2038
def _parse_levels(s):
 
2039
    try:
 
2040
        return int(s)
 
2041
    except ValueError:
 
2042
        msg = "The levels argument must be an integer."
 
2043
        raise errors.BzrCommandError(msg)
 
2044
 
 
2045
 
1263
2046
class cmd_log(Command):
1264
 
    """Show log of a branch, file, or directory.
1265
 
 
1266
 
    By default show the log of the branch containing the working directory.
1267
 
 
1268
 
    To request a range of logs, you can use the command -r begin..end
1269
 
    -r revision requests a specific revision, -r ..end or -r begin.. are
1270
 
    also valid.
1271
 
 
1272
 
    examples:
1273
 
        bzr log
1274
 
        bzr log foo.c
1275
 
        bzr log -r -10.. http://server/branch
 
2047
    """Show historical log for a branch or subset of a branch.
 
2048
 
 
2049
    log is bzr's default tool for exploring the history of a branch.
 
2050
    The branch to use is taken from the first parameter. If no parameters
 
2051
    are given, the branch containing the working directory is logged.
 
2052
    Here are some simple examples::
 
2053
 
 
2054
      bzr log                       log the current branch
 
2055
      bzr log foo.py                log a file in its branch
 
2056
      bzr log http://server/branch  log a branch on a server
 
2057
 
 
2058
    The filtering, ordering and information shown for each revision can
 
2059
    be controlled as explained below. By default, all revisions are
 
2060
    shown sorted (topologically) so that newer revisions appear before
 
2061
    older ones and descendants always appear before ancestors. If displayed,
 
2062
    merged revisions are shown indented under the revision in which they
 
2063
    were merged.
 
2064
 
 
2065
    :Output control:
 
2066
 
 
2067
      The log format controls how information about each revision is
 
2068
      displayed. The standard log formats are called ``long``, ``short``
 
2069
      and ``line``. The default is long. See ``bzr help log-formats``
 
2070
      for more details on log formats.
 
2071
 
 
2072
      The following options can be used to control what information is
 
2073
      displayed::
 
2074
 
 
2075
        -l N        display a maximum of N revisions
 
2076
        -n N        display N levels of revisions (0 for all, 1 for collapsed)
 
2077
        -v          display a status summary (delta) for each revision
 
2078
        -p          display a diff (patch) for each revision
 
2079
        --show-ids  display revision-ids (and file-ids), not just revnos
 
2080
 
 
2081
      Note that the default number of levels to display is a function of the
 
2082
      log format. If the -n option is not used, the standard log formats show
 
2083
      just the top level (mainline).
 
2084
 
 
2085
      Status summaries are shown using status flags like A, M, etc. To see
 
2086
      the changes explained using words like ``added`` and ``modified``
 
2087
      instead, use the -vv option.
 
2088
 
 
2089
    :Ordering control:
 
2090
 
 
2091
      To display revisions from oldest to newest, use the --forward option.
 
2092
      In most cases, using this option will have little impact on the total
 
2093
      time taken to produce a log, though --forward does not incrementally
 
2094
      display revisions like --reverse does when it can.
 
2095
 
 
2096
    :Revision filtering:
 
2097
 
 
2098
      The -r option can be used to specify what revision or range of revisions
 
2099
      to filter against. The various forms are shown below::
 
2100
 
 
2101
        -rX      display revision X
 
2102
        -rX..    display revision X and later
 
2103
        -r..Y    display up to and including revision Y
 
2104
        -rX..Y   display from X to Y inclusive
 
2105
 
 
2106
      See ``bzr help revisionspec`` for details on how to specify X and Y.
 
2107
      Some common examples are given below::
 
2108
 
 
2109
        -r-1                show just the tip
 
2110
        -r-10..             show the last 10 mainline revisions
 
2111
        -rsubmit:..         show what's new on this branch
 
2112
        -rancestor:path..   show changes since the common ancestor of this
 
2113
                            branch and the one at location path
 
2114
        -rdate:yesterday..  show changes since yesterday
 
2115
 
 
2116
      When logging a range of revisions using -rX..Y, log starts at
 
2117
      revision Y and searches back in history through the primary
 
2118
      ("left-hand") parents until it finds X. When logging just the
 
2119
      top level (using -n1), an error is reported if X is not found
 
2120
      along the way. If multi-level logging is used (-n0), X may be
 
2121
      a nested merge revision and the log will be truncated accordingly.
 
2122
 
 
2123
    :Path filtering:
 
2124
 
 
2125
      If parameters are given and the first one is not a branch, the log
 
2126
      will be filtered to show only those revisions that changed the
 
2127
      nominated files or directories.
 
2128
 
 
2129
      Filenames are interpreted within their historical context. To log a
 
2130
      deleted file, specify a revision range so that the file existed at
 
2131
      the end or start of the range.
 
2132
 
 
2133
      Historical context is also important when interpreting pathnames of
 
2134
      renamed files/directories. Consider the following example:
 
2135
 
 
2136
      * revision 1: add tutorial.txt
 
2137
      * revision 2: modify tutorial.txt
 
2138
      * revision 3: rename tutorial.txt to guide.txt; add tutorial.txt
 
2139
 
 
2140
      In this case:
 
2141
 
 
2142
      * ``bzr log guide.txt`` will log the file added in revision 1
 
2143
 
 
2144
      * ``bzr log tutorial.txt`` will log the new file added in revision 3
 
2145
 
 
2146
      * ``bzr log -r2 -p tutorial.txt`` will show the changes made to
 
2147
        the original file in revision 2.
 
2148
 
 
2149
      * ``bzr log -r2 -p guide.txt`` will display an error message as there
 
2150
        was no file called guide.txt in revision 2.
 
2151
 
 
2152
      Renames are always followed by log. By design, there is no need to
 
2153
      explicitly ask for this (and no way to stop logging a file back
 
2154
      until it was last renamed).
 
2155
 
 
2156
    :Other filtering:
 
2157
 
 
2158
      The --message option can be used for finding revisions that match a
 
2159
      regular expression in a commit message.
 
2160
 
 
2161
    :Tips & tricks:
 
2162
 
 
2163
      GUI tools and IDEs are often better at exploring history than command
 
2164
      line tools. You may prefer qlog or glog from the QBzr and Bzr-Gtk packages
 
2165
      respectively for example. (TortoiseBzr uses qlog for displaying logs.) See
 
2166
      http://bazaar-vcs.org/BzrPlugins and http://bazaar-vcs.org/IDEIntegration.
 
2167
 
 
2168
      Web interfaces are often better at exploring history than command line
 
2169
      tools, particularly for branches on servers. You may prefer Loggerhead
 
2170
      or one of its alternatives. See http://bazaar-vcs.org/WebInterface.
 
2171
 
 
2172
      You may find it useful to add the aliases below to ``bazaar.conf``::
 
2173
 
 
2174
        [ALIASES]
 
2175
        tip = log -r-1
 
2176
        top = log -l10 --line
 
2177
        show = log -v -p
 
2178
 
 
2179
      ``bzr tip`` will then show the latest revision while ``bzr top``
 
2180
      will show the last 10 mainline revisions. To see the details of a
 
2181
      particular revision X,  ``bzr show -rX``.
 
2182
 
 
2183
      If you are interested in looking deeper into a particular merge X,
 
2184
      use ``bzr log -n0 -rX``.
 
2185
 
 
2186
      ``bzr log -v`` on a branch with lots of history is currently
 
2187
      very slow. A fix for this issue is currently under development.
 
2188
      With or without that fix, it is recommended that a revision range
 
2189
      be given when using the -v option.
 
2190
 
 
2191
      bzr has a generic full-text matching plugin, bzr-search, that can be
 
2192
      used to find revisions matching user names, commit messages, etc.
 
2193
      Among other features, this plugin can find all revisions containing
 
2194
      a list of words but not others.
 
2195
 
 
2196
      When exploring non-mainline history on large projects with deep
 
2197
      history, the performance of log can be greatly improved by installing
 
2198
      the historycache plugin. This plugin buffers historical information
 
2199
      trading disk space for faster speed.
1276
2200
    """
1277
 
 
1278
 
    # TODO: Make --revision support uuid: and hash: [future tag:] notation.
1279
 
 
1280
 
    takes_args = ['location?']
1281
 
    takes_options = [Option('forward', 
1282
 
                            help='show from oldest to newest'),
1283
 
                     'timezone', 
1284
 
                     Option('verbose', 
1285
 
                             help='show files changed in each revision'),
1286
 
                     'show-ids', 'revision',
1287
 
                     'log-format',
1288
 
                     'line', 'long', 
1289
 
                     Option('message',
1290
 
                            help='show revisions whose message matches this regexp',
1291
 
                            type=str),
1292
 
                     'short',
1293
 
                     ]
 
2201
    takes_args = ['file*']
 
2202
    _see_also = ['log-formats', 'revisionspec']
 
2203
    takes_options = [
 
2204
            Option('forward',
 
2205
                   help='Show from oldest to newest.'),
 
2206
            'timezone',
 
2207
            custom_help('verbose',
 
2208
                   help='Show files changed in each revision.'),
 
2209
            'show-ids',
 
2210
            'revision',
 
2211
            Option('change',
 
2212
                   type=bzrlib.option._parse_revision_str,
 
2213
                   short_name='c',
 
2214
                   help='Show just the specified revision.'
 
2215
                   ' See also "help revisionspec".'),
 
2216
            'log-format',
 
2217
            Option('levels',
 
2218
                   short_name='n',
 
2219
                   help='Number of levels to display - 0 for all, 1 for flat.',
 
2220
                   argname='N',
 
2221
                   type=_parse_levels),
 
2222
            Option('message',
 
2223
                   short_name='m',
 
2224
                   help='Show revisions whose message matches this '
 
2225
                        'regular expression.',
 
2226
                   type=str),
 
2227
            Option('limit',
 
2228
                   short_name='l',
 
2229
                   help='Limit the output to the first N revisions.',
 
2230
                   argname='N',
 
2231
                   type=_parse_limit),
 
2232
            Option('show-diff',
 
2233
                   short_name='p',
 
2234
                   help='Show changes made in each revision as a patch.'),
 
2235
            Option('include-merges',
 
2236
                   help='Show merged revisions like --levels 0 does.'),
 
2237
            ]
1294
2238
    encoding_type = 'replace'
1295
2239
 
1296
2240
    @display_command
1297
 
    def run(self, location=None, timezone='original',
 
2241
    def run(self, file_list=None, timezone='original',
1298
2242
            verbose=False,
1299
2243
            show_ids=False,
1300
2244
            forward=False,
1301
2245
            revision=None,
 
2246
            change=None,
1302
2247
            log_format=None,
 
2248
            levels=None,
1303
2249
            message=None,
1304
 
            long=False,
1305
 
            short=False,
1306
 
            line=False):
1307
 
        from bzrlib.log import log_formatter, show_log
1308
 
        assert message is None or isinstance(message, basestring), \
1309
 
            "invalid message argument %r" % message
 
2250
            limit=None,
 
2251
            show_diff=False,
 
2252
            include_merges=False):
 
2253
        from bzrlib.log import (
 
2254
            Logger,
 
2255
            make_log_request_dict,
 
2256
            _get_info_for_log_files,
 
2257
            )
1310
2258
        direction = (forward and 'forward') or 'reverse'
1311
 
        
1312
 
        # log everything
1313
 
        file_id = None
1314
 
        if location:
1315
 
            # find the file id to log:
1316
 
 
1317
 
            dir, fp = bzrdir.BzrDir.open_containing(location)
1318
 
            b = dir.open_branch()
1319
 
            if fp != '':
1320
 
                try:
1321
 
                    # might be a tree:
1322
 
                    inv = dir.open_workingtree().inventory
1323
 
                except (errors.NotBranchError, errors.NotLocalUrl):
1324
 
                    # either no tree, or is remote.
1325
 
                    inv = b.basis_tree().inventory
1326
 
                file_id = inv.path2id(fp)
1327
 
        else:
1328
 
            # local dir only
1329
 
            # FIXME ? log the current subdir only RBC 20060203 
1330
 
            dir, relpath = bzrdir.BzrDir.open_containing('.')
1331
 
            b = dir.open_branch()
1332
 
 
1333
 
        if revision is None:
1334
 
            rev1 = None
1335
 
            rev2 = None
1336
 
        elif len(revision) == 1:
1337
 
            rev1 = rev2 = revision[0].in_history(b).revno
1338
 
        elif len(revision) == 2:
1339
 
            if revision[0].spec is None:
1340
 
                # missing begin-range means first revision
1341
 
                rev1 = 1
1342
 
            else:
1343
 
                rev1 = revision[0].in_history(b).revno
1344
 
 
1345
 
            if revision[1].spec is None:
1346
 
                # missing end-range means last known revision
1347
 
                rev2 = b.revno()
1348
 
            else:
1349
 
                rev2 = revision[1].in_history(b).revno
1350
 
        else:
1351
 
            raise BzrCommandError('bzr log --revision takes one or two values.')
1352
 
 
1353
 
        # By this point, the revision numbers are converted to the +ve
1354
 
        # form if they were supplied in the -ve form, so we can do
1355
 
        # this comparison in relative safety
1356
 
        if rev1 > rev2:
1357
 
            (rev2, rev1) = (rev1, rev2)
1358
 
 
1359
 
        if (log_format == None):
1360
 
            default = b.get_config().log_format()
1361
 
            log_format = get_log_format(long=long, short=short, line=line, 
1362
 
                                        default=default)
1363
 
        lf = log_formatter(log_format,
1364
 
                           show_ids=show_ids,
1365
 
                           to_file=self.outf,
1366
 
                           show_timezone=timezone)
1367
 
 
1368
 
        show_log(b,
1369
 
                 lf,
1370
 
                 file_id,
1371
 
                 verbose=verbose,
1372
 
                 direction=direction,
1373
 
                 start_revision=rev1,
1374
 
                 end_revision=rev2,
1375
 
                 search=message)
1376
 
 
 
2259
        if include_merges:
 
2260
            if levels is None:
 
2261
                levels = 0
 
2262
            else:
 
2263
                raise errors.BzrCommandError(
 
2264
                    '--levels and --include-merges are mutually exclusive')
 
2265
 
 
2266
        if change is not None:
 
2267
            if len(change) > 1:
 
2268
                raise errors.RangeInChangeOption()
 
2269
            if revision is not None:
 
2270
                raise errors.BzrCommandError(
 
2271
                    '--revision and --change are mutually exclusive')
 
2272
            else:
 
2273
                revision = change
 
2274
 
 
2275
        file_ids = []
 
2276
        filter_by_dir = False
 
2277
        if file_list:
 
2278
            # find the file ids to log and check for directory filtering
 
2279
            b, file_info_list, rev1, rev2 = _get_info_for_log_files(revision,
 
2280
                file_list)
 
2281
            for relpath, file_id, kind in file_info_list:
 
2282
                if file_id is None:
 
2283
                    raise errors.BzrCommandError(
 
2284
                        "Path unknown at end or start of revision range: %s" %
 
2285
                        relpath)
 
2286
                # If the relpath is the top of the tree, we log everything
 
2287
                if relpath == '':
 
2288
                    file_ids = []
 
2289
                    break
 
2290
                else:
 
2291
                    file_ids.append(file_id)
 
2292
                filter_by_dir = filter_by_dir or (
 
2293
                    kind in ['directory', 'tree-reference'])
 
2294
        else:
 
2295
            # log everything
 
2296
            # FIXME ? log the current subdir only RBC 20060203
 
2297
            if revision is not None \
 
2298
                    and len(revision) > 0 and revision[0].get_branch():
 
2299
                location = revision[0].get_branch()
 
2300
            else:
 
2301
                location = '.'
 
2302
            dir, relpath = bzrdir.BzrDir.open_containing(location)
 
2303
            b = dir.open_branch()
 
2304
            rev1, rev2 = _get_revision_range(revision, b, self.name())
 
2305
 
 
2306
        # Decide on the type of delta & diff filtering to use
 
2307
        # TODO: add an --all-files option to make this configurable & consistent
 
2308
        if not verbose:
 
2309
            delta_type = None
 
2310
        else:
 
2311
            delta_type = 'full'
 
2312
        if not show_diff:
 
2313
            diff_type = None
 
2314
        elif file_ids:
 
2315
            diff_type = 'partial'
 
2316
        else:
 
2317
            diff_type = 'full'
 
2318
 
 
2319
        b.lock_read()
 
2320
        try:
 
2321
            # Build the log formatter
 
2322
            if log_format is None:
 
2323
                log_format = log.log_formatter_registry.get_default(b)
 
2324
            lf = log_format(show_ids=show_ids, to_file=self.outf,
 
2325
                            show_timezone=timezone,
 
2326
                            delta_format=get_verbosity_level(),
 
2327
                            levels=levels,
 
2328
                            show_advice=levels is None)
 
2329
 
 
2330
            # Choose the algorithm for doing the logging. It's annoying
 
2331
            # having multiple code paths like this but necessary until
 
2332
            # the underlying repository format is faster at generating
 
2333
            # deltas or can provide everything we need from the indices.
 
2334
            # The default algorithm - match-using-deltas - works for
 
2335
            # multiple files and directories and is faster for small
 
2336
            # amounts of history (200 revisions say). However, it's too
 
2337
            # slow for logging a single file in a repository with deep
 
2338
            # history, i.e. > 10K revisions. In the spirit of "do no
 
2339
            # evil when adding features", we continue to use the
 
2340
            # original algorithm - per-file-graph - for the "single
 
2341
            # file that isn't a directory without showing a delta" case.
 
2342
            partial_history = revision and b.repository._format.supports_chks
 
2343
            match_using_deltas = (len(file_ids) != 1 or filter_by_dir
 
2344
                or delta_type or partial_history)
 
2345
 
 
2346
            # Build the LogRequest and execute it
 
2347
            if len(file_ids) == 0:
 
2348
                file_ids = None
 
2349
            rqst = make_log_request_dict(
 
2350
                direction=direction, specific_fileids=file_ids,
 
2351
                start_revision=rev1, end_revision=rev2, limit=limit,
 
2352
                message_search=message, delta_type=delta_type,
 
2353
                diff_type=diff_type, _match_using_deltas=match_using_deltas)
 
2354
            Logger(b, rqst).show(lf)
 
2355
        finally:
 
2356
            b.unlock()
 
2357
 
 
2358
 
 
2359
def _get_revision_range(revisionspec_list, branch, command_name):
 
2360
    """Take the input of a revision option and turn it into a revision range.
 
2361
 
 
2362
    It returns RevisionInfo objects which can be used to obtain the rev_id's
 
2363
    of the desired revisions. It does some user input validations.
 
2364
    """
 
2365
    if revisionspec_list is None:
 
2366
        rev1 = None
 
2367
        rev2 = None
 
2368
    elif len(revisionspec_list) == 1:
 
2369
        rev1 = rev2 = revisionspec_list[0].in_history(branch)
 
2370
    elif len(revisionspec_list) == 2:
 
2371
        start_spec = revisionspec_list[0]
 
2372
        end_spec = revisionspec_list[1]
 
2373
        if end_spec.get_branch() != start_spec.get_branch():
 
2374
            # b is taken from revision[0].get_branch(), and
 
2375
            # show_log will use its revision_history. Having
 
2376
            # different branches will lead to weird behaviors.
 
2377
            raise errors.BzrCommandError(
 
2378
                "bzr %s doesn't accept two revisions in different"
 
2379
                " branches." % command_name)
 
2380
        rev1 = start_spec.in_history(branch)
 
2381
        # Avoid loading all of history when we know a missing
 
2382
        # end of range means the last revision ...
 
2383
        if end_spec.spec is None:
 
2384
            last_revno, last_revision_id = branch.last_revision_info()
 
2385
            rev2 = RevisionInfo(branch, last_revno, last_revision_id)
 
2386
        else:
 
2387
            rev2 = end_spec.in_history(branch)
 
2388
    else:
 
2389
        raise errors.BzrCommandError(
 
2390
            'bzr %s --revision takes one or two values.' % command_name)
 
2391
    return rev1, rev2
 
2392
 
 
2393
 
 
2394
def _revision_range_to_revid_range(revision_range):
 
2395
    rev_id1 = None
 
2396
    rev_id2 = None
 
2397
    if revision_range[0] is not None:
 
2398
        rev_id1 = revision_range[0].rev_id
 
2399
    if revision_range[1] is not None:
 
2400
        rev_id2 = revision_range[1].rev_id
 
2401
    return rev_id1, rev_id2
1377
2402
 
1378
2403
def get_log_format(long=False, short=False, line=False, default='long'):
1379
2404
    log_format = default
1399
2424
    def run(self, filename):
1400
2425
        tree, relpath = WorkingTree.open_containing(filename)
1401
2426
        b = tree.branch
1402
 
        inv = tree.read_working_inventory()
1403
 
        file_id = inv.path2id(relpath)
 
2427
        file_id = tree.path2id(relpath)
1404
2428
        for revno, revision_id, what in log.find_touching_revisions(b, file_id):
1405
2429
            self.outf.write("%6d %s\n" % (revno, what))
1406
2430
 
1408
2432
class cmd_ls(Command):
1409
2433
    """List files in a tree.
1410
2434
    """
1411
 
    # TODO: Take a revision or remote path and list that tree instead.
1412
 
    hidden = True
1413
 
    takes_options = ['verbose', 'revision',
1414
 
                     Option('non-recursive',
1415
 
                            help='don\'t recurse into sub-directories'),
1416
 
                     Option('from-root',
1417
 
                            help='Print all paths from the root of the branch.'),
1418
 
                     Option('unknown', help='Print unknown files'),
1419
 
                     Option('versioned', help='Print versioned files'),
1420
 
                     Option('ignored', help='Print ignored files'),
1421
2435
 
1422
 
                     Option('null', help='Null separate the files'),
1423
 
                    ]
 
2436
    _see_also = ['status', 'cat']
 
2437
    takes_args = ['path?']
 
2438
    takes_options = [
 
2439
            'verbose',
 
2440
            'revision',
 
2441
            Option('recursive', short_name='R',
 
2442
                   help='Recurse into subdirectories.'),
 
2443
            Option('from-root',
 
2444
                   help='Print paths relative to the root of the branch.'),
 
2445
            Option('unknown', help='Print unknown files.'),
 
2446
            Option('versioned', help='Print versioned files.',
 
2447
                   short_name='V'),
 
2448
            Option('ignored', help='Print ignored files.'),
 
2449
            Option('null',
 
2450
                   help='Write an ascii NUL (\\0) separator '
 
2451
                   'between files rather than a newline.'),
 
2452
            Option('kind',
 
2453
                   help='List entries of a particular kind: file, directory, symlink.',
 
2454
                   type=unicode),
 
2455
            'show-ids',
 
2456
            ]
1424
2457
    @display_command
1425
 
    def run(self, revision=None, verbose=False, 
1426
 
            non_recursive=False, from_root=False,
 
2458
    def run(self, revision=None, verbose=False,
 
2459
            recursive=False, from_root=False,
1427
2460
            unknown=False, versioned=False, ignored=False,
1428
 
            null=False):
 
2461
            null=False, kind=None, show_ids=False, path=None):
 
2462
 
 
2463
        if kind and kind not in ('file', 'directory', 'symlink'):
 
2464
            raise errors.BzrCommandError('invalid kind specified')
1429
2465
 
1430
2466
        if verbose and null:
1431
 
            raise BzrCommandError('Cannot set both --verbose and --null')
 
2467
            raise errors.BzrCommandError('Cannot set both --verbose and --null')
1432
2468
        all = not (unknown or versioned or ignored)
1433
2469
 
1434
2470
        selection = {'I':ignored, '?':unknown, 'V':versioned}
1435
2471
 
1436
 
        tree, relpath = WorkingTree.open_containing(u'.')
 
2472
        if path is None:
 
2473
            fs_path = '.'
 
2474
        else:
 
2475
            if from_root:
 
2476
                raise errors.BzrCommandError('cannot specify both --from-root'
 
2477
                                             ' and PATH')
 
2478
            fs_path = path
 
2479
        tree, branch, relpath = bzrdir.BzrDir.open_containing_tree_or_branch(
 
2480
            fs_path)
 
2481
 
 
2482
        # Calculate the prefix to use
 
2483
        prefix = None
1437
2484
        if from_root:
1438
 
            relpath = u''
1439
 
        elif relpath:
1440
 
            relpath += '/'
1441
 
        if revision is not None:
1442
 
            tree = tree.branch.repository.revision_tree(
1443
 
                revision[0].in_history(tree.branch).rev_id)
1444
 
 
1445
 
        for fp, fc, kind, fid, entry in tree.list_files():
1446
 
            if fp.startswith(relpath):
1447
 
                fp = fp[len(relpath):]
1448
 
                if non_recursive and '/' in fp:
1449
 
                    continue
 
2485
            if relpath:
 
2486
                prefix = relpath + '/'
 
2487
        elif fs_path != '.':
 
2488
            prefix = fs_path + '/'
 
2489
 
 
2490
        if revision is not None or tree is None:
 
2491
            tree = _get_one_revision_tree('ls', revision, branch=branch)
 
2492
 
 
2493
        apply_view = False
 
2494
        if isinstance(tree, WorkingTree) and tree.supports_views():
 
2495
            view_files = tree.views.lookup_view()
 
2496
            if view_files:
 
2497
                apply_view = True
 
2498
                view_str = views.view_display_str(view_files)
 
2499
                note("Ignoring files outside view. View is %s" % view_str)
 
2500
 
 
2501
        tree.lock_read()
 
2502
        try:
 
2503
            for fp, fc, fkind, fid, entry in tree.list_files(include_root=False,
 
2504
                from_dir=relpath, recursive=recursive):
 
2505
                # Apply additional masking
1450
2506
                if not all and not selection[fc]:
1451
2507
                    continue
 
2508
                if kind is not None and fkind != kind:
 
2509
                    continue
 
2510
                if apply_view:
 
2511
                    try:
 
2512
                        if relpath:
 
2513
                            fullpath = osutils.pathjoin(relpath, fp)
 
2514
                        else:
 
2515
                            fullpath = fp
 
2516
                        views.check_path_in_view(tree, fullpath)
 
2517
                    except errors.FileOutsideView:
 
2518
                        continue
 
2519
 
 
2520
                # Output the entry
 
2521
                if prefix:
 
2522
                    fp = osutils.pathjoin(prefix, fp)
 
2523
                kindch = entry.kind_character()
 
2524
                outstring = fp + kindch
 
2525
                ui.ui_factory.clear_term()
1452
2526
                if verbose:
1453
 
                    kindch = entry.kind_character()
1454
 
                    self.outf.write('%-8s %s%s\n' % (fc, fp, kindch))
 
2527
                    outstring = '%-8s %s' % (fc, outstring)
 
2528
                    if show_ids and fid is not None:
 
2529
                        outstring = "%-50s %s" % (outstring, fid)
 
2530
                    self.outf.write(outstring + '\n')
1455
2531
                elif null:
1456
2532
                    self.outf.write(fp + '\0')
 
2533
                    if show_ids:
 
2534
                        if fid is not None:
 
2535
                            self.outf.write(fid)
 
2536
                        self.outf.write('\0')
1457
2537
                    self.outf.flush()
1458
2538
                else:
1459
 
                    self.outf.write(fp + '\n')
 
2539
                    if show_ids:
 
2540
                        if fid is not None:
 
2541
                            my_id = fid
 
2542
                        else:
 
2543
                            my_id = ''
 
2544
                        self.outf.write('%-50s %s\n' % (outstring, my_id))
 
2545
                    else:
 
2546
                        self.outf.write(outstring + '\n')
 
2547
        finally:
 
2548
            tree.unlock()
1460
2549
 
1461
2550
 
1462
2551
class cmd_unknowns(Command):
1463
 
    """List unknown files."""
 
2552
    """List unknown files.
 
2553
    """
 
2554
 
 
2555
    hidden = True
 
2556
    _see_also = ['ls']
 
2557
 
1464
2558
    @display_command
1465
2559
    def run(self):
1466
2560
        for f in WorkingTree.open_containing(u'.')[0].unknowns():
1468
2562
 
1469
2563
 
1470
2564
class cmd_ignore(Command):
1471
 
    """Ignore a command or pattern.
 
2565
    """Ignore specified files or patterns.
 
2566
 
 
2567
    See ``bzr help patterns`` for details on the syntax of patterns.
1472
2568
 
1473
2569
    To remove patterns from the ignore list, edit the .bzrignore file.
1474
 
 
1475
 
    If the pattern contains a slash, it is compared to the whole path
1476
 
    from the branch root.  Otherwise, it is compared to only the last
1477
 
    component of the path.  To match a file only in the root directory,
1478
 
    prepend './'.
1479
 
 
1480
 
    Ignore patterns are case-insensitive on case-insensitive systems.
1481
 
 
1482
 
    Note: wildcards must be quoted from the shell on Unix.
1483
 
 
1484
 
    examples:
1485
 
        bzr ignore ./Makefile
1486
 
        bzr ignore '*.class'
 
2570
    After adding, editing or deleting that file either indirectly by
 
2571
    using this command or directly by using an editor, be sure to commit
 
2572
    it.
 
2573
 
 
2574
    Note: ignore patterns containing shell wildcards must be quoted from
 
2575
    the shell on Unix.
 
2576
 
 
2577
    :Examples:
 
2578
        Ignore the top level Makefile::
 
2579
 
 
2580
            bzr ignore ./Makefile
 
2581
 
 
2582
        Ignore class files in all directories::
 
2583
 
 
2584
            bzr ignore "*.class"
 
2585
 
 
2586
        Ignore .o files under the lib directory::
 
2587
 
 
2588
            bzr ignore "lib/**/*.o"
 
2589
 
 
2590
        Ignore .o files under the lib directory::
 
2591
 
 
2592
            bzr ignore "RE:lib/.*\.o"
 
2593
 
 
2594
        Ignore everything but the "debian" toplevel directory::
 
2595
 
 
2596
            bzr ignore "RE:(?!debian/).*"
1487
2597
    """
1488
 
    # TODO: Complain if the filename is absolute
1489
 
    takes_args = ['name_pattern?']
 
2598
 
 
2599
    _see_also = ['status', 'ignored', 'patterns']
 
2600
    takes_args = ['name_pattern*']
1490
2601
    takes_options = [
1491
 
                     Option('old-default-rules',
1492
 
                            help='Out the ignore rules bzr < 0.9 always used.')
1493
 
                     ]
1494
 
    
1495
 
    def run(self, name_pattern=None, old_default_rules=None):
1496
 
        from bzrlib.atomicfile import AtomicFile
 
2602
        Option('old-default-rules',
 
2603
               help='Write out the ignore rules bzr < 0.9 always used.')
 
2604
        ]
 
2605
 
 
2606
    def run(self, name_pattern_list=None, old_default_rules=None):
 
2607
        from bzrlib import ignores
1497
2608
        if old_default_rules is not None:
1498
2609
            # dump the rules and exit
1499
2610
            for pattern in ignores.OLD_DEFAULTS:
1500
2611
                print pattern
1501
2612
            return
1502
 
        if name_pattern is None:
1503
 
            raise BzrCommandError("ignore requires a NAME_PATTERN")
 
2613
        if not name_pattern_list:
 
2614
            raise errors.BzrCommandError("ignore requires at least one "
 
2615
                                  "NAME_PATTERN or --old-default-rules")
 
2616
        name_pattern_list = [globbing.normalize_pattern(p)
 
2617
                             for p in name_pattern_list]
 
2618
        for name_pattern in name_pattern_list:
 
2619
            if (name_pattern[0] == '/' or
 
2620
                (len(name_pattern) > 1 and name_pattern[1] == ':')):
 
2621
                raise errors.BzrCommandError(
 
2622
                    "NAME_PATTERN should not be an absolute path")
1504
2623
        tree, relpath = WorkingTree.open_containing(u'.')
1505
 
        ifn = tree.abspath('.bzrignore')
1506
 
        if os.path.exists(ifn):
1507
 
            f = open(ifn, 'rt')
1508
 
            try:
1509
 
                igns = f.read().decode('utf-8')
1510
 
            finally:
1511
 
                f.close()
1512
 
        else:
1513
 
            igns = ''
1514
 
 
1515
 
        # TODO: If the file already uses crlf-style termination, maybe
1516
 
        # we should use that for the newly added lines?
1517
 
 
1518
 
        if igns and igns[-1] != '\n':
1519
 
            igns += '\n'
1520
 
        igns += name_pattern + '\n'
1521
 
 
1522
 
        f = AtomicFile(ifn, 'wt')
1523
 
        try:
1524
 
            f.write(igns.encode('utf-8'))
1525
 
            f.commit()
1526
 
        finally:
1527
 
            f.close()
1528
 
 
1529
 
        inv = tree.inventory
1530
 
        if inv.path2id('.bzrignore'):
1531
 
            mutter('.bzrignore is already versioned')
1532
 
        else:
1533
 
            mutter('need to make new .bzrignore file versioned')
1534
 
            tree.add(['.bzrignore'])
 
2624
        ignores.tree_ignores_add_patterns(tree, name_pattern_list)
 
2625
        ignored = globbing.Globster(name_pattern_list)
 
2626
        matches = []
 
2627
        tree.lock_read()
 
2628
        for entry in tree.list_files():
 
2629
            id = entry[3]
 
2630
            if id is not None:
 
2631
                filename = entry[0]
 
2632
                if ignored.match(filename):
 
2633
                    matches.append(filename.encode('utf-8'))
 
2634
        tree.unlock()
 
2635
        if len(matches) > 0:
 
2636
            print "Warning: the following files are version controlled and" \
 
2637
                  " match your ignore pattern:\n%s" \
 
2638
                  "\nThese files will continue to be version controlled" \
 
2639
                  " unless you 'bzr remove' them." % ("\n".join(matches),)
1535
2640
 
1536
2641
 
1537
2642
class cmd_ignored(Command):
1538
2643
    """List ignored files and the patterns that matched them.
1539
2644
 
1540
 
    See also: bzr ignore"""
 
2645
    List all the ignored files and the ignore pattern that caused the file to
 
2646
    be ignored.
 
2647
 
 
2648
    Alternatively, to list just the files::
 
2649
 
 
2650
        bzr ls --ignored
 
2651
    """
 
2652
 
 
2653
    encoding_type = 'replace'
 
2654
    _see_also = ['ignore', 'ls']
 
2655
 
1541
2656
    @display_command
1542
2657
    def run(self):
1543
2658
        tree = WorkingTree.open_containing(u'.')[0]
1544
 
        for path, file_class, kind, file_id, entry in tree.list_files():
1545
 
            if file_class != 'I':
1546
 
                continue
1547
 
            ## XXX: Slightly inefficient since this was already calculated
1548
 
            pat = tree.is_ignored(path)
1549
 
            print '%-50s %s' % (path, pat)
 
2659
        tree.lock_read()
 
2660
        try:
 
2661
            for path, file_class, kind, file_id, entry in tree.list_files():
 
2662
                if file_class != 'I':
 
2663
                    continue
 
2664
                ## XXX: Slightly inefficient since this was already calculated
 
2665
                pat = tree.is_ignored(path)
 
2666
                self.outf.write('%-50s %s\n' % (path, pat))
 
2667
        finally:
 
2668
            tree.unlock()
1550
2669
 
1551
2670
 
1552
2671
class cmd_lookup_revision(Command):
1553
2672
    """Lookup the revision-id from a revision-number
1554
2673
 
1555
 
    example:
 
2674
    :Examples:
1556
2675
        bzr lookup-revision 33
1557
2676
    """
1558
2677
    hidden = True
1559
2678
    takes_args = ['revno']
1560
 
    
 
2679
 
1561
2680
    @display_command
1562
2681
    def run(self, revno):
1563
2682
        try:
1564
2683
            revno = int(revno)
1565
2684
        except ValueError:
1566
 
            raise BzrCommandError("not a valid revision-number: %r" % revno)
 
2685
            raise errors.BzrCommandError("not a valid revision-number: %r" % revno)
1567
2686
 
1568
2687
        print WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
1569
2688
 
1570
2689
 
1571
2690
class cmd_export(Command):
1572
 
    """Export past revision to destination directory.
 
2691
    """Export current or past revision to a destination directory or archive.
1573
2692
 
1574
2693
    If no revision is specified this exports the last committed revision.
1575
2694
 
1577
2696
    given, try to find the format with the extension. If no extension
1578
2697
    is found exports to a directory (equivalent to --format=dir).
1579
2698
 
1580
 
    Root may be the top directory for tar, tgz and tbz2 formats. If none
1581
 
    is given, the top directory will be the root name of the file.
1582
 
 
1583
 
    Note: export of tree with non-ascii filenames to zip is not supported.
1584
 
 
1585
 
     Supported formats       Autodetected by extension
1586
 
     -----------------       -------------------------
1587
 
         dir                            -
 
2699
    If root is supplied, it will be used as the root directory inside
 
2700
    container formats (tar, zip, etc). If it is not supplied it will default
 
2701
    to the exported filename. The root option has no effect for 'dir' format.
 
2702
 
 
2703
    If branch is omitted then the branch containing the current working
 
2704
    directory will be used.
 
2705
 
 
2706
    Note: Export of tree with non-ASCII filenames to zip is not supported.
 
2707
 
 
2708
      =================       =========================
 
2709
      Supported formats       Autodetected by extension
 
2710
      =================       =========================
 
2711
         dir                         (none)
1588
2712
         tar                          .tar
1589
2713
         tbz2                    .tar.bz2, .tbz2
1590
2714
         tgz                      .tar.gz, .tgz
1591
2715
         zip                          .zip
 
2716
      =================       =========================
1592
2717
    """
1593
 
    takes_args = ['dest']
1594
 
    takes_options = ['revision', 'format', 'root']
1595
 
    def run(self, dest, revision=None, format=None, root=None):
 
2718
    takes_args = ['dest', 'branch_or_subdir?']
 
2719
    takes_options = [
 
2720
        Option('format',
 
2721
               help="Type of file to export to.",
 
2722
               type=unicode),
 
2723
        'revision',
 
2724
        Option('filters', help='Apply content filters to export the '
 
2725
                'convenient form.'),
 
2726
        Option('root',
 
2727
               type=str,
 
2728
               help="Name of the root directory inside the exported file."),
 
2729
        ]
 
2730
    def run(self, dest, branch_or_subdir=None, revision=None, format=None,
 
2731
        root=None, filters=False):
1596
2732
        from bzrlib.export import export
1597
 
        tree = WorkingTree.open_containing(u'.')[0]
1598
 
        b = tree.branch
1599
 
        if revision is None:
1600
 
            # should be tree.last_revision  FIXME
1601
 
            rev_id = b.last_revision()
 
2733
 
 
2734
        if branch_or_subdir is None:
 
2735
            tree = WorkingTree.open_containing(u'.')[0]
 
2736
            b = tree.branch
 
2737
            subdir = None
1602
2738
        else:
1603
 
            if len(revision) != 1:
1604
 
                raise BzrError('bzr export --revision takes exactly 1 argument')
1605
 
            rev_id = revision[0].in_history(b).rev_id
1606
 
        t = b.repository.revision_tree(rev_id)
 
2739
            b, subdir = Branch.open_containing(branch_or_subdir)
 
2740
            tree = None
 
2741
 
 
2742
        rev_tree = _get_one_revision_tree('export', revision, branch=b, tree=tree)
1607
2743
        try:
1608
 
            export(t, dest, format, root)
 
2744
            export(rev_tree, dest, format, root, subdir, filtered=filters)
1609
2745
        except errors.NoSuchExportFormat, e:
1610
 
            raise BzrCommandError('Unsupported export format: %s' % e.format)
 
2746
            raise errors.BzrCommandError('Unsupported export format: %s' % e.format)
1611
2747
 
1612
2748
 
1613
2749
class cmd_cat(Command):
1614
 
    """Write a file's text from a previous revision."""
1615
 
 
1616
 
    takes_options = ['revision']
 
2750
    """Write the contents of a file as of a given revision to standard output.
 
2751
 
 
2752
    If no revision is nominated, the last revision is used.
 
2753
 
 
2754
    Note: Take care to redirect standard output when using this command on a
 
2755
    binary file.
 
2756
    """
 
2757
 
 
2758
    _see_also = ['ls']
 
2759
    takes_options = [
 
2760
        Option('name-from-revision', help='The path name in the old tree.'),
 
2761
        Option('filters', help='Apply content filters to display the '
 
2762
                'convenience form.'),
 
2763
        'revision',
 
2764
        ]
1617
2765
    takes_args = ['filename']
 
2766
    encoding_type = 'exact'
1618
2767
 
1619
2768
    @display_command
1620
 
    def run(self, filename, revision=None):
 
2769
    def run(self, filename, revision=None, name_from_revision=False,
 
2770
            filters=False):
1621
2771
        if revision is not None and len(revision) != 1:
1622
 
            raise BzrCommandError("bzr cat --revision takes exactly one number")
1623
 
        tree = None
 
2772
            raise errors.BzrCommandError("bzr cat --revision takes exactly"
 
2773
                                         " one revision specifier")
 
2774
        tree, branch, relpath = \
 
2775
            bzrdir.BzrDir.open_containing_tree_or_branch(filename)
 
2776
        branch.lock_read()
1624
2777
        try:
1625
 
            tree, relpath = WorkingTree.open_containing(filename)
1626
 
            b = tree.branch
1627
 
        except NotBranchError:
1628
 
            pass
 
2778
            return self._run(tree, branch, relpath, filename, revision,
 
2779
                             name_from_revision, filters)
 
2780
        finally:
 
2781
            branch.unlock()
1629
2782
 
 
2783
    def _run(self, tree, b, relpath, filename, revision, name_from_revision,
 
2784
        filtered):
1630
2785
        if tree is None:
1631
 
            b, relpath = Branch.open_containing(filename)
1632
 
        if revision is None:
1633
 
            revision_id = b.last_revision()
1634
 
        else:
1635
 
            revision_id = revision[0].in_history(b).rev_id
1636
 
        b.print_file(relpath, revision_id)
 
2786
            tree = b.basis_tree()
 
2787
        rev_tree = _get_one_revision_tree('cat', revision, branch=b)
 
2788
 
 
2789
        old_file_id = rev_tree.path2id(relpath)
 
2790
 
 
2791
        if name_from_revision:
 
2792
            # Try in revision if requested
 
2793
            if old_file_id is None:
 
2794
                raise errors.BzrCommandError(
 
2795
                    "%r is not present in revision %s" % (
 
2796
                        filename, rev_tree.get_revision_id()))
 
2797
            else:
 
2798
                content = rev_tree.get_file_text(old_file_id)
 
2799
        else:
 
2800
            cur_file_id = tree.path2id(relpath)
 
2801
            found = False
 
2802
            if cur_file_id is not None:
 
2803
                # Then try with the actual file id
 
2804
                try:
 
2805
                    content = rev_tree.get_file_text(cur_file_id)
 
2806
                    found = True
 
2807
                except errors.NoSuchId:
 
2808
                    # The actual file id didn't exist at that time
 
2809
                    pass
 
2810
            if not found and old_file_id is not None:
 
2811
                # Finally try with the old file id
 
2812
                content = rev_tree.get_file_text(old_file_id)
 
2813
                found = True
 
2814
            if not found:
 
2815
                # Can't be found anywhere
 
2816
                raise errors.BzrCommandError(
 
2817
                    "%r is not present in revision %s" % (
 
2818
                        filename, rev_tree.get_revision_id()))
 
2819
        if filtered:
 
2820
            from bzrlib.filters import (
 
2821
                ContentFilterContext,
 
2822
                filtered_output_bytes,
 
2823
                )
 
2824
            filters = rev_tree._content_filter_stack(relpath)
 
2825
            chunks = content.splitlines(True)
 
2826
            content = filtered_output_bytes(chunks, filters,
 
2827
                ContentFilterContext(relpath, rev_tree))
 
2828
            self.outf.writelines(content)
 
2829
        else:
 
2830
            self.outf.write(content)
1637
2831
 
1638
2832
 
1639
2833
class cmd_local_time_offset(Command):
1640
2834
    """Show the offset in seconds from GMT to local time."""
1641
 
    hidden = True    
 
2835
    hidden = True
1642
2836
    @display_command
1643
2837
    def run(self):
1644
2838
        print osutils.local_time_offset()
1647
2841
 
1648
2842
class cmd_commit(Command):
1649
2843
    """Commit changes into a new revision.
1650
 
    
1651
 
    If no arguments are given, the entire tree is committed.
1652
 
 
1653
 
    If selected files are specified, only changes to those files are
1654
 
    committed.  If a directory is specified then the directory and everything 
1655
 
    within it is committed.
1656
 
 
1657
 
    A selected-file commit may fail in some cases where the committed
1658
 
    tree would be invalid, such as trying to commit a file in a
1659
 
    newly-added directory that is not itself committed.
 
2844
 
 
2845
    An explanatory message needs to be given for each commit. This is
 
2846
    often done by using the --message option (getting the message from the
 
2847
    command line) or by using the --file option (getting the message from
 
2848
    a file). If neither of these options is given, an editor is opened for
 
2849
    the user to enter the message. To see the changed files in the
 
2850
    boilerplate text loaded into the editor, use the --show-diff option.
 
2851
 
 
2852
    By default, the entire tree is committed and the person doing the
 
2853
    commit is assumed to be the author. These defaults can be overridden
 
2854
    as explained below.
 
2855
 
 
2856
    :Selective commits:
 
2857
 
 
2858
      If selected files are specified, only changes to those files are
 
2859
      committed.  If a directory is specified then the directory and
 
2860
      everything within it is committed.
 
2861
  
 
2862
      When excludes are given, they take precedence over selected files.
 
2863
      For example, to commit only changes within foo, but not changes
 
2864
      within foo/bar::
 
2865
  
 
2866
        bzr commit foo -x foo/bar
 
2867
  
 
2868
      A selective commit after a merge is not yet supported.
 
2869
 
 
2870
    :Custom authors:
 
2871
 
 
2872
      If the author of the change is not the same person as the committer,
 
2873
      you can specify the author's name using the --author option. The
 
2874
      name should be in the same format as a committer-id, e.g.
 
2875
      "John Doe <jdoe@example.com>". If there is more than one author of
 
2876
      the change you can specify the option multiple times, once for each
 
2877
      author.
 
2878
  
 
2879
    :Checks:
 
2880
 
 
2881
      A common mistake is to forget to add a new file or directory before
 
2882
      running the commit command. The --strict option checks for unknown
 
2883
      files and aborts the commit if any are found. More advanced pre-commit
 
2884
      checks can be implemented by defining hooks. See ``bzr help hooks``
 
2885
      for details.
 
2886
 
 
2887
    :Things to note:
 
2888
 
 
2889
      If you accidentially commit the wrong changes or make a spelling
 
2890
      mistake in the commit message say, you can use the uncommit command
 
2891
      to undo it. See ``bzr help uncommit`` for details.
 
2892
 
 
2893
      Hooks can also be configured to run after a commit. This allows you
 
2894
      to trigger updates to external systems like bug trackers. The --fixes
 
2895
      option can be used to record the association between a revision and
 
2896
      one or more bugs. See ``bzr help bugs`` for details.
 
2897
 
 
2898
      A selective commit may fail in some cases where the committed
 
2899
      tree would be invalid. Consider::
 
2900
  
 
2901
        bzr init foo
 
2902
        mkdir foo/bar
 
2903
        bzr add foo/bar
 
2904
        bzr commit foo -m "committing foo"
 
2905
        bzr mv foo/bar foo/baz
 
2906
        mkdir foo/bar
 
2907
        bzr add foo/bar
 
2908
        bzr commit foo/bar -m "committing bar but not baz"
 
2909
  
 
2910
      In the example above, the last commit will fail by design. This gives
 
2911
      the user the opportunity to decide whether they want to commit the
 
2912
      rename at the same time, separately first, or not at all. (As a general
 
2913
      rule, when in doubt, Bazaar has a policy of Doing the Safe Thing.)
1660
2914
    """
1661
2915
    # TODO: Run hooks on tree to-be-committed, and after commit.
1662
2916
 
1667
2921
 
1668
2922
    # XXX: verbose currently does nothing
1669
2923
 
 
2924
    _see_also = ['add', 'bugs', 'hooks', 'uncommit']
1670
2925
    takes_args = ['selected*']
1671
 
    takes_options = ['message', 'verbose', 
1672
 
                     Option('unchanged',
1673
 
                            help='commit even if nothing has changed'),
1674
 
                     Option('file', type=str, 
1675
 
                            argname='msgfile',
1676
 
                            help='file containing commit message'),
1677
 
                     Option('strict',
1678
 
                            help="refuse to commit if there are unknown "
1679
 
                            "files in the working tree."),
1680
 
                     Option('local',
1681
 
                            help="perform a local only commit in a bound "
1682
 
                                 "branch. Such commits are not pushed to "
1683
 
                                 "the master branch until a normal commit "
1684
 
                                 "is performed."
1685
 
                            ),
1686
 
                     ]
 
2926
    takes_options = [
 
2927
            ListOption('exclude', type=str, short_name='x',
 
2928
                help="Do not consider changes made to a given path."),
 
2929
            Option('message', type=unicode,
 
2930
                   short_name='m',
 
2931
                   help="Description of the new revision."),
 
2932
            'verbose',
 
2933
             Option('unchanged',
 
2934
                    help='Commit even if nothing has changed.'),
 
2935
             Option('file', type=str,
 
2936
                    short_name='F',
 
2937
                    argname='msgfile',
 
2938
                    help='Take commit message from this file.'),
 
2939
             Option('strict',
 
2940
                    help="Refuse to commit if there are unknown "
 
2941
                    "files in the working tree."),
 
2942
             ListOption('fixes', type=str,
 
2943
                    help="Mark a bug as being fixed by this revision "
 
2944
                         "(see \"bzr help bugs\")."),
 
2945
             ListOption('author', type=unicode,
 
2946
                    help="Set the author's name, if it's different "
 
2947
                         "from the committer."),
 
2948
             Option('local',
 
2949
                    help="Perform a local commit in a bound "
 
2950
                         "branch.  Local commits are not pushed to "
 
2951
                         "the master branch until a normal commit "
 
2952
                         "is performed."
 
2953
                    ),
 
2954
              Option('show-diff',
 
2955
                     help='When no message is supplied, show the diff along'
 
2956
                     ' with the status summary in the message editor.'),
 
2957
             ]
1687
2958
    aliases = ['ci', 'checkin']
1688
2959
 
1689
 
    def run(self, message=None, file=None, verbose=True, selected_list=None,
1690
 
            unchanged=False, strict=False, local=False):
1691
 
        from bzrlib.commit import (NullCommitReporter, ReportCommitToLog)
1692
 
        from bzrlib.errors import (PointlessCommit, ConflictsInTree,
1693
 
                StrictCommitFailed)
1694
 
        from bzrlib.msgeditor import edit_commit_message, \
1695
 
                make_commit_message_template
1696
 
        from tempfile import TemporaryFile
 
2960
    def _iter_bug_fix_urls(self, fixes, branch):
 
2961
        # Configure the properties for bug fixing attributes.
 
2962
        for fixed_bug in fixes:
 
2963
            tokens = fixed_bug.split(':')
 
2964
            if len(tokens) != 2:
 
2965
                raise errors.BzrCommandError(
 
2966
                    "Invalid bug %s. Must be in the form of 'tracker:id'. "
 
2967
                    "See \"bzr help bugs\" for more information on this "
 
2968
                    "feature.\nCommit refused." % fixed_bug)
 
2969
            tag, bug_id = tokens
 
2970
            try:
 
2971
                yield bugtracker.get_bug_url(tag, branch, bug_id)
 
2972
            except errors.UnknownBugTrackerAbbreviation:
 
2973
                raise errors.BzrCommandError(
 
2974
                    'Unrecognized bug %s. Commit refused.' % fixed_bug)
 
2975
            except errors.MalformedBugIdentifier, e:
 
2976
                raise errors.BzrCommandError(
 
2977
                    "%s\nCommit refused." % (str(e),))
 
2978
 
 
2979
    def run(self, message=None, file=None, verbose=False, selected_list=None,
 
2980
            unchanged=False, strict=False, local=False, fixes=None,
 
2981
            author=None, show_diff=False, exclude=None):
 
2982
        from bzrlib.errors import (
 
2983
            PointlessCommit,
 
2984
            ConflictsInTree,
 
2985
            StrictCommitFailed
 
2986
        )
 
2987
        from bzrlib.msgeditor import (
 
2988
            edit_commit_message_encoded,
 
2989
            generate_commit_message_template,
 
2990
            make_commit_message_template_encoded
 
2991
        )
1697
2992
 
1698
2993
        # TODO: Need a blackbox test for invoking the external editor; may be
1699
2994
        # slightly problematic to run this cross-platform.
1700
2995
 
1701
 
        # TODO: do more checks that the commit will succeed before 
 
2996
        # TODO: do more checks that the commit will succeed before
1702
2997
        # spending the user's valuable time typing a commit message.
1703
 
        #
1704
 
        # TODO: if the commit *does* happen to fail, then save the commit 
1705
 
        # message to a temporary file where it can be recovered
 
2998
 
 
2999
        properties = {}
 
3000
 
1706
3001
        tree, selected_list = tree_files(selected_list)
1707
3002
        if selected_list == ['']:
1708
3003
            # workaround - commit of root of tree should be exactly the same
1710
3005
            # selected-file merge commit is not done yet
1711
3006
            selected_list = []
1712
3007
 
 
3008
        if fixes is None:
 
3009
            fixes = []
 
3010
        bug_property = bugtracker.encode_fixes_bug_urls(
 
3011
            self._iter_bug_fix_urls(fixes, tree.branch))
 
3012
        if bug_property:
 
3013
            properties['bugs'] = bug_property
 
3014
 
1713
3015
        if local and not tree.branch.get_bound_location():
1714
3016
            raise errors.LocalRequiresBoundBranch()
1715
 
        if message is None and not file:
1716
 
            template = make_commit_message_template(tree, selected_list)
1717
 
            message = edit_commit_message(template)
1718
 
            if message is None:
1719
 
                raise BzrCommandError("please specify a commit message"
1720
 
                                      " with either --message or --file")
1721
 
        elif message and file:
1722
 
            raise BzrCommandError("please specify either --message or --file")
1723
 
        
1724
 
        if file:
1725
 
            message = codecs.open(file, 'rt', bzrlib.user_encoding).read()
1726
 
 
1727
 
        if message == "":
1728
 
            raise BzrCommandError("empty commit message specified")
1729
 
        
1730
 
        if verbose:
1731
 
            reporter = ReportCommitToLog()
1732
 
        else:
1733
 
            reporter = NullCommitReporter()
1734
 
        
 
3017
 
 
3018
        def get_message(commit_obj):
 
3019
            """Callback to get commit message"""
 
3020
            my_message = message
 
3021
            if my_message is None and not file:
 
3022
                t = make_commit_message_template_encoded(tree,
 
3023
                        selected_list, diff=show_diff,
 
3024
                        output_encoding=osutils.get_user_encoding())
 
3025
                start_message = generate_commit_message_template(commit_obj)
 
3026
                my_message = edit_commit_message_encoded(t,
 
3027
                    start_message=start_message)
 
3028
                if my_message is None:
 
3029
                    raise errors.BzrCommandError("please specify a commit"
 
3030
                        " message with either --message or --file")
 
3031
            elif my_message and file:
 
3032
                raise errors.BzrCommandError(
 
3033
                    "please specify either --message or --file")
 
3034
            if file:
 
3035
                my_message = codecs.open(file, 'rt',
 
3036
                                         osutils.get_user_encoding()).read()
 
3037
            if my_message == "":
 
3038
                raise errors.BzrCommandError("empty commit message specified")
 
3039
            return my_message
 
3040
 
 
3041
        # The API permits a commit with a filter of [] to mean 'select nothing'
 
3042
        # but the command line should not do that.
 
3043
        if not selected_list:
 
3044
            selected_list = None
1735
3045
        try:
1736
 
            tree.commit(message, specific_files=selected_list,
 
3046
            tree.commit(message_callback=get_message,
 
3047
                        specific_files=selected_list,
1737
3048
                        allow_pointless=unchanged, strict=strict, local=local,
1738
 
                        reporter=reporter)
 
3049
                        reporter=None, verbose=verbose, revprops=properties,
 
3050
                        authors=author,
 
3051
                        exclude=safe_relpath_files(tree, exclude))
1739
3052
        except PointlessCommit:
1740
3053
            # FIXME: This should really happen before the file is read in;
1741
3054
            # perhaps prepare the commit; get the message; then actually commit
1742
 
            raise BzrCommandError("no changes to commit."
1743
 
                                  " use --unchanged to commit anyhow")
 
3055
            raise errors.BzrCommandError("No changes to commit."
 
3056
                              " Use --unchanged to commit anyhow.")
1744
3057
        except ConflictsInTree:
1745
 
            raise BzrCommandError("Conflicts detected in working tree.  "
1746
 
                'Use "bzr conflicts" to list, "bzr resolve FILE" to resolve.')
 
3058
            raise errors.BzrCommandError('Conflicts detected in working '
 
3059
                'tree.  Use "bzr conflicts" to list, "bzr resolve FILE" to'
 
3060
                ' resolve.')
1747
3061
        except StrictCommitFailed:
1748
 
            raise BzrCommandError("Commit refused because there are unknown "
1749
 
                                  "files in the working tree.")
 
3062
            raise errors.BzrCommandError("Commit refused because there are"
 
3063
                              " unknown files in the working tree.")
1750
3064
        except errors.BoundBranchOutOfDate, e:
1751
 
            raise BzrCommandError(str(e) + "\n"
1752
 
                'To commit to master branch, run update and then commit.\n'
1753
 
                'You can also pass --local to commit to continue working '
1754
 
                'disconnected.')
 
3065
            raise errors.BzrCommandError(str(e) + "\n"
 
3066
            'To commit to master branch, run update and then commit.\n'
 
3067
            'You can also pass --local to commit to continue working '
 
3068
            'disconnected.')
 
3069
 
1755
3070
 
1756
3071
class cmd_check(Command):
1757
 
    """Validate consistency of branch history.
1758
 
 
1759
 
    This command checks various invariants about the branch storage to
1760
 
    detect data corruption or bzr bugs.
 
3072
    """Validate working tree structure, branch consistency and repository history.
 
3073
 
 
3074
    This command checks various invariants about branch and repository storage
 
3075
    to detect data corruption or bzr bugs.
 
3076
 
 
3077
    The working tree and branch checks will only give output if a problem is
 
3078
    detected. The output fields of the repository check are:
 
3079
 
 
3080
    revisions
 
3081
        This is just the number of revisions checked.  It doesn't
 
3082
        indicate a problem.
 
3083
 
 
3084
    versionedfiles
 
3085
        This is just the number of versionedfiles checked.  It
 
3086
        doesn't indicate a problem.
 
3087
 
 
3088
    unreferenced ancestors
 
3089
        Texts that are ancestors of other texts, but
 
3090
        are not properly referenced by the revision ancestry.  This is a
 
3091
        subtle problem that Bazaar can work around.
 
3092
 
 
3093
    unique file texts
 
3094
        This is the total number of unique file contents
 
3095
        seen in the checked revisions.  It does not indicate a problem.
 
3096
 
 
3097
    repeated file texts
 
3098
        This is the total number of repeated texts seen
 
3099
        in the checked revisions.  Texts can be repeated when their file
 
3100
        entries are modified, but the file contents are not.  It does not
 
3101
        indicate a problem.
 
3102
 
 
3103
    If no restrictions are specified, all Bazaar data that is found at the given
 
3104
    location will be checked.
 
3105
 
 
3106
    :Examples:
 
3107
 
 
3108
        Check the tree and branch at 'foo'::
 
3109
 
 
3110
            bzr check --tree --branch foo
 
3111
 
 
3112
        Check only the repository at 'bar'::
 
3113
 
 
3114
            bzr check --repo bar
 
3115
 
 
3116
        Check everything at 'baz'::
 
3117
 
 
3118
            bzr check baz
1761
3119
    """
1762
 
    takes_args = ['branch?']
1763
 
    takes_options = ['verbose']
1764
 
 
1765
 
    def run(self, branch=None, verbose=False):
1766
 
        from bzrlib.check import check
1767
 
        if branch is None:
1768
 
            tree = WorkingTree.open_containing()[0]
1769
 
            branch = tree.branch
1770
 
        else:
1771
 
            branch = Branch.open(branch)
1772
 
        check(branch, verbose)
1773
 
 
1774
 
 
1775
 
class cmd_scan_cache(Command):
1776
 
    hidden = True
1777
 
    def run(self):
1778
 
        from bzrlib.hashcache import HashCache
1779
 
 
1780
 
        c = HashCache(u'.')
1781
 
        c.read()
1782
 
        c.scan()
1783
 
            
1784
 
        print '%6d stats' % c.stat_count
1785
 
        print '%6d in hashcache' % len(c._cache)
1786
 
        print '%6d files removed from cache' % c.removed_count
1787
 
        print '%6d hashes updated' % c.update_count
1788
 
        print '%6d files changed too recently to cache' % c.danger_count
1789
 
 
1790
 
        if c.needs_write:
1791
 
            c.write()
 
3120
 
 
3121
    _see_also = ['reconcile']
 
3122
    takes_args = ['path?']
 
3123
    takes_options = ['verbose',
 
3124
                     Option('branch', help="Check the branch related to the"
 
3125
                                           " current directory."),
 
3126
                     Option('repo', help="Check the repository related to the"
 
3127
                                         " current directory."),
 
3128
                     Option('tree', help="Check the working tree related to"
 
3129
                                         " the current directory.")]
 
3130
 
 
3131
    def run(self, path=None, verbose=False, branch=False, repo=False,
 
3132
            tree=False):
 
3133
        from bzrlib.check import check_dwim
 
3134
        if path is None:
 
3135
            path = '.'
 
3136
        if not branch and not repo and not tree:
 
3137
            branch = repo = tree = True
 
3138
        check_dwim(path, verbose, do_branch=branch, do_repo=repo, do_tree=tree)
1792
3139
 
1793
3140
 
1794
3141
class cmd_upgrade(Command):
1798
3145
    this command. When the default format has changed you may also be warned
1799
3146
    during other operations to upgrade.
1800
3147
    """
 
3148
 
 
3149
    _see_also = ['check']
1801
3150
    takes_args = ['url?']
1802
3151
    takes_options = [
1803
 
                     Option('format', 
1804
 
                            help='Upgrade to a specific format. Current formats'
1805
 
                                 ' are: default, knit, metaweave and weave.'
1806
 
                                 ' Default is knit; metaweave and weave are'
1807
 
                                 ' deprecated',
1808
 
                            type=get_format_type),
 
3152
                    RegistryOption('format',
 
3153
                        help='Upgrade to a specific format.  See "bzr help'
 
3154
                             ' formats" for details.',
 
3155
                        lazy_registry=('bzrlib.bzrdir', 'format_registry'),
 
3156
                        converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
 
3157
                        value_switches=True, title='Branch format'),
1809
3158
                    ]
1810
3159
 
1811
 
 
1812
3160
    def run(self, url='.', format=None):
1813
3161
        from bzrlib.upgrade import upgrade
1814
 
        if format is None:
1815
 
            format = get_format_type('default')
1816
3162
        upgrade(url, format)
1817
3163
 
1818
3164
 
1819
3165
class cmd_whoami(Command):
1820
3166
    """Show or set bzr user id.
1821
 
    
1822
 
    examples:
1823
 
        bzr whoami --email
1824
 
        bzr whoami 'Frank Chu <fchu@example.com>'
 
3167
 
 
3168
    :Examples:
 
3169
        Show the email of the current user::
 
3170
 
 
3171
            bzr whoami --email
 
3172
 
 
3173
        Set the current user::
 
3174
 
 
3175
            bzr whoami "Frank Chu <fchu@example.com>"
1825
3176
    """
1826
3177
    takes_options = [ Option('email',
1827
 
                             help='display email address only'),
 
3178
                             help='Display email address only.'),
1828
3179
                      Option('branch',
1829
 
                             help='set identity for the current branch instead of '
1830
 
                                  'globally'),
 
3180
                             help='Set identity for the current branch instead of '
 
3181
                                  'globally.'),
1831
3182
                    ]
1832
3183
    takes_args = ['name?']
1833
3184
    encoding_type = 'replace'
1834
 
    
 
3185
 
1835
3186
    @display_command
1836
3187
    def run(self, email=False, branch=False, name=None):
1837
3188
        if name is None:
1838
3189
            # use branch if we're inside one; otherwise global config
1839
3190
            try:
1840
3191
                c = Branch.open_containing('.')[0].get_config()
1841
 
            except NotBranchError:
 
3192
            except errors.NotBranchError:
1842
3193
                c = config.GlobalConfig()
1843
3194
            if email:
1844
3195
                self.outf.write(c.user_email() + '\n')
1849
3200
        # display a warning if an email address isn't included in the given name.
1850
3201
        try:
1851
3202
            config.extract_email_address(name)
1852
 
        except BzrError, e:
 
3203
        except errors.NoEmailInUsername, e:
1853
3204
            warning('"%s" does not seem to contain an email address.  '
1854
3205
                    'This is allowed, but not recommended.', name)
1855
 
        
 
3206
 
1856
3207
        # use global config unless --branch given
1857
3208
        if branch:
1858
3209
            c = Branch.open_containing('.')[0].get_config()
1862
3213
 
1863
3214
 
1864
3215
class cmd_nick(Command):
1865
 
    """Print or set the branch nickname.  
1866
 
 
1867
 
    If unset, the tree root directory name is used as the nickname
1868
 
    To print the current nickname, execute with no argument.  
 
3216
    """Print or set the branch nickname.
 
3217
 
 
3218
    If unset, the tree root directory name is used as the nickname.
 
3219
    To print the current nickname, execute with no argument.
 
3220
 
 
3221
    Bound branches use the nickname of its master branch unless it is set
 
3222
    locally.
1869
3223
    """
 
3224
 
 
3225
    _see_also = ['info']
1870
3226
    takes_args = ['nickname?']
1871
3227
    def run(self, nickname=None):
1872
3228
        branch = Branch.open_containing(u'.')[0]
1877
3233
 
1878
3234
    @display_command
1879
3235
    def printme(self, branch):
1880
 
        print branch.nick 
 
3236
        print branch.nick
 
3237
 
 
3238
 
 
3239
class cmd_alias(Command):
 
3240
    """Set/unset and display aliases.
 
3241
 
 
3242
    :Examples:
 
3243
        Show the current aliases::
 
3244
 
 
3245
            bzr alias
 
3246
 
 
3247
        Show the alias specified for 'll'::
 
3248
 
 
3249
            bzr alias ll
 
3250
 
 
3251
        Set an alias for 'll'::
 
3252
 
 
3253
            bzr alias ll="log --line -r-10..-1"
 
3254
 
 
3255
        To remove an alias for 'll'::
 
3256
 
 
3257
            bzr alias --remove ll
 
3258
 
 
3259
    """
 
3260
    takes_args = ['name?']
 
3261
    takes_options = [
 
3262
        Option('remove', help='Remove the alias.'),
 
3263
        ]
 
3264
 
 
3265
    def run(self, name=None, remove=False):
 
3266
        if remove:
 
3267
            self.remove_alias(name)
 
3268
        elif name is None:
 
3269
            self.print_aliases()
 
3270
        else:
 
3271
            equal_pos = name.find('=')
 
3272
            if equal_pos == -1:
 
3273
                self.print_alias(name)
 
3274
            else:
 
3275
                self.set_alias(name[:equal_pos], name[equal_pos+1:])
 
3276
 
 
3277
    def remove_alias(self, alias_name):
 
3278
        if alias_name is None:
 
3279
            raise errors.BzrCommandError(
 
3280
                'bzr alias --remove expects an alias to remove.')
 
3281
        # If alias is not found, print something like:
 
3282
        # unalias: foo: not found
 
3283
        c = config.GlobalConfig()
 
3284
        c.unset_alias(alias_name)
 
3285
 
 
3286
    @display_command
 
3287
    def print_aliases(self):
 
3288
        """Print out the defined aliases in a similar format to bash."""
 
3289
        aliases = config.GlobalConfig().get_aliases()
 
3290
        for key, value in sorted(aliases.iteritems()):
 
3291
            self.outf.write('bzr alias %s="%s"\n' % (key, value))
 
3292
 
 
3293
    @display_command
 
3294
    def print_alias(self, alias_name):
 
3295
        from bzrlib.commands import get_alias
 
3296
        alias = get_alias(alias_name)
 
3297
        if alias is None:
 
3298
            self.outf.write("bzr alias: %s: not found\n" % alias_name)
 
3299
        else:
 
3300
            self.outf.write(
 
3301
                'bzr alias %s="%s"\n' % (alias_name, ' '.join(alias)))
 
3302
 
 
3303
    def set_alias(self, alias_name, alias_command):
 
3304
        """Save the alias in the global config."""
 
3305
        c = config.GlobalConfig()
 
3306
        c.set_alias(alias_name, alias_command)
1881
3307
 
1882
3308
 
1883
3309
class cmd_selftest(Command):
1884
3310
    """Run internal test suite.
1885
 
    
1886
 
    This creates temporary test directories in the working directory,
1887
 
    but not existing data is affected.  These directories are deleted
1888
 
    if the tests pass, or left behind to help in debugging if they
1889
 
    fail and --keep-output is specified.
1890
 
    
1891
 
    If arguments are given, they are regular expressions that say
1892
 
    which tests should run.
 
3311
 
 
3312
    If arguments are given, they are regular expressions that say which tests
 
3313
    should run.  Tests matching any expression are run, and other tests are
 
3314
    not run.
 
3315
 
 
3316
    Alternatively if --first is given, matching tests are run first and then
 
3317
    all other tests are run.  This is useful if you have been working in a
 
3318
    particular area, but want to make sure nothing else was broken.
 
3319
 
 
3320
    If --exclude is given, tests that match that regular expression are
 
3321
    excluded, regardless of whether they match --first or not.
 
3322
 
 
3323
    To help catch accidential dependencies between tests, the --randomize
 
3324
    option is useful. In most cases, the argument used is the word 'now'.
 
3325
    Note that the seed used for the random number generator is displayed
 
3326
    when this option is used. The seed can be explicitly passed as the
 
3327
    argument to this option if required. This enables reproduction of the
 
3328
    actual ordering used if and when an order sensitive problem is encountered.
 
3329
 
 
3330
    If --list-only is given, the tests that would be run are listed. This is
 
3331
    useful when combined with --first, --exclude and/or --randomize to
 
3332
    understand their impact. The test harness reports "Listed nn tests in ..."
 
3333
    instead of "Ran nn tests in ..." when list mode is enabled.
1893
3334
 
1894
3335
    If the global option '--no-plugins' is given, plugins are not loaded
1895
3336
    before running the selftests.  This has two effects: features provided or
1896
3337
    modified by plugins will not be tested, and tests provided by plugins will
1897
3338
    not be run.
1898
3339
 
1899
 
    examples:
1900
 
        bzr selftest ignore
1901
 
        bzr --no-plugins selftest -v
 
3340
    Tests that need working space on disk use a common temporary directory,
 
3341
    typically inside $TMPDIR or /tmp.
 
3342
 
 
3343
    :Examples:
 
3344
        Run only tests relating to 'ignore'::
 
3345
 
 
3346
            bzr selftest ignore
 
3347
 
 
3348
        Disable plugins and list tests as they're run::
 
3349
 
 
3350
            bzr --no-plugins selftest -v
1902
3351
    """
1903
 
    # TODO: --list should give a list of all available tests
1904
 
 
1905
3352
    # NB: this is used from the class without creating an instance, which is
1906
3353
    # why it does not have a self parameter.
1907
3354
    def get_transport_type(typestring):
1917
3364
            return FakeNFSServer
1918
3365
        msg = "No known transport type %s. Supported types are: sftp\n" %\
1919
3366
            (typestring)
1920
 
        raise BzrCommandError(msg)
 
3367
        raise errors.BzrCommandError(msg)
1921
3368
 
1922
3369
    hidden = True
1923
3370
    takes_args = ['testspecs*']
1924
3371
    takes_options = ['verbose',
1925
 
                     Option('one', help='stop when one test fails'),
1926
 
                     Option('keep-output', 
1927
 
                            help='keep output directories when tests fail'),
1928
 
                     Option('transport', 
 
3372
                     Option('one',
 
3373
                             help='Stop when one test fails.',
 
3374
                             short_name='1',
 
3375
                             ),
 
3376
                     Option('transport',
1929
3377
                            help='Use a different transport by default '
1930
3378
                                 'throughout the test suite.',
1931
3379
                            type=get_transport_type),
1932
 
                     Option('benchmark', help='run the bzr bencharks.'),
 
3380
                     Option('benchmark',
 
3381
                            help='Run the benchmarks rather than selftests.'),
1933
3382
                     Option('lsprof-timed',
1934
 
                            help='generate lsprof output for benchmarked'
 
3383
                            help='Generate lsprof output for benchmarked'
1935
3384
                                 ' sections of code.'),
 
3385
                     Option('lsprof-tests',
 
3386
                            help='Generate lsprof output for each test.'),
 
3387
                     Option('cache-dir', type=str,
 
3388
                            help='Cache intermediate benchmark output in this '
 
3389
                                 'directory.'),
 
3390
                     Option('first',
 
3391
                            help='Run all tests, but run specified tests first.',
 
3392
                            short_name='f',
 
3393
                            ),
 
3394
                     Option('list-only',
 
3395
                            help='List the tests instead of running them.'),
 
3396
                     RegistryOption('parallel',
 
3397
                        help="Run the test suite in parallel.",
 
3398
                        lazy_registry=('bzrlib.tests', 'parallel_registry'),
 
3399
                        value_switches=False,
 
3400
                        ),
 
3401
                     Option('randomize', type=str, argname="SEED",
 
3402
                            help='Randomize the order of tests using the given'
 
3403
                                 ' seed or "now" for the current time.'),
 
3404
                     Option('exclude', type=str, argname="PATTERN",
 
3405
                            short_name='x',
 
3406
                            help='Exclude tests that match this regular'
 
3407
                                 ' expression.'),
 
3408
                     Option('subunit',
 
3409
                        help='Output test progress via subunit.'),
 
3410
                     Option('strict', help='Fail on missing dependencies or '
 
3411
                            'known failures.'),
 
3412
                     Option('load-list', type=str, argname='TESTLISTFILE',
 
3413
                            help='Load a test id list from a text file.'),
 
3414
                     ListOption('debugflag', type=str, short_name='E',
 
3415
                                help='Turn on a selftest debug flag.'),
 
3416
                     ListOption('starting-with', type=str, argname='TESTID',
 
3417
                                param_name='starting_with', short_name='s',
 
3418
                                help=
 
3419
                                'Load only the tests starting with TESTID.'),
1936
3420
                     ]
1937
 
 
1938
 
    def run(self, testspecs_list=None, verbose=None, one=False,
1939
 
            keep_output=False, transport=None, benchmark=None,
1940
 
            lsprof_timed=None):
1941
 
        import bzrlib.ui
 
3421
    encoding_type = 'replace'
 
3422
 
 
3423
    def __init__(self):
 
3424
        Command.__init__(self)
 
3425
        self.additional_selftest_args = {}
 
3426
 
 
3427
    def run(self, testspecs_list=None, verbose=False, one=False,
 
3428
            transport=None, benchmark=None,
 
3429
            lsprof_timed=None, cache_dir=None,
 
3430
            first=False, list_only=False,
 
3431
            randomize=None, exclude=None, strict=False,
 
3432
            load_list=None, debugflag=None, starting_with=None, subunit=False,
 
3433
            parallel=None, lsprof_tests=False):
1942
3434
        from bzrlib.tests import selftest
1943
3435
        import bzrlib.benchmarks as benchmarks
1944
 
        # we don't want progress meters from the tests to go to the
1945
 
        # real output; and we don't want log messages cluttering up
1946
 
        # the real logs.
1947
 
        save_ui = ui.ui_factory
1948
 
        print '%10s: %s' % ('bzr', osutils.realpath(sys.argv[0]))
1949
 
        print '%10s: %s' % ('bzrlib', bzrlib.__path__[0])
1950
 
        print
1951
 
        info('running tests...')
 
3436
        from bzrlib.benchmarks import tree_creator
 
3437
 
 
3438
        # Make deprecation warnings visible, unless -Werror is set
 
3439
        symbol_versioning.activate_deprecation_warnings(override=False)
 
3440
 
 
3441
        if cache_dir is not None:
 
3442
            tree_creator.TreeCreator.CACHE_ROOT = osutils.abspath(cache_dir)
 
3443
        if testspecs_list is not None:
 
3444
            pattern = '|'.join(testspecs_list)
 
3445
        else:
 
3446
            pattern = ".*"
 
3447
        if subunit:
 
3448
            try:
 
3449
                from bzrlib.tests import SubUnitBzrRunner
 
3450
            except ImportError:
 
3451
                raise errors.BzrCommandError("subunit not available. subunit "
 
3452
                    "needs to be installed to use --subunit.")
 
3453
            self.additional_selftest_args['runner_class'] = SubUnitBzrRunner
 
3454
        if parallel:
 
3455
            self.additional_selftest_args.setdefault(
 
3456
                'suite_decorators', []).append(parallel)
 
3457
        if benchmark:
 
3458
            test_suite_factory = benchmarks.test_suite
 
3459
            # Unless user explicitly asks for quiet, be verbose in benchmarks
 
3460
            verbose = not is_quiet()
 
3461
            # TODO: should possibly lock the history file...
 
3462
            benchfile = open(".perf_history", "at", buffering=1)
 
3463
        else:
 
3464
            test_suite_factory = None
 
3465
            benchfile = None
1952
3466
        try:
1953
 
            ui.ui_factory = ui.SilentUIFactory()
1954
 
            if testspecs_list is not None:
1955
 
                pattern = '|'.join(testspecs_list)
1956
 
            else:
1957
 
                pattern = ".*"
1958
 
            if benchmark:
1959
 
                test_suite_factory = benchmarks.test_suite
1960
 
                if verbose is None:
1961
 
                    verbose = True
1962
 
            else:
1963
 
                test_suite_factory = None
1964
 
                if verbose is None:
1965
 
                    verbose = False
1966
 
            result = selftest(verbose=verbose, 
1967
 
                              pattern=pattern,
1968
 
                              stop_on_failure=one, 
1969
 
                              keep_output=keep_output,
1970
 
                              transport=transport,
1971
 
                              test_suite_factory=test_suite_factory,
1972
 
                              lsprof_timed=lsprof_timed)
1973
 
            if result:
1974
 
                info('tests passed')
1975
 
            else:
1976
 
                info('tests failed')
1977
 
            return int(not result)
 
3467
            selftest_kwargs = {"verbose": verbose,
 
3468
                              "pattern": pattern,
 
3469
                              "stop_on_failure": one,
 
3470
                              "transport": transport,
 
3471
                              "test_suite_factory": test_suite_factory,
 
3472
                              "lsprof_timed": lsprof_timed,
 
3473
                              "lsprof_tests": lsprof_tests,
 
3474
                              "bench_history": benchfile,
 
3475
                              "matching_tests_first": first,
 
3476
                              "list_only": list_only,
 
3477
                              "random_seed": randomize,
 
3478
                              "exclude_pattern": exclude,
 
3479
                              "strict": strict,
 
3480
                              "load_list": load_list,
 
3481
                              "debug_flags": debugflag,
 
3482
                              "starting_with": starting_with
 
3483
                              }
 
3484
            selftest_kwargs.update(self.additional_selftest_args)
 
3485
            result = selftest(**selftest_kwargs)
1978
3486
        finally:
1979
 
            ui.ui_factory = save_ui
1980
 
 
1981
 
 
1982
 
def _get_bzr_branch():
1983
 
    """If bzr is run from a branch, return Branch or None"""
1984
 
    from os.path import dirname
1985
 
    
1986
 
    try:
1987
 
        branch = Branch.open(dirname(osutils.abspath(dirname(__file__))))
1988
 
        return branch
1989
 
    except errors.BzrError:
1990
 
        return None
1991
 
    
1992
 
 
1993
 
def show_version():
1994
 
    import bzrlib
1995
 
    print "Bazaar (bzr) %s" % bzrlib.__version__
1996
 
    # is bzrlib itself in a branch?
1997
 
    branch = _get_bzr_branch()
1998
 
    if branch:
1999
 
        rh = branch.revision_history()
2000
 
        revno = len(rh)
2001
 
        print "  bzr checkout, revision %d" % (revno,)
2002
 
        print "  nick: %s" % (branch.nick,)
2003
 
        if rh:
2004
 
            print "  revid: %s" % (rh[-1],)
2005
 
    print "Using python interpreter:", sys.executable
2006
 
    import site
2007
 
    print "Using python standard library:", os.path.dirname(site.__file__)
2008
 
    print "Using bzrlib:",
2009
 
    if len(bzrlib.__path__) > 1:
2010
 
        # print repr, which is a good enough way of making it clear it's
2011
 
        # more than one element (eg ['/foo/bar', '/foo/bzr'])
2012
 
        print repr(bzrlib.__path__)
2013
 
    else:
2014
 
        print bzrlib.__path__[0]
2015
 
 
2016
 
    print
2017
 
    print bzrlib.__copyright__
2018
 
    print "http://bazaar-vcs.org/"
2019
 
    print
2020
 
    print "bzr comes with ABSOLUTELY NO WARRANTY.  bzr is free software, and"
2021
 
    print "you may use, modify and redistribute it under the terms of the GNU"
2022
 
    print "General Public License version 2 or later."
 
3487
            if benchfile is not None:
 
3488
                benchfile.close()
 
3489
        return int(not result)
2023
3490
 
2024
3491
 
2025
3492
class cmd_version(Command):
2026
3493
    """Show version of bzr."""
2027
3494
 
 
3495
    encoding_type = 'replace'
 
3496
    takes_options = [
 
3497
        Option("short", help="Print just the version number."),
 
3498
        ]
 
3499
 
2028
3500
    @display_command
2029
 
    def run(self):
2030
 
        show_version()
 
3501
    def run(self, short=False):
 
3502
        from bzrlib.version import show_version
 
3503
        if short:
 
3504
            self.outf.write(bzrlib.version_string + '\n')
 
3505
        else:
 
3506
            show_version(to_file=self.outf)
2031
3507
 
2032
3508
 
2033
3509
class cmd_rocks(Command):
2037
3513
 
2038
3514
    @display_command
2039
3515
    def run(self):
2040
 
        print "it sure does!"
 
3516
        print "It sure does!"
2041
3517
 
2042
3518
 
2043
3519
class cmd_find_merge_base(Command):
2046
3522
    #       merging only part of the history.
2047
3523
    takes_args = ['branch', 'other']
2048
3524
    hidden = True
2049
 
    
 
3525
 
2050
3526
    @display_command
2051
3527
    def run(self, branch, other):
2052
 
        from bzrlib.revision import common_ancestor, MultipleRevisionSources
2053
 
        
 
3528
        from bzrlib.revision import ensure_null
 
3529
 
2054
3530
        branch1 = Branch.open_containing(branch)[0]
2055
3531
        branch2 = Branch.open_containing(other)[0]
2056
 
 
2057
 
        history_1 = branch1.revision_history()
2058
 
        history_2 = branch2.revision_history()
2059
 
 
2060
 
        last1 = branch1.last_revision()
2061
 
        last2 = branch2.last_revision()
2062
 
 
2063
 
        source = MultipleRevisionSources(branch1.repository, 
2064
 
                                         branch2.repository)
2065
 
        
2066
 
        base_rev_id = common_ancestor(last1, last2, source)
2067
 
 
2068
 
        print 'merge base is revision %s' % base_rev_id
 
3532
        branch1.lock_read()
 
3533
        try:
 
3534
            branch2.lock_read()
 
3535
            try:
 
3536
                last1 = ensure_null(branch1.last_revision())
 
3537
                last2 = ensure_null(branch2.last_revision())
 
3538
 
 
3539
                graph = branch1.repository.get_graph(branch2.repository)
 
3540
                base_rev_id = graph.find_unique_lca(last1, last2)
 
3541
 
 
3542
                print 'merge base is revision %s' % base_rev_id
 
3543
            finally:
 
3544
                branch2.unlock()
 
3545
        finally:
 
3546
            branch1.unlock()
2069
3547
 
2070
3548
 
2071
3549
class cmd_merge(Command):
2072
3550
    """Perform a three-way merge.
2073
 
    
2074
 
    The branch is the branch you will merge from.  By default, it will merge
2075
 
    the latest revision.  If you specify a revision, that revision will be
2076
 
    merged.  If you specify two revisions, the first will be used as a BASE,
2077
 
    and the second one as OTHER.  Revision numbers are always relative to the
2078
 
    specified branch.
 
3551
 
 
3552
    The source of the merge can be specified either in the form of a branch,
 
3553
    or in the form of a path to a file containing a merge directive generated
 
3554
    with bzr send. If neither is specified, the default is the upstream branch
 
3555
    or the branch most recently merged using --remember.
 
3556
 
 
3557
    When merging a branch, by default the tip will be merged. To pick a different
 
3558
    revision, pass --revision. If you specify two values, the first will be used as
 
3559
    BASE and the second one as OTHER. Merging individual revisions, or a subset of
 
3560
    available revisions, like this is commonly referred to as "cherrypicking".
 
3561
 
 
3562
    Revision numbers are always relative to the branch being merged.
2079
3563
 
2080
3564
    By default, bzr will try to merge in all new work from the other
2081
3565
    branch, automatically determining an appropriate base.  If this
2082
3566
    fails, you may need to give an explicit base.
2083
 
    
 
3567
 
2084
3568
    Merge will do its best to combine the changes in two branches, but there
2085
3569
    are some kinds of problems only a human can fix.  When it encounters those,
2086
3570
    it will mark a conflict.  A conflict means that you need to fix something,
2093
3577
    default, use --remember. The value will only be saved if the remote
2094
3578
    location can be accessed.
2095
3579
 
2096
 
    Examples:
2097
 
 
2098
 
    To merge the latest revision from bzr.dev
2099
 
    bzr merge ../bzr.dev
2100
 
 
2101
 
    To merge changes up to and including revision 82 from bzr.dev
2102
 
    bzr merge -r 82 ../bzr.dev
2103
 
 
2104
 
    To merge the changes introduced by 82, without previous changes:
2105
 
    bzr merge -r 81..82 ../bzr.dev
2106
 
    
 
3580
    The results of the merge are placed into the destination working
 
3581
    directory, where they can be reviewed (with bzr diff), tested, and then
 
3582
    committed to record the result of the merge.
 
3583
 
2107
3584
    merge refuses to run if there are any uncommitted changes, unless
2108
3585
    --force is given.
2109
3586
 
2110
 
    The following merge types are available:
 
3587
    To select only some changes to merge, use "merge -i", which will prompt
 
3588
    you to apply each diff hunk and file change, similar to "shelve".
 
3589
 
 
3590
    :Examples:
 
3591
        To merge the latest revision from bzr.dev::
 
3592
 
 
3593
            bzr merge ../bzr.dev
 
3594
 
 
3595
        To merge changes up to and including revision 82 from bzr.dev::
 
3596
 
 
3597
            bzr merge -r 82 ../bzr.dev
 
3598
 
 
3599
        To merge the changes introduced by 82, without previous changes::
 
3600
 
 
3601
            bzr merge -r 81..82 ../bzr.dev
 
3602
 
 
3603
        To apply a merge directive contained in /tmp/merge:
 
3604
 
 
3605
            bzr merge /tmp/merge
2111
3606
    """
2112
 
    takes_args = ['branch?']
2113
 
    takes_options = ['revision', 'force', 'merge-type', 'reprocess', 'remember',
2114
 
                     Option('show-base', help="Show base revision text in "
2115
 
                            "conflicts"), 
2116
 
                     Option('uncommitted', help='Apply uncommitted changes'
2117
 
                            ' from a working copy, instead of branch changes')]
2118
 
 
2119
 
    def help(self):
2120
 
        from merge import merge_type_help
2121
 
        from inspect import getdoc
2122
 
        return getdoc(self) + '\n' + merge_type_help() 
2123
 
 
2124
 
    def run(self, branch=None, revision=None, force=False, merge_type=None,
2125
 
            show_base=False, reprocess=False, remember=False, 
2126
 
            uncommitted=False):
 
3607
 
 
3608
    encoding_type = 'exact'
 
3609
    _see_also = ['update', 'remerge', 'status-flags', 'send']
 
3610
    takes_args = ['location?']
 
3611
    takes_options = [
 
3612
        'change',
 
3613
        'revision',
 
3614
        Option('force',
 
3615
               help='Merge even if the destination tree has uncommitted changes.'),
 
3616
        'merge-type',
 
3617
        'reprocess',
 
3618
        'remember',
 
3619
        Option('show-base', help="Show base revision text in "
 
3620
               "conflicts."),
 
3621
        Option('uncommitted', help='Apply uncommitted changes'
 
3622
               ' from a working copy, instead of branch changes.'),
 
3623
        Option('pull', help='If the destination is already'
 
3624
                ' completely merged into the source, pull from the'
 
3625
                ' source rather than merging.  When this happens,'
 
3626
                ' you do not need to commit the result.'),
 
3627
        Option('directory',
 
3628
               help='Branch to merge into, '
 
3629
                    'rather than the one containing the working directory.',
 
3630
               short_name='d',
 
3631
               type=unicode,
 
3632
               ),
 
3633
        Option('preview', help='Instead of merging, show a diff of the'
 
3634
               ' merge.'),
 
3635
        Option('interactive', help='Select changes interactively.',
 
3636
            short_name='i')
 
3637
    ]
 
3638
 
 
3639
    def run(self, location=None, revision=None, force=False,
 
3640
            merge_type=None, show_base=False, reprocess=None, remember=False,
 
3641
            uncommitted=False, pull=False,
 
3642
            directory=None,
 
3643
            preview=False,
 
3644
            interactive=False,
 
3645
            ):
2127
3646
        if merge_type is None:
2128
 
            merge_type = Merge3Merger
2129
 
 
2130
 
        tree = WorkingTree.open_containing(u'.')[0]
2131
 
 
2132
 
        if branch is not None:
2133
 
            try:
2134
 
                reader = bundle.read_bundle_from_url(branch)
2135
 
            except NotABundle:
2136
 
                pass # Continue on considering this url a Branch
2137
 
            else:
2138
 
                conflicts = merge_bundle(reader, tree, not force, merge_type,
2139
 
                                            reprocess, show_base)
2140
 
                if conflicts == 0:
2141
 
                    return 0
 
3647
            merge_type = _mod_merge.Merge3Merger
 
3648
 
 
3649
        if directory is None: directory = u'.'
 
3650
        possible_transports = []
 
3651
        merger = None
 
3652
        allow_pending = True
 
3653
        verified = 'inapplicable'
 
3654
        tree = WorkingTree.open_containing(directory)[0]
 
3655
 
 
3656
        # die as quickly as possible if there are uncommitted changes
 
3657
        try:
 
3658
            basis_tree = tree.revision_tree(tree.last_revision())
 
3659
        except errors.NoSuchRevision:
 
3660
            basis_tree = tree.basis_tree()
 
3661
        if not force:
 
3662
            if tree.has_changes(basis_tree):
 
3663
                raise errors.UncommittedChanges(tree)
 
3664
 
 
3665
        view_info = _get_view_info_for_change_reporter(tree)
 
3666
        change_reporter = delta._ChangeReporter(
 
3667
            unversioned_filter=tree.is_ignored, view_info=view_info)
 
3668
        cleanups = []
 
3669
        try:
 
3670
            pb = ui.ui_factory.nested_progress_bar()
 
3671
            cleanups.append(pb.finished)
 
3672
            tree.lock_write()
 
3673
            cleanups.append(tree.unlock)
 
3674
            if location is not None:
 
3675
                try:
 
3676
                    mergeable = bundle.read_mergeable_from_url(location,
 
3677
                        possible_transports=possible_transports)
 
3678
                except errors.NotABundle:
 
3679
                    mergeable = None
2142
3680
                else:
2143
 
                    return 1
2144
 
 
2145
 
        branch = self._get_remembered_parent(tree, branch, 'Merging from')
2146
 
 
2147
 
        if revision is None or len(revision) < 1:
2148
 
            if uncommitted:
2149
 
                base = [branch, -1]
2150
 
                other = [branch, None]
2151
 
            else:
2152
 
                base = [None, None]
2153
 
                other = [branch, -1]
2154
 
            other_branch, path = Branch.open_containing(branch)
2155
 
        else:
2156
 
            if uncommitted:
2157
 
                raise BzrCommandError('Cannot use --uncommitted and --revision'
2158
 
                                      ' at the same time.')
2159
 
            if len(revision) == 1:
2160
 
                base = [None, None]
2161
 
                other_branch, path = Branch.open_containing(branch)
2162
 
                revno = revision[0].in_history(other_branch).revno
2163
 
                other = [branch, revno]
2164
 
            else:
2165
 
                assert len(revision) == 2
2166
 
                if None in revision:
2167
 
                    raise BzrCommandError(
2168
 
                        "Merge doesn't permit that revision specifier.")
2169
 
                other_branch, path = Branch.open_containing(branch)
2170
 
 
2171
 
                base = [branch, revision[0].in_history(other_branch).revno]
2172
 
                other = [branch, revision[1].in_history(other_branch).revno]
2173
 
 
2174
 
        if tree.branch.get_parent() is None or remember:
2175
 
            tree.branch.set_parent(other_branch.base)
2176
 
 
2177
 
        if path != "":
2178
 
            interesting_files = [path]
2179
 
        else:
2180
 
            interesting_files = None
2181
 
        pb = ui.ui_factory.nested_progress_bar()
2182
 
        try:
2183
 
            try:
2184
 
                conflict_count = merge(other, base, check_clean=(not force),
2185
 
                                       merge_type=merge_type,
2186
 
                                       reprocess=reprocess,
2187
 
                                       show_base=show_base,
2188
 
                                       pb=pb, file_list=interesting_files)
2189
 
            finally:
2190
 
                pb.finished()
2191
 
            if conflict_count != 0:
2192
 
                return 1
2193
 
            else:
 
3681
                    if uncommitted:
 
3682
                        raise errors.BzrCommandError('Cannot use --uncommitted'
 
3683
                            ' with bundles or merge directives.')
 
3684
 
 
3685
                    if revision is not None:
 
3686
                        raise errors.BzrCommandError(
 
3687
                            'Cannot use -r with merge directives or bundles')
 
3688
                    merger, verified = _mod_merge.Merger.from_mergeable(tree,
 
3689
                       mergeable, pb)
 
3690
 
 
3691
            if merger is None and uncommitted:
 
3692
                if revision is not None and len(revision) > 0:
 
3693
                    raise errors.BzrCommandError('Cannot use --uncommitted and'
 
3694
                        ' --revision at the same time.')
 
3695
                merger = self.get_merger_from_uncommitted(tree, location, pb,
 
3696
                                                          cleanups)
 
3697
                allow_pending = False
 
3698
 
 
3699
            if merger is None:
 
3700
                merger, allow_pending = self._get_merger_from_branch(tree,
 
3701
                    location, revision, remember, possible_transports, pb)
 
3702
 
 
3703
            merger.merge_type = merge_type
 
3704
            merger.reprocess = reprocess
 
3705
            merger.show_base = show_base
 
3706
            self.sanity_check_merger(merger)
 
3707
            if (merger.base_rev_id == merger.other_rev_id and
 
3708
                merger.other_rev_id is not None):
 
3709
                note('Nothing to do.')
2194
3710
                return 0
2195
 
        except errors.AmbiguousBase, e:
2196
 
            m = ("sorry, bzr can't determine the right merge base yet\n"
2197
 
                 "candidates are:\n  "
2198
 
                 + "\n  ".join(e.bases)
2199
 
                 + "\n"
2200
 
                 "please specify an explicit base with -r,\n"
2201
 
                 "and (if you want) report this to the bzr developers\n")
2202
 
            log_error(m)
2203
 
 
2204
 
    # TODO: move up to common parent; this isn't merge-specific anymore. 
2205
 
    def _get_remembered_parent(self, tree, supplied_location, verb_string):
 
3711
            if pull:
 
3712
                if merger.interesting_files is not None:
 
3713
                    raise errors.BzrCommandError('Cannot pull individual files')
 
3714
                if (merger.base_rev_id == tree.last_revision()):
 
3715
                    result = tree.pull(merger.other_branch, False,
 
3716
                                       merger.other_rev_id)
 
3717
                    result.report(self.outf)
 
3718
                    return 0
 
3719
            merger.check_basis(False)
 
3720
            if preview:
 
3721
                return self._do_preview(merger, cleanups)
 
3722
            elif interactive:
 
3723
                return self._do_interactive(merger, cleanups)
 
3724
            else:
 
3725
                return self._do_merge(merger, change_reporter, allow_pending,
 
3726
                                      verified)
 
3727
        finally:
 
3728
            for cleanup in reversed(cleanups):
 
3729
                cleanup()
 
3730
 
 
3731
    def _get_preview(self, merger, cleanups):
 
3732
        tree_merger = merger.make_merger()
 
3733
        tt = tree_merger.make_preview_transform()
 
3734
        cleanups.append(tt.finalize)
 
3735
        result_tree = tt.get_preview_tree()
 
3736
        return result_tree
 
3737
 
 
3738
    def _do_preview(self, merger, cleanups):
 
3739
        from bzrlib.diff import show_diff_trees
 
3740
        result_tree = self._get_preview(merger, cleanups)
 
3741
        show_diff_trees(merger.this_tree, result_tree, self.outf,
 
3742
                        old_label='', new_label='')
 
3743
 
 
3744
    def _do_merge(self, merger, change_reporter, allow_pending, verified):
 
3745
        merger.change_reporter = change_reporter
 
3746
        conflict_count = merger.do_merge()
 
3747
        if allow_pending:
 
3748
            merger.set_pending()
 
3749
        if verified == 'failed':
 
3750
            warning('Preview patch does not match changes')
 
3751
        if conflict_count != 0:
 
3752
            return 1
 
3753
        else:
 
3754
            return 0
 
3755
 
 
3756
    def _do_interactive(self, merger, cleanups):
 
3757
        """Perform an interactive merge.
 
3758
 
 
3759
        This works by generating a preview tree of the merge, then using
 
3760
        Shelver to selectively remove the differences between the working tree
 
3761
        and the preview tree.
 
3762
        """
 
3763
        from bzrlib import shelf_ui
 
3764
        result_tree = self._get_preview(merger, cleanups)
 
3765
        writer = bzrlib.option.diff_writer_registry.get()
 
3766
        shelver = shelf_ui.Shelver(merger.this_tree, result_tree, destroy=True,
 
3767
                                   reporter=shelf_ui.ApplyReporter(),
 
3768
                                   diff_writer=writer(sys.stdout))
 
3769
        shelver.run()
 
3770
 
 
3771
    def sanity_check_merger(self, merger):
 
3772
        if (merger.show_base and
 
3773
            not merger.merge_type is _mod_merge.Merge3Merger):
 
3774
            raise errors.BzrCommandError("Show-base is not supported for this"
 
3775
                                         " merge type. %s" % merger.merge_type)
 
3776
        if merger.reprocess is None:
 
3777
            if merger.show_base:
 
3778
                merger.reprocess = False
 
3779
            else:
 
3780
                # Use reprocess if the merger supports it
 
3781
                merger.reprocess = merger.merge_type.supports_reprocess
 
3782
        if merger.reprocess and not merger.merge_type.supports_reprocess:
 
3783
            raise errors.BzrCommandError("Conflict reduction is not supported"
 
3784
                                         " for merge type %s." %
 
3785
                                         merger.merge_type)
 
3786
        if merger.reprocess and merger.show_base:
 
3787
            raise errors.BzrCommandError("Cannot do conflict reduction and"
 
3788
                                         " show base.")
 
3789
 
 
3790
    def _get_merger_from_branch(self, tree, location, revision, remember,
 
3791
                                possible_transports, pb):
 
3792
        """Produce a merger from a location, assuming it refers to a branch."""
 
3793
        from bzrlib.tag import _merge_tags_if_possible
 
3794
        # find the branch locations
 
3795
        other_loc, user_location = self._select_branch_location(tree, location,
 
3796
            revision, -1)
 
3797
        if revision is not None and len(revision) == 2:
 
3798
            base_loc, _unused = self._select_branch_location(tree,
 
3799
                location, revision, 0)
 
3800
        else:
 
3801
            base_loc = other_loc
 
3802
        # Open the branches
 
3803
        other_branch, other_path = Branch.open_containing(other_loc,
 
3804
            possible_transports)
 
3805
        if base_loc == other_loc:
 
3806
            base_branch = other_branch
 
3807
        else:
 
3808
            base_branch, base_path = Branch.open_containing(base_loc,
 
3809
                possible_transports)
 
3810
        # Find the revision ids
 
3811
        other_revision_id = None
 
3812
        base_revision_id = None
 
3813
        if revision is not None:
 
3814
            if len(revision) >= 1:
 
3815
                other_revision_id = revision[-1].as_revision_id(other_branch)
 
3816
            if len(revision) == 2:
 
3817
                base_revision_id = revision[0].as_revision_id(base_branch)
 
3818
        if other_revision_id is None:
 
3819
            other_revision_id = _mod_revision.ensure_null(
 
3820
                other_branch.last_revision())
 
3821
        # Remember where we merge from
 
3822
        if ((remember or tree.branch.get_submit_branch() is None) and
 
3823
             user_location is not None):
 
3824
            tree.branch.set_submit_branch(other_branch.base)
 
3825
        _merge_tags_if_possible(other_branch, tree.branch)
 
3826
        merger = _mod_merge.Merger.from_revision_ids(pb, tree,
 
3827
            other_revision_id, base_revision_id, other_branch, base_branch)
 
3828
        if other_path != '':
 
3829
            allow_pending = False
 
3830
            merger.interesting_files = [other_path]
 
3831
        else:
 
3832
            allow_pending = True
 
3833
        return merger, allow_pending
 
3834
 
 
3835
    def get_merger_from_uncommitted(self, tree, location, pb, cleanups):
 
3836
        """Get a merger for uncommitted changes.
 
3837
 
 
3838
        :param tree: The tree the merger should apply to.
 
3839
        :param location: The location containing uncommitted changes.
 
3840
        :param pb: The progress bar to use for showing progress.
 
3841
        :param cleanups: A list of operations to perform to clean up the
 
3842
            temporary directories, unfinalized objects, etc.
 
3843
        """
 
3844
        location = self._select_branch_location(tree, location)[0]
 
3845
        other_tree, other_path = WorkingTree.open_containing(location)
 
3846
        merger = _mod_merge.Merger.from_uncommitted(tree, other_tree, pb)
 
3847
        if other_path != '':
 
3848
            merger.interesting_files = [other_path]
 
3849
        return merger
 
3850
 
 
3851
    def _select_branch_location(self, tree, user_location, revision=None,
 
3852
                                index=None):
 
3853
        """Select a branch location, according to possible inputs.
 
3854
 
 
3855
        If provided, branches from ``revision`` are preferred.  (Both
 
3856
        ``revision`` and ``index`` must be supplied.)
 
3857
 
 
3858
        Otherwise, the ``location`` parameter is used.  If it is None, then the
 
3859
        ``submit`` or ``parent`` location is used, and a note is printed.
 
3860
 
 
3861
        :param tree: The working tree to select a branch for merging into
 
3862
        :param location: The location entered by the user
 
3863
        :param revision: The revision parameter to the command
 
3864
        :param index: The index to use for the revision parameter.  Negative
 
3865
            indices are permitted.
 
3866
        :return: (selected_location, user_location).  The default location
 
3867
            will be the user-entered location.
 
3868
        """
 
3869
        if (revision is not None and index is not None
 
3870
            and revision[index] is not None):
 
3871
            branch = revision[index].get_branch()
 
3872
            if branch is not None:
 
3873
                return branch, branch
 
3874
        if user_location is None:
 
3875
            location = self._get_remembered(tree, 'Merging from')
 
3876
        else:
 
3877
            location = user_location
 
3878
        return location, user_location
 
3879
 
 
3880
    def _get_remembered(self, tree, verb_string):
2206
3881
        """Use tree.branch's parent if none was supplied.
2207
3882
 
2208
3883
        Report if the remembered location was used.
2209
3884
        """
2210
 
        if supplied_location is not None:
2211
 
            return supplied_location
2212
 
        stored_location = tree.branch.get_parent()
 
3885
        stored_location = tree.branch.get_submit_branch()
 
3886
        stored_location_type = "submit"
 
3887
        if stored_location is None:
 
3888
            stored_location = tree.branch.get_parent()
 
3889
            stored_location_type = "parent"
2213
3890
        mutter("%s", stored_location)
2214
3891
        if stored_location is None:
2215
 
            raise BzrCommandError("No location specified or remembered")
2216
 
        display_url = urlutils.unescape_for_display(stored_location, self.outf.encoding)
2217
 
        self.outf.write("%s remembered location %s\n" % (verb_string, display_url))
 
3892
            raise errors.BzrCommandError("No location specified or remembered")
 
3893
        display_url = urlutils.unescape_for_display(stored_location, 'utf-8')
 
3894
        note(u"%s remembered %s location %s", verb_string,
 
3895
                stored_location_type, display_url)
2218
3896
        return stored_location
2219
3897
 
2220
3898
 
2222
3900
    """Redo a merge.
2223
3901
 
2224
3902
    Use this if you want to try a different merge technique while resolving
2225
 
    conflicts.  Some merge techniques are better than others, and remerge 
 
3903
    conflicts.  Some merge techniques are better than others, and remerge
2226
3904
    lets you try different ones on different files.
2227
3905
 
2228
3906
    The options for remerge have the same meaning and defaults as the ones for
2229
3907
    merge.  The difference is that remerge can (only) be run when there is a
2230
3908
    pending merge, and it lets you specify particular files.
2231
3909
 
2232
 
    Examples:
2233
 
    $ bzr remerge --show-base
 
3910
    :Examples:
2234
3911
        Re-do the merge of all conflicted files, and show the base text in
2235
 
        conflict regions, in addition to the usual THIS and OTHER texts.
2236
 
 
2237
 
    $ bzr remerge --merge-type weave --reprocess foobar
 
3912
        conflict regions, in addition to the usual THIS and OTHER texts::
 
3913
 
 
3914
            bzr remerge --show-base
 
3915
 
2238
3916
        Re-do the merge of "foobar", using the weave merge algorithm, with
2239
 
        additional processing to reduce the size of conflict regions.
2240
 
    
2241
 
    The following merge types are available:"""
 
3917
        additional processing to reduce the size of conflict regions::
 
3918
 
 
3919
            bzr remerge --merge-type weave --reprocess foobar
 
3920
    """
2242
3921
    takes_args = ['file*']
2243
 
    takes_options = ['merge-type', 'reprocess',
2244
 
                     Option('show-base', help="Show base revision text in "
2245
 
                            "conflicts")]
2246
 
 
2247
 
    def help(self):
2248
 
        from merge import merge_type_help
2249
 
        from inspect import getdoc
2250
 
        return getdoc(self) + '\n' + merge_type_help() 
 
3922
    takes_options = [
 
3923
            'merge-type',
 
3924
            'reprocess',
 
3925
            Option('show-base',
 
3926
                   help="Show base revision text in conflicts."),
 
3927
            ]
2251
3928
 
2252
3929
    def run(self, file_list=None, merge_type=None, show_base=False,
2253
3930
            reprocess=False):
2254
 
        from bzrlib.merge import merge_inner, transform_tree
2255
3931
        if merge_type is None:
2256
 
            merge_type = Merge3Merger
 
3932
            merge_type = _mod_merge.Merge3Merger
2257
3933
        tree, file_list = tree_files(file_list)
2258
3934
        tree.lock_write()
2259
3935
        try:
2260
 
            pending_merges = tree.pending_merges() 
2261
 
            if len(pending_merges) != 1:
2262
 
                raise BzrCommandError("Sorry, remerge only works after normal"
2263
 
                                      " merges.  Not cherrypicking or"
2264
 
                                      " multi-merges.")
 
3936
            parents = tree.get_parent_ids()
 
3937
            if len(parents) != 2:
 
3938
                raise errors.BzrCommandError("Sorry, remerge only works after normal"
 
3939
                                             " merges.  Not cherrypicking or"
 
3940
                                             " multi-merges.")
2265
3941
            repository = tree.branch.repository
2266
 
            base_revision = common_ancestor(tree.branch.last_revision(), 
2267
 
                                            pending_merges[0], repository)
2268
 
            base_tree = repository.revision_tree(base_revision)
2269
 
            other_tree = repository.revision_tree(pending_merges[0])
2270
3942
            interesting_ids = None
2271
3943
            new_conflicts = []
2272
3944
            conflicts = tree.conflicts()
2275
3947
                for filename in file_list:
2276
3948
                    file_id = tree.path2id(filename)
2277
3949
                    if file_id is None:
2278
 
                        raise NotVersionedError(filename)
 
3950
                        raise errors.NotVersionedError(filename)
2279
3951
                    interesting_ids.add(file_id)
2280
3952
                    if tree.kind(file_id) != "directory":
2281
3953
                        continue
2282
 
                    
 
3954
 
2283
3955
                    for name, ie in tree.inventory.iter_entries(file_id):
2284
3956
                        interesting_ids.add(ie.file_id)
2285
3957
                new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
2286
 
            transform_tree(tree, tree.basis_tree(), interesting_ids)
 
3958
            else:
 
3959
                # Remerge only supports resolving contents conflicts
 
3960
                allowed_conflicts = ('text conflict', 'contents conflict')
 
3961
                restore_files = [c.path for c in conflicts
 
3962
                                 if c.typestring in allowed_conflicts]
 
3963
            _mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
2287
3964
            tree.set_conflicts(ConflictList(new_conflicts))
2288
 
            if file_list is None:
2289
 
                restore_files = list(tree.iter_conflicts())
2290
 
            else:
 
3965
            if file_list is not None:
2291
3966
                restore_files = file_list
2292
3967
            for filename in restore_files:
2293
3968
                try:
2294
3969
                    restore(tree.abspath(filename))
2295
 
                except NotConflicted:
 
3970
                except errors.NotConflicted:
2296
3971
                    pass
2297
 
            conflicts = merge_inner(tree.branch, other_tree, base_tree,
2298
 
                                    this_tree=tree,
2299
 
                                    interesting_ids=interesting_ids, 
2300
 
                                    other_rev_id=pending_merges[0], 
2301
 
                                    merge_type=merge_type, 
2302
 
                                    show_base=show_base,
2303
 
                                    reprocess=reprocess)
 
3972
            # Disable pending merges, because the file texts we are remerging
 
3973
            # have not had those merges performed.  If we use the wrong parents
 
3974
            # list, we imply that the working tree text has seen and rejected
 
3975
            # all the changes from the other tree, when in fact those changes
 
3976
            # have not yet been seen.
 
3977
            pb = ui.ui_factory.nested_progress_bar()
 
3978
            tree.set_parent_ids(parents[:1])
 
3979
            try:
 
3980
                merger = _mod_merge.Merger.from_revision_ids(pb,
 
3981
                                                             tree, parents[1])
 
3982
                merger.interesting_ids = interesting_ids
 
3983
                merger.merge_type = merge_type
 
3984
                merger.show_base = show_base
 
3985
                merger.reprocess = reprocess
 
3986
                conflicts = merger.do_merge()
 
3987
            finally:
 
3988
                tree.set_parent_ids(parents)
 
3989
                pb.finished()
2304
3990
        finally:
2305
3991
            tree.unlock()
2306
3992
        if conflicts > 0:
2308
3994
        else:
2309
3995
            return 0
2310
3996
 
 
3997
 
2311
3998
class cmd_revert(Command):
2312
 
    """Reverse all changes since the last commit.
2313
 
 
2314
 
    Only versioned files are affected.  Specify filenames to revert only 
2315
 
    those files.  By default, any files that are changed will be backed up
2316
 
    first.  Backup files have a '~' appended to their name.
 
3999
    """Revert files to a previous revision.
 
4000
 
 
4001
    Giving a list of files will revert only those files.  Otherwise, all files
 
4002
    will be reverted.  If the revision is not specified with '--revision', the
 
4003
    last committed revision is used.
 
4004
 
 
4005
    To remove only some changes, without reverting to a prior version, use
 
4006
    merge instead.  For example, "merge . --revision -2..-3" will remove the
 
4007
    changes introduced by -2, without affecting the changes introduced by -1.
 
4008
    Or to remove certain changes on a hunk-by-hunk basis, see the Shelf plugin.
 
4009
 
 
4010
    By default, any files that have been manually changed will be backed up
 
4011
    first.  (Files changed only by merge are not backed up.)  Backup files have
 
4012
    '.~#~' appended to their name, where # is a number.
 
4013
 
 
4014
    When you provide files, you can use their current pathname or the pathname
 
4015
    from the target revision.  So you can use revert to "undelete" a file by
 
4016
    name.  If you name a directory, all the contents of that directory will be
 
4017
    reverted.
 
4018
 
 
4019
    Any files that have been newly added since that revision will be deleted,
 
4020
    with a backup kept if appropriate.  Directories containing unknown files
 
4021
    will not be deleted.
 
4022
 
 
4023
    The working tree contains a list of pending merged revisions, which will
 
4024
    be included as parents in the next commit.  Normally, revert clears that
 
4025
    list as well as reverting the files.  If any files are specified, revert
 
4026
    leaves the pending merge list alone and reverts only the files.  Use "bzr
 
4027
    revert ." in the tree root to revert all files but keep the merge record,
 
4028
    and "bzr revert --forget-merges" to clear the pending merge list without
 
4029
    reverting any files.
2317
4030
    """
2318
 
    takes_options = ['revision', 'no-backup']
 
4031
 
 
4032
    _see_also = ['cat', 'export']
 
4033
    takes_options = [
 
4034
        'revision',
 
4035
        Option('no-backup', "Do not save backups of reverted files."),
 
4036
        Option('forget-merges',
 
4037
               'Remove pending merge marker, without changing any files.'),
 
4038
        ]
2319
4039
    takes_args = ['file*']
2320
 
    aliases = ['merge-revert']
2321
4040
 
2322
 
    def run(self, revision=None, no_backup=False, file_list=None):
2323
 
        from bzrlib.commands import parse_spec
2324
 
        if file_list is not None:
2325
 
            if len(file_list) == 0:
2326
 
                raise BzrCommandError("No files specified")
2327
 
        else:
2328
 
            file_list = []
2329
 
        
 
4041
    def run(self, revision=None, no_backup=False, file_list=None,
 
4042
            forget_merges=None):
2330
4043
        tree, file_list = tree_files(file_list)
2331
 
        if revision is None:
2332
 
            # FIXME should be tree.last_revision
2333
 
            rev_id = tree.last_revision()
2334
 
        elif len(revision) != 1:
2335
 
            raise BzrCommandError('bzr revert --revision takes exactly 1 argument')
2336
 
        else:
2337
 
            rev_id = revision[0].in_history(tree.branch).rev_id
 
4044
        tree.lock_write()
 
4045
        try:
 
4046
            if forget_merges:
 
4047
                tree.set_parent_ids(tree.get_parent_ids()[:1])
 
4048
            else:
 
4049
                self._revert_tree_to_revision(tree, revision, file_list, no_backup)
 
4050
        finally:
 
4051
            tree.unlock()
 
4052
 
 
4053
    @staticmethod
 
4054
    def _revert_tree_to_revision(tree, revision, file_list, no_backup):
 
4055
        rev_tree = _get_one_revision_tree('revert', revision, tree=tree)
2338
4056
        pb = ui.ui_factory.nested_progress_bar()
2339
4057
        try:
2340
 
            tree.revert(file_list, 
2341
 
                        tree.branch.repository.revision_tree(rev_id),
2342
 
                        not no_backup, pb)
 
4058
            tree.revert(file_list, rev_tree, not no_backup, pb,
 
4059
                report_changes=True)
2343
4060
        finally:
2344
4061
            pb.finished()
2345
4062
 
2346
4063
 
2347
4064
class cmd_assert_fail(Command):
2348
4065
    """Test reporting of assertion failures"""
 
4066
    # intended just for use in testing
 
4067
 
2349
4068
    hidden = True
 
4069
 
2350
4070
    def run(self):
2351
 
        assert False, "always fails"
 
4071
        raise AssertionError("always fails")
2352
4072
 
2353
4073
 
2354
4074
class cmd_help(Command):
2355
4075
    """Show help on a command or other topic.
 
4076
    """
2356
4077
 
2357
 
    For a list of all available commands, say 'bzr help commands'."""
2358
 
    takes_options = [Option('long', 'show help on all commands')]
 
4078
    _see_also = ['topics']
 
4079
    takes_options = [
 
4080
            Option('long', 'Show help on all commands.'),
 
4081
            ]
2359
4082
    takes_args = ['topic?']
2360
4083
    aliases = ['?', '--help', '-?', '-h']
2361
 
    
 
4084
 
2362
4085
    @display_command
2363
4086
    def run(self, topic=None, long=False):
2364
 
        import help
 
4087
        import bzrlib.help
2365
4088
        if topic is None and long:
2366
4089
            topic = "commands"
2367
 
        help.help(topic)
 
4090
        bzrlib.help.help(topic)
2368
4091
 
2369
4092
 
2370
4093
class cmd_shell_complete(Command):
2371
4094
    """Show appropriate completions for context.
2372
4095
 
2373
 
    For a list of all available commands, say 'bzr shell-complete'."""
 
4096
    For a list of all available commands, say 'bzr shell-complete'.
 
4097
    """
2374
4098
    takes_args = ['context?']
2375
4099
    aliases = ['s-c']
2376
4100
    hidden = True
2377
 
    
 
4101
 
2378
4102
    @display_command
2379
4103
    def run(self, context=None):
2380
4104
        import shellcomplete
2381
4105
        shellcomplete.shellcomplete(context)
2382
4106
 
2383
4107
 
2384
 
class cmd_fetch(Command):
2385
 
    """Copy in history from another branch but don't merge it.
2386
 
 
2387
 
    This is an internal method used for pull and merge."""
2388
 
    hidden = True
2389
 
    takes_args = ['from_branch', 'to_branch']
2390
 
    def run(self, from_branch, to_branch):
2391
 
        from bzrlib.fetch import Fetcher
2392
 
        from_b = Branch.open(from_branch)
2393
 
        to_b = Branch.open(to_branch)
2394
 
        Fetcher(to_b, from_b)
2395
 
 
2396
 
 
2397
4108
class cmd_missing(Command):
2398
4109
    """Show unmerged/unpulled revisions between two branches.
2399
4110
 
2400
 
    OTHER_BRANCH may be local or remote."""
 
4111
    OTHER_BRANCH may be local or remote.
 
4112
 
 
4113
    To filter on a range of revisions, you can use the command -r begin..end
 
4114
    -r revision requests a specific revision, -r ..end or -r begin.. are
 
4115
    also valid.
 
4116
 
 
4117
    :Examples:
 
4118
 
 
4119
        Determine the missing revisions between this and the branch at the
 
4120
        remembered pull location::
 
4121
 
 
4122
            bzr missing
 
4123
 
 
4124
        Determine the missing revisions between this and another branch::
 
4125
 
 
4126
            bzr missing http://server/branch
 
4127
 
 
4128
        Determine the missing revisions up to a specific revision on the other
 
4129
        branch::
 
4130
 
 
4131
            bzr missing -r ..-10
 
4132
 
 
4133
        Determine the missing revisions up to a specific revision on this
 
4134
        branch::
 
4135
 
 
4136
            bzr missing --my-revision ..-10
 
4137
    """
 
4138
 
 
4139
    _see_also = ['merge', 'pull']
2401
4140
    takes_args = ['other_branch?']
2402
 
    takes_options = [Option('reverse', 'Reverse the order of revisions'),
2403
 
                     Option('mine-only', 
2404
 
                            'Display changes in the local branch only'),
2405
 
                     Option('theirs-only', 
2406
 
                            'Display changes in the remote branch only'), 
2407
 
                     'log-format',
2408
 
                     'line',
2409
 
                     'long', 
2410
 
                     'short',
2411
 
                     'show-ids',
2412
 
                     'verbose'
2413
 
                     ]
 
4141
    takes_options = [
 
4142
        Option('reverse', 'Reverse the order of revisions.'),
 
4143
        Option('mine-only',
 
4144
               'Display changes in the local branch only.'),
 
4145
        Option('this' , 'Same as --mine-only.'),
 
4146
        Option('theirs-only',
 
4147
               'Display changes in the remote branch only.'),
 
4148
        Option('other', 'Same as --theirs-only.'),
 
4149
        'log-format',
 
4150
        'show-ids',
 
4151
        'verbose',
 
4152
        custom_help('revision',
 
4153
             help='Filter on other branch revisions (inclusive). '
 
4154
                'See "help revisionspec" for details.'),
 
4155
        Option('my-revision',
 
4156
            type=_parse_revision_str,
 
4157
            help='Filter on local branch revisions (inclusive). '
 
4158
                'See "help revisionspec" for details.'),
 
4159
        Option('include-merges',
 
4160
               'Show all revisions in addition to the mainline ones.'),
 
4161
        ]
2414
4162
    encoding_type = 'replace'
2415
4163
 
2416
4164
    @display_command
2417
4165
    def run(self, other_branch=None, reverse=False, mine_only=False,
2418
 
            theirs_only=False, log_format=None, long=False, short=False, line=False, 
2419
 
            show_ids=False, verbose=False):
2420
 
        from bzrlib.missing import find_unmerged, iter_log_data
2421
 
        from bzrlib.log import log_formatter
 
4166
            theirs_only=False,
 
4167
            log_format=None, long=False, short=False, line=False,
 
4168
            show_ids=False, verbose=False, this=False, other=False,
 
4169
            include_merges=False, revision=None, my_revision=None):
 
4170
        from bzrlib.missing import find_unmerged, iter_log_revisions
 
4171
        def message(s):
 
4172
            if not is_quiet():
 
4173
                self.outf.write(s)
 
4174
 
 
4175
        if this:
 
4176
            mine_only = this
 
4177
        if other:
 
4178
            theirs_only = other
 
4179
        # TODO: We should probably check that we don't have mine-only and
 
4180
        #       theirs-only set, but it gets complicated because we also have
 
4181
        #       this and other which could be used.
 
4182
        restrict = 'all'
 
4183
        if mine_only:
 
4184
            restrict = 'local'
 
4185
        elif theirs_only:
 
4186
            restrict = 'remote'
 
4187
 
2422
4188
        local_branch = Branch.open_containing(u".")[0]
2423
4189
        parent = local_branch.get_parent()
2424
4190
        if other_branch is None:
2425
4191
            other_branch = parent
2426
4192
            if other_branch is None:
2427
 
                raise BzrCommandError("No peer location known or specified.")
2428
 
            print "Using last location: " + local_branch.get_parent()
 
4193
                raise errors.BzrCommandError("No peer location known"
 
4194
                                             " or specified.")
 
4195
            display_url = urlutils.unescape_for_display(parent,
 
4196
                                                        self.outf.encoding)
 
4197
            message("Using saved parent location: "
 
4198
                    + display_url + "\n")
 
4199
 
2429
4200
        remote_branch = Branch.open(other_branch)
2430
4201
        if remote_branch.base == local_branch.base:
2431
4202
            remote_branch = local_branch
 
4203
 
 
4204
        local_revid_range = _revision_range_to_revid_range(
 
4205
            _get_revision_range(my_revision, local_branch,
 
4206
                self.name()))
 
4207
 
 
4208
        remote_revid_range = _revision_range_to_revid_range(
 
4209
            _get_revision_range(revision,
 
4210
                remote_branch, self.name()))
 
4211
 
2432
4212
        local_branch.lock_read()
2433
4213
        try:
2434
4214
            remote_branch.lock_read()
2435
4215
            try:
2436
 
                local_extra, remote_extra = find_unmerged(local_branch, remote_branch)
2437
 
                if (log_format == None):
2438
 
                    default = local_branch.get_config().log_format()
2439
 
                    log_format = get_log_format(long=long, short=short, 
2440
 
                                                line=line, default=default)
2441
 
                lf = log_formatter(log_format,
2442
 
                                   to_file=self.outf,
2443
 
                                   show_ids=show_ids,
2444
 
                                   show_timezone='original')
2445
 
                if reverse is False:
2446
 
                    local_extra.reverse()
2447
 
                    remote_extra.reverse()
 
4216
                local_extra, remote_extra = find_unmerged(
 
4217
                    local_branch, remote_branch, restrict,
 
4218
                    backward=not reverse,
 
4219
                    include_merges=include_merges,
 
4220
                    local_revid_range=local_revid_range,
 
4221
                    remote_revid_range=remote_revid_range)
 
4222
 
 
4223
                if log_format is None:
 
4224
                    registry = log.log_formatter_registry
 
4225
                    log_format = registry.get_default(local_branch)
 
4226
                lf = log_format(to_file=self.outf,
 
4227
                                show_ids=show_ids,
 
4228
                                show_timezone='original')
 
4229
 
 
4230
                status_code = 0
2448
4231
                if local_extra and not theirs_only:
2449
 
                    print "You have %d extra revision(s):" % len(local_extra)
2450
 
                    for data in iter_log_data(local_extra, local_branch.repository,
2451
 
                                              verbose):
2452
 
                        lf.show(*data)
 
4232
                    message("You have %d extra revision(s):\n" %
 
4233
                        len(local_extra))
 
4234
                    for revision in iter_log_revisions(local_extra,
 
4235
                                        local_branch.repository,
 
4236
                                        verbose):
 
4237
                        lf.log_revision(revision)
2453
4238
                    printed_local = True
 
4239
                    status_code = 1
2454
4240
                else:
2455
4241
                    printed_local = False
 
4242
 
2456
4243
                if remote_extra and not mine_only:
2457
4244
                    if printed_local is True:
2458
 
                        print "\n\n"
2459
 
                    print "You are missing %d revision(s):" % len(remote_extra)
2460
 
                    for data in iter_log_data(remote_extra, remote_branch.repository, 
2461
 
                                              verbose):
2462
 
                        lf.show(*data)
2463
 
                if not remote_extra and not local_extra:
2464
 
                    status_code = 0
2465
 
                    print "Branches are up to date."
2466
 
                else:
 
4245
                        message("\n\n\n")
 
4246
                    message("You are missing %d revision(s):\n" %
 
4247
                        len(remote_extra))
 
4248
                    for revision in iter_log_revisions(remote_extra,
 
4249
                                        remote_branch.repository,
 
4250
                                        verbose):
 
4251
                        lf.log_revision(revision)
2467
4252
                    status_code = 1
 
4253
 
 
4254
                if mine_only and not local_extra:
 
4255
                    # We checked local, and found nothing extra
 
4256
                    message('This branch is up to date.\n')
 
4257
                elif theirs_only and not remote_extra:
 
4258
                    # We checked remote, and found nothing extra
 
4259
                    message('Other branch is up to date.\n')
 
4260
                elif not (mine_only or theirs_only or local_extra or
 
4261
                          remote_extra):
 
4262
                    # We checked both branches, and neither one had extra
 
4263
                    # revisions
 
4264
                    message("Branches are up to date.\n")
2468
4265
            finally:
2469
4266
                remote_branch.unlock()
2470
4267
        finally:
2480
4277
        return status_code
2481
4278
 
2482
4279
 
 
4280
class cmd_pack(Command):
 
4281
    """Compress the data within a repository."""
 
4282
 
 
4283
    _see_also = ['repositories']
 
4284
    takes_args = ['branch_or_repo?']
 
4285
 
 
4286
    def run(self, branch_or_repo='.'):
 
4287
        dir = bzrdir.BzrDir.open_containing(branch_or_repo)[0]
 
4288
        try:
 
4289
            branch = dir.open_branch()
 
4290
            repository = branch.repository
 
4291
        except errors.NotBranchError:
 
4292
            repository = dir.open_repository()
 
4293
        repository.pack()
 
4294
 
 
4295
 
2483
4296
class cmd_plugins(Command):
2484
 
    """List plugins"""
2485
 
    hidden = True
 
4297
    """List the installed plugins.
 
4298
 
 
4299
    This command displays the list of installed plugins including
 
4300
    version of plugin and a short description of each.
 
4301
 
 
4302
    --verbose shows the path where each plugin is located.
 
4303
 
 
4304
    A plugin is an external component for Bazaar that extends the
 
4305
    revision control system, by adding or replacing code in Bazaar.
 
4306
    Plugins can do a variety of things, including overriding commands,
 
4307
    adding new commands, providing additional network transports and
 
4308
    customizing log output.
 
4309
 
 
4310
    See the Bazaar web site, http://bazaar-vcs.org, for further
 
4311
    information on plugins including where to find them and how to
 
4312
    install them. Instructions are also provided there on how to
 
4313
    write new plugins using the Python programming language.
 
4314
    """
 
4315
    takes_options = ['verbose']
 
4316
 
2486
4317
    @display_command
2487
 
    def run(self):
 
4318
    def run(self, verbose=False):
2488
4319
        import bzrlib.plugin
2489
4320
        from inspect import getdoc
2490
 
        for name, plugin in bzrlib.plugin.all_plugins().items():
2491
 
            if hasattr(plugin, '__path__'):
2492
 
                print plugin.__path__[0]
2493
 
            elif hasattr(plugin, '__file__'):
2494
 
                print plugin.__file__
2495
 
            else:
2496
 
                print `plugin`
2497
 
                
2498
 
            d = getdoc(plugin)
 
4321
        result = []
 
4322
        for name, plugin in bzrlib.plugin.plugins().items():
 
4323
            version = plugin.__version__
 
4324
            if version == 'unknown':
 
4325
                version = ''
 
4326
            name_ver = '%s %s' % (name, version)
 
4327
            d = getdoc(plugin.module)
2499
4328
            if d:
2500
 
                print '\t', d.split('\n')[0]
 
4329
                doc = d.split('\n')[0]
 
4330
            else:
 
4331
                doc = '(no description)'
 
4332
            result.append((name_ver, doc, plugin.path()))
 
4333
        for name_ver, doc, path in sorted(result):
 
4334
            print name_ver
 
4335
            print '   ', doc
 
4336
            if verbose:
 
4337
                print '   ', path
 
4338
            print
2501
4339
 
2502
4340
 
2503
4341
class cmd_testament(Command):
2504
4342
    """Show testament (signing-form) of a revision."""
2505
 
    takes_options = ['revision', 'long', 
2506
 
                     Option('strict', help='Produce a strict-format'
2507
 
                            ' testament')]
 
4343
    takes_options = [
 
4344
            'revision',
 
4345
            Option('long', help='Produce long-format testament.'),
 
4346
            Option('strict',
 
4347
                   help='Produce a strict-format testament.')]
2508
4348
    takes_args = ['branch?']
2509
4349
    @display_command
2510
4350
    def run(self, branch=u'.', revision=None, long=False, strict=False):
2513
4353
            testament_class = StrictTestament
2514
4354
        else:
2515
4355
            testament_class = Testament
2516
 
        b = WorkingTree.open_containing(branch)[0].branch
 
4356
        if branch == '.':
 
4357
            b = Branch.open_containing(branch)[0]
 
4358
        else:
 
4359
            b = Branch.open(branch)
2517
4360
        b.lock_read()
2518
4361
        try:
2519
4362
            if revision is None:
2520
4363
                rev_id = b.last_revision()
2521
4364
            else:
2522
 
                rev_id = revision[0].in_history(b).rev_id
 
4365
                rev_id = revision[0].as_revision_id(b)
2523
4366
            t = testament_class.from_revision(b.repository, rev_id)
2524
4367
            if long:
2525
4368
                sys.stdout.writelines(t.as_text_lines())
2535
4378
    This prints out the given file with an annotation on the left side
2536
4379
    indicating which revision, author and date introduced the change.
2537
4380
 
2538
 
    If the origin is the same for a run of consecutive lines, it is 
 
4381
    If the origin is the same for a run of consecutive lines, it is
2539
4382
    shown only at the top, unless the --all option is given.
2540
4383
    """
2541
4384
    # TODO: annotate directories; showing when each file was last changed
2542
 
    # TODO: if the working copy is modified, show annotations on that 
 
4385
    # TODO: if the working copy is modified, show annotations on that
2543
4386
    #       with new uncommitted lines marked
2544
4387
    aliases = ['ann', 'blame', 'praise']
2545
4388
    takes_args = ['filename']
2546
 
    takes_options = [Option('all', help='show annotations on all lines'),
2547
 
                     Option('long', help='show date in annotations'),
2548
 
                     'revision'
 
4389
    takes_options = [Option('all', help='Show annotations on all lines.'),
 
4390
                     Option('long', help='Show commit date in annotations.'),
 
4391
                     'revision',
 
4392
                     'show-ids',
2549
4393
                     ]
 
4394
    encoding_type = 'exact'
2550
4395
 
2551
4396
    @display_command
2552
 
    def run(self, filename, all=False, long=False, revision=None):
2553
 
        from bzrlib.annotate import annotate_file
2554
 
        tree, relpath = WorkingTree.open_containing(filename)
2555
 
        branch = tree.branch
2556
 
        branch.lock_read()
 
4397
    def run(self, filename, all=False, long=False, revision=None,
 
4398
            show_ids=False):
 
4399
        from bzrlib.annotate import annotate_file, annotate_file_tree
 
4400
        wt, branch, relpath = \
 
4401
            bzrdir.BzrDir.open_containing_tree_or_branch(filename)
 
4402
        if wt is not None:
 
4403
            wt.lock_read()
 
4404
        else:
 
4405
            branch.lock_read()
2557
4406
        try:
2558
 
            if revision is None:
2559
 
                revision_id = branch.last_revision()
2560
 
            elif len(revision) != 1:
2561
 
                raise BzrCommandError('bzr annotate --revision takes exactly 1 argument')
 
4407
            tree = _get_one_revision_tree('annotate', revision, branch=branch)
 
4408
            if wt is not None:
 
4409
                file_id = wt.path2id(relpath)
2562
4410
            else:
2563
 
                revision_id = revision[0].in_history(branch).rev_id
2564
 
            file_id = tree.inventory.path2id(relpath)
2565
 
            tree = branch.repository.revision_tree(revision_id)
 
4411
                file_id = tree.path2id(relpath)
 
4412
            if file_id is None:
 
4413
                raise errors.NotVersionedError(filename)
2566
4414
            file_version = tree.inventory[file_id].revision
2567
 
            annotate_file(branch, file_version, file_id, long, all, sys.stdout)
 
4415
            if wt is not None and revision is None:
 
4416
                # If there is a tree and we're not annotating historical
 
4417
                # versions, annotate the working tree's content.
 
4418
                annotate_file_tree(wt, file_id, self.outf, long, all,
 
4419
                    show_ids=show_ids)
 
4420
            else:
 
4421
                annotate_file(branch, file_version, file_id, long, all, self.outf,
 
4422
                              show_ids=show_ids)
2568
4423
        finally:
2569
 
            branch.unlock()
 
4424
            if wt is not None:
 
4425
                wt.unlock()
 
4426
            else:
 
4427
                branch.unlock()
2570
4428
 
2571
4429
 
2572
4430
class cmd_re_sign(Command):
2576
4434
    hidden = True # is this right ?
2577
4435
    takes_args = ['revision_id*']
2578
4436
    takes_options = ['revision']
2579
 
    
 
4437
 
2580
4438
    def run(self, revision_id_list=None, revision=None):
2581
 
        import bzrlib.gpg as gpg
2582
4439
        if revision_id_list is not None and revision is not None:
2583
 
            raise BzrCommandError('You can only supply one of revision_id or --revision')
 
4440
            raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
2584
4441
        if revision_id_list is None and revision is None:
2585
 
            raise BzrCommandError('You must supply either --revision or a revision_id')
 
4442
            raise errors.BzrCommandError('You must supply either --revision or a revision_id')
2586
4443
        b = WorkingTree.open_containing(u'.')[0].branch
 
4444
        b.lock_write()
 
4445
        try:
 
4446
            return self._run(b, revision_id_list, revision)
 
4447
        finally:
 
4448
            b.unlock()
 
4449
 
 
4450
    def _run(self, b, revision_id_list, revision):
 
4451
        import bzrlib.gpg as gpg
2587
4452
        gpg_strategy = gpg.GPGStrategy(b.get_config())
2588
4453
        if revision_id_list is not None:
2589
 
            for revision_id in revision_id_list:
2590
 
                b.repository.sign_revision(revision_id, gpg_strategy)
 
4454
            b.repository.start_write_group()
 
4455
            try:
 
4456
                for revision_id in revision_id_list:
 
4457
                    b.repository.sign_revision(revision_id, gpg_strategy)
 
4458
            except:
 
4459
                b.repository.abort_write_group()
 
4460
                raise
 
4461
            else:
 
4462
                b.repository.commit_write_group()
2591
4463
        elif revision is not None:
2592
4464
            if len(revision) == 1:
2593
4465
                revno, rev_id = revision[0].in_history(b)
2594
 
                b.repository.sign_revision(rev_id, gpg_strategy)
 
4466
                b.repository.start_write_group()
 
4467
                try:
 
4468
                    b.repository.sign_revision(rev_id, gpg_strategy)
 
4469
                except:
 
4470
                    b.repository.abort_write_group()
 
4471
                    raise
 
4472
                else:
 
4473
                    b.repository.commit_write_group()
2595
4474
            elif len(revision) == 2:
2596
4475
                # are they both on rh- if so we can walk between them
2597
4476
                # might be nice to have a range helper for arbitrary
2601
4480
                if to_revid is None:
2602
4481
                    to_revno = b.revno()
2603
4482
                if from_revno is None or to_revno is None:
2604
 
                    raise BzrCommandError('Cannot sign a range of non-revision-history revisions')
2605
 
                for revno in range(from_revno, to_revno + 1):
2606
 
                    b.repository.sign_revision(b.get_rev_id(revno), 
2607
 
                                               gpg_strategy)
 
4483
                    raise errors.BzrCommandError('Cannot sign a range of non-revision-history revisions')
 
4484
                b.repository.start_write_group()
 
4485
                try:
 
4486
                    for revno in range(from_revno, to_revno + 1):
 
4487
                        b.repository.sign_revision(b.get_rev_id(revno),
 
4488
                                                   gpg_strategy)
 
4489
                except:
 
4490
                    b.repository.abort_write_group()
 
4491
                    raise
 
4492
                else:
 
4493
                    b.repository.commit_write_group()
2608
4494
            else:
2609
 
                raise BzrCommandError('Please supply either one revision, or a range.')
 
4495
                raise errors.BzrCommandError('Please supply either one revision, or a range.')
2610
4496
 
2611
4497
 
2612
4498
class cmd_bind(Command):
2613
 
    """Bind the current branch to a master branch.
2614
 
 
2615
 
    After binding, commits must succeed on the master branch
2616
 
    before they are executed on the local one.
 
4499
    """Convert the current branch into a checkout of the supplied branch.
 
4500
 
 
4501
    Once converted into a checkout, commits must succeed on the master branch
 
4502
    before they will be applied to the local branch.
 
4503
 
 
4504
    Bound branches use the nickname of its master branch unless it is set
 
4505
    locally, in which case binding will update the the local nickname to be
 
4506
    that of the master.
2617
4507
    """
2618
4508
 
2619
 
    takes_args = ['location']
 
4509
    _see_also = ['checkouts', 'unbind']
 
4510
    takes_args = ['location?']
2620
4511
    takes_options = []
2621
4512
 
2622
4513
    def run(self, location=None):
2623
4514
        b, relpath = Branch.open_containing(u'.')
 
4515
        if location is None:
 
4516
            try:
 
4517
                location = b.get_old_bound_location()
 
4518
            except errors.UpgradeRequired:
 
4519
                raise errors.BzrCommandError('No location supplied.  '
 
4520
                    'This format does not remember old locations.')
 
4521
            else:
 
4522
                if location is None:
 
4523
                    raise errors.BzrCommandError('No location supplied and no '
 
4524
                        'previous location known')
2624
4525
        b_other = Branch.open(location)
2625
4526
        try:
2626
4527
            b.bind(b_other)
2627
 
        except DivergedBranches:
2628
 
            raise BzrCommandError('These branches have diverged.'
2629
 
                                  ' Try merging, and then bind again.')
 
4528
        except errors.DivergedBranches:
 
4529
            raise errors.BzrCommandError('These branches have diverged.'
 
4530
                                         ' Try merging, and then bind again.')
 
4531
        if b.get_config().has_explicit_nickname():
 
4532
            b.nick = b_other.nick
2630
4533
 
2631
4534
 
2632
4535
class cmd_unbind(Command):
2633
 
    """Unbind the current branch from its master branch.
 
4536
    """Convert the current checkout into a regular branch.
2634
4537
 
2635
 
    After unbinding, the local branch is considered independent.
2636
 
    All subsequent commits will be local.
 
4538
    After unbinding, the local branch is considered independent and subsequent
 
4539
    commits will be local only.
2637
4540
    """
2638
4541
 
 
4542
    _see_also = ['checkouts', 'bind']
2639
4543
    takes_args = []
2640
4544
    takes_options = []
2641
4545
 
2642
4546
    def run(self):
2643
4547
        b, relpath = Branch.open_containing(u'.')
2644
4548
        if not b.unbind():
2645
 
            raise BzrCommandError('Local branch is not bound')
 
4549
            raise errors.BzrCommandError('Local branch is not bound')
2646
4550
 
2647
4551
 
2648
4552
class cmd_uncommit(Command):
2651
4555
    --verbose will print out what is being removed.
2652
4556
    --dry-run will go through all the motions, but not actually
2653
4557
    remove anything.
2654
 
    
2655
 
    In the future, uncommit will create a revision bundle, which can then
2656
 
    be re-applied.
 
4558
 
 
4559
    If --revision is specified, uncommit revisions to leave the branch at the
 
4560
    specified revision.  For example, "bzr uncommit -r 15" will leave the
 
4561
    branch at revision 15.
 
4562
 
 
4563
    Uncommit leaves the working tree ready for a new commit.  The only change
 
4564
    it may make is to restore any pending merges that were present before
 
4565
    the commit.
2657
4566
    """
2658
4567
 
2659
4568
    # TODO: jam 20060108 Add an option to allow uncommit to remove
2660
4569
    # unreferenced information in 'branch-as-repository' branches.
2661
4570
    # TODO: jam 20060108 Add the ability for uncommit to remove unreferenced
2662
4571
    # information in shared branches as well.
 
4572
    _see_also = ['commit']
2663
4573
    takes_options = ['verbose', 'revision',
2664
 
                    Option('dry-run', help='Don\'t actually make changes'),
2665
 
                    Option('force', help='Say yes to all questions.')]
 
4574
                    Option('dry-run', help='Don\'t actually make changes.'),
 
4575
                    Option('force', help='Say yes to all questions.'),
 
4576
                    Option('local',
 
4577
                           help="Only remove the commits from the local branch"
 
4578
                                " when in a checkout."
 
4579
                           ),
 
4580
                    ]
2666
4581
    takes_args = ['location?']
2667
4582
    aliases = []
 
4583
    encoding_type = 'replace'
2668
4584
 
2669
4585
    def run(self, location=None,
2670
4586
            dry_run=False, verbose=False,
2671
 
            revision=None, force=False):
2672
 
        from bzrlib.log import log_formatter, show_log
2673
 
        import sys
2674
 
        from bzrlib.uncommit import uncommit
2675
 
 
 
4587
            revision=None, force=False, local=False):
2676
4588
        if location is None:
2677
4589
            location = u'.'
2678
4590
        control, relpath = bzrdir.BzrDir.open_containing(location)
2683
4595
            tree = None
2684
4596
            b = control.open_branch()
2685
4597
 
 
4598
        if tree is not None:
 
4599
            tree.lock_write()
 
4600
        else:
 
4601
            b.lock_write()
 
4602
        try:
 
4603
            return self._run(b, tree, dry_run, verbose, revision, force,
 
4604
                             local=local)
 
4605
        finally:
 
4606
            if tree is not None:
 
4607
                tree.unlock()
 
4608
            else:
 
4609
                b.unlock()
 
4610
 
 
4611
    def _run(self, b, tree, dry_run, verbose, revision, force, local=False):
 
4612
        from bzrlib.log import log_formatter, show_log
 
4613
        from bzrlib.uncommit import uncommit
 
4614
 
 
4615
        last_revno, last_rev_id = b.last_revision_info()
 
4616
 
2686
4617
        rev_id = None
2687
4618
        if revision is None:
2688
 
            revno = b.revno()
 
4619
            revno = last_revno
 
4620
            rev_id = last_rev_id
2689
4621
        else:
2690
4622
            # 'bzr uncommit -r 10' actually means uncommit
2691
4623
            # so that the final tree is at revno 10.
2692
4624
            # but bzrlib.uncommit.uncommit() actually uncommits
2693
4625
            # the revisions that are supplied.
2694
4626
            # So we need to offset it by one
2695
 
            revno = revision[0].in_history(b).revno+1
 
4627
            revno = revision[0].in_history(b).revno + 1
 
4628
            if revno <= last_revno:
 
4629
                rev_id = b.get_rev_id(revno)
2696
4630
 
2697
 
        if revno <= b.revno():
2698
 
            rev_id = b.get_rev_id(revno)
2699
 
        if rev_id is None:
 
4631
        if rev_id is None or _mod_revision.is_null(rev_id):
2700
4632
            self.outf.write('No revisions to uncommit.\n')
2701
4633
            return 1
2702
4634
 
2709
4641
                 verbose=False,
2710
4642
                 direction='forward',
2711
4643
                 start_revision=revno,
2712
 
                 end_revision=b.revno())
 
4644
                 end_revision=last_revno)
2713
4645
 
2714
4646
        if dry_run:
2715
4647
            print 'Dry-run, pretending to remove the above revisions.'
2723
4655
                    print 'Canceled'
2724
4656
                    return 0
2725
4657
 
 
4658
        mutter('Uncommitting from {%s} to {%s}',
 
4659
               last_rev_id, rev_id)
2726
4660
        uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
2727
 
                revno=revno)
 
4661
                 revno=revno, local=local)
 
4662
        note('You can restore the old tip by running:\n'
 
4663
             '  bzr pull . -r revid:%s', last_rev_id)
2728
4664
 
2729
4665
 
2730
4666
class cmd_break_lock(Command):
2734
4670
    holding the lock has been stopped.
2735
4671
 
2736
4672
    You can get information on what locks are open via the 'bzr info' command.
2737
 
    
2738
 
    example:
 
4673
 
 
4674
    :Examples:
2739
4675
        bzr break-lock
2740
4676
    """
2741
4677
    takes_args = ['location?']
2748
4684
            control.break_lock()
2749
4685
        except NotImplementedError:
2750
4686
            pass
2751
 
        
2752
 
 
2753
 
 
2754
 
# command-line interpretation helper for merge-related commands
2755
 
def merge(other_revision, base_revision,
2756
 
          check_clean=True, ignore_zero=False,
2757
 
          this_dir=None, backup_files=False, merge_type=Merge3Merger,
2758
 
          file_list=None, show_base=False, reprocess=False,
2759
 
          pb=DummyProgress()):
2760
 
    """Merge changes into a tree.
2761
 
 
2762
 
    base_revision
2763
 
        list(path, revno) Base for three-way merge.  
2764
 
        If [None, None] then a base will be automatically determined.
2765
 
    other_revision
2766
 
        list(path, revno) Other revision for three-way merge.
2767
 
    this_dir
2768
 
        Directory to merge changes into; '.' by default.
2769
 
    check_clean
2770
 
        If true, this_dir must have no uncommitted changes before the
2771
 
        merge begins.
2772
 
    ignore_zero - If true, suppress the "zero conflicts" message when 
2773
 
        there are no conflicts; should be set when doing something we expect
2774
 
        to complete perfectly.
2775
 
    file_list - If supplied, merge only changes to selected files.
2776
 
 
2777
 
    All available ancestors of other_revision and base_revision are
2778
 
    automatically pulled into the branch.
2779
 
 
2780
 
    The revno may be -1 to indicate the last revision on the branch, which is
2781
 
    the typical case.
2782
 
 
2783
 
    This function is intended for use from the command line; programmatic
2784
 
    clients might prefer to call merge.merge_inner(), which has less magic 
2785
 
    behavior.
2786
 
    """
2787
 
    from bzrlib.merge import Merger
2788
 
    if this_dir is None:
2789
 
        this_dir = u'.'
2790
 
    this_tree = WorkingTree.open_containing(this_dir)[0]
2791
 
    if show_base and not merge_type is Merge3Merger:
2792
 
        raise BzrCommandError("Show-base is not supported for this merge"
2793
 
                              " type. %s" % merge_type)
2794
 
    if reprocess and not merge_type.supports_reprocess:
2795
 
        raise BzrCommandError("Conflict reduction is not supported for merge"
2796
 
                              " type %s." % merge_type)
2797
 
    if reprocess and show_base:
2798
 
        raise BzrCommandError("Cannot do conflict reduction and show base.")
2799
 
    try:
2800
 
        merger = Merger(this_tree.branch, this_tree=this_tree, pb=pb)
2801
 
        merger.pp = ProgressPhase("Merge phase", 5, pb)
2802
 
        merger.pp.next_phase()
2803
 
        merger.check_basis(check_clean)
2804
 
        merger.set_other(other_revision)
2805
 
        merger.pp.next_phase()
2806
 
        merger.set_base(base_revision)
2807
 
        if merger.base_rev_id == merger.other_rev_id:
2808
 
            note('Nothing to do.')
 
4687
 
 
4688
 
 
4689
class cmd_wait_until_signalled(Command):
 
4690
    """Test helper for test_start_and_stop_bzr_subprocess_send_signal.
 
4691
 
 
4692
    This just prints a line to signal when it is ready, then blocks on stdin.
 
4693
    """
 
4694
 
 
4695
    hidden = True
 
4696
 
 
4697
    def run(self):
 
4698
        sys.stdout.write("running\n")
 
4699
        sys.stdout.flush()
 
4700
        sys.stdin.readline()
 
4701
 
 
4702
 
 
4703
class cmd_serve(Command):
 
4704
    """Run the bzr server."""
 
4705
 
 
4706
    aliases = ['server']
 
4707
 
 
4708
    takes_options = [
 
4709
        Option('inet',
 
4710
               help='Serve on stdin/out for use from inetd or sshd.'),
 
4711
        RegistryOption('protocol', 
 
4712
               help="Protocol to serve.", 
 
4713
               lazy_registry=('bzrlib.transport', 'transport_server_registry'),
 
4714
               value_switches=True),
 
4715
        Option('port',
 
4716
               help='Listen for connections on nominated port of the form '
 
4717
                    '[hostname:]portnumber.  Passing 0 as the port number will '
 
4718
                    'result in a dynamically allocated port.  The default port '
 
4719
                    'depends on the protocol.',
 
4720
               type=str),
 
4721
        Option('directory',
 
4722
               help='Serve contents of this directory.',
 
4723
               type=unicode),
 
4724
        Option('allow-writes',
 
4725
               help='By default the server is a readonly server.  Supplying '
 
4726
                    '--allow-writes enables write access to the contents of '
 
4727
                    'the served directory and below.'
 
4728
                ),
 
4729
        ]
 
4730
 
 
4731
    def get_host_and_port(self, port):
 
4732
        """Return the host and port to run the smart server on.
 
4733
 
 
4734
        If 'port' is None, None will be returned for the host and port.
 
4735
 
 
4736
        If 'port' has a colon in it, the string before the colon will be
 
4737
        interpreted as the host.
 
4738
 
 
4739
        :param port: A string of the port to run the server on.
 
4740
        :return: A tuple of (host, port), where 'host' is a host name or IP,
 
4741
            and port is an integer TCP/IP port.
 
4742
        """
 
4743
        host = None
 
4744
        if port is not None:
 
4745
            if ':' in port:
 
4746
                host, port = port.split(':')
 
4747
            port = int(port)
 
4748
        return host, port
 
4749
 
 
4750
    def run(self, port=None, inet=False, directory=None, allow_writes=False,
 
4751
            protocol=None):
 
4752
        from bzrlib.transport import get_transport, transport_server_registry
 
4753
        if directory is None:
 
4754
            directory = os.getcwd()
 
4755
        if protocol is None:
 
4756
            protocol = transport_server_registry.get()
 
4757
        host, port = self.get_host_and_port(port)
 
4758
        url = urlutils.local_path_to_url(directory)
 
4759
        if not allow_writes:
 
4760
            url = 'readonly+' + url
 
4761
        transport = get_transport(url)
 
4762
        protocol(transport, host, port, inet)
 
4763
 
 
4764
 
 
4765
class cmd_join(Command):
 
4766
    """Combine a tree into its containing tree.
 
4767
 
 
4768
    This command requires the target tree to be in a rich-root format.
 
4769
 
 
4770
    The TREE argument should be an independent tree, inside another tree, but
 
4771
    not part of it.  (Such trees can be produced by "bzr split", but also by
 
4772
    running "bzr branch" with the target inside a tree.)
 
4773
 
 
4774
    The result is a combined tree, with the subtree no longer an independant
 
4775
    part.  This is marked as a merge of the subtree into the containing tree,
 
4776
    and all history is preserved.
 
4777
    """
 
4778
 
 
4779
    _see_also = ['split']
 
4780
    takes_args = ['tree']
 
4781
    takes_options = [
 
4782
            Option('reference', help='Join by reference.', hidden=True),
 
4783
            ]
 
4784
 
 
4785
    def run(self, tree, reference=False):
 
4786
        sub_tree = WorkingTree.open(tree)
 
4787
        parent_dir = osutils.dirname(sub_tree.basedir)
 
4788
        containing_tree = WorkingTree.open_containing(parent_dir)[0]
 
4789
        repo = containing_tree.branch.repository
 
4790
        if not repo.supports_rich_root():
 
4791
            raise errors.BzrCommandError(
 
4792
                "Can't join trees because %s doesn't support rich root data.\n"
 
4793
                "You can use bzr upgrade on the repository."
 
4794
                % (repo,))
 
4795
        if reference:
 
4796
            try:
 
4797
                containing_tree.add_reference(sub_tree)
 
4798
            except errors.BadReferenceTarget, e:
 
4799
                # XXX: Would be better to just raise a nicely printable
 
4800
                # exception from the real origin.  Also below.  mbp 20070306
 
4801
                raise errors.BzrCommandError("Cannot join %s.  %s" %
 
4802
                                             (tree, e.reason))
 
4803
        else:
 
4804
            try:
 
4805
                containing_tree.subsume(sub_tree)
 
4806
            except errors.BadSubsumeSource, e:
 
4807
                raise errors.BzrCommandError("Cannot join %s.  %s" %
 
4808
                                             (tree, e.reason))
 
4809
 
 
4810
 
 
4811
class cmd_split(Command):
 
4812
    """Split a subdirectory of a tree into a separate tree.
 
4813
 
 
4814
    This command will produce a target tree in a format that supports
 
4815
    rich roots, like 'rich-root' or 'rich-root-pack'.  These formats cannot be
 
4816
    converted into earlier formats like 'dirstate-tags'.
 
4817
 
 
4818
    The TREE argument should be a subdirectory of a working tree.  That
 
4819
    subdirectory will be converted into an independent tree, with its own
 
4820
    branch.  Commits in the top-level tree will not apply to the new subtree.
 
4821
    """
 
4822
 
 
4823
    _see_also = ['join']
 
4824
    takes_args = ['tree']
 
4825
 
 
4826
    def run(self, tree):
 
4827
        containing_tree, subdir = WorkingTree.open_containing(tree)
 
4828
        sub_id = containing_tree.path2id(subdir)
 
4829
        if sub_id is None:
 
4830
            raise errors.NotVersionedError(subdir)
 
4831
        try:
 
4832
            containing_tree.extract(sub_id)
 
4833
        except errors.RootNotRich:
 
4834
            raise errors.RichRootUpgradeRequired(containing_tree.branch.base)
 
4835
 
 
4836
 
 
4837
class cmd_merge_directive(Command):
 
4838
    """Generate a merge directive for auto-merge tools.
 
4839
 
 
4840
    A directive requests a merge to be performed, and also provides all the
 
4841
    information necessary to do so.  This means it must either include a
 
4842
    revision bundle, or the location of a branch containing the desired
 
4843
    revision.
 
4844
 
 
4845
    A submit branch (the location to merge into) must be supplied the first
 
4846
    time the command is issued.  After it has been supplied once, it will
 
4847
    be remembered as the default.
 
4848
 
 
4849
    A public branch is optional if a revision bundle is supplied, but required
 
4850
    if --diff or --plain is specified.  It will be remembered as the default
 
4851
    after the first use.
 
4852
    """
 
4853
 
 
4854
    takes_args = ['submit_branch?', 'public_branch?']
 
4855
 
 
4856
    hidden = True
 
4857
 
 
4858
    _see_also = ['send']
 
4859
 
 
4860
    takes_options = [
 
4861
        RegistryOption.from_kwargs('patch-type',
 
4862
            'The type of patch to include in the directive.',
 
4863
            title='Patch type',
 
4864
            value_switches=True,
 
4865
            enum_switch=False,
 
4866
            bundle='Bazaar revision bundle (default).',
 
4867
            diff='Normal unified diff.',
 
4868
            plain='No patch, just directive.'),
 
4869
        Option('sign', help='GPG-sign the directive.'), 'revision',
 
4870
        Option('mail-to', type=str,
 
4871
            help='Instead of printing the directive, email to this address.'),
 
4872
        Option('message', type=str, short_name='m',
 
4873
            help='Message to use when committing this merge.')
 
4874
        ]
 
4875
 
 
4876
    encoding_type = 'exact'
 
4877
 
 
4878
    def run(self, submit_branch=None, public_branch=None, patch_type='bundle',
 
4879
            sign=False, revision=None, mail_to=None, message=None):
 
4880
        from bzrlib.revision import ensure_null, NULL_REVISION
 
4881
        include_patch, include_bundle = {
 
4882
            'plain': (False, False),
 
4883
            'diff': (True, False),
 
4884
            'bundle': (True, True),
 
4885
            }[patch_type]
 
4886
        branch = Branch.open('.')
 
4887
        stored_submit_branch = branch.get_submit_branch()
 
4888
        if submit_branch is None:
 
4889
            submit_branch = stored_submit_branch
 
4890
        else:
 
4891
            if stored_submit_branch is None:
 
4892
                branch.set_submit_branch(submit_branch)
 
4893
        if submit_branch is None:
 
4894
            submit_branch = branch.get_parent()
 
4895
        if submit_branch is None:
 
4896
            raise errors.BzrCommandError('No submit branch specified or known')
 
4897
 
 
4898
        stored_public_branch = branch.get_public_branch()
 
4899
        if public_branch is None:
 
4900
            public_branch = stored_public_branch
 
4901
        elif stored_public_branch is None:
 
4902
            branch.set_public_branch(public_branch)
 
4903
        if not include_bundle and public_branch is None:
 
4904
            raise errors.BzrCommandError('No public branch specified or'
 
4905
                                         ' known')
 
4906
        base_revision_id = None
 
4907
        if revision is not None:
 
4908
            if len(revision) > 2:
 
4909
                raise errors.BzrCommandError('bzr merge-directive takes '
 
4910
                    'at most two one revision identifiers')
 
4911
            revision_id = revision[-1].as_revision_id(branch)
 
4912
            if len(revision) == 2:
 
4913
                base_revision_id = revision[0].as_revision_id(branch)
 
4914
        else:
 
4915
            revision_id = branch.last_revision()
 
4916
        revision_id = ensure_null(revision_id)
 
4917
        if revision_id == NULL_REVISION:
 
4918
            raise errors.BzrCommandError('No revisions to bundle.')
 
4919
        directive = merge_directive.MergeDirective2.from_objects(
 
4920
            branch.repository, revision_id, time.time(),
 
4921
            osutils.local_time_offset(), submit_branch,
 
4922
            public_branch=public_branch, include_patch=include_patch,
 
4923
            include_bundle=include_bundle, message=message,
 
4924
            base_revision_id=base_revision_id)
 
4925
        if mail_to is None:
 
4926
            if sign:
 
4927
                self.outf.write(directive.to_signed(branch))
 
4928
            else:
 
4929
                self.outf.writelines(directive.to_lines())
 
4930
        else:
 
4931
            message = directive.to_email(mail_to, branch, sign)
 
4932
            s = SMTPConnection(branch.get_config())
 
4933
            s.send_email(message)
 
4934
 
 
4935
 
 
4936
class cmd_send(Command):
 
4937
    """Mail or create a merge-directive for submitting changes.
 
4938
 
 
4939
    A merge directive provides many things needed for requesting merges:
 
4940
 
 
4941
    * A machine-readable description of the merge to perform
 
4942
 
 
4943
    * An optional patch that is a preview of the changes requested
 
4944
 
 
4945
    * An optional bundle of revision data, so that the changes can be applied
 
4946
      directly from the merge directive, without retrieving data from a
 
4947
      branch.
 
4948
 
 
4949
    If --no-bundle is specified, then public_branch is needed (and must be
 
4950
    up-to-date), so that the receiver can perform the merge using the
 
4951
    public_branch.  The public_branch is always included if known, so that
 
4952
    people can check it later.
 
4953
 
 
4954
    The submit branch defaults to the parent, but can be overridden.  Both
 
4955
    submit branch and public branch will be remembered if supplied.
 
4956
 
 
4957
    If a public_branch is known for the submit_branch, that public submit
 
4958
    branch is used in the merge instructions.  This means that a local mirror
 
4959
    can be used as your actual submit branch, once you have set public_branch
 
4960
    for that mirror.
 
4961
 
 
4962
    Mail is sent using your preferred mail program.  This should be transparent
 
4963
    on Windows (it uses MAPI).  On Linux, it requires the xdg-email utility.
 
4964
    If the preferred client can't be found (or used), your editor will be used.
 
4965
 
 
4966
    To use a specific mail program, set the mail_client configuration option.
 
4967
    (For Thunderbird 1.5, this works around some bugs.)  Supported values for
 
4968
    specific clients are "claws", "evolution", "kmail", "mutt", and
 
4969
    "thunderbird"; generic options are "default", "editor", "emacsclient",
 
4970
    "mapi", and "xdg-email".  Plugins may also add supported clients.
 
4971
 
 
4972
    If mail is being sent, a to address is required.  This can be supplied
 
4973
    either on the commandline, by setting the submit_to configuration
 
4974
    option in the branch itself or the child_submit_to configuration option
 
4975
    in the submit branch.
 
4976
 
 
4977
    Two formats are currently supported: "4" uses revision bundle format 4 and
 
4978
    merge directive format 2.  It is significantly faster and smaller than
 
4979
    older formats.  It is compatible with Bazaar 0.19 and later.  It is the
 
4980
    default.  "0.9" uses revision bundle format 0.9 and merge directive
 
4981
    format 1.  It is compatible with Bazaar 0.12 - 0.18.
 
4982
 
 
4983
    The merge directives created by bzr send may be applied using bzr merge or
 
4984
    bzr pull by specifying a file containing a merge directive as the location.
 
4985
    """
 
4986
 
 
4987
    encoding_type = 'exact'
 
4988
 
 
4989
    _see_also = ['merge', 'pull']
 
4990
 
 
4991
    takes_args = ['submit_branch?', 'public_branch?']
 
4992
 
 
4993
    takes_options = [
 
4994
        Option('no-bundle',
 
4995
               help='Do not include a bundle in the merge directive.'),
 
4996
        Option('no-patch', help='Do not include a preview patch in the merge'
 
4997
               ' directive.'),
 
4998
        Option('remember',
 
4999
               help='Remember submit and public branch.'),
 
5000
        Option('from',
 
5001
               help='Branch to generate the submission from, '
 
5002
               'rather than the one containing the working directory.',
 
5003
               short_name='f',
 
5004
               type=unicode),
 
5005
        Option('output', short_name='o',
 
5006
               help='Write merge directive to this file; '
 
5007
                    'use - for stdout.',
 
5008
               type=unicode),
 
5009
        Option('strict',
 
5010
               help='Refuse to send if there are uncommitted changes in'
 
5011
               ' the working tree, --no-strict disables the check.'),
 
5012
        Option('mail-to', help='Mail the request to this address.',
 
5013
               type=unicode),
 
5014
        'revision',
 
5015
        'message',
 
5016
        Option('body', help='Body for the email.', type=unicode),
 
5017
        RegistryOption('format',
 
5018
                       help='Use the specified output format.',
 
5019
                       lazy_registry=('bzrlib.send', 'format_registry')),
 
5020
        ]
 
5021
 
 
5022
    def run(self, submit_branch=None, public_branch=None, no_bundle=False,
 
5023
            no_patch=False, revision=None, remember=False, output=None,
 
5024
            format=None, mail_to=None, message=None, body=None,
 
5025
            strict=None, **kwargs):
 
5026
        from bzrlib.send import send
 
5027
        return send(submit_branch, revision, public_branch, remember,
 
5028
                    format, no_bundle, no_patch, output,
 
5029
                    kwargs.get('from', '.'), mail_to, message, body,
 
5030
                    self.outf,
 
5031
                    strict=strict)
 
5032
 
 
5033
 
 
5034
class cmd_bundle_revisions(cmd_send):
 
5035
    """Create a merge-directive for submitting changes.
 
5036
 
 
5037
    A merge directive provides many things needed for requesting merges:
 
5038
 
 
5039
    * A machine-readable description of the merge to perform
 
5040
 
 
5041
    * An optional patch that is a preview of the changes requested
 
5042
 
 
5043
    * An optional bundle of revision data, so that the changes can be applied
 
5044
      directly from the merge directive, without retrieving data from a
 
5045
      branch.
 
5046
 
 
5047
    If --no-bundle is specified, then public_branch is needed (and must be
 
5048
    up-to-date), so that the receiver can perform the merge using the
 
5049
    public_branch.  The public_branch is always included if known, so that
 
5050
    people can check it later.
 
5051
 
 
5052
    The submit branch defaults to the parent, but can be overridden.  Both
 
5053
    submit branch and public branch will be remembered if supplied.
 
5054
 
 
5055
    If a public_branch is known for the submit_branch, that public submit
 
5056
    branch is used in the merge instructions.  This means that a local mirror
 
5057
    can be used as your actual submit branch, once you have set public_branch
 
5058
    for that mirror.
 
5059
 
 
5060
    Two formats are currently supported: "4" uses revision bundle format 4 and
 
5061
    merge directive format 2.  It is significantly faster and smaller than
 
5062
    older formats.  It is compatible with Bazaar 0.19 and later.  It is the
 
5063
    default.  "0.9" uses revision bundle format 0.9 and merge directive
 
5064
    format 1.  It is compatible with Bazaar 0.12 - 0.18.
 
5065
    """
 
5066
 
 
5067
    takes_options = [
 
5068
        Option('no-bundle',
 
5069
               help='Do not include a bundle in the merge directive.'),
 
5070
        Option('no-patch', help='Do not include a preview patch in the merge'
 
5071
               ' directive.'),
 
5072
        Option('remember',
 
5073
               help='Remember submit and public branch.'),
 
5074
        Option('from',
 
5075
               help='Branch to generate the submission from, '
 
5076
               'rather than the one containing the working directory.',
 
5077
               short_name='f',
 
5078
               type=unicode),
 
5079
        Option('output', short_name='o', help='Write directive to this file.',
 
5080
               type=unicode),
 
5081
        Option('strict',
 
5082
               help='Refuse to bundle revisions if there are uncommitted'
 
5083
               ' changes in the working tree, --no-strict disables the check.'),
 
5084
        'revision',
 
5085
        RegistryOption('format',
 
5086
                       help='Use the specified output format.',
 
5087
                       lazy_registry=('bzrlib.send', 'format_registry')),
 
5088
        ]
 
5089
    aliases = ['bundle']
 
5090
 
 
5091
    _see_also = ['send', 'merge']
 
5092
 
 
5093
    hidden = True
 
5094
 
 
5095
    def run(self, submit_branch=None, public_branch=None, no_bundle=False,
 
5096
            no_patch=False, revision=None, remember=False, output=None,
 
5097
            format=None, strict=None, **kwargs):
 
5098
        if output is None:
 
5099
            output = '-'
 
5100
        from bzrlib.send import send
 
5101
        return send(submit_branch, revision, public_branch, remember,
 
5102
                         format, no_bundle, no_patch, output,
 
5103
                         kwargs.get('from', '.'), None, None, None,
 
5104
                         self.outf, strict=strict)
 
5105
 
 
5106
 
 
5107
class cmd_tag(Command):
 
5108
    """Create, remove or modify a tag naming a revision.
 
5109
 
 
5110
    Tags give human-meaningful names to revisions.  Commands that take a -r
 
5111
    (--revision) option can be given -rtag:X, where X is any previously
 
5112
    created tag.
 
5113
 
 
5114
    Tags are stored in the branch.  Tags are copied from one branch to another
 
5115
    along when you branch, push, pull or merge.
 
5116
 
 
5117
    It is an error to give a tag name that already exists unless you pass
 
5118
    --force, in which case the tag is moved to point to the new revision.
 
5119
 
 
5120
    To rename a tag (change the name but keep it on the same revsion), run ``bzr
 
5121
    tag new-name -r tag:old-name`` and then ``bzr tag --delete oldname``.
 
5122
    """
 
5123
 
 
5124
    _see_also = ['commit', 'tags']
 
5125
    takes_args = ['tag_name']
 
5126
    takes_options = [
 
5127
        Option('delete',
 
5128
            help='Delete this tag rather than placing it.',
 
5129
            ),
 
5130
        Option('directory',
 
5131
            help='Branch in which to place the tag.',
 
5132
            short_name='d',
 
5133
            type=unicode,
 
5134
            ),
 
5135
        Option('force',
 
5136
            help='Replace existing tags.',
 
5137
            ),
 
5138
        'revision',
 
5139
        ]
 
5140
 
 
5141
    def run(self, tag_name,
 
5142
            delete=None,
 
5143
            directory='.',
 
5144
            force=None,
 
5145
            revision=None,
 
5146
            ):
 
5147
        branch, relpath = Branch.open_containing(directory)
 
5148
        branch.lock_write()
 
5149
        try:
 
5150
            if delete:
 
5151
                branch.tags.delete_tag(tag_name)
 
5152
                self.outf.write('Deleted tag %s.\n' % tag_name)
 
5153
            else:
 
5154
                if revision:
 
5155
                    if len(revision) != 1:
 
5156
                        raise errors.BzrCommandError(
 
5157
                            "Tags can only be placed on a single revision, "
 
5158
                            "not on a range")
 
5159
                    revision_id = revision[0].as_revision_id(branch)
 
5160
                else:
 
5161
                    revision_id = branch.last_revision()
 
5162
                if (not force) and branch.tags.has_tag(tag_name):
 
5163
                    raise errors.TagAlreadyExists(tag_name)
 
5164
                branch.tags.set_tag(tag_name, revision_id)
 
5165
                self.outf.write('Created tag %s.\n' % tag_name)
 
5166
        finally:
 
5167
            branch.unlock()
 
5168
 
 
5169
 
 
5170
class cmd_tags(Command):
 
5171
    """List tags.
 
5172
 
 
5173
    This command shows a table of tag names and the revisions they reference.
 
5174
    """
 
5175
 
 
5176
    _see_also = ['tag']
 
5177
    takes_options = [
 
5178
        Option('directory',
 
5179
            help='Branch whose tags should be displayed.',
 
5180
            short_name='d',
 
5181
            type=unicode,
 
5182
            ),
 
5183
        RegistryOption.from_kwargs('sort',
 
5184
            'Sort tags by different criteria.', title='Sorting',
 
5185
            alpha='Sort tags lexicographically (default).',
 
5186
            time='Sort tags chronologically.',
 
5187
            ),
 
5188
        'show-ids',
 
5189
        'revision',
 
5190
    ]
 
5191
 
 
5192
    @display_command
 
5193
    def run(self,
 
5194
            directory='.',
 
5195
            sort='alpha',
 
5196
            show_ids=False,
 
5197
            revision=None,
 
5198
            ):
 
5199
        branch, relpath = Branch.open_containing(directory)
 
5200
 
 
5201
        tags = branch.tags.get_tag_dict().items()
 
5202
        if not tags:
 
5203
            return
 
5204
 
 
5205
        branch.lock_read()
 
5206
        try:
 
5207
            if revision:
 
5208
                graph = branch.repository.get_graph()
 
5209
                rev1, rev2 = _get_revision_range(revision, branch, self.name())
 
5210
                revid1, revid2 = rev1.rev_id, rev2.rev_id
 
5211
                # only show revisions between revid1 and revid2 (inclusive)
 
5212
                tags = [(tag, revid) for tag, revid in tags if
 
5213
                    graph.is_between(revid, revid1, revid2)]
 
5214
            if sort == 'alpha':
 
5215
                tags.sort()
 
5216
            elif sort == 'time':
 
5217
                timestamps = {}
 
5218
                for tag, revid in tags:
 
5219
                    try:
 
5220
                        revobj = branch.repository.get_revision(revid)
 
5221
                    except errors.NoSuchRevision:
 
5222
                        timestamp = sys.maxint # place them at the end
 
5223
                    else:
 
5224
                        timestamp = revobj.timestamp
 
5225
                    timestamps[revid] = timestamp
 
5226
                tags.sort(key=lambda x: timestamps[x[1]])
 
5227
            if not show_ids:
 
5228
                # [ (tag, revid), ... ] -> [ (tag, dotted_revno), ... ]
 
5229
                for index, (tag, revid) in enumerate(tags):
 
5230
                    try:
 
5231
                        revno = branch.revision_id_to_dotted_revno(revid)
 
5232
                        if isinstance(revno, tuple):
 
5233
                            revno = '.'.join(map(str, revno))
 
5234
                    except errors.NoSuchRevision:
 
5235
                        # Bad tag data/merges can lead to tagged revisions
 
5236
                        # which are not in this branch. Fail gracefully ...
 
5237
                        revno = '?'
 
5238
                    tags[index] = (tag, revno)
 
5239
        finally:
 
5240
            branch.unlock()
 
5241
        for tag, revspec in tags:
 
5242
            self.outf.write('%-20s %s\n' % (tag, revspec))
 
5243
 
 
5244
 
 
5245
class cmd_reconfigure(Command):
 
5246
    """Reconfigure the type of a bzr directory.
 
5247
 
 
5248
    A target configuration must be specified.
 
5249
 
 
5250
    For checkouts, the bind-to location will be auto-detected if not specified.
 
5251
    The order of preference is
 
5252
    1. For a lightweight checkout, the current bound location.
 
5253
    2. For branches that used to be checkouts, the previously-bound location.
 
5254
    3. The push location.
 
5255
    4. The parent location.
 
5256
    If none of these is available, --bind-to must be specified.
 
5257
    """
 
5258
 
 
5259
    _see_also = ['branches', 'checkouts', 'standalone-trees', 'working-trees']
 
5260
    takes_args = ['location?']
 
5261
    takes_options = [
 
5262
        RegistryOption.from_kwargs(
 
5263
            'target_type',
 
5264
            title='Target type',
 
5265
            help='The type to reconfigure the directory to.',
 
5266
            value_switches=True, enum_switch=False,
 
5267
            branch='Reconfigure to be an unbound branch with no working tree.',
 
5268
            tree='Reconfigure to be an unbound branch with a working tree.',
 
5269
            checkout='Reconfigure to be a bound branch with a working tree.',
 
5270
            lightweight_checkout='Reconfigure to be a lightweight'
 
5271
                ' checkout (with no local history).',
 
5272
            standalone='Reconfigure to be a standalone branch '
 
5273
                '(i.e. stop using shared repository).',
 
5274
            use_shared='Reconfigure to use a shared repository.',
 
5275
            with_trees='Reconfigure repository to create '
 
5276
                'working trees on branches by default.',
 
5277
            with_no_trees='Reconfigure repository to not create '
 
5278
                'working trees on branches by default.'
 
5279
            ),
 
5280
        Option('bind-to', help='Branch to bind checkout to.', type=str),
 
5281
        Option('force',
 
5282
            help='Perform reconfiguration even if local changes'
 
5283
            ' will be lost.'),
 
5284
        Option('stacked-on',
 
5285
            help='Reconfigure a branch to be stacked on another branch.',
 
5286
            type=unicode,
 
5287
            ),
 
5288
        Option('unstacked',
 
5289
            help='Reconfigure a branch to be unstacked.  This '
 
5290
                'may require copying substantial data into it.',
 
5291
            ),
 
5292
        ]
 
5293
 
 
5294
    def run(self, location=None, target_type=None, bind_to=None, force=False,
 
5295
            stacked_on=None,
 
5296
            unstacked=None):
 
5297
        directory = bzrdir.BzrDir.open(location)
 
5298
        if stacked_on and unstacked:
 
5299
            raise BzrCommandError("Can't use both --stacked-on and --unstacked")
 
5300
        elif stacked_on is not None:
 
5301
            reconfigure.ReconfigureStackedOn().apply(directory, stacked_on)
 
5302
        elif unstacked:
 
5303
            reconfigure.ReconfigureUnstacked().apply(directory)
 
5304
        # At the moment you can use --stacked-on and a different
 
5305
        # reconfiguration shape at the same time; there seems no good reason
 
5306
        # to ban it.
 
5307
        if target_type is None:
 
5308
            if stacked_on or unstacked:
 
5309
                return
 
5310
            else:
 
5311
                raise errors.BzrCommandError('No target configuration '
 
5312
                    'specified')
 
5313
        elif target_type == 'branch':
 
5314
            reconfiguration = reconfigure.Reconfigure.to_branch(directory)
 
5315
        elif target_type == 'tree':
 
5316
            reconfiguration = reconfigure.Reconfigure.to_tree(directory)
 
5317
        elif target_type == 'checkout':
 
5318
            reconfiguration = reconfigure.Reconfigure.to_checkout(
 
5319
                directory, bind_to)
 
5320
        elif target_type == 'lightweight-checkout':
 
5321
            reconfiguration = reconfigure.Reconfigure.to_lightweight_checkout(
 
5322
                directory, bind_to)
 
5323
        elif target_type == 'use-shared':
 
5324
            reconfiguration = reconfigure.Reconfigure.to_use_shared(directory)
 
5325
        elif target_type == 'standalone':
 
5326
            reconfiguration = reconfigure.Reconfigure.to_standalone(directory)
 
5327
        elif target_type == 'with-trees':
 
5328
            reconfiguration = reconfigure.Reconfigure.set_repository_trees(
 
5329
                directory, True)
 
5330
        elif target_type == 'with-no-trees':
 
5331
            reconfiguration = reconfigure.Reconfigure.set_repository_trees(
 
5332
                directory, False)
 
5333
        reconfiguration.apply(force)
 
5334
 
 
5335
 
 
5336
class cmd_switch(Command):
 
5337
    """Set the branch of a checkout and update.
 
5338
 
 
5339
    For lightweight checkouts, this changes the branch being referenced.
 
5340
    For heavyweight checkouts, this checks that there are no local commits
 
5341
    versus the current bound branch, then it makes the local branch a mirror
 
5342
    of the new location and binds to it.
 
5343
 
 
5344
    In both cases, the working tree is updated and uncommitted changes
 
5345
    are merged. The user can commit or revert these as they desire.
 
5346
 
 
5347
    Pending merges need to be committed or reverted before using switch.
 
5348
 
 
5349
    The path to the branch to switch to can be specified relative to the parent
 
5350
    directory of the current branch. For example, if you are currently in a
 
5351
    checkout of /path/to/branch, specifying 'newbranch' will find a branch at
 
5352
    /path/to/newbranch.
 
5353
 
 
5354
    Bound branches use the nickname of its master branch unless it is set
 
5355
    locally, in which case switching will update the the local nickname to be
 
5356
    that of the master.
 
5357
    """
 
5358
 
 
5359
    takes_args = ['to_location']
 
5360
    takes_options = [Option('force',
 
5361
                        help='Switch even if local commits will be lost.'),
 
5362
                     Option('create-branch', short_name='b',
 
5363
                        help='Create the target branch from this one before'
 
5364
                             ' switching to it.'),
 
5365
                     ]
 
5366
 
 
5367
    def run(self, to_location, force=False, create_branch=False):
 
5368
        from bzrlib import switch
 
5369
        tree_location = '.'
 
5370
        control_dir = bzrdir.BzrDir.open_containing(tree_location)[0]
 
5371
        try:
 
5372
            branch = control_dir.open_branch()
 
5373
            had_explicit_nick = branch.get_config().has_explicit_nickname()
 
5374
        except errors.NotBranchError:
 
5375
            branch = None
 
5376
            had_explicit_nick = False
 
5377
        if create_branch:
 
5378
            if branch is None:
 
5379
                raise errors.BzrCommandError('cannot create branch without'
 
5380
                                             ' source branch')
 
5381
            if '/' not in to_location and '\\' not in to_location:
 
5382
                # This path is meant to be relative to the existing branch
 
5383
                this_url = self._get_branch_location(control_dir)
 
5384
                to_location = urlutils.join(this_url, '..', to_location)
 
5385
            to_branch = branch.bzrdir.sprout(to_location,
 
5386
                                 possible_transports=[branch.bzrdir.root_transport],
 
5387
                                 source_branch=branch).open_branch()
 
5388
            # try:
 
5389
            #     from_branch = control_dir.open_branch()
 
5390
            # except errors.NotBranchError:
 
5391
            #     raise BzrCommandError('Cannot create a branch from this'
 
5392
            #         ' location when we cannot open this branch')
 
5393
            # from_branch.bzrdir.sprout(
 
5394
            pass
 
5395
        else:
 
5396
            try:
 
5397
                to_branch = Branch.open(to_location)
 
5398
            except errors.NotBranchError:
 
5399
                this_url = self._get_branch_location(control_dir)
 
5400
                to_branch = Branch.open(
 
5401
                    urlutils.join(this_url, '..', to_location))
 
5402
        switch.switch(control_dir, to_branch, force)
 
5403
        if had_explicit_nick:
 
5404
            branch = control_dir.open_branch() #get the new branch!
 
5405
            branch.nick = to_branch.nick
 
5406
        note('Switched to branch: %s',
 
5407
            urlutils.unescape_for_display(to_branch.base, 'utf-8'))
 
5408
 
 
5409
    def _get_branch_location(self, control_dir):
 
5410
        """Return location of branch for this control dir."""
 
5411
        try:
 
5412
            this_branch = control_dir.open_branch()
 
5413
            # This may be a heavy checkout, where we want the master branch
 
5414
            master_location = this_branch.get_bound_location()
 
5415
            if master_location is not None:
 
5416
                return master_location
 
5417
            # If not, use a local sibling
 
5418
            return this_branch.base
 
5419
        except errors.NotBranchError:
 
5420
            format = control_dir.find_branch_format()
 
5421
            if getattr(format, 'get_reference', None) is not None:
 
5422
                return format.get_reference(control_dir)
 
5423
            else:
 
5424
                return control_dir.root_transport.base
 
5425
 
 
5426
 
 
5427
class cmd_view(Command):
 
5428
    """Manage filtered views.
 
5429
 
 
5430
    Views provide a mask over the tree so that users can focus on
 
5431
    a subset of a tree when doing their work. After creating a view,
 
5432
    commands that support a list of files - status, diff, commit, etc -
 
5433
    effectively have that list of files implicitly given each time.
 
5434
    An explicit list of files can still be given but those files
 
5435
    must be within the current view.
 
5436
 
 
5437
    In most cases, a view has a short life-span: it is created to make
 
5438
    a selected change and is deleted once that change is committed.
 
5439
    At other times, you may wish to create one or more named views
 
5440
    and switch between them.
 
5441
 
 
5442
    To disable the current view without deleting it, you can switch to
 
5443
    the pseudo view called ``off``. This can be useful when you need
 
5444
    to see the whole tree for an operation or two (e.g. merge) but
 
5445
    want to switch back to your view after that.
 
5446
 
 
5447
    :Examples:
 
5448
      To define the current view::
 
5449
 
 
5450
        bzr view file1 dir1 ...
 
5451
 
 
5452
      To list the current view::
 
5453
 
 
5454
        bzr view
 
5455
 
 
5456
      To delete the current view::
 
5457
 
 
5458
        bzr view --delete
 
5459
 
 
5460
      To disable the current view without deleting it::
 
5461
 
 
5462
        bzr view --switch off
 
5463
 
 
5464
      To define a named view and switch to it::
 
5465
 
 
5466
        bzr view --name view-name file1 dir1 ...
 
5467
 
 
5468
      To list a named view::
 
5469
 
 
5470
        bzr view --name view-name
 
5471
 
 
5472
      To delete a named view::
 
5473
 
 
5474
        bzr view --name view-name --delete
 
5475
 
 
5476
      To switch to a named view::
 
5477
 
 
5478
        bzr view --switch view-name
 
5479
 
 
5480
      To list all views defined::
 
5481
 
 
5482
        bzr view --all
 
5483
 
 
5484
      To delete all views::
 
5485
 
 
5486
        bzr view --delete --all
 
5487
    """
 
5488
 
 
5489
    _see_also = []
 
5490
    takes_args = ['file*']
 
5491
    takes_options = [
 
5492
        Option('all',
 
5493
            help='Apply list or delete action to all views.',
 
5494
            ),
 
5495
        Option('delete',
 
5496
            help='Delete the view.',
 
5497
            ),
 
5498
        Option('name',
 
5499
            help='Name of the view to define, list or delete.',
 
5500
            type=unicode,
 
5501
            ),
 
5502
        Option('switch',
 
5503
            help='Name of the view to switch to.',
 
5504
            type=unicode,
 
5505
            ),
 
5506
        ]
 
5507
 
 
5508
    def run(self, file_list,
 
5509
            all=False,
 
5510
            delete=False,
 
5511
            name=None,
 
5512
            switch=None,
 
5513
            ):
 
5514
        tree, file_list = tree_files(file_list, apply_view=False)
 
5515
        current_view, view_dict = tree.views.get_view_info()
 
5516
        if name is None:
 
5517
            name = current_view
 
5518
        if delete:
 
5519
            if file_list:
 
5520
                raise errors.BzrCommandError(
 
5521
                    "Both --delete and a file list specified")
 
5522
            elif switch:
 
5523
                raise errors.BzrCommandError(
 
5524
                    "Both --delete and --switch specified")
 
5525
            elif all:
 
5526
                tree.views.set_view_info(None, {})
 
5527
                self.outf.write("Deleted all views.\n")
 
5528
            elif name is None:
 
5529
                raise errors.BzrCommandError("No current view to delete")
 
5530
            else:
 
5531
                tree.views.delete_view(name)
 
5532
                self.outf.write("Deleted '%s' view.\n" % name)
 
5533
        elif switch:
 
5534
            if file_list:
 
5535
                raise errors.BzrCommandError(
 
5536
                    "Both --switch and a file list specified")
 
5537
            elif all:
 
5538
                raise errors.BzrCommandError(
 
5539
                    "Both --switch and --all specified")
 
5540
            elif switch == 'off':
 
5541
                if current_view is None:
 
5542
                    raise errors.BzrCommandError("No current view to disable")
 
5543
                tree.views.set_view_info(None, view_dict)
 
5544
                self.outf.write("Disabled '%s' view.\n" % (current_view))
 
5545
            else:
 
5546
                tree.views.set_view_info(switch, view_dict)
 
5547
                view_str = views.view_display_str(tree.views.lookup_view())
 
5548
                self.outf.write("Using '%s' view: %s\n" % (switch, view_str))
 
5549
        elif all:
 
5550
            if view_dict:
 
5551
                self.outf.write('Views defined:\n')
 
5552
                for view in sorted(view_dict):
 
5553
                    if view == current_view:
 
5554
                        active = "=>"
 
5555
                    else:
 
5556
                        active = "  "
 
5557
                    view_str = views.view_display_str(view_dict[view])
 
5558
                    self.outf.write('%s %-20s %s\n' % (active, view, view_str))
 
5559
            else:
 
5560
                self.outf.write('No views defined.\n')
 
5561
        elif file_list:
 
5562
            if name is None:
 
5563
                # No name given and no current view set
 
5564
                name = 'my'
 
5565
            elif name == 'off':
 
5566
                raise errors.BzrCommandError(
 
5567
                    "Cannot change the 'off' pseudo view")
 
5568
            tree.views.set_view(name, sorted(file_list))
 
5569
            view_str = views.view_display_str(tree.views.lookup_view())
 
5570
            self.outf.write("Using '%s' view: %s\n" % (name, view_str))
 
5571
        else:
 
5572
            # list the files
 
5573
            if name is None:
 
5574
                # No name given and no current view set
 
5575
                self.outf.write('No current view.\n')
 
5576
            else:
 
5577
                view_str = views.view_display_str(tree.views.lookup_view(name))
 
5578
                self.outf.write("'%s' view is: %s\n" % (name, view_str))
 
5579
 
 
5580
 
 
5581
class cmd_hooks(Command):
 
5582
    """Show hooks."""
 
5583
 
 
5584
    hidden = True
 
5585
 
 
5586
    def run(self):
 
5587
        for hook_key in sorted(hooks.known_hooks.keys()):
 
5588
            some_hooks = hooks.known_hooks_key_to_object(hook_key)
 
5589
            self.outf.write("%s:\n" % type(some_hooks).__name__)
 
5590
            for hook_name, hook_point in sorted(some_hooks.items()):
 
5591
                self.outf.write("  %s:\n" % (hook_name,))
 
5592
                found_hooks = list(hook_point)
 
5593
                if found_hooks:
 
5594
                    for hook in found_hooks:
 
5595
                        self.outf.write("    %s\n" %
 
5596
                                        (some_hooks.get_hook_name(hook),))
 
5597
                else:
 
5598
                    self.outf.write("    <no hooks installed>\n")
 
5599
 
 
5600
 
 
5601
class cmd_shelve(Command):
 
5602
    """Temporarily set aside some changes from the current tree.
 
5603
 
 
5604
    Shelve allows you to temporarily put changes you've made "on the shelf",
 
5605
    ie. out of the way, until a later time when you can bring them back from
 
5606
    the shelf with the 'unshelve' command.  The changes are stored alongside
 
5607
    your working tree, and so they aren't propagated along with your branch nor
 
5608
    will they survive its deletion.
 
5609
 
 
5610
    If shelve --list is specified, previously-shelved changes are listed.
 
5611
 
 
5612
    Shelve is intended to help separate several sets of changes that have
 
5613
    been inappropriately mingled.  If you just want to get rid of all changes
 
5614
    and you don't need to restore them later, use revert.  If you want to
 
5615
    shelve all text changes at once, use shelve --all.
 
5616
 
 
5617
    If filenames are specified, only the changes to those files will be
 
5618
    shelved. Other files will be left untouched.
 
5619
 
 
5620
    If a revision is specified, changes since that revision will be shelved.
 
5621
 
 
5622
    You can put multiple items on the shelf, and by default, 'unshelve' will
 
5623
    restore the most recently shelved changes.
 
5624
    """
 
5625
 
 
5626
    takes_args = ['file*']
 
5627
 
 
5628
    takes_options = [
 
5629
        'revision',
 
5630
        Option('all', help='Shelve all changes.'),
 
5631
        'message',
 
5632
        RegistryOption('writer', 'Method to use for writing diffs.',
 
5633
                       bzrlib.option.diff_writer_registry,
 
5634
                       value_switches=True, enum_switch=False),
 
5635
 
 
5636
        Option('list', help='List shelved changes.'),
 
5637
        Option('destroy',
 
5638
               help='Destroy removed changes instead of shelving them.'),
 
5639
    ]
 
5640
    _see_also = ['unshelve']
 
5641
 
 
5642
    def run(self, revision=None, all=False, file_list=None, message=None,
 
5643
            writer=None, list=False, destroy=False):
 
5644
        if list:
 
5645
            return self.run_for_list()
 
5646
        from bzrlib.shelf_ui import Shelver
 
5647
        if writer is None:
 
5648
            writer = bzrlib.option.diff_writer_registry.get()
 
5649
        try:
 
5650
            shelver = Shelver.from_args(writer(sys.stdout), revision, all,
 
5651
                file_list, message, destroy=destroy)
 
5652
            try:
 
5653
                shelver.run()
 
5654
            finally:
 
5655
                shelver.work_tree.unlock()
 
5656
        except errors.UserAbort:
2809
5657
            return 0
2810
 
        merger.backup_files = backup_files
2811
 
        merger.merge_type = merge_type 
2812
 
        merger.set_interesting_files(file_list)
2813
 
        merger.show_base = show_base 
2814
 
        merger.reprocess = reprocess
2815
 
        conflicts = merger.do_merge()
2816
 
        if file_list is None:
2817
 
            merger.set_pending()
2818
 
    finally:
2819
 
        pb.clear()
2820
 
    return conflicts
 
5658
 
 
5659
    def run_for_list(self):
 
5660
        tree = WorkingTree.open_containing('.')[0]
 
5661
        tree.lock_read()
 
5662
        try:
 
5663
            manager = tree.get_shelf_manager()
 
5664
            shelves = manager.active_shelves()
 
5665
            if len(shelves) == 0:
 
5666
                note('No shelved changes.')
 
5667
                return 0
 
5668
            for shelf_id in reversed(shelves):
 
5669
                message = manager.get_metadata(shelf_id).get('message')
 
5670
                if message is None:
 
5671
                    message = '<no message>'
 
5672
                self.outf.write('%3d: %s\n' % (shelf_id, message))
 
5673
            return 1
 
5674
        finally:
 
5675
            tree.unlock()
 
5676
 
 
5677
 
 
5678
class cmd_unshelve(Command):
 
5679
    """Restore shelved changes.
 
5680
 
 
5681
    By default, the most recently shelved changes are restored. However if you
 
5682
    specify a shelf by id those changes will be restored instead.  This works
 
5683
    best when the changes don't depend on each other.
 
5684
    """
 
5685
 
 
5686
    takes_args = ['shelf_id?']
 
5687
    takes_options = [
 
5688
        RegistryOption.from_kwargs(
 
5689
            'action', help="The action to perform.",
 
5690
            enum_switch=False, value_switches=True,
 
5691
            apply="Apply changes and remove from the shelf.",
 
5692
            dry_run="Show changes, but do not apply or remove them.",
 
5693
            delete_only="Delete changes without applying them."
 
5694
        )
 
5695
    ]
 
5696
    _see_also = ['shelve']
 
5697
 
 
5698
    def run(self, shelf_id=None, action='apply'):
 
5699
        from bzrlib.shelf_ui import Unshelver
 
5700
        unshelver = Unshelver.from_args(shelf_id, action)
 
5701
        try:
 
5702
            unshelver.run()
 
5703
        finally:
 
5704
            unshelver.tree.unlock()
 
5705
 
 
5706
 
 
5707
class cmd_clean_tree(Command):
 
5708
    """Remove unwanted files from working tree.
 
5709
 
 
5710
    By default, only unknown files, not ignored files, are deleted.  Versioned
 
5711
    files are never deleted.
 
5712
 
 
5713
    Another class is 'detritus', which includes files emitted by bzr during
 
5714
    normal operations and selftests.  (The value of these files decreases with
 
5715
    time.)
 
5716
 
 
5717
    If no options are specified, unknown files are deleted.  Otherwise, option
 
5718
    flags are respected, and may be combined.
 
5719
 
 
5720
    To check what clean-tree will do, use --dry-run.
 
5721
    """
 
5722
    takes_options = [Option('ignored', help='Delete all ignored files.'),
 
5723
                     Option('detritus', help='Delete conflict files, merge'
 
5724
                            ' backups, and failed selftest dirs.'),
 
5725
                     Option('unknown',
 
5726
                            help='Delete files unknown to bzr (default).'),
 
5727
                     Option('dry-run', help='Show files to delete instead of'
 
5728
                            ' deleting them.'),
 
5729
                     Option('force', help='Do not prompt before deleting.')]
 
5730
    def run(self, unknown=False, ignored=False, detritus=False, dry_run=False,
 
5731
            force=False):
 
5732
        from bzrlib.clean_tree import clean_tree
 
5733
        if not (unknown or ignored or detritus):
 
5734
            unknown = True
 
5735
        if dry_run:
 
5736
            force = True
 
5737
        clean_tree('.', unknown=unknown, ignored=ignored, detritus=detritus,
 
5738
                   dry_run=dry_run, no_prompt=force)
 
5739
 
 
5740
 
 
5741
class cmd_reference(Command):
 
5742
    """list, view and set branch locations for nested trees.
 
5743
 
 
5744
    If no arguments are provided, lists the branch locations for nested trees.
 
5745
    If one argument is provided, display the branch location for that tree.
 
5746
    If two arguments are provided, set the branch location for that tree.
 
5747
    """
 
5748
 
 
5749
    hidden = True
 
5750
 
 
5751
    takes_args = ['path?', 'location?']
 
5752
 
 
5753
    def run(self, path=None, location=None):
 
5754
        branchdir = '.'
 
5755
        if path is not None:
 
5756
            branchdir = path
 
5757
        tree, branch, relpath =(
 
5758
            bzrdir.BzrDir.open_containing_tree_or_branch(branchdir))
 
5759
        if path is not None:
 
5760
            path = relpath
 
5761
        if tree is None:
 
5762
            tree = branch.basis_tree()
 
5763
        if path is None:
 
5764
            info = branch._get_all_reference_info().iteritems()
 
5765
            self._display_reference_info(tree, branch, info)
 
5766
        else:
 
5767
            file_id = tree.path2id(path)
 
5768
            if file_id is None:
 
5769
                raise errors.NotVersionedError(path)
 
5770
            if location is None:
 
5771
                info = [(file_id, branch.get_reference_info(file_id))]
 
5772
                self._display_reference_info(tree, branch, info)
 
5773
            else:
 
5774
                branch.set_reference_info(file_id, path, location)
 
5775
 
 
5776
    def _display_reference_info(self, tree, branch, info):
 
5777
        ref_list = []
 
5778
        for file_id, (path, location) in info:
 
5779
            try:
 
5780
                path = tree.id2path(file_id)
 
5781
            except errors.NoSuchId:
 
5782
                pass
 
5783
            ref_list.append((path, location))
 
5784
        for path, location in sorted(ref_list):
 
5785
            self.outf.write('%s %s\n' % (path, location))
2821
5786
 
2822
5787
 
2823
5788
# these get imported and then picked up by the scan for cmd_*
2824
5789
# TODO: Some more consistent way to split command definitions across files;
2825
 
# we do need to load at least some information about them to know of 
 
5790
# we do need to load at least some information about them to know of
2826
5791
# aliases.  ideally we would avoid loading the implementation until the
2827
5792
# details were needed.
 
5793
from bzrlib.cmd_version_info import cmd_version_info
2828
5794
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore
2829
 
from bzrlib.bundle.commands import cmd_bundle_revisions
 
5795
from bzrlib.bundle.commands import (
 
5796
    cmd_bundle_info,
 
5797
    )
 
5798
from bzrlib.foreign import cmd_dpush
2830
5799
from bzrlib.sign_my_commits import cmd_sign_my_commits
2831
 
from bzrlib.weave_commands import cmd_weave_list, cmd_weave_join, \
 
5800
from bzrlib.weave_commands import cmd_versionedfile_list, \
2832
5801
        cmd_weave_plan_merge, cmd_weave_merge_text