~bzr-pqm/bzr/bzr.dev

3955.1.5 by Jonathan Lange
NEWS update and copyright update.
1
# Copyright (C) 2004, 2005, 2006, 2007, 2008, 2009 Canonical Ltd
1887.1.1 by Adeodato Simó
Do not separate paragraphs in the copyright statement with blank lines,
2
#
1147 by Martin Pool
- split builtin commands into separate module bzrlib.builtins;
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
1887.1.1 by Adeodato Simó
Do not separate paragraphs in the copyright statement with blank lines,
7
#
1147 by Martin Pool
- split builtin commands into separate module bzrlib.builtins;
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11
# GNU General Public License for more details.
1887.1.1 by Adeodato Simó
Do not separate paragraphs in the copyright statement with blank lines,
12
#
1147 by Martin Pool
- split builtin commands into separate module bzrlib.builtins;
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
4183.7.1 by Sabin Iacob
update FSF mailing address
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
1147 by Martin Pool
- split builtin commands into separate module bzrlib.builtins;
16
1185.33.90 by Martin Pool
[merge] add --dry-run option (mpe)
17
"""builtin bzr commands"""
18
1996.3.1 by John Arbash Meinel
Demandloading builtins.py drops our load time from 350ms to 291ms
19
import os
1185.33.90 by Martin Pool
[merge] add --dry-run option (mpe)
20
1996.3.1 by John Arbash Meinel
Demandloading builtins.py drops our load time from 350ms to 291ms
21
from bzrlib.lazy_import import lazy_import
22
lazy_import(globals(), """
1685.1.52 by John Arbash Meinel
[merge] bzr.dev 1704
23
import codecs
3224.5.1 by Andrew Bennetts
Lots of assorted hackery to reduce the number of imports for common operations. Improves 'rocks', 'st' and 'help' times by ~50ms on my laptop.
24
import cStringIO
1147 by Martin Pool
- split builtin commands into separate module bzrlib.builtins;
25
import sys
1551.12.8 by Aaron Bentley
Add merge-directive command
26
import time
1147 by Martin Pool
- split builtin commands into separate module bzrlib.builtins;
27
1773.4.2 by Martin Pool
Cleanup of imports; undeprecate all_revision_ids()
28
import bzrlib
1836.1.26 by John Arbash Meinel
[merge] bzr.dev 1869
29
from bzrlib import (
2376.4.22 by Jonathan Lange
Variety of whitespace cleanups, tightening of tests and docstring changes in
30
    bugtracker,
1836.1.26 by John Arbash Meinel
[merge] bzr.dev 1869
31
    bundle,
3770.1.2 by John Arbash Meinel
Add a --raw output for dump-btree.
32
    btree_index,
1836.1.26 by John Arbash Meinel
[merge] bzr.dev 1869
33
    bzrdir,
2225.1.1 by Aaron Bentley
Added revert change display, with tests
34
    delta,
1836.1.26 by John Arbash Meinel
[merge] bzr.dev 1869
35
    config,
36
    errors,
2298.8.1 by Kent Gibson
Normalise ignore patterns to use '/' path separator.
37
    globbing,
4119.3.2 by Robert Collins
Migrate existing hooks over to the new HookPoint infrastructure.
38
    hooks,
1836.1.26 by John Arbash Meinel
[merge] bzr.dev 1869
39
    log,
1996.3.5 by John Arbash Meinel
Cleanup, deprecated, and get the tests passing again.
40
    merge as _mod_merge,
1551.12.8 by Aaron Bentley
Add merge-directive command
41
    merge_directive,
1836.1.26 by John Arbash Meinel
[merge] bzr.dev 1869
42
    osutils,
2796.2.5 by Aaron Bentley
Implement reconfigure command
43
    reconfigure,
3193.8.18 by Aaron Bentley
Move all rename-guessing into RenameMap
44
    rename_map,
2598.5.1 by Aaron Bentley
Start eliminating the use of None to indicate null revision
45
    revision as _mod_revision,
2204.5.5 by Aaron Bentley
Remove RepositoryFormat.set_default_format, deprecate get_format_type
46
    symbol_versioning,
1836.1.26 by John Arbash Meinel
[merge] bzr.dev 1869
47
    transport,
48
    ui,
49
    urlutils,
3586.1.20 by Ian Clatworthy
centralise formatting of view file lists
50
    views,
1836.1.26 by John Arbash Meinel
[merge] bzr.dev 1869
51
    )
1996.3.1 by John Arbash Meinel
Demandloading builtins.py drops our load time from 350ms to 291ms
52
from bzrlib.branch import Branch
2120.7.2 by Aaron Bentley
Move autoresolve functionality to workingtree
53
from bzrlib.conflicts import ConflictList
3936.3.40 by Ian Clatworthy
review feedback from jam
54
from bzrlib.revisionspec import RevisionSpec, RevisionInfo
2535.2.1 by Adeodato Simó
New SMTPConnection class, a reduced version of that in bzr-email.
55
from bzrlib.smtp_connection import SMTPConnection
1996.3.1 by John Arbash Meinel
Demandloading builtins.py drops our load time from 350ms to 291ms
56
from bzrlib.workingtree import WorkingTree
57
""")
58
1185.12.56 by Aaron Bentley
Prevented display commands from printing broken pipe errors
59
from bzrlib.commands import Command, display_command
3921.3.9 by Marius Kruger
* add some blackbox tests and another whitebox test
60
from bzrlib.option import (
61
    ListOption,
62
    Option,
63
    RegistryOption,
64
    custom_help,
65
    _parse_revision_str,
66
    )
3874.1.4 by Vincent Ladeuil
Fixed as per Aarons' comment.
67
from bzrlib.trace import mutter, note, warning, is_quiet, get_verbosity_level
1147 by Martin Pool
- split builtin commands into separate module bzrlib.builtins;
68
69
3586.1.32 by Ian Clatworthy
merge bzr.dev r3998
70
def tree_files(file_list, default_branch=u'.', canonicalize=True,
71
    apply_view=True):
1185.35.28 by Aaron Bentley
Support diff with two branches as input.
72
    try:
3586.1.32 by Ian Clatworthy
merge bzr.dev r3998
73
        return internal_tree_files(file_list, default_branch, canonicalize,
74
            apply_view)
1996.3.34 by John Arbash Meinel
Update builtins to use errors.foo. Now errors can be avoided entirely for a bzr rocks run
75
    except errors.FileInWrongBranch, e:
76
        raise errors.BzrCommandError("%s is not in the same branch as %s" %
77
                                     (e.path, file_list[0]))
1185.35.28 by Aaron Bentley
Support diff with two branches as input.
78
1185.85.12 by John Arbash Meinel
Refactoring AddAction to allow redirecting to an encoding file.
79
3586.1.34 by Ian Clatworthy
fix tree/path handling for add
80
def tree_files_for_add(file_list):
4301.2.2 by Aaron Bentley
Update style
81
    """
82
    Return a tree and list of absolute paths from a file list.
83
84
    Similar to tree_files, but add handles files a bit differently, so it a
85
    custom implementation.  In particular, MutableTreeTree.smart_add expects
86
    absolute paths, which it immediately converts to relative paths.
87
    """
88
    # FIXME Would be nice to just return the relative paths like
89
    # internal_tree_files does, but there are a large number of unit tests
90
    # that assume the current interface to mutabletree.smart_add
3586.1.34 by Ian Clatworthy
fix tree/path handling for add
91
    if file_list:
4301.1.1 by Geoff Bache
Fixing bug 183831, where 'bzr add' fails with a python stack if the path contains a symbolic link
92
        tree, relpath = WorkingTree.open_containing(file_list[0])
4301.2.5 by Aaron Bentley
Move file_list updates after view_files check.
93
        if tree.supports_views():
94
            view_files = tree.views.lookup_view()
95
            if view_files:
96
                for filename in file_list:
97
                    if not osutils.is_inside_any(view_files, filename):
98
                        raise errors.FileOutsideView(filename, view_files)
4301.2.4 by Aaron Bentley
Further cleanups
99
        file_list = file_list[:]
4301.2.3 by Aaron Bentley
Clean up tree_add_files
100
        file_list[0] = tree.abspath(relpath)
3586.1.34 by Ian Clatworthy
fix tree/path handling for add
101
    else:
102
        tree = WorkingTree.open_containing(u'.')[0]
103
        if tree.supports_views():
104
            view_files = tree.views.lookup_view()
105
            if view_files:
106
                file_list = view_files
107
                view_str = views.view_display_str(view_files)
4210.1.1 by Ian Clatworthy
reword 'ignoring files outside view' message
108
                note("Ignoring files outside view. View is %s" % view_str)
4301.2.3 by Aaron Bentley
Clean up tree_add_files
109
    return tree, file_list
3586.1.34 by Ian Clatworthy
fix tree/path handling for add
110
111
3984.3.5 by Daniel Watkins
Changed from option type to helper function.
112
def _get_one_revision(command_name, revisions):
113
    if revisions is None:
114
        return None
115
    if len(revisions) != 1:
116
        raise errors.BzrCommandError(
117
            'bzr %s --revision takes exactly one revision identifier' % (
118
                command_name,))
119
    return revisions[0]
120
121
3732.1.1 by Ian Clatworthy
fix bzr st -rbranch:path-to-branch (Lukas Lalinsky)
122
def _get_one_revision_tree(command_name, revisions, branch=None, tree=None):
3655.3.1 by Lukáš Lalinský
Fix `bzr st -rbranch:PATH_TO_BRANCH`
123
    if branch is None:
124
        branch = tree.branch
3732.1.1 by Ian Clatworthy
fix bzr st -rbranch:path-to-branch (Lukas Lalinsky)
125
    if revisions is None:
3655.3.1 by Lukáš Lalinský
Fix `bzr st -rbranch:PATH_TO_BRANCH`
126
        if tree is not None:
127
            rev_tree = tree.basis_tree()
128
        else:
129
            rev_tree = branch.basis_tree()
130
    else:
3984.3.5 by Daniel Watkins
Changed from option type to helper function.
131
        revision = _get_one_revision(command_name, revisions)
132
        rev_tree = revision.as_tree(branch)
3655.3.1 by Lukáš Lalinský
Fix `bzr st -rbranch:PATH_TO_BRANCH`
133
    return rev_tree
134
135
1658.1.9 by Martin Pool
Give an error for bzr diff on an nonexistent file (Malone #3619)
136
# XXX: Bad function name; should possibly also be a class method of
137
# WorkingTree rather than a function.
3586.1.32 by Ian Clatworthy
merge bzr.dev r3998
138
def internal_tree_files(file_list, default_branch=u'.', canonicalize=True,
139
    apply_view=True):
1658.1.8 by Martin Pool
(internal_tree_files) Better docstring
140
    """Convert command-line paths to a WorkingTree and relative paths.
141
142
    This is typically used for command-line processors that take one or
143
    more filenames, and infer the workingtree that contains them.
144
145
    The filenames given are not required to exist.
146
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
147
    :param file_list: Filenames to convert.
1658.1.8 by Martin Pool
(internal_tree_files) Better docstring
148
2091.3.2 by Aaron Bentley
Traverse non-terminal symlinks for mv et al
149
    :param default_branch: Fallback tree path to use if file_list is empty or
150
        None.
1658.1.8 by Martin Pool
(internal_tree_files) Better docstring
151
3586.1.9 by Ian Clatworthy
first cut at view command
152
    :param apply_view: if True and a view is set, apply it or check that
153
        specified files are within it
154
1658.1.8 by Martin Pool
(internal_tree_files) Better docstring
155
    :return: workingtree, [relative_paths]
1185.12.101 by Aaron Bentley
Made commit take branch from first argument, if supplied.
156
    """
157
    if file_list is None or len(file_list) == 0:
3586.1.9 by Ian Clatworthy
first cut at view command
158
        tree = WorkingTree.open_containing(default_branch)[0]
159
        if tree.supports_views() and apply_view:
160
            view_files = tree.views.lookup_view()
161
            if view_files:
162
                file_list = view_files
3586.1.20 by Ian Clatworthy
centralise formatting of view file lists
163
                view_str = views.view_display_str(view_files)
4210.1.1 by Ian Clatworthy
reword 'ignoring files outside view' message
164
                note("Ignoring files outside view. View is %s" % view_str)
3586.1.9 by Ian Clatworthy
first cut at view command
165
        return tree, file_list
2091.3.5 by Aaron Bentley
Move realpath functionality into osutils
166
    tree = WorkingTree.open_containing(osutils.realpath(file_list[0]))[0]
3586.1.32 by Ian Clatworthy
merge bzr.dev r3998
167
    return tree, safe_relpath_files(tree, file_list, canonicalize,
168
        apply_view=apply_view)
169
170
171
def safe_relpath_files(tree, file_list, canonicalize=True, apply_view=True):
3602.1.1 by Robert Collins
Add support for -x or --exclude to bzr commit, fixing bug 3117. (Robert Collins)
172
    """Convert file_list into a list of relpaths in tree.
173
174
    :param tree: A tree to operate on.
175
    :param file_list: A list of user provided paths or None.
3586.1.18 by Ian Clatworthy
merge bzr.dev r3606
176
    :param apply_view: if True and a view is set, apply it or check that
177
        specified files are within it
3602.1.1 by Robert Collins
Add support for -x or --exclude to bzr commit, fixing bug 3117. (Robert Collins)
178
    :return: A list of relative paths.
179
    :raises errors.PathNotChild: When a provided path is in a different tree
180
        than tree.
181
    """
182
    if file_list is None:
183
        return None
3586.1.9 by Ian Clatworthy
first cut at view command
184
    if tree.supports_views() and apply_view:
185
        view_files = tree.views.lookup_view()
186
    else:
187
        view_files = []
1185.12.101 by Aaron Bentley
Made commit take branch from first argument, if supplied.
188
    new_list = []
3794.5.37 by Mark Hammond
Canonicalization is now done via a param to file_list.
189
    # tree.relpath exists as a "thunk" to osutils, but canonical_relpath
190
    # doesn't - fix that up here before we enter the loop.
191
    if canonicalize:
192
        fixer = lambda p: osutils.canonical_relpath(tree.basedir, p)
193
    else:
194
        fixer = tree.relpath
1185.12.101 by Aaron Bentley
Made commit take branch from first argument, if supplied.
195
    for filename in file_list:
1185.35.32 by Aaron Bentley
Fixed handling of files in mixed branches
196
        try:
3586.1.32 by Ian Clatworthy
merge bzr.dev r3998
197
            relpath = fixer(osutils.dereference_path(filename))
3586.1.20 by Ian Clatworthy
centralise formatting of view file lists
198
            if  view_files and not osutils.is_inside_any(view_files, relpath):
3586.1.9 by Ian Clatworthy
first cut at view command
199
                raise errors.FileOutsideView(filename, view_files)
200
            new_list.append(relpath)
1185.31.45 by John Arbash Meinel
Refactoring Exceptions found some places where the wrong exception was caught.
201
        except errors.PathNotChild:
1996.3.34 by John Arbash Meinel
Update builtins to use errors.foo. Now errors can be avoided entirely for a bzr rocks run
202
            raise errors.FileInWrongBranch(tree.branch, filename)
3602.1.1 by Robert Collins
Add support for -x or --exclude to bzr commit, fixing bug 3117. (Robert Collins)
203
    return new_list
1553.5.78 by Martin Pool
New bzr init --format option and test
204
205
3586.1.31 by Ian Clatworthy
view filtering for pull, update & merge
206
def _get_view_info_for_change_reporter(tree):
207
    """Get the view information from a tree for change reporting."""
208
    view_info = None
209
    try:
210
        current_view = tree.views.get_view_info()[0]
211
        if current_view is not None:
212
            view_info = (current_view, tree.views.lookup_view())
213
    except errors.ViewsNotSupported:
214
        pass
215
    return view_info
216
217
1185.16.112 by mbp at sourcefrog
todo
218
# TODO: Make sure no commands unconditionally use the working directory as a
219
# branch.  If a filename argument is used, the first of them should be used to
220
# specify the branch.  (Perhaps this can be factored out into some kind of
221
# Argument class, representing a file in a branch, where the first occurrence
222
# opens the branch?)
223
1147 by Martin Pool
- split builtin commands into separate module bzrlib.builtins;
224
class cmd_status(Command):
225
    """Display status summary.
226
227
    This reports on versioned and unknown files, reporting them
228
    grouped by state.  Possible states are:
229
1551.10.10 by Aaron Bentley
Add help text
230
    added
1147 by Martin Pool
- split builtin commands into separate module bzrlib.builtins;
231
        Versioned in the working copy but not in the previous revision.
232
1551.10.10 by Aaron Bentley
Add help text
233
    removed
1147 by Martin Pool
- split builtin commands into separate module bzrlib.builtins;
234
        Versioned in the previous revision but removed or deleted
235
        in the working copy.
236
1551.10.10 by Aaron Bentley
Add help text
237
    renamed
1147 by Martin Pool
- split builtin commands into separate module bzrlib.builtins;
238
        Path of this file changed from the previous revision;
239
        the text may also have changed.  This includes files whose
240
        parent directory was renamed.
241
1551.10.10 by Aaron Bentley
Add help text
242
    modified
1147 by Martin Pool
- split builtin commands into separate module bzrlib.builtins;
243
        Text has changed since the previous revision.
244
1551.10.10 by Aaron Bentley
Add help text
245
    kind changed
246
        File kind has been changed (e.g. from file to directory).
247
248
    unknown
1147 by Martin Pool
- split builtin commands into separate module bzrlib.builtins;
249
        Not versioned and not matching an ignore pattern.
250
2374.1.1 by Ian Clatworthy
Help and man page fixes
251
    To see ignored files use 'bzr ignored'.  For details on the
1147 by Martin Pool
- split builtin commands into separate module bzrlib.builtins;
252
    changes to file texts, use 'bzr diff'.
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
253
2792.1.1 by Ian Clatworthy
Add short options to status to assist migrating svn users (Daniel Watkins)
254
    Note that --short or -S gives status flags for each item, similar
255
    to Subversion's status command. To get output similar to svn -q,
3504.3.1 by Andrew Bennetts
Fix trivial bug in 'bzr help status' reported by mlh on #bzr.
256
    use bzr status -SV.
1551.10.10 by Aaron Bentley
Add help text
257
1147 by Martin Pool
- split builtin commands into separate module bzrlib.builtins;
258
    If no arguments are specified, the status of the entire working
259
    directory is shown.  Otherwise, only the status of the specified
260
    files or directories is reported.  If a directory is given, status
261
    is reported for everything inside that directory.
1185.1.35 by Robert Collins
Heikki Paajanen's status -r patch
262
3936.2.2 by Ian Clatworthy
add NEWS item & improve status help
263
    Before merges are committed, the pending merge tip revisions are
264
    shown. To see all pending merge revisions, use the -v option.
265
    To skip the display of pending merge information altogether, use
266
    the no-pending option or specify a file/directory.
267
1185.1.35 by Robert Collins
Heikki Paajanen's status -r patch
268
    If a revision argument is given, the status is calculated against
269
    that revision, or between two revisions if two are provided.
1185.3.2 by Martin Pool
- remove -r option from status command because it's not used
270
    """
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
271
1185.16.76 by Martin Pool
doc
272
    # TODO: --no-recurse, --recurse options
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
273
1147 by Martin Pool
- split builtin commands into separate module bzrlib.builtins;
274
    takes_args = ['file*']
3936.2.1 by Ian Clatworthy
verbose flag for status - code & tests
275
    takes_options = ['show-ids', 'revision', 'change', 'verbose',
2792.1.1 by Ian Clatworthy
Add short options to status to assist migrating svn users (Daniel Watkins)
276
                     Option('short', help='Use short status indicators.',
2663.1.7 by Daniel Watkins
Capitalised short names.
277
                            short_name='S'),
2663.1.5 by Daniel Watkins
Changed 'bzr stat --quiet' to 'bzr stat -(vs|sv)', as per list suggestions.
278
                     Option('versioned', help='Only show versioned files.',
3270.6.1 by James Westby
Add --no-pending to status to not show the pending merges. (#202830)
279
                            short_name='V'),
280
                     Option('no-pending', help='Don\'t show pending merges.',
281
                           ),
2663.1.5 by Daniel Watkins
Changed 'bzr stat --quiet' to 'bzr stat -(vs|sv)', as per list suggestions.
282
                     ]
1147 by Martin Pool
- split builtin commands into separate module bzrlib.builtins;
283
    aliases = ['st', 'stat']
1185.85.22 by John Arbash Meinel
Updated cmd_inventory. Changing from having each Command request an encoded stdout to providing one before calling run()
284
285
    encoding_type = 'replace'
2520.1.3 by Daniel Watkins
'help status' now points to 'help status-flags'.
286
    _see_also = ['diff', 'revert', 'status-flags']
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
287
1185.12.56 by Aaron Bentley
Prevented display commands from printing broken pipe errors
288
    @display_command
2318.2.1 by Kent Gibson
Apply status versioned patch
289
    def run(self, show_ids=False, file_list=None, revision=None, short=False,
3936.2.1 by Ian Clatworthy
verbose flag for status - code & tests
290
            versioned=False, no_pending=False, verbose=False):
1551.2.9 by Aaron Bentley
Fix status to work with checkouts
291
        from bzrlib.status import show_tree_status
1185.85.15 by John Arbash Meinel
Updated bzr status, adding test_cat
292
2745.4.2 by Lukáš Lalinsky
Allow options to be stored in attributes that differ from their 'name' and use this to let '--change' and '--revision' to override each other.
293
        if revision and len(revision) > 2:
294
            raise errors.BzrCommandError('bzr status --revision takes exactly'
295
                                         ' one or two revision specifiers')
2745.4.1 by Lukáš Lalinsky
New option -C/--change for diff and status to show changes in one revision. (#56299)
296
3636.1.1 by Robert Collins
Stop passing specific_file lists to show_tree_status when the specific
297
        tree, relfile_list = tree_files(file_list)
298
        # Avoid asking for specific files when that is not needed.
299
        if relfile_list == ['']:
300
            relfile_list = None
301
            # Don't disable pending merges for full trees other than '.'.
302
            if file_list == ['.']:
303
                no_pending = True
304
        # A specific path within a tree was given.
305
        elif relfile_list is not None:
306
            no_pending = True
1773.1.2 by Robert Collins
Remove --all option from status.
307
        show_tree_status(tree, show_ids=show_ids,
3636.1.1 by Robert Collins
Stop passing specific_file lists to show_tree_status when the specific
308
                         specific_files=relfile_list, revision=revision,
3270.6.1 by James Westby
Add --no-pending to status to not show the pending merges. (#202830)
309
                         to_file=self.outf, short=short, versioned=versioned,
3936.2.1 by Ian Clatworthy
verbose flag for status - code & tests
310
                         show_pending=(not no_pending), verbose=verbose)
1147 by Martin Pool
- split builtin commands into separate module bzrlib.builtins;
311
312
313
class cmd_cat_revision(Command):
1185.5.3 by John Arbash Meinel
cat-revision allows --revision for easier investigation.
314
    """Write out metadata for a revision.
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
315
1185.5.3 by John Arbash Meinel
cat-revision allows --revision for easier investigation.
316
    The revision to print can either be specified by a specific
317
    revision identifier, or you can use --revision.
318
    """
1147 by Martin Pool
- split builtin commands into separate module bzrlib.builtins;
319
320
    hidden = True
1185.5.3 by John Arbash Meinel
cat-revision allows --revision for easier investigation.
321
    takes_args = ['revision_id?']
322
    takes_options = ['revision']
1685.1.76 by Wouter van Heyst
codecleanup
323
    # cat-revision is more for frontends so should be exact
324
    encoding = 'strict'
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
325
1185.12.56 by Aaron Bentley
Prevented display commands from printing broken pipe errors
326
    @display_command
1185.5.3 by John Arbash Meinel
cat-revision allows --revision for easier investigation.
327
    def run(self, revision_id=None, revision=None):
328
        if revision_id is not None and revision is not None:
1996.3.34 by John Arbash Meinel
Update builtins to use errors.foo. Now errors can be avoided entirely for a bzr rocks run
329
            raise errors.BzrCommandError('You can only supply one of'
330
                                         ' revision_id or --revision')
1185.5.3 by John Arbash Meinel
cat-revision allows --revision for easier investigation.
331
        if revision_id is None and revision is None:
1996.3.34 by John Arbash Meinel
Update builtins to use errors.foo. Now errors can be avoided entirely for a bzr rocks run
332
            raise errors.BzrCommandError('You must supply either'
333
                                         ' --revision or a revision_id')
1185.33.66 by Martin Pool
[patch] use unicode literals for all hardcoded paths (Alexander Belchenko)
334
        b = WorkingTree.open_containing(u'.')[0].branch
1185.85.72 by John Arbash Meinel
Fix some of the tests.
335
336
        # TODO: jam 20060112 should cat-revision always output utf-8?
1185.5.3 by John Arbash Meinel
cat-revision allows --revision for easier investigation.
337
        if revision_id is not None:
2858.2.1 by Martin Pool
Remove most calls to safe_file_id and safe_revision_id.
338
            revision_id = osutils.safe_revision_id(revision_id, warn=False)
3668.4.1 by Jelmer Vernooij
Show proper error rather than traceback when an unknown revision id is specified to bzr cat-revision.
339
            try:
340
                self.outf.write(b.repository.get_revision_xml(revision_id).decode('utf-8'))
341
            except errors.NoSuchRevision:
342
                msg = "The repository %s contains no revision %s." % (b.repository.base,
343
                    revision_id)
344
                raise errors.BzrCommandError(msg)
1185.5.3 by John Arbash Meinel
cat-revision allows --revision for easier investigation.
345
        elif revision is not None:
346
            for rev in revision:
347
                if rev is None:
1996.3.34 by John Arbash Meinel
Update builtins to use errors.foo. Now errors can be avoided entirely for a bzr rocks run
348
                    raise errors.BzrCommandError('You cannot specify a NULL'
349
                                                 ' revision.')
3298.2.14 by Aaron Bentley
Optimize revision-info and cat-revision
350
                rev_id = rev.as_revision_id(b)
1185.85.78 by John Arbash Meinel
[merge] jam-integration 1512, includes Storage changes.
351
                self.outf.write(b.repository.get_revision_xml(rev_id).decode('utf-8'))
3770.1.1 by John Arbash Meinel
First draft of a basic dump-btree command.
352
353
354
class cmd_dump_btree(Command):
3770.1.4 by John Arbash Meinel
Clarify the help text a bit.
355
    """Dump the contents of a btree index file to stdout.
356
357
    PATH is a btree index file, it can be any URL. This includes things like
358
    .bzr/repository/pack-names, or .bzr/repository/indices/a34b3a...ca4a4.iix
359
360
    By default, the tuples stored in the index file will be displayed. With
361
    --raw, we will uncompress the pages, but otherwise display the raw bytes
362
    stored in the index.
3770.1.1 by John Arbash Meinel
First draft of a basic dump-btree command.
363
    """
364
365
    # TODO: Do we want to dump the internal nodes as well?
366
    # TODO: It would be nice to be able to dump the un-parsed information,
367
    #       rather than only going through iter_all_entries. However, this is
368
    #       good enough for a start
369
    hidden = True
3770.1.2 by John Arbash Meinel
Add a --raw output for dump-btree.
370
    encoding_type = 'exact'
3770.1.1 by John Arbash Meinel
First draft of a basic dump-btree command.
371
    takes_args = ['path']
3770.1.2 by John Arbash Meinel
Add a --raw output for dump-btree.
372
    takes_options = [Option('raw', help='Write the uncompressed bytes out,'
3770.1.5 by John Arbash Meinel
Add a trailing period for the option '--raw'
373
                                        ' rather than the parsed tuples.'),
3770.1.2 by John Arbash Meinel
Add a --raw output for dump-btree.
374
                    ]
375
376
    def run(self, path, raw=False):
3770.1.1 by John Arbash Meinel
First draft of a basic dump-btree command.
377
        dirname, basename = osutils.split(path)
378
        t = transport.get_transport(dirname)
3770.1.2 by John Arbash Meinel
Add a --raw output for dump-btree.
379
        if raw:
380
            self._dump_raw_bytes(t, basename)
381
        else:
382
            self._dump_entries(t, basename)
383
384
    def _get_index_and_bytes(self, trans, basename):
385
        """Create a BTreeGraphIndex and raw bytes."""
386
        bt = btree_index.BTreeGraphIndex(trans, basename, None)
387
        bytes = trans.get_bytes(basename)
388
        bt._file = cStringIO.StringIO(bytes)
389
        bt._size = len(bytes)
390
        return bt, bytes
391
392
    def _dump_raw_bytes(self, trans, basename):
393
        import zlib
394
395
        # We need to parse at least the root node.
396
        # This is because the first page of every row starts with an
397
        # uncompressed header.
398
        bt, bytes = self._get_index_and_bytes(trans, basename)
3770.1.3 by John Arbash Meinel
Simplify the --raw mode.
399
        for page_idx, page_start in enumerate(xrange(0, len(bytes),
400
                                                     btree_index._PAGE_SIZE)):
401
            page_end = min(page_start + btree_index._PAGE_SIZE, len(bytes))
402
            page_bytes = bytes[page_start:page_end]
403
            if page_idx == 0:
3770.1.2 by John Arbash Meinel
Add a --raw output for dump-btree.
404
                self.outf.write('Root node:\n')
3770.1.3 by John Arbash Meinel
Simplify the --raw mode.
405
                header_end, data = bt._parse_header_from_bytes(page_bytes)
406
                self.outf.write(page_bytes[:header_end])
407
                page_bytes = data
408
            self.outf.write('\nPage %d\n' % (page_idx,))
409
            decomp_bytes = zlib.decompress(page_bytes)
410
            self.outf.write(decomp_bytes)
411
            self.outf.write('\n')
3770.1.2 by John Arbash Meinel
Add a --raw output for dump-btree.
412
413
    def _dump_entries(self, trans, basename):
3770.1.1 by John Arbash Meinel
First draft of a basic dump-btree command.
414
        try:
3770.1.2 by John Arbash Meinel
Add a --raw output for dump-btree.
415
            st = trans.stat(basename)
3770.1.1 by John Arbash Meinel
First draft of a basic dump-btree command.
416
        except errors.TransportNotPossible:
417
            # We can't stat, so we'll fake it because we have to do the 'get()'
418
            # anyway.
3770.1.2 by John Arbash Meinel
Add a --raw output for dump-btree.
419
            bt, _ = self._get_index_and_bytes(trans, basename)
3770.1.1 by John Arbash Meinel
First draft of a basic dump-btree command.
420
        else:
3770.1.2 by John Arbash Meinel
Add a --raw output for dump-btree.
421
            bt = btree_index.BTreeGraphIndex(trans, basename, st.st_size)
3770.1.1 by John Arbash Meinel
First draft of a basic dump-btree command.
422
        for node in bt.iter_all_entries():
423
            # Node is made up of:
424
            # (index, key, value, [references])
425
            self.outf.write('%s\n' % (node[1:],))
426
1147 by Martin Pool
- split builtin commands into separate module bzrlib.builtins;
427
2127.2.1 by Daniel Silverstone
Add remove-tree and its blackbox tests
428
class cmd_remove_tree(Command):
429
    """Remove the working tree from a given branch/checkout.
430
431
    Since a lightweight checkout is little more than a working tree
432
    this will refuse to run against one.
2374.1.3 by Ian Clatworthy
Minor man page fixes for add, commit, export
433
2374.1.4 by Ian Clatworthy
Include feedback from mailing list.
434
    To re-create the working tree, use "bzr checkout".
2127.2.1 by Daniel Silverstone
Add remove-tree and its blackbox tests
435
    """
2485.1.2 by James Westby
Update with comments from review, thanks to John and Aaron.
436
    _see_also = ['checkout', 'working-trees']
2127.2.1 by Daniel Silverstone
Add remove-tree and its blackbox tests
437
    takes_args = ['location?']
3667.2.1 by Lukáš Lalinský
Make `bzr remove-tree` not remove trees with uncommitted changes by default
438
    takes_options = [
439
        Option('force',
440
               help='Remove the working tree even if it has '
441
                    'uncommitted changes.'),
442
        ]
2127.2.1 by Daniel Silverstone
Add remove-tree and its blackbox tests
443
3667.2.1 by Lukáš Lalinský
Make `bzr remove-tree` not remove trees with uncommitted changes by default
444
    def run(self, location='.', force=False):
2127.2.2 by Daniel Silverstone
Refactor the remove-tree stuff after review from J-A-M
445
        d = bzrdir.BzrDir.open(location)
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
446
2127.2.1 by Daniel Silverstone
Add remove-tree and its blackbox tests
447
        try:
448
            working = d.open_workingtree()
2127.2.2 by Daniel Silverstone
Refactor the remove-tree stuff after review from J-A-M
449
        except errors.NoWorkingTree:
2127.2.1 by Daniel Silverstone
Add remove-tree and its blackbox tests
450
            raise errors.BzrCommandError("No working tree to remove")
2127.2.2 by Daniel Silverstone
Refactor the remove-tree stuff after review from J-A-M
451
        except errors.NotLocalUrl:
4503.1.2 by Vincent Ladeuil
Use tree.has_changes() where appropriate (the test suite caught a
452
            raise errors.BzrCommandError("You cannot remove the working tree"
453
                                         " of a remote path")
3667.2.1 by Lukáš Lalinský
Make `bzr remove-tree` not remove trees with uncommitted changes by default
454
        if not force:
4503.1.2 by Vincent Ladeuil
Use tree.has_changes() where appropriate (the test suite caught a
455
            # XXX: What about pending merges ? -- vila 20090629
456
            if working.has_changes(working.basis_tree()):
3667.2.1 by Lukáš Lalinský
Make `bzr remove-tree` not remove trees with uncommitted changes by default
457
                raise errors.UncommittedChanges(working)
458
2127.2.2 by Daniel Silverstone
Refactor the remove-tree stuff after review from J-A-M
459
        working_path = working.bzrdir.root_transport.base
460
        branch_path = working.branch.bzrdir.root_transport.base
461
        if working_path != branch_path:
4503.1.2 by Vincent Ladeuil
Use tree.has_changes() where appropriate (the test suite caught a
462
            raise errors.BzrCommandError("You cannot remove the working tree"
463
                                         " from a lightweight checkout")
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
464
2127.2.1 by Daniel Silverstone
Add remove-tree and its blackbox tests
465
        d.destroy_workingtree()
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
466
2127.2.1 by Daniel Silverstone
Add remove-tree and its blackbox tests
467
1147 by Martin Pool
- split builtin commands into separate module bzrlib.builtins;
468
class cmd_revno(Command):
469
    """Show current revision number.
470
1185.85.24 by John Arbash Meinel
Moved run_bzr_decode into TestCase
471
    This is equal to the number of revisions on this branch.
472
    """
473
2425.2.3 by Robert Collins
Update existing builtin commands help text to use _see_also. (Robert Collins)
474
    _see_also = ['info']
1185.50.16 by John Arbash Meinel
[patch] Michael Ellerman: 'Trivial patch to allow revno to take a location'
475
    takes_args = ['location?']
4409.1.1 by Matthew Fuller
Add a --tree option to revno.
476
    takes_options = [
477
        Option('tree', help='Show revno of working tree'),
478
        ]
1185.85.24 by John Arbash Meinel
Moved run_bzr_decode into TestCase
479
1185.12.56 by Aaron Bentley
Prevented display commands from printing broken pipe errors
480
    @display_command
4409.1.1 by Matthew Fuller
Add a --tree option to revno.
481
    def run(self, tree=False, location=u'.'):
4409.1.21 by Vincent Ladeuil
Fix failing test.
482
        if tree:
483
            try:
484
                wt = WorkingTree.open_containing(location)[0]
485
                wt.lock_read()
486
            except (errors.NoWorkingTree, errors.NotLocalUrl):
487
                raise errors.NoWorkingTree(location)
488
            try:
4409.1.11 by John Arbash Meinel
A bit more cleanup, using the same WT.open_containing else: B.open() paradigm.
489
                revid = wt.last_revision()
490
                try:
491
                    revno_t = wt.branch.revision_id_to_dotted_revno(revid)
492
                except errors.NoSuchRevision:
493
                    revno_t = ('???',)
494
                revno = ".".join(str(n) for n in revno_t)
4409.1.21 by Vincent Ladeuil
Fix failing test.
495
            finally:
496
                wt.unlock()
497
        else:
498
            b = Branch.open_containing(location)[0]
499
            b.lock_read()
500
            try:
4409.1.11 by John Arbash Meinel
A bit more cleanup, using the same WT.open_containing else: B.open() paradigm.
501
                revno = b.revno()
4409.1.21 by Vincent Ladeuil
Fix failing test.
502
            finally:
4409.1.11 by John Arbash Meinel
A bit more cleanup, using the same WT.open_containing else: B.open() paradigm.
503
                b.unlock()
4409.1.21 by Vincent Ladeuil
Fix failing test.
504
4409.1.1 by Matthew Fuller
Add a --tree option to revno.
505
        self.outf.write(str(revno) + '\n')
1147 by Martin Pool
- split builtin commands into separate module bzrlib.builtins;
506
1182 by Martin Pool
- more disentangling of xml storage format from objects
507
1147 by Martin Pool
- split builtin commands into separate module bzrlib.builtins;
508
class cmd_revision_info(Command):
509
    """Show revision number and revision id for a given revision identifier.
510
    """
511
    hidden = True
512
    takes_args = ['revision_info*']
3886.1.1 by Michael Hudson
support -d in the revision-info command
513
    takes_options = [
514
        'revision',
515
        Option('directory',
516
            help='Branch to examine, '
517
                 'rather than the one containing the working directory.',
518
            short_name='d',
519
            type=unicode,
520
            ),
4409.1.3 by Matthew Fuller
Add --tree option to revision-info too.
521
        Option('tree', help='Show revno of working tree'),
3886.1.1 by Michael Hudson
support -d in the revision-info command
522
        ]
1185.85.24 by John Arbash Meinel
Moved run_bzr_decode into TestCase
523
1185.12.56 by Aaron Bentley
Prevented display commands from printing broken pipe errors
524
    @display_command
4409.1.3 by Matthew Fuller
Add --tree option to revision-info too.
525
    def run(self, revision=None, directory=u'.', tree=False,
526
            revision_info_list=[]):
1147 by Martin Pool
- split builtin commands into separate module bzrlib.builtins;
527
4409.1.10 by John Arbash Meinel
Clean up 'bzr revision-info' to support revision not in the branch history.
528
        try:
529
            wt = WorkingTree.open_containing(directory)[0]
530
            b = wt.branch
531
            wt.lock_read()
532
        except (errors.NoWorkingTree, errors.NotLocalUrl):
533
            wt = None
534
            b = Branch.open_containing(directory)[0]
535
            b.lock_read()
536
        try:
537
            revision_ids = []
538
            if revision is not None:
539
                revision_ids.extend(rev.as_revision_id(b) for rev in revision)
540
            if revision_info_list is not None:
541
                for rev_str in revision_info_list:
542
                    rev_spec = RevisionSpec.from_string(rev_str)
543
                    revision_ids.append(rev_spec.as_revision_id(b))
544
            # No arguments supplied, default to the last revision
545
            if len(revision_ids) == 0:
546
                if tree:
4409.1.12 by Matthew Fuller
Fix revision-info --tree so that when there IS no tree, it gives a
547
                    if wt is None:
548
                        raise errors.NoWorkingTree(directory)
4409.1.10 by John Arbash Meinel
Clean up 'bzr revision-info' to support revision not in the branch history.
549
                    revision_ids.append(wt.last_revision())
550
                else:
551
                    revision_ids.append(b.last_revision())
552
4409.1.17 by Matthew Fuller
Merge in revision-info cleanups and changes.
553
            revinfos = []
554
            maxlen = 0
4409.1.10 by John Arbash Meinel
Clean up 'bzr revision-info' to support revision not in the branch history.
555
            for revision_id in revision_ids:
4409.2.2 by Matthew Fuller
Readlock the branch around the revno-determining loop so that we don't
556
                try:
4409.1.10 by John Arbash Meinel
Clean up 'bzr revision-info' to support revision not in the branch history.
557
                    dotted_revno = b.revision_id_to_dotted_revno(revision_id)
558
                    revno = '.'.join(str(i) for i in dotted_revno)
4409.2.2 by Matthew Fuller
Readlock the branch around the revno-determining loop so that we don't
559
                except errors.NoSuchRevision:
4409.1.10 by John Arbash Meinel
Clean up 'bzr revision-info' to support revision not in the branch history.
560
                    revno = '???'
4409.2.2 by Matthew Fuller
Readlock the branch around the revno-determining loop so that we don't
561
                maxlen = max(maxlen, len(revno))
562
                revinfos.append([revno, revision_id])
563
        finally:
4409.1.10 by John Arbash Meinel
Clean up 'bzr revision-info' to support revision not in the branch history.
564
            if wt is None:
565
                b.unlock()
4409.1.3 by Matthew Fuller
Add --tree option to revision-info too.
566
            else:
4409.1.10 by John Arbash Meinel
Clean up 'bzr revision-info' to support revision not in the branch history.
567
                wt.unlock()
4409.2.1 by Matthew Fuller
Rework revision-info command so that it:
568
569
        for ri in revinfos:
4409.1.17 by Matthew Fuller
Merge in revision-info cleanups and changes.
570
            self.outf.write('%*s %s\n' % (maxlen, ri[0], ri[1]))
1147 by Martin Pool
- split builtin commands into separate module bzrlib.builtins;
571
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
572
1147 by Martin Pool
- split builtin commands into separate module bzrlib.builtins;
573
class cmd_add(Command):
574
    """Add specified files or directories.
575
576
    In non-recursive mode, all the named items are added, regardless
577
    of whether they were previously ignored.  A warning is given if
578
    any of the named files are already versioned.
579
580
    In recursive mode (the default), files are treated the same way
581
    but the behaviour for directories is different.  Directories that
582
    are already versioned do not give a warning.  All directories,
583
    whether already versioned or not, are searched for files or
584
    subdirectories that are neither versioned or ignored, and these
585
    are added.  This search proceeds recursively into versioned
586
    directories.  If no names are given '.' is assumed.
587
588
    Therefore simply saying 'bzr add' will version all files that
589
    are currently unknown.
590
1185.3.3 by Martin Pool
- patch from mpe to automatically add parent directories
591
    Adding a file whose parent directory is not versioned will
592
    implicitly add the parent, and so on up to the root. This means
1759.2.1 by Jelmer Vernooij
Fix some types (found using aspell).
593
    you should never need to explicitly add a directory, they'll just
1185.3.3 by Martin Pool
- patch from mpe to automatically add parent directories
594
    get added when you add a file in the directory.
1185.33.90 by Martin Pool
[merge] add --dry-run option (mpe)
595
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
596
    --dry-run will show which files would be added, but not actually
1185.33.90 by Martin Pool
[merge] add --dry-run option (mpe)
597
    add them.
1911.3.2 by John Arbash Meinel
Adding the AddFromBaseAction, which tries to reuse file ids from another tree
598
599
    --file-ids-from will try to use the file ids from the supplied path.
600
    It looks up ids trying to find a matching parent directory with the
2374.1.3 by Ian Clatworthy
Minor man page fixes for add, commit, export
601
    same filename, and then by pure path. This option is rarely needed
602
    but can be useful when adding the same logical file into two
603
    branches that will be merged later (without showing the two different
2374.1.4 by Ian Clatworthy
Include feedback from mailing list.
604
    adds as a conflict). It is also useful when merging another project
605
    into a subdirectory of this one.
1147 by Martin Pool
- split builtin commands into separate module bzrlib.builtins;
606
    """
607
    takes_args = ['file*']
2598.1.10 by Martin Pool
Clean up options that are registered globally and used once or not at all.
608
    takes_options = [
609
        Option('no-recurse',
2598.1.11 by Martin Pool
Insist that all options have a help string and fix those that don't.
610
               help="Don't recursively add the contents of directories."),
2598.1.10 by Martin Pool
Clean up options that are registered globally and used once or not at all.
611
        Option('dry-run',
612
               help="Show what would be done, but don't actually do anything."),
613
        'verbose',
614
        Option('file-ids-from',
615
               type=unicode,
616
               help='Lookup file ids from this tree.'),
617
        ]
1185.85.22 by John Arbash Meinel
Updated cmd_inventory. Changing from having each Command request an encoded stdout to providing one before calling run()
618
    encoding_type = 'replace'
2425.2.3 by Robert Collins
Update existing builtin commands help text to use _see_also. (Robert Collins)
619
    _see_also = ['remove']
1185.53.1 by Michael Ellerman
Add support for bzr add --dry-run
620
1911.3.2 by John Arbash Meinel
Adding the AddFromBaseAction, which tries to reuse file ids from another tree
621
    def run(self, file_list, no_recurse=False, dry_run=False, verbose=False,
622
            file_ids_from=None):
1185.53.1 by Michael Ellerman
Add support for bzr add --dry-run
623
        import bzrlib.add
624
2255.7.69 by Robert Collins
Fix all blackbox add tests, and the add --from-ids case in the UI.
625
        base_tree = None
1911.3.2 by John Arbash Meinel
Adding the AddFromBaseAction, which tries to reuse file ids from another tree
626
        if file_ids_from is not None:
627
            try:
628
                base_tree, base_path = WorkingTree.open_containing(
629
                                            file_ids_from)
630
            except errors.NoWorkingTree:
1996.3.1 by John Arbash Meinel
Demandloading builtins.py drops our load time from 350ms to 291ms
631
                base_branch, base_path = Branch.open_containing(
1911.3.2 by John Arbash Meinel
Adding the AddFromBaseAction, which tries to reuse file ids from another tree
632
                                            file_ids_from)
633
                base_tree = base_branch.basis_tree()
634
635
            action = bzrlib.add.AddFromBaseAction(base_tree, base_path,
636
                          to_file=self.outf, should_print=(not is_quiet()))
637
        else:
638
            action = bzrlib.add.AddAction(to_file=self.outf,
639
                should_print=(not is_quiet()))
640
2255.7.69 by Robert Collins
Fix all blackbox add tests, and the add --from-ids case in the UI.
641
        if base_tree:
642
            base_tree.lock_read()
643
        try:
2568.2.6 by Robert Collins
Review feedback.
644
            file_list = self._maybe_expand_globs(file_list)
3586.1.34 by Ian Clatworthy
fix tree/path handling for add
645
            tree, file_list = tree_files_for_add(file_list)
2568.2.8 by Robert Collins
Really really change the command to use the new API.
646
            added, ignored = tree.smart_add(file_list, not
2568.2.2 by Robert Collins
* New method ``_glob_expand_file_list_if_needed`` on the ``Command`` class
647
                no_recurse, action=action, save=not dry_run)
2255.7.69 by Robert Collins
Fix all blackbox add tests, and the add --from-ids case in the UI.
648
        finally:
649
            if base_tree is not None:
650
                base_tree.unlock()
1185.46.8 by Aaron Bentley
bzr add reports ignored patterns.
651
        if len(ignored) > 0:
1711.1.2 by Robert Collins
'bzr add' is now less verbose in telling you what ignore globs were
652
            if verbose:
653
                for glob in sorted(ignored.keys()):
1185.46.9 by Aaron Bentley
Added verbose option to bzr add, to list all ignored files.
654
                    for path in ignored[glob]:
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
655
                        self.outf.write("ignored %s matching \"%s\"\n"
1185.85.22 by John Arbash Meinel
Updated cmd_inventory. Changing from having each Command request an encoded stdout to providing one before calling run()
656
                                        % (path, glob))
1711.1.2 by Robert Collins
'bzr add' is now less verbose in telling you what ignore globs were
657
            else:
658
                match_len = 0
659
                for glob, paths in ignored.items():
660
                    match_len += len(paths)
1685.1.69 by Wouter van Heyst
merge bzr.dev 1740
661
                self.outf.write("ignored %d file(s).\n" % match_len)
4381.2.1 by Jason Spashett
Tweaks to bzr add messages
662
            self.outf.write("If you wish to add ignored files, "
663
                            "please add them explicitly by name. "
664
                            "(\"bzr ignored\" gives a list)\n")
1147 by Martin Pool
- split builtin commands into separate module bzrlib.builtins;
665
666
667
class cmd_mkdir(Command):
668
    """Create a new versioned directory.
669
670
    This is equivalent to creating the directory and then adding it.
671
    """
1685.1.80 by Wouter van Heyst
more code cleanup
672
1147 by Martin Pool
- split builtin commands into separate module bzrlib.builtins;
673
    takes_args = ['dir+']
1185.85.22 by John Arbash Meinel
Updated cmd_inventory. Changing from having each Command request an encoded stdout to providing one before calling run()
674
    encoding_type = 'replace'
1147 by Martin Pool
- split builtin commands into separate module bzrlib.builtins;
675
676
    def run(self, dir_list):
677
        for d in dir_list:
678
            os.mkdir(d)
1508.1.4 by Robert Collins
Convert most of the front ends commands to use WorkingTree.open_containing
679
            wt, dd = WorkingTree.open_containing(d)
1508.1.5 by Robert Collins
Move add from Branch to WorkingTree.
680
            wt.add([dd])
1685.1.80 by Wouter van Heyst
more code cleanup
681
            self.outf.write('added %s\n' % d)
1147 by Martin Pool
- split builtin commands into separate module bzrlib.builtins;
682
683
684
class cmd_relpath(Command):
685
    """Show path of a file relative to root"""
1685.1.80 by Wouter van Heyst
more code cleanup
686
1147 by Martin Pool
- split builtin commands into separate module bzrlib.builtins;
687
    takes_args = ['filename']
688
    hidden = True
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
689
1185.12.56 by Aaron Bentley
Prevented display commands from printing broken pipe errors
690
    @display_command
1147 by Martin Pool
- split builtin commands into separate module bzrlib.builtins;
691
    def run(self, filename):
1185.85.19 by John Arbash Meinel
Updated bzr relpath
692
        # TODO: jam 20050106 Can relpath return a munged path if
693
        #       sys.stdout encoding cannot represent it?
1508.1.4 by Robert Collins
Convert most of the front ends commands to use WorkingTree.open_containing
694
        tree, relpath = WorkingTree.open_containing(filename)
1185.85.22 by John Arbash Meinel
Updated cmd_inventory. Changing from having each Command request an encoded stdout to providing one before calling run()
695
        self.outf.write(relpath)
696
        self.outf.write('\n')
1147 by Martin Pool
- split builtin commands into separate module bzrlib.builtins;
697
698
699
class cmd_inventory(Command):
1185.33.33 by Martin Pool
[patch] add 'bzr inventory --kind directory'; remove 'bzr directories'
700
    """Show inventory of the current working copy or a revision.
701
702
    It is possible to limit the output to a particular entry
2027.4.2 by John Arbash Meinel
Fix bug #3631, allow 'bzr inventory filename'
703
    type using the --kind option.  For example: --kind file.
704
705
    It is also possible to restrict the list of files to a specific
706
    set. For example: bzr inventory --show-ids this/file
1185.33.33 by Martin Pool
[patch] add 'bzr inventory --kind directory'; remove 'bzr directories'
707
    """
1685.1.80 by Wouter van Heyst
more code cleanup
708
1551.10.13 by Aaron Bentley
Hide 'unknowns', document alterntatives to hidden commands
709
    hidden = True
2425.2.3 by Robert Collins
Update existing builtin commands help text to use _see_also. (Robert Collins)
710
    _see_also = ['ls']
2598.1.11 by Martin Pool
Insist that all options have a help string and fix those that don't.
711
    takes_options = [
712
        'revision',
713
        'show-ids',
714
        Option('kind',
2598.1.12 by Martin Pool
Fix up --kind options
715
               help='List entries of a particular kind: file, directory, symlink.',
716
               type=unicode),
2598.1.11 by Martin Pool
Insist that all options have a help string and fix those that don't.
717
        ]
2027.4.2 by John Arbash Meinel
Fix bug #3631, allow 'bzr inventory filename'
718
    takes_args = ['file*']
719
1185.12.56 by Aaron Bentley
Prevented display commands from printing broken pipe errors
720
    @display_command
2027.4.2 by John Arbash Meinel
Fix bug #3631, allow 'bzr inventory filename'
721
    def run(self, revision=None, show_ids=False, kind=None, file_list=None):
1185.33.33 by Martin Pool
[patch] add 'bzr inventory --kind directory'; remove 'bzr directories'
722
        if kind and kind not in ['file', 'directory', 'symlink']:
2598.1.12 by Martin Pool
Fix up --kind options
723
            raise errors.BzrCommandError('invalid kind %r specified' % (kind,))
2027.4.3 by John Arbash Meinel
Change how 'bzr inventory' finds paths
724
3984.3.7 by Daniel Watkins
Fixed incorrect calls.
725
        revision = _get_one_revision('inventory', revision)
2027.4.3 by John Arbash Meinel
Change how 'bzr inventory' finds paths
726
        work_tree, file_list = tree_files(file_list)
2255.7.24 by John Arbash Meinel
Rework cmd_inventory so that it uses paths2ids and locks the trees for read.
727
        work_tree.lock_read()
728
        try:
729
            if revision is not None:
3984.3.6 by Daniel Watkins
Converted cmd_inventory to use _get_one_revision.
730
                tree = revision.as_tree(work_tree.branch)
2255.7.24 by John Arbash Meinel
Rework cmd_inventory so that it uses paths2ids and locks the trees for read.
731
732
                extra_trees = [work_tree]
733
                tree.lock_read()
734
            else:
735
                tree = work_tree
736
                extra_trees = []
737
738
            if file_list is not None:
739
                file_ids = tree.paths2ids(file_list, trees=extra_trees,
740
                                          require_versioned=True)
741
                # find_ids_across_trees may include some paths that don't
742
                # exist in 'tree'.
743
                entries = sorted((tree.id2path(file_id), tree.inventory[file_id])
744
                                 for file_id in file_ids if file_id in tree)
745
            else:
746
                entries = tree.inventory.entries()
747
        finally:
748
            tree.unlock()
749
            if tree is not work_tree:
750
                work_tree.unlock()
2027.4.2 by John Arbash Meinel
Fix bug #3631, allow 'bzr inventory filename'
751
752
        for path, entry in entries:
1185.33.33 by Martin Pool
[patch] add 'bzr inventory --kind directory'; remove 'bzr directories'
753
            if kind and kind != entry.kind:
754
                continue
1147 by Martin Pool
- split builtin commands into separate module bzrlib.builtins;
755
            if show_ids:
1185.85.22 by John Arbash Meinel
Updated cmd_inventory. Changing from having each Command request an encoded stdout to providing one before calling run()
756
                self.outf.write('%-50s %s\n' % (path, entry.file_id))
1147 by Martin Pool
- split builtin commands into separate module bzrlib.builtins;
757
            else:
1185.85.22 by John Arbash Meinel
Updated cmd_inventory. Changing from having each Command request an encoded stdout to providing one before calling run()
758
                self.outf.write(path)
759
                self.outf.write('\n')
1147 by Martin Pool
- split builtin commands into separate module bzrlib.builtins;
760
761
762
class cmd_mv(Command):
763
    """Move or rename a file.
764
2666.1.1 by Ian Clatworthy
Bazaar User Reference generated from online help
765
    :Usage:
1147 by Martin Pool
- split builtin commands into separate module bzrlib.builtins;
766
        bzr mv OLDNAME NEWNAME
2666.1.1 by Ian Clatworthy
Bazaar User Reference generated from online help
767
1147 by Martin Pool
- split builtin commands into separate module bzrlib.builtins;
768
        bzr mv SOURCE... DESTINATION
769
770
    If the last argument is a versioned directory, all the other names
771
    are moved into it.  Otherwise, there must be exactly two arguments
2123.3.1 by Steffen Eichenberg
the mv command is now able to move files that have already been moved on the file system
772
    and the file is changed to a new name.
773
774
    If OLDNAME does not exist on the filesystem but is versioned and
775
    NEWNAME does exist on the filesystem but is not versioned, mv
776
    assumes that the file has been manually moved and only updates
777
    its internal inventory to reflect that change.
778
    The same is valid when moving many SOURCE files to a DESTINATION.
1147 by Martin Pool
- split builtin commands into separate module bzrlib.builtins;
779
780
    Files cannot be moved between branches.
781
    """
1685.1.80 by Wouter van Heyst
more code cleanup
782
1147 by Martin Pool
- split builtin commands into separate module bzrlib.builtins;
783
    takes_args = ['names*']
2598.1.1 by Martin Pool
Add test for and documentation of option style, fix up existing options to comply
784
    takes_options = [Option("after", help="Move only the bzr identifier"
785
        " of the file, because the file has already been moved."),
3193.8.37 by Aaron Bentley
Finish up conversion to mv --auto.
786
        Option('auto', help='Automatically guess renames.'),
787
        Option('dry-run', help='Avoid making changes when guessing renames.'),
2598.1.1 by Martin Pool
Add test for and documentation of option style, fix up existing options to comply
788
        ]
1616.1.8 by Martin Pool
Unify 'mv', 'move', 'rename'. (#5379, Matthew Fuller)
789
    aliases = ['move', 'rename']
1185.85.26 by John Arbash Meinel
bzr mv should succeed even if it can't display the paths.
790
    encoding_type = 'replace'
791
3193.8.37 by Aaron Bentley
Finish up conversion to mv --auto.
792
    def run(self, names_list, after=False, auto=False, dry_run=False):
3193.8.35 by Aaron Bentley
Implement mv --auto.
793
        if auto:
3193.8.37 by Aaron Bentley
Finish up conversion to mv --auto.
794
            return self.run_auto(names_list, after, dry_run)
795
        elif dry_run:
796
            raise errors.BzrCommandError('--dry-run requires --auto.')
1846.1.1 by Wouter van Heyst
Don't fail on 'bzr mv', extract move tests from OldTests.
797
        if names_list is None:
798
            names_list = []
1147 by Martin Pool
- split builtin commands into separate module bzrlib.builtins;
799
        if len(names_list) < 2:
1996.3.34 by John Arbash Meinel
Update builtins to use errors.foo. Now errors can be avoided entirely for a bzr rocks run
800
            raise errors.BzrCommandError("missing file argument")
3794.5.37 by Mark Hammond
Canonicalization is now done via a param to file_list.
801
        tree, rel_names = tree_files(names_list, canonicalize=False)
4539.2.1 by Robert Collins
Change cmd_mv not to take out branch locks. (Robert Collins, bug 216541)
802
        tree.lock_tree_write()
3201.2.1 by Lukáš Lalinský
Make 'mv a b' work for already renamed directories, like it does for files
803
        try:
804
            self._run(tree, names_list, rel_names, after)
805
        finally:
806
            tree.unlock()
3246.1.1 by Alexander Belchenko
Allow rename (change case of name) directory on case-insensitive filesystem.
807
3193.8.37 by Aaron Bentley
Finish up conversion to mv --auto.
808
    def run_auto(self, names_list, after, dry_run):
3193.8.36 by Aaron Bentley
Get remaining behaviour under test.
809
        if names_list is not None and len(names_list) > 1:
810
            raise errors.BzrCommandError('Only one path may be specified to'
811
                                         ' --auto.')
3193.8.37 by Aaron Bentley
Finish up conversion to mv --auto.
812
        if after:
813
            raise errors.BzrCommandError('--after cannot be specified with'
814
                                         ' --auto.')
3193.8.35 by Aaron Bentley
Implement mv --auto.
815
        work_tree, file_list = tree_files(names_list, default_branch='.')
4539.2.1 by Robert Collins
Change cmd_mv not to take out branch locks. (Robert Collins, bug 216541)
816
        work_tree.lock_tree_write()
3193.8.35 by Aaron Bentley
Implement mv --auto.
817
        try:
3193.8.37 by Aaron Bentley
Finish up conversion to mv --auto.
818
            rename_map.RenameMap.guess_renames(work_tree, dry_run)
3193.8.35 by Aaron Bentley
Implement mv --auto.
819
        finally:
820
            work_tree.unlock()
821
3201.2.1 by Lukáš Lalinský
Make 'mv a b' work for already renamed directories, like it does for files
822
    def _run(self, tree, names_list, rel_names, after):
823
        into_existing = osutils.isdir(names_list[-1])
824
        if into_existing and len(names_list) == 2:
3249.4.1 by Alexander Belchenko
merge Lukas' patch and update it with case-insensitive rename check.
825
            # special cases:
826
            # a. case-insensitive filesystem and change case of dir
827
            # b. move directory after the fact (if the source used to be
828
            #    a directory, but now doesn't exist in the working tree
829
            #    and the target is an existing directory, just rename it)
830
            if (not tree.case_sensitive
831
                and rel_names[0].lower() == rel_names[1].lower()):
3201.2.1 by Lukáš Lalinský
Make 'mv a b' work for already renamed directories, like it does for files
832
                into_existing = False
3249.4.1 by Alexander Belchenko
merge Lukas' patch and update it with case-insensitive rename check.
833
            else:
834
                inv = tree.inventory
3794.5.6 by Mark Hammond
Don't always call osutils.canonical_relpath() on the args, but let the necessary commands do what is right for them; cmd_move and cmd_commit both now use . Move and commit call Have the move and checkin commands use get_canonical_path(). Lots new move tests.
835
                # 'fix' the case of a potential 'from'
3794.5.20 by Mark Hammond
Use get_canonical_inventory_path and get_canonical_inventory_paths, and handle more edge cases in 'mv'
836
                from_id = tree.path2id(
837
                            tree.get_canonical_inventory_path(rel_names[0]))
3249.4.1 by Alexander Belchenko
merge Lukas' patch and update it with case-insensitive rename check.
838
                if (not osutils.lexists(names_list[0]) and
839
                    from_id and inv.get_file_kind(from_id) == "directory"):
840
                    into_existing = False
841
        # move/rename
3201.2.1 by Lukáš Lalinský
Make 'mv a b' work for already renamed directories, like it does for files
842
        if into_existing:
1147 by Martin Pool
- split builtin commands into separate module bzrlib.builtins;
843
            # move into existing directory
3794.5.6 by Mark Hammond
Don't always call osutils.canonical_relpath() on the args, but let the necessary commands do what is right for them; cmd_move and cmd_commit both now use . Move and commit call Have the move and checkin commands use get_canonical_path(). Lots new move tests.
844
            # All entries reference existing inventory items, so fix them up
845
            # for cicp file-systems.
3794.5.20 by Mark Hammond
Use get_canonical_inventory_path and get_canonical_inventory_paths, and handle more edge cases in 'mv'
846
            rel_names = tree.get_canonical_inventory_paths(rel_names)
2123.3.5 by Steffen Eichenberg
specifying named parameters
847
            for pair in tree.move(rel_names[:-1], rel_names[-1], after=after):
1185.85.25 by John Arbash Meinel
updated 'bzr mv'
848
                self.outf.write("%s => %s\n" % pair)
1147 by Martin Pool
- split builtin commands into separate module bzrlib.builtins;
849
        else:
850
            if len(names_list) != 2:
2123.3.1 by Steffen Eichenberg
the mv command is now able to move files that have already been moved on the file system
851
                raise errors.BzrCommandError('to mv multiple files the'
852
                                             ' destination must be a versioned'
853
                                             ' directory')
3794.5.6 by Mark Hammond
Don't always call osutils.canonical_relpath() on the args, but let the necessary commands do what is right for them; cmd_move and cmd_commit both now use . Move and commit call Have the move and checkin commands use get_canonical_path(). Lots new move tests.
854
855
            # for cicp file-systems: the src references an existing inventory
856
            # item:
3794.5.20 by Mark Hammond
Use get_canonical_inventory_path and get_canonical_inventory_paths, and handle more edge cases in 'mv'
857
            src = tree.get_canonical_inventory_path(rel_names[0])
3794.5.6 by Mark Hammond
Don't always call osutils.canonical_relpath() on the args, but let the necessary commands do what is right for them; cmd_move and cmd_commit both now use . Move and commit call Have the move and checkin commands use get_canonical_path(). Lots new move tests.
858
            # Find the canonical version of the destination:  In all cases, the
859
            # parent of the target must be in the inventory, so we fetch the
3794.5.20 by Mark Hammond
Use get_canonical_inventory_path and get_canonical_inventory_paths, and handle more edge cases in 'mv'
860
            # canonical version from there (we do not always *use* the
861
            # canonicalized tail portion - we may be attempting to rename the
862
            # case of the tail)
863
            canon_dest = tree.get_canonical_inventory_path(rel_names[1])
864
            dest_parent = osutils.dirname(canon_dest)
865
            spec_tail = osutils.basename(rel_names[1])
866
            # For a CICP file-system, we need to avoid creating 2 inventory
867
            # entries that differ only by case.  So regardless of the case
868
            # we *want* to use (ie, specified by the user or the file-system),
869
            # we must always choose to use the case of any existing inventory
870
            # items.  The only exception to this is when we are attempting a
871
            # case-only rename (ie, canonical versions of src and dest are
872
            # the same)
873
            dest_id = tree.path2id(canon_dest)
874
            if dest_id is None or tree.path2id(src) == dest_id:
875
                # No existing item we care about, so work out what case we
876
                # are actually going to use.
877
                if after:
878
                    # If 'after' is specified, the tail must refer to a file on disk.
879
                    if dest_parent:
880
                        dest_parent_fq = osutils.pathjoin(tree.basedir, dest_parent)
881
                    else:
882
                        # pathjoin with an empty tail adds a slash, which breaks
883
                        # relpath :(
884
                        dest_parent_fq = tree.basedir
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
885
3794.5.20 by Mark Hammond
Use get_canonical_inventory_path and get_canonical_inventory_paths, and handle more edge cases in 'mv'
886
                    dest_tail = osutils.canonical_relpath(
887
                                    dest_parent_fq,
888
                                    osutils.pathjoin(dest_parent_fq, spec_tail))
3794.5.6 by Mark Hammond
Don't always call osutils.canonical_relpath() on the args, but let the necessary commands do what is right for them; cmd_move and cmd_commit both now use . Move and commit call Have the move and checkin commands use get_canonical_path(). Lots new move tests.
889
                else:
3794.5.20 by Mark Hammond
Use get_canonical_inventory_path and get_canonical_inventory_paths, and handle more edge cases in 'mv'
890
                    # not 'after', so case as specified is used
891
                    dest_tail = spec_tail
892
            else:
893
                # Use the existing item so 'mv' fails with AlreadyVersioned.
894
                dest_tail = os.path.basename(canon_dest)
3794.5.11 by Mark Hammond
whitespace/logging changes.
895
            dest = osutils.pathjoin(dest_parent, dest_tail)
3794.5.20 by Mark Hammond
Use get_canonical_inventory_path and get_canonical_inventory_paths, and handle more edge cases in 'mv'
896
            mutter("attempting to move %s => %s", src, dest)
3794.5.6 by Mark Hammond
Don't always call osutils.canonical_relpath() on the args, but let the necessary commands do what is right for them; cmd_move and cmd_commit both now use . Move and commit call Have the move and checkin commands use get_canonical_path(). Lots new move tests.
897
            tree.rename_one(src, dest, after=after)
898
            self.outf.write("%s => %s\n" % (src, dest))
3246.1.1 by Alexander Belchenko
Allow rename (change case of name) directory on case-insensitive filesystem.
899
900
1147 by Martin Pool
- split builtin commands into separate module bzrlib.builtins;
901
class cmd_pull(Command):
1649.1.1 by Robert Collins
* 'pull' and 'push' now normalise the revision history, so that any two
902
    """Turn this branch into a mirror of another branch.
1147 by Martin Pool
- split builtin commands into separate module bzrlib.builtins;
903
904
    This command only works on branches that have not diverged.  Branches are
1649.1.1 by Robert Collins
* 'pull' and 'push' now normalise the revision history, so that any two
905
    considered diverged if the destination branch's most recent commit is one
906
    that has not been merged (directly or indirectly) into the parent.
1147 by Martin Pool
- split builtin commands into separate module bzrlib.builtins;
907
1661.1.1 by Martin Pool
[merge] olaf's --remember changes
908
    If branches have diverged, you can use 'bzr merge' to integrate the changes
909
    from one into the other.  Once one branch has merged, the other should
910
    be able to pull it again.
1147 by Martin Pool
- split builtin commands into separate module bzrlib.builtins;
911
1185.12.92 by Aaron Bentley
Fixed pull help, renamed clobber to overwrite
912
    If you want to forget your local changes and just update your branch to
1661.1.1 by Martin Pool
[merge] olaf's --remember changes
913
    match the remote one, use pull --overwrite.
1614.2.3 by Olaf Conradi
In commands push and pull, moved help text for --remember down. It's not
914
915
    If there is no default location set, the first pull will set it.  After
916
    that, you can omit the location to use the default.  To change the
1785.1.4 by John Arbash Meinel
Update help for the new --remember semantics.
917
    default, use --remember. The value will only be saved if the remote
918
    location can be accessed.
3313.1.1 by Ian Clatworthy
Improve doc on send/merge relationship (Peter Schuller)
919
920
    Note: The location can be specified either in the form of a branch,
921
    or in the form of a path to a file containing a merge directive generated
922
    with bzr send.
1147 by Martin Pool
- split builtin commands into separate module bzrlib.builtins;
923
    """
1685.1.80 by Wouter van Heyst
more code cleanup
924
4095.2.1 by Neil Martinsen-Burrell
Better help for bzr send
925
    _see_also = ['push', 'update', 'status-flags', 'send']
1551.17.4 by Aaron Bentley
Make pull -v description more specific
926
    takes_options = ['remember', 'overwrite', 'revision',
2768.1.5 by Ian Clatworthy
Wrap new std verbose option with new help instead of declaring a new one
927
        custom_help('verbose',
1551.17.4 by Aaron Bentley
Make pull -v description more specific
928
            help='Show logs of pulled revisions.'),
2220.2.8 by Martin Pool
Add -d option to push, pull, merge commands.
929
        Option('directory',
2598.1.1 by Martin Pool
Add test for and documentation of option style, fix up existing options to comply
930
            help='Branch to pull into, '
931
                 'rather than the one containing the working directory.',
2220.2.8 by Martin Pool
Add -d option to push, pull, merge commands.
932
            short_name='d',
933
            type=unicode,
934
            ),
4056.6.1 by Gary van der Merwe
Add --local option to pull.
935
        Option('local',
936
            help="Perform a local pull in a bound "
937
                 "branch.  Local pulls are not applied to "
938
                 "the master branch."
939
            ),
2220.2.8 by Martin Pool
Add -d option to push, pull, merge commands.
940
        ]
2520.1.6 by Daniel Watkins
Fixed 'pull' help.
941
    takes_args = ['location?']
1185.85.27 by John Arbash Meinel
Updated bzr branch and bzr pull
942
    encoding_type = 'replace'
1147 by Martin Pool
- split builtin commands into separate module bzrlib.builtins;
943
1551.11.10 by Aaron Bentley
Add change reporting to pull
944
    def run(self, location=None, remember=False, overwrite=False,
2220.2.8 by Martin Pool
Add -d option to push, pull, merge commands.
945
            revision=None, verbose=False,
4056.6.1 by Gary van der Merwe
Add --local option to pull.
946
            directory=None, local=False):
1558.5.6 by Aaron Bentley
Renamed make-repo init-repo
947
        # FIXME: too much stuff is in the command class
1551.14.11 by Aaron Bentley
rename rev_id and other_rev_id
948
        revision_id = None
1551.14.7 by Aaron Bentley
test suite fixes
949
        mergeable = None
2220.2.8 by Martin Pool
Add -d option to push, pull, merge commands.
950
        if directory is None:
951
            directory = u'.'
1558.5.6 by Aaron Bentley
Renamed make-repo init-repo
952
        try:
2220.2.8 by Martin Pool
Add -d option to push, pull, merge commands.
953
            tree_to = WorkingTree.open_containing(directory)[0]
1558.5.6 by Aaron Bentley
Renamed make-repo init-repo
954
            branch_to = tree_to.branch
1996.3.34 by John Arbash Meinel
Update builtins to use errors.foo. Now errors can be avoided entirely for a bzr rocks run
955
        except errors.NoWorkingTree:
1558.5.6 by Aaron Bentley
Renamed make-repo init-repo
956
            tree_to = None
2220.2.8 by Martin Pool
Add -d option to push, pull, merge commands.
957
            branch_to = Branch.open_containing(directory)[0]
4056.6.4 by Gary van der Merwe
Implement pull --local.
958
        
959
        if local and not branch_to.get_bound_location():
960
            raise errors.LocalRequiresBoundBranch()
1711.3.3 by John Arbash Meinel
Allow pull to use a bundle as a target,
961
2817.4.3 by Vincent Ladeuil
Add tests for commit, reuse master branch transport.
962
        possible_transports = []
1711.3.3 by John Arbash Meinel
Allow pull to use a bundle as a target,
963
        if location is not None:
3251.4.10 by Aaron Bentley
Pull of launchpad locations works (abentley, #181945)
964
            try:
965
                mergeable = bundle.read_mergeable_from_url(location,
966
                    possible_transports=possible_transports)
967
            except errors.NotABundle:
968
                mergeable = None
1711.3.3 by John Arbash Meinel
Allow pull to use a bundle as a target,
969
1558.5.6 by Aaron Bentley
Renamed make-repo init-repo
970
        stored_loc = branch_to.get_parent()
1147 by Martin Pool
- split builtin commands into separate module bzrlib.builtins;
971
        if location is None:
972
            if stored_loc is None:
1996.3.34 by John Arbash Meinel
Update builtins to use errors.foo. Now errors can be avoided entirely for a bzr rocks run
973
                raise errors.BzrCommandError("No pull location known or"
974
                                             " specified.")
1147 by Martin Pool
- split builtin commands into separate module bzrlib.builtins;
975
            else:
1685.1.58 by Martin Pool
urlutils.unescape_for_display should return Unicode
976
                display_url = urlutils.unescape_for_display(stored_loc,
977
                        self.outf.encoding)
3200.1.1 by James Westby
Make pull --quiet more quiet. Fixes #185907.
978
                if not is_quiet():
3596.3.1 by James Westby
Give the user a bit more information about which saved location is being used.
979
                    self.outf.write("Using saved parent location: %s\n" % display_url)
1147 by Martin Pool
- split builtin commands into separate module bzrlib.builtins;
980
                location = stored_loc
1185.56.1 by Michael Ellerman
Simplify handling of DivergedBranches in cmd_pull()
981
3993.1.1 by Ian Clatworthy
helper function when only one revision required (Daniel Watkins)
982
        revision = _get_one_revision('pull', revision)
1551.14.4 by Aaron Bentley
Change bundle reader and merge directive to both be 'mergeables'
983
        if mergeable is not None:
984
            if revision is not None:
985
                raise errors.BzrCommandError(
986
                    'Cannot use -r with merge directives or bundles')
2520.4.109 by Aaron Bentley
start work on directive cherry-picking
987
            mergeable.install_revisions(branch_to.repository)
988
            base_revision_id, revision_id, verified = \
989
                mergeable.get_merge_request(branch_to.repository)
1711.3.3 by John Arbash Meinel
Allow pull to use a bundle as a target,
990
            branch_from = branch_to
991
        else:
3251.4.10 by Aaron Bentley
Pull of launchpad locations works (abentley, #181945)
992
            branch_from = Branch.open(location,
993
                possible_transports=possible_transports)
1711.3.3 by John Arbash Meinel
Allow pull to use a bundle as a target,
994
995
            if branch_to.get_parent() is None or remember:
996
                branch_to.set_parent(branch_from.base)
997
4419.2.2 by Andrew Bennetts
Read lock branch_from in cmd_pull, avoids refetching last_revision_info and so reduces test_pull acceptance ratchet.
998
        if branch_from is not branch_to:
999
            branch_from.lock_read()
1551.19.42 by Aaron Bentley
Add lock around branch pull
1000
        try:
4419.2.2 by Andrew Bennetts
Read lock branch_from in cmd_pull, avoids refetching last_revision_info and so reduces test_pull acceptance ratchet.
1001
            if revision is not None:
1002
                revision_id = revision.as_revision_id(branch_from)
1003
1004
            branch_to.lock_write()
1005
            try:
1006
                if tree_to is not None:
1007
                    view_info = _get_view_info_for_change_reporter(tree_to)
1008
                    change_reporter = delta._ChangeReporter(
1009
                        unversioned_filter=tree_to.is_ignored,
1010
                        view_info=view_info)
1011
                    result = tree_to.pull(
1012
                        branch_from, overwrite, revision_id, change_reporter,
1013
                        possible_transports=possible_transports, local=local)
1014
                else:
1015
                    result = branch_to.pull(
1016
                        branch_from, overwrite, revision_id, local=local)
1017
1018
                result.report(self.outf)
1019
                if verbose and result.old_revid != result.new_revid:
1020
                    log.show_branch_change(
1021
                        branch_to, self.outf, result.old_revno,
1022
                        result.old_revid)
1023
            finally:
1024
                branch_to.unlock()
1551.19.42 by Aaron Bentley
Add lock around branch pull
1025
        finally:
4419.2.2 by Andrew Bennetts
Read lock branch_from in cmd_pull, avoids refetching last_revision_info and so reduces test_pull acceptance ratchet.
1026
            if branch_from is not branch_to:
1027
                branch_from.unlock()
1185.31.5 by John Arbash Meinel
Merged pull --verbose changes
1028
1147 by Martin Pool
- split builtin commands into separate module bzrlib.builtins;
1029
1490 by Robert Collins
Implement a 'bzr push' command, with saved locations; update diff to return 1.
1030
class cmd_push(Command):
1649.1.1 by Robert Collins
* 'pull' and 'push' now normalise the revision history, so that any two
1031
    """Update a mirror of this branch.
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
1032
1649.1.1 by Robert Collins
* 'pull' and 'push' now normalise the revision history, so that any two
1033
    The target branch will not have its working tree populated because this
1034
    is both expensive, and is not supported on remote file systems.
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
1035
1649.1.1 by Robert Collins
* 'pull' and 'push' now normalise the revision history, so that any two
1036
    Some smart servers or protocols *may* put the working tree in place in
1037
    the future.
1490 by Robert Collins
Implement a 'bzr push' command, with saved locations; update diff to return 1.
1038
1039
    This command only works on branches that have not diverged.  Branches are
1649.1.1 by Robert Collins
* 'pull' and 'push' now normalise the revision history, so that any two
1040
    considered diverged if the destination branch's most recent commit is one
1041
    that has not been merged (directly or indirectly) by the source branch.
1490 by Robert Collins
Implement a 'bzr push' command, with saved locations; update diff to return 1.
1042
1043
    If branches have diverged, you can use 'bzr push --overwrite' to replace
1649.1.1 by Robert Collins
* 'pull' and 'push' now normalise the revision history, so that any two
1044
    the other branch completely, discarding its unmerged changes.
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
1045
1490 by Robert Collins
Implement a 'bzr push' command, with saved locations; update diff to return 1.
1046
    If you want to ensure you have the different changes in the other branch,
1649.1.1 by Robert Collins
* 'pull' and 'push' now normalise the revision history, so that any two
1047
    do a merge (see bzr help merge) from the other branch, and commit that.
1048
    After that you will be able to do a push without '--overwrite'.
1614.2.3 by Olaf Conradi
In commands push and pull, moved help text for --remember down. It's not
1049
1050
    If there is no default push location set, the first push will set it.
1051
    After that, you can omit the location to use the default.  To change the
1785.1.4 by John Arbash Meinel
Update help for the new --remember semantics.
1052
    default, use --remember. The value will only be saved if the remote
1053
    location can be accessed.
1490 by Robert Collins
Implement a 'bzr push' command, with saved locations; update diff to return 1.
1054
    """
1685.1.80 by Wouter van Heyst
more code cleanup
1055
2485.1.2 by James Westby
Update with comments from review, thanks to John and Aaron.
1056
    _see_also = ['pull', 'update', 'working-trees']
3256.1.2 by Daniel Watkins
Added revision argument to push.
1057
    takes_options = ['remember', 'overwrite', 'verbose', 'revision',
2279.3.1 by mbp at sourcefrog
Add a -d option to push, pull, merge (ported from tags branch)
1058
        Option('create-prefix',
2220.2.8 by Martin Pool
Add -d option to push, pull, merge commands.
1059
               help='Create the path leading up to the branch '
2598.1.1 by Martin Pool
Add test for and documentation of option style, fix up existing options to comply
1060
                    'if it does not already exist.'),
2220.2.8 by Martin Pool
Add -d option to push, pull, merge commands.
1061
        Option('directory',
2598.1.1 by Martin Pool
Add test for and documentation of option style, fix up existing options to comply
1062
            help='Branch to push from, '
1063
                 'rather than the one containing the working directory.',
2220.2.8 by Martin Pool
Add -d option to push, pull, merge commands.
1064
            short_name='d',
1065
            type=unicode,
1066
            ),
2279.3.1 by mbp at sourcefrog
Add a -d option to push, pull, merge (ported from tags branch)
1067
        Option('use-existing-dir',
1068
               help='By default push will fail if the target'
1069
                    ' directory exists, but does not already'
2598.1.1 by Martin Pool
Add test for and documentation of option style, fix up existing options to comply
1070
                    ' have a control directory.  This flag will'
2279.3.1 by mbp at sourcefrog
Add a -d option to push, pull, merge (ported from tags branch)
1071
                    ' allow push to proceed.'),
3549.1.1 by Martin Pool
rename push --reference to --stacked-on
1072
        Option('stacked',
1073
            help='Create a stacked branch that references the public location '
1074
                'of the parent branch.'),
1075
        Option('stacked-on',
3221.19.4 by Ian Clatworthy
shallow -> stacked
1076
            help='Create a stacked branch that refers to another branch '
3221.19.2 by Ian Clatworthy
tweaks to ui during review by igc
1077
                'for the commit history. Only the work not present in the '
1078
                'referenced branch is included in the branch created.',
3221.11.12 by Robert Collins
Basic push --reference support, requires url, slow.
1079
            type=unicode),
4420.1.2 by Vincent Ladeuil
Fix bug #284038 by adding a --strict option to push.
1080
        Option('strict',
1081
               help='Refuse to push if there are uncommitted changes in'
4464.3.11 by Vincent Ladeuil
Add a check for tree/branch sync and tweak help.
1082
               ' the working tree, --no-strict disables the check.'),
2279.3.1 by mbp at sourcefrog
Add a -d option to push, pull, merge (ported from tags branch)
1083
        ]
1490 by Robert Collins
Implement a 'bzr push' command, with saved locations; update diff to return 1.
1084
    takes_args = ['location?']
1185.85.31 by John Arbash Meinel
Updated bzr push, including bringing in the unused --verbose flag.
1085
    encoding_type = 'replace'
1490 by Robert Collins
Implement a 'bzr push' command, with saved locations; update diff to return 1.
1086
1495 by Robert Collins
Add a --create-prefix to the new push command.
1087
    def run(self, location=None, remember=False, overwrite=False,
3221.14.3 by Ian Clatworthy
Merge bzr.dev r3466
1088
        create_prefix=False, verbose=False, revision=None,
3549.1.1 by Martin Pool
rename push --reference to --stacked-on
1089
        use_existing_dir=False, directory=None, stacked_on=None,
4420.1.2 by Vincent Ladeuil
Fix bug #284038 by adding a --strict option to push.
1090
        stacked=False, strict=None):
3221.19.1 by Ian Clatworthy
refactor cmd_push to use a helper function
1091
        from bzrlib.push import _show_push_branch
1092
2220.2.8 by Martin Pool
Add -d option to push, pull, merge commands.
1093
        if directory is None:
1094
            directory = '.'
4420.1.2 by Vincent Ladeuil
Fix bug #284038 by adding a --strict option to push.
1095
        # Get the source branch
4453.1.4 by Vincent Ladeuil
Cleanup.
1096
        (tree, br_from,
1097
         _unused) = bzrdir.BzrDir.open_containing_tree_or_branch(directory)
4420.1.2 by Vincent Ladeuil
Fix bug #284038 by adding a --strict option to push.
1098
        if strict is None:
4503.2.3 by Vincent Ladeuil
Use config.get_user_option_as_bool().
1099
            strict = br_from.get_config().get_user_option_as_bool('push_strict')
4503.2.4 by Vincent Ladeuil
Be more explicit about the default value for push|send --strict.
1100
        if strict is None: strict = True # default value
4420.1.2 by Vincent Ladeuil
Fix bug #284038 by adding a --strict option to push.
1101
        # Get the tip's revision_id
3984.3.9 by Daniel Watkins
Converted cmd_push.
1102
        revision = _get_one_revision('push', revision)
3221.19.1 by Ian Clatworthy
refactor cmd_push to use a helper function
1103
        if revision is not None:
3984.3.9 by Daniel Watkins
Converted cmd_push.
1104
            revision_id = revision.in_history(br_from).rev_id
3221.19.1 by Ian Clatworthy
refactor cmd_push to use a helper function
1105
        else:
4294.2.1 by Robert Collins
Move directory checking for bzr push options into Branch.create_clone_on_transport.
1106
            revision_id = None
4503.2.4 by Vincent Ladeuil
Be more explicit about the default value for push|send --strict.
1107
        if strict and tree is not None and revision_id is None:
4503.1.2 by Vincent Ladeuil
Use tree.has_changes() where appropriate (the test suite caught a
1108
            if (tree.has_changes(tree.basis_tree())
4503.2.6 by Vincent Ladeuil
Merge trunk resolving conflicts
1109
                or len(tree.get_parent_ids()) > 1):
4487.2.6 by Vincent Ladeuil
Fixed as per jam's review.
1110
                raise errors.UncommittedChanges(
1111
                    tree, more='Use --no-strict to force the push.')
1112
            if tree.last_revision() != tree.branch.last_revision():
1113
                # The tree has lost sync with its branch, there is little
1114
                # chance that the user is aware of it but he can still force
1115
                # the push with --no-strict
1116
                raise errors.OutOfDateTree(
1117
                    tree, more='Use --no-strict to force the push.')
3221.19.1 by Ian Clatworthy
refactor cmd_push to use a helper function
1118
3549.1.1 by Martin Pool
rename push --reference to --stacked-on
1119
        # Get the stacked_on branch, if any
1120
        if stacked_on is not None:
1121
            stacked_on = urlutils.normalize_url(stacked_on)
3221.19.4 by Ian Clatworthy
shallow -> stacked
1122
        elif stacked:
3221.11.15 by Robert Collins
no parent branch causes an error on push --shallow.
1123
            parent_url = br_from.get_parent()
1124
            if parent_url:
1125
                parent = Branch.open(parent_url)
3549.1.1 by Martin Pool
rename push --reference to --stacked-on
1126
                stacked_on = parent.get_public_branch()
1127
                if not stacked_on:
3221.11.17 by Robert Collins
no public location causes the parent to be used directly with push --shallow.
1128
                    # I considered excluding non-http url's here, thus forcing
1129
                    # 'public' branches only, but that only works for some
3221.14.3 by Ian Clatworthy
Merge bzr.dev r3466
1130
                    # users, so it's best to just depend on the user spotting an
3221.11.17 by Robert Collins
no public location causes the parent to be used directly with push --shallow.
1131
                    # error by the feedback given to them. RBC 20080227.
3549.1.1 by Martin Pool
rename push --reference to --stacked-on
1132
                    stacked_on = parent_url
1133
            if not stacked_on:
3221.11.15 by Robert Collins
no parent branch causes an error on push --shallow.
1134
                raise errors.BzrCommandError(
1135
                    "Could not determine branch to refer to.")
3221.19.1 by Ian Clatworthy
refactor cmd_push to use a helper function
1136
1137
        # Get the destination location
1490 by Robert Collins
Implement a 'bzr push' command, with saved locations; update diff to return 1.
1138
        if location is None:
3221.19.1 by Ian Clatworthy
refactor cmd_push to use a helper function
1139
            stored_loc = br_from.get_push_location()
1490 by Robert Collins
Implement a 'bzr push' command, with saved locations; update diff to return 1.
1140
            if stored_loc is None:
3221.19.1 by Ian Clatworthy
refactor cmd_push to use a helper function
1141
                raise errors.BzrCommandError(
1142
                    "No push location known or specified.")
1490 by Robert Collins
Implement a 'bzr push' command, with saved locations; update diff to return 1.
1143
            else:
1685.1.59 by Martin Pool
[broken] Fix up & refactor display of remembered urls to unescape properly
1144
                display_url = urlutils.unescape_for_display(stored_loc,
1145
                        self.outf.encoding)
3596.3.1 by James Westby
Give the user a bit more information about which saved location is being used.
1146
                self.outf.write("Using saved push location: %s\n" % display_url)
1490 by Robert Collins
Implement a 'bzr push' command, with saved locations; update diff to return 1.
1147
                location = stored_loc
1685.1.22 by John Arbash Meinel
cmd_push was passing the location directly to relpath, rather than a URL
1148
3221.19.1 by Ian Clatworthy
refactor cmd_push to use a helper function
1149
        _show_push_branch(br_from, revision_id, location, self.outf,
1150
            verbose=verbose, overwrite=overwrite, remember=remember,
3549.1.1 by Martin Pool
rename push --reference to --stacked-on
1151
            stacked_on=stacked_on, create_prefix=create_prefix,
3221.19.1 by Ian Clatworthy
refactor cmd_push to use a helper function
1152
            use_existing_dir=use_existing_dir)
1490 by Robert Collins
Implement a 'bzr push' command, with saved locations; update diff to return 1.
1153
1508.1.4 by Robert Collins
Convert most of the front ends commands to use WorkingTree.open_containing
1154
1147 by Martin Pool
- split builtin commands into separate module bzrlib.builtins;
1155
class cmd_branch(Command):
4431.2.1 by mernst at mit
branch documentation: clarify English word "copy"
1156
    """Create a new branch that is a copy of an existing branch.
1147 by Martin Pool
- split builtin commands into separate module bzrlib.builtins;
1157
1158
    If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
1159
    be used.  In other words, "branch ../foo/bar" will attempt to create ./bar.
2512.4.1 by Ian Clatworthy
Fixes #115491 - 'branch lp:projname' now creates ./projname as exected
1160
    If the FROM_LOCATION has no / or path separator embedded, the TO_LOCATION
1161
    is derived from the FROM_LOCATION by stripping a leading scheme or drive
1162
    identifier, if any. For example, "branch lp:foo-bar" will attempt to
1163
    create ./foo-bar.
1147 by Martin Pool
- split builtin commands into separate module bzrlib.builtins;
1164
1165
    To retrieve the branch as of a particular revision, supply the --revision
1166
    parameter, as in "branch foo/bar -r 5".
1167
    """
2425.2.3 by Robert Collins
Update existing builtin commands help text to use _see_also. (Robert Collins)
1168
1169
    _see_also = ['checkout']
1147 by Martin Pool
- split builtin commands into separate module bzrlib.builtins;
1170
    takes_args = ['from_location', 'to_location?']
3984.3.5 by Daniel Watkins
Changed from option type to helper function.
1171
    takes_options = ['revision', Option('hardlink',
3327.2.1 by John Klinger
Added --no-trees option to branch command
1172
        help='Hard-link working tree files where possible.'),
3983.1.1 by Daniel Watkins
Merged John Klinger's original work.
1173
        Option('no-tree',
3983.1.2 by Daniel Watkins
Minor cleanup.
1174
            help="Create a branch without a working-tree."),
3221.20.3 by Ian Clatworthy
shallow -> stacked
1175
        Option('stacked',
1176
            help='Create a stacked branch referring to the source branch. '
3221.11.20 by Robert Collins
Support --shallow on branch.
1177
                'The new branch will depend on the availability of the source '
1178
                'branch for all operations.'),
3696.2.3 by Daniel Watkins
Added --standalone option to branch.
1179
        Option('standalone',
1180
               help='Do not use a shared repository, even if available.'),
4479.2.1 by Alexander Belchenko
branch command now has new flag --use-existing-dir to force branching into existing directory if there is no branch yet.
1181
        Option('use-existing-dir',
1182
               help='By default branch will fail if the target'
1183
                    ' directory exists, but does not already'
1184
                    ' have a control directory.  This flag will'
1185
                    ' allow branch to proceed.'),
3221.11.20 by Robert Collins
Support --shallow on branch.
1186
        ]
1147 by Martin Pool
- split builtin commands into separate module bzrlib.builtins;
1187
    aliases = ['get', 'clone']
1188
3136.1.3 by Aaron Bentley
Implement hard-link support for branch and checkout
1189
    def run(self, from_location, to_location=None, revision=None,
4479.2.1 by Alexander Belchenko
branch command now has new flag --use-existing-dir to force branching into existing directory if there is no branch yet.
1190
            hardlink=False, stacked=False, standalone=False, no_tree=False,
1191
            use_existing_dir=False):
2220.2.30 by Martin Pool
split out tag-merging code and add some tests
1192
        from bzrlib.tag import _merge_tags_if_possible
2283.1.1 by John Arbash Meinel
(John Arbash Meinel) (trivial) remove unused and incorrect code.
1193
3123.5.11 by Aaron Bentley
Accelerate branching from a lightweight checkout
1194
        accelerator_tree, br_from = bzrdir.BzrDir.open_tree_or_branch(
1195
            from_location)
4393.3.8 by Ian Clatworthy
first tweak from jam's review
1196
        if (accelerator_tree is not None and
1197
            accelerator_tree.supports_content_filtering()):
1198
            accelerator_tree = None
3984.3.7 by Daniel Watkins
Fixed incorrect calls.
1199
        revision = _get_one_revision('branch', revision)
1185.17.3 by Martin Pool
[pick] larger read lock scope for branch command
1200
        br_from.lock_read()
1201
        try:
3984.3.3 by Daniel Watkins
Converted cmd_branch to use 1revision.
1202
            if revision is not None:
1203
                revision_id = revision.as_revision_id(br_from)
1185.8.4 by Aaron Bentley
Fixed branch -r
1204
            else:
1534.4.50 by Robert Collins
Got the bzrdir api straightened out, plenty of refactoring to use it pending, but the api is up and running.
1205
                # FIXME - wt.last_revision, fallback to branch, fall back to
1206
                # None or perhaps NULL_REVISION to mean copy nothing
1207
                # RBC 20060209
1208
                revision_id = br_from.last_revision()
1147 by Martin Pool
- split builtin commands into separate module bzrlib.builtins;
1209
            if to_location is None:
2512.4.1 by Ian Clatworthy
Fixes #115491 - 'branch lp:projname' now creates ./projname as exected
1210
                to_location = urlutils.derive_to_location(from_location)
1830.4.7 by Wouter van Heyst
review fixes, rename transport variable to to_transport
1211
            to_transport = transport.get_transport(to_location)
1147 by Martin Pool
- split builtin commands into separate module bzrlib.builtins;
1212
            try:
1685.1.20 by John Arbash Meinel
More changes to get 'bzr branch' and 'bzr pull' to work
1213
                to_transport.mkdir('.')
1773.4.1 by Martin Pool
Add pyflakes makefile target; fix many warnings
1214
            except errors.FileExists:
4479.2.1 by Alexander Belchenko
branch command now has new flag --use-existing-dir to force branching into existing directory if there is no branch yet.
1215
                if not use_existing_dir:
1216
                    raise errors.BzrCommandError('Target directory "%s" '
1217
                        'already exists.' % to_location)
1218
                else:
1219
                    try:
1220
                        bzrdir.BzrDir.open_from_transport(to_transport)
1221
                    except errors.NotBranchError:
1222
                        pass
1223
                    else:
1224
                        raise errors.AlreadyBranchError(to_location)
1773.4.1 by Martin Pool
Add pyflakes makefile target; fix many warnings
1225
            except errors.NoSuchFile:
1996.3.34 by John Arbash Meinel
Update builtins to use errors.foo. Now errors can be avoided entirely for a bzr rocks run
1226
                raise errors.BzrCommandError('Parent of "%s" does not exist.'
1227
                                             % to_location)
3978.2.3 by Jelmer Vernooij
Revert debug code.
1228
            try:
1229
                # preserve whatever source format we have.
1230
                dir = br_from.bzrdir.sprout(to_transport.base, revision_id,
1231
                                            possible_transports=[to_transport],
1232
                                            accelerator_tree=accelerator_tree,
1233
                                            hardlink=hardlink, stacked=stacked,
1234
                                            force_new_repo=standalone,
3983.1.7 by Daniel Watkins
Review comments from jam.
1235
                                            create_tree_if_local=not no_tree,
3978.2.3 by Jelmer Vernooij
Revert debug code.
1236
                                            source_branch=br_from)
1237
                branch = dir.open_branch()
1238
            except errors.NoSuchRevision:
1239
                to_transport.delete_tree('.')
1240
                msg = "The branch %s has no revision %s." % (from_location,
3984.3.3 by Daniel Watkins
Converted cmd_branch to use 1revision.
1241
                    revision)
3978.2.3 by Jelmer Vernooij
Revert debug code.
1242
                raise errors.BzrCommandError(msg)
2220.2.30 by Martin Pool
split out tag-merging code and add some tests
1243
            _merge_tags_if_possible(br_from, branch)
3221.20.3 by Ian Clatworthy
shallow -> stacked
1244
            # If the source branch is stacked, the new branch may
1245
            # be stacked whether we asked for that explicitly or not.
1246
            # We therefore need a try/except here and not just 'if stacked:'
3221.11.19 by Robert Collins
Branching a shallow branch gets a shallow branch.
1247
            try:
3221.20.3 by Ian Clatworthy
shallow -> stacked
1248
                note('Created new stacked branch referring to %s.' %
3537.3.1 by Martin Pool
Rename branch.get_stacked_on to get_stacked_on_url
1249
                    branch.get_stacked_on_url())
3221.11.19 by Robert Collins
Branching a shallow branch gets a shallow branch.
1250
            except (errors.NotStacked, errors.UnstackableBranchFormat,
3221.11.20 by Robert Collins
Support --shallow on branch.
1251
                errors.UnstackableRepositoryFormat), e:
3221.11.19 by Robert Collins
Branching a shallow branch gets a shallow branch.
1252
                note('Branched %d revision(s).' % branch.revno())
1147 by Martin Pool
- split builtin commands into separate module bzrlib.builtins;
1253
        finally:
1185.17.3 by Martin Pool
[pick] larger read lock scope for branch command
1254
            br_from.unlock()
1147 by Martin Pool
- split builtin commands into separate module bzrlib.builtins;
1255
1256
1508.1.20 by Robert Collins
Create a checkout command.
1257
class cmd_checkout(Command):
1258
    """Create a new checkout of an existing branch.
1259
1508.1.28 by Robert Collins
Test using bzr checkout to reconstitute working trees.
1260
    If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
1261
    the branch found in '.'. This is useful if you have removed the working tree
1262
    or if it was never created - i.e. if you pushed the branch to its current
1263
    location using SFTP.
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
1264
1508.1.20 by Robert Collins
Create a checkout command.
1265
    If the TO_LOCATION is omitted, the last component of the BRANCH_LOCATION will
1266
    be used.  In other words, "checkout ../foo/bar" will attempt to create ./bar.
2512.4.1 by Ian Clatworthy
Fixes #115491 - 'branch lp:projname' now creates ./projname as exected
1267
    If the BRANCH_LOCATION has no / or path separator embedded, the TO_LOCATION
1268
    is derived from the BRANCH_LOCATION by stripping a leading scheme or drive
1269
    identifier, if any. For example, "checkout lp:foo-bar" will attempt to
1270
    create ./foo-bar.
1508.1.20 by Robert Collins
Create a checkout command.
1271
1272
    To retrieve the branch as of a particular revision, supply the --revision
1273
    parameter, as in "checkout foo/bar -r 5". Note that this will be immediately
1274
    out of date [so you cannot commit] but it may be useful (i.e. to examine old
1275
    code.)
2425.2.3 by Robert Collins
Update existing builtin commands help text to use _see_also. (Robert Collins)
1276
    """
1508.1.20 by Robert Collins
Create a checkout command.
1277
2425.2.3 by Robert Collins
Update existing builtin commands help text to use _see_also. (Robert Collins)
1278
    _see_also = ['checkouts', 'branch']
1508.1.28 by Robert Collins
Test using bzr checkout to reconstitute working trees.
1279
    takes_args = ['branch_location?', 'to_location?']
3984.3.5 by Daniel Watkins
Changed from option type to helper function.
1280
    takes_options = ['revision',
1587.1.14 by Robert Collins
Make bound branch creation happen via 'checkout'
1281
                     Option('lightweight',
2598.1.1 by Martin Pool
Add test for and documentation of option style, fix up existing options to comply
1282
                            help="Perform a lightweight checkout.  Lightweight "
1587.1.14 by Robert Collins
Make bound branch creation happen via 'checkout'
1283
                                 "checkouts depend on access to the branch for "
2598.1.1 by Martin Pool
Add test for and documentation of option style, fix up existing options to comply
1284
                                 "every operation.  Normal checkouts can perform "
1587.1.14 by Robert Collins
Make bound branch creation happen via 'checkout'
1285
                                 "common operations like diff and status without "
1286
                                 "such access, and also support local commits."
1287
                            ),
3136.1.3 by Aaron Bentley
Implement hard-link support for branch and checkout
1288
                     Option('files-from', type=str,
1289
                            help="Get file contents from this tree."),
1290
                     Option('hardlink',
1291
                            help='Hard-link working tree files where possible.'
1292
                            ),
1587.1.14 by Robert Collins
Make bound branch creation happen via 'checkout'
1293
                     ]
1733.2.8 by Michael Ellerman
Add CVS compatible aliases for checkout and annotate, from fullermd.
1294
    aliases = ['co']
1508.1.20 by Robert Collins
Create a checkout command.
1295
2387.1.1 by Robert Collins
Remove the --basis parameter to clone etc. (Robert Collins)
1296
    def run(self, branch_location=None, to_location=None, revision=None,
3136.1.3 by Aaron Bentley
Implement hard-link support for branch and checkout
1297
            lightweight=False, files_from=None, hardlink=False):
1508.1.28 by Robert Collins
Test using bzr checkout to reconstitute working trees.
1298
        if branch_location is None:
1773.4.1 by Martin Pool
Add pyflakes makefile target; fix many warnings
1299
            branch_location = osutils.getcwd()
1508.1.28 by Robert Collins
Test using bzr checkout to reconstitute working trees.
1300
            to_location = branch_location
3123.5.20 by Aaron Bentley
Checkout uses branch tree as a fallback accelerator
1301
        accelerator_tree, source = bzrdir.BzrDir.open_tree_or_branch(
1302
            branch_location)
3984.3.7 by Daniel Watkins
Fixed incorrect calls.
1303
        revision = _get_one_revision('checkout', revision)
3123.5.20 by Aaron Bentley
Checkout uses branch tree as a fallback accelerator
1304
        if files_from is not None:
1305
            accelerator_tree = WorkingTree.open(files_from)
3984.3.4 by Daniel Watkins
Converted cmd_checkout to use 1revision.
1306
        if revision is not None:
1307
            revision_id = revision.as_revision_id(source)
1508.1.20 by Robert Collins
Create a checkout command.
1308
        else:
1309
            revision_id = None
1310
        if to_location is None:
2512.4.1 by Ian Clatworthy
Fixes #115491 - 'branch lp:projname' now creates ./projname as exected
1311
            to_location = urlutils.derive_to_location(branch_location)
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
1312
        # if the source and to_location are the same,
1508.1.28 by Robert Collins
Test using bzr checkout to reconstitute working trees.
1313
        # and there is no working tree,
1314
        # then reconstitute a branch
1997.1.4 by Robert Collins
``bzr checkout --lightweight`` now operates on readonly branches as well
1315
        if (osutils.abspath(to_location) ==
1773.4.1 by Martin Pool
Add pyflakes makefile target; fix many warnings
1316
            osutils.abspath(branch_location)):
1508.1.28 by Robert Collins
Test using bzr checkout to reconstitute working trees.
1317
            try:
1318
                source.bzrdir.open_workingtree()
1319
            except errors.NoWorkingTree:
1551.15.60 by Aaron Bentley
bzr checkout -r always works, even with -r0 (#127708)
1320
                source.bzrdir.create_workingtree(revision_id)
1508.1.28 by Robert Collins
Test using bzr checkout to reconstitute working trees.
1321
                return
3123.5.2 by Aaron Bentley
Allow checkout --files_from
1322
        source.create_checkout(to_location, revision_id, lightweight,
3136.1.3 by Aaron Bentley
Implement hard-link support for branch and checkout
1323
                               accelerator_tree, hardlink)
1508.1.20 by Robert Collins
Create a checkout command.
1324
1325
1147 by Martin Pool
- split builtin commands into separate module bzrlib.builtins;
1326
class cmd_renames(Command):
1327
    """Show list of renamed files.
1328
    """
1185.16.3 by Martin Pool
- remove all TODOs from bzr help messages
1329
    # TODO: Option to show renames between two historical versions.
1330
1331
    # TODO: Only show renames under dir, rather than in the whole branch.
2425.2.3 by Robert Collins
Update existing builtin commands help text to use _see_also. (Robert Collins)
1332
    _see_also = ['status']
1147 by Martin Pool
- split builtin commands into separate module bzrlib.builtins;
1333
    takes_args = ['dir?']
1334
1185.12.56 by Aaron Bentley
Prevented display commands from printing broken pipe errors
1335
    @display_command
1185.33.66 by Martin Pool
[patch] use unicode literals for all hardcoded paths (Alexander Belchenko)
1336
    def run(self, dir=u'.'):
1508.1.4 by Robert Collins
Convert most of the front ends commands to use WorkingTree.open_containing
1337
        tree = WorkingTree.open_containing(dir)[0]
2255.7.63 by Robert Collins
Fix cmd_renames to lock around inventory access.
1338
        tree.lock_read()
1339
        try:
1340
            new_inv = tree.inventory
1341
            old_tree = tree.basis_tree()
1342
            old_tree.lock_read()
1343
            try:
1344
                old_inv = old_tree.inventory
1551.21.1 by Aaron Bentley
Deprecate tree.find_renames
1345
                renames = []
1346
                iterator = tree.iter_changes(old_tree, include_unchanged=True)
1347
                for f, paths, c, v, p, n, k, e in iterator:
1348
                    if paths[0] == paths[1]:
1349
                        continue
1350
                    if None in (paths):
1351
                        continue
1352
                    renames.append(paths)
2255.7.63 by Robert Collins
Fix cmd_renames to lock around inventory access.
1353
                renames.sort()
1354
                for old_name, new_name in renames:
1355
                    self.outf.write("%s => %s\n" % (old_name, new_name))
1356
            finally:
1357
                old_tree.unlock()
1358
        finally:
1359
            tree.unlock()
1147 by Martin Pool
- split builtin commands into separate module bzrlib.builtins;
1360
1361
1508.1.24 by Robert Collins
Add update command for use with checkouts.
1362
class cmd_update(Command):
1363
    """Update a tree to have the latest code committed to its branch.
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
1364
1508.1.24 by Robert Collins
Add update command for use with checkouts.
1365
    This will perform a merge into the working tree, and may generate
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
1366
    conflicts. If you have any local changes, you will still
1587.1.10 by Robert Collins
update updates working tree and branch together.
1367
    need to commit them after the update for the update to be complete.
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
1368
1369
    If you want to discard your local changes, you can just do a
1587.1.10 by Robert Collins
update updates working tree and branch together.
1370
    'bzr revert' instead of 'bzr commit' after the update.
1508.1.24 by Robert Collins
Add update command for use with checkouts.
1371
    """
2425.2.3 by Robert Collins
Update existing builtin commands help text to use _see_also. (Robert Collins)
1372
2625.5.1 by Daniel Watkins
'bzr update's help now includes a see also reference to 'help status-flags'.
1373
    _see_also = ['pull', 'working-trees', 'status-flags']
1508.1.24 by Robert Collins
Add update command for use with checkouts.
1374
    takes_args = ['dir?']
1815.3.1 by Stefan (metze) Metzmacher
add 'up' as alias for 'update'
1375
    aliases = ['up']
1508.1.24 by Robert Collins
Add update command for use with checkouts.
1376
1377
    def run(self, dir='.'):
1378
        tree = WorkingTree.open_containing(dir)[0]
2806.2.2 by Vincent Ladeuil
Fix #128076 and #131396 by reusing bound branch transport.
1379
        possible_transports = []
1380
        master = tree.branch.get_master_branch(
1381
            possible_transports=possible_transports)
2084.2.1 by Aaron Bentley
Support updating lightweight checkouts of readonly branches
1382
        if master is not None:
1383
            tree.lock_write()
1384
        else:
1385
            tree.lock_tree_write()
1508.1.24 by Robert Collins
Add update command for use with checkouts.
1386
        try:
2014.1.1 by John Arbash Meinel
Stop using pending_merges() in 'bzr update'
1387
            existing_pending_merges = tree.get_parent_ids()[1:]
2598.5.4 by Aaron Bentley
Restore original Branch.last_revision behavior, fix bits that care
1388
            last_rev = _mod_revision.ensure_null(tree.last_revision())
1389
            if last_rev == _mod_revision.ensure_null(
1390
                tree.branch.last_revision()):
1587.1.11 by Robert Collins
Local commits appear to be working properly.
1391
                # may be up to date, check master too.
2598.5.4 by Aaron Bentley
Restore original Branch.last_revision behavior, fix bits that care
1392
                if master is None or last_rev == _mod_revision.ensure_null(
1393
                    master.last_revision()):
1830.1.1 by John Arbash Meinel
Print up to date even if bound, also always print out current revno.
1394
                    revno = tree.branch.revision_id_to_revno(last_rev)
1395
                    note("Tree is up to date at revision %d." % (revno,))
1396
                    return 0
3586.1.31 by Ian Clatworthy
view filtering for pull, update & merge
1397
            view_info = _get_view_info_for_change_reporter(tree)
2806.2.2 by Vincent Ladeuil
Fix #128076 and #131396 by reusing bound branch transport.
1398
            conflicts = tree.update(
3586.1.31 by Ian Clatworthy
view filtering for pull, update & merge
1399
                delta._ChangeReporter(unversioned_filter=tree.is_ignored,
1400
                view_info=view_info), possible_transports=possible_transports)
2598.5.4 by Aaron Bentley
Restore original Branch.last_revision behavior, fix bits that care
1401
            revno = tree.branch.revision_id_to_revno(
1402
                _mod_revision.ensure_null(tree.last_revision()))
1830.1.1 by John Arbash Meinel
Print up to date even if bound, also always print out current revno.
1403
            note('Updated to revision %d.' % (revno,))
2014.1.1 by John Arbash Meinel
Stop using pending_merges() in 'bzr update'
1404
            if tree.get_parent_ids()[1:] != existing_pending_merges:
1711.2.108 by John Arbash Meinel
Assert that update informs the user about where their local commits went.
1405
                note('Your local commits will now show as pending merges with '
1878.3.2 by Adeodato Simó
Update with suggestions from John Arbash Meinel.
1406
                     "'bzr status', and can be committed with 'bzr commit'.")
1508.1.24 by Robert Collins
Add update command for use with checkouts.
1407
            if conflicts != 0:
1408
                return 1
1409
            else:
1410
                return 0
1411
        finally:
1412
            tree.unlock()
1413
1414
1147 by Martin Pool
- split builtin commands into separate module bzrlib.builtins;
1415
class cmd_info(Command):
1694.2.6 by Martin Pool
[merge] bzr.dev
1416
    """Show information about a working tree, branch or repository.
1417
1418
    This command will show all known locations and formats associated to the
4032.2.1 by Ian Clatworthy
omit branch committers from info -v (now requires -vv)
1419
    tree, branch or repository.
4035.1.2 by Ian Clatworthy
clean-up trailing whitespace
1420
4032.2.1 by Ian Clatworthy
omit branch committers from info -v (now requires -vv)
1421
    In verbose mode, statistical information is included with each report.
1422
    To see extended statistic information, use a verbosity level of 2 or
1423
    higher by specifying the verbose option multiple times, e.g. -vv.
1694.2.6 by Martin Pool
[merge] bzr.dev
1424
1425
    Branches and working trees will also report any missing revisions.
4032.2.1 by Ian Clatworthy
omit branch committers from info -v (now requires -vv)
1426
1427
    :Examples:
1428
1429
      Display information on the format and related locations:
1430
1431
        bzr info
1432
1433
      Display the above together with extended format information and
1434
      basic statistics (like the number of files in the working tree and
1435
      number of revisions in the branch and repository):
1436
4217.3.1 by Ian Clatworthy
fix info help
1437
        bzr info -v
4032.2.1 by Ian Clatworthy
omit branch committers from info -v (now requires -vv)
1438
1439
      Display the above together with number of committers to the branch:
1440
4217.3.1 by Ian Clatworthy
fix info help
1441
        bzr info -vv
1694.2.6 by Martin Pool
[merge] bzr.dev
1442
    """
2485.1.2 by James Westby
Update with comments from review, thanks to John and Aaron.
1443
    _see_also = ['revno', 'working-trees', 'repositories']
1694.2.6 by Martin Pool
[merge] bzr.dev
1444
    takes_args = ['location?']
1624.3.21 by Olaf Conradi
Make bzr info command work on both local and remote locations. Support
1445
    takes_options = ['verbose']
2904.3.1 by Lukáš Lalinský
Unicode-safe output from ``bzr info``.
1446
    encoding_type = 'replace'
1694.2.6 by Martin Pool
[merge] bzr.dev
1447
1185.12.56 by Aaron Bentley
Prevented display commands from printing broken pipe errors
1448
    @display_command
2768.1.8 by Ian Clatworthy
Get test suite fully working again
1449
    def run(self, location=None, verbose=False):
1450
        if verbose:
4032.2.1 by Ian Clatworthy
omit branch committers from info -v (now requires -vv)
1451
            noise_level = get_verbosity_level()
2768.1.8 by Ian Clatworthy
Get test suite fully working again
1452
        else:
1453
            noise_level = 0
1694.2.6 by Martin Pool
[merge] bzr.dev
1454
        from bzrlib.info import show_bzrdir_info
1455
        show_bzrdir_info(bzrdir.BzrDir.open_containing(location)[0],
2904.3.1 by Lukáš Lalinský
Unicode-safe output from ``bzr info``.
1456
                         verbose=noise_level, outfile=self.outf)
1147 by Martin Pool
- split builtin commands into separate module bzrlib.builtins;
1457
1458
2292.1.13 by Marius Kruger
* merge the unversion command back into the remove command,
1459
class cmd_remove(Command):
2292.1.24 by Marius Kruger
minor text cleanups
1460
    """Remove files or directories.
1147 by Martin Pool
- split builtin commands into separate module bzrlib.builtins;
1461
3619.5.3 by Robert Collins
Review feedback.
1462
    This makes bzr stop tracking changes to the specified files. bzr will delete
1463
    them if they can easily be recovered using revert. If no options or
1464
    parameters are given bzr will scan for files that are being tracked by bzr
1465
    but missing in your tree and stop tracking them for you.
1147 by Martin Pool
- split builtin commands into separate module bzrlib.builtins;
1466
    """
1551.6.26 by Aaron Bentley
Add support for remove --new
1467
    takes_args = ['file*']
2292.1.30 by Marius Kruger
* Minor text fixes.
1468
    takes_options = ['verbose',
3619.5.1 by Robert Collins
* ``bzr rm`` will now scan for files that are missing and remove just
1469
        Option('new', help='Only remove files that have never been committed.'),
2292.1.28 by Marius Kruger
* NEWS
1470
        RegistryOption.from_kwargs('file-deletion-strategy',
2681.1.7 by Aaron Bentley
Fix option grammar
1471
            'The file deletion mode to be used.',
2292.1.28 by Marius Kruger
* NEWS
1472
            title='Deletion Strategy', value_switches=True, enum_switch=False,
2292.1.30 by Marius Kruger
* Minor text fixes.
1473
            safe='Only delete files if they can be'
1474
                 ' safely recovered (default).',
4556.1.1 by Martin Pool
Make 'rm --keep' help more clear
1475
            keep='Delete from bzr but leave the working copy.',
2292.1.28 by Marius Kruger
* NEWS
1476
            force='Delete all the specified files, even if they can not be '
1477
                'recovered and even if they are non-empty directories.')]
3619.5.2 by Robert Collins
* ``bzr rm`` is now aliased to ``bzr del`` for the convenience of svn
1478
    aliases = ['rm', 'del']
1685.1.77 by Wouter van Heyst
WorkingTree.remove takes an optional output file
1479
    encoding_type = 'replace'
2292.1.1 by Marius Kruger
"bzr remove" and "bzr rm" will now remove the working file.
1480
2292.1.30 by Marius Kruger
* Minor text fixes.
1481
    def run(self, file_list, verbose=False, new=False,
2292.1.28 by Marius Kruger
* NEWS
1482
        file_deletion_strategy='safe'):
1508.1.4 by Robert Collins
Convert most of the front ends commands to use WorkingTree.open_containing
1483
        tree, file_list = tree_files(file_list)
2292.1.1 by Marius Kruger
"bzr remove" and "bzr rm" will now remove the working file.
1484
3794.5.38 by Mark Hammond
Restore missing (apparently pointless) block accidently removed.
1485
        if file_list is not None:
1486
            file_list = [f for f in file_list]
1487
3619.5.1 by Robert Collins
* ``bzr rm`` will now scan for files that are missing and remove just
1488
        tree.lock_write()
1489
        try:
1490
            # Heuristics should probably all move into tree.remove_smart or
1491
            # some such?
1492
            if new:
1493
                added = tree.changes_from(tree.basis_tree(),
1494
                    specific_files=file_list).added
1495
                file_list = sorted([f[0] for f in added], reverse=True)
1496
                if len(file_list) == 0:
1497
                    raise errors.BzrCommandError('No matching files.')
1498
            elif file_list is None:
1499
                # missing files show up in iter_changes(basis) as
1500
                # versioned-with-no-kind.
1501
                missing = []
1502
                for change in tree.iter_changes(tree.basis_tree()):
3619.5.3 by Robert Collins
Review feedback.
1503
                    # Find paths in the working tree that have no kind:
1504
                    if change[1][1] is not None and change[6][1] is None:
3619.5.1 by Robert Collins
* ``bzr rm`` will now scan for files that are missing and remove just
1505
                        missing.append(change[1][1])
1506
                file_list = sorted(missing, reverse=True)
1507
                file_deletion_strategy = 'keep'
1508
            tree.remove(file_list, verbose=verbose, to_file=self.outf,
1509
                keep_files=file_deletion_strategy=='keep',
1510
                force=file_deletion_strategy=='force')
1511
        finally:
1512
            tree.unlock()
1147 by Martin Pool
- split builtin commands into separate module bzrlib.builtins;
1513
1514
1515
class cmd_file_id(Command):
1516
    """Print file_id of a particular file or directory.
1517
1518
    The file_id is assigned when the file is first added and remains the
1519
    same through all revisions where the file exists, even when it is
1520
    moved or renamed.
1521
    """
1685.1.80 by Wouter van Heyst
more code cleanup
1522
1147 by Martin Pool
- split builtin commands into separate module bzrlib.builtins;
1523
    hidden = True
2425.2.3 by Robert Collins
Update existing builtin commands help text to use _see_also. (Robert Collins)
1524
    _see_also = ['inventory', 'ls']
1147 by Martin Pool
- split builtin commands into separate module bzrlib.builtins;
1525
    takes_args = ['filename']
1185.85.35 by John Arbash Meinel
Updated file-path
1526
1185.12.56 by Aaron Bentley
Prevented display commands from printing broken pipe errors
1527
    @display_command
1147 by Martin Pool
- split builtin commands into separate module bzrlib.builtins;
1528
    def run(self, filename):
1508.1.4 by Robert Collins
Convert most of the front ends commands to use WorkingTree.open_containing
1529
        tree, relpath = WorkingTree.open_containing(filename)
2255.7.39 by Robert Collins
Remove gratuitous references to inventory.path2id from builtins.py, allowing more commands to work on dirstate trees.
1530
        i = tree.path2id(relpath)
1963.2.6 by Robey Pointer
pychecker is on crack; go back to using 'is None'.
1531
        if i is None:
2067.3.1 by Martin Pool
Clean up BzrNewError, other exception classes and users.
1532
            raise errors.NotVersionedError(filename)
1147 by Martin Pool
- split builtin commands into separate module bzrlib.builtins;
1533
        else:
1685.1.80 by Wouter van Heyst
more code cleanup
1534
            self.outf.write(i + '\n')
1147 by Martin Pool
- split builtin commands into separate module bzrlib.builtins;
1535
1536
1537
class cmd_file_path(Command):
1538
    """Print path of file_ids to a file or directory.
1539
1540
    This prints one line for each directory down to the target,
1185.85.35 by John Arbash Meinel
Updated file-path
1541
    starting at the branch root.
1542
    """
1685.1.80 by Wouter van Heyst
more code cleanup
1543
1147 by Martin Pool
- split builtin commands into separate module bzrlib.builtins;
1544
    hidden = True
1545
    takes_args = ['filename']
1185.85.35 by John Arbash Meinel
Updated file-path
1546
1185.12.56 by Aaron Bentley
Prevented display commands from printing broken pipe errors
1547
    @display_command
1147 by Martin Pool
- split builtin commands into separate module bzrlib.builtins;
1548
    def run(self, filename):
1508.1.4 by Robert Collins
Convert most of the front ends commands to use WorkingTree.open_containing
1549
        tree, relpath = WorkingTree.open_containing(filename)
2255.7.39 by Robert Collins
Remove gratuitous references to inventory.path2id from builtins.py, allowing more commands to work on dirstate trees.
1550
        fid = tree.path2id(relpath)
1963.2.6 by Robey Pointer
pychecker is on crack; go back to using 'is None'.
1551
        if fid is None:
2067.3.1 by Martin Pool
Clean up BzrNewError, other exception classes and users.
1552
            raise errors.NotVersionedError(filename)
2255.7.39 by Robert Collins
Remove gratuitous references to inventory.path2id from builtins.py, allowing more commands to work on dirstate trees.
1553
        segments = osutils.splitpath(relpath)
1554
        for pos in range(1, len(segments) + 1):
1555
            path = osutils.joinpath(segments[:pos])
1556
            self.outf.write("%s\n" % tree.path2id(path))
1147 by Martin Pool
- split builtin commands into separate module bzrlib.builtins;
1557
1558
1570.1.2 by Robert Collins
Import bzrtools' 'fix' command as 'bzr reconcile.'
1559
class cmd_reconcile(Command):
1560
    """Reconcile bzr metadata in a branch.
1561
1562
    This can correct data mismatches that may have been caused by
1563
    previous ghost operations or bzr upgrades. You should only
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
1564
    need to run this command if 'bzr check' or a bzr developer
1570.1.2 by Robert Collins
Import bzrtools' 'fix' command as 'bzr reconcile.'
1565
    advises you to run it.
1566
1567
    If a second branch is provided, cross-branch reconciliation is
1568
    also attempted, which will check that data like the tree root
1569
    id which was not present in very early bzr versions is represented
1570
    correctly in both branches.
1571
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
1572
    At the same time it is run it may recompress data resulting in
1570.1.2 by Robert Collins
Import bzrtools' 'fix' command as 'bzr reconcile.'
1573
    a potential saving in disk space or performance gain.
1574
1575
    The branch *MUST* be on a listable system such as local disk or sftp.
1576
    """
2425.2.3 by Robert Collins
Update existing builtin commands help text to use _see_also. (Robert Collins)
1577
1578
    _see_also = ['check']
1570.1.2 by Robert Collins
Import bzrtools' 'fix' command as 'bzr reconcile.'
1579
    takes_args = ['branch?']
1580
1581
    def run(self, branch="."):
1582
        from bzrlib.reconcile import reconcile
1773.4.1 by Martin Pool
Add pyflakes makefile target; fix many warnings
1583
        dir = bzrdir.BzrDir.open(branch)
1570.1.2 by Robert Collins
Import bzrtools' 'fix' command as 'bzr reconcile.'
1584
        reconcile(dir)
1585
1586
1147 by Martin Pool
- split builtin commands into separate module bzrlib.builtins;
1587
class cmd_revision_history(Command):
1733.2.1 by Michael Ellerman
Add an optional location parameter to the 'revision-history' command.
1588
    """Display the list of revision ids on a branch."""
2425.2.3 by Robert Collins
Update existing builtin commands help text to use _see_also. (Robert Collins)
1589
1590
    _see_also = ['log']
1733.2.1 by Michael Ellerman
Add an optional location parameter to the 'revision-history' command.
1591
    takes_args = ['location?']
1592
1147 by Martin Pool
- split builtin commands into separate module bzrlib.builtins;
1593
    hidden = True
1185.85.36 by John Arbash Meinel
Working on tests for revision-history, ancestry, and diff
1594
1185.12.56 by Aaron Bentley
Prevented display commands from printing broken pipe errors
1595
    @display_command
1733.2.1 by Michael Ellerman
Add an optional location parameter to the 'revision-history' command.
1596
    def run(self, location="."):
1597
        branch = Branch.open_containing(location)[0]
1598
        for revid in branch.revision_history():
1733.2.4 by Michael Ellerman
Merge bzr.dev, fix minor conflict in cmd_revision_history().
1599
            self.outf.write(revid)
1185.85.36 by John Arbash Meinel
Working on tests for revision-history, ancestry, and diff
1600
            self.outf.write('\n')
1147 by Martin Pool
- split builtin commands into separate module bzrlib.builtins;
1601
1602
1225 by Martin Pool
- branch now tracks ancestry - all merged revisions
1603
class cmd_ancestry(Command):
1604
    """List all revisions merged into this branch."""
2425.2.3 by Robert Collins
Update existing builtin commands help text to use _see_also. (Robert Collins)
1605
1606
    _see_also = ['log', 'revision-history']
1733.2.2 by Michael Ellerman
Add optional location to ancestry and fix behaviour for checkouts.
1607
    takes_args = ['location?']
1608
1225 by Martin Pool
- branch now tracks ancestry - all merged revisions
1609
    hidden = True
1185.85.36 by John Arbash Meinel
Working on tests for revision-history, ancestry, and diff
1610
1185.12.56 by Aaron Bentley
Prevented display commands from printing broken pipe errors
1611
    @display_command
1733.2.2 by Michael Ellerman
Add optional location to ancestry and fix behaviour for checkouts.
1612
    def run(self, location="."):
1613
        try:
1614
            wt = WorkingTree.open_containing(location)[0]
1615
        except errors.NoWorkingTree:
1616
            b = Branch.open(location)
1617
            last_revision = b.last_revision()
1618
        else:
1619
            b = wt.branch
1620
            last_revision = wt.last_revision()
1621
1622
        revision_ids = b.repository.get_ancestry(last_revision)
1668.1.14 by Martin Pool
merge olaf - InvalidRevisionId fixes
1623
        revision_ids.pop(0)
1624
        for revision_id in revision_ids:
1685.1.69 by Wouter van Heyst
merge bzr.dev 1740
1625
            self.outf.write(revision_id + '\n')
1225 by Martin Pool
- branch now tracks ancestry - all merged revisions
1626
1627
1147 by Martin Pool
- split builtin commands into separate module bzrlib.builtins;
1628
class cmd_init(Command):
1629
    """Make a directory into a versioned branch.
1630
1631
    Use this to create an empty branch, or before importing an
1632
    existing project.
1633
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
1634
    If there is a repository in a parent directory of the location, then
1662.1.19 by Martin Pool
Better error message when initting existing tree
1635
    the history of the branch will be stored in the repository.  Otherwise
2374.1.2 by Ian Clatworthy
Improved after feedback from reviewers
1636
    init creates a standalone branch which carries its own history
1637
    in the .bzr directory.
1662.1.19 by Martin Pool
Better error message when initting existing tree
1638
1639
    If there is already a branch at the location but it has no working tree,
1640
    the tree can be populated with 'bzr checkout'.
1641
2666.1.1 by Ian Clatworthy
Bazaar User Reference generated from online help
1642
    Recipe for importing a tree of files::
1643
1147 by Martin Pool
- split builtin commands into separate module bzrlib.builtins;
1644
        cd ~/project
1645
        bzr init
1185.12.93 by Aaron Bentley
Fixed obsolete help
1646
        bzr add .
1147 by Martin Pool
- split builtin commands into separate module bzrlib.builtins;
1647
        bzr status
3035.1.1 by John Arbash Meinel
Address bug #59302 and fix documentation that uses single quotes.
1648
        bzr commit -m "imported project"
1147 by Martin Pool
- split builtin commands into separate module bzrlib.builtins;
1649
    """
2425.2.3 by Robert Collins
Update existing builtin commands help text to use _see_also. (Robert Collins)
1650
2677.1.2 by Alexander Belchenko
bzr_man: see also topics as cross-reference links
1651
    _see_also = ['init-repository', 'branch', 'checkout']
1185.16.138 by Martin Pool
[patch] 'bzr init DIR' (John)
1652
    takes_args = ['location?']
1857.1.20 by Aaron Bentley
Strip out all the EnumOption stuff
1653
    takes_options = [
2524.1.1 by Aaron Bentley
Revert broken changes
1654
        Option('create-prefix',
1655
               help='Create the path leading up to the branch '
2598.1.1 by Martin Pool
Add test for and documentation of option style, fix up existing options to comply
1656
                    'if it does not already exist.'),
2241.1.4 by Martin Pool
Moved old weave-based repository formats into bzrlib.repofmt.weaverepo.
1657
         RegistryOption('format',
1658
                help='Specify a format for this branch. '
1659
                'See "help formats".',
3224.5.2 by Andrew Bennetts
Avoid importing bzrlib.bzrdir unnecessarily.
1660
                lazy_registry=('bzrlib.bzrdir', 'format_registry'),
1661
                converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
2241.1.19 by mbp at sourcefrog
(merge) trunk
1662
                value_switches=True,
1663
                title="Branch Format",
1664
                ),
2230.3.42 by Aaron Bentley
add --append-revisions-only option to init
1665
         Option('append-revisions-only',
1666
                help='Never change revnos or the existing log.'
1667
                '  Append revisions to it only.')
2241.1.4 by Martin Pool
Moved old weave-based repository formats into bzrlib.repofmt.weaverepo.
1668
         ]
2524.1.1 by Aaron Bentley
Revert broken changes
1669
    def run(self, location=None, format=None, append_revisions_only=False,
1670
            create_prefix=False):
1857.1.20 by Aaron Bentley
Strip out all the EnumOption stuff
1671
        if format is None:
2204.5.5 by Aaron Bentley
Remove RepositoryFormat.set_default_format, deprecate get_format_type
1672
            format = bzrdir.format_registry.make_bzrdir('default')
1185.16.138 by Martin Pool
[patch] 'bzr init DIR' (John)
1673
        if location is None:
1185.33.66 by Martin Pool
[patch] use unicode literals for all hardcoded paths (Alexander Belchenko)
1674
            location = u'.'
1830.4.5 by Wouter van Heyst
cleanup
1675
1830.4.7 by Wouter van Heyst
review fixes, rename transport variable to to_transport
1676
        to_transport = transport.get_transport(location)
1830.4.5 by Wouter van Heyst
cleanup
1677
1678
        # The path has to exist to initialize a
1679
        # branch inside of it.
1680
        # Just using os.mkdir, since I don't
1681
        # believe that we want to create a bunch of
1682
        # locations if the user supplies an extended path
2524.1.1 by Aaron Bentley
Revert broken changes
1683
        try:
1684
            to_transport.ensure_base()
1685
        except errors.NoSuchFile:
1686
            if not create_prefix:
1687
                raise errors.BzrCommandError("Parent directory of %s"
1688
                    " does not exist."
1689
                    "\nYou may supply --create-prefix to create all"
1690
                    " leading parent directories."
1691
                    % location)
4294.2.1 by Robert Collins
Move directory checking for bzr push options into Branch.create_clone_on_transport.
1692
            to_transport.create_prefix()
2504.1.3 by Daniel Watkins
Implemented --create-prefix for 'init'.
1693
1654.1.4 by Robert Collins
Teach `bzr init` how to init at the root of a repository.
1694
        try:
3697.5.4 by John Arbash Meinel
Merge vila's init[-repo] changes and add a NEWS entry.
1695
            a_bzrdir = bzrdir.BzrDir.open_from_transport(to_transport)
1996.3.34 by John Arbash Meinel
Update builtins to use errors.foo. Now errors can be avoided entirely for a bzr rocks run
1696
        except errors.NotBranchError:
1662.1.19 by Martin Pool
Better error message when initting existing tree
1697
            # really a NotBzrDir error...
2476.3.11 by Vincent Ladeuil
Cosmetic changes.
1698
            create_branch = bzrdir.BzrDir.create_branch_convenience
2476.3.6 by Vincent Ladeuil
Fix the 'init connects multiple times' in a different way.
1699
            branch = create_branch(to_transport.base, format=format,
2476.3.8 by Vincent Ladeuil
Mark transports that need to be instrumented or refactored to check
1700
                                   possible_transports=[to_transport])
3697.5.4 by John Arbash Meinel
Merge vila's init[-repo] changes and add a NEWS entry.
1701
            a_bzrdir = branch.bzrdir
1654.1.4 by Robert Collins
Teach `bzr init` how to init at the root of a repository.
1702
        else:
1996.3.34 by John Arbash Meinel
Update builtins to use errors.foo. Now errors can be avoided entirely for a bzr rocks run
1703
            from bzrlib.transport.local import LocalTransport
3697.5.4 by John Arbash Meinel
Merge vila's init[-repo] changes and add a NEWS entry.
1704
            if a_bzrdir.has_branch():
1830.4.8 by Wouter van Heyst
clean up imports (and get if collapsing right)
1705
                if (isinstance(to_transport, LocalTransport)
3697.5.4 by John Arbash Meinel
Merge vila's init[-repo] changes and add a NEWS entry.
1706
                    and not a_bzrdir.has_workingtree()):
1830.4.1 by Wouter van Heyst
Allow bzr init to create remote branches
1707
                        raise errors.BranchExistsWithoutWorkingTree(location)
1708
                raise errors.AlreadyBranchError(location)
3697.5.4 by John Arbash Meinel
Merge vila's init[-repo] changes and add a NEWS entry.
1709
            branch = a_bzrdir.create_branch()
1710
            a_bzrdir.create_workingtree()
2230.3.42 by Aaron Bentley
add --append-revisions-only option to init
1711
        if append_revisions_only:
1712
            try:
1713
                branch.set_append_revisions_only(True)
1714
            except errors.UpgradeRequired:
1715
                raise errors.BzrCommandError('This branch format cannot be set'
4301.3.1 by Andrew Bennetts
Implement RemoteBranch.set_append_revisions_only.
1716
                    ' to append-revisions-only.  Try --default.')
3535.9.1 by Marius Kruger
print info after init and init-repo
1717
        if not is_quiet():
3922.2.1 by Marius Kruger
make `bzr init` less verbose, and update tests
1718
            from bzrlib.info import describe_layout, describe_format
1719
            try:
1720
                tree = a_bzrdir.open_workingtree(recommend_upgrade=False)
1721
            except (errors.NoWorkingTree, errors.NotLocalUrl):
1722
                tree = None
1723
            repository = branch.repository
1724
            layout = describe_layout(repository, branch, tree).lower()
1725
            format = describe_format(a_bzrdir, repository, branch, tree)
1726
            self.outf.write("Created a %s (format: %s)\n" % (layout, format))
1727
            if repository.is_shared():
1728
                #XXX: maybe this can be refactored into transport.path_or_url()
1729
                url = repository.bzrdir.root_transport.external_url()
1730
                try:
1731
                    url = urlutils.local_path_from_url(url)
1732
                except errors.InvalidURL:
1733
                    pass
1734
                self.outf.write("Using shared repository: %s\n" % url)
1147 by Martin Pool
- split builtin commands into separate module bzrlib.builtins;
1735
1736
1558.5.6 by Aaron Bentley
Renamed make-repo init-repo
1737
class cmd_init_repository(Command):
1658.1.6 by Martin Pool
init-repo shouldn't insist on creating a new directory (Malone #38331)
1738
    """Create a shared repository to hold branches.
1739
2485.1.2 by James Westby
Update with comments from review, thanks to John and Aaron.
1740
    New branches created under the repository directory will store their
1741
    revisions in the repository, not in the branch directory.
1742
1743
    If the --no-trees option is used then the branches in the repository
1744
    will not have working trees by default.
1658.1.6 by Martin Pool
init-repo shouldn't insist on creating a new directory (Malone #38331)
1745
2666.1.1 by Ian Clatworthy
Bazaar User Reference generated from online help
1746
    :Examples:
1747
        Create a shared repositories holding just branches::
1748
1749
            bzr init-repo --no-trees repo
1750
            bzr init repo/trunk
1751
1752
        Make a lightweight checkout elsewhere::
1753
1754
            bzr checkout --lightweight repo/trunk trunk-checkout
1755
            cd trunk-checkout
1756
            (add files here)
1658.1.6 by Martin Pool
init-repo shouldn't insist on creating a new directory (Malone #38331)
1757
    """
2353.2.1 by John Arbash Meinel
(Wouter van Heyst) switch 'bzr init-repo' to default to '--no-trees'
1758
2666.1.1 by Ian Clatworthy
Bazaar User Reference generated from online help
1759
    _see_also = ['init', 'branch', 'checkout', 'repositories']
2241.1.4 by Martin Pool
Moved old weave-based repository formats into bzrlib.repofmt.weaverepo.
1760
    takes_args = ["location"]
2221.4.9 by Aaron Bentley
Zap trailing whitespace
1761
    takes_options = [RegistryOption('format',
2221.4.12 by Aaron Bentley
Add option grouping to RegistryOption and clean up format options
1762
                            help='Specify a format for this repository. See'
2598.1.1 by Martin Pool
Add test for and documentation of option style, fix up existing options to comply
1763
                                 ' "bzr help formats" for details.',
3224.5.2 by Andrew Bennetts
Avoid importing bzrlib.bzrdir unnecessarily.
1764
                            lazy_registry=('bzrlib.bzrdir', 'format_registry'),
1765
                            converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
2221.4.12 by Aaron Bentley
Add option grouping to RegistryOption and clean up format options
1766
                            value_switches=True, title='Repository format'),
2257.2.1 by Wouter van Heyst
Change the ui level default for init-repo to --trees.
1767
                     Option('no-trees',
2353.2.1 by John Arbash Meinel
(Wouter van Heyst) switch 'bzr init-repo' to default to '--no-trees'
1768
                             help='Branches in the repository will default to'
2598.1.1 by Martin Pool
Add test for and documentation of option style, fix up existing options to comply
1769
                                  ' not having a working tree.'),
2353.2.1 by John Arbash Meinel
(Wouter van Heyst) switch 'bzr init-repo' to default to '--no-trees'
1770
                    ]
1558.5.6 by Aaron Bentley
Renamed make-repo init-repo
1771
    aliases = ["init-repo"]
2353.2.1 by John Arbash Meinel
(Wouter van Heyst) switch 'bzr init-repo' to default to '--no-trees'
1772
2257.2.2 by Wouter van Heyst
Actually test that `bzr init-repo --{no,}-trees` still works
1773
    def run(self, location, format=None, no_trees=False):
1857.1.20 by Aaron Bentley
Strip out all the EnumOption stuff
1774
        if format is None:
2204.5.5 by Aaron Bentley
Remove RepositoryFormat.set_default_format, deprecate get_format_type
1775
            format = bzrdir.format_registry.make_bzrdir('default')
1857.1.20 by Aaron Bentley
Strip out all the EnumOption stuff
1776
1777
        if location is None:
1778
            location = '.'
1779
1830.4.7 by Wouter van Heyst
review fixes, rename transport variable to to_transport
1780
        to_transport = transport.get_transport(location)
2475.3.3 by John Arbash Meinel
Change calls to try/mkdir('.')/except FileExists to ensure_base()
1781
        to_transport.ensure_base()
1830.4.5 by Wouter van Heyst
cleanup
1782
1857.1.20 by Aaron Bentley
Strip out all the EnumOption stuff
1783
        newdir = format.initialize_on_transport(to_transport)
1558.5.2 by Aaron Bentley
Created *shared* repositories...
1784
        repo = newdir.create_repository(shared=True)
2257.2.2 by Wouter van Heyst
Actually test that `bzr init-repo --{no,}-trees` still works
1785
        repo.set_make_working_trees(not no_trees)
3535.9.1 by Marius Kruger
print info after init and init-repo
1786
        if not is_quiet():
1787
            from bzrlib.info import show_bzrdir_info
3697.5.4 by John Arbash Meinel
Merge vila's init[-repo] changes and add a NEWS entry.
1788
            show_bzrdir_info(repo.bzrdir, verbose=0, outfile=self.outf)
1558.5.1 by Aaron Bentley
Added make-repository command
1789
1790
1147 by Martin Pool
- split builtin commands into separate module bzrlib.builtins;
1791
class cmd_diff(Command):
3072.1.1 by Ian Clatworthy
Improved diff based on feedback from abentley
1792
    """Show differences in the working tree, between revisions or branches.
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
1793
3072.1.1 by Ian Clatworthy
Improved diff based on feedback from abentley
1794
    If no arguments are given, all changes for the current tree are listed.
1795
    If files are given, only the changes in those files are listed.
1796
    Remote and multiple branches can be compared by using the --old and
1797
    --new options. If not provided, the default for both is derived from
1798
    the first argument, if any, or the current tree if no arguments are
1799
    given.
1147 by Martin Pool
- split builtin commands into separate module bzrlib.builtins;
1800
1694.2.3 by Martin Pool
Add -p0, -p1 options for diff.
1801
    "bzr diff -p1" is equivalent to "bzr diff --prefix old/:new/", and
1802
    produces patches suitable for "patch -p1".
1803
2961.2.1 by Guillermo Gonzalez
* fix Bug #147938 (add exit values reference for cmd_diff help)
1804
    :Exit values:
1805
        1 - changed
1806
        2 - unrepresentable changes
1807
        3 - error
1808
        0 - no change
1809
2666.1.1 by Ian Clatworthy
Bazaar User Reference generated from online help
1810
    :Examples:
1811
        Shows the difference in the working tree versus the last commit::
1812
1813
            bzr diff
1814
1815
        Difference between the working tree and revision 1::
1816
1817
            bzr diff -r1
1818
1819
        Difference between revision 2 and revision 1::
1820
1821
            bzr diff -r1..2
1822
3072.1.1 by Ian Clatworthy
Improved diff based on feedback from abentley
1823
        Difference between revision 2 and revision 1 for branch xxx::
1824
1825
            bzr diff -r1..2 xxx
1826
1827
        Show just the differences for file NEWS::
1828
1829
            bzr diff NEWS
1830
1831
        Show the differences in working tree xxx for file NEWS::
1832
1833
            bzr diff xxx/NEWS
1834
1835
        Show the differences from branch xxx to this working tree:
1836
1837
            bzr diff --old xxx
1838
1839
        Show the differences between two branches for file NEWS::
1840
3072.1.4 by Ian Clatworthy
Tweak help
1841
            bzr diff --old xxx --new yyy NEWS
3072.1.1 by Ian Clatworthy
Improved diff based on feedback from abentley
1842
2666.1.1 by Ian Clatworthy
Bazaar User Reference generated from online help
1843
        Same as 'bzr diff' but prefix paths with old/ and new/::
1844
1845
            bzr diff --prefix old/:new/
1147 by Martin Pool
- split builtin commands into separate module bzrlib.builtins;
1846
    """
2425.2.3 by Robert Collins
Update existing builtin commands help text to use _see_also. (Robert Collins)
1847
    _see_also = ['status']
1147 by Martin Pool
- split builtin commands into separate module bzrlib.builtins;
1848
    takes_args = ['file*']
2598.1.10 by Martin Pool
Clean up options that are registered globally and used once or not at all.
1849
    takes_options = [
2598.1.11 by Martin Pool
Insist that all options have a help string and fix those that don't.
1850
        Option('diff-options', type=str,
1851
               help='Pass these options to the external diff program.'),
2193.3.1 by Martin Pool
Finish removal of global short-option table
1852
        Option('prefix', type=str,
1853
               short_name='p',
2852.1.1 by Vincent Ladeuil
Fix typo.
1854
               help='Set prefixes added to old and new filenames, as '
2598.1.1 by Martin Pool
Add test for and documentation of option style, fix up existing options to comply
1855
                    'two values separated by a colon. (eg "old/:new/").'),
3072.1.1 by Ian Clatworthy
Improved diff based on feedback from abentley
1856
        Option('old',
3118.1.2 by Ian Clatworthy
diff on branches without working trees (Ian Clatworthy, #6700)
1857
            help='Branch/tree to compare from.',
3072.1.1 by Ian Clatworthy
Improved diff based on feedback from abentley
1858
            type=unicode,
1859
            ),
1860
        Option('new',
3118.1.2 by Ian Clatworthy
diff on branches without working trees (Ian Clatworthy, #6700)
1861
            help='Branch/tree to compare to.',
3072.1.1 by Ian Clatworthy
Improved diff based on feedback from abentley
1862
            type=unicode,
1863
            ),
2598.1.11 by Martin Pool
Insist that all options have a help string and fix those that don't.
1864
        'revision',
2745.4.1 by Lukáš Lalinsky
New option -C/--change for diff and status to show changes in one revision. (#56299)
1865
        'change',
3123.6.2 by Aaron Bentley
Implement diff --using natively
1866
        Option('using',
1867
            help='Use this command to compare files.',
1868
            type=unicode,
1869
            ),
2190.2.1 by Martin Pool
remove global registration of short options
1870
        ]
1147 by Martin Pool
- split builtin commands into separate module bzrlib.builtins;
1871
    aliases = ['di', 'dif']
1185.85.36 by John Arbash Meinel
Working on tests for revision-history, ancestry, and diff
1872
    encoding_type = 'exact'
1147 by Martin Pool
- split builtin commands into separate module bzrlib.builtins;
1873
1185.12.56 by Aaron Bentley
Prevented display commands from printing broken pipe errors
1874
    @display_command
1684.1.6 by Martin Pool
(patch) --diff-prefix option (goffredo, alexander)
1875
    def run(self, revision=None, file_list=None, diff_options=None,
3123.6.2 by Aaron Bentley
Implement diff --using natively
1876
            prefix=None, old=None, new=None, using=None):
3072.1.1 by Ian Clatworthy
Improved diff based on feedback from abentley
1877
        from bzrlib.diff import _get_trees_to_diff, show_diff_trees
1684.1.6 by Martin Pool
(patch) --diff-prefix option (goffredo, alexander)
1878
1694.2.3 by Martin Pool
Add -p0, -p1 options for diff.
1879
        if (prefix is None) or (prefix == '0'):
1880
            # diff -p0 format
1694.2.1 by Martin Pool
Remove 'a/', 'b/' default prefixes on diff output.
1881
            old_label = ''
1882
            new_label = ''
1694.2.3 by Martin Pool
Add -p0, -p1 options for diff.
1883
        elif prefix == '1':
1884
            old_label = 'old/'
1885
            new_label = 'new/'
2197.2.1 by Martin Pool
Refactor cmd_diff
1886
        elif ':' in prefix:
1694.2.3 by Martin Pool
Add -p0, -p1 options for diff.
1887
            old_label, new_label = prefix.split(":")
2197.2.1 by Martin Pool
Refactor cmd_diff
1888
        else:
2324.1.1 by Dmitry Vasiliev
Small fixes for bzr diff
1889
            raise errors.BzrCommandError(
2325.1.2 by John Arbash Meinel
Add (eg "old/:new/") to errors to make it a little clearer.
1890
                '--prefix expects two values separated by a colon'
1891
                ' (eg "old/:new/")')
2197.2.1 by Martin Pool
Refactor cmd_diff
1892
2745.4.2 by Lukáš Lalinsky
Allow options to be stored in attributes that differ from their 'name' and use this to let '--change' and '--revision' to override each other.
1893
        if revision and len(revision) > 2:
1894
            raise errors.BzrCommandError('bzr diff --revision takes exactly'
1895
                                         ' one or two revision specifiers')
2325.1.2 by John Arbash Meinel
Add (eg "old/:new/") to errors to make it a little clearer.
1896
3072.1.1 by Ian Clatworthy
Improved diff based on feedback from abentley
1897
        old_tree, new_tree, specific_files, extra_trees = \
3586.1.21 by Ian Clatworthy
enhance diff to support views
1898
                _get_trees_to_diff(file_list, revision, old, new,
1899
                apply_view=True)
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
1900
        return show_diff_trees(old_tree, new_tree, sys.stdout,
3072.1.1 by Ian Clatworthy
Improved diff based on feedback from abentley
1901
                               specific_files=specific_files,
1902
                               external_diff_options=diff_options,
1903
                               old_label=old_label, new_label=new_label,
3123.6.2 by Aaron Bentley
Implement diff --using natively
1904
                               extra_trees=extra_trees, using=using)
1147 by Martin Pool
- split builtin commands into separate module bzrlib.builtins;
1905
1906
1907
class cmd_deleted(Command):
1908
    """List files deleted in the working tree.
1909
    """
1185.16.3 by Martin Pool
- remove all TODOs from bzr help messages
1910
    # TODO: Show files deleted since a previous revision, or
1911
    # between two revisions.
1912
    # TODO: Much more efficient way to do this: read in new
1913
    # directories with readdir, rather than stating each one.  Same
1914
    # level of effort but possibly much less IO.  (Or possibly not,
1915
    # if the directories are very large...)
2425.2.3 by Robert Collins
Update existing builtin commands help text to use _see_also. (Robert Collins)
1916
    _see_also = ['status', 'ls']
1185.85.49 by John Arbash Meinel
Updated cmd_deleted, including adding --show-ids option.
1917
    takes_options = ['show-ids']
1918
1185.12.56 by Aaron Bentley
Prevented display commands from printing broken pipe errors
1919
    @display_command
1147 by Martin Pool
- split builtin commands into separate module bzrlib.builtins;
1920
    def run(self, show_ids=False):
1185.33.66 by Martin Pool
[patch] use unicode literals for all hardcoded paths (Alexander Belchenko)
1921
        tree = WorkingTree.open_containing(u'.')[0]
2255.7.72 by Robert Collins
Update cmd_deleted to lock around inventory access.
1922
        tree.lock_read()
1923
        try:
1924
            old = tree.basis_tree()
1925
            old.lock_read()
1926
            try:
1927
                for path, ie in old.inventory.iter_entries():
1928
                    if not tree.has_id(ie.file_id):
1929
                        self.outf.write(path)
1930
                        if show_ids:
1931
                            self.outf.write(' ')
1932
                            self.outf.write(ie.file_id)
1933
                        self.outf.write('\n')
1934
            finally:
1935
                old.unlock()
1936
        finally:
1937
            tree.unlock()
1147 by Martin Pool
- split builtin commands into separate module bzrlib.builtins;
1938
1939
1940
class cmd_modified(Command):
1551.10.13 by Aaron Bentley
Hide 'unknowns', document alterntatives to hidden commands
1941
    """List files modified in working tree.
1942
    """
1551.10.14 by Aaron Bentley
Add some blank lines
1943
1147 by Martin Pool
- split builtin commands into separate module bzrlib.builtins;
1944
    hidden = True
2425.2.3 by Robert Collins
Update existing builtin commands help text to use _see_also. (Robert Collins)
1945
    _see_also = ['status', 'ls']
3251.6.2 by Adrian Wilkins
Added null separation option for bzr modified and bzr added
1946
    takes_options = [
1947
            Option('null',
1948
                   help='Write an ascii NUL (\\0) separator '
1949
                   'between files rather than a newline.')
1950
            ]
1551.10.14 by Aaron Bentley
Add some blank lines
1951
1185.12.56 by Aaron Bentley
Prevented display commands from printing broken pipe errors
1952
    @display_command
3251.6.2 by Adrian Wilkins
Added null separation option for bzr modified and bzr added
1953
    def run(self, null=False):
1185.33.66 by Martin Pool
[patch] use unicode literals for all hardcoded paths (Alexander Belchenko)
1954
        tree = WorkingTree.open_containing(u'.')[0]
1852.10.3 by Robert Collins
Remove all uses of compare_trees and replace with Tree.changes_from throughout bzrlib.
1955
        td = tree.changes_from(tree.basis_tree())
1398 by Robert Collins
integrate in Gustavos x-bit patch
1956
        for path, id, kind, text_modified, meta_modified in td.modified:
3251.6.2 by Adrian Wilkins
Added null separation option for bzr modified and bzr added
1957
            if null:
1958
                self.outf.write(path + '\0')
1959
            else:
1960
                self.outf.write(osutils.quotefn(path) + '\n')
1147 by Martin Pool
- split builtin commands into separate module bzrlib.builtins;
1961
1962
1963
class cmd_added(Command):
1551.10.13 by Aaron Bentley
Hide 'unknowns', document alterntatives to hidden commands
1964
    """List files added in working tree.
1965
    """
1551.10.14 by Aaron Bentley
Add some blank lines
1966
1147 by Martin Pool
- split builtin commands into separate module bzrlib.builtins;
1967
    hidden = True
2425.2.3 by Robert Collins
Update existing builtin commands help text to use _see_also. (Robert Collins)
1968
    _see_also = ['status', 'ls']
3251.6.2 by Adrian Wilkins
Added null separation option for bzr modified and bzr added
1969
    takes_options = [
1970
            Option('null',
1971
                   help='Write an ascii NUL (\\0) separator '
1972
                   'between files rather than a newline.')
1973
            ]
1551.10.14 by Aaron Bentley
Add some blank lines
1974
1185.12.56 by Aaron Bentley
Prevented display commands from printing broken pipe errors
1975
    @display_command
3251.6.2 by Adrian Wilkins
Added null separation option for bzr modified and bzr added
1976
    def run(self, null=False):
1185.33.66 by Martin Pool
[patch] use unicode literals for all hardcoded paths (Alexander Belchenko)
1977
        wt = WorkingTree.open_containing(u'.')[0]
2255.7.69 by Robert Collins
Fix all blackbox add tests, and the add --from-ids case in the UI.
1978
        wt.lock_read()
1979
        try:
1980
            basis = wt.basis_tree()
1981
            basis.lock_read()
1982
            try:
1983
                basis_inv = basis.inventory
1984
                inv = wt.inventory
1985
                for file_id in inv:
1986
                    if file_id in basis_inv:
1987
                        continue
1988
                    if inv.is_root(file_id) and len(basis_inv) == 0:
1989
                        continue
1990
                    path = inv.id2path(file_id)
1991
                    if not os.access(osutils.abspath(path), os.F_OK):
1992
                        continue
3251.6.2 by Adrian Wilkins
Added null separation option for bzr modified and bzr added
1993
                    if null:
1994
                        self.outf.write(path + '\0')
1995
                    else:
1996
                        self.outf.write(osutils.quotefn(path) + '\n')
2255.7.69 by Robert Collins
Fix all blackbox add tests, and the add --from-ids case in the UI.
1997
            finally:
1998
                basis.unlock()
1999
        finally:
2000
            wt.unlock()
1185.85.53 by John Arbash Meinel
Updated cmd_root
2001
1147 by Martin Pool
- split builtin commands into separate module bzrlib.builtins;
2002
2003
class cmd_root(Command):
2004
    """Show the tree root directory.
2005
2006
    The root is the nearest enclosing directory with a .bzr control
2007
    directory."""
2425.2.3 by Robert Collins
Update existing builtin commands help text to use _see_also. (Robert Collins)
2008
1147 by Martin Pool
- split builtin commands into separate module bzrlib.builtins;
2009
    takes_args = ['filename?']
1185.12.56 by Aaron Bentley
Prevented display commands from printing broken pipe errors
2010
    @display_command
1147 by Martin Pool
- split builtin commands into separate module bzrlib.builtins;
2011
    def run(self, filename=None):
2012
        """Print the branch root."""
1508.1.4 by Robert Collins
Convert most of the front ends commands to use WorkingTree.open_containing
2013
        tree = WorkingTree.open_containing(filename)[0]
1685.1.80 by Wouter van Heyst
more code cleanup
2014
        self.outf.write(tree.basedir + '\n')
1147 by Martin Pool
- split builtin commands into separate module bzrlib.builtins;
2015
2016
2466.9.1 by Kent Gibson
add bzr log --limit
2017
def _parse_limit(limitstring):
2018
    try:
2019
        return int(limitstring)
2020
    except ValueError:
2021
        msg = "The limit argument must be an integer."
2022
        raise errors.BzrCommandError(msg)
2023
2024
3970.1.1 by Ian Clatworthy
log -n/--levels (Ian Clatworthy)
2025
def _parse_levels(s):
3947.1.6 by Ian Clatworthy
log -n/--level-count N option
2026
    try:
2027
        return int(s)
2028
    except ValueError:
3970.1.1 by Ian Clatworthy
log -n/--levels (Ian Clatworthy)
2029
        msg = "The levels argument must be an integer."
3947.1.6 by Ian Clatworthy
log -n/--level-count N option
2030
        raise errors.BzrCommandError(msg)
2031
2032
1147 by Martin Pool
- split builtin commands into separate module bzrlib.builtins;
2033
class cmd_log(Command):
3974.1.2 by Ian Clatworthy
enhanced log help
2034
    """Show historical log for a branch or subset of a branch.
2035
2036
    log is bzr's default tool for exploring the history of a branch.
2037
    The branch to use is taken from the first parameter. If no parameters
2038
    are given, the branch containing the working directory is logged.
2039
    Here are some simple examples::
2040
2041
      bzr log                       log the current branch
2042
      bzr log foo.py                log a file in its branch
2043
      bzr log http://server/branch  log a branch on a server
2044
2045
    The filtering, ordering and information shown for each revision can
2046
    be controlled as explained below. By default, all revisions are
2047
    shown sorted (topologically) so that newer revisions appear before
2048
    older ones and descendants always appear before ancestors. If displayed,
2049
    merged revisions are shown indented under the revision in which they
2050
    were merged.
2051
2052
    :Output control:
4032.1.1 by John Arbash Meinel
Merge the removal of all trailing whitespace, and resolve conflicts.
2053
3974.1.4 by Ian Clatworthy
log-formats topic and explained range searching
2054
      The log format controls how information about each revision is
2055
      displayed. The standard log formats are called ``long``, ``short``
2056
      and ``line``. The default is long. See ``bzr help log-formats``
2057
      for more details on log formats.
3974.1.2 by Ian Clatworthy
enhanced log help
2058
3974.1.4 by Ian Clatworthy
log-formats topic and explained range searching
2059
      The following options can be used to control what information is
2060
      displayed::
4032.1.1 by John Arbash Meinel
Merge the removal of all trailing whitespace, and resolve conflicts.
2061
3974.1.4 by Ian Clatworthy
log-formats topic and explained range searching
2062
        -l N        display a maximum of N revisions
2063
        -n N        display N levels of revisions (0 for all, 1 for collapsed)
2064
        -v          display a status summary (delta) for each revision
2065
        -p          display a diff (patch) for each revision
2066
        --show-ids  display revision-ids (and file-ids), not just revnos
4032.1.1 by John Arbash Meinel
Merge the removal of all trailing whitespace, and resolve conflicts.
2067
3974.1.4 by Ian Clatworthy
log-formats topic and explained range searching
2068
      Note that the default number of levels to display is a function of the
4206.1.1 by Ian Clatworthy
log mainline by default
2069
      log format. If the -n option is not used, the standard log formats show
2070
      just the top level (mainline).
4032.1.1 by John Arbash Meinel
Merge the removal of all trailing whitespace, and resolve conflicts.
2071
3974.1.4 by Ian Clatworthy
log-formats topic and explained range searching
2072
      Status summaries are shown using status flags like A, M, etc. To see
2073
      the changes explained using words like ``added`` and ``modified``
2074
      instead, use the -vv option.
4032.1.1 by John Arbash Meinel
Merge the removal of all trailing whitespace, and resolve conflicts.
2075
3974.1.2 by Ian Clatworthy
enhanced log help
2076
    :Ordering control:
4032.1.1 by John Arbash Meinel
Merge the removal of all trailing whitespace, and resolve conflicts.
2077
3974.1.4 by Ian Clatworthy
log-formats topic and explained range searching
2078
      To display revisions from oldest to newest, use the --forward option.
2079
      In most cases, using this option will have little impact on the total
2080
      time taken to produce a log, though --forward does not incrementally
2081
      display revisions like --reverse does when it can.
4032.1.1 by John Arbash Meinel
Merge the removal of all trailing whitespace, and resolve conflicts.
2082
3974.1.2 by Ian Clatworthy
enhanced log help
2083
    :Revision filtering:
4032.1.1 by John Arbash Meinel
Merge the removal of all trailing whitespace, and resolve conflicts.
2084
3974.1.4 by Ian Clatworthy
log-formats topic and explained range searching
2085
      The -r option can be used to specify what revision or range of revisions
2086
      to filter against. The various forms are shown below::
4032.1.1 by John Arbash Meinel
Merge the removal of all trailing whitespace, and resolve conflicts.
2087
3974.1.4 by Ian Clatworthy
log-formats topic and explained range searching
2088
        -rX      display revision X
2089
        -rX..    display revision X and later
2090
        -r..Y    display up to and including revision Y
2091
        -rX..Y   display from X to Y inclusive
4032.1.1 by John Arbash Meinel
Merge the removal of all trailing whitespace, and resolve conflicts.
2092
3974.1.4 by Ian Clatworthy
log-formats topic and explained range searching
2093
      See ``bzr help revisionspec`` for details on how to specify X and Y.
2094
      Some common examples are given below::
4032.1.1 by John Arbash Meinel
Merge the removal of all trailing whitespace, and resolve conflicts.
2095
3974.1.4 by Ian Clatworthy
log-formats topic and explained range searching
2096
        -r-1                show just the tip
2097
        -r-10..             show the last 10 mainline revisions
2098
        -rsubmit:..         show what's new on this branch
2099
        -rancestor:path..   show changes since the common ancestor of this
2100
                            branch and the one at location path
2101
        -rdate:yesterday..  show changes since yesterday
4032.1.1 by John Arbash Meinel
Merge the removal of all trailing whitespace, and resolve conflicts.
2102
3974.1.4 by Ian Clatworthy
log-formats topic and explained range searching
2103
      When logging a range of revisions using -rX..Y, log starts at
2104
      revision Y and searches back in history through the primary
2105
      ("left-hand") parents until it finds X. When logging just the
2106
      top level (using -n1), an error is reported if X is not found
2107
      along the way. If multi-level logging is used (-n0), X may be
2108
      a nested merge revision and the log will be truncated accordingly.
2109
3974.1.2 by Ian Clatworthy
enhanced log help
2110
    :Path filtering:
4032.1.1 by John Arbash Meinel
Merge the removal of all trailing whitespace, and resolve conflicts.
2111
4202.2.5 by Ian Clatworthy
apply review tweaks & update help
2112
      If parameters are given and the first one is not a branch, the log
2113
      will be filtered to show only those revisions that changed the
2114
      nominated files or directories.
4032.1.1 by John Arbash Meinel
Merge the removal of all trailing whitespace, and resolve conflicts.
2115
3974.1.4 by Ian Clatworthy
log-formats topic and explained range searching
2116
      Filenames are interpreted within their historical context. To log a
2117
      deleted file, specify a revision range so that the file existed at
2118
      the end or start of the range.
4032.1.1 by John Arbash Meinel
Merge the removal of all trailing whitespace, and resolve conflicts.
2119
3974.1.4 by Ian Clatworthy
log-formats topic and explained range searching
2120
      Historical context is also important when interpreting pathnames of
2121
      renamed files/directories. Consider the following example:
4032.1.1 by John Arbash Meinel
Merge the removal of all trailing whitespace, and resolve conflicts.
2122
3974.1.4 by Ian Clatworthy
log-formats topic and explained range searching
2123
      * revision 1: add tutorial.txt
2124
      * revision 2: modify tutorial.txt
2125
      * revision 3: rename tutorial.txt to guide.txt; add tutorial.txt
4032.1.1 by John Arbash Meinel
Merge the removal of all trailing whitespace, and resolve conflicts.
2126
3974.1.4 by Ian Clatworthy
log-formats topic and explained range searching
2127
      In this case:
4032.1.1 by John Arbash Meinel
Merge the removal of all trailing whitespace, and resolve conflicts.
2128
3974.1.4 by Ian Clatworthy
log-formats topic and explained range searching
2129
      * ``bzr log guide.txt`` will log the file added in revision 1
4032.1.1 by John Arbash Meinel
Merge the removal of all trailing whitespace, and resolve conflicts.
2130
3974.1.4 by Ian Clatworthy
log-formats topic and explained range searching
2131
      * ``bzr log tutorial.txt`` will log the new file added in revision 3
4032.1.1 by John Arbash Meinel
Merge the removal of all trailing whitespace, and resolve conflicts.
2132
3974.1.4 by Ian Clatworthy
log-formats topic and explained range searching
2133
      * ``bzr log -r2 -p tutorial.txt`` will show the changes made to
2134
        the original file in revision 2.
4032.1.1 by John Arbash Meinel
Merge the removal of all trailing whitespace, and resolve conflicts.
2135
3974.1.4 by Ian Clatworthy
log-formats topic and explained range searching
2136
      * ``bzr log -r2 -p guide.txt`` will display an error message as there
2137
        was no file called guide.txt in revision 2.
4032.1.1 by John Arbash Meinel
Merge the removal of all trailing whitespace, and resolve conflicts.
2138
3974.1.4 by Ian Clatworthy
log-formats topic and explained range searching
2139
      Renames are always followed by log. By design, there is no need to
2140
      explicitly ask for this (and no way to stop logging a file back
2141
      until it was last renamed).
4032.1.1 by John Arbash Meinel
Merge the removal of all trailing whitespace, and resolve conflicts.
2142
3974.1.2 by Ian Clatworthy
enhanced log help
2143
    :Other filtering:
4032.1.1 by John Arbash Meinel
Merge the removal of all trailing whitespace, and resolve conflicts.
2144
3974.1.4 by Ian Clatworthy
log-formats topic and explained range searching
2145
      The --message option can be used for finding revisions that match a
2146
      regular expression in a commit message.
4032.1.1 by John Arbash Meinel
Merge the removal of all trailing whitespace, and resolve conflicts.
2147
3974.1.2 by Ian Clatworthy
enhanced log help
2148
    :Tips & tricks:
4032.1.1 by John Arbash Meinel
Merge the removal of all trailing whitespace, and resolve conflicts.
2149
3974.1.4 by Ian Clatworthy
log-formats topic and explained range searching
2150
      GUI tools and IDEs are often better at exploring history than command
2151
      line tools. You may prefer qlog or glog from the QBzr and Bzr-Gtk packages
2152
      respectively for example. (TortoiseBzr uses qlog for displaying logs.) See
2153
      http://bazaar-vcs.org/BzrPlugins and http://bazaar-vcs.org/IDEIntegration.
4032.1.1 by John Arbash Meinel
Merge the removal of all trailing whitespace, and resolve conflicts.
2154
3974.1.4 by Ian Clatworthy
log-formats topic and explained range searching
2155
      Web interfaces are often better at exploring history than command line
2156
      tools, particularly for branches on servers. You may prefer Loggerhead
2157
      or one of its alternatives. See http://bazaar-vcs.org/WebInterface.
4032.1.1 by John Arbash Meinel
Merge the removal of all trailing whitespace, and resolve conflicts.
2158
3974.1.4 by Ian Clatworthy
log-formats topic and explained range searching
2159
      You may find it useful to add the aliases below to ``bazaar.conf``::
4032.1.1 by John Arbash Meinel
Merge the removal of all trailing whitespace, and resolve conflicts.
2160
3974.1.4 by Ian Clatworthy
log-formats topic and explained range searching
2161
        [ALIASES]
4206.1.1 by Ian Clatworthy
log mainline by default
2162
        tip = log -r-1
4202.2.5 by Ian Clatworthy
apply review tweaks & update help
2163
        top = log -l10 --line
4206.1.1 by Ian Clatworthy
log mainline by default
2164
        show = log -v -p
4032.1.1 by John Arbash Meinel
Merge the removal of all trailing whitespace, and resolve conflicts.
2165
3974.1.4 by Ian Clatworthy
log-formats topic and explained range searching
2166
      ``bzr tip`` will then show the latest revision while ``bzr top``
2167
      will show the last 10 mainline revisions. To see the details of a
2168
      particular revision X,  ``bzr show -rX``.
4032.1.1 by John Arbash Meinel
Merge the removal of all trailing whitespace, and resolve conflicts.
2169
4206.1.1 by Ian Clatworthy
log mainline by default
2170
      If you are interested in looking deeper into a particular merge X,
2171
      use ``bzr log -n0 -rX``.
4032.1.1 by John Arbash Meinel
Merge the removal of all trailing whitespace, and resolve conflicts.
2172
3974.1.4 by Ian Clatworthy
log-formats topic and explained range searching
2173
      ``bzr log -v`` on a branch with lots of history is currently
2174
      very slow. A fix for this issue is currently under development.
2175
      With or without that fix, it is recommended that a revision range
2176
      be given when using the -v option.
4032.1.1 by John Arbash Meinel
Merge the removal of all trailing whitespace, and resolve conflicts.
2177
3974.1.4 by Ian Clatworthy
log-formats topic and explained range searching
2178
      bzr has a generic full-text matching plugin, bzr-search, that can be
2179
      used to find revisions matching user names, commit messages, etc.
2180
      Among other features, this plugin can find all revisions containing
2181
      a list of words but not others.
4032.1.1 by John Arbash Meinel
Merge the removal of all trailing whitespace, and resolve conflicts.
2182
3974.1.4 by Ian Clatworthy
log-formats topic and explained range searching
2183
      When exploring non-mainline history on large projects with deep
2184
      history, the performance of log can be greatly improved by installing
4360.1.1 by Ian Clatworthy
(trivial) revnocache -> historycache in log help (Ian Clatworthy)
2185
      the historycache plugin. This plugin buffers historical information
3974.1.4 by Ian Clatworthy
log-formats topic and explained range searching
2186
      trading disk space for faster speed.
1147 by Martin Pool
- split builtin commands into separate module bzrlib.builtins;
2187
    """
4202.2.1 by Ian Clatworthy
get directory logging working again
2188
    takes_args = ['file*']
3974.1.4 by Ian Clatworthy
log-formats topic and explained range searching
2189
    _see_also = ['log-formats', 'revisionspec']
2598.1.3 by Martin Pool
Option help improvements (thanks jamesw)
2190
    takes_options = [
2191
            Option('forward',
2192
                   help='Show from oldest to newest.'),
3755.1.1 by Vincent Ladeuil
Fix --verbose leaking into blackbox tests.
2193
            'timezone',
2768.1.5 by Ian Clatworthy
Wrap new std verbose option with new help instead of declaring a new one
2194
            custom_help('verbose',
2598.1.3 by Martin Pool
Option help improvements (thanks jamesw)
2195
                   help='Show files changed in each revision.'),
2196
            'show-ids',
2197
            'revision',
3734.1.1 by Vincent Ladeuil
Fix bug #248427 by adding a --change option to log.
2198
            Option('change',
2199
                   type=bzrlib.option._parse_revision_str,
2200
                   short_name='c',
2201
                   help='Show just the specified revision.'
2202
                   ' See also "help revisionspec".'),
2598.1.3 by Martin Pool
Option help improvements (thanks jamesw)
2203
            'log-format',
3947.1.10 by Ian Clatworthy
review feedback from vila
2204
            Option('levels',
3947.1.5 by Ian Clatworthy
rename --merge-revisions to --include-merges
2205
                   short_name='n',
3947.1.6 by Ian Clatworthy
log -n/--level-count N option
2206
                   help='Number of levels to display - 0 for all, 1 for flat.',
2207
                   argname='N',
3970.1.1 by Ian Clatworthy
log -n/--levels (Ian Clatworthy)
2208
                   type=_parse_levels),
2598.1.3 by Martin Pool
Option help improvements (thanks jamesw)
2209
            Option('message',
2210
                   short_name='m',
2211
                   help='Show revisions whose message matches this '
2212
                        'regular expression.',
2213
                   type=str),
2214
            Option('limit',
3108.1.1 by Matt Nordhoff
bzr log: Add -l short name for the --limit argument.
2215
                   short_name='l',
2598.1.3 by Martin Pool
Option help improvements (thanks jamesw)
2216
                   help='Limit the output to the first N revisions.',
2217
                   argname='N',
2218
                   type=_parse_limit),
3943.5.1 by Ian Clatworthy
first cut at log --show-diff
2219
            Option('show-diff',
3943.5.5 by Ian Clatworthy
tweak option name as requested in bug report
2220
                   short_name='p',
2221
                   help='Show changes made in each revision as a patch.'),
4221.2.1 by Ian Clatworthy
--include-merges as an alias for --levels 0 in log
2222
            Option('include-merges',
2223
                   help='Show merged revisions like --levels 0 does.'),
2598.1.3 by Martin Pool
Option help improvements (thanks jamesw)
2224
            ]
1185.85.22 by John Arbash Meinel
Updated cmd_inventory. Changing from having each Command request an encoded stdout to providing one before calling run()
2225
    encoding_type = 'replace'
2226
1185.12.56 by Aaron Bentley
Prevented display commands from printing broken pipe errors
2227
    @display_command
4202.2.1 by Ian Clatworthy
get directory logging working again
2228
    def run(self, file_list=None, timezone='original',
1147 by Martin Pool
- split builtin commands into separate module bzrlib.builtins;
2229
            verbose=False,
2230
            show_ids=False,
2231
            forward=False,
2232
            revision=None,
3734.1.1 by Vincent Ladeuil
Fix bug #248427 by adding a --change option to log.
2233
            change=None,
1553.2.1 by Erik Bågfors
Support for plugins to register log formatters and set default formatter
2234
            log_format=None,
3947.1.10 by Ian Clatworthy
review feedback from vila
2235
            levels=None,
2466.9.1 by Kent Gibson
add bzr log --limit
2236
            message=None,
3943.5.1 by Ian Clatworthy
first cut at log --show-diff
2237
            limit=None,
4221.2.1 by Ian Clatworthy
--include-merges as an alias for --levels 0 in log
2238
            show_diff=False,
2239
            include_merges=False):
4202.2.5 by Ian Clatworthy
apply review tweaks & update help
2240
        from bzrlib.log import (
2241
            Logger,
2242
            make_log_request_dict,
2243
            _get_info_for_log_files,
2244
            )
1147 by Martin Pool
- split builtin commands into separate module bzrlib.builtins;
2245
        direction = (forward and 'forward') or 'reverse'
4221.2.2 by Ian Clatworthy
jam feedback: make --levels and --include-merges mutually exclusive
2246
        if include_merges:
2247
            if levels is None:
2248
                levels = 0
2249
            else:
2250
                raise errors.BzrCommandError(
2251
                    '--levels and --include-merges are mutually exclusive')
3734.1.1 by Vincent Ladeuil
Fix bug #248427 by adding a --change option to log.
2252
2253
        if change is not None:
2254
            if len(change) > 1:
2255
                raise errors.RangeInChangeOption()
2256
            if revision is not None:
2257
                raise errors.BzrCommandError(
2258
                    '--revision and --change are mutually exclusive')
2259
            else:
2260
                revision = change
2261
4202.2.1 by Ian Clatworthy
get directory logging working again
2262
        file_ids = []
2263
        filter_by_dir = False
2264
        if file_list:
2265
            # find the file ids to log and check for directory filtering
2266
            b, file_info_list, rev1, rev2 = _get_info_for_log_files(revision,
2267
                file_list)
2268
            for relpath, file_id, kind in file_info_list:
2100.1.1 by wang
Running ``bzr log`` on nonexistent file gives an error instead of the
2269
                if file_id is None:
2270
                    raise errors.BzrCommandError(
3943.6.3 by Ian Clatworthy
search the start tree if the end tree doesn't have a file
2271
                        "Path unknown at end or start of revision range: %s" %
4202.2.1 by Ian Clatworthy
get directory logging working again
2272
                        relpath)
2273
                # If the relpath is the top of the tree, we log everything
2274
                if relpath == '':
2275
                    file_ids = []
2276
                    break
2277
                else:
2278
                    file_ids.append(file_id)
2279
                filter_by_dir = filter_by_dir or (
2280
                    kind in ['directory', 'tree-reference'])
1147 by Martin Pool
- split builtin commands into separate module bzrlib.builtins;
2281
        else:
4202.2.1 by Ian Clatworthy
get directory logging working again
2282
            # log everything
4202.2.5 by Ian Clatworthy
apply review tweaks & update help
2283
            # FIXME ? log the current subdir only RBC 20060203
1907.4.10 by Matthieu Moy
Cut long lines, prevent "path" component from being used in revno:branch/path.
2284
            if revision is not None \
2285
                    and len(revision) > 0 and revision[0].get_branch():
1907.4.2 by Matthieu Moy
Make log work nicely with revno:N:path too.
2286
                location = revision[0].get_branch()
2287
            else:
2288
                location = '.'
2289
            dir, relpath = bzrdir.BzrDir.open_containing(location)
1534.4.46 by Robert Collins
Nearly complete .bzr/checkout splitout.
2290
            b = dir.open_branch()
3904.2.4 by Marius Kruger
* rename _get2Revisions to _get_revision_range
2291
            rev1, rev2 = _get_revision_range(revision, b, self.name())
4202.2.1 by Ian Clatworthy
get directory logging working again
2292
2293
        # Decide on the type of delta & diff filtering to use
2294
        # TODO: add an --all-files option to make this configurable & consistent
2295
        if not verbose:
2296
            delta_type = None
2297
        else:
2298
            delta_type = 'full'
2299
        if not show_diff:
2300
            diff_type = None
2301
        elif file_ids:
2302
            diff_type = 'partial'
2303
        else:
2304
            diff_type = 'full'
2305
2306
        b.lock_read()
2307
        try:
2308
            # Build the log formatter
2230.4.1 by Aaron Bentley
Get log as fast branch5
2309
            if log_format is None:
2310
                log_format = log.log_formatter_registry.get_default(b)
2311
            lf = log_format(show_ids=show_ids, to_file=self.outf,
3874.1.4 by Vincent Ladeuil
Fixed as per Aarons' comment.
2312
                            show_timezone=timezone,
3947.1.1 by Ian Clatworthy
add --merge-revisions to log
2313
                            delta_format=get_verbosity_level(),
4221.2.3 by Ian Clatworthy
jam feedback: don't show advice if --levels explicitly given
2314
                            levels=levels,
2315
                            show_advice=levels is None)
2230.4.1 by Aaron Bentley
Get log as fast branch5
2316
4202.2.1 by Ian Clatworthy
get directory logging working again
2317
            # Choose the algorithm for doing the logging. It's annoying
2318
            # having multiple code paths like this but necessary until
2319
            # the underlying repository format is faster at generating
2320
            # deltas or can provide everything we need from the indices.
2321
            # The default algorithm - match-using-deltas - works for
2322
            # multiple files and directories and is faster for small
2323
            # amounts of history (200 revisions say). However, it's too
2324
            # slow for logging a single file in a repository with deep
2325
            # history, i.e. > 10K revisions. In the spirit of "do no
2326
            # evil when adding features", we continue to use the
2327
            # original algorithm - per-file-graph - for the "single
2328
            # file that isn't a directory without showing a delta" case.
4246.2.1 by Ian Clatworthy
supports_chks flag on repo formats & log tuning
2329
            partial_history = revision and b.repository._format.supports_chks
4202.2.1 by Ian Clatworthy
get directory logging working again
2330
            match_using_deltas = (len(file_ids) != 1 or filter_by_dir
4246.2.1 by Ian Clatworthy
supports_chks flag on repo formats & log tuning
2331
                or delta_type or partial_history)
4202.2.1 by Ian Clatworthy
get directory logging working again
2332
2333
            # Build the LogRequest and execute it
2334
            if len(file_ids) == 0:
2335
                file_ids = None
4202.2.5 by Ian Clatworthy
apply review tweaks & update help
2336
            rqst = make_log_request_dict(
2337
                direction=direction, specific_fileids=file_ids,
4202.2.1 by Ian Clatworthy
get directory logging working again
2338
                start_revision=rev1, end_revision=rev2, limit=limit,
2339
                message_search=message, delta_type=delta_type,
2340
                diff_type=diff_type, _match_using_deltas=match_using_deltas)
4202.2.3 by Ian Clatworthy
replace show_log_request with a Logger class
2341
            Logger(b, rqst).show(lf)
2230.4.1 by Aaron Bentley
Get log as fast branch5
2342
        finally:
2343
            b.unlock()
1147 by Martin Pool
- split builtin commands into separate module bzrlib.builtins;
2344
3943.6.3 by Ian Clatworthy
search the start tree if the end tree doesn't have a file
2345
3904.2.4 by Marius Kruger
* rename _get2Revisions to _get_revision_range
2346
def _get_revision_range(revisionspec_list, branch, command_name):
2347
    """Take the input of a revision option and turn it into a revision range.
2348
2349
    It returns RevisionInfo objects which can be used to obtain the rev_id's
4202.2.1 by Ian Clatworthy
get directory logging working again
2350
    of the desired revisions. It does some user input validations.
3904.2.4 by Marius Kruger
* rename _get2Revisions to _get_revision_range
2351
    """
3904.2.1 by Marius Kruger
* factor out _get2Revisions from cmd_log to be able to reuse how revesions is determined by log.
2352
    if revisionspec_list is None:
2353
        rev1 = None
2354
        rev2 = None
2355
    elif len(revisionspec_list) == 1:
2356
        rev1 = rev2 = revisionspec_list[0].in_history(branch)
2357
    elif len(revisionspec_list) == 2:
3936.3.21 by Ian Clatworthy
make log -rX.. as fast as log -rX..-1
2358
        start_spec = revisionspec_list[0]
2359
        end_spec = revisionspec_list[1]
2360
        if end_spec.get_branch() != start_spec.get_branch():
3904.2.1 by Marius Kruger
* factor out _get2Revisions from cmd_log to be able to reuse how revesions is determined by log.
2361
            # b is taken from revision[0].get_branch(), and
2362
            # show_log will use its revision_history. Having
2363
            # different branches will lead to weird behaviors.
2364
            raise errors.BzrCommandError(
3904.2.4 by Marius Kruger
* rename _get2Revisions to _get_revision_range
2365
                "bzr %s doesn't accept two revisions in different"
2366
                " branches." % command_name)
3936.3.21 by Ian Clatworthy
make log -rX.. as fast as log -rX..-1
2367
        rev1 = start_spec.in_history(branch)
2368
        # Avoid loading all of history when we know a missing
2369
        # end of range means the last revision ...
3936.3.40 by Ian Clatworthy
review feedback from jam
2370
        if end_spec.spec is None:
3936.3.21 by Ian Clatworthy
make log -rX.. as fast as log -rX..-1
2371
            last_revno, last_revision_id = branch.last_revision_info()
2372
            rev2 = RevisionInfo(branch, last_revno, last_revision_id)
2373
        else:
2374
            rev2 = end_spec.in_history(branch)
3904.2.1 by Marius Kruger
* factor out _get2Revisions from cmd_log to be able to reuse how revesions is determined by log.
2375
    else:
2376
        raise errors.BzrCommandError(
2377
            'bzr %s --revision takes one or two values.' % command_name)
2378
    return rev1, rev2
1185.85.4 by John Arbash Meinel
currently broken, trying to fix things up.
2379
3921.3.4 by Marius Kruger
add support to filter on local and remote revisions
2380
2381
def _revision_range_to_revid_range(revision_range):
2382
    rev_id1 = None
2383
    rev_id2 = None
2384
    if revision_range[0] is not None:
2385
        rev_id1 = revision_range[0].rev_id
2386
    if revision_range[1] is not None:
2387
        rev_id2 = revision_range[1].rev_id
2388
    return rev_id1, rev_id2
2389
1857.1.20 by Aaron Bentley
Strip out all the EnumOption stuff
2390
def get_log_format(long=False, short=False, line=False, default='long'):
2391
    log_format = default
2392
    if long:
2393
        log_format = 'long'
2394
    if short:
2395
        log_format = 'short'
2396
    if line:
2397
        log_format = 'line'
2398
    return log_format
2399
2400
1147 by Martin Pool
- split builtin commands into separate module bzrlib.builtins;
2401
class cmd_touching_revisions(Command):
2402
    """Return revision-ids which affected a particular file.
2403
1685.1.80 by Wouter van Heyst
more code cleanup
2404
    A more user-friendly interface is "bzr log FILE".
2405
    """
2406
1147 by Martin Pool
- split builtin commands into separate module bzrlib.builtins;
2407
    hidden = True
2408
    takes_args = ["filename"]
1185.85.55 by John Arbash Meinel
Updated cmd_touching_revisions
2409
1185.12.56 by Aaron Bentley
Prevented display commands from printing broken pipe errors
2410
    @display_command
1147 by Martin Pool
- split builtin commands into separate module bzrlib.builtins;
2411
    def run(self, filename):
1508.1.4 by Robert Collins
Convert most of the front ends commands to use WorkingTree.open_containing
2412
        tree, relpath = WorkingTree.open_containing(filename)
2413
        b = tree.branch
2255.7.39 by Robert Collins
Remove gratuitous references to inventory.path2id from builtins.py, allowing more commands to work on dirstate trees.
2414
        file_id = tree.path2id(relpath)
1773.4.1 by Martin Pool
Add pyflakes makefile target; fix many warnings
2415
        for revno, revision_id, what in log.find_touching_revisions(b, file_id):
1185.85.55 by John Arbash Meinel
Updated cmd_touching_revisions
2416
            self.outf.write("%6d %s\n" % (revno, what))
1147 by Martin Pool
- split builtin commands into separate module bzrlib.builtins;
2417
2418
2419
class cmd_ls(Command):
2420
    """List files in a tree.
2421
    """
1551.9.24 by Aaron Bentley
Unhide ls, add kind flag
2422
2425.2.3 by Robert Collins
Update existing builtin commands help text to use _see_also. (Robert Collins)
2423
    _see_also = ['status', 'cat']
2215.3.1 by Aaron Bentley
Allow ls to take a PATH
2424
    takes_args = ['path?']
2598.1.2 by Martin Pool
Also check that option help ends in a period, and fix those that don't
2425
    takes_options = [
2426
            'verbose',
2427
            'revision',
4206.2.1 by Ian Clatworthy
ls should be non-recursive by default
2428
            Option('recursive', short_name='R',
2429
                   help='Recurse into subdirectories.'),
2598.1.2 by Martin Pool
Also check that option help ends in a period, and fix those that don't
2430
            Option('from-root',
2598.1.3 by Martin Pool
Option help improvements (thanks jamesw)
2431
                   help='Print paths relative to the root of the branch.'),
2598.1.2 by Martin Pool
Also check that option help ends in a period, and fix those that don't
2432
            Option('unknown', help='Print unknown files.'),
3382.2.1 by Jerad Cramp
Fixed bug #165086. Command 'bzr ls' now accepts '-V' as an alias for '--versioned'.
2433
            Option('versioned', help='Print versioned files.',
2434
                   short_name='V'),
2598.1.2 by Martin Pool
Also check that option help ends in a period, and fix those that don't
2435
            Option('ignored', help='Print ignored files.'),
2436
            Option('null',
2437
                   help='Write an ascii NUL (\\0) separator '
2438
                   'between files rather than a newline.'),
2598.1.11 by Martin Pool
Insist that all options have a help string and fix those that don't.
2439
            Option('kind',
2598.1.12 by Martin Pool
Fix up --kind options
2440
                   help='List entries of a particular kind: file, directory, symlink.',
2441
                   type=unicode),
2598.1.2 by Martin Pool
Also check that option help ends in a period, and fix those that don't
2442
            'show-ids',
2443
            ]
1185.12.56 by Aaron Bentley
Prevented display commands from printing broken pipe errors
2444
    @display_command
2598.1.12 by Martin Pool
Fix up --kind options
2445
    def run(self, revision=None, verbose=False,
4206.2.1 by Ian Clatworthy
ls should be non-recursive by default
2446
            recursive=False, from_root=False,
1185.26.1 by John Arbash Meinel
Made ls work again, and take extra arguments.
2447
            unknown=False, versioned=False, ignored=False,
4032.4.5 by Eduardo Padoan
Check if the tree supports views only once when ls is called.
2448
            null=False, kind=None, show_ids=False, path=None):
1551.9.24 by Aaron Bentley
Unhide ls, add kind flag
2449
2450
        if kind and kind not in ('file', 'directory', 'symlink'):
2451
            raise errors.BzrCommandError('invalid kind specified')
1185.26.1 by John Arbash Meinel
Made ls work again, and take extra arguments.
2452
2453
        if verbose and null:
1996.3.34 by John Arbash Meinel
Update builtins to use errors.foo. Now errors can be avoided entirely for a bzr rocks run
2454
            raise errors.BzrCommandError('Cannot set both --verbose and --null')
1551.6.36 by Aaron Bentley
Revert --debris/--detritus changes
2455
        all = not (unknown or versioned or ignored)
1185.26.1 by John Arbash Meinel
Made ls work again, and take extra arguments.
2456
1551.6.36 by Aaron Bentley
Revert --debris/--detritus changes
2457
        selection = {'I':ignored, '?':unknown, 'V':versioned}
1185.26.1 by John Arbash Meinel
Made ls work again, and take extra arguments.
2458
2215.3.1 by Aaron Bentley
Allow ls to take a PATH
2459
        if path is None:
2460
            fs_path = '.'
2461
        else:
2462
            if from_root:
2463
                raise errors.BzrCommandError('cannot specify both --from-root'
2464
                                             ' and PATH')
2465
            fs_path = path
2215.3.3 by Aaron Bentley
Get ls working on branches
2466
        tree, branch, relpath = bzrdir.BzrDir.open_containing_tree_or_branch(
2467
            fs_path)
4370.6.3 by Ian Clatworthy
minimise differences to trunk code
2468
2469
        # Calculate the prefix to use
2470
        prefix = None
1185.26.1 by John Arbash Meinel
Made ls work again, and take extra arguments.
2471
        if from_root:
4370.6.3 by Ian Clatworthy
minimise differences to trunk code
2472
            if relpath:
2473
                prefix = relpath + '/'
2474
        elif fs_path != '.':
2475
            prefix = fs_path + '/'
4456.1.2 by Ian Clatworthy
fix tabs in builtins.py
2476
3655.3.1 by Lukáš Lalinský
Fix `bzr st -rbranch:PATH_TO_BRANCH`
2477
        if revision is not None or tree is None:
3732.1.1 by Ian Clatworthy
fix bzr st -rbranch:path-to-branch (Lukas Lalinsky)
2478
            tree = _get_one_revision_tree('ls', revision, branch=branch)
1551.6.36 by Aaron Bentley
Revert --debris/--detritus changes
2479
4032.4.5 by Eduardo Padoan
Check if the tree supports views only once when ls is called.
2480
        apply_view = False
4048.1.2 by Ian Clatworthy
fix broken test for ls -r
2481
        if isinstance(tree, WorkingTree) and tree.supports_views():
4032.4.2 by Eduardo Padoan
Make ls show only files on the current view.
2482
            view_files = tree.views.lookup_view()
2483
            if view_files:
4032.4.5 by Eduardo Padoan
Check if the tree supports views only once when ls is called.
2484
                apply_view = True
4032.4.2 by Eduardo Padoan
Make ls show only files on the current view.
2485
                view_str = views.view_display_str(view_files)
4210.1.1 by Ian Clatworthy
reword 'ignoring files outside view' message
2486
                note("Ignoring files outside view. View is %s" % view_str)
4032.4.2 by Eduardo Padoan
Make ls show only files on the current view.
2487
2255.2.61 by John Arbash Meinel
Find callers of list_files() and make sure the tree is always locked.
2488
        tree.lock_read()
2489
        try:
4370.6.3 by Ian Clatworthy
minimise differences to trunk code
2490
            for fp, fc, fkind, fid, entry in tree.list_files(include_root=False,
2491
                from_dir=relpath, recursive=recursive):
4456.1.1 by Ian Clatworthy
(igc) fix ls DIR --from-root and improve ls performance
2492
                # Apply additional masking
2493
                if not all and not selection[fc]:
2494
                    continue
2495
                if kind is not None and fkind != kind:
2496
                    continue
2497
                if apply_view:
2498
                    try:
2499
                        if relpath:
2500
                            fullpath = osutils.pathjoin(relpath, fp)
2501
                        else:
2502
                            fullpath = fp
2503
                        views.check_path_in_view(tree, fullpath)
2504
                    except errors.FileOutsideView:
2505
                        continue
4370.6.3 by Ian Clatworthy
minimise differences to trunk code
2506
4456.1.1 by Ian Clatworthy
(igc) fix ls DIR --from-root and improve ls performance
2507
                # Output the entry
2508
                if prefix:
2509
                    fp = osutils.pathjoin(prefix, fp)
2510
                kindch = entry.kind_character()
2511
                outstring = fp + kindch
2512
                ui.ui_factory.clear_term()
2513
                if verbose:
2514
                    outstring = '%-8s %s' % (fc, outstring)
2515
                    if show_ids and fid is not None:
2516
                        outstring = "%-50s %s" % (outstring, fid)
2517
                    self.outf.write(outstring + '\n')
2518
                elif null:
2519
                    self.outf.write(fp + '\0')
2520
                    if show_ids:
2521
                        if fid is not None:
2522
                            self.outf.write(fid)
2523
                        self.outf.write('\0')
2524
                    self.outf.flush()
2525
                else:
2526
                    if show_ids:
1551.9.27 by Aaron Bentley
Implement show-ids for all output formats
2527
                        if fid is not None:
2255.2.61 by John Arbash Meinel
Find callers of list_files() and make sure the tree is always locked.
2528
                            my_id = fid
2529
                        else:
2530
                            my_id = ''
4456.1.1 by Ian Clatworthy
(igc) fix ls DIR --from-root and improve ls performance
2531
                        self.outf.write('%-50s %s\n' % (outstring, my_id))
2532
                    else:
2255.2.61 by John Arbash Meinel
Find callers of list_files() and make sure the tree is always locked.
2533
                        self.outf.write(outstring + '\n')
2534
        finally:
2535
            tree.unlock()
1147 by Martin Pool
- split builtin commands into separate module bzrlib.builtins;
2536
4370.6.3 by Ian Clatworthy
minimise differences to trunk code
2537
1147 by Martin Pool
- split builtin commands into separate module bzrlib.builtins;
2538
class cmd_unknowns(Command):
1551.10.13 by Aaron Bentley
Hide 'unknowns', document alterntatives to hidden commands
2539
    """List unknown files.
2540
    """
1551.10.14 by Aaron Bentley
Add some blank lines
2541
1551.10.13 by Aaron Bentley
Hide 'unknowns', document alterntatives to hidden commands
2542
    hidden = True
2425.2.3 by Robert Collins
Update existing builtin commands help text to use _see_also. (Robert Collins)
2543
    _see_also = ['ls']
1551.10.14 by Aaron Bentley
Add some blank lines
2544
1185.12.56 by Aaron Bentley
Prevented display commands from printing broken pipe errors
2545
    @display_command
1147 by Martin Pool
- split builtin commands into separate module bzrlib.builtins;
2546
    def run(self):
1185.33.66 by Martin Pool
[patch] use unicode literals for all hardcoded paths (Alexander Belchenko)
2547
        for f in WorkingTree.open_containing(u'.')[0].unknowns():
1773.4.2 by Martin Pool
Cleanup of imports; undeprecate all_revision_ids()
2548
            self.outf.write(osutils.quotefn(f) + '\n')
1147 by Martin Pool
- split builtin commands into separate module bzrlib.builtins;
2549
2550
2551
class cmd_ignore(Command):
2063.5.1 by wang
"bzr ignore" takes multiple arguments. Fixes bug 29488.
2552
    """Ignore specified files or patterns.
1147 by Martin Pool
- split builtin commands into separate module bzrlib.builtins;
2553
3398.1.26 by Ian Clatworthy
jam feedback - make patterns a separate help topic
2554
    See ``bzr help patterns`` for details on the syntax of patterns.
2555
1147 by Martin Pool
- split builtin commands into separate module bzrlib.builtins;
2556
    To remove patterns from the ignore list, edit the .bzrignore file.
3398.1.26 by Ian Clatworthy
jam feedback - make patterns a separate help topic
2557
    After adding, editing or deleting that file either indirectly by
2558
    using this command or directly by using an editor, be sure to commit
2559
    it.
2135.2.2 by Kent Gibson
Ignore pattern matcher (glob.py) patches:
2560
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
2561
    Note: ignore patterns containing shell wildcards must be quoted from
2135.2.2 by Kent Gibson
Ignore pattern matcher (glob.py) patches:
2562
    the shell on Unix.
1147 by Martin Pool
- split builtin commands into separate module bzrlib.builtins;
2563
2666.1.1 by Ian Clatworthy
Bazaar User Reference generated from online help
2564
    :Examples:
2565
        Ignore the top level Makefile::
2566
2567
            bzr ignore ./Makefile
2568
2569
        Ignore class files in all directories::
2570
3035.1.1 by John Arbash Meinel
Address bug #59302 and fix documentation that uses single quotes.
2571
            bzr ignore "*.class"
2572
2573
        Ignore .o files under the lib directory::
2574
2575
            bzr ignore "lib/**/*.o"
2576
2577
        Ignore .o files under the lib directory::
2578
2579
            bzr ignore "RE:lib/.*\.o"
3257.1.1 by Adeodato Simó
Add an example of some bzrignore cool stuff with Python regexes.
2580
2581
        Ignore everything but the "debian" toplevel directory::
2582
2583
            bzr ignore "RE:(?!debian/).*"
1147 by Martin Pool
- split builtin commands into separate module bzrlib.builtins;
2584
    """
2425.2.3 by Robert Collins
Update existing builtin commands help text to use _see_also. (Robert Collins)
2585
3398.1.26 by Ian Clatworthy
jam feedback - make patterns a separate help topic
2586
    _see_also = ['status', 'ignored', 'patterns']
2063.5.1 by wang
"bzr ignore" takes multiple arguments. Fixes bug 29488.
2587
    takes_args = ['name_pattern*']
1765.1.1 by Robert Collins
Remove the default ignores list from bzr, lowering the minimum overhead in bzr add.
2588
    takes_options = [
2598.1.1 by Martin Pool
Add test for and documentation of option style, fix up existing options to comply
2589
        Option('old-default-rules',
2590
               help='Write out the ignore rules bzr < 0.9 always used.')
2591
        ]
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
2592
2063.5.2 by wang
Don't use mutable values as default argument definitions.
2593
    def run(self, name_pattern_list=None, old_default_rules=None):
3528.2.1 by Jelmer Vernooij
Move functionality to add ignores to the ignore file into a separate function.
2594
        from bzrlib import ignores
1765.1.1 by Robert Collins
Remove the default ignores list from bzr, lowering the minimum overhead in bzr add.
2595
        if old_default_rules is not None:
2596
            # dump the rules and exit
1836.1.12 by John Arbash Meinel
Move ignores into a file of their own, make DEFAULT_IGNORE a deprecated list. Create deprecated_list in symbol versioning.
2597
            for pattern in ignores.OLD_DEFAULTS:
1765.1.1 by Robert Collins
Remove the default ignores list from bzr, lowering the minimum overhead in bzr add.
2598
                print pattern
2599
            return
2077.1.2 by Kent Gibson
Strip trailing slashes from ignore patterns (#4559).
2600
        if not name_pattern_list:
2063.5.5 by wang
resolve a conflict
2601
            raise errors.BzrCommandError("ignore requires at least one "
2063.5.4 by wang
Copy Kent Gibson's changes that incorporates John Arbash Meinel's
2602
                                  "NAME_PATTERN or --old-default-rules")
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
2603
        name_pattern_list = [globbing.normalize_pattern(p)
2298.8.4 by Kent Gibson
Fix whitespace and alignment.
2604
                             for p in name_pattern_list]
2077.1.2 by Kent Gibson
Strip trailing slashes from ignore patterns (#4559).
2605
        for name_pattern in name_pattern_list:
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
2606
            if (name_pattern[0] == '/' or
2298.8.1 by Kent Gibson
Normalise ignore patterns to use '/' path separator.
2607
                (len(name_pattern) > 1 and name_pattern[1] == ':')):
2077.1.2 by Kent Gibson
Strip trailing slashes from ignore patterns (#4559).
2608
                raise errors.BzrCommandError(
2609
                    "NAME_PATTERN should not be an absolute path")
1185.33.66 by Martin Pool
[patch] use unicode literals for all hardcoded paths (Alexander Belchenko)
2610
        tree, relpath = WorkingTree.open_containing(u'.')
3528.2.1 by Jelmer Vernooij
Move functionality to add ignores to the ignore file into a separate function.
2611
        ignores.tree_ignores_add_patterns(tree, name_pattern_list)
2747.5.1 by Daniel Watkins
'ignore' now outputs a list of versioned files that match the given pattern.
2612
        ignored = globbing.Globster(name_pattern_list)
2613
        matches = []
2614
        tree.lock_read()
2615
        for entry in tree.list_files():
2616
            id = entry[3]
2617
            if id is not None:
2618
                filename = entry[0]
2619
                if ignored.match(filename):
2747.5.3 by Daniel Watkins
Modified to avoid encoding issues.
2620
                    matches.append(filename.encode('utf-8'))
2747.5.1 by Daniel Watkins
'ignore' now outputs a list of versioned files that match the given pattern.
2621
        tree.unlock()
2622
        if len(matches) > 0:
2623
            print "Warning: the following files are version controlled and" \
4098.6.1 by Neil Martinsen-Burrell
Use a more informative message when an ignore pattern matches existing version controlled files. Fixes #248895
2624
                  " match your ignore pattern:\n%s" \
2625
                  "\nThese files will continue to be version controlled" \
2626
                  " unless you 'bzr remove' them." % ("\n".join(matches),)
1147 by Martin Pool
- split builtin commands into separate module bzrlib.builtins;
2627
3603.3.1 by Robert Collins
* The help for ``bzr ignored`` now sugests ``bzr ls --ignored`` for
2628
1147 by Martin Pool
- split builtin commands into separate module bzrlib.builtins;
2629
class cmd_ignored(Command):
2630
    """List ignored files and the patterns that matched them.
3603.3.1 by Robert Collins
* The help for ``bzr ignored`` now sugests ``bzr ls --ignored`` for
2631
2632
    List all the ignored files and the ignore pattern that caused the file to
2633
    be ignored.
2634
2635
    Alternatively, to list just the files::
2636
2637
        bzr ls --ignored
2425.2.3 by Robert Collins
Update existing builtin commands help text to use _see_also. (Robert Collins)
2638
    """
1147 by Martin Pool
- split builtin commands into separate module bzrlib.builtins;
2639
3123.2.1 by Lukáš Lalinský
Use self.outf instead of sys.stdout in cmd_ignored.
2640
    encoding_type = 'replace'
3603.3.1 by Robert Collins
* The help for ``bzr ignored`` now sugests ``bzr ls --ignored`` for
2641
    _see_also = ['ignore', 'ls']
3123.2.1 by Lukáš Lalinský
Use self.outf instead of sys.stdout in cmd_ignored.
2642
1185.12.56 by Aaron Bentley
Prevented display commands from printing broken pipe errors
2643
    @display_command
1147 by Martin Pool
- split builtin commands into separate module bzrlib.builtins;
2644
    def run(self):
1185.33.66 by Martin Pool
[patch] use unicode literals for all hardcoded paths (Alexander Belchenko)
2645
        tree = WorkingTree.open_containing(u'.')[0]
2255.2.61 by John Arbash Meinel
Find callers of list_files() and make sure the tree is always locked.
2646
        tree.lock_read()
2647
        try:
2648
            for path, file_class, kind, file_id, entry in tree.list_files():
2649
                if file_class != 'I':
2650
                    continue
2651
                ## XXX: Slightly inefficient since this was already calculated
2652
                pat = tree.is_ignored(path)
3123.2.1 by Lukáš Lalinský
Use self.outf instead of sys.stdout in cmd_ignored.
2653
                self.outf.write('%-50s %s\n' % (path, pat))
2255.2.61 by John Arbash Meinel
Find callers of list_files() and make sure the tree is always locked.
2654
        finally:
2655
            tree.unlock()
1147 by Martin Pool
- split builtin commands into separate module bzrlib.builtins;
2656
2657
2658
class cmd_lookup_revision(Command):
2659
    """Lookup the revision-id from a revision-number
2660
2666.1.1 by Ian Clatworthy
Bazaar User Reference generated from online help
2661
    :Examples:
1147 by Martin Pool
- split builtin commands into separate module bzrlib.builtins;
2662
        bzr lookup-revision 33
2663
    """
2664
    hidden = True
2665
    takes_args = ['revno']
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
2666
1185.12.56 by Aaron Bentley
Prevented display commands from printing broken pipe errors
2667
    @display_command
1147 by Martin Pool
- split builtin commands into separate module bzrlib.builtins;
2668
    def run(self, revno):
2669
        try:
2670
            revno = int(revno)
2671
        except ValueError:
1996.3.34 by John Arbash Meinel
Update builtins to use errors.foo. Now errors can be avoided entirely for a bzr rocks run
2672
            raise errors.BzrCommandError("not a valid revision-number: %r" % revno)
1147 by Martin Pool
- split builtin commands into separate module bzrlib.builtins;
2673
1185.33.66 by Martin Pool
[patch] use unicode literals for all hardcoded paths (Alexander Belchenko)
2674
        print WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
1147 by Martin Pool
- split builtin commands into separate module bzrlib.builtins;
2675
2676
2677
class cmd_export(Command):
2374.1.1 by Ian Clatworthy
Help and man page fixes
2678
    """Export current or past revision to a destination directory or archive.
1147 by Martin Pool
- split builtin commands into separate module bzrlib.builtins;
2679
2680
    If no revision is specified this exports the last committed revision.
2681
2682
    Format may be an "exporter" name, such as tar, tgz, tbz2.  If none is
2683
    given, try to find the format with the extension. If no extension
2684
    is found exports to a directory (equivalent to --format=dir).
2685
2374.1.4 by Ian Clatworthy
Include feedback from mailing list.
2686
    If root is supplied, it will be used as the root directory inside
2687
    container formats (tar, zip, etc). If it is not supplied it will default
2688
    to the exported filename. The root option has no effect for 'dir' format.
1185.31.11 by John Arbash Meinel
Merging Alexander's zip export patch
2689
2374.1.2 by Ian Clatworthy
Improved after feedback from reviewers
2690
    If branch is omitted then the branch containing the current working
2691
    directory will be used.
2099.1.1 by Daniel Silverstone
Add source branch support to export command
2692
2374.1.3 by Ian Clatworthy
Minor man page fixes for add, commit, export
2693
    Note: Export of tree with non-ASCII filenames to zip is not supported.
1185.31.11 by John Arbash Meinel
Merging Alexander's zip export patch
2694
2666.1.1 by Ian Clatworthy
Bazaar User Reference generated from online help
2695
      =================       =========================
2696
      Supported formats       Autodetected by extension
2697
      =================       =========================
2666.1.5 by Ian Clatworthy
Incorporate feedback from Alex B. & James W.
2698
         dir                         (none)
1185.31.11 by John Arbash Meinel
Merging Alexander's zip export patch
2699
         tar                          .tar
2700
         tbz2                    .tar.bz2, .tbz2
2701
         tgz                      .tar.gz, .tgz
2702
         zip                          .zip
2666.1.1 by Ian Clatworthy
Bazaar User Reference generated from online help
2703
      =================       =========================
1185.31.11 by John Arbash Meinel
Merging Alexander's zip export patch
2704
    """
3613.2.1 by Robert Collins
Teach export how to export a subdirectory. (Robert Collins)
2705
    takes_args = ['dest', 'branch_or_subdir?']
2598.1.10 by Martin Pool
Clean up options that are registered globally and used once or not at all.
2706
    takes_options = [
2707
        Option('format',
2708
               help="Type of file to export to.",
2709
               type=unicode),
2710
        'revision',
3368.2.48 by Ian Clatworthy
apply first round of poolie's review feedback
2711
        Option('filters', help='Apply content filters to export the '
2712
                'convenient form.'),
2598.1.10 by Martin Pool
Clean up options that are registered globally and used once or not at all.
2713
        Option('root',
2714
               type=str,
2715
               help="Name of the root directory inside the exported file."),
2716
        ]
3613.2.1 by Robert Collins
Teach export how to export a subdirectory. (Robert Collins)
2717
    def run(self, dest, branch_or_subdir=None, revision=None, format=None,
3368.2.41 by Ian Clatworthy
1st cut merge of bzr.dev r3907
2718
        root=None, filters=False):
1185.31.12 by John Arbash Meinel
Refactored the export code to make it easier to add new export formats.
2719
        from bzrlib.export import export
2099.1.1 by Daniel Silverstone
Add source branch support to export command
2720
3613.2.1 by Robert Collins
Teach export how to export a subdirectory. (Robert Collins)
2721
        if branch_or_subdir is None:
2099.1.1 by Daniel Silverstone
Add source branch support to export command
2722
            tree = WorkingTree.open_containing(u'.')[0]
2723
            b = tree.branch
3613.2.1 by Robert Collins
Teach export how to export a subdirectory. (Robert Collins)
2724
            subdir = None
2099.1.1 by Daniel Silverstone
Add source branch support to export command
2725
        else:
3613.2.1 by Robert Collins
Teach export how to export a subdirectory. (Robert Collins)
2726
            b, subdir = Branch.open_containing(branch_or_subdir)
3655.3.1 by Lukáš Lalinský
Fix `bzr st -rbranch:PATH_TO_BRANCH`
2727
            tree = None
2728
3732.1.1 by Ian Clatworthy
fix bzr st -rbranch:path-to-branch (Lukas Lalinsky)
2729
        rev_tree = _get_one_revision_tree('export', revision, branch=b, tree=tree)
1185.31.12 by John Arbash Meinel
Refactored the export code to make it easier to add new export formats.
2730
        try:
3368.2.41 by Ian Clatworthy
1st cut merge of bzr.dev r3907
2731
            export(rev_tree, dest, format, root, subdir, filtered=filters)
1185.31.12 by John Arbash Meinel
Refactored the export code to make it easier to add new export formats.
2732
        except errors.NoSuchExportFormat, e:
1996.3.34 by John Arbash Meinel
Update builtins to use errors.foo. Now errors can be avoided entirely for a bzr rocks run
2733
            raise errors.BzrCommandError('Unsupported export format: %s' % e.format)
1147 by Martin Pool
- split builtin commands into separate module bzrlib.builtins;
2734
2735
2736
class cmd_cat(Command):
2374.1.1 by Ian Clatworthy
Help and man page fixes
2737
    """Write the contents of a file as of a given revision to standard output.
2738
2739
    If no revision is nominated, the last revision is used.
2740
2374.1.2 by Ian Clatworthy
Improved after feedback from reviewers
2741
    Note: Take care to redirect standard output when using this command on a
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
2742
    binary file.
2374.1.1 by Ian Clatworthy
Help and man page fixes
2743
    """
1147 by Martin Pool
- split builtin commands into separate module bzrlib.builtins;
2744
2425.2.3 by Robert Collins
Update existing builtin commands help text to use _see_also. (Robert Collins)
2745
    _see_also = ['ls']
2598.1.10 by Martin Pool
Clean up options that are registered globally and used once or not at all.
2746
    takes_options = [
2747
        Option('name-from-revision', help='The path name in the old tree.'),
3368.2.48 by Ian Clatworthy
apply first round of poolie's review feedback
2748
        Option('filters', help='Apply content filters to display the '
2749
                'convenience form.'),
2598.1.10 by Martin Pool
Clean up options that are registered globally and used once or not at all.
2750
        'revision',
2751
        ]
1147 by Martin Pool
- split builtin commands into separate module bzrlib.builtins;
2752
    takes_args = ['filename']
2178.4.4 by Alexander Belchenko
encoding_type = 'exact' force sys.stdout to be binary stream on win32
2753
    encoding_type = 'exact'
1147 by Martin Pool
- split builtin commands into separate module bzrlib.builtins;
2754
1185.12.56 by Aaron Bentley
Prevented display commands from printing broken pipe errors
2755
    @display_command
3368.2.31 by Ian Clatworthy
add --filters option to cat command
2756
    def run(self, filename, revision=None, name_from_revision=False,
2757
            filters=False):
1185.50.9 by John Arbash Meinel
[bug 3632] Matthieu Moy- bzr cat should default to last revision
2758
        if revision is not None and len(revision) != 1:
2073.2.1 by wang
``bzr cat`` can look up contents of removed or renamed files. If the
2759
            raise errors.BzrCommandError("bzr cat --revision takes exactly"
3063.4.1 by Lukáš Lalinský
Fix UnboundLocalError in cmd_cat.
2760
                                         " one revision specifier")
2761
        tree, branch, relpath = \
2762
            bzrdir.BzrDir.open_containing_tree_or_branch(filename)
2763
        branch.lock_read()
2764
        try:
2765
            return self._run(tree, branch, relpath, filename, revision,
3368.2.31 by Ian Clatworthy
add --filters option to cat command
2766
                             name_from_revision, filters)
3010.1.17 by Robert Collins
Lock correctness and commit_group management for re-sign, in builtins.
2767
        finally:
3063.4.1 by Lukáš Lalinský
Fix UnboundLocalError in cmd_cat.
2768
            branch.unlock()
3010.1.17 by Robert Collins
Lock correctness and commit_group management for re-sign, in builtins.
2769
3368.2.31 by Ian Clatworthy
add --filters option to cat command
2770
    def _run(self, tree, b, relpath, filename, revision, name_from_revision,
2771
        filtered):
1907.4.5 by Matthieu Moy
Make bzr cat -r revno:N:foo consistant with bzr cat -r branch:foo.
2772
        if tree is None:
2158.1.1 by Wouter van Heyst
Fix #73500 mostly by catching a NotLocalUrl exception in cmd_cat.
2773
            tree = b.basis_tree()
3732.1.1 by Ian Clatworthy
fix bzr st -rbranch:path-to-branch (Lukas Lalinsky)
2774
        rev_tree = _get_one_revision_tree('cat', revision, branch=b)
2073.2.1 by wang
``bzr cat`` can look up contents of removed or renamed files. If the
2775
2776
        old_file_id = rev_tree.path2id(relpath)
3655.3.1 by Lukáš Lalinský
Fix `bzr st -rbranch:PATH_TO_BRANCH`
2777
2073.2.3 by wang
Change option name to --name-from-revision. Always make new tree the
2778
        if name_from_revision:
4112.1.1 by Vincent Ladeuil
Fallback to old revision id if the current one doesn't exist in
2779
            # Try in revision if requested
2073.2.1 by wang
``bzr cat`` can look up contents of removed or renamed files. If the
2780
            if old_file_id is None:
3655.3.1 by Lukáš Lalinský
Fix `bzr st -rbranch:PATH_TO_BRANCH`
2781
                raise errors.BzrCommandError(
2782
                    "%r is not present in revision %s" % (
2783
                        filename, rev_tree.get_revision_id()))
2073.2.1 by wang
``bzr cat`` can look up contents of removed or renamed files. If the
2784
            else:
3341.2.1 by Alexander Belchenko
`bzr cat` no more internally used Tree.print_file().
2785
                content = rev_tree.get_file_text(old_file_id)
2073.2.1 by wang
``bzr cat`` can look up contents of removed or renamed files. If the
2786
        else:
4112.1.1 by Vincent Ladeuil
Fallback to old revision id if the current one doesn't exist in
2787
            cur_file_id = tree.path2id(relpath)
2788
            found = False
2789
            if cur_file_id is not None:
2790
                # Then try with the actual file id
2791
                try:
2792
                    content = rev_tree.get_file_text(cur_file_id)
2793
                    found = True
2794
                except errors.NoSuchId:
2795
                    # The actual file id didn't exist at that time
2796
                    pass
2797
            if not found and old_file_id is not None:
2798
                # Finally try with the old file id
2799
                content = rev_tree.get_file_text(old_file_id)
2800
                found = True
2801
            if not found:
2802
                # Can't be found anywhere
2803
                raise errors.BzrCommandError(
2804
                    "%r is not present in revision %s" % (
2805
                        filename, rev_tree.get_revision_id()))
3368.2.31 by Ian Clatworthy
add --filters option to cat command
2806
        if filtered:
2807
            from bzrlib.filters import (
2808
                ContentFilterContext,
2809
                filtered_output_bytes,
2810
                )
3368.2.33 by Ian Clatworthy
expand filter context to support interesting stuff
2811
            filters = rev_tree._content_filter_stack(relpath)
3368.2.48 by Ian Clatworthy
apply first round of poolie's review feedback
2812
            chunks = content.splitlines(True)
2813
            content = filtered_output_bytes(chunks, filters,
3368.2.33 by Ian Clatworthy
expand filter context to support interesting stuff
2814
                ContentFilterContext(relpath, rev_tree))
3368.2.31 by Ian Clatworthy
add --filters option to cat command
2815
            self.outf.writelines(content)
2816
        else:
2817
            self.outf.write(content)
1147 by Martin Pool
- split builtin commands into separate module bzrlib.builtins;
2818
2819
2820
class cmd_local_time_offset(Command):
2821
    """Show the offset in seconds from GMT to local time."""
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
2822
    hidden = True
1185.12.56 by Aaron Bentley
Prevented display commands from printing broken pipe errors
2823
    @display_command
1147 by Martin Pool
- split builtin commands into separate module bzrlib.builtins;
2824
    def run(self):
1773.4.1 by Martin Pool
Add pyflakes makefile target; fix many warnings
2825
        print osutils.local_time_offset()
1147 by Martin Pool
- split builtin commands into separate module bzrlib.builtins;
2826
2827
2828
2829
class cmd_commit(Command):
2830
    """Commit changes into a new revision.
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
2831
4351.1.1 by Ian Clatworthy
improve commit help
2832
    An explanatory message needs to be given for each commit. This is
2833
    often done by using the --message option (getting the message from the
2834
    command line) or by using the --file option (getting the message from
2835
    a file). If neither of these options is given, an editor is opened for
2836
    the user to enter the message. To see the changed files in the
2837
    boilerplate text loaded into the editor, use the --show-diff option.
2838
2839
    By default, the entire tree is committed and the person doing the
2840
    commit is assumed to be the author. These defaults can be overridden
2841
    as explained below.
2842
2843
    :Selective commits:
2844
2845
      If selected files are specified, only changes to those files are
2846
      committed.  If a directory is specified then the directory and
2847
      everything within it is committed.
2848
  
2849
      When excludes are given, they take precedence over selected files.
2850
      For example, to commit only changes within foo, but not changes
2851
      within foo/bar::
2852
  
2853
        bzr commit foo -x foo/bar
2854
  
2855
      A selective commit after a merge is not yet supported.
2856
2857
    :Custom authors:
2858
2859
      If the author of the change is not the same person as the committer,
2860
      you can specify the author's name using the --author option. The
2861
      name should be in the same format as a committer-id, e.g.
2862
      "John Doe <jdoe@example.com>". If there is more than one author of
2863
      the change you can specify the option multiple times, once for each
2864
      author.
2865
  
2866
    :Checks:
2867
2868
      A common mistake is to forget to add a new file or directory before
2869
      running the commit command. The --strict option checks for unknown
2870
      files and aborts the commit if any are found. More advanced pre-commit
2871
      checks can be implemented by defining hooks. See ``bzr help hooks``
2872
      for details.
2873
2874
    :Things to note:
2875
2876
      If you accidentially commit the wrong changes or make a spelling
2877
      mistake in the commit message say, you can use the uncommit command
2878
      to undo it. See ``bzr help uncommit`` for details.
2879
2880
      Hooks can also be configured to run after a commit. This allows you
2881
      to trigger updates to external systems like bug trackers. The --fixes
2882
      option can be used to record the association between a revision and
2883
      one or more bugs. See ``bzr help bugs`` for details.
2884
2885
      A selective commit may fail in some cases where the committed
2886
      tree would be invalid. Consider::
2887
  
2888
        bzr init foo
2889
        mkdir foo/bar
2890
        bzr add foo/bar
2891
        bzr commit foo -m "committing foo"
2892
        bzr mv foo/bar foo/baz
2893
        mkdir foo/bar
2894
        bzr add foo/bar
2895
        bzr commit foo/bar -m "committing bar but not baz"
2896
  
2897
      In the example above, the last commit will fail by design. This gives
2898
      the user the opportunity to decide whether they want to commit the
2899
      rename at the same time, separately first, or not at all. (As a general
2900
      rule, when in doubt, Bazaar has a policy of Doing the Safe Thing.)
1147 by Martin Pool
- split builtin commands into separate module bzrlib.builtins;
2901
    """
1185.16.3 by Martin Pool
- remove all TODOs from bzr help messages
2902
    # TODO: Run hooks on tree to-be-committed, and after commit.
2903
1185.16.65 by mbp at sourcefrog
- new commit --strict option
2904
    # TODO: Strict commit that fails if there are deleted files.
2905
    #       (what does "deleted files" mean ??)
2906
1185.16.3 by Martin Pool
- remove all TODOs from bzr help messages
2907
    # TODO: Give better message for -s, --summary, used by tla people
2908
2909
    # XXX: verbose currently does nothing
2910
4351.1.1 by Ian Clatworthy
improve commit help
2911
    _see_also = ['add', 'bugs', 'hooks', 'uncommit']
1147 by Martin Pool
- split builtin commands into separate module bzrlib.builtins;
2912
    takes_args = ['selected*']
2598.1.1 by Martin Pool
Add test for and documentation of option style, fix up existing options to comply
2913
    takes_options = [
3602.1.1 by Robert Collins
Add support for -x or --exclude to bzr commit, fixing bug 3117. (Robert Collins)
2914
            ListOption('exclude', type=str, short_name='x',
2915
                help="Do not consider changes made to a given path."),
2598.1.10 by Martin Pool
Clean up options that are registered globally and used once or not at all.
2916
            Option('message', type=unicode,
2917
                   short_name='m',
2918
                   help="Description of the new revision."),
2598.1.1 by Martin Pool
Add test for and documentation of option style, fix up existing options to comply
2919
            'verbose',
2920
             Option('unchanged',
2921
                    help='Commit even if nothing has changed.'),
2922
             Option('file', type=str,
2923
                    short_name='F',
2924
                    argname='msgfile',
2925
                    help='Take commit message from this file.'),
2926
             Option('strict',
2927
                    help="Refuse to commit if there are unknown "
2928
                    "files in the working tree."),
2929
             ListOption('fixes', type=str,
3535.10.7 by James Westby
Make the --fixes option conform to the style guide check once more.
2930
                    help="Mark a bug as being fixed by this revision "
3535.10.9 by James Westby
Make the improved messages show up in the UI.
2931
                         "(see \"bzr help bugs\")."),
4056.2.1 by James Westby
Allow specifying multiple authors for a revision.
2932
             ListOption('author', type=unicode,
2671.2.1 by Lukáš Lalinský
Add --author option to 'bzr commit' to record the author's name, if it's different from the committer.
2933
                    help="Set the author's name, if it's different "
2934
                         "from the committer."),
2598.1.1 by Martin Pool
Add test for and documentation of option style, fix up existing options to comply
2935
             Option('local',
2936
                    help="Perform a local commit in a bound "
2937
                         "branch.  Local commits are not pushed to "
2938
                         "the master branch until a normal commit "
2939
                         "is performed."
2940
                    ),
2598.6.10 by ghigo
In the commit dialog, the diff is stored as 8-bit raw data
2941
              Option('show-diff',
2942
                     help='When no message is supplied, show the diff along'
2943
                     ' with the status summary in the message editor.'),
2598.1.1 by Martin Pool
Add test for and documentation of option style, fix up existing options to comply
2944
             ]
1147 by Martin Pool
- split builtin commands into separate module bzrlib.builtins;
2945
    aliases = ['ci', 'checkin']
2946
4119.4.1 by Jonathan Lange
Extract bug fix encoding logic from commit.
2947
    def _iter_bug_fix_urls(self, fixes, branch):
2376.4.7 by jml at canonical
- Add docstrings to tests.
2948
        # Configure the properties for bug fixing attributes.
2949
        for fixed_bug in fixes:
2950
            tokens = fixed_bug.split(':')
2951
            if len(tokens) != 2:
2952
                raise errors.BzrCommandError(
3535.10.3 by James Westby
Talk about "trackers" rather than "tags" as it may be less confusing.
2953
                    "Invalid bug %s. Must be in the form of 'tracker:id'. "
3535.10.9 by James Westby
Make the improved messages show up in the UI.
2954
                    "See \"bzr help bugs\" for more information on this "
2955
                    "feature.\nCommit refused." % fixed_bug)
2376.4.7 by jml at canonical
- Add docstrings to tests.
2956
            tag, bug_id = tokens
2957
            try:
4119.4.1 by Jonathan Lange
Extract bug fix encoding logic from commit.
2958
                yield bugtracker.get_bug_url(tag, branch, bug_id)
2376.4.26 by Jonathan Lange
Tests for MalformedBugIdentifier and new error UnknownBugTrackerAbbreviation.
2959
            except errors.UnknownBugTrackerAbbreviation:
2376.4.7 by jml at canonical
- Add docstrings to tests.
2960
                raise errors.BzrCommandError(
2961
                    'Unrecognized bug %s. Commit refused.' % fixed_bug)
3535.10.9 by James Westby
Make the improved messages show up in the UI.
2962
            except errors.MalformedBugIdentifier, e:
2376.4.7 by jml at canonical
- Add docstrings to tests.
2963
                raise errors.BzrCommandError(
3535.10.9 by James Westby
Make the improved messages show up in the UI.
2964
                    "%s\nCommit refused." % (str(e),))
2376.4.7 by jml at canonical
- Add docstrings to tests.
2965
2768.1.5 by Ian Clatworthy
Wrap new std verbose option with new help instead of declaring a new one
2966
    def run(self, message=None, file=None, verbose=False, selected_list=None,
2817.4.4 by Vincent Ladeuil
Redo the lost modification.
2967
            unchanged=False, strict=False, local=False, fixes=None,
3602.1.1 by Robert Collins
Add support for -x or --exclude to bzr commit, fixing bug 3117. (Robert Collins)
2968
            author=None, show_diff=False, exclude=None):
2598.6.30 by ghigo
- Updated the identation on the basis of Aaron suggestions
2969
        from bzrlib.errors import (
2970
            PointlessCommit,
2971
            ConflictsInTree,
2972
            StrictCommitFailed
2973
        )
2974
        from bzrlib.msgeditor import (
2975
            edit_commit_message_encoded,
3642.2.1 by Jelmer Vernooij
Add simple commit message template hook.
2976
            generate_commit_message_template,
2598.6.30 by ghigo
- Updated the identation on the basis of Aaron suggestions
2977
            make_commit_message_template_encoded
2978
        )
1147 by Martin Pool
- split builtin commands into separate module bzrlib.builtins;
2979
1185.33.77 by Martin Pool
doc
2980
        # TODO: Need a blackbox test for invoking the external editor; may be
2981
        # slightly problematic to run this cross-platform.
2982
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
2983
        # TODO: do more checks that the commit will succeed before
1185.33.72 by Martin Pool
Fix commit message template for non-ascii files, and add test for handling of
2984
        # spending the user's valuable time typing a commit message.
2376.4.2 by jml at canonical
More sophisticated error handling for --fixes option
2985
2986
        properties = {}
2987
1508.1.4 by Robert Collins
Convert most of the front ends commands to use WorkingTree.open_containing
2988
        tree, selected_list = tree_files(selected_list)
1704.2.11 by Martin Pool
Handle 'bzr commit DIR' when dir contains pending merges.
2989
        if selected_list == ['']:
2990
            # workaround - commit of root of tree should be exactly the same
2991
            # as just default commit in that tree, and succeed even though
2992
            # selected-file merge commit is not done yet
2993
            selected_list = []
2994
2817.4.4 by Vincent Ladeuil
Redo the lost modification.
2995
        if fixes is None:
2996
            fixes = []
4119.4.1 by Jonathan Lange
Extract bug fix encoding logic from commit.
2997
        bug_property = bugtracker.encode_fixes_bug_urls(
2998
            self._iter_bug_fix_urls(fixes, tree.branch))
2453.2.1 by Martin Pool
Don't set the bugs property unless bugs are actually set
2999
        if bug_property:
3000
            properties['bugs'] = bug_property
2376.4.7 by jml at canonical
- Add docstrings to tests.
3001
1587.1.8 by Robert Collins
Local commits on unbound branches fail.
3002
        if local and not tree.branch.get_bound_location():
3003
            raise errors.LocalRequiresBoundBranch()
1147 by Martin Pool
- split builtin commands into separate module bzrlib.builtins;
3004
2149.1.4 by Aaron Bentley
Add additional test that callback is called with a Commit instance
3005
        def get_message(commit_obj):
2149.1.2 by Aaron Bentley
Defer getting the commit message until the revision is almost-committed
3006
            """Callback to get commit message"""
3007
            my_message = message
3008
            if my_message is None and not file:
2598.6.24 by ghigo
update on the basis of Aaron suggestions
3009
                t = make_commit_message_template_encoded(tree,
2598.6.30 by ghigo
- Updated the identation on the basis of Aaron suggestions
3010
                        selected_list, diff=show_diff,
3224.5.1 by Andrew Bennetts
Lots of assorted hackery to reduce the number of imports for common operations. Improves 'rocks', 'st' and 'help' times by ~50ms on my laptop.
3011
                        output_encoding=osutils.get_user_encoding())
3642.2.1 by Jelmer Vernooij
Add simple commit message template hook.
3012
                start_message = generate_commit_message_template(commit_obj)
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
3013
                my_message = edit_commit_message_encoded(t,
3642.2.1 by Jelmer Vernooij
Add simple commit message template hook.
3014
                    start_message=start_message)
2149.1.2 by Aaron Bentley
Defer getting the commit message until the revision is almost-committed
3015
                if my_message is None:
3016
                    raise errors.BzrCommandError("please specify a commit"
3017
                        " message with either --message or --file")
2598.6.29 by ghigo
Removed the check on the switch "--show-diff" in order to allow the
3018
            elif my_message and file:
2149.1.2 by Aaron Bentley
Defer getting the commit message until the revision is almost-committed
3019
                raise errors.BzrCommandError(
2598.6.29 by ghigo
Removed the check on the switch "--show-diff" in order to allow the
3020
                    "please specify either --message or --file")
2149.1.2 by Aaron Bentley
Defer getting the commit message until the revision is almost-committed
3021
            if file:
3602.1.1 by Robert Collins
Add support for -x or --exclude to bzr commit, fixing bug 3117. (Robert Collins)
3022
                my_message = codecs.open(file, 'rt',
3224.5.4 by Andrew Bennetts
Fix test suite, mainly weeding out uses of bzrlib.user_encoding.
3023
                                         osutils.get_user_encoding()).read()
2149.1.2 by Aaron Bentley
Defer getting the commit message until the revision is almost-committed
3024
            if my_message == "":
3025
                raise errors.BzrCommandError("empty commit message specified")
3026
            return my_message
2376.4.2 by jml at canonical
More sophisticated error handling for --fixes option
3027
1147 by Martin Pool
- split builtin commands into separate module bzrlib.builtins;
3028
        try:
2149.1.2 by Aaron Bentley
Defer getting the commit message until the revision is almost-committed
3029
            tree.commit(message_callback=get_message,
3030
                        specific_files=selected_list,
1607.1.5 by Robert Collins
Make commit verbose mode work!.
3031
                        allow_pointless=unchanged, strict=strict, local=local,
2789.2.1 by Ian Clatworthy
Make commit less verbose by default
3032
                        reporter=None, verbose=verbose, revprops=properties,
4056.2.1 by James Westby
Allow specifying multiple authors for a revision.
3033
                        authors=author,
3602.1.1 by Robert Collins
Add support for -x or --exclude to bzr commit, fixing bug 3117. (Robert Collins)
3034
                        exclude=safe_relpath_files(tree, exclude))
1147 by Martin Pool
- split builtin commands into separate module bzrlib.builtins;
3035
        except PointlessCommit:
3036
            # FIXME: This should really happen before the file is read in;
3037
            # perhaps prepare the commit; get the message; then actually commit
4351.1.2 by Ian Clatworthy
tweak grammar in error message
3038
            raise errors.BzrCommandError("No changes to commit."
3039
                              " Use --unchanged to commit anyhow.")
1185.14.10 by Aaron Bentley
Commit aborts with conflicts in the tree.
3040
        except ConflictsInTree:
1551.9.5 by Aaron Bentley
Revert broken save-commit-message code
3041
            raise errors.BzrCommandError('Conflicts detected in working '
3042
                'tree.  Use "bzr conflicts" to list, "bzr resolve FILE" to'
3043
                ' resolve.')
1185.16.65 by mbp at sourcefrog
- new commit --strict option
3044
        except StrictCommitFailed:
1551.9.5 by Aaron Bentley
Revert broken save-commit-message code
3045
            raise errors.BzrCommandError("Commit refused because there are"
3046
                              " unknown files in the working tree.")
1505.1.24 by John Arbash Meinel
Updated commit to handle bound branches. Included test to handle commit after merge
3047
        except errors.BoundBranchOutOfDate, e:
1551.9.5 by Aaron Bentley
Revert broken save-commit-message code
3048
            raise errors.BzrCommandError(str(e) + "\n"
3049
            'To commit to master branch, run update and then commit.\n'
3050
            'You can also pass --local to commit to continue working '
3051
            'disconnected.')
2111.1.1 by Martin Pool
Fix #32054, save message if commit fails.
3052
3053
1147 by Martin Pool
- split builtin commands into separate module bzrlib.builtins;
3054
class cmd_check(Command):
3015.4.20 by Daniel Watkins
Fixed summary.
3055
    """Validate working tree structure, branch consistency and repository history.
3015.3.25 by Daniel Watkins
Updated help.
3056
3057
    This command checks various invariants about branch and repository storage
3058
    to detect data corruption or bzr bugs.
3059
3060
    The working tree and branch checks will only give output if a problem is
3061
    detected. The output fields of the repository check are:
2745.6.8 by Aaron Bentley
Clean up text
3062
4070.11.7 by Martin Pool
Correction to rest syntax for cmd_check
3063
    revisions
3064
        This is just the number of revisions checked.  It doesn't
3065
        indicate a problem.
3066
3067
    versionedfiles
3068
        This is just the number of versionedfiles checked.  It
3069
        doesn't indicate a problem.
3070
3071
    unreferenced ancestors
3072
        Texts that are ancestors of other texts, but
3073
        are not properly referenced by the revision ancestry.  This is a
3074
        subtle problem that Bazaar can work around.
3075
3076
    unique file texts
3077
        This is the total number of unique file contents
3078
        seen in the checked revisions.  It does not indicate a problem.
3079
3080
    repeated file texts
3081
        This is the total number of repeated texts seen
3082
        in the checked revisions.  Texts can be repeated when their file
3083
        entries are modified, but the file contents are not.  It does not
3084
        indicate a problem.
3015.4.14 by Daniel Watkins
Updated check help to explain what happens when no options are given.
3085
3015.4.19 by Daniel Watkins
Improved check docs.
3086
    If no restrictions are specified, all Bazaar data that is found at the given
3087
    location will be checked.
3088
3089
    :Examples:
3090
3091
        Check the tree and branch at 'foo'::
3092
3093
            bzr check --tree --branch foo
3094
3095
        Check only the repository at 'bar'::
3096
3097
            bzr check --repo bar
3098
3099
        Check everything at 'baz'::
3100
3101
            bzr check baz
1147 by Martin Pool
- split builtin commands into separate module bzrlib.builtins;
3102
    """
2425.2.3 by Robert Collins
Update existing builtin commands help text to use _see_also. (Robert Collins)
3103
3104
    _see_also = ['reconcile']
3015.3.2 by Daniel Watkins
Check.check now takes a path rather than a branch.
3105
    takes_args = ['path?']
3015.4.2 by Daniel Watkins
Made UI changes to include CLI options.
3106
    takes_options = ['verbose',
3107
                     Option('branch', help="Check the branch related to the"
3108
                                           " current directory."),
3109
                     Option('repo', help="Check the repository related to the"
3110
                                         " current directory."),
3111
                     Option('tree', help="Check the working tree related to"
3112
                                         " the current directory.")]
1147 by Martin Pool
- split builtin commands into separate module bzrlib.builtins;
3113
3015.4.5 by Daniel Watkins
Each option selects only the specific thing to be checked.
3114
    def run(self, path=None, verbose=False, branch=False, repo=False,
3115
            tree=False):
3015.3.22 by Daniel Watkins
Changed 'check' to 'check_dwim'.
3116
        from bzrlib.check import check_dwim
3015.3.2 by Daniel Watkins
Check.check now takes a path rather than a branch.
3117
        if path is None:
3118
            path = '.'
3015.4.7 by Daniel Watkins
Vanilla 'bzr check' checks all items.
3119
        if not branch and not repo and not tree:
3120
            branch = repo = tree = True
3015.4.2 by Daniel Watkins
Made UI changes to include CLI options.
3121
        check_dwim(path, verbose, do_branch=branch, do_repo=repo, do_tree=tree)
1147 by Martin Pool
- split builtin commands into separate module bzrlib.builtins;
3122
3123
3124
class cmd_upgrade(Command):
3125
    """Upgrade branch storage to current format.
3126
3127
    The check command or bzr developers may sometimes advise you to run
1534.4.13 by Robert Collins
Give a reasonable warning on attempts to upgrade a readonly url.
3128
    this command. When the default format has changed you may also be warned
3129
    during other operations to upgrade.
1147 by Martin Pool
- split builtin commands into separate module bzrlib.builtins;
3130
    """
2425.2.3 by Robert Collins
Update existing builtin commands help text to use _see_also. (Robert Collins)
3131
3132
    _see_also = ['check']
1534.4.13 by Robert Collins
Give a reasonable warning on attempts to upgrade a readonly url.
3133
    takes_args = ['url?']
1857.1.20 by Aaron Bentley
Strip out all the EnumOption stuff
3134
    takes_options = [
2221.4.9 by Aaron Bentley
Zap trailing whitespace
3135
                    RegistryOption('format',
2221.4.12 by Aaron Bentley
Add option grouping to RegistryOption and clean up format options
3136
                        help='Upgrade to a specific format.  See "bzr help'
2598.1.1 by Martin Pool
Add test for and documentation of option style, fix up existing options to comply
3137
                             ' formats" for details.',
3224.5.2 by Andrew Bennetts
Avoid importing bzrlib.bzrdir unnecessarily.
3138
                        lazy_registry=('bzrlib.bzrdir', 'format_registry'),
3139
                        converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
2221.4.12 by Aaron Bentley
Add option grouping to RegistryOption and clean up format options
3140
                        value_switches=True, title='Branch format'),
1857.1.20 by Aaron Bentley
Strip out all the EnumOption stuff
3141
                    ]
3142
3143
    def run(self, url='.', format=None):
1147 by Martin Pool
- split builtin commands into separate module bzrlib.builtins;
3144
        from bzrlib.upgrade import upgrade
1857.1.20 by Aaron Bentley
Strip out all the EnumOption stuff
3145
        upgrade(url, format)
1147 by Martin Pool
- split builtin commands into separate module bzrlib.builtins;
3146
3147
3148
class cmd_whoami(Command):
1816.2.4 by Robey Pointer
flesh out 'whoami' docs a little, and don't display the identity after setting it
3149
    """Show or set bzr user id.
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
3150
2666.1.1 by Ian Clatworthy
Bazaar User Reference generated from online help
3151
    :Examples:
3152
        Show the email of the current user::
3153
3154
            bzr whoami --email
3155
3156
        Set the current user::
3157
3035.1.1 by John Arbash Meinel
Address bug #59302 and fix documentation that uses single quotes.
3158
            bzr whoami "Frank Chu <fchu@example.com>"
1816.2.4 by Robey Pointer
flesh out 'whoami' docs a little, and don't display the identity after setting it
3159
    """
1816.2.2 by Robey Pointer
fix 'whoami' to use encodings and allow setting the global or branch identity
3160
    takes_options = [ Option('email',
2598.1.1 by Martin Pool
Add test for and documentation of option style, fix up existing options to comply
3161
                             help='Display email address only.'),
1816.2.2 by Robey Pointer
fix 'whoami' to use encodings and allow setting the global or branch identity
3162
                      Option('branch',
2598.1.1 by Martin Pool
Add test for and documentation of option style, fix up existing options to comply
3163
                             help='Set identity for the current branch instead of '
3164
                                  'globally.'),
1816.2.2 by Robey Pointer
fix 'whoami' to use encodings and allow setting the global or branch identity
3165
                    ]
3166
    takes_args = ['name?']
3167
    encoding_type = 'replace'
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
3168
1185.12.56 by Aaron Bentley
Prevented display commands from printing broken pipe errors
3169
    @display_command
1816.2.2 by Robey Pointer
fix 'whoami' to use encodings and allow setting the global or branch identity
3170
    def run(self, email=False, branch=False, name=None):
3171
        if name is None:
3172
            # use branch if we're inside one; otherwise global config
3173
            try:
1816.2.10 by Robey Pointer
code style changes
3174
                c = Branch.open_containing('.')[0].get_config()
1996.3.34 by John Arbash Meinel
Update builtins to use errors.foo. Now errors can be avoided entirely for a bzr rocks run
3175
            except errors.NotBranchError:
1816.2.2 by Robey Pointer
fix 'whoami' to use encodings and allow setting the global or branch identity
3176
                c = config.GlobalConfig()
1816.2.4 by Robey Pointer
flesh out 'whoami' docs a little, and don't display the identity after setting it
3177
            if email:
1816.2.10 by Robey Pointer
code style changes
3178
                self.outf.write(c.user_email() + '\n')
1816.2.2 by Robey Pointer
fix 'whoami' to use encodings and allow setting the global or branch identity
3179
            else:
1816.2.10 by Robey Pointer
code style changes
3180
                self.outf.write(c.username() + '\n')
1816.2.4 by Robey Pointer
flesh out 'whoami' docs a little, and don't display the identity after setting it
3181
            return
1816.2.2 by Robey Pointer
fix 'whoami' to use encodings and allow setting the global or branch identity
3182
1840.1.2 by Robey Pointer
instead of raising an error, just display an exception if 'whoami' is given a name that doesn't look like it contains an email address
3183
        # display a warning if an email address isn't included in the given name.
3184
        try:
3185
            config.extract_email_address(name)
2055.2.2 by John Arbash Meinel
Switch extract_email_address() to use a more specific exception
3186
        except errors.NoEmailInUsername, e:
1840.1.5 by Robey Pointer
change the warning message for a 'whoami' with no email address, on jam's recommendation
3187
            warning('"%s" does not seem to contain an email address.  '
3188
                    'This is allowed, but not recommended.', name)
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
3189
1816.2.4 by Robey Pointer
flesh out 'whoami' docs a little, and don't display the identity after setting it
3190
        # use global config unless --branch given
3191
        if branch:
1816.2.10 by Robey Pointer
code style changes
3192
            c = Branch.open_containing('.')[0].get_config()
1147 by Martin Pool
- split builtin commands into separate module bzrlib.builtins;
3193
        else:
1816.2.4 by Robey Pointer
flesh out 'whoami' docs a little, and don't display the identity after setting it
3194
            c = config.GlobalConfig()
3195
        c.set_user_option('email', name)
1147 by Martin Pool
- split builtin commands into separate module bzrlib.builtins;
3196
1534.4.25 by Robert Collins
Add a --transport parameter to the test suite to set the default transport to be used in the test suite.
3197
1185.35.14 by Aaron Bentley
Implemented nick command
3198
class cmd_nick(Command):
3565.6.16 by Marius Kruger
update nick command description to mention how it works for bound branches,
3199
    """Print or set the branch nickname.
3200
3201
    If unset, the tree root directory name is used as the nickname.
3202
    To print the current nickname, execute with no argument.
3203
3204
    Bound branches use the nickname of its master branch unless it is set
3205
    locally.
1185.35.14 by Aaron Bentley
Implemented nick command
3206
    """
2425.2.3 by Robert Collins
Update existing builtin commands help text to use _see_also. (Robert Collins)
3207
3208
    _see_also = ['info']
1185.35.14 by Aaron Bentley
Implemented nick command
3209
    takes_args = ['nickname?']
3210
    def run(self, nickname=None):
1185.33.66 by Martin Pool
[patch] use unicode literals for all hardcoded paths (Alexander Belchenko)
3211
        branch = Branch.open_containing(u'.')[0]
1185.35.14 by Aaron Bentley
Implemented nick command
3212
        if nickname is None:
3213
            self.printme(branch)
3214
        else:
3215
            branch.nick = nickname
3216
3217
    @display_command
3218
    def printme(self, branch):
2367.1.8 by Robert Collins
Whitespace.
3219
        print branch.nick
1147 by Martin Pool
- split builtin commands into separate module bzrlib.builtins;
3220
1534.4.25 by Robert Collins
Add a --transport parameter to the test suite to set the default transport to be used in the test suite.
3221
2900.3.2 by Tim Penhey
A working alias command.
3222
class cmd_alias(Command):
2900.3.7 by Tim Penhey
Updates from Aaron's review.
3223
    """Set/unset and display aliases.
2900.3.2 by Tim Penhey
A working alias command.
3224
3225
    :Examples:
3226
        Show the current aliases::
3227
3228
            bzr alias
3229
3230
        Show the alias specified for 'll'::
3231
3232
            bzr alias ll
3233
3234
        Set an alias for 'll'::
3235
2900.3.10 by Tim Penhey
Show examples, and change text to use double rather than single quotes.
3236
            bzr alias ll="log --line -r-10..-1"
2900.3.2 by Tim Penhey
A working alias command.
3237
2900.3.4 by Tim Penhey
Removed the unalais separate command.
3238
        To remove an alias for 'll'::
3239
3240
            bzr alias --remove ll
3241
2900.3.2 by Tim Penhey
A working alias command.
3242
    """
3243
    takes_args = ['name?']
2900.3.4 by Tim Penhey
Removed the unalais separate command.
3244
    takes_options = [
3245
        Option('remove', help='Remove the alias.'),
3246
        ]
2900.3.2 by Tim Penhey
A working alias command.
3247
2900.3.4 by Tim Penhey
Removed the unalais separate command.
3248
    def run(self, name=None, remove=False):
3249
        if remove:
3250
            self.remove_alias(name)
3251
        elif name is None:
2900.3.2 by Tim Penhey
A working alias command.
3252
            self.print_aliases()
3253
        else:
3254
            equal_pos = name.find('=')
3255
            if equal_pos == -1:
3256
                self.print_alias(name)
3257
            else:
3258
                self.set_alias(name[:equal_pos], name[equal_pos+1:])
3259
2900.3.4 by Tim Penhey
Removed the unalais separate command.
3260
    def remove_alias(self, alias_name):
3261
        if alias_name is None:
3262
            raise errors.BzrCommandError(
3263
                'bzr alias --remove expects an alias to remove.')
3264
        # If alias is not found, print something like:
3265
        # unalias: foo: not found
2900.3.8 by Tim Penhey
Use the exception text for unalias not found.
3266
        c = config.GlobalConfig()
3267
        c.unset_alias(alias_name)
2900.3.4 by Tim Penhey
Removed the unalais separate command.
3268
3269
    @display_command
2900.3.2 by Tim Penhey
A working alias command.
3270
    def print_aliases(self):
3271
        """Print out the defined aliases in a similar format to bash."""
3272
        aliases = config.GlobalConfig().get_aliases()
2900.3.7 by Tim Penhey
Updates from Aaron's review.
3273
        for key, value in sorted(aliases.iteritems()):
2900.3.10 by Tim Penhey
Show examples, and change text to use double rather than single quotes.
3274
            self.outf.write('bzr alias %s="%s"\n' % (key, value))
2900.3.2 by Tim Penhey
A working alias command.
3275
3276
    @display_command
3277
    def print_alias(self, alias_name):
3278
        from bzrlib.commands import get_alias
3279
        alias = get_alias(alias_name)
3280
        if alias is None:
2900.3.7 by Tim Penhey
Updates from Aaron's review.
3281
            self.outf.write("bzr alias: %s: not found\n" % alias_name)
2900.3.2 by Tim Penhey
A working alias command.
3282
        else:
2900.3.7 by Tim Penhey
Updates from Aaron's review.
3283
            self.outf.write(
2900.3.11 by Tim Penhey
Fixed the output in the tests.
3284
                'bzr alias %s="%s"\n' % (alias_name, ' '.join(alias)))
2900.3.2 by Tim Penhey
A working alias command.
3285
2900.3.12 by Tim Penhey
Final review comments.
3286
    def set_alias(self, alias_name, alias_command):
2900.3.2 by Tim Penhey
A working alias command.
3287
        """Save the alias in the global config."""
3288
        c = config.GlobalConfig()
2900.3.12 by Tim Penhey
Final review comments.
3289
        c.set_alias(alias_name, alias_command)
2900.3.2 by Tim Penhey
A working alias command.
3290
3291
1147 by Martin Pool
- split builtin commands into separate module bzrlib.builtins;
3292
class cmd_selftest(Command):
1393.1.46 by Martin Pool
- bzr selftest arguments can be partial ids of tests to run
3293
    """Run internal test suite.
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
3294
2213.2.1 by Martin Pool
Add selftest --first flag
3295
    If arguments are given, they are regular expressions that say which tests
3296
    should run.  Tests matching any expression are run, and other tests are
3297
    not run.
3298
3299
    Alternatively if --first is given, matching tests are run first and then
3300
    all other tests are run.  This is useful if you have been working in a
3301
    particular area, but want to make sure nothing else was broken.
1552 by Martin Pool
Improved help text for bzr selftest
3302
2394.2.2 by Ian Clatworthy
Add --randomize and update help
3303
    If --exclude is given, tests that match that regular expression are
2394.2.9 by Ian Clatworthy
update NEWS and help to reflect removal of comma support
3304
    excluded, regardless of whether they match --first or not.
2394.2.2 by Ian Clatworthy
Add --randomize and update help
3305
3306
    To help catch accidential dependencies between tests, the --randomize
3307
    option is useful. In most cases, the argument used is the word 'now'.
3308
    Note that the seed used for the random number generator is displayed
3309
    when this option is used. The seed can be explicitly passed as the
3310
    argument to this option if required. This enables reproduction of the
3311
    actual ordering used if and when an order sensitive problem is encountered.
3312
3313
    If --list-only is given, the tests that would be run are listed. This is
3314
    useful when combined with --first, --exclude and/or --randomize to
3315
    understand their impact. The test harness reports "Listed nn tests in ..."
3316
    instead of "Ran nn tests in ..." when list mode is enabled.
3317
1552 by Martin Pool
Improved help text for bzr selftest
3318
    If the global option '--no-plugins' is given, plugins are not loaded
3319
    before running the selftests.  This has two effects: features provided or
3320
    modified by plugins will not be tested, and tests provided by plugins will
3321
    not be run.
3322
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
3323
    Tests that need working space on disk use a common temporary directory,
2598.4.1 by Martin Pool
Remove obsolete --clean-output, --keep-output, --numbered-dirs selftest options (thanks Alexander)
3324
    typically inside $TMPDIR or /tmp.
3325
2666.1.1 by Ian Clatworthy
Bazaar User Reference generated from online help
3326
    :Examples:
3327
        Run only tests relating to 'ignore'::
3328
3329
            bzr selftest ignore
3330
3331
        Disable plugins and list tests as they're run::
3332
3333
            bzr --no-plugins selftest -v
1185.16.58 by mbp at sourcefrog
- run all selftests by default
3334
    """
1534.4.25 by Robert Collins
Add a --transport parameter to the test suite to set the default transport to be used in the test suite.
3335
    # NB: this is used from the class without creating an instance, which is
3336
    # why it does not have a self parameter.
3337
    def get_transport_type(typestring):
3338
        """Parse and return a transport specifier."""
3339
        if typestring == "sftp":
3340
            from bzrlib.transport.sftp import SFTPAbsoluteServer
3341
            return SFTPAbsoluteServer
1534.4.26 by Robert Collins
Move working tree initialisation out from Branch.initialize, deprecated Branch.initialize to Branch.create.
3342
        if typestring == "memory":
3343
            from bzrlib.transport.memory import MemoryServer
3344
            return MemoryServer
1558.10.1 by Aaron Bentley
Handle lockdirs over NFS properly
3345
        if typestring == "fakenfs":
1558.10.2 by Robert Collins
Refactor the FakeNFS support into a TransportDecorator.
3346
            from bzrlib.transport.fakenfs import FakeNFSServer
1558.10.1 by Aaron Bentley
Handle lockdirs over NFS properly
3347
            return FakeNFSServer
1534.4.25 by Robert Collins
Add a --transport parameter to the test suite to set the default transport to be used in the test suite.
3348
        msg = "No known transport type %s. Supported types are: sftp\n" %\
3349
            (typestring)
1996.3.34 by John Arbash Meinel
Update builtins to use errors.foo. Now errors can be avoided entirely for a bzr rocks run
3350
        raise errors.BzrCommandError(msg)
1534.4.25 by Robert Collins
Add a --transport parameter to the test suite to set the default transport to be used in the test suite.
3351
1147 by Martin Pool
- split builtin commands into separate module bzrlib.builtins;
3352
    hidden = True
1185.1.57 by Robert Collins
nuke --pattern to selftest, replace with regexp.search calls.
3353
    takes_args = ['testspecs*']
1552 by Martin Pool
Improved help text for bzr selftest
3354
    takes_options = ['verbose',
2418.2.2 by Martin Pool
Add -1 option to selftest
3355
                     Option('one',
2598.1.1 by Martin Pool
Add test for and documentation of option style, fix up existing options to comply
3356
                             help='Stop when one test fails.',
2418.2.2 by Martin Pool
Add -1 option to selftest
3357
                             short_name='1',
3358
                             ),
2333.1.1 by Dmitry Vasiliev
Fixed typo and removed some trailing whitespaces
3359
                     Option('transport',
1534.4.25 by Robert Collins
Add a --transport parameter to the test suite to set the default transport to be used in the test suite.
3360
                            help='Use a different transport by default '
3361
                                 'throughout the test suite.',
3362
                            type=get_transport_type),
2598.1.1 by Martin Pool
Add test for and documentation of option style, fix up existing options to comply
3363
                     Option('benchmark',
3364
                            help='Run the benchmarks rather than selftests.'),
1725.1.1 by Robert Collins
'bzr selftest --benchmark --lsprof-timed' will use lsprofile to generate
3365
                     Option('lsprof-timed',
2598.1.1 by Martin Pool
Add test for and documentation of option style, fix up existing options to comply
3366
                            help='Generate lsprof output for benchmarked'
1725.1.1 by Robert Collins
'bzr selftest --benchmark --lsprof-timed' will use lsprofile to generate
3367
                                 ' sections of code.'),
1908.2.4 by John Arbash Meinel
Add the ability to specify a benchmark cache directory.
3368
                     Option('cache-dir', type=str,
2598.1.1 by Martin Pool
Add test for and documentation of option style, fix up existing options to comply
3369
                            help='Cache intermediate benchmark output in this '
3370
                                 'directory.'),
2213.2.1 by Martin Pool
Add selftest --first flag
3371
                     Option('first',
2598.1.1 by Martin Pool
Add test for and documentation of option style, fix up existing options to comply
3372
                            help='Run all tests, but run specified tests first.',
2418.2.1 by Martin Pool
Add -f alias for selftest --first
3373
                            short_name='f',
2321.2.1 by Alexander Belchenko
`bzr selftest --numbered-dirs` use numbered dirs for TestCaseInTempDir
3374
                            ),
2394.2.1 by Ian Clatworthy
--list and --exclude first cut
3375
                     Option('list-only',
2598.1.1 by Martin Pool
Add test for and documentation of option style, fix up existing options to comply
3376
                            help='List the tests instead of running them.'),
4205.3.2 by Robert Collins
Create fork and reinvoke parallel testing support.
3377
                     RegistryOption('parallel',
4205.3.5 by Robert Collins
Missing . on the parallel option.
3378
                        help="Run the test suite in parallel.",
4205.3.2 by Robert Collins
Create fork and reinvoke parallel testing support.
3379
                        lazy_registry=('bzrlib.tests', 'parallel_registry'),
3380
                        value_switches=False,
3381
                        ),
2394.2.2 by Ian Clatworthy
Add --randomize and update help
3382
                     Option('randomize', type=str, argname="SEED",
2598.1.1 by Martin Pool
Add test for and documentation of option style, fix up existing options to comply
3383
                            help='Randomize the order of tests using the given'
3384
                                 ' seed or "now" for the current time.'),
2394.2.2 by Ian Clatworthy
Add --randomize and update help
3385
                     Option('exclude', type=str, argname="PATTERN",
2394.2.6 by Ian Clatworthy
completed blackbox tests
3386
                            short_name='x',
2598.1.1 by Martin Pool
Add test for and documentation of option style, fix up existing options to comply
3387
                            help='Exclude tests that match this regular'
3388
                                 ' expression.'),
4165.1.1 by Robert Collins
Add builtin subunit support.
3389
                     Option('subunit',
3390
                        help='Output test progress via subunit.'),
2658.3.3 by Daniel Watkins
Added UI support for bzr selftest --strict.
3391
                     Option('strict', help='Fail on missing dependencies or '
3392
                            'known failures.'),
3193.1.8 by Vincent Ladeuil
Add '--load-list' option to selftest.
3393
                     Option('load-list', type=str, argname='TESTLISTFILE',
3394
                            help='Load a test id list from a text file.'),
3390.1.1 by Andrew Bennetts
Add --debugflags/-E option to selftest.
3395
                     ListOption('debugflag', type=str, short_name='E',
3396
                                help='Turn on a selftest debug flag.'),
3649.6.4 by Vincent Ladeuil
selftest --starting-with now accepts multiple values.
3397
                     ListOption('starting-with', type=str, argname='TESTID',
3398
                                param_name='starting_with', short_name='s',
3399
                                help=
3400
                                'Load only the tests starting with TESTID.'),
1725.1.1 by Robert Collins
'bzr selftest --benchmark --lsprof-timed' will use lsprofile to generate
3401
                     ]
2204.3.4 by Alexander Belchenko
Command 'selftest' use 'replace' encoding_type to prevent sudden traceback
3402
    encoding_type = 'replace'
1185.16.58 by mbp at sourcefrog
- run all selftests by default
3403
4000.2.3 by Robert Collins
Allow extra options to bzrlib.tests.selftest from plugins.
3404
    def __init__(self):
3405
        Command.__init__(self)
3406
        self.additional_selftest_args = {}
3407
2805.1.1 by Ian Clatworthy
Fix selftest --benchmark so verbose by default again
3408
    def run(self, testspecs_list=None, verbose=False, one=False,
2598.4.1 by Martin Pool
Remove obsolete --clean-output, --keep-output, --numbered-dirs selftest options (thanks Alexander)
3409
            transport=None, benchmark=None,
3410
            lsprof_timed=None, cache_dir=None,
3411
            first=False, list_only=False,
3198.1.1 by Vincent Ladeuil
Add --load-list option to selftest
3412
            randomize=None, exclude=None, strict=False,
4205.3.2 by Robert Collins
Create fork and reinvoke parallel testing support.
3413
            load_list=None, debugflag=None, starting_with=None, subunit=False,
3414
            parallel=None):
1707.2.2 by Robert Collins
Start on bench_add, an add benchtest.
3415
        from bzrlib.tests import selftest
3416
        import bzrlib.benchmarks as benchmarks
1908.2.16 by John Arbash Meinel
Move all the new TreeCreator classes into separate files.
3417
        from bzrlib.benchmarks import tree_creator
2321.2.1 by Alexander Belchenko
`bzr selftest --numbered-dirs` use numbered dirs for TestCaseInTempDir
3418
3427.5.3 by John Arbash Meinel
Update the activate_deprecation_warnings so it can be skipped if there is already an error set.
3419
        # Make deprecation warnings visible, unless -Werror is set
3427.5.7 by John Arbash Meinel
Bring back always in the form of 'override'.
3420
        symbol_versioning.activate_deprecation_warnings(override=False)
3427.5.3 by John Arbash Meinel
Update the activate_deprecation_warnings so it can be skipped if there is already an error set.
3421
1908.2.4 by John Arbash Meinel
Add the ability to specify a benchmark cache directory.
3422
        if cache_dir is not None:
1908.2.16 by John Arbash Meinel
Move all the new TreeCreator classes into separate files.
3423
            tree_creator.TreeCreator.CACHE_ROOT = osutils.abspath(cache_dir)
2095.4.1 by Martin Pool
Better progress bars during tests
3424
        if testspecs_list is not None:
3425
            pattern = '|'.join(testspecs_list)
3426
        else:
3427
            pattern = ".*"
4165.1.1 by Robert Collins
Add builtin subunit support.
3428
        if subunit:
4165.1.2 by Robert Collins
Make a clear error when attempting to use subunit and it is not available.
3429
            try:
3430
                from bzrlib.tests import SubUnitBzrRunner
3431
            except ImportError:
3432
                raise errors.BzrCommandError("subunit not available. subunit "
3433
                    "needs to be installed to use --subunit.")
4165.1.1 by Robert Collins
Add builtin subunit support.
3434
            self.additional_selftest_args['runner_class'] = SubUnitBzrRunner
4205.3.2 by Robert Collins
Create fork and reinvoke parallel testing support.
3435
        if parallel:
3436
            self.additional_selftest_args.setdefault(
3437
                'suite_decorators', []).append(parallel)
2095.4.1 by Martin Pool
Better progress bars during tests
3438
        if benchmark:
3439
            test_suite_factory = benchmarks.test_suite
2805.1.1 by Ian Clatworthy
Fix selftest --benchmark so verbose by default again
3440
            # Unless user explicitly asks for quiet, be verbose in benchmarks
3441
            verbose = not is_quiet()
2095.4.1 by Martin Pool
Better progress bars during tests
3442
            # TODO: should possibly lock the history file...
2197.1.1 by Martin Pool
Use line buffering to write .perf_history
3443
            benchfile = open(".perf_history", "at", buffering=1)
2095.4.1 by Martin Pool
Better progress bars during tests
3444
        else:
3445
            test_suite_factory = None
3446
            benchfile = None
1147 by Martin Pool
- split builtin commands into separate module bzrlib.builtins;
3447
        try:
4000.2.4 by Robert Collins
PEP8ification of selftest_kwargs in cmd_selftest.
3448
            selftest_kwargs = {"verbose": verbose,
3449
                              "pattern": pattern,
3450
                              "stop_on_failure": one,
3451
                              "transport": transport,
3452
                              "test_suite_factory": test_suite_factory,
3453
                              "lsprof_timed": lsprof_timed,
3454
                              "bench_history": benchfile,
3455
                              "matching_tests_first": first,
3456
                              "list_only": list_only,
3457
                              "random_seed": randomize,
3458
                              "exclude_pattern": exclude,
3459
                              "strict": strict,
3460
                              "load_list": load_list,
3461
                              "debug_flags": debugflag,
3462
                              "starting_with": starting_with
4000.2.3 by Robert Collins
Allow extra options to bzrlib.tests.selftest from plugins.
3463
                              }
3464
            selftest_kwargs.update(self.additional_selftest_args)
3465
            result = selftest(**selftest_kwargs)
1147 by Martin Pool
- split builtin commands into separate module bzrlib.builtins;
3466
        finally:
2095.4.1 by Martin Pool
Better progress bars during tests
3467
            if benchfile is not None:
3468
                benchfile.close()
3469
        return int(not result)
1147 by Martin Pool
- split builtin commands into separate module bzrlib.builtins;
3470
3471
3472
class cmd_version(Command):
3473
    """Show version of bzr."""
1871.1.1 by Robert Collins
Relocate bzrlib selftest external output tests to bzrlib/tests/blackbox/test_selftest.py.
3474
2785.1.2 by bialix at ukr
bugfix for #131100
3475
    encoding_type = 'replace'
3346.2.1 by Martin Pool
Add version --short option
3476
    takes_options = [
3477
        Option("short", help="Print just the version number."),
3478
        ]
2785.1.2 by bialix at ukr
bugfix for #131100
3479
1185.12.56 by Aaron Bentley
Prevented display commands from printing broken pipe errors
3480
    @display_command
3346.2.1 by Martin Pool
Add version --short option
3481
    def run(self, short=False):
1819.1.8 by Martin Pool
Improved reporting of bzrlib revision_id
3482
        from bzrlib.version import show_version
3346.2.1 by Martin Pool
Add version --short option
3483
        if short:
3346.2.7 by Martin Pool
Commands should use self.outf not print
3484
            self.outf.write(bzrlib.version_string + '\n')
3346.2.1 by Martin Pool
Add version --short option
3485
        else:
3486
            show_version(to_file=self.outf)
1147 by Martin Pool
- split builtin commands into separate module bzrlib.builtins;
3487
1871.1.1 by Robert Collins
Relocate bzrlib selftest external output tests to bzrlib/tests/blackbox/test_selftest.py.
3488
1147 by Martin Pool
- split builtin commands into separate module bzrlib.builtins;
3489
class cmd_rocks(Command):
3490
    """Statement of optimism."""
1871.1.1 by Robert Collins
Relocate bzrlib selftest external output tests to bzrlib/tests/blackbox/test_selftest.py.
3491
1147 by Martin Pool
- split builtin commands into separate module bzrlib.builtins;
3492
    hidden = True
1871.1.1 by Robert Collins
Relocate bzrlib selftest external output tests to bzrlib/tests/blackbox/test_selftest.py.
3493
1185.12.56 by Aaron Bentley
Prevented display commands from printing broken pipe errors
3494
    @display_command
1147 by Martin Pool
- split builtin commands into separate module bzrlib.builtins;
3495
    def run(self):
2227.4.1 by v.ladeuil+lp at free
Fix #78026.
3496
        print "It sure does!"
1147 by Martin Pool
- split builtin commands into separate module bzrlib.builtins;
3497
3498
3499
class cmd_find_merge_base(Command):
1871.1.1 by Robert Collins
Relocate bzrlib selftest external output tests to bzrlib/tests/blackbox/test_selftest.py.
3500
    """Find and print a base revision for merging two branches."""
1185.16.3 by Martin Pool
- remove all TODOs from bzr help messages
3501
    # TODO: Options to specify revisions on either side, as if
3502
    #       merging only part of the history.
1147 by Martin Pool
- split builtin commands into separate module bzrlib.builtins;
3503
    takes_args = ['branch', 'other']
3504
    hidden = True
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
3505
1185.12.56 by Aaron Bentley
Prevented display commands from printing broken pipe errors
3506
    @display_command
1147 by Martin Pool
- split builtin commands into separate module bzrlib.builtins;
3507
    def run(self, branch, other):
2872.2.1 by Andrew Bennetts
Remove unused imports in builtins.py revealed by pyflakes, and fix one undefined name.
3508
        from bzrlib.revision import ensure_null
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
3509
1442.1.64 by Robert Collins
Branch.open_containing now returns a tuple (Branch, relative-path).
3510
        branch1 = Branch.open_containing(branch)[0]
3511
        branch2 = Branch.open_containing(other)[0]
3010.1.17 by Robert Collins
Lock correctness and commit_group management for re-sign, in builtins.
3512
        branch1.lock_read()
3513
        try:
3514
            branch2.lock_read()
3515
            try:
3516
                last1 = ensure_null(branch1.last_revision())
3517
                last2 = ensure_null(branch2.last_revision())
3518
3519
                graph = branch1.repository.get_graph(branch2.repository)
3520
                base_rev_id = graph.find_unique_lca(last1, last2)
3521
3522
                print 'merge base is revision %s' % base_rev_id
3523
            finally:
3524
                branch2.unlock()
3525
        finally:
3526
            branch1.unlock()
1147 by Martin Pool
- split builtin commands into separate module bzrlib.builtins;
3527
3528
3529
class cmd_merge(Command):
3530
    """Perform a three-way merge.
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
3531
3277.1.1 by Peter Schuller
Document the relationship between bzr send and bzr merge. In
3532
    The source of the merge can be specified either in the form of a branch,
3533
    or in the form of a path to a file containing a merge directive generated
3534
    with bzr send. If neither is specified, the default is the upstream branch
3277.1.2 by Peter Schuller
As per feedback to previous attempt:
3535
    or the branch most recently merged using --remember.
3277.1.1 by Peter Schuller
Document the relationship between bzr send and bzr merge. In
3536
3277.1.2 by Peter Schuller
As per feedback to previous attempt:
3537
    When merging a branch, by default the tip will be merged. To pick a different
3538
    revision, pass --revision. If you specify two values, the first will be used as
3313.1.1 by Ian Clatworthy
Improve doc on send/merge relationship (Peter Schuller)
3539
    BASE and the second one as OTHER. Merging individual revisions, or a subset of
3540
    available revisions, like this is commonly referred to as "cherrypicking".
3277.1.3 by Peter Schuller
Identify by name the "cherrypicking" mode of operation of 'bzr merge'.
3541
3542
    Revision numbers are always relative to the branch being merged.
1172 by Martin Pool
- better explanation when merge fails with AmbiguousBase
3543
1551.2.19 by Aaron Bentley
Added See Conflicts to merge help
3544
    By default, bzr will try to merge in all new work from the other
1172 by Martin Pool
- better explanation when merge fails with AmbiguousBase
3545
    branch, automatically determining an appropriate base.  If this
3546
    fails, you may need to give an explicit base.
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
3547
1551.2.18 by Aaron Bentley
Updated docs to clarify conflict handling
3548
    Merge will do its best to combine the changes in two branches, but there
3549
    are some kinds of problems only a human can fix.  When it encounters those,
3550
    it will mark a conflict.  A conflict means that you need to fix something,
3551
    before you should commit.
3552
1551.2.19 by Aaron Bentley
Added See Conflicts to merge help
3553
    Use bzr resolve when you have fixed a problem.  See also bzr conflicts.
1551.2.18 by Aaron Bentley
Updated docs to clarify conflict handling
3554
1614.2.4 by Olaf Conradi
Renamed argument location in command merge back to branch.
3555
    If there is no default branch set, the first merge will set it. After
3556
    that, you can omit the branch to use the default.  To change the
1785.1.4 by John Arbash Meinel
Update help for the new --remember semantics.
3557
    default, use --remember. The value will only be saved if the remote
3558
    location can be accessed.
1614.2.2 by Olaf Conradi
Merge command:
3559
2220.2.8 by Martin Pool
Add -d option to push, pull, merge commands.
3560
    The results of the merge are placed into the destination working
3561
    directory, where they can be reviewed (with bzr diff), tested, and then
3562
    committed to record the result of the merge.
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
3563
1147 by Martin Pool
- split builtin commands into separate module bzrlib.builtins;
3564
    merge refuses to run if there are any uncommitted changes, unless
3565
    --force is given.
2666.1.1 by Ian Clatworthy
Bazaar User Reference generated from online help
3566
4526.6.15 by Aaron Bentley
Update command help
3567
    To select only some changes to merge, use "merge -i", which will prompt
3568
    you to apply each diff hunk and file change, similar to "shelve".
3569
2666.1.1 by Ian Clatworthy
Bazaar User Reference generated from online help
3570
    :Examples:
3571
        To merge the latest revision from bzr.dev::
3572
3573
            bzr merge ../bzr.dev
3574
3575
        To merge changes up to and including revision 82 from bzr.dev::
3576
3577
            bzr merge -r 82 ../bzr.dev
3578
3579
        To merge the changes introduced by 82, without previous changes::
3580
3581
            bzr merge -r 81..82 ../bzr.dev
3277.1.1 by Peter Schuller
Document the relationship between bzr send and bzr merge. In
3582
4031.3.1 by Frank Aspell
Fixing various typos
3583
        To apply a merge directive contained in /tmp/merge:
3277.1.1 by Peter Schuller
Document the relationship between bzr send and bzr merge. In
3584
3585
            bzr merge /tmp/merge
1147 by Martin Pool
- split builtin commands into separate module bzrlib.builtins;
3586
    """
2425.2.3 by Robert Collins
Update existing builtin commands help text to use _see_also. (Robert Collins)
3587
3008.1.25 by Aaron Bentley
Set encoding exact on cmd_merge
3588
    encoding_type = 'exact'
4095.2.1 by Neil Martinsen-Burrell
Better help for bzr send
3589
    _see_also = ['update', 'remerge', 'status-flags', 'send']
3277.1.4 by Peter Schuller
As per further feedback, use LOCATION instead of MERGE_OR_MERGE_DIRECTIVE.
3590
    takes_args = ['location?']
2598.1.10 by Martin Pool
Clean up options that are registered globally and used once or not at all.
3591
    takes_options = [
2839.5.1 by Alexander Belchenko
add -c option to merge command
3592
        'change',
2598.1.10 by Martin Pool
Clean up options that are registered globally and used once or not at all.
3593
        'revision',
3594
        Option('force',
3595
               help='Merge even if the destination tree has uncommitted changes.'),
3596
        'merge-type',
3597
        'reprocess',
3598
        'remember',
2220.2.8 by Martin Pool
Add -d option to push, pull, merge commands.
3599
        Option('show-base', help="Show base revision text in "
2598.1.1 by Martin Pool
Add test for and documentation of option style, fix up existing options to comply
3600
               "conflicts."),
2220.2.8 by Martin Pool
Add -d option to push, pull, merge commands.
3601
        Option('uncommitted', help='Apply uncommitted changes'
2598.1.1 by Martin Pool
Add test for and documentation of option style, fix up existing options to comply
3602
               ' from a working copy, instead of branch changes.'),
2220.2.8 by Martin Pool
Add -d option to push, pull, merge commands.
3603
        Option('pull', help='If the destination is already'
3604
                ' completely merged into the source, pull from the'
2598.1.1 by Martin Pool
Add test for and documentation of option style, fix up existing options to comply
3605
                ' source rather than merging.  When this happens,'
2220.2.8 by Martin Pool
Add -d option to push, pull, merge commands.
3606
                ' you do not need to commit the result.'),
3607
        Option('directory',
2598.1.10 by Martin Pool
Clean up options that are registered globally and used once or not at all.
3608
               help='Branch to merge into, '
3609
                    'rather than the one containing the working directory.',
3610
               short_name='d',
3611
               type=unicode,
3612
               ),
4526.6.3 by Aaron Bentley
Implement interactive merging.
3613
        Option('preview', help='Instead of merging, show a diff of the'
3614
               ' merge.'),
3615
        Option('interactive', help='Select changes interactively.',
3616
            short_name='i')
2220.2.8 by Martin Pool
Add -d option to push, pull, merge commands.
3617
    ]
1551.6.22 by Aaron Bentley
Improved help for remerge and merge
3618
3277.1.4 by Peter Schuller
As per further feedback, use LOCATION instead of MERGE_OR_MERGE_DIRECTIVE.
3619
    def run(self, location=None, revision=None, force=False,
3744.2.1 by John Arbash Meinel
Change 'bzr merge' so that it uses --reprocess as long as --show-base is not given.
3620
            merge_type=None, show_base=False, reprocess=None, remember=False,
2220.2.8 by Martin Pool
Add -d option to push, pull, merge commands.
3621
            uncommitted=False, pull=False,
3622
            directory=None,
3008.1.24 by Aaron Bentley
Add merge --preview to show diff
3623
            preview=False,
4526.6.3 by Aaron Bentley
Implement interactive merging.
3624
            interactive=False,
2220.2.8 by Martin Pool
Add -d option to push, pull, merge commands.
3625
            ):
1147 by Martin Pool
- split builtin commands into separate module bzrlib.builtins;
3626
        if merge_type is None:
1996.3.5 by John Arbash Meinel
Cleanup, deprecated, and get the tests passing again.
3627
            merge_type = _mod_merge.Merge3Merger
1614.2.2 by Olaf Conradi
Merge command:
3628
2220.2.8 by Martin Pool
Add -d option to push, pull, merge commands.
3629
        if directory is None: directory = u'.'
1551.15.67 by Aaron Bentley
Stop using _merge_helper for merging
3630
        possible_transports = []
3631
        merger = None
3632
        allow_pending = True
3633
        verified = 'inapplicable'
2220.2.8 by Martin Pool
Add -d option to push, pull, merge commands.
3634
        tree = WorkingTree.open_containing(directory)[0]
4037.2.1 by Roberto Aguilar
Check for umcommitted changes.
3635
3636
        # die as quickly as possible if there are uncommitted changes
4037.2.2 by Roberto Aguilar
Updating uncommitted changes check.
3637
        try:
3638
            basis_tree = tree.revision_tree(tree.last_revision())
3639
        except errors.NoSuchRevision:
3640
            basis_tree = tree.basis_tree()
4104.8.1 by Robert Collins
Cherrypick the fix for merge --force onto 1.13.1
3641
        if not force:
4503.1.2 by Vincent Ladeuil
Use tree.has_changes() where appropriate (the test suite caught a
3642
            if tree.has_changes(basis_tree):
4104.8.1 by Robert Collins
Cherrypick the fix for merge --force onto 1.13.1
3643
                raise errors.UncommittedChanges(tree)
4037.2.1 by Roberto Aguilar
Check for umcommitted changes.
3644
3586.1.31 by Ian Clatworthy
view filtering for pull, update & merge
3645
        view_info = _get_view_info_for_change_reporter(tree)
1551.10.25 by Aaron Bentley
Make ChangeReporter private
3646
        change_reporter = delta._ChangeReporter(
3586.1.31 by Ian Clatworthy
view filtering for pull, update & merge
3647
            unversioned_filter=tree.is_ignored, view_info=view_info)
1551.15.67 by Aaron Bentley
Stop using _merge_helper for merging
3648
        cleanups = []
3649
        try:
3650
            pb = ui.ui_factory.nested_progress_bar()
3651
            cleanups.append(pb.finished)
3652
            tree.lock_write()
3653
            cleanups.append(tree.unlock)
1551.15.74 by Aaron Bentley
Textual updates from review
3654
            if location is not None:
3251.4.10 by Aaron Bentley
Pull of launchpad locations works (abentley, #181945)
3655
                try:
3656
                    mergeable = bundle.read_mergeable_from_url(location,
3657
                        possible_transports=possible_transports)
3658
                except errors.NotABundle:
3659
                    mergeable = None
3660
                else:
1551.15.67 by Aaron Bentley
Stop using _merge_helper for merging
3661
                    if uncommitted:
3662
                        raise errors.BzrCommandError('Cannot use --uncommitted'
3663
                            ' with bundles or merge directives.')
3664
3665
                    if revision is not None:
3666
                        raise errors.BzrCommandError(
3667
                            'Cannot use -r with merge directives or bundles')
3668
                    merger, verified = _mod_merge.Merger.from_mergeable(tree,
3669
                       mergeable, pb)
3670
3671
            if merger is None and uncommitted:
3672
                if revision is not None and len(revision) > 0:
3673
                    raise errors.BzrCommandError('Cannot use --uncommitted and'
3674
                        ' --revision at the same time.')
4465.1.1 by Aaron Bentley
Refactor cmd_merge to allow supplying other forms of uncommitted changes.
3675
                merger = self.get_merger_from_uncommitted(tree, location, pb,
3676
                                                          cleanups)
1551.15.67 by Aaron Bentley
Stop using _merge_helper for merging
3677
                allow_pending = False
3678
3679
            if merger is None:
1551.15.75 by Aaron Bentley
_merger_from_branch -> _get_merger_from_branch
3680
                merger, allow_pending = self._get_merger_from_branch(tree,
1551.15.74 by Aaron Bentley
Textual updates from review
3681
                    location, revision, remember, possible_transports, pb)
1551.15.67 by Aaron Bentley
Stop using _merge_helper for merging
3682
3683
            merger.merge_type = merge_type
3684
            merger.reprocess = reprocess
3685
            merger.show_base = show_base
3686
            self.sanity_check_merger(merger)
3687
            if (merger.base_rev_id == merger.other_rev_id and
3376.2.11 by Martin Pool
Compare to None using is/is not not ==
3688
                merger.other_rev_id is not None):
1551.15.67 by Aaron Bentley
Stop using _merge_helper for merging
3689
                note('Nothing to do.')
3690
                return 0
3691
            if pull:
3692
                if merger.interesting_files is not None:
2872.2.1 by Andrew Bennetts
Remove unused imports in builtins.py revealed by pyflakes, and fix one undefined name.
3693
                    raise errors.BzrCommandError('Cannot pull individual files')
1551.15.67 by Aaron Bentley
Stop using _merge_helper for merging
3694
                if (merger.base_rev_id == tree.last_revision()):
3695
                    result = tree.pull(merger.other_branch, False,
3696
                                       merger.other_rev_id)
3697
                    result.report(self.outf)
3698
                    return 0
4037.2.4 by Roberto Aguilar
Set check_basis to False.
3699
            merger.check_basis(False)
3008.1.24 by Aaron Bentley
Add merge --preview to show diff
3700
            if preview:
4526.6.3 by Aaron Bentley
Implement interactive merging.
3701
                return self._do_preview(merger, cleanups)
3702
            elif interactive:
3703
                return self._do_interactive(merger, cleanups)
1551.15.66 by Aaron Bentley
Improve behavior with revision ids
3704
            else:
3008.1.24 by Aaron Bentley
Add merge --preview to show diff
3705
                return self._do_merge(merger, change_reporter, allow_pending,
3706
                                      verified)
1551.15.67 by Aaron Bentley
Stop using _merge_helper for merging
3707
        finally:
3708
            for cleanup in reversed(cleanups):
3709
                cleanup()
3710
4526.6.3 by Aaron Bentley
Implement interactive merging.
3711
    def _get_preview(self, merger, cleanups):
3008.1.24 by Aaron Bentley
Add merge --preview to show diff
3712
        tree_merger = merger.make_merger()
3713
        tt = tree_merger.make_preview_transform()
4526.6.3 by Aaron Bentley
Implement interactive merging.
3714
        cleanups.append(tt.finalize)
3715
        result_tree = tt.get_preview_tree()
4526.6.8 by Aaron Bentley
Remove unused tt parameter.
3716
        return result_tree
4526.6.3 by Aaron Bentley
Implement interactive merging.
3717
3718
    def _do_preview(self, merger, cleanups):
3719
        from bzrlib.diff import show_diff_trees
4526.6.8 by Aaron Bentley
Remove unused tt parameter.
3720
        result_tree = self._get_preview(merger, cleanups)
4526.6.3 by Aaron Bentley
Implement interactive merging.
3721
        show_diff_trees(merger.this_tree, result_tree, self.outf,
3722
                        old_label='', new_label='')
3008.1.24 by Aaron Bentley
Add merge --preview to show diff
3723
3724
    def _do_merge(self, merger, change_reporter, allow_pending, verified):
3725
        merger.change_reporter = change_reporter
3726
        conflict_count = merger.do_merge()
3727
        if allow_pending:
3728
            merger.set_pending()
3729
        if verified == 'failed':
3730
            warning('Preview patch does not match changes')
3731
        if conflict_count != 0:
3732
            return 1
3733
        else:
3734
            return 0
3735
4526.6.3 by Aaron Bentley
Implement interactive merging.
3736
    def _do_interactive(self, merger, cleanups):
4526.6.13 by Aaron Bentley
Add docstring to do_interactive.
3737
        """Perform an interactive merge.
3738
3739
        This works by generating a preview tree of the merge, then using
3740
        Shelver to selectively remove the differences between the working tree
3741
        and the preview tree.
3742
        """
4526.6.4 by Aaron Bentley
Remove changes_destroyed message.
3743
        from bzrlib import shelf_ui
4526.6.8 by Aaron Bentley
Remove unused tt parameter.
3744
        result_tree = self._get_preview(merger, cleanups)
4526.6.14 by Aaron Bentley
Use default DiffWriter.
3745
        writer = bzrlib.option.diff_writer_registry.get()
4526.6.4 by Aaron Bentley
Remove changes_destroyed message.
3746
        shelver = shelf_ui.Shelver(merger.this_tree, result_tree, destroy=True,
4526.6.14 by Aaron Bentley
Use default DiffWriter.
3747
                                   reporter=shelf_ui.ApplyReporter(),
3748
                                   diff_writer=writer(sys.stdout))
4526.6.3 by Aaron Bentley
Implement interactive merging.
3749
        shelver.run()
3750
1551.15.67 by Aaron Bentley
Stop using _merge_helper for merging
3751
    def sanity_check_merger(self, merger):
3752
        if (merger.show_base and
3753
            not merger.merge_type is _mod_merge.Merge3Merger):
3754
            raise errors.BzrCommandError("Show-base is not supported for this"
2665.2.1 by Michael Hudson
test and fix for a NameError in merge --weave --show-base
3755
                                         " merge type. %s" % merger.merge_type)
3744.2.1 by John Arbash Meinel
Change 'bzr merge' so that it uses --reprocess as long as --show-base is not given.
3756
        if merger.reprocess is None:
3757
            if merger.show_base:
3758
                merger.reprocess = False
3759
            else:
3760
                # Use reprocess if the merger supports it
3761
                merger.reprocess = merger.merge_type.supports_reprocess
1551.15.67 by Aaron Bentley
Stop using _merge_helper for merging
3762
        if merger.reprocess and not merger.merge_type.supports_reprocess:
3763
            raise errors.BzrCommandError("Conflict reduction is not supported"
2665.2.1 by Michael Hudson
test and fix for a NameError in merge --weave --show-base
3764
                                         " for merge type %s." %
3765
                                         merger.merge_type)
1551.15.67 by Aaron Bentley
Stop using _merge_helper for merging
3766
        if merger.reprocess and merger.show_base:
3767
            raise errors.BzrCommandError("Cannot do conflict reduction and"
3768
                                         " show base.")
3769
1551.15.75 by Aaron Bentley
_merger_from_branch -> _get_merger_from_branch
3770
    def _get_merger_from_branch(self, tree, location, revision, remember,
3771
                                possible_transports, pb):
3772
        """Produce a merger from a location, assuming it refers to a branch."""
1551.15.67 by Aaron Bentley
Stop using _merge_helper for merging
3773
        from bzrlib.tag import _merge_tags_if_possible
3774
        # find the branch locations
1551.20.2 by Aaron Bentley
Merge prefers submit branch, but falls back to parent branch
3775
        other_loc, user_location = self._select_branch_location(tree, location,
1551.15.74 by Aaron Bentley
Textual updates from review
3776
            revision, -1)
1551.15.67 by Aaron Bentley
Stop using _merge_helper for merging
3777
        if revision is not None and len(revision) == 2:
1551.20.2 by Aaron Bentley
Merge prefers submit branch, but falls back to parent branch
3778
            base_loc, _unused = self._select_branch_location(tree,
3779
                location, revision, 0)
1551.15.67 by Aaron Bentley
Stop using _merge_helper for merging
3780
        else:
3781
            base_loc = other_loc
3782
        # Open the branches
3783
        other_branch, other_path = Branch.open_containing(other_loc,
3784
            possible_transports)
3785
        if base_loc == other_loc:
3786
            base_branch = other_branch
3787
        else:
3788
            base_branch, base_path = Branch.open_containing(base_loc,
1551.15.66 by Aaron Bentley
Improve behavior with revision ids
3789
                possible_transports)
1551.15.67 by Aaron Bentley
Stop using _merge_helper for merging
3790
        # Find the revision ids
4435.1.4 by Aaron Bentley
Fix tabs.
3791
        other_revision_id = None
3792
        base_revision_id = None
3793
        if revision is not None:
3794
            if len(revision) >= 1:
3795
                other_revision_id = revision[-1].as_revision_id(other_branch)
3796
            if len(revision) == 2:
3797
                base_revision_id = revision[0].as_revision_id(base_branch)
4435.1.1 by Aaron Bentley
Correctly fall back to basis when no second revision specified.
3798
        if other_revision_id is None:
1551.15.67 by Aaron Bentley
Stop using _merge_helper for merging
3799
            other_revision_id = _mod_revision.ensure_null(
3800
                other_branch.last_revision())
2485.8.37 by Vincent Ladeuil
Fix merge multiple connections. Test suite *not* passing (sftp
3801
        # Remember where we merge from
1551.20.2 by Aaron Bentley
Merge prefers submit branch, but falls back to parent branch
3802
        if ((remember or tree.branch.get_submit_branch() is None) and
3803
             user_location is not None):
3804
            tree.branch.set_submit_branch(other_branch.base)
1551.15.67 by Aaron Bentley
Stop using _merge_helper for merging
3805
        _merge_tags_if_possible(other_branch, tree.branch)
3806
        merger = _mod_merge.Merger.from_revision_ids(pb, tree,
3807
            other_revision_id, base_revision_id, other_branch, base_branch)
3808
        if other_path != '':
3809
            allow_pending = False
3810
            merger.interesting_files = [other_path]
1645.1.1 by Aaron Bentley
Implement single-file merge
3811
        else:
1551.15.67 by Aaron Bentley
Stop using _merge_helper for merging
3812
            allow_pending = True
3813
        return merger, allow_pending
1147 by Martin Pool
- split builtin commands into separate module bzrlib.builtins;
3814
4465.1.1 by Aaron Bentley
Refactor cmd_merge to allow supplying other forms of uncommitted changes.
3815
    def get_merger_from_uncommitted(self, tree, location, pb, cleanups):
3816
        """Get a merger for uncommitted changes.
3817
3818
        :param tree: The tree the merger should apply to.
3819
        :param location: The location containing uncommitted changes.
3820
        :param pb: The progress bar to use for showing progress.
3821
        :param cleanups: A list of operations to perform to clean up the
3822
            temporary directories, unfinalized objects, etc.
3823
        """
3824
        location = self._select_branch_location(tree, location)[0]
3825
        other_tree, other_path = WorkingTree.open_containing(location)
3826
        merger = _mod_merge.Merger.from_uncommitted(tree, other_tree, pb)
3827
        if other_path != '':
3828
            merger.interesting_files = [other_path]
3829
        return merger
3830
1551.20.2 by Aaron Bentley
Merge prefers submit branch, but falls back to parent branch
3831
    def _select_branch_location(self, tree, user_location, revision=None,
1551.15.74 by Aaron Bentley
Textual updates from review
3832
                                index=None):
3833
        """Select a branch location, according to possible inputs.
3834
3835
        If provided, branches from ``revision`` are preferred.  (Both
3836
        ``revision`` and ``index`` must be supplied.)
3837
3838
        Otherwise, the ``location`` parameter is used.  If it is None, then the
1551.20.2 by Aaron Bentley
Merge prefers submit branch, but falls back to parent branch
3839
        ``submit`` or ``parent`` location is used, and a note is printed.
1551.15.74 by Aaron Bentley
Textual updates from review
3840
3841
        :param tree: The working tree to select a branch for merging into
3842
        :param location: The location entered by the user
3843
        :param revision: The revision parameter to the command
3844
        :param index: The index to use for the revision parameter.  Negative
3845
            indices are permitted.
1551.20.2 by Aaron Bentley
Merge prefers submit branch, but falls back to parent branch
3846
        :return: (selected_location, user_location).  The default location
3847
            will be the user-entered location.
1551.15.74 by Aaron Bentley
Textual updates from review
3848
        """
1551.15.66 by Aaron Bentley
Improve behavior with revision ids
3849
        if (revision is not None and index is not None
3850
            and revision[index] is not None):
3851
            branch = revision[index].get_branch()
3852
            if branch is not None:
1551.20.2 by Aaron Bentley
Merge prefers submit branch, but falls back to parent branch
3853
                return branch, branch
3854
        if user_location is None:
3855
            location = self._get_remembered(tree, 'Merging from')
3856
        else:
3857
            location = user_location
3858
        return location, user_location
1551.15.66 by Aaron Bentley
Improve behavior with revision ids
3859
1551.20.2 by Aaron Bentley
Merge prefers submit branch, but falls back to parent branch
3860
    def _get_remembered(self, tree, verb_string):
1685.1.59 by Martin Pool
[broken] Fix up & refactor display of remembered urls to unescape properly
3861
        """Use tree.branch's parent if none was supplied.
3862
3863
        Report if the remembered location was used.
3864
        """
1551.20.2 by Aaron Bentley
Merge prefers submit branch, but falls back to parent branch
3865
        stored_location = tree.branch.get_submit_branch()
3596.3.1 by James Westby
Give the user a bit more information about which saved location is being used.
3866
        stored_location_type = "submit"
1551.20.2 by Aaron Bentley
Merge prefers submit branch, but falls back to parent branch
3867
        if stored_location is None:
3868
            stored_location = tree.branch.get_parent()
3596.3.1 by James Westby
Give the user a bit more information about which saved location is being used.
3869
            stored_location_type = "parent"
1685.1.71 by Wouter van Heyst
change branch.{get,set}_parent to store a relative path but return full urls
3870
        mutter("%s", stored_location)
1685.1.59 by Martin Pool
[broken] Fix up & refactor display of remembered urls to unescape properly
3871
        if stored_location is None:
1996.3.34 by John Arbash Meinel
Update builtins to use errors.foo. Now errors can be avoided entirely for a bzr rocks run
3872
            raise errors.BzrCommandError("No location specified or remembered")
3249.1.1 by Ian Clatworthy
fix merge redirection when using a remembered location
3873
        display_url = urlutils.unescape_for_display(stored_location, 'utf-8')
3596.3.1 by James Westby
Give the user a bit more information about which saved location is being used.
3874
        note(u"%s remembered %s location %s", verb_string,
3875
                stored_location_type, display_url)
1685.1.59 by Martin Pool
[broken] Fix up & refactor display of remembered urls to unescape properly
3876
        return stored_location
3877
1147 by Martin Pool
- split builtin commands into separate module bzrlib.builtins;
3878
1185.35.4 by Aaron Bentley
Implemented remerge
3879
class cmd_remerge(Command):
3880
    """Redo a merge.
1551.6.22 by Aaron Bentley
Improved help for remerge and merge
3881
3882
    Use this if you want to try a different merge technique while resolving
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
3883
    conflicts.  Some merge techniques are better than others, and remerge
1551.6.22 by Aaron Bentley
Improved help for remerge and merge
3884
    lets you try different ones on different files.
3885
3886
    The options for remerge have the same meaning and defaults as the ones for
3887
    merge.  The difference is that remerge can (only) be run when there is a
3888
    pending merge, and it lets you specify particular files.
3889
2666.1.1 by Ian Clatworthy
Bazaar User Reference generated from online help
3890
    :Examples:
1551.6.22 by Aaron Bentley
Improved help for remerge and merge
3891
        Re-do the merge of all conflicted files, and show the base text in
2666.1.1 by Ian Clatworthy
Bazaar User Reference generated from online help
3892
        conflict regions, in addition to the usual THIS and OTHER texts::
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
3893
2666.1.1 by Ian Clatworthy
Bazaar User Reference generated from online help
3894
            bzr remerge --show-base
1551.6.22 by Aaron Bentley
Improved help for remerge and merge
3895
3896
        Re-do the merge of "foobar", using the weave merge algorithm, with
2666.1.1 by Ian Clatworthy
Bazaar User Reference generated from online help
3897
        additional processing to reduce the size of conflict regions::
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
3898
2666.1.1 by Ian Clatworthy
Bazaar User Reference generated from online help
3899
            bzr remerge --merge-type weave --reprocess foobar
2374.1.1 by Ian Clatworthy
Help and man page fixes
3900
    """
1185.35.4 by Aaron Bentley
Implemented remerge
3901
    takes_args = ['file*']
2598.1.1 by Martin Pool
Add test for and documentation of option style, fix up existing options to comply
3902
    takes_options = [
3903
            'merge-type',
3904
            'reprocess',
3905
            Option('show-base',
3906
                   help="Show base revision text in conflicts."),
3907
            ]
1185.35.4 by Aaron Bentley
Implemented remerge
3908
3909
    def run(self, file_list=None, merge_type=None, show_base=False,
3910
            reprocess=False):
3911
        if merge_type is None:
1996.3.5 by John Arbash Meinel
Cleanup, deprecated, and get the tests passing again.
3912
            merge_type = _mod_merge.Merge3Merger
1508.1.15 by Robert Collins
Merge from mpool.
3913
        tree, file_list = tree_files(file_list)
3914
        tree.lock_write()
1185.35.4 by Aaron Bentley
Implemented remerge
3915
        try:
1908.6.8 by Robert Collins
Remove remerges dependence on pending_merges, also makes it simpler.
3916
            parents = tree.get_parent_ids()
3917
            if len(parents) != 2:
1996.3.34 by John Arbash Meinel
Update builtins to use errors.foo. Now errors can be avoided entirely for a bzr rocks run
3918
                raise errors.BzrCommandError("Sorry, remerge only works after normal"
3919
                                             " merges.  Not cherrypicking or"
3920
                                             " multi-merges.")
1185.67.2 by Aaron Bentley
Renamed Branch.storage to Branch.repository
3921
            repository = tree.branch.repository
1185.35.4 by Aaron Bentley
Implemented remerge
3922
            interesting_ids = None
1551.7.10 by Aaron Bentley
Remerge doesn't clear unrelated conflicts
3923
            new_conflicts = []
3924
            conflicts = tree.conflicts()
1185.35.4 by Aaron Bentley
Implemented remerge
3925
            if file_list is not None:
3926
                interesting_ids = set()
3927
                for filename in file_list:
1508.1.15 by Robert Collins
Merge from mpool.
3928
                    file_id = tree.path2id(filename)
1558.2.1 by Aaron Bentley
Ensure remerge errors when file-id is None
3929
                    if file_id is None:
1996.3.34 by John Arbash Meinel
Update builtins to use errors.foo. Now errors can be avoided entirely for a bzr rocks run
3930
                        raise errors.NotVersionedError(filename)
1185.35.4 by Aaron Bentley
Implemented remerge
3931
                    interesting_ids.add(file_id)
1508.1.15 by Robert Collins
Merge from mpool.
3932
                    if tree.kind(file_id) != "directory":
1185.35.4 by Aaron Bentley
Implemented remerge
3933
                        continue
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
3934
1508.1.15 by Robert Collins
Merge from mpool.
3935
                    for name, ie in tree.inventory.iter_entries(file_id):
1185.35.4 by Aaron Bentley
Implemented remerge
3936
                        interesting_ids.add(ie.file_id)
1551.7.10 by Aaron Bentley
Remerge doesn't clear unrelated conflicts
3937
                new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
2080.2.1 by John Arbash Meinel
Make 'bzr remerge' not use deprecated WorkingTree.iter_conflicts
3938
            else:
2080.2.3 by John Arbash Meinel
remerge only supports text or content conflicts
3939
                # Remerge only supports resolving contents conflicts
3940
                allowed_conflicts = ('text conflict', 'contents conflict')
3941
                restore_files = [c.path for c in conflicts
3942
                                 if c.typestring in allowed_conflicts]
1996.3.5 by John Arbash Meinel
Cleanup, deprecated, and get the tests passing again.
3943
            _mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
1551.7.10 by Aaron Bentley
Remerge doesn't clear unrelated conflicts
3944
            tree.set_conflicts(ConflictList(new_conflicts))
2080.2.1 by John Arbash Meinel
Make 'bzr remerge' not use deprecated WorkingTree.iter_conflicts
3945
            if file_list is not None:
1185.35.4 by Aaron Bentley
Implemented remerge
3946
                restore_files = file_list
3947
            for filename in restore_files:
3948
                try:
1508.1.15 by Robert Collins
Merge from mpool.
3949
                    restore(tree.abspath(filename))
1996.3.34 by John Arbash Meinel
Update builtins to use errors.foo. Now errors can be avoided entirely for a bzr rocks run
3950
                except errors.NotConflicted:
1185.35.4 by Aaron Bentley
Implemented remerge
3951
                    pass
1551.15.52 by Aaron Bentley
Tweak from review comments
3952
            # Disable pending merges, because the file texts we are remerging
3953
            # have not had those merges performed.  If we use the wrong parents
3954
            # list, we imply that the working tree text has seen and rejected
3955
            # all the changes from the other tree, when in fact those changes
3956
            # have not yet been seen.
3062.2.8 by Aaron Bentley
Update remerge to use Merger.from_revision_ids
3957
            pb = ui.ui_factory.nested_progress_bar()
1551.15.53 by Aaron Bentley
Restore old method of adjusting partents
3958
            tree.set_parent_ids(parents[:1])
1551.15.47 by Aaron Bentley
Fix remerge --weave
3959
            try:
3062.2.8 by Aaron Bentley
Update remerge to use Merger.from_revision_ids
3960
                merger = _mod_merge.Merger.from_revision_ids(pb,
3961
                                                             tree, parents[1])
3962
                merger.interesting_ids = interesting_ids
3963
                merger.merge_type = merge_type
3964
                merger.show_base = show_base
3965
                merger.reprocess = reprocess
3966
                conflicts = merger.do_merge()
1551.15.47 by Aaron Bentley
Fix remerge --weave
3967
            finally:
1551.15.53 by Aaron Bentley
Restore old method of adjusting partents
3968
                tree.set_parent_ids(parents)
3062.2.8 by Aaron Bentley
Update remerge to use Merger.from_revision_ids
3969
                pb.finished()
1185.35.4 by Aaron Bentley
Implemented remerge
3970
        finally:
1508.1.15 by Robert Collins
Merge from mpool.
3971
            tree.unlock()
1185.35.4 by Aaron Bentley
Implemented remerge
3972
        if conflicts > 0:
3973
            return 1
3974
        else:
3975
            return 0
3976
2023.1.1 by ghigo
add topics help
3977
1147 by Martin Pool
- split builtin commands into separate module bzrlib.builtins;
3978
class cmd_revert(Command):
1551.8.27 by Aaron Bentley
Update docs again
3979
    """Revert files to a previous revision.
1147 by Martin Pool
- split builtin commands into separate module bzrlib.builtins;
3980
1551.8.27 by Aaron Bentley
Update docs again
3981
    Giving a list of files will revert only those files.  Otherwise, all files
3982
    will be reverted.  If the revision is not specified with '--revision', the
3983
    last committed revision is used.
1551.8.26 by Aaron Bentley
Update revert help text
3984
3985
    To remove only some changes, without reverting to a prior version, use
3026.1.1 by Nicholas Allen
Fix small typo in command description for the revert command.
3986
    merge instead.  For example, "merge . --revision -2..-3" will remove the
3987
    changes introduced by -2, without affecting the changes introduced by -1.
3988
    Or to remove certain changes on a hunk-by-hunk basis, see the Shelf plugin.
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
3989
1551.8.26 by Aaron Bentley
Update revert help text
3990
    By default, any files that have been manually changed will be backed up
3991
    first.  (Files changed only by merge are not backed up.)  Backup files have
1551.8.27 by Aaron Bentley
Update docs again
3992
    '.~#~' appended to their name, where # is a number.
3993
3994
    When you provide files, you can use their current pathname or the pathname
3995
    from the target revision.  So you can use revert to "undelete" a file by
3996
    name.  If you name a directory, all the contents of that directory will be
3997
    reverted.
2614.1.1 by Martin Pool
Doc for revert, #87548
3998
3999
    Any files that have been newly added since that revision will be deleted,
4000
    with a backup kept if appropriate.  Directories containing unknown files
4001
    will not be deleted.
2911.2.1 by Martin Pool
Better help for revert
4002
4003
    The working tree contains a list of pending merged revisions, which will
4004
    be included as parents in the next commit.  Normally, revert clears that
3006.1.1 by Adeodato Simó
Fix typos in revert's help.
4005
    list as well as reverting the files.  If any files are specified, revert
4006
    leaves the pending merge list alone and reverts only the files.  Use "bzr
2911.2.1 by Martin Pool
Better help for revert
4007
    revert ." in the tree root to revert all files but keep the merge record,
4008
    and "bzr revert --forget-merges" to clear the pending merge list without
4009
    reverting any files.
1147 by Martin Pool
- split builtin commands into separate module bzrlib.builtins;
4010
    """
2425.2.3 by Robert Collins
Update existing builtin commands help text to use _see_also. (Robert Collins)
4011
4012
    _see_also = ['cat', 'export']
2598.1.6 by Martin Pool
Add help for --no-backup
4013
    takes_options = [
2851.2.1 by Martin Pool
Add revert --forget-merges
4014
        'revision',
4015
        Option('no-backup', "Do not save backups of reverted files."),
4016
        Option('forget-merges',
4017
               'Remove pending merge marker, without changing any files.'),
4018
        ]
1147 by Martin Pool
- split builtin commands into separate module bzrlib.builtins;
4019
    takes_args = ['file*']
4020
2851.2.1 by Martin Pool
Add revert --forget-merges
4021
    def run(self, revision=None, no_backup=False, file_list=None,
4022
            forget_merges=None):
1185.50.53 by John Arbash Meinel
[patch] Aaron Bentley: make revert work in a subdirectory.
4023
        tree, file_list = tree_files(file_list)
3737.2.1 by John Arbash Meinel
Take out a write lock right away for 'bzr revert'
4024
        tree.lock_write()
4025
        try:
4026
            if forget_merges:
4027
                tree.set_parent_ids(tree.get_parent_ids()[:1])
4028
            else:
4029
                self._revert_tree_to_revision(tree, revision, file_list, no_backup)
4030
        finally:
4031
            tree.unlock()
2851.2.1 by Martin Pool
Add revert --forget-merges
4032
4033
    @staticmethod
4034
    def _revert_tree_to_revision(tree, revision, file_list, no_backup):
3732.1.1 by Ian Clatworthy
fix bzr st -rbranch:path-to-branch (Lukas Lalinsky)
4035
        rev_tree = _get_one_revision_tree('revert', revision, tree=tree)
1773.4.1 by Martin Pool
Add pyflakes makefile target; fix many warnings
4036
        pb = ui.ui_factory.nested_progress_bar()
1551.2.25 by Aaron Bentley
Stop using deprecated methods in merge and revert
4037
        try:
3655.3.1 by Lukáš Lalinský
Fix `bzr st -rbranch:PATH_TO_BRANCH`
4038
            tree.revert(file_list, rev_tree, not no_backup, pb,
4039
                report_changes=True)
1551.2.25 by Aaron Bentley
Stop using deprecated methods in merge and revert
4040
        finally:
4041
            pb.finished()
1147 by Martin Pool
- split builtin commands into separate module bzrlib.builtins;
4042
4043
4044
class cmd_assert_fail(Command):
4045
    """Test reporting of assertion failures"""
2090.2.1 by Martin Pool
Fix some code which relies on assertions and breaks under python -O
4046
    # intended just for use in testing
4047
1147 by Martin Pool
- split builtin commands into separate module bzrlib.builtins;
4048
    hidden = True
2090.2.1 by Martin Pool
Fix some code which relies on assertions and breaks under python -O
4049
1147 by Martin Pool
- split builtin commands into separate module bzrlib.builtins;
4050
    def run(self):
2090.2.1 by Martin Pool
Fix some code which relies on assertions and breaks under python -O
4051
        raise AssertionError("always fails")
1147 by Martin Pool
- split builtin commands into separate module bzrlib.builtins;
4052
4053
4054
class cmd_help(Command):
4055
    """Show help on a command or other topic.
2425.2.3 by Robert Collins
Update existing builtin commands help text to use _see_also. (Robert Collins)
4056
    """
1147 by Martin Pool
- split builtin commands into separate module bzrlib.builtins;
4057
2425.2.3 by Robert Collins
Update existing builtin commands help text to use _see_also. (Robert Collins)
4058
    _see_also = ['topics']
2598.1.1 by Martin Pool
Add test for and documentation of option style, fix up existing options to comply
4059
    takes_options = [
4060
            Option('long', 'Show help on all commands.'),
4061
            ]
1147 by Martin Pool
- split builtin commands into separate module bzrlib.builtins;
4062
    takes_args = ['topic?']
1616.1.15 by Martin Pool
Handle 'bzr ?', etc.
4063
    aliases = ['?', '--help', '-?', '-h']
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
4064
1185.12.56 by Aaron Bentley
Prevented display commands from printing broken pipe errors
4065
    @display_command
3984.4.5 by Ian Clatworthy
help xxx is full help; xxx -h is concise help
4066
    def run(self, topic=None, long=False):
2023.1.1 by ghigo
add topics help
4067
        import bzrlib.help
1147 by Martin Pool
- split builtin commands into separate module bzrlib.builtins;
4068
        if topic is None and long:
4069
            topic = "commands"
3984.4.5 by Ian Clatworthy
help xxx is full help; xxx -h is concise help
4070
        bzrlib.help.help(topic)
1147 by Martin Pool
- split builtin commands into separate module bzrlib.builtins;
4071
4072
4073
class cmd_shell_complete(Command):
4074
    """Show appropriate completions for context.
4075
2023.1.1 by ghigo
add topics help
4076
    For a list of all available commands, say 'bzr shell-complete'.
4077
    """
1147 by Martin Pool
- split builtin commands into separate module bzrlib.builtins;
4078
    takes_args = ['context?']
4079
    aliases = ['s-c']
4080
    hidden = True
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
4081
1185.12.56 by Aaron Bentley
Prevented display commands from printing broken pipe errors
4082
    @display_command
1147 by Martin Pool
- split builtin commands into separate module bzrlib.builtins;
4083
    def run(self, context=None):
4084
        import shellcomplete
4085
        shellcomplete.shellcomplete(context)
4086
4087
4088
class cmd_missing(Command):
1185.54.3 by Aaron Bentley
Factored out find_unmerged
4089
    """Show unmerged/unpulled revisions between two branches.
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
4090
2023.1.1 by ghigo
add topics help
4091
    OTHER_BRANCH may be local or remote.
3921.3.12 by Marius Kruger
add missing examples and NEWS
4092
4156.1.1 by Vincent Ladeuil
Trivial spelling correction to "bzr missing" documentation
4093
    To filter on a range of revisions, you can use the command -r begin..end
3921.3.13 by Marius Kruger
update missing documentation and blackbox test to better reflect `-r 3` behaviour.
4094
    -r revision requests a specific revision, -r ..end or -r begin.. are
4095
    also valid.
4096
3921.3.12 by Marius Kruger
add missing examples and NEWS
4097
    :Examples:
4098
4099
        Determine the missing revisions between this and the branch at the
4100
        remembered pull location::
4101
4102
            bzr missing
4103
4104
        Determine the missing revisions between this and another branch::
4105
4106
            bzr missing http://server/branch
4107
4108
        Determine the missing revisions up to a specific revision on the other
4109
        branch::
4110
4111
            bzr missing -r ..-10
4112
4113
        Determine the missing revisions up to a specific revision on this
4114
        branch::
4115
4116
            bzr missing --my-revision ..-10
2023.1.1 by ghigo
add topics help
4117
    """
2425.2.3 by Robert Collins
Update existing builtin commands help text to use _see_also. (Robert Collins)
4118
4119
    _see_also = ['merge', 'pull']
1185.54.1 by Aaron Bentley
Import Kinnison's plugin
4120
    takes_args = ['other_branch?']
2598.1.1 by Martin Pool
Add test for and documentation of option style, fix up existing options to comply
4121
    takes_options = [
3921.3.6 by Marius Kruger
* fix some indentation anomalies in cmd_missing
4122
        Option('reverse', 'Reverse the order of revisions.'),
4123
        Option('mine-only',
4124
               'Display changes in the local branch only.'),
4125
        Option('this' , 'Same as --mine-only.'),
4126
        Option('theirs-only',
4127
               'Display changes in the remote branch only.'),
4128
        Option('other', 'Same as --theirs-only.'),
4129
        'log-format',
4130
        'show-ids',
4131
        'verbose',
4132
        custom_help('revision',
3921.3.11 by Marius Kruger
swap options as per review:
4133
             help='Filter on other branch revisions (inclusive). '
3921.3.6 by Marius Kruger
* fix some indentation anomalies in cmd_missing
4134
                'See "help revisionspec" for details.'),
3921.3.11 by Marius Kruger
swap options as per review:
4135
        Option('my-revision',
3921.3.6 by Marius Kruger
* fix some indentation anomalies in cmd_missing
4136
            type=_parse_revision_str,
3921.3.11 by Marius Kruger
swap options as per review:
4137
            help='Filter on local branch revisions (inclusive). '
3921.3.6 by Marius Kruger
* fix some indentation anomalies in cmd_missing
4138
                'See "help revisionspec" for details.'),
4221.1.1 by Vincent Ladeuil
Clarify 'missing --include-merges' help.
4139
        Option('include-merges',
4140
               'Show all revisions in addition to the mainline ones.'),
3921.3.6 by Marius Kruger
* fix some indentation anomalies in cmd_missing
4141
        ]
1816.1.2 by Alexander Belchenko
fix non-ascii messages handling in 'missing' command
4142
    encoding_type = 'replace'
1185.54.1 by Aaron Bentley
Import Kinnison's plugin
4143
1816.1.2 by Alexander Belchenko
fix non-ascii messages handling in 'missing' command
4144
    @display_command
1185.54.1 by Aaron Bentley
Import Kinnison's plugin
4145
    def run(self, other_branch=None, reverse=False, mine_only=False,
3677.1.1 by Vincent Ladeuil
Begin fixing bug #233817.
4146
            theirs_only=False,
4147
            log_format=None, long=False, short=False, line=False,
4148
            show_ids=False, verbose=False, this=False, other=False,
3921.3.11 by Marius Kruger
swap options as per review:
4149
            include_merges=False, revision=None, my_revision=None):
2466.8.1 by Kent Gibson
Reworked LogFormatter API to simplify extending the attributes of the revision being logged. Added support for begin_log() and end_log() hooks in LogFormatters.
4150
        from bzrlib.missing import find_unmerged, iter_log_revisions
3778.5.1 by Martin Pool
missing -q is quieter (#284748)
4151
        def message(s):
4152
            if not is_quiet():
4153
                self.outf.write(s)
2528.1.1 by Martin Pool
Better option names for missing (elliot)
4154
4155
        if this:
3427.3.3 by John Arbash Meinel
Revert cmd_missing to use the original function, only now supply restrict
4156
            mine_only = this
2528.1.1 by Martin Pool
Better option names for missing (elliot)
4157
        if other:
3427.3.3 by John Arbash Meinel
Revert cmd_missing to use the original function, only now supply restrict
4158
            theirs_only = other
4159
        # TODO: We should probably check that we don't have mine-only and
4160
        #       theirs-only set, but it gets complicated because we also have
4161
        #       this and other which could be used.
4162
        restrict = 'all'
4163
        if mine_only:
4164
            restrict = 'local'
4165
        elif theirs_only:
4166
            restrict = 'remote'
2528.1.1 by Martin Pool
Better option names for missing (elliot)
4167
1773.4.1 by Martin Pool
Add pyflakes makefile target; fix many warnings
4168
        local_branch = Branch.open_containing(u".")[0]
1185.54.16 by Aaron Bentley
fixed location handling to match old missing
4169
        parent = local_branch.get_parent()
1185.54.1 by Aaron Bentley
Import Kinnison's plugin
4170
        if other_branch is None:
1185.54.16 by Aaron Bentley
fixed location handling to match old missing
4171
            other_branch = parent
4172
            if other_branch is None:
2485.8.11 by Vincent Ladeuil
Fix some display leaks in tests.
4173
                raise errors.BzrCommandError("No peer location known"
2485.8.17 by Vincent Ladeuil
Fix the fix.
4174
                                             " or specified.")
2193.4.1 by Alexander Belchenko
'bzr missing' without specifying location show remembered location unescaped
4175
            display_url = urlutils.unescape_for_display(parent,
4176
                                                        self.outf.encoding)
3778.5.1 by Martin Pool
missing -q is quieter (#284748)
4177
            message("Using saved parent location: "
3596.3.1 by James Westby
Give the user a bit more information about which saved location is being used.
4178
                    + display_url + "\n")
2193.4.1 by Alexander Belchenko
'bzr missing' without specifying location show remembered location unescaped
4179
1773.4.1 by Martin Pool
Add pyflakes makefile target; fix many warnings
4180
        remote_branch = Branch.open(other_branch)
1551.2.46 by abentley
Made bzr missing . work on win32
4181
        if remote_branch.base == local_branch.base:
4182
            remote_branch = local_branch
3921.3.4 by Marius Kruger
add support to filter on local and remote revisions
4183
4184
        local_revid_range = _revision_range_to_revid_range(
3921.3.11 by Marius Kruger
swap options as per review:
4185
            _get_revision_range(my_revision, local_branch,
3921.3.9 by Marius Kruger
* add some blackbox tests and another whitebox test
4186
                self.name()))
3921.3.4 by Marius Kruger
add support to filter on local and remote revisions
4187
4188
        remote_revid_range = _revision_range_to_revid_range(
3921.3.11 by Marius Kruger
swap options as per review:
4189
            _get_revision_range(revision,
3921.3.9 by Marius Kruger
* add some blackbox tests and another whitebox test
4190
                remote_branch, self.name()))
3921.3.4 by Marius Kruger
add support to filter on local and remote revisions
4191
1666.1.5 by Robert Collins
Merge bound branch test performance improvements.
4192
        local_branch.lock_read()
1594.3.6 by Robert Collins
Take out appropriate locks for missing.
4193
        try:
1551.2.46 by abentley
Made bzr missing . work on win32
4194
            remote_branch.lock_read()
1594.3.6 by Robert Collins
Take out appropriate locks for missing.
4195
            try:
3427.3.3 by John Arbash Meinel
Revert cmd_missing to use the original function, only now supply restrict
4196
                local_extra, remote_extra = find_unmerged(
3677.1.1 by Vincent Ladeuil
Begin fixing bug #233817.
4197
                    local_branch, remote_branch, restrict,
3677.1.4 by Vincent Ladeuil
Replace 'reverse' by 'backward' when talking about revision order.
4198
                    backward=not reverse,
3921.3.3 by Marius Kruger
tried to add `bzr missing -r1..-1` but failed :(
4199
                    include_merges=include_merges,
3921.3.4 by Marius Kruger
add support to filter on local and remote revisions
4200
                    local_revid_range=local_revid_range,
3921.3.6 by Marius Kruger
* fix some indentation anomalies in cmd_missing
4201
                    remote_revid_range=remote_revid_range)
3427.3.1 by John Arbash Meinel
Add bzrlib.missing.find_unmerged_mainline_revisions
4202
2485.8.11 by Vincent Ladeuil
Fix some display leaks in tests.
4203
                if log_format is None:
4204
                    registry = log.log_formatter_registry
4205
                    log_format = registry.get_default(local_branch)
2221.4.10 by Aaron Bentley
Implement log options using RegistryOption
4206
                lf = log_format(to_file=self.outf,
4207
                                show_ids=show_ids,
4208
                                show_timezone='original')
3427.3.7 by John Arbash Meinel
Update how 'bzr missing' works when given --mine-only or --theirs-only
4209
4210
                status_code = 0
1594.3.6 by Robert Collins
Take out appropriate locks for missing.
4211
                if local_extra and not theirs_only:
3778.5.1 by Martin Pool
missing -q is quieter (#284748)
4212
                    message("You have %d extra revision(s):\n" %
3778.5.2 by Martin Pool
review cleanups
4213
                        len(local_extra))
2485.8.13 by Vincent Ladeuil
merge bzr.dev@2495
4214
                    for revision in iter_log_revisions(local_extra,
2466.8.1 by Kent Gibson
Reworked LogFormatter API to simplify extending the attributes of the revision being logged. Added support for begin_log() and end_log() hooks in LogFormatters.
4215
                                        local_branch.repository,
4216
                                        verbose):
4217
                        lf.log_revision(revision)
1594.3.6 by Robert Collins
Take out appropriate locks for missing.
4218
                    printed_local = True
3427.3.7 by John Arbash Meinel
Update how 'bzr missing' works when given --mine-only or --theirs-only
4219
                    status_code = 1
1594.3.6 by Robert Collins
Take out appropriate locks for missing.
4220
                else:
4221
                    printed_local = False
3427.3.7 by John Arbash Meinel
Update how 'bzr missing' works when given --mine-only or --theirs-only
4222
1594.3.6 by Robert Collins
Take out appropriate locks for missing.
4223
                if remote_extra and not mine_only:
4224
                    if printed_local is True:
3778.5.1 by Martin Pool
missing -q is quieter (#284748)
4225
                        message("\n\n\n")
4226
                    message("You are missing %d revision(s):\n" %
3778.5.2 by Martin Pool
review cleanups
4227
                        len(remote_extra))
2485.8.13 by Vincent Ladeuil
merge bzr.dev@2495
4228
                    for revision in iter_log_revisions(remote_extra,
4229
                                        remote_branch.repository,
2466.8.1 by Kent Gibson
Reworked LogFormatter API to simplify extending the attributes of the revision being logged. Added support for begin_log() and end_log() hooks in LogFormatters.
4230
                                        verbose):
4231
                        lf.log_revision(revision)
3427.3.7 by John Arbash Meinel
Update how 'bzr missing' works when given --mine-only or --theirs-only
4232
                    status_code = 1
4233
4234
                if mine_only and not local_extra:
4235
                    # We checked local, and found nothing extra
3778.5.1 by Martin Pool
missing -q is quieter (#284748)
4236
                    message('This branch is up to date.\n')
3427.3.7 by John Arbash Meinel
Update how 'bzr missing' works when given --mine-only or --theirs-only
4237
                elif theirs_only and not remote_extra:
4238
                    # We checked remote, and found nothing extra
3778.5.1 by Martin Pool
missing -q is quieter (#284748)
4239
                    message('Other branch is up to date.\n')
3427.3.7 by John Arbash Meinel
Update how 'bzr missing' works when given --mine-only or --theirs-only
4240
                elif not (mine_only or theirs_only or local_extra or
4241
                          remote_extra):
4242
                    # We checked both branches, and neither one had extra
4243
                    # revisions
3778.5.1 by Martin Pool
missing -q is quieter (#284748)
4244
                    message("Branches are up to date.\n")
1594.3.6 by Robert Collins
Take out appropriate locks for missing.
4245
            finally:
1666.1.5 by Robert Collins
Merge bound branch test performance improvements.
4246
                remote_branch.unlock()
4247
        finally:
4248
            local_branch.unlock()
4249
        if not status_code and parent is None and other_branch is not None:
4250
            local_branch.lock_write()
4251
            try:
4252
                # handle race conditions - a parent might be set while we run.
4253
                if local_branch.get_parent() is None:
1685.1.19 by John Arbash Meinel
pull/merge/branch/missing should all save the absolute path to the other branch, not the relative one
4254
                    local_branch.set_parent(remote_branch.base)
1594.3.6 by Robert Collins
Take out appropriate locks for missing.
4255
            finally:
4256
                local_branch.unlock()
1666.1.5 by Robert Collins
Merge bound branch test performance improvements.
4257
        return status_code
1147 by Martin Pool
- split builtin commands into separate module bzrlib.builtins;
4258
4259
2604.2.1 by Robert Collins
(robertc) Introduce a pack command.
4260
class cmd_pack(Command):
4261
    """Compress the data within a repository."""
4262
4263
    _see_also = ['repositories']
4264
    takes_args = ['branch_or_repo?']
4265
4266
    def run(self, branch_or_repo='.'):
4267
        dir = bzrdir.BzrDir.open_containing(branch_or_repo)[0]
4268
        try:
4269
            branch = dir.open_branch()
4270
            repository = branch.repository
4271
        except errors.NotBranchError:
4272
            repository = dir.open_repository()
4273
        repository.pack()
4274
4275
1147 by Martin Pool
- split builtin commands into separate module bzrlib.builtins;
4276
class cmd_plugins(Command):
2617.3.1 by Ian Clatworthy
Make the plugins command public with better help
4277
    """List the installed plugins.
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
4278
3193.2.3 by Alexander Belchenko
another formatting variant suggested by John Meinel.
4279
    This command displays the list of installed plugins including
4280
    version of plugin and a short description of each.
4281
4282
    --verbose shows the path where each plugin is located.
2617.3.1 by Ian Clatworthy
Make the plugins command public with better help
4283
4284
    A plugin is an external component for Bazaar that extends the
4285
    revision control system, by adding or replacing code in Bazaar.
4286
    Plugins can do a variety of things, including overriding commands,
4287
    adding new commands, providing additional network transports and
4288
    customizing log output.
4289
4290
    See the Bazaar web site, http://bazaar-vcs.org, for further
4291
    information on plugins including where to find them and how to
4292
    install them. Instructions are also provided there on how to
4293
    write new plugins using the Python programming language.
4294
    """
3193.2.3 by Alexander Belchenko
another formatting variant suggested by John Meinel.
4295
    takes_options = ['verbose']
2629.1.1 by Ian Clatworthy
(Ian Clatworthy) Tweak the 'make plugins public' change following feedback from lifeless
4296
1185.12.56 by Aaron Bentley
Prevented display commands from printing broken pipe errors
4297
    @display_command
3193.2.3 by Alexander Belchenko
another formatting variant suggested by John Meinel.
4298
    def run(self, verbose=False):
1147 by Martin Pool
- split builtin commands into separate module bzrlib.builtins;
4299
        import bzrlib.plugin
4300
        from inspect import getdoc
3193.2.2 by Alexander Belchenko
new formatting of `bzr plugins` output.
4301
        result = []
2762.2.1 by Robert Collins
* ``bzr plugins`` now lists the version number for each plugin in square
4302
        for name, plugin in bzrlib.plugin.plugins().items():
3193.2.2 by Alexander Belchenko
new formatting of `bzr plugins` output.
4303
            version = plugin.__version__
4304
            if version == 'unknown':
4305
                version = ''
4306
            name_ver = '%s %s' % (name, version)
2762.2.1 by Robert Collins
* ``bzr plugins`` now lists the version number for each plugin in square
4307
            d = getdoc(plugin.module)
1147 by Martin Pool
- split builtin commands into separate module bzrlib.builtins;
4308
            if d:
3193.2.2 by Alexander Belchenko
new formatting of `bzr plugins` output.
4309
                doc = d.split('\n')[0]
4310
            else:
4311
                doc = '(no description)'
4312
            result.append((name_ver, doc, plugin.path()))
3193.2.3 by Alexander Belchenko
another formatting variant suggested by John Meinel.
4313
        for name_ver, doc, path in sorted(result):
4314
            print name_ver
4315
            print '   ', doc
4316
            if verbose:
4317
                print '   ', path
4318
            print
1147 by Martin Pool
- split builtin commands into separate module bzrlib.builtins;
4319
4320
1185.16.24 by Martin Pool
- add and test 'testament' builtin command
4321
class cmd_testament(Command):
4322
    """Show testament (signing-form) of a revision."""
2598.1.1 by Martin Pool
Add test for and documentation of option style, fix up existing options to comply
4323
    takes_options = [
4324
            'revision',
4325
            Option('long', help='Produce long-format testament.'),
4326
            Option('strict',
4327
                   help='Produce a strict-format testament.')]
1185.16.24 by Martin Pool
- add and test 'testament' builtin command
4328
    takes_args = ['branch?']
1185.12.56 by Aaron Bentley
Prevented display commands from printing broken pipe errors
4329
    @display_command
1551.7.1 by Aaron Bentley
Implement --strict at commandline, fix up strict format
4330
    def run(self, branch=u'.', revision=None, long=False, strict=False):
4331
        from bzrlib.testament import Testament, StrictTestament
4332
        if strict is True:
4333
            testament_class = StrictTestament
4334
        else:
4335
            testament_class = Testament
3530.2.1 by John Arbash Meinel
'bzr testament' should just open the branch
4336
        if branch == '.':
4337
            b = Branch.open_containing(branch)[0]
4338
        else:
4339
            b = Branch.open(branch)
1185.16.24 by Martin Pool
- add and test 'testament' builtin command
4340
        b.lock_read()
4341
        try:
4342
            if revision is None:
4343
                rev_id = b.last_revision()
4344
            else:
3298.2.8 by John Arbash Meinel
Get rid of .in_branch(need_revno=False) in favor of simpler .as_revision_id()
4345
                rev_id = revision[0].as_revision_id(b)
1551.7.1 by Aaron Bentley
Implement --strict at commandline, fix up strict format
4346
            t = testament_class.from_revision(b.repository, rev_id)
1185.16.24 by Martin Pool
- add and test 'testament' builtin command
4347
            if long:
4348
                sys.stdout.writelines(t.as_text_lines())
4349
            else:
4350
                sys.stdout.write(t.as_short_text())
4351
        finally:
4352
            b.unlock()
1185.16.32 by Martin Pool
- add a basic annotate built-in command
4353
4354
4355
class cmd_annotate(Command):
4356
    """Show the origin of each line in a file.
4357
1185.16.53 by Martin Pool
- annotate improvements from Goffreddo, with extra bug fixes and tests
4358
    This prints out the given file with an annotation on the left side
4359
    indicating which revision, author and date introduced the change.
4360
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
4361
    If the origin is the same for a run of consecutive lines, it is
1185.16.53 by Martin Pool
- annotate improvements from Goffreddo, with extra bug fixes and tests
4362
    shown only at the top, unless the --all option is given.
1185.16.32 by Martin Pool
- add a basic annotate built-in command
4363
    """
4364
    # TODO: annotate directories; showing when each file was last changed
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
4365
    # TODO: if the working copy is modified, show annotations on that
1185.16.53 by Martin Pool
- annotate improvements from Goffreddo, with extra bug fixes and tests
4366
    #       with new uncommitted lines marked
1733.2.8 by Michael Ellerman
Add CVS compatible aliases for checkout and annotate, from fullermd.
4367
    aliases = ['ann', 'blame', 'praise']
1185.16.32 by Martin Pool
- add a basic annotate built-in command
4368
    takes_args = ['filename']
2598.1.1 by Martin Pool
Add test for and documentation of option style, fix up existing options to comply
4369
    takes_options = [Option('all', help='Show annotations on all lines.'),
4370
                     Option('long', help='Show commit date in annotations.'),
2182.3.1 by John Arbash Meinel
Annotate now shows dotted revnos instead of plain revnos.
4371
                     'revision',
4372
                     'show-ids',
1185.16.53 by Martin Pool
- annotate improvements from Goffreddo, with extra bug fixes and tests
4373
                     ]
2593.1.1 by Adeodato Simó
Improve annotate to prevent unicode exceptions in certain situations.
4374
    encoding_type = 'exact'
1185.16.32 by Martin Pool
- add a basic annotate built-in command
4375
1185.12.56 by Aaron Bentley
Prevented display commands from printing broken pipe errors
4376
    @display_command
2182.3.1 by John Arbash Meinel
Annotate now shows dotted revnos instead of plain revnos.
4377
    def run(self, filename, all=False, long=False, revision=None,
4378
            show_ids=False):
3603.4.1 by Robert Collins
Implement lookups into the current working tree for bzr annotate, fixing bug 3439.
4379
        from bzrlib.annotate import annotate_file, annotate_file_tree
3146.2.1 by Lukáš Lalinský
Don't require a working tree in cmd_annotate.
4380
        wt, branch, relpath = \
4381
            bzrdir.BzrDir.open_containing_tree_or_branch(filename)
4382
        if wt is not None:
4383
            wt.lock_read()
4384
        else:
4385
            branch.lock_read()
1185.16.32 by Martin Pool
- add a basic annotate built-in command
4386
        try:
3732.1.1 by Ian Clatworthy
fix bzr st -rbranch:path-to-branch (Lukas Lalinsky)
4387
            tree = _get_one_revision_tree('annotate', revision, branch=branch)
3146.2.1 by Lukáš Lalinský
Don't require a working tree in cmd_annotate.
4388
            if wt is not None:
4389
                file_id = wt.path2id(relpath)
4390
            else:
4391
                file_id = tree.path2id(relpath)
2561.2.1 by James Westby
Display a useful error message when annotating a non-existant file (#122656)
4392
            if file_id is None:
2561.2.2 by James Westby
Fix up with comments from Aaron.
4393
                raise errors.NotVersionedError(filename)
1185.16.32 by Martin Pool
- add a basic annotate built-in command
4394
            file_version = tree.inventory[file_id].revision
3603.4.1 by Robert Collins
Implement lookups into the current working tree for bzr annotate, fixing bug 3439.
4395
            if wt is not None and revision is None:
4396
                # If there is a tree and we're not annotating historical
4397
                # versions, annotate the working tree's content.
4398
                annotate_file_tree(wt, file_id, self.outf, long, all,
4399
                    show_ids=show_ids)
4400
            else:
4401
                annotate_file(branch, file_version, file_id, long, all, self.outf,
4402
                              show_ids=show_ids)
1185.16.32 by Martin Pool
- add a basic annotate built-in command
4403
        finally:
3146.2.1 by Lukáš Lalinský
Don't require a working tree in cmd_annotate.
4404
            if wt is not None:
4405
                wt.unlock()
4406
            else:
4407
                branch.unlock()
1185.16.33 by Martin Pool
- move 'conflict' and 'resolved' from shipped plugin to regular builtins
4408
1442.1.59 by Robert Collins
Add re-sign command to generate a digital signature on a single revision.
4409
4410
class cmd_re_sign(Command):
4411
    """Create a digital signature for an existing revision."""
4412
    # TODO be able to replace existing ones.
4413
4414
    hidden = True # is this right ?
1185.78.1 by John Arbash Meinel
Updating bzr re-sign to allow multiple arguments, and updating tests
4415
    takes_args = ['revision_id*']
1442.1.59 by Robert Collins
Add re-sign command to generate a digital signature on a single revision.
4416
    takes_options = ['revision']
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
4417
1185.78.1 by John Arbash Meinel
Updating bzr re-sign to allow multiple arguments, and updating tests
4418
    def run(self, revision_id_list=None, revision=None):
4419
        if revision_id_list is not None and revision is not None:
1996.3.34 by John Arbash Meinel
Update builtins to use errors.foo. Now errors can be avoided entirely for a bzr rocks run
4420
            raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
1185.78.1 by John Arbash Meinel
Updating bzr re-sign to allow multiple arguments, and updating tests
4421
        if revision_id_list is None and revision is None:
1996.3.34 by John Arbash Meinel
Update builtins to use errors.foo. Now errors can be avoided entirely for a bzr rocks run
4422
            raise errors.BzrCommandError('You must supply either --revision or a revision_id')
1185.33.66 by Martin Pool
[patch] use unicode literals for all hardcoded paths (Alexander Belchenko)
4423
        b = WorkingTree.open_containing(u'.')[0].branch
3010.1.17 by Robert Collins
Lock correctness and commit_group management for re-sign, in builtins.
4424
        b.lock_write()
4425
        try:
4426
            return self._run(b, revision_id_list, revision)
4427
        finally:
4428
            b.unlock()
4429
4430
    def _run(self, b, revision_id_list, revision):
4431
        import bzrlib.gpg as gpg
1770.2.9 by Aaron Bentley
Add Branch.get_config, update BranchConfig() callers
4432
        gpg_strategy = gpg.GPGStrategy(b.get_config())
1185.78.1 by John Arbash Meinel
Updating bzr re-sign to allow multiple arguments, and updating tests
4433
        if revision_id_list is not None:
3010.1.17 by Robert Collins
Lock correctness and commit_group management for re-sign, in builtins.
4434
            b.repository.start_write_group()
4435
            try:
4436
                for revision_id in revision_id_list:
4437
                    b.repository.sign_revision(revision_id, gpg_strategy)
4438
            except:
4439
                b.repository.abort_write_group()
4440
                raise
4441
            else:
4442
                b.repository.commit_write_group()
1442.1.59 by Robert Collins
Add re-sign command to generate a digital signature on a single revision.
4443
        elif revision is not None:
1483 by Robert Collins
BUGFIX: re-sign should accept ranges
4444
            if len(revision) == 1:
4445
                revno, rev_id = revision[0].in_history(b)
3010.1.17 by Robert Collins
Lock correctness and commit_group management for re-sign, in builtins.
4446
                b.repository.start_write_group()
4447
                try:
4448
                    b.repository.sign_revision(rev_id, gpg_strategy)
4449
                except:
4450
                    b.repository.abort_write_group()
4451
                    raise
4452
                else:
4453
                    b.repository.commit_write_group()
1483 by Robert Collins
BUGFIX: re-sign should accept ranges
4454
            elif len(revision) == 2:
4455
                # are they both on rh- if so we can walk between them
4456
                # might be nice to have a range helper for arbitrary
4457
                # revision paths. hmm.
4458
                from_revno, from_revid = revision[0].in_history(b)
4459
                to_revno, to_revid = revision[1].in_history(b)
4460
                if to_revid is None:
4461
                    to_revno = b.revno()
4462
                if from_revno is None or to_revno is None:
1996.3.34 by John Arbash Meinel
Update builtins to use errors.foo. Now errors can be avoided entirely for a bzr rocks run
4463
                    raise errors.BzrCommandError('Cannot sign a range of non-revision-history revisions')
3010.1.17 by Robert Collins
Lock correctness and commit_group management for re-sign, in builtins.
4464
                b.repository.start_write_group()
4465
                try:
4466
                    for revno in range(from_revno, to_revno + 1):
4467
                        b.repository.sign_revision(b.get_rev_id(revno),
4468
                                                   gpg_strategy)
4469
                except:
4470
                    b.repository.abort_write_group()
4471
                    raise
4472
                else:
4473
                    b.repository.commit_write_group()
1483 by Robert Collins
BUGFIX: re-sign should accept ranges
4474
            else:
1996.3.34 by John Arbash Meinel
Update builtins to use errors.foo. Now errors can be avoided entirely for a bzr rocks run
4475
                raise errors.BzrCommandError('Please supply either one revision, or a range.')
1442.1.59 by Robert Collins
Add re-sign command to generate a digital signature on a single revision.
4476
1505.1.22 by John Arbash Meinel
Some small cleanup and discussion in preparation for modifying commit, pull, and merge
4477
1505.1.2 by John Arbash Meinel
(broken) working on implementing bound branches.
4478
class cmd_bind(Command):
2270.1.2 by John Arbash Meinel
Tweak the help text for bind/unbind according to Robert's suggestions.
4479
    """Convert the current branch into a checkout of the supplied branch.
1505.1.2 by John Arbash Meinel
(broken) working on implementing bound branches.
4480
2270.1.2 by John Arbash Meinel
Tweak the help text for bind/unbind according to Robert's suggestions.
4481
    Once converted into a checkout, commits must succeed on the master branch
4482
    before they will be applied to the local branch.
3565.6.15 by Marius Kruger
update bind and switch command descriptions to state what will happen to nicknames.
4483
3565.6.16 by Marius Kruger
update nick command description to mention how it works for bound branches,
4484
    Bound branches use the nickname of its master branch unless it is set
3565.6.15 by Marius Kruger
update bind and switch command descriptions to state what will happen to nicknames.
4485
    locally, in which case binding will update the the local nickname to be
4486
    that of the master.
1505.1.2 by John Arbash Meinel
(broken) working on implementing bound branches.
4487
    """
4488
2425.2.3 by Robert Collins
Update existing builtin commands help text to use _see_also. (Robert Collins)
4489
    _see_also = ['checkouts', 'unbind']
2230.3.31 by Aaron Bentley
Implement re-binding previously-bound branches
4490
    takes_args = ['location?']
1505.1.2 by John Arbash Meinel
(broken) working on implementing bound branches.
4491
    takes_options = []
4492
4493
    def run(self, location=None):
1505.1.22 by John Arbash Meinel
Some small cleanup and discussion in preparation for modifying commit, pull, and merge
4494
        b, relpath = Branch.open_containing(u'.')
2230.3.31 by Aaron Bentley
Implement re-binding previously-bound branches
4495
        if location is None:
4496
            try:
4497
                location = b.get_old_bound_location()
4498
            except errors.UpgradeRequired:
4499
                raise errors.BzrCommandError('No location supplied.  '
4500
                    'This format does not remember old locations.')
4501
            else:
4502
                if location is None:
2230.3.45 by Aaron Bentley
Change error message (mpool)
4503
                    raise errors.BzrCommandError('No location supplied and no '
4504
                        'previous location known')
1505.1.2 by John Arbash Meinel
(broken) working on implementing bound branches.
4505
        b_other = Branch.open(location)
1505.1.3 by John Arbash Meinel
(broken) Adding more tests, and some functionality
4506
        try:
4507
            b.bind(b_other)
1996.3.34 by John Arbash Meinel
Update builtins to use errors.foo. Now errors can be avoided entirely for a bzr rocks run
4508
        except errors.DivergedBranches:
4509
            raise errors.BzrCommandError('These branches have diverged.'
4510
                                         ' Try merging, and then bind again.')
3565.6.11 by Marius Kruger
Bind now updates explicit nicks
4511
        if b.get_config().has_explicit_nickname():
4512
            b.nick = b_other.nick
1505.1.2 by John Arbash Meinel
(broken) working on implementing bound branches.
4513
1505.1.22 by John Arbash Meinel
Some small cleanup and discussion in preparation for modifying commit, pull, and merge
4514
1505.1.2 by John Arbash Meinel
(broken) working on implementing bound branches.
4515
class cmd_unbind(Command):
2270.1.2 by John Arbash Meinel
Tweak the help text for bind/unbind according to Robert's suggestions.
4516
    """Convert the current checkout into a regular branch.
1505.1.2 by John Arbash Meinel
(broken) working on implementing bound branches.
4517
2270.1.2 by John Arbash Meinel
Tweak the help text for bind/unbind according to Robert's suggestions.
4518
    After unbinding, the local branch is considered independent and subsequent
4519
    commits will be local only.
1505.1.2 by John Arbash Meinel
(broken) working on implementing bound branches.
4520
    """
4521
2425.2.3 by Robert Collins
Update existing builtin commands help text to use _see_also. (Robert Collins)
4522
    _see_also = ['checkouts', 'bind']
1505.1.2 by John Arbash Meinel
(broken) working on implementing bound branches.
4523
    takes_args = []
4524
    takes_options = []
4525
4526
    def run(self):
1505.1.22 by John Arbash Meinel
Some small cleanup and discussion in preparation for modifying commit, pull, and merge
4527
        b, relpath = Branch.open_containing(u'.')
4528
        if not b.unbind():
1996.3.34 by John Arbash Meinel
Update builtins to use errors.foo. Now errors can be avoided entirely for a bzr rocks run
4529
            raise errors.BzrCommandError('Local branch is not bound')
1505.1.22 by John Arbash Meinel
Some small cleanup and discussion in preparation for modifying commit, pull, and merge
4530
1442.1.59 by Robert Collins
Add re-sign command to generate a digital signature on a single revision.
4531
1773.4.1 by Martin Pool
Add pyflakes makefile target; fix many warnings
4532
class cmd_uncommit(Command):
1185.31.24 by John Arbash Meinel
[merge] Added the uncommit plugin
4533
    """Remove the last committed revision.
4534
4535
    --verbose will print out what is being removed.
4536
    --dry-run will go through all the motions, but not actually
4537
    remove anything.
2747.2.1 by Daniel Watkins
Modified the help message of 'uncommit'.
4538
4539
    If --revision is specified, uncommit revisions to leave the branch at the
4540
    specified revision.  For example, "bzr uncommit -r 15" will leave the
4541
    branch at revision 15.
4542
1551.19.39 by Aaron Bentley
Update 'uncommit' docs
4543
    Uncommit leaves the working tree ready for a new commit.  The only change
4544
    it may make is to restore any pending merges that were present before
4545
    the commit.
1553.5.34 by Martin Pool
Stub lock-breaking command
4546
    """
1185.62.11 by John Arbash Meinel
Added TODO for bzr uncommit to remove unreferenced information.
4547
1553.5.34 by Martin Pool
Stub lock-breaking command
4548
    # TODO: jam 20060108 Add an option to allow uncommit to remove
1759.2.1 by Jelmer Vernooij
Fix some types (found using aspell).
4549
    # unreferenced information in 'branch-as-repository' branches.
1553.5.34 by Martin Pool
Stub lock-breaking command
4550
    # TODO: jam 20060108 Add the ability for uncommit to remove unreferenced
4551
    # information in shared branches as well.
2425.2.3 by Robert Collins
Update existing builtin commands help text to use _see_also. (Robert Collins)
4552
    _see_also = ['commit']
1185.62.10 by John Arbash Meinel
Removed --all from bzr uncommit, it was broken anyway.
4553
    takes_options = ['verbose', 'revision',
2598.1.1 by Martin Pool
Add test for and documentation of option style, fix up existing options to comply
4554
                    Option('dry-run', help='Don\'t actually make changes.'),
3280.4.1 by John Arbash Meinel
Add uncommit --local.
4555
                    Option('force', help='Say yes to all questions.'),
4556
                    Option('local',
4557
                           help="Only remove the commits from the local branch"
4558
                                " when in a checkout."
4559
                           ),
4560
                    ]
1185.31.24 by John Arbash Meinel
[merge] Added the uncommit plugin
4561
    takes_args = ['location?']
4562
    aliases = []
3101.1.1 by Aaron Bentley
Uncommit doesn't throw when it encounters un-encodable characters
4563
    encoding_type = 'replace'
1185.31.24 by John Arbash Meinel
[merge] Added the uncommit plugin
4564
1850.3.2 by John Arbash Meinel
Change uncommit -r 10 so that it uncommits *to* 10, rather than removing 10
4565
    def run(self, location=None,
1185.31.24 by John Arbash Meinel
[merge] Added the uncommit plugin
4566
            dry_run=False, verbose=False,
3280.4.1 by John Arbash Meinel
Add uncommit --local.
4567
            revision=None, force=False, local=False):
1185.31.24 by John Arbash Meinel
[merge] Added the uncommit plugin
4568
        if location is None:
1185.33.66 by Martin Pool
[patch] use unicode literals for all hardcoded paths (Alexander Belchenko)
4569
            location = u'.'
1558.1.12 by Aaron Bentley
Got uncommit working properly with checkouts
4570
        control, relpath = bzrdir.BzrDir.open_containing(location)
4571
        try:
4572
            tree = control.open_workingtree()
1558.9.1 by Aaron Bentley
Fix uncommit to handle bound branches, and to do locking
4573
            b = tree.branch
1558.1.12 by Aaron Bentley
Got uncommit working properly with checkouts
4574
        except (errors.NoWorkingTree, errors.NotLocalUrl):
4575
            tree = None
1558.9.1 by Aaron Bentley
Fix uncommit to handle bound branches, and to do locking
4576
            b = control.open_branch()
1185.31.24 by John Arbash Meinel
[merge] Added the uncommit plugin
4577
3065.2.2 by John Arbash Meinel
During bzr uncommit, lock the working tree if it is available.
4578
        if tree is not None:
4579
            tree.lock_write()
4580
        else:
4581
            b.lock_write()
3065.2.1 by Lukáš Lalinský
Add a global branch write lock to cmd_uncommit and avoid unnecessary Branch.revno calls.
4582
        try:
3280.4.1 by John Arbash Meinel
Add uncommit --local.
4583
            return self._run(b, tree, dry_run, verbose, revision, force,
4584
                             local=local)
3065.2.1 by Lukáš Lalinský
Add a global branch write lock to cmd_uncommit and avoid unnecessary Branch.revno calls.
4585
        finally:
3065.2.2 by John Arbash Meinel
During bzr uncommit, lock the working tree if it is available.
4586
            if tree is not None:
4587
                tree.unlock()
4588
            else:
4589
                b.unlock()
3065.2.1 by Lukáš Lalinský
Add a global branch write lock to cmd_uncommit and avoid unnecessary Branch.revno calls.
4590
3280.4.1 by John Arbash Meinel
Add uncommit --local.
4591
    def _run(self, b, tree, dry_run, verbose, revision, force, local=False):
3065.2.1 by Lukáš Lalinský
Add a global branch write lock to cmd_uncommit and avoid unnecessary Branch.revno calls.
4592
        from bzrlib.log import log_formatter, show_log
4593
        from bzrlib.uncommit import uncommit
4594
4595
        last_revno, last_rev_id = b.last_revision_info()
4596
1850.3.2 by John Arbash Meinel
Change uncommit -r 10 so that it uncommits *to* 10, rather than removing 10
4597
        rev_id = None
1185.31.24 by John Arbash Meinel
[merge] Added the uncommit plugin
4598
        if revision is None:
3065.2.1 by Lukáš Lalinský
Add a global branch write lock to cmd_uncommit and avoid unnecessary Branch.revno calls.
4599
            revno = last_revno
4600
            rev_id = last_rev_id
1185.31.24 by John Arbash Meinel
[merge] Added the uncommit plugin
4601
        else:
1850.3.2 by John Arbash Meinel
Change uncommit -r 10 so that it uncommits *to* 10, rather than removing 10
4602
            # 'bzr uncommit -r 10' actually means uncommit
4603
            # so that the final tree is at revno 10.
4604
            # but bzrlib.uncommit.uncommit() actually uncommits
4605
            # the revisions that are supplied.
4606
            # So we need to offset it by one
3065.2.1 by Lukáš Lalinský
Add a global branch write lock to cmd_uncommit and avoid unnecessary Branch.revno calls.
4607
            revno = revision[0].in_history(b).revno + 1
4608
            if revno <= last_revno:
4609
                rev_id = b.get_rev_id(revno)
1850.3.2 by John Arbash Meinel
Change uncommit -r 10 so that it uncommits *to* 10, rather than removing 10
4610
2948.2.2 by John Arbash Meinel
Re-introduce the None check in case someone asks to uncommit *to* the last revision
4611
        if rev_id is None or _mod_revision.is_null(rev_id):
1850.3.2 by John Arbash Meinel
Change uncommit -r 10 so that it uncommits *to* 10, rather than removing 10
4612
            self.outf.write('No revisions to uncommit.\n')
4613
            return 1
4614
4615
        lf = log_formatter('short',
4616
                           to_file=self.outf,
3629.1.2 by John Arbash Meinel
Change to just display the command to restore the tip,
4617
                           show_timezone='original')
1850.3.2 by John Arbash Meinel
Change uncommit -r 10 so that it uncommits *to* 10, rather than removing 10
4618
4619
        show_log(b,
4620
                 lf,
4621
                 verbose=False,
4622
                 direction='forward',
4623
                 start_revision=revno,
3065.2.1 by Lukáš Lalinský
Add a global branch write lock to cmd_uncommit and avoid unnecessary Branch.revno calls.
4624
                 end_revision=last_revno)
1185.31.24 by John Arbash Meinel
[merge] Added the uncommit plugin
4625
4626
        if dry_run:
4627
            print 'Dry-run, pretending to remove the above revisions.'
4628
            if not force:
4629
                val = raw_input('Press <enter> to continue')
4630
        else:
4631
            print 'The above revision(s) will be removed.'
4632
            if not force:
4633
                val = raw_input('Are you sure [y/N]? ')
4634
                if val.lower() not in ('y', 'yes'):
4635
                    print 'Canceled'
4636
                    return 0
4637
3629.1.1 by John Arbash Meinel
Change 'bzr uncommit' to display the revision ids and log them.
4638
        mutter('Uncommitting from {%s} to {%s}',
4639
               last_rev_id, rev_id)
1558.1.12 by Aaron Bentley
Got uncommit working properly with checkouts
4640
        uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
3280.4.1 by John Arbash Meinel
Add uncommit --local.
4641
                 revno=revno, local=local)
3629.1.2 by John Arbash Meinel
Change to just display the command to restore the tip,
4642
        note('You can restore the old tip by running:\n'
4643
             '  bzr pull . -r revid:%s', last_rev_id)
1185.31.24 by John Arbash Meinel
[merge] Added the uncommit plugin
4644
4645
1553.5.34 by Martin Pool
Stub lock-breaking command
4646
class cmd_break_lock(Command):
4647
    """Break a dead lock on a repository, branch or working directory.
4648
1553.5.35 by Martin Pool
Start break-lock --show
4649
    CAUTION: Locks should only be broken when you are sure that the process
1553.5.34 by Martin Pool
Stub lock-breaking command
4650
    holding the lock has been stopped.
1687.1.12 by Robert Collins
Hook in the full break-lock ui.
4651
4652
    You can get information on what locks are open via the 'bzr info' command.
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
4653
2666.1.1 by Ian Clatworthy
Bazaar User Reference generated from online help
4654
    :Examples:
1687.1.12 by Robert Collins
Hook in the full break-lock ui.
4655
        bzr break-lock
1553.5.34 by Martin Pool
Stub lock-breaking command
4656
    """
1687.1.12 by Robert Collins
Hook in the full break-lock ui.
4657
    takes_args = ['location?']
4658
4659
    def run(self, location=None, show=False):
4660
        if location is None:
4661
            location = u'.'
4662
        control, relpath = bzrdir.BzrDir.open_containing(location)
1687.1.17 by Robert Collins
Test break lock on old format branches.
4663
        try:
4664
            control.break_lock()
4665
        except NotImplementedError:
4666
            pass
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
4667
1553.5.35 by Martin Pool
Start break-lock --show
4668
1910.17.2 by Andrew Bennetts
Add start_bzr_subprocess and stop_bzr_subprocess to allow test code to continue
4669
class cmd_wait_until_signalled(Command):
4670
    """Test helper for test_start_and_stop_bzr_subprocess_send_signal.
4671
4672
    This just prints a line to signal when it is ready, then blocks on stdin.
4673
    """
4674
4675
    hidden = True
4676
4677
    def run(self):
1910.17.6 by Andrew Bennetts
Use sys.stdout consistently, rather than mixed with print.
4678
        sys.stdout.write("running\n")
1910.17.2 by Andrew Bennetts
Add start_bzr_subprocess and stop_bzr_subprocess to allow test code to continue
4679
        sys.stdout.flush()
4680
        sys.stdin.readline()
4681
1553.5.35 by Martin Pool
Start break-lock --show
4682
1910.19.1 by Andrew Bennetts
Support bzr:// urls to work with the new RPC-based transport which will be used
4683
class cmd_serve(Command):
2020.1.1 by Robert Collins
Add readonly support to the smart server, enabled by default via `bzr server`.
4684
    """Run the bzr server."""
4685
4686
    aliases = ['server']
4687
1910.19.1 by Andrew Bennetts
Support bzr:// urls to work with the new RPC-based transport which will be used
4688
    takes_options = [
4689
        Option('inet',
2598.1.1 by Martin Pool
Add test for and documentation of option style, fix up existing options to comply
4690
               help='Serve on stdin/out for use from inetd or sshd.'),
4370.4.1 by Jelmer Vernooij
Add registry for 'bzr serve' protocols.
4691
        RegistryOption('protocol', 
4692
               help="Protocol to serve.", 
4370.4.6 by Jelmer Vernooij
Move server protocol registry to bzrlib.transport.
4693
               lazy_registry=('bzrlib.transport', 'transport_server_registry'),
4370.4.1 by Jelmer Vernooij
Add registry for 'bzr serve' protocols.
4694
               value_switches=True),
1910.19.1 by Andrew Bennetts
Support bzr:// urls to work with the new RPC-based transport which will be used
4695
        Option('port',
2598.1.1 by Martin Pool
Add test for and documentation of option style, fix up existing options to comply
4696
               help='Listen for connections on nominated port of the form '
4697
                    '[hostname:]portnumber.  Passing 0 as the port number will '
4370.4.1 by Jelmer Vernooij
Add registry for 'bzr serve' protocols.
4698
                    'result in a dynamically allocated port.  The default port '
4699
                    'depends on the protocol.',
1910.19.7 by Andrew Bennetts
Allow specifying the host/interface to bzr serve, and use the new test
4700
               type=str),
1910.19.1 by Andrew Bennetts
Support bzr:// urls to work with the new RPC-based transport which will be used
4701
        Option('directory',
2598.1.1 by Martin Pool
Add test for and documentation of option style, fix up existing options to comply
4702
               help='Serve contents of this directory.',
1910.19.1 by Andrew Bennetts
Support bzr:// urls to work with the new RPC-based transport which will be used
4703
               type=unicode),
2020.1.1 by Robert Collins
Add readonly support to the smart server, enabled by default via `bzr server`.
4704
        Option('allow-writes',
2598.1.1 by Martin Pool
Add test for and documentation of option style, fix up existing options to comply
4705
               help='By default the server is a readonly server.  Supplying '
2020.1.1 by Robert Collins
Add readonly support to the smart server, enabled by default via `bzr server`.
4706
                    '--allow-writes enables write access to the contents of '
2598.1.1 by Martin Pool
Add test for and documentation of option style, fix up existing options to comply
4707
                    'the served directory and below.'
2020.1.1 by Robert Collins
Add readonly support to the smart server, enabled by default via `bzr server`.
4708
                ),
1910.19.1 by Andrew Bennetts
Support bzr:// urls to work with the new RPC-based transport which will be used
4709
        ]
4710
3955.1.4 by Jonathan Lange
Docstrings and extraction of method to get the smart server.
4711
    def get_host_and_port(self, port):
4712
        """Return the host and port to run the smart server on.
4713
4370.4.3 by Jelmer Vernooij
Move host/port parsing to early in bzr-serve.
4714
        If 'port' is None, None will be returned for the host and port.
3955.1.4 by Jonathan Lange
Docstrings and extraction of method to get the smart server.
4715
4716
        If 'port' has a colon in it, the string before the colon will be
4717
        interpreted as the host.
4718
4719
        :param port: A string of the port to run the server on.
4720
        :return: A tuple of (host, port), where 'host' is a host name or IP,
4721
            and port is an integer TCP/IP port.
4722
        """
4370.4.3 by Jelmer Vernooij
Move host/port parsing to early in bzr-serve.
4723
        host = None
4370.4.7 by Jelmer Vernooij
Review feedback from Ian.
4724
        if port is not None:
3955.1.2 by Jonathan Lange
Extract the port-getting logic. Use note() rather than print()
4725
            if ':' in port:
4726
                host, port = port.split(':')
4727
            port = int(port)
4728
        return host, port
4729
4370.4.1 by Jelmer Vernooij
Add registry for 'bzr serve' protocols.
4730
    def run(self, port=None, inet=False, directory=None, allow_writes=False,
4731
            protocol=None):
4370.4.6 by Jelmer Vernooij
Move server protocol registry to bzrlib.transport.
4732
        from bzrlib.transport import get_transport, transport_server_registry
4370.4.1 by Jelmer Vernooij
Add registry for 'bzr serve' protocols.
4733
        if directory is None:
4734
            directory = os.getcwd()
4735
        if protocol is None:
4370.4.6 by Jelmer Vernooij
Move server protocol registry to bzrlib.transport.
4736
            protocol = transport_server_registry.get()
4370.4.3 by Jelmer Vernooij
Move host/port parsing to early in bzr-serve.
4737
        host, port = self.get_host_and_port(port)
4370.4.4 by Jelmer Vernooij
Move more bzr smart server-specific stuff into a single function.
4738
        url = urlutils.local_path_to_url(directory)
4739
        if not allow_writes:
4740
            url = 'readonly+' + url
4741
        transport = get_transport(url)
4370.4.6 by Jelmer Vernooij
Move server protocol registry to bzrlib.transport.
4742
        protocol(transport, host, port, inet)
4370.4.1 by Jelmer Vernooij
Add registry for 'bzr serve' protocols.
4743
3955.1.2 by Jonathan Lange
Extract the port-getting logic. Use note() rather than print()
4744
1731.2.7 by Aaron Bentley
Add join command
4745
class cmd_join(Command):
4251.1.2 by Aaron Bentley
Hide the --reference option.
4746
    """Combine a tree into its containing tree.
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
4747
4251.1.2 by Aaron Bentley
Hide the --reference option.
4748
    This command requires the target tree to be in a rich-root format.
2338.3.1 by Aaron Bentley
Hide nested-tree commands and improve their docs
4749
4750
    The TREE argument should be an independent tree, inside another tree, but
4751
    not part of it.  (Such trees can be produced by "bzr split", but also by
4752
    running "bzr branch" with the target inside a tree.)
4753
4754
    The result is a combined tree, with the subtree no longer an independant
4755
    part.  This is marked as a merge of the subtree into the containing tree,
4756
    and all history is preserved.
1731.2.7 by Aaron Bentley
Add join command
4757
    """
4758
2425.2.3 by Robert Collins
Update existing builtin commands help text to use _see_also. (Robert Collins)
4759
    _see_also = ['split']
1731.2.7 by Aaron Bentley
Add join command
4760
    takes_args = ['tree']
2598.1.1 by Martin Pool
Add test for and documentation of option style, fix up existing options to comply
4761
    takes_options = [
4251.1.2 by Aaron Bentley
Hide the --reference option.
4762
            Option('reference', help='Join by reference.', hidden=True),
2598.1.1 by Martin Pool
Add test for and documentation of option style, fix up existing options to comply
4763
            ]
1731.2.7 by Aaron Bentley
Add join command
4764
2100.3.11 by Aaron Bentley
Add join --reference support
4765
    def run(self, tree, reference=False):
1731.2.7 by Aaron Bentley
Add join command
4766
        sub_tree = WorkingTree.open(tree)
4767
        parent_dir = osutils.dirname(sub_tree.basedir)
4768
        containing_tree = WorkingTree.open_containing(parent_dir)[0]
2255.2.235 by Martin Pool
Add blackbox test that join gives clean error when the repository doesn't support rich roots
4769
        repo = containing_tree.branch.repository
4770
        if not repo.supports_rich_root():
4771
            raise errors.BzrCommandError(
4772
                "Can't join trees because %s doesn't support rich root data.\n"
4773
                "You can use bzr upgrade on the repository."
4774
                % (repo,))
2100.3.11 by Aaron Bentley
Add join --reference support
4775
        if reference:
2255.2.219 by Martin Pool
fix unbound local error in cmd_join
4776
            try:
2100.3.11 by Aaron Bentley
Add join --reference support
4777
                containing_tree.add_reference(sub_tree)
2255.2.219 by Martin Pool
fix unbound local error in cmd_join
4778
            except errors.BadReferenceTarget, e:
2255.2.235 by Martin Pool
Add blackbox test that join gives clean error when the repository doesn't support rich roots
4779
                # XXX: Would be better to just raise a nicely printable
4780
                # exception from the real origin.  Also below.  mbp 20070306
2255.2.219 by Martin Pool
fix unbound local error in cmd_join
4781
                raise errors.BzrCommandError("Cannot join %s.  %s" %
2100.3.11 by Aaron Bentley
Add join --reference support
4782
                                             (tree, e.reason))
4783
        else:
4784
            try:
4785
                containing_tree.subsume(sub_tree)
4786
            except errors.BadSubsumeSource, e:
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
4787
                raise errors.BzrCommandError("Cannot join %s.  %s" %
2100.3.11 by Aaron Bentley
Add join --reference support
4788
                                             (tree, e.reason))
1553.5.35 by Martin Pool
Start break-lock --show
4789
1731.2.22 by Aaron Bentley
Initial work on split command
4790
4791
class cmd_split(Command):
3113.6.2 by Aaron Bentley
Un-hide split command, add NEWS
4792
    """Split a subdirectory of a tree into a separate tree.
2338.3.1 by Aaron Bentley
Hide nested-tree commands and improve their docs
4793
3113.6.2 by Aaron Bentley
Un-hide split command, add NEWS
4794
    This command will produce a target tree in a format that supports
4795
    rich roots, like 'rich-root' or 'rich-root-pack'.  These formats cannot be
4796
    converted into earlier formats like 'dirstate-tags'.
2338.3.1 by Aaron Bentley
Hide nested-tree commands and improve their docs
4797
4798
    The TREE argument should be a subdirectory of a working tree.  That
4799
    subdirectory will be converted into an independent tree, with its own
4800
    branch.  Commits in the top-level tree will not apply to the new subtree.
1731.2.22 by Aaron Bentley
Initial work on split command
4801
    """
4802
4251.1.4 by Aaron Bentley
Uncomment split's 'See also:join'
4803
    _see_also = ['join']
1731.2.22 by Aaron Bentley
Initial work on split command
4804
    takes_args = ['tree']
4805
4806
    def run(self, tree):
4807
        containing_tree, subdir = WorkingTree.open_containing(tree)
4808
        sub_id = containing_tree.path2id(subdir)
4809
        if sub_id is None:
4810
            raise errors.NotVersionedError(subdir)
1731.2.23 by Aaron Bentley
Throw user-friendly error splitting in shared repo with wrong format
4811
        try:
4812
            containing_tree.extract(sub_id)
4813
        except errors.RootNotRich:
4416.6.1 by Neil Martinsen-Burrell
Fix #220067 adding more specificity to the error message when split fails
4814
            raise errors.RichRootUpgradeRequired(containing_tree.branch.base)
1731.2.22 by Aaron Bentley
Initial work on split command
4815
4816
1551.12.8 by Aaron Bentley
Add merge-directive command
4817
class cmd_merge_directive(Command):
1551.12.32 by Aaron Bentley
Improve merge directive help
4818
    """Generate a merge directive for auto-merge tools.
4819
4820
    A directive requests a merge to be performed, and also provides all the
4821
    information necessary to do so.  This means it must either include a
4822
    revision bundle, or the location of a branch containing the desired
4823
    revision.
4824
4825
    A submit branch (the location to merge into) must be supplied the first
4826
    time the command is issued.  After it has been supplied once, it will
4827
    be remembered as the default.
4828
4829
    A public branch is optional if a revision bundle is supplied, but required
4830
    if --diff or --plain is specified.  It will be remembered as the default
4831
    after the first use.
4832
    """
1551.12.20 by Aaron Bentley
Pull directive registry into command class
4833
1551.12.14 by Aaron Bentley
Get merge-directive command basically working
4834
    takes_args = ['submit_branch?', 'public_branch?']
4835
2520.5.4 by Aaron Bentley
Replace 'bundle-revisions' with 'submit' command
4836
    hidden = True
4837
2681.1.4 by Aaron Bentley
Fix reference to told submit command
4838
    _see_also = ['send']
2520.4.121 by Aaron Bentley
Polish up submit command
4839
1551.12.43 by Aaron Bentley
Misc changes from review
4840
    takes_options = [
4841
        RegistryOption.from_kwargs('patch-type',
2681.1.7 by Aaron Bentley
Fix option grammar
4842
            'The type of patch to include in the directive.',
2598.1.2 by Martin Pool
Also check that option help ends in a period, and fix those that don't
4843
            title='Patch type',
4844
            value_switches=True,
4845
            enum_switch=False,
4846
            bundle='Bazaar revision bundle (default).',
4847
            diff='Normal unified diff.',
4848
            plain='No patch, just directive.'),
4849
        Option('sign', help='GPG-sign the directive.'), 'revision',
1551.12.26 by Aaron Bentley
Get email working, with optional message
4850
        Option('mail-to', type=str,
2598.1.2 by Martin Pool
Also check that option help ends in a period, and fix those that don't
4851
            help='Instead of printing the directive, email to this address.'),
1551.12.27 by Aaron Bentley
support custom message everywhere
4852
        Option('message', type=str, short_name='m',
2598.1.2 by Martin Pool
Also check that option help ends in a period, and fix those that don't
4853
            help='Message to use when committing this merge.')
1551.12.27 by Aaron Bentley
support custom message everywhere
4854
        ]
1551.12.14 by Aaron Bentley
Get merge-directive command basically working
4855
2530.2.1 by Adeodato Simó
Add encoding_type = 'exact' to cmd_merge_directive. (LP #120591)
4856
    encoding_type = 'exact'
4857
1551.12.16 by Aaron Bentley
Enable signing merge directives
4858
    def run(self, submit_branch=None, public_branch=None, patch_type='bundle',
1551.12.27 by Aaron Bentley
support custom message everywhere
4859
            sign=False, revision=None, mail_to=None, message=None):
2490.2.28 by Aaron Bentley
Fix handling of null revision
4860
        from bzrlib.revision import ensure_null, NULL_REVISION
2520.5.4 by Aaron Bentley
Replace 'bundle-revisions' with 'submit' command
4861
        include_patch, include_bundle = {
4862
            'plain': (False, False),
4863
            'diff': (True, False),
4864
            'bundle': (True, True),
4865
            }[patch_type]
1551.12.8 by Aaron Bentley
Add merge-directive command
4866
        branch = Branch.open('.')
1551.12.44 by Aaron Bentley
Add (set|get)_public_branch
4867
        stored_submit_branch = branch.get_submit_branch()
1551.12.14 by Aaron Bentley
Get merge-directive command basically working
4868
        if submit_branch is None:
1551.12.44 by Aaron Bentley
Add (set|get)_public_branch
4869
            submit_branch = stored_submit_branch
1551.12.14 by Aaron Bentley
Get merge-directive command basically working
4870
        else:
1551.12.44 by Aaron Bentley
Add (set|get)_public_branch
4871
            if stored_submit_branch is None:
1551.12.14 by Aaron Bentley
Get merge-directive command basically working
4872
                branch.set_submit_branch(submit_branch)
4873
        if submit_branch is None:
4874
            submit_branch = branch.get_parent()
4875
        if submit_branch is None:
4876
            raise errors.BzrCommandError('No submit branch specified or known')
1551.12.44 by Aaron Bentley
Add (set|get)_public_branch
4877
4878
        stored_public_branch = branch.get_public_branch()
1551.12.14 by Aaron Bentley
Get merge-directive command basically working
4879
        if public_branch is None:
1551.12.44 by Aaron Bentley
Add (set|get)_public_branch
4880
            public_branch = stored_public_branch
4881
        elif stored_public_branch is None:
4882
            branch.set_public_branch(public_branch)
2520.5.4 by Aaron Bentley
Replace 'bundle-revisions' with 'submit' command
4883
        if not include_bundle and public_branch is None:
1551.12.24 by Aaron Bentley
Add RegistryOption.from_swargs to simplify simple registry options
4884
            raise errors.BzrCommandError('No public branch specified or'
4885
                                         ' known')
2520.4.112 by Aaron Bentley
Make cherry-pick merge directives possible
4886
        base_revision_id = None
1551.12.17 by Aaron Bentley
add revision selection to mergedirective
4887
        if revision is not None:
2520.4.112 by Aaron Bentley
Make cherry-pick merge directives possible
4888
            if len(revision) > 2:
1551.12.17 by Aaron Bentley
add revision selection to mergedirective
4889
                raise errors.BzrCommandError('bzr merge-directive takes '
2520.4.112 by Aaron Bentley
Make cherry-pick merge directives possible
4890
                    'at most two one revision identifiers')
3298.2.8 by John Arbash Meinel
Get rid of .in_branch(need_revno=False) in favor of simpler .as_revision_id()
4891
            revision_id = revision[-1].as_revision_id(branch)
2520.4.112 by Aaron Bentley
Make cherry-pick merge directives possible
4892
            if len(revision) == 2:
3298.2.8 by John Arbash Meinel
Get rid of .in_branch(need_revno=False) in favor of simpler .as_revision_id()
4893
                base_revision_id = revision[0].as_revision_id(branch)
1551.12.17 by Aaron Bentley
add revision selection to mergedirective
4894
        else:
4895
            revision_id = branch.last_revision()
2490.2.28 by Aaron Bentley
Fix handling of null revision
4896
        revision_id = ensure_null(revision_id)
4897
        if revision_id == NULL_REVISION:
4898
            raise errors.BzrCommandError('No revisions to bundle.')
2520.4.73 by Aaron Bentley
Implement new merge directive format
4899
        directive = merge_directive.MergeDirective2.from_objects(
1551.12.17 by Aaron Bentley
add revision selection to mergedirective
4900
            branch.repository, revision_id, time.time(),
1551.12.8 by Aaron Bentley
Add merge-directive command
4901
            osutils.local_time_offset(), submit_branch,
2520.5.4 by Aaron Bentley
Replace 'bundle-revisions' with 'submit' command
4902
            public_branch=public_branch, include_patch=include_patch,
4903
            include_bundle=include_bundle, message=message,
4904
            base_revision_id=base_revision_id)
1551.12.26 by Aaron Bentley
Get email working, with optional message
4905
        if mail_to is None:
4906
            if sign:
4907
                self.outf.write(directive.to_signed(branch))
4908
            else:
4909
                self.outf.writelines(directive.to_lines())
1551.12.16 by Aaron Bentley
Enable signing merge directives
4910
        else:
1551.12.26 by Aaron Bentley
Get email working, with optional message
4911
            message = directive.to_email(mail_to, branch, sign)
2535.2.1 by Adeodato Simó
New SMTPConnection class, a reduced version of that in bzr-email.
4912
            s = SMTPConnection(branch.get_config())
4913
            s.send_email(message)
1551.12.8 by Aaron Bentley
Add merge-directive command
4914
1551.12.14 by Aaron Bentley
Get merge-directive command basically working
4915
4367.1.3 by Jelmer Vernooij
Move cmd_{send,bundle_revisions} back to bzrlib.builtins per Ians request.
4916
class cmd_send(Command):
4917
    """Mail or create a merge-directive for submitting changes.
4918
4919
    A merge directive provides many things needed for requesting merges:
4920
4921
    * A machine-readable description of the merge to perform
4922
4923
    * An optional patch that is a preview of the changes requested
4924
4925
    * An optional bundle of revision data, so that the changes can be applied
4926
      directly from the merge directive, without retrieving data from a
4927
      branch.
4928
4929
    If --no-bundle is specified, then public_branch is needed (and must be
4930
    up-to-date), so that the receiver can perform the merge using the
4931
    public_branch.  The public_branch is always included if known, so that
4932
    people can check it later.
4933
4934
    The submit branch defaults to the parent, but can be overridden.  Both
4935
    submit branch and public branch will be remembered if supplied.
4936
4937
    If a public_branch is known for the submit_branch, that public submit
4938
    branch is used in the merge instructions.  This means that a local mirror
4939
    can be used as your actual submit branch, once you have set public_branch
4940
    for that mirror.
4941
4942
    Mail is sent using your preferred mail program.  This should be transparent
4943
    on Windows (it uses MAPI).  On Linux, it requires the xdg-email utility.
4944
    If the preferred client can't be found (or used), your editor will be used.
4945
4946
    To use a specific mail program, set the mail_client configuration option.
4947
    (For Thunderbird 1.5, this works around some bugs.)  Supported values for
4948
    specific clients are "claws", "evolution", "kmail", "mutt", and
4949
    "thunderbird"; generic options are "default", "editor", "emacsclient",
4950
    "mapi", and "xdg-email".  Plugins may also add supported clients.
4951
4952
    If mail is being sent, a to address is required.  This can be supplied
4953
    either on the commandline, by setting the submit_to configuration
4954
    option in the branch itself or the child_submit_to configuration option
4955
    in the submit branch.
4956
4957
    Two formats are currently supported: "4" uses revision bundle format 4 and
4958
    merge directive format 2.  It is significantly faster and smaller than
4959
    older formats.  It is compatible with Bazaar 0.19 and later.  It is the
4960
    default.  "0.9" uses revision bundle format 0.9 and merge directive
4961
    format 1.  It is compatible with Bazaar 0.12 - 0.18.
4962
4963
    The merge directives created by bzr send may be applied using bzr merge or
4964
    bzr pull by specifying a file containing a merge directive as the location.
4965
    """
4966
4967
    encoding_type = 'exact'
4968
4969
    _see_also = ['merge', 'pull']
4970
4971
    takes_args = ['submit_branch?', 'public_branch?']
4972
4973
    takes_options = [
4974
        Option('no-bundle',
4975
               help='Do not include a bundle in the merge directive.'),
4976
        Option('no-patch', help='Do not include a preview patch in the merge'
4977
               ' directive.'),
4978
        Option('remember',
4979
               help='Remember submit and public branch.'),
4980
        Option('from',
4981
               help='Branch to generate the submission from, '
4982
               'rather than the one containing the working directory.',
4983
               short_name='f',
4984
               type=unicode),
4985
        Option('output', short_name='o',
4986
               help='Write merge directive to this file; '
4987
                    'use - for stdout.',
4988
               type=unicode),
4464.3.4 by Vincent Ladeuil
Fix bug #206577 by adding a --strict option to send.
4989
        Option('strict',
4990
               help='Refuse to send if there are uncommitted changes in'
4464.3.11 by Vincent Ladeuil
Add a check for tree/branch sync and tweak help.
4991
               ' the working tree, --no-strict disables the check.'),
4367.1.3 by Jelmer Vernooij
Move cmd_{send,bundle_revisions} back to bzrlib.builtins per Ians request.
4992
        Option('mail-to', help='Mail the request to this address.',
4993
               type=unicode),
4994
        'revision',
4995
        'message',
4996
        Option('body', help='Body for the email.', type=unicode),
4997
        RegistryOption('format',
4464.3.4 by Vincent Ladeuil
Fix bug #206577 by adding a --strict option to send.
4998
                       help='Use the specified output format.',
4999
                       lazy_registry=('bzrlib.send', 'format_registry')),
4367.1.3 by Jelmer Vernooij
Move cmd_{send,bundle_revisions} back to bzrlib.builtins per Ians request.
5000
        ]
5001
5002
    def run(self, submit_branch=None, public_branch=None, no_bundle=False,
5003
            no_patch=False, revision=None, remember=False, output=None,
4464.3.4 by Vincent Ladeuil
Fix bug #206577 by adding a --strict option to send.
5004
            format=None, mail_to=None, message=None, body=None,
5005
            strict=None, **kwargs):
4367.1.3 by Jelmer Vernooij
Move cmd_{send,bundle_revisions} back to bzrlib.builtins per Ians request.
5006
        from bzrlib.send import send
5007
        return send(submit_branch, revision, public_branch, remember,
4464.3.4 by Vincent Ladeuil
Fix bug #206577 by adding a --strict option to send.
5008
                    format, no_bundle, no_patch, output,
5009
                    kwargs.get('from', '.'), mail_to, message, body,
5010
                    self.outf,
5011
                    strict=strict)
4367.1.3 by Jelmer Vernooij
Move cmd_{send,bundle_revisions} back to bzrlib.builtins per Ians request.
5012
5013
4367.1.6 by Jelmer Vernooij
Fix bundle revisions.
5014
class cmd_bundle_revisions(cmd_send):
4367.1.3 by Jelmer Vernooij
Move cmd_{send,bundle_revisions} back to bzrlib.builtins per Ians request.
5015
    """Create a merge-directive for submitting changes.
5016
5017
    A merge directive provides many things needed for requesting merges:
5018
5019
    * A machine-readable description of the merge to perform
5020
5021
    * An optional patch that is a preview of the changes requested
5022
5023
    * An optional bundle of revision data, so that the changes can be applied
5024
      directly from the merge directive, without retrieving data from a
5025
      branch.
5026
5027
    If --no-bundle is specified, then public_branch is needed (and must be
5028
    up-to-date), so that the receiver can perform the merge using the
5029
    public_branch.  The public_branch is always included if known, so that
5030
    people can check it later.
5031
5032
    The submit branch defaults to the parent, but can be overridden.  Both
5033
    submit branch and public branch will be remembered if supplied.
5034
5035
    If a public_branch is known for the submit_branch, that public submit
5036
    branch is used in the merge instructions.  This means that a local mirror
5037
    can be used as your actual submit branch, once you have set public_branch
5038
    for that mirror.
5039
5040
    Two formats are currently supported: "4" uses revision bundle format 4 and
5041
    merge directive format 2.  It is significantly faster and smaller than
5042
    older formats.  It is compatible with Bazaar 0.19 and later.  It is the
5043
    default.  "0.9" uses revision bundle format 0.9 and merge directive
5044
    format 1.  It is compatible with Bazaar 0.12 - 0.18.
5045
    """
5046
5047
    takes_options = [
5048
        Option('no-bundle',
5049
               help='Do not include a bundle in the merge directive.'),
5050
        Option('no-patch', help='Do not include a preview patch in the merge'
5051
               ' directive.'),
5052
        Option('remember',
5053
               help='Remember submit and public branch.'),
5054
        Option('from',
5055
               help='Branch to generate the submission from, '
5056
               'rather than the one containing the working directory.',
5057
               short_name='f',
5058
               type=unicode),
5059
        Option('output', short_name='o', help='Write directive to this file.',
5060
               type=unicode),
4464.3.6 by Vincent Ladeuil
bundle-revisions should support --strict too.
5061
        Option('strict',
4464.3.11 by Vincent Ladeuil
Add a check for tree/branch sync and tweak help.
5062
               help='Refuse to bundle revisions if there are uncommitted'
5063
               ' changes in the working tree, --no-strict disables the check.'),
4367.1.3 by Jelmer Vernooij
Move cmd_{send,bundle_revisions} back to bzrlib.builtins per Ians request.
5064
        'revision',
5065
        RegistryOption('format',
5066
                       help='Use the specified output format.',
5067
                       lazy_registry=('bzrlib.send', 'format_registry')),
5068
        ]
5069
    aliases = ['bundle']
5070
5071
    _see_also = ['send', 'merge']
5072
5073
    hidden = True
5074
5075
    def run(self, submit_branch=None, public_branch=None, no_bundle=False,
5076
            no_patch=False, revision=None, remember=False, output=None,
4464.3.6 by Vincent Ladeuil
bundle-revisions should support --strict too.
5077
            format=None, strict=None, **kwargs):
4367.1.3 by Jelmer Vernooij
Move cmd_{send,bundle_revisions} back to bzrlib.builtins per Ians request.
5078
        if output is None:
5079
            output = '-'
5080
        from bzrlib.send import send
5081
        return send(submit_branch, revision, public_branch, remember,
5082
                         format, no_bundle, no_patch, output,
5083
                         kwargs.get('from', '.'), None, None, None,
4464.3.6 by Vincent Ladeuil
bundle-revisions should support --strict too.
5084
                         self.outf, strict=strict)
4367.1.3 by Jelmer Vernooij
Move cmd_{send,bundle_revisions} back to bzrlib.builtins per Ians request.
5085
5086
2220.2.2 by Martin Pool
Add tag command and basic implementation
5087
class cmd_tag(Command):
2664.1.1 by Joachim Nilsson
Change tag description for "help commands" to make it easier to find
5088
    """Create, remove or modify a tag naming a revision.
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
5089
2220.2.8 by Martin Pool
Add -d option to push, pull, merge commands.
5090
    Tags give human-meaningful names to revisions.  Commands that take a -r
5091
    (--revision) option can be given -rtag:X, where X is any previously
5092
    created tag.
5093
2220.2.41 by Martin Pool
Fix tag help (fullermd)
5094
    Tags are stored in the branch.  Tags are copied from one branch to another
5095
    along when you branch, push, pull or merge.
2220.2.42 by Martin Pool
Tag command refuses to replace existing tags unless you force it.
5096
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
5097
    It is an error to give a tag name that already exists unless you pass
2220.2.42 by Martin Pool
Tag command refuses to replace existing tags unless you force it.
5098
    --force, in which case the tag is moved to point to the new revision.
3566.2.1 by Benjamin Peterson
document how the rename tags
5099
3566.2.2 by Benjamin Peterson
fix markup
5100
    To rename a tag (change the name but keep it on the same revsion), run ``bzr
5101
    tag new-name -r tag:old-name`` and then ``bzr tag --delete oldname``.
2220.2.8 by Martin Pool
Add -d option to push, pull, merge commands.
5102
    """
2220.2.2 by Martin Pool
Add tag command and basic implementation
5103
2425.2.3 by Robert Collins
Update existing builtin commands help text to use _see_also. (Robert Collins)
5104
    _see_also = ['commit', 'tags']
2220.2.2 by Martin Pool
Add tag command and basic implementation
5105
    takes_args = ['tag_name']
5106
    takes_options = [
2220.2.21 by Martin Pool
Add tag --delete command and implementation
5107
        Option('delete',
2220.2.42 by Martin Pool
Tag command refuses to replace existing tags unless you force it.
5108
            help='Delete this tag rather than placing it.',
5109
            ),
5110
        Option('directory',
5111
            help='Branch in which to place the tag.',
5112
            short_name='d',
5113
            type=unicode,
5114
            ),
5115
        Option('force',
2598.1.2 by Martin Pool
Also check that option help ends in a period, and fix those that don't
5116
            help='Replace existing tags.',
2220.2.21 by Martin Pool
Add tag --delete command and implementation
5117
            ),
2220.2.6 by Martin Pool
Add tag -r option
5118
        'revision',
2220.2.2 by Martin Pool
Add tag command and basic implementation
5119
        ]
5120
2220.2.42 by Martin Pool
Tag command refuses to replace existing tags unless you force it.
5121
    def run(self, tag_name,
5122
            delete=None,
5123
            directory='.',
5124
            force=None,
2220.2.21 by Martin Pool
Add tag --delete command and implementation
5125
            revision=None,
2220.2.42 by Martin Pool
Tag command refuses to replace existing tags unless you force it.
5126
            ):
2220.2.2 by Martin Pool
Add tag command and basic implementation
5127
        branch, relpath = Branch.open_containing(directory)
2220.2.42 by Martin Pool
Tag command refuses to replace existing tags unless you force it.
5128
        branch.lock_write()
5129
        try:
5130
            if delete:
5131
                branch.tags.delete_tag(tag_name)
5132
                self.outf.write('Deleted tag %s.\n' % tag_name)
2220.2.21 by Martin Pool
Add tag --delete command and implementation
5133
            else:
2220.2.42 by Martin Pool
Tag command refuses to replace existing tags unless you force it.
5134
                if revision:
5135
                    if len(revision) != 1:
5136
                        raise errors.BzrCommandError(
5137
                            "Tags can only be placed on a single revision, "
5138
                            "not on a range")
3298.2.8 by John Arbash Meinel
Get rid of .in_branch(need_revno=False) in favor of simpler .as_revision_id()
5139
                    revision_id = revision[0].as_revision_id(branch)
2220.2.42 by Martin Pool
Tag command refuses to replace existing tags unless you force it.
5140
                else:
5141
                    revision_id = branch.last_revision()
5142
                if (not force) and branch.tags.has_tag(tag_name):
5143
                    raise errors.TagAlreadyExists(tag_name)
5144
                branch.tags.set_tag(tag_name, revision_id)
5145
                self.outf.write('Created tag %s.\n' % tag_name)
5146
        finally:
5147
            branch.unlock()
2220.2.2 by Martin Pool
Add tag command and basic implementation
5148
5149
2220.2.24 by Martin Pool
Add tags command
5150
class cmd_tags(Command):
5151
    """List tags.
5152
3007.1.1 by Adeodato Simó
Small fix to tags' help.
5153
    This command shows a table of tag names and the revisions they reference.
2220.2.24 by Martin Pool
Add tags command
5154
    """
5155
2425.2.3 by Robert Collins
Update existing builtin commands help text to use _see_also. (Robert Collins)
5156
    _see_also = ['tag']
2220.2.24 by Martin Pool
Add tags command
5157
    takes_options = [
5158
        Option('directory',
2598.1.2 by Martin Pool
Also check that option help ends in a period, and fix those that don't
5159
            help='Branch whose tags should be displayed.',
2220.2.24 by Martin Pool
Add tags command
5160
            short_name='d',
5161
            type=unicode,
5162
            ),
2805.8.6 by Adeodato Simó
Don't sort by revno; only by time if --sort=time is passed.
5163
        RegistryOption.from_kwargs('sort',
5164
            'Sort tags by different criteria.', title='Sorting',
5165
            alpha='Sort tags lexicographically (default).',
5166
            time='Sort tags chronologically.',
5167
            ),
2805.8.3 by Adeodato Simó
Show dotted revnos, and revids only with --show-ids.
5168
        'show-ids',
3904.2.1 by Marius Kruger
* factor out _get2Revisions from cmd_log to be able to reuse how revesions is determined by log.
5169
        'revision',
2220.2.24 by Martin Pool
Add tags command
5170
    ]
5171
5172
    @display_command
5173
    def run(self,
5174
            directory='.',
2805.8.6 by Adeodato Simó
Don't sort by revno; only by time if --sort=time is passed.
5175
            sort='alpha',
2805.8.3 by Adeodato Simó
Show dotted revnos, and revids only with --show-ids.
5176
            show_ids=False,
3904.2.1 by Marius Kruger
* factor out _get2Revisions from cmd_log to be able to reuse how revesions is determined by log.
5177
            revision=None,
2220.2.24 by Martin Pool
Add tags command
5178
            ):
5179
        branch, relpath = Branch.open_containing(directory)
3904.2.1 by Marius Kruger
* factor out _get2Revisions from cmd_log to be able to reuse how revesions is determined by log.
5180
2805.8.6 by Adeodato Simó
Don't sort by revno; only by time if --sort=time is passed.
5181
        tags = branch.tags.get_tag_dict().items()
3553.1.1 by Robert Collins
Do not scan history for tags when none are present.
5182
        if not tags:
5183
            return
3904.2.1 by Marius Kruger
* factor out _get2Revisions from cmd_log to be able to reuse how revesions is determined by log.
5184
4390.1.2 by Ian Clatworthy
fix locking in tags command
5185
        branch.lock_read()
5186
        try:
5187
            if revision:
3904.2.1 by Marius Kruger
* factor out _get2Revisions from cmd_log to be able to reuse how revesions is determined by log.
5188
                graph = branch.repository.get_graph()
3904.2.4 by Marius Kruger
* rename _get2Revisions to _get_revision_range
5189
                rev1, rev2 = _get_revision_range(revision, branch, self.name())
3904.2.1 by Marius Kruger
* factor out _get2Revisions from cmd_log to be able to reuse how revesions is determined by log.
5190
                revid1, revid2 = rev1.rev_id, rev2.rev_id
5191
                # only show revisions between revid1 and revid2 (inclusive)
5192
                tags = [(tag, revid) for tag, revid in tags if
3921.3.5 by Marius Kruger
extract graph.is_between from builtins.cmd_tags.run, and test it
5193
                    graph.is_between(revid, revid1, revid2)]
4390.1.2 by Ian Clatworthy
fix locking in tags command
5194
            if sort == 'alpha':
5195
                tags.sort()
5196
            elif sort == 'time':
5197
                timestamps = {}
5198
                for tag, revid in tags:
5199
                    try:
5200
                        revobj = branch.repository.get_revision(revid)
5201
                    except errors.NoSuchRevision:
5202
                        timestamp = sys.maxint # place them at the end
5203
                    else:
5204
                        timestamp = revobj.timestamp
5205
                    timestamps[revid] = timestamp
5206
                tags.sort(key=lambda x: timestamps[x[1]])
5207
            if not show_ids:
5208
                # [ (tag, revid), ... ] -> [ (tag, dotted_revno), ... ]
5209
                for index, (tag, revid) in enumerate(tags):
5210
                    try:
5211
                        revno = branch.revision_id_to_dotted_revno(revid)
5212
                        if isinstance(revno, tuple):
5213
                            revno = '.'.join(map(str, revno))
5214
                    except errors.NoSuchRevision:
5215
                        # Bad tag data/merges can lead to tagged revisions
5216
                        # which are not in this branch. Fail gracefully ...
5217
                        revno = '?'
5218
                    tags[index] = (tag, revno)
5219
        finally:
5220
            branch.unlock()
2805.8.6 by Adeodato Simó
Don't sort by revno; only by time if --sort=time is passed.
5221
        for tag, revspec in tags:
5222
            self.outf.write('%-20s %s\n' % (tag, revspec))
2220.2.24 by Martin Pool
Add tags command
5223
5224
2796.2.5 by Aaron Bentley
Implement reconfigure command
5225
class cmd_reconfigure(Command):
2796.2.15 by Aaron Bentley
More updates from review
5226
    """Reconfigure the type of a bzr directory.
5227
5228
    A target configuration must be specified.
5229
5230
    For checkouts, the bind-to location will be auto-detected if not specified.
5231
    The order of preference is
5232
    1. For a lightweight checkout, the current bound location.
5233
    2. For branches that used to be checkouts, the previously-bound location.
5234
    3. The push location.
5235
    4. The parent location.
5236
    If none of these is available, --bind-to must be specified.
5237
    """
2796.2.5 by Aaron Bentley
Implement reconfigure command
5238
3535.4.1 by Marius Kruger
Update reconfigure help to say exactly what it wil do.
5239
    _see_also = ['branches', 'checkouts', 'standalone-trees', 'working-trees']
2796.2.5 by Aaron Bentley
Implement reconfigure command
5240
    takes_args = ['location?']
3983.3.11 by Vincent Ladeuil
Fix indentation as per Aaron's review and then some.
5241
    takes_options = [
5242
        RegistryOption.from_kwargs(
5243
            'target_type',
5244
            title='Target type',
5245
            help='The type to reconfigure the directory to.',
5246
            value_switches=True, enum_switch=False,
5247
            branch='Reconfigure to be an unbound branch with no working tree.',
5248
            tree='Reconfigure to be an unbound branch with a working tree.',
5249
            checkout='Reconfigure to be a bound branch with a working tree.',
5250
            lightweight_checkout='Reconfigure to be a lightweight'
5251
                ' checkout (with no local history).',
5252
            standalone='Reconfigure to be a standalone branch '
5253
                '(i.e. stop using shared repository).',
5254
            use_shared='Reconfigure to use a shared repository.',
5255
            with_trees='Reconfigure repository to create '
5256
                'working trees on branches by default.',
5257
            with_no_trees='Reconfigure repository to not create '
5258
                'working trees on branches by default.'
5259
            ),
5260
        Option('bind-to', help='Branch to bind checkout to.', type=str),
5261
        Option('force',
4509.3.1 by Martin Pool
Initial failing test for 'reconfigure --stacked-on'
5262
            help='Perform reconfiguration even if local changes'
5263
            ' will be lost.'),
5264
        Option('stacked-on',
4509.3.3 by Martin Pool
Add reconfigure --unstacked command
5265
            help='Reconfigure a branch to be stacked on another branch.',
4509.3.1 by Martin Pool
Initial failing test for 'reconfigure --stacked-on'
5266
            type=unicode,
5267
            ),
4509.3.3 by Martin Pool
Add reconfigure --unstacked command
5268
        Option('unstacked',
5269
            help='Reconfigure a branch to be unstacked.  This '
4509.3.34 by Martin Pool
Fix typo
5270
                'may require copying substantial data into it.',
4509.3.3 by Martin Pool
Add reconfigure --unstacked command
5271
            ),
3983.3.11 by Vincent Ladeuil
Fix indentation as per Aaron's review and then some.
5272
        ]
2796.2.5 by Aaron Bentley
Implement reconfigure command
5273
4509.3.1 by Martin Pool
Initial failing test for 'reconfigure --stacked-on'
5274
    def run(self, location=None, target_type=None, bind_to=None, force=False,
4509.3.3 by Martin Pool
Add reconfigure --unstacked command
5275
            stacked_on=None,
5276
            unstacked=None):
2796.2.5 by Aaron Bentley
Implement reconfigure command
5277
        directory = bzrdir.BzrDir.open(location)
4509.3.35 by Martin Pool
Ban reconfigure --stacked-on foo --unstacked
5278
        if stacked_on and unstacked:
5279
            raise BzrCommandError("Can't use both --stacked-on and --unstacked")
5280
        elif stacked_on is not None:
4509.3.38 by Martin Pool
Move reconfigure --stacked-on core code into reconfigure.py
5281
            reconfigure.ReconfigureStackedOn().apply(directory, stacked_on)
4509.3.3 by Martin Pool
Add reconfigure --unstacked command
5282
        elif unstacked:
4509.3.39 by Martin Pool
Move reconfigure --unstacked to reconfigure.py
5283
            reconfigure.ReconfigureUnstacked().apply(directory)
4509.3.1 by Martin Pool
Initial failing test for 'reconfigure --stacked-on'
5284
        # At the moment you can use --stacked-on and a different
5285
        # reconfiguration shape at the same time; there seems no good reason
5286
        # to ban it.
2796.2.15 by Aaron Bentley
More updates from review
5287
        if target_type is None:
4509.3.3 by Martin Pool
Add reconfigure --unstacked command
5288
            if stacked_on or unstacked:
4509.3.1 by Martin Pool
Initial failing test for 'reconfigure --stacked-on'
5289
                return
5290
            else:
4509.3.22 by Martin Pool
Fix typo in reconfigure error message
5291
                raise errors.BzrCommandError('No target configuration '
4509.3.1 by Martin Pool
Initial failing test for 'reconfigure --stacked-on'
5292
                    'specified')
2796.2.15 by Aaron Bentley
More updates from review
5293
        elif target_type == 'branch':
2796.2.5 by Aaron Bentley
Implement reconfigure command
5294
            reconfiguration = reconfigure.Reconfigure.to_branch(directory)
5295
        elif target_type == 'tree':
5296
            reconfiguration = reconfigure.Reconfigure.to_tree(directory)
5297
        elif target_type == 'checkout':
3983.3.11 by Vincent Ladeuil
Fix indentation as per Aaron's review and then some.
5298
            reconfiguration = reconfigure.Reconfigure.to_checkout(
5299
                directory, bind_to)
2796.2.19 by Aaron Bentley
Support reconfigure --lightweight-checkout
5300
        elif target_type == 'lightweight-checkout':
5301
            reconfiguration = reconfigure.Reconfigure.to_lightweight_checkout(
5302
                directory, bind_to)
3311.2.6 by Aaron Bentley
rename 'sharing' to 'use-shared'
5303
        elif target_type == 'use-shared':
5304
            reconfiguration = reconfigure.Reconfigure.to_use_shared(directory)
3311.2.5 by Aaron Bentley
Implement reconfigure --standalone and --sharing
5305
        elif target_type == 'standalone':
5306
            reconfiguration = reconfigure.Reconfigure.to_standalone(directory)
3921.4.3 by Matthew Fuller
Add --with-trees and --with-no-trees to the 'reconfigure' command.
5307
        elif target_type == 'with-trees':
5308
            reconfiguration = reconfigure.Reconfigure.set_repository_trees(
5309
                directory, True)
5310
        elif target_type == 'with-no-trees':
5311
            reconfiguration = reconfigure.Reconfigure.set_repository_trees(
5312
                directory, False)
2796.2.5 by Aaron Bentley
Implement reconfigure command
5313
        reconfiguration.apply(force)
5314
5315
2999.1.1 by Ian Clatworthy
migrate switch command into the core - was in BzrTools
5316
class cmd_switch(Command):
3078.2.2 by Ian Clatworthy
get switch tests passing on heavyweight checkouts
5317
    """Set the branch of a checkout and update.
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
5318
3078.2.2 by Ian Clatworthy
get switch tests passing on heavyweight checkouts
5319
    For lightweight checkouts, this changes the branch being referenced.
5320
    For heavyweight checkouts, this checks that there are no local commits
5321
    versus the current bound branch, then it makes the local branch a mirror
5322
    of the new location and binds to it.
3565.6.15 by Marius Kruger
update bind and switch command descriptions to state what will happen to nicknames.
5323
3078.2.2 by Ian Clatworthy
get switch tests passing on heavyweight checkouts
5324
    In both cases, the working tree is updated and uncommitted changes
3565.6.15 by Marius Kruger
update bind and switch command descriptions to state what will happen to nicknames.
5325
    are merged. The user can commit or revert these as they desire.
3078.2.2 by Ian Clatworthy
get switch tests passing on heavyweight checkouts
5326
5327
    Pending merges need to be committed or reverted before using switch.
3246.5.1 by Robert Collins
* ``bzr switch`` will attempt to find branches to switch to relative to the
5328
5329
    The path to the branch to switch to can be specified relative to the parent
5330
    directory of the current branch. For example, if you are currently in a
5331
    checkout of /path/to/branch, specifying 'newbranch' will find a branch at
5332
    /path/to/newbranch.
3565.6.15 by Marius Kruger
update bind and switch command descriptions to state what will happen to nicknames.
5333
3565.6.16 by Marius Kruger
update nick command description to mention how it works for bound branches,
5334
    Bound branches use the nickname of its master branch unless it is set
3565.6.15 by Marius Kruger
update bind and switch command descriptions to state what will happen to nicknames.
5335
    locally, in which case switching will update the the local nickname to be
5336
    that of the master.
3078.2.2 by Ian Clatworthy
get switch tests passing on heavyweight checkouts
5337
    """
2999.1.1 by Ian Clatworthy
migrate switch command into the core - was in BzrTools
5338
5339
    takes_args = ['to_location']
3078.2.2 by Ian Clatworthy
get switch tests passing on heavyweight checkouts
5340
    takes_options = [Option('force',
4520.1.1 by John Arbash Meinel
'bzr switch -b' can now be used to create the branch while you switch to it.
5341
                        help='Switch even if local commits will be lost.'),
5342
                     Option('create-branch', short_name='b',
5343
                        help='Create the target branch from this one before'
5344
                             ' switching to it.'),
3078.2.2 by Ian Clatworthy
get switch tests passing on heavyweight checkouts
5345
                     ]
2999.1.1 by Ian Clatworthy
migrate switch command into the core - was in BzrTools
5346
4520.1.1 by John Arbash Meinel
'bzr switch -b' can now be used to create the branch while you switch to it.
5347
    def run(self, to_location, force=False, create_branch=False):
2999.1.2 by Ian Clatworthy
incorporate review feedback including basic blackbox tests
5348
        from bzrlib import switch
2999.1.1 by Ian Clatworthy
migrate switch command into the core - was in BzrTools
5349
        tree_location = '.'
2999.1.2 by Ian Clatworthy
incorporate review feedback including basic blackbox tests
5350
        control_dir = bzrdir.BzrDir.open_containing(tree_location)[0]
4354.2.1 by Aaron Bentley
Improve switch --force with lightweight checkouts.
5351
        try:
5352
            branch = control_dir.open_branch()
5353
            had_explicit_nick = branch.get_config().has_explicit_nickname()
5354
        except errors.NotBranchError:
4520.1.1 by John Arbash Meinel
'bzr switch -b' can now be used to create the branch while you switch to it.
5355
            branch = None
4354.2.1 by Aaron Bentley
Improve switch --force with lightweight checkouts.
5356
            had_explicit_nick = False
4520.1.1 by John Arbash Meinel
'bzr switch -b' can now be used to create the branch while you switch to it.
5357
        if create_branch:
5358
            if branch is None:
5359
                raise errors.BzrCommandError('cannot create branch without'
5360
                                             ' source branch')
5361
            if '/' not in to_location and '\\' not in to_location:
5362
                # This path is meant to be relative to the existing branch
5363
                this_url = self._get_branch_location(control_dir)
5364
                to_location = urlutils.join(this_url, '..', to_location)
5365
            to_branch = branch.bzrdir.sprout(to_location,
5366
                                 possible_transports=[branch.bzrdir.root_transport],
5367
                                 source_branch=branch).open_branch()
5368
            # try:
5369
            #     from_branch = control_dir.open_branch()
5370
            # except errors.NotBranchError:
5371
            #     raise BzrCommandError('Cannot create a branch from this'
5372
            #         ' location when we cannot open this branch')
5373
            # from_branch.bzrdir.sprout(
5374
            pass
5375
        else:
5376
            try:
5377
                to_branch = Branch.open(to_location)
5378
            except errors.NotBranchError:
5379
                this_url = self._get_branch_location(control_dir)
5380
                to_branch = Branch.open(
5381
                    urlutils.join(this_url, '..', to_location))
3078.2.2 by Ian Clatworthy
get switch tests passing on heavyweight checkouts
5382
        switch.switch(control_dir, to_branch, force)
4354.2.1 by Aaron Bentley
Improve switch --force with lightweight checkouts.
5383
        if had_explicit_nick:
3565.6.7 by Marius Kruger
* checkouts now use master nick when no explicit nick is set.
5384
            branch = control_dir.open_branch() #get the new branch!
5385
            branch.nick = to_branch.nick
2999.1.1 by Ian Clatworthy
migrate switch command into the core - was in BzrTools
5386
        note('Switched to branch: %s',
5387
            urlutils.unescape_for_display(to_branch.base, 'utf-8'))
5388
4354.2.1 by Aaron Bentley
Improve switch --force with lightweight checkouts.
5389
    def _get_branch_location(self, control_dir):
5390
        """Return location of branch for this control dir."""
5391
        try:
5392
            this_branch = control_dir.open_branch()
5393
            # This may be a heavy checkout, where we want the master branch
4354.2.2 by Aaron Bentley
Enable switch --force for lightweight checkouts after moves.
5394
            master_location = this_branch.get_bound_location()
5395
            if master_location is not None:
5396
                return master_location
4354.2.1 by Aaron Bentley
Improve switch --force with lightweight checkouts.
5397
            # If not, use a local sibling
5398
            return this_branch.base
5399
        except errors.NotBranchError:
5400
            format = control_dir.find_branch_format()
5401
            if getattr(format, 'get_reference', None) is not None:
5402
                return format.get_reference(control_dir)
5403
            else:
5404
                return control_dir.root_transport.base
5405
2999.1.1 by Ian Clatworthy
migrate switch command into the core - was in BzrTools
5406
3586.1.9 by Ian Clatworthy
first cut at view command
5407
class cmd_view(Command):
5408
    """Manage filtered views.
3586.1.33 by Ian Clatworthy
cleanup trailing whitespace
5409
3586.1.9 by Ian Clatworthy
first cut at view command
5410
    Views provide a mask over the tree so that users can focus on
5411
    a subset of a tree when doing their work. After creating a view,
5412
    commands that support a list of files - status, diff, commit, etc -
5413
    effectively have that list of files implicitly given each time.
5414
    An explicit list of files can still be given but those files
5415
    must be within the current view.
5416
5417
    In most cases, a view has a short life-span: it is created to make
5418
    a selected change and is deleted once that change is committed.
5419
    At other times, you may wish to create one or more named views
3586.1.14 by Ian Clatworthy
added --all option to the view command
5420
    and switch between them.
3586.1.33 by Ian Clatworthy
cleanup trailing whitespace
5421
3586.1.9 by Ian Clatworthy
first cut at view command
5422
    To disable the current view without deleting it, you can switch to
5423
    the pseudo view called ``off``. This can be useful when you need
5424
    to see the whole tree for an operation or two (e.g. merge) but
5425
    want to switch back to your view after that.
5426
5427
    :Examples:
3586.1.14 by Ian Clatworthy
added --all option to the view command
5428
      To define the current view::
3586.1.9 by Ian Clatworthy
first cut at view command
5429
5430
        bzr view file1 dir1 ...
5431
5432
      To list the current view::
5433
5434
        bzr view
5435
5436
      To delete the current view::
5437
5438
        bzr view --delete
5439
5440
      To disable the current view without deleting it::
5441
5442
        bzr view --switch off
5443
3586.1.14 by Ian Clatworthy
added --all option to the view command
5444
      To define a named view and switch to it::
3586.1.9 by Ian Clatworthy
first cut at view command
5445
5446
        bzr view --name view-name file1 dir1 ...
5447
5448
      To list a named view::
5449
5450
        bzr view --name view-name
5451
5452
      To delete a named view::
5453
5454
        bzr view --name view-name --delete
5455
5456
      To switch to a named view::
5457
5458
        bzr view --switch view-name
3586.1.14 by Ian Clatworthy
added --all option to the view command
5459
5460
      To list all views defined::
5461
5462
        bzr view --all
5463
5464
      To delete all views::
5465
5466
        bzr view --delete --all
3586.1.9 by Ian Clatworthy
first cut at view command
5467
    """
5468
3586.1.14 by Ian Clatworthy
added --all option to the view command
5469
    _see_also = []
3586.1.9 by Ian Clatworthy
first cut at view command
5470
    takes_args = ['file*']
5471
    takes_options = [
3586.1.14 by Ian Clatworthy
added --all option to the view command
5472
        Option('all',
5473
            help='Apply list or delete action to all views.',
5474
            ),
3586.1.9 by Ian Clatworthy
first cut at view command
5475
        Option('delete',
5476
            help='Delete the view.',
5477
            ),
5478
        Option('name',
3586.1.14 by Ian Clatworthy
added --all option to the view command
5479
            help='Name of the view to define, list or delete.',
3586.1.9 by Ian Clatworthy
first cut at view command
5480
            type=unicode,
5481
            ),
5482
        Option('switch',
5483
            help='Name of the view to switch to.',
5484
            type=unicode,
5485
            ),
5486
        ]
5487
5488
    def run(self, file_list,
3586.1.14 by Ian Clatworthy
added --all option to the view command
5489
            all=False,
3586.1.9 by Ian Clatworthy
first cut at view command
5490
            delete=False,
5491
            name=None,
5492
            switch=None,
5493
            ):
5494
        tree, file_list = tree_files(file_list, apply_view=False)
5495
        current_view, view_dict = tree.views.get_view_info()
5496
        if name is None:
5497
            name = current_view
5498
        if delete:
5499
            if file_list:
3586.1.11 by Ian Clatworthy
tweak user feedback
5500
                raise errors.BzrCommandError(
5501
                    "Both --delete and a file list specified")
3586.1.9 by Ian Clatworthy
first cut at view command
5502
            elif switch:
3586.1.11 by Ian Clatworthy
tweak user feedback
5503
                raise errors.BzrCommandError(
5504
                    "Both --delete and --switch specified")
3586.1.14 by Ian Clatworthy
added --all option to the view command
5505
            elif all:
5506
                tree.views.set_view_info(None, {})
5507
                self.outf.write("Deleted all views.\n")
3586.1.9 by Ian Clatworthy
first cut at view command
5508
            elif name is None:
3586.1.11 by Ian Clatworthy
tweak user feedback
5509
                raise errors.BzrCommandError("No current view to delete")
3586.1.9 by Ian Clatworthy
first cut at view command
5510
            else:
5511
                tree.views.delete_view(name)
5512
                self.outf.write("Deleted '%s' view.\n" % name)
5513
        elif switch:
5514
            if file_list:
3586.1.11 by Ian Clatworthy
tweak user feedback
5515
                raise errors.BzrCommandError(
5516
                    "Both --switch and a file list specified")
3586.1.14 by Ian Clatworthy
added --all option to the view command
5517
            elif all:
5518
                raise errors.BzrCommandError(
5519
                    "Both --switch and --all specified")
3586.1.9 by Ian Clatworthy
first cut at view command
5520
            elif switch == 'off':
5521
                if current_view is None:
3586.1.11 by Ian Clatworthy
tweak user feedback
5522
                    raise errors.BzrCommandError("No current view to disable")
3586.1.9 by Ian Clatworthy
first cut at view command
5523
                tree.views.set_view_info(None, view_dict)
3586.1.11 by Ian Clatworthy
tweak user feedback
5524
                self.outf.write("Disabled '%s' view.\n" % (current_view))
3586.1.9 by Ian Clatworthy
first cut at view command
5525
            else:
5526
                tree.views.set_view_info(switch, view_dict)
3586.1.20 by Ian Clatworthy
centralise formatting of view file lists
5527
                view_str = views.view_display_str(tree.views.lookup_view())
5528
                self.outf.write("Using '%s' view: %s\n" % (switch, view_str))
3586.1.14 by Ian Clatworthy
added --all option to the view command
5529
        elif all:
5530
            if view_dict:
5531
                self.outf.write('Views defined:\n')
5532
                for view in sorted(view_dict):
5533
                    if view == current_view:
5534
                        active = "=>"
5535
                    else:
5536
                        active = "  "
3586.1.20 by Ian Clatworthy
centralise formatting of view file lists
5537
                    view_str = views.view_display_str(view_dict[view])
5538
                    self.outf.write('%s %-20s %s\n' % (active, view, view_str))
3586.1.14 by Ian Clatworthy
added --all option to the view command
5539
            else:
5540
                self.outf.write('No views defined.\n')
3586.1.9 by Ian Clatworthy
first cut at view command
5541
        elif file_list:
5542
            if name is None:
5543
                # No name given and no current view set
5544
                name = 'my'
5545
            elif name == 'off':
3586.1.11 by Ian Clatworthy
tweak user feedback
5546
                raise errors.BzrCommandError(
5547
                    "Cannot change the 'off' pseudo view")
3586.1.9 by Ian Clatworthy
first cut at view command
5548
            tree.views.set_view(name, sorted(file_list))
3586.1.20 by Ian Clatworthy
centralise formatting of view file lists
5549
            view_str = views.view_display_str(tree.views.lookup_view())
3586.1.11 by Ian Clatworthy
tweak user feedback
5550
            self.outf.write("Using '%s' view: %s\n" % (name, view_str))
3586.1.9 by Ian Clatworthy
first cut at view command
5551
        else:
5552
            # list the files
3586.1.13 by Ian Clatworthy
fix list of a known view when no current view set
5553
            if name is None:
5554
                # No name given and no current view set
3586.1.9 by Ian Clatworthy
first cut at view command
5555
                self.outf.write('No current view.\n')
5556
            else:
3586.1.20 by Ian Clatworthy
centralise formatting of view file lists
5557
                view_str = views.view_display_str(tree.views.lookup_view(name))
3586.1.11 by Ian Clatworthy
tweak user feedback
5558
                self.outf.write("'%s' view is: %s\n" % (name, view_str))
3586.1.9 by Ian Clatworthy
first cut at view command
5559
5560
3254.2.1 by Daniel Watkins
Added cmd_hooks.
5561
class cmd_hooks(Command):
4119.3.2 by Robert Collins
Migrate existing hooks over to the new HookPoint infrastructure.
5562
    """Show hooks."""
3254.2.1 by Daniel Watkins
Added cmd_hooks.
5563
3254.2.9 by Daniel Watkins
Made cmd_hooks hidden.
5564
    hidden = True
3254.2.1 by Daniel Watkins
Added cmd_hooks.
5565
4119.3.2 by Robert Collins
Migrate existing hooks over to the new HookPoint infrastructure.
5566
    def run(self):
5567
        for hook_key in sorted(hooks.known_hooks.keys()):
5568
            some_hooks = hooks.known_hooks_key_to_object(hook_key)
5569
            self.outf.write("%s:\n" % type(some_hooks).__name__)
5570
            for hook_name, hook_point in sorted(some_hooks.items()):
5571
                self.outf.write("  %s:\n" % (hook_name,))
5572
                found_hooks = list(hook_point)
5573
                if found_hooks:
5574
                    for hook in found_hooks:
5575
                        self.outf.write("    %s\n" %
5576
                                        (some_hooks.get_hook_name(hook),))
5577
                else:
5578
                    self.outf.write("    <no hooks installed>\n")
3254.2.1 by Daniel Watkins
Added cmd_hooks.
5579
5580
0.16.80 by Aaron Bentley
Rename shelve2/unshelve2 to shelve/unshelve
5581
class cmd_shelve(Command):
0.16.74 by Aaron Bentley
Merge with shelf-manager
5582
    """Temporarily set aside some changes from the current tree.
5583
5584
    Shelve allows you to temporarily put changes you've made "on the shelf",
5585
    ie. out of the way, until a later time when you can bring them back from
3990.2.6 by Daniel Watkins
Improved shelve documentation, as per #327421.
5586
    the shelf with the 'unshelve' command.  The changes are stored alongside
5587
    your working tree, and so they aren't propagated along with your branch nor
5588
    will they survive its deletion.
0.16.74 by Aaron Bentley
Merge with shelf-manager
5589
0.16.113 by Aaron Bentley
Change ls-shelf to shelve --list
5590
    If shelve --list is specified, previously-shelved changes are listed.
5591
0.16.74 by Aaron Bentley
Merge with shelf-manager
5592
    Shelve is intended to help separate several sets of changes that have
5593
    been inappropriately mingled.  If you just want to get rid of all changes
5594
    and you don't need to restore them later, use revert.  If you want to
5595
    shelve all text changes at once, use shelve --all.
5596
5597
    If filenames are specified, only the changes to those files will be
5598
    shelved. Other files will be left untouched.
5599
5600
    If a revision is specified, changes since that revision will be shelved.
5601
5602
    You can put multiple items on the shelf, and by default, 'unshelve' will
5603
    restore the most recently shelved changes.
5604
    """
5605
5606
    takes_args = ['file*']
5607
5608
    takes_options = [
5609
        'revision',
5610
        Option('all', help='Shelve all changes.'),
5611
        'message',
0.16.108 by Aaron Bentley
Shelf supports multiple diff writers.
5612
        RegistryOption('writer', 'Method to use for writing diffs.',
5613
                       bzrlib.option.diff_writer_registry,
0.16.113 by Aaron Bentley
Change ls-shelf to shelve --list
5614
                       value_switches=True, enum_switch=False),
5615
0.16.119 by Aaron Bentley
Fix option help style.
5616
        Option('list', help='List shelved changes.'),
4100.3.1 by Aaron Bentley
Implement shelve --destroy
5617
        Option('destroy',
5618
               help='Destroy removed changes instead of shelving them.'),
0.16.74 by Aaron Bentley
Merge with shelf-manager
5619
    ]
0.16.117 by Aaron Bentley
Remove references to ls-shelf
5620
    _see_also = ['unshelve']
0.16.74 by Aaron Bentley
Merge with shelf-manager
5621
0.16.108 by Aaron Bentley
Shelf supports multiple diff writers.
5622
    def run(self, revision=None, all=False, file_list=None, message=None,
4100.3.1 by Aaron Bentley
Implement shelve --destroy
5623
            writer=None, list=False, destroy=False):
0.16.113 by Aaron Bentley
Change ls-shelf to shelve --list
5624
        if list:
5625
            return self.run_for_list()
0.16.74 by Aaron Bentley
Merge with shelf-manager
5626
        from bzrlib.shelf_ui import Shelver
0.16.108 by Aaron Bentley
Shelf supports multiple diff writers.
5627
        if writer is None:
5628
            writer = bzrlib.option.diff_writer_registry.get()
0.16.103 by Aaron Bentley
raise UserAbort instead of doing sys.exit
5629
        try:
0.16.108 by Aaron Bentley
Shelf supports multiple diff writers.
5630
            Shelver.from_args(writer(sys.stdout), revision, all, file_list,
4100.3.1 by Aaron Bentley
Implement shelve --destroy
5631
                              message, destroy=destroy).run()
0.16.103 by Aaron Bentley
raise UserAbort instead of doing sys.exit
5632
        except errors.UserAbort:
5633
            return 0
0.16.74 by Aaron Bentley
Merge with shelf-manager
5634
0.16.113 by Aaron Bentley
Change ls-shelf to shelve --list
5635
    def run_for_list(self):
0.16.118 by Aaron Bentley
Fix open_containing
5636
        tree = WorkingTree.open_containing('.')[0]
0.16.113 by Aaron Bentley
Change ls-shelf to shelve --list
5637
        tree.lock_read()
5638
        try:
5639
            manager = tree.get_shelf_manager()
5640
            shelves = manager.active_shelves()
5641
            if len(shelves) == 0:
5642
                note('No shelved changes.')
5643
                return 0
5644
            for shelf_id in reversed(shelves):
5645
                message = manager.get_metadata(shelf_id).get('message')
5646
                if message is None:
5647
                    message = '<no message>'
5648
                self.outf.write('%3d: %s\n' % (shelf_id, message))
5649
            return 1
5650
        finally:
5651
            tree.unlock()
5652
0.16.74 by Aaron Bentley
Merge with shelf-manager
5653
0.16.80 by Aaron Bentley
Rename shelve2/unshelve2 to shelve/unshelve
5654
class cmd_unshelve(Command):
0.16.74 by Aaron Bentley
Merge with shelf-manager
5655
    """Restore shelved changes.
5656
5657
    By default, the most recently shelved changes are restored. However if you
3990.2.5 by Daniel Watkins
Improve unshelve documentation, as per #327425.
5658
    specify a shelf by id those changes will be restored instead.  This works
5659
    best when the changes don't depend on each other.
0.16.74 by Aaron Bentley
Merge with shelf-manager
5660
    """
5661
5662
    takes_args = ['shelf_id?']
5663
    takes_options = [
5664
        RegistryOption.from_kwargs(
5665
            'action', help="The action to perform.",
5666
            enum_switch=False, value_switches=True,
5667
            apply="Apply changes and remove from the shelf.",
5668
            dry_run="Show changes, but do not apply or remove them.",
5669
            delete_only="Delete changes without applying them."
5670
        )
5671
    ]
0.16.117 by Aaron Bentley
Remove references to ls-shelf
5672
    _see_also = ['shelve']
0.16.74 by Aaron Bentley
Merge with shelf-manager
5673
5674
    def run(self, shelf_id=None, action='apply'):
5675
        from bzrlib.shelf_ui import Unshelver
5676
        Unshelver.from_args(shelf_id, action).run()
5677
5678
4020.1.1 by Jelmer Vernooij
Import clean-tree from bzrtools.
5679
class cmd_clean_tree(Command):
5680
    """Remove unwanted files from working tree.
5681
5682
    By default, only unknown files, not ignored files, are deleted.  Versioned
5683
    files are never deleted.
5684
5685
    Another class is 'detritus', which includes files emitted by bzr during
5686
    normal operations and selftests.  (The value of these files decreases with
5687
    time.)
5688
5689
    If no options are specified, unknown files are deleted.  Otherwise, option
5690
    flags are respected, and may be combined.
5691
5692
    To check what clean-tree will do, use --dry-run.
5693
    """
5694
    takes_options = [Option('ignored', help='Delete all ignored files.'),
5695
                     Option('detritus', help='Delete conflict files, merge'
5696
                            ' backups, and failed selftest dirs.'),
5697
                     Option('unknown',
5698
                            help='Delete files unknown to bzr (default).'),
5699
                     Option('dry-run', help='Show files to delete instead of'
5700
                            ' deleting them.'),
5701
                     Option('force', help='Do not prompt before deleting.')]
5702
    def run(self, unknown=False, ignored=False, detritus=False, dry_run=False,
5703
            force=False):
5704
        from bzrlib.clean_tree import clean_tree
5705
        if not (unknown or ignored or detritus):
5706
            unknown = True
5707
        if dry_run:
5708
            force = True
4020.1.5 by Aaron Bentley
Fix some formatting issues.
5709
        clean_tree('.', unknown=unknown, ignored=ignored, detritus=detritus,
4020.1.1 by Jelmer Vernooij
Import clean-tree from bzrtools.
5710
                   dry_run=dry_run, no_prompt=force)
5711
5712
4273.1.19 by Aaron Bentley
Implement reference command
5713
class cmd_reference(Command):
5714
    """list, view and set branch locations for nested trees.
5715
5716
    If no arguments are provided, lists the branch locations for nested trees.
5717
    If one argument is provided, display the branch location for that tree.
5718
    If two arguments are provided, set the branch location for that tree.
5719
    """
5720
5721
    hidden = True
5722
5723
    takes_args = ['path?', 'location?']
5724
5725
    def run(self, path=None, location=None):
5726
        branchdir = '.'
5727
        if path is not None:
5728
            branchdir = path
5729
        tree, branch, relpath =(
5730
            bzrdir.BzrDir.open_containing_tree_or_branch(branchdir))
5731
        if path is not None:
5732
            path = relpath
5733
        if tree is None:
5734
            tree = branch.basis_tree()
5735
        if path is None:
5736
            info = branch._get_all_reference_info().iteritems()
5737
            self._display_reference_info(tree, branch, info)
5738
        else:
5739
            file_id = tree.path2id(path)
5740
            if file_id is None:
5741
                raise errors.NotVersionedError(path)
5742
            if location is None:
5743
                info = [(file_id, branch.get_reference_info(file_id))]
5744
                self._display_reference_info(tree, branch, info)
5745
            else:
5746
                branch.set_reference_info(file_id, path, location)
5747
5748
    def _display_reference_info(self, tree, branch, info):
5749
        ref_list = []
5750
        for file_id, (path, location) in info:
5751
            try:
5752
                path = tree.id2path(file_id)
5753
            except errors.NoSuchId:
5754
                pass
5755
            ref_list.append((path, location))
5756
        for path, location in sorted(ref_list):
5757
            self.outf.write('%s %s\n' % (path, location))
5758
5759
1185.16.33 by Martin Pool
- move 'conflict' and 'resolved' from shipped plugin to regular builtins
5760
# these get imported and then picked up by the scan for cmd_*
5761
# TODO: Some more consistent way to split command definitions across files;
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
5762
# we do need to load at least some information about them to know of
1616.1.7 by Martin Pool
New developer commands 'weave-list' and 'weave-join'.
5763
# aliases.  ideally we would avoid loading the implementation until the
5764
# details were needed.
2022.1.2 by John Arbash Meinel
rename version_info => cmd_version_info
5765
from bzrlib.cmd_version_info import cmd_version_info
1185.35.4 by Aaron Bentley
Implemented remerge
5766
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore
2520.4.35 by Aaron Bentley
zap obsolete changeset commands, add bundle-info command
5767
from bzrlib.bundle.commands import (
5768
    cmd_bundle_info,
5769
    )
3920.2.2 by Jelmer Vernooij
Import dpush command.
5770
from bzrlib.foreign import cmd_dpush
1185.78.6 by John Arbash Meinel
Adding sign-my-commits as a builtin, along with some simple tests.
5771
from bzrlib.sign_my_commits import cmd_sign_my_commits
3350.6.4 by Robert Collins
First cut at pluralised VersionedFiles. Some rather massive API incompatabilities, primarily because of the difficulty of coherence among competing stores.
5772
from bzrlib.weave_commands import cmd_versionedfile_list, \
1616.1.17 by Martin Pool
New 'weave-plan-merge' and 'weave-merge-text' commands lifted from weave.py
5773
        cmd_weave_plan_merge, cmd_weave_merge_text