Merge lp:~mbp/bzr/doc-2.2 into lp:bzr/2.2

Proposed by Martin Pool
Status: Merged
Approved by: Andrew Bennetts
Approved revision: no longer in the source branch.
Merged at revision: 5073
Proposed branch: lp:~mbp/bzr/doc-2.2
Merge into: lp:bzr/2.2
Diff against target: 387 lines (+277/-46)
3 files modified
NEWS (+1/-1)
doc/developers/releasing.txt (+5/-1)
doc/en/whats-new/whats-new-in-2.2.txt (+271/-44)
To merge this branch: bzr merge lp:~mbp/bzr/doc-2.2
Reviewer Review Type Date Requested Status
Alexander Belchenko Needs Fixing
Andrew Bennetts Approve
Review via email: mp+32293@code.launchpad.net

Commit message

"what's new" document for 2.2

Description of the change

This adds a more sensible description of what's new in bzr 2.2.

Doing this after the fact is a bit hard so I think we should change our practices to add to this as we go along, either as well as or perhaps instead of the NEWS file. I'll start a separate list thread about that.

You can see the built output in http://sourcefrog.net/tmp/1m/bzr-2.2-whatsnew/html/whats-new/whats-new-in-2.2.html

The current live version at http://doc.bazaar.canonical.com/bzr.2.2/en/whats-new/whats-new-in-2.2.html looks a bit bad.

To post a comment you must log in.
Revision history for this message
Andrew Bennetts (spiv) wrote :

Looks good to me.

review: Approve
Revision history for this message
Alexander Belchenko (bialix) wrote :

Martin, I'd like to use another description for qbzr, like the one in my announce (see http://groups.google.com/group/qbzr/browse_thread/thread/b97536c38a32d3f3), e.g. the following text:

qbzr, a cross-platform graphical interface to Bazaar, gained many features and fixes in its 0.19 release, including:

* qannotate has new look and feel; with new features: find text and goto
to line.
* Improved performance of qlog, and treewidget-based dialogs (qcommit,
qadd, qrevert etc.)
* qpush, qmerge, etc.: When there are uncommitted changes in the working
tree, user has the option to commit, or revert.
* qcommit: user can update bound branch/chgeckout if it is not up to date.
* Fixed bug with Mac OS X support when windows start in background.
(Thanks to Luis Arias)
* qlog: Context menu actions for tag, and revert will now show a branch
menu if more than one branch is open.
* qlog: more context menu actions for update, cherry-pick, and reverse
cherry-pick.
* Language of GUI can be set in DEFAULT section of bazaar.conf as
``language = code``. Language codes are the same as for LANG environment
   variable. Environment variable LANGUAGE still preferred over settings
   in bazaar.conf.

review: Needs Fixing
Revision history for this message
Martin Pool (mbp) wrote :

Thanks Bialix.

Revision history for this message
Martin Pool (mbp) wrote :

sent to pqm by email

Preview Diff

[H/L] Next/Prev Comment, [J/K] Next/Prev File, [N/P] Next/Prev Hunk
=== modified file 'NEWS'
--- NEWS 2010-08-06 19:16:16 +0000
+++ NEWS 2010-08-11 09:29:39 +0000
@@ -58,7 +58,7 @@
58* Don't traceback trying to unversion children files of an already58* Don't traceback trying to unversion children files of an already
59 unversioned directory. (Vincent Ladeuil, #494221)59 unversioned directory. (Vincent Ladeuil, #494221)
6060
61* ``HTTP/1.1` test servers now set a ``Content-Length`` header to comply61* ``HTTP/1.1`` test servers now set a ``Content-Length`` header to comply
62 with pedantic ``HTTP/1.1`` clients. (Vincent Ladeuil, #568421)62 with pedantic ``HTTP/1.1`` clients. (Vincent Ladeuil, #568421)
6363
64* Progress bars prefer to truncate the text message rather than the64* Progress bars prefer to truncate the text message rather than the
6565
=== modified file 'doc/developers/releasing.txt'
--- doc/developers/releasing.txt 2010-05-27 19:54:56 +0000
+++ doc/developers/releasing.txt 2010-08-11 09:29:39 +0000
@@ -85,6 +85,8 @@
85 including its version number and the headings from85 including its version number and the headings from
86 ``NEWS-template.txt``.86 ``NEWS-template.txt``.
8787
88#. Update the "What's New" documents in ``doc/en/whats-new``.
89
88#. Commit this and send it to PQM.90#. Commit this and send it to PQM.
8991
9092
@@ -120,7 +122,7 @@
120122
121 version_info = (2, 1, 2, 'final', 0)123 version_info = (2, 1, 2, 'final', 0)
122124
123#. Check the release number in ``./NEWS``125#. Update the ``./NEWS`` section for this release.
124126
125 Fill out the date and a description of the release under the existing127 Fill out the date and a description of the release under the existing
126 header. If there isn't one, follow the above for using the NEWS128 header. If there isn't one, follow the above for using the NEWS
@@ -128,6 +130,8 @@
128130
129 See *2.1.1* or similar for an example of what this looks like.131 See *2.1.1* or similar for an example of what this looks like.
130132
133#. Add a summary of the release into the "What's New" document.
134
131#. To check that all bugs mentioned in ``./NEWS`` are actually marked as135#. To check that all bugs mentioned in ``./NEWS`` are actually marked as
132 closed in Launchpad, you can run ``tools/check-newsbugs.py``::136 closed in Launchpad, you can run ``tools/check-newsbugs.py``::
133137
134138
=== modified file 'doc/en/whats-new/whats-new-in-2.2.txt'
--- doc/en/whats-new/whats-new-in-2.2.txt 2010-03-04 04:15:18 +0000
+++ doc/en/whats-new/whats-new-in-2.2.txt 2010-08-11 09:29:39 +0000
@@ -1,62 +1,289 @@
1*************************
1What's New in Bazaar 2.2?2What's New in Bazaar 2.2?
2=========================3*************************
34
4This document outlines the major improvements in Bazaar 2.25Bazaar 2.2.0, released on the 6th of August 2010, marks the start of
5vs Bazaar 2.1. As well as summarizing improvements made to6another long-term-stable series. From here, we will only make bugfix
6the core product, it highlights enhancements within the broader7releases on the 2.2 series (2.2.1, etc), while 2.3 will become our new
7Bazaar world of potential interest to those upgrading.8development series. The 2.0 and 2.1 series will also continue to get
89bugfixes. (Currently 2.0 is planned to be supported for another 6 months.)
9.. warning::10
1011Users are encouraged to upgrade from the other stable series. This
11 Bazaar 2.2.0 is currently in development. While less stable than12document outlines the improvements in Bazaar 2.2 vs Bazaar 2.1. As well as
12 Bazaar 2.1.x, we aim to keep quality at a high level:13summarizing improvements made to the core product, it highlights
1314enhancements within the broader Bazaar world of potential interest to
14 * Monthly beta releases should be suitable for early adopters of new15those upgrading.
15 features.16
1617Bazaar 2.2.0 includes all the fixes from 2.1.2 and 2.0.6.
17 * Nightly builds are suitable for users interested in assisting18
18 with testing.19Over 120 bugs have been fixed in total. See the
1920:doc:`../release-notes/index` for a full list.
20 If it doubt, please use the latest 2.1 release instead.21
2122Bazaar 2.2.0 is fully compatible both locally and on the network with 2.0
23and 2.1, and can read and write repositories generated by all previous
24versions.
25
26
27Behaviour changes
28*****************
29
30There are some compatibility changes in this release.
31
32* For commandline users we no longer guess user identity for ``bzr
33 commit``: users must specify their identity using ``bzr whoami`` (you
34 don't need to specify your identity for readonly operations).
35 This avoids problems where the previous guessed default caused commits
36 be recorded as coming from, for example ``<sam@localhost>``.
2237
23Improved conflict handling38Improved conflict handling
24--------------------------39**************************
2540
26Tree-shape conflicts can be resolved by providing ``--take-this`` and41Tree-shape conflicts can be resolved by providing ``--take-this`` and
27``--take-other`` to the ``bzr resolve`` command. Just marking the conflict42``--take-other`` to the ``bzr resolve`` command. Just marking the conflict
28as resolved is still accessible via the ``--done`` default action.43as resolved is still accessible via the ``--done`` default action.
2944
45Local performance
46*****************
47
48* ``bzr init`` does not recursively scan directory contents anymore
49 leading to faster init for directories with existing content.
50 (Martin [gz], Parth Malwankar, #501307)
51
52* Less code is loaded at startup, so there's less overhead on running all
53 bzr commands.
54 (Andrew Bennetts, Martin Pool)
55
56* Reduce peak memory by one copy of compressed text.
57 (John Arbash Meinel, #566940)
58
59* Avoid repeated locking of local objects in ``diff``, ``missing``, and
60 ``pull``, so those options are faster.
61 (Andrew Bennetts)
62
63Network performance
64*******************
65
66* Bazaar now reads data from SSH connections more efficiently on platforms
67 that provide the ``socketpair`` function, and when using paramiko.
68 (Andrew Bennetts, #590637)
69
70* Index lookups in pack repositories search recently hit pack files
71 first. In repositories with many pack files this can greatly reduce the
72 number of files accessed, the number of bytes read, and the number of
73 read calls. An incremental pull via plain HTTP takes half the time and
74 bytes for a moderately large repository. (Andrew Bennetts)
75
76* Index lookups only re-order the indexes when the hit files aren't
77 already first. Reduces the cost of reordering
78 (John Arbash Meinel, #562429)
79
80
81Command impprovements
82*********************
83
84* Added ``bzr remove-branch`` command that can remove a local or remote
85 branch. (Jelmer Vernooij, #276295)
86
87* ``bzr export`` now takes an optional argument ``--per-file-timestamps``
88 to set file mtimes to the last timestamp of the last revision in which
89 they were changed rather than the current time. (Jelmer Vernooij)
90
91* Tag names can now be determined automatically by ``automatic_tag_name``
92 hooks on ``Branch`` if they are not specified on the command line.
93 (Jelmer Vernooij)
94
95* Tree-shape conflicts can be resolved by providing ``--take-this`` and
96 ``--take-other`` to the ``bzr resolve`` command. Just marking the conflict
97 as resolved is still accessible via the ``--done`` default action.
98 (Vincent Ladeuil)
99
100* The ``--directory`` option is supported for a number of additional
101 commands: added, annotate, bind, cat, cat-revision, clean-tree,
102 conflicts, deleted, export, ignore, ignored, lookup-revision, ls,
103 merge-directive, missing, modified, nick, re-sign, resolve, shelve,
104 switch, unbind, unknowns, unshelve, whoami.
105 (Martin von Gagern, #527878)
106
107* ``bzr commit`` accepts ``-p`` (for "patch") as a shorter name for
108 ``--show-diff``.
109 (Parth Malwankar, #571467)
110
111* ``bzr ignore`` now supports a ``--default-rules`` option that displays
112 the default ignore rules used by bzr. The flag ``--old-default-rules``
113 is no longer supported by ``ignore``.
114 (Parth Malwankar, #538703)
115
116* ``bzr pack`` now supports a ``--clean-obsolete-packs`` option that
117 can save disk space by deleting obsolete pack files created during the
118 pack operation.
119 (Parth Malwankar, #304320)
120
121* New command line option ``--authors`` to ``bzr log`` allows users to
122 select which of the apparent authors and committer should be
123 included in the log. Defaults depend on format. (Martin von Gagern, #513322)
124
125* The bash_completion plugin from the bzr-bash-completion project has
126 been merged into the tree. It provides a bash-completion command and
127 replaces the outdated ``contrib/bash/bzr`` script with a version
128 using the plugin. (Martin von Gagern, #560030)
129
130* A new transport based on GIO (the gnome i/o library) provides access to
131 samba shares, webdav using gio+smb and gio+dav. It is also possible to
132 use gio for some already existing transport methods as gio+file,
133 gio+sftp, gio+ftp.
134 (Mattias Eriksson)
135
136
137Controlling plugins
138*******************
139
140* Plugins can be disabled by defining ``BZR_DISABLE_PLUGINS`` as
141 a list of plugin names separated by ':' (';' on windows).
142 (Vincent Ladeuil, #411413)
143
144* Plugins can be loaded from arbitrary locations by defining
145 ``BZR_PLUGINS_AT`` as a list of ``name@path`` separated by ':' (';' on
146 Microsoft
147 Windows). This takes precedence over ``BZR_PLUGIN_PATH`` for the
148 specified plugins, and is expected to be most useful for plugin
149 developers.
150 (Vincent Ladeuil, #82693)
151
152
153Apport crash reporting
154**********************
155
156* If the Apport crash-reporting tool is available, bzr crashes are now
157 stored into the ``/var/crash`` apport spool directory, and the user is
158 invited to report them to the developers from there, either
159 automatically or by running ``apport-bug``. No information is sent
160 without specific permission from the user. (Martin Pool, #515052)
161
30162
31Improved Launchpad integration163Improved Launchpad integration
32------------------------------164******************************
33165
34Merges can be proposed on Launchpad with the new **lp-propose-merge**166* Merges can be proposed on Launchpad with the new ``lp-propose-merge``
35command.167 command.
36
37
38Notable plugin enhancements
39---------------------------
40
41The grep plugin ...
42168
43169
44Better documentation170Better documentation
45--------------------171********************
46172
47Numerous improvements have been made to the developer documentation.173* ``bzr help patterns`` now explains case insensitive patterns and
48174 points to Python regular expression documentation.
49175 (Parth Malwankar, #594386)
50Enhanced GUI clients176
51--------------------177* Numerous improvements have been made to the developer documentation.
52178
53(Details coming soon.)179
180Changes to plugins
181******************
182
183
184bzr grep
185========
186
187The `grep plugin <https://launchpad.net/bzr-grep>`_ has developed well
188during the bzr 2.2 cycle. bzr grep can search the versioned files in the
189working tree, or in one or a series of revisions, or it can search through
190only the changes in a revision range.
191
192qbzr
193====
194
195`qbzr <https://launchpad.net/qbzr>`_, a cross-platform graphical interface
196to Bazaar, gained many features and fixes in its 0.19 release, including:
197
198* qannotate has new look and feel; with new features: find text and goto
199 to line.
200
201* Improved performance of qlog, and treewidget-based dialogs (qcommit,
202 qadd, qrevert etc.)
203
204* qpush, qmerge, etc.: When there are uncommitted changes in the working
205 tree, user has the option to commit, or revert.
206
207* qcommit: user can update bound branch/chgeckout if it is not up to date.
208
209* Fixed bug with Mac OS X support when windows start in background.
210 (Thanks to Luis Arias)
211
212* qlog: Context menu actions for tag, and revert will now show a branch
213 menu if more than one branch is open.
214
215* qlog: more context menu actions for update, cherry-pick, and reverse
216 cherry-pick.
217
218* Language of GUI can be set in DEFAULT section of bazaar.conf as
219``language = code``. Language codes are the same as for LANG environment
220 variable. Environment variable LANGUAGE still preferred over settings
221 in bazaar.conf.
222
223* Language of GUI can be set in DEFAULT section of bazaar.conf
224 as ``language = code``. Language codes are the same as for LANG environment
225 variable. Environment variable LANGUAGE still preferred over settings
226 in bazaar.conf. (Alexander Belchenko)
227
228* New Thai and Hungarian translations.
229
230
231Platform-specific changes
232*************************
233
234Microsoft Windows
235=================
236
237* There's a new py2exe windows program ``bzrw.exe``, which allows for starting a Bazaar GUI with out have a console open in the background. (Gary van der Merwe, #433781`)
238
239* The all-in-one Windows installer will now be built with docstrings stripped
240 from the library zip, reducing the size and slightly improving cold startup
241 time. Bundled plugins are unchanged for the moment, but if adding other new
242 plugins to an all-in-one installation, ensure they are compiled and
243 installed with -O1 or help may not work. (Martin [gz])
244
245* Parsing of command lines, for example in ``diff --using``, no longer
246 treats backslash as an escape character on Windows. (Gordon Tyler,
247 #392248)
248
249
250API changes
251***********
252
253* BzrError subclasses no longer support the name "message" to be used
254 as an argument for __init__ or in _fmt format specification as this
255 breaks in some Python versions. errors.LockError.__init__ argument
256 is now named "msg" instead of earlier "message".
257 (Parth Malwankar, #603461)
258
259* The old ``bzr selftest --benchmark`` option has been removed.
260 <https://launchpad.net/bzr-usertest> is an actively-maintained
261 macrobenchmark suite.
262 (Martin Pool)
263
264* bzrlib library users now need to call ``__enter__`` and ``__exit__`` on
265 the result of ``bzrlib.initialize``. This change was made when fixing
266 the bad habit recent bzr versions have had of leaving progress bars
267 behind on the screen. That required calling another function before
268 exiting the program, and it made sense to provide a full context
269 manager at the same time. (Robert Collins)
270
271* The ``bzr`` front end now requires a ``bzrlib.ui.ui_factory`` which is a
272 context manager in the Python 2.5 and above sense. The bzrlib base class
273 is such a manager, but third party UI factories which do not derive from
274 ``bzrlib.ui.UIFactory`` will be incompatible with the command line front
275 end.
276
277* URLs like ``foo:bar/baz`` are now always parsed as a URL with scheme "foo"
278 and path "bar/baz", even if bzr does not recognize "foo" as a known URL
279 scheme. Previously these URLs would be treated as local paths.
280 (Gordon Tyler)
54281
55282
56Further information283Further information
57-------------------284*******************
58285
59For more detailed information on the changes made, be sure to check286For more detailed information on the changes made, see the
60the :doc:`../release-notes/index` for:287the :doc:`../release-notes/index` for:
61288
62* the interim bzr `milestones <https://launchpad.net/bzr/2.2>`_289* the interim bzr `milestones <https://launchpad.net/bzr/2.2>`_
@@ -66,5 +293,5 @@
66293
67* :doc:`whats-new-in-2.1`294* :doc:`whats-new-in-2.1`
68295
69Enjoy,296
70The Bazaar Development Team297.. vim: ft=rst

Subscribers

People subscribed via source and target branches