/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/builtins.py

  • Committer: Ian Clatworthy
  • Date: 2010-03-30 20:13:52 UTC
  • mto: This revision was merged to the branch mainline in revision 5125.
  • Revision ID: ian.clatworthy@canonical.com-20100330201352-vw2gtujybyg3rvwc
whitespace fix in win32 installer

Show diffs side-by-side

added added

removed removed

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