← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/builtins.py

  • Committer: Robert Collins
  • Date: 2007-04-19 02:27:44 UTC
  • mto: This revision was merged to the branch mainline in revision 2426.
  • Revision ID: robertc@robertcollins.net-20070419022744-pfdqz42kp1wizh43
``make docs`` now creates a man page at ``man1/bzr.1`` fixing bug 107388.
(Robert Collins)

Show diffs side-by-side

added added

removed removed

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