/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: Martin
  • Date: 2019-06-16 19:53:27 UTC
  • mto: This revision was merged to the branch mainline in revision 7349.
  • Revision ID: gzlist@googlemail.com-20190616195327-awvhgbjo9g6mkt57
https://launchpad.net/bugs/240550
Relocate the bzr log file out of $HOME

Now under $XDG_CACHE_HOME on nix and %LOCALAPPDATA% on windows.

Setting $BRZ_HOME will override the cache location, to simplify test
isolation, and $BRZ_LOG is still the final word.

Drive-by fix various docs around bzr/brz spelling.

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