From 5159ae5142a63c13992b335e33ad347adaa3ac70 Mon Sep 17 00:00:00 2001 From: "jocuri%softhome.net" <> Date: Sun, 2 Nov 2003 22:04:28 +0000 Subject: Rebuilding documentation for the 2.17.5 release; the docbook system on landfill proved to be broken. --- docs/html/Bugzilla-Guide.html | 1111 ++++++++++++++++++++++++++++++----------- 1 file changed, 832 insertions(+), 279 deletions(-) (limited to 'docs/html/Bugzilla-Guide.html') diff --git a/docs/html/Bugzilla-Guide.html b/docs/html/Bugzilla-Guide.html index 216216cc5..3b3283361 100644 --- a/docs/html/Bugzilla-Guide.html +++ b/docs/html/Bugzilla-Guide.html @@ -4,8 +4,7 @@ >The Bugzilla Guide - 2.17.5 Development Release

The Bugzilla Guide - 2.17.5 Development Release

The Bugzilla Guide - 2.17.5 Development Release

Matthew P. Barnson

Matthew P. Barnson

Jacob Steenhagen

Jacob Steenhagen

The Bugzilla Team

This is the documentation for Bugzilla, the mozilla.org @@ -503,15 +512,21 @@ HREF="#upgrade-patches" CLASS="chapter" >


Chapter 1. About This Guide

Chapter 1. About This Guide

1.1. Copyright Information

1.1. Copyright Information

1.2. Disclaimer

1.2. Disclaimer

No liability for the contents of this document can be accepted. Use the concepts, examples, and other content at your own risk. @@ -615,7 +632,9 @@ CLASS="section" >


1.3. New Versions

1.3. New Versions

This is the 2.17.5 version of The Bugzilla Guide. It is so named to match the current version of Bugzilla. @@ -674,7 +693,9 @@ CLASS="section" >


1.4. Credits

1.4. Credits

The people listed below have made enormous contributions to the creation of this Guide, through their writing, dedicated hacking efforts, @@ -798,13 +819,17 @@ CLASS="section" >


1.5. Document Conventions

1.5. Document Conventions

This document uses the following conventions:


Chapter 2. Introduction

Chapter 2. Introduction

2.1. What is Bugzilla?

2.1. What is Bugzilla?

Bugzilla is a bug- or issue-tracking system. Bug-tracking systems allow individual or groups of developers effectively to keep track @@ -1244,7 +1273,9 @@ CLASS="section" >


2.2. Why Should We Use Bugzilla?

2.2. Why Should We Use Bugzilla?

For many years, defect-tracking software has remained principally the domain of large software development houses. Even then, most shops @@ -1316,13 +1347,17 @@ TARGET="_top" CLASS="chapter" >


Chapter 3. Using Bugzilla

Chapter 3. Using Bugzilla

3.1. How do I use Bugzilla?

3.1. How do I use Bugzilla?

This section contains information for end-users of Bugzilla. There is a Bugzilla test installation, called @@ -1341,7 +1376,9 @@ CLASS="section" >


3.1.1. Create a Bugzilla Account

3.1.1. Create a Bugzilla Account

If you want to use Bugzilla, first you need to create an account. Consult with the administrator responsible for your installation of @@ -1409,7 +1446,9 @@ CLASS="section" >


3.1.2. Anatomy of a Bug

3.1.2. Anatomy of a Bug

The core of Bugzilla is the screen which displays a particular bug. It's a good place to explain some Bugzilla concepts. @@ -1674,7 +1713,9 @@ CLASS="section" >


3.1.3. Searching for Bugs

3.1.3. Searching for Bugs

The Bugzilla Search page is is the interface where you can find any bug report, comment, or patch currently in the Bugzilla system. You @@ -1702,7 +1743,9 @@ CLASS="section" >


3.1.4. Bug Lists

3.1.4. Bug Lists

If you run a search, a list of matching bugs will be returned. The default search is to return all open bugs on the system - don't try @@ -1774,7 +1817,9 @@ CLASS="section" >


3.1.5. Filing Bugs

3.1.5. Filing Bugs

Years of bug writing experience has been distilled for your reading pleasure into the @@ -1832,7 +1877,9 @@ CLASS="section" >


3.1.6. Patch Viewer

3.1.6. Patch Viewer

Viewing and reviewing patches in Bugzilla is often difficult due to lack of context, improper format and the inherent readability issues that @@ -1888,7 +1935,9 @@ CLASS="section" >


3.1.6.1. Viewing Patches in Patch Viewer

3.1.6.1. Viewing Patches in Patch Viewer

The main way to view a patch in patch viewer is to click on the "Diff" link next to a patch in the Attachments list on a bug. You may @@ -1900,7 +1949,9 @@ CLASS="section" >


3.1.6.2. Seeing the Difference Between Two Patches

3.1.6.2. Seeing the Difference Between Two Patches

To see the difference between two patches, you must first view the newer patch in Patch Viewer. Then select the older patch from the @@ -1913,7 +1964,9 @@ CLASS="section" >


3.1.6.3. Getting More Context in a Patch

3.1.6.3. Getting More Context in a Patch

To get more context in a patch, you put a number in the textbox at the top of Patch Viewer ("Patch / File / [textbox]") and hit enter. @@ -1927,7 +1980,9 @@ CLASS="section" >


3.1.6.4. Collapsing and Expanding Sections of a Patch

3.1.6.4. Collapsing and Expanding Sections of a Patch

To view only a certain set of files in a patch (for example, if a patch is absolutely huge and you want to only review part of it at a @@ -1941,7 +1996,9 @@ CLASS="section" >


3.1.6.5. Linking to a Section of a Patch

3.1.6.5. Linking to a Section of a Patch

To link to a section of a patch (for example, if you want to be able to give someone a URL to show them which part you are talking @@ -1954,7 +2011,9 @@ CLASS="section" >


3.1.6.6. Going to Bonsai and LXR

3.1.6.6. Going to Bonsai and LXR

To go to Bonsai to get blame for the lines you are interested in, you can click the "Lines XX-YY" link on the section header you are @@ -1970,7 +2029,9 @@ CLASS="section" >


3.1.6.7. Creating a Unified Diff

3.1.6.7. Creating a Unified Diff

If the patch is not in a format that you like, you can turn it into a unified diff format by clicking the "Raw Unified" link at the top @@ -1983,7 +2044,9 @@ CLASS="section" >


3.2. Hints and Tips

3.2. Hints and Tips

This section distills some Bugzilla tips and best practices that have been developed.


3.2.1. Autolinkification

3.2.1. Autolinkification

Bugzilla comments are plain text - so posting HTML will result in literal HTML tags rather than being interpreted by a browser. @@ -2055,7 +2120,9 @@ CLASS="section" >


3.2.2. Quicksearch

3.2.2. Quicksearch

Quicksearch is a single-text-box query tool which uses metacharacters to indicate what is to be searched. For example, typing @@ -2086,7 +2153,9 @@ CLASS="section" >


3.2.3. Comments

3.2.3. Comments

If you are changing the fields on a bug, only comment if either you have something pertinent to say, or Bugzilla requires it. @@ -2108,7 +2177,9 @@ CLASS="section" >


3.2.4. Attachments

3.2.4. Attachments

Use attachments, rather than comments, for large chunks of ASCII data, such as trace, debugging output files, or log files. That way, it doesn't @@ -2132,7 +2203,9 @@ CLASS="section" >


3.2.5. Filing Bugs

3.2.5. Filing Bugs

Try to make sure that everything said in the summary is also said in the first comment. Summaries are often updated and this will @@ -2156,7 +2229,9 @@ CLASS="section" >


3.3. User Preferences

3.3. User Preferences

Once you have logged in, you can customise various aspects of Bugzilla via the "Edit prefs" link in the page footer. @@ -2166,7 +2241,9 @@ CLASS="section" >


3.3.1. Account Settings

3.3.1. Account Settings

On this tab, you can change your basic account information, including your password, email address and real name. For security @@ -2189,7 +2266,9 @@ CLASS="section" >


3.3.2. Email Settings

3.3.2. Email Settings

On this tab you can reduce or increase the amount of email sent you from Bugzilla, opting in our out depending on your relationship to @@ -2236,7 +2315,9 @@ CLASS="section" >


3.3.3. Page Footer

3.3.3. Page Footer

On the Search page, you can store queries in Bugzilla, so if you regularly run a particular query it is just a drop-down menu away. @@ -2248,7 +2329,9 @@ CLASS="section" >


3.3.4. Permissions

3.3.4. Permissions

This is a purely informative page which outlines your current permissions on this installation of Bugzilla - what product groups you @@ -2261,13 +2344,17 @@ NAME="permissionsettings">3.3.4. Permissions


Chapter 4. Installation

Chapter 4. Installation

4.1. Step-by-step Install

4.1. Step-by-step Install

Bugzilla has been successfully installed under many different operating systems including almost all Unix clones and @@ -2421,7 +2508,9 @@ CLASS="section" >


4.1.1. MySQL

4.1.1. MySQL

Visit the MySQL homepage at

Figure 4-1. Set Max Packet Size in MySQL


4.1.2. Perl

4.1.2. Perl

Any machine that doesn't have Perl on it is a sad machine indeed. Perl can be got in source form from


4.1.3. Perl Modules

4.1.3. Perl Modules

Perl modules can be found using

Example 4-1. Installing perl modules with CPAN


4.1.3.1. Bundle::Bugzilla

4.1.3.1. Bundle::Bugzilla

If you are running at least perl 5.6.1, you can save yourself a lot of time by using Bundle::Bugzilla. This bundle contains every module @@ -3031,7 +3130,9 @@ CLASS="section" >


4.1.3.2. AppConfig (1.52)

4.1.3.2. AppConfig (1.52)

Dependency for Template Toolkit. We probably don't need to specifically check for it anymore. @@ -3042,7 +3143,9 @@ CLASS="section" >


4.1.3.3. CGI (2.88)

4.1.3.3. CGI (2.88)

The CGI module parses form elements and cookies and does many other usefule things. It come as a part of recent perl distributions, but @@ -3073,7 +3176,9 @@ CLASS="section" >


4.1.3.4. Data::Dumper (any)

4.1.3.4. Data::Dumper (any)

The Data::Dumper module provides data structure persistence for Perl (similar to Java's serialization). It comes with later @@ -3105,7 +3210,9 @@ CLASS="section" >


4.1.3.5. TimeDate modules (2.21)

4.1.3.5. TimeDate modules (2.21)

Many of the more common date/time/calendar related Perl modules have been grouped into a bundle similar to the MySQL modules bundle. @@ -3138,7 +3245,9 @@ CLASS="section" >


4.1.3.6. DBI (1.32)

4.1.3.6. DBI (1.32)

The DBI module is a generic Perl module used the MySQL-related modules. As long as your Perl installation was done @@ -3170,7 +3279,9 @@ CLASS="section" >


4.1.3.7. MySQL-related modules

4.1.3.7. MySQL-related modules

The Perl/MySQL interface requires a few mutually-dependent Perl modules. These modules are grouped together into the the @@ -3213,7 +3324,9 @@ CLASS="section" >


4.1.3.8. File::Spec (0.82)

4.1.3.8. File::Spec (0.82)

File::Spec is a perl module that allows file operations, such as generating full path names, to work cross platform. @@ -3243,7 +3356,9 @@ CLASS="section" >


4.1.3.9. File::Temp (any)

4.1.3.9. File::Temp (any)

File::Temp is used to generate a temporary filename that is guaranteed to be unique. It comes as a standard part of perl @@ -3273,7 +3388,9 @@ CLASS="section" >


4.1.3.10. Template Toolkit (2.08)

4.1.3.10. Template Toolkit (2.08)

When you install Template Toolkit, you'll get asked various questions about features to enable. The defaults are fine, except @@ -3305,7 +3422,9 @@ CLASS="section" >


4.1.3.11. Text::Wrap (2001.0131)

4.1.3.11. Text::Wrap (2001.0131)

Text::Wrap is designed to proved intelligent text wrapping.


4.1.3.12. GD (1.20) [optional]

4.1.3.12. GD (1.20) [optional]

The GD library was written by Thomas Boutell a long while ago to programmatically generate images in C. Since then it's become the @@ -3437,7 +3558,9 @@ CLASS="section" >


4.1.3.13. Chart::Base (0.99c) [optional]

4.1.3.13. Chart::Base (0.99c) [optional]

The Chart module provides Bugzilla with on-the-fly charting abilities. It can be installed in the usual fashion after it has been @@ -3464,7 +3587,9 @@ CLASS="section" >


4.1.3.14. XML::Parser (any) [Optional]

4.1.3.14. XML::Parser (any) [Optional]

XML::Parser is used by the


4.1.3.15. GD::Graph (any) [Optional]

4.1.3.15. GD::Graph (any) [Optional]

In addition to GD listed above, the reporting interface of Bugzilla needs to have the GD::Graph module installed. @@ -3527,7 +3654,9 @@ CLASS="section" >


4.1.3.16. GD::Text::Align (any) [Optional]

4.1.3.16. GD::Text::Align (any) [Optional]

GD::Text::Align, as the name implies, is used to draw aligned strings of text. It is needed by the reporting interface. @@ -3557,7 +3686,9 @@ CLASS="section" >


4.1.3.17. MIME::Parser (any) [Optional]

4.1.3.17. MIME::Parser (any) [Optional]

MIME::Parser is only needed if you want to use the e-mail interface located in the


4.1.3.18. PatchReader (0.9.1) [Optional]

4.1.3.18. PatchReader (0.9.1) [Optional]

PatchReader is only needed if you want to use Patch Viewer, a Bugzilla feature to format patches in a pretty HTML fashion. There are a @@ -3626,7 +3759,9 @@ CLASS="section" >


4.1.4. HTTP Server

4.1.4. HTTP Server

You have freedom of choice here, pretty much any web server that is capable of running


4.1.5. Bugzilla

4.1.5. Bugzilla

You should untar the Bugzilla files into a directory that you're willing to make writable by the default web server user (probably @@ -3794,7 +3931,9 @@ CLASS="section" >


4.1.6. Setting Up the MySQL Database

4.1.6. Setting Up the MySQL Database

After you've gotten all the software installed and working you're ready to start preparing the database for its life as the back end to @@ -3949,7 +4088,9 @@ CLASS="section" >


4.1.7. 4.1.7. checksetup.pl


4.1.8. Configuring Bugzilla

4.1.8. Configuring Bugzilla

You should run through the parameters on the Edit Parameters page (link in the footer) and set them all to appropriate values. @@ -4113,13 +4256,17 @@ CLASS="section" >


4.2. Optional Additional Configuration

4.2. Optional Additional Configuration

4.2.1. Dependency Charts

4.2.1. Dependency Charts

As well as the text-based dependency graphs, Bugzilla also supports dependency graphing, using a package called 'dot'. @@ -4181,7 +4328,9 @@ CLASS="section" >


4.2.2. Bug Graphs

4.2.2. Bug Graphs

As long as you installed the GD and Graph::Base Perl modules you might as well turn on the nifty Bugzilla bug reporting graphs.


4.2.3. The Whining Cron

4.2.3. The Whining Cron

By now you have a fully functional Bugzilla, but what good are bugs if they're not annoying? To help make those bugs more annoying you @@ -4325,7 +4476,9 @@ CLASS="section" >


4.2.4. LDAP Authentication

4.2.4. LDAP Authentication

loginmethod
loginmethod

This parameter should be set to

LDAPserver
LDAPserver

This parameter should be set to the name (and optionally the @@ -4493,7 +4650,9 @@ CLASS="QUOTE" >

LDAPbinddn [Optional]
LDAPbinddn [Optional]

Some LDAP servers will not allow an anonymous bind to search @@ -4509,7 +4668,9 @@ CLASS="QUOTE" >

LDAPBaseDN
LDAPBaseDN

The LDAPBaseDN parameter should be set to the location in @@ -4524,7 +4685,9 @@ CLASS="QUOTE" >

LDAPuidattribute
LDAPuidattribute

The LDAPuidattribute parameter should be set to the attribute @@ -4540,7 +4703,9 @@ CLASS="QUOTE" >

LDAPmailattribute
LDAPmailattribute

The LDAPmailattribute parameter should be the name of the @@ -4561,7 +4726,9 @@ CLASS="section" >


4.2.5. Preventing untrusted Bugzilla content from executing malicious +NAME="content-type" +>4.2.5. Preventing untrusted Bugzilla content from executing malicious Javascript code

It is possible for a Bugzilla to execute malicious Javascript @@ -4665,7 +4832,9 @@ CLASS="section" >


4.2.6. 4.2.6. directoryindex for the Bugzilla default page.


4.2.7. Bugzilla and 4.2.7. Bugzilla and mod_perl


4.2.8. 4.2.8. mod_throttle @@ -4754,7 +4927,9 @@ CLASS="section" >

4.3. OS Specific Installation Notes

4.3. OS Specific Installation Notes

Many aspects of the Bugzilla installation can be affected by the the operating system you choose to install it on. Sometimes it can be made @@ -4775,7 +4950,9 @@ CLASS="section" >


4.3.1. Microsoft Windows

4.3.1. Microsoft Windows

Making Bugzilla work on windows is still a very painful processes. The Bugzilla Team is working to make it easier, but that goal is not @@ -4799,7 +4976,9 @@ CLASS="section" >


4.3.1.1. Win32 Perl

4.3.1.1. Win32 Perl

Perl for Windows can be obtained from


4.3.1.2. Perl Modules on Win32

4.3.1.2. Perl Modules on Win32

Bugzilla on Windows requires the same perl modules found in


4.3.1.3. Code changes required to run on win32

4.3.1.3. Code changes required to run on win32

Unfortunately, Bugzilla still doesn't run "out of the box" on Windows. There is work in progress to make this easier, but until that @@ -4946,7 +5129,9 @@ CLASS="section" >


4.3.1.3.1. Changes to 4.3.1.3.1. Changes to checksetup.pl


4.3.1.3.2. Changes to 4.3.1.3.2. Changes to BugMail.pm


4.3.1.4. Serving the web pages

4.3.1.4. Serving the web pages

As is the case on Unix based systems, any web server should be able to handle Bugzilla; however, the Bugzilla Team still recommends @@ -5169,7 +5358,9 @@ CLASS="section" >


4.3.2. 4.3.2. Mac OS X


4.3.3. Linux-Mandrake 8.0

4.3.3. Linux-Mandrake 8.0

Linux-Mandrake 8.0 includes every required and optional library for Bugzilla. The easiest way to install them is by using the @@ -5459,7 +5652,9 @@ CLASS="section" >


4.4. HTTP Server Configuration

4.4. HTTP Server Configuration

The Bugzilla Team recommends Apache when using Bugzilla, however, any web server that can be configured to run


4.4.1. Apache 4.4.1. Apache httpd

Example 4-2.


4.4.2. Microsoft 4.4.2. Microsoft Internet Information Services


4.4.3. AOL Server

4.4.3. AOL Server

Ben FrantzDale reported success using AOL Server with Bugzilla. He reported his experience and what appears below is based on that. @@ -6012,7 +6215,9 @@ CLASS="section" >


4.5. Troubleshooting

4.5. Troubleshooting

This section gives solutions to common Bugzilla installation problems. @@ -6022,7 +6227,9 @@ CLASS="section" >


4.5.1. Bundle::Bugzilla makes me upgrade to Perl 5.6.1

4.5.1. Bundle::Bugzilla makes me upgrade to Perl 5.6.1

Try executing


4.5.2. DBD::Sponge::db prepare failed

4.5.2. DBD::Sponge::db prepare failed

The following error message may appear due to a bug in DBD::mysql (over which the Bugzilla team have no control): @@ -6129,7 +6338,9 @@ CLASS="section" >


4.5.3. cannot chdir(/var/spool/mqueue)

4.5.3. cannot chdir(/var/spool/mqueue)

If you are installing Bugzilla on SuSE Linux, or some other distributions with @@ -6185,7 +6396,9 @@ CLASS="section" >


4.5.4. Your vendor has not defined Fcntl macro O_NOINHERIT

4.5.4. Your vendor has not defined Fcntl macro O_NOINHERIT

This is caused by a bug in the version of

Figure 4-2. Other File::Temp error messages

Figure 4-3. Patch for File::Temp in Perl 5.6.0


Chapter 5. Administering Bugzilla

Chapter 5. Administering Bugzilla

5.1. Bugzilla Configuration

5.1. Bugzilla Configuration

Bugzilla is configured by changing various parameters, accessed from the "Edit parameters" link in the page footer. Here are @@ -6573,13 +6794,17 @@ CLASS="section" >


5.2. User Administration

5.2. User Administration

5.2.1. Creating the Default User

5.2.1. Creating the Default User

When you first run checksetup.pl after installing Bugzilla, it will prompt you for the administrative username (email address) and @@ -6622,13 +6847,17 @@ CLASS="section" >


5.2.2. Managing Other Users

5.2.2. Managing Other Users

5.2.2.1. Creating new users

5.2.2.1. Creating new users

Your users can create their own user accounts by clicking the "New Account" link at the bottom of each page (assuming they @@ -6699,7 +6928,9 @@ CLASS="section" >


5.2.2.2. Modifying Users

5.2.2.2. Modifying Users

To see a specific user, search for their login name in the box provided on the "Edit Users" page. To see all users, @@ -6928,13 +7159,17 @@ CLASS="section" >


5.3. Product, Component, Milestone, and Version Administration

5.3. Product, Component, Milestone, and Version Administration

5.3.1. Products

5.3.1. Products


5.3.2. Components

5.3.2. Components

Components are subsections of a Product. E.g. the computer game you are designing may have a "UI" @@ -7041,7 +7278,9 @@ CLASS="section" >


5.3.3. Versions

5.3.3. Versions

Versions are the revisions of the product, such as "Flinders 3.1", "Flinders 95", and "Flinders 2000". Version is not a multi-select @@ -7075,7 +7314,9 @@ CLASS="section" >


5.3.4. Milestones

5.3.4. Milestones

Milestones are "targets" that you plan to get a bug fixed by. For example, you have a bug that you plan to fix for your 3.0 release, it @@ -7176,7 +7417,9 @@ CLASS="section" >


5.4. Voting

5.4. Voting

Voting allows users to be given a pot of votes which they can allocate to bugs, to indicate that they'd like them fixed. @@ -7236,7 +7479,9 @@ CLASS="section" >


5.5. Groups and Group Security

5.5. Groups and Group Security

Groups allow the administrator to isolate bugs or products that should only be seen by certain people. @@ -7416,7 +7661,9 @@ CLASS="section" >


5.6. Bugzilla Security

5.6. Bugzilla Security


5.6.1. TCP/IP Ports

5.6.1. TCP/IP Ports

TCP/IP defines 65,000 some ports for trafic. Of those, Bugzilla only needs 1... 2 if you need to use features that require e-mail such @@ -7531,7 +7780,9 @@ CLASS="section" >


5.6.2. MySQL

5.6.2. MySQL

MySQL ships by default with many settings that should be changed. By defaults it allows anybody to connect from localhost without a @@ -7658,7 +7909,9 @@ CLASS="section" >


5.6.3. Daemon Accounts

5.6.3. Daemon Accounts

Many daemons, such as Apache's httpd and MySQL's mysqld default to running as either


5.6.4. Web Server Access Controls

5.6.4. Web Server Access Controls

There are many files that are placed in the Bugzilla directory area that should not be accessable from the web. Because of the way @@ -8057,7 +8312,9 @@ CLASS="section" >


5.7. Template Customization

5.7. Template Customization

One of the large changes for 2.16 was the templatization of the entire user-facing UI, using the @@ -8085,7 +8342,9 @@ CLASS="section" >


5.7.1. What to Edit

5.7.1. What to Edit

There are two different ways of editing of Bugzilla's templates, and which you use depends mainly on how you upgrade Bugzilla. The @@ -8233,7 +8492,9 @@ CLASS="section" >


5.7.2. How To Edit Templates

5.7.2. How To Edit Templates

The syntax of the Template Toolkit language is beyond the scope of this guide. It's reasonably easy to pick up by looking at the current @@ -8313,7 +8574,9 @@ CLASS="section" >


5.7.3. Template Formats

5.7.3. Template Formats

Some CGIs have the ability to use more than one template. For example, buglist.cgi can output bug lists as RDF or two @@ -8373,7 +8636,9 @@ CLASS="section" >


5.7.4. Particular Templates

5.7.4. Particular Templates

There are a few templates you may be particularly interested in customizing for your installation. @@ -8560,7 +8825,9 @@ CLASS="section" >


5.7.5. Configuring Bugzilla to Detect the User's Language

5.7.5. Configuring Bugzilla to Detect the User's Language

Begining in version 2.18 (first introduced in version 2.17.4), it's now possible to have the users web browser tell Bugzilla @@ -8601,7 +8868,9 @@ CLASS="section" >


5.8. Change Permission Customization

5.8. Change Permission Customization


5.9. Upgrading to New Releases

5.9. Upgrading to New Releases

Example 5-1. Upgrading using CVS

Example 5-2. Upgrading using the tarball

Example 5-3. Upgrading using patches


5.10. Integrating Bugzilla with Third-Party Tools

5.10. Integrating Bugzilla with Third-Party Tools

5.10.1. Bonsai

5.10.1. Bonsai

Bonsai is a web-based tool for managing


5.10.2. CVS

5.10.2. CVS

CVS integration is best accomplished, at this point, using the Bugzilla Email Gateway.


5.10.3. Perforce SCM

5.10.3. Perforce SCM

You can find the project page for Bugzilla and Teamtrack Perforce integration (p4dti) at: @@ -9394,7 +9679,9 @@ CLASS="section" >


5.10.4. Tinderbox/Tinderbox2

5.10.4. Tinderbox/Tinderbox2

We need Tinderbox integration information.

5.10.4. Tinderbox/Tinderbox2

Appendix A. The Bugzilla FAQ

Appendix A. The Bugzilla FAQ

This FAQ includes questions not covered elsewhere in the Guide.

1. General Questions

1. General Questions

A.1.1. Where can I find information about Bugzilla?

A.1.2. What license is Bugzilla distributed under? @@ -9960,7 +10255,9 @@ CLASS="qandaentry" CLASS="question" >

A.1.3. How do I get commercial support for Bugzilla? @@ -10004,7 +10301,9 @@ CLASS="qandaentry" CLASS="question" >

A.1.4. What major companies or projects are currently using Bugzilla @@ -10049,7 +10348,9 @@ CLASS="qandaentry" CLASS="question" >

A.1.5. Who maintains Bugzilla? @@ -10077,7 +10378,9 @@ CLASS="qandaentry" CLASS="question" >

A.1.6. How does Bugzilla stack up against other bug-tracking databases? @@ -10113,7 +10416,9 @@ CLASS="qandaentry" CLASS="question" >

A.1.7. Why doesn't Bugzilla offer this or that feature or compatibility @@ -10151,7 +10456,9 @@ CLASS="qandaentry" CLASS="question" >

A.1.8. Why MySQL? I'm interested in seeing Bugzilla run on @@ -10194,7 +10501,9 @@ CLASS="qandaentry" CLASS="question" >

A.1.9. What is

A.1.10. My perl is not located at

A.1.11. Is there an easy way to change the Bugzilla cookie name? @@ -10302,7 +10615,9 @@ CLASS="answer" CLASS="qandadiv" >

2. Managerial Questions

2. Managerial Questions

A.2.1. Is Bugzilla web-based, or do you have to have specific software or @@ -10363,7 +10680,9 @@ CLASS="qandaentry" CLASS="question" >

A.2.2. Can Bugzilla integrate with @@ -10387,7 +10706,9 @@ CLASS="qandaentry" CLASS="question" >

A.2.3. Does Bugzilla allow the user to track multiple projects? @@ -10410,7 +10731,9 @@ CLASS="qandaentry" CLASS="question" >

A.2.4. If I am on many projects, and search for all bugs assigned to me, will @@ -10433,7 +10756,9 @@ CLASS="qandaentry" CLASS="question" >

A.2.5. Does Bugzilla allow attachments (text, screenshots, URLs etc)? If yes, @@ -10460,7 +10785,9 @@ CLASS="qandaentry" CLASS="question" >

A.2.6. Does Bugzilla allow us to define our own priorities and levels? Do we @@ -10495,7 +10822,9 @@ CLASS="qandaentry" CLASS="question" >

A.2.7. Does Bugzilla provide any reporting features, metrics, graphs, etc? You @@ -10531,7 +10860,9 @@ CLASS="qandaentry" CLASS="question" >

A.2.8. Is there email notification and if so, what do you see when you get an @@ -10556,7 +10887,9 @@ CLASS="qandaentry" CLASS="question" >

A.2.9. Can email notification be set up to send to multiple @@ -10579,7 +10912,9 @@ CLASS="qandaentry" CLASS="question" >

A.2.10. Do users have to have any particular @@ -10636,7 +10971,9 @@ CLASS="qandaentry" CLASS="question" >

A.2.11. Does Bugzilla allow data to be imported and exported? If I had outsiders @@ -10696,7 +11033,9 @@ CLASS="qandaentry" CLASS="question" >

A.2.12. Has anyone converted Bugzilla to another language to be used in other @@ -10732,7 +11071,9 @@ CLASS="qandaentry" CLASS="question" >

A.2.13. Can a user create and save reports? Can they do this in Word format? @@ -10755,7 +11096,9 @@ CLASS="qandaentry" CLASS="question" >

A.2.14. Does Bugzilla have the ability to search by word, phrase, compound @@ -10779,7 +11122,9 @@ CLASS="qandaentry" CLASS="question" >

A.2.15. Does Bugzilla provide record locking when there is simultaneous access @@ -10804,7 +11149,9 @@ CLASS="qandaentry" CLASS="question" >

A.2.16. Are there any backup features provided? @@ -10832,7 +11179,9 @@ CLASS="qandaentry" CLASS="question" >

A.2.17. Can users be on the system while a backup is in progress? @@ -10856,7 +11205,9 @@ CLASS="qandaentry" CLASS="question" >

A.2.18. What type of human resources are needed to be on staff to install and @@ -10889,7 +11240,9 @@ CLASS="qandaentry" CLASS="question" >

A.2.19. What time frame are we looking at if we decide to hire people to install @@ -10920,7 +11273,9 @@ CLASS="qandaentry" CLASS="question" >

A.2.20. Is there any licensing fee or other fees for using Bugzilla? Any @@ -10943,14 +11298,18 @@ CLASS="answer" CLASS="qandadiv" >

3. Bugzilla Security

3. Bugzilla Security

A.3.1. How do I completely disable MySQL security if it's giving me problems @@ -10977,7 +11336,9 @@ CLASS="qandaentry" CLASS="question" >

A.3.2. Are there any security problems with Bugzilla? @@ -11003,7 +11364,9 @@ CLASS="qandaentry" CLASS="question" >

A.3.3. I've implemented the security fixes mentioned in Chris Yeh's security @@ -11028,14 +11391,18 @@ CLASS="answer" CLASS="qandadiv" >

4. Bugzilla Email

4. Bugzilla Email

A.4.1. I have a user who doesn't want to receive any more email from Bugzilla. @@ -11063,7 +11430,9 @@ CLASS="qandaentry" CLASS="question" >

A.4.2. I'm evaluating/testing Bugzilla, and don't want it to send email to @@ -11087,7 +11456,9 @@ CLASS="qandaentry" CLASS="question" >

A.4.3. I want whineatnews.pl to whine at something more, or other than, only new @@ -11118,7 +11489,9 @@ CLASS="qandaentry" CLASS="question" >

A.4.4. I don't like/want to use Procmail to hand mail off to bug_email.pl. @@ -11134,7 +11507,9 @@ CLASS="answer" You can call bug_email.pl directly from your aliases file, with an entry like this:

bugzilla-daemon: "|/usr/local/bin/bugzilla/contrib/bug_email.pl" @@ -11153,7 +11528,9 @@ CLASS="qandaentry" CLASS="question" >

A.4.5. How do I set up the email interface to submit/change bugs via email? @@ -11176,7 +11553,9 @@ CLASS="qandaentry" CLASS="question" >

A.4.6. Email takes FOREVER to reach me from Bugzilla -- it's extremely slow. @@ -11235,7 +11614,9 @@ CLASS="qandaentry" CLASS="question" >

A.4.7. How come email from Bugzilla changes never reaches me? @@ -11264,14 +11645,18 @@ CLASS="answer" CLASS="qandadiv" >

5. Bugzilla Database

5. Bugzilla Database

A.5.1. I've heard Bugzilla can be used with Oracle? @@ -11297,7 +11682,9 @@ CLASS="qandaentry" CLASS="question" >

A.5.2. I think my database might be corrupted, or contain invalid entries. What @@ -11342,7 +11729,9 @@ CLASS="qandaentry" CLASS="question" >

A.5.3. I want to manually edit some entries in my database. How? @@ -11381,7 +11770,9 @@ CLASS="qandaentry" CLASS="question" >

A.5.4. I think I've set up MySQL permissions correctly, but Bugzilla still can't @@ -11440,7 +11831,9 @@ CLASS="qandaentry" CLASS="question" >

A.5.5. How do I synchronize bug information among multiple different Bugzilla @@ -11475,14 +11868,18 @@ CLASS="answer" CLASS="qandadiv" >

6. Bugzilla and Win32

6. Bugzilla and Win32

A.6.1. What is the easiest way to run Bugzilla on Win32 (Win98+/NT/2K)? @@ -11505,7 +11902,9 @@ CLASS="qandaentry" CLASS="question" >

A.6.2. Is there a "Bundle::Bugzilla" equivalent for Win32? @@ -11529,7 +11928,9 @@ CLASS="qandaentry" CLASS="question" >

A.6.3. CGI's are failing with a "something.cgi is not a valid Windows NT @@ -11550,7 +11951,9 @@ CLASS="answer" >

Microsoft has some advice on this matter, as well:

"Set application mappings. In the ISM, map the extension for the script @@ -11573,7 +11976,9 @@ CLASS="qandaentry" CLASS="question" >

A.6.4. I'm having trouble with the perl modules for NT not being able to talk to @@ -11639,14 +12044,18 @@ TARGET="_top" CLASS="qandadiv" >

7. Bugzilla Usage

7. Bugzilla Usage

A.7.1. How do I change my user name (email address) in Bugzilla? @@ -11669,7 +12078,9 @@ CLASS="qandaentry" CLASS="question" >

A.7.2. The query page is very confusing. Isn't there a simpler way to query? @@ -11693,7 +12104,9 @@ CLASS="qandaentry" CLASS="question" >

A.7.3. I'm confused by the behavior of the "accept" button in the Show Bug form. @@ -11745,7 +12158,9 @@ CLASS="qandaentry" CLASS="question" >

A.7.4. I can't upload anything into the database via the "Create Attachment" @@ -11770,7 +12185,9 @@ CLASS="qandaentry" CLASS="question" >

A.7.5. How do I change a keyword in Bugzilla, once some bugs are using it? @@ -11794,7 +12211,9 @@ CLASS="qandaentry" CLASS="question" >

A.7.6. Why can't I close bugs from the "Change Several Bugs at Once" page? @@ -11828,14 +12247,18 @@ CLASS="answer" CLASS="qandadiv" >

8. Bugzilla Hacking

8. Bugzilla Hacking

A.8.1. What kind of style should I use for templatization? @@ -11892,7 +12315,9 @@ CLASS="qandaentry" CLASS="question" >

A.8.2. What bugs are in Bugzilla right now? @@ -11936,7 +12361,9 @@ CLASS="qandaentry" CLASS="question" >

A.8.3. How can I change the default priority to a null value? For instance, have the default @@ -11965,7 +12392,9 @@ CLASS="qandaentry" CLASS="question" >

A.8.4. What's the best way to submit patches? What guidelines should I follow? @@ -12040,7 +12469,9 @@ TARGET="_top" CLASS="appendix" >


Appendix B. The Bugzilla Database

Appendix B. The Bugzilla Database


B.1. Modifying Your Running System

B.1. Modifying Your Running System

Bugzilla optimizes database lookups by storing all relatively static information in the @@ -12121,7 +12554,9 @@ CLASS="section" >


B.2. MySQL Bugzilla Database Introduction

B.2. MySQL Bugzilla Database Introduction

This information comes straight from my life. I was forced to learn how Bugzilla organizes database because of nitpicky requests from users @@ -12181,7 +12616,9 @@ CLASS="section" >


B.2.1. Bugzilla Database Basics

B.2.1. Bugzilla Database Basics

If you were like me, at this point you're totally clueless about the internals of MySQL, and if it weren't for this executive order from @@ -12293,7 +12730,9 @@ CLASS="section" >


B.2.1.1. Bugzilla Database Tables

B.2.1.1. Bugzilla Database Tables

Imagine your MySQL database as a series of spreadsheets, and you won't be too far off. If you use this command:


Appendix C. Useful Patches and Utilities for Bugzilla

Appendix C. Useful Patches and Utilities for Bugzilla

Are you looking for a way to put your Bugzilla into overdrive? Catch some of the niftiest tricks here in this section.


C.1. Apache +NAME="rewrite" +>C.1. Apache mod_rewrite

C.2. Command-line Bugzilla Queries

C.2. Command-line Bugzilla Queries

There are a suite of Unix utilities for querying Bugzilla from the command line. They live in the @@ -12686,7 +13131,9 @@ CLASS="command" CLASS="appendix" >


Appendix D. Bugzilla Variants and Competitors

Appendix D. Bugzilla Variants and Competitors

I created this section to answer questions about Bugzilla competitors and variants, then found a wonderful site which covers an awful lot of what @@ -12703,7 +13150,9 @@ CLASS="section" >


D.1. Red Hat Bugzilla

D.1. Red Hat Bugzilla

Red Hat's old fork of Bugzilla which was based on version 2.8 is now obsolete. The newest version in use is based on version 2.17.1 and is in @@ -12735,7 +13184,9 @@ CLASS="section" >


D.2. Loki Bugzilla (Fenris)

D.2. Loki Bugzilla (Fenris)

Fenris was a fork from Bugzilla made by Loki Games; when Loki went into receivership, it died. While Loki's other code lives on, @@ -12749,7 +13200,9 @@ CLASS="section" >


D.3. Issuezilla

D.3. Issuezilla

Issuezilla was another fork from Bugzilla, made by collab.net and hosted at tigris.org. It is also dead; the primary focus of bug-tracking @@ -12766,7 +13219,9 @@ CLASS="section" >


D.4. Scarab

D.4. Scarab

Scarab is a new open source bug-tracking system built using Java Servlet technology. It is currently at version 1.0 beta 13.


D.5. Perforce SCM

D.5. Perforce SCM

Although Perforce isn't really a bug tracker, it can be used as such through the


D.6. SourceForge

D.6. SourceForge

SourceForge is a way of coordinating geographically distributed free software and open source projects over the Internet. @@ -12828,11 +13287,15 @@ TARGET="_top" CLASS="appendix" >


Appendix E. GNU Free Documentation License

Appendix E. GNU Free Documentation License

Version 1.1, March 2000

Copyright (C) 2000 Free Software Foundation, Inc. 59 Temple Place, @@ -12845,7 +13308,9 @@ CLASS="section" >


0. PREAMBLE

0. PREAMBLE

The purpose of this License is to make a manual, textbook, or other written document "free" in the sense of freedom: to assure everyone the @@ -12873,7 +13338,9 @@ CLASS="section" >


1. APPLICABILITY AND DEFINITIONS

1. APPLICABILITY AND DEFINITIONS

This License applies to any manual or other work that contains a notice placed by the copyright holder saying it can be distributed under @@ -12936,7 +13403,9 @@ CLASS="section" >


2. VERBATIM COPYING

2. VERBATIM COPYING

You may copy and distribute the Document in any medium, either commercially or noncommercially, provided that this License, the @@ -12956,7 +13425,9 @@ CLASS="section" >


3. COPYING IN QUANTITY

3. COPYING IN QUANTITY

If you publish printed copies of the Document numbering more than 100, and the Document's license notice requires Cover Texts, you must @@ -12998,7 +13469,9 @@ CLASS="section" >


4. MODIFICATIONS

4. MODIFICATIONS

You may copy and distribute a Modified Version of the Document under the conditions of sections 2 and 3 above, provided that you release @@ -13134,7 +13607,9 @@ CLASS="section" >


5. COMBINING DOCUMENTS

5. COMBINING DOCUMENTS

You may combine the Document with other documents released under this License, under the terms defined in section 4 above for modified @@ -13163,7 +13638,9 @@ CLASS="section" >


6. COLLECTIONS OF DOCUMENTS

6. COLLECTIONS OF DOCUMENTS

You may make a collection consisting of the Document and other documents released under this License, and replace the individual copies @@ -13182,7 +13659,9 @@ CLASS="section" >


7. AGGREGATION WITH INDEPENDENT WORKS

7. AGGREGATION WITH INDEPENDENT WORKS

A compilation of the Document or its derivatives with other separate and independent documents or works, in or on a volume of a @@ -13204,7 +13683,9 @@ CLASS="section" >


8. TRANSLATION

8. TRANSLATION

Translation is considered a kind of modification, so you may distribute translations of the Document under the terms of section 4. @@ -13222,7 +13703,9 @@ CLASS="section" >


9. TERMINATION

9. TERMINATION

You may not copy, modify, sublicense, or distribute the Document except as expressly provided for under this License. Any other attempt to @@ -13237,7 +13720,9 @@ CLASS="section" >


10. FUTURE REVISIONS OF THIS LICENSE

10. FUTURE REVISIONS OF THIS LICENSE

The Free Software Foundation may publish new, revised versions of the GNU Free Documentation License from time to time. Such new versions @@ -13263,13 +13748,17 @@ CLASS="section" >


How to use this License for your documents

How to use this License for your documents

To use this License in a document you have written, include a copy of the License in the document and put the following copyright and license notices just after the title page:

Copyright (c) YEAR YOUR NAME. Permission is granted to copy, @@ -13296,13 +13785,17 @@ CLASS="BLOCKQUOTE" CLASS="GLOSSARY" >

Glossary

Glossary

0-9, high ascii

0-9, high ascii

A

A
Apache

B

B
Bugzilla

C

C
Common Gateway Interface
(CGI)
Component
Comprehensive Perl Archive Network
(CPAN)
contrib

D

D

G

G
Groups

J

J
JavaScript

M

M
Message Transport Agent
(MTA)
MySQL

P

P
Perl Package Manager
(PPM)

Q

Q

R

R
Relational DataBase Managment System
(RDBMS)
Regular Expression
(regexp)

S

S

T

T
Target Milestone
Tool Command Language
(TCL)

Z

Z
Zarro Boogs Found