← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/builtins.py

  • Committer: Neil Martinsen-Burrell
  • Date: 2012-04-11 02:22:42 UTC
  • mto: This revision was merged to the branch mainline in revision 6521.
  • Revision ID: nmb@wartburg.edu-20120411022242-ipigxsc6v6bnxnji
pass in tag dictionary instead of branch

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