← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/builtins.py

  • Committer: Alexander Belchenko
  • Date: 2006-07-30 16:43:12 UTC
  • mto: (1711.2.111 jam-integration)
  • mto: This revision was merged to the branch mainline in revision 1906.
  • Revision ID: bialix@ukr.net-20060730164312-b025fd3ff0cee59e
rename  gpl.txt => COPYING.txt

Show diffs side-by-side

added added

removed removed

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