← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/builtins.py

  • Committer: John Arbash Meinel
  • Date: 2010-08-02 17:16:12 UTC
  • mto: This revision was merged to the branch mainline in revision 5369.
  • Revision ID: john@arbash-meinel.com-20100802171612-rdh5ods70w2bl3j7
We also have to re-implement it for _simple_set_pyx.pyx

Show diffs side-by-side

added added

removed removed

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