/brz/remove-bazaar

####################
Breezy Release Notes
####################

.. toctree::
   :maxdepth: 1

brz 3.0.0 is the first release of ``Breezy``, a fork of Bazaar. For more
information, see our release announcement on the Bazaar mailing list and
README.

brz 3.0.0
#########

:Codename: Pelican
:3.0.1: NOT RELEASED YET

External Compatibility Breaks
*****************************

 * The bzr command has been renamed to brz, to prevent
   clashes with upstream Bazaar.
   (Martin Packman, Jelmer Vernooij)

 * The --prefix/-p argument for ``bzr diff`` now defaults to -p1 rather
   than -p0. (Jelmer Vernooij, #1695126)

 * The ``brz register-branch`` command from the Launchpad plugin has been
   removed, because it has not worked for at least five years: it relies on
   password authentication rather than SSO, the relevant systems no longer
   have firewall-level access to the outside world, and in general the
   Mirrored branch type is deprecated.  Either just push the branch to
   Launchpad or use code imports instead
   (https://help.launchpad.net/VcsImports).
   (Colin Watson, #254567, #483689)

 * brz no longer supports building the C extensions using Pyrex.
   Only Cython is supported. (Jelmer Vernooij)

 * Support for HTTP support using "pycurl" and the associated
   URL schemes "http+pycurl://" and "https+pycurl://" has been dropped.
   (Jelmer Vernooij, #82086, #377389, #122258, #516222, #545776, #1696602)

 * Support for medusa for FTP tests has been dropped, only
   pyftpdlib is now supported. (Jelmer Vernooij)

 * The deprecated ``brz get`` and ``brz clone`` commands have been
   removed. (Jelmer Vernooij)

 * The setting to ignore missing C extensions has been changed from
   ``ignore_missing_extensions=True`` to
   ``suppress_warnings=missing_extensions``. (Jelmer Vernooij)

 * Remove format names as options to ``brz init`` and ``brz
   init-repository``.. Now you must use ``brz init --format=...``.
   This simplifies ``brz init --help``.
   (Neil Martinsen-Burrell, #330494)

 * ``python-gpg`` is now used for checking GPG signatures rather than
   ``python-gpgme``. (Jelmer Vernooij, #1702308)

 * ``python-gpg`` is now used for signing commits, rather than shelling
   out to the gnupg command. The ``gpg_signing_command`` option has been
   removed.  (Jelmer Vernooij, #847388)

New Features
************

 * The 'bisect' plugin is now shipped with bzr. (Jelmer Vernooij)

 * The 'fastimport' plugin is now bundled with Bazaar.
   (Jelmer Vernooij)

 * The 'stats' plugin is now bundled with Bazaar.
   (Jelmer Vernooij)

 * The 'upload' plugin is now bundled with Bazaar.
   (Jelmer Vernooij)

 * The 'cvs' and 'mtn' plugins are now bundled with Bazaar.
   (Jelmer Vernooij)

 * The 'email' plugin is now bundled with Bazaar.
   (Jelmer Vernooij)

 * The 'import' command is now bundled with brz.
   Imported from bzrtools by Aaron Bentley. (Jelmer Vernooij, #773241)

 * The 'link-tree' command is now bundled with brz.
   Imported from bzrtools by Aaron Bentley. (Jelmer Vernooij)

 * The 'fetch-ghosts' command is now bundled with brz.
   Imported from bzrtools by Aaron Bentley. (Jelmer Vernooij)

 * The 'commitfromnews' plugin is now bundled and
   can be enabled by setting ``commit.template_from_files = NEWS``.
   (Jelmer Vernooij)

 * The 'darcs' plugin is now bundled.
   (Jelmer Vernooij)

 * The functionality from ``bzr-guess`` is now merged into Breezy.
   It will provide suggestions if the user typoes a command.
   (Jelmer Vernooij)

Improvements
************

 * Doc generators now support the SOURCE_DATE_EPOCH environment
   variable (https://reproducible-builds.org/specs/source-date-epoch/).
   (Jelmer Vernooij)

 * The ``repodebug`` plugin is now bundled.
   (Jelmer Vernooij)

Bug Fixes
*********

* Support Server Name Indication (SNI) when talking to https servers.
  Cherry-picked from lp:~vila/bzr/1089352-sni-support
  (Vincent Ladeuil, #1089352)

* The ``bisect`` command now works in non-``.bzr`` directories.
  (Jelmer Vernooij)

* When creating ``authentication.conf``, umask is now set so only the
  current user can read the file. Breezy warns if the file is
  accessible for other users when it starts.
  (Joke de Buhr, Jelmer Vernooij, #475501)

* Support ``brz commit -x`` in combination with iter_changes.
  (Jelmer Vernooij, #796582, #403811, #694946, #268135, #299879)

* Print a proper error when encountering ghost revisions in
  mainline in ``bzr log``. (Jelmer Vernooij, #726466)

* Security fix: hostnames starting with a dash in bzr+ssh URLs
  are now filtered out when using a subprocess SSH client.
  .
  Thanks to Augie Fackler for reporting.
  (Jelmer Vernooij, #1710979)

* Mark all options as unicode. Allows using non-ASCII values in most
  options. (Jelmer Vernooij, #563692)

* Support automatic rename tracking into new directories.
  (mnn, #373319)

Documentation
*************

 * Various documents have been updated to explain that Breezy is a fork
   of Bazaar.

 * Documentation translations into Japanese, Spanish and Russian have been
   removed since there are no current translators to update them.
   (Jelmer Vernooij)

API Changes
***********

 * bzrlib has been renamed to breezy. (Martin Packman, Jelmer Vernooij)

 * Signature of ``load_tests`` used by ``TestLoader`` changed to be
   compatible with standard libarary unittest.  (Martin Packman)

 * All previously deprecated functionality has been removed.
   (Jelmer Vernooij)

 * ``CommitBuilder.record_entry_contents`` has been removed.
   (Jelmer Vernooij, #731433, #604953)

 * Renamed ``breezy.delta.report_delta`` parameter ``filter=`` to
   ``predicate=``. (Martin Packman)

 * ``Branch.bzrdir``, ``Repository.bzrdir`` and ``WorkingTree.bzrdir``
   have been renamed to ``Branch.controldir``, ``Repository.controldir``
   and ``WorkingTree.controldir``, respectively.
   (Jelmer Vernooij, #1695774)

 * ``BzrBranch`` and the various bzr branch format implementations
   have been moved to ``breezy.bzr``. (Jelmer Vernooij)

 * ``MetaDirBranchFormatFactory`` has been removed.
   Use lazy registration on ``breezy.branch.format_registry``
   instead. (Jelmer Vernooij)

 * ``breezy.bzrdir.format_registry`` has been removed; use
   ``breezy.controldir.format_registry`` instead.
   (Jelmer Vernooij)

 * ``breezy.api`` has been removed.  (Jelmer Vernooij, #742192)

 * ``ControlDir.find_bzrdirs`` has been renamed to
   ``ControlDir.find_controldirs``. (Jelmer Vernooij)

 * ``Repository.get_revisions`` no longer accepts ``None`` as
   argument. (Jelmer Vernooij)

 * A new ``Repository.iter_revisions`` method has been added.
   (Jelmer Vernooij)

 * A new ``WorkingTreeFormat.supports_setting_file_ids`` property
   has been added that can be set to False to indicate a working tree
   doesn't support e.g. passing a file_id into ``WorkingTree.mkdir``.
   (Jelmer Vernooij, #1707533)

 * A new ``RepositoryFormat.supports_setting_revision_ids`` property
   has been added that can be set to False to indicate a repository
   doesn't support passing revision ids to ``CommitBuilder.commit``.
   (Jelmer Vernooij)

 * A new ``RepositoryFormat.supports_overriding_transport`` property
   has been added that can be set to False to indicate a repository
   doesn't support passing an alternative transport to
   ``RepositoryFormat.open``.
   (Jelmer Vernooij)

 * ``Repository.print_file`` and ``Branch.print_file`` have been removed.
   (Jelmer Vernooij)

 * Various ``lock_write`` and ``lock_read`` functions now return a
   context manager. (Jelmer Vernooij)

 * The ``BranchWriteLockResult.branch_token`` (returned by
   ``Branch.lock_write``) has been renamed to
   ``BranchWriteLockResult.token``. (Jelmer Vernooij)

 * ``breezy.decorators.needs_write_lock``,
   ``breezy.decorators.needs_read_lock`` and
   ``breezy.mutabletree.needs_tree_write_lock`` have been deprecated.
   Instead, use the context managers returned by ``.lock_write``,
   ``.lock_read`` and ``.lock_tree_write`` respectively. (Jelmer Vernooij)

 * ``Tree`` methods now take a ``path`` as primary key argument, rather
   than a ``file_id``. ``file_id`` is still present as optional argument
   for most functions, and can be specified to speed up lookups.
   (Jelmer Vernooij)

Internals
*********

.. Major internal changes, unlikely to be visible to users or plugin 
   developers, but interesting for brz developers.

Testing
*******

 * A test isolation issue in ``breezy.tests.test_ui`` was fixed,
   which caused ``output_encoding = iso-8859-1`` to be added to the
   users' bazaar.conf. (Jelmer Vernooij)

 * Newer versions of ``pyftpdlib`` are now supported for running FTP tests.
   (Jelmer Vernooij)

 * The ``--subunit`` argument for ``brz selftest`` has been renamed to
   ``--subunit1``, and a new argument ``--subunit2`` has been added that
   outputs subunit v2.
   (Jelmer Vernooij, #1699346, #661205)

 * Launchpad plugin tests no longer try to connect to production
   Launchpad. (Jelmer Vernooij, #723183)

 * Set the ``GPGHOME`` environment variable during testing, to prevent
   e.g. leaking keys into the users' GNUPG directory.
   (Jelmer Vernooij, #843885)

..
   vim: tw=74 ft=rst ff=unix