11
:2.4b3: NOT RELEASED YET
13
External Compatibility Breaks
14
*****************************
16
.. These may require users to change the way they use Bazaar.
18
* ``bzr-2.4`` has officially dropped support for python2.4 and python2.5.
19
We will continue to maintain ``bzr-2.3`` for people who still need to
20
use those versions of python. (John Arbash Meinel)
25
.. New commands, options, etc that users may wish to try out.
30
.. Improvements to existing commands, especially improved performance
31
or memory usage, or better results.
33
* ``bzr branch --stacked`` from a smart server uses the network a little
34
more efficiently. For a simple branch it reduces the number of
35
round-trips by about 20%. (Andrew Bennetts)
37
* Slightly reduced memory consumption when fetching into a 2a repository
38
by reusing existing caching a little better. (Andrew Bennetts)
40
* Speed up ``bzr status`` by a little bit when there are a couple of
41
modified files. We now track how many files we have seen that need
42
updating, and only rewrite the dirstate file if enough of them have
43
changed. The default is 10, and can be overridden by setting the branch
44
option "``bzr.workingtree.worth_saving_limit``".
45
(Ian Clatworthy, John Arbash Meinel, #380202)
50
.. Fixes for situations where bzr would previously crash or give incorrect
51
or undesirable results.
53
* All Tree types can now be exported as tar.*, zip or directories.
56
* Correct parent is now set when using 'switch -b' with bound branches.
57
(A. S. Budden, #513709)
59
* ``WT.inventory`` and ``WT.iter_entries_by_dir()`` was not correctly
60
reporting subdirectories that were tree references (in formats that
61
supported them). (John Arbash Meinel, #764677)
67
.. Improved or updated documentation.
72
.. Changes that may require updates in plugins or other code that uses
75
* ``annotate_file`` has been deprecated in favor of
76
``annotate_file_revision_tree``. (Jelmer Vernooij, #775598)
78
* ``Inter.get`` now raises ``NoCompatibleInter`` if there are no
79
compatible optimisers rather than an instance of the class it is called
82
* The default implementation of ``Branch`` is now oriented to
83
storing the branch tip. Branch implementations which store the full
84
history should now subclass ``FullHistoryBzrBranch``.
85
``Branch._last_revision_info`` has been renamed to
86
``Branch._read_last_revision_info`` (Jelmer Vernooij)
88
* ``Tree.__iter__`` has been deprecated; use ``Tree.all_file_ids``
89
instead. (Jelmer Vernooij)
94
.. Major internal changes, unlikely to be visible to users or plugin
95
developers, but interesting for bzr developers.
100
.. Fixes and changes that are only relevant to bzr's test framework and
101
suite. This can include new facilities for writing tests, fixes to
102
spurious test failures and changes to the way things should be tested.
110
This is the second beta of the 2.4 series, leading to a 2.4.0 release in
111
August 2011. Beta releases are suitable for everyday use but may cause some
112
incompatibilities with plugins.
114
This release includes all bug fixed in previous series known at the time of
118
External Compatibility Breaks
119
*****************************
121
.. These may require users to change the way they use Bazaar.
123
* Two command synonyms for ``bzr branch`` have been deprecated, to avoid
124
confusion and to allow the names to later be reused. The removed names
125
are: ``get`` and ``clone``. (Martin Pool, #506265)
130
.. New commands, options, etc that users may wish to try out.
132
* ``bzr commit`` now supports a ``--lossy`` argument that can be used
133
to discard any data that can not be natively represented when committing
134
to a foreign VCS. (Jelmer Vernooij, #587721)
139
.. Improvements to existing commands, especially improved performance
140
or memory usage, or better results.
142
* ``bzr merge`` in large trees is now significantly faster. On a 70k entry
143
tree, the time went from ~3min down to 30s. This also effects ``bzr pull``
144
and ``bzr update`` since they use the same merge logic to update the
145
WorkingTree. (John Arbash Meinel, #759091)
147
* ``bzr revert`` now properly uses ``bzr status``'s optimized
148
``iter_changes``. This can be a significant performance difference (33s
149
to 5s on large trees). (John Arbash Meinel, #759096)
151
* Resolve ``lp:FOO`` urls locally rather than doing an XMLRPC request if
152
the user has done ``bzr launchpad-login``. The bzr+ssh URLs were already
153
being handed off to the remote server anyway (xmlrpc has been mapping
154
``lp:bzr`` to ``bzr+ssh://bazaar.launchpad.net/+branch/bzr``, rather
155
than ``bzr+ssh://bazaar.launchpad.net/~bzr-pqm/bzr/bzr.dev`` for a few
156
months now.) By doing it ourselves, we can cut out substantial startup
157
time. From Netherlands to London it was taking 368ms to do the XMLRPC
158
call as much as 2s from Sydney. You can test the local logic by using
159
``-Dlaunchpad``. (John Arbash Meinel, #397739)
161
* When building a new WorkingTree (such as during ``bzr co`` or
162
``bzr branch``) we now properly store the stat and hash of files that
163
are old enough. This saves a fair amount of time on the first
164
``bzr status`` (on a 500MB tree, it saves about 30+s).
165
(John Arbash Meinel, #740932)
171
.. Fixes for situations where bzr would previously crash or give incorrect
172
or undesirable results.
174
* Arguments that can't be decoded to unicode in the current posix locale give
175
a clearer error message without a traceback. (Martin [gz], #745712)
177
* ``bzrlib.log._DEFAULT_REQUEST_PARAMS`` is no longer accidentally
178
mutated by ``bzrlib.log._apply_log_request_defaults``. In practice
179
these default values aren't relied on very often so this probably
180
wasn't causing any trouble. (Andrew Bennetts)
182
* ``bzr log`` now works on revisions which are not in the current branch.
183
(Matt Giuca, #241998)
185
* Don't rewrite the dirstate file when non-interesting changes have
186
occurred. This can significantly improve 'bzr status' times when there
187
are only small changes to a large tree.
188
(Ian Clatworthy, John Arbash Meinel, #380202)
190
* Lazy hooks are now reset between test runs. (Jelmer Vernooij, #745566)
192
* ``bzrlib.merge.Merge`` now calls ``iter_changes`` without
193
``include_unversioned=True``. This makes it significantly faster in many
194
cases, because it only looks at modified files, rather than building
195
information about all files. This can cause failures in other
196
TreeTransform code, because it had been expecting to know the names of
197
things which had not changed (such as parent directories). All cases we
198
know about so far have been fixed, but there may be fallout for edge
199
cases that we are missing. (John Arbash Meinel, #759091)
201
* ``SFTPTransport`` is more pro-active about closing file-handles. This
202
reduces the chance of having threads fail from async requests while
203
running the test suite. (John Arbash Meinel, #656170)
205
* Standalone bzr.exe installation on Windows: user can put additional python
206
libraries into ``site-packages`` subdirectory of the installation directory,
207
this might be required for "installing" extra dependencies for some plugins.
208
(Alexander Belchenko, #743256)
210
* ``transform.revert()`` has been updated to use
211
``wt.iter_changes(basis_tree)`` rather than
212
``basis_tree.iter_changes(wt)``. This allows the optimized code path to
213
kick in, improving ``bzr revert`` times significantly (33s to 4s on
214
large trees, 0.7s to 0.3s on small trees.) (John Arbash Meinel, #759096)
216
* ``TreeTransform.create_file/new_file`` can now take an optional ``sha1``
217
parameter. If supplied, when the transform is applied, it will then call
218
``self._tree._observed_sha1`` for those files. This lets us update the
219
hash-cache for content that we create, preventing us from re-reading the
220
content in the next ``bzr status``. (John Arbash Meinel, #740932)
225
* Added a section about using a shared SSH account on a server for bzr+ssh
226
access. (Russell Smith)
228
* The documentation now recommends using SSH rather than SFTP in the
229
tutorials and the examples, because that will generally be much faster
230
and better in cases where it can be used. SFTP is still available and
231
mentioned as an alternative. (Martin Pool, #636712)
236
.. Changes that may require updates in plugins or other code that uses
239
* ``Branch.update_revisions`` has been made private and should no
240
longer be used by external users. Use ``Branch.pull`` or ``Branch.push``
241
instead. (Jelmer Vernooij, #771765)
243
* Commands now have an `invoked_as` attribute, showing the name under
244
which they were called before alias expansion.
247
* ``Hooks.create_hook`` is now deprecated in favour of ``Hooks.add_hook``.
250
* If you call `bzrlib.initialize` but forget to enter the resulting object
251
as a context manager, bzrlib will now be initialized anyhow.
252
(Previously simple programs calling bzrlib might find the library was
253
mysteriously silent.)
256
* Inventory-specific functionality has been split out of ``Tree`` into
257
a new ``InventoryTree`` class. Tree instances no longer
258
necessarily provide an ``inventory`` attribute. (Jelmer Vernooij)
260
* Inventory-specific functionality has been split out of ``RevisionTree``
261
into a new ``InventoryRevisionTree`` class. RevisionTree instances no
262
longer necessarily provide an ``inventory`` attribute. (Jelmer Vernooij)
264
* New method ``Hooks.uninstall_named_hook``. (Jelmer Vernooij, #301472)
266
* ``revision_graph_can_have_wrong_parents`` is now an attribute
267
on ``RepositoryFormat`` rather than a method on ``Repository``.
270
* ``Testament`` now takes a ``tree`` rather than an
271
``inventory``. (Jelmer Vernooij, #762608)
273
* ``TestCase.failUnlessExists`` and ``failIfExists`` are deprecated in
274
favour of ``assertPathExists`` and ``assertPathDoesNotExist``
278
* The ``revno`` parameter of ``log.LogRevision`` may now be None,
279
representing a revision which is not in the current branch.
280
(Matt Giuca, #241998)
282
* The various knit pack repository format classes have been moved
283
from ``bzrlib.repofmt.pack_repo`` to
284
``bzrlib.repofmt.knitpack_repo``. (Jelmer Vernooij)
286
* ``RevisionTree`` now has a new method ``get_file_revision``.
289
* ``WorkingTree`` no longer provides an ``inventory``. Instead,
290
all inventory-related functionality is now on the subclass
291
``InventoryWorkingTree`` that all native Bazaar working tree
292
implementations derive from. (Jelmer Vernooij)
297
.. Major internal changes, unlikely to be visible to users or plugin
298
developers, but interesting for bzr developers.
300
* Added ``osutils.lstat`` and ``osutils.fstat``. These are just the ``os``
301
functions on Linux, but they are wrapped on Windows so that fstat
302
matches lstat results across all python versions.
305
* ``WorkingTree._observed_sha1`` also updates the 'size' column. It
306
happened to be updated as a side-effect of commit, but if we start using
307
the function elsewhere we might as well do it directly.
313
.. Fixes and changes that are only relevant to bzr's test framework and
314
suite. This can include new facilities for writing tests, fixes to
315
spurious test failures and changes to the way things should be tested.
317
* Stop using `failIf`, `failUnless`, `failIfEqual`, etc, that give
318
`PendingDeprecationWarnings` on Python2.7.
319
(Martin Pool, #760435)
327
This is the first beta of the 2.4 series, leading up to a 2.4.0
328
release in August 2011. Beta releases are suitable for everyday use
329
but may cause some incompatibilities with plugins. Some plugins may need
330
small updates to work with 2.4b1.
332
External Compatibility Breaks
333
*****************************
340
* Added ``changelog_merge`` plugin for merging changes to ``Changelog`` files
341
in GNU format. See ``bzr help changelog_merge`` for details.
344
* Configuration options can now use references to other options in the same
345
file by enclosing them with curly brackets (``{other_opt}``). This makes it
346
possible to use, for example,
347
``push_location=lp:~vila/bzr/config-{nickname}`` in ``branch.conf`` when
348
using a loom. During the beta period, the default behaviour is to disable
349
this feature. It can be activated by declaring ``bzr.config.expand = True``
350
in ``bazaar.conf``. (Vincent Ladeuil)
352
* External merge tools can now be configured in bazaar.conf. See
353
``bzr help configuration`` for more information. (Gordon Tyler, #489915)
355
* The ``lp:`` directory service now supports Launchpad's QA staging.
356
(Jelmer Vernooij, #667483)
361
* A new hidden command ``bzr repair-workingtree``. This is a way to force
362
the dirstate file to be rebuilt, rather than using a ``bzr checkout``
363
workaround. (John Arbash Meinel)
365
* Added a ``Branch.heads_to_fetch`` RPC to the smart server protocol.
366
This allows formats from plugins (such as looms) to efficiently tell the
367
client which revisions need to be fetched. (Andrew Bennetts)
369
* Branching, merging and pulling a branch now copies revisions named in
370
tags, not just the tag metadata. (Andrew Bennetts, #309682)
372
* ``bzr cat-revision`` no longer requires a working tree.
373
(Jelmer Vernooij, #704405)
375
* ``bzr export --per-file-timestamps`` for .tar.gz files will now
376
override the mtime for trees exported on Python 2.7 and later, which
377
expose the 'mtime' field in gzip files. This makes the output of
378
``bzr export --per-file-timestamps`` for a particular tree
379
deterministic. (Jelmer Vernooij, #711226)
381
* ``bzr export --format=zip`` can now export to standard output,
382
like the other exporters can. (Jelmer Vernooij, #513752)
384
* ``bzr export`` can now create ``.tar.xz`` and ``.tar.lzma`` files.
385
(Jelmer Vernooij, #551714)
387
* Getting all entries from ``CHKInventory.iter_entries_by_dir()`` has been
388
sped up dramatically for large trees. Iterating by dir is not the best
389
way to load data from a CHK inventory, so it preloads all the items in
390
the correct order. (With the gcc-tree, this changes it (re)reading 8GB
391
of CHK data, down to just 150MB.) This has noticeable affects for things
392
like building checkouts, etc. (John Arbash Meinel, #737234)
397
* A MemoryError thrown on the server during a remote operation will now be
398
usefully reported, and other unexpected errors will include the class name.
399
(Martin [gz], #722416)
401
* ``bzr annotate -r-1 file`` will now properly annotate a deleted file.
402
(Andrew King, #537442)
404
* ``bzr export`` to zip files will now set a mode on directories.
405
(Jelmer Vernooij, #207253)
407
* ``bzr export`` to tgz files will only write out the basename of the
408
tarfile to the gzip file. (Jelmer Vernooij, #102234)
410
* ``bzr push --overwrite`` with an older revision specified will now correctly
411
roll back the target branch. (Jelmer Vernooij, #386576)
413
* ``bzr lp-propose`` can now propose merges against packaging branches on
414
Launchpad without requiring the target branch to be specified.
415
(Jelmer Vernooij, #704647)
417
* ``bzr lp-propose`` no longer requires a reviewer to be specified. It will
418
instead leave setting the reviewer up to Launchpad if it was not specified.
419
(Jelmer Vernooij, #583772)
421
* ``bzr pull`` will now exit with exit code 1 if there were tag conflicts.
422
(Jelmer Vernooij, #213185)
424
* ``bzr mv`` user errors no longer throw UnicodeEncodeError with non-ascii
425
paths, however they may still print junk if not on a UTF-8 terminal.
426
(Martin [gz], #707954)
428
* ``bzr reconfigure --unstacked`` now copies revisions (and their
429
ancestors) named in tags into the unstacked repository, not just the
430
ancestry of the branch's tip. (Andrew Bennetts, #401646)
432
* ``bzr serve`` no longer crashes when a server_started hook is installed and
433
IPv6 support is available on the system. (Jelmer Vernooij, #293697)
435
* ``bzr status`` will not rewrite the dirstate file if it only has
436
'trivial' changes. (Currently limited to dir updates and newly-added
437
files changing state.) This saves a bit of time for regular operations.
438
eg. ``bzr status`` in a 100k tree takes 1.4s to compute the status, but 1s
439
to re-save the dirstate file. (John Arbash Meinel, #765881)
441
* ``bzr tags`` will no longer choke on branches with ghost revisions in
442
their mainline and tags on revisions not in the branch ancestry.
443
(Jelmer Vernooij, #397556)
445
* ``bzr whoami`` will now display an error if both a new identity and
446
``--email`` were specified. (Jelmer Vernooij, #680449)
448
* ``launchpadlib`` doesn't provide the ``uris`` module in some old versions.
449
(Vincent Ladeuil, #706835)
451
* Empty entries in the ``NO_PROXY`` variable are no longer treated as matching
453
(Martin Pool, #586341)
455
* Plugins incompatible with the current version of bzr no longer produce a
456
warning on every command invocation. Instead, a message is shown by
457
``bzr plugins`` and in crash reports.
458
(#704195, Martin Pool)
460
* The "pretty" version of ``needs_read_lock`` and ``needs_write_lock`` now
461
preserves the identity of default parameter values.
462
(Andrew Bennetts, #718569)
464
* ``bzr dump-btree --raw`` no longer tracebacks on a B-Tree file
465
containing no rows. (Eric Siegerman, #715508)
467
* Fix ``bzr lp-mirror`` to work on command line branch URLs and branches
468
without an explicit public location. (Max Bowsher)
470
* On Python 2.6 and higher, use multiprocessing.cpu_count() to retrieve the
471
number of available processors. (Jelmer Vernooij, #693140)
476
* Added ``Branch.heads_to_fetch`` method. Implementations of the Branch API
477
must now inherit or implement this method. (Andrew Bennetts, #721328)
479
* Added ``bzrlib.mergetools`` module with helper functions for working with
480
the list of external merge tools. (Gordon Tyler, #489915)
482
* All methods and arguments that were deprecated before 2.0
483
have been removed. (Jelmer Vernooij)
485
* Branch formats should now be registered on the format registry
486
(``bzrlib.branch.format_registry``) rather than using the class
487
methods on ``BranchFormat``. (Jelmer Vernooij, #714729)
489
* ``Branch.set_revision_history`` is now deprecated.
492
* ``BranchFormat.supports_leaving_lock()`` and
493
``RepositoryFormat.supports_leaving_lock`` flags have been added.
496
* ``Branch.fetch`` implementations must now accept an optional
497
``fetch_tags`` keyword argument. (Andrew Bennetts)
499
* ``Branch.import_last_revision_info`` is deprecated. Use the
500
``import_last_revision_info_and_tags`` method instead.
503
* Because it was too specific to BzrDir implementations,
504
``ControlDir.sprout`` no longer has a default implementation; it now
505
raises ``NotImplementedError``. (Jelmer Vernooij, #717937)
507
* ``bzrlib.deprecated_graph`` has been removed. ``bzrlib.graph``
508
scales better tree and should be used instead.
509
(Jelmer Vernooij, #733612)
511
* ``ControlDirFormat.register_format`` has been removed. Instead,
512
``Prober`` implementations should now implement a ``known_formats``
513
method. (Jelmer Vernooij)
515
* ControlDirFormats can now provide a ``check_status`` method and
516
raise a custom exception or warning when an unsupported or deprecated
517
format is being opened. (Jelmer Vernooij, #731311)
519
* ``bzrlib.revionspec.dwim_revspecs`` is deprecated.
520
Use ``bzrlib.revisionspec.RevisionSpec_dwim.append_possible_revspec`` and
521
``bzrlib.revisionspec.RevisionSpec_dwim.append_possible_lazy_revspec``
522
instead. (Jelmer Vernooij, #721971)
524
* ``BzrDirFormat`` has a new attribute ``fixed_components`` that
525
indicates whether the components of the bzrdir can be upgraded
526
independent of the ``BzrDir``. (Jelmer Vernooij)
528
* ``BzrProber.register_format`` and ``BzrProber.unregister_format`` are
529
now deprecated in favour of the ``BzrProber.formats`` format registry.
532
* ``ControlDir`` implementations no longer have to provide the
533
``get_branch_transport``, ``get_workingtree_transport`` and
534
``get_repository_transport`` methods. (Jelmer Vernooij, #730325)
536
* ``Converter`` has been moved from ``bzrlib.bzrdir`` to
537
``bzrlib.controldir``. (Jelmer Vernooij)
539
* Repository formats can now provide
540
``_get_extra_interrepo_test_combinations`` in the same module
541
to provide extra test combinations for ``bzrlib.tests.per_repository``.
544
* Repository formats should now be registered on the format registry
545
(``bzrlib.repository.format_registry``) rather than using the class
546
methods on ``RepositoryFormat``. (Jelmer Vernooij)
548
* Repository formats can now indicate they do not support the full
549
VersionedFiles API by setting the ``supports_full_versioned_files``
550
attribute to False. A subset of the VersionedFiles API
551
(signatures and text graphs) still needs to be supported.
554
* Repository formats have a new method ``is_deprecated`` that
555
implementations can override to return True to trigger a deprecation
556
warning. (Jelmer Vernooij)
558
* The ``revision_id`` parameter of
559
``Repository.search_missing_revision_ids`` and
560
``InterRepository.search_missing_revision_ids`` is deprecated. It is
561
replaced by the ``revision_ids`` parameter. (Andrew Bennetts)
563
* Working tree formats should now be registered on the format registry
564
(``bzrlib.working_tree.format_registry``) rather than using the class
565
methods on ``WorkingTreeFormat``. (Jelmer Vernooij, #714730)
570
* ``CatchingExceptionThread`` (formerly ThreadWithException) has been moved
571
out of the ``bzrlib.tests`` hierarchy to make it clearer that it can be used
572
outside of tests. This class makes it easier to track exceptions in threads
573
by catching them so they can be re-raised in the controlling thread. It's
574
available in the ``bzrlib.cethread`` module. (Vincent Ladeuil)
576
* Correctly propogate malloc failures from diff-delta.c code as MemoryError
577
so OOM conditions during groupcompress are clearly reported. This entailed a
578
change to several function signatures. (Martin [gz], #633336)
580
* ``HookPoint.lazy_hook`` and ``Hooks.install_named_lazy_hook`` can install
581
hooks for which the callable is loaded lazily. (Jelmer Vernooij)
586
* The Range parsing for HTTP requests will correctly parse incomplete ranges.
587
(Vincent Ladeuil, #731240)
590
vim: tw=74 ft=rst ff=unix