/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to doc/en/release-notes/brz-3.0.txt

  • Committer: Jelmer Vernooij
  • Date: 2019-05-29 03:22:34 UTC
  • mfrom: (7303 work)
  • mto: This revision was merged to the branch mainline in revision 7306.
  • Revision ID: jelmer@jelmer.uk-20190529032234-mt3fuws8gq03tapi
Merge trunk.

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/en/release-notes/brz-3.0.txt
 
1
####################
 
2
Breezy Release Notes
 
3
####################
 
4
 
 
5
.. toctree::
 
6
   :maxdepth: 1
 
7
 
 
8
brz 3.0.0
 
9
#########
 
10
 
 
11
:Codename: Pelican
 
12
:3.0.0: 2019-03-06
 
13
 
 
14
brz 3.0.0 is the first release of ``Breezy``, a fork of Bazaar. For more
 
15
information, see our release announcement on the Bazaar mailing list and
 
16
README.
 
17
 
 
18
External Compatibility Breaks
 
19
*****************************
 
20
 
 
21
 * The bzr command has been renamed to brz, to prevent clashes with upstream
 
22
   Bazaar.
 
23
   (Martin Packman, Jelmer Vernooij)
 
24
 
 
25
 * The --prefix/-p argument for ``brz diff`` now defaults to -p1 rather
 
26
   than -p0. (Jelmer Vernooij, #1695126)
 
27
 
 
28
 * The ``brz register-branch`` command from the Launchpad plugin has been
 
29
   removed, because it has not worked for at least five years: it relies on
 
30
   password authentication rather than SSO, the relevant systems no longer
 
31
   have firewall-level access to the outside world, and in general the
 
32
   Mirrored branch type is deprecated.  Either just push the branch to
 
33
   Launchpad or use code imports instead
 
34
   (https://help.launchpad.net/VcsImports).
 
35
   (Colin Watson, #254567, #483689)
 
36
 
 
37
 * brz no longer supports building the C extensions using Pyrex.
 
38
   Only Cython is supported. (Jelmer Vernooij)
 
39
 
 
40
 * Support for HTTP support using "pycurl" and the associated
 
41
   URL schemes "http+pycurl://" and "https+pycurl://" has been dropped.
 
42
   (Jelmer Vernooij, #82086, #377389, #122258, #516222, #545776, #1696602)
 
43
 
 
44
 * Support for medusa for FTP tests has been dropped, only
 
45
   pyftpdlib is now supported. (Jelmer Vernooij)
 
46
 
 
47
 * The deprecated ``brz get`` and ``brz clone`` commands have been
 
48
   removed. (Jelmer Vernooij)
 
49
 
 
50
 * The setting to ignore missing C extensions has been changed from
 
51
   ``ignore_missing_extensions=True`` to
 
52
   ``suppress_warnings=missing_extensions``. (Jelmer Vernooij)
 
53
 
 
54
 * Remove format names as options to ``brz init`` and ``brz
 
55
   init-repository``.. Now you must use ``brz init --format=...``.
 
56
   This simplifies ``brz init --help``.
 
57
   (Neil Martinsen-Burrell, #330494)
 
58
 
 
59
 * ``python-gpg`` is now used for checking GPG signatures rather than
 
60
   ``python-gpgme``. (Jelmer Vernooij, #1702308)
 
61
 
 
62
 * ``python-gpg`` is now used for signing commits, rather than shelling
 
63
   out to the gnupg command. The ``gpg_signing_command`` option has been
 
64
   removed.  (Jelmer Vernooij, #847388)
 
65
 
 
66
 * The ``bzr.transform.orphan_policy`` configuration option
 
67
   has been renamed to ``transform.orphan_policy``.
 
68
   (Jelmer Vernooij)
 
69
 
 
70
 * Backslash (\) is no longer accepted as a path separator
 
71
   on platforms where it is not the default path separator,
 
72
   e.g. POSIX systems. This is so that filenames with backslashes
 
73
   in their name can be added explicitly. (#176263, #165151)
 
74
 
 
75
 * One-letter shortcuts for Ubuntu releases are no
 
76
   longer supported after 'ubuntu:'. Bazaar's mapping for
 
77
   one-letter distroseries had not been updated since natty.
 
78
   (Jelmer Vernooij)
 
79
 
 
80
 * The ``brz lp-mirror-branch`` subcommand has been removed.
 
81
   Please use the ``lp-force-branch-mirror`` command from
 
82
   the lptools package instead. (Jelmer Vernooij, #518807)
 
83
 
 
84
 * Up-to-date checking for Bazaar packaging branches is no
 
85
   longer performed, since there are no longer
 
86
   any automated imports. (Jelmer Vernooij)
 
87
 
 
88
 * ``setuptools`` is now required to build and install Breezy.
 
89
   (Jelmer Vernooij)
 
90
 
 
91
New Features
 
92
************
 
93
 
 
94
 * The 'bisect' plugin is now shipped with brz. (Jelmer Vernooij)
 
95
 
 
96
 * The 'fastimport' plugin is now bundled with Breezy.
 
97
   (Jelmer Vernooij)
 
98
 
 
99
 * The ``grep`` plugin has been merged into Breezy.
 
100
   (Parth Malwankar, Martin Packman, Jelmer Vernooij)
 
101
 
 
102
 * The 'stats' plugin is now bundled with Breezy.
 
103
   (Jelmer Vernooij)
 
104
 
 
105
 * The 'upload' plugin is now bundled with Breezy.
 
106
   (Jelmer Vernooij)
 
107
 
 
108
 * The 'cvs' and 'mtn' plugins are now bundled with Breezy.
 
109
   (Jelmer Vernooij)
 
110
 
 
111
 * The 'email' plugin is now bundled with Breezy.
 
112
   (Jelmer Vernooij)
 
113
 
 
114
 * The 'import' command is now bundled with brz.
 
115
   Imported from bzrtools by Aaron Bentley. (Jelmer Vernooij, #773241)
 
116
 
 
117
 * The 'link-tree' command is now bundled with brz.
 
118
   Imported from bzrtools by Aaron Bentley. (Jelmer Vernooij)
 
119
 
 
120
 * The 'fetch-ghosts' command is now bundled with brz.
 
121
   Imported from bzrtools by Aaron Bentley. (Jelmer Vernooij)
 
122
 
 
123
 * The 'commitfromnews' plugin is now bundled and
 
124
   can be enabled by setting ``commit.template_from_files = NEWS``.
 
125
   (Jelmer Vernooij)
 
126
 
 
127
 * The 'darcs' plugin is now bundled.
 
128
   (Jelmer Vernooij)
 
129
 
 
130
 * The functionality from ``bzr-guess`` is now merged into Breezy.
 
131
   It will provide suggestions if the user typoes a command.
 
132
   (Jelmer Vernooij)
 
133
 
 
134
 * Support the creation of colocated branches in ``brz fast-import``.
 
135
   (Jelmer Vernooij, #1744626)
 
136
 
 
137
 * New ``lp-logout`` command to unset launchpad username.
 
138
   (Jelmer Vernooij, #349143)
 
139
 
 
140
 * Plugins can now be registered using the 'entrypoints' mechanism in
 
141
   setuptools. (Jelmer Vernooij, #1802647)
 
142
 
 
143
 * The Breezy UI now handles RCP-style URLs and suggests the
 
144
   user specify either ``git+ssh`` or ``bzr+ssh``.
 
145
   (Jelmer Vernooij)
 
146
 
 
147
Improvements
 
148
************
 
149
 
 
150
 * Doc generators now support the SOURCE_DATE_EPOCH environment
 
151
   variable (https://reproducible-builds.org/specs/source-date-epoch/).
 
152
   (Jelmer Vernooij)
 
153
 
 
154
 * The ``repodebug`` plugin is now bundled.
 
155
   (Jelmer Vernooij)
 
156
 
 
157
 * New ``brz cp`` command which copies files (but does not currently track
 
158
   history). (Jelmer Vernooij, start towards #269095)
 
159
 
 
160
 * HPSS calls for ``RevisionTree.archive`` and
 
161
   ``RevisionTree.annotate_iter`` have been added. (Jelmer Vernooij,
 
162
   #897781)
 
163
 
 
164
 * New ``lp+bzr://`` URL scheme for Bazaar-only branches on Launchpad.
 
165
   (Jelmer Vernooij)
 
166
 
 
167
 * Report colocated branch information in ``brz info``.
 
168
   (Jelmer Vernooij, #1803846)
 
169
 
 
170
Bug Fixes
 
171
*********
 
172
 
 
173
* Support Server Name Indication (SNI) when talking to https servers.
 
174
  Cherry-picked from lp:~vila/bzr/1089352-sni-support
 
175
  (Vincent Ladeuil, #1089352)
 
176
 
 
177
* The ``bisect`` command now works in non-``.bzr`` directories.
 
178
  (Jelmer Vernooij)
 
179
 
 
180
* When creating ``authentication.conf``, umask is now set so only the
 
181
  current user can read the file. Breezy warns if the file is
 
182
  accessible for other users when it starts.
 
183
  (Joke de Buhr, Jelmer Vernooij, #475501)
 
184
 
 
185
* Support ``brz commit -x`` in combination with iter_changes.
 
186
  (Jelmer Vernooij, #796582, #403811, #694946, #268135, #299879)
 
187
 
 
188
* Print a proper error when encountering ghost revisions in
 
189
  mainline in ``brz log``. (Jelmer Vernooij, #726466)
 
190
 
 
191
* Security fix: hostnames starting with a dash in bzr+ssh URLs
 
192
  are now filtered out when using a subprocess SSH client.
 
193
  .
 
194
  Thanks to Augie Fackler for reporting.
 
195
  (Jelmer Vernooij, #1710979)
 
196
 
 
197
* Mark all options as unicode. Allows using non-ASCII values in most
 
198
  options. (Jelmer Vernooij, #563692)
 
199
 
 
200
* Support automatic rename tracking into new directories.
 
201
  (mnn, #373319)
 
202
 
 
203
* Avoid writing directly to sys.stdout, but use self.outf in
 
204
  Command implementations instead. (#268573, B. Clausius)
 
205
 
 
206
* It is now possible to version files with backslashes in their name
 
207
  on platforms that support it. (Jelmer Vernooij, #81844)
 
208
 
 
209
* Support '0' markers in fastimport plugin. (Jelmer Vernooij, #1744615)
 
210
 
 
211
* Support adding/removing filenames that consist of just
 
212
  backslashes in where backslash is not the path separator.
 
213
  (Jelmer Vernooij, #176263, #165151)
 
214
 
 
215
* Report correct path in output of ``brz add``.
 
216
  (Brian de Alwis, Jelmer Vernooij, #1799482)
 
217
 
 
218
* Don't report empty directories in git trees as changes.
 
219
  (Jelmer Vernooij, #1804072)
 
220
 
 
221
* Fix support for 'brz ignore' in Git trees.
 
222
  (Jelmer Vernooij, #1804053)
 
223
 
 
224
* Print a clearer error when GPG can't be found.
 
225
  (Jelmer Vernooij, #1803898)
 
226
 
 
227
* Fix a corner case when moving files.
 
228
  (Jelmer Vernooij, #533152)
 
229
 
 
230
* Fix fastexport output to standard output when
 
231
  running under Python 3. (Jelmer Vernooij, #1805172)
 
232
 
 
233
* Restore absolute URLs in branch reference URLs. This is
 
234
  needed for backwards compatibility with Bazaar.
 
235
  (Jelmer Vernooij, #1803845)
 
236
 
 
237
* Don't report .git files as unknown files.
 
238
  (Jelmer Vernooij, Debian Bug #921240)
 
239
 
 
240
* Raise better error when path subsegments lack =.
 
241
  (Jelmer Vernooij, #891483)
 
242
 
 
243
* Display correct pull location argument in
 
244
  output of ``brz uncommit``.
 
245
  (Jelmer Vernooij, #386577)
 
246
 
 
247
Documentation
 
248
*************
 
249
 
 
250
 * Various documents have been updated to explain that Breezy is a fork
 
251
   of Bazaar.
 
252
 
 
253
 * Documentation translations into Japanese, Spanish and Russian have been
 
254
   removed since there are no current translators to update them.
 
255
   (Jelmer Vernooij)
 
256
 
 
257
 * A quick introduction about using Breezy with GitHub has been added.
 
258
   (Jelmer Vernooij, #1803867)
 
259
 
 
260
API Changes
 
261
***********
 
262
 
 
263
 * bzrlib has been renamed to breezy. (Martin Packman, Jelmer Vernooij)
 
264
 
 
265
 * Signature of ``load_tests`` used by ``TestLoader`` changed to be
 
266
   compatible with standard libarary unittest.  (Martin Packman)
 
267
 
 
268
 * All previously deprecated functionality has been removed.
 
269
   (Jelmer Vernooij)
 
270
 
 
271
 * ``CommitBuilder.record_entry_contents`` has been removed.
 
272
   (Jelmer Vernooij, #731433, #604953)
 
273
 
 
274
 * Renamed ``breezy.delta.report_delta`` parameter ``filter=`` to
 
275
   ``predicate=``. (Martin Packman)
 
276
 
 
277
 * ``Branch.bzrdir``, ``Repository.bzrdir`` and ``WorkingTree.bzrdir``
 
278
   have been renamed to ``Branch.controldir``, ``Repository.controldir``
 
279
   and ``WorkingTree.controldir``, respectively.
 
280
   (Jelmer Vernooij, #1695774)
 
281
 
 
282
 * ``BzrBranch`` and the various bzr branch format implementations
 
283
   have been moved to ``breezy.bzr``. (Jelmer Vernooij)
 
284
 
 
285
 * ``MetaDirBranchFormatFactory`` has been removed.
 
286
   Use lazy registration on ``breezy.branch.format_registry``
 
287
   instead. (Jelmer Vernooij)
 
288
 
 
289
 * ``breezy.bzrdir.format_registry`` has been removed; use
 
290
   ``breezy.controldir.format_registry`` instead.
 
291
   (Jelmer Vernooij)
 
292
 
 
293
 * ``breezy.api`` has been removed.  (Jelmer Vernooij, #742192)
 
294
 
 
295
 * ``ControlDir.find_bzrdirs`` has been renamed to
 
296
   ``ControlDir.find_controldirs``. (Jelmer Vernooij)
 
297
 
 
298
 * ``Repository.get_revisions`` no longer accepts ``None`` as
 
299
   argument. (Jelmer Vernooij)
 
300
 
 
301
 * A new ``Repository.iter_revisions`` method has been added.
 
302
   (Jelmer Vernooij)
 
303
 
 
304
 * A new ``WorkingTreeFormat.supports_setting_file_ids`` property
 
305
   has been added that can be set to False to indicate a working tree
 
306
   doesn't support e.g. passing a file_id into ``WorkingTree.mkdir``.
 
307
   (Jelmer Vernooij, #1707533)
 
308
 
 
309
 * A new ``RepositoryFormat.supports_setting_revision_ids`` property
 
310
   has been added that can be set to False to indicate a repository
 
311
   doesn't support passing revision ids to ``CommitBuilder.commit``.
 
312
   (Jelmer Vernooij)
 
313
 
 
314
 * A new ``RepositoryFormat.supports_overriding_transport`` property
 
315
   has been added that can be set to False to indicate a repository
 
316
   doesn't support passing an alternative transport to
 
317
   ``RepositoryFormat.open``.
 
318
   (Jelmer Vernooij)
 
319
 
 
320
 * ``Repository.print_file`` and ``Branch.print_file`` have been removed.
 
321
   (Jelmer Vernooij)
 
322
 
 
323
 * Various ``lock_write`` and ``lock_read`` functions now return a
 
324
   context manager. (Jelmer Vernooij)
 
325
 
 
326
 * The ``BranchWriteLockResult.branch_token`` (returned by
 
327
   ``Branch.lock_write``) has been renamed to
 
328
   ``BranchWriteLockResult.token``. (Jelmer Vernooij)
 
329
 
 
330
 * ``breezy.decorators.needs_write_lock``,
 
331
   ``breezy.decorators.needs_read_lock`` and
 
332
   ``breezy.mutabletree.needs_tree_write_lock`` have been deprecated.
 
333
   Instead, use the context managers returned by ``.lock_write``,
 
334
   ``.lock_read`` and ``.lock_tree_write`` respectively. (Jelmer Vernooij)
 
335
 
 
336
 * ``Tree`` methods now take a ``path`` as primary key argument, rather
 
337
   than a ``file_id``. ``file_id`` is still present as optional argument
 
338
   for most functions, and can be specified to speed up lookups.
 
339
   (Jelmer Vernooij)
 
340
 
 
341
Internals
 
342
*********
 
343
 
 
344
.. Major internal changes, unlikely to be visible to users or plugin 
 
345
   developers, but interesting for brz developers.
 
346
 
 
347
* Allow overriding of default HTTP headers by caller.
 
348
  (Jelmer Vernooij, #1753734)
 
349
 
 
350
Testing
 
351
*******
 
352
 
 
353
 * Allow /dev/null to be a symlink to a chardev. (Igo Pashev, #832257)
 
354
 
 
355
 * A test isolation issue in ``breezy.tests.test_ui`` was fixed,
 
356
   which caused ``output_encoding = iso-8859-1`` to be added to the
 
357
   users' bazaar.conf. (Jelmer Vernooij)
 
358
 
 
359
 * Newer versions of ``pyftpdlib`` are now supported for running FTP tests.
 
360
   (Jelmer Vernooij)
 
361
 
 
362
 * The ``--subunit`` argument for ``brz selftest`` has been renamed to
 
363
   ``--subunit1``, and a new argument ``--subunit2`` has been added that
 
364
   outputs subunit v2.
 
365
   (Jelmer Vernooij, #1699346, #661205)
 
366
 
 
367
 * Launchpad plugin tests no longer try to connect to production
 
368
   Launchpad. (Jelmer Vernooij, #723183)
 
369
 
 
370
 * Set the ``GPGHOME`` environment variable during testing, to prevent
 
371
   e.g. leaking keys into the users' GNUPG directory.
 
372
   (Jelmer Vernooij, #843885)
 
373
 
 
374
 * Allow some slack when comparing times.
 
375
   (Jelmer Vernooij, #1804121)
 
376
 
 
377
 * Fix a spuriously failing fastexport test due to dictionary
 
378
   ordering. (Jelmer Vernooij, #1808630)
 
379
 
 
380
..
 
381
   vim: tw=74 ft=rst ff=unix