← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/builtins.py

  • Committer: Vincent Ladeuil
  • Date: 2011-08-12 09:49:24 UTC
  • mfrom: (6015.9.10 2.4)
  • mto: This revision was merged to the branch mainline in revision 6066.
  • Revision ID: v.ladeuil+lp@free.fr-20110812094924-knc5s0g7vs31a2f1
Merge 2.4 into trunk

Show diffs side-by-side

added added

removed removed

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