From aa3122956b8e1d75cbe016ac46d472c60c88e1ee Mon Sep 17 00:00:00 2001 From: Max Kanat-Alexander Date: Fri, 22 Oct 2010 17:20:34 -0700 Subject: Bug 604256: Release Notes for Bugzilla 4.0rc1. r=LpSolit, a=mkanat --- template/en/default/pages/release-notes.html.tmpl | 915 +++++++++++++++++++++- 1 file changed, 894 insertions(+), 21 deletions(-) diff --git a/template/en/default/pages/release-notes.html.tmpl b/template/en/default/pages/release-notes.html.tmpl index 8877c2672..eea13e85d 100644 --- a/template/en/default/pages/release-notes.html.tmpl +++ b/template/en/default/pages/release-notes.html.tmpl @@ -18,12 +18,648 @@ #%] [% PROCESS global/variables.none.tmpl %] +[% SET title = "$terms.Bugzilla 4.0 Release Notes" %] [% INCLUDE global/header.html.tmpl - title = "$terms.Bugzilla 3.6 Release Notes" + title = title style_urls = ['skins/standard/page.css'] %] -

Table of Contents

+

[% title FILTER html %]

+ + + +

Introduction

+ +

This is [% terms.Bugzilla %] 4.0! Since 3.6 (our previous major + release) we've come a long way, and we've come even further compared to + 3.0 in 2007! Since [% terms.Bugzilla %] 3.0, almost every major user + interface in [% terms.Bugzilla %] has been redesigned, the WebServices have + evolved enormously, there's a great new Extensions system, and there + are hundreds of other new features. With the major redesigns that come + particularly in this release compared to 3.6, we felt that it was time to + call this release 4.0.

+ +

It's not just major WebService and UI enhancements that are new in + [%+ terms.Bugzilla %] 4.0—there are many other exciting new features, + including automatic duplicate detection, enhanced custom field + functionality, autocomplete for users, search improvements, and much + more. Overall, 4.0 is far and away the best version of [% terms.Bugzilla %] + we've ever released.

+ +

If you're upgrading, make sure to read Notes + On Upgrading From a Previous Version. If you are upgrading from a release + before 3.6, make sure to read the release notes for all the + previous versions in between your version + and this one, particularly the Upgrading section of each + version's release notes.

+ +

We would like to thank + ITA Software, + the IBM Linux Technology Center, + and Red Hat for funding the development + of certain features and improvements in this release of + [%+ terms.Bugzilla %].

+ +

Minimum Requirements

+ +

Any requirements that are new since 3.6.3 will look like + this.

+ + + + +

Perl

+ +

Perl v5.8.1

+ +[% INCLUDE db_req db='mysql' %] + +[% INCLUDE db_req db='pg' %] + +[% INCLUDE db_req db='oracle' %] + +

Required Perl Modules

+ +[% INCLUDE req_table reqs = REQUIRED_MODULES + new = ['List-MoreUtils'] + updated = ['Email-MIME', 'CGI.pm'] %] + +

Optional Perl Modules

+ +

The following perl modules, if installed, enable various + features of [% terms.Bugzilla %]:

+ +[% INCLUDE req_table reqs = OPTIONAL_MODULES + new = ['JSON-XS'] + updated = [] + include_feature = 1 %] + +

Optional Apache Modules

+ +

If you are using Apache as your webserver, [% terms.Bugzilla %] can + now take advantage of some Apache features if you have the below Apache + modules installed and enabled. Currently, + certain [% terms.Bugzilla %] features + are enabled only if you have all of the following modules installed + and enabled:

+ + + +

On most systems (but not on Windows), checksetup.pl is able to + tell whether or not you have these modules installed, and it will tell + you.

+ +

New Features and Improvements

+ + + +

Automatic Duplicate Detection When Filing + [%+ terms.Bugs %]

+ +

When filing [% terms.abug %], as soon as you start typing in the summary + field, [% terms.Bugzilla %] will suggest possible duplicates of the + [%+ terms.bug %] you are filing.

+ +

In order for this feature to work, all pre-requisites for JSON-RPC + support must be installed on your [% terms.Bugzilla %]. It will be + much faster on installations that run under mod_perl than it will + be on other installations.

+ +

This automatic duplicate detection does not currently work for installations + running on PostgreSQL.

+ +

New Advanced Search UI

+ +

Thanks to the UI work of Guy + Pyrzak, the Advanced Search UI has been completely redesigned. + It is now much simpler, and far more approachable for new users, while + still retaining all of the features that power users are used to.

+ +

New Attachment Details UI

+ +

The UI used for editing attachment details has been completely + redesigned, allowing for a normally-size comment box to be used + when commenting on attachments, and allowing nearly the entire screen + width to be used when doing code reviews or editing an attachment as + a comment.

+ +

Thanks to Guy Pyrzak for + his excellent work on this UI redesign.

+ +

Autocomplete for Users and Keywords

+ +

Once you type at least three characters in any field that can contain a user + (including the [% field_descs.cc FILTER html %], + [%+ field_descs.qa_contact FILTER html %], or + [%+ field_descs.assigned_to FILTER html %] fields), a list will appear + containing all of the users whose real names or usernames match what you are + typing. Your [% terms.Bugzilla %] must have all of the optional Perl + modules required for JSON-RPC support installed, though, in order for + this feature to work. Also, this feature will be much + faster on installations that run under mod_perl than it will be on + other installations.

+ +

There is also a similar autocomplete for the Keywords field. The + Keywords autocomplete does not require JSON-RPC.

+ +

General Usability Improvements

+ +

In addition to the enhancements listed above, there have been + many improvements made across the [% terms.Bugzilla %] + user interface. For a list of specific enhancements that were significant, + see the Other Enhancements and Changes + section.

+ +

New Default Status Workflow

+ +

For new installations of [% terms.Bugzilla %], the default set of + statuses will now be:

+ + + +

And the UNCONFIRMED status will be enabled by default in all products.

+ +

On upgrade, existing installations will not be affected--you will retain + your existing status workflow. However, we strongly recommend that you + update your existing workflow to the new one, using a special tool + we've included, contrib/convert-workflow.pl, which you + can run after you use checksetup.pl to upgrade. The + whineatnews.pl and bugzilla-submit scripts + will probably not work properly if you continue to use the old workflow + (though most other parts of [% terms.Bugzilla %] will still function + normally).

+ +

For more information about the workflow and our rationale for changing + it, see the + blog + post about it and the + [% terms.bug %] + where the change was made.

+ +

"Last Search" Now Remembers Multiple Searches

+ +

At the top of every [% terms.bug %] in [% terms.Bugzilla %], there are + links that look like: "First", "Last", "Prev", "Next", and + "Show last search results". In earlier versions of [% terms.Bugzilla %], + if you did two separate searches in separate windows, these links would + only work for the last search you did. Now, [% terms.Bugzilla %] + will "remember" which search result you came from and give you the right + "last search results" or "next bug" from that list, instead of + always using your most recent search.

+ +

There are still some situations where [% terms.Bugzilla %] will have to + "guess" which search you are trying to navigate through, but it does its + best to get it right.

+ +

Cross-Domain WebServices with JSONP

+ +

[% terms.Bugzilla %] now supports making WebService calls from + another domain, inside of a web browser, thanks to support for + JSONP. + This will allow for web "mash-ups" to use [% terms.Bugzilla %] data. + When using JSONP, you may only call functions that get data, + you may not call functions that change data.

+ +

For more details, see the + JSONP + section of the JSON-RPC WebService documentation.

+ +

Major WebService Enhancements

+ +

The WebService has been expanded considerably. The WebService should now be + able to do everything with [% terms.bugs %] that you can do via the + web interface, including updating [% terms.bugs %], adding attachments, + and getting attachment data. For specifics, see the + WebService Changes section of these + release notes.

+ +

Mandatory Custom Fields

+ +

You can now specify that certain custom fields are "mandatory", + meaning that they must have a value when [% terms.abug %] is filed, + and they can never be empty after that.

+ +

Voting Is Now An Extension

+ +

All of the code for voting in [% terms.Bugzilla %] has been moved + into an extension, called "Voting", in the extensions/Voting/ + directory. To enable it, you must remove the disabled file + from that directory, and run checksetup.pl.

+ +

In a future version of [% terms.Bugzilla %], the Voting extension will + be moved outside of the [% terms.Bugzilla %] core code, so we are looking + for somebody who has an interest in the Voting system and would like to + maintain it as a separate extension. There are many enhancement requests + that have been made against the Voting system, and the best way for those + to get addressed is for somebody to step up and offer to maintain the + system outside of [% terms.Bugzilla %]'s core code.

+ +

Users Get New CSS and Javascript + Automatically

+ +

In past versions of [% terms.Bugzilla %], if you changed + [%+ terms.Bugzilla %]'s CSS or Javascript files, then every user of + [%+ terms.Bugzilla %] would have to clear their cache in order to get + the updated files. Now, if you are using Apache as your webserver and + you have the optional Apache modules + installed, users will automatically get every new version of + [%+ terms.Bugzilla %]'s Javascript and CSS without having to clear + their caches.

+ +

This feature also gives a slight performance speedup to + [%+ terms.Bugzilla %] in some cases, and so we recommend that all + administrators install the optional Apache modules if possible.

+ +

Many New Hooks

+ +

Many new code hooks have been added for use by Extensions, + in [% terms.Bugzilla %] 4.0. Now Extensions can access and modify + nearly every part of [% terms.Bugzilla %].

+ +

New Apache Configuration

+ +

(Note: If your [% terms.Bugzilla %] runs under mod_perl or runs on some + other webserver than Apache, this section does not apply to you.)

+ +

The Apache configuration used for [% terms.Bugzilla %] has changed. + In particular, a different AllowOverride statement is required. + See the + Configuration + section of the [% terms.Bugzilla %] Guide for details.

+ +

Other Enhancements and Changes

+ +

Enhancements for Users

+ + + +

Enhancements for Administrators and Developers

+ + + +

WebService Changes

+ + + +

Outstanding Issues

+ + + +

Notes On Upgrading From a Previous Version

+ +

New .htaccess file

+ +

In previous versions of [% terms.Bugzilla %], there was a file + in [% terms.Bugzilla %]'s root directory called ".htaccess" that was + generated by checksetup.pl. This file is now shipped with + [%+ terms.Bugzilla %] instead of being generated during installation.

+ +

If you update via CVS or bzr, you will get a message that your existing + .htaccess file conflicts with the new one. You must + remove your existing .htaccess file and use the new one + instead. Continuing to use your old .htaccess file will cause certain new + features of [% terms.Bugzilla %] to not work properly, and may also lead + to security issues for your system in the future.

+ +

Code Changes Which May Affect Customizations and + Extensions

+ + + + +

[% terms.Bugzilla %] 3.6 Release Notes

- -

Perl

- +

Perl

+

Perl v5.8.1

-[% INCLUDE db_req db='mysql' %] - -[% INCLUDE db_req db='pg' %] - -[% INCLUDE db_req db='oracle' %] - +

For MySQL Users

+ + + +

For PostgreSQL Users

+ + +

For Oracle Users

+ + +

Required Perl Modules

-[% INCLUDE req_table reqs = REQUIRED_MODULES - new = [] updated = [] %] - -

Optional Perl Modules

- + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Module Version
CGI3.21 +
Digest::SHA + (Any) +
Date::Format2.21 +
DateTime0.28 +
DateTime::TimeZone0.71 +
DBI1.41 +
Template2.22 +
Email::Send2.00 +
Email::MIME1.861 +
Email::MIME::Encodings1.313 +
Email::MIME::Modifier1.442 +
URI + (Any) +
+ +

Optional Perl Modules

+

The following perl modules, if installed, enable various features of [% terms.Bugzilla %]:

-[% INCLUDE req_table reqs = OPTIONAL_MODULES - new = ['JSON-RPC', 'Test-Taint'] - updated = ['Chart'] - include_feature = 1 %] + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Module VersionEnables Feature
GD1.20 + Graphical Reports, New Charts, Old Charts
Chart::Lines2.1 + New Charts, Old Charts
Template::Plugin::GD::Image + (Any) + Graphical Reports
GD::Text + (Any) + Graphical Reports
GD::Graph + (Any) + Graphical Reports
XML::Twig + (Any) + Move [% terms.Bugs %] Between Installations, + Automatic Update Notifications
MIME::Parser5.406 + Move [% terms.Bugs %] Between Installations
LWP::UserAgent + (Any) + Automatic Update Notifications
PatchReader0.9.4 + Patch Viewer
Net::LDAP + (Any) + LDAP Authentication
Authen::SASL + (Any) + SMTP Authentication
Authen::Radius + (Any) + RADIUS Authentication
SOAP::Lite0.710.06 + XML-RPC Interface
JSON::RPC + (Any) + JSON-RPC Interface
Test::Taint + (Any) + JSON-RPC Interface, XML-RPC Interface
HTML::Parser3.40 + More HTML in Product/Group Descriptions
HTML::Scrubber + (Any) + More HTML in Product/Group Descriptions
Email::MIME::Attachment::Stripper + (Any) + Inbound Email
Email::Reply + (Any) + Inbound Email
TheSchwartz + (Any) + Mail Queueing
Daemon::Generic + (Any) + Mail Queueing
mod_perl21.999022 + mod_perl

New Features and Improvements

@@ -3196,7 +4069,7 @@ sub y { $var++ } [% BLOCK db_req %] [% SET m = DB_MODULE.$db %] -

For [% m.name FILTER html %] Users

+

For [% m.name FILTER html %] Users