Bazaar

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

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

Subscribers

People subscribed via source and target branches