← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/builtins.py

  • Committer: Martin Packman
  • Date: 2012-03-27 17:32:19 UTC
  • mto: (6437.54.3 2.5)
  • mto: This revision was merged to the branch mainline in revision 6525.
  • Revision ID: martin.packman@canonical.com-20120327173219-401pil42gke8j0xh
https://launchpad.net/bugs/940704
Fall back to sys.prefix not /usr when looking for .mo files

Show diffs side-by-side

added added

removed removed

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