/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to bzrlib/builtins.py

  • Committer: Neil Martinsen-Burrell
  • Date: 2009-12-11 00:00:04 UTC
  • mto: (4892.1.1 integration)
  • mto: This revision was merged to the branch mainline in revision 4893.
  • Revision ID: nmb@wartburg.edu-20091211000004-zwb6gatjrsig4q1g
Fixes from Vicent and Martins reviews

Show diffs side-by-side

added added

removed removed

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