From 78e1dc6bd8beed4e3884875ae8a4f96753dab9cf Mon Sep 17 00:00:00 2001 From: "gerv%gerv.net" <> Date: Thu, 9 May 2002 04:16:36 +0000 Subject: The first installment of Gerv's spanking of the Bugzilla Guide. This is a work-in-progress. --- docs/html/about.html | 12 +- docs/html/aboutthisguide.html | 27 +- docs/html/bzhacking.html | 4 +- docs/html/conventions.html | 12 +- docs/html/copyright.html | 8 +- docs/html/credits.html | 26 +- docs/html/dbdoc.html | 4 +- docs/html/disclaimer.html | 5 +- docs/html/errata.html | 2 +- docs/html/faq.html | 314 ++++++------- docs/html/geninstall.html | 31 +- docs/html/gfdl-howto.html | 2 +- docs/html/gfdl.html | 2 +- docs/html/glossary.html | 4 +- docs/html/how.html | 939 ++++++++++++------------------------- docs/html/index.html | 218 ++------- docs/html/installation.html | 38 +- docs/html/newversions.html | 20 +- docs/html/patches.html | 4 +- docs/html/programadmin.html | 26 +- docs/html/rhbugzilla.html | 4 +- docs/html/security.html | 39 ++ docs/html/setperl.html | 2 +- docs/html/stepbystep.html | 45 +- docs/html/tinderbox.html | 10 +- docs/html/translations.html | 14 +- docs/html/useradmin.html | 69 --- docs/html/using.html | 16 +- docs/html/variant-fenris.html | 4 +- docs/html/variant-issuezilla.html | 4 +- docs/html/variant-perforce.html | 4 +- docs/html/variant-scarab.html | 4 +- docs/html/variant-sourceforge.html | 4 +- docs/html/variants.html | 24 +- docs/html/whatis.html | 71 +-- docs/html/win32.html | 10 +- docs/images/caution.gif | Bin 260 -> 134 bytes docs/images/tip.gif | Bin 2432 -> 1229 bytes docs/images/warning.gif | Bin 151 -> 140 bytes docs/sgml/administration.sgml | 8 +- docs/sgml/conventions.sgml | 8 +- docs/sgml/using.sgml | 745 +++++++++++------------------ docs/xml/administration.xml | 8 +- docs/xml/conventions.xml | 8 +- docs/xml/using.xml | 745 +++++++++++------------------ 45 files changed, 1312 insertions(+), 2232 deletions(-) (limited to 'docs') diff --git a/docs/html/about.html b/docs/html/about.html index 739bea103..cef771118 100644 --- a/docs/html/about.html +++ b/docs/html/about.html @@ -104,21 +104,11 @@ HREF="credits.html" >
1.6. Contributors
1.7. Feedback
1.8. Translations
1.9. 1.7. Document Conventions
1.1. Purpose and Scope of this Guide

This document was started on September 17, 2000 by Matthew P. - Barnson after a great deal of procrastination updating the - Bugzilla FAQ, which I left untouched for nearly half a year. - After numerous complete rewrites and reformatting, it is the - document you see today. -

Bugzilla is simply the best piece of bug-tracking software the world has ever seen. This document is intended to be the comprehensive guide to the installation, administration, @@ -90,7 +83,7 @@ NAME="aboutthisguide">1.1. Purpose and Scope of this Guide

This release of the Bugzilla Guide is the 2.142.16 release. It is so named that it may match the current version of Bugzilla. The numbering tradition stems from that used for many free software projects, @@ -117,26 +110,12 @@ TARGET="_top" >http://www.bugzilla.org/. Intermediate releases will have a minor revision number following a period. The current version - of Bugzilla, as of this writing (August 10, 2001) is 2.14; if + of Bugzilla, as of this writing (April 2nd, 2002) is 2.16; if something were seriously wrong with that edition of the Guide, subsequent releases would receive an additional dotted-decimal - digit to indicate the update (2.14.1, 2.14.2, etc.). + digit to indicate the update (2.16.1, 2.16.2, etc.). Got it? Good.

I wrote this in response to the enormous demand for decent - Bugzilla documentation. I have incorporated instructions from - the Bugzilla README, Frequently Asked Questions, Database Schema - Document, and various mailing lists to create it. Chances are, - there are glaring errors in this documentation; please contact - <barnboy@trilobyte.net> to correct them. -

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

A.4.2. Has anyone you know of already done any Bugzilla integration with @@ -1604,7 +1604,7 @@ CLASS="qandaentry" CLASS="question" >

A.4.3. Does Bugzilla allow the user to track multiple projects? @@ -1630,7 +1630,7 @@ CLASS="qandaentry" CLASS="question" >

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

A.4.5. Does Bugzilla allow attachments (text, screenshots, urls etc)? If yes, @@ -1681,7 +1681,7 @@ CLASS="qandaentry" CLASS="question" >

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

A.4.7. The index.html page doesn't show the footer. It's really annoying to have @@ -1901,7 +1901,7 @@ CLASS="qandaentry" CLASS="question" >

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

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

A.4.10. Can email notification be set up to send to multiple @@ -1988,7 +1988,7 @@ CLASS="qandaentry" CLASS="question" >

A.4.11. If there is email notification, do users have to have any particular @@ -2045,7 +2045,7 @@ CLASS="qandaentry" CLASS="question" >

A.4.12. If I just wanted to track certain bugs, as they go through life, can I @@ -2072,7 +2072,7 @@ CLASS="qandaentry" CLASS="question" >

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

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

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

A.4.16. Can a user re-run a report with a new project, same query? @@ -2188,7 +2188,7 @@ CLASS="qandaentry" CLASS="question" >

A.4.17. Can a user modify an existing report and then save it into another name? @@ -2211,7 +2211,7 @@ CLASS="qandaentry" CLASS="question" >

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

A.4.19. Can the admin person establish separate group and individual user @@ -2258,7 +2258,7 @@ CLASS="qandaentry" CLASS="question" >

A.4.20. Does Bugzilla provide record locking when there is simultaneous access @@ -2283,7 +2283,7 @@ CLASS="qandaentry" CLASS="question" >

A.4.21. Are there any backup features provided? @@ -2311,7 +2311,7 @@ CLASS="qandaentry" CLASS="question" >

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

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

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

A.4.25. Is there any licensing fee or other fees for using Bugzilla? Any @@ -2435,7 +2435,7 @@ CLASS="qandaentry" CLASS="question" >

A.5.1. How do I download and install Bugzilla? @@ -2462,7 +2462,7 @@ CLASS="qandaentry" CLASS="question" >

A.5.2. How do I install Bugzilla on Windows NT? @@ -2485,7 +2485,7 @@ CLASS="qandaentry" CLASS="question" >

A.5.3. Is there an easy way to change the Bugzilla cookie name? @@ -2513,7 +2513,7 @@ CLASS="qandaentry" CLASS="question" >

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

A.6.2. Are there any security problems with Bugzilla? @@ -2566,7 +2566,7 @@ CLASS="qandaentry" CLASS="question" >

A.6.3. I've implemented the security fixes mentioned in Chris Yeh's security @@ -2598,7 +2598,7 @@ CLASS="qandaentry" CLASS="question" >

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

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

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

A.7.4. I don't like/want to use Procmail to hand mail off to bug_email.pl. @@ -2692,7 +2692,7 @@ 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" @@ -2711,7 +2711,7 @@ CLASS="qandaentry" CLASS="question" >

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

A.7.6. Email takes FOREVER to reach me from bugzilla -- it's extremely slow. @@ -2766,7 +2766,7 @@ CLASS="qandaentry" CLASS="question" >

A.7.7. How come email never reaches me from bugzilla changes? @@ -2802,7 +2802,7 @@ CLASS="qandaentry" CLASS="question" >

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

A.8.2. Bugs are missing from queries, but exist in the database (and I can pull @@ -2862,7 +2862,7 @@ CLASS="qandaentry" CLASS="question" >

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

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

A.8.5. I try to add myself as a user, but Bugzilla always tells me my password is wrong. @@ -2958,7 +2958,7 @@ CLASS="qandaentry" CLASS="question" >

A.8.6. I think I've set up MySQL permissions correctly, but bugzilla still can't @@ -2985,7 +2985,7 @@ CLASS="qandaentry" CLASS="question" >

A.8.7. How do I synchronize bug information among multiple different Bugzilla @@ -3021,7 +3021,7 @@ CLASS="qandaentry" CLASS="question" >

A.8.8. Why do I get bizarre errors when trying to submit data, particularly problems @@ -3047,7 +3047,7 @@ CLASS="qandaentry" CLASS="question" >

A.8.9. How come even after I delete bugs, the long descriptions show up? @@ -3059,7 +3059,7 @@ CLASS="answer" > - This should only happen with Bugzilla 2.14 if you are + This should only happen with Bugzilla 2.16 if you are using the "shadow database"

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

A.9.2. Is there a "Bundle::Bugzilla" equivalent for Win32? @@ -3136,7 +3136,7 @@ CLASS="qandaentry" CLASS="question" >

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

Microsoft has some advice on this matter, as well:

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

A.9.4. Can I have some general instructions on how to make Bugzilla on Win32 work? @@ -3292,7 +3292,7 @@ CLASS="qandaentry" CLASS="question" >

A.9.5. I'm having trouble with the perl modules for NT not being able to talk to @@ -3365,7 +3365,7 @@ CLASS="qandaentry" CLASS="question" >

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

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

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

A.10.4. Email submissions to Bugzilla that have attachments end up asking me to @@ -3496,7 +3496,7 @@ CLASS="qandaentry" CLASS="question" >

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

A.11.1. What bugs are in Bugzilla right now? @@ -3570,7 +3570,7 @@ CLASS="qandaentry" CLASS="question" >

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

A.11.3. What's the best way to submit patches? What guidelines should I follow? diff --git a/docs/html/geninstall.html b/docs/html/geninstall.html index 8a760b410..b5cecc5fc 100644 --- a/docs/html/geninstall.html +++ b/docs/html/geninstall.html @@ -79,7 +79,7 @@ CLASS="section" >

3.5.1. Modifying Your Running System

3.5.1. Modifying Your Running System

Bugzilla optimizes database lookups by storing all relatively static information in the versioncache file, located in the data/ subdirectory @@ -110,13 +110,26 @@ CLASS="section" >

3.5.2. Upgrading From Previous Versions

3.5.2. Upgrading From Previous Versions

The developers of Bugzilla are constantly adding new tables, columns and - fields. You'll get SQL errors if you just update the code. The strategy - to update is to simply always run the checksetup.pl script whenever - you upgrade your installation of Bugzilla. If you want to see what has - changed, you can read the comments in that file, starting from the end. +> A plain Bugzilla is fairly easy to upgrade from one version to a newer one. + However, things get a bit more complicated if you've made changes to + Bugzilla's code. In this case, you may have to re-make or reapply those + changes. + It is recommended that you take a backup of your database and your entire + Bugzilla installation before attempting an upgrade. You can upgrade a 'clean' + installation by untarring a new tarball over the old installation. If you + are upgrading from 2.12 or later, you can type cvs -z3 + update, and resolve conflicts if there are any. +

Because the developers of Bugzilla are constantly adding new tables, columns + and fields, you'll probably get SQL errors if you just update the code and + attempt to use Bugzilla. Always run the checksetup.pl script whenever + you upgrade your installation.

If you are running Bugzilla version 2.8 or lower, and wish to upgrade to @@ -148,7 +161,9 @@ CLASS="filename" generate the .htaccess files. +> files. These .htaccess files + will not work with Apache 1.2.x - but this has security holes, so you + shouldn't be using it anyway.

How to use this License for your documents

Copyright (c) YEAR YOUR NAME. diff --git a/docs/html/gfdl.html b/docs/html/gfdl.html index 494181248..86804257f 100644 --- a/docs/html/gfdl.html +++ b/docs/html/gfdl.html @@ -142,7 +142,7 @@ HREF="gfdl-howto.html" >

Version 1.1, March 2000

Copyright (C) 2000 Free Software Foundation, Inc. diff --git a/docs/html/glossary.html b/docs/html/glossary.html index 8f3993bb9..3702edfef 100644 --- a/docs/html/glossary.html +++ b/docs/html/glossary.html @@ -68,7 +68,7 @@ CLASS="glossdiv" >

0-9, high ascii

0-9, high ascii
P

Example 1. A Sample Product

Bugzilla is a large, complex system. Describing how to use it - requires some time. If you are only interested in installing or - administering a Bugzilla installation, please consult the +> This section contains information for end-users of Bugzilla. + If you are administering a Bugzilla installation, please consult the Installing and Administering Bugzilla portions of this Guide. - This section is principally aimed towards developing end-user - mastery of Bugzilla, so you may fully enjoy the benefits - afforded by using this reliable open-source bug-tracking - software.

Throughout this portion of the Guide, we will refer to user - account options available at the Bugzilla test installation, +> There is a Bugzilla test installation, called landfill.tequilarista.org. -

Some people have run into difficulties completing this - tutorial. If you run into problems, please check the - updated online documentation available at http://www.trilobyte.net/barnsons. If you're still stumped, please subscribe to the newsgroup and provide details of exactly what's stumping you! If enough people complain, I'll have to fix it in the next version of this Guide. You can subscribe to the newsgroup at news://news.mozilla.org/netscape.public.mozilla.webtools -

Although Landfill serves as a great introduction to - Bugzilla, it does not offer all the options you would have as a - user on your own installation of Bugzilla, nor can it do more - than serve as a general introduction to Bugzilla. Additionally, - Landfill often runs cutting-edge versions of Bugzilla for +> Landfill, which you are welcome to play with. + However, it does not necessarily have all Bugzilla features + enabled, and often runs cutting-edge versions of Bugzilla for testing, so some things may work slightly differently than mentioned here.

2.3.1. Create a Bugzilla Account

First things first! If you want to use Bugzilla, first you +> If you want to use Bugzilla, first you need to create an account. Consult with the administrator responsible for your installation of Bugzilla for the URL you - should use to access it. If you're test-driving the end-user - Bugzilla experience, use this URL: http://landfill.tequilarista.org/bugzilla-tip/

  • Click the "Open a new Bugzilla account" link. -

  • Enter your "E-mail address" and "Real Name" (or whatever - name you want to call yourself) in the spaces provided, - then select the "Create Account" button. +> Click the "Open a new Bugzilla account" link, enter your + email address and, optionally, your name in the spaces provided, + then click "Create Account".

  • "Log In" link in the yellow area at - the bottom of the page in your browser, then enter your - "E-mail address" and "Password" - you just received into the spaces provided, and select + the bottom of the page in your browser, enter your + email address and password into the spaces provided, and click "Login". -

    If you ever forget your password, you can come back to - this page, enter your "E-mail address", - then select the "E-mail me a password" - button to have your password mailed to you again so - that you can login. -

    -

    Many modern browsers include an - "Auto-Complete" or "Form - Fill" feature to remember the user names and - passwords you type in at many sites. Unfortunately, - sometimes they attempt to guess what you will put in - as your password, and guess wrong. If you notice a - text box is already filled out, please overwrite the - contents of the text box so you can be sure to input - the correct information. -

  • Congratulations! If you followed these directions, you now - are the proud owner of a user account on - landfill.tequilarista.org (Landfill) or your local Bugzilla - install. You should now see in your browser a page called the - "Bugzilla Query Page". It may look daunting, but with this - Guide to walk you through it, you will master it in no time. +> You are now logged in. Bugzilla uses cookies for authentication, so + (unless your IP address changes) you should not have to log in again.

    2.3.2. The Bugzilla Query Page

    2.3.2. Anatomy of a Bug

    The Bugzilla Query Page is the heart and soul of the Bugzilla - user experience. It is the master interface where you can - find any bug report, comment, or patch currently in the - Bugzilla system. We'll go into how to create your own bug - report later on. -

    There are efforts underway to simplify query usage. If you - have a local installation of Bugzilla 2.12 or higher, you - should have quicksearch.html available to - use and simplify your searches. There is also a helper for - the query interface, called - queryhelp.cgi. Landfill tends to run the - latest code, so these two utilities should be available there - for your perusal. -

    At this point, let's visit the query page. - The core of Bugzilla is the screen which displays a particular bug. + It's a good place to explain some Bugzilla concepts. + landfill.tequilarista.org/bugzilla-tip/query.cgi -

    The first thing you need to notice about the Bugzilla Query - Page is that nearly every box you see on your screen has a - hyperlink nearby, explaining what it is or what it does. Near - the upper-left-hand corner of your browser window you should - see the word "Status" underlined. Select it. -

    Notice the page that popped up? Every underlined word you see - on your screen is a hyperlink that will take you to - context-sensitive help. Click around for a while, and learn - what everything here does. To return to the query interface - after pulling up a help page, use the "Back" - button in your browser. -

    I'm sure that after checking out the online help, you are now - an expert on the Bugzilla Query Page. If, however, you feel - you haven't mastered it yet, let me walk you through making a - few successful queries to find out what there are in the - Bugzilla bug-tracking system itself. +>Bug 1 on Landfill is a good example. Note that the names of most fields + are hyperlinks; clicking them will take you to context-sensitive + help on that particular field.

  • Ensure you are back on the "Bugzilla Query - Page". Do nothing in the boxes marked "Status", - "Resolution", "Platform", "OpSys", "Priority", or - "Severity". The default query for "Status" is to find all - bugs that are NEW, ASSIGNED, or REOPENED, which is what we - want. If you don't select anything in the other 5 - scrollboxes there, then you are saying that "any of these - are OK"; we're not locking ourselves into only finding - bugs on the "DEC" Platform, or "Windows 95" OpSys - (Operating System). You're smart, I think you have it - figured out. -

    Basically, selecting anything on the - query page narrows your search down. Leaving stuff - unselected, or text boxes unfilled, broadens your search. -

  • You see the box immediately below the top six boxes that - contains an "Email" text box, with the words "matching - as", a drop-down selection box, then some checkboxes with - "Assigned To" checked by default? This allows you to - filter your search down based upon email address. Let's - put my email address in there, and see what happens. -

    Type "barnboy@trilobyte.net" in the top Email text box. -

  • Let's narrow the search some more. Scroll down until you - find the box with the word "Program" over the top of it. - This is where we can narrow our search down to only - specific products (software programs or product lines) in - our Bugzilla database. Please notice the box is a - scrollbox. Using the down arrow on - the scrollbox, scroll down until you can see an entry - called "Bugzilla". Select this entry. -

  • Did you notice that some of the boxes to the right changed - when you selected "Bugzilla"? Every Program (or Product) - has different Versions, Components, and Target Milestones - associated with it. A "Version" is the number of a - software program. -

    Example 2-1. Some Famous Software Versions

    Do you remember the hype in 1995 when Microsoft - Windows 95(r) was released? It may have been several - years ago, but Microsoft(tm) spent over $300 Million - advertising this new Version of their software. - Three years later, they released Microsoft Windows - 98(r), another new version, to great fanfare, and - then in 2000 quietly released Microsoft Windows - ME(Millenium Edition)(r). -

    Software "Versions" help a manufacturer - differentiate their current product from their - previous products. Most do not identify their - products by the year they were released. Instead, - the "original" version of their software will often - be numbered "1.0", with small bug-fix releases on - subsequent tenths of a digit. In most cases, it's - not a decimal number; for instance, often 1.9 is an - older version of the software - than 1.11, but is a newer - version than 1.1.1. -

    In general, a "Version" in Bugzilla should refer to - released products, not products - that have not yet been released to the public. - Forthcoming products are what the Target Milestone - field is for. -

    -

    A "Component" is a piece of a Product. - It may be a standalone program, or some other logical - division of a Product or Program. - Normally, a Component has a single Owner, who is responsible - for overseeing efforts to improve that Component. -

    Example 2-2. Mozilla's Bugzilla Components

    Mozilla's "Bugzilla" Product is composed of several pieces (Components): +> Product and Component: + Bugs are divided up by Product and Component, with a Product having one + or more Components in it. For example, bugzilla.mozilla.org's + "Bugzilla" Product is composed of several Components:

    Administration, - Administration of a bugzilla installation, including - editcomponents.cgi, - editgroups.cgi, - editkeywords.cgi, - editparams.cgi, - editproducts.cgi, - editusers.cgi, - editversions.cgi, and - sanitycheck.cgi. -
    Bugzilla-General, - Anything that doesn't fit in the other components, or spans - multiple components. -
    Creating/Changing Bugs, - Creating, changing, and viewing bugs. - enter_bug.cgi, - post_bug.cgi, - show_bug.cgi and - process_bug.cgi. -
    Documentation, - The bugzilla documentation, including anything in the - docs/ directory and The Bugzilla Guide - (This document :) -
    Email, - Anything to do with email sent by Bugzilla. - processmail -
    Installation, - The installation process of Bugzilla. This includes - checksetup.pl and whatever else it evolves into. -
    Query/Buglist, - Anything to do with searching for bugs and viewing the buglists. - query.cgi and - buglist.cgi -
    Reporting/Charting, - Getting reports from Bugzilla. - reports.cgi and - duplicates.cgi -
    User Accounts, - Anything about managing a user account from the user's perspective. - userprefs.cgi, saved queries, creating accounts, - changing passwords, logging in, etc. -
    User Interface, - General issues having to do with the user interface cosmetics (not - functionality) including cosmetic issues, HTML templates, etc. -

  • +> Status and Resolution: + A bug passes through several Statuses in its lifetime, and ends up in the + RESOLVED status, with one of a set of Resolutions (e.g. FIXED, INVALID.) + The different possible + values for Status and Resolution on your installation will be documented + in the context-sensitive help for those items. +

  • Assigned To: + The person responsible for fixing the bug.

  • A "Milestone", or "Target Milestone" is a often a planned - future "Version" of a product. In many cases, though, - Milestones simply represent significant dates for a - developer. Having certain features in your Product is - frequently tied to revenue (money) the developer will - receive if the features work by the time she reaches the - Target Milestone. Target Milestones are a great tool to - organize your time. If someone will pay you $100,000 for - incorporating certain features by a certain date, those - features by that Milestone date become a very high - priority. Milestones tend to be highly malleable - creatures, though, that appear to be in reach but are out - of reach by the time the important day arrives. +> URL: + A URL associated with the bug, if any.

  • The Bugzilla Project has set up Milestones for future - Bugzilla versions 2.14, 2.16, 2.18, 3.0, etc. However, a - Target Milestone can just as easily be a specific date, - code name, or weird alphanumeric combination, like "M19". +> Summary: + A one-sentence summary of the problem.

  • OK, now let's select the "Bugzilla" component from its scrollbox. +> Status Whiteboard: (a.k.a. Whiteboard) A + free-form text area for adding short notes and tags to a bug.

  • Skip down the page a bit -- do you see the "submit query" button? - Select it, and let's run - this query! +> Keywords: + The administrator can define keywords which you can use to tag and + categorise bugs - e.g. The Mozilla Project has keywords like crash + and regression.

  • Congratulations! You've completed your first Query, and - have before you the Bug List of the author of this Guide, - Matthew P. Barnson (barnboy@trilobyte.net). If I'm doing - well, you'll have a cryptic "Zarro Boogs Found" message on - your screen. It is just a happy hacker's way of saying - "Zero Bugs Found". However, I am fairly certain I will - always have some bugs assigned to me that aren't done yet, - so you won't often see that message! +> Platform and OS: + These indicate the computing environment where the bug was found. +

  • Version: + The "Version" field is usually used for versions of a product which have + been released, and is set to indicate which versions of a Component + have the particular problem the bug report is about. +

  • Priority: + The bug assignee uses this field to prioritise his or her bugs. It's + a good idea not to change this on other people's bugs. +

  • Severity: + This indicates how severe the problem is - from blocker ("application + unusable") to trivial ("minor cosmetic issue"). You can also use this + field to indicate whether a bug is an enhancement request. +

  • Target: + (a.k.a. Target Milestone) A future version by which the bug is to be + fixed. e.g. The Bugzilla Project's milestones for future + Bugzilla versions are 2.18, 2.20, 3.0, etc. Milestones are + not restricted to numbers, thought - you can use any text strings, + such as dates. +

  • Reporter: + The person who filed the bug. +

  • CC list: + A list of people who get mail when the bug changes. +

  • Attachments: + You can attach files (e.g. testcases or patches) to bugs. If there are + any attachments, they are listed in this section. +

  • Dependencies: + If this bug cannot be fixed unless other bugs are fixed (depends on), or + this bug stops other bugs being fixed (blocks), their numbers are + recorded here. +

  • Votes: + Whether this bug has any votes. +

  • Additional Comments: + You can add your two cents to the bug discussion here, if you have + something worthwhile to say.

  • 2.3.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 can play with it here: + landfill.tequilarista.org/bugzilla-tip/query.cgi. +

    The Search page has controls for selecting different possible values + for all of the fields in a bug, as described above. Once you've defined + a search, you can either run it, or save it as a Remembered Query, which + can optionally appear in the footer of your pages. +

    Highly advanced querying is done using Boolean Charts, which have their + own context-sensitive help. +

    2.3.4. Bug Lists

    I encourage you to click the bug numbers in the left-hand - column and examine my bugs. Also notice that if you click the - underlined links near the top of this page, they do not take - you to context-sensitive help here, but instead sort the - columns of bugs on the screen! When you need to sort your bugs - by priority, severity, or the people they are assigned to, - this is a tremendous timesaver. +> 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 running this search on a Bugzilla installation with + a lot of bugs!

    A couple more interesting things about the Bug List page: +> The format of the list is configurable. For example, it can be + sorted by clicking the column headings. Other useful features + can be accessed using the links at the bottom of the list:

    : change the bug + attributes which appear in the list.: Sends mail + to the owners of all bugs on the list.Chapter 6. Bugzilla Variants and Competitors
    Long Format: this gives you a large page + with a non-editable summary of the fields of each bug.
    Change Columns: by selecting - this link, you can show all kinds of information in the - Bug List
    Change several bugs at once: If - you have sufficient rights to change all the bugs shown in - the Bug List, you can mass-modify them. This is a big - time-saver.
    Send mail to bug owners: If you - have many related bugs, you can request an update from - every person who owns the bugs in the Bug List asking them - the status.

    There are many more options to the Bugzilla Query Page and - the Bug List than I have shown you. But this should be - enough for you to learn to get around. I encourage you to - check out the Bugzilla Home Page to learn about the Anatomy and Life Cycle of a Bug before continuing. -

    2.3.3. Creating and Managing Bug Reports

    2.3.5. Filing Bugs

    2.3.3.1. Writing a Great Bug Report

    Before we plunge into writing your first bug report, I - encourage you to read some bug-writing guidelines. If you - are reading this document as part of a Bugzilla CVS checkout - or un-tarred Bugzilla distribution, you should be able to - read them by clicking here. If you are reading this online, check out the Mozilla.org bug-writing guidelines at http://www.mozilla.org/quality/bug-writing-guidelines.html. While some of the advice is Mozilla-specific, the basic principles of reporting Reproducible, Specific bugs, isolating the Product you are using, the Version of the Product, the Component which failed, the Hardware Platform, and Operating System you were using at the time of the failure go a long way toward ensuring accurate, responsible fixes for the bug that bit you. -

    While you are at it, why not learn how to find previously - reported bugs? Mozilla.org has published a great tutorial - on finding duplicate bugs, available at Years of bug writing experience has been distilled for your reading + pleasure into the http://www.mozilla.org/quality/help/beginning-duplicate-finding.html. +> Bug Writing Guidelines. +While some of the advice is Mozilla-specific, the basic principles of reporting Reproducible, Specific bugs, isolating the Product you are using, the Version of the Product, the Component which failed, the Hardware Platform, and Operating System you were using at the time of the failure go a long way toward ensuring accurate, responsible fixes for the bug that bit you.

    I realize this was a lot to read. However, understanding - the mentality of writing great bug reports will help us on - the next part! -

    The procedure for filing a test bug is as follows: +

    1. Go back to Go to http://landfill.tequilarista.org/bugzilla-tip/ in your browser. -

    2. Select the Landfill + in your browser and click + Enter a new bug report link. -

    3. Select a product. -

    4. Now you should be at the "Enter Bug" form. The - "reporter" should have been automatically filled out for - you (or else Bugzilla prompted you to Log In again -- - you did keep the email with your username and password, - didn't you?). +>.

    5. Select a Component in the scrollbox. +> Select a product - any one will do.

    6. Bugzilla should have made reasonable guesses, based upon +> Fill in the fields. + Bugzilla should have made reasonable guesses, based upon your browser, for the "Platform" and "OS" drop-down - boxes. If those are wrong, change them -- if you're on - an SGI box running IRIX, we want to know! + boxes. If they are wrong, change them.

    7. Fill in the "Assigned To" box with the email address you - provided earlier. This way you don't end up sending - copies of your bug to lots of other people, since it's - just a test bug. -

    8. Leave the "CC" text box blank. Fill in the "URL" box - with "http://www.mozilla.org". -

    9. Enter "The Bugzilla Guide" in the Summary text box, and - place any comments you have on this tutorial, or the - Guide in general, into the Description box. +> Select "Commit" and send in your bug report.

    Voila! Select "Commit" and send in your bug report! Next - we'll look at resolving bugs. -

    2.3.3.2. Managing your Bug Reports

    OK, you should have a link to the bug you just created near - the top of your page. It should say "Bug XXXX posted", with - a link to the right saying "Back to BUG# XXXX". Select this - link. -

    1. Scroll down a bit on the subsequent page, until you see - the "Resolve bug, changing resolution to (dropdown box). - Normally, you would "Accept bug (change status to - ASSIGNED)", fix it, and then resolve. But in this case, - we're going to short-circuit the process because this - wasn't a real bug. Change the dropdown next to "Resolve - Bug" to "INVALID", make sure the radio button is marked - next to "Resolve Bug", then click "Commit". -

    2. Hey! It said it couldn't take the change in a big red - box! That's right, you must specify a Comment in order - to make this change. Select the "Back" button in your - browser, add a Comment, then try Resolving the bug with - INVALID status again. This time it should work. -

    You have now learned the basics of Bugzilla navigation, - entering a bug, and bug maintenance. I encourage you to - explore these features, and see what you can do with them! - We'll spend no more time on individual Bugs or Queries from - this point on, so you are on your own there. -

    But I'll give a few last hints! -

    There is a CLUE on the Query page that will teach you more how to use the form. -

    If you click the hyperlink on the Component box of the Query page, you will be presented a form that will describe what all the components are. -

    Possibly the most powerful feature of the Query page is the - Boolean Chart section. It's a bit confusing to use the first time, but can provide unparalleled flexibility in your queries, allowing you to build extremely powerful requests. -

    Finally, you can build some nifty Reports using the "Bug Reports" link near the bottom of the query page, and also available via the "Reports" link at the footer of each page. -

    The Bugzilla Guide

    Matthew P. Barnson

    Matthew P. Barnson

    barnboy@trilobyte.net

    mbarnson@sisna.com

    Zach Lipton

    zach AT zachlipton DOT com


    2001-04-25

    Revision History
    Revision v2.1120 December 2000Revised by: MPB
    Converted the README, FAQ, and DATABASE information into - SGML docbook format.
    Revision 2.11.106 March 2001Revised by: MPB
    Took way too long to revise this for 2.12 release. Updated - FAQ to use qandaset tags instead of literallayout, cleaned - up administration section, added User Guide section, - miscellaneous FAQ updates and third-party integration - information. From this point on all new tags are lowercase - in preparation for the 2.13 release of the Guide in XML - format instead of SGML.
    Revision 2.12.024 April 2001Revised by: MPB
    Things fixed this release: Elaborated on queryhelp - interface, added FAQ regarding moving bugs from one keyword - to another, clarified possible problems with the Landfill - tutorial, fixed a boatload of typos and unclear sentence - structures. Incorporated the README into the UNIX - installation section, and changed the README to indicate the - deprecated status. Things I know need work: Used - "simplelist" a lot, where I should have used "procedure" to - tag things. Need to lowercase all tags to be XML compliant.
    Revision 2.14.007 August 2001Revised by: MPB
    Attempted to integrate relevant portions of the UNIX and - Windows installation instructions, moved some data from FAQ - to Install, removed references to README from text, added - Mac OS X install instructions, fixed a bunch - of tpyos (Mark Harig), linked text that referenced other - parts of the Guide, and nuked the old MySQL permissions - section.

    This is the documentation for Bugzilla, the Mozilla +> This is the documentation for Bugzilla, the mozilla.org bug-tracking system. -

    Bugzilla is an enterprise-class set of software utilities - that, when used together, power issue-tracking for hundreds of + Bugzilla is an enterprise-class piece of software + that powers issue-tracking for hundreds of organizations around the world, tracking millions of bugs. - While it is easy to use and quite flexible, it is - difficult for a novice to install and maintain. Although we - have provided step-by-step directions, Bugzilla is not always - easy to get working. Please be sure the person responsible - for installing and maintaining this software is a qualified - professional for the operating system upon which you install - Bugzilla.

    THIS DOCUMENTATION IS MAINTAINED IN DOCBOOK 4.1.2 XML FORMAT. - IF YOU WISH TO MAKE CORRECTIONS, PLEASE MAKE THEM IN PLAIN - TEXT OR SGML DIFFS AGAINST THE SOURCE. I CANNOT ACCEPT - ADDITIONS TO THE GUIDE WRITTEN IN HTML! +> This documentation is maintained in DocBook 4.1.2 XML format. + Changes are best submitted as plain text or SGML diffs, attached + to a Bugzilla bug.

    1.6. Contributors
    1.7. Feedback
    1.8. Translations
    1.9. 1.7. Document Conventions
    6. The Future of Bugzilla
    7. Bugzilla Variants and Competitors
    7.1. 6.1. Red Hat Bugzilla
    7.2. 6.2. Loki Bugzilla (Fenris)
    7.3. 6.3. Issuezilla
    7.4. 6.4. Scarab
    7.5. 6.5. Perforce SCM
    7.6. 6.6. SourceForge
    List of Examples
    2-1. Some Famous Software Versions
    2-2. Mozilla's Bugzilla Components
    3-1. Setting up bonsaitools symlink
    3-2. Running checksetup.pl as the web user
    3-3. Installing ActivePerl ppd Modules on Microsoft Windows
    3-4. Installing OpenInteract ppd Modules manually on Microsoft Windows
    3-5. Removing encrypt() for Windows NT Bugzilla version 2.12 or earlier
    4-1. Creating some Components
    4-2. Common Use of Versions
    4-3. A Different Use of Versions
    4-4. Using SortKey with Target Milestone
    4-5. When to Use Group Security
    4-6. Creating a New Group
    4-7. Bugzilla Groups
    D-1. Using Setperl to set your perl path
    1. A Sample Product
    3.2.1. Introduction
    3.2.2. Installing the Prerequisites
    3.2.5. DBI Perl Module
    3.2.6. Data::Dumper Perl Module
    3.2.7. MySQL related Perl Module Collection
    3.2.8. TimeDate Perl Module Collection
    3.2.9. GD Perl Module (1.8.3)
    3.2.10. Chart::Base Perl Module (0.99c)
    3.2.11. DB_File Perl Module
    3.2.12. HTTP Server
    3.2.13. Installing the Bugzilla Files
    3.2.14. Setting Up the MySQL Database
    3.2.15. Tweaking localconfig
    3.2.16. Setting Up Maintainers Manually (Optional)
    3.2.17. The Whining Cron (Optional)
    3.2.18. Bug Graphs (Optional)
    3.2.19. Securing MySQL
    3.5.1. Modifying Your Running System
    3.5.2. Upgrading From Previous Versions
    1.4. New Versions

    This is the 2.14 version of The Bugzilla Guide. If you are +> This is the 2.16 version of The Bugzilla Guide. If you are reading this from any source other than those below, please check one of these mirrors to make sure you are reading an up-to-date version of the Guide. @@ -90,18 +90,9 @@ NAME="newversions">1.4. New Versions

  • TriloBYTE -

  • Mozilla.orgbugzilla.org

  • the Mozilla CVS page, and check out the mozilla/webtools/bugzilla/docs/ branch. +>, and check out the mozilla/webtools/bugzilla/docs/ branch.

    D.5.1. Things that have caused problems and should be avoided
    D.5.2. Coding Style for Bugzilla
    4.3.2. Components

    Example 4-1. Creating some Components

    7.1. Red Hat Bugzilla

    6.1. Red Hat Bugzilla

    Red Hat Bugzilla is probably the most popular Bugzilla variant on the planet. One of the major benefits of Red Hat Bugzilla is diff --git a/docs/html/security.html b/docs/html/security.html index 63e94f8cf..49a2d10a4 100644 --- a/docs/html/security.html +++ b/docs/html/security.html @@ -323,6 +323,45 @@ TARGET="_top" >

    When you run checksetup.pl, the script will attempt to modify various + permissions on files which Bugzilla uses. If you do not have a + webservergroup set in the localconfig file, then Bugzilla will have to + make certain files world readable and/or writable. THIS IS + INSECURE!. This means that anyone who can get access to + your system can do whatever they want to your Bugzilla installation. +

    This also means that if your webserver runs all cgi scripts as the + same user/group, anyone on the system who can run cgi scripts will + be able to take control of your Bugzilla installation. +

    On Apache, you can use .htaccess files to protect access to these directories, as outlined in

    Example D-1. Using Setperl to set your perl path

    3.2.1. Introduction

    3.2.1. Introduction

    Installation of bugzilla is pretty straightforward, particularly if your machine already has MySQL and the MySQL-related perl packages installed. @@ -108,7 +108,7 @@ CLASS="section" >

    3.2.2. Installing the Prerequisites

    3.2.2. Installing the Prerequisites

    3.2.5. DBI Perl Module

    3.2.5. DBI Perl Module

    The DBI module is a generic Perl module used by other database related Perl modules. For our purposes it's required by the MySQL-related @@ -631,7 +631,7 @@ HREF="downloadlinks.html"

    Untar the module tarball -- it should create its own directory @@ -774,7 +774,7 @@ CLASS="section" >

    3.2.6. Data::Dumper Perl Module

    3.2.6. Data::Dumper Perl Module

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

    3.2.7. MySQL related Perl Module Collection

    3.2.7. MySQL related Perl Module Collection

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

    3.2.8. TimeDate Perl Module Collection

    3.2.8. TimeDate Perl Module Collection

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

    3.2.9. GD Perl Module (1.8.3)

    3.2.9. GD Perl Module (1.8.3)

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

    3.2.10. Chart::Base Perl Module (0.99c)

    3.2.10. Chart::Base Perl Module (0.99c)

    The Chart module provides bugzilla with on-the-fly charting abilities. It can be installed in the usual fashion after it @@ -944,7 +944,7 @@ CLASS="section" >

    3.2.11. DB_File Perl Module

    3.2.11. DB_File Perl Module

    DB_File is a module which allows Perl programs to make use of the facilities provided by Berkeley DB version 1.x. This @@ -958,7 +958,7 @@ CLASS="section" >

    3.2.12. HTTP Server

    3.2.12. HTTP Server

    You have a freedom of choice here - Apache, Netscape or any other server on UNIX would do. You can easily run the web @@ -1133,7 +1133,7 @@ CLASS="section" >

    3.2.13. Installing the Bugzilla Files

    3.2.13. Installing the Bugzilla Files

    You should untar the Bugzilla files into a directory that you're willing to make writable by the default web server user @@ -1222,7 +1222,7 @@ HREF="patches.html"

    Example 3-1. Setting up bonsaitools symlink

    
perl -pi -e 's@#!/usr/bonsaitools/bin/perl@#!/usr/bin/perl@' *cgi *pl Bug.pm processmail syncshadowdb
    +>
perl -pi -e 's@#\!/usr/bonsaitools/bin/perl@#\!/usr/bin/perl@' *cgi *pl Bug.pm
    +processmail syncshadowdb
     	    

    3.2.14. Setting Up the MySQL Database

    3.2.14. 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 a the back end to a high @@ -1567,7 +1568,7 @@ CLASS="section" >

    3.2.15. Tweaking 3.2.15. Tweaking localconfig

    Example 3-2. Running checksetup.pl as the web user

    3.2.16. Setting Up Maintainers Manually (Optional)

    3.2.16. Setting Up Maintainers Manually (Optional)

    If you want to add someone else to every group by hand, you can do it by typing the appropriate MySQL commands. Run @@ -1817,7 +1818,7 @@ CLASS="section" >

    3.2.17. The Whining Cron (Optional)

    3.2.17. The Whining Cron (Optional)

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

    3.2.18. Bug Graphs (Optional)

    3.2.18. Bug Graphs (Optional)

    As long as you installed the GD and Graph::Base Perl modules you might as well turn on the nifty bugzilla bug reporting @@ -1956,7 +1957,7 @@ CLASS="section" >

    3.2.19. Securing MySQL

    3.2.19. Securing MySQL

    If you followed the installation instructions for setting up your "bugs" and "root" user in MySQL, much of this should not diff --git a/docs/html/tinderbox.html b/docs/html/tinderbox.html index 81c7a427e..21d52bda0 100644 --- a/docs/html/tinderbox.html +++ b/docs/html/tinderbox.html @@ -16,8 +16,8 @@ REL="PREVIOUS" TITLE="Perforce SCM" HREF="scm.html">NextNextThe Future of BugzillaBugzilla Variants and Competitors

    Prev

    1.8. Translations

    1.6. Translations

    The Bugzilla Guide needs translators! Please volunteer your translation into the language of your choice. If you will @@ -86,7 +86,7 @@ HREF="mailto:mozilla-webtools@mozilla.org" >mozilla-webtools@mozilla.org>, and arrange with - Matt Barnson to check it into CVS. + The Bugzilla Team to check it into CVS.

    PrevFeedbackCredits
  • Email Notification: You may choose - from one of three options: -

    1. All qualifying bugs except those which I change: - The user will be notified of any change to any bug - for which she is the reporter, assignee, QA - Contact, CC recipient, or "watcher". -

    2. Only those bugs which I am listed on the CC line: - The user will not be notified of changes to bugs - where she is the assignee, reporter, or QA - Contact, but will receive them if she is on the CC - list. -

      She will still receive whining cron emails if - you set up the "whinemail" feature. -

      -

    3. All Qualifying Bugs: This - user is a glutton for punishment. If her name is - in the reporter, QA Contact, CC, assignee, or is a - "watcher", she will get email updates regarding - the bug. -

    -

    Disable Text: If you type anything in this box, including just a space, the user account is diff --git a/docs/html/using.html b/docs/html/using.html index b71f98823..95c04c1d7 100644 --- a/docs/html/using.html +++ b/docs/html/using.html @@ -124,13 +124,23 @@ HREF="how.html#myaccount" >

    2.3.2. The Bugzilla Query PageAnatomy of a Bug
    2.3.3. Searching for Bugs
    2.3.4. Bug Lists
    2.3.5. Creating and Managing Bug ReportsFiling Bugs
    Chapter 7. Bugzilla Variants and CompetitorsChapter 6. Bugzilla Variants and Competitors

    7.2. Loki Bugzilla (Fenris)

    6.2. Loki Bugzilla (Fenris)

    Fenris can be found at Chapter 7. Bugzilla Variants and CompetitorsChapter 6. Bugzilla Variants and Competitors

    7.3. Issuezilla

    6.3. Issuezilla

    Issuezilla is another fork from Bugzilla, and seems nearly as popular as the Red Hat Bugzilla fork. Some Issuezilla team diff --git a/docs/html/variant-perforce.html b/docs/html/variant-perforce.html index 93433340b..6fe293481 100644 --- a/docs/html/variant-perforce.html +++ b/docs/html/variant-perforce.html @@ -53,7 +53,7 @@ ACCESSKEY="P" WIDTH="80%" ALIGN="center" VALIGN="bottom" ->Chapter 7. Bugzilla Variants and CompetitorsChapter 6. Bugzilla Variants and Competitors

    7.5. Perforce SCM

    6.5. Perforce SCM

    Although Perforce isn't really a bug tracker, it can be used as such through the Chapter 7. Bugzilla Variants and CompetitorsChapter 6. Bugzilla Variants and Competitors

    7.4. Scarab

    6.4. Scarab

    Scarab is a promising new bug-tracking system built using Java Serlet technology. As of this writing, no source code has diff --git a/docs/html/variant-sourceforge.html b/docs/html/variant-sourceforge.html index 012afa804..70d37059b 100644 --- a/docs/html/variant-sourceforge.html +++ b/docs/html/variant-sourceforge.html @@ -53,7 +53,7 @@ ACCESSKEY="P" WIDTH="80%" ALIGN="center" VALIGN="bottom" ->Chapter 7. Bugzilla Variants and CompetitorsChapter 6. Bugzilla Variants and Competitors

    7.6. SourceForge

    6.6. SourceForge

    SourceForge is more of a way of coordinating geographically distributed free software and open source projects over the diff --git a/docs/html/variants.html b/docs/html/variants.html index 7b64944c3..c9d5d92ca 100644 --- a/docs/html/variants.html +++ b/docs/html/variants.html @@ -10,8 +10,8 @@ REL="HOME" TITLE="The Bugzilla Guide" HREF="index.html">Prev

  • Chapter 7. Bugzilla Variants and Competitors

    Chapter 6. Bugzilla Variants and Competitors
    Table of Contents
    7.1. 6.1. Red Hat Bugzilla
    7.2. 6.2. Loki Bugzilla (Fenris)
    7.3. 6.3. Issuezilla
    7.4. 6.4. Scarab
    7.5. 6.5. Perforce SCM
    7.6. 6.6. SourceForge
    PrevThe Future of BugzillaTinderbox/Tinderbox2
    • integrated, product-based granular security schema -

      Powerful searching

    • inter-bug dependencies and dependency graphing -

      User-configurable email notifications of bug changes

    • advanced reporting capabilities -

      Full change history

    • a robust, stable RDBMS back-end -

      Inter-bug dependency tracking and graphing

    • extensive configurability -

      Excellent attachment management

    • a very well-understood and well-thought-out natural bug resolution protocol -

      Integrated, product-based, granular security schema

    • email, XML, console, and HTTP APIs -

      Fully security-audited, and runs under Perl's taint mode

    • available integration with automated software - configuration management systems, including Perforce and - CVS (through the Bugzilla email interface and - checkin/checkout scripts) -

      A robust, stable RDBMS back-end

    • too many more features to list -

      Web, XML, email and console interfaces

    -

  • Despite its current robustness and popularity, Bugzilla faces - some near-term challenges, such as reliance on a single - database, a lack of abstraction of the user interface and - program logic, verbose email bug notifications, a powerful but - daunting query interface, little reporting configurability, - problems with extremely large queries, some unsupportable bug - resolution options, little internationalization (although non-US - character sets are accepted for comments), and dependence on - some nonstandard libraries. -

    Completely customisable and/or localisable web user interface

  • Some recent headway has been made on the query front, however. - If you are using the latest version of Bugzilla, you should see - a "simple search" form on the default front page of - your Bugzilla install. Type in two or three search terms and - you should pull up some relevant information. This is also - available as "queryhelp.cgi". -

    Extensive configurability

  • Despite these small problems, Bugzilla is very hard to beat. It - is under very active development to address - the current issues, and continually gains new features. +>Smooth upgrade pathway between versions

  • Example 3-3. Installing ActivePerl ppd Modules on Microsoft Windows

    Example 3-4. Installing OpenInteract ppd Modules manually on Microsoft Windows

    From Andrew Pearson:

    You can make Bugzilla work with Personal Web Server for @@ -1487,11 +1487,11 @@ VALIGN="TOP" >not necessary for Bugzilla 2.13 and later, which includes the current release, Bugzilla - 2.14. + 2.16.

    Example 3-5. Removing encrypt() for Windows NT Bugzilla version 2.12 or earlierTHIS IS INSECURE!. This means that anyone who can get access to your system can do whatever they want to your Bugzilla installation. - + + + This also means that if your webserver runs all cgi scripts as the same user/group, anyone on the system who can run cgi scripts will be able to take control of your Bugzilla installation. - - + + On Apache, you can use .htaccess files to protect access to these directories, as outlined in Bug 57161 for the localconfig file, and Bug 65572 for adequate protection in your data/ and shadow/ directories. diff --git a/docs/sgml/conventions.sgml b/docs/sgml/conventions.sgml index 71f2b0c5e..6382985b6 100644 --- a/docs/sgml/conventions.sgml +++ b/docs/sgml/conventions.sgml @@ -23,25 +23,25 @@ Warnings - Warnings. + Don't run with scissors! Hint - Hint. + Warm jar lids under the hot tap to loosen them. Notes - Note. + Dear John... Information requiring special attention - Warning. + Read this or the cat gets it. diff --git a/docs/sgml/using.sgml b/docs/sgml/using.sgml index 6cb301d61..892961729 100644 --- a/docs/sgml/using.sgml +++ b/docs/sgml/using.sgml @@ -55,54 +55,20 @@ system against which all others are measured. Bugzilla has matured immensely, and now boasts many advanced features. These include: - - - integrated, product-based granular security schema - - - - - inter-bug dependencies and dependency graphing - - - - - advanced reporting capabilities - - - - - a robust, stable RDBMS back-end - - - - - extensive configurability - - - - - a very well-understood and well-thought-out natural bug resolution protocol - - - - - email, XML, console, and web interfaces - - - - - available integration with automated software - configuration management systems, including Perforce and - CVS (through the Bugzilla email interface and - checkin/checkout scripts) - - - - - too many more features to list - - + +Powerful searching +User-configurable email notifications of bug changes +Full change history +Inter-bug dependency tracking and graphing +Excellent attachment management +Integrated, product-based, granular security schema +Fully security-audited, and runs under Perl's taint mode +A robust, stable RDBMS back-end +Web, XML, email and console interfaces +Completely customisable and/or localisable web user interface +Extensive configurability +Smooth upgrade pathway between versions + @@ -178,25 +144,16 @@ system against which all others are measured. - Bugzilla is a large, complex system. Describing how to use it - requires some time. If you are only interested in installing or - administering a Bugzilla installation, please consult the + This section contains information for end-users of Bugzilla. + If you are administering a Bugzilla installation, please consult the Installing and Administering Bugzilla portions of this Guide. - This section is principally aimed towards developing end-user - mastery of Bugzilla, so you may fully enjoy the benefits - afforded by using this reliable open-source bug-tracking - software. - Throughout this portion of the Guide, we will refer to user - account options available at the Bugzilla test installation, + There is a Bugzilla test installation, called - landfill.tequilarista.org. - Although Landfill serves as a great introduction to - Bugzilla, it does not offer all the options you would have as a - user on your own installation of Bugzilla, nor can it do more - than serve as a general introduction to Bugzilla. Additionally, - Landfill often runs cutting-edge versions of Bugzilla for + Landfill, which you are welcome to play with. + However, it does not necessarily have all Bugzilla features + enabled, and often runs cutting-edge versions of Bugzilla for testing, so some things may work slightly differently than mentioned here. @@ -207,21 +164,16 @@ system against which all others are measured. If you want to use Bugzilla, first you need to create an account. Consult with the administrator responsible for your installation of Bugzilla for the URL you - should use to access it. If you're test-driving the end-user - Bugzilla experience, use this URL: http://landfill.tequilarista.org/bugzilla-tip/ - Click the "Open a new Bugzilla account" link. - - - - - Enter your "E-mail address" and "Real Name" (or whatever - name you want to call yourself) in the spaces provided, - then select the "Create Account" button. + Click the Open a new Bugzilla account link, enter your + email address and, optionally, your name in the spaces provided, + then click Create Account. @@ -230,308 +182,289 @@ system against which all others are measured. you provided above, which contains your login name (generally the same as the email address), and a password you can use to access your account. This password is - randomly generated, and should be changed at your nearest - opportunity (we'll go into how to do it later). + randomly generated, and can be changed to something more memorable. Click the Log In link in the yellow area at - the bottom of the page in your browser, then enter your - E-mail address and Password - you just received into the spaces provided, and select + the bottom of the page in your browser, enter your + email address and password into the spaces provided, and click Login. - - - If you ever forget your password, you can come back to - this page, enter your E-mail address, - then select the E-mail me a password - button to have your password mailed to you again so - that you can login. - - - Congratulations! If you followed these directions, you now - are the proud owner of a user account on - landfill.tequilarista.org (Landfill) or your local Bugzilla - install. You should now see in your browser a page called the - Bugzilla Query Page. It may look daunting, but with this - Guide to walk you through it, you will master it in no time. + You are now logged in. Bugzilla uses cookies for authentication, so + (unless your IP address changes) you should not have to log in again. -

    - The Bugzilla Query Page - - The Bugzilla Query Page is the heart and soul of the Bugzilla - user experience. It is the master interface where you can - find any bug report, comment, or patch currently in the - Bugzilla system. We'll go into how to create your own bug - report later on. - - - At this point, let's visit the query page. - - landfill.tequilarista.org/bugzilla-tip/query.cgi - - - The first thing you need to notice about the Bugzilla Query - Page is that nearly every box you see on your screen has a - hyperlink nearby, explaining what it is or what it does. Near - the upper-left-hand corner of your browser window you should - see the word Status underlined. Select it. - +
    + Anatomy of a Bug - Notice the page that popped up? Every underlined word you see - on your screen is a hyperlink that will take you to - context-sensitive help. Click around for a while, and learn - what everything here does. To return to the query interface - after pulling up a help page, use the Back - button in your browser. + The core of Bugzilla is the screen which displays a particular bug. + It's a good place to explain some Bugzilla concepts. + Bug 1 on Landfill is a good example. Note that the names of most fields + are hyperlinks; clicking them will take you to context-sensitive + help on that particular field. - - I'm sure that after checking out the online help, you are now - an expert on the Bugzilla Query Page. If, however, you feel - you haven't mastered it yet, let me walk you through making a - few successful queries to find out what there are in the - Bugzilla bug-tracking system itself. - - - + + + + + Product and Component: + Bugs are divided up by Product and Component, with a Product having one + or more Components in it. For example, bugzilla.mozilla.org's + "Bugzilla" Product is composed of several Components: + + Administration, + Administration of a bugzilla installation, including + editcomponents.cgi, + editgroups.cgi, + editkeywords.cgi, + editparams.cgi, + editproducts.cgi, + editusers.cgi, + editversions.cgi, and + sanitycheck.cgi. + + Bugzilla-General, + Anything that doesn't fit in the other components, or spans + multiple components. + + Creating/Changing Bugs, + Creating, changing, and viewing bugs. + enter_bug.cgi, + post_bug.cgi, + show_bug.cgi and + process_bug.cgi. + + Documentation, + The bugzilla documentation, including anything in the + docs/ directory and The Bugzilla Guide + + + Email, + Anything to do with email sent by Bugzilla. + processmail + + Installation, + The installation process of Bugzilla. This includes + checksetup.pl and whatever else it evolves into. + + Query/Buglist, + Anything to do with searching for bugs and viewing the buglists. + query.cgi and + buglist.cgi + + Reporting/Charting, + Getting reports from Bugzilla. + reports.cgi and + duplicates.cgi + + User Accounts, + Anything about managing a user account from the user's perspective. + userprefs.cgi, saved queries, creating accounts, + changing passwords, logging in, etc. + + User Interface, + General issues having to do with the user interface cosmetics (not + functionality) including cosmetic issues, HTML templates, etc. + + + + + + - Ensure you are back on the Bugzilla Query - Page. Do nothing in the boxes marked "Status", - "Resolution", "Platform", "OpSys", "Priority", or - "Severity". The default query for "Status" is to find all - bugs that are NEW, ASSIGNED, or REOPENED, which is what we - want. If you don't select anything in the other 5 - scrollboxes there, then you are saying that "any of these - are OK"; we're not locking ourselves into only finding - bugs on the "DEC" Platform, or "Windows 95" OpSys - (Operating System). You're smart, I think you have it - figured out. + Status and Resolution: + A bug passes through several Statuses in its lifetime, and ends up in the + RESOLVED status, with one of a set of Resolutions (e.g. FIXED, INVALID.) + The different possible + values for Status and Resolution on your installation will be documented + in the context-sensitive help for those items. + + + + + + Assigned To: + The person responsible for fixing the bug. + + + - Basically, selecting anything on the - query page narrows your search down. Leaving stuff - unselected, or text boxes unfilled, broadens your search. + URL: + A URL associated with the bug, if any. - + - + - You see the box immediately below the top six boxes that - contains an "Email" text box, with the words "matching - as", a drop-down selection box, then some checkboxes with - "Assigned To" checked by default? This allows you to - filter your search down based upon email address. Let's - put my email address in there, and see what happens. + Summary: + A one-sentence summary of the problem. + + + - Type "barnboy@trilobyte.net" in the top Email text box. + Status Whiteboard: (a.k.a. Whiteboard) A + free-form text area for adding short notes and tags to a bug. - + + + + + Keywords: + The administrator can define keywords which you can use to tag and + categorise bugs - e.g. The Mozilla Project has keywords like crash + and regression. + + - + - Let's narrow the search some more. Scroll down until you - find the box with the word "Program" over the top of it. - This is where we can narrow our search down to only - specific products (software programs or product lines) in - our Bugzilla database. Please notice the box is a - scrollbox. Using the down arrow on - the scrollbox, scroll down until you can see an entry - called "Bugzilla". Select this entry. + Platform and OS: + These indicate the computing environment where the bug was found. - - + + + - Did you notice that some of the boxes to the right changed - when you selected "Bugzilla"? Every Program (or Product) - has different Versions, Components, and Target Milestones - associated with it. A "Version" is the number of a - software program. - - Some Famous Software Versions - - - Do you remember the hype in 1995 when Microsoft - Windows 95(r) was released? It may have been several - years ago, but Microsoft(tm) spent over $300 Million - advertising this new Version of their software. - Three years later, they released Microsoft Windows - 98(r), another new version, to great fanfare, and - then in 2000 quietly released Microsoft Windows - ME(Millenium Edition)(r). - - - Software "Versions" help a manufacturer - differentiate their current product from their - previous products. Most do not identify their - products by the year they were released. Instead, - the "original" version of their software will often - be numbered "1.0", with small bug-fix releases on - subsequent tenths of a digit. In most cases, it's - not a decimal number; for instance, often 1.9 is an - older version of the software - than 1.11, but is a newer - version than 1.1.1. - - - In general, a "Version" in Bugzilla should refer to - released products, not products - that have not yet been released to the public. - Forthcoming products are what the Target Milestone - field is for. - - - + Version: + The "Version" field is usually used for versions of a product which have + been released, and is set to indicate which versions of a Component + have the particular problem the bug report is about. + + + - A "Component" is a piece of a Product. - It may be a standalone program, or some other logical - division of a Product or Program. - Normally, a Component has a single Owner, who is responsible - for overseeing efforts to improve that Component. - - Mozilla's Bugzilla Components - - - Mozilla's "Bugzilla" Product is composed of several pieces (Components): - - Administration, - Administration of a bugzilla installation, including - editcomponents.cgi, - editgroups.cgi, - editkeywords.cgi, - editparams.cgi, - editproducts.cgi, - editusers.cgi, - editversions.cgi, and - sanitycheck.cgi. - - Bugzilla-General, - Anything that doesn't fit in the other components, or spans - multiple components. - - Creating/Changing Bugs, - Creating, changing, and viewing bugs. - enter_bug.cgi, - post_bug.cgi, - show_bug.cgi and - process_bug.cgi. - - Documentation, - The bugzilla documentation, including anything in the - docs/ directory and The Bugzilla Guide - (This document :) - - Email, - Anything to do with email sent by Bugzilla. - processmail - - Installation, - The installation process of Bugzilla. This includes - checksetup.pl and whatever else it evolves into. - - Query/Buglist, - Anything to do with searching for bugs and viewing the buglists. - query.cgi and - buglist.cgi - - Reporting/Charting, - Getting reports from Bugzilla. - reports.cgi and - duplicates.cgi - - User Accounts, - Anything about managing a user account from the user's perspective. - userprefs.cgi, saved queries, creating accounts, - changing passwords, logging in, etc. - - User Interface, - General issues having to do with the user interface cosmetics (not - functionality) including cosmetic issues, HTML templates, etc. - - - - - + Priority: + The bug assignee uses this field to prioritise his or her bugs. It's + a good idea not to change this on other people's bugs. + + + - A "Milestone", or "Target Milestone" is a often a planned - future "Version" of a product. In many cases, though, - Milestones simply represent significant dates for a - developer. Having certain features in your Product is - frequently tied to revenue (money) the developer will - receive if the features work by the time she reaches the - Target Milestone. Target Milestones are a great tool to - organize your time. If someone will pay you $100,000 for - incorporating certain features by a certain date, those - features by that Milestone date become a very high - priority. Milestones tend to be highly malleable - creatures, though, that appear to be in reach but are out - of reach by the time the important day arrives. + Severity: + This indicates how severe the problem is - from blocker ("application + unusable") to trivial ("minor cosmetic issue"). You can also use this + field to indicate whether a bug is an enhancement request. + + + - The Bugzilla Project has set up Milestones for future - Bugzilla versions 2.14, 2.16, 2.18, 3.0, etc. However, a - Target Milestone can just as easily be a specific date, - code name, or weird alphanumeric combination, like "M19". + Target: + (a.k.a. Target Milestone) A future version by which the bug is to be + fixed. e.g. The Bugzilla Project's milestones for future + Bugzilla versions are 2.18, 2.20, 3.0, etc. Milestones are + not restricted to numbers, thought - you can use any text strings, + such as dates. - + + + + + Reporter: + The person who filed the bug. + + - + - OK, now let's select the "Bugzilla" component from its scrollbox. + CC list: + A list of people who get mail when the bug changes. - - + + + - Skip down the page a bit -- do you see the "submit query" button? - Select it, and let's run - this query! + Attachments: + You can attach files (e.g. testcases or patches) to bugs. If there are + any attachments, they are listed in this section. - - + + + - Congratulations! You've completed your first Query, and - have before you the Bug List of the author of this Guide, - Matthew P. Barnson (barnboy@trilobyte.net). If I'm doing - well, you'll have a cryptic "Zarro Boogs Found" message on - your screen. It is just a happy hacker's way of saying - "Zero Bugs Found". However, I am fairly certain I will - always have some bugs assigned to me that aren't done yet, - so you won't often see that message! + Dependencies: + If this bug cannot be fixed unless other bugs are fixed (depends on), or + this bug stops other bugs being fixed (blocks), their numbers are + recorded here. - - + + + + + Votes: + Whether this bug has any votes. + + + + + + Additional Comments: + You can add your two cents to the bug discussion here, if you have + something worthwhile to say. + + + + + +
    + +
    + Searching for Bugs - I encourage you to click the bug numbers in the left-hand - column and examine my bugs. Also notice that if you click the - underlined links near the top of this page, they do not take - you to context-sensitive help here, but instead sort the - columns of bugs on the screen! When you need to sort your bugs - by priority, severity, or the people they are assigned to, - this is a tremendous timesaver. + The Bugzilla Search page is is the interface where you can + find any bug report, comment, or patch currently in the + Bugzilla system. You can play with it here: + + landfill.tequilarista.org/bugzilla-tip/query.cgi. + + + + The Search page has controls for selecting different possible values + for all of the fields in a bug, as described above. Once you've defined + a search, you can either run it, or save it as a Remembered Query, which + can optionally appear in the footer of your pages. + + + + Highly advanced querying is done using Boolean Charts, which have their + own context-sensitive help. + + +
    + +
    + 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 running this search on a Bugzilla installation with + a lot of bugs! - A couple more interesting things about the Bug List page: + The format of the list is configurable. For example, it can be + sorted by clicking the column headings. Other useful features + can be accessed using the links at the bottom of the list: - Change Columns: by selecting - this link, you can show all kinds of information in the - Bug List + Long Format: this gives you a large page + with a non-editable summary of the fields of each bug. + Change Columns: change the bug + attributes which appear in the list. Change several bugs at once: If - you have sufficient rights to change all the bugs shown in - the Bug List, you can mass-modify them. This is a big - time-saver. - Send mail to bug owners: If you - have many related bugs, you can request an update from - every person who owns the bugs in the Bug List asking them - the status. + your account is sufficiently empowered, you can make the same + change to all the bugs in the list - for example, changing their + owner. + Send mail to bug owners: Sends mail + to the owners of all bugs on the list. Edit this query: If you didn't get exactly the results you were looking for, you can return to the Query page through this link and make small @@ -539,172 +472,54 @@ system against which all others are measured. accurate results. - - - There are many more options to the Bugzilla Query Page and - the Bug List than I have shown you. But this should be - enough for you to learn to get around. I encourage you to - check out the Bugzilla Home Page to learn about the Anatomy and Life Cycle of a Bug before continuing. - -
    - Creating and Managing Bug Reports + Filing Bugs And all this time, I thought we were taking bugs out... -
    - Writing a Great Bug Report - - Before we plunge into writing your first bug report, I - encourage you to read some bug-writing guidelines. If you - are reading this document as part of a Bugzilla CVS checkout - or un-tarred Bugzilla distribution, you should be able to - read them by clicking here. If you are reading this online, check out the Mozilla.org bug-writing guidelines at http://www.mozilla.org/quality/bug-writing-guidelines.html. While some of the advice is Mozilla-specific, the basic principles of reporting Reproducible, Specific bugs, isolating the Product you are using, the Version of the Product, the Component which failed, the Hardware Platform, and Operating System you were using at the time of the failure go a long way toward ensuring accurate, responsible fixes for the bug that bit you. - - - While you are at it, why not learn how to find previously - reported bugs? Mozilla.org has published a great tutorial - on finding duplicate bugs, available at http://www.mozilla.org/quality/help/beginning-duplicate-finding.html. - - I realize this was a lot to read. However, understanding - the mentality of writing great bug reports will help us on - the next part! + Years of bug writing experience has been distilled for your reading + pleasure into the + Bug Writing Guidelines. +While some of the advice is Mozilla-specific, the basic principles of reporting Reproducible, Specific bugs, isolating the Product you are using, the Version of the Product, the Component which failed, the Hardware Platform, and Operating System you were using at the time of the failure go a long way toward ensuring accurate, responsible fixes for the bug that bit you. + + The procedure for filing a test bug is as follows: + + - Go back to http://landfill.tequilarista.org/bugzilla-tip/ in your browser. - - - - - Select the Enter a new bug report link. + Go to Landfill + in your browser and click + Enter a new bug report. - Select a product. - - - - - Now you should be at the "Enter Bug" form. The - "reporter" should have been automatically filled out for - you (or else Bugzilla prompted you to Log In again -- - you did keep the email with your username and password, - didn't you?). - - - - - Select a Component in the scrollbox. + Select a product - any one will do. + Fill in the fields. Bugzilla should have made reasonable guesses, based upon your browser, for the "Platform" and "OS" drop-down - boxes. If those are wrong, change them -- if you're on - an SGI box running IRIX, we want to know! - - - - - Fill in the "Assigned To" box with the email address you - provided earlier. This way you don't end up sending - copies of your bug to lots of other people, since it's - just a test bug. - - - - - Leave the "CC" text box blank. Fill in the "URL" box - with "http://www.mozilla.org". - - - - - Enter "The Bugzilla Guide" in the Summary text box, and - place any comments you have on this tutorial, or the - Guide in general, into the Description box. - - - - - Voila! Select "Commit" and send in your bug report! Next - we'll look at resolving bugs. - -
    - -
    - Managing your Bug Reports - - OK, you should have a link to the bug you just created near - the top of your page. It should say "Bug XXXX posted", with - a link to the right saying "Back to BUG# XXXX". Select this - link. - - - - - Scroll down a bit on the subsequent page, until you see - the "Resolve bug, changing resolution to (dropdown box). - Normally, you would "Accept bug (change status to - ASSIGNED)", fix it, and then resolve. But in this case, - we're going to short-circuit the process because this - wasn't a real bug. Change the dropdown next to "Resolve - Bug" to "INVALID", make sure the radio button is marked - next to "Resolve Bug", then click "Commit". + boxes. If they are wrong, change them. - Hey! It said it couldn't take the change in a big red - box! That's right, you must specify a Comment in order - to make this change. Select the "Back" button in your - browser, add a Comment, then try Resolving the bug with - INVALID status again. This time it should work. + Select "Commit" and send in your bug report. - - - You have now learned the basics of Bugzilla navigation, - entering a bug, and bug maintenance. I encourage you to - explore these features, and see what you can do with them! - We'll spend no more time on individual Bugs or Queries from - this point on, so you are on your own there. - - - But I'll give a few last hints! - - - There is a CLUE on the Query page that will teach you more how to use the form. - - - If you click the hyperlink on the Component box of the Query page, you will be presented a form that will describe what all the components are. - - - Possibly the most powerful feature of the Query page is the - Boolean Chart section. It's a bit confusing to use the first time, but can provide unparalleled flexibility in your queries, allowing you to build extremely powerful requests. - - - Finally, you can build some nifty Reports using the "Bug Reports" link near the bottom of the query page, and also available via the "Reports" link at the footer of each page. - -
    +
    diff --git a/docs/xml/administration.xml b/docs/xml/administration.xml index 8794a0e2c..6789ca071 100644 --- a/docs/xml/administration.xml +++ b/docs/xml/administration.xml @@ -1373,12 +1373,14 @@ Group3, since he isn't in Group4. make certain files world readable and/or writable. THIS IS INSECURE!. This means that anyone who can get access to your system can do whatever they want to your Bugzilla installation. - + + + This also means that if your webserver runs all cgi scripts as the same user/group, anyone on the system who can run cgi scripts will be able to take control of your Bugzilla installation. - - + + On Apache, you can use .htaccess files to protect access to these directories, as outlined in Bug 57161 for the localconfig file, and Bug 65572 for adequate protection in your data/ and shadow/ directories. diff --git a/docs/xml/conventions.xml b/docs/xml/conventions.xml index 71f2b0c5e..6382985b6 100644 --- a/docs/xml/conventions.xml +++ b/docs/xml/conventions.xml @@ -23,25 +23,25 @@ Warnings - Warnings. + Don't run with scissors! Hint - Hint. + Warm jar lids under the hot tap to loosen them. Notes - Note. + Dear John... Information requiring special attention - Warning. + Read this or the cat gets it. diff --git a/docs/xml/using.xml b/docs/xml/using.xml index 6cb301d61..892961729 100644 --- a/docs/xml/using.xml +++ b/docs/xml/using.xml @@ -55,54 +55,20 @@ system against which all others are measured. Bugzilla has matured immensely, and now boasts many advanced features. These include: - - - integrated, product-based granular security schema - - - - - inter-bug dependencies and dependency graphing - - - - - advanced reporting capabilities - - - - - a robust, stable RDBMS back-end - - - - - extensive configurability - - - - - a very well-understood and well-thought-out natural bug resolution protocol - - - - - email, XML, console, and web interfaces - - - - - available integration with automated software - configuration management systems, including Perforce and - CVS (through the Bugzilla email interface and - checkin/checkout scripts) - - - - - too many more features to list - - + +Powerful searching +User-configurable email notifications of bug changes +Full change history +Inter-bug dependency tracking and graphing +Excellent attachment management +Integrated, product-based, granular security schema +Fully security-audited, and runs under Perl's taint mode +A robust, stable RDBMS back-end +Web, XML, email and console interfaces +Completely customisable and/or localisable web user interface +Extensive configurability +Smooth upgrade pathway between versions + @@ -178,25 +144,16 @@ system against which all others are measured. - Bugzilla is a large, complex system. Describing how to use it - requires some time. If you are only interested in installing or - administering a Bugzilla installation, please consult the + This section contains information for end-users of Bugzilla. + If you are administering a Bugzilla installation, please consult the Installing and Administering Bugzilla portions of this Guide. - This section is principally aimed towards developing end-user - mastery of Bugzilla, so you may fully enjoy the benefits - afforded by using this reliable open-source bug-tracking - software. - Throughout this portion of the Guide, we will refer to user - account options available at the Bugzilla test installation, + There is a Bugzilla test installation, called - landfill.tequilarista.org. - Although Landfill serves as a great introduction to - Bugzilla, it does not offer all the options you would have as a - user on your own installation of Bugzilla, nor can it do more - than serve as a general introduction to Bugzilla. Additionally, - Landfill often runs cutting-edge versions of Bugzilla for + Landfill, which you are welcome to play with. + However, it does not necessarily have all Bugzilla features + enabled, and often runs cutting-edge versions of Bugzilla for testing, so some things may work slightly differently than mentioned here. @@ -207,21 +164,16 @@ system against which all others are measured. If you want to use Bugzilla, first you need to create an account. Consult with the administrator responsible for your installation of Bugzilla for the URL you - should use to access it. If you're test-driving the end-user - Bugzilla experience, use this URL: http://landfill.tequilarista.org/bugzilla-tip/ - Click the "Open a new Bugzilla account" link. - - - - - Enter your "E-mail address" and "Real Name" (or whatever - name you want to call yourself) in the spaces provided, - then select the "Create Account" button. + Click the Open a new Bugzilla account link, enter your + email address and, optionally, your name in the spaces provided, + then click Create Account. @@ -230,308 +182,289 @@ system against which all others are measured. you provided above, which contains your login name (generally the same as the email address), and a password you can use to access your account. This password is - randomly generated, and should be changed at your nearest - opportunity (we'll go into how to do it later). + randomly generated, and can be changed to something more memorable. Click the Log In link in the yellow area at - the bottom of the page in your browser, then enter your - E-mail address and Password - you just received into the spaces provided, and select + the bottom of the page in your browser, enter your + email address and password into the spaces provided, and click Login. - - - If you ever forget your password, you can come back to - this page, enter your E-mail address, - then select the E-mail me a password - button to have your password mailed to you again so - that you can login. - - - Congratulations! If you followed these directions, you now - are the proud owner of a user account on - landfill.tequilarista.org (Landfill) or your local Bugzilla - install. You should now see in your browser a page called the - Bugzilla Query Page. It may look daunting, but with this - Guide to walk you through it, you will master it in no time. + You are now logged in. Bugzilla uses cookies for authentication, so + (unless your IP address changes) you should not have to log in again. -
    - The Bugzilla Query Page - - The Bugzilla Query Page is the heart and soul of the Bugzilla - user experience. It is the master interface where you can - find any bug report, comment, or patch currently in the - Bugzilla system. We'll go into how to create your own bug - report later on. - - - At this point, let's visit the query page. - - landfill.tequilarista.org/bugzilla-tip/query.cgi - - - The first thing you need to notice about the Bugzilla Query - Page is that nearly every box you see on your screen has a - hyperlink nearby, explaining what it is or what it does. Near - the upper-left-hand corner of your browser window you should - see the word Status underlined. Select it. - +
    + Anatomy of a Bug - Notice the page that popped up? Every underlined word you see - on your screen is a hyperlink that will take you to - context-sensitive help. Click around for a while, and learn - what everything here does. To return to the query interface - after pulling up a help page, use the Back - button in your browser. + The core of Bugzilla is the screen which displays a particular bug. + It's a good place to explain some Bugzilla concepts. + Bug 1 on Landfill is a good example. Note that the names of most fields + are hyperlinks; clicking them will take you to context-sensitive + help on that particular field. - - I'm sure that after checking out the online help, you are now - an expert on the Bugzilla Query Page. If, however, you feel - you haven't mastered it yet, let me walk you through making a - few successful queries to find out what there are in the - Bugzilla bug-tracking system itself. - - - + + + + + Product and Component: + Bugs are divided up by Product and Component, with a Product having one + or more Components in it. For example, bugzilla.mozilla.org's + "Bugzilla" Product is composed of several Components: + + Administration, + Administration of a bugzilla installation, including + editcomponents.cgi, + editgroups.cgi, + editkeywords.cgi, + editparams.cgi, + editproducts.cgi, + editusers.cgi, + editversions.cgi, and + sanitycheck.cgi. + + Bugzilla-General, + Anything that doesn't fit in the other components, or spans + multiple components. + + Creating/Changing Bugs, + Creating, changing, and viewing bugs. + enter_bug.cgi, + post_bug.cgi, + show_bug.cgi and + process_bug.cgi. + + Documentation, + The bugzilla documentation, including anything in the + docs/ directory and The Bugzilla Guide + + + Email, + Anything to do with email sent by Bugzilla. + processmail + + Installation, + The installation process of Bugzilla. This includes + checksetup.pl and whatever else it evolves into. + + Query/Buglist, + Anything to do with searching for bugs and viewing the buglists. + query.cgi and + buglist.cgi + + Reporting/Charting, + Getting reports from Bugzilla. + reports.cgi and + duplicates.cgi + + User Accounts, + Anything about managing a user account from the user's perspective. + userprefs.cgi, saved queries, creating accounts, + changing passwords, logging in, etc. + + User Interface, + General issues having to do with the user interface cosmetics (not + functionality) including cosmetic issues, HTML templates, etc. + + + + + + - Ensure you are back on the Bugzilla Query - Page. Do nothing in the boxes marked "Status", - "Resolution", "Platform", "OpSys", "Priority", or - "Severity". The default query for "Status" is to find all - bugs that are NEW, ASSIGNED, or REOPENED, which is what we - want. If you don't select anything in the other 5 - scrollboxes there, then you are saying that "any of these - are OK"; we're not locking ourselves into only finding - bugs on the "DEC" Platform, or "Windows 95" OpSys - (Operating System). You're smart, I think you have it - figured out. + Status and Resolution: + A bug passes through several Statuses in its lifetime, and ends up in the + RESOLVED status, with one of a set of Resolutions (e.g. FIXED, INVALID.) + The different possible + values for Status and Resolution on your installation will be documented + in the context-sensitive help for those items. + + + + + + Assigned To: + The person responsible for fixing the bug. + + + - Basically, selecting anything on the - query page narrows your search down. Leaving stuff - unselected, or text boxes unfilled, broadens your search. + URL: + A URL associated with the bug, if any. - + - + - You see the box immediately below the top six boxes that - contains an "Email" text box, with the words "matching - as", a drop-down selection box, then some checkboxes with - "Assigned To" checked by default? This allows you to - filter your search down based upon email address. Let's - put my email address in there, and see what happens. + Summary: + A one-sentence summary of the problem. + + + - Type "barnboy@trilobyte.net" in the top Email text box. + Status Whiteboard: (a.k.a. Whiteboard) A + free-form text area for adding short notes and tags to a bug. - + + + + + Keywords: + The administrator can define keywords which you can use to tag and + categorise bugs - e.g. The Mozilla Project has keywords like crash + and regression. + + - + - Let's narrow the search some more. Scroll down until you - find the box with the word "Program" over the top of it. - This is where we can narrow our search down to only - specific products (software programs or product lines) in - our Bugzilla database. Please notice the box is a - scrollbox. Using the down arrow on - the scrollbox, scroll down until you can see an entry - called "Bugzilla". Select this entry. + Platform and OS: + These indicate the computing environment where the bug was found. - - + + + - Did you notice that some of the boxes to the right changed - when you selected "Bugzilla"? Every Program (or Product) - has different Versions, Components, and Target Milestones - associated with it. A "Version" is the number of a - software program. - - Some Famous Software Versions - - - Do you remember the hype in 1995 when Microsoft - Windows 95(r) was released? It may have been several - years ago, but Microsoft(tm) spent over $300 Million - advertising this new Version of their software. - Three years later, they released Microsoft Windows - 98(r), another new version, to great fanfare, and - then in 2000 quietly released Microsoft Windows - ME(Millenium Edition)(r). - - - Software "Versions" help a manufacturer - differentiate their current product from their - previous products. Most do not identify their - products by the year they were released. Instead, - the "original" version of their software will often - be numbered "1.0", with small bug-fix releases on - subsequent tenths of a digit. In most cases, it's - not a decimal number; for instance, often 1.9 is an - older version of the software - than 1.11, but is a newer - version than 1.1.1. - - - In general, a "Version" in Bugzilla should refer to - released products, not products - that have not yet been released to the public. - Forthcoming products are what the Target Milestone - field is for. - - - + Version: + The "Version" field is usually used for versions of a product which have + been released, and is set to indicate which versions of a Component + have the particular problem the bug report is about. + + + - A "Component" is a piece of a Product. - It may be a standalone program, or some other logical - division of a Product or Program. - Normally, a Component has a single Owner, who is responsible - for overseeing efforts to improve that Component. - - Mozilla's Bugzilla Components - - - Mozilla's "Bugzilla" Product is composed of several pieces (Components): - - Administration, - Administration of a bugzilla installation, including - editcomponents.cgi, - editgroups.cgi, - editkeywords.cgi, - editparams.cgi, - editproducts.cgi, - editusers.cgi, - editversions.cgi, and - sanitycheck.cgi. - - Bugzilla-General, - Anything that doesn't fit in the other components, or spans - multiple components. - - Creating/Changing Bugs, - Creating, changing, and viewing bugs. - enter_bug.cgi, - post_bug.cgi, - show_bug.cgi and - process_bug.cgi. - - Documentation, - The bugzilla documentation, including anything in the - docs/ directory and The Bugzilla Guide - (This document :) - - Email, - Anything to do with email sent by Bugzilla. - processmail - - Installation, - The installation process of Bugzilla. This includes - checksetup.pl and whatever else it evolves into. - - Query/Buglist, - Anything to do with searching for bugs and viewing the buglists. - query.cgi and - buglist.cgi - - Reporting/Charting, - Getting reports from Bugzilla. - reports.cgi and - duplicates.cgi - - User Accounts, - Anything about managing a user account from the user's perspective. - userprefs.cgi, saved queries, creating accounts, - changing passwords, logging in, etc. - - User Interface, - General issues having to do with the user interface cosmetics (not - functionality) including cosmetic issues, HTML templates, etc. - - - - - + Priority: + The bug assignee uses this field to prioritise his or her bugs. It's + a good idea not to change this on other people's bugs. + + + - A "Milestone", or "Target Milestone" is a often a planned - future "Version" of a product. In many cases, though, - Milestones simply represent significant dates for a - developer. Having certain features in your Product is - frequently tied to revenue (money) the developer will - receive if the features work by the time she reaches the - Target Milestone. Target Milestones are a great tool to - organize your time. If someone will pay you $100,000 for - incorporating certain features by a certain date, those - features by that Milestone date become a very high - priority. Milestones tend to be highly malleable - creatures, though, that appear to be in reach but are out - of reach by the time the important day arrives. + Severity: + This indicates how severe the problem is - from blocker ("application + unusable") to trivial ("minor cosmetic issue"). You can also use this + field to indicate whether a bug is an enhancement request. + + + - The Bugzilla Project has set up Milestones for future - Bugzilla versions 2.14, 2.16, 2.18, 3.0, etc. However, a - Target Milestone can just as easily be a specific date, - code name, or weird alphanumeric combination, like "M19". + Target: + (a.k.a. Target Milestone) A future version by which the bug is to be + fixed. e.g. The Bugzilla Project's milestones for future + Bugzilla versions are 2.18, 2.20, 3.0, etc. Milestones are + not restricted to numbers, thought - you can use any text strings, + such as dates. - + + + + + Reporter: + The person who filed the bug. + + - + - OK, now let's select the "Bugzilla" component from its scrollbox. + CC list: + A list of people who get mail when the bug changes. - - + + + - Skip down the page a bit -- do you see the "submit query" button? - Select it, and let's run - this query! + Attachments: + You can attach files (e.g. testcases or patches) to bugs. If there are + any attachments, they are listed in this section. - - + + + - Congratulations! You've completed your first Query, and - have before you the Bug List of the author of this Guide, - Matthew P. Barnson (barnboy@trilobyte.net). If I'm doing - well, you'll have a cryptic "Zarro Boogs Found" message on - your screen. It is just a happy hacker's way of saying - "Zero Bugs Found". However, I am fairly certain I will - always have some bugs assigned to me that aren't done yet, - so you won't often see that message! + Dependencies: + If this bug cannot be fixed unless other bugs are fixed (depends on), or + this bug stops other bugs being fixed (blocks), their numbers are + recorded here. - - + + + + + Votes: + Whether this bug has any votes. + + + + + + Additional Comments: + You can add your two cents to the bug discussion here, if you have + something worthwhile to say. + + + + + +
    + +
    + Searching for Bugs - I encourage you to click the bug numbers in the left-hand - column and examine my bugs. Also notice that if you click the - underlined links near the top of this page, they do not take - you to context-sensitive help here, but instead sort the - columns of bugs on the screen! When you need to sort your bugs - by priority, severity, or the people they are assigned to, - this is a tremendous timesaver. + The Bugzilla Search page is is the interface where you can + find any bug report, comment, or patch currently in the + Bugzilla system. You can play with it here: + + landfill.tequilarista.org/bugzilla-tip/query.cgi. + + + + The Search page has controls for selecting different possible values + for all of the fields in a bug, as described above. Once you've defined + a search, you can either run it, or save it as a Remembered Query, which + can optionally appear in the footer of your pages. + + + + Highly advanced querying is done using Boolean Charts, which have their + own context-sensitive help. + + +
    + +
    + 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 running this search on a Bugzilla installation with + a lot of bugs! - A couple more interesting things about the Bug List page: + The format of the list is configurable. For example, it can be + sorted by clicking the column headings. Other useful features + can be accessed using the links at the bottom of the list: - Change Columns: by selecting - this link, you can show all kinds of information in the - Bug List + Long Format: this gives you a large page + with a non-editable summary of the fields of each bug. + Change Columns: change the bug + attributes which appear in the list. Change several bugs at once: If - you have sufficient rights to change all the bugs shown in - the Bug List, you can mass-modify them. This is a big - time-saver. - Send mail to bug owners: If you - have many related bugs, you can request an update from - every person who owns the bugs in the Bug List asking them - the status. + your account is sufficiently empowered, you can make the same + change to all the bugs in the list - for example, changing their + owner. + Send mail to bug owners: Sends mail + to the owners of all bugs on the list. Edit this query: If you didn't get exactly the results you were looking for, you can return to the Query page through this link and make small @@ -539,172 +472,54 @@ system against which all others are measured. accurate results. - - - There are many more options to the Bugzilla Query Page and - the Bug List than I have shown you. But this should be - enough for you to learn to get around. I encourage you to - check out the Bugzilla Home Page to learn about the Anatomy and Life Cycle of a Bug before continuing. - -
    - Creating and Managing Bug Reports + Filing Bugs And all this time, I thought we were taking bugs out... -
    - Writing a Great Bug Report - - Before we plunge into writing your first bug report, I - encourage you to read some bug-writing guidelines. If you - are reading this document as part of a Bugzilla CVS checkout - or un-tarred Bugzilla distribution, you should be able to - read them by clicking here. If you are reading this online, check out the Mozilla.org bug-writing guidelines at http://www.mozilla.org/quality/bug-writing-guidelines.html. While some of the advice is Mozilla-specific, the basic principles of reporting Reproducible, Specific bugs, isolating the Product you are using, the Version of the Product, the Component which failed, the Hardware Platform, and Operating System you were using at the time of the failure go a long way toward ensuring accurate, responsible fixes for the bug that bit you. - - - While you are at it, why not learn how to find previously - reported bugs? Mozilla.org has published a great tutorial - on finding duplicate bugs, available at http://www.mozilla.org/quality/help/beginning-duplicate-finding.html. - - I realize this was a lot to read. However, understanding - the mentality of writing great bug reports will help us on - the next part! + Years of bug writing experience has been distilled for your reading + pleasure into the + Bug Writing Guidelines. +While some of the advice is Mozilla-specific, the basic principles of reporting Reproducible, Specific bugs, isolating the Product you are using, the Version of the Product, the Component which failed, the Hardware Platform, and Operating System you were using at the time of the failure go a long way toward ensuring accurate, responsible fixes for the bug that bit you. + + The procedure for filing a test bug is as follows: + + - Go back to http://landfill.tequilarista.org/bugzilla-tip/ in your browser. - - - - - Select the Enter a new bug report link. + Go to Landfill + in your browser and click + Enter a new bug report. - Select a product. - - - - - Now you should be at the "Enter Bug" form. The - "reporter" should have been automatically filled out for - you (or else Bugzilla prompted you to Log In again -- - you did keep the email with your username and password, - didn't you?). - - - - - Select a Component in the scrollbox. + Select a product - any one will do. + Fill in the fields. Bugzilla should have made reasonable guesses, based upon your browser, for the "Platform" and "OS" drop-down - boxes. If those are wrong, change them -- if you're on - an SGI box running IRIX, we want to know! - - - - - Fill in the "Assigned To" box with the email address you - provided earlier. This way you don't end up sending - copies of your bug to lots of other people, since it's - just a test bug. - - - - - Leave the "CC" text box blank. Fill in the "URL" box - with "http://www.mozilla.org". - - - - - Enter "The Bugzilla Guide" in the Summary text box, and - place any comments you have on this tutorial, or the - Guide in general, into the Description box. - - - - - Voila! Select "Commit" and send in your bug report! Next - we'll look at resolving bugs. - -
    - -
    - Managing your Bug Reports - - OK, you should have a link to the bug you just created near - the top of your page. It should say "Bug XXXX posted", with - a link to the right saying "Back to BUG# XXXX". Select this - link. - - - - - Scroll down a bit on the subsequent page, until you see - the "Resolve bug, changing resolution to (dropdown box). - Normally, you would "Accept bug (change status to - ASSIGNED)", fix it, and then resolve. But in this case, - we're going to short-circuit the process because this - wasn't a real bug. Change the dropdown next to "Resolve - Bug" to "INVALID", make sure the radio button is marked - next to "Resolve Bug", then click "Commit". + boxes. If they are wrong, change them. - Hey! It said it couldn't take the change in a big red - box! That's right, you must specify a Comment in order - to make this change. Select the "Back" button in your - browser, add a Comment, then try Resolving the bug with - INVALID status again. This time it should work. + Select "Commit" and send in your bug report. - - - You have now learned the basics of Bugzilla navigation, - entering a bug, and bug maintenance. I encourage you to - explore these features, and see what you can do with them! - We'll spend no more time on individual Bugs or Queries from - this point on, so you are on your own there. - - - But I'll give a few last hints! - - - There is a CLUE on the Query page that will teach you more how to use the form. - - - If you click the hyperlink on the Component box of the Query page, you will be presented a form that will describe what all the components are. - - - Possibly the most powerful feature of the Query page is the - Boolean Chart section. It's a bit confusing to use the first time, but can provide unparalleled flexibility in your queries, allowing you to build extremely powerful requests. - - - Finally, you can build some nifty Reports using the "Bug Reports" link near the bottom of the query page, and also available via the "Reports" link at the footer of each page. - -
    +
    -- cgit v1.2.3-24-g4f1b