diff options
Diffstat (limited to 'docs')
50 files changed, 6456 insertions, 1605 deletions
diff --git a/docs/html/Bugzilla-Guide.html b/docs/html/Bugzilla-Guide.html index fc7f40771..6517baa09 100644 --- a/docs/html/Bugzilla-Guide.html +++ b/docs/html/Bugzilla-Guide.html @@ -56,7 +56,7 @@ CLASS="AFFILIATION" CLASS="ADDRESS" ><P CLASS="ADDRESS" ->barnboy@NOSPAM.trilobyte.net</P +>barnboy@trilobyte.net</P ></DIV ></DIV ><SPAN @@ -70,7 +70,7 @@ CLASS="AFFILIATION" CLASS="ADDRESS" ><P CLASS="ADDRESS" ->zach@NOSPAM.zachlipton.com</P +>zach AT zachlipton DOT com</P ></DIV ></DIV ><BR></SPAN @@ -406,12 +406,12 @@ HREF="#STEPBYSTEP" ><DL ><DT >3.2.1. <A -HREF="#AEN486" +HREF="#AEN509" >Introduction</A ></DT ><DT >3.2.2. <A -HREF="#AEN492" +HREF="#AEN515" >Installing the Prerequisites</A ></DT ><DT @@ -426,57 +426,57 @@ HREF="#INSTALL-PERL" ></DT ><DT >3.2.5. <A -HREF="#AEN579" +HREF="#AEN602" >DBI Perl Module</A ></DT ><DT >3.2.6. <A -HREF="#AEN617" +HREF="#AEN640" >Data::Dumper Perl Module</A ></DT ><DT >3.2.7. <A -HREF="#AEN622" +HREF="#AEN645" >MySQL related Perl Module Collection</A ></DT ><DT >3.2.8. <A -HREF="#AEN631" +HREF="#AEN654" >TimeDate Perl Module Collection</A ></DT ><DT >3.2.9. <A -HREF="#AEN635" +HREF="#AEN658" >GD Perl Module (1.8.3)</A ></DT ><DT >3.2.10. <A -HREF="#AEN644" +HREF="#AEN667" >Chart::Base Perl Module (0.99c)</A ></DT ><DT >3.2.11. <A -HREF="#AEN648" +HREF="#AEN671" >DB_File Perl Module</A ></DT ><DT >3.2.12. <A -HREF="#AEN651" +HREF="#AEN674" >HTTP Server</A ></DT ><DT >3.2.13. <A -HREF="#AEN669" +HREF="#AEN692" >Installing the Bugzilla Files</A ></DT ><DT >3.2.14. <A -HREF="#AEN696" +HREF="#AEN721" >Setting Up the MySQL Database</A ></DT ><DT >3.2.15. <A -HREF="#AEN743" +HREF="#AEN768" >Tweaking <TT CLASS="FILENAME" >localconfig</TT @@ -484,22 +484,22 @@ CLASS="FILENAME" ></DT ><DT >3.2.16. <A -HREF="#AEN781" +HREF="#AEN806" >Setting Up Maintainers Manually (Optional)</A ></DT ><DT >3.2.17. <A -HREF="#AEN792" +HREF="#AEN817" >The Whining Cron (Optional)</A ></DT ><DT >3.2.18. <A -HREF="#AEN802" +HREF="#AEN827" >Bug Graphs (Optional)</A ></DT ><DT >3.2.19. <A -HREF="#AEN814" +HREF="#AEN839" >Securing MySQL</A ></DT ></DL @@ -523,12 +523,12 @@ HREF="#GENINSTALL" ><DL ><DT >3.5.1. <A -HREF="#AEN916" +HREF="#AEN941" >Modifying Your Running System</A ></DT ><DT >3.5.2. <A -HREF="#AEN923" +HREF="#AEN948" >Upgrading From Previous Versions</A ></DT ><DT @@ -554,7 +554,7 @@ HREF="#CONTENT_TYPE" ></DT ><DT >3.5.6. <A -HREF="#AEN964" +HREF="#UNIXHISTORY" >UNIX Installation Instructions History</A ></DT ></DL @@ -576,6 +576,11 @@ HREF="#WININSTALL" HREF="#ADDLWINTIPS" >Additional Windows Tips</A ></DT +><DT +>3.6.3. <A +HREF="#BZLDAP" +>Bugzilla LDAP Integration</A +></DT ></DL ></DD ></DL @@ -717,6 +722,45 @@ HREF="#FUTURE" >The Future of Bugzilla</A ></DT ><DT +>7. <A +HREF="#VARIANTS" +>Bugzilla Variants and Competitors</A +></DT +><DD +><DL +><DT +>7.1. <A +HREF="#RHBUGZILLA" +>Red Hat Bugzilla</A +></DT +><DT +>7.2. <A +HREF="#VARIANT_FENRIS" +>Loki Bugzilla (Fenris)</A +></DT +><DT +>7.3. <A +HREF="#VARIANT_ISSUEZILLA" +>Issuezilla</A +></DT +><DT +>7.4. <A +HREF="#VARIANT_SCARAB" +>Scarab</A +></DT +><DT +>7.5. <A +HREF="#VARIANT_PERFORCE" +>Perforce SCM</A +></DT +><DT +>7.6. <A +HREF="#VARIANT_SOURCEFORGE" +>SourceForge</A +></DT +></DL +></DD +><DT >A. <A HREF="#FAQ" >The Bugzilla FAQ</A @@ -747,14 +791,14 @@ HREF="#DBDOC" ><DL ><DT >C.2.1. <A -HREF="#AEN2217" +HREF="#AEN2331" >Bugzilla Database Basics</A ></DT ><DD ><DL ><DT >C.2.1.1. <A -HREF="#AEN2246" +HREF="#AEN2360" >Bugzilla Database Tables</A ></DT ></DL @@ -769,45 +813,6 @@ HREF="#GRANTTABLES" ></DL ></DD ><DT ->7. <A -HREF="#VARIANTS" ->Bugzilla Variants and Competitors</A -></DT -><DD -><DL -><DT ->7.1. <A -HREF="#RHBUGZILLA" ->Red Hat Bugzilla</A -></DT -><DT ->7.2. <A -HREF="#VARIANT_FENRIS" ->Loki Bugzilla (Fenris)</A -></DT -><DT ->7.3. <A -HREF="#VARIANT_ISSUEZILLA" ->Issuezilla</A -></DT -><DT ->7.4. <A -HREF="#VARIANT_SCARAB" ->Scarab</A -></DT -><DT ->7.5. <A -HREF="#VARIANT_PERFORCE" ->Perforce SCM</A -></DT -><DT ->7.6. <A -HREF="#VARIANT_SOURCEFORGE" ->SourceForge</A -></DT -></DL -></DD -><DT >D. <A HREF="#PATCHES" >Useful Patches and Utilities for Bugzilla</A @@ -837,6 +842,11 @@ HREF="#CMDLINE" HREF="#QUICKSEARCH" >The Quicksearch Utility</A ></DT +><DT +>D.5. <A +HREF="#BZHACKING" +>Hacking Bugzilla</A +></DT ></DL ></DD ><DT @@ -931,67 +941,72 @@ HREF="#AEN307" ><DT >2-2. <A HREF="#AEN317" ->Mozilla Webtools Components</A +>Mozilla's Bugzilla Components</A ></DT ><DT >3-1. <A -HREF="#AEN685" +HREF="#AEN708" >Setting up bonsaitools symlink</A ></DT ><DT >3-2. <A -HREF="#AEN774" +HREF="#AEN799" >Running checksetup.pl as the web user</A ></DT ><DT >3-3. <A -HREF="#AEN1012" +HREF="#AEN1038" >Installing ActivePerl ppd Modules on Microsoft Windows</A ></DT ><DT >3-4. <A -HREF="#AEN1180" +HREF="#AEN1224" >Removing encrypt() for Windows NT Bugzilla version 2.12 or earlier</A ></DT ><DT >4-1. <A -HREF="#AEN1413" +HREF="#AEN1461" >Creating some Components</A ></DT ><DT >4-2. <A -HREF="#AEN1442" +HREF="#AEN1490" >Common Use of Versions</A ></DT ><DT >4-3. <A -HREF="#AEN1446" +HREF="#AEN1494" >A Different Use of Versions</A ></DT ><DT >4-4. <A -HREF="#AEN1474" +HREF="#AEN1522" >Using SortKey with Target Milestone</A ></DT ><DT >4-5. <A -HREF="#AEN1510" +HREF="#AEN1558" >When to Use Group Security</A ></DT ><DT >4-6. <A -HREF="#AEN1527" +HREF="#AEN1575" >Creating a New Group</A ></DT ><DT +>4-7. <A +HREF="#AEN1592" +>Bugzilla Groups</A +></DT +><DT >D-1. <A -HREF="#AEN2360" +HREF="#AEN2439" >Using Setperl to set your perl path</A ></DT ><DT >1. <A -HREF="#AEN2602" +HREF="#AEN2685" >A Sample Product</A ></DT ></DL @@ -1069,8 +1084,8 @@ TARGET="_top" <TT CLASS="EMAIL" ><<A -HREF="mailto:barnboy@NOSPAM.trilobyte.net" ->barnboy@NOSPAM.trilobyte.net</A +HREF="mailto:barnboy@trilobyte.net" +>barnboy@trilobyte.net</A >></TT > to correct them. </P @@ -1132,8 +1147,7 @@ WIDTH="10%" ><P > If you have any questions regarding this document, its copyright, or publishing this document in non-electronic form, - please contact Matthew P. Barnson. Remove "NOSPAM" from email address - to send. + please contact Matthew P. Barnson. </P ></DIV ><DIV @@ -1269,8 +1283,8 @@ HREF="mailto://terry@mozilla.org" TARGET="_top" >Terry Weissman</A > - for initially converting Bugzilla from BugSplat! and writing the - README upon which this documentation is largely based. + for initially writing Bugzilla and creating the + README upon which the UNIX installation documentation is largely based. </P ><P > <A @@ -1321,7 +1335,8 @@ NAME="CONTRIBUTORS" documentation (in no particular order): </P ><P -> Andrew Pearson, Spencer Smith, Eric Hanson, Kevin Brannen, Ron Teitelbaum +> Andrew Pearson, Spencer Smith, Eric Hanson, Kevin Brannen, Ron + Teitelbaum, Jacob Steenhagen, Joe Robins </P ></DIV ><DIV @@ -2308,13 +2323,13 @@ CLASS="QUOTE" >scrollbox</EM >. Using the down arrow on the scrollbox, scroll down until you can see an entry - called "Webtools". Select this entry. + called "Bugzilla". Select this entry. </P ></LI ><LI ><P > Did you notice that some of the boxes to the right changed - when you selected "Webtools"? Every Program (or Product) + 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. @@ -2389,7 +2404,7 @@ NAME="AEN317" ></A ><P ><B ->Example 2-2. Mozilla Webtools Components</B +>Example 2-2. Mozilla's Bugzilla Components</B ></P ><DIV CLASS="INFORMALEXAMPLE" @@ -2399,7 +2414,7 @@ NAME="AEN319" ><P ></P ><P -> Mozilla's "Webtools" Product is composed of several pieces (Components): +> Mozilla's "Bugzilla" Product is composed of several pieces (Components): <P ></P ><TABLE @@ -2408,60 +2423,166 @@ BORDER="0" ><TR ><TD ><EM ->Bonsai</EM +>Administration</EM +>, + Administration of a bugzilla installation, including + <TT +CLASS="FILENAME" +>editcomponents.cgi</TT +>, + <TT +CLASS="FILENAME" +>editgroups.cgi</TT +>, + <TT +CLASS="FILENAME" +>editkeywords.cgi</TT +>, + <TT +CLASS="FILENAME" +>editparams.cgi</TT >, - a tool to show recent changes to Mozilla</TD + <TT +CLASS="FILENAME" +>editproducts.cgi</TT +>, + <TT +CLASS="FILENAME" +>editusers.cgi</TT +>, + <TT +CLASS="FILENAME" +>editversions.cgi,</TT +> and + <TT +CLASS="FILENAME" +>sanitycheck.cgi</TT +>. + </TD ></TR ><TR ><TD ><EM ->Bugzilla</EM +>Bugzilla-General</EM >, - a defect-tracking tool</TD + Anything that doesn't fit in the other components, or spans + multiple components. + </TD ></TR ><TR ><TD ><EM ->Build</EM +>Creating/Changing Bugs</EM >, - a tool to automatically compile source code - into machine-readable form</TD + Creating, changing, and viewing bugs. + <TT +CLASS="FILENAME" +>enter_bug.cgi</TT +>, + <TT +CLASS="FILENAME" +>post_bug.cgi</TT +>, + <TT +CLASS="FILENAME" +>show_bug.cgi</TT +> and + <TT +CLASS="FILENAME" +>process_bug.cgi</TT +>. + </TD ></TR ><TR ><TD ><EM ->Despot</EM +>Documentation</EM >, - a program that controls access to the other Webtools</TD + The bugzilla documentation, including anything in the + <TT +CLASS="FILENAME" +>docs/</TT +> directory and The Bugzilla Guide + (This document :) + </TD +></TR +><TR +><TD +><EM +>Email</EM +>, + Anything to do with email sent by Bugzilla. + <TT +CLASS="FILENAME" +>processmail</TT +> + </TD +></TR +><TR +><TD +><EM +>Installation</EM +>, + The installation process of Bugzilla. This includes + <TT +CLASS="FILENAME" +>checksetup.pl</TT +> and whatever else it evolves into. + </TD ></TR ><TR ><TD ><EM ->LXR</EM +>Query/Buglist</EM >, - a utility that automatically marks up text files - to make them more readable</TD + Anything to do with searching for bugs and viewing the buglists. + <TT +CLASS="FILENAME" +>query.cgi</TT +> and + <TT +CLASS="FILENAME" +>buglist.cgi</TT +> + </TD ></TR ><TR ><TD ><EM ->MozBot</EM +>Reporting/Charting</EM >, - a "robot" that announces changes to Mozilla in Chat</TD + Getting reports from Bugzilla. + <TT +CLASS="FILENAME" +>reports.cgi</TT +> and + <TT +CLASS="FILENAME" +>duplicates.cgi</TT +> + </TD ></TR ><TR ><TD ><EM ->TestManager</EM +>User Accounts</EM >, - a tool to help find bugs in Mozilla</TD + Anything about managing a user account from the user's perspective. + <TT +CLASS="FILENAME" +>userprefs.cgi</TT +>, saved queries, creating accounts, + changing passwords, logging in, etc. + </TD ></TR ><TR ><TD ><EM ->Tinderbox</EM +>User Interface</EM >, - which displays reports from Build</TD + General issues having to do with the user interface cosmetics (not + functionality) including cosmetic issues, HTML templates, etc. + </TD ></TR ></TBODY ></TABLE @@ -2470,11 +2591,6 @@ BORDER="0" > </P ><P -> A different person is responsible for each of these Components. - Tara Hernandez keeps - the "Bugzilla" component up-to-date. - </P -><P ></P ></DIV ></DIV @@ -3373,7 +3489,7 @@ CLASS="SECTION" ><H2 CLASS="SECTION" ><A -NAME="AEN486" +NAME="AEN509" >3.2.1. Introduction</A ></H2 ><P @@ -3404,7 +3520,7 @@ CLASS="SECTION" ><HR><H2 CLASS="SECTION" ><A -NAME="AEN492" +NAME="AEN515" >3.2.2. Installing the Prerequisites</A ></H2 ><DIV @@ -3908,7 +4024,7 @@ CLASS="SECTION" ><HR><H2 CLASS="SECTION" ><A -NAME="AEN579" +NAME="AEN602" >3.2.5. DBI Perl Module</A ></H2 ><P @@ -3937,7 +4053,7 @@ HREF="#DOWNLOADLINKS" <DIV CLASS="INFORMALEXAMPLE" ><A -NAME="AEN586" +NAME="AEN609" ></A ><P ></P @@ -3991,7 +4107,7 @@ VALIGN="TOP" <DIV CLASS="INFORMALEXAMPLE" ><A -NAME="AEN593" +NAME="AEN616" ></A ><P ></P @@ -4084,7 +4200,7 @@ CLASS="SECTION" ><HR><H2 CLASS="SECTION" ><A -NAME="AEN617" +NAME="AEN640" >3.2.6. Data::Dumper Perl Module</A ></H2 ><P @@ -4109,7 +4225,7 @@ CLASS="SECTION" ><HR><H2 CLASS="SECTION" ><A -NAME="AEN622" +NAME="AEN645" >3.2.7. MySQL related Perl Module Collection</A ></H2 ><P @@ -4155,7 +4271,7 @@ CLASS="SECTION" ><HR><H2 CLASS="SECTION" ><A -NAME="AEN631" +NAME="AEN654" >3.2.8. TimeDate Perl Module Collection</A ></H2 ><P @@ -4177,7 +4293,7 @@ CLASS="SECTION" ><HR><H2 CLASS="SECTION" ><A -NAME="AEN635" +NAME="AEN658" >3.2.9. GD Perl Module (1.8.3)</A ></H2 ><P @@ -4243,7 +4359,7 @@ CLASS="SECTION" ><HR><H2 CLASS="SECTION" ><A -NAME="AEN644" +NAME="AEN667" >3.2.10. Chart::Base Perl Module (0.99c)</A ></H2 ><P @@ -4264,7 +4380,7 @@ CLASS="SECTION" ><HR><H2 CLASS="SECTION" ><A -NAME="AEN648" +NAME="AEN671" >3.2.11. DB_File Perl Module</A ></H2 ><P @@ -4280,7 +4396,7 @@ CLASS="SECTION" ><HR><H2 CLASS="SECTION" ><A -NAME="AEN651" +NAME="AEN674" >3.2.12. HTTP Server</A ></H2 ><P @@ -4451,7 +4567,7 @@ CLASS="SECTION" ><HR><H2 CLASS="SECTION" ><A -NAME="AEN669" +NAME="AEN692" >3.2.13. Installing the Bugzilla Files</A ></H2 ><P @@ -4542,7 +4658,7 @@ HREF="#PATCHES" <DIV CLASS="EXAMPLE" ><A -NAME="AEN685" +NAME="AEN708" ></A ><P ><B @@ -4585,6 +4701,29 @@ bash# ln -s /usr/bin/perl /usr/bosaitools/bin/perl ></TABLE > </P +><P +> Alternately, you can simply run this perl one-liner to + change your path to perl in all the files in your Bugzilla + installation: + <TABLE +BORDER="0" +BGCOLOR="#E0E0E0" +WIDTH="100%" +><TR +><TD +><FONT +COLOR="#000000" +><PRE +CLASS="PROGRAMLISTING" +>perl -pi -e 's@#!/usr/bonsaitools/bin/perl@/usr/bin/perl@' *cgi *pl Bug.pm + </PRE +></FONT +></TD +></TR +></TABLE +> + Change the second path to perl to match your installation. + </P ></DIV > <DIV @@ -4630,7 +4769,7 @@ CLASS="SECTION" ><HR><H2 CLASS="SECTION" ><A -NAME="AEN696" +NAME="AEN721" >3.2.14. Setting Up the MySQL Database</A ></H2 ><P @@ -4868,7 +5007,7 @@ CLASS="SECTION" ><HR><H2 CLASS="SECTION" ><A -NAME="AEN743" +NAME="AEN768" >3.2.15. Tweaking <TT CLASS="FILENAME" >localconfig</TT @@ -4994,7 +5133,7 @@ CLASS="QUOTE" <DIV CLASS="EXAMPLE" ><A -NAME="AEN774" +NAME="AEN799" ></A ><P ><B @@ -5074,7 +5213,7 @@ CLASS="SECTION" ><HR><H2 CLASS="SECTION" ><A -NAME="AEN781" +NAME="AEN806" >3.2.16. Setting Up Maintainers Manually (Optional)</A ></H2 ><P @@ -5124,7 +5263,7 @@ CLASS="SECTION" ><HR><H2 CLASS="SECTION" ><A -NAME="AEN792" +NAME="AEN817" >3.2.17. The Whining Cron (Optional)</A ></H2 ><P @@ -5210,7 +5349,7 @@ CLASS="SECTION" ><HR><H2 CLASS="SECTION" ><A -NAME="AEN802" +NAME="AEN827" >3.2.18. Bug Graphs (Optional)</A ></H2 ><P @@ -5267,7 +5406,7 @@ CLASS="SECTION" ><HR><H2 CLASS="SECTION" ><A -NAME="AEN814" +NAME="AEN839" >3.2.19. Securing MySQL</A ></H2 ><P @@ -5740,7 +5879,7 @@ CLASS="SECTION" ><H2 CLASS="SECTION" ><A -NAME="AEN916" +NAME="AEN941" >3.5.1. Modifying Your Running System</A ></H2 ><P @@ -5773,7 +5912,7 @@ CLASS="SECTION" ><HR><H2 CLASS="SECTION" ><A -NAME="AEN923" +NAME="AEN948" >3.5.2. Upgrading From Previous Versions</A ></H2 ><P @@ -5985,7 +6124,7 @@ CLASS="SECTION" ><HR><H2 CLASS="SECTION" ><A -NAME="AEN964" +NAME="UNIXHISTORY" >3.5.6. UNIX Installation Instructions History</A ></H2 ><P @@ -5997,9 +6136,11 @@ NAME="AEN964" > The February 25, 1999 re-write of this page was done by Ry4an Brase <ry4an@ry4an.org>, with some edits by Terry Weissman, Bryce Nesbitt, Martin Pool, & Dan Mosedale (But - don't send bug reports to them; report them using bugzilla, at - http://bugzilla.mozilla.org/enter_bug.cgi , project Webtools, - component Bugzilla). + don't send bug reports to them; report them using bugzilla, at <A +HREF="http://bugzilla.mozilla.org/enter_bug.cgi?product=Bugzilla" +TARGET="_top" +>http://bugzilla.mozilla.org/enter_bug.cgi?product=Bugzilla</A +> ). </P ><P > This document was heavily modified again Wednesday, March 07 @@ -6255,7 +6396,7 @@ CLASS="COMMAND" ><DIV CLASS="EXAMPLE" ><A -NAME="AEN1012" +NAME="AEN1038" ></A ><P ><B @@ -7084,7 +7225,9 @@ TARGET="_top" ></LI ><LI ><P -> Modify the invocation of all system() calls in all perl scripts in your Bugzilla directory. For instance, change this line in processmail: +> Modify the invocation of all system() calls in all perl + scripts in your Bugzilla directory. For instance, change + this line in processmail: <TABLE BORDER="0" BGCOLOR="#E0E0E0" @@ -7095,14 +7238,14 @@ WIDTH="100%" COLOR="#000000" ><PRE CLASS="PROGRAMLISTING" ->system ("./processmail.pl",@ARGLIST); +> +system ("./processmail.pl",@ARGLIST); </PRE ></FONT ></TD ></TR ></TABLE -> -to +> to <TABLE BORDER="0" BGCOLOR="#E0E0E0" @@ -7113,7 +7256,8 @@ WIDTH="100%" COLOR="#000000" ><PRE CLASS="PROGRAMLISTING" ->system ("perl processmail.pl",@ARGLIST); +> +system ("perl processmail.pl",@ARGLIST); </PRE ></FONT ></TD @@ -7122,6 +7266,94 @@ CLASS="PROGRAMLISTING" > </P ></LI +><LI +><P +> Add <TT +CLASS="FUNCTION" +>binmode()</TT +> calls so attachments + will work (<A +HREF="http://bugzilla.mozilla.org/show_bug.cgi?id=62000" +TARGET="_top" +>bug 62000</A +>). + </P +><P +> Because Microsoft Windows based systems handle binary + files different than Unix based systems, you need to add + the following lines to + <TT +CLASS="FILENAME" +>createattachment.cgi</TT +> and + <TT +CLASS="FILENAME" +>showattachment.cgi</TT +> before the + <TT +CLASS="FUNCTION" +>require 'CGI.pl';</TT +> line.</P +><P +><TABLE +BORDER="0" +BGCOLOR="#E0E0E0" +WIDTH="100%" +><TR +><TD +><FONT +COLOR="#000000" +><PRE +CLASS="PROGRAMLISTING" +>binmode(STDIN); +binmode(STDOUT);</PRE +></FONT +></TD +></TR +></TABLE +> + </P +><DIV +CLASS="NOTE" +><P +></P +><TABLE +CLASS="NOTE" +WIDTH="100%" +BORDER="0" +><TR +><TD +WIDTH="25" +ALIGN="CENTER" +VALIGN="TOP" +><IMG +SRC="../images/note.gif" +HSPACE="5" +ALT="Note"></TD +><TD +ALIGN="LEFT" +VALIGN="TOP" +><P +> According to <A +HREF="http://bugzilla.mozilla.org/show_bug.cgi?id=62000" +TARGET="_top" +>bug 62000</A +>, the perl documentation says that you should always use <TT +CLASS="FUNCTION" +>binmode()</TT +> when dealing with binary files, but never when dealing with text files. That seems to suggest that rather than aribtrarily putting <TT +CLASS="FUNCTION" +>binmode()</TT +> at the begining of the attachment files, there should be logic to determine if <TT +CLASS="FUNCTION" +>binmode()</TT +> is needed or not. + </P +></TD +></TR +></TABLE +></DIV +></LI ></OL ></DIV ><DIV @@ -7149,7 +7381,9 @@ VALIGN="TOP" relationships to Properties -> Home directory (tab) -> Application Settings (section) -> Configuration (button), such as: - <TABLE + </P +><P +> <TABLE BORDER="0" BGCOLOR="#E0E0E0" WIDTH="100%" @@ -7208,7 +7442,7 @@ VALIGN="TOP" ><P > From Andrew Pearson: <A -NAME="AEN1169" +NAME="AEN1212" ></A ><BLOCKQUOTE CLASS="BLOCKQUOTE" @@ -7226,7 +7460,23 @@ TARGET="_top" registry at the following location: </P ><P -> HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\W3SVC\Parameters\ScriptMap +> <TABLE +BORDER="0" +BGCOLOR="#E0E0E0" +WIDTH="100%" +><TR +><TD +><FONT +COLOR="#000000" +><PRE +CLASS="PROGRAMLISTING" +>HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\W3SVC\Parameters\ScriptMap + </PRE +></FONT +></TD +></TR +></TABLE +> </P ><P > The keys should be called ".pl" and ".cgi", and both @@ -7273,11 +7523,12 @@ VALIGN="TOP" <EM >not necessary</EM > for Bugzilla 2.13 and - later. + later, which includes the current release, Bugzilla + 2.14. <DIV CLASS="EXAMPLE" ><A -NAME="AEN1180" +NAME="AEN1224" ></A ><P ><B @@ -7285,7 +7536,7 @@ NAME="AEN1180" 2.12 or earlier</B ></P ><P -> Replace this: +> Replace this: <TABLE BORDER="0" BGCOLOR="#E0E0E0" @@ -7296,16 +7547,16 @@ WIDTH="100%" COLOR="#000000" ><PRE CLASS="PROGRAMLISTING" -> -SendSQL("SELECT encrypt(" . SqlQuote($enteredpwd) . ", " . SqlQuote(substr($realcryptpwd, 0, 2)) . ")"); -my $enteredcryptpwd = FetchOneColumn(); +> +SendSQL("SELECT encrypt(" . SqlQuote($enteredpwd) . ", " . SQLQuote(substr($realcryptpwd, 0, 2)) . ")"); +my $enteredcryptpwd = FetchOneColumn(); </PRE ></FONT ></TD ></TR ></TABLE -> - with this: +> +with this: <TABLE BORDER="0" BGCOLOR="#E0E0E0" @@ -7316,14 +7567,14 @@ WIDTH="100%" COLOR="#000000" ><PRE CLASS="PROGRAMLISTING" -> -my $enteredcryptpwd = $enteredpwd +> +my $enteredcryptpwd = $enteredpwd </PRE ></FONT ></TD ></TR ></TABLE -> +> in cgi.pl. </P ></DIV @@ -7334,6 +7585,87 @@ my $enteredcryptpwd = $enteredpwd ></TABLE ></DIV ></DIV +><DIV +CLASS="SECTION" +><HR><H2 +CLASS="SECTION" +><A +NAME="BZLDAP" +>3.6.3. Bugzilla LDAP Integration</A +></H2 +><P +> What follows is some late-breaking information on using the + LDAP authentication options with Bugzilla. The author has not + tested these (nor even formatted this section!) so please + contribute feedback to the newsgroup. + </P +><P +CLASS="LITERALLAYOUT" +>Mozilla::LDAP module<br> +<br> +The Mozilla::LDAP module allows you to use LDAP for authentication to<br> +the Bugzilla system. This module is not required if you are not using<br> +LDAP.<br> +<br> +Mozilla::LDAP (aka PerLDAP) is available for download from<br> +http://www.mozilla.org/directory.<br> +<br> +NOTE: The Mozilla::LDAP module requires Netscape's Directory SDK.<br> +Follow the link for "Directory SDK for C" on that same page to<br> +download the SDK first. After you have installed this SDK, then<br> +install the PerLDAP module.<br> +----------------------------------------------------------------------<br> +<br> +Post-Installation Checklist<br> +----------------------------------------------------------------------<br> +Set useLDAP to "On" **only** if you will be using an LDAP directory<br> +for authentication. Be very careful when setting up this parameter;<br> +if you set LDAP authentication, but do not have a valid LDAP directory<br> +set up, you will not be able to log back in to Bugzilla once you log<br> +out. (If this happens, you can get back in by manually editing the<br> +data/params file, and setting useLDAP back to 0.)<br> +<br> +If using LDAP, you must set the three additional parameters:<br> +<br> +Set LDAPserver to the name (and optionally port) of your LDAP server.<br> +If no port is specified, it defaults to the default port of 389. (e.g<br> +"ldap.mycompany.com" or "ldap.mycompany.com:1234")<br> +<br> +Set LDAPBaseDN to the base DN for searching for users in your LDAP<br> +directory. (e.g. "ou=People,o=MyCompany") uids must be unique under<br> +the DN specified here.<br> +<br> +Set LDAPmailattribute to the name of the attribute in your LDAP<br> +directory which contains the primary email address. On most directory<br> +servers available, this is "mail", but you may need to change this.<br> +----------------------------------------------------------------------<br> +<br> +(Not sure where this bit should go, but it's important that it be in<br> +there somewhere...)<br> +----------------------------------------------------------------------<br> +Using LDAP authentication for Bugzilla:<br> +<br> +The existing authentication scheme for Bugzilla uses email addresses<br> +as the primary user ID, and a password to authenticate that user. All<br> +places within Bugzilla where you need to deal with user ID (e.g<br> +assigning a bug) use the email address.<br> +<br> +The LDAP authentication builds on top of this scheme, rather than<br> +replacing it. The initial log in is done with a username and password<br> +for the LDAP directory. This then fetches the email address from LDAP<br> +and authenticates seamlessly in the standard Bugzilla authentication<br> +scheme using this email address. If an account for this address<br> +already exists in your Bugzilla system, it will log in to that<br> +account. If no account for that email address exists, one is created<br> +at the time of login. (In this case, Bugzilla will attempt to use the<br> +"displayName" or "cn" attribute to determine the user's full name.)<br> +<br> +After authentication, all other user-related tasks are still handled<br> +by email address, not LDAP username. You still assign bugs by email<br> +address, query on users by email address, etc.<br> +----------------------------------------------------------------------<br> + </P +></DIV ></DIV ></DIV ><DIV @@ -8614,7 +8946,7 @@ NAME="COMPONENTS" <DIV CLASS="EXAMPLE" ><A -NAME="AEN1413" +NAME="AEN1461" ></A ><P ><B @@ -8623,7 +8955,7 @@ NAME="AEN1413" ><DIV CLASS="INFORMALEXAMPLE" ><A -NAME="AEN1415" +NAME="AEN1463" ></A ><P ></P @@ -8769,7 +9101,7 @@ NAME="VERSIONS" <DIV CLASS="EXAMPLE" ><A -NAME="AEN1442" +NAME="AEN1490" ></A ><P ><B @@ -8778,7 +9110,7 @@ NAME="AEN1442" ><DIV CLASS="INFORMALEXAMPLE" ><A -NAME="AEN1444" +NAME="AEN1492" ></A ><P ></P @@ -8800,7 +9132,7 @@ NAME="AEN1444" <DIV CLASS="EXAMPLE" ><A -NAME="AEN1446" +NAME="AEN1494" ></A ><P ><B @@ -8809,7 +9141,7 @@ NAME="AEN1446" ><DIV CLASS="INFORMALEXAMPLE" ><A -NAME="AEN1448" +NAME="AEN1496" ></A ><P ></P @@ -8946,7 +9278,7 @@ TYPE="1" ><DIV CLASS="EXAMPLE" ><A -NAME="AEN1474" +NAME="AEN1522" ></A ><P ><B @@ -8955,7 +9287,7 @@ NAME="AEN1474" ><DIV CLASS="INFORMALEXAMPLE" ><A -NAME="AEN1476" +NAME="AEN1524" ></A ><P ></P @@ -9169,7 +9501,7 @@ NAME="GROUPS" <DIV CLASS="EXAMPLE" ><A -NAME="AEN1510" +NAME="AEN1558" ></A ><P ><B @@ -9178,7 +9510,7 @@ NAME="AEN1510" ><DIV CLASS="INFORMALEXAMPLE" ><A -NAME="AEN1512" +NAME="AEN1560" ></A ><P ></P @@ -9295,7 +9627,7 @@ TYPE="1" <DIV CLASS="EXAMPLE" ><A -NAME="AEN1527" +NAME="AEN1575" ></A ><P ><B @@ -9304,7 +9636,7 @@ NAME="AEN1527" ><DIV CLASS="INFORMALEXAMPLE" ><A -NAME="AEN1529" +NAME="AEN1577" ></A ><P ></P @@ -9425,6 +9757,112 @@ VALIGN="TOP" </P ></LI ></OL +><P +> You may find this example illustrative for how bug groups work. + <DIV +CLASS="EXAMPLE" +><A +NAME="AEN1592" +></A +><P +><B +>Example 4-7. Bugzilla Groups</B +></P +><P +CLASS="LITERALLAYOUT" +>Bugzilla Groups example<br> +-----------------------<br> +<br> +For this example, let us suppose we have four groups, call them<br> +Group1, Group2, Group3, and Group4.<br> +<br> +We have 5 users, User1, User2, User3, User4, User5.<br> +<br> +We have 8 bugs, Bug1, ..., Bug8.<br> +<br> +Group membership is defined by this chart:<br> +(X denotes that user is in that group.)<br> +(I apologize for the nasty formatting of this table. Try viewing<br> +it in a text-based browser or something for now. -MPB)<br> +<br> + G G G G<br> + r r r r<br> + o o o o<br> + u u u u<br> + p p p p<br> + 1 2 3 4<br> + +-+-+-+-+<br> +User1|X| | | |<br> + +-+-+-+-+<br> +User2| |X| | |<br> + +-+-+-+-+<br> +User3|X| |X| |<br> + +-+-+-+-+<br> +User4|X|X|X| |<br> + +-+-+-+-+<br> +User5| | | | |<br> + +-+-+-+-+<br> +<br> +Bug restrictions are defined by this chart:<br> +(X denotes that bug is restricted to that group.)<br> +<br> + G G G G<br> + r r r r<br> + o o o o<br> + u u u u<br> + p p p p<br> + 1 2 3 4<br> + +-+-+-+-+<br> +Bug1| | | | |<br> + +-+-+-+-+<br> +Bug2| |X| | |<br> + +-+-+-+-+<br> +Bug3| | |X| |<br> + +-+-+-+-+<br> +Bug4| | | |X|<br> + +-+-+-+-+<br> +Bug5|X|X| | |<br> + +-+-+-+-+<br> +Bug6|X| |X| |<br> + +-+-+-+-+<br> +Bug7|X|X|X| |<br> + +-+-+-+-+<br> +Bug8|X|X|X|X|<br> + +-+-+-+-+<br> +<br> +Who can see each bug?<br> +<br> +Bug1 has no group restrictions. Therefore, Bug1 can be seen by any<br> +user, whatever their group membership. This is going to be the only<br> +bug that User5 can see, because User5 isn't in any groups.<br> +<br> +Bug2 can be seen by anyone in Group2, that is User2 and User4.<br> +<br> +Bug3 can be seen by anyone in Group3, that is User3 and User4.<br> +<br> +Bug4 can be seen by anyone in Group4. Nobody is in Group4, so none of<br> +these users can see Bug4.<br> +<br> +Bug5 can be seen by anyone who is in _both_ Group1 and Group2. This<br> +is only User4. User1 cannot see it because he is not in Group2, and<br> +User2 cannot see it because she is not in Group1.<br> +<br> +Bug6 can be seen by anyone who is in both Group1 and Group3. This<br> +would include User3 and User4. Similar to Bug5, User1 cannot see Bug6<br> +because he is not in Group3.<br> +<br> +Bug7 can be seen by anyone who is in Group1, Group2, and Group3. This<br> +is only User4. All of the others are missing at least one of those<br> +group priveleges, and thus cannot see the bug.<br> +<br> +Bug8 can be seen by anyone who is in Group1, Group2, Group3, and<br> +Group4. There is nobody in all four of these groups, so nobody can<br> +see Bug8. It doesn't matter that User4 is in Group1, Group2, and<br> +Group3, since he isn't in Group4.<br> + </P +></DIV +> + </P ></DIV ></DIV ><DIV @@ -9792,6 +10230,20 @@ CLASS="QUOTE" an @resolution field, you can even change the Bugzilla bug state. </P +><P +> There is also a project, based upon somewhat dated Bugzilla + code, to integrate CVS and Bugzilla through CVS' ability to + email. Check it out at: + <A +HREF="http://homepages.kcbbs.gen.nz/~tonyg/" +TARGET="_top" +> http://homepages.kcbbs.gen.nz/~tonyg/</A +>, under the + <SPAN +CLASS="QUOTE" +>"cvszilla"</SPAN +> link. + </P ></DIV ><DIV CLASS="SECTION" @@ -9861,14 +10313,748 @@ CLASS="SYNOPSIS" ></TR ></TABLE ><P -> The future of Bugzilla is Bugzilla 3.0. Unfortunately, I do - not have more information about it right now, and most of what - went into the "future" section is now present. That stuff was - blue-sky a year ago; MattyT should have me a new document - sometime... +> Bugzilla's future is a constantly-changing thing, as various developers + <SPAN +CLASS="QUOTE" +>"scratch an itch"</SPAN +> when it comes to functionality. + Thus this section is very malleable, subject to change without notice, etc. + You'll probably also notice the lack of formatting. I apologize that it's + not quite as readable as the rest of the Guide. + </P +><P +> <P +CLASS="LITERALLAYOUT" +> Bugzilla Blue Sky<br> +<br> +Customisability<br> +<br> + One of the major stumbling blocks of Bugzilla has been that it is too<br> + rigid and does not adapt itself well enough to the needs of an<br> + organisation. This has led to organisations making changes to the<br> + Bugzilla code that need to be redone each new version of Bugzilla.<br> + Bugzilla should attempt to move away from this to a world where this<br> + doesn't need to occur.<br> +<br> + Most of the subsections in this section are currently explicit design<br> + goals for the "Bugzilla 3" rewrite. This does not necessarily mean<br> + that they will not occur before them in Bugzilla 2, but most are<br> + significant undertakings.<br> +<br> + Field Customisation<br> +<br> + Many installations wish to customise the fields that appear on bug<br> + reports. Current versions of Bugzilla offer limited<br> + customisability. In particular, some fields can be turned off.<br> +<br> + However, many administrators wish to add their own fields, and rename<br> + or otherwise modify existing fields. An architecture that supports<br> + this would be extraordinarily useful.<br> +<br> + Indeed, many fields work similarly and could be abstracted into "field<br> + types", so that an administrator need write little or no code to<br> + support the new fields they desire.<br> +<br> + Possible field types include text (eg status whiteboard), numbers,<br> + dates (eg report time), accounts (eg reporter, qa, cc), inter-bug<br> + relationships (dependencies, duplicates), option groups (platform, os,<br> + severity, priority, target milestone, version) etc.<br> +<br> + Ideally an administrator could configure their fields through a<br> + Bugzilla interface that requires no code to be added. However, it is<br> + highly unlikely this ideal will never be met, and in a similar way<br> + that office applications have scripting languages, Bugzilla should<br> + allow new field types to be written.<br> +<br> + Similarly, a common desire is for resolutions to be added or removed.<br> +<br> + Allocations<br> +<br> + ?<br> +<br> + Option Groups<br> +<br> + ?<br> +<br> + Relations<br> +<br> + ?<br> +<br> + Database Integrity<br> +<br> + Furthermore, it is desirable for administrators to be able to specify<br> + rules that must or should apply between the fields on a bug report.<br> +<br> + For example, you might wish to specify that a bug with status ASSIGNED<br> + must have a target milestone field that that is not untargetted. Or<br> + that a bug with a certain number of votes should get ASSIGNED. Or<br> + that the QA contact must be different from the assignee.<br> +<br> + "Must" relationships could be implemented by refusing to make changes<br> + that violate the relationships, or alternatively, automatically<br> + updating certain fields in order to satisfy the criteria. Which<br> + occurs should be up to the administrator.<br> +<br> + "Should" relationships could be implemented by a combination of<br> + emitting warnings on the process bug page, the same on notification<br> + mails, or emitting periodic whine mails about the situation. Again,<br> + which occurs should be up to the administrator.<br> +<br> + It should also be possible for whine mails to be emitted for "must"<br> + relationships, as they might become violated through direct database<br> + access, Bugzilla bugs, or because they were there before the<br> + relationship was enforced.<br> +<br> + As well as implementing intra-bug constraints, it would be useful to<br> + create inter-bug constraints. For example, a bug that is dependent on<br> + another bug should not have an earlier milestone or greater priority<br> + than that bug.<br> +<br> + Database Adaptability<br> +<br> + Often an administrator desires that fields adapt to the values of<br> + other fields. For example, the value of a field might determine the<br> + possible values of another field or even whether it appears (whether<br> + it is "applicable").<br> +<br> + Limited adaptability is present in Bugzilla 2, and only on the<br> + "Product" field:<br> + * The possible values of the target milestone, version and component<br> + fields depend on the product.<br> + * UNCONFIRMED can be turned off for specific products.<br> + * Voting can be configured differently or turned off for different<br> + products, and there is a separate user vote limits for each<br> + product.<br> +<br> + It would be good if more adaptability was present, both in terms of<br> + all fields relying on the product, as well as the ability to adapt<br> + based on the value of all fields.<br> +<br> + Example ???<br> +<br> + General adaptability raises the issue of circular references between<br> + fields causing problems. One possible solution to this is to place<br> + the fields in a total ordering and require a field refer only to the<br> + previous fields.<br> +<br> + In Bugzilla 2, changing the product of a bug meant a second page would<br> + appear that allowed you to choose a new milestone, component and<br> + version, as those fields adapted themselves to the new product. This<br> + page could be generalised to support all instances where:<br> + * a field value must or might be changed because the possible values<br> + have changed<br> + * is going to drop off because it it is no longer applicable, and<br> + this should be confirmed<br> + * must be specified because it is suddenly applicable, and the<br> + default value, if one exists, might not be acceptable<br> +<br> + Database Independence<br> +<br> + Currently Bugzilla only runs on the MySQL database. It would be<br> + desirable for Bugzilla to run on other databases, because:<br> + * Organisations may have existing database products they use and<br> + would prefer to run a homogenous environment.<br> + * Databases each have their own shortcomings, including MySQL. An<br> + administrator might choose a database that would work better with<br> + their Bugzilla.<br> +<br> + This raises the possibility that we could use features that are only<br> + present in some databases, by appropriately falling back. For<br> + example, in the MySQL world, we live without:<br> + * record-level locking, instead we use table-level locking<br> + * referential and record constraints, instead we checking code<br> + * subselects, instead we use multiple queries and redundant "caches"<br> +<br> + Multiple Front Ends<br> +<br> + Currently Bugzilla is manipulated via the Web, and notifies via<br> + E-Mail. It would be desirable for Bugzilla to easily support various<br> + front ends.<br> +<br> + There is no reason that Bugzilla could not be controlled via a whole<br> + range of front ends, including Web, E-Mail, IRC, ICQ, etc, and<br> + similarly for how it notifies. It's also possible that we could<br> + introduce a special Bugzilla client that uses its own protocol, for<br> + maximum user productivity.<br> +<br> + Indeed a request reply might be returned via a totally different<br> + transport method than was use to submit the request.<br> +<br> +Internationalisation<br> +<br> + Bugzilla currently supports only English. All of the field names,<br> + user instructions, etc are written in English. It would be desirable<br> + to allow "language packs" so Bugzilla can be easily used in<br> + non-English speaking locales.<br> +<br> + To a degree field customisation supports this, because administrators<br> + could specify their own fields names anyway. However, there will<br> + always be some basic facilities not covered by this, and it is<br> + desirable that the administrator's interface also is<br> + internationalisable.<br> +<br> +Better Searching<br> +<br> + General Summary Reports<br> +<br> + Sometimes, the normal querying page leaves a lot to be desired. There<br> + are other facilities already in place or which people have asked for:<br> +<br> + Most Doomed Reports - All Bugs or All Bugs In A Product, Categorised<br> + On Assignee, Shows and Counts Number of Bugs For Each Assignee<br> + Most Voted For Bugs - All Bugs, Categorised On Product, Shows Top Ten<br> + Bugs Voters Most Want Fixed<br> + Number of Open Bugs For An Assignee - Bug List, Categorised On<br> + Developers, Counts Number of Bugs In Category<br> +<br> + The important thing to realise is that people want categorised reports<br> + on all sorts of things - a general summary report.<br> +<br> + In a categorised report, you choose the subset of bugs you wish to<br> + operate on (similar to how you would specify a query), and then<br> + categorise them on one or more fields.<br> +<br> + For each category you display the count of the number of things in<br> + that category. You can optionally display the bugs themselves, or<br> + leave them out, just showing the counts. And you can optionally limit<br> + the number of things (bugs or subcategories) that display in each<br> + category.<br> +<br> + Such a mechanism would let you do all of the above and more.<br> + Applications of this mechanism would only be recognised once it was<br> + implemented.<br> +<br> + Related Bugs<br> +<br> + It would be nice to have a field where you could enter other bugs<br> + related to the current bug. It would be handy for navigation and<br> + possibly even finding duplicates.<br> +<br> + Column Specification Support<br> +<br> + Currently bug lists use the columns that you last used. This doesn't<br> + work well for "prepackaged queries", where you followed a link. You<br> + can probably add a column by specifying a sort column, but this is<br> + difficult and suboptimal.<br> +<br> + Furthermore, I find that when I want to add a column to a bug list,<br> + it's usually a one off and I would prefer it to go away for the next<br> + query. Hence, it would be nice to specify the columns that appear on<br> + the bug list (and general summary report) pages. The default query<br> + mechanism should be able to let you specify your default columns.<br> +<br> + Advanced Querying Redesign<br> +<br> + ?<br> +<br> +Keywords<br> +<br> + People have a need to apply tags to bugs. In the beginning, people<br> + placed designators in the summary and status whiteboard. However,<br> + these fields were not designed for that, and so there were many flaws<br> + with this system:<br> + * They pollute the field with information that was never intended to<br> + be present.<br> + * Removing them with a bulk change is a difficult problem that has<br> + too many pitfalls to implement.<br> + * You can easily get the capitalisation wrong.<br> +<br> + Then dependencies were introduced (when?), and people realised that<br> + they could use them for "tracking bugs". Again, dependencies were not<br> + designed for that, and so there were more flaws, albeit different<br> + ones, including:<br> + * They aren't really bugs, so it's difficult to distinguish issues<br> + from bugs.<br> + * They can pollute bugs counts, and you must somehow exclude them<br> + from queries.<br> + * There is a whole lot of useless information on them. They have an<br> + assignee but there is nothing to fix, and that person can get<br> + whined at by Bugzilla. They have target milestones which must be<br> + manually maintained. And so on.<br> +<br> + Finally, keywords were introduced (when?) for this purpose to remove<br> + the need for these two systems. Unfortunately, the simple keywords<br> + implementation was itself lacking in certain features provided by the<br> + two previous systems, and has remained almost unchanged since its<br> + inception. Furthermore, it could not be forseen that in large<br> + installations, the sheer number of keywords could become unwieldly and<br> + could lead to a movement back to the other systems.<br> +<br> + The keywords system was the right idea, however, and it remains so.<br> + Fixing the keywords system is one of the most important Bugzilla<br> + issues.<br> +<br> + Bringing Keywords Up To Par<br> +<br> + For the most part, keywords are very good at what they do. It is easy<br> + to add and remove them (unlike summary/whiteboard designators), we can<br> + simply see what issues are present on a bug (unlike tracking bugs),<br> + and we do not confuse bugs with issues (unlike tracking bugs).<br> +<br> + However, there are still some "regressions" in the keyword system over<br> + previous systems:<br> + * Users wish to view the "dependency forest" of a keyword. While a<br> + dependency tree is of one bug, a dependency forest is of a bug<br> + list, and consists of a dependency tree for each member of the bug<br> + list. Users can work around this with tracking bugs by creating a<br> + tracking bug and viewing the dependency tree of that tracking bug.<br> + * Users wish to specify the keywords that initially apply to a bug,<br> + but instead they must edit the bug once it has already been<br> + submitted. They can work around this with summary designators,<br> + since they specify the summary at reporting time.<br> + * Users wish to store or share a bug list that contains a keywords<br> + column. Hence they wish to be able to specify what columns appear<br> + in the bug list URL, as mentioned earlier. They can work around<br> + this using summary designators, since almost all bug lists have a<br> + summary column.<br> + * Users wish to be able to view keywords on a bug list. However<br> + often they are only interested in a small number of keywords.<br> + Having a bug list with a keywords column means that all keywords<br> + will appear on a bug list. This can take a substantial amount of<br> + space where a bug has a lot of keywords, since the table columns<br> + in Bugzilla adjust to the largest cell in that column. Hence<br> + users wish to be able to specify which keywords should appear in<br> + the bug list. In a very real sense, each keyword is a field unto<br> + itself. Users can work around this by using summary designators,<br> + since they keywords will share the space in the summary column.<br> + * Users wish to know when bugs with a specific issue are resolved.<br> + Hence they wish to be able to receive notifications on all the<br> + bugs with a specific keyword. The introduction a generic watching<br> + facility (also for things like watching all bugs in a component)<br> + would achieve this. Users can work around this by using tracking<br> + bugs, as dependencies have an existing way of detecting fixes to<br> + bug a bug was blocked by.<br> +<br> + Dealing With The Keyword Overload<br> +<br> + At the time of writing, the mozilla.org installation has approximately<br> + 100 keywords, and many more would be in use if the keywords system<br> + didn't have the problems it does.<br> +<br> + Such a large number of keywords introduces logistical problems:<br> + * It must be easy for someone to learn what a keyword means. If a<br> + keyword is buried within a lot of other keywords, it can be<br> + difficult to find.<br> + * It must be easy to see what keywords are on a bug. If the number<br> + of keywords is large, then this can be difficult.<br> +<br> + These lead some people to feel that there are "too many keywords".<br> +<br> + These problems are not without solutions however. It is harder to<br> + find a list of designators or tracking bugs than it is a list of<br> + keywords.<br> +<br> + The essential problem is it needs to be easy to find the keywords<br> + we're interested in through the mass of keywords.<br> +<br> + Keyword Applicability<br> +<br> + As has been previously mentioned, it is desirable for fields to be<br> + able to adapt to the values of other fields. This is certainly true<br> + for keywords. Many keywords are simply not relevant because of the<br> + bugs product, component, etc.<br> +<br> + Hence, by introducing keyword applicability, and not displaying<br> + keywords that are not relevant to the current bug, or clearly<br> + separating them, we can make the keyword overload problem less<br> + significant.<br> +<br> + Currently when you click on "keywords" on a bug, you get a list of all<br> + bugs. It would be desirable to introduce a list of keywords tailored<br> + to a specific bug, that reports, in order:<br> + * the keywords currently on the bug<br> + * the keywords not currently on the bug, but applicable to the bug<br> + * optionally, the keywords not applicable to the bug<br> +<br> + This essentially orders the keywords into three groups, where each<br> + group is more important than the previous, and therefore appears<br> + closer to the top.<br> +<br> + Keyword Grouping & Ordering<br> +<br> + We could further enhance both the global and bug specific keyword list<br> + by grouping keywords. We should always have a "flat" view of<br> + keywords, but other ways of viewing the keywords would be useful too.<br> +<br> + If keyword applicability was implemented, we could group keywords<br> + based on their "applicability condition". Keywords that apply to all<br> + bugs could be separated from keywords that apply to a specific<br> + product, both on the global keyword list and the keyword list of a bug<br> + that is in that product.<br> +<br> + We could specify groups of our own. For example, many keywords are in<br> + a mutually exclusive group, essentially like radio buttons in a user<br> + interface. This creates a natural grouping, although other groupings<br> + occur (which depends on your keywords).<br> +<br> + It is possible that we could use collapsing/expanding operations on<br> + "twisties" to only should the groups we are interested in.<br> +<br> + And instead of grouping keywords, we could order them on some metric<br> + of usefulness, such as:<br> + * when the keyword was last added to a bug<br> + * how many bugs the keyword is on<br> + * how many open bugs the keyword is on<br> +<br> + Opting Out Of Keywords<br> +<br> + Not all people are going to care about all keywords. Therefore it<br> + makes sense that you may wish to specify which keywords you are<br> + interested in, either on the bug page, or on notifications.<br> +<br> + Other keywords will therefore not bother users who are not interested<br> + in them.<br> +<br> + Keyword Security<br> +<br> + Currently all keywords are available and editable to all people with<br> + edit bugs access. This situation is clearly suboptimal.<br> +<br> + Although relying on good behaviour for people to not do what they<br> + shouldn't works reasonably well on the mozilla.org, it is better to<br> + enforce that behaviour - it can be breached through malice, accident<br> + or ignorance.<br> +<br> + And in the situation where it is desirable for the presence or absence<br> + of a keyword not to be revealed, organisations either need to be<br> + content with the divulgence, or not use keywords at all.<br> +<br> + In the situation where they choose to divulge, introducing the ability<br> + to restrict who can see the keyword would also reduce keyword<br> + overload.<br> +<br> + Personal Keywords<br> +<br> + Keywords join together a set of bugs which would otherwise be<br> + unrelated in the bug system.<br> +<br> + We allow users to store their own queries. However we don't allow<br> + them to store their own keywords on a bug. This reduces the<br> + usefulness of personal queries, since you cannot join a set of<br> + unrelated bugs together in a way that you wish. Lists of bug numbers<br> + can work, by they can only be used for small lists, and it is<br> + impossible to share a list between multiple queries.<br> +<br> + Personal keywords are necessary to replace personal tracking bugs, as<br> + they would not pollute the keyword space. Indeed, on many<br> + installations this could remove some keywords out of the global<br> + keyword space.<br> +<br> + In a similar vein and with similar effects, group keywords could be<br> + introduced that are only available to members of a specific group.<br> +<br> + Keyword Restrictions<br> +<br> + Keywords are not islands unto themselves. Along with their potential<br> + to be involved in the inter-field relationships mentioned earlier,<br> + keywords can also be related to other keywords.<br> +<br> + Essentially, there are two possibilities:<br> + * a set of keywords are mutually exclusive<br> + * the presence of a keyword implies another keyword must be present<br> +<br> + Introduction of the ability to specify these restrictions would have<br> + benefits.<br> +<br> + If mutually exclusive keywords were present on a bug, their removal<br> + would fix up the database, as well as reducing the number of keywords<br> + on that bug.<br> +<br> + In the situation where a keyword implies another keyword, there are<br> + two possiblities as to how to handle the situation.<br> +<br> + The first is automatically add the keyword. This would fix up the<br> + database, but it would increase the number of keywords on a bug.<br> +<br> + The second is to automatically remove the keyword, and alter queries<br> + so they pick up the first keyword as well as the removed keyword.<br> + This would fix up the database and reduce the number of keywords on a<br> + bug, but it might confuse users who don't see the keyword.<br> + Alternatively, the implied keywords could be listed separately.<br> +<br> +Notifications<br> +<br> + Every time a bug gets changed notifications get sent out to people<br> + letting them know about what changes have been made. This is a<br> + significant feature, and all sorts of questions can be raised, but<br> + they mainly boil down to when they should be sent and what they should<br> + look like.<br> +<br> + Changes You're Interested In<br> +<br> + As of version 2.12 users can specify what sort of changes they are<br> + interested in receiving notifications for. However, this is still<br> + limited. As yet there is no facility to specify which keywords you<br> + care about, and whether you care about changes to fields such as the<br> + QA contact changes.<br> + Furthermore, often an unnecessary comment will go along with a change,<br> + either because it is required, or the commenter is ignorant of how the<br> + new system works. While explaining why you did something is useful,<br> + merely commenting on what you did is not because that information is<br> + already accessible view "Bug Activity".<br> +<br> + Because of this unnecessary comment, a lot of changes that would<br> + otherwise not generate notifications for certain people do so, because<br> + few people are willing to turn off comments. One way to deal with<br> + this problem is to allow people to specify that their comments are<br> + purely explanatory, and that anyone who is not interested in the<br> + change will not be interested in the comment.<br> +<br> + Furthermore, one possible rationale for unnecessary comments is that<br> + the bug activity does not display on the normal page and hence it is<br> + difficult to cross reference comments and actions. Hence, it would be<br> + beneficial to be able to do this.<br> +<br> + Bugs You're Watching<br> +<br> + Currently to receive a notification about a bug you need to have your<br> + name on it. This is suboptimal because you need to know about a bug<br> + before you can receive notifications on it. Often you are interested<br> + in any bug with a field set to a specific value. For example, you<br> + might be interested in all bugs with a specific product, component or<br> + keyword.<br> +<br> + If someone could automatically receive notifications about these bugs,<br> + it would make everyone's lives easier. Currently the default assignee<br> + and QA contact for a component will automatically receive<br> + notifications for<br> +<br> + Question: This moves half way to a BCC.<br> +<br> + Bulk Changes<br> +<br> + A very useful feature of Bugzilla is the ability to perform an action<br> + on multiple bugs at once. However, this means that similar<br> + notifications are currently generated for each bug modified.<br> +<br> + This can result in a torrent of notifications that can annoy.<br> +<br> + Furthermore, since the bugs are all changed close to each other in<br> + time, it is easy for someone to mass delete all the notifications<br> + generated by a bulk change and miss an unrelated notification in the<br> + middle.<br> +<br> + These factors can lead to a tendency for people to delay bulk changes,<br> + or avoid them entirely. This is suboptimal.<br> +<br> + It would be better if a bulk change generated only one notification<br> + mail. This would vastly reduce the annoyance factor, and prevent<br> + accidental deletion of notifications.<br> +<br> + One problem with this change is that some people separate out<br> + notifications using filtering. This means that they would no longer<br> + be match parts of a bulk change under different filtering rules.<br> +<br> + One possibility to resolve this is to allow people to specify groups<br> + of bugs. All bugs within a group would go into the same<br> + notification. The filters could then distinguish the different bug<br> + groups.<br> +<br> + In any case, it is likely there would need to be a transition period<br> + to allow people to alter their filters.<br> +<br> +Nominations<br> +<br> + ?<br> +<br> +Linking Bugzilla Installations<br> +<br> + The first example of linking Bugzilla installations together has is<br> + the introduction of bug moving in version 2.12. However, it would be<br> + useful to be able to link installations in more ways.<br> + * Dependencies and other relationships between bugs in other<br> + installations. This is difficult because dependencies are<br> + synchronised on both bugs, so the installation that changes<br> + dependencies would need to communicate the new state to the other<br> + installation. It would also mean that relationships and<br> + notifications that refer to other bugs would need to communicate<br> + with the other installation.<br> + * References to bugs in other installations. Currently if you type<br> + "bug XXX" or "bug #XXX" where XXX is a number, you get an<br> + automatic hyperlink to that bug. It would be useful if you could<br> + say "YYY bug #XXX" where YYY is the name of another installation.<br> +<br> +Retirement<br> +<br> + ?<br> +<br> +Whiny Reports<br> +<br> + ?<br> +<br> + Group Redesign<br> +<br> + ?<br> +<br> + Hard Wrapping Comments<br> +<br> + Currently Bugzilla "hard wraps" its comments to a specific line size,<br> + similar to E-Mail. This has various problems:<br> + * The way it currently works, wrapping is done in the browser at<br> + submission time using a non-standard HTML extension not supported<br> + by some (uncommon) browsers. These browsers generate comments<br> + that scroll off the right side of the screen.<br> + * Because comments are of fixed width, when you expand your browser<br> + window, the comments do not expand to fit available space.<br> +<br> + It would be much better to move to a world of soft wrapping, where the<br> + browser wraps the text at display time, similar to a world processor.<br> + And as in a word processor, soft wrapping does not preclude the<br> + insertion of newlines.<br> +<br> + Hard wrapping is too entrenched into text E-Mail to fix, but we can<br> + fix Bugzilla without causing any problems. The old content will still<br> + be wrapped too early, but at least new content will work.<br> + </P +> </P ></DIV ><DIV +CLASS="CHAPTER" +><HR><H1 +><A +NAME="VARIANTS" +>Chapter 7. Bugzilla Variants and Competitors</A +></H1 +><P +>I created this section to answer questions about Bugzilla + competitors and variants, then found a wonderful site which covers + an awful lot of what I wanted to discuss. Rather than quote it in + its entirety, I'll simply refer you here: <A +HREF="http://linas.org/linux/pm.html" +TARGET="_top" +>http://linas.org/linux/pm.html</A +></P +><DIV +CLASS="SECTION" +><HR><H1 +CLASS="SECTION" +><A +NAME="RHBUGZILLA" +>7.1. Red Hat Bugzilla</A +></H1 +><P +> Red Hat Bugzilla is probably the most popular Bugzilla variant + on the planet. One of the major benefits of Red Hat Bugzilla is + the ability to work with Oracle, MySQL, and PostGreSQL databases + serving as the back-end, instead of just MySQL. Dave Lawrence + has worked very hard to keep Red Hat Bugzilla up-to-date, and + many people prefer the snappier-looking page layout of Red Hat + Bugzilla to the default Mozilla-standard formatting. + </P +><P +>URL: <A +HREF="http://bugzilla.redhat.com/bugzilla/" +TARGET="_top" +>http://bugzilla.redhat.com/bugzilla/</A +></P +></DIV +><DIV +CLASS="SECTION" +><HR><H1 +CLASS="SECTION" +><A +NAME="VARIANT_FENRIS" +>7.2. Loki Bugzilla (Fenris)</A +></H1 +><P +>Fenris can be found at <A +HREF="http://fenris.lokigames.com/" +TARGET="_top" +>http://fenris.lokigames.com</A +>. It is a fork from Bugzilla.</P +></DIV +><DIV +CLASS="SECTION" +><HR><H1 +CLASS="SECTION" +><A +NAME="VARIANT_ISSUEZILLA" +>7.3. Issuezilla</A +></H1 +><P +>Issuezilla is another fork from Bugzilla, and seems nearly + as popular as the Red Hat Bugzilla fork. Some Issuezilla team + members are regular contributors to the Bugzilla mailing + list/newsgroup. Issuezilla is not the primary focus of + bug-tracking at tigris.org, however. Their Java-based + bug-tracker, <A +HREF="#VARIANT_SCARAB" +>Scarab, a newfangled Java-based issue tracker</A +>, is under heavy development + and looks promising!</P +><P +>URL: <A +HREF="http://issuezilla.tigris.org/servlets/ProjectHome" +TARGET="_top" +>http://issuezilla.tigris.org/servlets/ProjectHome</A +></P +></DIV +><DIV +CLASS="SECTION" +><HR><H1 +CLASS="SECTION" +><A +NAME="VARIANT_SCARAB" +>7.4. Scarab</A +></H1 +><P +>Scarab is a promising new bug-tracking system built using + Java Serlet technology. As of this writing, no source code has + been released as a package, but you can obtain the code from + CVS. + </P +><P +>URL: <A +HREF="http://scarab.tigris.org/" +TARGET="_top" +>http://scarab.tigris.org</A +></P +></DIV +><DIV +CLASS="SECTION" +><HR><H1 +CLASS="SECTION" +><A +NAME="VARIANT_PERFORCE" +>7.5. Perforce SCM</A +></H1 +><P +>Although Perforce isn't really a bug tracker, it can be used + as such through the <SPAN +CLASS="QUOTE" +>"jobs"</SPAN +> functionality.</P +><P +><A +HREF="http://www.perforce.com/perforce/technotes/note052.html" +TARGET="_top" +>http://www.perforce.com/perforce/technotes/note052.html</A +>http://www.perforce.com/perforce/technotes/note052.html</P +></DIV +><DIV +CLASS="SECTION" +><HR><H1 +CLASS="SECTION" +><A +NAME="VARIANT_SOURCEFORGE" +>7.6. SourceForge</A +></H1 +><P +>SourceForge is more of a way of coordinating geographically + distributed free software and open source projects over the + Internet than strictly a bug tracker, but if you're hunting for + bug-tracking for your open project, it may be just what the + software engineer ordered!</P +><P +>URL: <A +HREF="http://www.sourceforge.net" +TARGET="_top" +>http://www.sourceforge.net</A +></P +></DIV +></DIV +><DIV CLASS="APPENDIX" ><HR><H1 ><A @@ -9887,63 +11073,63 @@ HREF="#FAQ_GENERAL" ><DL ><DT >A.1.1. <A -HREF="#AEN1620" +HREF="#AEN1713" > Where can I find information about Bugzilla?</A ></DT ><DT >A.1.2. <A -HREF="#AEN1626" +HREF="#AEN1719" > What license is Bugzilla distributed under? </A ></DT ><DT >A.1.3. <A -HREF="#AEN1632" +HREF="#AEN1725" > How do I get commercial support for Bugzilla? </A ></DT ><DT >A.1.4. <A -HREF="#AEN1639" +HREF="#AEN1732" > What major companies or projects are currently using Bugzilla for bug-tracking? </A ></DT ><DT >A.1.5. <A -HREF="#AEN1664" +HREF="#AEN1757" > Who maintains Bugzilla? </A ></DT ><DT >A.1.6. <A -HREF="#AEN1670" +HREF="#AEN1763" > How does Bugzilla stack up against other bug-tracking databases? </A ></DT ><DT >A.1.7. <A -HREF="#AEN1677" +HREF="#AEN1770" > How do I change my user name in Bugzilla? </A ></DT ><DT >A.1.8. <A -HREF="#AEN1682" +HREF="#AEN1775" > Why doesn't Bugzilla offer this or that feature or compatability with this other tracking software? </A ></DT ><DT >A.1.9. <A -HREF="#AEN1689" +HREF="#AEN1782" > Why MySQL? I'm interested in seeing Bugzilla run on Oracle/Sybase/Msql/PostgreSQL/MSSQL? </A ></DT ><DT >A.1.10. <A -HREF="#AEN1707" +HREF="#AEN1800" > Why do the scripts say "/usr/bonsaitools/bin/perl" instead of "/usr/bin/perl" or something else? </A @@ -9959,19 +11145,19 @@ HREF="#FAQ_REDHAT" ><DL ><DT >A.2.1. <A -HREF="#AEN1724" +HREF="#AEN1817" > What about Red Hat Bugzilla? </A ></DT ><DT >A.2.2. <A -HREF="#AEN1732" +HREF="#AEN1825" > What are the primary benefits of Red Hat Bugzilla? </A ></DT ><DT >A.2.3. <A -HREF="#AEN1760" +HREF="#AEN1853" > What's the current status of Red Hat Bugzilla? </A ></DT @@ -9986,7 +11172,7 @@ HREF="#FAQ_LOKI" ><DL ><DT >A.3.1. <A -HREF="#AEN1773" +HREF="#AEN1866" > What is Loki Bugzilla (Fenris)? </A ></DT @@ -10001,41 +11187,41 @@ HREF="#FAQ_PHB" ><DL ><DT >A.4.1. <A -HREF="#AEN1784" +HREF="#AEN1877" > Is Bugzilla web-based or do you have to have specific software or specific operating system on your machine? </A ></DT ><DT >A.4.2. <A -HREF="#AEN1789" +HREF="#AEN1882" > Has anyone you know of already done any Bugzilla integration with Perforce (SCM software)? </A ></DT ><DT >A.4.3. <A -HREF="#AEN1794" +HREF="#AEN1887" > Does Bugzilla allow the user to track multiple projects? </A ></DT ><DT >A.4.4. <A -HREF="#AEN1799" +HREF="#AEN1892" > If I am on many projects, and search for all bugs assigned to me, will Bugzilla list them for me and allow me to sort by project, severity etc? </A ></DT ><DT >A.4.5. <A -HREF="#AEN1804" +HREF="#AEN1897" > Does Bugzilla allow attachments (text, screenshots, urls etc)? If yes, are there any that are NOT allowed? </A ></DT ><DT >A.4.6. <A -HREF="#AEN1809" +HREF="#AEN1902" > Does Bugzilla allow us to define our own priorities and levels? Do we have complete freedom to change the labels of fields and format of them, and the choice of acceptable values? @@ -10043,7 +11229,7 @@ HREF="#AEN1809" ></DT ><DT >A.4.7. <A -HREF="#AEN1814" +HREF="#AEN1909" > The index.html page doesn't show the footer. It's really annoying to have to go to the querypage just to check my "my bugs" link. How do I get a footer on static HTML pages? @@ -10051,35 +11237,35 @@ HREF="#AEN1814" ></DT ><DT >A.4.8. <A -HREF="#AEN1820" +HREF="#AEN1931" > Does Bugzilla provide any reporting features, metrics, graphs, etc? You know, the type of stuff that management likes to see. :) </A ></DT ><DT >A.4.9. <A -HREF="#AEN1828" +HREF="#AEN1939" > Is there email notification and if so, what do you see when you get an email? Do you see bug number and title or is it only the number? </A ></DT ><DT >A.4.10. <A -HREF="#AEN1833" +HREF="#AEN1944" > Can email notification be set up to send to multiple people, some on the To List, CC List, BCC List etc? </A ></DT ><DT >A.4.11. <A -HREF="#AEN1838" +HREF="#AEN1949" > If there is email notification, do users have to have any particular type of email application? </A ></DT ><DT >A.4.12. <A -HREF="#AEN1845" +HREF="#AEN1956" > If I just wanted to track certain bugs, as they go through life, can I set it up to alert me via email whenever that bug changes, whether it be owner, status or description etc.? @@ -10087,7 +11273,7 @@ HREF="#AEN1845" ></DT ><DT >A.4.13. <A -HREF="#AEN1850" +HREF="#AEN1961" > Does Bugzilla allow data to be imported and exported? If I had outsiders write up a bug report using a MS Word bug template, could that template be imported into "matching" fields? If I wanted to take the results of a query @@ -10096,75 +11282,67 @@ HREF="#AEN1850" ></DT ><DT >A.4.14. <A -HREF="#AEN1858" -> Does Bugzilla allow fields to be added, changed or deleted? If I want to - customize the bug submission form to meet our needs, can I do that using our - terminology? - </A -></DT -><DT ->A.4.15. <A -HREF="#AEN1863" +HREF="#AEN1969" > Has anyone converted Bugzilla to another language to be used in other countries? Is it localizable? </A ></DT ><DT ->A.4.16. <A -HREF="#AEN1868" +>A.4.15. <A +HREF="#AEN1974" > Can a user create and save reports? Can they do this in Word format? Excel format? </A ></DT ><DT ->A.4.17. <A -HREF="#AEN1873" +>A.4.16. <A +HREF="#AEN1979" > Can a user re-run a report with a new project, same query? </A ></DT ><DT ->A.4.18. <A -HREF="#AEN1878" +>A.4.17. <A +HREF="#AEN1984" > Can a user modify an existing report and then save it into another name? </A ></DT ><DT ->A.4.19. <A -HREF="#AEN1883" +>A.4.18. <A +HREF="#AEN1989" > Does Bugzilla have the ability to search by word, phrase, compound search? </A ></DT ><DT ->A.4.20. <A -HREF="#AEN1888" +>A.4.19. <A +HREF="#AEN1994" > Can the admin person establish separate group and individual user privileges? </A ></DT ><DT ->A.4.21. <A -HREF="#AEN1893" +>A.4.20. <A +HREF="#AEN1999" > Does Bugzilla provide record locking when there is simultaneous access to the same bug? Does the second person get a notice that the bug is in use or how are they notified? </A ></DT ><DT ->A.4.22. <A -HREF="#AEN1898" +>A.4.21. <A +HREF="#AEN2004" > Are there any backup features provided? </A ></DT ><DT ->A.4.23. <A -HREF="#AEN1904" +>A.4.22. <A +HREF="#AEN2010" > Can users be on the system while a backup is in progress? </A ></DT ><DT ->A.4.24. <A -HREF="#AEN1909" +>A.4.23. <A +HREF="#AEN2015" > What type of human resources are needed to be on staff to install and maintain Bugzilla? Specifically, what type of skills does the person need to have? I need to find out if we were to go with Bugzilla, what types of @@ -10173,8 +11351,8 @@ HREF="#AEN1909" </A ></DT ><DT ->A.4.25. <A -HREF="#AEN1916" +>A.4.24. <A +HREF="#AEN2022" > What time frame are we looking at if we decide to hire people to install and maintain the Bugzilla? Is this something that takes hours or weeks to install and a couple of hours per week to maintain and customize or is this @@ -10183,8 +11361,8 @@ HREF="#AEN1916" </A ></DT ><DT ->A.4.26. <A -HREF="#AEN1921" +>A.4.25. <A +HREF="#AEN2027" > Is there any licensing fee or other fees for using Bugzilla? Any out-of-pocket cost other than the bodies needed as identified above? </A @@ -10200,19 +11378,19 @@ HREF="#FAQ_INSTALL" ><DL ><DT >A.5.1. <A -HREF="#AEN1928" +HREF="#AEN2034" > How do I download and install Bugzilla? </A ></DT ><DT >A.5.2. <A -HREF="#AEN1934" +HREF="#AEN2040" > How do I install Bugzilla on Windows NT? </A ></DT ><DT >A.5.3. <A -HREF="#AEN1939" +HREF="#AEN2045" > Is there an easy way to change the Bugzilla cookie name? </A ></DT @@ -10227,20 +11405,20 @@ HREF="#FAQ_SECURITY" ><DL ><DT >A.6.1. <A -HREF="#AEN1946" +HREF="#AEN2052" > How do I completely disable MySQL security if it's giving me problems (I've followed the instructions in the installation section of this guide!)? </A ></DT ><DT >A.6.2. <A -HREF="#AEN1952" +HREF="#AEN2058" > Are there any security problems with Bugzilla? </A ></DT ><DT >A.6.3. <A -HREF="#AEN1957" +HREF="#AEN2063" > I've implemented the security fixes mentioned in Chris Yeh's security advisory of 5/10/2000 advising not to run MySQL as root, and am running into problems with MySQL no longer working correctly. @@ -10257,48 +11435,48 @@ HREF="#FAQ_EMAIL" ><DL ><DT >A.7.1. <A -HREF="#AEN1964" +HREF="#AEN2070" > I have a user who doesn't want to receive any more email from Bugzilla. How do I stop it entirely for this user? </A ></DT ><DT >A.7.2. <A -HREF="#AEN1969" +HREF="#AEN2075" > I'm evaluating/testing Bugzilla, and don't want it to send email to anyone but me. How do I do it? </A ></DT ><DT >A.7.3. <A -HREF="#AEN1974" +HREF="#AEN2080" > I want whineatnews.pl to whine at something more, or other than, only new bugs. How do I do it? </A ></DT ><DT >A.7.4. <A -HREF="#AEN1980" +HREF="#AEN2086" > I don't like/want to use Procmail to hand mail off to bug_email.pl. What alternatives do I have? </A ></DT ><DT >A.7.5. <A -HREF="#AEN1987" +HREF="#AEN2093" > How do I set up the email interface to submit/change bugs via email? </A ></DT ><DT >A.7.6. <A -HREF="#AEN1992" +HREF="#AEN2098" > Email takes FOREVER to reach me from bugzilla -- it's extremely slow. What gives? </A ></DT ><DT >A.7.7. <A -HREF="#AEN1999" +HREF="#AEN2105" > How come email never reaches me from bugzilla changes? </A ></DT @@ -10313,60 +11491,60 @@ HREF="#FAQ_DB" ><DL ><DT >A.8.1. <A -HREF="#AEN2007" +HREF="#AEN2113" > I've heard Bugzilla can be used with Oracle? </A ></DT ><DT >A.8.2. <A -HREF="#AEN2012" +HREF="#AEN2118" > Bugs are missing from queries, but exist in the database (and I can pull them up by specifying the bug ID). What's wrong? </A ></DT ><DT >A.8.3. <A -HREF="#AEN2017" +HREF="#AEN2123" > I think my database might be corrupted, or contain invalid entries. What do I do? </A ></DT ><DT >A.8.4. <A -HREF="#AEN2022" +HREF="#AEN2131" > I want to manually edit some entries in my database. How? </A ></DT ><DT >A.8.5. <A -HREF="#AEN2027" +HREF="#AEN2136" > I try to add myself as a user, but Bugzilla always tells me my password is wrong. </A ></DT ><DT >A.8.6. <A -HREF="#AEN2032" +HREF="#AEN2141" > I think I've set up MySQL permissions correctly, but bugzilla still can't connect. </A ></DT ><DT >A.8.7. <A -HREF="#AEN2037" +HREF="#AEN2146" > How do I synchronize bug information among multiple different Bugzilla databases? </A ></DT ><DT >A.8.8. <A -HREF="#AEN2044" +HREF="#AEN2153" > Why do I get bizarre errors when trying to submit data, particularly problems with "groupset"? </A ></DT ><DT >A.8.9. <A -HREF="#AEN2049" +HREF="#AEN2158" > How come even after I delete bugs, the long descriptions show up? </A ></DT @@ -10381,32 +11559,32 @@ HREF="#FAQ_NT" ><DL ><DT >A.9.1. <A -HREF="#AEN2056" +HREF="#AEN2168" > What is the easiest way to run Bugzilla on Win32 (Win98+/NT/2K)? </A ></DT ><DT >A.9.2. <A -HREF="#AEN2061" +HREF="#AEN2173" > Is there a "Bundle::Bugzilla" equivalent for Win32? </A ></DT ><DT >A.9.3. <A -HREF="#AEN2066" +HREF="#AEN2178" > CGI's are failing with a "something.cgi is not a valid Windows NT application" error. Why? </A ></DT ><DT >A.9.4. <A -HREF="#AEN2074" +HREF="#AEN2186" > Can I have some general instructions on how to make Bugzilla on Win32 work? </A ></DT ><DT >A.9.5. <A -HREF="#AEN2080" +HREF="#AEN2192" > I'm having trouble with the perl modules for NT not being able to talk to to the database. </A @@ -10422,34 +11600,34 @@ HREF="#FAQ_USE" ><DL ><DT >A.10.1. <A -HREF="#AEN2101" +HREF="#AEN2213" > The query page is very confusing. Isn't there a simpler way to query? </A ></DT ><DT >A.10.2. <A -HREF="#AEN2107" +HREF="#AEN2219" > I'm confused by the behavior of the "accept" button in the Show Bug form. Why doesn't it assign the bug to me when I accept it? </A ></DT ><DT >A.10.3. <A -HREF="#AEN2117" +HREF="#AEN2229" > I can't upload anything into the database via the "Create Attachment" link. What am I doing wrong? </A ></DT ><DT >A.10.4. <A -HREF="#AEN2122" +HREF="#AEN2234" > Email submissions to Bugzilla that have attachments end up asking me to save it as a "cgi" file. </A ></DT ><DT >A.10.5. <A -HREF="#AEN2127" +HREF="#AEN2239" > How do I change a keyword in Bugzilla, once some bugs are using it? </A ></DT @@ -10464,20 +11642,20 @@ HREF="#FAQ_HACKING" ><DL ><DT >A.11.1. <A -HREF="#AEN2134" +HREF="#AEN2246" > What bugs are in Bugzilla right now? </A ></DT ><DT >A.11.2. <A -HREF="#AEN2143" +HREF="#AEN2255" > How can I change the default priority to a null value? For instance, have the default priority be "---" instead of "P2"? </A ></DT ><DT >A.11.3. <A -HREF="#AEN2149" +HREF="#AEN2261" > What's the best way to submit patches? What guidelines should I follow? </A ></DT @@ -10497,7 +11675,7 @@ CLASS="QANDAENTRY" CLASS="QUESTION" ><P ><A -NAME="AEN1620" +NAME="AEN1713" ></A ><B >A.1.1. </B @@ -10523,7 +11701,7 @@ CLASS="QANDAENTRY" CLASS="QUESTION" ><P ><A -NAME="AEN1626" +NAME="AEN1719" ></A ><B >A.1.2. </B @@ -10550,7 +11728,7 @@ CLASS="QANDAENTRY" CLASS="QUESTION" ><P ><A -NAME="AEN1632" +NAME="AEN1725" ></A ><B >A.1.3. </B @@ -10585,7 +11763,7 @@ CLASS="QANDAENTRY" CLASS="QUESTION" ><P ><A -NAME="AEN1639" +NAME="AEN1732" ></A ><B >A.1.4. </B @@ -10693,7 +11871,7 @@ CLASS="QANDAENTRY" CLASS="QUESTION" ><P ><A -NAME="AEN1664" +NAME="AEN1757" ></A ><B >A.1.5. </B @@ -10720,7 +11898,7 @@ CLASS="QANDAENTRY" CLASS="QUESTION" ><P ><A -NAME="AEN1670" +NAME="AEN1763" ></A ><B >A.1.6. </B @@ -10759,7 +11937,7 @@ CLASS="QANDAENTRY" CLASS="QUESTION" ><P ><A -NAME="AEN1677" +NAME="AEN1770" ></A ><B >A.1.7. </B @@ -10782,7 +11960,7 @@ CLASS="QANDAENTRY" CLASS="QUESTION" ><P ><A -NAME="AEN1682" +NAME="AEN1775" ></A ><B >A.1.8. </B @@ -10820,7 +11998,7 @@ CLASS="QANDAENTRY" CLASS="QUESTION" ><P ><A -NAME="AEN1689" +NAME="AEN1782" ></A ><B >A.1.9. </B @@ -10835,7 +12013,7 @@ CLASS="ANSWER" > </B >Terry Weissman answers, <A -NAME="AEN1693" +NAME="AEN1786" ></A ><BLOCKQUOTE CLASS="BLOCKQUOTE" @@ -10911,7 +12089,7 @@ CLASS="QANDAENTRY" CLASS="QUESTION" ><P ><A -NAME="AEN1707" +NAME="AEN1800" ></A ><B >A.1.10. </B @@ -10931,7 +12109,7 @@ CLASS="ANSWER" ><P > Here's Terry Weissman's comment, for some historical context: <A -NAME="AEN1712" +NAME="AEN1805" ></A ><BLOCKQUOTE CLASS="BLOCKQUOTE" @@ -11028,7 +12206,7 @@ CLASS="QANDAENTRY" CLASS="QUESTION" ><P ><A -NAME="AEN1724" +NAME="AEN1817" ></A ><B >A.2.1. </B @@ -11052,7 +12230,7 @@ CLASS="ANSWER" ><P > Dave Lawrence, the original Red Hat Bugzilla maintainer, mentions: <A -NAME="AEN1729" +NAME="AEN1822" ></A ><BLOCKQUOTE CLASS="BLOCKQUOTE" @@ -11075,7 +12253,7 @@ CLASS="QANDAENTRY" CLASS="QUESTION" ><P ><A -NAME="AEN1732" +NAME="AEN1825" ></A ><B >A.2.2. </B @@ -11091,7 +12269,7 @@ CLASS="ANSWER" >Dave Lawrence</EM >: <A -NAME="AEN1737" +NAME="AEN1830" ></A ><BLOCKQUOTE CLASS="BLOCKQUOTE" @@ -11207,7 +12385,7 @@ CLASS="QANDAENTRY" CLASS="QUESTION" ><P ><A -NAME="AEN1760" +NAME="AEN1853" ></A ><B >A.2.3. </B @@ -11253,7 +12431,7 @@ VALIGN="TOP" >Dave Lawrence</EM >: <A -NAME="AEN1767" +NAME="AEN1860" ></A ><BLOCKQUOTE CLASS="BLOCKQUOTE" @@ -11322,7 +12500,7 @@ CLASS="QANDAENTRY" CLASS="QUESTION" ><P ><A -NAME="AEN1773" +NAME="AEN1866" ></A ><B >A.3.1. </B @@ -11388,7 +12566,7 @@ CLASS="QANDAENTRY" CLASS="QUESTION" ><P ><A -NAME="AEN1784" +NAME="AEN1877" ></A ><B >A.4.1. </B @@ -11412,7 +12590,7 @@ CLASS="QANDAENTRY" CLASS="QUESTION" ><P ><A -NAME="AEN1789" +NAME="AEN1882" ></A ><B >A.4.2. </B @@ -11436,7 +12614,7 @@ CLASS="QANDAENTRY" CLASS="QUESTION" ><P ><A -NAME="AEN1794" +NAME="AEN1887" ></A ><B >A.4.3. </B @@ -11462,7 +12640,7 @@ CLASS="QANDAENTRY" CLASS="QUESTION" ><P ><A -NAME="AEN1799" +NAME="AEN1892" ></A ><B >A.4.4. </B @@ -11485,7 +12663,7 @@ CLASS="QANDAENTRY" CLASS="QUESTION" ><P ><A -NAME="AEN1804" +NAME="AEN1897" ></A ><B >A.4.5. </B @@ -11513,7 +12691,7 @@ CLASS="QANDAENTRY" CLASS="QUESTION" ><P ><A -NAME="AEN1809" +NAME="AEN1902" ></A ><B >A.4.6. </B @@ -11531,6 +12709,15 @@ CLASS="ANSWER" progression states, also require adjusting the program logic to compensate for the change. </P +><P +> There is no GUI for adding fields to Bugzilla at this + time. You can follow development of this feature at + <A +HREF="http://bugzilla.mozilla.org/show_bug.cgi?id=91037" +TARGET="_top" +>http://bugzilla.mozilla.org/show_bug.cgi?id=91037</A +> + </P ></DIV ></DIV ><DIV @@ -11539,7 +12726,7 @@ CLASS="QANDAENTRY" CLASS="QUESTION" ><P ><A -NAME="AEN1814" +NAME="AEN1909" ></A ><B >A.4.7. </B @@ -11553,41 +12740,160 @@ CLASS="ANSWER" ><P ><B > </B -> This was a late-breaking question for the Guide, so I just have to - quote the relevant newsgroup thread on it. - </P +> It's possible to get the footer on the static index page using + Server Side Includes (SSI). The trick to doing this is making + sure that your web server is set up to allow SSI and specifically, + the #exec directive. You should also rename <TT +CLASS="FILENAME" +>index.html</TT +> + to <TT +CLASS="FILENAME" +>index.shtml</TT +>. + </P ><P -CLASS="LITERALLAYOUT" ->> AFAIK, most sites (even if they have SSI enabled) won't have #exec cmd<br> -> enabled. Perhaps what would be better is a #include virtual and a<br> -> footer.cgi the basically has the "require 'CGI.pl' and PutFooter command.<br> -><br> -> Please note that under most configurations, this also requires naming<br> -> the file from index.html to index.shtml (and making sure that it will<br> -> still be reconized as an index). Personally, I think this is better on<br> -> a per-installation basis (perhaps add something to the FAQ that says how<br> -> to do this).<br> -<br> -Good point. Yeah, easy enough to do, that it shouldn't be a big deal for<br> -someone to take it on if they want it. FAQ is a good place for it.<br> -<br> -> Dave Miller wrote:<br> -><br> ->> I did a little experimenting with getting the command menu and footer on<br> ->> the end of the index page while leaving it as an HTML file...<br> ->><br> ->> I was successful. :)<br> ->><br> ->> I added this line:<br> ->><br> ->> <br> ->><br> ->> Just before the </BODY> </HTML> at the end of the file. And it worked.<br> ->><br> ->> Thought I'd toss that out there. Should I check this in? For those that<br> ->> have SSI disabled, it'll act like a comment, so I wouldn't think it would<br> ->> break anything.<br> - </P +> After you've done all that, you can add the following line to + <TT +CLASS="FILENAME" +>index.shtml</TT +>: +<TABLE +BORDER="0" +BGCOLOR="#E0E0E0" +WIDTH="100%" +><TR +><TD +><FONT +COLOR="#000000" +><PRE +CLASS="PROGRAMLISTING" +><!--#exec cmd="/usr/bin/perl -e &quot;require 'CGI.pl'; PutFooter();&quot;" --></PRE +></FONT +></TD +></TR +></TABLE +> + </P +><P +><DIV +CLASS="NOTE" +><P +></P +><TABLE +CLASS="NOTE" +WIDTH="100%" +BORDER="0" +><TR +><TD +WIDTH="25" +ALIGN="CENTER" +VALIGN="TOP" +><IMG +SRC="../images/note.gif" +HSPACE="5" +ALT="Note"></TD +><TD +ALIGN="LEFT" +VALIGN="TOP" +><P +> This line will be replaced with the actual HTML for the footer + when the page is requested, so you should put this line where you + want the footer to appear. + </P +></TD +></TR +></TABLE +></DIV +></P +><P +> Because this method depends on being able to use a #exec directive, + and most ISP's will not allow that, there is an alternative method. + You could have a small script (such as <TT +CLASS="FILENAME" +>api.cgi</TT +>) + that basically looks like: +<TABLE +BORDER="0" +BGCOLOR="#E0E0E0" +WIDTH="100%" +><TR +><TD +><FONT +COLOR="#000000" +><PRE +CLASS="PROGRAMLISTING" +>#!/usr/bonsaitools/bin/perl -w + +require 'globals.pl'; + +if ($::FORM{sub} eq 'PutFooter') { + PutFooter(); +} else { + die 'api.cgi was incorrectly called'; +}</PRE +></FONT +></TD +></TR +></TABLE +> + and then put this line in <TT +CLASS="FILENAME" +>index.shtml</TT +>. +<TABLE +BORDER="0" +BGCOLOR="#E0E0E0" +WIDTH="100%" +><TR +><TD +><FONT +COLOR="#000000" +><PRE +CLASS="PROGRAMLISTING" +><!--#include virtual="api.cgi?sub=PutFooter"--></PRE +></FONT +></TD +></TR +></TABLE +> + </P +><P +> <DIV +CLASS="NOTE" +><P +></P +><TABLE +CLASS="NOTE" +WIDTH="100%" +BORDER="0" +><TR +><TD +WIDTH="25" +ALIGN="CENTER" +VALIGN="TOP" +><IMG +SRC="../images/note.gif" +HSPACE="5" +ALT="Note"></TD +><TD +ALIGN="LEFT" +VALIGN="TOP" +><P +> This still requires being able to use Server Side Includes, if + this simply will not work for you, see <A +HREF="http://bugzilla.mozilla.org/show_bug.cgi?id=80183" +TARGET="_top" +>bug 80183</A +> + for a third option. + </P +></TD +></TR +></TABLE +></DIV +></P ></DIV ></DIV ><DIV @@ -11596,7 +12902,7 @@ CLASS="QANDAENTRY" CLASS="QUESTION" ><P ><A -NAME="AEN1820" +NAME="AEN1931" ></A ><B >A.4.8. </B @@ -11635,7 +12941,7 @@ CLASS="QANDAENTRY" CLASS="QUESTION" ><P ><A -NAME="AEN1828" +NAME="AEN1939" ></A ><B >A.4.9. </B @@ -11660,7 +12966,7 @@ CLASS="QANDAENTRY" CLASS="QUESTION" ><P ><A -NAME="AEN1833" +NAME="AEN1944" ></A ><B >A.4.10. </B @@ -11683,7 +12989,7 @@ CLASS="QANDAENTRY" CLASS="QUESTION" ><P ><A -NAME="AEN1838" +NAME="AEN1949" ></A ><B >A.4.11. </B @@ -11740,7 +13046,7 @@ CLASS="QANDAENTRY" CLASS="QUESTION" ><P ><A -NAME="AEN1845" +NAME="AEN1956" ></A ><B >A.4.12. </B @@ -11767,7 +13073,7 @@ CLASS="QANDAENTRY" CLASS="QUESTION" ><P ><A -NAME="AEN1850" +NAME="AEN1961" ></A ><B >A.4.13. </B @@ -11812,34 +13118,10 @@ CLASS="QANDAENTRY" CLASS="QUESTION" ><P ><A -NAME="AEN1858" +NAME="AEN1969" ></A ><B >A.4.14. </B -> Does Bugzilla allow fields to be added, changed or deleted? If I want to - customize the bug submission form to meet our needs, can I do that using our - terminology? - </P -></DIV -><DIV -CLASS="ANSWER" -><P -><B -> </B -> Yes. - </P -></DIV -></DIV -><DIV -CLASS="QANDAENTRY" -><DIV -CLASS="QUESTION" -><P -><A -NAME="AEN1863" -></A -><B ->A.4.15. </B > Has anyone converted Bugzilla to another language to be used in other countries? Is it localizable? </P @@ -11862,10 +13144,10 @@ CLASS="QANDAENTRY" CLASS="QUESTION" ><P ><A -NAME="AEN1868" +NAME="AEN1974" ></A ><B ->A.4.16. </B +>A.4.15. </B > Can a user create and save reports? Can they do this in Word format? Excel format? </P @@ -11885,10 +13167,10 @@ CLASS="QANDAENTRY" CLASS="QUESTION" ><P ><A -NAME="AEN1873" +NAME="AEN1979" ></A ><B ->A.4.17. </B +>A.4.16. </B > Can a user re-run a report with a new project, same query? </P ></DIV @@ -11907,10 +13189,10 @@ CLASS="QANDAENTRY" CLASS="QUESTION" ><P ><A -NAME="AEN1878" +NAME="AEN1984" ></A ><B ->A.4.18. </B +>A.4.17. </B > Can a user modify an existing report and then save it into another name? </P ></DIV @@ -11930,10 +13212,10 @@ CLASS="QANDAENTRY" CLASS="QUESTION" ><P ><A -NAME="AEN1883" +NAME="AEN1989" ></A ><B ->A.4.19. </B +>A.4.18. </B > Does Bugzilla have the ability to search by word, phrase, compound search? </P @@ -11954,10 +13236,10 @@ CLASS="QANDAENTRY" CLASS="QUESTION" ><P ><A -NAME="AEN1888" +NAME="AEN1994" ></A ><B ->A.4.20. </B +>A.4.19. </B > Can the admin person establish separate group and individual user privileges? </P @@ -11977,10 +13259,10 @@ CLASS="QANDAENTRY" CLASS="QUESTION" ><P ><A -NAME="AEN1893" +NAME="AEN1999" ></A ><B ->A.4.21. </B +>A.4.20. </B > Does Bugzilla provide record locking when there is simultaneous access to the same bug? Does the second person get a notice that the bug is in use or how are they notified? @@ -12002,10 +13284,10 @@ CLASS="QANDAENTRY" CLASS="QUESTION" ><P ><A -NAME="AEN1898" +NAME="AEN2004" ></A ><B ->A.4.22. </B +>A.4.21. </B > Are there any backup features provided? </P ></DIV @@ -12030,10 +13312,10 @@ CLASS="QANDAENTRY" CLASS="QUESTION" ><P ><A -NAME="AEN1904" +NAME="AEN2010" ></A ><B ->A.4.23. </B +>A.4.22. </B > Can users be on the system while a backup is in progress? </P ></DIV @@ -12054,10 +13336,10 @@ CLASS="QANDAENTRY" CLASS="QUESTION" ><P ><A -NAME="AEN1909" +NAME="AEN2015" ></A ><B ->A.4.24. </B +>A.4.23. </B > What type of human resources are needed to be on staff to install and maintain Bugzilla? Specifically, what type of skills does the person need to have? I need to find out if we were to go with Bugzilla, what types of @@ -12093,10 +13375,10 @@ CLASS="QANDAENTRY" CLASS="QUESTION" ><P ><A -NAME="AEN1916" +NAME="AEN2022" ></A ><B ->A.4.25. </B +>A.4.24. </B > What time frame are we looking at if we decide to hire people to install and maintain the Bugzilla? Is this something that takes hours or weeks to install and a couple of hours per week to maintain and customize or is this @@ -12124,10 +13406,10 @@ CLASS="QANDAENTRY" CLASS="QUESTION" ><P ><A -NAME="AEN1921" +NAME="AEN2027" ></A ><B ->A.4.26. </B +>A.4.25. </B > Is there any licensing fee or other fees for using Bugzilla? Any out-of-pocket cost other than the bodies needed as identified above? </P @@ -12156,7 +13438,7 @@ CLASS="QANDAENTRY" CLASS="QUESTION" ><P ><A -NAME="AEN1928" +NAME="AEN2034" ></A ><B >A.5.1. </B @@ -12183,7 +13465,7 @@ CLASS="QANDAENTRY" CLASS="QUESTION" ><P ><A -NAME="AEN1934" +NAME="AEN2040" ></A ><B >A.5.2. </B @@ -12206,7 +13488,7 @@ CLASS="QANDAENTRY" CLASS="QUESTION" ><P ><A -NAME="AEN1939" +NAME="AEN2045" ></A ><B >A.5.3. </B @@ -12236,7 +13518,7 @@ CLASS="QANDAENTRY" CLASS="QUESTION" ><P ><A -NAME="AEN1946" +NAME="AEN2052" ></A ><B >A.6.1. </B @@ -12264,7 +13546,7 @@ CLASS="QANDAENTRY" CLASS="QUESTION" ><P ><A -NAME="AEN1952" +NAME="AEN2058" ></A ><B >A.6.2. </B @@ -12289,7 +13571,7 @@ CLASS="QANDAENTRY" CLASS="QUESTION" ><P ><A -NAME="AEN1957" +NAME="AEN2063" ></A ><B >A.6.3. </B @@ -12323,7 +13605,7 @@ CLASS="QANDAENTRY" CLASS="QUESTION" ><P ><A -NAME="AEN1964" +NAME="AEN2070" ></A ><B >A.7.1. </B @@ -12347,7 +13629,7 @@ CLASS="QANDAENTRY" CLASS="QUESTION" ><P ><A -NAME="AEN1969" +NAME="AEN2075" ></A ><B >A.7.2. </B @@ -12371,7 +13653,7 @@ CLASS="QANDAENTRY" CLASS="QUESTION" ><P ><A -NAME="AEN1974" +NAME="AEN2080" ></A ><B >A.7.3. </B @@ -12401,7 +13683,7 @@ CLASS="QANDAENTRY" CLASS="QUESTION" ><P ><A -NAME="AEN1980" +NAME="AEN2086" ></A ><B >A.7.4. </B @@ -12417,7 +13699,7 @@ CLASS="ANSWER" > You can call bug_email.pl directly from your aliases file, with an entry like this: <A -NAME="AEN1984" +NAME="AEN2090" ></A ><BLOCKQUOTE CLASS="BLOCKQUOTE" @@ -12438,7 +13720,7 @@ CLASS="QANDAENTRY" CLASS="QUESTION" ><P ><A -NAME="AEN1987" +NAME="AEN2093" ></A ><B >A.7.5. </B @@ -12461,7 +13743,7 @@ CLASS="QANDAENTRY" CLASS="QUESTION" ><P ><A -NAME="AEN1992" +NAME="AEN2098" ></A ><B >A.7.6. </B @@ -12476,20 +13758,14 @@ CLASS="ANSWER" > </B > If you are using an alternate Mail Transport Agent (MTA other than sendmail), make sure the options given in the "processmail" script for all - instances of "sendmail" are correct for your MTA. If you are using Sendmail, - you may wish to delete the "-ODeliveryMode=deferred" option in the - "processmail" script for every invocation of "sendmail". (Be sure and leave - the "-t" option, though!) + instances of "sendmail" are correct for your MTA. </P ><P -> A better alternative is to change the "-O" option to - "-ODeliveryMode=background". This prevents Sendmail from hanging your - Bugzilla Perl processes if the domain to which it must send mail - is unavailable. - </P -><P -> This is now a configurable parameter called "sendmailnow", available - from editparams.cgi. +> If you are using Sendmail, try enabling "sendmailnow" in editparams.cgi. + If you are using Postfix, you will also need to enable <SPAN +CLASS="QUOTE" +>"sendmailnow"</SPAN +>. </P ></DIV ></DIV @@ -12499,7 +13775,7 @@ CLASS="QANDAENTRY" CLASS="QUESTION" ><P ><A -NAME="AEN1999" +NAME="AEN2105" ></A ><B >A.7.7. </B @@ -12537,7 +13813,7 @@ CLASS="QANDAENTRY" CLASS="QUESTION" ><P ><A -NAME="AEN2007" +NAME="AEN2113" ></A ><B >A.8.1. </B @@ -12562,7 +13838,7 @@ CLASS="QANDAENTRY" CLASS="QUESTION" ><P ><A -NAME="AEN2012" +NAME="AEN2118" ></A ><B >A.8.2. </B @@ -12597,7 +13873,7 @@ CLASS="QANDAENTRY" CLASS="QUESTION" ><P ><A -NAME="AEN2017" +NAME="AEN2123" ></A ><B >A.8.3. </B @@ -12610,12 +13886,29 @@ CLASS="ANSWER" ><P ><B > </B -> Run the "sanity check" utility (./sanitycheck.cgi in the bugzilla_home - directory) to see! If it all comes back, you're OK. If it doesn't come back - OK (i.e. any red letters), there are certain things Bugzilla can recover - from and certain things it can't. If it can't auto-recover, I hope you're - familiar with mysqladmin commands or have installed another way to manage - your database... +> Run the <SPAN +CLASS="QUOTE" +>"sanity check"</SPAN +> utility + (<TT +CLASS="FILENAME" +>./sanitycheck.cgi</TT +> in the + Bugzilla_home directory) from your web browser to see! If + it finishes without errors, you're + <EM +>probably</EM +> OK. If it doesn't come back + OK (i.e. any red letters), there are certain things + Bugzilla can recover from and certain things it can't. If + it can't auto-recover, I hope you're familiar with + mysqladmin commands or have installed another way to + manage your database. Sanity Check, although it is a good + basic check on your database integrity, by no means is a + substitute for competent database administration and + avoiding deletion of data. It is not exhaustive, and was + created to do a basic check for the most common problems + in Bugzilla databases. </P ></DIV ></DIV @@ -12625,7 +13918,7 @@ CLASS="QANDAENTRY" CLASS="QUESTION" ><P ><A -NAME="AEN2022" +NAME="AEN2131" ></A ><B >A.8.4. </B @@ -12652,7 +13945,7 @@ CLASS="QANDAENTRY" CLASS="QUESTION" ><P ><A -NAME="AEN2027" +NAME="AEN2136" ></A ><B >A.8.5. </B @@ -12676,7 +13969,7 @@ CLASS="QANDAENTRY" CLASS="QUESTION" ><P ><A -NAME="AEN2032" +NAME="AEN2141" ></A ><B >A.8.6. </B @@ -12703,7 +13996,7 @@ CLASS="QANDAENTRY" CLASS="QUESTION" ><P ><A -NAME="AEN2037" +NAME="AEN2146" ></A ><B >A.8.7. </B @@ -12739,7 +14032,7 @@ CLASS="QANDAENTRY" CLASS="QUESTION" ><P ><A -NAME="AEN2044" +NAME="AEN2153" ></A ><B >A.8.8. </B @@ -12765,7 +14058,7 @@ CLASS="QANDAENTRY" CLASS="QUESTION" ><P ><A -NAME="AEN2049" +NAME="AEN2158" ></A ><B >A.8.9. </B @@ -12777,10 +14070,21 @@ CLASS="ANSWER" ><P ><B > </B -> Delete everything from $BUZILLA_HOME/shadow. Bugzilla creates shadow - files there, with each filename corresponding to a - bug number. Also be sure to run syncshadowdb to make sure, if you are using - a shadow database, that the shadow database is current. +> This should only happen with Bugzilla 2.14 if you are + using the <SPAN +CLASS="QUOTE" +>"shadow database"</SPAN +> feature, and your + shadow database is out of sync. Try running + <TT +CLASS="FILENAME" +>syncshadowdb</TT +> + <TT +CLASS="OPTION" +>-syncall</TT +> to make sure your shadow + database is in synch with your primary database. </P ></DIV ></DIV @@ -12798,7 +14102,7 @@ CLASS="QANDAENTRY" CLASS="QUESTION" ><P ><A -NAME="AEN2056" +NAME="AEN2168" ></A ><B >A.9.1. </B @@ -12821,7 +14125,7 @@ CLASS="QANDAENTRY" CLASS="QUESTION" ><P ><A -NAME="AEN2061" +NAME="AEN2173" ></A ><B >A.9.2. </B @@ -12845,7 +14149,7 @@ CLASS="QANDAENTRY" CLASS="QUESTION" ><P ><A -NAME="AEN2066" +NAME="AEN2178" ></A ><B >A.9.3. </B @@ -12866,7 +14170,7 @@ CLASS="ANSWER" ><P > Microsoft has some advice on this matter, as well: <A -NAME="AEN2071" +NAME="AEN2183" ></A ><BLOCKQUOTE CLASS="BLOCKQUOTE" @@ -12891,7 +14195,7 @@ CLASS="QANDAENTRY" CLASS="QUESTION" ><P ><A -NAME="AEN2074" +NAME="AEN2186" ></A ><B >A.9.4. </B @@ -13002,7 +14306,7 @@ CLASS="QANDAENTRY" CLASS="QUESTION" ><P ><A -NAME="AEN2080" +NAME="AEN2192" ></A ><B >A.9.5. </B @@ -13077,7 +14381,7 @@ CLASS="QANDAENTRY" CLASS="QUESTION" ><P ><A -NAME="AEN2101" +NAME="AEN2213" ></A ><B >A.10.1. </B @@ -13105,7 +14409,7 @@ CLASS="QANDAENTRY" CLASS="QUESTION" ><P ><A -NAME="AEN2107" +NAME="AEN2219" ></A ><B >A.10.2. </B @@ -13158,7 +14462,7 @@ CLASS="QANDAENTRY" CLASS="QUESTION" ><P ><A -NAME="AEN2117" +NAME="AEN2229" ></A ><B >A.10.3. </B @@ -13183,7 +14487,7 @@ CLASS="QANDAENTRY" CLASS="QUESTION" ><P ><A -NAME="AEN2122" +NAME="AEN2234" ></A ><B >A.10.4. </B @@ -13208,7 +14512,7 @@ CLASS="QANDAENTRY" CLASS="QUESTION" ><P ><A -NAME="AEN2127" +NAME="AEN2239" ></A ><B >A.10.5. </B @@ -13240,7 +14544,7 @@ CLASS="QANDAENTRY" CLASS="QUESTION" ><P ><A -NAME="AEN2134" +NAME="AEN2246" ></A ><B >A.11.1. </B @@ -13253,20 +14557,20 @@ CLASS="ANSWER" ><B > </B > Try <A -HREF="http://bugzilla.mozilla.org/buglist.cgi?bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&product=Webtools&component=Bugzilla" +HREF="http://bugzilla.mozilla.org/buglist.cgi?bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&product=Bugzilla" TARGET="_top" > this link</A > to view current bugs or requests for enhancement for Bugzilla. </P ><P -> You can view bugs marked for 2.14 release +> You can view bugs marked for 2.16 release <A -HREF="http://bugzilla.mozilla.org/buglist.cgi?product=Webtools&component=Bugzilla&target_milestone=Bugzilla+2.14" +HREF="http://bugzilla.mozilla.org/buglist.cgi?product=Bugzilla&target_milestone=Bugzilla+2.16" TARGET="_top" >here</A >. - This list includes bugs for the 2.14 release that have already + This list includes bugs for the 2.16 release that have already been fixed and checked into CVS. Please consult the <A HREF="http://www.mozilla.org/projects/bugzilla/" @@ -13284,7 +14588,7 @@ CLASS="QANDAENTRY" CLASS="QUESTION" ><P ><A -NAME="AEN2143" +NAME="AEN2255" ></A ><B >A.11.2. </B @@ -13316,7 +14620,7 @@ CLASS="QANDAENTRY" CLASS="QUESTION" ><P ><A -NAME="AEN2149" +NAME="AEN2261" ></A ><B >A.11.3. </B @@ -13334,8 +14638,15 @@ CLASS="ANSWER" TYPE="1" ><LI ><P -> Enter a bug into bugzilla.mozilla.org for the "Webtools" product, - "Bugzilla" component. +> Enter a bug into bugzilla.mozilla.org for the <SPAN +CLASS="QUOTE" +>"<A +HREF="http://bugzilla.mozilla.org/enter_bug.cgi?product=Bugzilla" +TARGET="_top" +>Bugzilla</A +>"</SPAN +> + product. </P ></LI ><LI @@ -13539,7 +14850,7 @@ NAME="DBSCHEMA" CLASS="MEDIAOBJECT" ><P ><IMG -SRC="dbschema.jpg" +SRC="../images/dbschema.jpg" ALT="Database Relationships" ></IMG ><DIV @@ -13624,7 +14935,7 @@ CLASS="SECTION" ><HR><H2 CLASS="SECTION" ><A -NAME="AEN2217" +NAME="AEN2331" >C.2.1. Bugzilla Database Basics</A ></H2 ><P @@ -13747,7 +15058,7 @@ CLASS="SECTION" ><HR><H3 CLASS="SECTION" ><A -NAME="AEN2246" +NAME="AEN2360" >C.2.1.1. Bugzilla Database Tables</A ></H3 ><P @@ -14217,151 +15528,6 @@ http://www.mysql.com/Manual/manual.html.<br> ></DIV ></DIV ><DIV -CLASS="CHAPTER" -><HR><H1 -><A -NAME="VARIANTS" ->Chapter 7. Bugzilla Variants and Competitors</A -></H1 -><P ->I created this section to answer questions about Bugzilla - competitors and variants, then found a wonderful site which covers - an awful lot of what I wanted to discuss. Rather than quote it in - its entirety, I'll simply refer you here: <A -HREF="http://linas.org/linux/pm.html" -TARGET="_top" ->http://linas.org/linux/pm.html</A -></P -><DIV -CLASS="SECTION" -><HR><H1 -CLASS="SECTION" -><A -NAME="RHBUGZILLA" ->7.1. Red Hat Bugzilla</A -></H1 -><P -> Red Hat Bugzilla is probably the most popular Bugzilla variant - on the planet. One of the major benefits of Red Hat Bugzilla is - the ability to work with Oracle, MySQL, and PostGreSQL databases - serving as the back-end, instead of just MySQL. Dave Lawrence - has worked very hard to keep Red Hat Bugzilla up-to-date, and - many people prefer the snappier-looking page layout of Red Hat - Bugzilla to the default Mozilla-standard formatting. - </P -><P ->URL: <A -HREF="http://bugzilla.redhat.com/bugzilla/" -TARGET="_top" ->http://bugzilla.redhat.com/bugzilla/</A -></P -></DIV -><DIV -CLASS="SECTION" -><HR><H1 -CLASS="SECTION" -><A -NAME="VARIANT_FENRIS" ->7.2. Loki Bugzilla (Fenris)</A -></H1 -><P ->Fenris can be found at <A -HREF="http://fenris.lokigames.com/" -TARGET="_top" ->http://fenris.lokigames.com</A ->. It is a fork from Bugzilla.</P -></DIV -><DIV -CLASS="SECTION" -><HR><H1 -CLASS="SECTION" -><A -NAME="VARIANT_ISSUEZILLA" ->7.3. Issuezilla</A -></H1 -><P ->Issuezilla is another fork from Bugzilla, and seems nearly - as popular as the Red Hat Bugzilla fork. Some Issuezilla team - members are regular contributors to the Bugzilla mailing - list/newsgroup. Issuezilla is not the primary focus of - bug-tracking at tigris.org, however. Their Java-based - bug-tracker, <A -HREF="#VARIANT_SCARAB" ->Scarab, a newfangled Java-based issue tracker</A ->, is under heavy development - and looks promising!</P -><P ->URL: <A -HREF="http://issuezilla.tigris.org/servlets/ProjectHome" -TARGET="_top" ->http://issuezilla.tigris.org/servlets/ProjectHome</A -></P -></DIV -><DIV -CLASS="SECTION" -><HR><H1 -CLASS="SECTION" -><A -NAME="VARIANT_SCARAB" ->7.4. Scarab</A -></H1 -><P ->Scarab is a promising new bug-tracking system built using - Java Serlet technology. As of this writing, no source code has - been released as a package, but you can obtain the code from - CVS. - </P -><P ->URL: <A -HREF="http://scarab.tigris.org/" -TARGET="_top" ->http://scarab.tigris.org</A -></P -></DIV -><DIV -CLASS="SECTION" -><HR><H1 -CLASS="SECTION" -><A -NAME="VARIANT_PERFORCE" ->7.5. Perforce SCM</A -></H1 -><P ->Although Perforce isn't really a bug tracker, it can be used - as such through the <SPAN -CLASS="QUOTE" ->"jobs"</SPAN -> functionality.</P -><P -><A -HREF="http://www.perforce.com/perforce/technotes/note052.html" -TARGET="_top" ->http://www.perforce.com/perforce/technotes/note052.html</A ->http://www.perforce.com/perforce/technotes/note052.html</P -></DIV -><DIV -CLASS="SECTION" -><HR><H1 -CLASS="SECTION" -><A -NAME="VARIANT_SOURCEFORGE" ->7.6. SourceForge</A -></H1 -><P ->SourceForge is more of a way of coordinating geographically - distributed free software and open source projects over the - Internet than strictly a bug tracker, but if you're hunting for - bug-tracking for your open project, it may be just what the - software engineer ordered!</P -><P ->URL: <A -HREF="http://www.sourceforge.net" -TARGET="_top" ->http://www.sourceforge.net</A -></P -></DIV -></DIV -><DIV CLASS="APPENDIX" ><HR><H1 ><A @@ -14585,7 +15751,7 @@ CLASS="COMMAND" <DIV CLASS="EXAMPLE" ><A -NAME="AEN2360" +NAME="AEN2439" ></A ><P ><B @@ -14812,6 +15978,110 @@ TARGET="_top" > has details. </P ></DIV +><DIV +CLASS="SECTION" +><HR><H1 +CLASS="SECTION" +><A +NAME="BZHACKING" +>D.5. Hacking Bugzilla</A +></H1 +><P +> What follows are some general guidelines for changing Bugzilla, and adhering to good coding practice while doing so. We've had some checkins in the past which ruined Bugzilla installations because of disregard for these conventions. Sorry for the lack of formatting; I got this info into the Guide on the day of 2.14 release and haven't formatted it yet. + </P +><P +CLASS="LITERALLAYOUT" +><br> +The following is a guide for reviewers when checking code into Bugzilla's<br> +CVS repostory at mozilla.org. If you wish to submit patches to Bugzilla,<br> +you should follow the rules and style conventions below. Any code that<br> +does not adhere to these basic rules will not be added to Bugzilla's<br> +codebase.<br> +<br> + 1. Usage of variables in Regular Expressions<br> +<br> + It is very important that you don't use a variable in a regular<br> + expression unless that variable is supposed to contain an expression.<br> + This especially applies when using grep. You should use:<br> +<br> + grep ($_ eq $value, @array);<br> +<br> + - NOT -<br> +<br> + grep (/$value/, @array);<br> +<br> + If you need to use a non-expression variable inside of an expression, be<br> + sure to quote it properly (using \Q..\E).<br> +<br> +Coding Style for Bugzilla<br> +-------------------------<br> +<br> +While it's true that not all of the code currently in Bugzilla adheres to<br> +this styleguide, it is something that is being worked toward. Therefore,<br> +we ask that all new code (submitted patches and new files) follow this guide<br> +as closely as possible (if you're only changing 1 or 2 lines, you don't have<br> +to reformat the entire file :).<br> +<br> + 1. Whitespace<br> +<br> + Bugzilla's prefered indentation is 4 spaces (no tabs, please).<br> +<br> + 2. Curly braces.<br> +<br> + The opening brace of a block should be on the same line as the statement<br> + that is causing the block and the closing brace should be at the same<br> + indentation level as that statement, for example:<br> +<br> + if ($var) {<br> + print "The variable is true";<br> + } else {<br> + print "Try again";<br> + }<br> +<br> + - NOT -<br> +<br> + if ($var)<br> + {<br> + print "The variable is true";<br> + }<br> + else<br> + {<br> + print "Try again";<br> + }<br> +<br> + 3. File Names<br> +<br> + File names for bugzilla code and support documention should be legal across<br> + multiple platforms. \ / : * ? " < > and | are all illegal characters for<br> + filenames on various platforms. Also, file names should not have spaces in<br> + them as they can cause confusion in CVS and other mozilla.org utilities.<br> +<br> + 4. Variable Names<br> +<br> + If a variable is scoped globally ($::variable) its name should be descriptive<br> + of what it contains. Local variables can be named a bit looser, provided the<br> + context makes their content obvious. For example, $ret could be used as a<br> + staging variable for a routine's return value as the line |return $ret;| will<br> + make it blatently obvious what the variable holds and most likely be shown<br> + on the same screen as |my $ret = "";|.<br> +<br> + 5. Cross Database Compatability<br> +<br> + Bugzilla was originally written to work with MySQL and therefore took advantage<br> + of some of its features that aren't contained in other RDBMS software. These<br> + should be avoided in all new code. Examples of these features are enums and<br> + encrypt().<br> +<br> + 6. Cross Platform Compatability<br> +<br> + While Bugzilla was written to be used on Unix based systems (and Unix/Linux is<br> + still the only officially supported platform) there are many who desire/need to<br> + run Bugzilla on Microsoft Windows boxes. Whenever possible, we should strive<br> + not to make the lives of these people any more complicated and avoid doing things<br> + that break Bugzilla's ability to run on multiple operating systems.<br> +<br> + </P +></DIV ></DIV ><DIV CLASS="APPENDIX" @@ -14823,7 +16093,7 @@ NAME="GFDL" ><P >Version 1.1, March 2000</P ><A -NAME="AEN2416" +NAME="AEN2499" ></A ><BLOCKQUOTE CLASS="BLOCKQUOTE" @@ -15322,7 +16592,7 @@ NAME="GFDL_HOWTO" a copy of the License in the document and put the following copyright and license notices just after the title page:</P ><A -NAME="AEN2506" +NAME="AEN2589" ></A ><BLOCKQUOTE CLASS="BLOCKQUOTE" @@ -15361,7 +16631,7 @@ CLASS="GLOSSDIV" ><H1 CLASS="GLOSSDIV" ><A -NAME="AEN2511" +NAME="AEN2594" >0-9, high ascii</A ></H1 ><DL @@ -15695,7 +16965,7 @@ NAME="GLOSS_P" ><DIV CLASS="EXAMPLE" ><A -NAME="AEN2602" +NAME="AEN2685" ></A ><P ><B diff --git a/docs/html/aboutthisguide.html b/docs/html/aboutthisguide.html index 0d5a74da5..0ed58bd19 100644 --- a/docs/html/aboutthisguide.html +++ b/docs/html/aboutthisguide.html @@ -131,8 +131,8 @@ TARGET="_top" <TT CLASS="EMAIL" ><<A -HREF="mailto:barnboy@NOSPAM.trilobyte.net" ->barnboy@NOSPAM.trilobyte.net</A +HREF="mailto:barnboy@trilobyte.net" +>barnboy@trilobyte.net</A >></TT > to correct them. </P diff --git a/docs/html/bzhacking.html b/docs/html/bzhacking.html new file mode 100644 index 000000000..5bb15b44f --- /dev/null +++ b/docs/html/bzhacking.html @@ -0,0 +1,231 @@ +<HTML +><HEAD +><TITLE +>Hacking Bugzilla</TITLE +><META +NAME="GENERATOR" +CONTENT="Modular DocBook HTML Stylesheet Version 1.61 +"><LINK +REL="HOME" +TITLE="The Bugzilla Guide" +HREF="index.html"><LINK +REL="UP" +TITLE="Useful Patches and Utilities for Bugzilla" +HREF="patches.html"><LINK +REL="PREVIOUS" +TITLE="The Quicksearch Utility" +HREF="quicksearch.html"><LINK +REL="NEXT" +TITLE="GNU Free Documentation License" +HREF="gfdl.html"></HEAD +><BODY +CLASS="SECTION" +BGCOLOR="#FFFFFF" +TEXT="#000000" +LINK="#0000FF" +VLINK="#840084" +ALINK="#0000FF" +><DIV +CLASS="NAVHEADER" +><TABLE +WIDTH="100%" +BORDER="0" +CELLPADDING="0" +CELLSPACING="0" +><TR +><TH +COLSPAN="3" +ALIGN="center" +>The Bugzilla Guide</TH +></TR +><TR +><TD +WIDTH="10%" +ALIGN="left" +VALIGN="bottom" +><A +HREF="quicksearch.html" +>Prev</A +></TD +><TD +WIDTH="80%" +ALIGN="center" +VALIGN="bottom" +>Appendix D. Useful Patches and Utilities for Bugzilla</TD +><TD +WIDTH="10%" +ALIGN="right" +VALIGN="bottom" +><A +HREF="gfdl.html" +>Next</A +></TD +></TR +></TABLE +><HR +ALIGN="LEFT" +WIDTH="100%"></DIV +><DIV +CLASS="SECTION" +><H1 +CLASS="SECTION" +><A +NAME="BZHACKING" +>D.5. Hacking Bugzilla</A +></H1 +><P +> What follows are some general guidelines for changing Bugzilla, and adhering to good coding practice while doing so. We've had some checkins in the past which ruined Bugzilla installations because of disregard for these conventions. Sorry for the lack of formatting; I got this info into the Guide on the day of 2.14 release and haven't formatted it yet. + </P +><P +CLASS="LITERALLAYOUT" +><br> +The following is a guide for reviewers when checking code into Bugzilla's<br> +CVS repostory at mozilla.org. If you wish to submit patches to Bugzilla,<br> +you should follow the rules and style conventions below. Any code that<br> +does not adhere to these basic rules will not be added to Bugzilla's<br> +codebase.<br> +<br> + 1. Usage of variables in Regular Expressions<br> +<br> + It is very important that you don't use a variable in a regular<br> + expression unless that variable is supposed to contain an expression.<br> + This especially applies when using grep. You should use:<br> +<br> + grep ($_ eq $value, @array);<br> +<br> + - NOT -<br> +<br> + grep (/$value/, @array);<br> +<br> + If you need to use a non-expression variable inside of an expression, be<br> + sure to quote it properly (using \Q..\E).<br> +<br> +Coding Style for Bugzilla<br> +-------------------------<br> +<br> +While it's true that not all of the code currently in Bugzilla adheres to<br> +this styleguide, it is something that is being worked toward. Therefore,<br> +we ask that all new code (submitted patches and new files) follow this guide<br> +as closely as possible (if you're only changing 1 or 2 lines, you don't have<br> +to reformat the entire file :).<br> +<br> + 1. Whitespace<br> +<br> + Bugzilla's prefered indentation is 4 spaces (no tabs, please).<br> +<br> + 2. Curly braces.<br> +<br> + The opening brace of a block should be on the same line as the statement<br> + that is causing the block and the closing brace should be at the same<br> + indentation level as that statement, for example:<br> +<br> + if ($var) {<br> + print "The variable is true";<br> + } else {<br> + print "Try again";<br> + }<br> +<br> + - NOT -<br> +<br> + if ($var)<br> + {<br> + print "The variable is true";<br> + }<br> + else<br> + {<br> + print "Try again";<br> + }<br> +<br> + 3. File Names<br> +<br> + File names for bugzilla code and support documention should be legal across<br> + multiple platforms. \ / : * ? " < > and | are all illegal characters for<br> + filenames on various platforms. Also, file names should not have spaces in<br> + them as they can cause confusion in CVS and other mozilla.org utilities.<br> +<br> + 4. Variable Names<br> +<br> + If a variable is scoped globally ($::variable) its name should be descriptive<br> + of what it contains. Local variables can be named a bit looser, provided the<br> + context makes their content obvious. For example, $ret could be used as a<br> + staging variable for a routine's return value as the line |return $ret;| will<br> + make it blatently obvious what the variable holds and most likely be shown<br> + on the same screen as |my $ret = "";|.<br> +<br> + 5. Cross Database Compatability<br> +<br> + Bugzilla was originally written to work with MySQL and therefore took advantage<br> + of some of its features that aren't contained in other RDBMS software. These<br> + should be avoided in all new code. Examples of these features are enums and<br> + encrypt().<br> +<br> + 6. Cross Platform Compatability<br> +<br> + While Bugzilla was written to be used on Unix based systems (and Unix/Linux is<br> + still the only officially supported platform) there are many who desire/need to<br> + run Bugzilla on Microsoft Windows boxes. Whenever possible, we should strive<br> + not to make the lives of these people any more complicated and avoid doing things<br> + that break Bugzilla's ability to run on multiple operating systems.<br> +<br> + </P +></DIV +><DIV +CLASS="NAVFOOTER" +><HR +ALIGN="LEFT" +WIDTH="100%"><TABLE +WIDTH="100%" +BORDER="0" +CELLPADDING="0" +CELLSPACING="0" +><TR +><TD +WIDTH="33%" +ALIGN="left" +VALIGN="top" +><A +HREF="quicksearch.html" +>Prev</A +></TD +><TD +WIDTH="34%" +ALIGN="center" +VALIGN="top" +><A +HREF="index.html" +>Home</A +></TD +><TD +WIDTH="33%" +ALIGN="right" +VALIGN="top" +><A +HREF="gfdl.html" +>Next</A +></TD +></TR +><TR +><TD +WIDTH="33%" +ALIGN="left" +VALIGN="top" +>The Quicksearch Utility</TD +><TD +WIDTH="34%" +ALIGN="center" +VALIGN="top" +><A +HREF="patches.html" +>Up</A +></TD +><TD +WIDTH="33%" +ALIGN="right" +VALIGN="top" +>GNU Free Documentation License</TD +></TR +></TABLE +></DIV +></BODY +></HTML +>
\ No newline at end of file diff --git a/docs/html/contributors.html b/docs/html/contributors.html index 8a867fca4..6b87af19c 100644 --- a/docs/html/contributors.html +++ b/docs/html/contributors.html @@ -78,7 +78,8 @@ NAME="CONTRIBUTORS" documentation (in no particular order): </P ><P -> Andrew Pearson, Spencer Smith, Eric Hanson, Kevin Brannen, Ron Teitelbaum +> Andrew Pearson, Spencer Smith, Eric Hanson, Kevin Brannen, Ron + Teitelbaum, Jacob Steenhagen, Joe Robins </P ></DIV ><DIV diff --git a/docs/html/copyright.html b/docs/html/copyright.html index e3de39020..f480206d2 100644 --- a/docs/html/copyright.html +++ b/docs/html/copyright.html @@ -122,8 +122,7 @@ WIDTH="10%" ><P > If you have any questions regarding this document, its copyright, or publishing this document in non-electronic form, - please contact Matthew P. Barnson. Remove "NOSPAM" from email address - to send. + please contact Matthew P. Barnson. </P ></DIV ><DIV diff --git a/docs/html/credits.html b/docs/html/credits.html index 7081514ea..1c177276b 100644 --- a/docs/html/credits.html +++ b/docs/html/credits.html @@ -85,8 +85,8 @@ HREF="mailto://terry@mozilla.org" TARGET="_top" >Terry Weissman</A > - for initially converting Bugzilla from BugSplat! and writing the - README upon which this documentation is largely based. + for initially writing Bugzilla and creating the + README upon which the UNIX installation documentation is largely based. </P ><P > <A diff --git a/docs/html/cvs.html b/docs/html/cvs.html index 55eb0a261..47dbc8940 100644 --- a/docs/html/cvs.html +++ b/docs/html/cvs.html @@ -91,6 +91,20 @@ CLASS="QUOTE" an @resolution field, you can even change the Bugzilla bug state. </P +><P +> There is also a project, based upon somewhat dated Bugzilla + code, to integrate CVS and Bugzilla through CVS' ability to + email. Check it out at: + <A +HREF="http://homepages.kcbbs.gen.nz/~tonyg/" +TARGET="_top" +> http://homepages.kcbbs.gen.nz/~tonyg/</A +>, under the + <SPAN +CLASS="QUOTE" +>"cvszilla"</SPAN +> link. + </P ></DIV ><DIV CLASS="NAVFOOTER" diff --git a/docs/html/dbdoc.html b/docs/html/dbdoc.html index a28d1f91f..44ea6aa60 100644 --- a/docs/html/dbdoc.html +++ b/docs/html/dbdoc.html @@ -137,7 +137,7 @@ CLASS="SECTION" ><H2 CLASS="SECTION" ><A -NAME="AEN2217" +NAME="AEN2331" >C.2.1. Bugzilla Database Basics</A ></H2 ><P @@ -260,7 +260,7 @@ CLASS="SECTION" ><H3 CLASS="SECTION" ><A -NAME="AEN2246" +NAME="AEN2360" >C.2.1.1. Bugzilla Database Tables</A ></H3 ><P diff --git a/docs/html/dbschema.html b/docs/html/dbschema.html index 3cecb843f..36f51014d 100644 --- a/docs/html/dbschema.html +++ b/docs/html/dbschema.html @@ -78,7 +78,7 @@ NAME="DBSCHEMA" CLASS="MEDIAOBJECT" ><P ><IMG -SRC="dbschema.jpg" +SRC="../images/dbschema.jpg" ALT="Database Relationships" ></IMG ><DIV diff --git a/docs/html/faq.html b/docs/html/faq.html index 0765b564a..eea2d6b3d 100644 --- a/docs/html/faq.html +++ b/docs/html/faq.html @@ -10,8 +10,8 @@ REL="HOME" TITLE="The Bugzilla Guide" HREF="index.html"><LINK REL="PREVIOUS" -TITLE="The Future of Bugzilla" -HREF="future.html"><LINK +TITLE="SourceForge" +HREF="variant_sourceforge.html"><LINK REL="NEXT" TITLE="Software Download Links" HREF="downloadlinks.html"></HEAD @@ -41,7 +41,7 @@ WIDTH="10%" ALIGN="left" VALIGN="bottom" ><A -HREF="future.html" +HREF="variant_sourceforge.html" >Prev</A ></TD ><TD @@ -81,63 +81,63 @@ HREF="faq.html#FAQ_GENERAL" ><DL ><DT >A.1.1. <A -HREF="faq.html#AEN1620" +HREF="faq.html#AEN1713" > Where can I find information about Bugzilla?</A ></DT ><DT >A.1.2. <A -HREF="faq.html#AEN1626" +HREF="faq.html#AEN1719" > What license is Bugzilla distributed under? </A ></DT ><DT >A.1.3. <A -HREF="faq.html#AEN1632" +HREF="faq.html#AEN1725" > How do I get commercial support for Bugzilla? </A ></DT ><DT >A.1.4. <A -HREF="faq.html#AEN1639" +HREF="faq.html#AEN1732" > What major companies or projects are currently using Bugzilla for bug-tracking? </A ></DT ><DT >A.1.5. <A -HREF="faq.html#AEN1664" +HREF="faq.html#AEN1757" > Who maintains Bugzilla? </A ></DT ><DT >A.1.6. <A -HREF="faq.html#AEN1670" +HREF="faq.html#AEN1763" > How does Bugzilla stack up against other bug-tracking databases? </A ></DT ><DT >A.1.7. <A -HREF="faq.html#AEN1677" +HREF="faq.html#AEN1770" > How do I change my user name in Bugzilla? </A ></DT ><DT >A.1.8. <A -HREF="faq.html#AEN1682" +HREF="faq.html#AEN1775" > Why doesn't Bugzilla offer this or that feature or compatability with this other tracking software? </A ></DT ><DT >A.1.9. <A -HREF="faq.html#AEN1689" +HREF="faq.html#AEN1782" > Why MySQL? I'm interested in seeing Bugzilla run on Oracle/Sybase/Msql/PostgreSQL/MSSQL? </A ></DT ><DT >A.1.10. <A -HREF="faq.html#AEN1707" +HREF="faq.html#AEN1800" > Why do the scripts say "/usr/bonsaitools/bin/perl" instead of "/usr/bin/perl" or something else? </A @@ -153,19 +153,19 @@ HREF="faq.html#FAQ_REDHAT" ><DL ><DT >A.2.1. <A -HREF="faq.html#AEN1724" +HREF="faq.html#AEN1817" > What about Red Hat Bugzilla? </A ></DT ><DT >A.2.2. <A -HREF="faq.html#AEN1732" +HREF="faq.html#AEN1825" > What are the primary benefits of Red Hat Bugzilla? </A ></DT ><DT >A.2.3. <A -HREF="faq.html#AEN1760" +HREF="faq.html#AEN1853" > What's the current status of Red Hat Bugzilla? </A ></DT @@ -180,7 +180,7 @@ HREF="faq.html#FAQ_LOKI" ><DL ><DT >A.3.1. <A -HREF="faq.html#AEN1773" +HREF="faq.html#AEN1866" > What is Loki Bugzilla (Fenris)? </A ></DT @@ -195,41 +195,41 @@ HREF="faq.html#FAQ_PHB" ><DL ><DT >A.4.1. <A -HREF="faq.html#AEN1784" +HREF="faq.html#AEN1877" > Is Bugzilla web-based or do you have to have specific software or specific operating system on your machine? </A ></DT ><DT >A.4.2. <A -HREF="faq.html#AEN1789" +HREF="faq.html#AEN1882" > Has anyone you know of already done any Bugzilla integration with Perforce (SCM software)? </A ></DT ><DT >A.4.3. <A -HREF="faq.html#AEN1794" +HREF="faq.html#AEN1887" > Does Bugzilla allow the user to track multiple projects? </A ></DT ><DT >A.4.4. <A -HREF="faq.html#AEN1799" +HREF="faq.html#AEN1892" > If I am on many projects, and search for all bugs assigned to me, will Bugzilla list them for me and allow me to sort by project, severity etc? </A ></DT ><DT >A.4.5. <A -HREF="faq.html#AEN1804" +HREF="faq.html#AEN1897" > Does Bugzilla allow attachments (text, screenshots, urls etc)? If yes, are there any that are NOT allowed? </A ></DT ><DT >A.4.6. <A -HREF="faq.html#AEN1809" +HREF="faq.html#AEN1902" > Does Bugzilla allow us to define our own priorities and levels? Do we have complete freedom to change the labels of fields and format of them, and the choice of acceptable values? @@ -237,7 +237,7 @@ HREF="faq.html#AEN1809" ></DT ><DT >A.4.7. <A -HREF="faq.html#AEN1814" +HREF="faq.html#AEN1909" > The index.html page doesn't show the footer. It's really annoying to have to go to the querypage just to check my "my bugs" link. How do I get a footer on static HTML pages? @@ -245,35 +245,35 @@ HREF="faq.html#AEN1814" ></DT ><DT >A.4.8. <A -HREF="faq.html#AEN1820" +HREF="faq.html#AEN1931" > Does Bugzilla provide any reporting features, metrics, graphs, etc? You know, the type of stuff that management likes to see. :) </A ></DT ><DT >A.4.9. <A -HREF="faq.html#AEN1828" +HREF="faq.html#AEN1939" > Is there email notification and if so, what do you see when you get an email? Do you see bug number and title or is it only the number? </A ></DT ><DT >A.4.10. <A -HREF="faq.html#AEN1833" +HREF="faq.html#AEN1944" > Can email notification be set up to send to multiple people, some on the To List, CC List, BCC List etc? </A ></DT ><DT >A.4.11. <A -HREF="faq.html#AEN1838" +HREF="faq.html#AEN1949" > If there is email notification, do users have to have any particular type of email application? </A ></DT ><DT >A.4.12. <A -HREF="faq.html#AEN1845" +HREF="faq.html#AEN1956" > If I just wanted to track certain bugs, as they go through life, can I set it up to alert me via email whenever that bug changes, whether it be owner, status or description etc.? @@ -281,7 +281,7 @@ HREF="faq.html#AEN1845" ></DT ><DT >A.4.13. <A -HREF="faq.html#AEN1850" +HREF="faq.html#AEN1961" > Does Bugzilla allow data to be imported and exported? If I had outsiders write up a bug report using a MS Word bug template, could that template be imported into "matching" fields? If I wanted to take the results of a query @@ -290,75 +290,67 @@ HREF="faq.html#AEN1850" ></DT ><DT >A.4.14. <A -HREF="faq.html#AEN1858" -> Does Bugzilla allow fields to be added, changed or deleted? If I want to - customize the bug submission form to meet our needs, can I do that using our - terminology? - </A -></DT -><DT ->A.4.15. <A -HREF="faq.html#AEN1863" +HREF="faq.html#AEN1969" > Has anyone converted Bugzilla to another language to be used in other countries? Is it localizable? </A ></DT ><DT ->A.4.16. <A -HREF="faq.html#AEN1868" +>A.4.15. <A +HREF="faq.html#AEN1974" > Can a user create and save reports? Can they do this in Word format? Excel format? </A ></DT ><DT ->A.4.17. <A -HREF="faq.html#AEN1873" +>A.4.16. <A +HREF="faq.html#AEN1979" > Can a user re-run a report with a new project, same query? </A ></DT ><DT ->A.4.18. <A -HREF="faq.html#AEN1878" +>A.4.17. <A +HREF="faq.html#AEN1984" > Can a user modify an existing report and then save it into another name? </A ></DT ><DT ->A.4.19. <A -HREF="faq.html#AEN1883" +>A.4.18. <A +HREF="faq.html#AEN1989" > Does Bugzilla have the ability to search by word, phrase, compound search? </A ></DT ><DT ->A.4.20. <A -HREF="faq.html#AEN1888" +>A.4.19. <A +HREF="faq.html#AEN1994" > Can the admin person establish separate group and individual user privileges? </A ></DT ><DT ->A.4.21. <A -HREF="faq.html#AEN1893" +>A.4.20. <A +HREF="faq.html#AEN1999" > Does Bugzilla provide record locking when there is simultaneous access to the same bug? Does the second person get a notice that the bug is in use or how are they notified? </A ></DT ><DT ->A.4.22. <A -HREF="faq.html#AEN1898" +>A.4.21. <A +HREF="faq.html#AEN2004" > Are there any backup features provided? </A ></DT ><DT ->A.4.23. <A -HREF="faq.html#AEN1904" +>A.4.22. <A +HREF="faq.html#AEN2010" > Can users be on the system while a backup is in progress? </A ></DT ><DT ->A.4.24. <A -HREF="faq.html#AEN1909" +>A.4.23. <A +HREF="faq.html#AEN2015" > What type of human resources are needed to be on staff to install and maintain Bugzilla? Specifically, what type of skills does the person need to have? I need to find out if we were to go with Bugzilla, what types of @@ -367,8 +359,8 @@ HREF="faq.html#AEN1909" </A ></DT ><DT ->A.4.25. <A -HREF="faq.html#AEN1916" +>A.4.24. <A +HREF="faq.html#AEN2022" > What time frame are we looking at if we decide to hire people to install and maintain the Bugzilla? Is this something that takes hours or weeks to install and a couple of hours per week to maintain and customize or is this @@ -377,8 +369,8 @@ HREF="faq.html#AEN1916" </A ></DT ><DT ->A.4.26. <A -HREF="faq.html#AEN1921" +>A.4.25. <A +HREF="faq.html#AEN2027" > Is there any licensing fee or other fees for using Bugzilla? Any out-of-pocket cost other than the bodies needed as identified above? </A @@ -394,19 +386,19 @@ HREF="faq.html#FAQ_INSTALL" ><DL ><DT >A.5.1. <A -HREF="faq.html#AEN1928" +HREF="faq.html#AEN2034" > How do I download and install Bugzilla? </A ></DT ><DT >A.5.2. <A -HREF="faq.html#AEN1934" +HREF="faq.html#AEN2040" > How do I install Bugzilla on Windows NT? </A ></DT ><DT >A.5.3. <A -HREF="faq.html#AEN1939" +HREF="faq.html#AEN2045" > Is there an easy way to change the Bugzilla cookie name? </A ></DT @@ -421,20 +413,20 @@ HREF="faq.html#FAQ_SECURITY" ><DL ><DT >A.6.1. <A -HREF="faq.html#AEN1946" +HREF="faq.html#AEN2052" > How do I completely disable MySQL security if it's giving me problems (I've followed the instructions in the installation section of this guide!)? </A ></DT ><DT >A.6.2. <A -HREF="faq.html#AEN1952" +HREF="faq.html#AEN2058" > Are there any security problems with Bugzilla? </A ></DT ><DT >A.6.3. <A -HREF="faq.html#AEN1957" +HREF="faq.html#AEN2063" > I've implemented the security fixes mentioned in Chris Yeh's security advisory of 5/10/2000 advising not to run MySQL as root, and am running into problems with MySQL no longer working correctly. @@ -451,48 +443,48 @@ HREF="faq.html#FAQ_EMAIL" ><DL ><DT >A.7.1. <A -HREF="faq.html#AEN1964" +HREF="faq.html#AEN2070" > I have a user who doesn't want to receive any more email from Bugzilla. How do I stop it entirely for this user? </A ></DT ><DT >A.7.2. <A -HREF="faq.html#AEN1969" +HREF="faq.html#AEN2075" > I'm evaluating/testing Bugzilla, and don't want it to send email to anyone but me. How do I do it? </A ></DT ><DT >A.7.3. <A -HREF="faq.html#AEN1974" +HREF="faq.html#AEN2080" > I want whineatnews.pl to whine at something more, or other than, only new bugs. How do I do it? </A ></DT ><DT >A.7.4. <A -HREF="faq.html#AEN1980" +HREF="faq.html#AEN2086" > I don't like/want to use Procmail to hand mail off to bug_email.pl. What alternatives do I have? </A ></DT ><DT >A.7.5. <A -HREF="faq.html#AEN1987" +HREF="faq.html#AEN2093" > How do I set up the email interface to submit/change bugs via email? </A ></DT ><DT >A.7.6. <A -HREF="faq.html#AEN1992" +HREF="faq.html#AEN2098" > Email takes FOREVER to reach me from bugzilla -- it's extremely slow. What gives? </A ></DT ><DT >A.7.7. <A -HREF="faq.html#AEN1999" +HREF="faq.html#AEN2105" > How come email never reaches me from bugzilla changes? </A ></DT @@ -507,60 +499,60 @@ HREF="faq.html#FAQ_DB" ><DL ><DT >A.8.1. <A -HREF="faq.html#AEN2007" +HREF="faq.html#AEN2113" > I've heard Bugzilla can be used with Oracle? </A ></DT ><DT >A.8.2. <A -HREF="faq.html#AEN2012" +HREF="faq.html#AEN2118" > Bugs are missing from queries, but exist in the database (and I can pull them up by specifying the bug ID). What's wrong? </A ></DT ><DT >A.8.3. <A -HREF="faq.html#AEN2017" +HREF="faq.html#AEN2123" > I think my database might be corrupted, or contain invalid entries. What do I do? </A ></DT ><DT >A.8.4. <A -HREF="faq.html#AEN2022" +HREF="faq.html#AEN2131" > I want to manually edit some entries in my database. How? </A ></DT ><DT >A.8.5. <A -HREF="faq.html#AEN2027" +HREF="faq.html#AEN2136" > I try to add myself as a user, but Bugzilla always tells me my password is wrong. </A ></DT ><DT >A.8.6. <A -HREF="faq.html#AEN2032" +HREF="faq.html#AEN2141" > I think I've set up MySQL permissions correctly, but bugzilla still can't connect. </A ></DT ><DT >A.8.7. <A -HREF="faq.html#AEN2037" +HREF="faq.html#AEN2146" > How do I synchronize bug information among multiple different Bugzilla databases? </A ></DT ><DT >A.8.8. <A -HREF="faq.html#AEN2044" +HREF="faq.html#AEN2153" > Why do I get bizarre errors when trying to submit data, particularly problems with "groupset"? </A ></DT ><DT >A.8.9. <A -HREF="faq.html#AEN2049" +HREF="faq.html#AEN2158" > How come even after I delete bugs, the long descriptions show up? </A ></DT @@ -575,32 +567,32 @@ HREF="faq.html#FAQ_NT" ><DL ><DT >A.9.1. <A -HREF="faq.html#AEN2056" +HREF="faq.html#AEN2168" > What is the easiest way to run Bugzilla on Win32 (Win98+/NT/2K)? </A ></DT ><DT >A.9.2. <A -HREF="faq.html#AEN2061" +HREF="faq.html#AEN2173" > Is there a "Bundle::Bugzilla" equivalent for Win32? </A ></DT ><DT >A.9.3. <A -HREF="faq.html#AEN2066" +HREF="faq.html#AEN2178" > CGI's are failing with a "something.cgi is not a valid Windows NT application" error. Why? </A ></DT ><DT >A.9.4. <A -HREF="faq.html#AEN2074" +HREF="faq.html#AEN2186" > Can I have some general instructions on how to make Bugzilla on Win32 work? </A ></DT ><DT >A.9.5. <A -HREF="faq.html#AEN2080" +HREF="faq.html#AEN2192" > I'm having trouble with the perl modules for NT not being able to talk to to the database. </A @@ -616,34 +608,34 @@ HREF="faq.html#FAQ_USE" ><DL ><DT >A.10.1. <A -HREF="faq.html#AEN2101" +HREF="faq.html#AEN2213" > The query page is very confusing. Isn't there a simpler way to query? </A ></DT ><DT >A.10.2. <A -HREF="faq.html#AEN2107" +HREF="faq.html#AEN2219" > I'm confused by the behavior of the "accept" button in the Show Bug form. Why doesn't it assign the bug to me when I accept it? </A ></DT ><DT >A.10.3. <A -HREF="faq.html#AEN2117" +HREF="faq.html#AEN2229" > I can't upload anything into the database via the "Create Attachment" link. What am I doing wrong? </A ></DT ><DT >A.10.4. <A -HREF="faq.html#AEN2122" +HREF="faq.html#AEN2234" > Email submissions to Bugzilla that have attachments end up asking me to save it as a "cgi" file. </A ></DT ><DT >A.10.5. <A -HREF="faq.html#AEN2127" +HREF="faq.html#AEN2239" > How do I change a keyword in Bugzilla, once some bugs are using it? </A ></DT @@ -658,20 +650,20 @@ HREF="faq.html#FAQ_HACKING" ><DL ><DT >A.11.1. <A -HREF="faq.html#AEN2134" +HREF="faq.html#AEN2246" > What bugs are in Bugzilla right now? </A ></DT ><DT >A.11.2. <A -HREF="faq.html#AEN2143" +HREF="faq.html#AEN2255" > How can I change the default priority to a null value? For instance, have the default priority be "---" instead of "P2"? </A ></DT ><DT >A.11.3. <A -HREF="faq.html#AEN2149" +HREF="faq.html#AEN2261" > What's the best way to submit patches? What guidelines should I follow? </A ></DT @@ -691,7 +683,7 @@ CLASS="QANDAENTRY" CLASS="QUESTION" ><P ><A -NAME="AEN1620" +NAME="AEN1713" ></A ><B >A.1.1. </B @@ -717,7 +709,7 @@ CLASS="QANDAENTRY" CLASS="QUESTION" ><P ><A -NAME="AEN1626" +NAME="AEN1719" ></A ><B >A.1.2. </B @@ -744,7 +736,7 @@ CLASS="QANDAENTRY" CLASS="QUESTION" ><P ><A -NAME="AEN1632" +NAME="AEN1725" ></A ><B >A.1.3. </B @@ -779,7 +771,7 @@ CLASS="QANDAENTRY" CLASS="QUESTION" ><P ><A -NAME="AEN1639" +NAME="AEN1732" ></A ><B >A.1.4. </B @@ -887,7 +879,7 @@ CLASS="QANDAENTRY" CLASS="QUESTION" ><P ><A -NAME="AEN1664" +NAME="AEN1757" ></A ><B >A.1.5. </B @@ -914,7 +906,7 @@ CLASS="QANDAENTRY" CLASS="QUESTION" ><P ><A -NAME="AEN1670" +NAME="AEN1763" ></A ><B >A.1.6. </B @@ -953,7 +945,7 @@ CLASS="QANDAENTRY" CLASS="QUESTION" ><P ><A -NAME="AEN1677" +NAME="AEN1770" ></A ><B >A.1.7. </B @@ -976,7 +968,7 @@ CLASS="QANDAENTRY" CLASS="QUESTION" ><P ><A -NAME="AEN1682" +NAME="AEN1775" ></A ><B >A.1.8. </B @@ -1014,7 +1006,7 @@ CLASS="QANDAENTRY" CLASS="QUESTION" ><P ><A -NAME="AEN1689" +NAME="AEN1782" ></A ><B >A.1.9. </B @@ -1029,7 +1021,7 @@ CLASS="ANSWER" > </B >Terry Weissman answers, <A -NAME="AEN1693" +NAME="AEN1786" ></A ><BLOCKQUOTE CLASS="BLOCKQUOTE" @@ -1105,7 +1097,7 @@ CLASS="QANDAENTRY" CLASS="QUESTION" ><P ><A -NAME="AEN1707" +NAME="AEN1800" ></A ><B >A.1.10. </B @@ -1125,7 +1117,7 @@ CLASS="ANSWER" ><P > Here's Terry Weissman's comment, for some historical context: <A -NAME="AEN1712" +NAME="AEN1805" ></A ><BLOCKQUOTE CLASS="BLOCKQUOTE" @@ -1222,7 +1214,7 @@ CLASS="QANDAENTRY" CLASS="QUESTION" ><P ><A -NAME="AEN1724" +NAME="AEN1817" ></A ><B >A.2.1. </B @@ -1246,7 +1238,7 @@ CLASS="ANSWER" ><P > Dave Lawrence, the original Red Hat Bugzilla maintainer, mentions: <A -NAME="AEN1729" +NAME="AEN1822" ></A ><BLOCKQUOTE CLASS="BLOCKQUOTE" @@ -1269,7 +1261,7 @@ CLASS="QANDAENTRY" CLASS="QUESTION" ><P ><A -NAME="AEN1732" +NAME="AEN1825" ></A ><B >A.2.2. </B @@ -1285,7 +1277,7 @@ CLASS="ANSWER" >Dave Lawrence</EM >: <A -NAME="AEN1737" +NAME="AEN1830" ></A ><BLOCKQUOTE CLASS="BLOCKQUOTE" @@ -1401,7 +1393,7 @@ CLASS="QANDAENTRY" CLASS="QUESTION" ><P ><A -NAME="AEN1760" +NAME="AEN1853" ></A ><B >A.2.3. </B @@ -1447,7 +1439,7 @@ VALIGN="TOP" >Dave Lawrence</EM >: <A -NAME="AEN1767" +NAME="AEN1860" ></A ><BLOCKQUOTE CLASS="BLOCKQUOTE" @@ -1516,7 +1508,7 @@ CLASS="QANDAENTRY" CLASS="QUESTION" ><P ><A -NAME="AEN1773" +NAME="AEN1866" ></A ><B >A.3.1. </B @@ -1582,7 +1574,7 @@ CLASS="QANDAENTRY" CLASS="QUESTION" ><P ><A -NAME="AEN1784" +NAME="AEN1877" ></A ><B >A.4.1. </B @@ -1606,7 +1598,7 @@ CLASS="QANDAENTRY" CLASS="QUESTION" ><P ><A -NAME="AEN1789" +NAME="AEN1882" ></A ><B >A.4.2. </B @@ -1630,7 +1622,7 @@ CLASS="QANDAENTRY" CLASS="QUESTION" ><P ><A -NAME="AEN1794" +NAME="AEN1887" ></A ><B >A.4.3. </B @@ -1656,7 +1648,7 @@ CLASS="QANDAENTRY" CLASS="QUESTION" ><P ><A -NAME="AEN1799" +NAME="AEN1892" ></A ><B >A.4.4. </B @@ -1679,7 +1671,7 @@ CLASS="QANDAENTRY" CLASS="QUESTION" ><P ><A -NAME="AEN1804" +NAME="AEN1897" ></A ><B >A.4.5. </B @@ -1707,7 +1699,7 @@ CLASS="QANDAENTRY" CLASS="QUESTION" ><P ><A -NAME="AEN1809" +NAME="AEN1902" ></A ><B >A.4.6. </B @@ -1725,6 +1717,15 @@ CLASS="ANSWER" progression states, also require adjusting the program logic to compensate for the change. </P +><P +> There is no GUI for adding fields to Bugzilla at this + time. You can follow development of this feature at + <A +HREF="http://bugzilla.mozilla.org/show_bug.cgi?id=91037" +TARGET="_top" +>http://bugzilla.mozilla.org/show_bug.cgi?id=91037</A +> + </P ></DIV ></DIV ><DIV @@ -1733,7 +1734,7 @@ CLASS="QANDAENTRY" CLASS="QUESTION" ><P ><A -NAME="AEN1814" +NAME="AEN1909" ></A ><B >A.4.7. </B @@ -1747,41 +1748,160 @@ CLASS="ANSWER" ><P ><B > </B -> This was a late-breaking question for the Guide, so I just have to - quote the relevant newsgroup thread on it. - </P +> It's possible to get the footer on the static index page using + Server Side Includes (SSI). The trick to doing this is making + sure that your web server is set up to allow SSI and specifically, + the #exec directive. You should also rename <TT +CLASS="FILENAME" +>index.html</TT +> + to <TT +CLASS="FILENAME" +>index.shtml</TT +>. + </P ><P -CLASS="LITERALLAYOUT" ->> AFAIK, most sites (even if they have SSI enabled) won't have #exec cmd<br> -> enabled. Perhaps what would be better is a #include virtual and a<br> -> footer.cgi the basically has the "require 'CGI.pl' and PutFooter command.<br> -><br> -> Please note that under most configurations, this also requires naming<br> -> the file from index.html to index.shtml (and making sure that it will<br> -> still be reconized as an index). Personally, I think this is better on<br> -> a per-installation basis (perhaps add something to the FAQ that says how<br> -> to do this).<br> -<br> -Good point. Yeah, easy enough to do, that it shouldn't be a big deal for<br> -someone to take it on if they want it. FAQ is a good place for it.<br> -<br> -> Dave Miller wrote:<br> -><br> ->> I did a little experimenting with getting the command menu and footer on<br> ->> the end of the index page while leaving it as an HTML file...<br> ->><br> ->> I was successful. :)<br> ->><br> ->> I added this line:<br> ->><br> ->> <br> ->><br> ->> Just before the </BODY> </HTML> at the end of the file. And it worked.<br> ->><br> ->> Thought I'd toss that out there. Should I check this in? For those that<br> ->> have SSI disabled, it'll act like a comment, so I wouldn't think it would<br> ->> break anything.<br> - </P +> After you've done all that, you can add the following line to + <TT +CLASS="FILENAME" +>index.shtml</TT +>: +<TABLE +BORDER="0" +BGCOLOR="#E0E0E0" +WIDTH="100%" +><TR +><TD +><FONT +COLOR="#000000" +><PRE +CLASS="PROGRAMLISTING" +><!--#exec cmd="/usr/bin/perl -e &quot;require 'CGI.pl'; PutFooter();&quot;" --></PRE +></FONT +></TD +></TR +></TABLE +> + </P +><P +><DIV +CLASS="NOTE" +><P +></P +><TABLE +CLASS="NOTE" +WIDTH="100%" +BORDER="0" +><TR +><TD +WIDTH="25" +ALIGN="CENTER" +VALIGN="TOP" +><IMG +SRC="../images/note.gif" +HSPACE="5" +ALT="Note"></TD +><TD +ALIGN="LEFT" +VALIGN="TOP" +><P +> This line will be replaced with the actual HTML for the footer + when the page is requested, so you should put this line where you + want the footer to appear. + </P +></TD +></TR +></TABLE +></DIV +></P +><P +> Because this method depends on being able to use a #exec directive, + and most ISP's will not allow that, there is an alternative method. + You could have a small script (such as <TT +CLASS="FILENAME" +>api.cgi</TT +>) + that basically looks like: +<TABLE +BORDER="0" +BGCOLOR="#E0E0E0" +WIDTH="100%" +><TR +><TD +><FONT +COLOR="#000000" +><PRE +CLASS="PROGRAMLISTING" +>#!/usr/bonsaitools/bin/perl -w + +require 'globals.pl'; + +if ($::FORM{sub} eq 'PutFooter') { + PutFooter(); +} else { + die 'api.cgi was incorrectly called'; +}</PRE +></FONT +></TD +></TR +></TABLE +> + and then put this line in <TT +CLASS="FILENAME" +>index.shtml</TT +>. +<TABLE +BORDER="0" +BGCOLOR="#E0E0E0" +WIDTH="100%" +><TR +><TD +><FONT +COLOR="#000000" +><PRE +CLASS="PROGRAMLISTING" +><!--#include virtual="api.cgi?sub=PutFooter"--></PRE +></FONT +></TD +></TR +></TABLE +> + </P +><P +> <DIV +CLASS="NOTE" +><P +></P +><TABLE +CLASS="NOTE" +WIDTH="100%" +BORDER="0" +><TR +><TD +WIDTH="25" +ALIGN="CENTER" +VALIGN="TOP" +><IMG +SRC="../images/note.gif" +HSPACE="5" +ALT="Note"></TD +><TD +ALIGN="LEFT" +VALIGN="TOP" +><P +> This still requires being able to use Server Side Includes, if + this simply will not work for you, see <A +HREF="http://bugzilla.mozilla.org/show_bug.cgi?id=80183" +TARGET="_top" +>bug 80183</A +> + for a third option. + </P +></TD +></TR +></TABLE +></DIV +></P ></DIV ></DIV ><DIV @@ -1790,7 +1910,7 @@ CLASS="QANDAENTRY" CLASS="QUESTION" ><P ><A -NAME="AEN1820" +NAME="AEN1931" ></A ><B >A.4.8. </B @@ -1829,7 +1949,7 @@ CLASS="QANDAENTRY" CLASS="QUESTION" ><P ><A -NAME="AEN1828" +NAME="AEN1939" ></A ><B >A.4.9. </B @@ -1854,7 +1974,7 @@ CLASS="QANDAENTRY" CLASS="QUESTION" ><P ><A -NAME="AEN1833" +NAME="AEN1944" ></A ><B >A.4.10. </B @@ -1877,7 +1997,7 @@ CLASS="QANDAENTRY" CLASS="QUESTION" ><P ><A -NAME="AEN1838" +NAME="AEN1949" ></A ><B >A.4.11. </B @@ -1934,7 +2054,7 @@ CLASS="QANDAENTRY" CLASS="QUESTION" ><P ><A -NAME="AEN1845" +NAME="AEN1956" ></A ><B >A.4.12. </B @@ -1961,7 +2081,7 @@ CLASS="QANDAENTRY" CLASS="QUESTION" ><P ><A -NAME="AEN1850" +NAME="AEN1961" ></A ><B >A.4.13. </B @@ -2006,34 +2126,10 @@ CLASS="QANDAENTRY" CLASS="QUESTION" ><P ><A -NAME="AEN1858" +NAME="AEN1969" ></A ><B >A.4.14. </B -> Does Bugzilla allow fields to be added, changed or deleted? If I want to - customize the bug submission form to meet our needs, can I do that using our - terminology? - </P -></DIV -><DIV -CLASS="ANSWER" -><P -><B -> </B -> Yes. - </P -></DIV -></DIV -><DIV -CLASS="QANDAENTRY" -><DIV -CLASS="QUESTION" -><P -><A -NAME="AEN1863" -></A -><B ->A.4.15. </B > Has anyone converted Bugzilla to another language to be used in other countries? Is it localizable? </P @@ -2056,10 +2152,10 @@ CLASS="QANDAENTRY" CLASS="QUESTION" ><P ><A -NAME="AEN1868" +NAME="AEN1974" ></A ><B ->A.4.16. </B +>A.4.15. </B > Can a user create and save reports? Can they do this in Word format? Excel format? </P @@ -2079,10 +2175,10 @@ CLASS="QANDAENTRY" CLASS="QUESTION" ><P ><A -NAME="AEN1873" +NAME="AEN1979" ></A ><B ->A.4.17. </B +>A.4.16. </B > Can a user re-run a report with a new project, same query? </P ></DIV @@ -2101,10 +2197,10 @@ CLASS="QANDAENTRY" CLASS="QUESTION" ><P ><A -NAME="AEN1878" +NAME="AEN1984" ></A ><B ->A.4.18. </B +>A.4.17. </B > Can a user modify an existing report and then save it into another name? </P ></DIV @@ -2124,10 +2220,10 @@ CLASS="QANDAENTRY" CLASS="QUESTION" ><P ><A -NAME="AEN1883" +NAME="AEN1989" ></A ><B ->A.4.19. </B +>A.4.18. </B > Does Bugzilla have the ability to search by word, phrase, compound search? </P @@ -2148,10 +2244,10 @@ CLASS="QANDAENTRY" CLASS="QUESTION" ><P ><A -NAME="AEN1888" +NAME="AEN1994" ></A ><B ->A.4.20. </B +>A.4.19. </B > Can the admin person establish separate group and individual user privileges? </P @@ -2171,10 +2267,10 @@ CLASS="QANDAENTRY" CLASS="QUESTION" ><P ><A -NAME="AEN1893" +NAME="AEN1999" ></A ><B ->A.4.21. </B +>A.4.20. </B > Does Bugzilla provide record locking when there is simultaneous access to the same bug? Does the second person get a notice that the bug is in use or how are they notified? @@ -2196,10 +2292,10 @@ CLASS="QANDAENTRY" CLASS="QUESTION" ><P ><A -NAME="AEN1898" +NAME="AEN2004" ></A ><B ->A.4.22. </B +>A.4.21. </B > Are there any backup features provided? </P ></DIV @@ -2224,10 +2320,10 @@ CLASS="QANDAENTRY" CLASS="QUESTION" ><P ><A -NAME="AEN1904" +NAME="AEN2010" ></A ><B ->A.4.23. </B +>A.4.22. </B > Can users be on the system while a backup is in progress? </P ></DIV @@ -2248,10 +2344,10 @@ CLASS="QANDAENTRY" CLASS="QUESTION" ><P ><A -NAME="AEN1909" +NAME="AEN2015" ></A ><B ->A.4.24. </B +>A.4.23. </B > What type of human resources are needed to be on staff to install and maintain Bugzilla? Specifically, what type of skills does the person need to have? I need to find out if we were to go with Bugzilla, what types of @@ -2287,10 +2383,10 @@ CLASS="QANDAENTRY" CLASS="QUESTION" ><P ><A -NAME="AEN1916" +NAME="AEN2022" ></A ><B ->A.4.25. </B +>A.4.24. </B > What time frame are we looking at if we decide to hire people to install and maintain the Bugzilla? Is this something that takes hours or weeks to install and a couple of hours per week to maintain and customize or is this @@ -2318,10 +2414,10 @@ CLASS="QANDAENTRY" CLASS="QUESTION" ><P ><A -NAME="AEN1921" +NAME="AEN2027" ></A ><B ->A.4.26. </B +>A.4.25. </B > Is there any licensing fee or other fees for using Bugzilla? Any out-of-pocket cost other than the bodies needed as identified above? </P @@ -2350,7 +2446,7 @@ CLASS="QANDAENTRY" CLASS="QUESTION" ><P ><A -NAME="AEN1928" +NAME="AEN2034" ></A ><B >A.5.1. </B @@ -2377,7 +2473,7 @@ CLASS="QANDAENTRY" CLASS="QUESTION" ><P ><A -NAME="AEN1934" +NAME="AEN2040" ></A ><B >A.5.2. </B @@ -2400,7 +2496,7 @@ CLASS="QANDAENTRY" CLASS="QUESTION" ><P ><A -NAME="AEN1939" +NAME="AEN2045" ></A ><B >A.5.3. </B @@ -2430,7 +2526,7 @@ CLASS="QANDAENTRY" CLASS="QUESTION" ><P ><A -NAME="AEN1946" +NAME="AEN2052" ></A ><B >A.6.1. </B @@ -2458,7 +2554,7 @@ CLASS="QANDAENTRY" CLASS="QUESTION" ><P ><A -NAME="AEN1952" +NAME="AEN2058" ></A ><B >A.6.2. </B @@ -2483,7 +2579,7 @@ CLASS="QANDAENTRY" CLASS="QUESTION" ><P ><A -NAME="AEN1957" +NAME="AEN2063" ></A ><B >A.6.3. </B @@ -2517,7 +2613,7 @@ CLASS="QANDAENTRY" CLASS="QUESTION" ><P ><A -NAME="AEN1964" +NAME="AEN2070" ></A ><B >A.7.1. </B @@ -2541,7 +2637,7 @@ CLASS="QANDAENTRY" CLASS="QUESTION" ><P ><A -NAME="AEN1969" +NAME="AEN2075" ></A ><B >A.7.2. </B @@ -2565,7 +2661,7 @@ CLASS="QANDAENTRY" CLASS="QUESTION" ><P ><A -NAME="AEN1974" +NAME="AEN2080" ></A ><B >A.7.3. </B @@ -2595,7 +2691,7 @@ CLASS="QANDAENTRY" CLASS="QUESTION" ><P ><A -NAME="AEN1980" +NAME="AEN2086" ></A ><B >A.7.4. </B @@ -2611,7 +2707,7 @@ CLASS="ANSWER" > You can call bug_email.pl directly from your aliases file, with an entry like this: <A -NAME="AEN1984" +NAME="AEN2090" ></A ><BLOCKQUOTE CLASS="BLOCKQUOTE" @@ -2632,7 +2728,7 @@ CLASS="QANDAENTRY" CLASS="QUESTION" ><P ><A -NAME="AEN1987" +NAME="AEN2093" ></A ><B >A.7.5. </B @@ -2655,7 +2751,7 @@ CLASS="QANDAENTRY" CLASS="QUESTION" ><P ><A -NAME="AEN1992" +NAME="AEN2098" ></A ><B >A.7.6. </B @@ -2670,20 +2766,14 @@ CLASS="ANSWER" > </B > If you are using an alternate Mail Transport Agent (MTA other than sendmail), make sure the options given in the "processmail" script for all - instances of "sendmail" are correct for your MTA. If you are using Sendmail, - you may wish to delete the "-ODeliveryMode=deferred" option in the - "processmail" script for every invocation of "sendmail". (Be sure and leave - the "-t" option, though!) - </P -><P -> A better alternative is to change the "-O" option to - "-ODeliveryMode=background". This prevents Sendmail from hanging your - Bugzilla Perl processes if the domain to which it must send mail - is unavailable. + instances of "sendmail" are correct for your MTA. </P ><P -> This is now a configurable parameter called "sendmailnow", available - from editparams.cgi. +> If you are using Sendmail, try enabling "sendmailnow" in editparams.cgi. + If you are using Postfix, you will also need to enable <SPAN +CLASS="QUOTE" +>"sendmailnow"</SPAN +>. </P ></DIV ></DIV @@ -2693,7 +2783,7 @@ CLASS="QANDAENTRY" CLASS="QUESTION" ><P ><A -NAME="AEN1999" +NAME="AEN2105" ></A ><B >A.7.7. </B @@ -2731,7 +2821,7 @@ CLASS="QANDAENTRY" CLASS="QUESTION" ><P ><A -NAME="AEN2007" +NAME="AEN2113" ></A ><B >A.8.1. </B @@ -2756,7 +2846,7 @@ CLASS="QANDAENTRY" CLASS="QUESTION" ><P ><A -NAME="AEN2012" +NAME="AEN2118" ></A ><B >A.8.2. </B @@ -2791,7 +2881,7 @@ CLASS="QANDAENTRY" CLASS="QUESTION" ><P ><A -NAME="AEN2017" +NAME="AEN2123" ></A ><B >A.8.3. </B @@ -2804,12 +2894,29 @@ CLASS="ANSWER" ><P ><B > </B -> Run the "sanity check" utility (./sanitycheck.cgi in the bugzilla_home - directory) to see! If it all comes back, you're OK. If it doesn't come back - OK (i.e. any red letters), there are certain things Bugzilla can recover - from and certain things it can't. If it can't auto-recover, I hope you're - familiar with mysqladmin commands or have installed another way to manage - your database... +> Run the <SPAN +CLASS="QUOTE" +>"sanity check"</SPAN +> utility + (<TT +CLASS="FILENAME" +>./sanitycheck.cgi</TT +> in the + Bugzilla_home directory) from your web browser to see! If + it finishes without errors, you're + <EM +>probably</EM +> OK. If it doesn't come back + OK (i.e. any red letters), there are certain things + Bugzilla can recover from and certain things it can't. If + it can't auto-recover, I hope you're familiar with + mysqladmin commands or have installed another way to + manage your database. Sanity Check, although it is a good + basic check on your database integrity, by no means is a + substitute for competent database administration and + avoiding deletion of data. It is not exhaustive, and was + created to do a basic check for the most common problems + in Bugzilla databases. </P ></DIV ></DIV @@ -2819,7 +2926,7 @@ CLASS="QANDAENTRY" CLASS="QUESTION" ><P ><A -NAME="AEN2022" +NAME="AEN2131" ></A ><B >A.8.4. </B @@ -2846,7 +2953,7 @@ CLASS="QANDAENTRY" CLASS="QUESTION" ><P ><A -NAME="AEN2027" +NAME="AEN2136" ></A ><B >A.8.5. </B @@ -2870,7 +2977,7 @@ CLASS="QANDAENTRY" CLASS="QUESTION" ><P ><A -NAME="AEN2032" +NAME="AEN2141" ></A ><B >A.8.6. </B @@ -2897,7 +3004,7 @@ CLASS="QANDAENTRY" CLASS="QUESTION" ><P ><A -NAME="AEN2037" +NAME="AEN2146" ></A ><B >A.8.7. </B @@ -2933,7 +3040,7 @@ CLASS="QANDAENTRY" CLASS="QUESTION" ><P ><A -NAME="AEN2044" +NAME="AEN2153" ></A ><B >A.8.8. </B @@ -2959,7 +3066,7 @@ CLASS="QANDAENTRY" CLASS="QUESTION" ><P ><A -NAME="AEN2049" +NAME="AEN2158" ></A ><B >A.8.9. </B @@ -2971,10 +3078,21 @@ CLASS="ANSWER" ><P ><B > </B -> Delete everything from $BUZILLA_HOME/shadow. Bugzilla creates shadow - files there, with each filename corresponding to a - bug number. Also be sure to run syncshadowdb to make sure, if you are using - a shadow database, that the shadow database is current. +> This should only happen with Bugzilla 2.14 if you are + using the <SPAN +CLASS="QUOTE" +>"shadow database"</SPAN +> feature, and your + shadow database is out of sync. Try running + <TT +CLASS="FILENAME" +>syncshadowdb</TT +> + <TT +CLASS="OPTION" +>-syncall</TT +> to make sure your shadow + database is in synch with your primary database. </P ></DIV ></DIV @@ -2992,7 +3110,7 @@ CLASS="QANDAENTRY" CLASS="QUESTION" ><P ><A -NAME="AEN2056" +NAME="AEN2168" ></A ><B >A.9.1. </B @@ -3015,7 +3133,7 @@ CLASS="QANDAENTRY" CLASS="QUESTION" ><P ><A -NAME="AEN2061" +NAME="AEN2173" ></A ><B >A.9.2. </B @@ -3039,7 +3157,7 @@ CLASS="QANDAENTRY" CLASS="QUESTION" ><P ><A -NAME="AEN2066" +NAME="AEN2178" ></A ><B >A.9.3. </B @@ -3060,7 +3178,7 @@ CLASS="ANSWER" ><P > Microsoft has some advice on this matter, as well: <A -NAME="AEN2071" +NAME="AEN2183" ></A ><BLOCKQUOTE CLASS="BLOCKQUOTE" @@ -3085,7 +3203,7 @@ CLASS="QANDAENTRY" CLASS="QUESTION" ><P ><A -NAME="AEN2074" +NAME="AEN2186" ></A ><B >A.9.4. </B @@ -3196,7 +3314,7 @@ CLASS="QANDAENTRY" CLASS="QUESTION" ><P ><A -NAME="AEN2080" +NAME="AEN2192" ></A ><B >A.9.5. </B @@ -3271,7 +3389,7 @@ CLASS="QANDAENTRY" CLASS="QUESTION" ><P ><A -NAME="AEN2101" +NAME="AEN2213" ></A ><B >A.10.1. </B @@ -3299,7 +3417,7 @@ CLASS="QANDAENTRY" CLASS="QUESTION" ><P ><A -NAME="AEN2107" +NAME="AEN2219" ></A ><B >A.10.2. </B @@ -3352,7 +3470,7 @@ CLASS="QANDAENTRY" CLASS="QUESTION" ><P ><A -NAME="AEN2117" +NAME="AEN2229" ></A ><B >A.10.3. </B @@ -3377,7 +3495,7 @@ CLASS="QANDAENTRY" CLASS="QUESTION" ><P ><A -NAME="AEN2122" +NAME="AEN2234" ></A ><B >A.10.4. </B @@ -3402,7 +3520,7 @@ CLASS="QANDAENTRY" CLASS="QUESTION" ><P ><A -NAME="AEN2127" +NAME="AEN2239" ></A ><B >A.10.5. </B @@ -3434,7 +3552,7 @@ CLASS="QANDAENTRY" CLASS="QUESTION" ><P ><A -NAME="AEN2134" +NAME="AEN2246" ></A ><B >A.11.1. </B @@ -3447,20 +3565,20 @@ CLASS="ANSWER" ><B > </B > Try <A -HREF="http://bugzilla.mozilla.org/buglist.cgi?bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&product=Webtools&component=Bugzilla" +HREF="http://bugzilla.mozilla.org/buglist.cgi?bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&product=Bugzilla" TARGET="_top" > this link</A > to view current bugs or requests for enhancement for Bugzilla. </P ><P -> You can view bugs marked for 2.14 release +> You can view bugs marked for 2.16 release <A -HREF="http://bugzilla.mozilla.org/buglist.cgi?product=Webtools&component=Bugzilla&target_milestone=Bugzilla+2.14" +HREF="http://bugzilla.mozilla.org/buglist.cgi?product=Bugzilla&target_milestone=Bugzilla+2.16" TARGET="_top" >here</A >. - This list includes bugs for the 2.14 release that have already + This list includes bugs for the 2.16 release that have already been fixed and checked into CVS. Please consult the <A HREF="http://www.mozilla.org/projects/bugzilla/" @@ -3478,7 +3596,7 @@ CLASS="QANDAENTRY" CLASS="QUESTION" ><P ><A -NAME="AEN2143" +NAME="AEN2255" ></A ><B >A.11.2. </B @@ -3510,7 +3628,7 @@ CLASS="QANDAENTRY" CLASS="QUESTION" ><P ><A -NAME="AEN2149" +NAME="AEN2261" ></A ><B >A.11.3. </B @@ -3528,8 +3646,15 @@ CLASS="ANSWER" TYPE="1" ><LI ><P -> Enter a bug into bugzilla.mozilla.org for the "Webtools" product, - "Bugzilla" component. +> Enter a bug into bugzilla.mozilla.org for the <SPAN +CLASS="QUOTE" +>"<A +HREF="http://bugzilla.mozilla.org/enter_bug.cgi?product=Bugzilla" +TARGET="_top" +>Bugzilla</A +>"</SPAN +> + product. </P ></LI ><LI @@ -3590,7 +3715,7 @@ WIDTH="33%" ALIGN="left" VALIGN="top" ><A -HREF="future.html" +HREF="variant_sourceforge.html" >Prev</A ></TD ><TD @@ -3615,7 +3740,7 @@ HREF="downloadlinks.html" WIDTH="33%" ALIGN="left" VALIGN="top" ->The Future of Bugzilla</TD +>SourceForge</TD ><TD WIDTH="34%" ALIGN="center" diff --git a/docs/html/future.html b/docs/html/future.html index 314f0e050..99a577ff8 100644 --- a/docs/html/future.html +++ b/docs/html/future.html @@ -13,8 +13,8 @@ REL="PREVIOUS" TITLE="Tinderbox/Tinderbox2" HREF="tinderbox.html"><LINK REL="NEXT" -TITLE="The Bugzilla FAQ" -HREF="faq.html"></HEAD +TITLE="Bugzilla Variants and Competitors" +HREF="variants.html"></HEAD ><BODY CLASS="CHAPTER" BGCOLOR="#FFFFFF" @@ -54,7 +54,7 @@ WIDTH="10%" ALIGN="right" VALIGN="bottom" ><A -HREF="faq.html" +HREF="variants.html" >Next</A ></TD ></TR @@ -85,11 +85,600 @@ CLASS="SYNOPSIS" ></TR ></TABLE ><P -> The future of Bugzilla is Bugzilla 3.0. Unfortunately, I do - not have more information about it right now, and most of what - went into the "future" section is now present. That stuff was - blue-sky a year ago; MattyT should have me a new document - sometime... +> Bugzilla's future is a constantly-changing thing, as various developers + <SPAN +CLASS="QUOTE" +>"scratch an itch"</SPAN +> when it comes to functionality. + Thus this section is very malleable, subject to change without notice, etc. + You'll probably also notice the lack of formatting. I apologize that it's + not quite as readable as the rest of the Guide. + </P +><P +> <P +CLASS="LITERALLAYOUT" +> Bugzilla Blue Sky<br> +<br> +Customisability<br> +<br> + One of the major stumbling blocks of Bugzilla has been that it is too<br> + rigid and does not adapt itself well enough to the needs of an<br> + organisation. This has led to organisations making changes to the<br> + Bugzilla code that need to be redone each new version of Bugzilla.<br> + Bugzilla should attempt to move away from this to a world where this<br> + doesn't need to occur.<br> +<br> + Most of the subsections in this section are currently explicit design<br> + goals for the "Bugzilla 3" rewrite. This does not necessarily mean<br> + that they will not occur before them in Bugzilla 2, but most are<br> + significant undertakings.<br> +<br> + Field Customisation<br> +<br> + Many installations wish to customise the fields that appear on bug<br> + reports. Current versions of Bugzilla offer limited<br> + customisability. In particular, some fields can be turned off.<br> +<br> + However, many administrators wish to add their own fields, and rename<br> + or otherwise modify existing fields. An architecture that supports<br> + this would be extraordinarily useful.<br> +<br> + Indeed, many fields work similarly and could be abstracted into "field<br> + types", so that an administrator need write little or no code to<br> + support the new fields they desire.<br> +<br> + Possible field types include text (eg status whiteboard), numbers,<br> + dates (eg report time), accounts (eg reporter, qa, cc), inter-bug<br> + relationships (dependencies, duplicates), option groups (platform, os,<br> + severity, priority, target milestone, version) etc.<br> +<br> + Ideally an administrator could configure their fields through a<br> + Bugzilla interface that requires no code to be added. However, it is<br> + highly unlikely this ideal will never be met, and in a similar way<br> + that office applications have scripting languages, Bugzilla should<br> + allow new field types to be written.<br> +<br> + Similarly, a common desire is for resolutions to be added or removed.<br> +<br> + Allocations<br> +<br> + ?<br> +<br> + Option Groups<br> +<br> + ?<br> +<br> + Relations<br> +<br> + ?<br> +<br> + Database Integrity<br> +<br> + Furthermore, it is desirable for administrators to be able to specify<br> + rules that must or should apply between the fields on a bug report.<br> +<br> + For example, you might wish to specify that a bug with status ASSIGNED<br> + must have a target milestone field that that is not untargetted. Or<br> + that a bug with a certain number of votes should get ASSIGNED. Or<br> + that the QA contact must be different from the assignee.<br> +<br> + "Must" relationships could be implemented by refusing to make changes<br> + that violate the relationships, or alternatively, automatically<br> + updating certain fields in order to satisfy the criteria. Which<br> + occurs should be up to the administrator.<br> +<br> + "Should" relationships could be implemented by a combination of<br> + emitting warnings on the process bug page, the same on notification<br> + mails, or emitting periodic whine mails about the situation. Again,<br> + which occurs should be up to the administrator.<br> +<br> + It should also be possible for whine mails to be emitted for "must"<br> + relationships, as they might become violated through direct database<br> + access, Bugzilla bugs, or because they were there before the<br> + relationship was enforced.<br> +<br> + As well as implementing intra-bug constraints, it would be useful to<br> + create inter-bug constraints. For example, a bug that is dependent on<br> + another bug should not have an earlier milestone or greater priority<br> + than that bug.<br> +<br> + Database Adaptability<br> +<br> + Often an administrator desires that fields adapt to the values of<br> + other fields. For example, the value of a field might determine the<br> + possible values of another field or even whether it appears (whether<br> + it is "applicable").<br> +<br> + Limited adaptability is present in Bugzilla 2, and only on the<br> + "Product" field:<br> + * The possible values of the target milestone, version and component<br> + fields depend on the product.<br> + * UNCONFIRMED can be turned off for specific products.<br> + * Voting can be configured differently or turned off for different<br> + products, and there is a separate user vote limits for each<br> + product.<br> +<br> + It would be good if more adaptability was present, both in terms of<br> + all fields relying on the product, as well as the ability to adapt<br> + based on the value of all fields.<br> +<br> + Example ???<br> +<br> + General adaptability raises the issue of circular references between<br> + fields causing problems. One possible solution to this is to place<br> + the fields in a total ordering and require a field refer only to the<br> + previous fields.<br> +<br> + In Bugzilla 2, changing the product of a bug meant a second page would<br> + appear that allowed you to choose a new milestone, component and<br> + version, as those fields adapted themselves to the new product. This<br> + page could be generalised to support all instances where:<br> + * a field value must or might be changed because the possible values<br> + have changed<br> + * is going to drop off because it it is no longer applicable, and<br> + this should be confirmed<br> + * must be specified because it is suddenly applicable, and the<br> + default value, if one exists, might not be acceptable<br> +<br> + Database Independence<br> +<br> + Currently Bugzilla only runs on the MySQL database. It would be<br> + desirable for Bugzilla to run on other databases, because:<br> + * Organisations may have existing database products they use and<br> + would prefer to run a homogenous environment.<br> + * Databases each have their own shortcomings, including MySQL. An<br> + administrator might choose a database that would work better with<br> + their Bugzilla.<br> +<br> + This raises the possibility that we could use features that are only<br> + present in some databases, by appropriately falling back. For<br> + example, in the MySQL world, we live without:<br> + * record-level locking, instead we use table-level locking<br> + * referential and record constraints, instead we checking code<br> + * subselects, instead we use multiple queries and redundant "caches"<br> +<br> + Multiple Front Ends<br> +<br> + Currently Bugzilla is manipulated via the Web, and notifies via<br> + E-Mail. It would be desirable for Bugzilla to easily support various<br> + front ends.<br> +<br> + There is no reason that Bugzilla could not be controlled via a whole<br> + range of front ends, including Web, E-Mail, IRC, ICQ, etc, and<br> + similarly for how it notifies. It's also possible that we could<br> + introduce a special Bugzilla client that uses its own protocol, for<br> + maximum user productivity.<br> +<br> + Indeed a request reply might be returned via a totally different<br> + transport method than was use to submit the request.<br> +<br> +Internationalisation<br> +<br> + Bugzilla currently supports only English. All of the field names,<br> + user instructions, etc are written in English. It would be desirable<br> + to allow "language packs" so Bugzilla can be easily used in<br> + non-English speaking locales.<br> +<br> + To a degree field customisation supports this, because administrators<br> + could specify their own fields names anyway. However, there will<br> + always be some basic facilities not covered by this, and it is<br> + desirable that the administrator's interface also is<br> + internationalisable.<br> +<br> +Better Searching<br> +<br> + General Summary Reports<br> +<br> + Sometimes, the normal querying page leaves a lot to be desired. There<br> + are other facilities already in place or which people have asked for:<br> +<br> + Most Doomed Reports - All Bugs or All Bugs In A Product, Categorised<br> + On Assignee, Shows and Counts Number of Bugs For Each Assignee<br> + Most Voted For Bugs - All Bugs, Categorised On Product, Shows Top Ten<br> + Bugs Voters Most Want Fixed<br> + Number of Open Bugs For An Assignee - Bug List, Categorised On<br> + Developers, Counts Number of Bugs In Category<br> +<br> + The important thing to realise is that people want categorised reports<br> + on all sorts of things - a general summary report.<br> +<br> + In a categorised report, you choose the subset of bugs you wish to<br> + operate on (similar to how you would specify a query), and then<br> + categorise them on one or more fields.<br> +<br> + For each category you display the count of the number of things in<br> + that category. You can optionally display the bugs themselves, or<br> + leave them out, just showing the counts. And you can optionally limit<br> + the number of things (bugs or subcategories) that display in each<br> + category.<br> +<br> + Such a mechanism would let you do all of the above and more.<br> + Applications of this mechanism would only be recognised once it was<br> + implemented.<br> +<br> + Related Bugs<br> +<br> + It would be nice to have a field where you could enter other bugs<br> + related to the current bug. It would be handy for navigation and<br> + possibly even finding duplicates.<br> +<br> + Column Specification Support<br> +<br> + Currently bug lists use the columns that you last used. This doesn't<br> + work well for "prepackaged queries", where you followed a link. You<br> + can probably add a column by specifying a sort column, but this is<br> + difficult and suboptimal.<br> +<br> + Furthermore, I find that when I want to add a column to a bug list,<br> + it's usually a one off and I would prefer it to go away for the next<br> + query. Hence, it would be nice to specify the columns that appear on<br> + the bug list (and general summary report) pages. The default query<br> + mechanism should be able to let you specify your default columns.<br> +<br> + Advanced Querying Redesign<br> +<br> + ?<br> +<br> +Keywords<br> +<br> + People have a need to apply tags to bugs. In the beginning, people<br> + placed designators in the summary and status whiteboard. However,<br> + these fields were not designed for that, and so there were many flaws<br> + with this system:<br> + * They pollute the field with information that was never intended to<br> + be present.<br> + * Removing them with a bulk change is a difficult problem that has<br> + too many pitfalls to implement.<br> + * You can easily get the capitalisation wrong.<br> +<br> + Then dependencies were introduced (when?), and people realised that<br> + they could use them for "tracking bugs". Again, dependencies were not<br> + designed for that, and so there were more flaws, albeit different<br> + ones, including:<br> + * They aren't really bugs, so it's difficult to distinguish issues<br> + from bugs.<br> + * They can pollute bugs counts, and you must somehow exclude them<br> + from queries.<br> + * There is a whole lot of useless information on them. They have an<br> + assignee but there is nothing to fix, and that person can get<br> + whined at by Bugzilla. They have target milestones which must be<br> + manually maintained. And so on.<br> +<br> + Finally, keywords were introduced (when?) for this purpose to remove<br> + the need for these two systems. Unfortunately, the simple keywords<br> + implementation was itself lacking in certain features provided by the<br> + two previous systems, and has remained almost unchanged since its<br> + inception. Furthermore, it could not be forseen that in large<br> + installations, the sheer number of keywords could become unwieldly and<br> + could lead to a movement back to the other systems.<br> +<br> + The keywords system was the right idea, however, and it remains so.<br> + Fixing the keywords system is one of the most important Bugzilla<br> + issues.<br> +<br> + Bringing Keywords Up To Par<br> +<br> + For the most part, keywords are very good at what they do. It is easy<br> + to add and remove them (unlike summary/whiteboard designators), we can<br> + simply see what issues are present on a bug (unlike tracking bugs),<br> + and we do not confuse bugs with issues (unlike tracking bugs).<br> +<br> + However, there are still some "regressions" in the keyword system over<br> + previous systems:<br> + * Users wish to view the "dependency forest" of a keyword. While a<br> + dependency tree is of one bug, a dependency forest is of a bug<br> + list, and consists of a dependency tree for each member of the bug<br> + list. Users can work around this with tracking bugs by creating a<br> + tracking bug and viewing the dependency tree of that tracking bug.<br> + * Users wish to specify the keywords that initially apply to a bug,<br> + but instead they must edit the bug once it has already been<br> + submitted. They can work around this with summary designators,<br> + since they specify the summary at reporting time.<br> + * Users wish to store or share a bug list that contains a keywords<br> + column. Hence they wish to be able to specify what columns appear<br> + in the bug list URL, as mentioned earlier. They can work around<br> + this using summary designators, since almost all bug lists have a<br> + summary column.<br> + * Users wish to be able to view keywords on a bug list. However<br> + often they are only interested in a small number of keywords.<br> + Having a bug list with a keywords column means that all keywords<br> + will appear on a bug list. This can take a substantial amount of<br> + space where a bug has a lot of keywords, since the table columns<br> + in Bugzilla adjust to the largest cell in that column. Hence<br> + users wish to be able to specify which keywords should appear in<br> + the bug list. In a very real sense, each keyword is a field unto<br> + itself. Users can work around this by using summary designators,<br> + since they keywords will share the space in the summary column.<br> + * Users wish to know when bugs with a specific issue are resolved.<br> + Hence they wish to be able to receive notifications on all the<br> + bugs with a specific keyword. The introduction a generic watching<br> + facility (also for things like watching all bugs in a component)<br> + would achieve this. Users can work around this by using tracking<br> + bugs, as dependencies have an existing way of detecting fixes to<br> + bug a bug was blocked by.<br> +<br> + Dealing With The Keyword Overload<br> +<br> + At the time of writing, the mozilla.org installation has approximately<br> + 100 keywords, and many more would be in use if the keywords system<br> + didn't have the problems it does.<br> +<br> + Such a large number of keywords introduces logistical problems:<br> + * It must be easy for someone to learn what a keyword means. If a<br> + keyword is buried within a lot of other keywords, it can be<br> + difficult to find.<br> + * It must be easy to see what keywords are on a bug. If the number<br> + of keywords is large, then this can be difficult.<br> +<br> + These lead some people to feel that there are "too many keywords".<br> +<br> + These problems are not without solutions however. It is harder to<br> + find a list of designators or tracking bugs than it is a list of<br> + keywords.<br> +<br> + The essential problem is it needs to be easy to find the keywords<br> + we're interested in through the mass of keywords.<br> +<br> + Keyword Applicability<br> +<br> + As has been previously mentioned, it is desirable for fields to be<br> + able to adapt to the values of other fields. This is certainly true<br> + for keywords. Many keywords are simply not relevant because of the<br> + bugs product, component, etc.<br> +<br> + Hence, by introducing keyword applicability, and not displaying<br> + keywords that are not relevant to the current bug, or clearly<br> + separating them, we can make the keyword overload problem less<br> + significant.<br> +<br> + Currently when you click on "keywords" on a bug, you get a list of all<br> + bugs. It would be desirable to introduce a list of keywords tailored<br> + to a specific bug, that reports, in order:<br> + * the keywords currently on the bug<br> + * the keywords not currently on the bug, but applicable to the bug<br> + * optionally, the keywords not applicable to the bug<br> +<br> + This essentially orders the keywords into three groups, where each<br> + group is more important than the previous, and therefore appears<br> + closer to the top.<br> +<br> + Keyword Grouping & Ordering<br> +<br> + We could further enhance both the global and bug specific keyword list<br> + by grouping keywords. We should always have a "flat" view of<br> + keywords, but other ways of viewing the keywords would be useful too.<br> +<br> + If keyword applicability was implemented, we could group keywords<br> + based on their "applicability condition". Keywords that apply to all<br> + bugs could be separated from keywords that apply to a specific<br> + product, both on the global keyword list and the keyword list of a bug<br> + that is in that product.<br> +<br> + We could specify groups of our own. For example, many keywords are in<br> + a mutually exclusive group, essentially like radio buttons in a user<br> + interface. This creates a natural grouping, although other groupings<br> + occur (which depends on your keywords).<br> +<br> + It is possible that we could use collapsing/expanding operations on<br> + "twisties" to only should the groups we are interested in.<br> +<br> + And instead of grouping keywords, we could order them on some metric<br> + of usefulness, such as:<br> + * when the keyword was last added to a bug<br> + * how many bugs the keyword is on<br> + * how many open bugs the keyword is on<br> +<br> + Opting Out Of Keywords<br> +<br> + Not all people are going to care about all keywords. Therefore it<br> + makes sense that you may wish to specify which keywords you are<br> + interested in, either on the bug page, or on notifications.<br> +<br> + Other keywords will therefore not bother users who are not interested<br> + in them.<br> +<br> + Keyword Security<br> +<br> + Currently all keywords are available and editable to all people with<br> + edit bugs access. This situation is clearly suboptimal.<br> +<br> + Although relying on good behaviour for people to not do what they<br> + shouldn't works reasonably well on the mozilla.org, it is better to<br> + enforce that behaviour - it can be breached through malice, accident<br> + or ignorance.<br> +<br> + And in the situation where it is desirable for the presence or absence<br> + of a keyword not to be revealed, organisations either need to be<br> + content with the divulgence, or not use keywords at all.<br> +<br> + In the situation where they choose to divulge, introducing the ability<br> + to restrict who can see the keyword would also reduce keyword<br> + overload.<br> +<br> + Personal Keywords<br> +<br> + Keywords join together a set of bugs which would otherwise be<br> + unrelated in the bug system.<br> +<br> + We allow users to store their own queries. However we don't allow<br> + them to store their own keywords on a bug. This reduces the<br> + usefulness of personal queries, since you cannot join a set of<br> + unrelated bugs together in a way that you wish. Lists of bug numbers<br> + can work, by they can only be used for small lists, and it is<br> + impossible to share a list between multiple queries.<br> +<br> + Personal keywords are necessary to replace personal tracking bugs, as<br> + they would not pollute the keyword space. Indeed, on many<br> + installations this could remove some keywords out of the global<br> + keyword space.<br> +<br> + In a similar vein and with similar effects, group keywords could be<br> + introduced that are only available to members of a specific group.<br> +<br> + Keyword Restrictions<br> +<br> + Keywords are not islands unto themselves. Along with their potential<br> + to be involved in the inter-field relationships mentioned earlier,<br> + keywords can also be related to other keywords.<br> +<br> + Essentially, there are two possibilities:<br> + * a set of keywords are mutually exclusive<br> + * the presence of a keyword implies another keyword must be present<br> +<br> + Introduction of the ability to specify these restrictions would have<br> + benefits.<br> +<br> + If mutually exclusive keywords were present on a bug, their removal<br> + would fix up the database, as well as reducing the number of keywords<br> + on that bug.<br> +<br> + In the situation where a keyword implies another keyword, there are<br> + two possiblities as to how to handle the situation.<br> +<br> + The first is automatically add the keyword. This would fix up the<br> + database, but it would increase the number of keywords on a bug.<br> +<br> + The second is to automatically remove the keyword, and alter queries<br> + so they pick up the first keyword as well as the removed keyword.<br> + This would fix up the database and reduce the number of keywords on a<br> + bug, but it might confuse users who don't see the keyword.<br> + Alternatively, the implied keywords could be listed separately.<br> +<br> +Notifications<br> +<br> + Every time a bug gets changed notifications get sent out to people<br> + letting them know about what changes have been made. This is a<br> + significant feature, and all sorts of questions can be raised, but<br> + they mainly boil down to when they should be sent and what they should<br> + look like.<br> +<br> + Changes You're Interested In<br> +<br> + As of version 2.12 users can specify what sort of changes they are<br> + interested in receiving notifications for. However, this is still<br> + limited. As yet there is no facility to specify which keywords you<br> + care about, and whether you care about changes to fields such as the<br> + QA contact changes.<br> + Furthermore, often an unnecessary comment will go along with a change,<br> + either because it is required, or the commenter is ignorant of how the<br> + new system works. While explaining why you did something is useful,<br> + merely commenting on what you did is not because that information is<br> + already accessible view "Bug Activity".<br> +<br> + Because of this unnecessary comment, a lot of changes that would<br> + otherwise not generate notifications for certain people do so, because<br> + few people are willing to turn off comments. One way to deal with<br> + this problem is to allow people to specify that their comments are<br> + purely explanatory, and that anyone who is not interested in the<br> + change will not be interested in the comment.<br> +<br> + Furthermore, one possible rationale for unnecessary comments is that<br> + the bug activity does not display on the normal page and hence it is<br> + difficult to cross reference comments and actions. Hence, it would be<br> + beneficial to be able to do this.<br> +<br> + Bugs You're Watching<br> +<br> + Currently to receive a notification about a bug you need to have your<br> + name on it. This is suboptimal because you need to know about a bug<br> + before you can receive notifications on it. Often you are interested<br> + in any bug with a field set to a specific value. For example, you<br> + might be interested in all bugs with a specific product, component or<br> + keyword.<br> +<br> + If someone could automatically receive notifications about these bugs,<br> + it would make everyone's lives easier. Currently the default assignee<br> + and QA contact for a component will automatically receive<br> + notifications for<br> +<br> + Question: This moves half way to a BCC.<br> +<br> + Bulk Changes<br> +<br> + A very useful feature of Bugzilla is the ability to perform an action<br> + on multiple bugs at once. However, this means that similar<br> + notifications are currently generated for each bug modified.<br> +<br> + This can result in a torrent of notifications that can annoy.<br> +<br> + Furthermore, since the bugs are all changed close to each other in<br> + time, it is easy for someone to mass delete all the notifications<br> + generated by a bulk change and miss an unrelated notification in the<br> + middle.<br> +<br> + These factors can lead to a tendency for people to delay bulk changes,<br> + or avoid them entirely. This is suboptimal.<br> +<br> + It would be better if a bulk change generated only one notification<br> + mail. This would vastly reduce the annoyance factor, and prevent<br> + accidental deletion of notifications.<br> +<br> + One problem with this change is that some people separate out<br> + notifications using filtering. This means that they would no longer<br> + be match parts of a bulk change under different filtering rules.<br> +<br> + One possibility to resolve this is to allow people to specify groups<br> + of bugs. All bugs within a group would go into the same<br> + notification. The filters could then distinguish the different bug<br> + groups.<br> +<br> + In any case, it is likely there would need to be a transition period<br> + to allow people to alter their filters.<br> +<br> +Nominations<br> +<br> + ?<br> +<br> +Linking Bugzilla Installations<br> +<br> + The first example of linking Bugzilla installations together has is<br> + the introduction of bug moving in version 2.12. However, it would be<br> + useful to be able to link installations in more ways.<br> + * Dependencies and other relationships between bugs in other<br> + installations. This is difficult because dependencies are<br> + synchronised on both bugs, so the installation that changes<br> + dependencies would need to communicate the new state to the other<br> + installation. It would also mean that relationships and<br> + notifications that refer to other bugs would need to communicate<br> + with the other installation.<br> + * References to bugs in other installations. Currently if you type<br> + "bug XXX" or "bug #XXX" where XXX is a number, you get an<br> + automatic hyperlink to that bug. It would be useful if you could<br> + say "YYY bug #XXX" where YYY is the name of another installation.<br> +<br> +Retirement<br> +<br> + ?<br> +<br> +Whiny Reports<br> +<br> + ?<br> +<br> + Group Redesign<br> +<br> + ?<br> +<br> + Hard Wrapping Comments<br> +<br> + Currently Bugzilla "hard wraps" its comments to a specific line size,<br> + similar to E-Mail. This has various problems:<br> + * The way it currently works, wrapping is done in the browser at<br> + submission time using a non-standard HTML extension not supported<br> + by some (uncommon) browsers. These browsers generate comments<br> + that scroll off the right side of the screen.<br> + * Because comments are of fixed width, when you expand your browser<br> + window, the comments do not expand to fit available space.<br> +<br> + It would be much better to move to a world of soft wrapping, where the<br> + browser wraps the text at display time, similar to a world processor.<br> + And as in a word processor, soft wrapping does not preclude the<br> + insertion of newlines.<br> +<br> + Hard wrapping is too entrenched into text E-Mail to fix, but we can<br> + fix Bugzilla without causing any problems. The old content will still<br> + be wrapped too early, but at least new content will work.<br> + </P +> </P ></DIV ><DIV @@ -123,7 +712,7 @@ WIDTH="33%" ALIGN="right" VALIGN="top" ><A -HREF="faq.html" +HREF="variants.html" >Next</A ></TD ></TR @@ -142,7 +731,7 @@ VALIGN="top" WIDTH="33%" ALIGN="right" VALIGN="top" ->The Bugzilla FAQ</TD +>Bugzilla Variants and Competitors</TD ></TR ></TABLE ></DIV diff --git a/docs/html/geninstall.html b/docs/html/geninstall.html index b8f25789a..18217ef48 100644 --- a/docs/html/geninstall.html +++ b/docs/html/geninstall.html @@ -78,7 +78,7 @@ CLASS="SECTION" ><H2 CLASS="SECTION" ><A -NAME="AEN916" +NAME="AEN941" >3.5.1. Modifying Your Running System</A ></H2 ><P @@ -111,7 +111,7 @@ CLASS="SECTION" ><H2 CLASS="SECTION" ><A -NAME="AEN923" +NAME="AEN948" >3.5.2. Upgrading From Previous Versions</A ></H2 ><P @@ -323,7 +323,7 @@ CLASS="SECTION" ><H2 CLASS="SECTION" ><A -NAME="AEN964" +NAME="UNIXHISTORY" >3.5.6. UNIX Installation Instructions History</A ></H2 ><P @@ -335,9 +335,11 @@ NAME="AEN964" > The February 25, 1999 re-write of this page was done by Ry4an Brase <ry4an@ry4an.org>, with some edits by Terry Weissman, Bryce Nesbitt, Martin Pool, & Dan Mosedale (But - don't send bug reports to them; report them using bugzilla, at - http://bugzilla.mozilla.org/enter_bug.cgi , project Webtools, - component Bugzilla). + don't send bug reports to them; report them using bugzilla, at <A +HREF="http://bugzilla.mozilla.org/enter_bug.cgi?product=Bugzilla" +TARGET="_top" +>http://bugzilla.mozilla.org/enter_bug.cgi?product=Bugzilla</A +> ). </P ><P > This document was heavily modified again Wednesday, March 07 diff --git a/docs/html/gfdl.html b/docs/html/gfdl.html index 966c2b9d1..dfb5c69da 100644 --- a/docs/html/gfdl.html +++ b/docs/html/gfdl.html @@ -10,8 +10,8 @@ REL="HOME" TITLE="The Bugzilla Guide" HREF="index.html"><LINK REL="PREVIOUS" -TITLE="The Quicksearch Utility" -HREF="quicksearch.html"><LINK +TITLE="Hacking Bugzilla" +HREF="bzhacking.html"><LINK REL="NEXT" TITLE="PREAMBLE" HREF="gfdl_0.html"></HEAD @@ -41,7 +41,7 @@ WIDTH="10%" ALIGN="left" VALIGN="bottom" ><A -HREF="quicksearch.html" +HREF="bzhacking.html" >Prev</A ></TD ><TD @@ -141,7 +141,7 @@ HREF="gfdl_howto.html" ><P >Version 1.1, March 2000</P ><A -NAME="AEN2416" +NAME="AEN2499" ></A ><BLOCKQUOTE CLASS="BLOCKQUOTE" @@ -167,7 +167,7 @@ WIDTH="33%" ALIGN="left" VALIGN="top" ><A -HREF="quicksearch.html" +HREF="bzhacking.html" >Prev</A ></TD ><TD @@ -192,7 +192,7 @@ HREF="gfdl_0.html" WIDTH="33%" ALIGN="left" VALIGN="top" ->The Quicksearch Utility</TD +>Hacking Bugzilla</TD ><TD WIDTH="34%" ALIGN="center" diff --git a/docs/html/gfdl_howto.html b/docs/html/gfdl_howto.html index 7dac6f4c6..775fca0c8 100644 --- a/docs/html/gfdl_howto.html +++ b/docs/html/gfdl_howto.html @@ -78,7 +78,7 @@ NAME="GFDL_HOWTO" a copy of the License in the document and put the following copyright and license notices just after the title page:</P ><A -NAME="AEN2506" +NAME="AEN2589" ></A ><BLOCKQUOTE CLASS="BLOCKQUOTE" diff --git a/docs/html/glossary.html b/docs/html/glossary.html index d689a8f76..7f821c83b 100644 --- a/docs/html/glossary.html +++ b/docs/html/glossary.html @@ -68,7 +68,7 @@ CLASS="GLOSSDIV" ><H1 CLASS="GLOSSDIV" ><A -NAME="AEN2511" +NAME="AEN2594" >0-9, high ascii</A ></H1 ><DL @@ -402,7 +402,7 @@ NAME="GLOSS_P" ><DIV CLASS="EXAMPLE" ><A -NAME="AEN2602" +NAME="AEN2685" ></A ><P ><B diff --git a/docs/html/granttables.html b/docs/html/granttables.html index 79cdf736f..2c5147270 100644 --- a/docs/html/granttables.html +++ b/docs/html/granttables.html @@ -16,8 +16,8 @@ REL="PREVIOUS" TITLE="MySQL Bugzilla Database Introduction" HREF="dbdoc.html"><LINK REL="NEXT" -TITLE="Bugzilla Variants and Competitors" -HREF="variants.html"></HEAD +TITLE="Useful Patches and Utilities for Bugzilla" +HREF="patches.html"></HEAD ><BODY CLASS="SECTION" BGCOLOR="#FFFFFF" @@ -57,7 +57,7 @@ WIDTH="10%" ALIGN="right" VALIGN="bottom" ><A -HREF="variants.html" +HREF="patches.html" >Next</A ></TD ></TR @@ -313,7 +313,7 @@ WIDTH="33%" ALIGN="right" VALIGN="top" ><A -HREF="variants.html" +HREF="patches.html" >Next</A ></TD ></TR @@ -335,7 +335,7 @@ HREF="database.html" WIDTH="33%" ALIGN="right" VALIGN="top" ->Bugzilla Variants and Competitors</TD +>Useful Patches and Utilities for Bugzilla</TD ></TR ></TABLE ></DIV diff --git a/docs/html/how.html b/docs/html/how.html index 7f9501755..cad748643 100644 --- a/docs/html/how.html +++ b/docs/html/how.html @@ -438,13 +438,13 @@ CLASS="QUOTE" >scrollbox</EM >. Using the down arrow on the scrollbox, scroll down until you can see an entry - called "Webtools". Select this entry. + called "Bugzilla". Select this entry. </P ></LI ><LI ><P > Did you notice that some of the boxes to the right changed - when you selected "Webtools"? Every Program (or Product) + 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. @@ -519,7 +519,7 @@ NAME="AEN317" ></A ><P ><B ->Example 2-2. Mozilla Webtools Components</B +>Example 2-2. Mozilla's Bugzilla Components</B ></P ><DIV CLASS="INFORMALEXAMPLE" @@ -529,7 +529,7 @@ NAME="AEN319" ><P ></P ><P -> Mozilla's "Webtools" Product is composed of several pieces (Components): +> Mozilla's "Bugzilla" Product is composed of several pieces (Components): <P ></P ><TABLE @@ -538,60 +538,166 @@ BORDER="0" ><TR ><TD ><EM ->Bonsai</EM +>Administration</EM >, - a tool to show recent changes to Mozilla</TD + Administration of a bugzilla installation, including + <TT +CLASS="FILENAME" +>editcomponents.cgi</TT +>, + <TT +CLASS="FILENAME" +>editgroups.cgi</TT +>, + <TT +CLASS="FILENAME" +>editkeywords.cgi</TT +>, + <TT +CLASS="FILENAME" +>editparams.cgi</TT +>, + <TT +CLASS="FILENAME" +>editproducts.cgi</TT +>, + <TT +CLASS="FILENAME" +>editusers.cgi</TT +>, + <TT +CLASS="FILENAME" +>editversions.cgi,</TT +> and + <TT +CLASS="FILENAME" +>sanitycheck.cgi</TT +>. + </TD ></TR ><TR ><TD ><EM ->Bugzilla</EM +>Bugzilla-General</EM >, - a defect-tracking tool</TD + Anything that doesn't fit in the other components, or spans + multiple components. + </TD ></TR ><TR ><TD ><EM ->Build</EM +>Creating/Changing Bugs</EM +>, + Creating, changing, and viewing bugs. + <TT +CLASS="FILENAME" +>enter_bug.cgi</TT +>, + <TT +CLASS="FILENAME" +>post_bug.cgi</TT >, - a tool to automatically compile source code - into machine-readable form</TD + <TT +CLASS="FILENAME" +>show_bug.cgi</TT +> and + <TT +CLASS="FILENAME" +>process_bug.cgi</TT +>. + </TD ></TR ><TR ><TD ><EM ->Despot</EM +>Documentation</EM >, - a program that controls access to the other Webtools</TD + The bugzilla documentation, including anything in the + <TT +CLASS="FILENAME" +>docs/</TT +> directory and The Bugzilla Guide + (This document :) + </TD ></TR ><TR ><TD ><EM ->LXR</EM +>Email</EM >, - a utility that automatically marks up text files - to make them more readable</TD + Anything to do with email sent by Bugzilla. + <TT +CLASS="FILENAME" +>processmail</TT +> + </TD ></TR ><TR ><TD ><EM ->MozBot</EM +>Installation</EM >, - a "robot" that announces changes to Mozilla in Chat</TD + The installation process of Bugzilla. This includes + <TT +CLASS="FILENAME" +>checksetup.pl</TT +> and whatever else it evolves into. + </TD ></TR ><TR ><TD ><EM ->TestManager</EM +>Query/Buglist</EM >, - a tool to help find bugs in Mozilla</TD + Anything to do with searching for bugs and viewing the buglists. + <TT +CLASS="FILENAME" +>query.cgi</TT +> and + <TT +CLASS="FILENAME" +>buglist.cgi</TT +> + </TD ></TR ><TR ><TD ><EM ->Tinderbox</EM +>Reporting/Charting</EM >, - which displays reports from Build</TD + Getting reports from Bugzilla. + <TT +CLASS="FILENAME" +>reports.cgi</TT +> and + <TT +CLASS="FILENAME" +>duplicates.cgi</TT +> + </TD +></TR +><TR +><TD +><EM +>User Accounts</EM +>, + Anything about managing a user account from the user's perspective. + <TT +CLASS="FILENAME" +>userprefs.cgi</TT +>, saved queries, creating accounts, + changing passwords, logging in, etc. + </TD +></TR +><TR +><TD +><EM +>User Interface</EM +>, + General issues having to do with the user interface cosmetics (not + functionality) including cosmetic issues, HTML templates, etc. + </TD ></TR ></TBODY ></TABLE @@ -600,11 +706,6 @@ BORDER="0" > </P ><P -> A different person is responsible for each of these Components. - Tara Hernandez keeps - the "Bugzilla" component up-to-date. - </P -><P ></P ></DIV ></DIV diff --git a/docs/html/index.html b/docs/html/index.html index 8cc084540..2e51ca844 100644 --- a/docs/html/index.html +++ b/docs/html/index.html @@ -59,7 +59,7 @@ CLASS="AFFILIATION" CLASS="ADDRESS" ><P CLASS="ADDRESS" ->barnboy@NOSPAM.trilobyte.net</P +>barnboy@trilobyte.net</P ></DIV ></DIV ><SPAN @@ -73,7 +73,7 @@ CLASS="AFFILIATION" CLASS="ADDRESS" ><P CLASS="ADDRESS" ->zach@NOSPAM.zachlipton.com</P +>zach AT zachlipton DOT com</P ></DIV ></DIV ><BR></SPAN @@ -409,12 +409,12 @@ HREF="stepbystep.html" ><DL ><DT >3.2.1. <A -HREF="stepbystep.html#AEN486" +HREF="stepbystep.html#AEN509" >Introduction</A ></DT ><DT >3.2.2. <A -HREF="stepbystep.html#AEN492" +HREF="stepbystep.html#AEN515" >Installing the Prerequisites</A ></DT ><DT @@ -429,57 +429,57 @@ HREF="stepbystep.html#INSTALL-PERL" ></DT ><DT >3.2.5. <A -HREF="stepbystep.html#AEN579" +HREF="stepbystep.html#AEN602" >DBI Perl Module</A ></DT ><DT >3.2.6. <A -HREF="stepbystep.html#AEN617" +HREF="stepbystep.html#AEN640" >Data::Dumper Perl Module</A ></DT ><DT >3.2.7. <A -HREF="stepbystep.html#AEN622" +HREF="stepbystep.html#AEN645" >MySQL related Perl Module Collection</A ></DT ><DT >3.2.8. <A -HREF="stepbystep.html#AEN631" +HREF="stepbystep.html#AEN654" >TimeDate Perl Module Collection</A ></DT ><DT >3.2.9. <A -HREF="stepbystep.html#AEN635" +HREF="stepbystep.html#AEN658" >GD Perl Module (1.8.3)</A ></DT ><DT >3.2.10. <A -HREF="stepbystep.html#AEN644" +HREF="stepbystep.html#AEN667" >Chart::Base Perl Module (0.99c)</A ></DT ><DT >3.2.11. <A -HREF="stepbystep.html#AEN648" +HREF="stepbystep.html#AEN671" >DB_File Perl Module</A ></DT ><DT >3.2.12. <A -HREF="stepbystep.html#AEN651" +HREF="stepbystep.html#AEN674" >HTTP Server</A ></DT ><DT >3.2.13. <A -HREF="stepbystep.html#AEN669" +HREF="stepbystep.html#AEN692" >Installing the Bugzilla Files</A ></DT ><DT >3.2.14. <A -HREF="stepbystep.html#AEN696" +HREF="stepbystep.html#AEN721" >Setting Up the MySQL Database</A ></DT ><DT >3.2.15. <A -HREF="stepbystep.html#AEN743" +HREF="stepbystep.html#AEN768" >Tweaking <TT CLASS="FILENAME" >localconfig</TT @@ -487,22 +487,22 @@ CLASS="FILENAME" ></DT ><DT >3.2.16. <A -HREF="stepbystep.html#AEN781" +HREF="stepbystep.html#AEN806" >Setting Up Maintainers Manually (Optional)</A ></DT ><DT >3.2.17. <A -HREF="stepbystep.html#AEN792" +HREF="stepbystep.html#AEN817" >The Whining Cron (Optional)</A ></DT ><DT >3.2.18. <A -HREF="stepbystep.html#AEN802" +HREF="stepbystep.html#AEN827" >Bug Graphs (Optional)</A ></DT ><DT >3.2.19. <A -HREF="stepbystep.html#AEN814" +HREF="stepbystep.html#AEN839" >Securing MySQL</A ></DT ></DL @@ -526,12 +526,12 @@ HREF="geninstall.html" ><DL ><DT >3.5.1. <A -HREF="geninstall.html#AEN916" +HREF="geninstall.html#AEN941" >Modifying Your Running System</A ></DT ><DT >3.5.2. <A -HREF="geninstall.html#AEN923" +HREF="geninstall.html#AEN948" >Upgrading From Previous Versions</A ></DT ><DT @@ -557,7 +557,7 @@ HREF="geninstall.html#CONTENT_TYPE" ></DT ><DT >3.5.6. <A -HREF="geninstall.html#AEN964" +HREF="geninstall.html#UNIXHISTORY" >UNIX Installation Instructions History</A ></DT ></DL @@ -579,6 +579,11 @@ HREF="win32.html#WININSTALL" HREF="win32.html#ADDLWINTIPS" >Additional Windows Tips</A ></DT +><DT +>3.6.3. <A +HREF="win32.html#BZLDAP" +>Bugzilla LDAP Integration</A +></DT ></DL ></DD ></DL @@ -720,6 +725,45 @@ HREF="future.html" >The Future of Bugzilla</A ></DT ><DT +>7. <A +HREF="variants.html" +>Bugzilla Variants and Competitors</A +></DT +><DD +><DL +><DT +>7.1. <A +HREF="rhbugzilla.html" +>Red Hat Bugzilla</A +></DT +><DT +>7.2. <A +HREF="variant_fenris.html" +>Loki Bugzilla (Fenris)</A +></DT +><DT +>7.3. <A +HREF="variant_issuezilla.html" +>Issuezilla</A +></DT +><DT +>7.4. <A +HREF="variant_scarab.html" +>Scarab</A +></DT +><DT +>7.5. <A +HREF="variant_perforce.html" +>Perforce SCM</A +></DT +><DT +>7.6. <A +HREF="variant_sourceforge.html" +>SourceForge</A +></DT +></DL +></DD +><DT >A. <A HREF="faq.html" >The Bugzilla FAQ</A @@ -750,14 +794,14 @@ HREF="dbdoc.html" ><DL ><DT >C.2.1. <A -HREF="dbdoc.html#AEN2217" +HREF="dbdoc.html#AEN2331" >Bugzilla Database Basics</A ></DT ><DD ><DL ><DT >C.2.1.1. <A -HREF="dbdoc.html#AEN2246" +HREF="dbdoc.html#AEN2360" >Bugzilla Database Tables</A ></DT ></DL @@ -772,45 +816,6 @@ HREF="granttables.html" ></DL ></DD ><DT ->7. <A -HREF="variants.html" ->Bugzilla Variants and Competitors</A -></DT -><DD -><DL -><DT ->7.1. <A -HREF="rhbugzilla.html" ->Red Hat Bugzilla</A -></DT -><DT ->7.2. <A -HREF="variant_fenris.html" ->Loki Bugzilla (Fenris)</A -></DT -><DT ->7.3. <A -HREF="variant_issuezilla.html" ->Issuezilla</A -></DT -><DT ->7.4. <A -HREF="variant_scarab.html" ->Scarab</A -></DT -><DT ->7.5. <A -HREF="variant_perforce.html" ->Perforce SCM</A -></DT -><DT ->7.6. <A -HREF="variant_sourceforge.html" ->SourceForge</A -></DT -></DL -></DD -><DT >D. <A HREF="patches.html" >Useful Patches and Utilities for Bugzilla</A @@ -840,6 +845,11 @@ HREF="cmdline.html" HREF="quicksearch.html" >The Quicksearch Utility</A ></DT +><DT +>D.5. <A +HREF="bzhacking.html" +>Hacking Bugzilla</A +></DT ></DL ></DD ><DT @@ -934,67 +944,72 @@ HREF="how.html#AEN307" ><DT >2-2. <A HREF="how.html#AEN317" ->Mozilla Webtools Components</A +>Mozilla's Bugzilla Components</A ></DT ><DT >3-1. <A -HREF="stepbystep.html#AEN685" +HREF="stepbystep.html#AEN708" >Setting up bonsaitools symlink</A ></DT ><DT >3-2. <A -HREF="stepbystep.html#AEN774" +HREF="stepbystep.html#AEN799" >Running checksetup.pl as the web user</A ></DT ><DT >3-3. <A -HREF="win32.html#AEN1012" +HREF="win32.html#AEN1038" >Installing ActivePerl ppd Modules on Microsoft Windows</A ></DT ><DT >3-4. <A -HREF="win32.html#AEN1180" +HREF="win32.html#AEN1224" >Removing encrypt() for Windows NT Bugzilla version 2.12 or earlier</A ></DT ><DT >4-1. <A -HREF="programadmin.html#AEN1413" +HREF="programadmin.html#AEN1461" >Creating some Components</A ></DT ><DT >4-2. <A -HREF="programadmin.html#AEN1442" +HREF="programadmin.html#AEN1490" >Common Use of Versions</A ></DT ><DT >4-3. <A -HREF="programadmin.html#AEN1446" +HREF="programadmin.html#AEN1494" >A Different Use of Versions</A ></DT ><DT >4-4. <A -HREF="programadmin.html#AEN1474" +HREF="programadmin.html#AEN1522" >Using SortKey with Target Milestone</A ></DT ><DT >4-5. <A -HREF="programadmin.html#AEN1510" +HREF="programadmin.html#AEN1558" >When to Use Group Security</A ></DT ><DT >4-6. <A -HREF="programadmin.html#AEN1527" +HREF="programadmin.html#AEN1575" >Creating a New Group</A ></DT ><DT +>4-7. <A +HREF="programadmin.html#AEN1592" +>Bugzilla Groups</A +></DT +><DT >D-1. <A -HREF="setperl.html#AEN2360" +HREF="setperl.html#AEN2439" >Using Setperl to set your perl path</A ></DT ><DT >1. <A -HREF="glossary.html#AEN2602" +HREF="glossary.html#AEN2685" >A Sample Product</A ></DT ></DL diff --git a/docs/html/installation.html b/docs/html/installation.html index 1561b6b5f..5725bb8b8 100644 --- a/docs/html/installation.html +++ b/docs/html/installation.html @@ -90,12 +90,12 @@ HREF="stepbystep.html" ><DL ><DT >3.2.1. <A -HREF="stepbystep.html#AEN486" +HREF="stepbystep.html#AEN509" >Introduction</A ></DT ><DT >3.2.2. <A -HREF="stepbystep.html#AEN492" +HREF="stepbystep.html#AEN515" >Installing the Prerequisites</A ></DT ><DT @@ -110,57 +110,57 @@ HREF="stepbystep.html#INSTALL-PERL" ></DT ><DT >3.2.5. <A -HREF="stepbystep.html#AEN579" +HREF="stepbystep.html#AEN602" >DBI Perl Module</A ></DT ><DT >3.2.6. <A -HREF="stepbystep.html#AEN617" +HREF="stepbystep.html#AEN640" >Data::Dumper Perl Module</A ></DT ><DT >3.2.7. <A -HREF="stepbystep.html#AEN622" +HREF="stepbystep.html#AEN645" >MySQL related Perl Module Collection</A ></DT ><DT >3.2.8. <A -HREF="stepbystep.html#AEN631" +HREF="stepbystep.html#AEN654" >TimeDate Perl Module Collection</A ></DT ><DT >3.2.9. <A -HREF="stepbystep.html#AEN635" +HREF="stepbystep.html#AEN658" >GD Perl Module (1.8.3)</A ></DT ><DT >3.2.10. <A -HREF="stepbystep.html#AEN644" +HREF="stepbystep.html#AEN667" >Chart::Base Perl Module (0.99c)</A ></DT ><DT >3.2.11. <A -HREF="stepbystep.html#AEN648" +HREF="stepbystep.html#AEN671" >DB_File Perl Module</A ></DT ><DT >3.2.12. <A -HREF="stepbystep.html#AEN651" +HREF="stepbystep.html#AEN674" >HTTP Server</A ></DT ><DT >3.2.13. <A -HREF="stepbystep.html#AEN669" +HREF="stepbystep.html#AEN692" >Installing the Bugzilla Files</A ></DT ><DT >3.2.14. <A -HREF="stepbystep.html#AEN696" +HREF="stepbystep.html#AEN721" >Setting Up the MySQL Database</A ></DT ><DT >3.2.15. <A -HREF="stepbystep.html#AEN743" +HREF="stepbystep.html#AEN768" >Tweaking <TT CLASS="FILENAME" >localconfig</TT @@ -168,22 +168,22 @@ CLASS="FILENAME" ></DT ><DT >3.2.16. <A -HREF="stepbystep.html#AEN781" +HREF="stepbystep.html#AEN806" >Setting Up Maintainers Manually (Optional)</A ></DT ><DT >3.2.17. <A -HREF="stepbystep.html#AEN792" +HREF="stepbystep.html#AEN817" >The Whining Cron (Optional)</A ></DT ><DT >3.2.18. <A -HREF="stepbystep.html#AEN802" +HREF="stepbystep.html#AEN827" >Bug Graphs (Optional)</A ></DT ><DT >3.2.19. <A -HREF="stepbystep.html#AEN814" +HREF="stepbystep.html#AEN839" >Securing MySQL</A ></DT ></DL @@ -207,12 +207,12 @@ HREF="geninstall.html" ><DL ><DT >3.5.1. <A -HREF="geninstall.html#AEN916" +HREF="geninstall.html#AEN941" >Modifying Your Running System</A ></DT ><DT >3.5.2. <A -HREF="geninstall.html#AEN923" +HREF="geninstall.html#AEN948" >Upgrading From Previous Versions</A ></DT ><DT @@ -238,7 +238,7 @@ HREF="geninstall.html#CONTENT_TYPE" ></DT ><DT >3.5.6. <A -HREF="geninstall.html#AEN964" +HREF="geninstall.html#UNIXHISTORY" >UNIX Installation Instructions History</A ></DT ></DL @@ -260,6 +260,11 @@ HREF="win32.html#WININSTALL" HREF="win32.html#ADDLWINTIPS" >Additional Windows Tips</A ></DT +><DT +>3.6.3. <A +HREF="win32.html#BZLDAP" +>Bugzilla LDAP Integration</A +></DT ></DL ></DD ></DL diff --git a/docs/html/patches.html b/docs/html/patches.html index e90e3d10f..877cb9134 100644 --- a/docs/html/patches.html +++ b/docs/html/patches.html @@ -10,8 +10,8 @@ REL="HOME" TITLE="The Bugzilla Guide" HREF="index.html"><LINK REL="PREVIOUS" -TITLE="SourceForge" -HREF="variant_sourceforge.html"><LINK +TITLE="MySQL Permissions & Grant Tables" +HREF="granttables.html"><LINK REL="NEXT" TITLE="Apache mod_rewrite magic" HREF="rewrite.html"></HEAD @@ -41,7 +41,7 @@ WIDTH="10%" ALIGN="left" VALIGN="bottom" ><A -HREF="variant_sourceforge.html" +HREF="granttables.html" >Prev</A ></TD ><TD @@ -99,6 +99,11 @@ HREF="cmdline.html" HREF="quicksearch.html" >The Quicksearch Utility</A ></DT +><DT +>D.5. <A +HREF="bzhacking.html" +>Hacking Bugzilla</A +></DT ></DL ></DIV ><P @@ -119,7 +124,7 @@ WIDTH="33%" ALIGN="left" VALIGN="top" ><A -HREF="variant_sourceforge.html" +HREF="granttables.html" >Prev</A ></TD ><TD @@ -144,7 +149,7 @@ HREF="rewrite.html" WIDTH="33%" ALIGN="left" VALIGN="top" ->SourceForge</TD +>MySQL Permissions & Grant Tables</TD ><TD WIDTH="34%" ALIGN="center" diff --git a/docs/html/programadmin.html b/docs/html/programadmin.html index d8409c743..ea2bcbcfc 100644 --- a/docs/html/programadmin.html +++ b/docs/html/programadmin.html @@ -232,7 +232,7 @@ NAME="COMPONENTS" <DIV CLASS="EXAMPLE" ><A -NAME="AEN1413" +NAME="AEN1461" ></A ><P ><B @@ -241,7 +241,7 @@ NAME="AEN1413" ><DIV CLASS="INFORMALEXAMPLE" ><A -NAME="AEN1415" +NAME="AEN1463" ></A ><P ></P @@ -387,7 +387,7 @@ NAME="VERSIONS" <DIV CLASS="EXAMPLE" ><A -NAME="AEN1442" +NAME="AEN1490" ></A ><P ><B @@ -396,7 +396,7 @@ NAME="AEN1442" ><DIV CLASS="INFORMALEXAMPLE" ><A -NAME="AEN1444" +NAME="AEN1492" ></A ><P ></P @@ -418,7 +418,7 @@ NAME="AEN1444" <DIV CLASS="EXAMPLE" ><A -NAME="AEN1446" +NAME="AEN1494" ></A ><P ><B @@ -427,7 +427,7 @@ NAME="AEN1446" ><DIV CLASS="INFORMALEXAMPLE" ><A -NAME="AEN1448" +NAME="AEN1496" ></A ><P ></P @@ -564,7 +564,7 @@ TYPE="1" ><DIV CLASS="EXAMPLE" ><A -NAME="AEN1474" +NAME="AEN1522" ></A ><P ><B @@ -573,7 +573,7 @@ NAME="AEN1474" ><DIV CLASS="INFORMALEXAMPLE" ><A -NAME="AEN1476" +NAME="AEN1524" ></A ><P ></P @@ -787,7 +787,7 @@ NAME="GROUPS" <DIV CLASS="EXAMPLE" ><A -NAME="AEN1510" +NAME="AEN1558" ></A ><P ><B @@ -796,7 +796,7 @@ NAME="AEN1510" ><DIV CLASS="INFORMALEXAMPLE" ><A -NAME="AEN1512" +NAME="AEN1560" ></A ><P ></P @@ -913,7 +913,7 @@ TYPE="1" <DIV CLASS="EXAMPLE" ><A -NAME="AEN1527" +NAME="AEN1575" ></A ><P ><B @@ -922,7 +922,7 @@ NAME="AEN1527" ><DIV CLASS="INFORMALEXAMPLE" ><A -NAME="AEN1529" +NAME="AEN1577" ></A ><P ></P @@ -1043,6 +1043,112 @@ VALIGN="TOP" </P ></LI ></OL +><P +> You may find this example illustrative for how bug groups work. + <DIV +CLASS="EXAMPLE" +><A +NAME="AEN1592" +></A +><P +><B +>Example 4-7. Bugzilla Groups</B +></P +><P +CLASS="LITERALLAYOUT" +>Bugzilla Groups example<br> +-----------------------<br> +<br> +For this example, let us suppose we have four groups, call them<br> +Group1, Group2, Group3, and Group4.<br> +<br> +We have 5 users, User1, User2, User3, User4, User5.<br> +<br> +We have 8 bugs, Bug1, ..., Bug8.<br> +<br> +Group membership is defined by this chart:<br> +(X denotes that user is in that group.)<br> +(I apologize for the nasty formatting of this table. Try viewing<br> +it in a text-based browser or something for now. -MPB)<br> +<br> + G G G G<br> + r r r r<br> + o o o o<br> + u u u u<br> + p p p p<br> + 1 2 3 4<br> + +-+-+-+-+<br> +User1|X| | | |<br> + +-+-+-+-+<br> +User2| |X| | |<br> + +-+-+-+-+<br> +User3|X| |X| |<br> + +-+-+-+-+<br> +User4|X|X|X| |<br> + +-+-+-+-+<br> +User5| | | | |<br> + +-+-+-+-+<br> +<br> +Bug restrictions are defined by this chart:<br> +(X denotes that bug is restricted to that group.)<br> +<br> + G G G G<br> + r r r r<br> + o o o o<br> + u u u u<br> + p p p p<br> + 1 2 3 4<br> + +-+-+-+-+<br> +Bug1| | | | |<br> + +-+-+-+-+<br> +Bug2| |X| | |<br> + +-+-+-+-+<br> +Bug3| | |X| |<br> + +-+-+-+-+<br> +Bug4| | | |X|<br> + +-+-+-+-+<br> +Bug5|X|X| | |<br> + +-+-+-+-+<br> +Bug6|X| |X| |<br> + +-+-+-+-+<br> +Bug7|X|X|X| |<br> + +-+-+-+-+<br> +Bug8|X|X|X|X|<br> + +-+-+-+-+<br> +<br> +Who can see each bug?<br> +<br> +Bug1 has no group restrictions. Therefore, Bug1 can be seen by any<br> +user, whatever their group membership. This is going to be the only<br> +bug that User5 can see, because User5 isn't in any groups.<br> +<br> +Bug2 can be seen by anyone in Group2, that is User2 and User4.<br> +<br> +Bug3 can be seen by anyone in Group3, that is User3 and User4.<br> +<br> +Bug4 can be seen by anyone in Group4. Nobody is in Group4, so none of<br> +these users can see Bug4.<br> +<br> +Bug5 can be seen by anyone who is in _both_ Group1 and Group2. This<br> +is only User4. User1 cannot see it because he is not in Group2, and<br> +User2 cannot see it because she is not in Group1.<br> +<br> +Bug6 can be seen by anyone who is in both Group1 and Group3. This<br> +would include User3 and User4. Similar to Bug5, User1 cannot see Bug6<br> +because he is not in Group3.<br> +<br> +Bug7 can be seen by anyone who is in Group1, Group2, and Group3. This<br> +is only User4. All of the others are missing at least one of those<br> +group priveleges, and thus cannot see the bug.<br> +<br> +Bug8 can be seen by anyone who is in Group1, Group2, Group3, and<br> +Group4. There is nobody in all four of these groups, so nobody can<br> +see Bug8. It doesn't matter that User4 is in Group1, Group2, and<br> +Group3, since he isn't in Group4.<br> + </P +></DIV +> + </P ></DIV ></DIV ><DIV diff --git a/docs/html/quicksearch.html b/docs/html/quicksearch.html index 68596a202..43ae5c20b 100644 --- a/docs/html/quicksearch.html +++ b/docs/html/quicksearch.html @@ -16,8 +16,8 @@ REL="PREVIOUS" TITLE="Command-line Bugzilla Queries" HREF="cmdline.html"><LINK REL="NEXT" -TITLE="GNU Free Documentation License" -HREF="gfdl.html"></HEAD +TITLE="Hacking Bugzilla" +HREF="bzhacking.html"></HEAD ><BODY CLASS="SECTION" BGCOLOR="#FFFFFF" @@ -57,7 +57,7 @@ WIDTH="10%" ALIGN="right" VALIGN="bottom" ><A -HREF="gfdl.html" +HREF="bzhacking.html" >Next</A ></TD ></TR @@ -160,7 +160,7 @@ WIDTH="33%" ALIGN="right" VALIGN="top" ><A -HREF="gfdl.html" +HREF="bzhacking.html" >Next</A ></TD ></TR @@ -182,7 +182,7 @@ HREF="patches.html" WIDTH="33%" ALIGN="right" VALIGN="top" ->GNU Free Documentation License</TD +>Hacking Bugzilla</TD ></TR ></TABLE ></DIV diff --git a/docs/html/setperl.html b/docs/html/setperl.html index b863a204b..1d5384be2 100644 --- a/docs/html/setperl.html +++ b/docs/html/setperl.html @@ -216,7 +216,7 @@ CLASS="COMMAND" <DIV CLASS="EXAMPLE" ><A -NAME="AEN2360" +NAME="AEN2439" ></A ><P ><B diff --git a/docs/html/stepbystep.html b/docs/html/stepbystep.html index 60e0ec84e..2837c7ddc 100644 --- a/docs/html/stepbystep.html +++ b/docs/html/stepbystep.html @@ -78,7 +78,7 @@ CLASS="SECTION" ><H2 CLASS="SECTION" ><A -NAME="AEN486" +NAME="AEN509" >3.2.1. Introduction</A ></H2 ><P @@ -109,7 +109,7 @@ CLASS="SECTION" ><H2 CLASS="SECTION" ><A -NAME="AEN492" +NAME="AEN515" >3.2.2. Installing the Prerequisites</A ></H2 ><DIV @@ -613,7 +613,7 @@ CLASS="SECTION" ><H2 CLASS="SECTION" ><A -NAME="AEN579" +NAME="AEN602" >3.2.5. DBI Perl Module</A ></H2 ><P @@ -642,7 +642,7 @@ HREF="downloadlinks.html" <DIV CLASS="INFORMALEXAMPLE" ><A -NAME="AEN586" +NAME="AEN609" ></A ><P ></P @@ -696,7 +696,7 @@ VALIGN="TOP" <DIV CLASS="INFORMALEXAMPLE" ><A -NAME="AEN593" +NAME="AEN616" ></A ><P ></P @@ -789,7 +789,7 @@ CLASS="SECTION" ><H2 CLASS="SECTION" ><A -NAME="AEN617" +NAME="AEN640" >3.2.6. Data::Dumper Perl Module</A ></H2 ><P @@ -814,7 +814,7 @@ CLASS="SECTION" ><H2 CLASS="SECTION" ><A -NAME="AEN622" +NAME="AEN645" >3.2.7. MySQL related Perl Module Collection</A ></H2 ><P @@ -860,7 +860,7 @@ CLASS="SECTION" ><H2 CLASS="SECTION" ><A -NAME="AEN631" +NAME="AEN654" >3.2.8. TimeDate Perl Module Collection</A ></H2 ><P @@ -882,7 +882,7 @@ CLASS="SECTION" ><H2 CLASS="SECTION" ><A -NAME="AEN635" +NAME="AEN658" >3.2.9. GD Perl Module (1.8.3)</A ></H2 ><P @@ -948,7 +948,7 @@ CLASS="SECTION" ><H2 CLASS="SECTION" ><A -NAME="AEN644" +NAME="AEN667" >3.2.10. Chart::Base Perl Module (0.99c)</A ></H2 ><P @@ -969,7 +969,7 @@ CLASS="SECTION" ><H2 CLASS="SECTION" ><A -NAME="AEN648" +NAME="AEN671" >3.2.11. DB_File Perl Module</A ></H2 ><P @@ -985,7 +985,7 @@ CLASS="SECTION" ><H2 CLASS="SECTION" ><A -NAME="AEN651" +NAME="AEN674" >3.2.12. HTTP Server</A ></H2 ><P @@ -1156,7 +1156,7 @@ CLASS="SECTION" ><H2 CLASS="SECTION" ><A -NAME="AEN669" +NAME="AEN692" >3.2.13. Installing the Bugzilla Files</A ></H2 ><P @@ -1247,7 +1247,7 @@ HREF="patches.html" <DIV CLASS="EXAMPLE" ><A -NAME="AEN685" +NAME="AEN708" ></A ><P ><B @@ -1290,6 +1290,29 @@ bash# ln -s /usr/bin/perl /usr/bosaitools/bin/perl ></TABLE > </P +><P +> Alternately, you can simply run this perl one-liner to + change your path to perl in all the files in your Bugzilla + installation: + <TABLE +BORDER="0" +BGCOLOR="#E0E0E0" +WIDTH="100%" +><TR +><TD +><FONT +COLOR="#000000" +><PRE +CLASS="PROGRAMLISTING" +>perl -pi -e 's@#!/usr/bonsaitools/bin/perl@/usr/bin/perl@' *cgi *pl Bug.pm + </PRE +></FONT +></TD +></TR +></TABLE +> + Change the second path to perl to match your installation. + </P ></DIV > <DIV @@ -1335,7 +1358,7 @@ CLASS="SECTION" ><H2 CLASS="SECTION" ><A -NAME="AEN696" +NAME="AEN721" >3.2.14. Setting Up the MySQL Database</A ></H2 ><P @@ -1573,7 +1596,7 @@ CLASS="SECTION" ><H2 CLASS="SECTION" ><A -NAME="AEN743" +NAME="AEN768" >3.2.15. Tweaking <TT CLASS="FILENAME" >localconfig</TT @@ -1699,7 +1722,7 @@ CLASS="QUOTE" <DIV CLASS="EXAMPLE" ><A -NAME="AEN774" +NAME="AEN799" ></A ><P ><B @@ -1779,7 +1802,7 @@ CLASS="SECTION" ><H2 CLASS="SECTION" ><A -NAME="AEN781" +NAME="AEN806" >3.2.16. Setting Up Maintainers Manually (Optional)</A ></H2 ><P @@ -1829,7 +1852,7 @@ CLASS="SECTION" ><H2 CLASS="SECTION" ><A -NAME="AEN792" +NAME="AEN817" >3.2.17. The Whining Cron (Optional)</A ></H2 ><P @@ -1915,7 +1938,7 @@ CLASS="SECTION" ><H2 CLASS="SECTION" ><A -NAME="AEN802" +NAME="AEN827" >3.2.18. Bug Graphs (Optional)</A ></H2 ><P @@ -1972,7 +1995,7 @@ CLASS="SECTION" ><H2 CLASS="SECTION" ><A -NAME="AEN814" +NAME="AEN839" >3.2.19. Securing MySQL</A ></H2 ><P diff --git a/docs/html/variant_sourceforge.html b/docs/html/variant_sourceforge.html index d26098477..cfbaffb94 100644 --- a/docs/html/variant_sourceforge.html +++ b/docs/html/variant_sourceforge.html @@ -16,8 +16,8 @@ REL="PREVIOUS" TITLE="Perforce SCM" HREF="variant_perforce.html"><LINK REL="NEXT" -TITLE="Useful Patches and Utilities for Bugzilla" -HREF="patches.html"></HEAD +TITLE="The Bugzilla FAQ" +HREF="faq.html"></HEAD ><BODY CLASS="SECTION" BGCOLOR="#FFFFFF" @@ -57,7 +57,7 @@ WIDTH="10%" ALIGN="right" VALIGN="bottom" ><A -HREF="patches.html" +HREF="faq.html" >Next</A ></TD ></TR @@ -117,7 +117,7 @@ WIDTH="33%" ALIGN="right" VALIGN="top" ><A -HREF="patches.html" +HREF="faq.html" >Next</A ></TD ></TR @@ -139,7 +139,7 @@ HREF="variants.html" WIDTH="33%" ALIGN="right" VALIGN="top" ->Useful Patches and Utilities for Bugzilla</TD +>The Bugzilla FAQ</TD ></TR ></TABLE ></DIV diff --git a/docs/html/variants.html b/docs/html/variants.html index 7a679b216..a2405d770 100644 --- a/docs/html/variants.html +++ b/docs/html/variants.html @@ -10,8 +10,8 @@ REL="HOME" TITLE="The Bugzilla Guide" HREF="index.html"><LINK REL="PREVIOUS" -TITLE="MySQL Permissions & Grant Tables" -HREF="granttables.html"><LINK +TITLE="The Future of Bugzilla" +HREF="future.html"><LINK REL="NEXT" TITLE="Red Hat Bugzilla" HREF="rhbugzilla.html"></HEAD @@ -41,7 +41,7 @@ WIDTH="10%" ALIGN="left" VALIGN="bottom" ><A -HREF="granttables.html" +HREF="future.html" >Prev</A ></TD ><TD @@ -133,7 +133,7 @@ WIDTH="33%" ALIGN="left" VALIGN="top" ><A -HREF="granttables.html" +HREF="future.html" >Prev</A ></TD ><TD @@ -158,7 +158,7 @@ HREF="rhbugzilla.html" WIDTH="33%" ALIGN="left" VALIGN="top" ->MySQL Permissions & Grant Tables</TD +>The Future of Bugzilla</TD ><TD WIDTH="34%" ALIGN="center" diff --git a/docs/html/win32.html b/docs/html/win32.html index 32f2515e8..6b639622d 100644 --- a/docs/html/win32.html +++ b/docs/html/win32.html @@ -301,7 +301,7 @@ CLASS="COMMAND" ><DIV CLASS="EXAMPLE" ><A -NAME="AEN1012" +NAME="AEN1038" ></A ><P ><B @@ -1130,7 +1130,9 @@ TARGET="_top" ></LI ><LI ><P -> Modify the invocation of all system() calls in all perl scripts in your Bugzilla directory. For instance, change this line in processmail: +> Modify the invocation of all system() calls in all perl + scripts in your Bugzilla directory. For instance, change + this line in processmail: <TABLE BORDER="0" BGCOLOR="#E0E0E0" @@ -1141,14 +1143,14 @@ WIDTH="100%" COLOR="#000000" ><PRE CLASS="PROGRAMLISTING" ->system ("./processmail.pl",@ARGLIST); +> +system ("./processmail.pl",@ARGLIST); </PRE ></FONT ></TD ></TR ></TABLE -> -to +> to <TABLE BORDER="0" BGCOLOR="#E0E0E0" @@ -1159,7 +1161,8 @@ WIDTH="100%" COLOR="#000000" ><PRE CLASS="PROGRAMLISTING" ->system ("perl processmail.pl",@ARGLIST); +> +system ("perl processmail.pl",@ARGLIST); </PRE ></FONT ></TD @@ -1168,6 +1171,94 @@ CLASS="PROGRAMLISTING" > </P ></LI +><LI +><P +> Add <TT +CLASS="FUNCTION" +>binmode()</TT +> calls so attachments + will work (<A +HREF="http://bugzilla.mozilla.org/show_bug.cgi?id=62000" +TARGET="_top" +>bug 62000</A +>). + </P +><P +> Because Microsoft Windows based systems handle binary + files different than Unix based systems, you need to add + the following lines to + <TT +CLASS="FILENAME" +>createattachment.cgi</TT +> and + <TT +CLASS="FILENAME" +>showattachment.cgi</TT +> before the + <TT +CLASS="FUNCTION" +>require 'CGI.pl';</TT +> line.</P +><P +><TABLE +BORDER="0" +BGCOLOR="#E0E0E0" +WIDTH="100%" +><TR +><TD +><FONT +COLOR="#000000" +><PRE +CLASS="PROGRAMLISTING" +>binmode(STDIN); +binmode(STDOUT);</PRE +></FONT +></TD +></TR +></TABLE +> + </P +><DIV +CLASS="NOTE" +><P +></P +><TABLE +CLASS="NOTE" +WIDTH="100%" +BORDER="0" +><TR +><TD +WIDTH="25" +ALIGN="CENTER" +VALIGN="TOP" +><IMG +SRC="../images/note.gif" +HSPACE="5" +ALT="Note"></TD +><TD +ALIGN="LEFT" +VALIGN="TOP" +><P +> According to <A +HREF="http://bugzilla.mozilla.org/show_bug.cgi?id=62000" +TARGET="_top" +>bug 62000</A +>, the perl documentation says that you should always use <TT +CLASS="FUNCTION" +>binmode()</TT +> when dealing with binary files, but never when dealing with text files. That seems to suggest that rather than aribtrarily putting <TT +CLASS="FUNCTION" +>binmode()</TT +> at the begining of the attachment files, there should be logic to determine if <TT +CLASS="FUNCTION" +>binmode()</TT +> is needed or not. + </P +></TD +></TR +></TABLE +></DIV +></LI ></OL ></DIV ><DIV @@ -1195,7 +1286,9 @@ VALIGN="TOP" relationships to Properties -> Home directory (tab) -> Application Settings (section) -> Configuration (button), such as: - <TABLE + </P +><P +> <TABLE BORDER="0" BGCOLOR="#E0E0E0" WIDTH="100%" @@ -1254,7 +1347,7 @@ VALIGN="TOP" ><P > From Andrew Pearson: <A -NAME="AEN1169" +NAME="AEN1212" ></A ><BLOCKQUOTE CLASS="BLOCKQUOTE" @@ -1272,7 +1365,23 @@ TARGET="_top" registry at the following location: </P ><P -> HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\W3SVC\Parameters\ScriptMap +> <TABLE +BORDER="0" +BGCOLOR="#E0E0E0" +WIDTH="100%" +><TR +><TD +><FONT +COLOR="#000000" +><PRE +CLASS="PROGRAMLISTING" +>HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\W3SVC\Parameters\ScriptMap + </PRE +></FONT +></TD +></TR +></TABLE +> </P ><P > The keys should be called ".pl" and ".cgi", and both @@ -1319,11 +1428,12 @@ VALIGN="TOP" <EM >not necessary</EM > for Bugzilla 2.13 and - later. + later, which includes the current release, Bugzilla + 2.14. <DIV CLASS="EXAMPLE" ><A -NAME="AEN1180" +NAME="AEN1224" ></A ><P ><B @@ -1331,7 +1441,7 @@ NAME="AEN1180" 2.12 or earlier</B ></P ><P -> Replace this: +> Replace this: <TABLE BORDER="0" BGCOLOR="#E0E0E0" @@ -1342,16 +1452,16 @@ WIDTH="100%" COLOR="#000000" ><PRE CLASS="PROGRAMLISTING" -> -SendSQL("SELECT encrypt(" . SqlQuote($enteredpwd) . ", " . SqlQuote(substr($realcryptpwd, 0, 2)) . ")"); -my $enteredcryptpwd = FetchOneColumn(); +> +SendSQL("SELECT encrypt(" . SqlQuote($enteredpwd) . ", " . SQLQuote(substr($realcryptpwd, 0, 2)) . ")"); +my $enteredcryptpwd = FetchOneColumn(); </PRE ></FONT ></TD ></TR ></TABLE -> - with this: +> +with this: <TABLE BORDER="0" BGCOLOR="#E0E0E0" @@ -1362,14 +1472,14 @@ WIDTH="100%" COLOR="#000000" ><PRE CLASS="PROGRAMLISTING" -> -my $enteredcryptpwd = $enteredpwd +> +my $enteredcryptpwd = $enteredpwd </PRE ></FONT ></TD ></TR ></TABLE -> +> in cgi.pl. </P ></DIV @@ -1380,6 +1490,87 @@ my $enteredcryptpwd = $enteredpwd ></TABLE ></DIV ></DIV +><DIV +CLASS="SECTION" +><H2 +CLASS="SECTION" +><A +NAME="BZLDAP" +>3.6.3. Bugzilla LDAP Integration</A +></H2 +><P +> What follows is some late-breaking information on using the + LDAP authentication options with Bugzilla. The author has not + tested these (nor even formatted this section!) so please + contribute feedback to the newsgroup. + </P +><P +CLASS="LITERALLAYOUT" +>Mozilla::LDAP module<br> +<br> +The Mozilla::LDAP module allows you to use LDAP for authentication to<br> +the Bugzilla system. This module is not required if you are not using<br> +LDAP.<br> +<br> +Mozilla::LDAP (aka PerLDAP) is available for download from<br> +http://www.mozilla.org/directory.<br> +<br> +NOTE: The Mozilla::LDAP module requires Netscape's Directory SDK.<br> +Follow the link for "Directory SDK for C" on that same page to<br> +download the SDK first. After you have installed this SDK, then<br> +install the PerLDAP module.<br> +----------------------------------------------------------------------<br> +<br> +Post-Installation Checklist<br> +----------------------------------------------------------------------<br> +Set useLDAP to "On" **only** if you will be using an LDAP directory<br> +for authentication. Be very careful when setting up this parameter;<br> +if you set LDAP authentication, but do not have a valid LDAP directory<br> +set up, you will not be able to log back in to Bugzilla once you log<br> +out. (If this happens, you can get back in by manually editing the<br> +data/params file, and setting useLDAP back to 0.)<br> +<br> +If using LDAP, you must set the three additional parameters:<br> +<br> +Set LDAPserver to the name (and optionally port) of your LDAP server.<br> +If no port is specified, it defaults to the default port of 389. (e.g<br> +"ldap.mycompany.com" or "ldap.mycompany.com:1234")<br> +<br> +Set LDAPBaseDN to the base DN for searching for users in your LDAP<br> +directory. (e.g. "ou=People,o=MyCompany") uids must be unique under<br> +the DN specified here.<br> +<br> +Set LDAPmailattribute to the name of the attribute in your LDAP<br> +directory which contains the primary email address. On most directory<br> +servers available, this is "mail", but you may need to change this.<br> +----------------------------------------------------------------------<br> +<br> +(Not sure where this bit should go, but it's important that it be in<br> +there somewhere...)<br> +----------------------------------------------------------------------<br> +Using LDAP authentication for Bugzilla:<br> +<br> +The existing authentication scheme for Bugzilla uses email addresses<br> +as the primary user ID, and a password to authenticate that user. All<br> +places within Bugzilla where you need to deal with user ID (e.g<br> +assigning a bug) use the email address.<br> +<br> +The LDAP authentication builds on top of this scheme, rather than<br> +replacing it. The initial log in is done with a username and password<br> +for the LDAP directory. This then fetches the email address from LDAP<br> +and authenticates seamlessly in the standard Bugzilla authentication<br> +scheme using this email address. If an account for this address<br> +already exists in your Bugzilla system, it will log in to that<br> +account. If no account for that email address exists, one is created<br> +at the time of login. (In this case, Bugzilla will attempt to use the<br> +"displayName" or "cn" attribute to determine the user's full name.)<br> +<br> +After authentication, all other user-related tasks are still handled<br> +by email address, not LDAP username. You still assign bugs by email<br> +address, query on users by email address, etc.<br> +----------------------------------------------------------------------<br> + </P +></DIV ></DIV ><DIV CLASS="NAVFOOTER" diff --git a/docs/html/dbschema.jpg b/docs/images/dbschema.jpg Binary files differindex 17e2422e5..17e2422e5 100644 --- a/docs/html/dbschema.jpg +++ b/docs/images/dbschema.jpg diff --git a/docs/sgml/dbschema.ps b/docs/images/dbschema.ps index 8952a6834..8952a6834 100644 --- a/docs/sgml/dbschema.ps +++ b/docs/images/dbschema.ps diff --git a/docs/sgml/Bugzilla-Guide.sgml b/docs/sgml/Bugzilla-Guide.sgml index 59befaf0a..8f2136bd8 100644 --- a/docs/sgml/Bugzilla-Guide.sgml +++ b/docs/sgml/Bugzilla-Guide.sgml @@ -26,7 +26,7 @@ <!ENTITY bzg-ver "2.14"> <!ENTITY bzg-cvs-ver "2.15.0"> <!ENTITY bzg-auth "Matthew P. Barnson"> -<!ENTITY bzg-auth-email "<email>barnboy@NOSPAM.trilobyte.net</email>"> +<!ENTITY bzg-auth-email "<email>barnboy@trilobyte.net</email>"> <!ENTITY mysql "http://www.mysql.com/"> <!ENTITY perl-ver "5.6.1"> @@ -126,14 +126,14 @@ try to avoid clutter and feel free to waste space in the code to make it more re <othername>P.</othername> <surname>Barnson</surname> <affiliation> - <address><email>barnboy@NOSPAM.trilobyte.net</email></address> + <address><email>barnboy@trilobyte.net</email></address> </affiliation> </author> <collab> <collabname>Zach Lipton</collabname> <affiliation> - <address><email>zach@NOSPAM.zachlipton.com</email></address> + <address><email>zach AT zachlipton DOT com</email></address> </affiliation> </collab> @@ -196,6 +196,9 @@ try to avoid clutter and feel free to waste space in the code to make it more re <!-- The Future of Bugzilla --> &future; +<!-- Major Bugzilla Variants --> +&variants; + <!-- Appendix: The Frequently Asked Questions --> &faq; @@ -205,9 +208,6 @@ try to avoid clutter and feel free to waste space in the code to make it more re <!-- Appendix: The Database Schema --> &database; -<!-- Appendix: Major Bugzilla Variants --> -&variants; - <!-- Appendix: Custom Patches --> &patches; diff --git a/docs/sgml/about.sgml b/docs/sgml/about.sgml index 89f7bb127..04e054bc2 100644 --- a/docs/sgml/about.sgml +++ b/docs/sgml/about.sgml @@ -70,8 +70,7 @@ <para> If you have any questions regarding this document, its copyright, or publishing this document in non-electronic form, - please contact &bzg-auth;. Remove "NOSPAM" from email address - to send. + please contact &bzg-auth;. </para> </section> @@ -172,8 +171,8 @@ </para> <para> <ulink url="mailto://terry@mozilla.org">Terry Weissman</ulink> - for initially converting Bugzilla from BugSplat! and writing the - README upon which this documentation is largely based. + for initially writing Bugzilla and creating the + README upon which the UNIX installation documentation is largely based. </para> <para> <ulink url="mailto://tara@tequilarista.org">Tara @@ -204,7 +203,8 @@ documentation (in no particular order): </para> <para> - Andrew Pearson, Spencer Smith, Eric Hanson, Kevin Brannen, Ron Teitelbaum + Andrew Pearson, Spencer Smith, Eric Hanson, Kevin Brannen, Ron + Teitelbaum, Jacob Steenhagen, Joe Robins </para> </section> <section id="feedback"> diff --git a/docs/sgml/administration.sgml b/docs/sgml/administration.sgml index 54f984fbc..98e726312 100644 --- a/docs/sgml/administration.sgml +++ b/docs/sgml/administration.sgml @@ -1192,6 +1192,103 @@ </para> </listitem> </orderedlist> + <para> + You may find this example illustrative for how bug groups work. + <example> + <title>Bugzilla Groups</title> + <literallayout> +Bugzilla Groups example +----------------------- + +For this example, let us suppose we have four groups, call them +Group1, Group2, Group3, and Group4. + +We have 5 users, User1, User2, User3, User4, User5. + +We have 8 bugs, Bug1, ..., Bug8. + +Group membership is defined by this chart: +(X denotes that user is in that group.) +(I apologize for the nasty formatting of this table. Try viewing +it in a text-based browser or something for now. -MPB) + + G G G G + r r r r + o o o o + u u u u + p p p p + 1 2 3 4 + +-+-+-+-+ +User1|X| | | | + +-+-+-+-+ +User2| |X| | | + +-+-+-+-+ +User3|X| |X| | + +-+-+-+-+ +User4|X|X|X| | + +-+-+-+-+ +User5| | | | | + +-+-+-+-+ + +Bug restrictions are defined by this chart: +(X denotes that bug is restricted to that group.) + + G G G G + r r r r + o o o o + u u u u + p p p p + 1 2 3 4 + +-+-+-+-+ +Bug1| | | | | + +-+-+-+-+ +Bug2| |X| | | + +-+-+-+-+ +Bug3| | |X| | + +-+-+-+-+ +Bug4| | | |X| + +-+-+-+-+ +Bug5|X|X| | | + +-+-+-+-+ +Bug6|X| |X| | + +-+-+-+-+ +Bug7|X|X|X| | + +-+-+-+-+ +Bug8|X|X|X|X| + +-+-+-+-+ + +Who can see each bug? + +Bug1 has no group restrictions. Therefore, Bug1 can be seen by any +user, whatever their group membership. This is going to be the only +bug that User5 can see, because User5 isn't in any groups. + +Bug2 can be seen by anyone in Group2, that is User2 and User4. + +Bug3 can be seen by anyone in Group3, that is User3 and User4. + +Bug4 can be seen by anyone in Group4. Nobody is in Group4, so none of +these users can see Bug4. + +Bug5 can be seen by anyone who is in _both_ Group1 and Group2. This +is only User4. User1 cannot see it because he is not in Group2, and +User2 cannot see it because she is not in Group1. + +Bug6 can be seen by anyone who is in both Group1 and Group3. This +would include User3 and User4. Similar to Bug5, User1 cannot see Bug6 +because he is not in Group3. + +Bug7 can be seen by anyone who is in Group1, Group2, and Group3. This +is only User4. All of the others are missing at least one of those +group priveleges, and thus cannot see the bug. + +Bug8 can be seen by anyone who is in Group1, Group2, Group3, and +Group4. There is nobody in all four of these groups, so nobody can +see Bug8. It doesn't matter that User4 is in Group1, Group2, and +Group3, since he isn't in Group4. + </literallayout> + </example> + </para> </section> </section> diff --git a/docs/sgml/database.sgml b/docs/sgml/database.sgml index aee9b37e5..7ff52134c 100644 --- a/docs/sgml/database.sgml +++ b/docs/sgml/database.sgml @@ -13,7 +13,7 @@ <para> <mediaobject> <imageobject> - <imagedata fileref="dbschema.jpg" format="jpg"> + <imagedata fileref="../images/dbschema.jpg" format="jpg"> </imageobject> <textobject> diff --git a/docs/sgml/dbschema.jpg b/docs/sgml/dbschema.jpg Binary files differdeleted file mode 100644 index 17e2422e5..000000000 --- a/docs/sgml/dbschema.jpg +++ /dev/null diff --git a/docs/sgml/faq.sgml b/docs/sgml/faq.sgml index 34b952b01..79fa528c4 100644 --- a/docs/sgml/faq.sgml +++ b/docs/sgml/faq.sgml @@ -620,6 +620,12 @@ progression states, also require adjusting the program logic to compensate for the change. </para> + <para> + There is no GUI for adding fields to Bugzilla at this + time. You can follow development of this feature at + <ulink + url="http://bugzilla.mozilla.org/show_bug.cgi?id=91037">http://bugzilla.mozilla.org/show_bug.cgi?id=91037</ulink> + </para> </answer> </qandaentry> @@ -633,42 +639,62 @@ </para> </question> <answer> - <para> - This was a late-breaking question for the Guide, so I just have to - quote the relevant newsgroup thread on it. - </para> - <literallayout> -> AFAIK, most sites (even if they have SSI enabled) won't have #exec cmd -> enabled. Perhaps what would be better is a #include virtual and a -> footer.cgi the basically has the "require 'CGI.pl' and PutFooter command. -> -> Please note that under most configurations, this also requires naming -> the file from index.html to index.shtml (and making sure that it will -> still be reconized as an index). Personally, I think this is better on -> a per-installation basis (perhaps add something to the FAQ that says how -> to do this). - -Good point. Yeah, easy enough to do, that it shouldn't be a big deal for -someone to take it on if they want it. FAQ is a good place for it. - -> Dave Miller wrote: -> ->> I did a little experimenting with getting the command menu and footer on ->> the end of the index page while leaving it as an HTML file... ->> ->> I was successful. :) ->> ->> I added this line: ->> ->> <!--#exec cmd="/usr/bin/perl -e "require 'CGI.pl'; ->>PutFooter();"" --> ->> ->> Just before the </BODY> </HTML> at the end of the file. And it worked. ->> ->> Thought I'd toss that out there. Should I check this in? For those that ->> have SSI disabled, it'll act like a comment, so I wouldn't think it would ->> break anything. - </literallayout> + <para> + It's possible to get the footer on the static index page using + Server Side Includes (SSI). The trick to doing this is making + sure that your web server is set up to allow SSI and specifically, + the #exec directive. You should also rename <filename>index.html</filename> + to <filename>index.shtml</filename>. + </para> + <para> + After you've done all that, you can add the following line to + <filename>index.shtml</filename>: +<programlisting> +<![CDATA[ +<!--#exec cmd="/usr/bin/perl -e "require 'CGI.pl'; PutFooter();"" --> +]]> +</programlisting> + </para> + <para><note> + <para> + This line will be replaced with the actual HTML for the footer + when the page is requested, so you should put this line where you + want the footer to appear. + </para> + </note></para> + <para> + Because this method depends on being able to use a #exec directive, + and most ISP's will not allow that, there is an alternative method. + You could have a small script (such as <filename>api.cgi</filename>) + that basically looks like: +<programlisting> +<![CDATA[ +#!/usr/bonsaitools/bin/perl -w + +require 'globals.pl'; + +if ($::FORM{sub} eq 'PutFooter') { + PutFooter(); +} else { + die 'api.cgi was incorrectly called'; +} +]]> +</programlisting> + and then put this line in <filename>index.shtml</filename>. +<programlisting> +<![CDATA[ +<!--#include virtual="api.cgi?sub=PutFooter"--> +]]> +</programlisting> + </para> + <para> <note> + <para> + This still requires being able to use Server Side Includes, if + this simply will not work for you, see <ulink + url="http://bugzilla.mozilla.org/show_bug.cgi?id=80183">bug 80183</ulink> + for a third option. + </para> + </note></para> </answer> </qandaentry> <qandaentry> @@ -807,21 +833,6 @@ someone to take it on if they want it. FAQ is a good place for it. <qandaentry> <question> <para> - Does Bugzilla allow fields to be added, changed or deleted? If I want to - customize the bug submission form to meet our needs, can I do that using our - terminology? - </para> - </question> - <answer> - <para> - Yes. - </para> - </answer> - </qandaentry> - - <qandaentry> - <question> - <para> Has anyone converted Bugzilla to another language to be used in other countries? Is it localizable? </para> @@ -1221,20 +1232,11 @@ someone to take it on if they want it. FAQ is a good place for it. <para> If you are using an alternate Mail Transport Agent (MTA other than sendmail), make sure the options given in the "processmail" script for all - instances of "sendmail" are correct for your MTA. If you are using Sendmail, - you may wish to delete the "-ODeliveryMode=deferred" option in the - "processmail" script for every invocation of "sendmail". (Be sure and leave - the "-t" option, though!) - </para> - <para> - A better alternative is to change the "-O" option to - "-ODeliveryMode=background". This prevents Sendmail from hanging your - Bugzilla Perl processes if the domain to which it must send mail - is unavailable. + instances of "sendmail" are correct for your MTA. </para> <para> - This is now a configurable parameter called "sendmailnow", available - from editparams.cgi. + If you are using Sendmail, try enabling "sendmailnow" in editparams.cgi. + If you are using Postfix, you will also need to enable <quote>sendmailnow</quote>. </para> </answer> </qandaentry> @@ -1315,12 +1317,21 @@ someone to take it on if they want it. FAQ is a good place for it. </question> <answer> <para> - Run the "sanity check" utility (./sanitycheck.cgi in the bugzilla_home - directory) to see! If it all comes back, you're OK. If it doesn't come back - OK (i.e. any red letters), there are certain things Bugzilla can recover - from and certain things it can't. If it can't auto-recover, I hope you're - familiar with mysqladmin commands or have installed another way to manage - your database... + Run the <quote>sanity check</quote> utility + (<filename>./sanitycheck.cgi</filename> in the + Bugzilla_home directory) from your web browser to see! If + it finishes without errors, you're + <emphasis>probably</emphasis> OK. If it doesn't come back + OK (i.e. any red letters), there are certain things + Bugzilla can recover from and certain things it can't. If + it can't auto-recover, I hope you're familiar with + mysqladmin commands or have installed another way to + manage your database. Sanity Check, although it is a good + basic check on your database integrity, by no means is a + substitute for competent database administration and + avoiding deletion of data. It is not exhaustive, and was + created to do a basic check for the most common problems + in Bugzilla databases. </para> </answer> </qandaentry> @@ -1428,10 +1439,12 @@ someone to take it on if they want it. FAQ is a good place for it. </question> <answer> <para> - Delete everything from $BUZILLA_HOME/shadow. Bugzilla creates shadow - files there, with each filename corresponding to a - bug number. Also be sure to run syncshadowdb to make sure, if you are using - a shadow database, that the shadow database is current. + This should only happen with Bugzilla &bz-ver; if you are + using the <quote>shadow database</quote> feature, and your + shadow database is out of sync. Try running + <filename>syncshadowdb</filename> + <option>-syncall</option> to make sure your shadow + database is in synch with your primary database. </para> </answer> </qandaentry> @@ -1752,14 +1765,14 @@ A: Sure! Here ya go! </question> <answer> <para> - Try <ulink url="http://bugzilla.mozilla.org/buglist.cgi?bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&product=Webtools&component=Bugzilla"> + Try <ulink url="http://bugzilla.mozilla.org/buglist.cgi?bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&product=Bugzilla"> this link</ulink> to view current bugs or requests for enhancement for Bugzilla. </para> <para> - You can view bugs marked for 2.14 release - <ulink url="http://bugzilla.mozilla.org/buglist.cgi?product=Webtools&component=Bugzilla&target_milestone=Bugzilla+2.14">here</ulink>. - This list includes bugs for the 2.14 release that have already + You can view bugs marked for 2.16 release + <ulink url="http://bugzilla.mozilla.org/buglist.cgi?product=Bugzilla&target_milestone=Bugzilla+2.16">here</ulink>. + This list includes bugs for the 2.16 release that have already been fixed and checked into CVS. Please consult the <ulink url="http://www.mozilla.org/projects/bugzilla/"> Bugzilla Project Page</ulink> for details on how to @@ -1800,8 +1813,9 @@ A: Sure! Here ya go! <orderedlist> <listitem> <para> - Enter a bug into bugzilla.mozilla.org for the "Webtools" product, - "Bugzilla" component. + Enter a bug into bugzilla.mozilla.org for the <quote><ulink + url="http://bugzilla.mozilla.org/enter_bug.cgi?product=Bugzilla">Bugzilla</ulink></quote> + product. </para> </listitem> <listitem> diff --git a/docs/sgml/future.sgml b/docs/sgml/future.sgml index 1f4681a31..54f191349 100644 --- a/docs/sgml/future.sgml +++ b/docs/sgml/future.sgml @@ -4,11 +4,595 @@ <title>The Future of Bugzilla</title> <synopsis>Bugzilla's Future. Much of this is the present, now.</synopsis> <para> - The future of Bugzilla is Bugzilla 3.0. Unfortunately, I do - not have more information about it right now, and most of what - went into the "future" section is now present. That stuff was - blue-sky a year ago; MattyT should have me a new document - sometime... + Bugzilla's future is a constantly-changing thing, as various developers + <quote>scratch an itch</quote> when it comes to functionality. + Thus this section is very malleable, subject to change without notice, etc. + You'll probably also notice the lack of formatting. I apologize that it's + not quite as readable as the rest of the Guide. + </para> + <para> + <literallayout> + Bugzilla Blue Sky + +Customisability + + One of the major stumbling blocks of Bugzilla has been that it is too + rigid and does not adapt itself well enough to the needs of an + organisation. This has led to organisations making changes to the + Bugzilla code that need to be redone each new version of Bugzilla. + Bugzilla should attempt to move away from this to a world where this + doesn't need to occur. + + Most of the subsections in this section are currently explicit design + goals for the "Bugzilla 3" rewrite. This does not necessarily mean + that they will not occur before them in Bugzilla 2, but most are + significant undertakings. + + Field Customisation + + Many installations wish to customise the fields that appear on bug + reports. Current versions of Bugzilla offer limited + customisability. In particular, some fields can be turned off. + + However, many administrators wish to add their own fields, and rename + or otherwise modify existing fields. An architecture that supports + this would be extraordinarily useful. + + Indeed, many fields work similarly and could be abstracted into "field + types", so that an administrator need write little or no code to + support the new fields they desire. + + Possible field types include text (eg status whiteboard), numbers, + dates (eg report time), accounts (eg reporter, qa, cc), inter-bug + relationships (dependencies, duplicates), option groups (platform, os, + severity, priority, target milestone, version) etc. + + Ideally an administrator could configure their fields through a + Bugzilla interface that requires no code to be added. However, it is + highly unlikely this ideal will never be met, and in a similar way + that office applications have scripting languages, Bugzilla should + allow new field types to be written. + + Similarly, a common desire is for resolutions to be added or removed. + + Allocations + + ? + + Option Groups + + ? + + Relations + + ? + + Database Integrity + + Furthermore, it is desirable for administrators to be able to specify + rules that must or should apply between the fields on a bug report. + + For example, you might wish to specify that a bug with status ASSIGNED + must have a target milestone field that that is not untargetted. Or + that a bug with a certain number of votes should get ASSIGNED. Or + that the QA contact must be different from the assignee. + + "Must" relationships could be implemented by refusing to make changes + that violate the relationships, or alternatively, automatically + updating certain fields in order to satisfy the criteria. Which + occurs should be up to the administrator. + + "Should" relationships could be implemented by a combination of + emitting warnings on the process bug page, the same on notification + mails, or emitting periodic whine mails about the situation. Again, + which occurs should be up to the administrator. + + It should also be possible for whine mails to be emitted for "must" + relationships, as they might become violated through direct database + access, Bugzilla bugs, or because they were there before the + relationship was enforced. + + As well as implementing intra-bug constraints, it would be useful to + create inter-bug constraints. For example, a bug that is dependent on + another bug should not have an earlier milestone or greater priority + than that bug. + + Database Adaptability + + Often an administrator desires that fields adapt to the values of + other fields. For example, the value of a field might determine the + possible values of another field or even whether it appears (whether + it is "applicable"). + + Limited adaptability is present in Bugzilla 2, and only on the + "Product" field: + * The possible values of the target milestone, version and component + fields depend on the product. + * UNCONFIRMED can be turned off for specific products. + * Voting can be configured differently or turned off for different + products, and there is a separate user vote limits for each + product. + + It would be good if more adaptability was present, both in terms of + all fields relying on the product, as well as the ability to adapt + based on the value of all fields. + + Example ??? + + General adaptability raises the issue of circular references between + fields causing problems. One possible solution to this is to place + the fields in a total ordering and require a field refer only to the + previous fields. + + In Bugzilla 2, changing the product of a bug meant a second page would + appear that allowed you to choose a new milestone, component and + version, as those fields adapted themselves to the new product. This + page could be generalised to support all instances where: + * a field value must or might be changed because the possible values + have changed + * is going to drop off because it it is no longer applicable, and + this should be confirmed + * must be specified because it is suddenly applicable, and the + default value, if one exists, might not be acceptable + + Database Independence + + Currently Bugzilla only runs on the MySQL database. It would be + desirable for Bugzilla to run on other databases, because: + * Organisations may have existing database products they use and + would prefer to run a homogenous environment. + * Databases each have their own shortcomings, including MySQL. An + administrator might choose a database that would work better with + their Bugzilla. + + This raises the possibility that we could use features that are only + present in some databases, by appropriately falling back. For + example, in the MySQL world, we live without: + * record-level locking, instead we use table-level locking + * referential and record constraints, instead we checking code + * subselects, instead we use multiple queries and redundant "caches" + + Multiple Front Ends + + Currently Bugzilla is manipulated via the Web, and notifies via + E-Mail. It would be desirable for Bugzilla to easily support various + front ends. + + There is no reason that Bugzilla could not be controlled via a whole + range of front ends, including Web, E-Mail, IRC, ICQ, etc, and + similarly for how it notifies. It's also possible that we could + introduce a special Bugzilla client that uses its own protocol, for + maximum user productivity. + + Indeed a request reply might be returned via a totally different + transport method than was use to submit the request. + +Internationalisation + + Bugzilla currently supports only English. All of the field names, + user instructions, etc are written in English. It would be desirable + to allow "language packs" so Bugzilla can be easily used in + non-English speaking locales. + + To a degree field customisation supports this, because administrators + could specify their own fields names anyway. However, there will + always be some basic facilities not covered by this, and it is + desirable that the administrator's interface also is + internationalisable. + +Better Searching + + General Summary Reports + + Sometimes, the normal querying page leaves a lot to be desired. There + are other facilities already in place or which people have asked for: + + Most Doomed Reports - All Bugs or All Bugs In A Product, Categorised + On Assignee, Shows and Counts Number of Bugs For Each Assignee + Most Voted For Bugs - All Bugs, Categorised On Product, Shows Top Ten + Bugs Voters Most Want Fixed + Number of Open Bugs For An Assignee - Bug List, Categorised On + Developers, Counts Number of Bugs In Category + + The important thing to realise is that people want categorised reports + on all sorts of things - a general summary report. + + In a categorised report, you choose the subset of bugs you wish to + operate on (similar to how you would specify a query), and then + categorise them on one or more fields. + + For each category you display the count of the number of things in + that category. You can optionally display the bugs themselves, or + leave them out, just showing the counts. And you can optionally limit + the number of things (bugs or subcategories) that display in each + category. + + Such a mechanism would let you do all of the above and more. + Applications of this mechanism would only be recognised once it was + implemented. + + Related Bugs + + It would be nice to have a field where you could enter other bugs + related to the current bug. It would be handy for navigation and + possibly even finding duplicates. + + Column Specification Support + + Currently bug lists use the columns that you last used. This doesn't + work well for "prepackaged queries", where you followed a link. You + can probably add a column by specifying a sort column, but this is + difficult and suboptimal. + + Furthermore, I find that when I want to add a column to a bug list, + it's usually a one off and I would prefer it to go away for the next + query. Hence, it would be nice to specify the columns that appear on + the bug list (and general summary report) pages. The default query + mechanism should be able to let you specify your default columns. + + Advanced Querying Redesign + + ? + +Keywords + + People have a need to apply tags to bugs. In the beginning, people + placed designators in the summary and status whiteboard. However, + these fields were not designed for that, and so there were many flaws + with this system: + * They pollute the field with information that was never intended to + be present. + * Removing them with a bulk change is a difficult problem that has + too many pitfalls to implement. + * You can easily get the capitalisation wrong. + + Then dependencies were introduced (when?), and people realised that + they could use them for "tracking bugs". Again, dependencies were not + designed for that, and so there were more flaws, albeit different + ones, including: + * They aren't really bugs, so it's difficult to distinguish issues + from bugs. + * They can pollute bugs counts, and you must somehow exclude them + from queries. + * There is a whole lot of useless information on them. They have an + assignee but there is nothing to fix, and that person can get + whined at by Bugzilla. They have target milestones which must be + manually maintained. And so on. + + Finally, keywords were introduced (when?) for this purpose to remove + the need for these two systems. Unfortunately, the simple keywords + implementation was itself lacking in certain features provided by the + two previous systems, and has remained almost unchanged since its + inception. Furthermore, it could not be forseen that in large + installations, the sheer number of keywords could become unwieldly and + could lead to a movement back to the other systems. + + The keywords system was the right idea, however, and it remains so. + Fixing the keywords system is one of the most important Bugzilla + issues. + + Bringing Keywords Up To Par + + For the most part, keywords are very good at what they do. It is easy + to add and remove them (unlike summary/whiteboard designators), we can + simply see what issues are present on a bug (unlike tracking bugs), + and we do not confuse bugs with issues (unlike tracking bugs). + + However, there are still some "regressions" in the keyword system over + previous systems: + * Users wish to view the "dependency forest" of a keyword. While a + dependency tree is of one bug, a dependency forest is of a bug + list, and consists of a dependency tree for each member of the bug + list. Users can work around this with tracking bugs by creating a + tracking bug and viewing the dependency tree of that tracking bug. + * Users wish to specify the keywords that initially apply to a bug, + but instead they must edit the bug once it has already been + submitted. They can work around this with summary designators, + since they specify the summary at reporting time. + * Users wish to store or share a bug list that contains a keywords + column. Hence they wish to be able to specify what columns appear + in the bug list URL, as mentioned earlier. They can work around + this using summary designators, since almost all bug lists have a + summary column. + * Users wish to be able to view keywords on a bug list. However + often they are only interested in a small number of keywords. + Having a bug list with a keywords column means that all keywords + will appear on a bug list. This can take a substantial amount of + space where a bug has a lot of keywords, since the table columns + in Bugzilla adjust to the largest cell in that column. Hence + users wish to be able to specify which keywords should appear in + the bug list. In a very real sense, each keyword is a field unto + itself. Users can work around this by using summary designators, + since they keywords will share the space in the summary column. + * Users wish to know when bugs with a specific issue are resolved. + Hence they wish to be able to receive notifications on all the + bugs with a specific keyword. The introduction a generic watching + facility (also for things like watching all bugs in a component) + would achieve this. Users can work around this by using tracking + bugs, as dependencies have an existing way of detecting fixes to + bug a bug was blocked by. + + Dealing With The Keyword Overload + + At the time of writing, the mozilla.org installation has approximately + 100 keywords, and many more would be in use if the keywords system + didn't have the problems it does. + + Such a large number of keywords introduces logistical problems: + * It must be easy for someone to learn what a keyword means. If a + keyword is buried within a lot of other keywords, it can be + difficult to find. + * It must be easy to see what keywords are on a bug. If the number + of keywords is large, then this can be difficult. + + These lead some people to feel that there are "too many keywords". + + These problems are not without solutions however. It is harder to + find a list of designators or tracking bugs than it is a list of + keywords. + + The essential problem is it needs to be easy to find the keywords + we're interested in through the mass of keywords. + + Keyword Applicability + + As has been previously mentioned, it is desirable for fields to be + able to adapt to the values of other fields. This is certainly true + for keywords. Many keywords are simply not relevant because of the + bugs product, component, etc. + + Hence, by introducing keyword applicability, and not displaying + keywords that are not relevant to the current bug, or clearly + separating them, we can make the keyword overload problem less + significant. + + Currently when you click on "keywords" on a bug, you get a list of all + bugs. It would be desirable to introduce a list of keywords tailored + to a specific bug, that reports, in order: + * the keywords currently on the bug + * the keywords not currently on the bug, but applicable to the bug + * optionally, the keywords not applicable to the bug + + This essentially orders the keywords into three groups, where each + group is more important than the previous, and therefore appears + closer to the top. + + Keyword Grouping & Ordering + + We could further enhance both the global and bug specific keyword list + by grouping keywords. We should always have a "flat" view of + keywords, but other ways of viewing the keywords would be useful too. + + If keyword applicability was implemented, we could group keywords + based on their "applicability condition". Keywords that apply to all + bugs could be separated from keywords that apply to a specific + product, both on the global keyword list and the keyword list of a bug + that is in that product. + + We could specify groups of our own. For example, many keywords are in + a mutually exclusive group, essentially like radio buttons in a user + interface. This creates a natural grouping, although other groupings + occur (which depends on your keywords). + + It is possible that we could use collapsing/expanding operations on + "twisties" to only should the groups we are interested in. + + And instead of grouping keywords, we could order them on some metric + of usefulness, such as: + * when the keyword was last added to a bug + * how many bugs the keyword is on + * how many open bugs the keyword is on + + Opting Out Of Keywords + + Not all people are going to care about all keywords. Therefore it + makes sense that you may wish to specify which keywords you are + interested in, either on the bug page, or on notifications. + + Other keywords will therefore not bother users who are not interested + in them. + + Keyword Security + + Currently all keywords are available and editable to all people with + edit bugs access. This situation is clearly suboptimal. + + Although relying on good behaviour for people to not do what they + shouldn't works reasonably well on the mozilla.org, it is better to + enforce that behaviour - it can be breached through malice, accident + or ignorance. + + And in the situation where it is desirable for the presence or absence + of a keyword not to be revealed, organisations either need to be + content with the divulgence, or not use keywords at all. + + In the situation where they choose to divulge, introducing the ability + to restrict who can see the keyword would also reduce keyword + overload. + + Personal Keywords + + Keywords join together a set of bugs which would otherwise be + unrelated in the bug system. + + We allow users to store their own queries. However we don't allow + them to store their own keywords on a bug. This reduces the + usefulness of personal queries, since you cannot join a set of + unrelated bugs together in a way that you wish. Lists of bug numbers + can work, by they can only be used for small lists, and it is + impossible to share a list between multiple queries. + + Personal keywords are necessary to replace personal tracking bugs, as + they would not pollute the keyword space. Indeed, on many + installations this could remove some keywords out of the global + keyword space. + + In a similar vein and with similar effects, group keywords could be + introduced that are only available to members of a specific group. + + Keyword Restrictions + + Keywords are not islands unto themselves. Along with their potential + to be involved in the inter-field relationships mentioned earlier, + keywords can also be related to other keywords. + + Essentially, there are two possibilities: + * a set of keywords are mutually exclusive + * the presence of a keyword implies another keyword must be present + + Introduction of the ability to specify these restrictions would have + benefits. + + If mutually exclusive keywords were present on a bug, their removal + would fix up the database, as well as reducing the number of keywords + on that bug. + + In the situation where a keyword implies another keyword, there are + two possiblities as to how to handle the situation. + + The first is automatically add the keyword. This would fix up the + database, but it would increase the number of keywords on a bug. + + The second is to automatically remove the keyword, and alter queries + so they pick up the first keyword as well as the removed keyword. + This would fix up the database and reduce the number of keywords on a + bug, but it might confuse users who don't see the keyword. + Alternatively, the implied keywords could be listed separately. + +Notifications + + Every time a bug gets changed notifications get sent out to people + letting them know about what changes have been made. This is a + significant feature, and all sorts of questions can be raised, but + they mainly boil down to when they should be sent and what they should + look like. + + Changes You're Interested In + + As of version 2.12 users can specify what sort of changes they are + interested in receiving notifications for. However, this is still + limited. As yet there is no facility to specify which keywords you + care about, and whether you care about changes to fields such as the + QA contact changes. + Furthermore, often an unnecessary comment will go along with a change, + either because it is required, or the commenter is ignorant of how the + new system works. While explaining why you did something is useful, + merely commenting on what you did is not because that information is + already accessible view "Bug Activity". + + Because of this unnecessary comment, a lot of changes that would + otherwise not generate notifications for certain people do so, because + few people are willing to turn off comments. One way to deal with + this problem is to allow people to specify that their comments are + purely explanatory, and that anyone who is not interested in the + change will not be interested in the comment. + + Furthermore, one possible rationale for unnecessary comments is that + the bug activity does not display on the normal page and hence it is + difficult to cross reference comments and actions. Hence, it would be + beneficial to be able to do this. + + Bugs You're Watching + + Currently to receive a notification about a bug you need to have your + name on it. This is suboptimal because you need to know about a bug + before you can receive notifications on it. Often you are interested + in any bug with a field set to a specific value. For example, you + might be interested in all bugs with a specific product, component or + keyword. + + If someone could automatically receive notifications about these bugs, + it would make everyone's lives easier. Currently the default assignee + and QA contact for a component will automatically receive + notifications for + + Question: This moves half way to a BCC. + + Bulk Changes + + A very useful feature of Bugzilla is the ability to perform an action + on multiple bugs at once. However, this means that similar + notifications are currently generated for each bug modified. + + This can result in a torrent of notifications that can annoy. + + Furthermore, since the bugs are all changed close to each other in + time, it is easy for someone to mass delete all the notifications + generated by a bulk change and miss an unrelated notification in the + middle. + + These factors can lead to a tendency for people to delay bulk changes, + or avoid them entirely. This is suboptimal. + + It would be better if a bulk change generated only one notification + mail. This would vastly reduce the annoyance factor, and prevent + accidental deletion of notifications. + + One problem with this change is that some people separate out + notifications using filtering. This means that they would no longer + be match parts of a bulk change under different filtering rules. + + One possibility to resolve this is to allow people to specify groups + of bugs. All bugs within a group would go into the same + notification. The filters could then distinguish the different bug + groups. + + In any case, it is likely there would need to be a transition period + to allow people to alter their filters. + +Nominations + + ? + +Linking Bugzilla Installations + + The first example of linking Bugzilla installations together has is + the introduction of bug moving in version 2.12. However, it would be + useful to be able to link installations in more ways. + * Dependencies and other relationships between bugs in other + installations. This is difficult because dependencies are + synchronised on both bugs, so the installation that changes + dependencies would need to communicate the new state to the other + installation. It would also mean that relationships and + notifications that refer to other bugs would need to communicate + with the other installation. + * References to bugs in other installations. Currently if you type + "bug XXX" or "bug #XXX" where XXX is a number, you get an + automatic hyperlink to that bug. It would be useful if you could + say "YYY bug #XXX" where YYY is the name of another installation. + +Retirement + + ? + +Whiny Reports + + ? + + Group Redesign + + ? + + Hard Wrapping Comments + + Currently Bugzilla "hard wraps" its comments to a specific line size, + similar to E-Mail. This has various problems: + * The way it currently works, wrapping is done in the browser at + submission time using a non-standard HTML extension not supported + by some (uncommon) browsers. These browsers generate comments + that scroll off the right side of the screen. + * Because comments are of fixed width, when you expand your browser + window, the comments do not expand to fit available space. + + It would be much better to move to a world of soft wrapping, where the + browser wraps the text at display time, similar to a world processor. + And as in a word processor, soft wrapping does not preclude the + insertion of newlines. + + Hard wrapping is too entrenched into text E-Mail to fix, but we can + fix Bugzilla without causing any problems. The old content will still + be wrapped too early, but at least new content will work. + </literallayout> </para> </chapter> @@ -32,3 +616,4 @@ sgml-shorttag:t sgml-tag-region-if-active:t End: --> + diff --git a/docs/sgml/installation.sgml b/docs/sgml/installation.sgml index 547d466ba..9cf100fdb 100644 --- a/docs/sgml/installation.sgml +++ b/docs/sgml/installation.sgml @@ -616,6 +616,15 @@ bash# mkdir /usr/bonsaitools/bin bash# ln -s /usr/bin/perl /usr/bosaitools/bin/perl </programlisting> </para> + <para> + Alternately, you can simply run this perl one-liner to + change your path to perl in all the files in your Bugzilla + installation: + <programlisting> +perl -pi -e 's@#!/usr/bonsaitools/bin/perl@/usr/bin/perl@' *cgi *pl Bug.pm + </programlisting> + Change the second path to perl to match your installation. + </para> </example> <tip> <para> @@ -1241,7 +1250,7 @@ bash# cd $BUGZILLA_HOME; for i in `ls *.cgi`; \ </section> - <section> + <section id="unixhistory"> <title>UNIX Installation Instructions History</title> <para> This document was originally adapted from the Bonsai @@ -1252,9 +1261,8 @@ bash# cd $BUGZILLA_HOME; for i in `ls *.cgi`; \ The February 25, 1999 re-write of this page was done by Ry4an Brase <ry4an@ry4an.org>, with some edits by Terry Weissman, Bryce Nesbitt, Martin Pool, & Dan Mosedale (But - don't send bug reports to them; report them using bugzilla, at - http://bugzilla.mozilla.org/enter_bug.cgi , project Webtools, - component Bugzilla). + don't send bug reports to them; report them using bugzilla, at <ulink + url="http://bugzilla.mozilla.org/enter_bug.cgi?product=Bugzilla">http://bugzilla.mozilla.org/enter_bug.cgi?product=Bugzilla</ulink> ). </para> <para> This document was heavily modified again Wednesday, March 07 @@ -1696,16 +1704,46 @@ exit; <step> <para> - Modify the invocation of all system() calls in all perl scripts in your Bugzilla directory. For instance, change this line in processmail: - <programlisting> -system ("./processmail.pl",@ARGLIST); - </programlisting> -to - <programlisting> + Modify the invocation of all system() calls in all perl + scripts in your Bugzilla directory. For instance, change + this line in processmail: + <programlisting> +system ("./processmail.pl",@ARGLIST); + </programlisting> to + <programlisting> system ("perl processmail.pl",@ARGLIST); </programlisting> </para> </step> + <step> + <para> + Add <function>binmode()</function> calls so attachments + will work (<ulink + url="http://bugzilla.mozilla.org/show_bug.cgi?id=62000">bug 62000</ulink>). + </para> + <para> + Because Microsoft Windows based systems handle binary + files different than Unix based systems, you need to add + the following lines to + <filename>createattachment.cgi</filename> and + <filename>showattachment.cgi</filename> before the + <function>require 'CGI.pl';</function> line. +</para> +<para> +<programlisting> +<![CDATA[ +binmode(STDIN); +binmode(STDOUT); +]]> +</programlisting> + </para> + <note> + <para> + According to <ulink + url="http://bugzilla.mozilla.org/show_bug.cgi?id=62000">bug 62000</ulink>, the perl documentation says that you should always use <function>binmode()</function> when dealing with binary files, but never when dealing with text files. That seems to suggest that rather than aribtrarily putting <function>binmode()</function> at the begining of the attachment files, there should be logic to determine if <function>binmode()</function> is needed or not. + </para> + </note> + </step> </procedure> <tip> @@ -1714,6 +1752,8 @@ system ("perl processmail.pl",@ARGLIST); relationships to Properties -> Home directory (tab) -> Application Settings (section) -> Configuration (button), such as: + </para> + <para> <programlisting> .cgi to: <perl install directory>\perl.exe %s %s .pl to: <perl install directory>\perl.exe %s %s @@ -1742,7 +1782,9 @@ GET,HEAD,POST registry at the following location: </para> <para> - HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\W3SVC\Parameters\ScriptMap + <programlisting> +HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\W3SVC\Parameters\ScriptMap + </programlisting> </para> <para> The keys should be called ".pl" and ".cgi", and both @@ -1761,26 +1803,102 @@ GET,HEAD,POST If attempting to run Bugzilla 2.12 or older, you will need to remove encrypt() calls from the Perl source. This is <emphasis>not necessary</emphasis> for Bugzilla 2.13 and - later. + later, which includes the current release, Bugzilla + &bz-ver;. <example> <title>Removing encrypt() for Windows NT Bugzilla version 2.12 or earlier</title> <para> - Replace this: - <programlisting> -SendSQL("SELECT encrypt(" . SqlQuote($enteredpwd) . ", " . SqlQuote(substr($realcryptpwd, 0, 2)) . ")"); -my $enteredcryptpwd = FetchOneColumn(); - </programlisting> - with this: - <programlisting> -my $enteredcryptpwd = $enteredpwd - </programlisting> + Replace this: + <programlisting> +SendSQL("SELECT encrypt(" . SqlQuote($enteredpwd) . ", " . SQLQuote(substr($realcryptpwd, 0, 2)) . ")"); +my $enteredcryptpwd = FetchOneColumn(); + </programlisting> +with this: + <programlisting> +my $enteredcryptpwd = $enteredpwd + </programlisting> in cgi.pl. </para> </example> </para> </tip> </section> + + <section id="bzldap"> + <title>Bugzilla LDAP Integration</title> + <para> + What follows is some late-breaking information on using the + LDAP authentication options with Bugzilla. The author has not + tested these (nor even formatted this section!) so please + contribute feedback to the newsgroup. + </para> + <literallayout> +Mozilla::LDAP module + +The Mozilla::LDAP module allows you to use LDAP for authentication to +the Bugzilla system. This module is not required if you are not using +LDAP. + +Mozilla::LDAP (aka PerLDAP) is available for download from +http://www.mozilla.org/directory. + +NOTE: The Mozilla::LDAP module requires Netscape's Directory SDK. +Follow the link for "Directory SDK for C" on that same page to +download the SDK first. After you have installed this SDK, then +install the PerLDAP module. +---------------------------------------------------------------------- + +Post-Installation Checklist +---------------------------------------------------------------------- +Set useLDAP to "On" **only** if you will be using an LDAP directory +for authentication. Be very careful when setting up this parameter; +if you set LDAP authentication, but do not have a valid LDAP directory +set up, you will not be able to log back in to Bugzilla once you log +out. (If this happens, you can get back in by manually editing the +data/params file, and setting useLDAP back to 0.) + +If using LDAP, you must set the three additional parameters: + +Set LDAPserver to the name (and optionally port) of your LDAP server. +If no port is specified, it defaults to the default port of 389. (e.g +"ldap.mycompany.com" or "ldap.mycompany.com:1234") + +Set LDAPBaseDN to the base DN for searching for users in your LDAP +directory. (e.g. "ou=People,o=MyCompany") uids must be unique under +the DN specified here. + +Set LDAPmailattribute to the name of the attribute in your LDAP +directory which contains the primary email address. On most directory +servers available, this is "mail", but you may need to change this. +---------------------------------------------------------------------- + +(Not sure where this bit should go, but it's important that it be in +there somewhere...) +---------------------------------------------------------------------- +Using LDAP authentication for Bugzilla: + +The existing authentication scheme for Bugzilla uses email addresses +as the primary user ID, and a password to authenticate that user. All +places within Bugzilla where you need to deal with user ID (e.g +assigning a bug) use the email address. + +The LDAP authentication builds on top of this scheme, rather than +replacing it. The initial log in is done with a username and password +for the LDAP directory. This then fetches the email address from LDAP +and authenticates seamlessly in the standard Bugzilla authentication +scheme using this email address. If an account for this address +already exists in your Bugzilla system, it will log in to that +account. If no account for that email address exists, one is created +at the time of login. (In this case, Bugzilla will attempt to use the +"displayName" or "cn" attribute to determine the user's full name.) + +After authentication, all other user-related tasks are still handled +by email address, not LDAP username. You still assign bugs by email +address, query on users by email address, etc. +---------------------------------------------------------------------- + </literallayout> + </section> </section> </chapter> diff --git a/docs/sgml/integration.sgml b/docs/sgml/integration.sgml index e0547c365..36cc617e2 100644 --- a/docs/sgml/integration.sgml +++ b/docs/sgml/integration.sgml @@ -35,6 +35,14 @@ an @resolution field, you can even change the Bugzilla bug state. </para> + <para> + There is also a project, based upon somewhat dated Bugzilla + code, to integrate CVS and Bugzilla through CVS' ability to + email. Check it out at: + <ulink url="http://homepages.kcbbs.gen.nz/~tonyg/"> + http://homepages.kcbbs.gen.nz/~tonyg/</ulink>, under the + <quote>cvszilla</quote> link. + </para> </section> <section id="scm" xreflabel="Perforce SCM (Fast Software Configuration Management System, a powerful commercial alternative to CVS"> diff --git a/docs/sgml/patches.sgml b/docs/sgml/patches.sgml index 3a1ce90d2..3f49255f2 100644 --- a/docs/sgml/patches.sgml +++ b/docs/sgml/patches.sgml @@ -247,6 +247,104 @@ RewriteRule ^/([0-9]+)$ http://foo.bar.com/show_bug.cgi?id=$1 [L,R] </para> </section> + <section id="bzhacking"> + <title>Hacking Bugzilla</title> + <para> + What follows are some general guidelines for changing Bugzilla, and adhering to good coding practice while doing so. We've had some checkins in the past which ruined Bugzilla installations because of disregard for these conventions. Sorry for the lack of formatting; I got this info into the Guide on the day of 2.14 release and haven't formatted it yet. + </para> + <literallayout> + +The following is a guide for reviewers when checking code into Bugzilla's +CVS repostory at mozilla.org. If you wish to submit patches to Bugzilla, +you should follow the rules and style conventions below. Any code that +does not adhere to these basic rules will not be added to Bugzilla's +codebase. + + 1. Usage of variables in Regular Expressions + + It is very important that you don't use a variable in a regular + expression unless that variable is supposed to contain an expression. + This especially applies when using grep. You should use: + + grep ($_ eq $value, @array); + + - NOT - + + grep (/$value/, @array); + + If you need to use a non-expression variable inside of an expression, be + sure to quote it properly (using \Q..\E). + +Coding Style for Bugzilla +------------------------- + +While it's true that not all of the code currently in Bugzilla adheres to +this styleguide, it is something that is being worked toward. Therefore, +we ask that all new code (submitted patches and new files) follow this guide +as closely as possible (if you're only changing 1 or 2 lines, you don't have +to reformat the entire file :). + + 1. Whitespace + + Bugzilla's prefered indentation is 4 spaces (no tabs, please). + + 2. Curly braces. + + The opening brace of a block should be on the same line as the statement + that is causing the block and the closing brace should be at the same + indentation level as that statement, for example: + + if ($var) { + print "The variable is true"; + } else { + print "Try again"; + } + + - NOT - + + if ($var) + { + print "The variable is true"; + } + else + { + print "Try again"; + } + + 3. File Names + + File names for bugzilla code and support documention should be legal across + multiple platforms. \ / : * ? " < > and | are all illegal characters for + filenames on various platforms. Also, file names should not have spaces in + them as they can cause confusion in CVS and other mozilla.org utilities. + + 4. Variable Names + + If a variable is scoped globally ($::variable) its name should be descriptive + of what it contains. Local variables can be named a bit looser, provided the + context makes their content obvious. For example, $ret could be used as a + staging variable for a routine's return value as the line |return $ret;| will + make it blatently obvious what the variable holds and most likely be shown + on the same screen as |my $ret = "";|. + + 5. Cross Database Compatability + + Bugzilla was originally written to work with MySQL and therefore took advantage + of some of its features that aren't contained in other RDBMS software. These + should be avoided in all new code. Examples of these features are enums and + encrypt(). + + 6. Cross Platform Compatability + + While Bugzilla was written to be used on Unix based systems (and Unix/Linux is + still the only officially supported platform) there are many who desire/need to + run Bugzilla on Microsoft Windows boxes. Whenever possible, we should strive + not to make the lives of these people any more complicated and avoid doing things + that break Bugzilla's ability to run on multiple operating systems. + + </literallayout> + </section> + </appendix> diff --git a/docs/sgml/using.sgml b/docs/sgml/using.sgml index 91a7658cd..934817081 100644 --- a/docs/sgml/using.sgml +++ b/docs/sgml/using.sgml @@ -399,13 +399,13 @@ system against which all others are measured. our Bugzilla database. Please notice the box is a <emphasis>scrollbox</emphasis>. Using the down arrow on the scrollbox, scroll down until you can see an entry - called "Webtools". Select this entry. + called "Bugzilla". Select this entry. </para> </listitem> <listitem> <para> Did you notice that some of the boxes to the right changed - when you selected "Webtools"? Every Program (or Product) + 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. @@ -452,36 +452,67 @@ system against which all others are measured. Normally, a Component has a single Owner, who is responsible for overseeing efforts to improve that Component. <example> - <title>Mozilla Webtools Components</title> + <title>Mozilla's Bugzilla Components</title> <informalexample> <para> - Mozilla's "Webtools" Product is composed of several pieces (Components): + Mozilla's "Bugzilla" Product is composed of several pieces (Components): <simplelist> - <member><emphasis>Bonsai</emphasis>, - a tool to show recent changes to Mozilla</member> - <member><emphasis>Bugzilla</emphasis>, - a defect-tracking tool</member> - <member><emphasis>Build</emphasis>, - a tool to automatically compile source code - into machine-readable form</member> - <member><emphasis>Despot</emphasis>, - a program that controls access to the other Webtools</member> - <member><emphasis>LXR</emphasis>, - a utility that automatically marks up text files - to make them more readable</member> - <member><emphasis>MozBot</emphasis>, - a "robot" that announces changes to Mozilla in Chat</member> - <member><emphasis>TestManager</emphasis>, - a tool to help find bugs in Mozilla</member> - <member><emphasis>Tinderbox</emphasis>, - which displays reports from Build</member> + <member><emphasis>Administration</emphasis>, + Administration of a bugzilla installation, including + <filename>editcomponents.cgi</filename>, + <filename>editgroups.cgi</filename>, + <filename>editkeywords.cgi</filename>, + <filename>editparams.cgi</filename>, + <filename>editproducts.cgi</filename>, + <filename>editusers.cgi</filename>, + <filename>editversions.cgi,</filename> and + <filename>sanitycheck.cgi</filename>. + </member> + <member><emphasis>Bugzilla-General</emphasis>, + Anything that doesn't fit in the other components, or spans + multiple components. + </member> + <member><emphasis>Creating/Changing Bugs</emphasis>, + Creating, changing, and viewing bugs. + <filename>enter_bug.cgi</filename>, + <filename>post_bug.cgi</filename>, + <filename>show_bug.cgi</filename> and + <filename>process_bug.cgi</filename>. + </member> + <member><emphasis>Documentation</emphasis>, + The bugzilla documentation, including anything in the + <filename>docs/</filename> directory and The Bugzilla Guide + (This document :) + </member> + <member><emphasis>Email</emphasis>, + Anything to do with email sent by Bugzilla. + <filename>processmail</filename> + </member> + <member><emphasis>Installation</emphasis>, + The installation process of Bugzilla. This includes + <filename>checksetup.pl</filename> and whatever else it evolves into. + </member> + <member><emphasis>Query/Buglist</emphasis>, + Anything to do with searching for bugs and viewing the buglists. + <filename>query.cgi</filename> and + <filename>buglist.cgi</filename> + </member> + <member><emphasis>Reporting/Charting</emphasis>, + Getting reports from Bugzilla. + <filename>reports.cgi</filename> and + <filename>duplicates.cgi</filename> + </member> + <member><emphasis>User Accounts</emphasis>, + Anything about managing a user account from the user's perspective. + <filename>userprefs.cgi</filename>, saved queries, creating accounts, + changing passwords, logging in, etc. + </member> + <member><emphasis>User Interface</emphasis>, + General issues having to do with the user interface cosmetics (not + functionality) including cosmetic issues, HTML templates, etc. + </member> </simplelist> </para> - <para> - A different person is responsible for each of these Components. - Tara Hernandez keeps - the "Bugzilla" component up-to-date. - </para> </informalexample> </example> </para> diff --git a/docs/txt/Bugzilla-Guide.txt b/docs/txt/Bugzilla-Guide.txt index 46972a7d8..685ce6408 100644 --- a/docs/txt/Bugzilla-Guide.txt +++ b/docs/txt/Bugzilla-Guide.txt @@ -3,10 +3,10 @@ The Bugzilla Guide Matthew P. Barnson - barnboy@NOSPAM.trilobyte.net + barnboy@trilobyte.net Zach Lipton - zach@NOSPAM.zachlipton.com + zach AT zachlipton DOT com Revision History Revision v2.11 20 December 2000 Revised by: MPB Converted the README, FAQ, and DATABASE information into SGML docbook @@ -136,6 +136,7 @@ Matthew P. Barnson 3.6.1. Win32 Installation: Step-by-step 3.6.2. Additional Windows Tips + 3.6.3. Bugzilla LDAP Integration 4. Administering Bugzilla @@ -169,6 +170,15 @@ Matthew P. Barnson 5.4. Tinderbox/Tinderbox2 6. The Future of Bugzilla + 7. Bugzilla Variants and Competitors + + 7.1. Red Hat Bugzilla + 7.2. Loki Bugzilla (Fenris) + 7.3. Issuezilla + 7.4. Scarab + 7.5. Perforce SCM + 7.6. SourceForge + A. The Bugzilla FAQ B. Software Download Links C. The Bugzilla Database @@ -182,21 +192,13 @@ Matthew P. Barnson C.3. MySQL Permissions & Grant Tables - 7. Bugzilla Variants and Competitors - - 7.1. Red Hat Bugzilla - 7.2. Loki Bugzilla (Fenris) - 7.3. Issuezilla - 7.4. Scarab - 7.5. Perforce SCM - 7.6. SourceForge - D. Useful Patches and Utilities for Bugzilla D.1. Apache mod_rewrite magic D.2. The setperl.csh Utility D.3. Command-line Bugzilla Queries D.4. The Quicksearch Utility + D.5. Hacking Bugzilla E. GNU Free Documentation License @@ -217,7 +219,7 @@ Matthew P. Barnson List of Examples 2-1. Some Famous Software Versions - 2-2. Mozilla Webtools Components + 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 @@ -230,6 +232,7 @@ Matthew P. Barnson 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 _________________________________________________________________ @@ -270,8 +273,8 @@ Chapter 1. About This Guide 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@NOSPAM.trilobyte.net> to correct them. + errors in this documentation; please contact <barnboy@trilobyte.net> + to correct them. _________________________________________________________________ 1.2. Copyright Information @@ -289,7 +292,7 @@ Chapter 1. About This Guide If you have any questions regarding this document, its copyright, or publishing this document in non-electronic form, please contact - Matthew P. Barnson. Remove "NOSPAM" from email address to send. + Matthew P. Barnson. _________________________________________________________________ 1.3. Disclaimer @@ -356,8 +359,8 @@ Chapter 1. About This Guide numerous e-mail and IRC support sessions, and overall excellent contribution to the Bugzilla community: - Terry Weissman for initially converting Bugzilla from BugSplat! and - writing the README upon which this documentation is largely based. + Terry Weissman for initially writing Bugzilla and creating the README + upon which the UNIX installation documentation is largely based. Tara Hernandez for keeping Bugzilla development going strong after Terry left Mozilla.org @@ -380,7 +383,7 @@ Chapter 1. About This Guide documentation (in no particular order): Andrew Pearson, Spencer Smith, Eric Hanson, Kevin Brannen, Ron - Teitelbaum + Teitelbaum, Jacob Steenhagen, Joe Robins _________________________________________________________________ 1.7. Feedback @@ -686,10 +689,10 @@ Chapter 2. Using Bugzilla 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 "Webtools". Select + scroll down until you can see an entry called "Bugzilla". Select this entry. 4. Did you notice that some of the boxes to the right changed when - you selected "Webtools"? Every Program (or Product) has different + 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 @@ -715,22 +718,33 @@ Chapter 2. Using Bugzilla 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 Webtools Components - Mozilla's "Webtools" Product is composed of several pieces + Example 2-2. Mozilla's Bugzilla Components + Mozilla's "Bugzilla" Product is composed of several pieces (Components): - Bonsai, a tool to show recent changes to Mozilla - Bugzilla, a defect-tracking tool - Build, a tool to automatically compile source code into - machine-readable form - Despot, a program that controls access to the other Webtools - LXR, a utility that automatically marks up text files to make them - more readable - MozBot, a "robot" that announces changes to Mozilla in Chat - TestManager, a tool to help find bugs in Mozilla - Tinderbox, which displays reports from Build - A different person is responsible for each of these Components. - Tara Hernandez keeps the "Bugzilla" component up-to-date. + 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. 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 @@ -1439,6 +1453,12 @@ bash# mkdir /usr/bonsaitools bash# mkdir /usr/bonsaitools/bin bash# ln -s /usr/bin/perl /usr/bosaitools/bin/perl + Alternately, you can simply run this perl one-liner to change your + path to perl in all the files in your Bugzilla installation: +perl -pi -e 's@#!/usr/bonsaitools/bin/perl@/usr/bin/perl@' *cgi *pl Bug.pm + + Change the second path to perl to match your installation. + Tip If you don't have root access to set this symlink up, check out the @@ -1853,8 +1873,7 @@ bash# cd $BUGZILLA_HOME; for i in `ls *.cgi`; \ <ry4an@ry4an.org>, with some edits by Terry Weissman, Bryce Nesbitt, Martin Pool, & Dan Mosedale (But don't send bug reports to them; report them using bugzilla, at - http://bugzilla.mozilla.org/enter_bug.cgi , project Webtools, - component Bugzilla). + http://bugzilla.mozilla.org/enter_bug.cgi?product=Bugzilla ). This document was heavily modified again Wednesday, March 07 2001 to reflect changes for Bugzilla 2.12 release by Matthew P. Barnson. The @@ -2104,20 +2123,40 @@ exit; your Bugzilla directory. For instance, change this line in processmail: + system ("./processmail.pl",@ARGLIST); to + system ("perl processmail.pl",@ARGLIST); + 14. Add binmode() calls so attachments will work (bug 62000). + Because Microsoft Windows based systems handle binary files + different than Unix based systems, you need to add the following + lines to createattachment.cgi and showattachment.cgi before the + require 'CGI.pl'; line. + +binmode(STDIN); +binmode(STDOUT); + + Note + + According to bug 62000, the perl documentation says that you should + always use binmode() when dealing with binary files, but never when + dealing with text files. That seems to suggest that rather than + aribtrarily putting binmode() at the begining of the attachment files, + there should be logic to determine if binmode() is needed or not. + Tip If you are using IIS or Personal Web Server, you must add cgi relationships to Properties -> Home directory (tab) -> Application Settings (section) -> Configuration (button), such as: + .cgi to: <perl install directory>\perl.exe %s %s .pl to: <perl install directory>\perl.exe %s %s GET,HEAD,POST @@ -2139,8 +2178,7 @@ GET,HEAD,POST Basically you need to add two String Keys in the registry at the following location: - HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\W3SVC\Paramete - rs\ScriptMap +HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\W3SVC\Parameters\ScriptMap The keys should be called ".pl" and ".cgi", and both should have a value something like: c:/perl/bin/perl.exe "%s" "%s" @@ -2152,14 +2190,15 @@ GET,HEAD,POST If attempting to run Bugzilla 2.12 or older, you will need to remove encrypt() calls from the Perl source. This is not necessary for - Bugzilla 2.13 and later. + Bugzilla 2.13 and later, which includes the current release, Bugzilla + 2.14. Example 3-4. Removing encrypt() for Windows NT Bugzilla version 2.12 or earlier Replace this: -SendSQL("SELECT encrypt(" . SqlQuote($enteredpwd) . ", " . SqlQuote(substr($rea +SendSQL("SELECT encrypt(" . SqlQuote($enteredpwd) . ", " . SQLQuote(substr($rea lcryptpwd, 0, 2)) . ")"); my $enteredcryptpwd = FetchOneColumn(); @@ -2170,6 +2209,66 @@ my $enteredcryptpwd = $enteredpwd in cgi.pl. _________________________________________________________________ +3.6.3. Bugzilla LDAP Integration + + What follows is some late-breaking information on using the LDAP + authentication options with Bugzilla. The author has not tested these + (nor even formatted this section!) so please contribute feedback to + the newsgroup. + + Mozilla::LDAP module + The Mozilla::LDAP module allows you to use LDAP for authentication to + the Bugzilla system. This module is not required if you are not using + LDAP. + Mozilla::LDAP (aka PerLDAP) is available for download from + http://www.mozilla.org/directory. + NOTE: The Mozilla::LDAP module requires Netscape's Directory SDK. + Follow the link for "Directory SDK for C" on that same page to + download the SDK first. After you have installed this SDK, then + install the PerLDAP module. + ---------------------------------------------------------------------- + Post-Installation Checklist + ---------------------------------------------------------------------- + Set useLDAP to "On" **only** if you will be using an LDAP directory + for authentication. Be very careful when setting up this parameter; + if you set LDAP authentication, but do not have a valid LDAP directory + set up, you will not be able to log back in to Bugzilla once you log + out. (If this happens, you can get back in by manually editing the + data/params file, and setting useLDAP back to 0.) + If using LDAP, you must set the three additional parameters: + Set LDAPserver to the name (and optionally port) of your LDAP server. + If no port is specified, it defaults to the default port of 389. (e.g + "ldap.mycompany.com" or "ldap.mycompany.com:1234") + Set LDAPBaseDN to the base DN for searching for users in your LDAP + directory. (e.g. "ou=People,o=MyCompany") uids must be unique under + the DN specified here. + Set LDAPmailattribute to the name of the attribute in your LDAP + directory which contains the primary email address. On most directory + servers available, this is "mail", but you may need to change this. + ---------------------------------------------------------------------- + (Not sure where this bit should go, but it's important that it be in + there somewhere...) + ---------------------------------------------------------------------- + Using LDAP authentication for Bugzilla: + The existing authentication scheme for Bugzilla uses email addresses + as the primary user ID, and a password to authenticate that user. All + places within Bugzilla where you need to deal with user ID (e.g + assigning a bug) use the email address. + The LDAP authentication builds on top of this scheme, rather than + replacing it. The initial log in is done with a username and password + for the LDAP directory. This then fetches the email address from LDAP + and authenticates seamlessly in the standard Bugzilla authentication + scheme using this email address. If an account for this address + already exists in your Bugzilla system, it will log in to that + account. If no account for that email address exists, one is created + at the time of login. (In this case, Bugzilla will attempt to use the + "displayName" or "cn" attribute to determine the user's full name.) + After authentication, all other user-related tasks are still handled + by email address, not LDAP username. You still assign bugs by email + address, query on users by email address, etc. + ---------------------------------------------------------------------- + _________________________________________________________________ + Chapter 4. Administering Bugzilla Or, I just got this cool thing installed. Now what the heck do I do @@ -2880,6 +2979,84 @@ Chapter 4. Administering Bugzilla instructions for creating a new Product. If you need to add users to these new groups as you create them, you will find the option to add them to the group available under the "Edit User" screens. + + You may find this example illustrative for how bug groups work. + + Example 4-7. Bugzilla Groups + + Bugzilla Groups example + ----------------------- + For this example, let us suppose we have four groups, call them + Group1, Group2, Group3, and Group4. + We have 5 users, User1, User2, User3, User4, User5. + We have 8 bugs, Bug1, ..., Bug8. + Group membership is defined by this chart: + (X denotes that user is in that group.) + (I apologize for the nasty formatting of this table. Try viewing + it in a text-based browser or something for now. -MPB) + G G G G + r r r r + o o o o + u u u u + p p p p + 1 2 3 4 + +-+-+-+-+ + User1|X| | | | + +-+-+-+-+ + User2| |X| | | + +-+-+-+-+ + User3|X| |X| | + +-+-+-+-+ + User4|X|X|X| | + +-+-+-+-+ + User5| | | | | + +-+-+-+-+ + Bug restrictions are defined by this chart: + (X denotes that bug is restricted to that group.) + G G G G + r r r r + o o o o + u u u u + p p p p + 1 2 3 4 + +-+-+-+-+ + Bug1| | | | | + +-+-+-+-+ + Bug2| |X| | | + +-+-+-+-+ + Bug3| | |X| | + +-+-+-+-+ + Bug4| | | |X| + +-+-+-+-+ + Bug5|X|X| | | + +-+-+-+-+ + Bug6|X| |X| | + +-+-+-+-+ + Bug7|X|X|X| | + +-+-+-+-+ + Bug8|X|X|X|X| + +-+-+-+-+ + Who can see each bug? + Bug1 has no group restrictions. Therefore, Bug1 can be seen by any + user, whatever their group membership. This is going to be the only + bug that User5 can see, because User5 isn't in any groups. + Bug2 can be seen by anyone in Group2, that is User2 and User4. + Bug3 can be seen by anyone in Group3, that is User3 and User4. + Bug4 can be seen by anyone in Group4. Nobody is in Group4, so none of + these users can see Bug4. + Bug5 can be seen by anyone who is in _both_ Group1 and Group2. This + is only User4. User1 cannot see it because he is not in Group2, and + User2 cannot see it because she is not in Group1. + Bug6 can be seen by anyone who is in both Group1 and Group3. This + would include User3 and User4. Similar to Bug5, User1 cannot see Bug6 + because he is not in Group3. + Bug7 can be seen by anyone who is in Group1, Group2, and Group3. This + is only User4. All of the others are missing at least one of those + group priveleges, and thus cannot see the bug. + Bug8 can be seen by anyone who is in Group1, Group2, Group3, and + Group4. There is nobody in all four of these groups, so nobody can + see Bug8. It doesn't matter that User4 is in Group1, Group2, and + Group3, since he isn't in Group4. _________________________________________________________________ 4.4. Bugzilla Security @@ -3012,6 +3189,10 @@ Chapter 5. Integrating Bugzilla with Third-Party Tools have CVS check-in comments append to your Bugzilla bug. If you have your check-in script include an @resolution field, you can even change the Bugzilla bug state. + + There is also a project, based upon somewhat dated Bugzilla code, to + integrate CVS and Bugzilla through CVS' ability to email. Check it out + at: http://homepages.kcbbs.gen.nz/~tonyg/, under the "cvszilla" link. _________________________________________________________________ 5.3. Perforce SCM @@ -3039,10 +3220,665 @@ Chapter 6. The Future of Bugzilla Bugzilla's Future. Much of this is the present, now. - The future of Bugzilla is Bugzilla 3.0. Unfortunately, I do not have - more information about it right now, and most of what went into the - "future" section is now present. That stuff was blue-sky a year ago; - MattyT should have me a new document sometime... + Bugzilla's future is a constantly-changing thing, as various + developers "scratch an itch" when it comes to functionality. Thus this + section is very malleable, subject to change without notice, etc. + You'll probably also notice the lack of formatting. I apologize that + it's not quite as readable as the rest of the Guide. + + Bugzilla Blue Sky + Customisability + One of the major stumbling blocks of Bugzilla has been that it is t + oo + rigid and does not adapt itself well enough to the needs of an + organisation. This has led to organisations making changes to the + Bugzilla code that need to be redone each new version of Bugzilla. + Bugzilla should attempt to move away from this to a world where thi + s + doesn't need to occur. + Most of the subsections in this section are currently explicit desi + gn + goals for the "Bugzilla 3" rewrite. This does not necessarily mean + that they will not occur before them in Bugzilla 2, but most are + significant undertakings. + Field Customisation + Many installations wish to customise the fields that appear on bug + reports. Current versions of Bugzilla offer limited + customisability. In particular, some fields can be turned off. + However, many administrators wish to add their own fields, and rena + me + or otherwise modify existing fields. An architecture that supports + this would be extraordinarily useful. + Indeed, many fields work similarly and could be abstracted into "fi + eld + types", so that an administrator need write little or no code to + support the new fields they desire. + Possible field types include text (eg status whiteboard), numbers, + dates (eg report time), accounts (eg reporter, qa, cc), inter-bug + relationships (dependencies, duplicates), option groups (platform, + os, + severity, priority, target milestone, version) etc. + Ideally an administrator could configure their fields through a + Bugzilla interface that requires no code to be added. However, it + is + highly unlikely this ideal will never be met, and in a similar way + that office applications have scripting languages, Bugzilla should + allow new field types to be written. + Similarly, a common desire is for resolutions to be added or remove + d. + Allocations + ? + Option Groups + ? + Relations + ? + Database Integrity + Furthermore, it is desirable for administrators to be able to speci + fy + rules that must or should apply between the fields on a bug report. + For example, you might wish to specify that a bug with status ASSIG + NED + must have a target milestone field that that is not untargetted. O + r + that a bug with a certain number of votes should get ASSIGNED. Or + that the QA contact must be different from the assignee. + "Must" relationships could be implemented by refusing to make chang + es + that violate the relationships, or alternatively, automatically + updating certain fields in order to satisfy the criteria. Which + occurs should be up to the administrator. + "Should" relationships could be implemented by a combination of + emitting warnings on the process bug page, the same on notification + mails, or emitting periodic whine mails about the situation. Again + , + which occurs should be up to the administrator. + It should also be possible for whine mails to be emitted for "must" + relationships, as they might become violated through direct databas + e + access, Bugzilla bugs, or because they were there before the + relationship was enforced. + As well as implementing intra-bug constraints, it would be useful t + o + create inter-bug constraints. For example, a bug that is dependent + on + another bug should not have an earlier milestone or greater priorit + y + than that bug. + Database Adaptability + Often an administrator desires that fields adapt to the values of + other fields. For example, the value of a field might determine th + e + possible values of another field or even whether it appears (whethe + r + it is "applicable"). + Limited adaptability is present in Bugzilla 2, and only on the + "Product" field: + * The possible values of the target milestone, version and compon + ent + fields depend on the product. + * UNCONFIRMED can be turned off for specific products. + * Voting can be configured differently or turned off for differen + t + products, and there is a separate user vote limits for each + product. + It would be good if more adaptability was present, both in terms of + all fields relying on the product, as well as the ability to adapt + based on the value of all fields. + Example ??? + General adaptability raises the issue of circular references betwee + n + fields causing problems. One possible solution to this is to place + the fields in a total ordering and require a field refer only to th + e + previous fields. + In Bugzilla 2, changing the product of a bug meant a second page wo + uld + appear that allowed you to choose a new milestone, component and + version, as those fields adapted themselves to the new product. Th + is + page could be generalised to support all instances where: + * a field value must or might be changed because the possible val + ues + have changed + * is going to drop off because it it is no longer applicable, and + this should be confirmed + * must be specified because it is suddenly applicable, and the + default value, if one exists, might not be acceptable + Database Independence + Currently Bugzilla only runs on the MySQL database. It would be + desirable for Bugzilla to run on other databases, because: + * Organisations may have existing database products they use and + would prefer to run a homogenous environment. + * Databases each have their own shortcomings, including MySQL. A + n + administrator might choose a database that would work better wi + th + their Bugzilla. + This raises the possibility that we could use features that are onl + y + present in some databases, by appropriately falling back. For + example, in the MySQL world, we live without: + * record-level locking, instead we use table-level locking + * referential and record constraints, instead we checking code + * subselects, instead we use multiple queries and redundant "cach + es" + Multiple Front Ends + Currently Bugzilla is manipulated via the Web, and notifies via + E-Mail. It would be desirable for Bugzilla to easily support vario + us + front ends. + There is no reason that Bugzilla could not be controlled via a whol + e + range of front ends, including Web, E-Mail, IRC, ICQ, etc, and + similarly for how it notifies. It's also possible that we could + introduce a special Bugzilla client that uses its own protocol, for + maximum user productivity. + Indeed a request reply might be returned via a totally different + transport method than was use to submit the request. + Internationalisation + Bugzilla currently supports only English. All of the field names, + user instructions, etc are written in English. It would be desirab + le + to allow "language packs" so Bugzilla can be easily used in + non-English speaking locales. + To a degree field customisation supports this, because administrato + rs + could specify their own fields names anyway. However, there will + always be some basic facilities not covered by this, and it is + desirable that the administrator's interface also is + internationalisable. + Better Searching + General Summary Reports + Sometimes, the normal querying page leaves a lot to be desired. Th + ere + are other facilities already in place or which people have asked fo + r: + Most Doomed Reports - All Bugs or All Bugs In A Product, Categorise + d + On Assignee, Shows and Counts Number of Bugs For Each Assignee + Most Voted For Bugs - All Bugs, Categorised On Product, Shows Top T + en + Bugs Voters Most Want Fixed + Number of Open Bugs For An Assignee - Bug List, Categorised On + Developers, Counts Number of Bugs In Category + The important thing to realise is that people want categorised repo + rts + on all sorts of things - a general summary report. + In a categorised report, you choose the subset of bugs you wish to + operate on (similar to how you would specify a query), and then + categorise them on one or more fields. + For each category you display the count of the number of things in + that category. You can optionally display the bugs themselves, or + leave them out, just showing the counts. And you can optionally li + mit + the number of things (bugs or subcategories) that display in each + category. + Such a mechanism would let you do all of the above and more. + Applications of this mechanism would only be recognised once it was + implemented. + Related Bugs + It would be nice to have a field where you could enter other bugs + related to the current bug. It would be handy for navigation and + possibly even finding duplicates. + Column Specification Support + Currently bug lists use the columns that you last used. This doesn + 't + work well for "prepackaged queries", where you followed a link. Yo + u + can probably add a column by specifying a sort column, but this is + difficult and suboptimal. + Furthermore, I find that when I want to add a column to a bug list, + it's usually a one off and I would prefer it to go away for the nex + t + query. Hence, it would be nice to specify the columns that appear + on + the bug list (and general summary report) pages. The default query + mechanism should be able to let you specify your default columns. + Advanced Querying Redesign + ? + Keywords + People have a need to apply tags to bugs. In the beginning, people + placed designators in the summary and status whiteboard. However, + these fields were not designed for that, and so there were many fla + ws + with this system: + * They pollute the field with information that was never intended + to + be present. + * Removing them with a bulk change is a difficult problem that ha + s + too many pitfalls to implement. + * You can easily get the capitalisation wrong. + Then dependencies were introduced (when?), and people realised that + they could use them for "tracking bugs". Again, dependencies were + not + designed for that, and so there were more flaws, albeit different + ones, including: + * They aren't really bugs, so it's difficult to distinguish issue + s + from bugs. + * They can pollute bugs counts, and you must somehow exclude them + from queries. + * There is a whole lot of useless information on them. They have + an + assignee but there is nothing to fix, and that person can get + whined at by Bugzilla. They have target milestones which must + be + manually maintained. And so on. + Finally, keywords were introduced (when?) for this purpose to remov + e + the need for these two systems. Unfortunately, the simple keywords + implementation was itself lacking in certain features provided by t + he + two previous systems, and has remained almost unchanged since its + inception. Furthermore, it could not be forseen that in large + installations, the sheer number of keywords could become unwieldly + and + could lead to a movement back to the other systems. + The keywords system was the right idea, however, and it remains so. + Fixing the keywords system is one of the most important Bugzilla + issues. + Bringing Keywords Up To Par + For the most part, keywords are very good at what they do. It is e + asy + to add and remove them (unlike summary/whiteboard designators), we + can + simply see what issues are present on a bug (unlike tracking bugs), + and we do not confuse bugs with issues (unlike tracking bugs). + However, there are still some "regressions" in the keyword system o + ver + previous systems: + * Users wish to view the "dependency forest" of a keyword. While + a + dependency tree is of one bug, a dependency forest is of a bug + list, and consists of a dependency tree for each member of the + bug + list. Users can work around this with tracking bugs by creatin + g a + tracking bug and viewing the dependency tree of that tracking b + ug. + * Users wish to specify the keywords that initially apply to a bu + g, + but instead they must edit the bug once it has already been + submitted. They can work around this with summary designators, + since they specify the summary at reporting time. + * Users wish to store or share a bug list that contains a keyword + s + column. Hence they wish to be able to specify what columns app + ear + in the bug list URL, as mentioned earlier. They can work aroun + d + this using summary designators, since almost all bug lists have + a + summary column. + * Users wish to be able to view keywords on a bug list. However + often they are only interested in a small number of keywords. + Having a bug list with a keywords column means that all keyword + s + will appear on a bug list. This can take a substantial amount + of + space where a bug has a lot of keywords, since the table column + s + in Bugzilla adjust to the largest cell in that column. Hence + users wish to be able to specify which keywords should appear i + n + the bug list. In a very real sense, each keyword is a field un + to + itself. Users can work around this by using summary designator + s, + since they keywords will share the space in the summary column. + * Users wish to know when bugs with a specific issue are resolved + . + Hence they wish to be able to receive notifications on all the + bugs with a specific keyword. The introduction a generic watch + ing + facility (also for things like watching all bugs in a component + ) + would achieve this. Users can work around this by using tracki + ng + bugs, as dependencies have an existing way of detecting fixes t + o + bug a bug was blocked by. + Dealing With The Keyword Overload + At the time of writing, the mozilla.org installation has approximat + ely + 100 keywords, and many more would be in use if the keywords system + didn't have the problems it does. + Such a large number of keywords introduces logistical problems: + * It must be easy for someone to learn what a keyword means. If + a + keyword is buried within a lot of other keywords, it can be + difficult to find. + * It must be easy to see what keywords are on a bug. If the numb + er + of keywords is large, then this can be difficult. + These lead some people to feel that there are "too many keywords". + These problems are not without solutions however. It is harder to + find a list of designators or tracking bugs than it is a list of + keywords. + The essential problem is it needs to be easy to find the keywords + we're interested in through the mass of keywords. + Keyword Applicability + As has been previously mentioned, it is desirable for fields to be + able to adapt to the values of other fields. This is certainly tru + e + for keywords. Many keywords are simply not relevant because of the + bugs product, component, etc. + Hence, by introducing keyword applicability, and not displaying + keywords that are not relevant to the current bug, or clearly + separating them, we can make the keyword overload problem less + significant. + Currently when you click on "keywords" on a bug, you get a list of + all + bugs. It would be desirable to introduce a list of keywords tailor + ed + to a specific bug, that reports, in order: + * the keywords currently on the bug + * the keywords not currently on the bug, but applicable to the bu + g + * optionally, the keywords not applicable to the bug + This essentially orders the keywords into three groups, where each + group is more important than the previous, and therefore appears + closer to the top. + Keyword Grouping & Ordering + We could further enhance both the global and bug specific keyword l + ist + by grouping keywords. We should always have a "flat" view of + keywords, but other ways of viewing the keywords would be useful to + o. + If keyword applicability was implemented, we could group keywords + based on their "applicability condition". Keywords that apply to a + ll + bugs could be separated from keywords that apply to a specific + product, both on the global keyword list and the keyword list of a + bug + that is in that product. + We could specify groups of our own. For example, many keywords are + in + a mutually exclusive group, essentially like radio buttons in a use + r + interface. This creates a natural grouping, although other groupin + gs + occur (which depends on your keywords). + It is possible that we could use collapsing/expanding operations on + "twisties" to only should the groups we are interested in. + And instead of grouping keywords, we could order them on some metri + c + of usefulness, such as: + * when the keyword was last added to a bug + * how many bugs the keyword is on + * how many open bugs the keyword is on + Opting Out Of Keywords + Not all people are going to care about all keywords. Therefore it + makes sense that you may wish to specify which keywords you are + interested in, either on the bug page, or on notifications. + Other keywords will therefore not bother users who are not interest + ed + in them. + Keyword Security + Currently all keywords are available and editable to all people wit + h + edit bugs access. This situation is clearly suboptimal. + Although relying on good behaviour for people to not do what they + shouldn't works reasonably well on the mozilla.org, it is better to + enforce that behaviour - it can be breached through malice, acciden + t + or ignorance. + And in the situation where it is desirable for the presence or abse + nce + of a keyword not to be revealed, organisations either need to be + content with the divulgence, or not use keywords at all. + In the situation where they choose to divulge, introducing the abil + ity + to restrict who can see the keyword would also reduce keyword + overload. + Personal Keywords + Keywords join together a set of bugs which would otherwise be + unrelated in the bug system. + We allow users to store their own queries. However we don't allow + them to store their own keywords on a bug. This reduces the + usefulness of personal queries, since you cannot join a set of + unrelated bugs together in a way that you wish. Lists of bug numbe + rs + can work, by they can only be used for small lists, and it is + impossible to share a list between multiple queries. + Personal keywords are necessary to replace personal tracking bugs, + as + they would not pollute the keyword space. Indeed, on many + installations this could remove some keywords out of the global + keyword space. + In a similar vein and with similar effects, group keywords could be + introduced that are only available to members of a specific group. + Keyword Restrictions + Keywords are not islands unto themselves. Along with their potenti + al + to be involved in the inter-field relationships mentioned earlier, + keywords can also be related to other keywords. + Essentially, there are two possibilities: + * a set of keywords are mutually exclusive + * the presence of a keyword implies another keyword must be prese + nt + Introduction of the ability to specify these restrictions would hav + e + benefits. + If mutually exclusive keywords were present on a bug, their removal + would fix up the database, as well as reducing the number of keywor + ds + on that bug. + In the situation where a keyword implies another keyword, there are + two possiblities as to how to handle the situation. + The first is automatically add the keyword. This would fix up the + database, but it would increase the number of keywords on a bug. + The second is to automatically remove the keyword, and alter querie + s + so they pick up the first keyword as well as the removed keyword. + This would fix up the database and reduce the number of keywords on + a + bug, but it might confuse users who don't see the keyword. + Alternatively, the implied keywords could be listed separately. + Notifications + Every time a bug gets changed notifications get sent out to people + letting them know about what changes have been made. This is a + significant feature, and all sorts of questions can be raised, but + they mainly boil down to when they should be sent and what they sho + uld + look like. + Changes You're Interested In + As of version 2.12 users can specify what sort of changes they are + interested in receiving notifications for. However, this is still + limited. As yet there is no facility to specify which keywords you + care about, and whether you care about changes to fields such as th + e + QA contact changes. + Furthermore, often an unnecessary comment will go along with a chan + ge, + either because it is required, or the commenter is ignorant of how + the + new system works. While explaining why you did something is useful + , + merely commenting on what you did is not because that information i + s + already accessible view "Bug Activity". + Because of this unnecessary comment, a lot of changes that would + otherwise not generate notifications for certain people do so, beca + use + few people are willing to turn off comments. One way to deal with + this problem is to allow people to specify that their comments are + purely explanatory, and that anyone who is not interested in the + change will not be interested in the comment. + Furthermore, one possible rationale for unnecessary comments is tha + t + the bug activity does not display on the normal page and hence it i + s + difficult to cross reference comments and actions. Hence, it would + be + beneficial to be able to do this. + Bugs You're Watching + Currently to receive a notification about a bug you need to have yo + ur + name on it. This is suboptimal because you need to know about a bu + g + before you can receive notifications on it. Often you are interest + ed + in any bug with a field set to a specific value. For example, you + might be interested in all bugs with a specific product, component + or + keyword. + If someone could automatically receive notifications about these bu + gs, + it would make everyone's lives easier. Currently the default assig + nee + and QA contact for a component will automatically receive + notifications for + Question: This moves half way to a BCC. + Bulk Changes + A very useful feature of Bugzilla is the ability to perform an acti + on + on multiple bugs at once. However, this means that similar + notifications are currently generated for each bug modified. + This can result in a torrent of notifications that can annoy. + Furthermore, since the bugs are all changed close to each other in + time, it is easy for someone to mass delete all the notifications + generated by a bulk change and miss an unrelated notification in th + e + middle. + These factors can lead to a tendency for people to delay bulk chang + es, + or avoid them entirely. This is suboptimal. + It would be better if a bulk change generated only one notification + mail. This would vastly reduce the annoyance factor, and prevent + accidental deletion of notifications. + One problem with this change is that some people separate out + notifications using filtering. This means that they would no longe + r + be match parts of a bulk change under different filtering rules. + One possibility to resolve this is to allow people to specify group + s + of bugs. All bugs within a group would go into the same + notification. The filters could then distinguish the different bug + groups. + In any case, it is likely there would need to be a transition perio + d + to allow people to alter their filters. + Nominations + ? + Linking Bugzilla Installations + The first example of linking Bugzilla installations together has is + the introduction of bug moving in version 2.12. However, it would + be + useful to be able to link installations in more ways. + * Dependencies and other relationships between bugs in other + installations. This is difficult because dependencies are + synchronised on both bugs, so the installation that changes + dependencies would need to communicate the new state to the oth + er + installation. It would also mean that relationships and + notifications that refer to other bugs would need to communicat + e + with the other installation. + * References to bugs in other installations. Currently if you ty + pe + "bug XXX" or "bug #XXX" where XXX is a number, you get an + automatic hyperlink to that bug. It would be useful if you cou + ld + say "YYY bug #XXX" where YYY is the name of another installatio + n. + Retirement + ? + Whiny Reports + ? + Group Redesign + ? + Hard Wrapping Comments + Currently Bugzilla "hard wraps" its comments to a specific line siz + e, + similar to E-Mail. This has various problems: + * The way it currently works, wrapping is done in the browser at + submission time using a non-standard HTML extension not support + ed + by some (uncommon) browsers. These browsers generate comments + that scroll off the right side of the screen. + * Because comments are of fixed width, when you expand your brows + er + window, the comments do not expand to fit available space. + It would be much better to move to a world of soft wrapping, where + the + browser wraps the text at display time, similar to a world processo + r. + And as in a word processor, soft wrapping does not preclude the + insertion of newlines. + Hard wrapping is too entrenched into text E-Mail to fix, but we can + fix Bugzilla without causing any problems. The old content will st + ill + be wrapped too early, but at least new content will work. + _________________________________________________________________ + +Chapter 7. Bugzilla Variants and Competitors + + I created this section to answer questions about Bugzilla competitors + and variants, then found a wonderful site which covers an awful lot of + what I wanted to discuss. Rather than quote it in its entirety, I'll + simply refer you here: http://linas.org/linux/pm.html + _________________________________________________________________ + +7.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 the ability + to work with Oracle, MySQL, and PostGreSQL databases serving as the + back-end, instead of just MySQL. Dave Lawrence has worked very hard to + keep Red Hat Bugzilla up-to-date, and many people prefer the + snappier-looking page layout of Red Hat Bugzilla to the default + Mozilla-standard formatting. + + URL: http://bugzilla.redhat.com/bugzilla/ + _________________________________________________________________ + +7.2. Loki Bugzilla (Fenris) + + Fenris can be found at http://fenris.lokigames.com. It is a fork from + Bugzilla. + _________________________________________________________________ + +7.3. Issuezilla + + Issuezilla is another fork from Bugzilla, and seems nearly as popular + as the Red Hat Bugzilla fork. Some Issuezilla team members are regular + contributors to the Bugzilla mailing list/newsgroup. Issuezilla is not + the primary focus of bug-tracking at tigris.org, however. Their + Java-based bug-tracker, Scarab, a newfangled Java-based issue tracker, + is under heavy development and looks promising! + + URL: http://issuezilla.tigris.org/servlets/ProjectHome + _________________________________________________________________ + +7.4. Scarab + + Scarab is a promising new bug-tracking system built using Java Serlet + technology. As of this writing, no source code has been released as a + package, but you can obtain the code from CVS. + + URL: http://scarab.tigris.org + _________________________________________________________________ + +7.5. Perforce SCM + + Although Perforce isn't really a bug tracker, it can be used as such + through the "jobs" functionality. + + http://www.perforce.com/perforce/technotes/note052.htmlhttp://www.perf + orce.com/perforce/technotes/note052.html + _________________________________________________________________ + +7.6. SourceForge + + SourceForge is more of a way of coordinating geographically + distributed free software and open source projects over the Internet + than strictly a bug tracker, but if you're hunting for bug-tracking + for your open project, it may be just what the software engineer + ordered! + + URL: http://www.sourceforge.net _________________________________________________________________ Appendix A. The Bugzilla FAQ @@ -3130,51 +3966,47 @@ Appendix A. The Bugzilla FAQ fields? If I wanted to take the results of a query and export that data to MS Excel, could I do that? - A.4.14. Does Bugzilla allow fields to be added, changed or - deleted? If I want to customize the bug submission form - to meet our needs, can I do that using our terminology? - - A.4.15. Has anyone converted Bugzilla to another language to be + A.4.14. Has anyone converted Bugzilla to another language to be used in other countries? Is it localizable? - A.4.16. Can a user create and save reports? Can they do this in + A.4.15. Can a user create and save reports? Can they do this in Word format? Excel format? - A.4.17. Can a user re-run a report with a new project, same + A.4.16. Can a user re-run a report with a new project, same query? - A.4.18. Can a user modify an existing report and then save it + A.4.17. Can a user modify an existing report and then save it into another name? - A.4.19. Does Bugzilla have the ability to search by word, phrase, + A.4.18. Does Bugzilla have the ability to search by word, phrase, compound search? - A.4.20. Can the admin person establish separate group and + A.4.19. Can the admin person establish separate group and individual user privileges? - A.4.21. Does Bugzilla provide record locking when there is + A.4.20. Does Bugzilla provide record locking when there is simultaneous access to the same bug? Does the second person get a notice that the bug is in use or how are they notified? - A.4.22. Are there any backup features provided? - A.4.23. Can users be on the system while a backup is in progress? + A.4.21. Are there any backup features provided? + A.4.22. Can users be on the system while a backup is in progress? - A.4.24. What type of human resources are needed to be on staff to + A.4.23. What type of human resources are needed to be on staff to install and maintain Bugzilla? Specifically, what type of skills does the person need to have? I need to find out if we were to go with Bugzilla, what types of individuals would we need to hire and how much would that cost vs buying an "Out-of-the-Box" solution. - A.4.25. What time frame are we looking at if we decide to hire + A.4.24. What time frame are we looking at if we decide to hire people to install and maintain the Bugzilla? Is this something that takes hours or weeks to install and a couple of hours per week to maintain and customize or is this a multi-week install process, plus a full time job for 1 person, 2 people, etc? - A.4.26. Is there any licensing fee or other fees for using + A.4.25. Is there any licensing fee or other fees for using Bugzilla? Any out-of-pocket cost other than the bodies needed as identified above? @@ -3645,51 +4477,50 @@ Appendix A. The Bugzilla FAQ progression states, also require adjusting the program logic to compensate for the change. + There is no GUI for adding fields to Bugzilla at this time. You can + follow development of this feature at + http://bugzilla.mozilla.org/show_bug.cgi?id=91037 + A.4.7. The index.html page doesn't show the footer. It's really annoying to have to go to the querypage just to check my "my bugs" link. How do I get a footer on static HTML pages? - This was a late-breaking question for the Guide, so I just have to - quote the relevant newsgroup thread on it. + It's possible to get the footer on the static index page using Server + Side Includes (SSI). The trick to doing this is making sure that your + web server is set up to allow SSI and specifically, the #exec + directive. You should also rename index.html to index.shtml. - > AFAIK, most sites (even if they have SSI enabled) won't have #exec c - md - > enabled. Perhaps what would be better is a #include virtual and a - > footer.cgi the basically has the "require 'CGI.pl' and PutFooter com - mand. - > - > Please note that under most configurations, this also requires namin - g - > the file from index.html to index.shtml (and making sure that it wil - l - > still be reconized as an index). Personally, I think this is better - on - > a per-installation basis (perhaps add something to the FAQ that says - how - > to do this). - Good point. Yeah, easy enough to do, that it shouldn't be a big deal - for - someone to take it on if they want it. FAQ is a good place for it. - > Dave Miller wrote: - > - >> I did a little experimenting with getting the command menu and foot - er on - >> the end of the index page while leaving it as an HTML file... - >> - >> I was successful. :) - >> - >> I added this line: - >> - >> - >> - >> Just before the </BODY> </HTML> at the end of the file. And it wor - ked. - >> - >> Thought I'd toss that out there. Should I check this in? For thos - e that - >> have SSI disabled, it'll act like a comment, so I wouldn't think it - would - >> break anything. + After you've done all that, you can add the following line to + index.shtml: +<!--#exec cmd="/usr/bin/perl -e "require 'CGI.pl'; PutFooter();"" --> + + Note + + This line will be replaced with the actual HTML for the footer when + the page is requested, so you should put this line where you want the + footer to appear. + + Because this method depends on being able to use a #exec directive, + and most ISP's will not allow that, there is an alternative method. + You could have a small script (such as api.cgi) that basically looks + like: +#!/usr/bonsaitools/bin/perl -w + +require 'globals.pl'; + +if ($::FORM{sub} eq 'PutFooter') { + PutFooter(); +} else { + die 'api.cgi was incorrectly called'; +} + + and then put this line in index.shtml. + <!--#include virtual="api.cgi?sub=PutFooter"--> + + Note + + This still requires being able to use Server Side Includes, if this + simply will not work for you, see bug 80183 for a third option. A.4.8. Does Bugzilla provide any reporting features, metrics, graphs, etc? You know, the type of stuff that management likes to see. :) @@ -3765,46 +4596,40 @@ Appendix A. The Bugzilla FAQ find an excellent example at http://www.mozilla.org/quality/help/bugzilla-helper.html - A.4.14. Does Bugzilla allow fields to be added, changed or deleted? If - I want to customize the bug submission form to meet our needs, can I - do that using our terminology? - - Yes. - - A.4.15. Has anyone converted Bugzilla to another language to be used + A.4.14. Has anyone converted Bugzilla to another language to be used in other countries? Is it localizable? Currently, no. Internationalization support for Perl did not exist in a robust fashion until the recent release of version 5.6.0; Bugzilla is, and likely will remain (until 3.X) completely non-localized. - A.4.16. Can a user create and save reports? Can they do this in Word + A.4.15. Can a user create and save reports? Can they do this in Word format? Excel format? Yes. No. No. - A.4.17. Can a user re-run a report with a new project, same query? + A.4.16. Can a user re-run a report with a new project, same query? Yes. - A.4.18. Can a user modify an existing report and then save it into + A.4.17. Can a user modify an existing report and then save it into another name? You can save an unlimited number of queries in Bugzilla. You are free to modify them and rename them to your heart's desire. - A.4.19. Does Bugzilla have the ability to search by word, phrase, + A.4.18. Does Bugzilla have the ability to search by word, phrase, compound search? You have no idea. Bugzilla's query interface, particularly with the advanced Boolean operators, is incredibly versatile. - A.4.20. Can the admin person establish separate group and individual + A.4.19. Can the admin person establish separate group and individual user privileges? Yes. - A.4.21. Does Bugzilla provide record locking when there is + A.4.20. Does Bugzilla provide record locking when there is simultaneous access to the same bug? Does the second person get a notice that the bug is in use or how are they notified? @@ -3812,19 +4637,19 @@ Appendix A. The Bugzilla FAQ detection, and offers the offending user a choice of options to deal with the conflict. - A.4.22. Are there any backup features provided? + A.4.21. Are there any backup features provided? MySQL, the database back-end for Bugzilla, allows hot-backup of data. You can find strategies for dealing with backup considerations at http://www.mysql.com/doc/B/a/Backup.html - A.4.23. Can users be on the system while a backup is in progress? + A.4.22. Can users be on the system while a backup is in progress? Yes. However, commits to the database must wait until the tables are unlocked. Bugzilla databases are typically very small, and backups routinely take less than a minute. - A.4.24. What type of human resources are needed to be on staff to + A.4.23. What type of human resources are needed to be on staff to install and maintain Bugzilla? Specifically, what type of skills does the person need to have? I need to find out if we were to go with Bugzilla, what types of individuals would we need to hire and how much @@ -3843,7 +4668,7 @@ Appendix A. The Bugzilla FAQ me three to five hours to make Bugzilla happy on a Development installation of Linux-Mandrake. - A.4.25. What time frame are we looking at if we decide to hire people + A.4.24. What time frame are we looking at if we decide to hire people to install and maintain the Bugzilla? Is this something that takes hours or weeks to install and a couple of hours per week to maintain and customize or is this a multi-week install process, plus a full @@ -3856,7 +4681,7 @@ Appendix A. The Bugzilla FAQ UNIX or Perl skills to handle your process management and bug-tracking maintenance & customization. - A.4.26. Is there any licensing fee or other fees for using Bugzilla? + A.4.25. Is there any licensing fee or other fees for using Bugzilla? Any out-of-pocket cost other than the bodies needed as identified above? @@ -3950,18 +4775,11 @@ Appendix A. The Bugzilla FAQ If you are using an alternate Mail Transport Agent (MTA other than sendmail), make sure the options given in the "processmail" script for - all instances of "sendmail" are correct for your MTA. If you are using - Sendmail, you may wish to delete the "-ODeliveryMode=deferred" option - in the "processmail" script for every invocation of "sendmail". (Be - sure and leave the "-t" option, though!) + all instances of "sendmail" are correct for your MTA. - A better alternative is to change the "-O" option to - "-ODeliveryMode=background". This prevents Sendmail from hanging your - Bugzilla Perl processes if the domain to which it must send mail is - unavailable. - - This is now a configurable parameter called "sendmailnow", available - from editparams.cgi. + If you are using Sendmail, try enabling "sendmailnow" in + editparams.cgi. If you are using Postfix, you will also need to enable + "sendmailnow". A.7.7. How come email never reaches me from bugzilla changes? @@ -4004,12 +4822,17 @@ Appendix A. The Bugzilla FAQ A.8.3. I think my database might be corrupted, or contain invalid entries. What do I do? - Run the "sanity check" utility (./sanitycheck.cgi in the bugzilla_home - directory) to see! If it all comes back, you're OK. If it doesn't come - back OK (i.e. any red letters), there are certain things Bugzilla can - recover from and certain things it can't. If it can't auto-recover, I - hope you're familiar with mysqladmin commands or have installed - another way to manage your database... + Run the "sanity check" utility (./sanitycheck.cgi in the Bugzilla_home + directory) from your web browser to see! If it finishes without + errors, you're probably OK. If it doesn't come back OK (i.e. any red + letters), there are certain things Bugzilla can recover from and + certain things it can't. If it can't auto-recover, I hope you're + familiar with mysqladmin commands or have installed another way to + manage your database. Sanity Check, although it is a good basic check + on your database integrity, by no means is a substitute for competent + database administration and avoiding deletion of data. It is not + exhaustive, and was created to do a basic check for the most common + problems in Bugzilla databases. A.8.4. I want to manually edit some entries in my database. How? @@ -4065,10 +4888,10 @@ Appendix A. The Bugzilla FAQ A.8.9. How come even after I delete bugs, the long descriptions show up? - Delete everything from $BUZILLA_HOME/shadow. Bugzilla creates shadow - files there, with each filename corresponding to a bug number. Also be - sure to run syncshadowdb to make sure, if you are using a shadow - database, that the shadow database is current. + This should only happen with Bugzilla 2.14 if you are using the + "shadow database" feature, and your shadow database is out of sync. + Try running syncshadowdb -syncall to make sure your shadow database is + in synch with your primary database. 9. Bugzilla and Win32 @@ -4279,8 +5102,8 @@ Appendix A. The Bugzilla FAQ Try this link to view current bugs or requests for enhancement for Bugzilla. - You can view bugs marked for 2.14 release here. This list includes - bugs for the 2.14 release that have already been fixed and checked + You can view bugs marked for 2.16 release here. This list includes + bugs for the 2.16 release that have already been fixed and checked into CVS. Please consult the Bugzilla Project Page for details on how to check current sources out of CVS so you can have these bug fixes early! @@ -4300,8 +5123,7 @@ Appendix A. The Bugzilla FAQ A.11.3. What's the best way to submit patches? What guidelines should I follow? - 1. Enter a bug into bugzilla.mozilla.org for the "Webtools" product, - "Bugzilla" component. + 1. Enter a bug into bugzilla.mozilla.org for the "Bugzilla" product. 2. Upload your patch as a unified DIFF (having used "diff -u" against the current sources checked out of CVS), or new source file by clicking "Create a new attachment" link on the bug page you've @@ -4904,74 +5726,6 @@ C.3. MySQL Permissions & Grant Tables http://www.mysql.com/Manual/manual.html. _________________________________________________________________ -Chapter 7. Bugzilla Variants and Competitors - - I created this section to answer questions about Bugzilla competitors - and variants, then found a wonderful site which covers an awful lot of - what I wanted to discuss. Rather than quote it in its entirety, I'll - simply refer you here: http://linas.org/linux/pm.html - _________________________________________________________________ - -7.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 the ability - to work with Oracle, MySQL, and PostGreSQL databases serving as the - back-end, instead of just MySQL. Dave Lawrence has worked very hard to - keep Red Hat Bugzilla up-to-date, and many people prefer the - snappier-looking page layout of Red Hat Bugzilla to the default - Mozilla-standard formatting. - - URL: http://bugzilla.redhat.com/bugzilla/ - _________________________________________________________________ - -7.2. Loki Bugzilla (Fenris) - - Fenris can be found at http://fenris.lokigames.com. It is a fork from - Bugzilla. - _________________________________________________________________ - -7.3. Issuezilla - - Issuezilla is another fork from Bugzilla, and seems nearly as popular - as the Red Hat Bugzilla fork. Some Issuezilla team members are regular - contributors to the Bugzilla mailing list/newsgroup. Issuezilla is not - the primary focus of bug-tracking at tigris.org, however. Their - Java-based bug-tracker, Scarab, a newfangled Java-based issue tracker, - is under heavy development and looks promising! - - URL: http://issuezilla.tigris.org/servlets/ProjectHome - _________________________________________________________________ - -7.4. Scarab - - Scarab is a promising new bug-tracking system built using Java Serlet - technology. As of this writing, no source code has been released as a - package, but you can obtain the code from CVS. - - URL: http://scarab.tigris.org - _________________________________________________________________ - -7.5. Perforce SCM - - Although Perforce isn't really a bug tracker, it can be used as such - through the "jobs" functionality. - - http://www.perforce.com/perforce/technotes/note052.htmlhttp://www.perf - orce.com/perforce/technotes/note052.html - _________________________________________________________________ - -7.6. SourceForge - - SourceForge is more of a way of coordinating geographically - distributed free software and open source projects over the Internet - than strictly a bug tracker, but if you're hunting for bug-tracking - for your open project, it may be just what the software engineer - ordered! - - URL: http://www.sourceforge.net - _________________________________________________________________ - Appendix D. Useful Patches and Utilities for Bugzilla Are you looking for a way to put your Bugzilla into overdrive? Catch @@ -5095,6 +5849,109 @@ D.4. The Quicksearch Utility has details. _________________________________________________________________ +D.5. Hacking Bugzilla + + What follows are some general guidelines for changing Bugzilla, and + adhering to good coding practice while doing so. We've had some + checkins in the past which ruined Bugzilla installations because of + disregard for these conventions. Sorry for the lack of formatting; I + got this info into the Guide on the day of 2.14 release and haven't + formatted it yet. + + The following is a guide for reviewers when checking code into Bugzill + a's + CVS repostory at mozilla.org. If you wish to submit patches to Bugzil + la, + you should follow the rules and style conventions below. Any code tha + t + does not adhere to these basic rules will not be added to Bugzilla's + codebase. + 1. Usage of variables in Regular Expressions + It is very important that you don't use a variable in a regular + expression unless that variable is supposed to contain an expressi + on. + This especially applies when using grep. You should use: + grep ($_ eq $value, @array); + - NOT - + grep (/$value/, @array); + If you need to use a non-expression variable inside of an expressi + on, be + sure to quote it properly (using \Q..\E). + Coding Style for Bugzilla + ------------------------- + While it's true that not all of the code currently in Bugzilla adheres + to + this styleguide, it is something that is being worked toward. Therefo + re, + we ask that all new code (submitted patches and new files) follow this + guide + as closely as possible (if you're only changing 1 or 2 lines, you don' + t have + to reformat the entire file :). + 1. Whitespace + Bugzilla's prefered indentation is 4 spaces (no tabs, please). + 2. Curly braces. + The opening brace of a block should be on the same line as the sta + tement + that is causing the block and the closing brace should be at the s + ame + indentation level as that statement, for example: + if ($var) { + print "The variable is true"; + } else { + print "Try again"; + } + - NOT - + if ($var) + { + print "The variable is true"; + } + else + { + print "Try again"; + } + 3. File Names + File names for bugzilla code and support documention should be leg + al across + multiple platforms. \ / : * ? " < > and | are all illegal charact + ers for + filenames on various platforms. Also, file names should not have + spaces in + them as they can cause confusion in CVS and other mozilla.org util + ities. + 4. Variable Names + If a variable is scoped globally ($::variable) its name should be + descriptive + of what it contains. Local variables can be named a bit looser, p + rovided the + context makes their content obvious. For example, $ret could be u + sed as a + staging variable for a routine's return value as the line |return + $ret;| will + make it blatently obvious what the variable holds and most likely + be shown + on the same screen as |my $ret = "";|. + 5. Cross Database Compatability + Bugzilla was originally written to work with MySQL and therefore t + ook advantage + of some of its features that aren't contained in other RDBMS softw + are. These + should be avoided in all new code. Examples of these features are + enums and + encrypt(). + 6. Cross Platform Compatability + While Bugzilla was written to be used on Unix based systems (and U + nix/Linux is + still the only officially supported platform) there are many who d + esire/need to + run Bugzilla on Microsoft Windows boxes. Whenever possible, we sh + ould strive + not to make the lives of these people any more complicated and avo + id doing things + that break Bugzilla's ability to run on multiple operating systems + . + _________________________________________________________________ + Appendix E. GNU Free Documentation License Version 1.1, March 2000 diff --git a/docs/xml/Bugzilla-Guide.xml b/docs/xml/Bugzilla-Guide.xml index 59befaf0a..8f2136bd8 100644 --- a/docs/xml/Bugzilla-Guide.xml +++ b/docs/xml/Bugzilla-Guide.xml @@ -26,7 +26,7 @@ <!ENTITY bzg-ver "2.14"> <!ENTITY bzg-cvs-ver "2.15.0"> <!ENTITY bzg-auth "Matthew P. Barnson"> -<!ENTITY bzg-auth-email "<email>barnboy@NOSPAM.trilobyte.net</email>"> +<!ENTITY bzg-auth-email "<email>barnboy@trilobyte.net</email>"> <!ENTITY mysql "http://www.mysql.com/"> <!ENTITY perl-ver "5.6.1"> @@ -126,14 +126,14 @@ try to avoid clutter and feel free to waste space in the code to make it more re <othername>P.</othername> <surname>Barnson</surname> <affiliation> - <address><email>barnboy@NOSPAM.trilobyte.net</email></address> + <address><email>barnboy@trilobyte.net</email></address> </affiliation> </author> <collab> <collabname>Zach Lipton</collabname> <affiliation> - <address><email>zach@NOSPAM.zachlipton.com</email></address> + <address><email>zach AT zachlipton DOT com</email></address> </affiliation> </collab> @@ -196,6 +196,9 @@ try to avoid clutter and feel free to waste space in the code to make it more re <!-- The Future of Bugzilla --> &future; +<!-- Major Bugzilla Variants --> +&variants; + <!-- Appendix: The Frequently Asked Questions --> &faq; @@ -205,9 +208,6 @@ try to avoid clutter and feel free to waste space in the code to make it more re <!-- Appendix: The Database Schema --> &database; -<!-- Appendix: Major Bugzilla Variants --> -&variants; - <!-- Appendix: Custom Patches --> &patches; diff --git a/docs/xml/about.xml b/docs/xml/about.xml index 89f7bb127..04e054bc2 100644 --- a/docs/xml/about.xml +++ b/docs/xml/about.xml @@ -70,8 +70,7 @@ <para> If you have any questions regarding this document, its copyright, or publishing this document in non-electronic form, - please contact &bzg-auth;. Remove "NOSPAM" from email address - to send. + please contact &bzg-auth;. </para> </section> @@ -172,8 +171,8 @@ </para> <para> <ulink url="mailto://terry@mozilla.org">Terry Weissman</ulink> - for initially converting Bugzilla from BugSplat! and writing the - README upon which this documentation is largely based. + for initially writing Bugzilla and creating the + README upon which the UNIX installation documentation is largely based. </para> <para> <ulink url="mailto://tara@tequilarista.org">Tara @@ -204,7 +203,8 @@ documentation (in no particular order): </para> <para> - Andrew Pearson, Spencer Smith, Eric Hanson, Kevin Brannen, Ron Teitelbaum + Andrew Pearson, Spencer Smith, Eric Hanson, Kevin Brannen, Ron + Teitelbaum, Jacob Steenhagen, Joe Robins </para> </section> <section id="feedback"> diff --git a/docs/xml/administration.xml b/docs/xml/administration.xml index 54f984fbc..98e726312 100644 --- a/docs/xml/administration.xml +++ b/docs/xml/administration.xml @@ -1192,6 +1192,103 @@ </para> </listitem> </orderedlist> + <para> + You may find this example illustrative for how bug groups work. + <example> + <title>Bugzilla Groups</title> + <literallayout> +Bugzilla Groups example +----------------------- + +For this example, let us suppose we have four groups, call them +Group1, Group2, Group3, and Group4. + +We have 5 users, User1, User2, User3, User4, User5. + +We have 8 bugs, Bug1, ..., Bug8. + +Group membership is defined by this chart: +(X denotes that user is in that group.) +(I apologize for the nasty formatting of this table. Try viewing +it in a text-based browser or something for now. -MPB) + + G G G G + r r r r + o o o o + u u u u + p p p p + 1 2 3 4 + +-+-+-+-+ +User1|X| | | | + +-+-+-+-+ +User2| |X| | | + +-+-+-+-+ +User3|X| |X| | + +-+-+-+-+ +User4|X|X|X| | + +-+-+-+-+ +User5| | | | | + +-+-+-+-+ + +Bug restrictions are defined by this chart: +(X denotes that bug is restricted to that group.) + + G G G G + r r r r + o o o o + u u u u + p p p p + 1 2 3 4 + +-+-+-+-+ +Bug1| | | | | + +-+-+-+-+ +Bug2| |X| | | + +-+-+-+-+ +Bug3| | |X| | + +-+-+-+-+ +Bug4| | | |X| + +-+-+-+-+ +Bug5|X|X| | | + +-+-+-+-+ +Bug6|X| |X| | + +-+-+-+-+ +Bug7|X|X|X| | + +-+-+-+-+ +Bug8|X|X|X|X| + +-+-+-+-+ + +Who can see each bug? + +Bug1 has no group restrictions. Therefore, Bug1 can be seen by any +user, whatever their group membership. This is going to be the only +bug that User5 can see, because User5 isn't in any groups. + +Bug2 can be seen by anyone in Group2, that is User2 and User4. + +Bug3 can be seen by anyone in Group3, that is User3 and User4. + +Bug4 can be seen by anyone in Group4. Nobody is in Group4, so none of +these users can see Bug4. + +Bug5 can be seen by anyone who is in _both_ Group1 and Group2. This +is only User4. User1 cannot see it because he is not in Group2, and +User2 cannot see it because she is not in Group1. + +Bug6 can be seen by anyone who is in both Group1 and Group3. This +would include User3 and User4. Similar to Bug5, User1 cannot see Bug6 +because he is not in Group3. + +Bug7 can be seen by anyone who is in Group1, Group2, and Group3. This +is only User4. All of the others are missing at least one of those +group priveleges, and thus cannot see the bug. + +Bug8 can be seen by anyone who is in Group1, Group2, Group3, and +Group4. There is nobody in all four of these groups, so nobody can +see Bug8. It doesn't matter that User4 is in Group1, Group2, and +Group3, since he isn't in Group4. + </literallayout> + </example> + </para> </section> </section> diff --git a/docs/xml/database.xml b/docs/xml/database.xml index aee9b37e5..7ff52134c 100644 --- a/docs/xml/database.xml +++ b/docs/xml/database.xml @@ -13,7 +13,7 @@ <para> <mediaobject> <imageobject> - <imagedata fileref="dbschema.jpg" format="jpg"> + <imagedata fileref="../images/dbschema.jpg" format="jpg"> </imageobject> <textobject> diff --git a/docs/xml/faq.xml b/docs/xml/faq.xml index 34b952b01..79fa528c4 100644 --- a/docs/xml/faq.xml +++ b/docs/xml/faq.xml @@ -620,6 +620,12 @@ progression states, also require adjusting the program logic to compensate for the change. </para> + <para> + There is no GUI for adding fields to Bugzilla at this + time. You can follow development of this feature at + <ulink + url="http://bugzilla.mozilla.org/show_bug.cgi?id=91037">http://bugzilla.mozilla.org/show_bug.cgi?id=91037</ulink> + </para> </answer> </qandaentry> @@ -633,42 +639,62 @@ </para> </question> <answer> - <para> - This was a late-breaking question for the Guide, so I just have to - quote the relevant newsgroup thread on it. - </para> - <literallayout> -> AFAIK, most sites (even if they have SSI enabled) won't have #exec cmd -> enabled. Perhaps what would be better is a #include virtual and a -> footer.cgi the basically has the "require 'CGI.pl' and PutFooter command. -> -> Please note that under most configurations, this also requires naming -> the file from index.html to index.shtml (and making sure that it will -> still be reconized as an index). Personally, I think this is better on -> a per-installation basis (perhaps add something to the FAQ that says how -> to do this). - -Good point. Yeah, easy enough to do, that it shouldn't be a big deal for -someone to take it on if they want it. FAQ is a good place for it. - -> Dave Miller wrote: -> ->> I did a little experimenting with getting the command menu and footer on ->> the end of the index page while leaving it as an HTML file... ->> ->> I was successful. :) ->> ->> I added this line: ->> ->> <!--#exec cmd="/usr/bin/perl -e "require 'CGI.pl'; ->>PutFooter();"" --> ->> ->> Just before the </BODY> </HTML> at the end of the file. And it worked. ->> ->> Thought I'd toss that out there. Should I check this in? For those that ->> have SSI disabled, it'll act like a comment, so I wouldn't think it would ->> break anything. - </literallayout> + <para> + It's possible to get the footer on the static index page using + Server Side Includes (SSI). The trick to doing this is making + sure that your web server is set up to allow SSI and specifically, + the #exec directive. You should also rename <filename>index.html</filename> + to <filename>index.shtml</filename>. + </para> + <para> + After you've done all that, you can add the following line to + <filename>index.shtml</filename>: +<programlisting> +<![CDATA[ +<!--#exec cmd="/usr/bin/perl -e "require 'CGI.pl'; PutFooter();"" --> +]]> +</programlisting> + </para> + <para><note> + <para> + This line will be replaced with the actual HTML for the footer + when the page is requested, so you should put this line where you + want the footer to appear. + </para> + </note></para> + <para> + Because this method depends on being able to use a #exec directive, + and most ISP's will not allow that, there is an alternative method. + You could have a small script (such as <filename>api.cgi</filename>) + that basically looks like: +<programlisting> +<![CDATA[ +#!/usr/bonsaitools/bin/perl -w + +require 'globals.pl'; + +if ($::FORM{sub} eq 'PutFooter') { + PutFooter(); +} else { + die 'api.cgi was incorrectly called'; +} +]]> +</programlisting> + and then put this line in <filename>index.shtml</filename>. +<programlisting> +<![CDATA[ +<!--#include virtual="api.cgi?sub=PutFooter"--> +]]> +</programlisting> + </para> + <para> <note> + <para> + This still requires being able to use Server Side Includes, if + this simply will not work for you, see <ulink + url="http://bugzilla.mozilla.org/show_bug.cgi?id=80183">bug 80183</ulink> + for a third option. + </para> + </note></para> </answer> </qandaentry> <qandaentry> @@ -807,21 +833,6 @@ someone to take it on if they want it. FAQ is a good place for it. <qandaentry> <question> <para> - Does Bugzilla allow fields to be added, changed or deleted? If I want to - customize the bug submission form to meet our needs, can I do that using our - terminology? - </para> - </question> - <answer> - <para> - Yes. - </para> - </answer> - </qandaentry> - - <qandaentry> - <question> - <para> Has anyone converted Bugzilla to another language to be used in other countries? Is it localizable? </para> @@ -1221,20 +1232,11 @@ someone to take it on if they want it. FAQ is a good place for it. <para> If you are using an alternate Mail Transport Agent (MTA other than sendmail), make sure the options given in the "processmail" script for all - instances of "sendmail" are correct for your MTA. If you are using Sendmail, - you may wish to delete the "-ODeliveryMode=deferred" option in the - "processmail" script for every invocation of "sendmail". (Be sure and leave - the "-t" option, though!) - </para> - <para> - A better alternative is to change the "-O" option to - "-ODeliveryMode=background". This prevents Sendmail from hanging your - Bugzilla Perl processes if the domain to which it must send mail - is unavailable. + instances of "sendmail" are correct for your MTA. </para> <para> - This is now a configurable parameter called "sendmailnow", available - from editparams.cgi. + If you are using Sendmail, try enabling "sendmailnow" in editparams.cgi. + If you are using Postfix, you will also need to enable <quote>sendmailnow</quote>. </para> </answer> </qandaentry> @@ -1315,12 +1317,21 @@ someone to take it on if they want it. FAQ is a good place for it. </question> <answer> <para> - Run the "sanity check" utility (./sanitycheck.cgi in the bugzilla_home - directory) to see! If it all comes back, you're OK. If it doesn't come back - OK (i.e. any red letters), there are certain things Bugzilla can recover - from and certain things it can't. If it can't auto-recover, I hope you're - familiar with mysqladmin commands or have installed another way to manage - your database... + Run the <quote>sanity check</quote> utility + (<filename>./sanitycheck.cgi</filename> in the + Bugzilla_home directory) from your web browser to see! If + it finishes without errors, you're + <emphasis>probably</emphasis> OK. If it doesn't come back + OK (i.e. any red letters), there are certain things + Bugzilla can recover from and certain things it can't. If + it can't auto-recover, I hope you're familiar with + mysqladmin commands or have installed another way to + manage your database. Sanity Check, although it is a good + basic check on your database integrity, by no means is a + substitute for competent database administration and + avoiding deletion of data. It is not exhaustive, and was + created to do a basic check for the most common problems + in Bugzilla databases. </para> </answer> </qandaentry> @@ -1428,10 +1439,12 @@ someone to take it on if they want it. FAQ is a good place for it. </question> <answer> <para> - Delete everything from $BUZILLA_HOME/shadow. Bugzilla creates shadow - files there, with each filename corresponding to a - bug number. Also be sure to run syncshadowdb to make sure, if you are using - a shadow database, that the shadow database is current. + This should only happen with Bugzilla &bz-ver; if you are + using the <quote>shadow database</quote> feature, and your + shadow database is out of sync. Try running + <filename>syncshadowdb</filename> + <option>-syncall</option> to make sure your shadow + database is in synch with your primary database. </para> </answer> </qandaentry> @@ -1752,14 +1765,14 @@ A: Sure! Here ya go! </question> <answer> <para> - Try <ulink url="http://bugzilla.mozilla.org/buglist.cgi?bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&product=Webtools&component=Bugzilla"> + Try <ulink url="http://bugzilla.mozilla.org/buglist.cgi?bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&product=Bugzilla"> this link</ulink> to view current bugs or requests for enhancement for Bugzilla. </para> <para> - You can view bugs marked for 2.14 release - <ulink url="http://bugzilla.mozilla.org/buglist.cgi?product=Webtools&component=Bugzilla&target_milestone=Bugzilla+2.14">here</ulink>. - This list includes bugs for the 2.14 release that have already + You can view bugs marked for 2.16 release + <ulink url="http://bugzilla.mozilla.org/buglist.cgi?product=Bugzilla&target_milestone=Bugzilla+2.16">here</ulink>. + This list includes bugs for the 2.16 release that have already been fixed and checked into CVS. Please consult the <ulink url="http://www.mozilla.org/projects/bugzilla/"> Bugzilla Project Page</ulink> for details on how to @@ -1800,8 +1813,9 @@ A: Sure! Here ya go! <orderedlist> <listitem> <para> - Enter a bug into bugzilla.mozilla.org for the "Webtools" product, - "Bugzilla" component. + Enter a bug into bugzilla.mozilla.org for the <quote><ulink + url="http://bugzilla.mozilla.org/enter_bug.cgi?product=Bugzilla">Bugzilla</ulink></quote> + product. </para> </listitem> <listitem> diff --git a/docs/xml/installation.xml b/docs/xml/installation.xml index 547d466ba..9cf100fdb 100644 --- a/docs/xml/installation.xml +++ b/docs/xml/installation.xml @@ -616,6 +616,15 @@ bash# mkdir /usr/bonsaitools/bin bash# ln -s /usr/bin/perl /usr/bosaitools/bin/perl </programlisting> </para> + <para> + Alternately, you can simply run this perl one-liner to + change your path to perl in all the files in your Bugzilla + installation: + <programlisting> +perl -pi -e 's@#!/usr/bonsaitools/bin/perl@/usr/bin/perl@' *cgi *pl Bug.pm + </programlisting> + Change the second path to perl to match your installation. + </para> </example> <tip> <para> @@ -1241,7 +1250,7 @@ bash# cd $BUGZILLA_HOME; for i in `ls *.cgi`; \ </section> - <section> + <section id="unixhistory"> <title>UNIX Installation Instructions History</title> <para> This document was originally adapted from the Bonsai @@ -1252,9 +1261,8 @@ bash# cd $BUGZILLA_HOME; for i in `ls *.cgi`; \ The February 25, 1999 re-write of this page was done by Ry4an Brase <ry4an@ry4an.org>, with some edits by Terry Weissman, Bryce Nesbitt, Martin Pool, & Dan Mosedale (But - don't send bug reports to them; report them using bugzilla, at - http://bugzilla.mozilla.org/enter_bug.cgi , project Webtools, - component Bugzilla). + don't send bug reports to them; report them using bugzilla, at <ulink + url="http://bugzilla.mozilla.org/enter_bug.cgi?product=Bugzilla">http://bugzilla.mozilla.org/enter_bug.cgi?product=Bugzilla</ulink> ). </para> <para> This document was heavily modified again Wednesday, March 07 @@ -1696,16 +1704,46 @@ exit; <step> <para> - Modify the invocation of all system() calls in all perl scripts in your Bugzilla directory. For instance, change this line in processmail: - <programlisting> -system ("./processmail.pl",@ARGLIST); - </programlisting> -to - <programlisting> + Modify the invocation of all system() calls in all perl + scripts in your Bugzilla directory. For instance, change + this line in processmail: + <programlisting> +system ("./processmail.pl",@ARGLIST); + </programlisting> to + <programlisting> system ("perl processmail.pl",@ARGLIST); </programlisting> </para> </step> + <step> + <para> + Add <function>binmode()</function> calls so attachments + will work (<ulink + url="http://bugzilla.mozilla.org/show_bug.cgi?id=62000">bug 62000</ulink>). + </para> + <para> + Because Microsoft Windows based systems handle binary + files different than Unix based systems, you need to add + the following lines to + <filename>createattachment.cgi</filename> and + <filename>showattachment.cgi</filename> before the + <function>require 'CGI.pl';</function> line. +</para> +<para> +<programlisting> +<![CDATA[ +binmode(STDIN); +binmode(STDOUT); +]]> +</programlisting> + </para> + <note> + <para> + According to <ulink + url="http://bugzilla.mozilla.org/show_bug.cgi?id=62000">bug 62000</ulink>, the perl documentation says that you should always use <function>binmode()</function> when dealing with binary files, but never when dealing with text files. That seems to suggest that rather than aribtrarily putting <function>binmode()</function> at the begining of the attachment files, there should be logic to determine if <function>binmode()</function> is needed or not. + </para> + </note> + </step> </procedure> <tip> @@ -1714,6 +1752,8 @@ system ("perl processmail.pl",@ARGLIST); relationships to Properties -> Home directory (tab) -> Application Settings (section) -> Configuration (button), such as: + </para> + <para> <programlisting> .cgi to: <perl install directory>\perl.exe %s %s .pl to: <perl install directory>\perl.exe %s %s @@ -1742,7 +1782,9 @@ GET,HEAD,POST registry at the following location: </para> <para> - HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\W3SVC\Parameters\ScriptMap + <programlisting> +HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\W3SVC\Parameters\ScriptMap + </programlisting> </para> <para> The keys should be called ".pl" and ".cgi", and both @@ -1761,26 +1803,102 @@ GET,HEAD,POST If attempting to run Bugzilla 2.12 or older, you will need to remove encrypt() calls from the Perl source. This is <emphasis>not necessary</emphasis> for Bugzilla 2.13 and - later. + later, which includes the current release, Bugzilla + &bz-ver;. <example> <title>Removing encrypt() for Windows NT Bugzilla version 2.12 or earlier</title> <para> - Replace this: - <programlisting> -SendSQL("SELECT encrypt(" . SqlQuote($enteredpwd) . ", " . SqlQuote(substr($realcryptpwd, 0, 2)) . ")"); -my $enteredcryptpwd = FetchOneColumn(); - </programlisting> - with this: - <programlisting> -my $enteredcryptpwd = $enteredpwd - </programlisting> + Replace this: + <programlisting> +SendSQL("SELECT encrypt(" . SqlQuote($enteredpwd) . ", " . SQLQuote(substr($realcryptpwd, 0, 2)) . ")"); +my $enteredcryptpwd = FetchOneColumn(); + </programlisting> +with this: + <programlisting> +my $enteredcryptpwd = $enteredpwd + </programlisting> in cgi.pl. </para> </example> </para> </tip> </section> + + <section id="bzldap"> + <title>Bugzilla LDAP Integration</title> + <para> + What follows is some late-breaking information on using the + LDAP authentication options with Bugzilla. The author has not + tested these (nor even formatted this section!) so please + contribute feedback to the newsgroup. + </para> + <literallayout> +Mozilla::LDAP module + +The Mozilla::LDAP module allows you to use LDAP for authentication to +the Bugzilla system. This module is not required if you are not using +LDAP. + +Mozilla::LDAP (aka PerLDAP) is available for download from +http://www.mozilla.org/directory. + +NOTE: The Mozilla::LDAP module requires Netscape's Directory SDK. +Follow the link for "Directory SDK for C" on that same page to +download the SDK first. After you have installed this SDK, then +install the PerLDAP module. +---------------------------------------------------------------------- + +Post-Installation Checklist +---------------------------------------------------------------------- +Set useLDAP to "On" **only** if you will be using an LDAP directory +for authentication. Be very careful when setting up this parameter; +if you set LDAP authentication, but do not have a valid LDAP directory +set up, you will not be able to log back in to Bugzilla once you log +out. (If this happens, you can get back in by manually editing the +data/params file, and setting useLDAP back to 0.) + +If using LDAP, you must set the three additional parameters: + +Set LDAPserver to the name (and optionally port) of your LDAP server. +If no port is specified, it defaults to the default port of 389. (e.g +"ldap.mycompany.com" or "ldap.mycompany.com:1234") + +Set LDAPBaseDN to the base DN for searching for users in your LDAP +directory. (e.g. "ou=People,o=MyCompany") uids must be unique under +the DN specified here. + +Set LDAPmailattribute to the name of the attribute in your LDAP +directory which contains the primary email address. On most directory +servers available, this is "mail", but you may need to change this. +---------------------------------------------------------------------- + +(Not sure where this bit should go, but it's important that it be in +there somewhere...) +---------------------------------------------------------------------- +Using LDAP authentication for Bugzilla: + +The existing authentication scheme for Bugzilla uses email addresses +as the primary user ID, and a password to authenticate that user. All +places within Bugzilla where you need to deal with user ID (e.g +assigning a bug) use the email address. + +The LDAP authentication builds on top of this scheme, rather than +replacing it. The initial log in is done with a username and password +for the LDAP directory. This then fetches the email address from LDAP +and authenticates seamlessly in the standard Bugzilla authentication +scheme using this email address. If an account for this address +already exists in your Bugzilla system, it will log in to that +account. If no account for that email address exists, one is created +at the time of login. (In this case, Bugzilla will attempt to use the +"displayName" or "cn" attribute to determine the user's full name.) + +After authentication, all other user-related tasks are still handled +by email address, not LDAP username. You still assign bugs by email +address, query on users by email address, etc. +---------------------------------------------------------------------- + </literallayout> + </section> </section> </chapter> diff --git a/docs/xml/integration.xml b/docs/xml/integration.xml index e0547c365..36cc617e2 100644 --- a/docs/xml/integration.xml +++ b/docs/xml/integration.xml @@ -35,6 +35,14 @@ an @resolution field, you can even change the Bugzilla bug state. </para> + <para> + There is also a project, based upon somewhat dated Bugzilla + code, to integrate CVS and Bugzilla through CVS' ability to + email. Check it out at: + <ulink url="http://homepages.kcbbs.gen.nz/~tonyg/"> + http://homepages.kcbbs.gen.nz/~tonyg/</ulink>, under the + <quote>cvszilla</quote> link. + </para> </section> <section id="scm" xreflabel="Perforce SCM (Fast Software Configuration Management System, a powerful commercial alternative to CVS"> diff --git a/docs/xml/patches.xml b/docs/xml/patches.xml index 3a1ce90d2..3f49255f2 100644 --- a/docs/xml/patches.xml +++ b/docs/xml/patches.xml @@ -247,6 +247,104 @@ RewriteRule ^/([0-9]+)$ http://foo.bar.com/show_bug.cgi?id=$1 [L,R] </para> </section> + <section id="bzhacking"> + <title>Hacking Bugzilla</title> + <para> + What follows are some general guidelines for changing Bugzilla, and adhering to good coding practice while doing so. We've had some checkins in the past which ruined Bugzilla installations because of disregard for these conventions. Sorry for the lack of formatting; I got this info into the Guide on the day of 2.14 release and haven't formatted it yet. + </para> + <literallayout> + +The following is a guide for reviewers when checking code into Bugzilla's +CVS repostory at mozilla.org. If you wish to submit patches to Bugzilla, +you should follow the rules and style conventions below. Any code that +does not adhere to these basic rules will not be added to Bugzilla's +codebase. + + 1. Usage of variables in Regular Expressions + + It is very important that you don't use a variable in a regular + expression unless that variable is supposed to contain an expression. + This especially applies when using grep. You should use: + + grep ($_ eq $value, @array); + + - NOT - + + grep (/$value/, @array); + + If you need to use a non-expression variable inside of an expression, be + sure to quote it properly (using \Q..\E). + +Coding Style for Bugzilla +------------------------- + +While it's true that not all of the code currently in Bugzilla adheres to +this styleguide, it is something that is being worked toward. Therefore, +we ask that all new code (submitted patches and new files) follow this guide +as closely as possible (if you're only changing 1 or 2 lines, you don't have +to reformat the entire file :). + + 1. Whitespace + + Bugzilla's prefered indentation is 4 spaces (no tabs, please). + + 2. Curly braces. + + The opening brace of a block should be on the same line as the statement + that is causing the block and the closing brace should be at the same + indentation level as that statement, for example: + + if ($var) { + print "The variable is true"; + } else { + print "Try again"; + } + + - NOT - + + if ($var) + { + print "The variable is true"; + } + else + { + print "Try again"; + } + + 3. File Names + + File names for bugzilla code and support documention should be legal across + multiple platforms. \ / : * ? " < > and | are all illegal characters for + filenames on various platforms. Also, file names should not have spaces in + them as they can cause confusion in CVS and other mozilla.org utilities. + + 4. Variable Names + + If a variable is scoped globally ($::variable) its name should be descriptive + of what it contains. Local variables can be named a bit looser, provided the + context makes their content obvious. For example, $ret could be used as a + staging variable for a routine's return value as the line |return $ret;| will + make it blatently obvious what the variable holds and most likely be shown + on the same screen as |my $ret = "";|. + + 5. Cross Database Compatability + + Bugzilla was originally written to work with MySQL and therefore took advantage + of some of its features that aren't contained in other RDBMS software. These + should be avoided in all new code. Examples of these features are enums and + encrypt(). + + 6. Cross Platform Compatability + + While Bugzilla was written to be used on Unix based systems (and Unix/Linux is + still the only officially supported platform) there are many who desire/need to + run Bugzilla on Microsoft Windows boxes. Whenever possible, we should strive + not to make the lives of these people any more complicated and avoid doing things + that break Bugzilla's ability to run on multiple operating systems. + + </literallayout> + </section> + </appendix> diff --git a/docs/xml/using.xml b/docs/xml/using.xml index 91a7658cd..934817081 100644 --- a/docs/xml/using.xml +++ b/docs/xml/using.xml @@ -399,13 +399,13 @@ system against which all others are measured. our Bugzilla database. Please notice the box is a <emphasis>scrollbox</emphasis>. Using the down arrow on the scrollbox, scroll down until you can see an entry - called "Webtools". Select this entry. + called "Bugzilla". Select this entry. </para> </listitem> <listitem> <para> Did you notice that some of the boxes to the right changed - when you selected "Webtools"? Every Program (or Product) + 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. @@ -452,36 +452,67 @@ system against which all others are measured. Normally, a Component has a single Owner, who is responsible for overseeing efforts to improve that Component. <example> - <title>Mozilla Webtools Components</title> + <title>Mozilla's Bugzilla Components</title> <informalexample> <para> - Mozilla's "Webtools" Product is composed of several pieces (Components): + Mozilla's "Bugzilla" Product is composed of several pieces (Components): <simplelist> - <member><emphasis>Bonsai</emphasis>, - a tool to show recent changes to Mozilla</member> - <member><emphasis>Bugzilla</emphasis>, - a defect-tracking tool</member> - <member><emphasis>Build</emphasis>, - a tool to automatically compile source code - into machine-readable form</member> - <member><emphasis>Despot</emphasis>, - a program that controls access to the other Webtools</member> - <member><emphasis>LXR</emphasis>, - a utility that automatically marks up text files - to make them more readable</member> - <member><emphasis>MozBot</emphasis>, - a "robot" that announces changes to Mozilla in Chat</member> - <member><emphasis>TestManager</emphasis>, - a tool to help find bugs in Mozilla</member> - <member><emphasis>Tinderbox</emphasis>, - which displays reports from Build</member> + <member><emphasis>Administration</emphasis>, + Administration of a bugzilla installation, including + <filename>editcomponents.cgi</filename>, + <filename>editgroups.cgi</filename>, + <filename>editkeywords.cgi</filename>, + <filename>editparams.cgi</filename>, + <filename>editproducts.cgi</filename>, + <filename>editusers.cgi</filename>, + <filename>editversions.cgi,</filename> and + <filename>sanitycheck.cgi</filename>. + </member> + <member><emphasis>Bugzilla-General</emphasis>, + Anything that doesn't fit in the other components, or spans + multiple components. + </member> + <member><emphasis>Creating/Changing Bugs</emphasis>, + Creating, changing, and viewing bugs. + <filename>enter_bug.cgi</filename>, + <filename>post_bug.cgi</filename>, + <filename>show_bug.cgi</filename> and + <filename>process_bug.cgi</filename>. + </member> + <member><emphasis>Documentation</emphasis>, + The bugzilla documentation, including anything in the + <filename>docs/</filename> directory and The Bugzilla Guide + (This document :) + </member> + <member><emphasis>Email</emphasis>, + Anything to do with email sent by Bugzilla. + <filename>processmail</filename> + </member> + <member><emphasis>Installation</emphasis>, + The installation process of Bugzilla. This includes + <filename>checksetup.pl</filename> and whatever else it evolves into. + </member> + <member><emphasis>Query/Buglist</emphasis>, + Anything to do with searching for bugs and viewing the buglists. + <filename>query.cgi</filename> and + <filename>buglist.cgi</filename> + </member> + <member><emphasis>Reporting/Charting</emphasis>, + Getting reports from Bugzilla. + <filename>reports.cgi</filename> and + <filename>duplicates.cgi</filename> + </member> + <member><emphasis>User Accounts</emphasis>, + Anything about managing a user account from the user's perspective. + <filename>userprefs.cgi</filename>, saved queries, creating accounts, + changing passwords, logging in, etc. + </member> + <member><emphasis>User Interface</emphasis>, + General issues having to do with the user interface cosmetics (not + functionality) including cosmetic issues, HTML templates, etc. + </member> </simplelist> </para> - <para> - A different person is responsible for each of these Components. - Tara Hernandez keeps - the "Bugzilla" component up-to-date. - </para> </informalexample> </example> </para> |
