diff options
Diffstat (limited to 'docs')
34 files changed, 11347 insertions, 7900 deletions
diff --git a/docs/sgml/Bugzilla-Guide.sgml b/docs/sgml/Bugzilla-Guide.sgml index 88daac2bb..30deb5c4a 100644 --- a/docs/sgml/Bugzilla-Guide.sgml +++ b/docs/sgml/Bugzilla-Guide.sgml @@ -1,4 +1,4 @@ -<!DOCTYPE BOOK PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [ +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [ <!-- Include macros --> <!ENTITY about SYSTEM "about.sgml"> @@ -17,99 +17,156 @@ <!ENTITY patches SYSTEM "patches.sgml"> <!ENTITY variants SYSTEM "variants.sgml"> <!ENTITY requiredsoftware SYSTEM "requiredsoftware.sgml"> +<!ENTITY revhistory SYSTEM "revhistory.sgml"> + +<!ENTITY bz "http://www.mozilla.org/projects/bugzilla"> +<!ENTITY bz-ver "2.14"> +<!ENTITY bz-cvs-ver "2.15"> +<!ENTITY bzg-date "August 10, 2001"> +<!ENTITY bzg-ver "2.14.0"> +<!ENTITY bzg-cvs-ver "2.15.0"> +<!ENTITY bzg-auth "Matthew P. Barnson"> +<!ENTITY bzg-auth-email "<email>barnboy@NOSPAM.trilobyte.net</email>"> +<!ENTITY mysql "http://www.mysql.com/"> +<!ENTITY perl-ver "5.6.1"> ]> -<!-- Coding standards for this document - -1. Preface new or modified sections with a comment stating who - modified it and when; please also use the "authorinitials" tag. - -2. There is no "two". - -3. Other than the GFDL, please use the "section" tag instead of "sect1", "sect2", etc. - -4. Use Entities to include files for new chapters in Bugzilla-Guide.sgml. - -5. Ensure all documents compile cleanly to HTML after modification. - The errors "DTD Declaration not allowed here" and "DTDDECL catalog types not supported" - are normal errors to be expected when compiling the whole guide. - -6. Try to index important terms wherever possible. -7. Follow coding standards at http://www.linuxdoc.org. - -8. All tags should be lowercase (needsfix) - -9. Code being submitted for review should use the -"review" tag. Documentation on this is available at -http://www.linuxdoc.org/LDP/LDP-Author-Guide/tools-hints.html - under section 4.9.4, "Making notes on the text while it's being written". +<!-- Coding standards for this document -10. Please use sensible spacing. The comments at the very end of each Guide - file define reasonable defaults for PSGML mode in EMACS. - Double-indent tags, use double spacing whenever possible, - try to avoid clutter and feel free to waste space in the code to make it more readable. +* Other than the GFDL, please use the "section" tag instead of "sect1", "sect2", etc. +* Use Entities to include files for new chapters in Bugzilla-Guide.sgml. +* Try to use Entities for frequently-used passages of text as well. +* Ensure all documents compile cleanly to HTML after modification. +The warning, "DTDDECL catalog types not supported" is normal. +* Try to index important terms wherever possible. +* Use "glossterm" whenever you introduce a new term. +* Follow coding standards at http://www.linuxdoc.org, and +check out the KDE guidelines (they are nice, too) +http://i18n.kde.org/doc/markup.html +* All tags should be lowercase (needsfix) +* Please use sensible spacing. The comments at the very end of each +file define reasonable defaults for PSGML mode in EMACS. +Double-indent tags, use double spacing whenever possible, and +try to avoid clutter and feel free to waste space in the code to make it more readable. --> -<BOOK ID="index"> +<book id="index"> <!-- Header --> - <BOOKINFO> - <TITLE>The Bugzilla Guide</TITLE> - <PUBDATE>2001-04-25</PUBDATE> - <AUTHOR> - <FIRSTNAME>Matthew</FIRSTNAME> - <OTHERNAME>P.</OTHERNAME> - <SURNAME>Barnson</SURNAME> - <affiliation> - <address><email>barnboy@trilobyte.net</email></address> - </affiliation> - </AUTHOR> - - <ABSTRACT> - <PARA>This is the documentation for Bugzilla, the Mozilla bug-tracking system.</PARA> - </ABSTRACT> - - <REVHISTORY> - <REVISION> - <REVNUMBER>v2.11</REVNUMBER> - <DATE>20 December 2000</DATE> - <AUTHORINITIALS>MPB</AUTHORINITIALS> - <REVREMARK>Converted the README, FAQ, and DATABASE information into SGML - docbook format.</REVREMARK> - </REVISION> + <bookinfo> + <title>The Bugzilla Guide</title> + <pubdate>2001-04-25</pubdate> + <revhistory> + <revision> + <revnumber>v2.11</revnumber> + <date>20 December 2000</date> + <authorinitials>MPB</authorinitials> + <revremark> + Converted the README, FAQ, and DATABASE information into + SGML docbook format. + </revremark> + </revision> <revision> <revnumber>2.11.1</revnumber> <date>06 March 2001</date> <authorinitials>MPB</authorinitials> <revremark> - Took way too long to revise this for 2.12 release. - Updated FAQ to use qandaset tags instead of literallayout, - cleaned up administration section, added User Guide section, - miscellaneous FAQ updates and third-party integration information. - From this point on all new tags are lowercase in preparation for the - 2.13 release of the Guide in XML format instead of SGML. + Took way too long to revise this for 2.12 release. Updated + FAQ to use qandaset tags instead of literallayout, cleaned + up administration section, added User Guide section, + miscellaneous FAQ updates and third-party integration + information. From this point on all new tags are lowercase + in preparation for the 2.13 release of the Guide in XML + format instead of SGML. </revremark> </revision> - + <revision> <revnumber>2.12.0</revnumber> <date>24 April 2001</date> <authorinitials>MPB</authorinitials> <revremark> - Things fixed this release: Elaborated on queryhelp interface, added FAQ regarding - moving bugs from one keyword to another, clarified possible problems with the Landfill - tutorial, fixed a boatload of typos and unclear sentence structures. Incorporated the - README into the UNIX installation section, and changed the README to indicate the deprecated - status. Things I know need work: Used "simplelist" a lot, where I should have used - "procedure" to tag things. Need to lowercase all tags to be XML compliant. + Things fixed this release: Elaborated on queryhelp + interface, added FAQ regarding moving bugs from one keyword + to another, clarified possible problems with the Landfill + tutorial, fixed a boatload of typos and unclear sentence + structures. Incorporated the README into the UNIX + installation section, and changed the README to indicate the + deprecated status. Things I know need work: Used + "simplelist" a lot, where I should have used "procedure" to + tag things. Need to lowercase all tags to be XML compliant. </revremark> </revision> - </REVHISTORY> + + <revision> + <revnumber>2.14.0</revnumber> + <date>07 August 2001</date> + <authorinitials>MPB</authorinitials> + <revremark> + Attempted to integrate relevant portions of the UNIX and + Windows installation instructions, moved some data from FAQ + to Install, removed references to README from text, added + Mac OS X install instructions, fixed a bunch + of tpyos (Mark Harig), linked text that referenced other + parts of the Guide, and nuked the old MySQL permissions + section. + </revremark> + </revision> + </revhistory> + + <authorgroup> + + <author> + <firstname>Matthew</firstname> + <othername>P.</othername> + <surname>Barnson</surname> + <affiliation> + <address><email>barnboy@NOSPAM.trilobyte.net</email></address> + </affiliation> + </author> + + <collab> + <collabname>Zach Lipton</collabname> + <affiliation> + <address><email>zach@NOSPAM.zachlipton.com</email></address> + </affiliation> + </collab> + + <editor> + <firstname>I.</firstname> + <surname>Freely</surname> + <othername>P.</othername> + <affiliation> + <address><email>ipfreely@freely.eye-p.net</email></address> + </affiliation> + </editor> + + </authorgroup> + + <abstract> + <para> + This is the documentation for Bugzilla, the Mozilla + bug-tracking system. + </para> + <para> + Bugzilla is an enterprise-class set of software utilities + that, when used together, power issue-tracking for hundreds of + organizations around the world, tracking millions of bugs. + While it is easy to use and quite flexible, it is very + difficult for a novice to install and maintain. Although we + have provided step-by-step directions, Bugzilla is not always + easy to get working. Please be sure the person responsible + for installing and maintaining this software is a qualified + professional on operating system upon which you install + Bugzilla. + </para> + </abstract> + <KEYWORDSET> <KEYWORD>Bugzilla</KEYWORD> @@ -127,15 +184,15 @@ http://www.linuxdoc.org/LDP/LDP-Author-Guide/tools-hints.html <!-- About This Guide --> &about; +<!-- Using Bugzilla --> +&using; + <!-- Installing Bugzilla --> &installation; <!-- Administering Bugzilla --> &administration; -<!-- Using Bugzilla --> -&using; - <!-- Integrating Bugzilla with Third-Party Tools --> &integration; @@ -166,31 +223,26 @@ http://www.linuxdoc.org/LDP/LDP-Author-Guide/tools-hints.html <!-- Index --> &index; -</BOOK> + +</book> <!-- Keep this comment at the end of the file Local variables: mode: sgml -sgml-omittag:t -sgml-shorttag:t -sgml-namecase-general:t -sgml-general-insert-case:lower -sgml-minimize-attributes:nil sgml-always-quote-attributes:t -sgml-indent-step:2 -sgml-indent-data:t -sgml-parent-document:nil +sgml-auto-insert-required-elements:t +sgml-balanced-tag-edit:t sgml-exposed-tags:nil +sgml-general-insert-case:lower +sgml-indent-data:t +sgml-indent-step:2 sgml-local-catalogs:nil sgml-local-ecat-files:nil +sgml-minimize-attributes:nil +sgml-namecase-general:t +sgml-omittag:t +sgml-parent-document:("Bugzilla-Guide.sgml" "book" "chapter") +sgml-shorttag:t +sgml-tag-region-if-active:t End: --> - - - - - - - - - diff --git a/docs/sgml/about.sgml b/docs/sgml/about.sgml index d1b56cfdb..d92fa9b30 100644 --- a/docs/sgml/about.sgml +++ b/docs/sgml/about.sgml @@ -1,242 +1,256 @@ -<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [ -<!ENTITY conventions SYSTEM "conventions.sgml"> ] > +<!-- <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [ +<!ENTITY conventions SYSTEM "conventions.sgml"> ] > --> -<CHAPTER ID="about"> -<TITLE>About This Guide</TITLE> +<chapter id="about"> +<title>About This Guide</title> - <SECTION ID="aboutthisguide"> - <TITLE>Purpose and Scope of this Guide</TITLE> - <PARA> - This document was started on September 17, 2000 - by Matthew P. Barnson after a great deal of procrastination updating the Bugzilla FAQ, - which I left untouched for nearly half a year. - After numerous complete rewrites and reformatting, it is the document you see today. - </PARA> - <PARA> - Despite the lack of updates, Bugzilla is simply the best piece of bug-tracking software - the world has ever seen. This document is intended to be the comprehensive guide to - the installation, administration, maintenance, and use of the Bugzilla bug-tracking system. - </PARA> - <PARA> - This release of the Bugzilla Guide is the <EMPHASIS>2.11</EMPHASIS> release. - It is so named that it may match the current version of Bugzilla. - The numbering tradition stems from that used for many free software projects, - in which <EMPHASIS>even-numbered</EMPHASIS> point releases (1.2, 1.14, etc.) - are considered "stable releases", intended for public consumption; on the other - hand, <EMPHASIS>odd-numbered</EMPHASIS> point releases (1.3, 2.09, etc.) - are considered unstable <EMPHASIS>development</EMPHASIS> releases intended - for advanced users, systems administrators, developers, and those who enjoy - a lot of pain. - </PARA> - <PARA> - Newer revisions of the Bugzilla Guide will follow the numbering conventions of - the main-tree Bugzilla releases, available at - <ULINK URL="http://www.mozilla.org/bugs/source.html">Mozilla.org</ULINK>, with - the exception that intermediate releases will have a minor revision number - following a period. For instance, if the current version of Bugzilla is 4.2, - the current "stable" version of the Bugzilla guide, in, say, it's fifth revision, - would be numbered "4.2.5". Got it? Good. - </PARA> - <PARA> - I wrote this in response to the enormous demand for decent Bugzilla documentation. - I have incorporated instructions from the Bugzilla README, Frequently Asked Questions, - Database Schema Document, and various mailing lists to create it. - Chances are, there are glaring errors in this documentation; please contact - <EMAIL>barnboy@trilobyte.net</EMAIL> to correct them. - </PARA> - </SECTION> + <section id="aboutthisguide"> + <title>Purpose and Scope of this Guide</title> + <para> + This document was started on September 17, 2000 by Matthew P. + Barnson after a great deal of procrastination updating the + Bugzilla FAQ, which I left untouched for nearly half a year. + After numerous complete rewrites and reformatting, it is the + document you see today. + </para> + <para> + Despite the lack of updates, Bugzilla is simply the best piece + of bug-tracking software the world has ever seen. This document + is intended to be the comprehensive guide to the installation, + administration, maintenance, and use of the Bugzilla + bug-tracking system. + </para> + <para> + This release of the Bugzilla Guide is the + <emphasis>&bzg-ver;</emphasis> release. It is so named that it + may match the current version of Bugzilla. The numbering + tradition stems from that used for many free software projects, + in which <emphasis>even-numbered</emphasis> point releases (1.2, + 1.14, etc.) are considered "stable releases", intended for + public consumption; on the other hand, + <emphasis>odd-numbered</emphasis> point releases (1.3, 2.09, + etc.) are considered unstable <emphasis>development</emphasis> + releases intended for advanced users, systems administrators, + developers, and those who enjoy a lot of pain. + </para> + <para> + Newer revisions of the Bugzilla Guide follow the numbering + conventions of the main-tree Bugzilla releases, available at + <ulink url="&bz;">&bz;</ulink>. Intermediate releases will have + a minor revision number following a period. The current version + of Bugzilla, as of this writing (&bzg-date;) is &bz-ver;; if + something were seriously wrong with that edition of the Guide, + subsequent releases would receive an additional dotted-decimal + digit to indicate the update (&bzg-ver;.1, &bzg-ver;.2, etc.). + Got it? Good. + </para> + <para> + I wrote this in response to the enormous demand for decent + Bugzilla documentation. I have incorporated instructions from + the Bugzilla README, Frequently Asked Questions, Database Schema + Document, and various mailing lists to create it. Chances are, + there are glaring errors in this documentation; please contact + &bzg-auth-email; to correct them. + </para> + </section> - <SECTION ID="copyright"> - <TITLE>Copyright Information</TITLE> - <BLOCKQUOTE> - <ATTRIBUTION>Copyright (c) 2000-2001 Matthew P. Barnson</ATTRIBUTION> - <PARA> - Permission is granted to copy, distribute and/or modify this document under thei - terms of the GNU Free Documentation License, Version 1.1 or any later version published - by the Free Software Foundation; with no Invariant Sections, no Front-Cover Texts, and - with no Back-Cover Texts. A copy of the license is included in the section entitled - "GNU Free Documentation LIcense". - </PARA> - </BLOCKQUOTE> - <PARA> - If you have any questions regarding this document, its' copyright, or publishing this - document in non-electronic form, please contact <EMAIL>barnboy@trilobyte.net</EMAIL> - </PARA> - </SECTION> + <section id="copyright"> + <title>Copyright Information</title> + <blockquote> + <attribution>Copyright (c) 2000-2001 &bzg-auth;</attribution> + <para> + Permission is granted to copy, distribute and/or modify this + document under the terms of the GNU Free Documentation + License, Version 1.1 or any later version published by the + Free Software Foundation; with no Invariant Sections, no + Front-Cover Texts, and with no Back-Cover Texts. A copy of + the license is included in the section entitled "GNU Free + Documentation LIcense". + </para> + </blockquote> + <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. + </para> + </section> - <SECTION ID="disclaimer"> - <TITLE>Disclaimer</TITLE> - <PARA> + <section id="disclaimer"> + <title>Disclaimer</title> + <para> No liability for the contents of this document can be accepted. Use the concepts, examples, and other content at your own risk. As this is a new edition of this document, there may be errors - and inaccuracies that may damage your system. Use of this document - may cause your girlfriend to leave you, your cats to pee on your - furniture and clothing, your computer to cease functioning, your - boss to fire you, and global thermonuclear war. Proceed with caution. - </PARA> - <PARA> - All copyrights are held by their respective owners, unless specifically - noted otherwise. Use of a term in this document should not be regarded - as affecting the validity of any trademark or service mark. - In particular, I like to put down Microsoft(tm). Live with it. - </PARA> - <PARA> - Naming of particular products or brands should not be seen as endorsements, - with the exception of the term "GNU/Linux". - Use GNU/Linux. Love it. Bathe with it. It is life and happiness. - I endorse it wholeheartedly and encourage you to do the same. - </PARA> - <PARA> - You are strongly recommended to make a backup of your system before - installing Bugzilla and at regular intervals thereafter. Heaven knows - it's saved my bacon time after time; if you implement any suggestion in - this Guide, implement this one! - </PARA> - <PARA> - Bugzilla has not undergone a complete security review. - Security holes probably exist in the code. - Great care should be taken both in the installation and usage of this software. - Carefully consider the implications of installing other network services with Bugzilla. - </PARA> - </SECTION> + and inaccuracies that may damage your system. Use of this + document may cause your girlfriend to leave you, your cats to + pee on your furniture and clothing, your computer to cease + functioning, your boss to fire you, and global thermonuclear + war. Proceed with caution. + </para> + <para> + All copyrights are held by their respective owners, unless + specifically noted otherwise. Use of a term in this document + should not be regarded as affecting the validity of any + trademark or service mark. + </para> + <para> + Naming of particular products or brands should not be seen as + endorsements, with the exception of the term "GNU/Linux". I + wholeheartedly endorse the use of GNU/Linux in every situation + where it is appropriate. It is an extremely versatile, stable, + and robust operating system that offers an ideal operating + environment for Bugzilla. + </para> + <para> + You are strongly recommended to make a backup of your system + before installing Bugzilla and at regular intervals thereafter. + Heaven knows it's saved my bacon time after time; if you + implement any suggestion in this Guide, implement this one! + </para> + <para> + Although the Bugzilla development team has taken great care to + ensure that all easily-exploitable bugs or options are + documented or fixed in the code, security holes surely exist. + Great care should be taken both in the installation and usage of + this software. Carefully consider the implications of installing + other network services with Bugzilla. The Bugzilla development + team members, Netscape Communications, America Online Inc., and + any affiliated developers or sponsors assume no liability for + your use of this product. You have the source code to this + product, and are responsible for auditing it yourself to insure + your security needs are met. + </para> + </section> <!-- Section 2: New Versions --> - <SECTION ID="newversions"> - <TITLE>New Versions</TITLE> - <PARA> - This is the initial release of the Bugzilla Guide. - </PARA> - <PARA> + <section id="newversions"> + <title>New Versions</title> + <para> + This is the &bzg-ver; version of The Bugzilla Guide. If you are + reading this from any source other than those below, please + check one of these mirrors to make sure you are reading an + up-to-date version of the Guide. + </para> + <para> This document can be found in the following places: - </PARA> - <PARA> - <ITEMIZEDLIST> - <LISTITEM> - <PARA> - <ULINK URL="http://www.trilobyte.net/barnsons/">TriloBYTE</ULINK> - </PARA> - </LISTITEM> - <LISTITEM> - <PARA> - <ULINK URL="http://www.mozilla.org/projects/bugzilla/">Mozilla.org</ULINK> - </PARA> - </LISTITEM> - <LISTITEM> - <PARA> - <ULINK URL="http://www.linuxdoc.org/">The Linux Documentation Project</ULINK> - </PARA> - </LISTITEM> - </ITEMIZEDLIST> - </PARA> - <PARA> + </para> + <para> + <itemizedlist> + <listitem> + <para> + <ulink url="http://www.trilobyte.net/barnsons/">TriloBYTE</ulink> + </para> + </listitem> + <listitem> + <para> + <ulink url="http://www.mozilla.org/projects/bugzilla/">Mozilla.org</ulink> + </para> + </listitem> + <listitem> + <para> + <ulink url="http://www.linuxdoc.org/">The Linux + Documentation Project</ulink> + </para> + </listitem> + </itemizedlist> + </para> + <para> The latest version of this document can be checked out via CVS. - Please follow the instructions available at - <ULINK URL="http://www.mozilla.org/cvs.html">the Mozilla CVS page</ULINK>, - and check out the mozilla/webtools/bugzilla/docs/ branch. - </PARA> - </SECTION> + Please follow the instructions available at <ulink + url="http://www.mozilla.org/cvs.html">the Mozilla CVS page</ulink>, and check out the mozilla/webtools/bugzilla/docs/ branch. + </para> + </section> - <SECTION ID="credits"> - <TITLE>Credits</TITLE> - <PARA> - The people listed below have made enormous contributions to the creation - of this Guide, through their dedicated hacking efforts, - numerous e-mail and IRC support sessions, - and overall excellent contribution to the Bugzilla community: - </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. - </PARA> - <PARA> - <ULINK URL="mailto://tara@tequilarista.org">Tara Hernandez</ULINK> - for keeping Bugzilla development going strong after Terry left Mozilla.org - </PARA> - <PARA> - <ULINK URL="mailto://dkl@redhat.com">Dave Lawrence</ULINK> - for providing insight into the key differences between Red Hat's - customized Bugzilla, and being largely responsible for the - "Red Hat Bugzilla" appendix - </PARA> - <PARA> - <ULINK URL="mailto://endico@mozilla.org">Dawn Endico</ULINK> - for being a hacker extraordinaire and putting up with my incessant + <section id="credits"> + <title>Credits</title> + <para> + The people listed below have made enormous contributions to the + creation of this Guide, through their dedicated hacking efforts, + numerous e-mail and IRC support sessions, and overall excellent + contribution to the Bugzilla community: + </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. + </para> + <para> + <ulink url="mailto://tara@tequilarista.org">Tara + Hernandez</ulink> for keeping Bugzilla development going + strong after Terry left Mozilla.org + </para> + <para> + <ulink url="mailto://dkl@redhat.com">Dave Lawrence</ulink> for + providing insight into the key differences between Red Hat's + customized Bugzilla, and being largely responsible for the "Red + Hat Bugzilla" appendix + </para> + <para> + <ulink url="mailto://endico@mozilla.org">Dawn Endico</ulink> for + being a hacker extraordinaire and putting up with my incessant questions and arguments on irc.mozilla.org in #mozwebtools - </PARA> - <PARA> - Last but not least, all the members of the - <ULINK URL="news://news.mozilla.org/netscape/public/mozilla/webtools"> - netscape.public.mozilla.webtools</ULINK> newsgroup. Without your - discussions, insight, suggestions, and patches, this could never have happened. - </PARA> - </SECTION> - <SECTION id="contributors"> -<TITLE>Contributors</TITLE> - <PARA> - Thanks go to these people for significant contributions - to this documentation (in no particular order): - </PARA> - <PARA> - Zach Lipton (significant textual contributions), - Andrew Pearson, - Spencer Smith, - Eric Hanson, - Kevin Brannen, - </PARA> - </SECTION> - <SECTION ID="feedback"> - <TITLE>Feedback</TITLE> - <PARA> - I welcome feedback on this document. Without your submissions and input, - this Guide cannot continue to exist. Please mail additions, comments, criticisms, etc. - to <EMAIL>barnboy@trilobyte.net</EMAIL>. Please send flames to - <EMAIL>devnull@localhost</EMAIL> - </PARA> - </SECTION> + </para> + <para> + Last but not least, all the members of the <ulink + url="news://news.mozilla.org/netscape/public/mozilla/webtools"> netscape.public.mozilla.webtools</ulink> newsgroup. Without your discussions, insight, suggestions, and patches, this could never have happened. + </para> + </section> - <SECTION ID="translations"> - <TITLE>Translations</TITLE> - <PARA> - The Bugzilla Guide needs translators! - Please volunteer your translation into the language of your choice. - If you will translate this Guide, please notify the members of the mozilla-webtools mailing list at - <email>mozilla-webtools@mozilla.org</email>. Since The Bugzilla Guide is also hosted on the - Linux Documentation Project, you would also do well to notify - </PARA> - </SECTION> + <section id="contributors"> +<title>Contributors</title> + <para> + Thanks go to these people for significant contributions to this + documentation (in no particular order): + </para> + <para> + Andrew Pearson, Spencer Smith, Eric Hanson, Kevin Brannen, Ron Teitelbaum + </para> + </section> + <section id="feedback"> + <title>Feedback</title> + <para> + I welcome feedback on this document. Without your submissions + and input, this Guide cannot continue to exist. Please mail + additions, comments, criticisms, etc. to + <email>barnboy@trilobyte.net</email>. Please send flames to + <email>devnull@localhost</email> + </para> + </section> + + <section id="translations"> + <title>Translations</title> + <para> + The Bugzilla Guide needs translators! Please volunteer your + translation into the language of your choice. If you will + translate this Guide, please notify the members of the + mozilla-webtools mailing list at + <email>mozilla-webtools@mozilla.org</email>, and arrange with + Matt Barnson to check it into CVS. + </para> + </section> <!-- conventions used here (didn't want to give it a chapter of its own) --> &conventions; + </chapter> -</CHAPTER> - - -<!-- Keep this comment at the end of the file -Local variables: -mode: sgml -sgml-omittag:t -sgml-shorttag:t -sgml-namecase-general:t -sgml-general-insert-case:upper -sgml-minimize-attributes:nil +<!-- Keep this comment at the end of the file +Local variables: +mode: sgml sgml-always-quote-attributes:t -sgml-indent-step:2 -sgml-indent-data:t -sgml-parent-document:Bugzilla-Guide\.sgml +sgml-auto-insert-required-elements:t +sgml-balanced-tag-edit:t sgml-exposed-tags:nil +sgml-general-insert-case:lower +sgml-indent-data:t +sgml-indent-step:2 sgml-local-catalogs:nil -sgml-local-ecat-files:nil -sgml-doctype:"<!DOCTYPE chapter PUBLIC \"-//OASIS//DTD DocBook V4.1//EN\">" -End: ---> - - - - - - - - +sgml-local-ecat-files:nil +sgml-minimize-attributes:nil +sgml-namecase-general:t +sgml-omittag:t +sgml-parent-document:("Bugzilla-Guide.sgml" "book" "chapter") +sgml-shorttag:t +sgml-tag-region-if-active:t +End: --> diff --git a/docs/sgml/administration.sgml b/docs/sgml/administration.sgml index 8ca600c54..0f290da31 100644 --- a/docs/sgml/administration.sgml +++ b/docs/sgml/administration.sgml @@ -1,1145 +1,1257 @@ -<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook V4.1//EN"> +<!-- <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook V4.1//EN"> --> -<!-- TOC -Chapter: Administration - Localconfig and Checksetup.pl customizations - The Email Gateway - Editing parameters - Deciding your site policies - The Shadow Database - Customizing password mail & layout - The Whining Cron - Why you shouldn't allow deletion - User administration - Creating Users - Disabling Users - User Permissions - Product Administration - Creating products - Creating components - Assigning default owners and Q/A contacts to components - Product Milestones - Product Versions - Voting ---> - -<CHAPTER id="administration"> - <TITLE>Administering Bugzilla</TITLE> -<SUBTITLE>Or, I just got this cool thing installed. Now what the heck do I do with it?</SUBTITLE> - -<PARA> -So you followed the README isntructions to the letter, and -just logged into bugzilla with your super-duper god account and you are sitting at the query -screen. Yet, you have nothing to query. Your first act of business needs to be to setup the -operating parameters for bugzilla.</PARA> +<chapter id="administration"> + <title>Administering Bugzilla</title> + <subtitle> + Or, I just got this cool thing installed. Now what the heck do I + do with it? + </subtitle> + + <para> + So you followed the installation instructions to the letter, and + just logged into bugzilla with your super-duper god account and + you are sitting at the query screen. Yet, you have nothing to + query. Your first act of business needs to be to setup the + operating parameters for bugzilla. + </para> - <SECTION id="postinstall-check"> - <TITLE>Post-Installation Checklist</TITLE> - <PARA> + <section id="postinstall-check"> + <title>Post-Installation Checklist</title> + <para> After installation, follow the checklist below to ensure that - you have a successful installation. - If you do not see a recommended setting for a parameter, - consider leaving it at the default - while you perform your initial tests on your Bugzilla setup. - </PARA> - <INDEXTERM> - <PRIMARY>checklist</PRIMARY> - </INDEXTERM> - <PROCEDURE> - <STEP> - <PARA> - Bring up "editparams.cgi" in your web browser. For instance, to edit parameters - at mozilla.org, the URL would be <ULINK URL="http://bugzilla.mozilla.org/editparams.cgi"> - http://bugzilla.mozilla.org/editparams.cgi</ULINK>, also available under the "edit parameters" - link on your query page. - </PARA> - </STEP> - <STEP> - <PARA> - Set "maintainer" to <EMPHASIS>your</EMPHASIS> email address. - This allows Bugzilla's error messages - to display your email + you have a successful installation. If you do not see a + recommended setting for a parameter, consider leaving it at the + default while you perform your initial tests on your Bugzilla + setup. + </para> + <indexterm> + <primary>checklist</primary> + </indexterm> + <procedure> + <step> + <para> + Bring up "editparams.cgi" in your web browser. For + instance, to edit parameters at mozilla.org, the URL would + be <ulink url="http://bugzilla.mozilla.org/editparams.cgi"> + http://bugzilla.mozilla.org/editparams.cgi</ulink>, also + available under the "edit parameters" link on your query + page. + </para> + </step> + <step> + <para> + Set "maintainer" to <emphasis>your</emphasis> email address. + This allows Bugzilla's error messages to display your email address and allow people to contact you for help. - </PARA> - </STEP> - <STEP> - <PARA> - Set "urlbase" to the URL reference for your Bugzilla installation. - If your bugzilla query page is at http://www.foo.com/bugzilla/query.cgi, - your url base is http://www.foo.com/bugzilla/ - </PARA> - </STEP> - <STEP> - <PARA> - Set "usebuggroups" to "1" <EMPHASIS>only</EMPHASIS> - if you need to restrict access to products. - I suggest leaving this parameter <EMPHASIS>off</EMPHASIS> - while initially testing your Bugzilla. - </PARA> - </STEP> - <STEP> - <PARA> - Set "usebuggroupsentry" to "1" if you want to restrict access to products. - Once again, if you are simply testing your installation, I suggest against - turning this parameter on; the strict security checking may stop you from - being able to modify your new entries. - </PARA> - </STEP> - <STEP> - <PARA> - Set "shadowdb" to "bug_shadowdb" if you will be - running a *very* large installation of Bugzilla. - The shadow database enables many simultaneous users - to read and write to the database - without interfering with one another. - <NOTE> - <PARA> + </para> + </step> + <step> + <para> + Set "urlbase" to the URL reference for your Bugzilla + installation. If your bugzilla query page is at + http://www.foo.com/bugzilla/query.cgi, your url base is + http://www.foo.com/bugzilla/ + </para> + </step> + <step> + <para> + Set "usebuggroups" to "on" <emphasis>only</emphasis> if you + need to restrict access to products. I suggest leaving this + parameter <emphasis>off</emphasis> while initially testing + your Bugzilla. + </para> + </step> + <step> + <para> + Set "usebuggroupsentry" to "on" if you want to restrict + access to products. Once again, if you are simply testing + your installation, I suggest against turning this parameter + on; the strict security checking may stop you from being + able to modify your new entries. + </para> + </step> + <step> + <para> + Set "shadowdb" to "bug_shadowdb" if you will be running a + *very* large installation of Bugzilla. The shadow database + enables many simultaneous users to read and write to the + database without interfering with one another. + <note> + <para> Enabling "shadowdb" can adversely affect the stability - of your installation of Bugzilla. - You may frequently need to manually synchronize your databases, - or schedule nightly syncs - via "cron" - </PARA> - </NOTE> - Once again, in testing you should - avoid this option -- use it if or when you <EMPHASIS>need</EMPHASIS> to use it, and have - repeatedly run into the problem it was designed to solve -- very long wait times while - attempting to commit a change to the database. - </PARA> - <PARA> - If you use the "shadowdb" option, - it is only natural that you should turn the "queryagainstshadowdb" - option "On" as well. Otherwise you are replicating data into a shadow database for no reason! - </PARA> - </STEP> - <STEP> - <PARA> - If you have custom logos or HTML you must put in place to fit within your site design guidelines, - place the code in the "headerhtml", "footerhtml", "errorhtml", - "bannerhtml", or "blurbhtml" text boxes. - <NOTE> - <PARA> + of your installation of Bugzilla. You may frequently + need to manually synchronize your databases, or schedule + nightly syncs via "cron" + </para> + </note> Once again, in testing you should avoid this option + -- use it if or when you <emphasis>need</emphasis> to use + it, and have repeatedly run into the problem it was designed + to solve -- very long wait times while attempting to commit + a change to the database. + </para> + <para> + If you use the "shadowdb" option, it is only natural that + you should turn the "queryagainstshadowdb" option "On" as + well. Otherwise you are replicating data into a shadow + database for no reason! + </para> + </step> + <step> + <para> + If you have custom logos or HTML you must put in place to + fit within your site design guidelines, place the code in + the "headerhtml", "footerhtml", "errorhtml", "bannerhtml", + or "blurbhtml" text boxes. + <note> + <para> The "headerhtml" text box is the HTML printed out - <EMPHASIS>before</EMPHASIS> any other code on the page. - If you have a special banner, put the code for it in "bannerhtml". - You may want to leave these - settings at the defaults initially. - </PARA> - </NOTE> - </PARA> - </STEP> - <STEP> - <PARA> - Add any text you wish to the "passwordmail" parameter box. For instance, - many people choose to use this box to give a quick training blurb about how to - use Bugzilla at your site. - </PARA> - </STEP> - <STEP> - <PARA> - Ensure "newemailtech" is "on". - Your users will thank you. This is the default in the post-2.12 world, and is - only an issue if you are upgrading. - </PARA> - </STEP> - <STEP> - <PARA> - Do you want to use the qa contact ("useqacontact") - and status whiteboard ("usestatuswhiteboard") fields? - These fields are useful because they allow for more flexibility, - particularly when you have an existing - Quality Assurance and/or Release Engineering team, - but they may not be needed for smaller installations. - </PARA> - </STEP> - <STEP> - <PARA> - Set "whinedays" to the amount of days you want to let bugs go - in the "New" or "Reopened" state before - notifying people they have untouched new bugs. If you do not plan to use this feature, simply do - not set up the whining cron job described in the README, or set this value to "0". - </PARA> - </STEP> - <STEP> - <PARA> + <emphasis>before</emphasis> any other code on the page. + If you have a special banner, put the code for it in + "bannerhtml". You may want to leave these settings at + the defaults initially. + </para> + </note> + </para> + </step> + <step> + <para> + Add any text you wish to the "passwordmail" parameter box. + For instance, many people choose to use this box to give a + quick training blurb about how to use Bugzilla at your site. + </para> + </step> + <step> + <para> + Ensure "newemailtech" is "on". Your users will thank you. + This is the default in the post-2.12 world, and is only an + issue if you are upgrading. + </para> + </step> + <step> + <para> + Do you want to use the QA Contact ("useqacontact") and + status whiteboard ("usestatuswhiteboard") fields? These + fields are useful because they allow for more flexibility, + particularly when you have an existing Quality Assurance + and/or Release Engineering team, but they may not be needed + for smaller installations. + </para> + </step> + <step> + <para> + Set "whinedays" to the amount of days you want to let bugs + go in the "New" or "Reopened" state before notifying people + they have untouched new bugs. If you do not plan to use + this feature, simply do not set up the whining cron job + described in the installation instructions, or set this + value to "0". + </para> + </step> + <step> + <para> Set the "commenton" options according to your site policy. - It is a wise idea to require comments when users - resolve, reassign, or reopen bugs. - <NOTE> - <PARA> - It is generally far better to require a developer comment when resolving bugs than not. - Few things are more annoying to bug database users than having a developer - mark a bug "fixed" without any comment as to what the fix was (or even that it was truly fixed!) - </PARA> - </NOTE> - </PARA> - </STEP> - <STEP> - <PARA> - Set "supportwatchers" to "On". This feature is helpful for team leads to monitor progress in their - respective areas, and can offer many other benefits, such as allowing a developer to pick up a - former engineer's bugs without requiring her to change all the information in the bug. - </PARA> - </STEP> - </PROCEDURE> - </SECTION> + It is a wise idea to require comments when users resolve, + reassign, or reopen bugs. + <note> + <para> + It is generally far better to require a developer + comment when resolving bugs than not. Few things are + more annoying to bug database users than having a + developer mark a bug "fixed" without any comment as to + what the fix was (or even that it was truly fixed!) + </para> + </note> + </para> + </step> + <step> + <para> + Set "supportwatchers" to "On". This feature is helpful for + team leads to monitor progress in their respective areas, + and can offer many other benefits, such as allowing a + developer to pick up a former engineer's bugs without + requiring her to change all the information in the bug. + </para> + </step> + </procedure> + </section> - <SECTION id="useradmin"> - <TITLE>User Administration</TITLE> - <PARA> + <section id="useradmin"> + <title>User Administration</title> + <para> User administration is one of the easiest parts of Bugzilla. - Keeping it from getting out of hand, however, can become a challenge. - </PARA> + Keeping it from getting out of hand, however, can become a + challenge. + </para> - <SECTION id="defaultuser"> - <TITLE>Creating the Default User</TITLE> + <section id="defaultuser"> + <title>Creating the Default User</title> - <PARA> - When you first run checksetup.pl after installing Bugzilla, it will prompt you - for the administrative username (email address) and password for this "super user". - If for some reason you were to delete the "super user" account, re-running - checksetup.pl will again prompt you for this username and password. - </PARA> - <TIP> - <PARA> - If you wish to add more administrative users, you must use the MySQL interface. - Run "mysql" from the command line, and use these commands ("mysql>" denotes the - mysql prompt, not something you should type in): - <COMMAND><PROMPT>mysql></PROMPT> use bugs;</COMMAND> - <COMMAND><PROMPT>mysql></PROMPT> update profiles set groupset=0x7ffffffffffffff - where login_name = "(user's login name)"; </COMMAND> - </PARA> - </TIP> - </SECTION> + <para> + When you first run checksetup.pl after installing Bugzilla, it + will prompt you for the administrative username (email + address) and password for this "super user". If for some + reason you were to delete the "super user" account, re-running + checksetup.pl will again prompt you for this username and + password. + </para> + <tip> + <para> + If you wish to add more administrative users, you must use the + MySQL interface. Run "mysql" from the command line, and use + these commands ("mysql>" denotes the mysql prompt, not + something you should type in): + <command><prompt>mysql></prompt> use bugs;</command> + <command><prompt>mysql></prompt> update profiles set + groupset=0x7ffffffffffffff where login_name = "(user's + login name)"; </command> + </para> + </tip> + </section> - <SECTION id="manageusers"> - <TITLE>Managing Other Users</TITLE> + <section id="manageusers"> + <title>Managing Other Users</title> - <SECTION id="login"> - <TITLE>Logging In</TITLE> - <ORDEREDLIST> - <LISTITEM> - <PARA> - Open the index.html page for your Bugzilla installation in your browser window. - </PARA> - </LISTITEM> - <LISTITEM> - <PARA> + <section id="login"> + <title>Logging In</title> + <orderedlist> + <listitem> + <para> + Open the index.html page for your Bugzilla installation + in your browser window. + </para> + </listitem> + <listitem> + <para> Click the "Query Existing Bug Reports" link. - </PARA> - </LISTITEM> - <LISTITEM> - <PARA> + </para> + </listitem> + <listitem> + <para> Click the "Log In" link at the foot of the page. - </PARA> - </LISTITEM> - <LISTITEM> - <PARA> - Type your email address, and the password which was emailed to you when you - created your Bugzilla account, into the spaces provided. - </PARA> - </LISTITEM> - </ORDEREDLIST> - <PARA>Congratulations, you are logged in!</PARA> - </SECTION> + </para> + </listitem> + <listitem> + <para> + Type your email address, and the password which was + emailed to you when you created your Bugzilla account, + into the spaces provided. + </para> + </listitem> + </orderedlist> + <para>Congratulations, you are logged in!</para> + </section> - <SECTION id="createnewusers"> - <TITLE>Creating new users</TITLE> - <PARA> - Your users can create their own user accounts by clicking the "New Account" - link at the bottom of each page. - However, should you desire to create user accounts ahead of time, here is how you do it. - </PARA> - <ORDEREDLIST> - <LISTITEM> - <PARA> - After logging in, click the "Users" link at the footer of the query page. - </PARA> - </LISTITEM> - <LISTITEM> - <PARA> - To see a specific user, type a portion of their login name - in the box provided and click "submit". - To see all users, simply click the "submit" button. - You must click "submit" here to be able to add a new user. - </PARA> - <TIP> - <PARA> - More functionality is available via the list on the right-hand side - of the text entry box. - You can match what you type as a case-insensitive substring (the default) - of all users on your system, a case-sensitive regular expression - (please see the "man regexp" manual page for details on regular expression syntax), - or a <EMPHASIS>reverse</EMPHASIS> regular expression match, - where every user name which does NOT match the regular expression - is selected. - </PARA> - </TIP> - </LISTITEM> - <LISTITEM> - <PARA> - Click the "Add New User" link at the bottom of the user list - </PARA> - </LISTITEM> - <LISTITEM> - <PARA> - Fill out the form presented. This page is self-explanatory. When done, click "submit". - </PARA> - <NOTE> - <PARA> - Adding a user this way will <EMPHASIS>not</EMPHASIS> send an email - informing them of their username and password. - In general, it is preferable to log out and use the "New Account" - button to create users, as it will pre-populate all the required fields and also notify - the user of her account name and password. - </PARA> - </NOTE> - </LISTITEM> - </ORDEREDLIST> - </SECTION> + <section id="createnewusers"> + <title>Creating new users</title> + <para> + Your users can create their own user accounts by clicking + the "New Account" link at the bottom of each page. However, + should you desire to create user accounts ahead of time, + here is how you do it. + </para> + <orderedlist> + <listitem> + <para> + After logging in, click the "Users" link at the footer + of the query page. + </para> + </listitem> + <listitem> + <para> + To see a specific user, type a portion of their login + name in the box provided and click "submit". To see all + users, simply click the "submit" button. You must click + "submit" here to be able to add a new user. + </para> + <tip> + <para> + More functionality is available via the list on the + right-hand side of the text entry box. You can match + what you type as a case-insensitive substring (the + default) of all users on your system, a case-sensitive + regular expression (please see the "man regexp" manual + page for details on regular expression syntax), or a + <emphasis>reverse</emphasis> regular expression match, + where every user name which does NOT match the regular + expression is selected. + </para> + </tip> + </listitem> + <listitem> + <para> + Click the "Add New User" link at the bottom of the user + list + </para> + </listitem> + <listitem> + <para> + Fill out the form presented. This page is + self-explanatory. When done, click "submit". + </para> + <note> + <para> + Adding a user this way will <emphasis>not</emphasis> + send an email informing them of their username and + password. In general, it is preferable to log out and + use the "New Account" button to create users, as it + will pre-populate all the required fields and also + notify the user of her account name and password. + </para> + </note> + </listitem> + </orderedlist> + </section> - <SECTION id="disableusers"> - <TITLE>Disabling Users</TITLE> - <PARA> - I bet you noticed that big "Disabled Text" entry box available from the "Add New User" screen, - when you edit an account? - By entering any text in this box and selecting "submit", - you have prevented the user from using Bugzilla via the web interface. - Your explanation, written in this text box, will be presented to the user - the next time she attempts to use the system. - <WARNING> - <PARA> - Don't disable your own administrative account, or you will hate life! - </PARA> - </WARNING> - </PARA> - </SECTION> + <section id="disableusers"> + <title>Disabling Users</title> + <para> + I bet you noticed that big "Disabled Text" entry box + available from the "Add New User" screen, when you edit an + account? By entering any text in this box and selecting + "submit", you have prevented the user from using Bugzilla + via the web interface. Your explanation, written in this + text box, will be presented to the user the next time she + attempts to use the system. + <warning> + <para> + Don't disable your own administrative account, or you + will hate life! + </para> + </warning> + </para> + </section> - <SECTION id="modifyusers"> - <TITLE>Modifying Users</TITLE> - <PARA> - Here I will attempt to describe the function of each option on the user edit screen. - </PARA> - <ITEMIZEDLIST> - <LISTITEM> - <PARA> - <EMPHASIS>Login Name</EMPHASIS>: This is generally the user's email address. - However, if you have edited your system parameters, - this may just be the user's login name or some other identifier. - <TIP> - <PARA> - For compatability reasons, you should probably - stick with email addresses as user login names. It will make your life easier. - </PARA> - </TIP> - </PARA> - </LISTITEM> - <LISTITEM> - <PARA> - <EMPHASIS>Real Name</EMPHASIS>: Duh! - </PARA> - </LISTITEM> - <LISTITEM> - <PARA> - <EMPHASIS>Password</EMPHASIS>: You will only see asterisks in versions - of Bugzilla newer than 2.10 or early 2.11. You can change the user password here. - </PARA> - </LISTITEM> - <LISTITEM> - <PARA> - <EMPHASIS>Email Notification</EMPHASIS>: You may choose from one of three options: - <ORDEREDLIST> - <LISTITEM> - <PARA> + <section id="modifyusers"> + <title>Modifying Users</title> + <para> + Here I will attempt to describe the function of each option + on the Edit User screen. + </para> + <itemizedlist> + <listitem> + <para> + <emphasis>Login Name</emphasis>: This is generally the + user's email address. However, if you have edited your + system parameters, this may just be the user's login + name or some other identifier. + <tip> + <para> + For compatability reasons, you should probably stick + with email addresses as user login names. It will + make your life easier. + </para> + </tip> + </para> + </listitem> + <listitem> + <para> + <emphasis>Real Name</emphasis>: Duh! + </para> + </listitem> + <listitem> + <para> + <emphasis>Password</emphasis>: You will only see + asterisks in versions of Bugzilla newer than 2.10 or + early 2.11. You can change the user password here. + </para> + </listitem> + <listitem> + <para> + <emphasis>Email Notification</emphasis>: You may choose + from one of three options: + <orderedlist> + <listitem> + <para> All qualifying bugs except those which I change: The user will be notified of any change to any bug - for which she is the reporter, assignee, Q/A contact, CC recipient, or "watcher". - </PARA> - </LISTITEM> - <LISTITEM> - <PARA> + for which she is the reporter, assignee, QA + Contact, CC recipient, or "watcher". + </para> + </listitem> + <listitem> + <para> Only those bugs which I am listed on the CC line: - The user will not be notified of changes to bugs where she is the assignee, - reporter, or Q/A contact, but will receive them if she is on the CC list. - <NOTE> - <PARA> - She will still receive whining cron emails if you set up the "whinemail" feature. - </PARA> - </NOTE> - </PARA> - </LISTITEM> - <LISTITEM> - <PARA> - <EMPHASIS>All Qualifying Bugs</EMPHASIS>: This user is a glutton for punishment. - If her name is in the reporter, Q/A contact, CC, assignee, or is a "watcher", - she will get email updates regarding the bug. - </PARA> - </LISTITEM> - </ORDEREDLIST> -</PARA> - <PARA> - <EMPHASIS>Disable Text</EMPHASIS>: If you type anything in this box, - including just a space, the user account is disabled from making any changes - to bugs via the web interface, and what you type in this box is presented as the reason. - <WARNING> - <PARA>Don't disable the administrator account!</PARA> - </WARNING> - <NOTE> - <PARA> - As of this writing, the user can still submit bugs via the e-mail gateway, - if you set it up, despite the disabled text field. The e-mail gateway should - <EMPHASIS>not</EMPHASIS> be enabled for secure installations of Bugzilla. - </PARA> - </NOTE> - </PARA> - </LISTITEM> - <LISTITEM> - <PARA> - <EMPHASIS>CanConfirm</EMPHASIS>: This field is only used if you have enabled - "unconfirmed" status in your parameters screen. If you enable this for a user, - that user can then move bugs from "Unconfirmed" to "Confirmed" status (ergo: "New" status). - Be judicious about allowing users to turn this bit on for other users. - </PARA> - </LISTITEM> - <LISTITEM> - <PARA> - <EMPHASIS>Creategroups</EMPHASIS>: This option will allow a user to create and - destroy groups in Bugzilla. Unless you are using the Bugzilla GroupSentry security - option "usebuggroupsentry" in your parameters, this setting has no effect. - </PARA> - </LISTITEM> - <LISTITEM> - <PARA> - <EMPHASIS>Editbugs</EMPHASIS>: Unless a user has this bit set, they can only edit - those bugs for which they are the assignee or the reporter. - <NOTE> - <PARA> - Leaving this option unchecked does not prevent users from adding - comments to a bug! They simply cannot change a bug priority, severity, - etc. unless they are the assignee or reporter. - </PARA> - </NOTE> - </PARA> - </LISTITEM> - <LISTITEM> - <PARA> - <EMPHASIS>Editcomponents</EMPHASIS>: This flag allows a user to create new - products and components, as well as modify and destroy those that have no bugs - associated with them. If a product or component has bugs associated with it, - those bugs must be moved to a different product or component before Bugzilla - will allow them to be destroyed. The name of a product or component can be - changed without affecting the associated bugs, but it tends to annoy - the hell out of your users when these change a lot. - </PARA> - </LISTITEM> - <LISTITEM> - <PARA> - <EMPHASIS>Editkeywords</EMPHASIS>: If you use Bugzilla's keyword functionality, - enabling this feature allows a user can create and destroy keywords. - As always, the keywords for existing bugs containing the keyword - the user wishes to destroy must be changed before Bugzilla will allow it to die. - You must be very careful about creating too many new keywords - if you run a very large Bugzilla installation; keywords are global variables - across products, and you can often run into a phenomenon called "keyword bloat". - This confuses users, and then the feature goes unused. - </PARA> - </LISTITEM> - <LISTITEM> - <PARA> - <EMPHASIS>Editusers</EMPHASIS>: This flag allows a user do what you're doing - right now: edit other users. - This will allow those with the right to do so to remove administrator - priveleges from other users or grant them to themselves. Enable with care. - </PARA> - </LISTITEM> - <LISTITEM> - <PARA> - <EMPHASIS>PRODUCT</EMPHASIS>: PRODUCT bugs access. This allows an administrator, - with product-level granularity, to specify in which products a user can edit bugs. - The user must still have the "editbugs" privelege to edit bugs in this area; - this simply restricts them from even seeing bugs outside these boundaries if the administrator - has enabled the group sentry parameter "usebuggroupsentry". Unless you are using bug groups, + The user will not be notified of changes to bugs + where she is the assignee, reporter, or QA + Contact, but will receive them if she is on the CC + list. + <note> + <para> + She will still receive whining cron emails if + you set up the "whinemail" feature. + </para> + </note> + </para> + </listitem> + <listitem> + <para> + <emphasis>All Qualifying Bugs</emphasis>: This + user is a glutton for punishment. If her name is + in the reporter, QA Contact, CC, assignee, or is a + "watcher", she will get email updates regarding + the bug. + </para> + </listitem> + </orderedlist> +</para> + <para> + <emphasis>Disable Text</emphasis>: If you type anything + in this box, including just a space, the user account is + disabled from making any changes to bugs via the web + interface, and what you type in this box is presented as + the reason. + <warning> + <para>Don't disable the administrator account!</para> + </warning> + <note> + <para> + As of this writing, the user can still submit bugs + via the e-mail gateway, if you set it up, despite + the disabled text field. The e-mail gateway should + <emphasis>not</emphasis> be enabled for secure + installations of Bugzilla. + </para> + </note> + </para> + </listitem> + <listitem> + <para> + <emphasis>CanConfirm</emphasis>: This field is only used + if you have enabled "unconfirmed" status in your + parameters screen. If you enable this for a user, that + user can then move bugs from "Unconfirmed" to + "Confirmed" status (e.g.: "New" status). Be judicious + about allowing users to turn this bit on for other + users. + </para> + </listitem> + <listitem> + <para> + <emphasis>Creategroups</emphasis>: This option will + allow a user to create and destroy groups in Bugzilla. + Unless you are using the Bugzilla GroupSentry security + option "usebuggroupsentry" in your parameters, this + setting has no effect. + </para> + </listitem> + <listitem> + <para> + <emphasis>Editbugs</emphasis>: Unless a user has this + bit set, they can only edit those bugs for which they + are the assignee or the reporter. + <note> + <para> + Leaving this option unchecked does not prevent users + from adding comments to a bug! They simply cannot + change a bug priority, severity, etc. unless they + are the assignee or reporter. + </para> + </note> + </para> + </listitem> + <listitem> + <para> + <emphasis>Editcomponents</emphasis>: This flag allows a + user to create new products and components, as well as + modify and destroy those that have no bugs associated + with them. If a product or component has bugs + associated with it, those bugs must be moved to a + different product or component before Bugzilla will + allow them to be destroyed. The name of a product or + component can be changed without affecting the + associated bugs, but it tends to annoy the hell out of + your users when these change a lot. + </para> + </listitem> + <listitem> + <para> + <emphasis>Editkeywords</emphasis>: If you use Bugzilla's + keyword functionality, enabling this feature allows a + user can create and destroy keywords. As always, the + keywords for existing bugs containing the keyword the + user wishes to destroy must be changed before Bugzilla + will allow it to die. You must be very careful about + creating too many new keywords if you run a very large + Bugzilla installation; keywords are global variables + across products, and you can often run into a phenomenon + called "keyword bloat". This confuses users, and then + the feature goes unused. + </para> + </listitem> + <listitem> + <para> + <emphasis>Editusers</emphasis>: This flag allows a user + do what you're doing right now: edit other users. This + will allow those with the right to do so to remove + administrator priveleges from other users or grant them + to themselves. Enable with care. + </para> + </listitem> + <listitem> + <para> + <emphasis>PRODUCT</emphasis>: PRODUCT bugs access. This + allows an administrator, with product-level granularity, + to specify in which products a user can edit bugs. The + user must still have the "editbugs" privelege to edit + bugs in this area; this simply restricts them from even + seeing bugs outside these boundaries if the + administrator has enabled the group sentry parameter + "usebuggroupsentry". Unless you are using bug groups, this option has no effect. - </PARA> - </LISTITEM> - </ITEMIZEDLIST> - </SECTION> - </SECTION> - </SECTION> + </para> + </listitem> + </itemizedlist> + </section> + </section> + </section> - <SECTION id="programadmin"> - <TITLE>Product, Component, Milestone, and Version Administration</TITLE> - <EPIGRAPH> - <PARA> + <section id="programadmin"> + <title>Product, Component, Milestone, and Version + Administration</title> + <epigraph> + <para> Dear Lord, we have to get our users to do WHAT? - </PARA> - </EPIGRAPH> + </para> + </epigraph> - <SECTION id="products"> - <TITLE>Products</TITLE> - <SUBTITLE>Formerly, and in some spots still, called "Programs"</SUBTITLE> - <PARA> - <GLOSSTERM baseform="product" linkend="gloss_product">Products</GLOSSTERM> are the - broadest category in Bugzilla, and you should have the least of these. - If your company makes computer games, you should have one product per game, - and possibly a few special products - (website, meetings...) - </PARA> - <PARA> - A Product (formerly called "Program", and still referred to that way - in some portions of the source code) controls some very important functions. - The number of "votes" available for users to vote for the most important bugs - is set per-product, as is the number of votes required to move a bug automatically - from the UNCONFIRMED status to the NEW status. One can close a Product for further - bug entry and define various Versions available from the Edit Product screen. - </PARA> - <PARA>To create a new product:</PARA> - <ORDEREDLIST> - <LISTITEM> - <PARA> + <section id="products"> + <title>Products</title> + <subtitle>Formerly, and in some spots still, called + "Programs"</subtitle> + <para> + <glossterm linkend="gloss_product" baseform="product">Products</glossterm> are + the broadest category in Bugzilla, and you should have the + least of these. If your company makes computer games, you + should have one product per game, and possibly a few special + products (website, meetings...) + </para> + <para> + A Product (formerly called "Program", and still referred to + that way in some portions of the source code) controls some + very important functions. The number of "votes" available for + users to vote for the most important bugs is set per-product, + as is the number of votes required to move a bug automatically + from the UNCONFIRMED status to the NEW status. One can close + a Product for further bug entry and define various Versions + available from the Edit product screen. + </para> + <para>To create a new product:</para> + <orderedlist> + <listitem> + <para> Select "components" from the yellow footer - </PARA> - <TIP> - <PARA> - It may seem counterintuitive to click "components" when you want - to edit the properties associated with Products. This is one of a long - list of things we want in Bugzilla 3.0... - </PARA> - </TIP> - </LISTITEM> - <LISTITEM> - <PARA> + </para> + <tip> + <para> + It may seem counterintuitive to click "components" when + you want to edit the properties associated with + Products. This is one of a long list of things we want + in Bugzilla 3.0... + </para> + </tip> + </listitem> + <listitem> + <para> Select the "Add" link to the right of "Add a new product". - </PARA> - </LISTITEM> - <LISTITEM> - <PARA> - Enter the name of the product and a description. - The Description field is free-form. - </PARA> - </LISTITEM> - </ORDEREDLIST> - <TIP> - <PARA> - Don't worry about the "Closed for bug entry", "Maximum Votes per person", - "Maximum votes a person can put on a single bug", "Number of votes a bug in - this Product needs to automatically get out of the UNCOMFIRMED state", - and "Version" options yet. - We'll cover those in a few moments. - </PARA> - </TIP> - </SECTION> + </para> + </listitem> + <listitem> + <para> + Enter the name of the product and a description. The + Description field is free-form. + </para> + </listitem> + </orderedlist> + <tip> + <para> + Don't worry about the "Closed for bug entry", "Maximum Votes + per person", "Maximum votes a person can put on a single + bug", "Number of votes a bug in this Product needs to + automatically get out of the UNCOMFIRMED state", and + "Version" options yet. We'll cover those in a few moments. + </para> + </tip> + </section> - <SECTION id="components"> - <TITLE>Components</TITLE> - <PARA> + <section id="components"> + <title>Components</title> + <para> Components are subsections of a Product. - <EXAMPLE> - <TITLE>Creating some Components</TITLE> - <INFORMALEXAMPLE> - <PARA> - The computer game you are designing may a "UI" component, an "API" component, - a "Sound System" component, and a "Plugins" component, each overseen by a different - programmer. It often makes sense to divide Components in Bugzilla according to the - natural divisions of responsibility within your Product or company. - </PARA> - </INFORMALEXAMPLE> - </EXAMPLE> - - Each component has a owner and (if you turned it on in the parameters), a qa - contact. The owner should be the primary person who fixes bugs in that component. The QA - Contact should be the person who will ensure these bugs are completely fixed. The Owner, - QA Contact, and Reporter will get email when new bugs are created in this Component and - when these bugs change. Default Owner and Default QA Contact fields only dictate the - <EMPHASIS>default assignments</EMPHASIS>; the Owner and Q/A Contact fields in a bug - are otherwise unrelated to the Component. - </PARA> + <example> + <title>Creating some Components</title> + <informalexample> + <para> + The computer game you are designing may have a "UI" + component, an "API" component, a "Sound System" + component, and a "Plugins" component, each overseen by + a different programmer. It often makes sense to divide + Components in Bugzilla according to the natural + divisions of responsibility within your Product or + company. + </para> + </informalexample> + </example> Each component has a owner and (if you turned it on + in the parameters), a QA Contact. The owner should be the + primary person who fixes bugs in that component. The QA + Contact should be the person who will ensure these bugs are + completely fixed. The Owner, QA Contact, and Reporter will get + email when new bugs are created in this Component and when + these bugs change. Default Owner and Default QA Contact fields + only dictate the <emphasis>default assignments</emphasis>; the + Owner and QA Contact fields in a bug are otherwise unrelated + to the Component. + </para> - <PARA> + <para> To create a new Component: - </PARA> - <ORDEREDLIST> - <LISTITEM> - <PARA> - Select the "Edit components" link from the "Edit Product" page - </PARA> - </LISTITEM> - <LISTITEM> - <PARA> - Select the "Add" link to the right of the "Add a new component" text - on the "Select Component" page. - </PARA> - </LISTITEM> - <LISTITEM> - <PARA> - Fill out the "Component" field, a short "Description", and the "Initial Owner". - The "Component" field should not contain a space. The "Description" field is - free-form. The "Initial Owner" field must be that of a valid user already - existing in the database. If the initial owner does not exist, Bugzilla - will refuse to create the component. - <TIP> - <PARA> - Is your "Default Owner" a user who is not yet in the database? - No problem. - <ORDEREDLIST> - <LISTITEM> - <PARA> - Select the "Log out" link on the footer of the page. - </PARA> - </LISTITEM> - <LISTITEM> - <PARA> - Select the "New Account" link on the footer of the "Relogin" page - </PARA> - </LISTITEM> - <LISTITEM> - <PARA> - Type in the email address of the default owner you want to create - in the "E-mail address" field, and her full name in the "Real name" + </para> + <orderedlist> + <listitem> + <para> + Select the "Edit components" link from the "Edit product" + page + </para> + </listitem> + <listitem> + <para> + Select the "Add" link to the right of the "Add a new + component" text on the "Select Component" page. + </para> + </listitem> + <listitem> + <para> + Fill out the "Component" field, a short "Description", and + the "Initial Owner". The Component and Description fields + are free-form; the "Initial Owner" field must be that of a + user ID already existing in the database. If the initial + owner does not exist, Bugzilla will refuse to create the + component. + <tip> + <para> + Is your "Default Owner" a user who is not yet in the + database? No problem. + <orderedlist> + <listitem> + <para> + Select the "Log out" link on the footer of the + page. + </para> + </listitem> + <listitem> + <para> + Select the "New Account" link on the footer of + the "Relogin" page + </para> + </listitem> + <listitem> + <para> + Type in the email address of the default owner + you want to create in the "E-mail address" + field, and her full name in the "Real name" field, then select the "Submit Query" button. - </PARA> - </LISTITEM> - <LISTITEM> - <PARA> - Now select "Log in" again, type in your login information, and you - can modify the product to use the Default Owner information - you require. - </PARA> - </LISTITEM> - </ORDEREDLIST> - </PARA> - </TIP> - </PARA> - </LISTITEM> - <LISTITEM> - <PARA> - Either "edit" more components or return to the "query" page on the ensuing - "Addming new component" page. To return to the Product you were editing, you - must select the "components" link as before. - </PARA> - </LISTITEM> - </ORDEREDLIST> - </SECTION> + </para> + </listitem> + <listitem> + <para> + Now select "Log in" again, type in your login + information, and you can modify the product to + use the Default Owner information you require. + </para> + </listitem> + </orderedlist> + </para> + </tip> + </para> + </listitem> + <listitem> + <para> + Either Edit more components or return to the Bugzilla + Query Page. To return to the Product you were editing, you + must select the Components link as before. + </para> + </listitem> + </orderedlist> + </section> - <SECTION id="versions"> - <TITLE>Versions</TITLE> - <PARA> - Versions are the revisions of the product, such as "Flinders 3.1", "Flinders 95", - and "Flinders 2000". Using Versions helps you isolate code changes and are an aid - in reporting. + <section id="versions"> + <title>Versions</title> + <para> + Versions are the revisions of the product, such as "Flinders + 3.1", "Flinders 95", and "Flinders 2000". Using Versions + helps you isolate code changes and are an aid in reporting. - <EXAMPLE> - <TITLE>Common Use of Versions</TITLE> - <INFORMALEXAMPLE> - <PARA> - A user reports a bug - against Version "Beta 2.0" of your product. The current Version of your software - is "Release Candidate 1", and no longer has the bug. This will - help you triage and classify bugs according to their relevance. It is also - possible people may report bugs against bleeding-edge beta versions that are - not evident in older versions of the software. This can help isolate code - changes that caused the bug - </PARA> - </INFORMALEXAMPLE> - </EXAMPLE> - <EXAMPLE> - <TITLE>A Different Use of Versions</TITLE> - <INFORMALEXAMPLE> - <PARA> - This field has been used to good effect by an online service provider in a slightly - different way. They had three versions of the product: "Production", "QA", - and "Dev". Although it may be the same product, a bug in the development - environment is not normally as critical as a Production bug, nor does it - need to be reported publicly. When used in conjunction with Target Milestones, - one can easily specify the environment where a bug can be reproduced, and - the Milestone by which it will be fixed. - </PARA> - </INFORMALEXAMPLE> - </EXAMPLE> - </PARA> - <PARA> + <example> + <title>Common Use of Versions</title> + <informalexample> + <para> + A user reports a bug against Version "Beta 2.0" of your + product. The current Version of your software is + "Release Candidate 1", and no longer has the bug. This + will help you triage and classify bugs according to + their relevance. It is also possible people may report + bugs against bleeding-edge beta versions that are not + evident in older versions of the software. This can + help isolate code changes that caused the bug + </para> + </informalexample> + </example> + <example> + <title>A Different Use of Versions</title> + <informalexample> + <para> + This field has been used to good effect by an online + service provider in a slightly different way. They had + three versions of the product: "Production", "QA", and + "Dev". Although it may be the same product, a bug in + the development environment is not normally as critical + as a Production bug, nor does it need to be reported + publicly. When used in conjunction with Target + Milestones, one can easily specify the environment where + a bug can be reproduced, and the Milestone by which it + will be fixed. + </para> + </informalexample> + </example> + </para> + <para> To create and edit Versions: - </PARA> - <ORDEREDLIST> - <LISTITEM> - <PARA> - From the "Edit Product" screen, select "Edit Versions" - </PARA> - </LISTITEM> - <LISTITEM> - <PARA> - You will notice that the product already has the default version "undefined". - If your product doesn't use version numbers, you may want to leave this as it is - or edit it so that it is "---". You can then go back to the edit versions page - and add new versions to your product. - </PARA> - <PARA> - Otherwise, click the "Add" button to the right of the "Add a new version" text. - </PARA> - </LISTITEM> - <LISTITEM> - <PARA> - Enter the name of the Version. This can be free-form characters up to the limit of the - text box. Then select the "Add" button. - </PARA> - </LISTITEM> - <LISTITEM> - <PARA> - At this point you can select "Edit" to edit more Versions, or return to the "Query" - page, from which you can navigate back to the product through the "components" link - at the foot of the Query page. - </PARA> - </LISTITEM> - </ORDEREDLIST> - </SECTION> + </para> + <orderedlist> + <listitem> + <para> + From the "Edit product" screen, select "Edit Versions" + </para> + </listitem> + <listitem> + <para> + You will notice that the product already has the default + version "undefined". If your product doesn't use version + numbers, you may want to leave this as it is or edit it so + that it is "---". You can then go back to the edit + versions page and add new versions to your product. + </para> + <para> + Otherwise, click the "Add" button to the right of the "Add + a new version" text. + </para> + </listitem> + <listitem> + <para> + Enter the name of the Version. This can be free-form + characters up to the limit of the text box. Then select + the "Add" button. + </para> + </listitem> + <listitem> + <para> + At this point you can select "Edit" to edit more Versions, + or return to the "Query" page, from which you can navigate + back to the product through the "components" link at the + foot of the Query page. + </para> + </listitem> + </orderedlist> + </section> - <SECTION id="milestones"> - <TITLE>Milestones</TITLE> - <PARA> - Milestones are "targets" that you plan to get a bug fixed by. For example, you have a bug that - you plan to fix for your 3.0 release, it would be assigned the milestone of 3.0. Or, you have a - bug that you plan to fix for 2.8, this would have a milestone of 2.8. - </PARA> - <NOTE> - <PARA> - Milestone options will only appear for a Product if you turned the "usetargetmilestone" field - in the "Edit Parameters" screen "On". - </PARA> - </NOTE> - <PARA> - To create new Milestones, set Default Milestones, and set Milestone URL: - </PARA> - <ORDEREDLIST> - <LISTITEM> - <PARA> + <section id="milestones"> + <title>Milestones</title> + <para> + Milestones are "targets" that you plan to get a bug fixed by. + For example, you have a bug that you plan to fix for your 3.0 + release, it would be assigned the milestone of 3.0. Or, you + have a bug that you plan to fix for 2.8, this would have a + milestone of 2.8. + </para> + <note> + <para> + Milestone options will only appear for a Product if you + turned the "usetargetmilestone" field in the "Edit + Parameters" screen "On". + </para> + </note> + <para> + To create new Milestones, set Default Milestones, and set + Milestone URL: + </para> + <orderedlist> + <listitem> + <para> Select "edit milestones" - </PARA> - </LISTITEM> - <LISTITEM> - <PARA> - Select "Add" to the right of the "Add a new milestone" text - </PARA> - </LISTITEM> - <LISTITEM> - <PARA> + </para> + </listitem> + <listitem> + <para> + Select "Add" to the right of the "Add a new milestone" + text + </para> + </listitem> + <listitem> + <para> Enter the name of the Milestone in the "Milestone" field. - You can optionally set the "Sortkey", which is a positive or negative number (-255 to 255) - that defines where in the list this particular milestone appears. - Select "Add". - </PARA> - <EXAMPLE> - <TITLE>Using SortKey with Target Milestone</TITLE> - <INFORMALEXAMPLE> - <PARA> - Let's say you create a target milestone called "Release 1.0", with Sortkey set to "0". - Later, you realize that you will have a public beta, called "Beta1". - You can create a Milestone called "Beta1", with a Sortkey of "-1" in order to ensure - people will see the Target Milestone of "Beta1" earlier on the list than "Release 1.0" - </PARA> - </INFORMALEXAMPLE> - </EXAMPLE> - </LISTITEM> - <LISTITEM> - <PARA> - If you want to add more milestones, select the "Edit" link. - If you don't, well shoot, you have to go back to the "query" page and select "components" - again, and make your way back to the Product you were editing. - <NOTE> - <PARA> - This is another in the list of unusual user interface decisions that - we'd like to get cleaned up. Shouldn't there be a link to the effect of - "edit the Product I was editing when I ended up here"? In any case, - clicking "components" in the footer takes you back to the "Select product" - screen, from which you can begin editing your product again. - </PARA> - </NOTE> - </PARA> - </LISTITEM> - <LISTITEM> - <PARA> - From the Edit Product screen again (once you've made your way back), enter the URL - for a description of what your milestones are for this product in the "Milestone URL" field. - It should be of the format "http://www.foo.com/bugzilla/product_milestones.html" - </PARA> - <PARA> - Some common uses of this field include product descriptions, product roadmaps, - and of course a simple description of the meaning of each milestone. - </PARA> - </LISTITEM> - <LISTITEM> - <PARA> - If you're using Target Milestones, the "Default Milestone" field must have some - kind of entry. If you really don't care if people set coherent Target Milestones, - simply leave this at the default, "---". However, controlling and regularly updating the Default - Milestone field is a powerful tool when reporting the status of projects. - </PARA> - <PARA>Select the "Update" button when you are done.</PARA> - </LISTITEM> - <LISTITEM> - <PARA> - - </PARA> - </LISTITEM> - </ORDEREDLIST> - </SECTION> + You can optionally set the "Sortkey", which is a positive + or negative number (-255 to 255) that defines where in the + list this particular milestone appears. Select "Add". + </para> + <example> + <title>Using SortKey with Target Milestone</title> + <informalexample> + <para> + Let's say you create a target milestone called + "Release 1.0", with Sortkey set to "0". Later, you + realize that you will have a public beta, called + "Beta1". You can create a Milestone called "Beta1", + with a Sortkey of "-1" in order to ensure people will + see the Target Milestone of "Beta1" earlier on the + list than "Release 1.0" + </para> + </informalexample> + </example> + </listitem> + <listitem> + <para> + If you want to add more milestones, select the "Edit" + link. If you don't, well shoot, you have to go back to the + "query" page and select "components" again, and make your + way back to the Product you were editing. + <note> + <para> + This is another in the list of unusual user interface + decisions that we'd like to get cleaned up. Shouldn't + there be a link to the effect of "edit the Product I + was editing when I ended up here"? In any case, + clicking "components" in the footer takes you back to + the "Select product" screen, from which you can begin + editing your product again. + </para> + </note> + </para> + </listitem> + <listitem> + <para> + From the Edit product screen again (once you've made your + way back), enter the URL for a description of what your + milestones are for this product in the "Milestone URL" + field. It should be of the format + "http://www.foo.com/bugzilla/product_milestones.html" + </para> + <para> + Some common uses of this field include product + descriptions, product roadmaps, and of course a simple + description of the meaning of each milestone. + </para> + </listitem> + <listitem> + <para> + If you're using Target Milestones, the "Default Milestone" + field must have some kind of entry. If you really don't + care if people set coherent Target Milestones, simply + leave this at the default, "---". However, controlling + and regularly updating the Default Milestone field is a + powerful tool when reporting the status of projects. + </para> + <para>Select the "Update" button when you are done.</para> + </listitem> + </orderedlist> + </section> - <SECTION id="voting"> - <TITLE>Voting</TITLE> - <PARA> - The concept of "voting" is a poorly understood, yet powerful feature for the management - of open-source projects. Each user is assigned so many Votes per product, which they can - freely reassign (or assign multiple votes to a single bug). - This allows developers to gauge user need for a particular enhancement - or bugfix. By allowing bugs with a certain number of votes to automatically move from - "UNCONFIRMED" to "NEW", users of the bug system can help high-priority bugs garner + <section id="voting"> + <title>Voting</title> + <para> + The concept of "voting" is a poorly understood, yet powerful + feature for the management of open-source projects. Each user + is assigned so many Votes per product, which they can freely + reassign (or assign multiple votes to a single bug). This + allows developers to gauge user need for a particular + enhancement or bugfix. By allowing bugs with a certain number + of votes to automatically move from "UNCONFIRMED" to "NEW", + users of the bug system can help high-priority bugs garner attention so they don't sit for a long time awaiting triage. - </PARA> - <PARA> - The daunting challenge of Votes is deciding where you draw the line for a "vocal majority". If you - only have a user base of 100 users, setting a low threshold for bugs to move from UNCONFIRMED - to NEW makes sense. As the Bugzilla user base expands, however, these thresholds must be - re-evaluated. You should gauge whether this feature is worth the time and close monitoring involved, - and perhaps forego implementation until you have a critical mass of users who demand it. - </PARA> - <PARA>To modify Voting settings:</PARA> - <ORDEREDLIST> - <LISTITEM> - <PARA> - Navigate to the "Edit Product" screen for the Product you wish to modify - </PARA> - </LISTITEM> - <LISTITEM> - <PARA> - Set "Maximum Votes per person" to your calculated value. Setting this field - to "0" disables voting. - </PARA> - </LISTITEM> - <LISTITEM> - <PARA> - Set "Maximum Votes a person can put on a single bug" to your calculated value. It - should probably be some number lower than the "Maximum votes per person". - Setting this field to "0" disables voting, but leaves the voting options open - to the user. This is confusing. - </PARA> - </LISTITEM> - <LISTITEM> - <PARA> - Set "Number of votes a bug in this product needs to automatically get out of the - UNCONFIRMED state" to your calculated number. Setting this field to "0" - disables the automatic move of bugs from UNCONFIRMED to NEW. Some people - advocate leaving this at "0", but of what use are Votes if your Bugzilla - user base is unable to affect which bugs appear on Development radar? - <TIP> - <PARA> - You should probably set this number to higher than a small coalition of - Bugzilla users can influence it. Most sites use this as a "referendum" - mechanism -- if users are able to vote a bug out of UNCONFIRMED, it - is a <EMPHASIS>really</EMPHASIS> bad bug! - </PARA> - </TIP> - </PARA> - </LISTITEM> - <LISTITEM> - <PARA> - Once you have adjusted the values to your preference, select the "Update" button. - </PARA> - </LISTITEM> - </ORDEREDLIST> - </SECTION> + </para> + <para> + The daunting challenge of Votes is deciding where you draw the + line for a "vocal majority". If you only have a user base of + 100 users, setting a low threshold for bugs to move from + UNCONFIRMED to NEW makes sense. As the Bugzilla user base + expands, however, these thresholds must be re-evaluated. You + should gauge whether this feature is worth the time and close + monitoring involved, and perhaps forego implementation until + you have a critical mass of users who demand it. + </para> + <para>To modify Voting settings:</para> + <orderedlist> + <listitem> + <para> + Navigate to the "Edit product" screen for the Product you + wish to modify + </para> + </listitem> + <listitem> + <para> + Set "Maximum Votes per person" to your calculated value. + Setting this field to "0" disables voting. + </para> + </listitem> + <listitem> + <para> + Set "Maximum Votes a person can put on a single bug" to + your calculated value. It should probably be some number + lower than the "Maximum votes per person". Setting this + field to "0" disables voting, but leaves the voting + options open to the user. This is confusing. + </para> + </listitem> + <listitem> + <para> + Set "Number of votes a bug in this product needs to + automatically get out of the UNCONFIRMED state" to your + calculated number. Setting this field to "0" disables + the automatic move of bugs from UNCONFIRMED to NEW. Some + people advocate leaving this at "0", but of what use are + Votes if your Bugzilla user base is unable to affect which + bugs appear on Development radar? + <tip> + <para> + You should probably set this number to higher than a + small coalition of Bugzilla users can influence it. + Most sites use this as a "referendum" mechanism -- if + users are able to vote a bug out of UNCONFIRMED, it is + a <emphasis>really</emphasis> bad bug! + </para> + </tip> + </para> + </listitem> + <listitem> + <para> + Once you have adjusted the values to your preference, + select the "Update" button. + </para> + </listitem> + </orderedlist> + </section> - <SECTION id="groups"> - <TITLE>Groups and Group Security</TITLE> - <PARA> - Groups can be very useful in bugzilla, because they allow users to isolate - bugs or products that should only be seen by certain people. Groups can also - be a complicated minefield of interdependencies and weirdness if mismanaged. + <section id="groups"> + <title>Groups and Group Security</title> + <para> + Groups can be very useful in bugzilla, because they allow + users to isolate bugs or products that should only be seen by + certain people. Groups can also be a complicated minefield of + interdependencies and weirdness if mismanaged. - <EXAMPLE> - <TITLE>When to Use Group Security</TITLE> - <INFORMALEXAMPLE> - <PARA> - Many Bugzilla sites isolate "Security-related" bugs from all other bugs. - This way, they can have a fix ready before the security vulnerability - is announced to the world. You can create a "Security" product which, by - default, has no members, and only add members to the group (in their individual - User page, as described under User Administration) who should have - priveleged access to "Security" bugs. Alternately, you may create a Group - independently of any Product, and change the Group mask on individual bugs - to restrict access to members only of certain Groups. - </PARA> - </INFORMALEXAMPLE> - </EXAMPLE> - - Groups only work if you enable the "usebuggroups" paramater. - In addition, if the "usebuggroupsentry" parameter is "On", one can restrict access - to products by groups, so that only members of a product group are able to view - bugs within that product. - Group security in Bugzilla can be divided into two categories: - Generic and Product-Based. - </PARA> - <NOTE> - <PARA> - Groups in Bugzilla are a complicated beast that evolved out of very simple user - permission bitmasks, apparently itself derived from common concepts in UNIX access - controls. A "bitmask" is a fixed-length number whose value can describe one, and - only one, set of states. For instance, UNIX file permissions are assigned bitmask - values: "execute" has a value of 1, "write" has a value of 2, - and "read" has a value of 4. Add them together, - and a file can be read, written to, and executed if it has a bitmask of "7". (This - is a simplified example -- anybody who knows UNIX security knows there is much - more to it than this. Please bear with me for the purpose of this note.) The only - way a bitmask scheme can work is by doubling the bit count for each value. Thus - if UNIX wanted to offer another file permission, the next would have to be a value of - 8, then the next 16, the next 32, etc. - </PARA> - <PARA> - Similarly, Bugzilla offers a bitmask to define group permissions, with an internal - limit of 64. Several are already occupied - by built-in permissions. The way around this limitation is - to avoid assigning groups to products if you have many products, avoid bloating - of group lists, and religiously prune irrelevant groups. In reality, most installations - of Bugzilla support far fewer than 64 groups, so this limitation has not hit - for most sites, but it is on the table to be revised for Bugzilla 3.0 - because it interferes with the security schemes of some administrators. - </PARA> - </NOTE> - <PARA> + <example> + <title>When to Use Group Security</title> + <informalexample> + <para> + Many Bugzilla sites isolate "Security-related" bugs from + all other bugs. This way, they can have a fix ready + before the security vulnerability is announced to the + world. You can create a "Security" product which, by + default, has no members, and only add members to the + group (in their individual User page, as described under + User Administration) who should have priveleged access + to "Security" bugs. Alternately, you may create a Group + independently of any Product, and change the Group mask + on individual bugs to restrict access to members only of + certain Groups. + </para> + </informalexample> + </example> Groups only work if you enable the "usebuggroups" + paramater. In addition, if the "usebuggroupsentry" parameter + is "On", one can restrict access to products by groups, so + that only members of a product group are able to view bugs + within that product. Group security in Bugzilla can be divided + into two categories: Generic and Product-Based. + </para> + <note> + <para> + Groups in Bugzilla are a complicated beast that evolved out + of very simple user permission bitmasks, apparently itself + derived from common concepts in UNIX access controls. A + "bitmask" is a fixed-length number whose value can describe + one, and only one, set of states. For instance, UNIX file + permissions are assigned bitmask values: "execute" has a + value of 1, "write" has a value of 2, and "read" has a + value of 4. Add them together, and a file can be read, + written to, and executed if it has a bitmask of "7". (This + is a simplified example -- anybody who knows UNIX security + knows there is much more to it than this. Please bear with + me for the purpose of this note.) The only way a bitmask + scheme can work is by doubling the bit count for each value. + Thus if UNIX wanted to offer another file permission, the + next would have to be a value of 8, then the next 16, the + next 32, etc. + </para> + <para> + Similarly, Bugzilla offers a bitmask to define group + permissions, with an internal limit of 64. Several are + already occupied by built-in permissions. The way around + this limitation is to avoid assigning groups to products if + you have many products, avoid bloating of group lists, and + religiously prune irrelevant groups. In reality, most + installations of Bugzilla support far fewer than 64 groups, + so this limitation has not hit for most sites, but it is on + the table to be revised for Bugzilla 3.0 because it + interferes with the security schemes of some administrators. + </para> + </note> + <para> To enable Generic Group Security ("usebuggroups"): - </PARA> - <ORDEREDLIST> - <LISTITEM> - <PARA> + </para> + <orderedlist> + <listitem> + <para> Turn "On" "usebuggroups" in the "Edit Parameters" screen. - </PARA> - </LISTITEM> - <LISTITEM> - <PARA> - You will generally have no groups set up. Select the "groups" link - in the footer. - </PARA> - </LISTITEM> - <LISTITEM> - <PARA> - Take a moment to understand the instructions on the "Edit Groups" screen. - Once you feel confident you understand what is expected of you, select the - "Add Group" link. - </PARA> - </LISTITEM> - <LISTITEM> - <PARA> - Fill out the "New Name" (remember, no spaces!), "New Description", and "New - User RegExp" fields. "New User RegExp" allows you to automatically place - all users who fulfill the Regular Expression into the new group. + </para> + </listitem> + <listitem> + <para> + You will generally have no groups set up. Select the + "groups" link in the footer. + </para> + </listitem> + <listitem> + <para> + Take a moment to understand the instructions on the "Edit + Groups" screen. Once you feel confident you understand + what is expected of you, select the "Add Group" link. + </para> + </listitem> + <listitem> + <para> + Fill out the "New Name" (remember, no spaces!), "New + Description", and "New User RegExp" fields. "New User + RegExp" allows you to automatically place all users who + fulfill the Regular Expression into the new group. - <EXAMPLE> - <TITLE>Creating a New Group</TITLE> - <INFORMALEXAMPLE> - <PARA> - I created a group called "DefaultGroup" with a description of "This is simply - a group to play with", and a "New User RegExp" of "*@velio.com". This - new group automatically includes all Bugzilla users with "@velio.com" at the - end of their user id. When I finished, my new group was assigned bit #128. - </PARA> - </INFORMALEXAMPLE> - </EXAMPLE> - - When you have finished, select the "Add" button. - </PARA> - </LISTITEM> - </ORDEREDLIST> + <example> + <title>Creating a New Group</title> + <informalexample> + <para> + I created a group called DefaultGroup with a + description of <quote>This is simply a group to play + with</quote>, and a New User RegExp of <quote>.*@mydomain.tld</quote>. + This new group automatically includes all Bugzilla + users with "@mydomain.tld" at the end of their user id. + When I finished, my new group was assigned bit #128. + </para> + </informalexample> + </example> When you have finished, select the Add + button. + </para> + </listitem> + </orderedlist> - <PARA> - To enable Product-Based Group Security ("usebuggroupsentry"): - </PARA> - <WARNING> - <PARA> - Don't forget that you only have 64 groups masks available, total, for - your installation of Bugzilla! If you plan on having more than 50 - products in your individual Bugzilla installation, and require group - security for your products, you should - consider either running multiple Bugzillas or using Generic Group Security - instead of Product-Based ("usebuggroupsentry") Group Security. - </PARA> - </WARNING> - <ORDEREDLIST> - <LISTITEM> - <PARA> - Turn "On" "usebuggroups" and "usebuggroupsentry" in the "Edit Parameters" screen. - </PARA> - <WARNING> - <PARA> - "usebuggroupsentry" has the capacity to prevent the administrative user - from directly altering bugs because of conflicting group permissions. - If you plan on using "usebuggroupsentry", you should plan on restricting administrative - account usage to administrative duties only. - In other words, manage bugs with an unpriveleged user account, and - manage users, groups, Products, etc. with the administrative account. - </PARA> - </WARNING> - </LISTITEM> - <LISTITEM> - <PARA> - You will generally have no Groups set up, unless you enabled "usebuggroupsentry" - prior to creating any Products. To create "Generic Group Security" groups, - follow the instructions given above. To create Product-Based Group security, - simply follow the 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. - </PARA> - </LISTITEM> - </ORDEREDLIST> - </SECTION> - </SECTION> + <para> + To enable Product-Based Group Security (usebuggroupsentry): + </para> + <warning> + <para> + Don't forget that you only have 64 groups masks available, + total, for your installation of Bugzilla! If you plan on + having more than 50 products in your individual Bugzilla + installation, and require group security for your products, + you should consider either running multiple Bugzillas or + using Generic Group Security instead of Product-Based + ("usebuggroupsentry") Group Security. + </para> + </warning> + <orderedlist> + <listitem> + <para> + Turn "On" "usebuggroups" and "usebuggroupsentry" in the + "Edit Parameters" screen. + </para> + <warning> + <para> + "usebuggroupsentry" has the capacity to prevent the + administrative user from directly altering bugs because + of conflicting group permissions. If you plan on using + "usebuggroupsentry", you should plan on restricting + administrative account usage to administrative duties + only. In other words, manage bugs with an unpriveleged + user account, and manage users, groups, Products, etc. + with the administrative account. + </para> + </warning> + </listitem> + <listitem> + <para> + You will generally have no Groups set up, unless you + enabled "usebuggroupsentry" prior to creating any + Products. To create "Generic Group Security" groups, + follow the instructions given above. To create + Product-Based Group security, simply follow the + 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. + </para> + </listitem> + </orderedlist> + </section> + </section> - <SECTION id="security"> - <TITLE>Bugzilla Security</TITLE> - <EPIGRAPH> - <PARA> - Putting your money in a wall safe is better protection than depending on the fact that - no one knows that you hide your money in a mayonnaise jar in your fridge. - </PARA> - </EPIGRAPH> - <NOTE> - <PARA> - Poorly-configured MySQL, Bugzilla, and FTP installations have given attackers full - access to systems in the past. Please take these guidelines seriously, even - for Bugzilla machines hidden away behind your firewall. 80% of all computer + <section id="security"> + <title>Bugzilla Security</title> + <epigraph> + <para> + Putting your money in a wall safe is better protection than + depending on the fact that no one knows that you hide your + money in a mayonnaise jar in your fridge. + </para> + </epigraph> + <note> + <para> + Poorly-configured MySQL, Bugzilla, and FTP installations have + given attackers full access to systems in the past. Please + take these guidelines seriously, even for Bugzilla machines + hidden away behind your firewall. 80% of all computer trespassers are insiders, not anonymous crackers. - </PARA> - </NOTE> - <PARA> - First thing's first: Secure your installation. - <NOTE> - <PARA> - These instructions must, of necessity, be somewhat vague since Bugzilla runs on so many different - platforms. If you have refinements of these directions for specific platforms, please - submit them to <ULINK URL="mailto://mozilla-webtools@mozilla.org">mozilla-webtools@mozilla.org</ULINK> - </PARA> - </NOTE> - <ORDEREDLIST> - <LISTITEM> - <PARA> - Ensure you are running at least MysQL version 3.22.32 or newer. Earlier versions had - notable security holes and poorly secured default configuration choices. - </PARA> - </LISTITEM> - <LISTITEM> - <PARA><EMPHASIS>There is no substitute for understanding the tools on your system!</EMPHASIS> - Read <ULINK URL="http://www.mysql.com/documentation/mysql/bychapter/manual_Privilege_system.html"> - The MySQL Privelege System</ULINK> until you can recite it from memory!</PARA> - <PARA> - At the very least, ensure you password the "mysql -u root" account and the "bugs" account, establish grant - table rights (consult the Keystone guide in Appendix C: The Bugzilla Database for some easy-to-use details) - that do not allow CREATE, DROP, RELOAD, SHUTDOWN, and PROCESS for user "bugs". I wrote up the Keystone - advice back when I knew far less about security than I do now : ) - </PARA> - </LISTITEM> - <LISTITEM> - <PARA> - Lock down /etc/inetd.conf. Heck, disable inet entirely on this box. It should only listen to - port 25 for Sendmail + </para> + </note> + <para> + Secure your installation. + <note> + <para> + These instructions must, of necessity, be somewhat vague + since Bugzilla runs on so many different platforms. If you + have refinements of these directions for specific platforms, + please submit them to <ulink url="mailto://mozilla-webtools@mozilla.org">mozilla-webtools@mozilla.org</ulink> + </para> + </note> + <orderedlist> + <listitem> + <para> + Ensure you are running at least MysQL version 3.22.32 or + newer. Earlier versions had notable security holes and + poorly secured default configuration choices. + </para> + </listitem> + <listitem> + <para><emphasis>There is no substitute for understanding the + tools on your system!</emphasis> Read <ulink url="http://www.mysql.com/documentation/mysql/bychapter/manual_Privilege_system.html"> The MySQL Privilege System</ulink> until you can recite it from memory!</para> + <para> + At the very least, ensure you password the "mysql -u root" + account and the "bugs" account, establish grant table + rights (consult the Keystone guide in Appendix C: The + Bugzilla Database for some easy-to-use details) that do + not allow CREATE, DROP, RELOAD, SHUTDOWN, and PROCESS for + user "bugs". I wrote up the Keystone advice back when I + knew far less about security than I do now : ) + </para> + </listitem> + <listitem> + <para> + Lock down /etc/inetd.conf. Heck, disable inet entirely on + this box. It should only listen to port 25 for Sendmail and port 80 for Apache. - </PARA> - </LISTITEM> - <LISTITEM> - <PARA>Do not run Apache as "nobody". This will require very lax permissions in your Bugzilla directories. - Run it, instead, as a user with a name, set via your httpd.conf file.</PARA> - </LISTITEM> - <LISTITEM> - <PARA> - Ensure you have adequate access controls for the $BUGZILLA_HOME/data/ and - $BUGZILLA_HOME/shadow/ directories, as well as the $BUGZILLA_HOME/localconfig and - $BUGZILLA_HOME/globals.pl files. - The localconfig file stores your "bugs" user password, - which would be terrible to have in the hands - of a criminal, while the "globals.pl" stores some default information regarding your - installation which could aid a system cracker. - In addition, some files under $BUGZILLA_HOME/data/ store sensitive information, and - $BUGZILLA_HOME/shadow/ stores bug information for faster retrieval. If you fail to secure - these directories and this file, you will expose bug information to those who may not - be allowed to see it. - </PARA> - <NOTE> - <PARA> - Bugzilla provides default .htaccess files to protect the most common Apache - installations. However, you should verify these are adequate according to the site-wide - security policy of your web server, and ensure that the .htaccess files are - allowed to "override" default permissions set in your Apache configuration files. - Covering Apache security is beyond the scope of this Guide; please consult the Apache - documentation for details. - </PARA> - <PARA> - If you are using a web server that does not support the .htaccess control method, - <EMPHASIS>you are at risk!</EMPHASIS> After installing, check to see if you can - view the file "localconfig" in your web browser (ergo: - <ULINK URL="http://bugzilla.mozilla.org/localconfig"> - http://bugzilla.mozilla.org/localconfig</ULINK>. If you can read the contents of this - file, your web server has not secured your bugzilla directory properly and you - must fix this problem before deploying Bugzilla. If, however, it gives you a - "Forbidden" error, then it probably respects the .htaccess conventions and you - are good to go. - </PARA> - </NOTE> - <PARA> - On Apache, you can use .htaccess files to protect access to these directories, as outlined - in <ULINK URL="http://bugzilla.mozilla.org/show_bug.cgi?id=57161">Bug 57161</ULINK> for the - localconfig file, and <ULINK URL="http://bugzilla.mozilla.org/show_bug.cgi?id=65572"> - Bug 65572</ULINK> for adequate protection in your data/ and shadow/ directories. - </PARA> - <PARA> - Note the instructions which follow are Apache-specific. If you use IIS, Netscape, or other - non-Apache web servers, please consult your system documentation for how to secure these - files from being transmitted to curious users. - </PARA> - <PARA> - Place the following text into a file named ".htaccess", readable by your web server, - in your $BUGZILLA_HOME/data directory. - <LITERALLAYOUT> - <Files comments> - allow from all - </Files> - deny from all - </LITERALLAYOUT> - </PARA> - <PARA> - Place the following text into a file named ".htaccess", readable by your web server, - in your $BUGZILLA_HOME/ directory. - <LITERALLAYOUT> - <Files localconfig> - deny from all - </Files> - allow from all - </LITERALLAYOUT> - </PARA> - <PARA> - Place the following text into a file named ".htaccess", readable by your web server, - in your $BUGZILLA_HOME/shadow directory. - <LITERALLAYOUT> - deny from all - </LITERALLAYOUT> - </PARA> - </LISTITEM> - </ORDEREDLIST> - </PARA> - </SECTION> -</CHAPTER> - - + </para> + </listitem> + <listitem> + <para> + Do not run Apache as <quote>nobody</quote>. This will + require very lax permissions in your Bugzilla directories. + Run it, instead, as a user with a name, set via your + httpd.conf file. + <note> + <para> + <quote>nobody</quote> is a real user on UNIX systems. + Having a process run as user id <quote>nobody</quote> + is absolutely no protection against system crackers + versus using any other user account. As a general + security measure, I recommend you create unique user + ID's for each daemon running on your system and, if + possible, use "chroot" to jail that process away from + the rest of your system. + </para> + </note> + </para> + </listitem> + <listitem> + <para> + Ensure you have adequate access controls for the + $BUGZILLA_HOME/data/ and $BUGZILLA_HOME/shadow/ + directories, as well as the $BUGZILLA_HOME/localconfig and + $BUGZILLA_HOME/globals.pl files. The localconfig file + stores your "bugs" user password, which would be terrible + to have in the hands of a criminal, while the "globals.pl" + stores some default information regarding your + installation which could aid a system cracker. In + addition, some files under $BUGZILLA_HOME/data/ store + sensitive information, and $BUGZILLA_HOME/shadow/ stores + bug information for faster retrieval. If you fail to + secure these directories and this file, you will expose + bug information to those who may not be allowed to see it. + </para> + <note> + <para> + Bugzilla provides default .htaccess files to protect the + most common Apache installations. However, you should + verify these are adequate according to the site-wide + security policy of your web server, and ensure that the + .htaccess files are allowed to "override" default + permissions set in your Apache configuration files. + Covering Apache security is beyond the scope of this + Guide; please consult the Apache documentation for + details. + </para> + <para> + If you are using a web server that does not support the + .htaccess control method, <emphasis>you are at + risk!</emphasis> After installing, check to see if + you can view the file "localconfig" in your web browser + (e.g.: <ulink url="http://bugzilla.mozilla.org/localconfig"> http://bugzilla.mozilla.org/localconfig</ulink>). If you can read the contents of this file, your web server has not secured your bugzilla directory properly and you must fix this problem before deploying Bugzilla. If, however, it gives you a "Forbidden" error, then it probably respects the .htaccess conventions and you are good to go. + </para> + </note> + <para> + On Apache, you can use .htaccess files to protect access + to these directories, as outlined in <ulink url="http://bugzilla.mozilla.org/show_bug.cgi?id=57161">Bug 57161</ulink> for the localconfig file, and <ulink url="http://bugzilla.mozilla.org/show_bug.cgi?id=65572"> Bug 65572</ulink> for adequate protection in your data/ and shadow/ directories. + </para> + <para> + Note the instructions which follow are Apache-specific. + If you use IIS, Netscape, or other non-Apache web servers, + please consult your system documentation for how to secure + these files from being transmitted to curious users. + </para> + <para> + Place the following text into a file named ".htaccess", + readable by your web server, in your $BUGZILLA_HOME/data + directory. <literallayout> <Files comments> allow + from all </Files> deny from all </literallayout> + </para> + <para> + Place the following text into a file named ".htaccess", + readable by your web server, in your $BUGZILLA_HOME/ + directory. <literallayout> <Files localconfig> deny + from all </Files> allow from all </literallayout> + </para> + <para> + Place the following text into a file named ".htaccess", + readable by your web server, in your $BUGZILLA_HOME/shadow + directory. <literallayout> deny from all </literallayout> + </para> + </listitem> + </orderedlist> + </para> + </section> +</chapter> <!-- Keep this comment at the end of the file Local variables: mode: sgml -sgml-omittag:t -sgml-shorttag:t -sgml-namecase-general:t -sgml-general-insert-case:upper -sgml-minimize-attributes:nil sgml-always-quote-attributes:t -sgml-indent-step:2 -sgml-indent-data:t -sgml-parent-document:nil +sgml-auto-insert-required-elements:t +sgml-balanced-tag-edit:t sgml-exposed-tags:nil +sgml-general-insert-case:lower +sgml-indent-data:t +sgml-indent-step:2 sgml-local-catalogs:nil sgml-local-ecat-files:nil +sgml-minimize-attributes:nil +sgml-namecase-general:t +sgml-omittag:t +sgml-parent-document:("Bugzilla-Guide.sgml" "book" "chapter") +sgml-shorttag:t +sgml-tag-region-if-active:t End: --> diff --git a/docs/sgml/conventions.sgml b/docs/sgml/conventions.sgml index 66f72303c..71f2b0c5e 100644 --- a/docs/sgml/conventions.sgml +++ b/docs/sgml/conventions.sgml @@ -89,23 +89,28 @@ </informaltable> </section> + + + + + <!-- Keep this comment at the end of the file Local variables: mode: sgml -sgml-omittag:t -sgml-shorttag:t -sgml-namecase-general:t -sgml-general-insert-case:upper -sgml-minimize-attributes:nil sgml-always-quote-attributes:t -sgml-indent-step:2 -sgml-indent-data:t -sgml-parent-document:nil +sgml-auto-insert-required-elements:t +sgml-balanced-tag-edit:t sgml-exposed-tags:nil +sgml-general-insert-case:lower +sgml-indent-data:t +sgml-indent-step:2 sgml-local-catalogs:nil sgml-local-ecat-files:nil +sgml-minimize-attributes:nil +sgml-namecase-general:t +sgml-omittag:t +sgml-parent-document:("Bugzilla-Guide.sgml" "book" "chapter") +sgml-shorttag:t +sgml-tag-region-if-active:t End: --> - - - diff --git a/docs/sgml/database.sgml b/docs/sgml/database.sgml index eced31c52..aee9b37e5 100644 --- a/docs/sgml/database.sgml +++ b/docs/sgml/database.sgml @@ -1,197 +1,153 @@ -<!DOCTYPE appendix PUBLIC "-//OASIS//DTD DocBook V4.1//EN"> - -<APPENDIX id="database"> - -<TITLE>The Bugzilla Database</TITLE> -<NOTE> -<PARA>This document really needs to be updated with more fleshed out information about primary keys, interrelationships, and maybe some nifty tables to document dependencies. Any takers?</PARA> -</NOTE> - <SECTION id="dbschema"> - <TITLE>Database Schema Chart</TITLE> - <PARA> - <MEDIAOBJECT> - <IMAGEOBJECT> - <IMAGEDATA FILEREF="dbschema.jpg" FORMAT="jpg"> - </IMAGEOBJECT> - - <TEXTOBJECT> - <PHRASE>Database Relationships</PHRASE> - </TEXTOBJECT> - - <CAPTION> - <PARA>Bugzilla database relationships chart</PARA> - </CAPTION> - </MEDIAOBJECT> - </PARA> - </SECTION> - - <SECTION id="dbdoc"> -<TITLE>MySQL Bugzilla Database Introduction</TITLE> -<LITERALLAYOUT> - -Contributor(s): Matthew P. Barnson (mbarnson@excitehome.net) - -Last update: May 16, 2000 - -Changes: -Version 1.0: Initial public release (May 16, 2000) - -Maintainer: Matthew P. Barnson (mbarnson@excitehome.net) - - -=== -Table Of Contents -=== - -FOREWORD -INTRODUCTION -THE BASICS -THE TABLES -THE DETAILS - - - -=== -FOREWORD -=== - - This information comes straight from my life. I was forced to learn how -Bugzilla organizes database because of nitpicky requests from users for tiny -changes in wording, rather than having people re-educate themselves or -figure out how to work our procedures around the tool. It sucks, but it can -and will happen to you, so learn how the schema works and deal with it when it -comes. - - I'm sorry this version is plain text. I can whip this info out a lot faster -if I'm not concerned about complex formatting. I'll get it into sgml for easy -portability as time permits. - - The Bugzilla Database Schema has a home! In addition to availability via CVS -and released versions 2.12 and higher of Bugzilla, you can find the latest & -greatest version of the Bugzilla Database Schema at -http://www.trilobyte.net/barnsons/. This is a living document; please be sure -you are up-to-date with the latest version before mirroring. - - The Bugzilla Database Schema is designed to provide vital information -regarding the structure of the MySQL database. Where appropriate, this -document will refer to URLs rather than including documents in their entirety -to ensure completeness even should this paper become out of date. - - This document is not maintained by Netscape or Netscape employees, so please -do not contact them regarding errors or omissions contained herein. Please -direct all questions, comments, updates, flames, etc. to Matthew P. Barnson -mbarnson@excitehome.net) (barnboy or barnhome on irc.mozilla.org in -#mozwebtools). - - I'm sure I've made some glaring errors or omissions in this paper -- please -email me corrections or post corrections to the -netscape.public.mozilla.webtools newsgroup. - - - -=== -INTRODUCTION -=== - - - - So, here you are with your brand-new installation of Bugzilla. You've got -MySQL set up, Apache working right, Perl DBI and DBD talking to the database -flawlessly. Maybe you've even entered a few test bugs to make sure email's -working; people seem to be notified of new bugs and changes, and you can -enter and edit bugs to your heart's content. Perhaps you've gone through the -trouble of setting up a gateway for people to submit bugs to your database via -email, have had a few people test it, and received rave reviews from your beta -testers. - - What's the next thing you do? Outline a training strategy for your -development team, of course, and bring them up to speed on the new tool you've -labored over for hours. - - Your first training session starts off very well! You have a captive -audience which seems enraptured by the efficiency embodied in this thing called -"Bugzilla". You are caught up describing the nifty features, how people can -save favorite queries in the database, set them up as headers and footers on -their pages, customize their layouts, generate reports, track status with -greater efficiency than ever before, leap tall buildings with a single bound -and rescue Jane from the clutches of Certain Death! - - But Certain Death speaks up -- a tiny voice, from the dark corners of the -conference room. "I have a concern," the voice hisses from the darkness, -"about the use of the word 'verified'. - - The room, previously filled with happy chatter, lapses into reverential -silence as Certain Death (better known as the Vice President of Software -Engineering) continues. "You see, for two years we've used the word 'verified' -to indicate that a developer or quality assurance engineer has confirmed that, -in fact, a bug is valid. I don't want to lose two years of training to a -new software product. You need to change the bug status of 'verified' to -'approved' as soon as possible. To avoid confusion, of course." - - Oh no! Terror strikes your heart, as you find yourself mumbling "yes, yes, I -don't think that would be a problem," You review the changes with Certain -Death, and continue to jabber on, "no, it's not too big a change. I mean, we -have the source code, right? You know, 'Use the Source, Luke' and all that... -no problem," All the while you quiver inside like a beached jellyfish bubbling, -burbling, and boiling on a hot Jamaican sand dune... - - Thus begins your adventure into the heart of Bugzilla. You've been forced -to learn about non-portable enum() fields, varchar columns, and tinyint -definitions. The Adventure Awaits You! - - - -=== -The Basics -=== - - If you were like me, at this point you're totally clueless about the -internals of MySQL, and if it weren't for this executive order from the Vice -President you couldn't care less about the difference between a "bigint" and a -"tinyint" entry in MySQL. I'd refer you first to the MySQL documentation, -available at http://www.mysql.com/doc.html, but that's mostly a confusing -morass of high-level database jargon. Here are the basics you need to know -about the database to proceed: - -1. To connect to your database, type "mysql -u root" at the command prompt as -any user. If this works without asking you for a password, SHAME ON YOU! You -should have locked your security down like the README told you to. You can -find details on locking down your database in the Bugzilla FAQ in this -directory (under "Security"), or more robust security generalities in the -MySQL searchable documentation at -http://www.mysql.com/php/manual.php3?section=Privilege_system . - -2. You should now be at a prompt that looks like this: - -mysql> - - At the prompt, if "bugs" is the name of your Bugzilla database, type: - -mysql> use bugs; +<!-- <!DOCTYPE appendix PUBLIC "-//OASIS//DTD DocBook V4.1//EN"> --> + +<appendix id="database"> + +<title>The Bugzilla Database</title> +<note> +<para> + This document really needs to be updated with more fleshed out information about primary keys, interrelationships, and maybe some nifty tables to document dependencies. Any takers? + </para> + </note> + <section id="dbschema"> + <title>Database Schema Chart</title> + <para> + <mediaobject> + <imageobject> + <imagedata fileref="dbschema.jpg" format="jpg"> + </imageobject> - (don't forget the ";" at the end of each line, or you'll be kicking yourself -all the way through this documentation) - Young Grasshopper, you are now ready for the unveiling of the Bugzilla -database, in the next section... - - - -=== -THE TABLES -=== - - Imagine your MySQL database as a series of spreadsheets, and you won't be too -far off. If you use this command: - -mysql> show tables from bugs; - - you'll be able to see all the "spreadsheets" (tables) in your database. Cool, -huh? It's kinda' like a filesystem, only much faster and more robust. Come -on, I'll show you more! - - From the command issued above, you should now have some output that looks -like this: - + <textobject> + <phrase>Database Relationships</phrase> + </textobject> + + <caption> + <para>Bugzilla database relationships chart</para> + </caption> + </mediaobject> + </para> + </section> + + <section id="dbdoc"> +<title>MySQL Bugzilla Database Introduction</title> + <para> + This information comes straight from my life. I was forced to learn how + Bugzilla organizes database because of nitpicky requests from users for tiny + changes in wording, rather than having people re-educate themselves or + figure out how to work our procedures around the tool. It sucks, but it can + and will happen to you, so learn how the schema works and deal with it when it + comes. + </para> + + <para> + So, here you are with your brand-new installation of Bugzilla. You've got + MySQL set up, Apache working right, Perl DBI and DBD talking to the database + flawlessly. Maybe you've even entered a few test bugs to make sure email's + working; people seem to be notified of new bugs and changes, and you can + enter and edit bugs to your heart's content. Perhaps you've gone through the + trouble of setting up a gateway for people to submit bugs to your database via + email, have had a few people test it, and received rave reviews from your beta + testers. + </para> + <para> + What's the next thing you do? Outline a training strategy for your + development team, of course, and bring them up to speed on the new tool you've + labored over for hours. + </para> + <para> + Your first training session starts off very well! You have a captive + audience which seems enraptured by the efficiency embodied in this thing called + "Bugzilla". You are caught up describing the nifty features, how people can + save favorite queries in the database, set them up as headers and footers on + their pages, customize their layouts, generate reports, track status with + greater efficiency than ever before, leap tall buildings with a single bound + and rescue Jane from the clutches of Certain Death! + </para> + <para> + But Certain Death speaks up -- a tiny voice, from the dark corners of the + conference room. "I have a concern," the voice hisses from the darkness, + "about the use of the word 'verified'. + </para> + <para> + The room, previously filled with happy chatter, lapses into reverential + silence as Certain Death (better known as the Vice President of Software + Engineering) continues. "You see, for two years we've used the word 'verified' + to indicate that a developer or quality assurance engineer has confirmed that, + in fact, a bug is valid. I don't want to lose two years of training to a + new software product. You need to change the bug status of 'verified' to + 'approved' as soon as possible. To avoid confusion, of course." + </para> + <para> + Oh no! Terror strikes your heart, as you find yourself mumbling "yes, yes, I + don't think that would be a problem," You review the changes with Certain + Death, and continue to jabber on, "no, it's not too big a change. I mean, we + have the source code, right? You know, 'Use the Source, Luke' and all that... + no problem," All the while you quiver inside like a beached jellyfish bubbling, + burbling, and boiling on a hot Jamaican sand dune... + </para> + <para> + Thus begins your adventure into the heart of Bugzilla. You've been forced + to learn about non-portable enum() fields, varchar columns, and tinyint + definitions. The Adventure Awaits You! + </para> + + <section> + <title>Bugzilla Database Basics</title> + <para> + If you were like me, at this point you're totally clueless + about the internals of MySQL, and if it weren't for this + executive order from the Vice President you couldn't care less + about the difference between a <quote>bigint</quote> and a + <quote>tinyint</quote> entry in MySQL. I recommend you refer + to the MySQL documentation, available at <ulink url="http://www.mysql.com/doc.html">MySQL.com</ulink>. Below are the basics you need to know about the Bugzilla database. Check the chart above for more details. + </para> + <para><orderedlist> + <listitem> + <para> + To connect to your database: + </para> + <para> + <prompt>bash#</prompt><command>mysql</command><parameter>-u root</parameter> + </para> + <para> + If this works without asking you for a password, + <emphasis>shame on you</emphasis>! You should have + locked your security down like the installation + instructions told you to. You can find details on + locking down your database in the Bugzilla FAQ in this + directory (under "Security"), or more robust security + generalities in the MySQL searchable documentation at + http://www.mysql.com/php/manual.php3?section=Privilege_system . + </para> + </listitem> + + <listitem> + <para>You should now be at a prompt that looks like + this:</para> + <para><prompt>mysql></prompt></para> + <para>At the prompt, if <quote>bugs</quote> is the name + you chose in the<filename>localconfig</filename> file + for your Bugzilla database, type:</para> + <para><prompt>mysql</prompt><command>use bugs;</command></para> + <note> + <para>Don't forget the <quote>;</quote> at the end of + each line, or you'll be kicking yourself later.</para> + </note> + </listitem> + </orderedlist> + </para> + <section> + <title>Bugzilla Database Tables</title> + <para> Imagine your MySQL database as a series of + spreadsheets, and you won't be too far off. If you use this + command:</para> + <para><prompt>mysql></prompt><command>show tables from bugs;</command></para> + <para>you'll be able to see all the + <quote>spreadsheets</quote> (tables) in your database. It + is similar to a file system, only faster and more robust for + certain types of operations.</para> + <para>From the command issued above, ou should have some + output that looks like this: + <programlisting> +-------------------+ | Tables in bugs | +-------------------+ @@ -213,14 +169,13 @@ like this: | profiles | | profiles_activity | | shadowlog | +| tokens | | versions | | votes | | watch | +-------------------+ - - - If it doesn't look quite the same, that probably means it's time to -update this documentation :) + </programlisting></para> +<literallayout> Here's an overview of what each table does. Most columns in each table have descriptive names that make it fairly trivial to figure out their jobs. @@ -398,23 +353,36 @@ LINKS Great MySQL tutorial site: http://www.devshed.com/Server_Side/MySQL/ - </LITERALLAYOUT> - </SECTION> - - <SECTION id="granttables"> - <TITLE>MySQL Permissions & Grant Tables</TITLE> - - <NOTE> - <PARA>The following portion of documentation comes from my answer to an old discussion of Keystone, - a cool product that does trouble-ticket tracking for IT departments. I wrote this post to the - Keystone support group regarding MySQL grant table permissions, and how to use them effectively. - It is badly in need of updating, as I believe MySQL has added a field or two to the grant tables - since this time, but it serves as a decent introduction and troubleshooting document for grant - table issues. I used Keynote to track my troubles until I discovered Bugzilla, - which gave me a whole new set of troubles to work on : )</PARA> - </NOTE> - - <LITERALLAYOUT> + </literallayout> + </section> + </section> + </section> + + <section id="granttables"> + <title>MySQL Permissions & Grant Tables</title> + + <note> + <para>The following portion of documentation comes from my + answer to an old discussion of Keystone, a cool product that + does trouble-ticket tracking for IT departments. I wrote this + post to the Keystone support group regarding MySQL grant + table permissions, and how to use them effectively. It is + badly in need of updating, as I believe MySQL has added a + field or two to the grant tables since this time, but it + serves as a decent introduction and troubleshooting document + for grant table issues. I used Keynote to track my troubles + until I discovered Bugzilla, which gave me a whole new set of + troubles to work on : ) Although it is of limited use, it + still has SOME use, thus it's still included.</para> + <para> + Please note, however, that I was a relatively new user to + MySQL at the time. Some of my suggestions, particularly in + how to set up security, showed a terrible lack of + security-related database experience. + </para> + </note> + + <literallayout> From matt_barnson@singletrac.com Wed Jul 7 09:00:07 1999 Date: Mon, 1 Mar 1999 21:37:04 -0700 From: Matthew Barnson matt_barnson@singletrac.com @@ -577,59 +545,28 @@ Once again, you can't go wrong by reading section 6 of the MySQL manual. It is more detailed than I! http://www.mysql.com/Manual/manual.html. ----------------------------------------------------------------------------- -10/12/2000 -Matthew sent in some mail with updated contact information: -NEW CONTACT INFORMATION: - - ------------------------ - Matthew P. Barnson - Manager, Systems Administration - Excite@Home Business Applications - mbarnson@excitehome.net - (801)234-8300 - - - </LITERALLAYOUT> - </SECTION> - <SECTION id="cleanupwork"> - <TITLE>Cleaning up after mucking with Bugzilla</TITLE> - <LITERALLAYOUT> -Contributed by Eric Hanson: -There are several things, and one trick. There is a small tiny piece of -documentation I saw once that said something very important. -1) After pretty much any manual working of the Mysql db, you must -delete a file in the bugzilla directory: data/versioncache -Versioncache basically is a way to speed up bugzilla (from what I -understand). It stores a lot of commonly used information. However, -this file is refreshed every so often (I can't remember the time -interval though). So eventually all changes do propogate out, so you -may see stuff suddenly working. -2) Assuming that failed, you will also have to check something with the -checksetup.pl file. It actually is run twice. The first time it -creates the file: localconfig. You can modify localconfig, (or not if -you are doing bug_status stuff) or you should delete localconfig and -rerun your modified checksetup.pl. Since I don't actually see anything -in localconfig pertaining to bug_status, this point is mainly a FYI. - </LITERALLAYOUT> - </SECTION> - -</APPENDIX> + </literallayout> + </section> + +</appendix> <!-- Keep this comment at the end of the file Local variables: mode: sgml -sgml-omittag:t -sgml-shorttag:t -sgml-namecase-general:t -sgml-general-insert-case:upper -sgml-minimize-attributes:nil sgml-always-quote-attributes:t -sgml-indent-step:2 -sgml-indent-data:t -sgml-parent-document:nil +sgml-auto-insert-required-elements:t +sgml-balanced-tag-edit:t sgml-exposed-tags:nil +sgml-general-insert-case:lower +sgml-indent-data:t +sgml-indent-step:2 sgml-local-catalogs:nil sgml-local-ecat-files:nil +sgml-minimize-attributes:nil +sgml-namecase-general:t +sgml-omittag:t +sgml-parent-document:("Bugzilla-Guide.sgml" "book" "chapter") +sgml-shorttag:t +sgml-tag-region-if-active:t End: --> diff --git a/docs/sgml/dbschema.mysql b/docs/sgml/dbschema.mysql new file mode 100644 index 000000000..c75c4caa4 --- /dev/null +++ b/docs/sgml/dbschema.mysql @@ -0,0 +1,309 @@ +# MySQL dump 7.1 +# +# Host: localhost Database: bugs +#-------------------------------------------------------- +# Server version 3.22.32 + +# +# Table structure for table 'attachments' +# +CREATE TABLE attachments ( + attach_id mediumint(9) DEFAULT '0' NOT NULL auto_increment, + bug_id mediumint(9) DEFAULT '0' NOT NULL, + creation_ts timestamp(14), + description mediumtext NOT NULL, + mimetype mediumtext NOT NULL, + ispatch tinyint(4), + filename mediumtext NOT NULL, + thedata longblob NOT NULL, + submitter_id mediumint(9) DEFAULT '0' NOT NULL, + PRIMARY KEY (attach_id) +); +create index index_41 on attachments (bug_id); +create index index_42 on attachments (creation_ts); + +# +# Table structure for table 'bugs' +# +CREATE TABLE bugs ( + bug_id mediumint(9) DEFAULT '0' NOT NULL auto_increment, + groupset bigint(20) DEFAULT '0' NOT NULL, + assigned_to mediumint(9) DEFAULT '0' NOT NULL, + bug_file_loc text, + bug_severity enum DEFAULT 'blocker' NOT NULL, + bug_status enum DEFAULT 'UNCONFIRMED' NOT NULL, + creation_ts datetime DEFAULT '0000-00-00 00:00:00' NOT NULL, + delta_ts timestamp(14), + short_desc mediumtext, + op_sys enum DEFAULT 'All' NOT NULL, + priority enum DEFAULT 'P1' NOT NULL, + product varchar(64) DEFAULT '' NOT NULL, + rep_platform enum, + reporter mediumint(9) DEFAULT '0' NOT NULL, + version varchar(16) DEFAULT '' NOT NULL, + component varchar(50) DEFAULT '' NOT NULL, + resolution enum DEFAULT '' NOT NULL, + target_milestone varchar(20) DEFAULT '---' NOT NULL, + qa_contact mediumint(9) DEFAULT '0' NOT NULL, + status_whiteboard mediumtext NOT NULL, + votes mediumint(9) DEFAULT '0' NOT NULL, + keywords mediumtext NOT NULL, + lastdiffed datetime DEFAULT '0000-00-00 00:00:00' NOT NULL, + everconfirmed tinyint(4) DEFAULT '0' NOT NULL, + PRIMARY KEY (bug_id) +); +create index index_7 on bugs (assigned_to); +create index index_8 on bugs (creation_ts); +create index index_9 on bugs (delta_ts); +create index index_10 on bugs (bug_severity); +create index index_11 on bugs (bug_status); +create index index_12 on bugs (op_sys); +create index index_13 on bugs (priority); +create index index_14 on bugs (product); +create index index_15 on bugs (reporter); +create index index_16 on bugs (version); +create index index_17 on bugs (component); +create index index_18 on bugs (resolution); +create index index_19 on bugs (target_milestone); +create index index_20 on bugs (qa_contact); +create index index_21 on bugs (votes); + +# +# Table structure for table 'bugs_activity' +# +CREATE TABLE bugs_activity ( + bug_id mediumint(9) DEFAULT '0' NOT NULL, + who mediumint(9) DEFAULT '0' NOT NULL, + bug_when datetime DEFAULT '0000-00-00 00:00:00' NOT NULL, + fieldid mediumint(9) DEFAULT '0' NOT NULL, + oldvalue tinytext, + newvalue tinytext +); +create index index_43 on bugs_activity (bug_id); +create index index_44 on bugs_activity (bug_when); +create index index_45 on bugs_activity (fieldid); + +# +# Table structure for table 'cc' +# +CREATE TABLE cc ( + bug_id mediumint(9) DEFAULT '0' NOT NULL, + who mediumint(9) DEFAULT '0' NOT NULL +); +create index index_31 on cc (who); +create unique index index_32 on cc (bug_id,who); + +# +# Table structure for table 'components' +# +CREATE TABLE components ( + value tinytext, + program varchar(64), + initialowner tinytext NOT NULL, + initialqacontact tinytext NOT NULL, + description mediumtext NOT NULL +); + +# +# Table structure for table 'dependencies' +# +CREATE TABLE dependencies ( + blocked mediumint(9) DEFAULT '0' NOT NULL, + dependson mediumint(9) DEFAULT '0' NOT NULL +); +create index index_34 on dependencies (blocked); +create index index_35 on dependencies (dependson); + +# +# Table structure for table 'duplicates' +# +CREATE TABLE duplicates ( + dupe_of mediumint(9) DEFAULT '0' NOT NULL, + dupe mediumint(9) DEFAULT '0' NOT NULL, + PRIMARY KEY (dupe) +); + +# +# Table structure for table 'fielddefs' +# +CREATE TABLE fielddefs ( + fieldid mediumint(9) DEFAULT '0' NOT NULL auto_increment, + name varchar(64) DEFAULT '' NOT NULL, + description mediumtext NOT NULL, + mailhead tinyint(4) DEFAULT '0' NOT NULL, + sortkey smallint(6) DEFAULT '0' NOT NULL, + PRIMARY KEY (fieldid) +); +create unique index index_28 on fielddefs (name); +create index index_29 on fielddefs (sortkey); + +# +# Table structure for table 'groups' +# +CREATE TABLE groups ( + bit bigint(20) DEFAULT '0' NOT NULL, + name varchar(255) DEFAULT '' NOT NULL, + description text NOT NULL, + isbuggroup tinyint(4) DEFAULT '0' NOT NULL, + userregexp tinytext NOT NULL +); +create unique index index_3 on groups (bit); +create unique index index_4 on groups (name); + +# +# Table structure for table 'keyworddefs' +# +CREATE TABLE keyworddefs ( + id smallint(6) DEFAULT '0' NOT NULL, + name varchar(64) DEFAULT '' NOT NULL, + description mediumtext, + PRIMARY KEY (id) +); +create unique index index_33 on keyworddefs (name); + +# +# Table structure for table 'keywords' +# +CREATE TABLE keywords ( + bug_id mediumint(9) DEFAULT '0' NOT NULL, + keywordid smallint(6) DEFAULT '0' NOT NULL +); +create index index_39 on keywords (keywordid); +create unique index index_40 on keywords (bug_id, keywordid); + +# +# Table structure for table 'logincookies' +# +CREATE TABLE logincookies ( + cookie mediumint(9) DEFAULT '0' NOT NULL auto_increment, + userid mediumint(9) DEFAULT '0' NOT NULL, + cryptpassword varchar(64), + hostname varchar(128), + lastused timestamp(14), + PRIMARY KEY (cookie) +); +create index index_30 on logincookies (lastused); + +# +# Table structure for table 'longdescs' +# +CREATE TABLE longdescs ( + bug_id mediumint(9) DEFAULT '0' NOT NULL, + who mediumint(9) DEFAULT '0' NOT NULL, + bug_when datetime DEFAULT '0000-00-00 00:00:00' NOT NULL, + thetext mediumtext +); +create index index_22 on longdescs (bug_id); +create index index_23 on longdescs (bug_when); + +# +# Table structure for table 'milestones' +# +CREATE TABLE milestones ( + value varchar(20) DEFAULT '' NOT NULL, + product varchar(64) DEFAULT '' NOT NULL, + sortkey smallint(6) DEFAULT '0' NOT NULL, +); +create unique index index_24 on milestones (product, value); + +# +# Table structure for table 'namedqueries' +# +CREATE TABLE namedqueries ( + userid mediumint(9) DEFAULT '0' NOT NULL, + name varchar(64) DEFAULT '' NOT NULL, + watchfordiffs tinyint(4) DEFAULT '0' NOT NULL, + linkinfooter tinyint(4) DEFAULT '0' NOT NULL, + query mediumtext NOT NULL +); +create unique index index_25 on namedqueries (userid, name); +create index index_26 on namedqueries (watchfordiffs); + +# +# Table structure for table 'products' +# +CREATE TABLE products ( + product varchar(64), + description mediumtext, + milestoneurl tinytext NOT NULL, + disallownew tinyint(4) DEFAULT '0' NOT NULL, + votesperuser smallint(6) DEFAULT '0' NOT NULL, + maxvotesperbug smallint(6) DEFAULT '10000' NOT NULL, + votestoconfirm smallint(6) DEFAULT '0' NOT NULL, + defaultmilestone varchar(20) DEFAULT '---' NOT NULL +); + +# +# Table structure for table 'profiles' +# +CREATE TABLE profiles ( + userid mediumint(9) DEFAULT '0' NOT NULL auto_increment, + login_name varchar(255) DEFAULT '' NOT NULL, + password varchar(16), + cryptpassword varchar(64), + realname varchar(255), + groupset bigint(20) DEFAULT '0' NOT NULL, + emailnotification enum DEFAULT 'ExcludeSelfChanges' NOT NULL, + disabledtext mediumtext NOT NULL, + newemailtech tinyint(4) DEFAULT '0' NOT NULL, + mybugslink tinyint(4) DEFAULT '1' NOT NULL, + blessgroupset bigint(20) DEFAULT '0' NOT NULL, + PRIMARY KEY (userid) +); +create unique index index_27 on profiles (login_name); + +# +# Table structure for table 'profiles_activity' +# +CREATE TABLE profiles_activity ( + userid mediumint(9) DEFAULT '0' NOT NULL, + who mediumint(9) DEFAULT '0' NOT NULL, + profiles_when datetime DEFAULT '0000-00-00 00:00:00' NOT NULL, + fieldid mediumint(9) DEFAULT '0' NOT NULL, + oldvalue tinytext, + newvalue tinytext +); +create index index_0 on profiles_activity (userid); +create index index_1 on profiles_activity (profiles_when); +create index index_2 on profiles_activity (fieldid); + +# +# Table structure for table 'shadowlog' +# +CREATE TABLE shadowlog ( + id int(11) DEFAULT '0' NOT NULL auto_increment, + ts timestamp(14), + reflected tinyint(4) DEFAULT '0' NOT NULL, + command mediumtext NOT NULL, + PRIMARY KEY (id) +); +create index index_38 on shadowlog (reflected); + +# +# Table structure for table 'versions' +# +CREATE TABLE versions ( + value tinytext, + program varchar(64) DEFAULT '' NOT NULL +); + +# +# Table structure for table 'votes' +# +CREATE TABLE votes ( + who mediumint(9) DEFAULT '0' NOT NULL, + bug_id mediumint(9) DEFAULT '0' NOT NULL, + count smallint(6) DEFAULT '0' NOT NULL +); +create index index_5 on votes (who); +create index index_6 on votes (bug_id); + +# +# Table structure for table 'watch' +# +CREATE TABLE watch ( + watcher mediumint(9) DEFAULT '0' NOT NULL, + watched mediumint(9) DEFAULT '0' NOT NULL +); +create index index_36 on watch (watched); +create unique index index_37 on watch (watcher, watched); diff --git a/docs/sgml/dbschema.ps b/docs/sgml/dbschema.ps new file mode 100644 index 000000000..8952a6834 --- /dev/null +++ b/docs/sgml/dbschema.ps @@ -0,0 +1,1733 @@ +%-12345X@PJL JOB +@PJL ENTER LANGUAGE = POSTSCRIPT +
+%!PS-Adobe-3.0
+%%Title: PDM Model_7 - I:\DATA\SDESI
+%%Creator: PSCRIPT.DRV Version 4.0
+%%CreationDate: 12/06/00 23:59:39
+%%BoundingBox: 12 13 601 779
+%%Pages: (atend)
+%%PageOrder: Special
+%%Requirements:
+%%DocumentNeededFonts: (atend)
+%%DocumentSuppliedFonts: (atend)
+%%DocumentData: Clean7Bit
+%%LanguageLevel: 2
+%%EndComments
+
+%%BeginProlog
+%%BeginProcSet: Pscript_Win_ErrorHandler 1.0 1
+/currentpacking where{pop/oldpack currentpacking def/setpacking where{pop
+false setpacking}if}if/$brkpage 64 dict def $brkpage begin/prnt{dup type
+/stringtype ne{=string cvs}if dup length 6 mul/tx exch def/ty 10 def
+currentpoint/toy exch def/tox exch def 1 setgray newpath tox toy 2 sub moveto
+0 ty rlineto tx 0 rlineto 0 ty neg rlineto closepath fill tox toy moveto 0
+setgray show}bind def/nl{currentpoint exch pop lmargin exch moveto 0 -10
+rmoveto}def/=={/cp 0 def typeprint nl}def/typeprint{dup type exec}readonly def
+/lmargin 72 def/rmargin 72 def/tprint{dup length cp add rmargin gt{nl/cp 0 def
+}if dup length cp add/cp exch def prnt}readonly def/cvsprint{=string cvs
+tprint( )tprint}readonly def/integertype{cvsprint}readonly def/realtype{
+cvsprint}readonly def/booleantype{cvsprint}readonly def/operatortype{(--)
+tprint =string cvs tprint(-- )tprint}readonly def/marktype{pop(-mark- )tprint}
+readonly def/dicttype{pop(-dictionary- )tprint}readonly def/nulltype{pop
+(-null- )tprint}readonly def/filetype{pop(-filestream- )tprint}readonly def
+/savetype{pop(-savelevel- )tprint}readonly def/fonttype{pop(-fontid- )tprint}
+readonly def/nametype{dup xcheck not{(/)tprint}if cvsprint}readonly def
+/stringtype{dup rcheck{(\()tprint tprint(\))tprint}{pop(-string- )tprint}
+ifelse}readonly def/arraytype{dup rcheck{dup xcheck{({)tprint{typeprint}forall
+(})tprint}{([)tprint{typeprint}forall(])tprint}ifelse}{pop(-array- )tprint}
+ifelse}readonly def/packedarraytype{dup rcheck{dup xcheck{({)tprint{typeprint}
+forall(})tprint}{([)tprint{typeprint}forall(])tprint}ifelse}{pop
+(-packedarray- )tprint}ifelse}readonly def/courier/Courier findfont 10
+scalefont def end errordict/handleerror{systemdict begin $error begin $brkpage
+begin newerror{/newerror false store vmstatus pop pop 0 ne{grestoreall}if
+showpage initgraphics courier setfont lmargin 720 moveto(ERROR: )prnt
+errorname prnt nl(OFFENDING COMMAND: )prnt/command load prnt $error/ostack
+known{nl nl(STACK:)prnt nl nl $error/ostack get aload length{==}repeat}if
+systemdict/showpage get exec(%%[ Error: )print errorname =print
+(; OffendingCommand: )print/command load =print( ]%%)= flush}if end end end}
+dup 0 systemdict put dup 4 $brkpage put bind readonly put/currentpacking where
+{pop/setpacking where{pop oldpack setpacking}if}if
+%%EndProcSet
+userdict /Pscript_Win_Driver_Incr 200 dict dup begin put
+%%BeginResource: file Pscript_FatalError 2.0 0
+/FatalErrorIf{{initgraphics findfont exch scalefont setfont counttomark 3 div
+cvi{moveto show}repeat showpage quit}{cleartomark}ifelse}bind def
+%%EndResource
+/VM? {vmstatus exch sub exch pop gt { [
+(This job requires more memory than is available in this printer.) 100 500
+(Try one or more of the following, and then print again:) 100 485
+(In the PostScript dialog box, click Optimize For Portability.) 115 470
+(In the Device Options dialog box, make sure the Available Printer Memory is accurate.) 115 455
+(Reduce the number of fonts in the document.) 115 440
+(Print the document in parts.) 115 425
+12 /Times-Roman showpage
+(%%[ PrinterError: Low Printer VM ]%%) =
+true FatalErrorIf}if} bind def
+30000 VM?
+%%BeginResource: file Pscript_Win_Utils 2.0 0
+/|/def load def/,/load load |/~/exch , |/?/ifelse , |/!/pop , |/`/begin , |/^
+/index , |/@/dup , |/+/translate , |/$/roll , |/U/userdict , |/M/moveto , |/-
+/rlineto , |/&/currentdict , |/:/gsave , |/;/grestore , |/F/false , |/T/true ,
+|/N/newpath , |/E/end , |/Ac/arc , |/An/arcn , |/A/ashow , |/D/awidthshow , |
+/C/closepath , |/V/div , |/O/eofill , |/L/fill , |/I/lineto , |/-C/rcurveto ,
+|/-M/rmoveto , |/+S/scale , |/Ji/setfont , |/Lc/setlinecap , |/Lj/setlinejoin
+, |/Lw/setlinewidth , |/S/show , |/LH/showpage , |/K/stroke , |/W/widthshow ,
+|/R/rotate , |/b{bind |}bind |/bd{bind |}bind |/xd{~ |}bd/ld{, |}bd/lw/Lw ld
+/lc/Lc ld/lj/Lj ld/sg/setgray ld/L2? F/languagelevel where{! languagelevel 2
+ge{! T}if}if |/g{@ not{U/DefIf_save save put}if U/DefIf_bool 2 ^ put}b
+/DefIf_El{if U/DefIf_bool get not @{U/DefIf_save get restore}if}b/e{DefIf_El !
+}b/self & |/reinitialize{[/TextInit/GraphInit/UtilsInit counttomark{@ where{
+self eq}{F}?{cvx exec}{!}?}repeat cleartomark}b/initialize{`{/ADO_mxRot ~ |
+/TextInitialised? F | reinitialize E}{U/Pscript_Win_Data 200 dict @ ` put
+/ADO_mxRot ~ |/TextInitialised? F | reinitialize}?}b/terminate{!{& self eq{
+exit}{E}?}loop E}b/suspend/terminate , |/resume{` Pscript_Win_Data `}b/snap{
+transform 0.25 sub round 0.25 add ~ 0.25 sub round 0.25 add ~ itransform}b
+/dsnap{dtransform round ~ round ~ idtransform}b<04>cvn{}|/setjn{{statusdict
+/jobname known{statusdict/jobname 3 -1 $ put}if}stopped cleartomark}b/solid{[]
+0 setdash}b/setdsh{0 setdash}b/colspRefresh{}b/rp{4 2 $ M 1 ^ 0 - 0 ~ - neg 0
+-}b/rr{1 ^ 0 - 0 ~ - neg 0 - C}b
+%%EndResource
+%%BeginResource: file Pscript_Win_Utils_L1 2.0 0
+L2? not g{/rf{N rp L}b/fx{1 1 dtransform @ 0 ge{1 sub 1}{1 add -0.25}? 3 -1 $
+@ 0 ge{1 sub 1}{1 add -0.25}? 3 1 $ 4 1 $ idtransform 4 -2 $ idtransform}b/BZ{
+4 -2 $ snap + +S fx rf}b/rs{N rp C K}b/rc{N rp clip N}b/sg{setgray}b/sco{
+setrgbcolor}b/sgco{{sg}{sco}?}b}e
+%%EndResource
+%%BeginResource: file Pscript_Win_Utils_L2 2.0 0
+L2? g{/colspA/DeviceGray |/colspABC/DeviceRGB |/setAorABC{{colspA}{colspABC}?
+setcolorspace}b/rf/rectfill , |/fx{1 1 dtransform @ 0 ge{1 sub 0.5}{1 add -0.5
+}? 3 -1 $ @ 0 ge{1 sub 0.5}{1 add -0.5}? 3 1 $ 4 1 $ idtransform 4 -2 $
+idtransform}b/BZ{4 -2 $ snap + +S fx rf}b/rs/rectstroke , |/rc/rectclip , |/sg
+{@ @ setcolor}b/sco{setcolor}b/colspRefresh{colspABC setcolorspace}b/sgco{{sg
+}{sco}?}b/UtilsInit{F setglobal}b/definecolorrendering{/ColorRendering
+defineresource !}b/findcolorrendering{@/ColorRendering resourcestatus{! !
+/ColorRendering findresource T}{! F}?}b/selectcolorrendering{@/ColorRendering
+resourcestatus{! !/ColorRendering}{!/DefaultColorRendering/ColorRendering}?
+findresource setcolorrendering}b}e
+%%EndResource
+end
+%%EndProlog
+
+%%BeginSetup
+[ 1.000 0 0 1.000 0 0 ] false Pscript_Win_Driver_Incr dup /initialize get exec
+
+[{0
+/languagelevel where{pop languagelevel}{1}ifelse 2 ge{1 dict dup/JobTimeout 4 -1 roll put setuserparams}{statusdict/setjobtimeout get exec}ifelse
+} stopped cleartomark
+[{240
+/languagelevel where{pop languagelevel}{1}ifelse 2 ge{1 dict dup/WaitTimeout 4 -1 roll put setuserparams}{statusdict/waittimeout 3 -1 roll put}ifelse
+} stopped cleartomark
+[{
+%%BeginFeature: *Print as Grayscale No
+
+ <</ProcessColorModel /DeviceRGB>> setpagedevice
+%%EndFeature
+} stopped cleartomark
+[{
+
+} stopped cleartomark
+[{
+%%BeginFeature: *InputSlot AutoSelect Tray
+
+%%EndFeature
+} stopped cleartomark
+[{
+%%BeginFeature: *PageSize Letter
+
+ <</DeferredMediaSelection true>> setpagedevice
+ 2 dict dup /PageSize [612 792] put dup /ImagingBBox null put setpagedevice
+%%EndFeature
+} stopped cleartomark
+[{
+%%BeginFeature: *ColorSmart Text Vivid Color
+
+ globaldict /ColorSmartColorMatching known
+ { true ColorSmartColorMatching } if
+ globaldict /ColorSmartColorMatching known
+ { Vivid ColorSmartTextAdjustment } if
+
+%%EndFeature
+} stopped cleartomark
+[{
+%%BeginFeature: *ColorSmart Graphics Vivid Color
+
+ globaldict /ColorSmartColorMatching known
+ { Vivid ColorSmartGraphicsAdjustment } if
+
+%%EndFeature
+} stopped cleartomark
+[{
+%%BeginFeature: *ColorSmart Photos Match Color Across Printers
+
+ globaldict /ColorSmartColorMatching known
+ { MatchScreen ColorSmartImageAdjustment } if
+
+%%EndFeature
+} stopped cleartomark
+[{
+%%BeginFeature: *Text Halftone Detail
+
+ globaldict /ColorSmartColorMatching known
+ { Detail ColorSmartTextHalftone } if
+
+%%EndFeature
+} stopped cleartomark
+[{
+%%BeginFeature: *Graphics Halftone Smooth
+
+ globaldict /ColorSmartColorMatching known
+ { Smooth ColorSmartGraphicsHalftone } if
+
+%%EndFeature
+} stopped cleartomark
+[{
+%%BeginFeature: *Image Halftone Smooth
+
+ globaldict /ColorSmartColorMatching known
+ { Smooth ColorSmartImageHalftone } if
+
+%%EndFeature
+} stopped cleartomark
+[{
+%%BeginFeature: *ColorSmart Auto
+
+ globaldict /ColorSmartColorMatching known
+ { Vivid ColorSmartTextAdjustment } if
+ globaldict /ColorSmartColorMatching known
+ { Vivid ColorSmartGraphicsAdjustment } if
+ globaldict /ColorSmartColorMatching known
+ { MatchScreen ColorSmartImageAdjustment } if
+ globaldict /ColorSmartColorMatching known
+ { Detail ColorSmartTextHalftone } if
+ globaldict /ColorSmartColorMatching known
+ { Smooth ColorSmartGraphicsHalftone } if
+ globaldict /ColorSmartColorMatching known
+ { Smooth ColorSmartImageHalftone } if
+ /setscreen { pop pop pop } def
+ /setcolorscreen { pop pop pop pop pop pop pop pop pop pop pop pop } def
+ globaldict /ColorSmartColorMatching known
+ {true ColorSmartColorMatching } if
+
+%%EndFeature
+} stopped cleartomark
+[{
+%%BeginFeature: *OutputBin Upper
+1 dict dup /OutputFaceUp false put setpagedevice
+%%EndFeature
+} stopped cleartomark
+[{
+%%BeginFeature: *MediaType Plain Paper
+
+%%EndFeature
+} stopped cleartomark
+1 setlinecap 1 setlinejoin
+/mysetup [ 0.240 0 0 -0.240 12.000 779.000 ] |
+%%EndSetup
+
+userdict begin /savelevel0 save def end
+%%Page: 1 1
+%%BeginPageSetup
+[{
+%%BeginFeature: *Rear Feed Unit Not Installed
+
+%%EndFeature
+} stopped cleartomark
+[{
+%%BeginFeature: *VMOption 36 - 43 MB RAM
+
+%%EndFeature
+} stopped cleartomark
+[{
+%%BeginFeature: *Resolution 300dpi
+
+%%EndFeature
+} stopped cleartomark
+[{
+%%BeginFeature: *Duplex
+
+%%EndFeature
+} stopped cleartomark
+userdict begin /pagesave save def end mysetup concat colspRefresh : 1.000 1.000 1.000 sco 0 0 2550 3300 rf ;
+%%EndPageSetup
+
+: 0 0 2454 3191 rc pagesave restore
+Pscript_Win_Driver_Incr begin
+%%BeginResource: file Pscript_Win_Graphics 2.0 0
+/SavedCTM null |/CTMsave{/SavedCTM SavedCTM currentmatrix |}b/CTMrestore{
+SavedCTM setmatrix}b/mp null |/ADO_mxRot null |/GDIHMatrix null |
+/GDIHPatternDict 22 dict | GDIHPatternDict `/PatternType 1 |/PaintType 2 |
+/Reps L2?{1}{5}? |/XStep 8 Reps mul |/YStep XStep |/BBox[0 0 XStep YStep]|
+/TilingType 1 |/PaintProc{` 1 Lw[]0 setdash PaintData , exec E}b/FGnd null |
+/BGnd null |/HS_Horizontal{horiz}b/HS_Vertical{vert}b/HS_FDiagonal{fdiag}b
+/HS_BDiagonal{biag}b/HS_Cross{horiz vert}b/HS_DiagCross{fdiag biag}b/MaxXYStep
+XStep YStep gt{XStep}{YStep}? |/horiz{Reps{0 4 M XStep 0 - 0 8 +}repeat 0 -8
+Reps mul + K}b/vert{Reps{4 0 M 0 YStep - 8 0 +}repeat 0 -8 Reps mul + K}b/biag
+{Reps{0 0 M MaxXYStep @ - 0 YStep neg M MaxXYStep @ - 0 8 +}repeat 0 -8 Reps
+mul + 0 YStep M 8 8 - K}b/fdiag{Reps{0 0 M MaxXYStep @ neg - 0 YStep M
+MaxXYStep @ neg - 0 8 +}repeat 0 -8 Reps mul + MaxXYStep @ M 8 -8 - K}b E
+/makehatch{GDIHPatternDict/PaintData 3 -1 $ put CTMsave GDIHMatrix setmatrix
+GDIHPatternDict matrix mp CTMrestore ~ U ~ 2 ^ put}b/h0{/h0/HS_Horizontal
+makehatch}b/h1{/h1/HS_Vertical makehatch}b/h2{/h2/HS_FDiagonal makehatch}b/h3{
+/h3/HS_BDiagonal makehatch}b/h4{/h4/HS_Cross makehatch}b/h5{/h5/HS_DiagCross
+makehatch}b/GDIBWPatternDict 17 dict @ `/PatternType 1 |/PaintType L2?{1}{2}?
+|/RepsV L2?{1}{6}? |/RepsH L2?{1}{5}? |/BBox[0 0 RepsH 1]|/TilingType 1 |
+/XStep 1 |/YStep 1 |/Height 8 RepsV mul |/Width 8 |/mx[Width 0 0 Height neg 0
+Height]|/FGnd null |/BGnd null |/SetBGndFGnd L2?{{BGnd null ne{BGnd aload !
+sgco BBox aload ! 2 ^ sub ~ 3 ^ sub ~ rf}if FGnd null ne{FGnd aload ! sgco}if}
+}{{}}? b/PaintProc{` SetBGndFGnd RepsH{Width Height F mx PaintData imagemask
+Width 0 +}repeat E}b E |/GDIBWPatternMx null |/pfprep{save 4 1 $
+/PatternOfTheDay 4 1 $ GDIBWPatternDict `/PaintData ~ |/BGnd ~ |/FGnd ~ | E
+CTMsave GDIBWPatternMx setmatrix GDIBWPatternDict matrix mp CTMrestore ~ !}b
+/hrf null |/prf{pfprep ~ 6 1 $ 5 hrf restore}b/GraphInit{GDIHMatrix null eq{
+/SavedCTM matrix | : ADO_mxRot concat 0 0 snap + : 0.48 @ GDIHPatternDict `
+YStep mul ~ XStep mul ~ dsnap YStep V ~ XStep V ~ E +S/GDIHMatrix matrix
+currentmatrix readonly | ; : 0.24 -0.24 +S GDIBWPatternDict ` Width Height E
+dsnap +S/GDIBWPatternMx matrix currentmatrix readonly | ; ;}if}b/cirp{360 0 An
+C}b/ellp{CTMsave + +S 0.5 0 M 0 0 0.5 360 0 An C CTMrestore}b/rrp{/rad ~ |/y2
+~ |/x2 ~ |/y1 ~ |/x1 ~ | x2 x1 add 2 V y1 M x1 y1 x1 y2 rad arct x1 y2 x2 y2
+rad arct x2 y2 x2 y1 rad arct x2 y1 x1 y1 rad arct C}b/RRp{CTMsave + +S/dyS ~
+|/dxS ~ | dxS 2 V 0 M 0 0 0 dyS 0.5 arct 0 dyS dxS dyS 0.5 arct dxS dyS dxS 0
+0.5 arct dxS 0 0 0 0.5 arct C CTMrestore}b
+%%EndResource
+
+%%BeginResource: file Pscript_Win_Graphics_L1 2.0 0
+L2? not g{/arct{arcto ! ! ! !}b/GDIpattfill{@ ` BGnd null ne PaintType 2 eq
+and{: BGnd aload ! sgco fEOFill{O}{L}? ; FGnd aload ! U/fGray 2 ^ put{2}{4}?
+-1 $}if E @ patterncalc : 4 ^/PaintType get 2 eq{fGray{6 -1 $ sg}{8 -3 $ sco}?
+}if fEOFill{eoclip}{clip}? N patternfill ; N}b/hrf{/fGray 1 ^ 6 eq | -4 $ N rp
+C/fEOFill F | GDIpattfill}b/hfMain{/fEOFill ~ |/fGray ~ | GDIpattfill}b/hf{T
+hfMain}b/hfW{F hfMain}b/hs{currentpoint strokepath M hfW}b/pfMain{/fEOFill ~ |
+pfprep GDIpattfill restore N}b/pf{T pfMain}b/pfW{F pfMain}b/ps{currentpoint
+strokepath M pfW}b/mpstr 1 string |/mp{~ @ length 12 add dict copy `
+/PatternCTM matrix currentmatrix |/PatternMatrix ~ |/PatWidth XStep mpstr
+length mul |/PatHeight YStep |/FontType 3 |/Encoding 256 array | 3 string 0 1
+255{Encoding ~ @ 3 ^ cvs cvn put}for !/FontMatrix matrix |/FontBBox BBox |
+/BuildChar{! @ ` XStep 0 FontBBox aload ! setcachedevice/PaintProc , E : exec
+;}b & E ~ @ 3 -1 $ definefont}b/patterncalc{` : PatternCTM setmatrix
+PatternMatrix concat BBox aload ! ! ! + pathbbox ; PatHeight V ceiling 4 1 $
+PatWidth V ceiling 4 1 $ PatHeight V floor 4 1 $ PatWidth V floor 4 1 $ 2 ^
+sub cvi abs ~ 3 ^ sub cvi abs ~ 4 2 $ PatHeight mul ~ PatWidth mul ~ E}b
+/patternfill{5 -1 $ @ ` Ji PatternCTM setmatrix PatternMatrix concat 0 2 ^ 2 ^
+M 0 1 mpstr length 1 sub{1 ^ mpstr 3 1 $ put}for ! 2 ^{currentpoint 5 ^{mpstr
+S}repeat YStep add M}repeat ! ! ! ! E}b}e
+%%EndResource
+
+%%BeginResource: file Pscript_Win_Graphics_L2 2.0 0
+L2? g{/mp/makepattern , |/hrf{6 eq setAorABC setpattern rectfill}b/hf{
+setAorABC setpattern O}b/hfW{setAorABC setpattern L}b/hs{setAorABC setpattern
+K}b/pf{pfprep setpattern O restore N}b/pfW{pfprep setpattern L restore N}b/ps{
+pfprep setpattern K restore N}b}e
+%%EndResource
+
+end reinitialize
+userdict begin /pagesave save def end mysetup concat colspRefresh
+: 0 0 0 sco 1 Lc 1 Lj solid 0 0 2454 3191 rc
+1989 1646 N M 0 -419 - 1 Lw solid 0 0 0 sco K ;
+N 1968.500 1645.500 19.500 88.603 -1.397 An
+1 Lw 1 Lc 1 Lj 0 0 0 sco K : 0 0 2454 3191 rc
+1931 1666 N M 38 0 - 0 0 0 sco K ;
+N 1930.500 1685.500 19.500 -88.531 175.601 An
+0 0 0 sco K : 0 0 2454 3191 rc
+1911 2275 N M 0 -589 - 0 0 0 sco K ; : 1818 1632 636 23 rc : 1.000 1.000 1.000 sco 1872 1632 156 23 rf ; pagesave restore
+Pscript_Win_Driver_Incr begin
+%%BeginResource: file Pscript_Win_Encoding 2.0 0
+/bullets{{/bullet}repeat}b/ANSIEncoding[/grave/acute/circumflex/tilde/macron
+/breve/dotaccent/dieresis/ring/cedilla/hungarumlaut/ogonek/caron/dotlessi 18
+bullets StandardEncoding 32 95 getinterval aload ! 3 bullets/quotesinglbase
+/florin/quotedblbase/ellipsis/dagger/daggerdbl/circumflex/perthousand/Scaron
+/guilsinglleft/OE 4 bullets/quoteleft/quoteright/quotedblleft/quotedblright
+/bullet/endash/emdash/tilde/trademark/scaron/guilsinglright/oe 2 bullets
+/Ydieresis/space/exclamdown/cent/sterling/currency/yen/brokenbar/section
+/dieresis/copyright/ordfeminine/guillemotleft/logicalnot/hyphen/registered
+/macron/degree/plusminus/twosuperior/threesuperior/acute/mu/paragraph
+/periodcentered/cedilla/onesuperior/ordmasculine/guillemotright/onequarter
+/onehalf/threequarters/questiondown/Agrave/Aacute/Acircumflex/Atilde/Adieresis
+/Aring/AE/Ccedilla/Egrave/Eacute/Ecircumflex/Edieresis/Igrave/Iacute
+/Icircumflex/Idieresis/Eth/Ntilde/Ograve/Oacute/Ocircumflex/Otilde/Odieresis
+/multiply/Oslash/Ugrave/Uacute/Ucircumflex/Udieresis/Yacute/Thorn/germandbls
+/agrave/aacute/acircumflex/atilde/adieresis/aring/ae/ccedilla/egrave/eacute
+/ecircumflex/edieresis/igrave/iacute/icircumflex/idieresis/eth/ntilde/ograve
+/oacute/ocircumflex/otilde/odieresis/divide/oslash/ugrave/uacute/ucircumflex
+/udieresis/yacute/thorn/ydieresis]| ANSIEncoding @ 39/quotesingle put 96/grave
+put/ANSIEncodingOld ANSIEncoding 256 array copy | ANSIEncodingOld @[138 153
+154 169 172 174 177 178 179 181 185 188 189 190 208 215 221 222 240 247 253
+254]{/bullet put @}forall 166/bar put 176/ring put
+%%EndResource
+
+%%BeginResource: file Pscript_Win_Text 2.0 0
+/TextInit{TextInitialised? not{/Pscript_Windows_Font & |/TextInitialised? T |
+/fM[1 0 0 -1 0 0]|/mFM matrix |/iMat[1 0 0.212557 neg 1 0 0]|}if}b/xUP null |
+/yUP null |/uW null |/xSP null |/ySP null |/sW null |/copyfont{1 ^ length add
+dict `{1 ^/FID ne{|}{! !}?}forall & E}b/rF{3 copyfont @ `/Encoding
+ANSIEncoding &/CharStrings known{CharStrings/Eth known not{! ANSIEncodingOld}
+if}if | E}b/mF{findfont ~{@/Encoding get @ StandardEncoding eq{! T}{{
+ISOLatin1Encoding}stopped{! F}{eq}?{T}{@ ` T 32 1 127{Encoding 1 ^ get
+StandardEncoding 3 -1 $ get eq and}for E}?}?}{F}?{rF}{3 copyfont}? `
+/OrigFontType ~ |/OrigFontName ~ | & E 2 ^ ~ definefont fM 5 4 -1 $ put fM 4 0
+put fM makefont Pscript_Windows_Font 3 1 $ put}b/xF{scalefont
+Pscript_Windows_Font 3 1 $ put}b/xMF{mFM astore makefont Pscript_Windows_Font
+3 1 $ put}b/xF2/scalefont , |/xMF2{mFM astore makefont}b/sLT{: Lw -M
+currentpoint snap M 0 - 0 Lc K ;}b/sSU{N/uW ~ |/yUP ~ |/xUP ~ |}b/sU{xUP yUP
+uW sLT}b/sST{N/sW ~ |/ySP ~ |/xSP ~ |}b/sT{xSP ySP sW sLT}b/sR{: + R 0 0 M}b
+/sRxy{: matrix astore concat 0 0 M}b/eR/; , |
+%%EndResource
+
+end reinitialize
+userdict begin /pagesave save def end mysetup concat colspRefresh
+: 0 0 0 sco 1 Lw 1 Lc 1 Lj 1818 1632 636 23 rc 0 0 0 sco %%IncludeFont: Helvetica
+(F0) cvn
+0.950
+ (Helvetica) cvn /Type1
+T
+(Helvetica) cvn
+mF
+(F0_20) cvn
+F0
+20
+xF
+F0_20
+Ji
+1872 1632 M
+-0.012 0 (product = product)A
+;
+1989 1304 N M 7 34 - -15 0 - 8 -34 - C : 0 0 0 sco O ; 1 Lw 1 Lc 1 Lj 0 0 0 sco K : 0 0 2454 3191 rc
+2135 1050 N M -906 0 - 0 0 0 sco K ; : 1408 1060 1026 23 rc : 1.000 1.000 1.000 sco 1462 1060 164 23 rf ; 0 0 0 sco F0_20
+Ji
+1462 1060 M
+0.002 0 (product = program)A
+;
+1742 1050 N M -33 7 - 0 -15 - 33 8 - C : 0 0 0 sco O ; 0 0 0 sco K : 0 0 2454 3191 rc
+2093 1250 N M -1848 0 - 0 0 0 sco K ; : 1014 1260 1026 23 rc : 1.000 1.000 1.000 sco 1068 1260 164 23 rf ; 0 0 0 sco F0_20
+Ji
+1068 1260 M
+0.002 0 (product = program)A
+;
+1742 1250 N M -33 7 - 0 -15 - 33 8 - C : 0 0 0 sco O ; 0 0 0 sco K : 0 0 2454 3191 rc
+1798 1151 N M -946 0 - 0 0 0 sco K ; : 1204 1161 1026 23 rc : 1.000 1.000 1.000 sco 1258 1161 156 23 rf ; 0 0 0 sco F0_20
+Ji
+1258 1161 M
+-0.012 0 (product = product)A
+;
+1742 1151 N M -33 7 - 0 -15 - 33 8 - C : 0 0 0 sco O ; 0 0 0 sco K : 0 0 2454 3191 rc
+717 1719 N M 0 689 - 0 0 0 sco K ;
+N 736.500 1718.500 19.500 -88.531 175.601 An
+0 0 0 sco K : 0 0 2454 3191 rc
+864 1699 N M -127 0 - 0 0 0 sco K ;
+N 863.500 1678.500 19.500 88.603 -1.397 An
+0 0 0 sco K : 0 0 2454 3191 rc
+884 1464 N M 0 215 - 0 0 0 sco K ; : 681 1687 918 23 rc : 1.000 1.000 1.000 sco 735 1687 130 23 rf ; 0 0 0 sco F0_20
+Ji
+735 1687 M
+-0.115 0 (userid = userid)A
+;
+717 2221 N M -8 -33 - 15 0 - -7 33 - C : 0 0 0 sco O ; 0 0 0 sco K : 0 0 2454 3191 rc
+649 1684 N M 0 737 - 0 0 0 sco K ;
+N 628.500 1683.500 19.500 1.397 -91.469 An
+0 0 0 sco K : 0 0 2454 3191 rc
+334 1664 N M 295 0 - 0 0 0 sco K ; : 513 1635 918 23 rc : 1.000 1.000 1.000 sco 567 1635 130 23 rf ; 0 0 0 sco F0_20
+Ji
+567 1635 M
+-0.115 0 (userid = userid)A
+;
+649 2221 N M -8 -33 - 15 0 - -7 33 - C : 0 0 0 sco O ; 0 0 0 sco K : 0 0 2454 3191 rc
+837 1882 N M 0 378 - 0 0 0 sco K ;
+N 856.500 1881.500 19.500 -88.531 175.601 An
+0 0 0 sco K : 0 0 2454 3191 rc
+1121 1862 N M -264 0 - 0 0 0 sco K ; : 0 0 2454 3191 rc
+1467 1862 N M -346 0 - 0 0 0 sco K ; : 869 1850 756 23 rc : 1.000 1.000 1.000 sco 923 1850 113 23 rf ; 0 0 0 sco F0_20
+Ji
+923 1850 M
+-0.078 0 (userid = who)A
+;
+837 2221 N M -8 -33 - 15 0 - -7 33 - C : 0 0 0 sco O ; 0 0 0 sco K : 0 0 2454 3191 rc
+962 2267 N M -94 0 - 0 0 0 sco K ;
+N 961.500 2246.500 19.500 88.603 -1.397 An
+0 0 0 sco K : 0 0 2454 3191 rc
+982 2105 N M 0 142 - 0 0 0 sco K ;
+N 1001.500 2104.500 19.500 -88.531 175.601 An
+0 0 0 sco K : 0 0 2454 3191 rc
+1347 2085 N M -345 0 - 0 0 0 sco K ; : 872 2164 756 23 rc : 1.000 1.000 1.000 sco 926 2164 113 23 rf ; 0 0 0 sco F0_20
+Ji
+926 2164 M
+-0.078 0 (userid = who)A
+;
+872 2267 N M 33 -8 - 0 15 - -33 -7 - C : 0 0 0 sco O ; 0 0 0 sco K : 0 0 2454 3191 rc
+978 2437 N M -158 0 - 0 0 0 sco K ;
+N 977.500 2416.500 19.500 88.603 -1.397 An
+0 0 0 sco K : 0 0 2454 3191 rc
+998 2345 N M 0 72 - 0 0 0 sco K ;
+N 1017.500 2344.500 19.500 -88.531 175.601 An
+0 0 0 sco K : 0 0 2454 3191 rc
+1212 2325 N M -194 0 - 0 0 0 sco K ; : 888 2369 756 23 rc : 1.000 1.000 1.000 sco 942 2369 113 23 rf ; 0 0 0 sco F0_20
+Ji
+942 2369 M
+-0.078 0 (userid = who)A
+;
+872 2437 N M 33 -7 - 0 15 - -33 -8 - C : 0 0 0 sco O ; 0 0 0 sco K : 0 0 2454 3191 rc
+829 2672 N M 0 -152 - 0 0 0 sco K ;
+N 848.500 2671.500 19.500 178.531 85.815 An
+0 0 0 sco K : 0 0 2454 3191 rc
+1194 2692 N M -345 0 - 0 0 0 sco K ; : 700 2697 1242 23 rc : 1.000 1.000 1.000 sco 754 2697 184 23 rf ; 0 0 0 sco F0_20
+Ji
+754 2697 M
+-0.104 0 (userid = submitter_id)A
+;
+829 2620 N M 8 33 - -15 0 - 7 -33 - C : 0 0 0 sco O ; 0 0 0 sco K : 0 0 2454 3191 rc
+570 2708 N M 0 -156 - 0 0 0 sco K ;
+N 589.500 2707.500 19.500 178.531 85.815 An
+0 0 0 sco K : 0 0 2454 3191 rc
+773 2728 N M -183 0 - 0 0 0 sco K ;
+N 772.500 2747.500 19.500 1.397 -91.469 An
+0 0 0 sco K : 0 0 2454 3191 rc
+793 2836 N M 0 -88 - 0 0 0 sco K ; : 572 2716 756 23 rc : 1.000 1.000 1.000 sco 626 2716 113 23 rf ; 0 0 0 sco F0_20
+Ji
+626 2716 M
+-0.078 0 (userid = who)A
+;
+570 2620 N M 8 33 - -15 0 - 7 -33 - C : 0 0 0 sco O ; 0 0 0 sco K : 0 0 2454 3191 rc
+1554 2379 N M 690 0 - 0 0 0 sco K ;
+N 1553.500 2358.500 19.500 178.531 85.815 An
+0 0 0 sco K : 0 0 2454 3191 rc
+1534 2032 N M 0 327 - 0 0 0 sco K ; : 1427 2384 918 23 rc : 1.000 1.000 1.000 sco 1481 2384 140 23 rf ; 0 0 0 sco F0_20
+Ji
+1481 2384 M
+-0.192 0 (bug_id = bug_id)A
+;
+1826 2379 N M -33 8 - 0 -15 - 33 7 - C : 0 0 0 sco O ; 0 0 0 sco K : 0 0 2454 3191 rc
+1306 2476 N M 620 0 - 0 0 0 sco K ;
+N 1305.500 2455.500 19.500 178.531 85.815 An
+0 0 0 sco K : 0 0 2454 3191 rc
+1286 2224 N M 0 232 - 0 0 0 sco K ; : 1179 2481 918 23 rc : 1.000 1.000 1.000 sco 1233 2481 140 23 rf ; 0 0 0 sco F0_20
+Ji
+1233 2481 M
+-0.192 0 (bug_id = bug_id)A
+;
+1826 2476 N M -33 8 - 0 -15 - 33 7 - C : 0 0 0 sco O ; 0 0 0 sco K : 0 0 2454 3191 rc
+1693 2787 N M 140 0 - 0 0 0 sco K ;
+N 1692.500 2766.500 19.500 178.531 85.815 An
+0 0 0 sco K : 0 0 2454 3191 rc
+1673 2652 N M 0 115 - 0 0 0 sco K ;
+N 1652.500 2651.500 19.500 1.397 -91.469 An
+0 0 0 sco K : 0 0 2454 3191 rc
+1487 2632 N M 166 0 - 0 0 0 sco K ; : 1549 2697 905 23 rc : 1.000 1.000 1.000 sco 1603 2697 140 23 rf ; 0 0 0 sco F0_20
+Ji
+1603 2697 M
+-0.192 0 (bug_id = bug_id)A
+;
+1826 2787 N M -33 7 - 0 -15 - 33 8 - C : 0 0 0 sco O ; 0 0 0 sco K : 0 0 2454 3191 rc
+1953 2954 N M -880 0 - 0 0 0 sco K ; : 1321 2964 918 23 rc : 1.000 1.000 1.000 sco 1375 2964 140 23 rf ; 0 0 0 sco F0_20
+Ji
+1375 2964 M
+-0.192 0 (bug_id = bug_id)A
+;
+1826 2954 N M -33 8 - 0 -15 - 33 7 - C : 0 0 0 sco O ; 0 0 0 sco K : 0 0 2454 3191 rc
+326 2275 N M 314 0 - 0 0 0 sco K ;
+N 325.500 2254.500 19.500 178.531 85.815 An
+0 0 0 sco K : 0 0 2454 3191 rc
+306 1933 N M 0 322 - 0 0 0 sco K ; : 204 2280 918 23 rc : 1.000 1.000 1.000 sco 258 2280 130 23 rf ; 0 0 0 sco F0_20
+Ji
+258 2280 M
+-0.115 0 (userid = userid)A
+;
+426 2275 N M -33 7 - -1 -15 - 34 8 - C : 0 0 0 sco O ; 0 0 0 sco K : 0 0 2454 3191 rc
+224 2919 N M 0 -905 - 0 0 0 sco K ; : 107 2409 1026 23 rc : 1.000 1.000 1.000 sco 161 2409 126 23 rf ; 0 0 0 sco F0_20
+Ji
+161 2409 M
+-0.075 0 (fieldid = fieldid)A
+;
+224 2819 N M -7 -34 - 15 0 - -8 34 - C : 0 0 0 sco O ; 0 0 0 sco K : 0 0 2454 3191 rc
+360 2910 N M 573 0 - 0 0 0 sco K ; : 555 2920 1026 23 rc : 1.000 1.000 1.000 sco 609 2920 126 23 rf ; 0 0 0 sco F0_20
+Ji
+609 2920 M
+-0.075 0 (fieldid = fieldid)A
+;
+542 2910 N M 34 -8 - 0 16 - -34 -8 - C : 0 0 0 sco O ; 0 0 0 sco K : 0 0 2454 3191 rc
+2070 2339 N M 0 -475 - 0 0 0 sco K ; : 1946 2044 508 23 rc : 1.000 1.000 1.000 sco 2000 2044 140 23 rf ; 0 0 0 sco F0_20
+Ji
+2000 2044 M
+-0.192 0 (bug_id = bug_id)A
+;
+2070 2227 N M -7 -33 - 15 0 - -8 33 - C : 0 0 0 sco O ; 0 0 0 sco K : 0 0 2454 3191 rc
+1726 2297 N M 372 0 - 0 0 0 sco K ;
+N 1725.500 2276.500 19.500 178.531 85.815 An
+0 0 0 sco K : 0 0 2454 3191 rc
+1706 1859 N M 0 418 - 0 0 0 sco K ;
+N 1685.500 1858.500 19.500 1.397 -91.469 An
+0 0 0 sco K : 0 0 2454 3191 rc
+1537 1839 N M 149 0 - 0 0 0 sco K ; : 1582 2056 872 23 rc : 1.000 1.000 1.000 sco 1636 2056 140 23 rf ; 0 0 0 sco F0_20
+Ji
+1636 2056 M
+-0.192 0 (bug_id = bug_id)A
+;
+1826 2297 N M -33 8 - 0 -15 - 33 7 - C : 0 0 0 sco O ; 0 0 0 sco K
+174 1137 N M 416 206 rr : 1.000 1.000 1.000 sco O ; 0 Lc 0 Lj 0 0 0 sco K : 235 1142 345 32 rc 0 0 0 sco (F0_27) cvn
+F0
+27
+xF
+F0_27
+Ji
+308 1142 M
+0.093 0 (components)A
+; : 0 0 2454 3191 rc
+174 1177 N M 416 0 - 1 Lc 1 Lj 0 0 0 sco K ; : 184 1180 196 32 rc 0 0 0 sco F0_27
+Ji
+184 1180 M
+-0.106 0 (value)A
+; : 400 1180 190 32 rc 0 0 0 sco F0_27
+Ji
+400 1180 M
+0.058 0 (tinytext)A
+; : 184 1213 196 32 rc 0 0 0 sco F0_27
+Ji
+184 1213 M
+-0.074 0 (program)A
+; : 400 1213 190 32 rc 0 0 0 sco F0_27
+Ji
+400 1213 M
+-0.001 0 (VARCHAR\(64\))A
+; : 184 1246 196 32 rc 0 0 0 sco F0_27
+Ji
+184 1246 M
+-0.002 0 (initialowner)A
+; : 400 1246 190 32 rc 0 0 0 sco F0_27
+Ji
+400 1246 M
+0.058 0 (tinytext)A
+; : 184 1279 196 32 rc 0 0 0 sco F0_27
+Ji
+184 1279 M
+0.151 0 (initialqacontact)A
+; : 400 1279 190 32 rc 0 0 0 sco F0_27
+Ji
+400 1279 M
+0.058 0 (tinytext)A
+; : 184 1312 196 29 rc 0 0 0 sco F0_27
+Ji
+184 1312 M
+0.132 0 (description)A
+; : 400 1312 190 29 rc 0 0 0 sco F0_27
+Ji
+400 1312 M
+-0.154 0 (mediumtext)A
+;
+643 1054 N M 320 143 rr : 1.000 1.000 1.000 sco O ; 0 0 0 sco K : 665 1059 288 32 rc 0 0 0 sco F0_27
+Ji
+738 1059 M
+0.097 0 (milestones)A
+; : 0 0 2454 3191 rc
+643 1094 N M 320 0 - 1 Lc 1 Lj 0 0 0 sco K ; : 653 1097 100 32 rc 0 0 0 sco F0_27
+Ji
+0 29 1 sSU
+653 1097 M
+-0.106 0 (value)A
+-64 sU
+; : 773 1097 190 32 rc 0 0 0 sco F0_27
+Ji
+0 29 1 sSU
+773 1097 M
+-0.001 0 (VARCHAR\(20\))A
+-180 sU
+; : 653 1130 100 32 rc 0 0 0 sco F0_27
+Ji
+653 1130 M
+0.136 0 (product)A
+; : 773 1130 190 32 rc 0 0 0 sco F0_27
+Ji
+773 1130 M
+-0.001 0 (VARCHAR\(64\))A
+; : 653 1163 100 31 rc 0 0 0 sco F0_27
+Ji
+653 1163 M
+0.283 0 (sortkey)A
+; : 773 1163 190 31 rc 0 0 0 sco F0_27
+Ji
+773 1163 M
+0.046 0 (smallint\(6\))A
+;
+1742 1001 N M 432 303 rr : 1.000 1.000 1.000 sco O ; 0 0 0 sco K : 1832 1006 332 32 rc 0 0 0 sco F0_27
+Ji
+1905 1006 M
+0.182 0 (products)A
+; : 0 0 2454 3191 rc
+1742 1042 N M 432 0 - 1 Lc 1 Lj 0 0 0 sco K ; : 1752 1044 212 32 rc 0 0 0 sco F0_27
+Ji
+0 29 1 sSU
+1752 1044 M
+0.136 0 (product)A
+-91 sU
+; : 1984 1044 190 32 rc 0 0 0 sco F0_27
+Ji
+0 29 1 sSU
+1984 1044 M
+-0.001 0 (VARCHAR\(64\))A
+-180 sU
+; : 1752 1077 212 32 rc 0 0 0 sco F0_27
+Ji
+1752 1077 M
+0.132 0 (description)A
+; : 1984 1077 190 32 rc 0 0 0 sco F0_27
+Ji
+1984 1077 M
+-0.154 0 (mediumtext)A
+; : 1752 1110 212 32 rc 0 0 0 sco F0_27
+Ji
+1752 1110 M
+0.039 0 (milestoneurl)A
+; : 1984 1110 190 32 rc 0 0 0 sco F0_27
+Ji
+1984 1110 M
+0.058 0 (tinytext)A
+; : 1752 1143 212 32 rc 0 0 0 sco F0_27
+Ji
+1752 1143 M
+-0.048 0 (disallownew)A
+; : 1984 1143 190 32 rc 0 0 0 sco F0_27
+Ji
+1984 1143 M
+0.148 0 (tinyint\(4\))A
+; : 1752 1176 212 32 rc 0 0 0 sco F0_27
+Ji
+1752 1176 M
+0.078 0 (votesperuser)A
+; : 1984 1176 190 32 rc 0 0 0 sco F0_27
+Ji
+1984 1176 M
+0.046 0 (smallint\(6\))A
+; : 1752 1209 212 32 rc 0 0 0 sco F0_27
+Ji
+1752 1209 M
+-0.113 0 (maxvotesperbug)A
+; : 1984 1209 190 32 rc 0 0 0 sco F0_27
+Ji
+1984 1209 M
+0.046 0 (smallint\(6\))A
+; : 1752 1242 212 32 rc 0 0 0 sco F0_27
+Ji
+1752 1242 M
+0.032 0 (votestoconfirm)A
+; : 1984 1242 190 32 rc 0 0 0 sco F0_27
+Ji
+1984 1242 M
+0.046 0 (smallint\(6\))A
+; : 1752 1275 212 27 rc 0 0 0 sco F0_27
+Ji
+1752 1275 M
+0.026 0 (defaultmilestone)A
+; : 1984 1275 190 27 rc 0 0 0 sco F0_27
+Ji
+1984 1275 M
+-0.001 0 (VARCHAR\(20\))A
+;
+1052 964 N M 328 116 rr : 1.000 1.000 1.000 sco O ; 0 0 0 sco K : 1092 969 278 32 rc 0 0 0 sco F0_27
+Ji
+1165 969 M
+0.060 0 (versions)A
+; : 0 0 2454 3191 rc
+1052 1004 N M 328 0 - 1 Lc 1 Lj 0 0 0 sco K ; : 1062 1007 108 32 rc 0 0 0 sco F0_27
+Ji
+1062 1007 M
+-0.106 0 (value)A
+; : 1190 1007 190 32 rc 0 0 0 sco F0_27
+Ji
+1190 1007 M
+0.058 0 (tinytext)A
+; : 1062 1040 108 32 rc 0 0 0 sco F0_27
+Ji
+1062 1040 M
+-0.074 0 (program)A
+; : 1190 1040 190 32 rc 0 0 0 sco F0_27
+Ji
+1190 1040 M
+-0.001 0 (VARCHAR\(64\))A
+;
+1282 1466 N M 382 207 rr : 1.000 1.000 1.000 sco O ; 0 0 0 sco K : 1358 1471 296 32 rc 0 0 0 sco F0_27
+Ji
+1431 1471 M
+0.077 0 (groups)A
+; : 0 0 2454 3191 rc
+1282 1506 N M 382 0 - 1 Lc 1 Lj 0 0 0 sco K ; : 1292 1509 147 32 rc 0 0 0 sco F0_27
+Ji
+1292 1509 M
+0.163 0 (bit)A
+; : 1459 1509 205 32 rc 0 0 0 sco F0_27
+Ji
+1459 1509 M
+0.046 0 (bigint\(20\))A
+; : 1292 1542 147 32 rc 0 0 0 sco F0_27
+Ji
+1292 1542 M
+-0.132 0 (name)A
+; : 1459 1542 205 32 rc 0 0 0 sco F0_27
+Ji
+1459 1542 M
+-0.002 0 (VARCHAR\(255\))A
+; : 1292 1575 147 32 rc 0 0 0 sco F0_27
+Ji
+1292 1575 M
+0.132 0 (description)A
+; : 1459 1575 205 32 rc 0 0 0 sco F0_27
+Ji
+1459 1575 M
+-0.131 0 (text)A
+; : 1292 1608 147 32 rc 0 0 0 sco F0_27
+Ji
+1292 1608 M
+0.043 0 (isbuggroup)A
+; : 1459 1608 205 32 rc 0 0 0 sco F0_27
+Ji
+1459 1608 M
+0.148 0 (tinyint\(4\))A
+; : 1292 1641 147 29 rc 0 0 0 sco F0_27
+Ji
+1292 1641 M
+-0.105 0 (userregexp)A
+; : 1459 1641 205 29 rc 0 0 0 sco F0_27
+Ji
+1459 1641 M
+0.058 0 (tinytext)A
+;
+671 1361 N M 426 207 rr : 1.000 1.000 1.000 sco O ; 0 0 0 sco K : 736 1366 351 32 rc 0 0 0 sco F0_27
+Ji
+809 1366 M
+0.121 0 (logincookies)A
+; : 0 0 2454 3191 rc
+671 1401 N M 426 0 - 1 Lc 1 Lj 0 0 0 sco K ; : 681 1404 191 32 rc 0 0 0 sco F0_27
+Ji
+0 29 1 sSU
+681 1404 M
+0.162 0 (cookie)A
+-79 sU
+; : 892 1404 205 32 rc 0 0 0 sco F0_27
+Ji
+0 29 1 sSU
+892 1404 M
+-0.043 0 (mediumint\(9\))A
+-157 sU
+; : 681 1437 191 32 rc 0 0 0 sco F0_27
+Ji
+681 1437 M
+0.080 0 (userid)A
+; : 892 1437 205 32 rc 0 0 0 sco F0_27
+Ji
+892 1437 M
+-0.043 0 (mediumint\(9\))A
+; : 681 1470 191 32 rc 0 0 0 sco F0_27
+Ji
+681 1470 M
+0.151 0 (cryptpassword)A
+; : 892 1470 205 32 rc 0 0 0 sco F0_27
+Ji
+892 1470 M
+-0.001 0 (VARCHAR\(64\))A
+; : 681 1503 191 32 rc 0 0 0 sco F0_27
+Ji
+681 1503 M
+0.055 0 (hostname)A
+; : 892 1503 205 32 rc 0 0 0 sco F0_27
+Ji
+892 1503 M
+-0.002 0 (VARCHAR\(128\))A
+; : 681 1536 191 29 rc 0 0 0 sco F0_27
+Ji
+681 1536 M
+0.182 0 (lastused)A
+; : 892 1536 205 29 rc 0 0 0 sco F0_27
+Ji
+892 1536 M
+0.036 0 (timestamp\(14\))A
+;
+136 1493 N M 382 207 rr : 1.000 1.000 1.000 sco O ; 0 0 0 sco K : 168 1498 340 32 rc 0 0 0 sco F0_27
+Ji
+241 1498 M
+-0.006 0 (namedqueries)A
+; : 0 0 2454 3191 rc
+136 1533 N M 382 0 - 1 Lc 1 Lj 0 0 0 sco K ; : 146 1536 162 32 rc 0 0 0 sco F0_27
+Ji
+0 29 1 sSU
+146 1536 M
+0.080 0 (userid)A
+-74 sU
+; : 328 1536 190 32 rc 0 0 0 sco F0_27
+Ji
+0 29 1 sSU
+328 1536 M
+-0.043 0 (mediumint\(9\))A
+-157 sU
+; : 146 1569 162 32 rc 0 0 0 sco F0_27
+Ji
+0 29 1 sSU
+146 1569 M
+-0.132 0 (name)A
+-67 sU
+; : 328 1569 190 32 rc 0 0 0 sco F0_27
+Ji
+0 29 1 sSU
+328 1569 M
+-0.001 0 (VARCHAR\(64\))A
+-180 sU
+; : 146 1602 162 32 rc 0 0 0 sco F0_27
+Ji
+146 1602 M
+-0.042 0 (watchfordiffs)A
+; : 328 1602 190 32 rc 0 0 0 sco F0_27
+Ji
+328 1602 M
+0.148 0 (tinyint\(4\))A
+; : 146 1635 162 32 rc 0 0 0 sco F0_27
+Ji
+146 1635 M
+0.038 0 (linkinfooter)A
+; : 328 1635 190 32 rc 0 0 0 sco F0_27
+Ji
+328 1635 M
+0.148 0 (tinyint\(4\))A
+; : 146 1668 162 29 rc 0 0 0 sco F0_27
+Ji
+146 1668 M
+0.095 0 (query)A
+; : 328 1668 190 29 rc 0 0 0 sco F0_27
+Ji
+328 1668 M
+-0.154 0 (mediumtext)A
+;
+1165 2554 N M 378 335 rr : 1.000 1.000 1.000 sco O ; 0 0 0 sco K : 1206 2559 327 32 rc 0 0 0 sco F0_27
+Ji
+1279 2559 M
+0.176 0 (attachments)A
+; : 0 0 2454 3191 rc
+1165 2595 N M 378 0 - 1 Lc 1 Lj 0 0 0 sco K ; : 1175 2597 165 32 rc 0 0 0 sco F0_27
+Ji
+0 29 1 sSU
+1175 2597 M
+0.159 0 (attach_id)A
+-111 sU
+; : 1360 2597 183 32 rc 0 0 0 sco F0_27
+Ji
+0 29 1 sSU
+1360 2597 M
+-0.043 0 (mediumint\(9\))A
+-157 sU
+; : 1175 2630 165 32 rc 0 0 0 sco F0_27
+Ji
+1175 2630 M
+-0.009 0 (bug_id)A
+; : 1360 2630 183 32 rc 0 0 0 sco F0_27
+Ji
+1360 2630 M
+-0.043 0 (mediumint\(9\))A
+; : 1175 2663 165 32 rc 0 0 0 sco F0_27
+Ji
+1175 2663 M
+0.177 0 (creation_ts)A
+; : 1360 2663 183 32 rc 0 0 0 sco F0_27
+Ji
+1360 2663 M
+0.036 0 (timestamp\(14\))A
+; : 1175 2696 165 32 rc 0 0 0 sco F0_27
+Ji
+1175 2696 M
+0.132 0 (description)A
+; : 1360 2696 183 32 rc 0 0 0 sco F0_27
+Ji
+1360 2696 M
+-0.154 0 (mediumtext)A
+; : 1175 2729 165 32 rc 0 0 0 sco F0_27
+Ji
+1175 2729 M
+-0.002 0 (mimetype)A
+; : 1360 2729 183 32 rc 0 0 0 sco F0_27
+Ji
+1360 2729 M
+-0.154 0 (mediumtext)A
+; : 1175 2762 165 32 rc 0 0 0 sco F0_27
+Ji
+1175 2762 M
+0.209 0 (ispatch)A
+; : 1360 2762 183 32 rc 0 0 0 sco F0_27
+Ji
+1360 2762 M
+0.148 0 (tinyint\(4\))A
+; : 1175 2795 165 32 rc 0 0 0 sco F0_27
+Ji
+1175 2795 M
+-0.129 0 (filename)A
+; : 1360 2795 183 32 rc 0 0 0 sco F0_27
+Ji
+1360 2795 M
+-0.154 0 (mediumtext)A
+; : 1175 2828 165 32 rc 0 0 0 sco F0_27
+Ji
+1175 2828 M
+0.133 0 (thedata)A
+; : 1360 2828 183 32 rc 0 0 0 sco F0_27
+Ji
+1360 2828 M
+-0.007 0 (longblob)A
+; : 1175 2861 165 26 rc 0 0 0 sco F0_27
+Ji
+1175 2861 M
+0.080 0 (submitter_id)A
+; : 1360 2861 183 26 rc 0 0 0 sco F0_27
+Ji
+1360 2861 M
+-0.043 0 (mediumint\(9\))A
+;
+1826 2227 N M 456 815 rr : 1.000 1.000 1.000 sco O ; 0 0 0 sco K : 1951 2232 321 32 rc 0 0 0 sco F0_27
+Ji
+2024 2232 M
+0.116 0 (bugs)A
+; : 0 0 2454 3191 rc
+1826 2268 N M 456 0 - 1 Lc 1 Lj 0 0 0 sco K ; : 1836 2270 236 32 rc 0 0 0 sco F0_27
+Ji
+0 29 1 sSU
+1836 2270 M
+-0.009 0 (bug_id)A
+-81 sU
+; : 2092 2270 190 32 rc 0 0 0 sco F0_27
+Ji
+0 29 1 sSU
+2092 2270 M
+-0.043 0 (mediumint\(9\))A
+-157 sU
+; : 1836 2303 236 32 rc 0 0 0 sco F0_27
+Ji
+1836 2303 M
+0.118 0 (groupset)A
+; : 2092 2303 190 32 rc 0 0 0 sco F0_27
+Ji
+2092 2303 M
+0.046 0 (bigint\(20\))A
+; : 1836 2336 236 32 rc 0 0 0 sco F0_27
+Ji
+1836 2336 M
+0.129 0 (assigned_to)A
+; : 2092 2336 190 32 rc 0 0 0 sco F0_27
+Ji
+2092 2336 M
+-0.043 0 (mediumint\(9\))A
+; : 1836 2369 236 32 rc 0 0 0 sco F0_27
+Ji
+1836 2369 M
+-0.006 0 (bug_file_loc)A
+; : 2092 2369 190 32 rc 0 0 0 sco F0_27
+Ji
+2092 2369 M
+-0.131 0 (text)A
+; : 1836 2402 236 32 rc 0 0 0 sco F0_27
+Ji
+1836 2402 M
+0.078 0 (bug_severity)A
+; : 2092 2402 190 32 rc 0 0 0 sco F0_27
+Ji
+2092 2402 M
+-0.132 0 (enum)A
+; : 1836 2435 236 32 rc 0 0 0 sco F0_27
+Ji
+1836 2435 M
+0.192 0 (bug_status)A
+; : 2092 2435 190 32 rc 0 0 0 sco F0_27
+Ji
+2092 2435 M
+-0.132 0 (enum)A
+; : 1836 2468 236 32 rc 0 0 0 sco F0_27
+Ji
+1836 2468 M
+0.177 0 (creation_ts)A
+; : 2092 2468 190 32 rc 0 0 0 sco F0_27
+Ji
+2092 2468 M
+0.057 0 (datetime)A
+; : 1836 2501 236 32 rc 0 0 0 sco F0_27
+Ji
+1836 2501 M
+0.181 0 (delta_ts)A
+; : 2092 2501 190 32 rc 0 0 0 sco F0_27
+Ji
+2092 2501 M
+0.036 0 (timestamp\(14\))A
+; : 1836 2534 236 32 rc 0 0 0 sco F0_27
+Ji
+1836 2534 M
+0.194 0 (short_desc)A
+; : 2092 2534 190 32 rc 0 0 0 sco F0_27
+Ji
+2092 2534 M
+-0.154 0 (mediumtext)A
+; : 1836 2567 236 32 rc 0 0 0 sco F0_27
+Ji
+1836 2567 M
+0.244 0 (op_sys)A
+; : 2092 2567 190 32 rc 0 0 0 sco F0_27
+Ji
+2092 2567 M
+-0.132 0 (enum)A
+; : 1836 2600 236 32 rc 0 0 0 sco F0_27
+Ji
+1836 2600 M
+0.125 0 (priority)A
+; : 2092 2600 190 32 rc 0 0 0 sco F0_27
+Ji
+2092 2600 M
+-0.132 0 (enum)A
+; : 1836 2633 236 32 rc 0 0 0 sco F0_27
+Ji
+1836 2633 M
+0.136 0 (product)A
+; : 2092 2633 190 32 rc 0 0 0 sco F0_27
+Ji
+2092 2633 M
+-0.001 0 (VARCHAR\(64\))A
+; : 1836 2666 236 32 rc 0 0 0 sco F0_27
+Ji
+1836 2666 M
+-0.046 0 (rep_platform)A
+; : 2092 2666 190 32 rc 0 0 0 sco F0_27
+Ji
+2092 2666 M
+-0.132 0 (enum)A
+; : 1836 2699 236 32 rc 0 0 0 sco F0_27
+Ji
+1836 2699 M
+0.059 0 (reporter)A
+; : 2092 2699 190 32 rc 0 0 0 sco F0_27
+Ji
+2092 2699 M
+-0.043 0 (mediumint\(9\))A
+; : 1836 2732 236 32 rc 0 0 0 sco F0_27
+Ji
+1836 2732 M
+-0.003 0 (version)A
+; : 2092 2732 190 32 rc 0 0 0 sco F0_27
+Ji
+2092 2732 M
+-0.001 0 (VARCHAR\(16\))A
+; : 1836 2765 236 32 rc 0 0 0 sco F0_27
+Ji
+1836 2765 M
+0.048 0 (component)A
+; : 2092 2765 190 32 rc 0 0 0 sco F0_27
+Ji
+2092 2765 M
+-0.001 0 (VARCHAR\(50\))A
+; : 1836 2798 236 32 rc 0 0 0 sco F0_27
+Ji
+1836 2798 M
+0.096 0 (resolution)A
+; : 2092 2798 190 32 rc 0 0 0 sco F0_27
+Ji
+2092 2798 M
+-0.132 0 (enum)A
+; : 1836 2831 236 32 rc 0 0 0 sco F0_27
+Ji
+1836 2831 M
+0.089 0 (target_milestone)A
+; : 2092 2831 190 32 rc 0 0 0 sco F0_27
+Ji
+2092 2831 M
+-0.001 0 (VARCHAR\(20\))A
+; : 1836 2864 236 32 rc 0 0 0 sco F0_27
+Ji
+1836 2864 M
+0.192 0 (qa_contact)A
+; : 2092 2864 190 32 rc 0 0 0 sco F0_27
+Ji
+2092 2864 M
+-0.043 0 (mediumint\(9\))A
+; : 1836 2897 236 32 rc 0 0 0 sco F0_27
+Ji
+1836 2897 M
+0.111 0 (status_whiteboard)A
+; : 2092 2897 190 32 rc 0 0 0 sco F0_27
+Ji
+2092 2897 M
+-0.154 0 (mediumtext)A
+; : 1836 2930 236 32 rc 0 0 0 sco F0_27
+Ji
+1836 2930 M
+0.094 0 (votes)A
+; : 2092 2930 190 32 rc 0 0 0 sco F0_27
+Ji
+2092 2930 M
+-0.043 0 (mediumint\(9\))A
+; : 1836 2963 236 32 rc 0 0 0 sco F0_27
+Ji
+1836 2963 M
+0.122 0 (keywords)A
+; : 2092 2963 190 32 rc 0 0 0 sco F0_27
+Ji
+2092 2963 M
+-0.154 0 (mediumtext)A
+; : 1836 2996 236 32 rc 0 0 0 sco F0_27
+Ji
+1836 2996 M
+-0.005 0 (lastdiffed)A
+; : 2092 2996 190 32 rc 0 0 0 sco F0_27
+Ji
+2092 2996 M
+0.057 0 (datetime)A
+; : 1836 3029 236 11 rc 0 0 0 sco F0_27
+Ji
+1836 3029 M
+-0.080 0 (everconfirmed)A
+; : 2092 3029 190 11 rc 0 0 0 sco F0_27
+Ji
+2092 3029 M
+0.148 0 (tinyint\(4\))A
+;
+768 2778 N M 330 239 rr : 1.000 1.000 1.000 sco O ; 0 0 0 sco K : 781 2783 307 32 rc 0 0 0 sco F0_27
+Ji
+854 2783 M
+0.149 0 (bugs_activity)A
+; : 0 0 2454 3191 rc
+768 2819 N M 330 0 - 1 Lc 1 Lj 0 0 0 sco K ; : 778 2821 133 32 rc 0 0 0 sco F0_27
+Ji
+778 2821 M
+-0.009 0 (bug_id)A
+; : 931 2821 167 32 rc 0 0 0 sco F0_27
+Ji
+931 2821 M
+-0.043 0 (mediumint\(9\))A
+; : 778 2854 133 32 rc 0 0 0 sco F0_27
+Ji
+778 2854 M
+-0.173 0 (who)A
+; : 931 2854 167 32 rc 0 0 0 sco F0_27
+Ji
+931 2854 M
+-0.043 0 (mediumint\(9\))A
+; : 778 2887 133 32 rc 0 0 0 sco F0_27
+Ji
+778 2887 M
+-0.072 0 (bug_when)A
+; : 931 2887 167 32 rc 0 0 0 sco F0_27
+Ji
+931 2887 M
+0.057 0 (datetime)A
+; : 778 2920 133 32 rc 0 0 0 sco F0_27
+Ji
+778 2920 M
+-0.075 0 (fieldid)A
+; : 931 2920 167 32 rc 0 0 0 sco F0_27
+Ji
+931 2920 M
+-0.043 0 (mediumint\(9\))A
+; : 778 2953 133 32 rc 0 0 0 sco F0_27
+Ji
+778 2953 M
+-0.069 0 (oldvalue)A
+; : 931 2953 167 32 rc 0 0 0 sco F0_27
+Ji
+931 2953 M
+0.058 0 (tinytext)A
+; : 778 2986 133 29 rc 0 0 0 sco F0_27
+Ji
+778 2986 M
+-0.131 0 (newvalue)A
+; : 931 2986 167 29 rc 0 0 0 sco F0_27
+Ji
+931 2986 M
+0.058 0 (tinytext)A
+;
+1370 1784 N M 286 116 rr : 1.000 1.000 1.000 sco O ; 0 0 0 sco K : 1426 1789 220 32 rc 0 0 0 sco F0_27
+Ji
+1499 1789 M
+0.500 0 (cc)A
+; : 0 0 2454 3191 rc
+1370 1825 N M 286 0 - 1 Lc 1 Lj 0 0 0 sco K ; : 1380 1827 89 32 rc 0 0 0 sco F0_27
+Ji
+0 29 1 sSU
+1380 1827 M
+-0.009 0 (bug_id)A
+-81 sU
+; : 1489 1827 167 32 rc 0 0 0 sco F0_27
+Ji
+0 29 1 sSU
+1489 1827 M
+-0.043 0 (mediumint\(9\))A
+-157 sU
+; : 1380 1860 89 32 rc 0 0 0 sco F0_27
+Ji
+0 29 1 sSU
+1380 1860 M
+-0.173 0 (who)A
+-49 sU
+; : 1489 1860 167 32 rc 0 0 0 sco F0_27
+Ji
+0 29 1 sSU
+1489 1860 M
+-0.043 0 (mediumint\(9\))A
+-157 sU
+;
+178 2819 N M 364 207 rr : 1.000 1.000 1.000 sco O ; 0 0 0 sco K : 237 2824 295 32 rc 0 0 0 sco F0_27
+Ji
+310 2824 M
+-0.061 0 (fielddefs)A
+; : 0 0 2454 3191 rc
+178 2859 N M 364 0 - 1 Lc 1 Lj 0 0 0 sco K ; : 188 2862 144 32 rc 0 0 0 sco F0_27
+Ji
+0 29 1 sSU
+188 2862 M
+-0.075 0 (fieldid)A
+-70 sU
+; : 352 2862 190 32 rc 0 0 0 sco F0_27
+Ji
+0 29 1 sSU
+352 2862 M
+-0.043 0 (mediumint\(9\))A
+-157 sU
+; : 188 2895 144 32 rc 0 0 0 sco F0_27
+Ji
+188 2895 M
+-0.132 0 (name)A
+; : 352 2895 190 32 rc 0 0 0 sco F0_27
+Ji
+352 2895 M
+-0.001 0 (VARCHAR\(64\))A
+; : 188 2928 144 32 rc 0 0 0 sco F0_27
+Ji
+188 2928 M
+0.132 0 (description)A
+; : 352 2928 190 32 rc 0 0 0 sco F0_27
+Ji
+352 2928 M
+-0.154 0 (mediumtext)A
+; : 188 2961 144 32 rc 0 0 0 sco F0_27
+Ji
+188 2961 M
+-0.067 0 (mailhead)A
+; : 352 2961 190 32 rc 0 0 0 sco F0_27
+Ji
+352 2961 M
+0.148 0 (tinyint\(4\))A
+; : 188 2994 144 29 rc 0 0 0 sco F0_27
+Ji
+188 2994 M
+0.283 0 (sortkey)A
+; : 352 2994 190 29 rc 0 0 0 sco F0_27
+Ji
+352 2994 M
+0.046 0 (smallint\(6\))A
+;
+1954 1803 N M 330 116 rr : 1.000 1.000 1.000 sco O ; 0 0 0 sco K : 1988 1808 286 32 rc 0 0 0 sco F0_27
+Ji
+2061 1808 M
+0.122 0 (keywords)A
+; : 0 0 2454 3191 rc
+1954 1843 N M 330 0 - 1 Lc 1 Lj 0 0 0 sco K ; : 1964 1846 133 32 rc 0 0 0 sco F0_27
+Ji
+0 29 1 sSU
+1964 1846 M
+-0.009 0 (bug_id)A
+-81 sU
+; : 2117 1846 167 32 rc 0 0 0 sco F0_27
+Ji
+0 29 1 sSU
+2117 1846 M
+-0.043 0 (mediumint\(9\))A
+-157 sU
+; : 1964 1879 133 32 rc 0 0 0 sco F0_27
+Ji
+0 29 1 sSU
+1964 1879 M
+0.053 0 (keywordid)A
+-122 sU
+; : 2117 1879 167 32 rc 0 0 0 sco F0_27
+Ji
+0 29 1 sSU
+2117 1879 M
+0.046 0 (smallint\(6\))A
+-125 sU
+;
+1104 2179 N M 330 175 rr : 1.000 1.000 1.000 sco O ; 0 0 0 sco K : 1134 2184 290 32 rc 0 0 0 sco F0_27
+Ji
+1207 2184 M
+0.161 0 (longdescs)A
+; : 0 0 2454 3191 rc
+1104 2220 N M 330 0 - 1 Lc 1 Lj 0 0 0 sco K ; : 1114 2222 133 32 rc 0 0 0 sco F0_27
+Ji
+1114 2222 M
+-0.009 0 (bug_id)A
+; : 1267 2222 167 32 rc 0 0 0 sco F0_27
+Ji
+1267 2222 M
+-0.043 0 (mediumint\(9\))A
+; : 1114 2255 133 32 rc 0 0 0 sco F0_27
+Ji
+1114 2255 M
+-0.173 0 (who)A
+; : 1267 2255 167 32 rc 0 0 0 sco F0_27
+Ji
+1267 2255 M
+-0.043 0 (mediumint\(9\))A
+; : 1114 2288 133 32 rc 0 0 0 sco F0_27
+Ji
+1114 2288 M
+-0.072 0 (bug_when)A
+; : 1267 2288 167 32 rc 0 0 0 sco F0_27
+Ji
+1267 2288 M
+0.057 0 (datetime)A
+; : 1114 2321 133 31 rc 0 0 0 sco F0_27
+Ji
+1114 2321 M
+-0.008 0 (thetext)A
+; : 1267 2321 167 31 rc 0 0 0 sco F0_27
+Ji
+1267 2321 M
+-0.154 0 (mediumtext)A
+;
+426 2221 N M 446 399 rr : 1.000 1.000 1.000 sco O ; 0 0 0 sco K : 532 2226 330 32 rc 0 0 0 sco F0_27
+Ji
+605 2226 M
+-0.003 0 (profiles)A
+; : 0 0 2454 3191 rc
+426 2262 N M 446 0 - 1 Lc 1 Lj 0 0 0 sco K ; : 436 2264 211 32 rc 0 0 0 sco F0_27
+Ji
+0 29 1 sSU
+436 2264 M
+0.080 0 (userid)A
+-74 sU
+; : 667 2264 205 32 rc 0 0 0 sco F0_27
+Ji
+0 29 1 sSU
+667 2264 M
+-0.043 0 (mediumint\(9\))A
+-157 sU
+; : 436 2297 211 32 rc 0 0 0 sco F0_27
+Ji
+436 2297 M
+-0.056 0 (login_name)A
+; : 667 2297 205 32 rc 0 0 0 sco F0_27
+Ji
+667 2297 M
+-0.002 0 (VARCHAR\(255\))A
+; : 436 2330 211 32 rc 0 0 0 sco F0_27
+Ji
+436 2330 M
+0.058 0 (password)A
+; : 667 2330 205 32 rc 0 0 0 sco F0_27
+Ji
+667 2330 M
+-0.001 0 (VARCHAR\(16\))A
+; : 436 2363 211 32 rc 0 0 0 sco F0_27
+Ji
+436 2363 M
+0.151 0 (cryptpassword)A
+; : 667 2363 205 32 rc 0 0 0 sco F0_27
+Ji
+667 2363 M
+-0.001 0 (VARCHAR\(64\))A
+; : 436 2396 211 32 rc 0 0 0 sco F0_27
+Ji
+436 2396 M
+-0.067 0 (realname)A
+; : 667 2396 205 32 rc 0 0 0 sco F0_27
+Ji
+667 2396 M
+-0.002 0 (VARCHAR\(255\))A
+; : 436 2429 211 32 rc 0 0 0 sco F0_27
+Ji
+436 2429 M
+0.118 0 (groupset)A
+; : 667 2429 205 32 rc 0 0 0 sco F0_27
+Ji
+667 2429 M
+0.046 0 (bigint\(20\))A
+; : 436 2462 211 32 rc 0 0 0 sco F0_27
+Ji
+436 2462 M
+0.026 0 (emailnotification)A
+; : 667 2462 205 32 rc 0 0 0 sco F0_27
+Ji
+667 2462 M
+-0.132 0 (enum)A
+; : 436 2495 211 32 rc 0 0 0 sco F0_27
+Ji
+436 2495 M
+-0.006 0 (disabledtext)A
+; : 667 2495 205 32 rc 0 0 0 sco F0_27
+Ji
+667 2495 M
+-0.154 0 (mediumtext)A
+; : 436 2528 211 32 rc 0 0 0 sco F0_27
+Ji
+436 2528 M
+-0.004 0 (newemailtech)A
+; : 667 2528 205 32 rc 0 0 0 sco F0_27
+Ji
+667 2528 M
+0.148 0 (tinyint\(4\))A
+; : 436 2561 211 32 rc 0 0 0 sco F0_27
+Ji
+436 2561 M
+0.097 0 (mybugslink)A
+; : 667 2561 205 32 rc 0 0 0 sco F0_27
+Ji
+667 2561 M
+0.148 0 (tinyint\(4\))A
+; : 436 2594 211 24 rc 0 0 0 sco F0_27
+Ji
+436 2594 M
+0.148 0 (blessgroupset)A
+; : 667 2594 205 24 rc 0 0 0 sco F0_27
+Ji
+667 2594 M
+0.046 0 (bigint\(20\))A
+;
+150 1818 N M 374 239 rr : 1.000 1.000 1.000 sco O ; 0 0 0 sco K : 171 1823 343 32 rc 0 0 0 sco F0_27
+Ji
+244 1823 M
+0.086 0 (profiles_activity)A
+; : 0 0 2454 3191 rc
+150 1858 N M 374 0 - 1 Lc 1 Lj 0 0 0 sco K ; : 160 1861 177 32 rc 0 0 0 sco F0_27
+Ji
+160 1861 M
+0.080 0 (userid)A
+; : 357 1861 167 32 rc 0 0 0 sco F0_27
+Ji
+357 1861 M
+-0.043 0 (mediumint\(9\))A
+; : 160 1894 177 32 rc 0 0 0 sco F0_27
+Ji
+160 1894 M
+-0.173 0 (who)A
+; : 357 1894 167 32 rc 0 0 0 sco F0_27
+Ji
+357 1894 M
+-0.043 0 (mediumint\(9\))A
+; : 160 1927 177 32 rc 0 0 0 sco F0_27
+Ji
+160 1927 M
+-0.043 0 (profiles_when)A
+; : 357 1927 167 32 rc 0 0 0 sco F0_27
+Ji
+357 1927 M
+0.057 0 (datetime)A
+; : 160 1960 177 32 rc 0 0 0 sco F0_27
+Ji
+160 1960 M
+-0.075 0 (fieldid)A
+; : 357 1960 167 32 rc 0 0 0 sco F0_27
+Ji
+357 1960 M
+-0.043 0 (mediumint\(9\))A
+; : 160 1993 177 32 rc 0 0 0 sco F0_27
+Ji
+160 1993 M
+-0.069 0 (oldvalue)A
+; : 357 1993 167 32 rc 0 0 0 sco F0_27
+Ji
+357 1993 M
+0.058 0 (tinytext)A
+; : 160 2026 177 28 rc 0 0 0 sco F0_27
+Ji
+160 2026 M
+-0.131 0 (newvalue)A
+; : 357 2026 167 28 rc 0 0 0 sco F0_27
+Ji
+357 2026 M
+0.058 0 (tinytext)A
+;
+1289 1975 N M 286 143 rr : 1.000 1.000 1.000 sco O ; 0 0 0 sco K : 1326 1980 239 32 rc 0 0 0 sco F0_27
+Ji
+1399 1980 M
+0.094 0 (votes)A
+; : 0 0 2454 3191 rc
+1289 2016 N M 286 0 - 1 Lc 1 Lj 0 0 0 sco K ; : 1299 2018 89 32 rc 0 0 0 sco F0_27
+Ji
+1299 2018 M
+-0.173 0 (who)A
+; : 1408 2018 167 32 rc 0 0 0 sco F0_27
+Ji
+1408 2018 M
+-0.043 0 (mediumint\(9\))A
+; : 1299 2051 89 32 rc 0 0 0 sco F0_27
+Ji
+1299 2051 M
+-0.009 0 (bug_id)A
+; : 1408 2051 167 32 rc 0 0 0 sco F0_27
+Ji
+1408 2051 M
+-0.043 0 (mediumint\(9\))A
+; : 1299 2084 89 32 rc 0 0 0 sco F0_27
+Ji
+1299 2084 M
+0.192 0 (count)A
+; : 1408 2084 167 32 rc 0 0 0 sco F0_27
+Ji
+1408 2084 M
+0.046 0 (smallint\(6\))A
+;
+1914 755 N M 342 116 rr : 1.000 1.000 1.000 sco O ; 0 0 0 sco K : 1927 760 319 32 rc 0 0 0 sco F0_27
+Ji
+2000 760 M
+0.075 0 (dependencies)A
+; : 0 0 2454 3191 rc
+1914 796 N M 342 0 - 1 Lc 1 Lj 0 0 0 sco K ; : 1924 798 145 32 rc 0 0 0 sco F0_27
+Ji
+1924 798 M
+0.137 0 (blocked)A
+; : 2089 798 167 32 rc 0 0 0 sco F0_27
+Ji
+2089 798 M
+-0.043 0 (mediumint\(9\))A
+; : 1924 831 145 32 rc 0 0 0 sco F0_27
+Ji
+1924 831 M
+0.045 0 (dependson)A
+; : 2089 831 167 32 rc 0 0 0 sco F0_27
+Ji
+2089 831 M
+-0.043 0 (mediumint\(9\))A
+;
+1548 755 N M 302 116 rr : 1.000 1.000 1.000 sco O ; 0 0 0 sco K : 1564 760 276 32 rc 0 0 0 sco F0_27
+Ji
+1637 760 M
+0.145 0 (duplicates)A
+; : 0 0 2454 3191 rc
+1548 796 N M 302 0 - 1 Lc 1 Lj 0 0 0 sco K ; : 1558 798 105 32 rc 0 0 0 sco F0_27
+Ji
+1558 798 M
+-0.083 0 (dupe_of)A
+; : 1683 798 167 32 rc 0 0 0 sco F0_27
+Ji
+1683 798 M
+-0.043 0 (mediumint\(9\))A
+; : 1558 831 105 32 rc 0 0 0 sco F0_27
+Ji
+0 29 1 sSU
+1558 831 M
+-0.012 0 (dupe)A
+-60 sU
+; : 1683 831 167 32 rc 0 0 0 sco F0_27
+Ji
+0 29 1 sSU
+1683 831 M
+-0.043 0 (mediumint\(9\))A
+-157 sU
+;
+1058 728 N M 364 143 rr : 1.000 1.000 1.000 sco O ; 0 0 0 sco K : 1091 733 321 32 rc 0 0 0 sco F0_27
+Ji
+1164 733 M
+0.041 0 (keyworddefs)A
+; : 0 0 2454 3191 rc
+1058 769 N M 364 0 - 1 Lc 1 Lj 0 0 0 sco K ; : 1068 771 144 32 rc 0 0 0 sco F0_27
+Ji
+0 29 1 sSU
+1068 771 M
+-0.003 0 (id)A
+-21 sU
+; : 1232 771 190 32 rc 0 0 0 sco F0_27
+Ji
+0 29 1 sSU
+1232 771 M
+0.046 0 (smallint\(6\))A
+-125 sU
+; : 1068 804 144 32 rc 0 0 0 sco F0_27
+Ji
+1068 804 M
+-0.132 0 (name)A
+; : 1232 804 190 32 rc 0 0 0 sco F0_27
+Ji
+1232 804 M
+-0.001 0 (VARCHAR\(64\))A
+; : 1068 837 144 32 rc 0 0 0 sco F0_27
+Ji
+1068 837 M
+0.132 0 (description)A
+; : 1232 837 190 32 rc 0 0 0 sco F0_27
+Ji
+1232 837 M
+-0.154 0 (mediumtext)A
+;
+170 696 N M 346 175 rr : 1.000 1.000 1.000 sco O ; 0 0 0 sco K : 205 701 301 32 rc 0 0 0 sco F0_27
+Ji
+278 701 M
+-0.007 0 (shadowlog)A
+; : 0 0 2454 3191 rc
+170 737 N M 346 0 - 1 Lc 1 Lj 0 0 0 sco K ; : 180 739 133 32 rc 0 0 0 sco F0_27
+Ji
+0 29 1 sSU
+180 739 M
+-0.003 0 (id)A
+-21 sU
+; : 333 739 183 32 rc 0 0 0 sco F0_27
+Ji
+0 29 1 sSU
+333 739 M
+0.069 0 (int\(11\))A
+-77 sU
+; : 180 772 133 32 rc 0 0 0 sco F0_27
+Ji
+180 772 M
+0.497 0 (ts)A
+; : 333 772 183 32 rc 0 0 0 sco F0_27
+Ji
+333 772 M
+0.036 0 (timestamp\(14\))A
+; : 180 805 133 32 rc 0 0 0 sco F0_27
+Ji
+180 805 M
+0.051 0 (reflected)A
+; : 333 805 183 32 rc 0 0 0 sco F0_27
+Ji
+333 805 M
+0.148 0 (tinyint\(4\))A
+; : 180 838 133 31 rc 0 0 0 sco F0_27
+Ji
+180 838 M
+-0.076 0 (command)A
+; : 333 838 183 31 rc 0 0 0 sco F0_27
+Ji
+333 838 M
+-0.154 0 (mediumtext)A
+;
+646 755 N M 308 116 rr : 1.000 1.000 1.000 sco O ; 0 0 0 sco K : 691 760 253 32 rc 0 0 0 sco F0_27
+Ji
+764 760 M
+0.095 0 (watch)A
+; : 0 0 2454 3191 rc
+646 796 N M 308 0 - 1 Lc 1 Lj 0 0 0 sco K ; : 656 798 111 32 rc 0 0 0 sco F0_27
+Ji
+0 29 1 sSU
+656 798 M
+0.068 0 (watcher)A
+-95 sU
+; : 787 798 167 32 rc 0 0 0 sco F0_27
+Ji
+0 29 1 sSU
+787 798 M
+-0.043 0 (mediumint\(9\))A
+-157 sU
+; : 656 831 111 32 rc 0 0 0 sco F0_27
+Ji
+0 29 1 sSU
+656 831 M
+0.065 0 (watched)A
+-101 sU
+; : 787 831 167 32 rc 0 0 0 sco F0_27
+Ji
+0 29 1 sSU
+787 831 M
+-0.043 0 (mediumint\(9\))A
+-157 sU
+; : 0 0 2454 3191 rc
+780 2186 N M -3 -403 - 459 -177 - 1 Lc 1 Lj [ 37 25 ] setdsh : 1.000 1.000 1.000 sco solid K ; 0 0 0 sco K ; : 0 0 2454 3191 rc
+1686 1620 N M 160 243 - 0 331 - 1 Lc 1 Lj [ 37 25 ] setdsh : 1.000 1.000 1.000 sco solid K ; 0 0 0 sco K ;
+LH
+pagesave restore
+
+(%%[ Page: 1 ]%%) =
+%%PageTrailer
+
+%%Trailer
+%%DocumentNeededFonts: Helvetica
+%%DocumentSuppliedFonts:
+Pscript_Win_Driver_Incr dup /terminate get exec
+savelevel0 restore
+%%Pages: 1
+(%%[ LastPage ]%%) =
+%%EOF
+%-12345X@PJL EOJ +%-12345X
\ No newline at end of file diff --git a/docs/sgml/faq.sgml b/docs/sgml/faq.sgml index 2b67890a9..f01b43053 100644 --- a/docs/sgml/faq.sgml +++ b/docs/sgml/faq.sgml @@ -1,6 +1,6 @@ -<!DOCTYPE appendix PUBLIC "-//OASIS//DTD DocBook V4.1//EN"> +<!-- <!DOCTYPE appendix PUBLIC "-//OASIS//DTD DocBook V4.1//EN"> --> -<appendix id="faq"> +<appendix id="faq" xreflabel="The Bugzilla FAQ"> <title>The Bugzilla FAQ</title> <qandaset> @@ -17,8 +17,8 @@ <answer> <para> You can stay up-to-date with the latest Bugzilla - information at <ulink url="http://www.mozilla.org/projects/bugzilla/"> - http://www.mozilla.org/projects/bugzilla/</ulink> + information at <ulink + url="http://www.mozilla.org/projects/bugzilla/"> http://www.mozilla.org/projects/bugzilla/</ulink> </para> </answer> </qandaentry> @@ -31,9 +31,9 @@ </question> <answer> <para> - Bugzilla is covered by the Mozilla Public License. - See details at <ulink url="http://www.mozilla.org/MPL/"> - http://www.mozilla.org/MPL/</ulink> + Bugzilla is covered by the Mozilla Public License. See + details at <ulink url="http://www.mozilla.org/MPL/"> + http://www.mozilla.org/MPL/</ulink> </para> </answer> </qandaentry> @@ -46,16 +46,17 @@ </question> <answer> <para> - <ulink url="http://www.collab.net/">www.collab.net</ulink> offers - Bugzilla as part of their standard offering to large projects. - They do have some minimum fees that are pretty hefty, and generally - aren't interested in small projects. + <ulink url="http://www.collab.net/">www.collab.net</ulink> + offers Bugzilla as part of their standard offering to + large projects. They do have some minimum fees that are + pretty hefty, and generally aren't interested in small + projects. </para> <para> - There are several experienced - Bugzilla hackers on the mailing list/newsgroup who are willing - to whore themselves out for generous compensation. - Try sending a message to the mailing list asking for a volunteer. + There are several experienced Bugzilla hackers on the + mailing list/newsgroup who are willing to whore themselves + out for generous compensation. Try sending a message to + the mailing list asking for a volunteer. </para> </answer> </qandaentry> @@ -63,14 +64,15 @@ <qandaentry> <question> <para> - What major companies or projects are currently using Bugzilla - for bug-tracking? + What major companies or projects are currently using + Bugzilla for bug-tracking? </para> </question> <answer> <para> - There are <emphasis>dozens</emphasis> of major comapanies with public - Bugzilla sites to track bugs in their products. A few include: + There are <emphasis>dozens</emphasis> of major comapanies + with public Bugzilla sites to track bugs in their + products. A few include: <simplelist> <member>Netscape/AOL</member> <member>Mozilla.org</member> @@ -92,8 +94,9 @@ </simplelist> </para> <para> - Suffice to say, there are more than enough huge projects using Bugzilla - that we can safely say it's extremely popular. + Suffice to say, there are more than enough huge projects + using Bugzilla that we can safely say it's extremely + popular. </para> </answer> </qandaentry> @@ -106,13 +109,16 @@ </question> <answer> <para> - There are many, many contributors from around the world maintaining Bugzilla. - The designated "Maintainer" is Tara Hernandez, with QA support by Matthew Tuck. - Dan Mosedale and Dawn Endico are employees of Mozilla.org responsible for the - installation of Bugzilla there, and are very frequent code contributors. - Terry Weissman originally ported Bugzilla, but "these days, Terry just hangs around - and heckles." The rest of us are mostly transient developers; Bugzilla suits - our needs, and we contribute code as we have needs for updates. + There are many, many contributors from around the world + maintaining Bugzilla. The designated "Maintainer" is Tara + Hernandez, with QA support by Matthew Tuck. Dan Mosedale + and Dawn Endico are employees of Mozilla.org responsible + for the installation of Bugzilla there, and are very + frequent code contributors. Terry Weissman originally + ported Bugzilla, but "these days, Terry just hangs around + and heckles." The rest of us are mostly transient + developers; Bugzilla suits our needs, and we contribute + code as we have needs for updates. </para> </answer> </qandaentry> @@ -120,23 +126,28 @@ <qandaentry> <question> <para> - How does Bugzilla stack up against other bug-tracking databases? + How does Bugzilla stack up against other bug-tracking + databases? </para> </question> <answer> <para> - A year has gone by, and I <emphasis>still</emphasis> can't find any head-to-head - comparisons of Bugzilla against other defect-tracking software. However, from my - personal experience with other bug-trackers, Bugzilla offers - superior performance on commodity hardware, better price (free!), more developer- - friendly features (such as stored queries, email integration, and platform - independence), improved scalability, open source code, greater flexibility, - and superior ease-of-use. + A year has gone by, and I <emphasis>still</emphasis> can't + find any head-to-head comparisons of Bugzilla against + other defect-tracking software. However, from my personal + experience with other bug-trackers, Bugzilla offers + superior performance on commodity hardware, better price + (free!), more developer- friendly features (such as stored + queries, email integration, and platform independence), + improved scalability, open source code, greater + flexibility, and superior ease-of-use. </para> <para> - If you happen to be a commercial Bugzilla vendor, please step forward with a rebuttal - so I can include it in the FAQ. We're not in pursuit of Bugzilla ueber alles; - we simply love having a powerful, open-source tool to get our jobs done. + If you happen to be a commercial Bugzilla vendor, please + step forward with a rebuttal so I can include it in the + FAQ. We're not in pursuit of Bugzilla ueber alles; we + simply love having a powerful, open-source tool to get our + jobs done. </para> </answer> </qandaentry> @@ -149,8 +160,9 @@ </question> <answer> <para> - You can't. However, the administrative account can, by simply opening - your user account in editusers.cgi and changing the login name. + You can't. However, the administrative account can, by + simply opening your user account in editusers.cgi and + changing the login name. </para> </answer> </qandaentry> @@ -158,24 +170,26 @@ <qandaentry> <question> <para> - Why doesn't Bugzilla offer this or that feature or compatability - with this other tracking software? + Why doesn't Bugzilla offer this or that feature or + compatability with this other tracking software? </para> </question> <answer> <para> - It may be that the support has not been built yet, or that you - have not yet found it. Bugzilla is making tremendous strides in - usability, customizability, scalability, and user interface. It - is widely considered the most complete and popular open-source - bug-tracking software in existence. + It may be that the support has not been built yet, or that + you have not yet found it. Bugzilla is making tremendous + strides in usability, customizability, scalability, and + user interface. It is widely considered the most complete + and popular open-source bug-tracking software in + existence. </para> <para> - That doesn't mean it can't use improvement! - You can help the project along by either hacking a patch yourself - that supports the functionality you require, or else submitting a - "Request for Enhancement" (RFE) using the bug submission interface - at <ulink url="http://bugzilla.mozilla.org/">bugzilla.mozilla.org</ulink>. + That doesn't mean it can't use improvement! You can help + the project along by either hacking a patch yourself that + supports the functionality you require, or else submitting + a "Request for Enhancement" (RFE) using the bug submission + interface at <ulink + url="http://bugzilla.mozilla.org/">bugzilla.mozilla.org</ulink>. </para> </answer> </qandaentry> @@ -191,37 +205,40 @@ <para>Terry Weissman answers, <blockquote> <para> - You're not the only one. But <emphasis>I</emphasis> am not very interested. I'm not - a real SQL or database person. I just wanted to make a useful tool, - and build it on top of free software. So, I picked MySQL, and - learned SQL by staring at the MySQL manual and some code lying - around here, and - wrote Bugzilla. I didn't know that Enum's were non-standard SQL. - I'm not sure if I would have cared, but I didn't even know. So, to - me, things are "portable" because it uses MySQL, and MySQL is - portable enough. I fully understand (now) that people want to be - portable to other databases, but that's never been a real concern - of mine. + You're not the only one. But <emphasis>I</emphasis> am + not very interested. I'm not a real SQL or database + person. I just wanted to make a useful tool, and build + it on top of free software. So, I picked MySQL, and + learned SQL by staring at the MySQL manual and some + code lying around here, and wrote Bugzilla. I didn't + know that Enum's were non-standard SQL. I'm not sure + if I would have cared, but I didn't even know. So, to + me, things are "portable" because it uses MySQL, and + MySQL is portable enough. I fully understand (now) + that people want to be portable to other databases, + but that's never been a real concern of mine. </para> </blockquote> </para> <para> - Things aren't quite that grim these days, however. Terry pretty much - sums up much of the thinking many of us have for Bugzilla, but there - is light on the horizon for database-independence! Here are some options: + Things aren't quite that grim these days, however. Terry + pretty much sums up much of the thinking many of us have + for Bugzilla, but there is light on the horizon for + database-independence! Here are some options: </para> <simplelist> <member> - <emphasis><ulink url="http://bugzilla.redhat.com/">Red Hat Bugzilla</ulink></emphasis>: - Runs a modified Bugzilla 2.8 atop an Oracle database. + <emphasis><ulink url="http://bugzilla.redhat.com/">Red + Hat Bugzilla</ulink></emphasis>: Runs a modified + Bugzilla 2.8 atop an Oracle database. </member> <member> - <emphasis><ulink url="http://sourceforge.net/projects/interzilla">Interzilla</ulink></emphasis>: - A project to run Bugzilla on Interbase. No code released yet, however. + <emphasis><ulink + url="http://sourceforge.net/projects/interzilla">Interzilla</ulink></emphasis>: A project to run Bugzilla on Interbase. No code released yet, however. </member> <member> - <emphasis>Bugzilla 3.0</emphasis>: One of the primary stated goals - is multiple database support. + <emphasis>Bugzilla 3.0</emphasis>: One of the primary + stated goals is multiple database support. </member> </simplelist> </answer> @@ -230,36 +247,40 @@ <qandaentry> <question> <para> - Why do the scripts say "/usr/bonsaitools/bin/perl" instead of - "/usr/bin/perl" or something else? + Why do the scripts say "/usr/bonsaitools/bin/perl" instead + of "/usr/bin/perl" or something else? </para> </question> <answer> <para> - Mozilla.org uses /usr/bonsaitools/bin/perl. The prime rule in making - submissions is "don't break bugzilla.mozilla.org". If it breaks it, your - patch will be reverted faster than you can do a diff. + Mozilla.org uses /usr/bonsaitools/bin/perl. The prime + rule in making submissions is "don't break + bugzilla.mozilla.org". If it breaks it, your patch will be + reverted faster than you can do a diff. </para> <para> - Here's Terry Weissman's comment, for some historical context: + Here's Terry Weissman's comment, for some historical + context: <blockquote> <para> - [This was] purely my own convention. I wanted a place to put a version of - Perl and other tools that was strictly under my control for the - various webtools, and not subject to anyone else. Edit it to point - to whatever you like. + [This was] purely my own convention. I wanted a place + to put a version of Perl and other tools that was + strictly under my control for the various webtools, + and not subject to anyone else. Edit it to point to + whatever you like. </para> <note> <para> - We always recommend that, if possible, you keep the path - as /usr/bonsaitools/bin/perl, and simply add a /usr/bonsaitools - and /usr/bonsaitools/bin directory, then symlink your version - of perl to /usr/bonsaitools/bin/perl. This will make upgrading + We always recommend that, if possible, you keep the + path as /usr/bonsaitools/bin/perl, and simply add a + /usr/bonsaitools and /usr/bonsaitools/bin directory, + then symlink your version of perl to + /usr/bonsaitools/bin/perl. This will make upgrading your Bugzilla much easier in the future. </para> <para> - Obviously, if you do not have root access to your Bugzilla - box, our suggestion is irrelevant. + Obviously, if you do not have root access to your + Bugzilla box, our suggestion is irrelevant. </para> </note> </blockquote> @@ -276,7 +297,8 @@ <note> <para> <emphasis>This section is no longer up-to-date.</emphasis> - Please see the section on "Red Hat Bugzilla" under "Variants" in The Bugzilla Guide. + Please see the section on "Red Hat Bugzilla" under + "Variants" in The Bugzilla Guide. </para> </note> </para> @@ -288,27 +310,29 @@ </question> <answer> <para> - Red Hat Bugzilla is arguably more user-friendly, customizable, and scalable - than stock Bugzilla. Check it out at - http://bugzilla.redhat.com and the sources at ftp://people.redhat.com/dkl/. - They've set their Bugzilla up to work with Oracle out of the box. - Note that Redhat Bugzilla is based upon the 2.8 Bugzilla tree; - Bugzilla has made some tremendous advances since the 2.8 release. - Why not download both Bugzillas to check out the differences for - yourself? + Red Hat Bugzilla is arguably more user-friendly, + customizable, and scalable than stock Bugzilla. Check it + out at http://bugzilla.redhat.com and the sources at + ftp://people.redhat.com/dkl/. They've set their Bugzilla + up to work with Oracle out of the box. Note that Redhat + Bugzilla is based upon the 2.8 Bugzilla tree; Bugzilla has + made some tremendous advances since the 2.8 release. Why + not download both Bugzillas to check out the differences + for yourself? </para> <para> - Dave Lawrence, the original Red Hat Bugzilla maintainer, mentions: + Dave Lawrence, the original Red Hat Bugzilla maintainer, + mentions: <blockquote> <para> - Somebody needs to take the ball and run with it. I'm the only - maintainer and am very pressed for time. + Somebody needs to take the ball and run with it. I'm + the only maintainer and am very pressed for time. </para> - </blockquote> - If you, or someone you know, has the time and expertise to do the integration - work so main-tree Bugzilla 2.12 and higher integrates the Red - Hat Bugzilla Oracle modifications, please donate your - time to supporting the Bugzilla project. + </blockquote> If you, or someone you know, has the time + and expertise to do the integration work so main-tree + Bugzilla 2.12 and higher integrates the Red Hat Bugzilla + Oracle modifications, please donate your time to + supporting the Bugzilla project. </para> </answer> </qandaentry> @@ -324,102 +348,123 @@ <emphasis>Dave Lawrence</emphasis>: <blockquote> <para> - For the record, we are not using any template type implementation for - the cosmetic changes maded to Bugzilla. It is just alot of html changes - in the code itself. I admit I may have gotten a little carried away with it - but the corporate types asked for a more standardized interface to match up - with other projects relating to Red Hat web sites. A lot of other web based - internal tools I am working on also look like Bugzilla. + For the record, we are not using any template type + implementation for the cosmetic changes maded to + Bugzilla. It is just alot of html changes in the code + itself. I admit I may have gotten a little carried + away with it but the corporate types asked for a more + standardized interface to match up with other projects + relating to Red Hat web sites. A lot of other web + based internal tools I am working on also look like + Bugzilla. </para> <para> - I do want to land the changes that I have made to Bugzilla but I may - have to back out a good deal and make a different version of Red Hat's - Bugzilla for checking in to CVS. Especially the cosmetic changes because it - seems they may not fit the general public. I will do that as soon as I can. - I also still do my regular QA responsibilities along with Bugzilla so time - is difficult sometimes to come by. + I do want to land the changes that I have made to + Bugzilla but I may have to back out a good deal and + make a different version of Red Hat's Bugzilla for + checking in to CVS. Especially the cosmetic changes + because it seems they may not fit the general public. + I will do that as soon as I can. I also still do my + regular QA responsibilities along with Bugzilla so + time is difficult sometimes to come by. </para> <para> - There are also a good deal of other changes that were requested by - management for things like support contracts and different permission - groups for making bugs private. Here is a short list of the major + There are also a good deal of other changes that were + requested by management for things like support + contracts and different permission groups for making + bugs private. Here is a short list of the major changes that have been made: </para> <orderedlist> <listitem> <para> - No enum types. All old enum types are now separate smaller tables. + No enum types. All old enum types are now separate + smaller tables. </para> </listitem> <listitem> <para> - No bit wise operations. Not all databases support this so they were - changed to a more generic way of doing this task + No bit wise operations. Not all databases support + this so they were changed to a more generic way of + doing this task </para> </listitem> <listitem> <para> - Bug reports can only be altered by the reporter, assignee, or a - privileged bugzilla user. The rest of the world can see the bug but in - a non-changeable format (unless the bug has been marked private). They - can however add comments, add and remove themselves from the CC list + Bug reports can only be altered by the reporter, + assignee, or a privileged bugzilla user. The rest + of the world can see the bug but in a + non-changeable format (unless the bug has been + marked private). They can however add comments, + add and remove themselves from the CC list </para> </listitem> <listitem> <para> - Different group scheme. Each group has an id number related to it. - There is a user_group table which contains userid to groupid mappings - to determine which groups each user belongs to. Additionally there is - a bug_group table that has bugid to groupid mappings to show which - groups can see a particular bug. If there are no entries for a bug in - this table then the bug is public. + Different group scheme. Each group has an id + number related to it. There is a user_group table + which contains userid to groupid mappings to + determine which groups each user belongs to. + Additionally there is a bug_group table that has + bugid to groupid mappings to show which groups can + see a particular bug. If there are no entries for + a bug in this table then the bug is public. </para> </listitem> <listitem> <para> - Product groups. product_table created to only allow certain products to - be visible for certain groups in both bug entry and query. This was + Product groups. product_table created to only + allow certain products to be visible for certain + groups in both bug entry and query. This was particulary helpful for support contracts. </para> </listitem> <listitem> <para> - Of course many (too many) changes to Bugzilla code itself to allow use - with Oracle and still allow operation with Mysql if so desired. - Currently if you use Mysql it is set to use Mysql's old permission - scheme to keep breakage to a minimum. Hopefully one day this will - standardize on one style which may of course be something completely + Of course many (too many) changes to Bugzilla code + itself to allow use with Oracle and still allow + operation with Mysql if so desired. Currently if + you use Mysql it is set to use Mysql's old + permission scheme to keep breakage to a minimum. + Hopefully one day this will standardize on one + style which may of course be something completely different. </para> </listitem> <listitem> <para> - Uses Text::Template perl module for rendering of the dynamic HTML pages - such as enter_bug.cgi, query.cgi, bug_form.pl, and for the header and - footer parts of the page. This allows the html to be separate from the - perl code for customizing the look and feel of the page to one's - preference. + Uses Text::Template perl module for rendering of + the dynamic HTML pages such as enter_bug.cgi, + query.cgi, bug_form.pl, and for the header and + footer parts of the page. This allows the html to + be separate from the perl code for customizing the + look and feel of the page to one's preference. </para> </listitem> <listitem> <para> - There are many other smaller changes. There is also a port to Oracle - that I have been working on as time permits but is not completely - finished but somewhat usable. I will merge it into our standard code - base when it becomes production quality. Unfortunately there will have - to be some conditionals in the code to make it work with other than - Oracle due to some differences between Oracle and Mysql. + There are many other smaller changes. There is + also a port to Oracle that I have been working on + as time permits but is not completely finished but + somewhat usable. I will merge it into our standard + code base when it becomes production quality. + Unfortunately there will have to be some + conditionals in the code to make it work with + other than Oracle due to some differences between + Oracle and Mysql. </para> </listitem> </orderedlist> <para> - Both the Mysql and Oracle versions of our current code base are - available from ftp://people.redhat.com/dkl. If Terry/Tara wants I can submit - patch files for all of the changes I have made and he can determine what is - suitable for addition to the main bugzilla cade base. But for me to commit - changes to the actual CVS I will need to back out alot of things that are - not suitable for the rest of the Bugzilla community. I am open to - suggestions. + Both the Mysql and Oracle versions of our current code + base are available from ftp://people.redhat.com/dkl. + If Terry/Tara wants I can submit patch files for all + of the changes I have made and he can determine what + is suitable for addition to the main bugzilla cade + base. But for me to commit changes to the actual CVS I + will need to back out alot of things that are not + suitable for the rest of the Bugzilla community. I am + open to suggestions. </para> </blockquote> </para> @@ -437,57 +482,66 @@ <note> <para> This information is somewhat dated; I last updated it - 7 June 2000. Please see the "Variants" section of "The Bugzilla Guide" - for more up-to-date information regarding Red Hat Bugzilla. + 7 June 2000. Please see the "Variants" section of + "The Bugzilla Guide" for more up-to-date information + regarding Red Hat Bugzilla. </para> - </note> - <emphasis>Dave Lawrence</emphasis>: + </note> <emphasis>Dave Lawrence</emphasis>: <blockquote> <para> - I suppose the current thread warrants an update on the status of - Oracle and bugzilla ;) We have now been running Bugzilla 2.8 on - Oracle for the last two days in our production environment. I - tried to do as much testing as possible with it before going live - which is some of the reason for the long delay. I did not get - enough feedback as I would have liked from internal developers to - help weed out any bugs still left so I said "Fine, i will take it - live and then I will get the feedback I want :)" So it is now - starting to stabilize and it running quite well after working - feverishly the last two days fixing problems as soon as they came - in from the outside world. The current branch in cvs is up2date if - anyone would like to grab it and try it out. The oracle _setup.pl - is broken right now due to some last minute changes but I will - update that soon. Therefore you would probably need to create the - database tables the old fashioned way using the supplied sql - creation scripts located in the ./oracle directory. We have heavy - optimizations in the database it self thanks to the in-house DBA - here at Red Hat so it is running quite fast. The database itself - is located on a dual PII450 with 1GB ram and 14 high voltage - differential raided scsi drives. The tables and indexes are - partitioned in 4 chuncks across the raided drive which is nice - because when ever you need to do a full table scan, it is actually - starting in 4 different locations on 4 different drives - simultaneously. And the indexes of course are on separate drives - from the data so that speeds things up tremendously. When I can - find the time I will document all that we have done to get this - thing going to help others that may need it. + I suppose the current thread warrants an update + on the status of Oracle and bugzilla ;) We have now + been running Bugzilla 2.8 on Oracle for the last two + days in our production environment. I tried to do as + much testing as possible with it before going live + which is some of the reason for the long delay. I did + not get enough feedback as I would have liked from + internal developers to help weed out any bugs still + left so I said "Fine, i will take it live and then I + will get the feedback I want :)" So it is now starting + to stabilize and it running quite well after working + feverishly the last two days fixing problems as soon + as they came in from the outside world. The current + branch in cvs is up2date if anyone would like to grab + it and try it out. The oracle _setup.pl is broken + right now due to some last minute changes but I will + update that soon. Therefore you would probably need to + create the database tables the old fashioned way using + the supplied sql creation scripts located in the + ./oracle directory. We have heavy optimizations in the + database it self thanks to the in-house DBA here at + Red Hat so it is running quite fast. The database + itself is located on a dual PII450 with 1GB ram and 14 + high voltage differential raided scsi drives. The + tables and indexes are partitioned in 4 chuncks across + the raided drive which is nice because when ever you + need to do a full table scan, it is actually starting + in 4 different locations on 4 different drives + simultaneously. And the indexes of course are on + separate drives from the data so that speeds things up + tremendously. When I can find the time I will + document all that we have done to get this thing going + to help others that may need it. </para> <para> - As Matt has mentioned it is still using out-dated code and with a - little help I would like to bring everything up to date for - eventual incorporation with the main cvs tree. Due to other - duties I have with the company any help with this wiould be - appreciated. What we are using now is what I call a best first - effort. It definitely can be improved on and may even need - complete rewrites in a lot of areas. A lot of changes may have to - be made in the way Bugzilla does things currently to make this - transition to a more generic database interface. Fortunately when - making the Oracle changes I made sure I didn't do anything that I - would consider Oracle specific and could not be easily done with - other databases. Alot of the sql statements need to be broken up - into smaller utilities that themselves would need to make - decisions on what database they are using but the majority of the - code can be made database neutral. + As Matt has mentioned it is still using out-dated code + and with a little help I would like to bring + everything up to date for eventual incorporation with + the main cvs tree. Due to other duties I have with the + company any help with this wiould be appreciated. What + we are using now is what I call a best first effort. + It definitely can be improved on and may even need + complete rewrites in a lot of areas. A lot of changes + may have to be made in the way Bugzilla does things + currently to make this transition to a more generic + database interface. Fortunately when making the + Oracle changes I made sure I didn't do anything that + I would consider Oracle specific and could not be + easily done with other databases. Alot of the sql + statements need to be broken up into smaller utilities + that themselves would need to make decisions on what + database they are using but the majority of the code + can be made database neutral. </para> </blockquote> </para> @@ -501,15 +555,15 @@ <para> <note> <para> - Loki's "Fenris" Bugzilla is based upon the (now ancient) Bugzilla 2.8 - tree, and is no longer actively maintained. + Loki's "Fenris" Bugzilla is based upon the (now ancient) + Bugzilla 2.8 tree, and is no longer actively maintained. It works well enough for Loki. Additionally, the major - differences in Fenris have now been integrated into - the main source tree of Bugzilla, so there's not much - reason to go grab the source. I leave this section of the - FAQ principally for historical interest, but unless Loki has further - input into Bugzilla's future, it will be deprecated in future versions - of the Guide. + differences in Fenris have now been integrated into the + main source tree of Bugzilla, so there's not much reason + to go grab the source. I leave this section of the FAQ + principally for historical interest, but unless Loki has + further input into Bugzilla's future, it will be + deprecated in future versions of the Guide. </para> </note> </para> @@ -522,22 +576,25 @@ </question> <answer> <para> - Loki Games has a customized version of Bugzilla available at - http://fenris.lokigames.com. From that page, + Loki Games has a customized version of Bugzilla available + at http://fenris.lokigames.com. From that page, <blockquote> <para> - You may have noticed that Fenris is a fork from Bugzilla-- our - patches weren't suitable for integration --and a few people have - expressed interest in the code. Fenris has one major improvement - over Bugzilla, and that is individual comments are not appended - onto a string blob, they are stored as a record in a separate - table. This allows you to, for instance, separate comments out - according to privilege levels in case your bug database could - contain sensitive information not for public eyes. We also provide - things like email hiding to protect user's privacy, additional - fields such as 'user_affected' in case someone enters someone - else's bug, comment editing and deletion, and more conditional - system variables than Bugzilla does (turn off attachments, + You may have noticed that Fenris is a fork from + Bugzilla-- our patches weren't suitable for + integration --and a few people have expressed interest + in the code. Fenris has one major improvement over + Bugzilla, and that is individual comments are not + appended onto a string blob, they are stored as a + record in a separate table. This allows you to, for + instance, separate comments out according to privilege + levels in case your bug database could contain + sensitive information not for public eyes. We also + provide things like email hiding to protect user's + privacy, additional fields such as 'user_affected' in + case someone enters someone else's bug, comment + editing and deletion, and more conditional system + variables than Bugzilla does (turn off attachments, qacontact, etc.). </para> </blockquote> @@ -553,9 +610,9 @@ </question> <answer> <para> - Raphael Barrerro <raistlin@lokigames.com>. - Michael Vance created the initial fork, but no longer - maintains the project. + Raphael Barrerro <raistlin@lokigames.com>. Michael + Vance created the initial fork, but no longer maintains + the project. </para> </answer> </qandaentry> @@ -574,8 +631,9 @@ <para> <note> <para> - The title of this section doesn't mean you're a PHB -- it just means - you probably HAVE a PHB who wants to know this :) + The title of this section doesn't mean you're a PHB -- it + just means you probably HAVE a PHB who wants to know this + :) </para> </note> </para> @@ -583,14 +641,15 @@ <qandaentry> <question> <para> - Is Bugzilla web-based or do you have to have specific software or - specific operating system on your machine? + Is Bugzilla web-based or do you have to have specific + software or specific operating system on your machine? </para> </question> <answer> <para> - It is web and e-mail based. You can edit bugs by sending specially - formatted email to a properly configured Bugzilla, or control via the web. + It is web and e-mail based. You can edit bugs by sending + specially formatted email to a properly configured + Bugzilla, or control via the web. </para> </answer> </qandaentry> @@ -598,17 +657,18 @@ <qandaentry> <question> <para> - Has anyone you know of already done any Bugzilla integration with - Perforce (SCM software)? + Has anyone you know of already done any Bugzilla + integration with Perforce (SCM software)? </para> </question> <answer> <para> - Yes! You can find more information elsewhere in "The Bugzilla - Guide" in the "Integration with Third-Party Products" section. - The section on Perforce isn't very large, but as the maintainer - of the Guide is charged with Perforce/Bugzilla integration by - his company, you can expect this section to grow. + Yes! You can find more information elsewhere in "The + Bugzilla Guide" in the "Integration with Third-Party + Products" section. The section on Perforce isn't very + large, but as the maintainer of the Guide is charged with + Perforce/Bugzilla integration by his company, you can + expect this section to grow. </para> </answer> </qandaentry> @@ -624,8 +684,8 @@ Absolutely! You can track up to a "soft-limit" of around 64 individual "Products", that can each be composed of as many "Components" as you want. Check the Administration - section of the Bugzilla Guide for more information regarding - setting up Products and Components. + section of the Bugzilla Guide for more information + regarding setting up Products and Components. </para> </answer> </qandaentry> @@ -633,8 +693,9 @@ <qandaentry> <question> <para> - 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? + 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? </para> </question> <answer> @@ -647,18 +708,20 @@ <qandaentry> <question> <para> - Does Bugzilla allow attachments (text, screenshots, urls etc)? If yes, - are there any that are NOT allowed? + Does Bugzilla allow attachments (text, screenshots, urls + etc)? If yes, are there any that are NOT allowed? </para> </question> <answer> <para> - Yes. There are many specific MIME-types that are pre-defined by Bugzilla, - but you may specify any arbitrary MIME-type you need when you - upload the file. Since all attachments are stored in the database, - however, I recommend storing large binary attachments elsewhere - in the web server's file system and providing a hyperlink - as a comment, or in the provided "URL" field in the bug report. + Yes. There are many specific MIME-types that are + pre-defined by Bugzilla, but you may specify any arbitrary + MIME-type you need when you upload the file. Since all + attachments are stored in the database, however, I + recommend storing large binary attachments elsewhere in + the web server's file system and providing a hyperlink as + a comment, or in the provided "URL" field in the bug + report. </para> </answer> </qandaentry> @@ -666,16 +729,17 @@ <qandaentry> <question> <para> - 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? + 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? </para> </question> <answer> <para> - Yes. However, modifying some fields, notably those related to bug - progression states, also require adjusting the program logic to - compensate for the change. + Yes. However, modifying some fields, notably those + related to bug progression states, also require adjusting + the program logic to compensate for the change. </para> </answer> </qandaentry> @@ -684,70 +748,65 @@ <qandaentry> <question> <para> - 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? + 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? </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. + 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. +> 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> </answer> </qandaentry> <qandaentry> <question> <para> - Does Bugzilla provide any reporting features, metrics, graphs, etc? You - know, the type of stuff that management likes to see. :) + Does Bugzilla provide any reporting features, metrics, + graphs, etc? You know, the type of stuff that management + likes to see. :) </para> </question> <answer> <para> - Yes. Look at <ulink url="http://bugzilla.mozilla.org/reports.cgi"> - http://bugzilla.mozilla.org/reports.cgi</ulink> for basic reporting - facilities. + Yes. Look at <ulink + url="http://bugzilla.mozilla.org/reports.cgi"> http://bugzilla.mozilla.org/reports.cgi</ulink> for basic reporting facilities. </para> <para> - For more advanced reporting, I recommend hooking up a professional - reporting package, such as Crystal Reports, and use ODBC to access - the MySQL database. You can do a lot through the Query page of - Bugzilla as well, but right now Advanced Reporting is much - better accomplished through third-party utilities that can - interface with the database directly. + For more advanced reporting, I recommend hooking up a + professional reporting package, such as Crystal Reports, + and use ODBC to access the MySQL database. You can do a + lot through the Query page of Bugzilla as well, but right + now Advanced Reporting is much better accomplished through + third-party utilities that can interface with the database + directly. </para> <para> Advanced Reporting is a Bugzilla 3.X proposed feature. @@ -758,15 +817,16 @@ someone to take it on if they want it. FAQ is a good place for it. <qandaentry> <question> <para> - 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? + 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? </para> </question> <answer> <para> - Email notification is user-configurable. The bug id and Topic - of the bug report accompany each email notification, along with - a list of the changes made. + Email notification is user-configurable. The bug id and + Topic of the bug report accompany each email notification, + along with a list of the changes made. </para> </answer> </qandaentry> @@ -788,22 +848,24 @@ someone to take it on if they want it. FAQ is a good place for it. <qandaentry> <question> <para> - If there is email notification, do users have to have any particular - type of email application? + If there is email notification, do users have to have any + particular type of email application? </para> </question> <answer> <para> - Bugzilla email is sent in plain text, the most compatible mail format - on the planet. + Bugzilla email is sent in plain text, the most compatible + mail format on the planet. <note> <para> - If you decide to use the bugzilla_email integration features - to allow Bugzilla to record responses to mail with the associated bug, - you may need to caution your users to set their mailer to "respond - to messages in the format in which they were sent". For security reasons - Bugzilla ignores HTML tags in comments, and if a user sends HTML-based - email into Bugzilla the resulting comment looks downright awful. + If you decide to use the bugzilla_email integration + features to allow Bugzilla to record responses to mail + with the associated bug, you may need to caution your + users to set their mailer to "respond to messages in + the format in which they were sent". For security + reasons Bugzilla ignores HTML tags in comments, and if + a user sends HTML-based email into Bugzilla the + resulting comment looks downright awful. </para> </note> </para> @@ -813,17 +875,19 @@ someone to take it on if they want it. FAQ is a good place for it. <qandaentry> <question> <para> - 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.? + 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.? </para> </question> <answer> <para> - Yes. Place yourself in the "cc" field of the bug you wish to monitor. - Then change your "Notify me of changes to" field in the Email Settings - tab of the User Preferences screen in Bugzilla to the "Only those - bugs which I am listed on the CC line" option. + Yes. Place yourself in the "cc" field of the bug you wish + to monitor. Then change your "Notify me of changes to" + field in the Email Settings tab of the User Preferences + screen in Bugzilla to the "Only those bugs which I am + listed on the CC line" option. </para> </answer> </qandaentry> @@ -831,32 +895,34 @@ someone to take it on if they want it. FAQ is a good place for it. <qandaentry> <question> <para> - 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 - and export that data to MS Excel, could I do that? + 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 and + export that data to MS Excel, could I do that? </para> </question> <answer> <para> - Mozilla allows data export through a custom DTD in XML format. - It does not, however, export to specific formats other than the - XML Mozilla DTD. Importing the data into Excel or any other application - is left as an exercise for the reader. + Mozilla allows data export through a custom DTD in XML + format. It does not, however, export to specific formats + other than the XML Mozilla DTD. Importing the data into + Excel or any other application is left as an exercise for + the reader. </para> <para> - If you create import filters to other applications from Mozilla's XML, - please submit your modifications for inclusion in future Bugzilla - distributions. + If you create import filters to other applications from + Mozilla's XML, please submit your modifications for + inclusion in future Bugzilla distributions. </para> <para> - As for data import, any application can send data to Bugzilla through - the HTTP protocol, or through Mozilla's XML API. However, it seems - kind of silly to put another front-end in front of Bugzilla; - it makes more sense to create a simplified bug submission form in - HTML. You can find an excellent example at - <ulink url="http://www.mozilla.org/quality/help/bugzilla-helper.html"> - http://www.mozilla.org/quality/help/bugzilla-helper.html</ulink> + As for data import, any application can send data to + Bugzilla through the HTTP protocol, or through Mozilla's + XML API. However, it seems kind of silly to put another + front-end in front of Bugzilla; it makes more sense to + create a simplified bug submission form in HTML. You can + find an excellent example at <ulink + url="http://www.mozilla.org/quality/help/bugzilla-helper.html"> http://www.mozilla.org/quality/help/bugzilla-helper.html</ulink> </para> </answer> </qandaentry> @@ -864,9 +930,9 @@ 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? + 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> @@ -879,16 +945,16 @@ someone to take it on if they want it. FAQ is a good place for it. <qandaentry> <question> <para> - Has anyone converted Bugzilla to another language to be used in other - countries? Is it localizable? + Has anyone converted Bugzilla to another language to be + used in other countries? Is it localizable? </para> </question> <answer> <para> - 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. + 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. </para> </answer> </qandaentry> @@ -896,8 +962,8 @@ someone to take it on if they want it. FAQ is a good place for it. <qandaentry> <question> <para> - Can a user create and save reports? Can they do this in Word format? - Excel format? + Can a user create and save reports? Can they do this in + Word format? Excel format? </para> </question> <answer> @@ -923,13 +989,15 @@ someone to take it on if they want it. FAQ is a good place for it. <qandaentry> <question> <para> - Can a user modify an existing report and then save it into another name? + Can a user modify an existing report and then save it into + another name? </para> </question> <answer> <para> - You can save an unlimited number of queries in Bugzilla. You are free - to modify them and rename them to your heart's desire. + You can save an unlimited number of queries in Bugzilla. + You are free to modify them and rename them to your + heart's desire. </para> </answer> </qandaentry> @@ -937,14 +1005,15 @@ someone to take it on if they want it. FAQ is a good place for it. <qandaentry> <question> <para> - Does Bugzilla have the ability to search by word, phrase, compound - search? + Does Bugzilla have the ability to search by word, phrase, + compound search? </para> </question> <answer> <para> - You have no idea. Bugzilla's query interface, particularly with the - advanced Boolean operators, is incredibly versatile. + You have no idea. Bugzilla's query interface, + particularly with the advanced Boolean operators, is + incredibly versatile. </para> </answer> </qandaentry> @@ -952,8 +1021,8 @@ someone to take it on if they want it. FAQ is a good place for it. <qandaentry> <question> <para> - Can the admin person establish separate group and individual user - privileges? + Can the admin person establish separate group and + individual user privileges? </para> </question> <answer> @@ -966,15 +1035,17 @@ someone to take it on if they want it. FAQ is a good place for it. <qandaentry> <question> <para> - 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? + 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? </para> </question> <answer> <para> - Bugzilla does not lock records. It provides mid-air collision detection, - and offers the offending user a choice of options to deal with the conflict. + Bugzilla does not lock records. It provides mid-air + collision detection, and offers the offending user a + choice of options to deal with the conflict. </para> </answer> </qandaentry> @@ -987,10 +1058,10 @@ someone to take it on if they want it. FAQ is a good place for it. </question> <answer> <para> - MySQL, the database back-end for Bugzilla, allows hot-backup of data. - You can find strategies for dealing with backup considerations - at <ulink url="http://www.mysql.com/doc/B/a/Backup.html"> - http://www.mysql.com/doc/B/a/Backup.html</ulink> + MySQL, the database back-end for Bugzilla, allows + hot-backup of data. You can find strategies for dealing + with backup considerations at <ulink + url="http://www.mysql.com/doc/B/a/Backup.html"> http://www.mysql.com/doc/B/a/Backup.html</ulink> </para> </answer> </qandaentry> @@ -1003,8 +1074,8 @@ someone to take it on if they want it. FAQ is a good place for it. </question> <answer> <para> - Yes. However, commits to the database must wait - until the tables are unlocked. Bugzilla databases are typically + 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. </para> </answer> @@ -1013,29 +1084,33 @@ someone to take it on if they want it. FAQ is a good place for it. <qandaentry> <question> <para> - 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. + 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. </para> </question> <answer> <para> - If Bugzilla is set up correctly from the start, continuing maintenance needs - are minimal and can be completed by unskilled labor. Things like rotate - backup tapes and check log files for the word "error". + If Bugzilla is set up correctly from the start, continuing + maintenance needs are minimal and can be completed by + unskilled labor. Things like rotate backup tapes and + check log files for the word "error". </para> <para> - Commercial Bug-tracking software typically costs somewhere upwards - of $20,000 or more for 5-10 floating licenses. Bugzilla consultation - is available from skilled members of the newsgroup. + Commercial Bug-tracking software typically costs somewhere + upwards of $20,000 or more for 5-10 floating licenses. + Bugzilla consultation is available from skilled members of + the newsgroup. </para> <para> - As an example, as of this writing I typically charge - $115 for the first hour, and $89 each hour thereafter - for consulting work. It takes me three to five hours to make Bugzilla - happy on a Development installation of Linux-Mandrake. + As an example, as of this writing I typically charge $115 + for the first hour, and $89 each hour thereafter for + consulting work. It takes me three to five hours to make + Bugzilla happy on a Development installation of + Linux-Mandrake. </para> </answer> </qandaentry> @@ -1043,20 +1118,22 @@ someone to take it on if they want it. FAQ is a good place for it. <qandaentry> <question> <para> - 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? + 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? </para> </question> <answer> <para> - It all depends on your level of commitment. Someone with much Bugzilla - experience can get you up and running in less than a day, and - your Bugzilla install can run untended for years. If your - Bugzilla strategy is critical to your business workflow, hire somebody - with reasonable UNIX or Perl skills to handle your process management and + It all depends on your level of commitment. Someone with + much Bugzilla experience can get you up and running in + less than a day, and your Bugzilla install can run + untended for years. If your Bugzilla strategy is critical + to your business workflow, hire somebody with reasonable + UNIX or Perl skills to handle your process management and bug-tracking maintenance & customization. </para> </answer> @@ -1065,14 +1142,16 @@ someone to take it on if they want it. FAQ is a good place for it. <qandaentry> <question> <para> - Is there any licensing fee or other fees for using Bugzilla? Any - out-of-pocket cost other than the bodies needed as identified above? + Is there any licensing fee or other fees for using + Bugzilla? Any out-of-pocket cost other than the bodies + needed as identified above? </para> </question> <answer> <para> - No. MySQL asks, if you find their product valuable, that you purchase - a support contract from them that suits your needs. + No. MySQL asks, if you find their product valuable, that + you purchase a support contract from them that suits your + needs. </para> </answer> </qandaentry> @@ -1088,10 +1167,8 @@ someone to take it on if they want it. FAQ is a good place for it. </question> <answer> <para> - Check <ulink url="http://www.mozilla.org/projects/bugzilla/"> - http://www.mozilla.org/projects/bugzilla/</ulink> for details. - Once you download it, untar it, read the README and - the Bugzilla Guide. + Check <ulink + url="http://www.mozilla.org/projects/bugzilla/"> http://www.mozilla.org/projects/bugzilla/</ulink> for details. Once you download it, untar it, read the Bugzilla Guide. </para> </answer> </qandaentry> @@ -1104,8 +1181,8 @@ someone to take it on if they want it. FAQ is a good place for it. </question> <answer> <para> - Installation on Windows NT has its own section in - "The Bugzilla Guide". + Installation on Windows NT has its own section in "The + Bugzilla Guide". </para> </answer> </qandaentry> @@ -1131,16 +1208,19 @@ someone to take it on if they want it. FAQ is a good place for it. <qandaentry> <question> <para> - How do I completely disable MySQL security if it's giving me problems - (I've followed the instructions in the README!)? + 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!)? </para> </question> <answer> <para> - Run mysql like this: "mysqld --skip-grant-tables". Please remember <emphasis>this - makes mysql as secure as taping a $100 to the floor of a football stadium - bathroom for safekeeping.</emphasis> Please read the Security section of the - Administration chapter of "The Bugzilla Guide" before proceeding. + Run mysql like this: "mysqld --skip-grant-tables". Please + remember <emphasis>this makes mysql as secure as taping a + $100 to the floor of a football stadium bathroom for + safekeeping.</emphasis> Please read the Security + section of the Administration chapter of "The Bugzilla + Guide" before proceeding. </para> </answer> </qandaentry> @@ -1153,10 +1233,11 @@ someone to take it on if they want it. FAQ is a good place for it. </question> <answer> <para> - The Bugzilla code has not undergone a complete security audit. - It is recommended that you closely examine permissions on your Bugzilla - installation, and follow the recommended security guidelines found - in the README and in The Bugzilla Guide. + The Bugzilla code has not undergone a complete security + audit. It is recommended that you closely examine + permissions on your Bugzilla installation, and follow the + recommended security guidelines found in The Bugzilla + Guide. </para> </answer> </qandaentry> @@ -1165,16 +1246,17 @@ someone to take it on if they want it. FAQ is a good place for it. <qandaentry> <question> <para> - 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. + 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. </para> </question> <answer> <para> - This is a common problem, related to running out of file descriptors. - Simply add "ulimit -n unlimited" to the script which starts - mysqld. + This is a common problem, related to running out of file + descriptors. Simply add "ulimit -n unlimited" to the + script which starts mysqld. </para> </answer> </qandaentry> @@ -1186,14 +1268,14 @@ someone to take it on if they want it. FAQ is a good place for it. <qandaentry> <question> <para> - I have a user who doesn't want to receive any more email from Bugzilla. - How do I stop it entirely for this user? + I have a user who doesn't want to receive any more email + from Bugzilla. How do I stop it entirely for this user? </para> </question> <answer> <para> - With the email changes to 2.12, the user should be able to set - this in user email preferences. + With the email changes to 2.12, the user should be able to + set this in user email preferences. </para> </answer> </qandaentry> @@ -1201,14 +1283,15 @@ someone to take it on if they want it. FAQ is a good place for it. <qandaentry> <question> <para> - I'm evaluating/testing Bugzilla, and don't want it to send email to - anyone but me. How do I do it? + I'm evaluating/testing Bugzilla, and don't want it to send + email to anyone but me. How do I do it? </para> </question> <answer> <para> - Edit the param for the mail text. Replace "To:" with "X-Real-To:", - replace "Cc:" with "X-Real-CC:", and add a "To: (myemailaddress)". + Edit the param for the mail text. Replace "To:" with + "X-Real-To:", replace "Cc:" with "X-Real-CC:", and add a + "To: (myemailaddress)". </para> </answer> </qandaentry> @@ -1216,17 +1299,15 @@ someone to take it on if they want it. FAQ is a good place for it. <qandaentry> <question> <para> - I want whineatnews.pl to whine at something more, or other than, only new - bugs. How do I do it? + I want whineatnews.pl to whine at something more, or other + than, only new bugs. How do I do it? </para> </question> <answer> <para> - Try Klaas Freitag's excellent patch for "whineatassigned" functionality. - You can find it at<ulink url=" http://bugzilla.mozilla.org/show_bug.cgi?id=6679"> - http://bugzilla.mozilla.org/show_bug.cgi?id=6679</ulink>. This - patch is against an older version of Bugzilla, so you must apply - the diffs manually. + Try Klaas Freitag's excellent patch for "whineatassigned" + functionality. You can find it at<ulink url=" + http://bugzilla.mozilla.org/show_bug.cgi?id=6679"> http://bugzilla.mozilla.org/show_bug.cgi?id=6679</ulink>. This patch is against an older version of Bugzilla, so you must apply the diffs manually. </para> </answer> </qandaentry> @@ -1234,22 +1315,23 @@ someone to take it on if they want it. FAQ is a good place for it. <qandaentry> <question> <para> - I don't like/want to use Procmail to hand mail off to bug_email.pl. - What alternatives do I have? + I don't like/want to use Procmail to hand mail off to + bug_email.pl. What alternatives do I have? </para> </question> <answer> <para> - You can call bug_email.pl directly from your aliases file, with - an entry like this: + You can call bug_email.pl directly from your aliases file, + with an entry like this: <blockquote> <para> - bugzilla-daemon: "|/usr/local/bin/bugzilla/contrib/bug_email.pl" + bugzilla-daemon: + "|/usr/local/bin/bugzilla/contrib/bug_email.pl" </para> - </blockquote> - However, this is fairly nasty and subject to problems; you also - need to set up your smrsh (sendmail restricted shell) to allow - it. In a pinch, though, it can work. + </blockquote> However, this is fairly nasty and subject to + problems; you also need to set up your smrsh (sendmail + restricted shell) to allow it. In a pinch, though, it can + work. </para> </answer> </qandaentry> @@ -1257,13 +1339,15 @@ someone to take it on if they want it. FAQ is a good place for it. <qandaentry> <question> <para> - How do I set up the email interface to submit/change bugs via email? + How do I set up the email interface to submit/change bugs + via email? </para> </question> <answer> <para> - You can find an updated README.mailif file in the contrib/ directory - of your Bugzilla distribution that walks you through the setup. + You can find an updated README.mailif file in the contrib/ + directory of your Bugzilla distribution that walks you + through the setup. </para> </answer> </qandaentry> @@ -1271,28 +1355,29 @@ someone to take it on if they want it. FAQ is a good place for it. <qandaentry> <question> <para> - Email takes FOREVER to reach me from bugzilla -- it's extremely slow. - What gives? + Email takes FOREVER to reach me from bugzilla -- it's + extremely slow. What gives? </para> </question> <answer> <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!) + 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. + "-ODeliveryMode=background". This prevents Sendmail from + hanging your Bugzilla Perl processes if the domain to + which it must send mail is unavailable. </para> <para> - This is now a configurable parameter called "sendmailnow", available - from editparams.cgi. + This is now a configurable parameter called "sendmailnow", + available from editparams.cgi. </para> </answer> </qandaentry> @@ -1305,15 +1390,16 @@ someone to take it on if they want it. FAQ is a good place for it. </question> <answer> <para> - Double-check that you have not turned off email in your user preferences. - Confirm that Bugzilla is able to send email by visiting the "Log In" - link of your Bugzilla installation and clicking the "Email me a password" - button after entering your email address. + Double-check that you have not turned off email in your + user preferences. Confirm that Bugzilla is able to send + email by visiting the "Log In" link of your Bugzilla + installation and clicking the "Email me a password" button + after entering your email address. </para> <para> - If you never receive mail from Bugzilla, chances you do not have - sendmail in "/usr/lib/sendmail". Ensure sendmail lives in, or is symlinked - to, "/usr/lib/sendmail". + If you never receive mail from Bugzilla, chances you do + not have sendmail in "/usr/lib/sendmail". Ensure sendmail + lives in, or is symlinked to, "/usr/lib/sendmail". </para> </answer> </qandaentry> @@ -1330,10 +1416,11 @@ someone to take it on if they want it. FAQ is a good place for it. </question> <answer> <para> - Red Hat Bugzilla, mentioned above, works with Oracle. The current version - from Mozilla.org does not have this capability. Unfortunately, though - you will sacrifice a lot of the really great features available in - Bugzilla 2.10 and 2.12 if you go with the 2.8-based Redhat version. + Red Hat Bugzilla, mentioned above, works with Oracle. The + current version from Mozilla.org does not have this + capability. Unfortunately, though you will sacrifice a + lot of the really great features available in Bugzilla + 2.10 and 2.12 if you go with the 2.8-based Redhat version. </para> </answer> </qandaentry> @@ -1341,25 +1428,30 @@ someone to take it on if they want it. FAQ is a good place for it. <qandaentry> <question> <para> - Bugs are missing from queries, but exist in the database (and I can pull - them up by specifying the bug ID). What's wrong? + Bugs are missing from queries, but exist in the database + (and I can pull them up by specifying the bug ID). What's + wrong? </para> </question> <answer> <para> - You've almost certainly enabled the "shadow database", but for some - reason it hasn't been updated for all your bugs. This is the database - against which queries are run, so that really complex or slow queries won't - lock up portions of the database for other users. You can turn off the - shadow database in editparams.cgi. If you wish to continue using the shadow - database, then as your "bugs" user run "./syncshadowdb -syncall" from the - command line in the bugzilla installation directory to recreate your shadow - database. After it finishes, be sure to check the params and make sure that - "queryagainstshadowdb" is still turned on. The syncshadowdb program turns it - off if it was on, and is supposed to turn it back on when completed; that - way, if it crashes in the middle of recreating the database, it will stay - off forever until someone turns it back on by hand. Apparently, it doesn't - always do that yet. + You've almost certainly enabled the "shadow database", + but for some reason it hasn't been updated for all your + bugs. This is the database against which queries are run, + so that really complex or slow queries won't lock up + portions of the database for other users. You can turn off + the shadow database in editparams.cgi. If you wish to + continue using the shadow database, then as your "bugs" + user run "./syncshadowdb -syncall" from the command line + in the bugzilla installation directory to recreate your + shadow database. After it finishes, be sure to check the + params and make sure that "queryagainstshadowdb" is still + turned on. The syncshadowdb program turns it off if it was + on, and is supposed to turn it back on when completed; + that way, if it crashes in the middle of recreating the + database, it will stay off forever until someone turns it + back on by hand. Apparently, it doesn't always do that + yet. </para> </answer> </qandaentry> @@ -1367,18 +1459,20 @@ someone to take it on if they want it. FAQ is a good place for it. <qandaentry> <question> <para> - I think my database might be corrupted, or contain invalid entries. What - do I do? + I think my database might be corrupted, or contain invalid + entries. What do I do? </para> </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 "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... </para> </answer> </qandaentry> @@ -1391,12 +1485,14 @@ someone to take it on if they want it. FAQ is a good place for it. </question> <answer> <para> - There is no facility in Bugzilla itself to do this. It's also generally - not a smart thing to do if you don't know exactly what you're doing. - However, if you understand SQL you can use the mysqladmin utility to - manually insert, delete, and modify table information. Personally, I - use "phpMyAdmin". You have to compile a PHP module with MySQL - support to make it work, but it's very clean and easy to use. + There is no facility in Bugzilla itself to do this. It's + also generally not a smart thing to do if you don't know + exactly what you're doing. However, if you understand SQL + you can use the mysqladmin utility to manually insert, + delete, and modify table information. Personally, I use + "phpMyAdmin". You have to compile a PHP module with MySQL + support to make it work, but it's very clean and easy to + use. </para> </answer> </qandaentry> @@ -1404,14 +1500,17 @@ someone to take it on if they want it. FAQ is a good place for it. <qandaentry> <question> <para> - I try to add myself as a user, but Bugzilla always tells me my password is wrong. + I try to add myself as a user, but Bugzilla always tells + me my password is wrong. </para> </question> <answer> <para> - Certain version of MySQL (notably, 3.23.29 and 3.23.30) accidentally disabled - the "crypt()" function. This prevented MySQL from storing encrypted passwords. - Upgrade to the "3.23 stable" version of MySQL and you should be good to go. + Certain version of MySQL (notably, 3.23.29 and 3.23.30) + accidentally disabled the "crypt()" function. This + prevented MySQL from storing encrypted passwords. Upgrade + to the "3.23 stable" version of MySQL and you should be + good to go. </para> </answer> </qandaentry> @@ -1419,17 +1518,18 @@ someone to take it on if they want it. FAQ is a good place for it. <qandaentry> <question> <para> - I think I've set up MySQL permissions correctly, but bugzilla still can't - connect. + I think I've set up MySQL permissions correctly, but + bugzilla still can't connect. </para> </question> <answer> <para> - Try running MySQL from its binary: "mysqld --skip-grant-tables". This - will allow you to completely rule out grant tables as the cause of your - frustration. However, I do not recommend you run it this way on a regular - basis, unless you really want your web site defaced and your machine - cracked. + Try running MySQL from its binary: "mysqld + --skip-grant-tables". This will allow you to completely + rule out grant tables as the cause of your frustration. + However, I do not recommend you run it this way on a + regular basis, unless you really want your web site + defaced and your machine cracked. </para> </answer> </qandaentry> @@ -1437,26 +1537,28 @@ someone to take it on if they want it. FAQ is a good place for it. <qandaentry> <question> <para> - How do I synchronize bug information among multiple different Bugzilla - databases? + How do I synchronize bug information among multiple + different Bugzilla databases? </para> </question> <answer> <para> - Well, you can synchronize or you can move bugs. Synchronization will - only work one way -- you can create a read-only copy of the database - at one site, and have it regularly updated at intervals from the main - database. + Well, you can synchronize or you can move bugs. + Synchronization will only work one way -- you can create a + read-only copy of the database at one site, and have it + regularly updated at intervals from the main database. </para> <para> - MySQL has some synchronization features builtin to the latest releases. - It would be great if someone looked into the possibilities there - and provided a report to the newsgroup on how to effectively - synchronize two Bugzilla installations. + MySQL has some synchronization features builtin to the + latest releases. It would be great if someone looked into + the possibilities there and provided a report to the + newsgroup on how to effectively synchronize two Bugzilla + installations. </para> <para> - If you simply need to transfer bugs from one Bugzilla to another, - checkout the "move.pl" script in the Bugzilla distribution. + If you simply need to transfer bugs from one Bugzilla to + another, checkout the "move.pl" script in the Bugzilla + distribution. </para> </answer> </qandaentry> @@ -1464,15 +1566,16 @@ someone to take it on if they want it. FAQ is a good place for it. <qandaentry> <question> <para> - Why do I get bizarre errors when trying to submit data, particularly problems - with "groupset"? + Why do I get bizarre errors when trying to submit data, + particularly problems with "groupset"? </para> </question> <answer> <para> - If you're sure your MySQL parameters are correct, you might want turn - "strictvaluechecks" OFF in editparams.cgi. If you have "usebugsentry" set - "On", you also cannot submit a bug as readable by more than one group with + If you're sure your MySQL parameters are correct, you + might want turn "strictvaluechecks" OFF in editparams.cgi. + If you have "usebugsentry" set "On", you also cannot + submit a bug as readable by more than one group with "strictvaluechecks" ON. </para> </answer> @@ -1481,15 +1584,17 @@ someone to take it on if they want it. FAQ is a good place for it. <qandaentry> <question> <para> - How come even after I delete bugs, the long descriptions show up? + How come even after I delete bugs, the long descriptions + show up? </para> </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. + 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. </para> </answer> </qandaentry> @@ -1502,13 +1607,14 @@ someone to take it on if they want it. FAQ is a good place for it. <qandaentry> <question> <para> - What is the easiest way to run Bugzilla on Win32 (Win98+/NT/2K)? + What is the easiest way to run Bugzilla on Win32 + (Win98+/NT/2K)? </para> </question> <answer> <para> - Remove Windows. Install Linux. Install Bugzilla. - The boss will never know the difference. + Remove Windows. Install Linux. Install Bugzilla. The boss + will never know the difference. </para> </answer> </qandaentry> @@ -1521,9 +1627,10 @@ someone to take it on if they want it. FAQ is a good place for it. </question> <answer> <para> - Not currently. Bundle::Bugzilla enormously simplifies Bugzilla - installation on UNIX systems. If someone can volunteer to - create a suitable PPM bundle for Win32, it would be appreciated. + Not currently. Bundle::Bugzilla enormously simplifies + Bugzilla installation on UNIX systems. If someone can + volunteer to create a suitable PPM bundle for Win32, it + would be appreciated. </para> </answer> </qandaentry> @@ -1531,29 +1638,34 @@ someone to take it on if they want it. FAQ is a good place for it. <qandaentry> <question> <para> - CGI's are failing with a "something.cgi is not a valid Windows NT - application" error. Why? + CGI's are failing with a "something.cgi is not a valid + Windows NT application" error. Why? </para> </question> <answer> <para> - Depending on what Web server you are using, you will have to configure - the Web server to treat *.cgi files as CGI scripts. In IIS, you do this by - adding *.cgi to the App Mappings with the <path>\perl.exe %s %s as the + Depending on what Web server you are using, you will have + to configure the Web server to treat *.cgi files as CGI + scripts. In IIS, you do this by adding *.cgi to the App + Mappings with the <path>\perl.exe %s %s as the executable. </para> <para> Microsoft has some advice on this matter, as well: <blockquote> <para> - "Set application mappings. In the ISM, map the extension for the script - file(s) to the executable for the script interpreter. For example, you might - map the extension .py to Python.exe, the executable for the Python script - interpreter. Note For the ActiveState Perl script interpreter, the extension - .pl is associated with PerlIS.dll by default. If you want to change the - association of .pl to perl.exe, you need to change the application mapping. - In the mapping, you must add two percent (%) characters to the end of the - pathname for perl.exe, as shown in this example: c:\perl\bin\perl.exe %s %s" + "Set application mappings. In the ISM, map the + extension for the script file(s) to the executable for + the script interpreter. For example, you might map the + extension .py to Python.exe, the executable for the + Python script interpreter. Note For the ActiveState + Perl script interpreter, the extension .pl is + associated with PerlIS.dll by default. If you want to + change the association of .pl to perl.exe, you need to + change the application mapping. In the mapping, you + must add two percent (%) characters to the end of the + pathname for perl.exe, as shown in this example: + c:\perl\bin\perl.exe %s %s" </para> </blockquote> </para> @@ -1563,108 +1675,69 @@ someone to take it on if they want it. FAQ is a good place for it. <qandaentry> <question> <para> - Can I have some general instructions on how to make Bugzilla on Win32 work? - </para> - </question> + Can I have some general instructions on how to make + Bugzilla on Win32 work? + </para> + </question> <answer> <para> - The following couple entries are deprecated in favor of the Windows installation - instructions available in the "Administration" portion of "The Bugzilla Guide". - However, they are provided here for historical interest and insight. - <literallayout> - 1. #!C:/perl/bin/perl had to be added to every perl file. - 2. Converted to Net::SMTP to handle mail messages instead of - /usr/bin/sendmail. - 3. The crypt function isn't available on Windows NT (at least none that I - am aware), so I made encrypted passwords = plaintext passwords. - 4. The system call to diff had to be changed to the Cygwin diff. - 5. This was just to get a demo running under NT, it seems to be working - good, and I have inserted almost 100 bugs from another bug tracking - system. Since this work was done just to get an in-house demo, I am NOT - planning on making a patch for submission to Bugzilla. If you would - like a zip file, let me know. - -Q: Hmm, couldn't figure it out from the general instructions above. How -about step-by-step? -A: Sure! Here ya go! - - 1. Install IIS 4.0 from the NT Option Pack #4. - 2. Download and install Active Perl. - 3. Install the Windows GNU tools from Cygwin. Make sure to add the bin - directory to your system path. (Everyone should have these, whether - they decide to use Bugzilla or not. :-) ) - 4. Download relevant packages from ActiveState at - http://www.activestate.com/packages/zips/. + DBD-Mysql.zip - 5. Extract each zip file with WinZip, and install each ppd file using the - notation: ppm install <module>.ppd - 6. Install Mysql. *Note: If you move the default install from c:\mysql, - you must add the appropriate startup parameters to the NT service. (ex. - -b e:\\programs\\mysql) - 7. Download any Mysql client. http://www.mysql.com/download_win.html - 8. Setup MySql. (These are the commands that I used.) - - I. Cleanup default database settings. - C:\mysql\bin\mysql -u root mysql - mysql> DELETE FROM user WHERE Host='localhost' AND User=''; - mysql> quit - C:\mysql\bin\mysqladmin reload - - II. Set password for root. - C:\mysql\bin\mysql -u root mysql - mysql> UPDATE user SET Password=PASSWORD('new_password') - WHERE user='root'; - mysql> FLUSH PRIVILEGES; - mysql> quit - C:\mysql\bin\mysqladmin -u root reload - - III. Create bugs user. - C:\mysql\bin\mysql -u root -p - mysql> insert into user (host,user,password) - values('localhost','bugs',''); - mysql> quit - C:\mysql\bin\mysqladmin -u root reload - - IV. Create the bugs database. - C:\mysql\bin\mysql -u root -p - mysql> create database bugs; - - V. Give the bugs user access to the bugs database. - mysql> insert into db - (host,db,user,select_priv,insert_priv,update_priv,delete_priv,create_priv,drop_priv) - values('localhost','bugs','bugs','Y','Y','Y','Y','Y','N') - mysql> quit - C:\mysql\bin\mysqladmin -u root reload - 9. Run the table scripts to setup the bugs database. - 10. Change CGI.pm to use the following regular expression because of - differing backslashes in NT versus UNIX. - o $0 =~ m:[^\\]*$:; - 11. Had to make the crypt password = plain text password in the database. - (Thanks to Andrew Lahser" <andrew_lahser@merck.com>" on this one.) The - files that I changed were: - o globals.pl - o CGI.pl - o alternately, you can try commenting all references to 'crypt' - string and replace them with similar lines but without encrypt() - or crypr() functions insida all files. - 12. Replaced sendmail with Windmail. Basically, you have to come up with a - sendmail substitute for NT. Someone said that they used a Perl module - (Net::SMTP), but I was trying to save time and do as little Perl coding - as possible. - 13. Added "perl" to the beginning of all Perl system calls that use a perl - script as an argument and renamed processmail to processmail.pl. - 14. In processmail.pl, I added binmode(HANDLE) before all read() calls. I'm - not sure about this one, but the read() under NT wasn't counting the - EOLs without the binary read." - </literallayout> + The following couple entries are deprecated in favor of + the Windows installation instructions available in the + "Administration" portion of "The Bugzilla Guide". However, + they are provided here for historical interest and + insight. <literallayout> 1. #!C:/perl/bin/perl had to be + added to every perl file. 2. Converted to Net::SMTP to + handle mail messages instead of /usr/bin/sendmail. 3. + The crypt function isn't available on Windows NT (at + least none that I am aware), so I made encrypted + passwords = plaintext passwords. 4. The system call to + diff had to be changed to the Cygwin diff. 5. This was + just to get a demo running under NT, it seems to be + working good, and I have inserted almost 100 bugs from + another bug tracking system. Since this work was done + just to get an in-house demo, I am NOT planning on + making a patch for submission to Bugzilla. If you would + like a zip file, let me know. Q: Hmm, couldn't figure it + out from the general instructions above. How about + step-by-step? A: Sure! Here ya go! 1. Install IIS 4.0 + from the NT Option Pack #4. 2. Download and install + Active Perl. 3. Install the Windows GNU tools from + Cygwin. Make sure to add the bin directory to your + system path. (Everyone should have these, whether they + decide to use Bugzilla or not. :-) ) 4. Download + relevant packages from ActiveState at + http://www.activestate.com/packages/zips/. + + DBD-Mysql.zip 5. Extract each zip file with WinZip, and + install each ppd file using the notation: ppm install + <module>.ppd 6. Install Mysql. *Note: If you move + the default install from c:\mysql, you must add the + appropriate startup parameters to the NT service. (ex. + -b e:\\programs\\mysql) 7. Download any Mysql client. + http://www.mysql.com/download_win.html 8. Setup MySql. + (These are the commands that I used.) I. Cleanup default + database settings. C:\mysql\bin\mysql -u root mysql + mysql> DELETE FROM user WHERE Host='localhost' AND + User=''; mysql> quit C:\mysql\bin\mysqladmin reload II. + Set password for root. C:\mysql\bin\mysql -u root mysql + mysql> UPDATE user SET Password=PASSWORD('new_password') + WHERE user='root'; mysql> FLUSH PRIVILEGES; mysql> quit + C:\mysql\bin\mysqladmin -u root reload III. Create bugs + user. C:\mysql\bin\mysql -u root -p mysql> insert into + user (host,user,password) values('localhost','bugs',''); + mysql> quit C:\mysql\bin\mysqladmin -u root reload IV. + Create the bugs database. C:\mysql\bin\mysql -u root -p + mysql> create database bugs; V. Give the bugs user + access to the bugs database. mysql> insert into db + (host,db,user,select_priv,insert_priv,update_priv,delete_priv,create_priv,drop_priv) values('localhost','bugs','bugs','Y','Y','Y','Y','Y','N') mysql> quit C:\mysql\bin\mysqladmin -u root reload 9. Run the table scripts to setup the bugs database. 10. Change CGI.pm to use the following regular expression because of differing backslashes in NT versus UNIX. o $0 =~ m:[^\\]*$:; 11. Had to make the crypt password = plain text password in the database. (Thanks to Andrew Lahser" <andrew_lahser@merck.com>" on this one.) The files that I changed were: o globals.pl o CGI.pl o alternately, you can try commenting all references to 'crypt' string and replace them with similar lines but without encrypt() or crypr() functions insida all files. 12. Replaced sendmail with Windmail. Basically, you have to come up with a sendmail substitute for NT. Someone said that they used a Perl module (Net::SMTP), but I was trying to save time and do as little Perl coding as possible. 13. Added "perl" to the beginning of all Perl system calls that use a perl script as an argument and renamed processmail to processmail.pl. 14. In processmail.pl, I added binmode(HANDLE) before all read() calls. I'm not sure about this one, but the read() under NT wasn't counting the EOLs without the binary read." </literallayout> </para> </answer> </qandaentry> - - <qandaentry> - <question> - <para> - I'm having trouble with the perl modules for NT not being able to talk to - to the database. + + <qandaentry> + <question> + <para> + I'm having trouble with the perl modules for NT not being + able to talk to to the database. </para> </question> <answer> @@ -1693,14 +1766,14 @@ A: Sure! Here ya go! </listitem> <listitem> <para> - <prompt>PPM></prompt> <command>install DBI DBD-mysql GD</command> + <prompt>PPM></prompt> <command>install DBI DBD-mysql + GD</command> </para> </listitem> - </orderedlist> - I reckon TimeDate and Data::Dumper come with the activeperl. You can check - the ActiveState site for packages for installation through PPM. - <ulink url=" http://www.activestate.com/Packages/"> - http://www.activestate.com/Packages/</ulink> + </orderedlist> I reckon TimeDate and Data::Dumper come + with the activeperl. You can check the ActiveState site + for packages for installation through PPM. <ulink url=" + http://www.activestate.com/Packages/"> http://www.activestate.com/Packages/</ulink> </para> </answer> </qandaentry> @@ -1713,15 +1786,15 @@ A: Sure! Here ya go! <qandaentry> <question> <para> - The query page is very confusing. Isn't there a simpler way to query? + The query page is very confusing. Isn't there a simpler + way to query? </para> </question> <answer> <para> - We are developing in that direction. You can follow progress on this - at <ulink url="http://bugzilla.mozilla.org/show_bug.cgi?id=16775"> - http://bugzilla.mozilla.org/show_bug.cgi?id=16775</ulink>. Some functionality - is available in Bugzilla 2.12, and is available as "quicksearch.html" + We are developing in that direction. You can follow + progress on this at <ulink + url="http://bugzilla.mozilla.org/show_bug.cgi?id=16775"> http://bugzilla.mozilla.org/show_bug.cgi?id=16775</ulink>. Some functionality is available in Bugzilla 2.12, and is available as "quicksearch.html" </para> </answer> </qandaentry> @@ -1729,23 +1802,24 @@ A: Sure! Here ya go! <qandaentry> <question> <para> - 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? + 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? </para> </question> <answer> <para> - The current behavior is acceptable to bugzilla.mozilla.org and most - users. I personally don't like it. You have your choice of patches - to change this behavior, however. + The current behavior is acceptable to bugzilla.mozilla.org + and most users. I personally don't like it. You have + your choice of patches to change this behavior, however. <simplelist> - <member><ulink url="http://bugzilla.mozilla.org/showattachment.cgi?attach_id=8029"> - Add a "and accept bug" radio button</ulink></member> - <member><ulink url="http://bugzilla.mozilla.org/showattachment.cgi?attach_id=8153"> - "Accept" button automatically assigns to you</ulink></member> - </simplelist> - Note that these patches are somewhat dated. You will need to do the find - and replace manually to apply them. They are very small, though. It is easy. + <member><ulink + url="http://bugzilla.mozilla.org/showattachment.cgi?attach_id=8029"> Add a "and accept bug" radio button</ulink></member> + <member><ulink + url="http://bugzilla.mozilla.org/showattachment.cgi?attach_id=8153"> "Accept" button automatically assigns to you</ulink></member> + </simplelist> Note that these patches are somewhat dated. + You will need to do the find and replace manually to apply + them. They are very small, though. It is easy. </para> </answer> </qandaentry> @@ -1753,15 +1827,16 @@ A: Sure! Here ya go! <qandaentry> <question> <para> - I can't upload anything into the database via the "Create Attachment" - link. What am I doing wrong? + I can't upload anything into the database via the "Create + Attachment" link. What am I doing wrong? </para> </question> <answer> <para> - The most likely cause is a very old browser or a browser that is - incompatible with file upload via POST. Download the latest Netscape, - Microsoft, or Mozilla browser to handle uploads correctly. + The most likely cause is a very old browser or a browser + that is incompatible with file upload via POST. Download + the latest Netscape, Microsoft, or Mozilla browser to + handle uploads correctly. </para> </answer> </qandaentry> @@ -1769,15 +1844,16 @@ A: Sure! Here ya go! <qandaentry> <question> <para> - Email submissions to Bugzilla that have attachments end up asking me to - save it as a "cgi" file. + Email submissions to Bugzilla that have attachments end up + asking me to save it as a "cgi" file. </para> </question> <answer> <para> - Yup. Just rename it once you download it, or save it under a different - filename. This will not be fixed anytime too soon, because it would - cripple some other functionality. + Yup. Just rename it once you download it, or save it + under a different filename. This will not be fixed + anytime too soon, because it would cripple some other + functionality. </para> </answer> </qandaentry> @@ -1785,14 +1861,16 @@ A: Sure! Here ya go! <qandaentry> <question> <para> - How do I change a keyword in Bugzilla, once some bugs are using it? + How do I change a keyword in Bugzilla, once some bugs are + using it? </para> </question> <answer> <para> - In the Bugzilla administrator UI, edit the keyword and it will let you - replace the old keyword name with a new one. This will cause a problem - with the keyword cache. Run sanitycheck.cgi to fix it. + In the Bugzilla administrator UI, edit the keyword and it + will let you replace the old keyword name with a new one. + This will cause a problem with the keyword cache. Run + sanitycheck.cgi to fix it. </para> </answer> </qandaentry> @@ -1810,19 +1888,12 @@ 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"> - this link</ulink> to view current bugs or requests for - enhancement for Bugzilla. + Try <ulink + url="http://bugzilla.mozilla.org/buglist.cgi?bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&product=Webtools&component=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 - 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 - check current sources out of CVS so you can have these - bug fixes early! + 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 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 check current sources out of CVS so you can have these bug fixes early! </para> </answer> </qandaentry> @@ -1830,19 +1901,15 @@ A: Sure! Here ya go! <qandaentry> <question> <para> - How can I change the default priority to a null value? For instance, have the default - priority be "---" instead of "P2"? + How can I change the default priority to a null value? + For instance, have the default priority be "---" instead + of "P2"? </para> </question> <answer> <para> - This is well-documented here: <ulink url="http://bugzilla.mozilla.org/show_bug.cgi?id=49862"> - http://bugzilla.mozilla.org/show_bug.cgi?id=49862</ulink>. Ultimately, it's as easy - as adding the "---" priority field to your localconfig file in the appropriate area, - re-running checksetup.pl, and then changing the default priority in your browser using - "editparams.cgi". Hmm, now that I think about it, that is kind of a klunky way to handle - it, but for now it's what we have! Although the bug has been closed "resolved wontfix", - there may be a better way to handle this... + This is well-documented here: <ulink + url="http://bugzilla.mozilla.org/show_bug.cgi?id=49862"> http://bugzilla.mozilla.org/show_bug.cgi?id=49862</ulink>. Ultimately, it's as easy as adding the "---" priority field to your localconfig file in the appropriate area, re-running checksetup.pl, and then changing the default priority in your browser using "editparams.cgi". Hmm, now that I think about it, that is kind of a klunky way to handle it, but for now it's what we have! Although the bug has been closed "resolved wontfix", there may be a better way to handle this... </para> </answer> </qandaentry> @@ -1850,7 +1917,8 @@ A: Sure! Here ya go! <qandaentry> <question> <para> - What's the best way to submit patches? What guidelines should I follow? + What's the best way to submit patches? What guidelines + should I follow? </para> </question> <answer> @@ -1858,42 +1926,47 @@ 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 + "Webtools" product, "Bugzilla" component. </para> </listitem> <listitem> <para> - Upload your patch as a unified DIFF (having used "diff -u" against - the <emphasis>current sources</emphasis> checked out of CVS), - or new source file by clicking - "Create a new attachment" link on the bug page you've just created, and - include any descriptions of database changes you may make, into the bug - ID you submitted in step #1. Be sure and click the "Patch" radio - button to indicate the text you are sending is a patch! + Upload your patch as a unified DIFF (having used + "diff -u" against the <emphasis>current + sources</emphasis> checked out of CVS), or new + source file by clicking "Create a new attachment" + link on the bug page you've just created, and + include any descriptions of database changes you may + make, into the bug ID you submitted in step #1. Be + sure and click the "Patch" radio button to indicate + the text you are sending is a patch! </para> </listitem> <listitem> <para> Announce your patch and the associated URL - (http://bugzilla.mozilla.org/show_bug.cgi?id=XXXX) for discussion in - the newsgroup (netscape.public.mozilla.webtools). You'll get a really - good, fairly immediate reaction to the implications of your patch, - which will also give us an idea how well-received the change would - be. + (http://bugzilla.mozilla.org/show_bug.cgi?id=XXXX) + for discussion in the newsgroup + (netscape.public.mozilla.webtools). You'll get a + really good, fairly immediate reaction to the + implications of your patch, which will also give us + an idea how well-received the change would be. </para> </listitem> <listitem> <para> - If it passes muster with minimal modification, the person to whom - the bug is assigned in Bugzilla is responsible for seeing the patch - is checked into CVS. + If it passes muster with minimal modification, the + person to whom the bug is assigned in Bugzilla is + responsible for seeing the patch is checked into + CVS. </para> </listitem> <listitem> <para> - Bask in the glory of the fact that you helped write the most successful - open-source bug-tracking software on the planet :) + Bask in the glory of the fact that you helped write + the most successful open-source bug-tracking + software on the planet :) </para> </listitem> </orderedlist> @@ -1912,17 +1985,20 @@ A: Sure! Here ya go! <!-- Keep this comment at the end of the file Local variables: mode: sgml -sgml-omittag:t -sgml-shorttag:t -sgml-namecase-general:t -sgml-general-insert-case:lower -sgml-minimize-attributes:nil sgml-always-quote-attributes:t -sgml-indent-step:2 -sgml-indent-data:t -sgml-parent-document:nil +sgml-auto-insert-required-elements:t +sgml-balanced-tag-edit:t sgml-exposed-tags:nil +sgml-general-insert-case:lower +sgml-indent-data:t +sgml-indent-step:2 sgml-local-catalogs:nil sgml-local-ecat-files:nil +sgml-minimize-attributes:nil +sgml-namecase-general:t +sgml-omittag:t +sgml-parent-document:("Bugzilla-Guide.sgml" "book" "chapter") +sgml-shorttag:t +sgml-tag-region-if-active:t End: --> diff --git a/docs/sgml/future.sgml b/docs/sgml/future.sgml index 4cdf9e6f8..2e048dc5e 100644 --- a/docs/sgml/future.sgml +++ b/docs/sgml/future.sgml @@ -3,326 +3,30 @@ <chapter id="future"> <title>The Future of Bugzilla</title> <synopsis>Bugzilla's Future. Much of this is the present, now.</synopsis> - <section id="spamlite"> - <title>Reducing Spam</title> - <para><literallayout> -Those who use Bugzilla frequently are probably used to notification spam -- unwanted or unnecessary notifications. A number of proposals have -been put forward to attempt to reduce this. - -1. Reduce CC Spam - -Some of you probably know me as that guy who CCs on heaps and heaps of -bugs. Just as you get a lot of CC changes from me, so do I get a lot -from others. Why should CC changes send out email notifications? - -It's not necessarily the best idea to just remove the CC spam, there are -other issues too, like the difficulty of adding to large CC fields. - -For these reasons and more, an RFE for a per user "BCC" facility exists -that people could use to silently and privately track bugs, in a similar -way to voting today, but applying to an unlimited number of bugs. See -"http://bugzilla.mozilla.org/show_bug.cgi?id=7345". - -2. Bulk Changes - -You know the drill - a large milestone change, a component movement, -whatever, and lots of notifications are generated. If there's enough -maybe you'll just go delete, delete, delete, whoops, there goes another -notification that wasn't from the bulk change you missed. - -Shouldn't bulk changes send out one notification? A proposal for this -is at "http://bugzilla.mozilla.org/show_bug.cgi?id=26943". - -3. Configurable Notification Criteria - -It would be good if you could choose what you want to receive. There -are two parts to this. - -(a) Choose a selection of bugs you're interested in. This would be -similar to CC except you let the set be computed from selection criteria -rather than limited to the bugs your name is on. There is currently a -limited version of this in the bugzilla preferences, ie "all qualifying -bugs"/"all qualifying bugs except the ones I change"/"only those bugs -which I am listed on the cc line". -(b) Choose what changes will trigger a notification for the bugs you are -watching. With this, you could choose whether you want to receive cc, -dependency and keyword changes, for example. - -Both of these proposals live at -"http://bugzilla.mozilla.org/show_bug.cgi?id=14137". -Note that they also live at -"http://bugzilla.mozilla.org/show_bug.cgi?id=17464", and the change -has been checked in. This is fixed with Bugzilla 2.12 and is no longer -an issue. Woo-Hoo! -</literallayout></para> - </section> - - <section id="searching"> - <title>Better Searching</title> - <para><literallayout> -Current searching tools in Bugzilla include the querying mechanism, -special summary reports and dependency trees. This message is about new -facilities. - -1. General Summary Reports - -For some time now it has been apparent to me that the query bug list -leaves a little to be desired in its linear nature. There is a need to -have categorised subsets, and counts of each category. If you don't -believe me, how about these facilities already in place or which people -have asked for: - -Most Doomed Reports - Categorised On Assignee, Shows and Counts Number -of Bugs For Each Assignee -Bug #15806 (Most Voted For Bugs) - Categorised On Product, Shows Bugs -Voters Most Want Fixed -Bug #9789 (BugAThon Tracking Page) - Categorised On Developer (Subset), -Counts Number of Bugs -Bug #9409 and #9411 - The desire to be able to report on more subsets. - -Hopefully you can see the gist of what is desired here. It's a general -reporting mechanism. - -This mechanism lets you choose the subset of bugs to operate on (like -query), let's you categorise them, possibly along with subcategories and -counts the number of bugs within each category. It might or might not -show the actual bugs themselves, and it might limit the number of bugs -within a category, or categories to report on. - -I'm further sure that many applications of this mechanism would only be -recognised once it was implemented. - -The general summary reports bug is at -"http://bugzilla.mozilla.org/show_bug.cgi?id=12282". - -2. 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. See -"http://bugzilla.mozilla.org/show_bug.cgi?id=12286". - -3. Column Specification Support - -Currently query seems to get what columns to report on from whatever the -user 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 query, 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 query -(and general summary report) pages. The default query mechanism should -be able to let you specify your default columns. - -This proposal lives at -"http://bugzilla.mozilla.org/show_bug.cgi?id=12284". -</literallayout></para> - </section> - - <section id="trackingbugs"> - <title>Description Flags and Tracking Bugs</title> - <para><literallayout> -Since I last posted on this issue, we now have "keywords" that solve -many of the issues of description and status whiteboard keywords. We -have seen a migration towards keywords, but there is still further to -go. - -Description ( + Status Whiteboard ) Keywords --------------------------------------------- - -Some description keywords remain. I'd like to hear what reasons, other -than time, there are for these staying as they are. I'm suspecting many -are not really being used. Hopefully we can totally remove these -eventually. - -Tracking Bugs -------------- - -When I suggested keywords, I did so to get rid of tracking bugs too, -though we've had less success on that front. - -There are many disadvantages to tracking bugs. - -- They can pollute bugs counts, and you must make sure you exclude -them. I believe the meta keyword might be used for this purpose. -- They have an assignee but there is nothing to fix, and that person can -get whined at by Bugzilla. -- It would be better to craft your own "dependency tree" rather than -rely on a fixed hierachy in the bug system. -- In creating a nice little hierachy, many bugs duplicate information -that should be available in other ways, eg -"http://bugzilla.mozilla.org/show_bug.cgi?id=12833" which is -about beta 1 networking issues. These could fall behind the actual -data. What tracking bugs are good for, ad hoc lists, is what keywords -are better for. -- An automatically generated dependency structure between one "tracking -bug" and another would be better than a manual one, since it gives exact -rather than manually set up classifications. - -Probably the only feature preventing tracking bugs being replaced is the -dependency tree. The quintessential tracking bug seems to be bug #7229 -"chofmann's watch list", which probably has about a couple of hundred -bugs at various levels, which allows a nice visualisation. - -Before keywords can replace tracking bugs better visualisation is going -to be required. General summary reports and dependency forests of a bug -list ("http://bugzilla.mozilla.org/show_bug.cgi?id=12992") could both -help, but neither solves the problem totally. Perhaps keywords within -keywords would help here. In any case, I'm still thinking about this -one. - -Some tracking bugs could definitely be turned into keywords immediately -though, and I'll point the finger at -"http://bugzilla.mozilla.org/show_bug.cgi?id=7954" here since that's -what came to mind first. -</literallayout></para> - </section> - - <section id="bugprobs"> - <title>Bug Issues</title> - <para><literallayout> -1. Inline Bug Changes - -Why do I see so many "moving to M5" and "reassigning to blahblah" -messages, and in other circumstances none are entered? Why aren't these -automatically generated? A comment should be only necessary when there -is something to add, and if I'm not interested in this sort of -information, I should be able to hide it. - -At the moment we're in a hybrid world where we don't get everything, but -we can't get rid of the bug change "messages" either. Furthermore, -"View Bug Activity" requires me to manually cross reference events on -another page, rather than being able to visually see the chronological -order. Shouldn't I be able to see all the information on one page? - -A proposal to allow bugs to be shown either way is at -"http://bugzilla.mozilla.org/show_bug.cgi?id=11368". - -2. Hard Wrapping Comments - -One thing that annoys me is the fact that comments are "hard wrapped" to -a certain column width. This is a mistake Internet Mail and News has -made, unlike every word processor in existence, and as a consequence, -Usenet suffers to this day from bad software. Why has Bugzilla repeated -the problem? - -Hard wrapping to a certain column width is open to abuse (see old -Mozilla browsers that didn't wrap properly, resulting in many ugly bug -reports we have to read to this day), and furthermore doesn't expand to -fill greater screen sizes. I'm also under the impression the current -hard wrap uses a non-standard HTML facility. See -"http://bugzilla.mozilla.org/show_bug.cgi?id=11901". - -3. REMIND and LATER Are Evil - -I really hate REMIND and LATER. Not because they mean something -won't be implemented, but because they aren't the best solutions. - -Why are they bad? Well, basically because they are not resolved, yet -they are marked as such. Hence queries have to be well crafted to -include them. - -LATER, according to Bugzilla, means it won't be done this release. -There is a better mechanism of doing this, that is assigning to -nobody@mozilla.org and making the milestone blank. It's more likely to -appear in a casual query, and it doesn't resolve the bug. - -REMIND, according to Bugzilla, means it might still be implemented this -release. Well, why not just move it to a later milestone then? You're -a lot less likely to forget it. If it's really needed, a keyword would -be better. - -Some people can't use blank milestones to mean an untargetted milestone, -since they use this to assess new bugs that have no target. Hence, it -would be nice to distinguish between bugs that have not yet been -considered, and those that really are not assigned to any milestone in -the future (assumedly beyond). - -All this is covered at -"http://bugzilla.mozilla.org/show_bug.cgi?id=13534". - -4. Create An Enhancement Field - -Currently enhancement is an option in severity. This means that -important enhancements (like for example, POP3 support) are not properly -distinguished as such, because they need a proper severity. This -dilutes the meaning of enhancement. - -If enhancement was separated, we could properly see what was an -enhancement. See "http://bugzilla.mozilla.org/show_bug.cgi?id=9412". I -see keywords like [RFE] and [FEATURE] that seem to be compensating for -this problem. -</literallayout></para> - </section> - - <section id="dbaseintegrity"> - <title>Database Integrity</title> - <para><literallayout> -Bugzilla could be more proactive in detecting suboptimal situations and -prevent them or whine about them. - -1. Bugzilla Crime #1: Marking A Bug Fixed With Unresolved Dependencies - -It can't be marked fixed with unresolved dependencies. Either mark it -INVALID (tracking bugs), fix the dependencies at the same time, or -resolve the blockers. - -See "http://bugzilla.mozilla.org/show_bug.cgi?id=24496". - -2. Keyword Restrictions - -Some keywords should only apply in certain circumstances, eg beta1 => -Milestone < -M14, css1 => Component = Style System are possibilities. See -"http://bugzilla.mozilla.org/show_bug.cgi?id=26940". - -3. Whine About Old Votes - -Old votes can just sit on resolved bugs. This is problematic with -duplicates especially. Automatic transferral/removal is not -appropriate since bugs can be reopened, but a whining solution might -work. See "http://bugzilla.mozilla.org/show_bug.cgi?id=27553". - -4. Whine And Warn About Milestone Mismatches - -Here's a fun one. Bug X (M17) depends on Bug Y (M15). Bug Y gets moved -out to M19. The notification to the assignee of Bug X gets ignored (of -course) and Bug X is now due to be fixed before one of its blockers. - -Warnings about this when it is detected as well as whining about it in -email would help bring these issues to the attention of people sooner. - -Note that this would be less of a problem if we didn't have so many -tracking bugs since they aren't updated that often and often have this -problem. - -See "http://bugzilla.mozilla.org/show_bug.cgi?id=16743". -</literallayout></para> - </section> - - <section id="bz30"> - <title>Bugzilla 3.0</title> - <para>One day, Bugzilla 3.0 will have lots of cool stuff.</para> - </section> - + <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...</para> </chapter> <!-- Keep this comment at the end of the file Local variables: mode: sgml -sgml-omittag:t -sgml-shorttag:t -sgml-namecase-general:t -sgml-general-insert-case:lower -sgml-minimize-attributes:nil sgml-always-quote-attributes:t -sgml-indent-step:2 -sgml-indent-data:t -sgml-parent-document:nil +sgml-auto-insert-required-elements:t +sgml-balanced-tag-edit:t sgml-exposed-tags:nil +sgml-general-insert-case:lower +sgml-indent-data:t +sgml-indent-step:2 sgml-local-catalogs:nil sgml-local-ecat-files:nil +sgml-minimize-attributes:nil +sgml-namecase-general:t +sgml-omittag:t +sgml-parent-document:("Bugzilla-Guide.sgml" "book" "chapter") +sgml-shorttag:t +sgml-tag-region-if-active:t End: --> diff --git a/docs/sgml/gfdl.sgml b/docs/sgml/gfdl.sgml index 1091631d4..7d8d9967f 100644 --- a/docs/sgml/gfdl.sgml +++ b/docs/sgml/gfdl.sgml @@ -1,4 +1,4 @@ -<!DOCTYPE appendix PUBLIC "-//OASIS//DTD DocBook V4.1//EN"> +<!-- <!DOCTYPE appendix PUBLIC "-//OASIS//DTD DocBook V4.1//EN"> --> <appendix id="gfdl"> <title>GNU Free Documentation License</title> @@ -450,19 +450,25 @@ of this license document, but changing it is not allowed.</para> </sect1> </appendix> + + <!-- Keep this comment at the end of the file Local variables: mode: sgml -sgml-omittag:nil -sgml-shorttag:t -sgml-minimize-attributes:nil sgml-always-quote-attributes:t -sgml-indent-step:2 -sgml-parent-document: ("Bugzilla-Guide.sgml" "appendix") +sgml-auto-insert-required-elements:t +sgml-balanced-tag-edit:t sgml-exposed-tags:nil +sgml-general-insert-case:lower +sgml-indent-data:t +sgml-indent-step:2 +sgml-local-catalogs:nil sgml-local-ecat-files:nil -sgml-local-catalogs: CATALOG -sgml-validate-command: "nsgmls -s gfdl.sgml" -ispell-skip-sgml: t +sgml-minimize-attributes:nil +sgml-namecase-general:t +sgml-omittag:t +sgml-parent-document:("Bugzilla-Guide.sgml" "book" "chapter") +sgml-shorttag:t +sgml-tag-region-if-active:t End: --> diff --git a/docs/sgml/glossary.sgml b/docs/sgml/glossary.sgml index 32525f737..71ba2dd36 100644 --- a/docs/sgml/glossary.sgml +++ b/docs/sgml/glossary.sgml @@ -1,108 +1,177 @@ <!-- <!DOCTYPE glossary PUBLIC "-//OASIS//DTD DocBook V4.1//EN" > --> -<glossary id="glossary"> - - <glossdiv id="gloss_a"> - <title>A</title> - <glossentry> - <glossterm>There are no entries for A</glossterm> - <glossdef> - <para></para> - </glossdef> - </glossentry> - </glossdiv> - - <glossdiv id="gloss_b"> - <title>B</title> - <glossentry> - <glossterm>Bug</glossterm> - <glossdef> - <para>A "Bug" in Bugzilla refers to an issue entered into the database which has an associated number, assignments, comments, etc. Many also refer to a "Ticket" or "Issue"; in this context, they are synonymous.</para> - </glossdef> - </glossentry> - - <glossentry> - <glossterm>Bug Number</glossterm> - <glossdef> - <para>Each Bugzilla Bug is assigned a number that uniquely identifies that Bug. The Bug associated with a Bug Number can be pulled up via a query, or easily from the very front page by typing the number in the "Find" box.</para> - </glossdef> - </glossentry> - - <glossentry> - <glossterm>Bug Life Cycle</glossterm> - <glossdef> - <para>A Bug has stages through which it must pass before becoming a "closed bug", including acceptance, resolution, and verification. The "Bug Life Cycle" is moderately flexible according to the needs of the organization using it, though.</para> - </glossdef> - </glossentry> - </glossdiv> - - <glossdiv id="gloss_i"> - <title>I</title> - <glossentry id="gloss_infiniteloop"> - <glossterm>Infinite Loop</glossterm> - <glosssee otherterm="gloss_recursion"> - </glossentry> - </glossdiv> - -<glossdiv id="gloss_p"> - <title>P</title> - <glossentry> - <glossterm id="gloss_product">Product</glossterm> - <glossdef> - <para>A Product is a broad category of types of bugs. In general, there are several Components to a Product. A Product also defines a default Group (used for Bug Security) for all bugs entered into components beneath it.</para> - <example> - <title>A Sample Product</title> - <para>A company sells a software product called "X". They also maintain some older software called "Y", and have a secret project "Z". An effective use of Products might be to create Products "X", "Y", and "Z", each with Components "User Interface", "Database", and "Business Logic". They might also change group permissions so that only those people who are members of Group "Z" can see components and bugs under Product "Z".</para> - </example> - </glossdef> - </glossentry> - </glossdiv> - - <glossdiv id="gloss_q"> - <title>Q</title> - <glossentry> - <glossterm>Q/A</glossterm> - <glossdef> - <para>"Q/A" is short for "Quality Assurance". In most large software development organizations, there is a team devoted to ensuring the product meets minimum standards before shipping. This team will also generally want to track the progress of bugs over their life cycle, thus the need for the "Q/A Contact" field in a Bug.</para> - </glossdef> - </glossentry> - </glossdiv> - -<glossdiv id="gloss_r"> - <title>R</title> - <glossentry> - <glossterm id="gloss_recursion">Recursion</glossterm> - <glosssee otherterm="gloss_infiniteloop"> - </glossentry> - </glossdiv> - -<glossdiv id="gloss_z"> - <title>Z</title> - <glossentry> - <glossterm>Zarro Boogs Found</glossterm> - <glossdef> - <para>This is the cryptic response sent by Bugzilla when a query returned no results. It is just a goofy way of saying "Zero Bugs Found".</para> - </glossdef> - </glossentry> -</glossdiv> - -</glossary> - - + <glossary id="glossary"> + <glossdiv> + <title>0-9, high ascii</title> + <glossentry> + <glossterm>.htaccess</glossterm> + <glossdef> + <para> + Apache web server, and other NCSA-compliant web servers, + observe the convention of using files in directories + called <filename>.htaccess</filename> files. These + restrict parameters of the web server. In Bugzilla, they + are used to restrict access to certain files which would + otherwise compromise your installation. For instance, the + <filename>localconfig</filename> file contains the + password to your database. If this information were + generally available, and remote access to your database + turned on, you risk corruption of your database by + computer criminals or the curious. + </para> + </glossdef> + </glossentry> + </glossdiv> + + <glossdiv id="gloss_a"> + <title>A</title> + <glossentry> + <glossterm>There are no entries for A</glossterm> + <glossdef> + <para></para> + </glossdef> + </glossentry> + </glossdiv> + + <glossdiv id="gloss_b"> + <title>B</title> + <glossentry> + <glossterm>Bug</glossterm> + <glossdef> + <para> + A <quote>Bug</quote> in Bugzilla refers to an issue + entered into the database which has an associated number, + assignments, comments, etc. Some also refer to a + <quote>tickets</quote> or <quote>issues</quote>; in the + context of Bugzilla, they are synonymous. + </para> + </glossdef> + </glossentry> + + <glossentry> + <glossterm>Bug Number</glossterm> + <glossdef> + <para> + Each Bugzilla Bug is assigned a number that uniquely + identifies that Bug. The Bug associated with a Bug Number + can be pulled up via a query, or easily from the very + front page by typing the number in the "Find" box. + </para> + </glossdef> + </glossentry> + + <glossentry> + <glossterm>Bug Life Cycle</glossterm> + <glossdef> + <para>A Bug has stages through which it must pass before + becoming a <quote>closed bug</quote>, including + acceptance, resolution, and verification. The <quote>Bug + Life Cycle</quote> is moderately flexible according to + the needs of the organization using it, though.</para> + </glossdef> + </glossentry> + </glossdiv> + + <glossdiv id="gloss_i"> + <title>I</title> + <glossentry id="gloss_infiniteloop"> + <glossterm>Infinite Loop</glossterm> + <glossdef> + <para>A loop of information that never ends; see recursion.</para> + </glossdef> + </glossentry> + </glossdiv> + + <glossdiv id="gloss_p"> + <title>P</title> + <glossentry> + <glossterm id="gloss_product">Product</glossterm> + <glossdef> + <para>A Product is a broad category of types of bugs. In + general, there are several Components to a Product. A + Product also defines a default Group (used for Bug + Security) for all bugs entered into components beneath + it.</para> + <example> + <title>A Sample Product</title> + <para>A company sells a software product called + <quote>X</quote>. They also maintain some older + software called <quote>Y</quote>, and have a secret + project <quote>Z</quote>. An effective use of Products + might be to create Products <quote>X</quote>, + <quote>Y</quote>, <quote>Z</quote>, each with Components + of User Interface, Database, and Business Logic. They + might also change group permissions so that only those + people who are members of Group <quote>Z</quote> can see + components and bugs under Product + <quote>Z</quote>.</para> + </example> + </glossdef> + </glossentry> + </glossdiv> + + <glossdiv id="gloss_q"> + <title>Q</title> + <glossentry> + <glossterm>QA</glossterm> + <glossdef> + <para><quote>QA</quote>, <quote>Q/A</quote>, and + <quote>Q.A.</quote> are short for <quote>Quality + Assurance</quote>. In most large software development + organizations, there is a team devoted to ensuring the + product meets minimum standards before shipping. This + team will also generally want to track the progress of + bugs over their life cycle, thus the need for the + <quote>QA Contact</quote> field in a Bug.</para> + </glossdef> + </glossentry> + </glossdiv> + + <glossdiv id="gloss_r"> + <title>R</title> + <glossentry> + <glossterm id="gloss_recursion">Recursion</glossterm> + <glossdef> + <para>The property of a function looking back at itself for + something. <quote>GNU</quote>, for instance, stands for + <quote>GNU's Not UNIX</quote>, thus recursing upon itself + for definition. For further clarity, see Infinite + Loop.</para> + </glossdef> + </glossentry> + </glossdiv> + + <glossdiv id="gloss_z"> + <title>Z</title> + <glossentry> + <glossterm>Zarro Boogs Found</glossterm> + <glossdef> + <para>This is the cryptic response sent by Bugzilla when a + query returned no results. It is just a goofy way of + saying "Zero Bugs Found".</para> + </glossdef> + </glossentry> + </glossdiv> + + </glossary> + <!-- Keep this comment at the end of the file Local variables: mode: sgml -sgml-omittag:t -sgml-shorttag:t -sgml-namecase-general:t -sgml-general-insert-case:lower -sgml-minimize-attributes:nil sgml-always-quote-attributes:t -sgml-indent-step:2 -sgml-indent-data:t -sgml-parent-document:nil +sgml-auto-insert-required-elements:t +sgml-balanced-tag-edit:t sgml-exposed-tags:nil +sgml-general-insert-case:lower +sgml-indent-data:t +sgml-indent-step:2 sgml-local-catalogs:nil sgml-local-ecat-files:nil +sgml-minimize-attributes:nil +sgml-namecase-general:t +sgml-omittag:t +sgml-parent-document:("Bugzilla-Guide.sgml" "book" "chapter") +sgml-shorttag:t +sgml-tag-region-if-active:t End: --> diff --git a/docs/sgml/index.sgml b/docs/sgml/index.sgml index e69de29bb..7ca578cfc 100644 --- a/docs/sgml/index.sgml +++ b/docs/sgml/index.sgml @@ -0,0 +1,20 @@ +<!-- Keep this comment at the end of the file +Local variables: +mode: sgml +sgml-always-quote-attributes:t +sgml-auto-insert-required-elements:t +sgml-balanced-tag-edit:t +sgml-exposed-tags:nil +sgml-general-insert-case:lower +sgml-indent-data:t +sgml-indent-step:2 +sgml-local-catalogs:nil +sgml-local-ecat-files:nil +sgml-minimize-attributes:nil +sgml-namecase-general:t +sgml-omittag:t +sgml-parent-document:("Bugzilla-Guide.sgml" "book" "chapter") +sgml-shorttag:t +sgml-tag-region-if-active:t +End: +--> diff --git a/docs/sgml/installation.sgml b/docs/sgml/installation.sgml index 8165afd6d..dfbc35071 100644 --- a/docs/sgml/installation.sgml +++ b/docs/sgml/installation.sgml @@ -1,578 +1,633 @@ -<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook V4.1//EN"> +<!-- <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook V4.1//EN"> --> -<CHAPTER id="installation"> - <TITLE>Installing Bugzilla</TITLE> + <chapter id="installation"> + <title>Installation</title> + <para> + These installation instructions are presented assuming you are + installing on a UNIX or completely POSIX-compliant system. If + you are installing on Microsoft Windows or another oddball + operating system, please consult the appropriate sections in + this installation guide for notes on how to be successful. + </para> + <section id="errata"> + <title>ERRATA</title> + <para>Here are some miscellaneous notes about possible issues you + main run into when you begin your Bugzilla installation. + Reference platforms for Bugzilla installation are Redhat Linux + 7.2, Linux-Mandrake 8.0, and Solaris 8.</para> - <SECTION id="README.unix"> - <TITLE>UNIX Installation</TITLE> - <SECTION> - <TITLE>ERRATA</TITLE> - <NOTE> - <PARA> - If you are installing Bugzilla on S.u.S.e. Linux, or some other - distributions with "paranoid" security options, it is possible - that the checksetup.pl script may fail with the error: - <ERRORNAME>cannot chdir(/var/spool/mqueue): Permission denied</ERRORNAME> - This is because your - /var/spool/mqueue directory has a mode of "drwx------". Type - <COMMAND>chmod 755 /var/spool/mqueue</COMMAND> as root to fix this problem. - </PARA> - </NOTE> + <simplelist> + <member> + If you are installing Bugzilla on S.u.S.e. Linux, or some + other distributions with <quote>paranoid</quote> security + options, it is possible that the checksetup.pl script may fail + with the error: <errorname>cannot chdir(/var/spool/mqueue): + Permission denied</errorname> This is because your + <filename>/var/spool/mqueue</filename> directory has a mode of + <quote>drwx------</quote>. Type <command>chmod 755 + <filename>/var/spool/mqueue</filename></command> as root to + fix this problem. + </member> - <NOTE> - <PARA> - Release Notes for Bugzilla 2.12 are available at docs/rel_notes.txt - </PARA> - </NOTE> + <member> + Bugzilla may be installed on Macintosh OS X (10), which is a + unix-based (BSD) operating system. Everything required for + Bugzilla on OS X will install cleanly, but the optional GD + perl module which is used for bug charting requires some + additional setup for installation. Please see the Mac OS X + installation section below for details + </member> - <NOTE> - <PARA> - The preferred documentation for Bugzilla is available in docs/, with - a variety of document types available. Please refer to these documents when - installing, configuring, and maintaining your Bugzilla installation. - </PARA> - </NOTE> + <member> + Release Notes for Bugzilla &bz-ver; are available at + <filename>docs/rel_notes.txt</filename> in your Bugzilla + source distribution. + </member> - <WARNING> - <PARA> - Bugzilla is not a package where you can just plop it in a directory, - twiddle a few things, and you're off. Installing Bugzilla assumes you - know your variant of UNIX or Microsoft Windows well, are familiar with the - command line, and are comfortable compiling and installing a plethora - of third-party utilities. To install Bugzilla on Win32 requires - fair Perl proficiency, and if you use a webserver other than Apache you - should be intimately familiar with the security mechanisms and CGI - environment thereof. - </PARA> - </WARNING> + <member> + The preferred documentation for Bugzilla is available in + docs/, with a variety of document types available. Please + refer to these documents when installing, configuring, and + maintaining your Bugzilla installation. + </member> + </simplelist> + + <warning> + <para> + Bugzilla is not a package where you can just plop it in a directory, + twiddle a few things, and you're off. Installing Bugzilla assumes you + know your variant of UNIX or Microsoft Windows well, are familiar with the + command line, and are comfortable compiling and installing a plethora + of third-party utilities. To install Bugzilla on Win32 requires + fair Perl proficiency, and if you use a webserver other than Apache you + should be intimately familiar with the security mechanisms and CGI + environment thereof. + </para> + </warning> + + <warning> + <para> + Bugzilla has not undergone a complete security review. Security holes + may exist in the code. Great care should be taken both in the installation + and usage of this software. Carefully consider the implications of + installing other network services with Bugzilla. + </para> + </warning> + </section> + + <section id="stepbystep" xreflabel="Bugzilla Installation Step-by-step"> + <title>Step-by-step Install</title> + <section> + <title>Introduction</title> + <para> + Installation of bugzilla is pretty straightforward, particularly if your + machine already has MySQL and the MySQL-related perl packages installed. + If those aren't installed yet, then that's the first order of business. The + other necessary ingredient is a web server set up to run cgi scripts. + While using Apache for your webserver is not required, it is recommended. + </para> - <WARNING> - <PARA> - Bugzilla has not undergone a complete security review. Security holes - may exist in the code. Great care should be taken both in the installation - and usage of this software. Carefully consider the implications of - installing other network services with Bugzilla. - </PARA> - </WARNING> - </SECTION> - - <SECTION> - <TITLE>Step-by-step Install</TITLE> - <SECTION> - <TITLE>Introduction</TITLE> - <PARA> - Installation of bugzilla is pretty straightforward, particularly if your - machine already has MySQL and the MySQL-related perl packages installed. - If those aren't installed yet, then that's the first order of business. The - other necessary ingredient is a web server set up to run cgi scripts. - While using Apache for your webserver is not required, it is recommended. - </PARA> - - <PARA> - Bugzilla has been successfully installed under Solaris, Linux, and - Win32. The peculiarities of installing on Win32 (Win98+/NT/2K) are not - included in this section of the Guide; please check out the "Win32 Installation Instructions" - for further advice on getting Bugzilla to work on Microsoft Windows. - </PARA> - - <PARA> - The Bugzilla Guide is contained in the "docs/" folder. It is available - in plain text (docs/txt), HTML (docs/html), or SGML source (docs/sgml). - </PARA> - </SECTION> - <SECTION> - <TITLE>Installing the Prerequisites</TITLE> - - <PARA> - The software packages necessary for the proper running of bugzilla are: - <ORDEREDLIST> - <LISTITEM> - <PARA> - MySQL database server and the mysql client (3.22.5 or greater) - </PARA> - </LISTITEM> - <LISTITEM> - <PARA> - Perl (5.004 or greater) - </PARA> - </LISTITEM> - <LISTITEM> - <PARA> - DBI Perl module - </PARA> - </LISTITEM> - <LISTITEM> - <PARA> - Data::Dumper Perl module - </PARA> - </LISTITEM> - <LISTITEM> - <PARA> - DBD::mySQL - </PARA> - </LISTITEM> - <LISTITEM> - <PARA> - TimeDate Perl module collection - </PARA> - </LISTITEM> - <LISTITEM> - <PARA> - GD perl module (1.8.3) (optional, for bug charting) - </PARA> - </LISTITEM> - <LISTITEM> - <PARA> - Chart::Base Perl module (0.99c) (optional, for bug charting) - </PARA> - </LISTITEM> - <LISTITEM> - <PARA> - DB_File Perl module (optional, for bug charting) - </PARA> - </LISTITEM> - <LISTITEM> - <PARA> - The web server of your choice. Apache is recommended. - </PARA> - </LISTITEM> - <LISTITEM> - <PARA> - MIME::Parser Perl module (optional, for contrib/bug_email.pl interface) - </PARA> - </LISTITEM> - </ORDEREDLIST> - <NOTE> - <PARA> - You must run Bugzilla on a filesystem that supports file locking via - flock(). This is necessary for Bugzilla to operate safely with multiple - instances. - </PARA> - </NOTE> - <WARNING> - <PARA> - It is a good idea, while installing Bugzilla, to ensure it is not - <EMPHASIS>accessible</EMPHASIS> by other machines on the Internet. - Your machine may be vulnerable to attacks - while you are installing. In other words, ensure there is some kind of firewall between you - and the rest of the Internet. Many installation steps require an active Internet connection - to complete, but you must take care to ensure that at no point is your machine vulnerable - to an attack. - </PARA> - </WARNING> - - </PARA> - </SECTION> - <SECTION> - <TITLE>Installing MySQL Database</TITLE> - <PARA> - Visit MySQL homepage at http://www.mysql.org/ and grab the latest stable - release of the server. Both binaries and source are available and which - you get shouldn't matter. Be aware that many of the binary versions - of MySQL store their data files in /var which on many installations - (particularly common with linux installations) is part of a smaller - root partition. If you decide to build from sources you can easily set - the dataDir as an option to configure. - </PARA> - <PARA> - If you've installed from source or non-package (RPM, deb, etc.) binaries - you'll want to make sure to add mysqld to your init scripts so the server - daemon will come back up whenever your machine reboots. - You also may want to edit those init scripts, to make sure that - mysqld will accept large packets. By default, mysqld is set up to only - accept packets up to 64K long. This limits the size of attachments you - may put on bugs. If you add something like "-O max_allowed_packet=1M" - to the command that starts mysqld (or safe_mysqld), then you will be - able to have attachments up to about 1 megabyte. - </PARA> - <NOTE> - <PARA> - If you plan on running Bugzilla and MySQL on the same machine, - consider using the "--skip-networking" option in the init script. - This enhances security by preventing network access to MySQL. - </PARA> - </NOTE> - </SECTION> - - <SECTION> - <TITLE>Perl (5.004 or greater)</TITLE> - <PARA> - Any machine that doesn't have perl on it is a sad machine indeed. Perl - for *nix systems can be gotten in source form from http://www.perl.com. - </PARA> - <PARA> - Perl is now a far cry from the the single compiler/interpreter binary it - once was. It now includes a great many required modules and quite a - few other support files. If you're not up to or not inclined to build - perl from source, you'll want to install it on your machine using some - sort of packaging system (be it RPM, deb, or what have you) to ensure - a sane install. In the subsequent sections you'll be installing quite - a few perl modules; this can be quite ornery if your perl installation - isn't up to snuff. - </PARA> - <TIP> - <PARA> - You can skip the following Perl module installation - steps by installing "Bundle::Bugzilla" from CPAN, which includes them. - All Perl module installation steps require you have an active Internet - connection. - </PARA> - <PARA> - <COMPUTEROUTPUT> - <PROMPT>bash#</PROMPT> - <COMMAND>perl -MCPAN -e 'install "Bundle::Bugzilla"'</COMMAND> - </COMPUTEROUTPUT> - </PARA> - <PARA> - Bundle::Bugzilla doesn't include GD, Chart::Base, or MIME::Parser, - which are not essential to a basic Bugzilla install. If installing - this bundle fails, you should install each module individually to - isolate the problem. - </PARA> - </TIP> - </SECTION> - - <SECTION> - <TITLE>DBI Perl Module</TITLE> - <PARA> - The DBI module is a generic Perl module used by other database related - Perl modules. For our purposes it's required by the MySQL-related - modules. As long as your Perl installation was done correctly the - DBI module should be a breeze. It's a mixed Perl/C module, but Perl's - MakeMaker system simplifies the C compilation greatly. - </PARA> - <PARA> - Like almost all Perl modules DBI can be found on the Comprehensive Perl - Archive Network (CPAN) at http://www.cpan.org. The CPAN servers have a - real tendency to bog down, so please use mirrors. The current location - at the time of this writing (02/17/99) can be found in Appendix A. - </PARA> - <PARA> - Quality, general Perl module installation instructions can be found on - the CPAN website, but the easy thing to do is to just use the CPAN shell - which does all the hard work for you. - </PARA> - <PARA> - To use the CPAN shell to install DBI: - <INFORMALEXAMPLE> - <PARA> - <COMPUTEROUTPUT> - <PROMPT>bash#</PROMPT> - <COMMAND>perl -MCPAN -e 'install "DBI"'</COMMAND> - </COMPUTEROUTPUT> - <NOTE> - <PARA>Replace "DBI" with the name of whichever module you wish - to install, such as Data::Dumper, TimeDate, GD, etc.</PARA> - </NOTE> - </PARA> - </INFORMALEXAMPLE> - To do it the hard way: - <INFORMALEXAMPLE> - <PARA> - Untar the module tarball -- it should create its own directory - </PARA> - <PARA> - CD to the directory just created, and enter the following commands: - <ORDEREDLIST> - <LISTITEM> - <PARA> - <COMPUTEROUTPUT> - <PROMPT>bash#</PROMPT> - <COMMAND>perl Makefile.PL</COMMAND> - </COMPUTEROUTPUT> - </PARA> - </LISTITEM> - <LISTITEM> - <PARA> - <COMPUTEROUTPUT> - <PROMPT>bash#</PROMPT> - <COMMAND>make</COMMAND> - </COMPUTEROUTPUT> - </PARA> - </LISTITEM> - <LISTITEM> - <PARA> - <COMPUTEROUTPUT> - <PROMPT>bash#</PROMPT> - <COMMAND>make test</COMMAND> - </COMPUTEROUTPUT> - </PARA> - </LISTITEM> - <LISTITEM> - <PARA> - <COMPUTEROUTPUT> - <PROMPT>bash#</PROMPT> - <COMMAND>make install</COMMAND> - </COMPUTEROUTPUT> - </PARA> - </LISTITEM> - </ORDEREDLIST> - If everything went ok that should be all it takes. For the vast - majority of perl modules this is all that's required. - </PARA> - </INFORMALEXAMPLE> - </PARA> - </SECTION> - <SECTION> - <TITLE>Data::Dumper Perl Module</TITLE> - <PARA> - The Data::Dumper module provides data structure persistence for Perl - (similar to Java's serialization). It comes with later sub-releases of - Perl 5.004, but a re-installation just to be sure it's available won't - hurt anything. - </PARA> - <PARA> - Data::Dumper is used by the MySQL related Perl modules. It can be - found on CPAN (link in Appendix A) and can be installed by following - the same four step make sequence used for the DBI module. - </PARA> - </SECTION> + <para> + Bugzilla has been successfully installed under Solaris, Linux, + and Win32. The peculiarities of installing on Win32 (Microsoft + Windows) are not included in this section of the Guide; please + check out the <xref linkend="win32"> for further advice + on getting Bugzilla to work on Microsoft Windows. + </para> + + <para> + The Bugzilla Guide is contained in the "docs/" folder in your + Bugzilla distribution. It is available in plain text + (docs/txt), HTML (docs/html), or SGML source (docs/sgml). + </para> + </section> + <section> + <title>Installing the Prerequisites</title> + <note> + <para>If you want to skip these manual installation steps for + the CPAN dependencies listed below, and are running the very + most recent version of Perl and MySQL (both the executables + and development libraries) on your system, check out + Bundle::Bugzilla in <xref + linkend="bundlebugzilla"></para> + </note> + <para> + The software packages necessary for the proper running of bugzilla are: + <orderedlist> + <listitem> + <para> + MySQL database server and the mysql client (3.22.5 or greater) + </para> + </listitem> + <listitem> + <para> + Perl (5.004 or greater, 5.6.1 is recommended if you wish + to use Bundle::Bugzilla) + </para> + </listitem> + <listitem> + <para> + DBI Perl module + </para> + </listitem> + <listitem> + <para> + Data::Dumper Perl module + </para> + </listitem> + <listitem> + <para> + Bundle::Mysql Perl module collection + </para> + </listitem> + <listitem> + <para> + TimeDate Perl module collection + </para> + </listitem> + <listitem> + <para> + GD perl module (1.8.3) (optional, for bug charting) + </para> + </listitem> + <listitem> + <para> + Chart::Base Perl module (0.99c) (optional, for bug charting) + </para> + </listitem> + <listitem> + <para> + DB_File Perl module (optional, for bug charting) + </para> + </listitem> + <listitem> + <para> + The web server of your choice. Apache is recommended. + </para> + </listitem> + <listitem> + <para> + MIME::Parser Perl module (optional, for contrib/bug_email.pl interface) + </para> + </listitem> + </orderedlist> - <SECTION> - <TITLE>MySQL related Perl Module Collection</TITLE> - <PARA> - The Perl/MySQL interface requires a few mutually-dependent perl - modules. These modules are grouped together into the the - Msql-Mysql-modules package. This package can be found at CPAN. - After the archive file has been downloaded it should - be untarred. - </PARA> - <PARA> - The MySQL modules are all built using one make file which is generated - by running: - <PROMPT>bash#</PROMPT> - <COMMAND>perl Makefile.pl</COMMAND> - </PARA> - <PARA> - The MakeMaker process will ask you a few questions about the desired - compilation target and your MySQL installation. For many of the questions - the provided default will be adequate. - </PARA> - <PARA> - When asked if your desired target is the MySQL or mSQL packages - selected the MySQL related ones. Later you will be asked if you wish - to provide backwards compatibility with the older MySQL packages; you - must answer YES to this question. The default will be no, and if you - select it things won't work later. - </PARA> - <PARA> + <warning> + <para> + It is a good idea, while installing Bugzilla, to ensure it + is not <emphasis>accessible</emphasis> by other machines + on the Internet. Your machine may be vulnerable to attacks + while you are installing. In other words, ensure there is + some kind of firewall between you and the rest of the + Internet. Many installation steps require an active + Internet connection to complete, but you must take care to + ensure that at no point is your machine vulnerable to an + attack. + </para> + </warning> + + </para> + </section> + <section id="install-mysql"> + <title>Installing MySQL Database</title> + <para> + Visit MySQL homepage at http://www.mysql.com/ and grab the + latest stable release of the server. Both binaries and source + are available and which you get shouldn't matter. Be aware + that many of the binary versions of MySQL store their data + files in /var which on many installations (particularly common + with linux installations) is part of a smaller root partition. + If you decide to build from sources you can easily set the + dataDir as an option to configure. + </para> + <para> + If you've installed from source or non-package (RPM, deb, + etc.) binaries you'll want to make sure to add mysqld to your + init scripts so the server daemon will come back up whenever + your machine reboots. You also may want to edit those init + scripts, to make sure that mysqld will accept large packets. + By default, mysqld is set up to only accept packets up to 64K + long. This limits the size of attachments you may put on + bugs. If you add something like "-O max_allowed_packet=1M" to + the command that starts mysqld (or safe_mysqld), then you will + be able to have attachments up to about 1 megabyte. + </para> + <note> + <para> + If you plan on running Bugzilla and MySQL on the same + machine, consider using the "--skip-networking" option in + the init script. This enhances security by preventing + network access to MySQL. + </para> + </note> + </section> + + <section id="install-perl"> + <title>Perl (5.004 or greater)</title> + <para> + Any machine that doesn't have perl on it is a sad machine + indeed. Perl for *nix systems can be gotten in source form + from http://www.perl.com. Although Bugzilla runs with most + post-5.004 versions of Perl, it's a good idea to be up to the + very latest version if you can when running Bugzilla. As of + this writing, that is perl version &perl-ver;. + </para> + <para> + Perl is now a far cry from the the single compiler/interpreter + binary it once was. It includes a great many required modules + and quite a few other support files. If you're not up to or + not inclined to build perl from source, you'll want to install + it on your machine using some sort of packaging system (be it + RPM, deb, or what have you) to ensure a sane install. In the + subsequent sections you'll be installing quite a few perl + modules; this can be quite ornery if your perl installation + isn't up to snuff. + </para> + <warning> + <para>Many people complain that Perl modules will not install + for them. Most times, the error messages complain that they + are missing a file in <quote>@INC</quote>. Virtually every + time, this is due to permissions being set too restrictively + for you to compile Perl modules or not having the necessary + Perl development libraries installed on your system.. + Consult your local UNIX systems administrator for help + solving these permissions issues; if you + <emphasis>are</emphasis> the local UNIX sysadmin, please + consult the newsgroup/mailing list for further assistance or + hire someone to help you out. + </para> + </warning> + <tip id="bundlebugzilla" xreflabel="Using Bundle::Bugzilla instead of manually installing Perl modules"> + <para> + You can skip the following Perl module installation steps by + installing "Bundle::Bugzilla" from CPAN, which includes + them. All Perl module installation steps require you have an + active Internet connection. If you wish to use + Bundle::Bugzilla, however, you must be using the latest + version of Perl (at this writing, version &perl-ver;) + </para> + <para> + <computeroutput> <prompt>bash#</prompt> <command>perl -MCPAN + -e 'install "Bundle::Bugzilla"'</command> + </computeroutput> + </para> + <para> + Bundle::Bugzilla doesn't include GD, Chart::Base, or + MIME::Parser, which are not essential to a basic Bugzilla + install. If installing this bundle fails, you should + install each module individually to isolate the problem. + </para> + </tip> + </section> + + <section> + <title>DBI Perl Module</title> + <para> + The DBI module is a generic Perl module used by other database related + Perl modules. For our purposes it's required by the MySQL-related + modules. As long as your Perl installation was done correctly the + DBI module should be a breeze. It's a mixed Perl/C module, but Perl's + MakeMaker system simplifies the C compilation greatly. + </para> + <para> + Like almost all Perl modules DBI can be found on the Comprehensive Perl + Archive Network (CPAN) at http://www.cpan.org. The CPAN servers have a + real tendency to bog down, so please use mirrors. The current location + at the time of this writing (02/17/99) can be found in Appendix A. + </para> + <para> + Quality, general Perl module installation instructions can be found on + the CPAN website, but the easy thing to do is to just use the CPAN shell + which does all the hard work for you. + </para> + <para> + To use the CPAN shell to install DBI: + <informalexample> + <para> + <computeroutput> + <prompt>bash#</prompt> + <command>perl -MCPAN -e 'install "DBI"'</command> + </computeroutput> + <note> + <para>Replace "DBI" with the name of whichever module you wish + to install, such as Data::Dumper, TimeDate, GD, etc.</para> + </note> + </para> + </informalexample> + To do it the hard way: + <informalexample> + <para> + Untar the module tarball -- it should create its own directory + </para> + <para> + CD to the directory just created, and enter the following commands: + <orderedlist> + <listitem> + <para> + <computeroutput> + <prompt>bash#</prompt> + <command>perl Makefile.PL</command> + </computeroutput> + </para> + </listitem> + <listitem> + <para> + <computeroutput> + <prompt>bash#</prompt> + <command>make</command> + </computeroutput> + </para> + </listitem> + <listitem> + <para> + <computeroutput> + <prompt>bash#</prompt> + <command>make test</command> + </computeroutput> + </para> + </listitem> + <listitem> + <para> + <computeroutput> + <prompt>bash#</prompt> + <command>make install</command> + </computeroutput> + </para> + </listitem> + </orderedlist> + If everything went ok that should be all it takes. For the vast + majority of perl modules this is all that's required. + </para> + </informalexample> + </para> + </section> + <section> + <title>Data::Dumper Perl Module</title> + <para> + The Data::Dumper module provides data structure persistence for Perl + (similar to Java's serialization). It comes with later sub-releases of + Perl 5.004, but a re-installation just to be sure it's available won't + hurt anything. + </para> + <para> + Data::Dumper is used by the MySQL-related Perl modules. It can be + found on CPAN (link in Appendix A) and can be installed by following + the same four step make sequence used for the DBI module. + </para> + </section> + + <section> + <title>MySQL related Perl Module Collection</title> + <para> + The Perl/MySQL interface requires a few mutually-dependent perl + modules. These modules are grouped together into the the + Msql-Mysql-modules package. This package can be found at CPAN. + After the archive file has been downloaded it should + be untarred. + </para> + <para> + The MySQL modules are all built using one make file which is generated + by running: + <prompt>bash#</prompt> + <command>perl Makefile.pl</command> + </para> + <para> + The MakeMaker process will ask you a few questions about the desired + compilation target and your MySQL installation. For many of the questions + the provided default will be adequate. + </para> + <para> + When asked if your desired target is the MySQL or mSQL packages, + select the MySQL related ones. Later you will be asked if you wish + to provide backwards compatibility with the older MySQL packages; you + should answer YES to this question. The default is NO. + </para> + <para> A host of 'localhost' should be fine and a testing user of 'test' and a null password should find itself with sufficient access to run tests on the 'test' database which MySQL created upon installation. If 'make test' and 'make install' go through without errors you should be ready to go as far as database connectivity is concerned. - </PARA> - </SECTION> + </para> + </section> - <SECTION> - <TITLE>TimeDate Perl Module Collection</TITLE> - <PARA> + <section> + <title>TimeDate Perl Module Collection</title> + <para> Many of the more common date/time/calendar related Perl modules have been grouped into a bundle similar to the MySQL modules bundle. This - bundle is stored on the CPAN under the name TimeDate. A (hopefully - current) link can be found in Appendix A. The component module we're + bundle is stored on the CPAN under the name TimeDate. A link + link may be found in Appendix B, Software Download Links. + The component module we're most interested in is the Date::Format module, but installing all of them is probably a good idea anyway. The standard Perl module installation instructions should work perfectly for this simple package. - </PARA> - </SECTION> - <SECTION> - <TITLE>GD Perl Module (1.8.3)</TITLE> - <PARA> + </para> + </section> + <section> + <title>GD Perl Module (1.8.3)</title> + <para> The GD library was written by Thomas Boutell a long while ago to programatically generate images in C. Since then it's become almost a defacto standard for programatic image construction. The Perl bindings to it found in the GD library are used on a million web pages to generate graphs on the fly. That's what bugzilla will be using it for so you'd better install it if you want any of the graphing to work. - </PARA> - <PARA> + </para> + <para> Actually bugzilla uses the Graph module which relies on GD itself, but isn't that always the way with OOP. At any rate, you can find the - GD library on CPAN (link in Appendix "Required Software"). - </PARA> - <NOTE> - <PARA> + GD library on CPAN (link in Appendix B, Software Download Links). + </para> + <note> + <para> The Perl GD library requires some other libraries that may or may not be installed on your system, including "libpng" and "libgd". The full requirements are listed in the Perl GD library README. Just realize that if compiling GD fails, it's probably because you're missing a required library. - </PARA> - </NOTE> - </SECTION> + </para> + </note> + </section> - <SECTION> - <TITLE>Chart::Base Perl Module (0.99c)</TITLE> - <PARA> + <section> + <title>Chart::Base Perl Module (0.99c)</title> + <para> The Chart module provides bugzilla with on-the-fly charting abilities. It can be installed in the usual fashion after it has been fetched from CPAN where it is found as the Chart-x.x... tarball in a - directory to be listed in Appendix "Required Software". Note that as with the GD perl - module, only the specific versions listed above (or newer) will work. Earlier + directory to be listed in Appendix B, "Software Download Links". + Note that as with the GD perl + module, only the version listed above, or newer, will work. + Earlier versions used GIF's, which are no longer supported by the latest versions of GD. - </PARA> - </SECTION> + </para> + </section> - <SECTION> - <TITLE>DB_File Perl Module</TITLE> - <PARA> + <section> + <title>DB_File Perl Module</title> + <para> DB_File is a module which allows Perl programs to make use of the facilities provided by Berkeley DB version 1.x. This module is required by collectstats.pl which is used for bug charting. If you plan to make use of bug charting, you must install this module. - </PARA> - </SECTION> + </para> + </section> - <SECTION> - <TITLE>HTTP Server</TITLE> - <PARA> + <section> + <title>HTTP Server</title> + <para> You have a freedom of choice here - Apache, Netscape or any other server on UNIX would do. You can easily run the web server on a different machine than MySQL, but need to adjust the MySQL "bugs" user permissions accordingly. - </PARA> - <PARA> + </para> + <para> You'll want to make sure that your web server will run any file with the .cgi extension as a cgi and not just display it. If you're using apache that means uncommenting the following line in the srm.conf file: - <COMPUTEROUTPUT>AddHandler cgi-script .cgi</COMPUTEROUTPUT> - </PARA> - <PARA> + <computeroutput>AddHandler cgi-script .cgi</computeroutput> + </para> + <para> With apache you'll also want to make sure that within the access.conf file the line: - <COMPUTEROUTPUT> + <computeroutput> Options ExecCGI - </COMPUTEROUTPUT> + </computeroutput> is in the stanza that covers the directories you intend to put the bugzilla .html and .cgi files into. - </PARA> - <PARA> + </para> + <para> If you are using a newer version of Apache, both of the above lines will be (or will need to be) in the httpd.conf file, rather than srm.conf or access.conf. - </PARA> - <WARNING> - <PARA> + </para> + <warning> + <para> There are two critical directories and a file that should not be a served by - the HTTP server. These are the 'data' and 'shadow' directories and the - 'localconfig' file. You should configure your HTTP server to not serve + the HTTP server. These are the <quote>data</quote> and <quote>shadow</quote> + directories and the + <quote>localconfig</quote> file. You should configure your HTTP server to not serve content from these files. Failure to do so will expose critical passwords - and other data. Please see your HTTP server configuration manual on how - to do this. If you use quips (at the top of the buglist pages) you will want - the 'data/comments' file to still be served. This file contains those quips. - </PARA> - </WARNING> - </SECTION> + and other data. Please see <xref linkend="htaccess"> for details. + </para> + </warning> + </section> - <SECTION> - <TITLE>Installing the Bugzilla Files</TITLE> - <PARA> + <section> + <title>Installing the Bugzilla Files</title> + <para> You should untar the Bugzilla files into a directory that you're willing to make writable by the default web server user (probably - 'nobody'). You may decide to put the files off of the main web space + <quote>nobody</quote>). You may decide to put the files off of the main web space for your web server or perhaps off of /usr/local with a symbolic link in the web space that points to the bugzilla directory. At any rate, just dump all the files in the same place (optionally omitting the CVS directories if they were accidentally tarred up with the rest of Bugzilla) and make sure you can access the files in that directory through your web server. - </PARA> - <TIP> - <PARA> + </para> + <tip> + <para> If you symlink the bugzilla directory into your Apache's HTML heirarchy, you may receive "Forbidden" errors unless you add the "FollowSymLinks" directive to the <Directory> entry for the HTML root. - </PARA> - </TIP> - <PARA> + </para> + </tip> + <para> Once all the files are in a web accessible directory, make that directory writable by your webserver's user (which may require just making it world writable). This is a temporary step until you run - the post-install "checksetup.pl" script, which locks down your + the post-install <quote>checksetup.pl</quote> script, which locks down your installation. - </PARA> - <PARA> + </para> + <para> Lastly, you'll need to set up a symbolic link to /usr/bonsaitools/bin/perl for the correct location of your perl executable (probably /usr/bin/perl). Otherwise you must hack all the .cgi files to change where they look for perl. To make future upgrades easier, you should use the symlink approach. - <EXAMPLE> - <TITLE>Setting up bonsaitools symlink</TITLE> - <PARA> + <example> + <title>Setting up bonsaitools symlink</title> + <para> Here's how you set up the Perl symlink on Linux to make Bugzilla work. Your mileage may vary; if you are running on Solaris, you probably need to subsitute - "/usr/local/bin/perl" for "/usr/bin/perl" below; if on certain other UNIX systems, - Perl may live in weird places like "/opt/perl". As root, run these commands: - <PROGRAMLISTING> + <quote>/usr/local/bin/perl</quote> for <quote>/usr/bin/perl</quote> + below; if on certain other UNIX systems, + Perl may live in weird places like <quote>/opt/perl</quote>. As root, run these commands: + <programlisting> bash# mkdir /usr/bonsaitools bash# mkdir /usr/bonsaitools/bin bash# ln -s /usr/bin/perl /usr/bosaitools/bin/perl - </PROGRAMLISTING> - </PARA> - </EXAMPLE> - <TIP> - <PARA> - If you don't have root access to set this symlink up, check out the - "setperl.csh" utility, listed in the Patches section of this - Guide. It will change the path to perl in all your Bugzilla files for - you. - </PARA> - </TIP> - </PARA> - </SECTION> + </programlisting> + </para> + </example> + <tip> + <para> + If you don't have root access to set this symlink up, + check out the + <xref linkend="setperl">, listed in <xref linkend="patches">. + It will change the path to perl in all your Bugzilla files for you. + </para> + </tip> + </para> + </section> - <SECTION> - <TITLE>Setting Up the MySQL Database</TITLE> - <PARA> + <section> + <title>Setting Up the MySQL Database</title> + <para> After you've gotten all the software installed and working you're ready to start preparing the database for its life as a the back end to a high quality bug tracker. - </PARA> - <PARA> + </para> + <para> First, you'll want to fix MySQL permissions to allow access from Bugzilla. For the purpose of this Installation section, the Bugzilla username - will be "bugs", and will have minimal permissions. Bugzilla has - not undergone a thorough security audit. It may be possible for - a system cracker to somehow trick Bugzilla into executing a command - such as "; DROP DATABASE mysql". - </PARA> - <PARA> - That would be bad. - </PARA> - <PARA> + will be "bugs", and will have minimal permissions. + + <warning> + <para> + Bugzilla has not undergone a thorough security audit. It + may be possible for a system cracker to somehow trick + Bugzilla into executing a command such as <command>DROP + DATABASE mysql</command>. + </para> + <para>That would be bad.</para> + </warning> + </para> + + <para> Give the MySQL root user a password. MySQL passwords are limited to 16 characters. - <SIMPLELIST> - <MEMBER> - <COMPUTEROUTPUT> - <PROMPT>bash#</PROMPT> - <COMMAND>mysql -u root mysql</COMMAND> - </COMPUTEROUTPUT> - </MEMBER> - <MEMBER> - <COMPUTEROUTPUT> - <PROMPT>mysql></PROMPT> - <COMMAND> + <simplelist> + <member> + <computeroutput> + <prompt>bash#</prompt> + <command>mysql -u root mysql</command> + </computeroutput> + </member> + <member> + <computeroutput> + <prompt>mysql></prompt> + <command> UPDATE user SET Password=PASSWORD ('new_password') WHERE user='root'; - </COMMAND> - </COMPUTEROUTPUT> - </MEMBER> - <MEMBER> - <COMPUTEROUTPUT> - <PROMPT>mysql></PROMPT> - <COMMAND>FLUSH PRIVILEGES;</COMMAND> - </COMPUTEROUTPUT> - </MEMBER> - </SIMPLELIST> + </command> + </computeroutput> + </member> + <member> + <computeroutput> + <prompt>mysql></prompt> + <command>FLUSH PRIVILEGES;</command> + </computeroutput> + </member> + </simplelist> From this point on, if you need to access MySQL as the MySQL root user, you will need to use "mysql -u root -p" and enter your new_password. Remember that MySQL user names have nothing to do with Unix user names (login names). - </PARA> - <PARA> + </para> + <para> Next, we create the "bugs" user, and grant sufficient permissions for checksetup.pl, which we'll use later, to work its magic. This also restricts the "bugs" user to operations @@ -580,755 +635,1091 @@ bash# ln -s /usr/bin/perl /usr/bosaitools/bin/perl to connect from "localhost". Modify it to reflect your setup if you will be connecting from another machine or as a different user. - </PARA> - <PARA> + </para> + <para> Remember to set bugs_password to some unique password. - <SIMPLELIST> - <MEMBER> - <COMPUTEROUTPUT> - <PROMPT>mysql></PROMPT> - <COMMAND>GRANT SELECT,INSERT,UPDATE,DELETE,INDEX, + <simplelist> + <member> + <computeroutput> + <prompt>mysql></prompt> + <command>GRANT SELECT,INSERT,UPDATE,DELETE,INDEX, ALTER,CREATE,DROP,REFERENCES ON bugs.* TO bugs@localhost - IDENTIFIED BY 'bugs_password';</COMMAND> - </COMPUTEROUTPUT> - </MEMBER> - <MEMBER> - <COMPUTEROUTPUT> - <PROMPT> + IDENTIFIED BY 'bugs_password';</command> + </computeroutput> + </member> + <member> + <computeroutput> + <prompt> mysql> - </PROMPT> - <COMMAND> + </prompt> + <command> FLUSH PRIVILEGES; - </COMMAND> - </COMPUTEROUTPUT> - </MEMBER> - </SIMPLELIST> - </PARA> - <PARA> + </command> + </computeroutput> + </member> + </simplelist> + </para> + <para> Next, run the magic checksetup.pl script. (Many thanks to Holger Schurig <holgerschurig@nikocity.de> for writing this script!) It will make sure Bugzilla files and directories have reasonable permissions, set up the "data" directory, and create all the MySQL tables. - <SIMPLELIST> - <MEMBER> - <COMPUTEROUTPUT> - <PROMPT>bash#</PROMPT> - <COMMAND>./checksetup.pl</COMMAND> - </COMPUTEROUTPUT> - </MEMBER> - </SIMPLELIST> + <simplelist> + <member> + <computeroutput> + <prompt>bash#</prompt> + <command>./checksetup.pl</command> + </computeroutput> + </member> + </simplelist> The first time you run it, it will create a file called "localconfig". - </PARA> - </SECTION> + </para> + </section> - <SECTION> - <TITLE>Tweaking "localconfig"</TITLE> - <PARA> + <section> + <title>Tweaking "localconfig"</title> + <para> This file contains a variety of settings you may need to tweak including how Bugzilla should connect to the MySQL database. - </PARA> - <PARA> + </para> + <para> The connection settings include: - <ORDEREDLIST> - <LISTITEM> - <PARA> + <orderedlist> + <listitem> + <para> server's host: just use "localhost" if the MySQL server is local - </PARA> - </LISTITEM> - <LISTITEM> - <PARA> + </para> + </listitem> + <listitem> + <para> database name: "bugs" if you're following these directions - </PARA> - </LISTITEM> - <LISTITEM> - <PARA> + </para> + </listitem> + <listitem> + <para> MySQL username: "bugs" if you're following these directions - </PARA> - </LISTITEM> - <LISTITEM> - <PARA> + </para> + </listitem> + <listitem> + <para> Password for the "bugs" MySQL account above - </PARA> - </LISTITEM> - </ORDEREDLIST> - </PARA> - <PARA> + </para> + </listitem> + </orderedlist> + </para> + <para> + You may also install .htaccess files that the Apache webserver will use + to restrict access to Bugzilla data files. See <xref linkend="htaccess">. + </para> + <para> Once you are happy with the settings, re-run checksetup.pl. On this second run, it will create the database and an administrator account for which you will be prompted to provide information. - </PARA> - <PARA> + </para> + <para> When logged into an administrator account once Bugzilla is running, if you go to the query page (off of the bugzilla main menu), you'll find an 'edit parameters' option that is filled with editable treats. - </PARA> - <PARA> + </para> + <para> Should everything work, you should have a nearly empty copy of the bug tracking setup. - </PARA> - <PARA> + </para> + <para> The second time around, checksetup.pl will stall if it is on a filesystem that does not fully support file locking via flock(), such as NFS mounts. This support is required for Bugzilla to operate safely with multiple instances. If flock() is not fully supported, it will stall at: - <ERRORCODE>Now regenerating the shadow database for all bugs.</ERRORCODE> - <NOTE> - <PARA> + <errorcode>Now regenerating the shadow database for all bugs.</errorcode> + <note> + <para> The second time you run checksetup.pl, you should become the - user your web server runs as, and that you ensure you have set the - "webservergroup" parameter in localconfig to match the web server's group - name, if any. I believe, for the next release of Bugzilla, this will - be fixed so that Bugzilla supports a "webserveruser" parameter in localconfig + user your web server runs as, and that you ensure that you set the + "webservergroup" parameter in localconfig to match the web + server's group + name, if any. I believe, for the next release of Bugzilla, + this will + be fixed so that Bugzilla supports a "webserveruser" parameter + in localconfig as well. - <EXAMPLE> - <TITLE>Running checksetup.pl as the web user</TITLE> - <PARA> - Assuming your web server runs as user "apache", and Bugzilla is installed in - "/usr/local/bugzilla", here's one way to run checksetup.pl as the web server user. - As root, for the <EMPHASIS>second run</EMPHASIS> of checksetup.pl, do this: - <PROGRAMLISTING> + <example> + <title>Running checksetup.pl as the web user</title> + <para> + Assuming your web server runs as user "apache", + and Bugzilla is installed in + "/usr/local/bugzilla", here's one way to run checksetup.pl + as the web server user. + As root, for the <emphasis>second run</emphasis> + of checksetup.pl, do this: + <programlisting> bash# chown -R apache:apache /usr/local/bugzilla bash# su - apache bash# cd /usr/local/bugzilla bash# ./checksetup.pl - </PROGRAMLISTING> - </PARA> - </EXAMPLE> - </PARA> - </NOTE> - </PARA> - <NOTE> - <PARA> - The checksetup.pl script is designed so that you can run it at any time - without causing harm. You should run it after any upgrade to Bugzilla. - </PARA> - </NOTE> - </SECTION> - - <SECTION> - <TITLE>Setting Up Maintainers Manually (Optional)</TITLE> - <PARA> - If you want to add someone else to every group by hand, you can do it - by typing the appropriate MySQL commands. Run '<COMPUTEROUTPUT> - mysql -u root -p bugs</COMPUTEROUTPUT>' - (you may need different parameters, depending on your security settings - according to section 3, above). Then: - <SIMPLELIST> - <MEMBER> - <COMPUTEROUTPUT> - <PROMPT>mysql></PROMPT> - <COMMAND>update profiles set groupset=0x7fffffffffffffff - where login_name = 'XXX';</COMMAND> - </COMPUTEROUTPUT> - </MEMBER> - </SIMPLELIST> - replacing XXX with the Bugzilla email address. - </PARA> - </SECTION> + </programlisting> + </para> + </example> + </para> + </note> + </para> + <note> + <para> + The checksetup.pl script is designed so that you can run + it at any time without causing harm. You should run it + after any upgrade to Bugzilla. + </para> + </note> + </section> - <SECTION> - <TITLE>The Whining Cron (Optional)</TITLE> - <PARA> - By now you've got a fully functional bugzilla, but what good are bugs - if they're not annoying? To help make those bugs more annoying you can - set up bugzilla's automatic whining system. This can be done by adding - the following command as a daily crontab entry (for help on that see that - crontab man page): - <SIMPLELIST> - <MEMBER> - <COMPUTEROUTPUT> - <COMMAND>cd <your-bugzilla-directory> ; ./whineatnews.pl</COMMAND> - </COMPUTEROUTPUT> - </MEMBER> - </SIMPLELIST> - </PARA> - </SECTION> + <section> + <title>Setting Up Maintainers Manually (Optional)</title> + <para> + If you want to add someone else to every group by hand, you + can do it by typing the appropriate MySQL commands. Run + '<computeroutput> mysql -u root -p bugs</computeroutput>' You + may need different parameters, depending on your security + settings. Then: + <simplelist> + <member> + <computeroutput> <prompt>mysql></prompt> <command>update + profiles set groupset=0x7fffffffffffffff where + login_name = 'XXX';</command> </computeroutput> + </member> + </simplelist> replacing XXX with the Bugzilla email address. + </para> + </section> - <SECTION> - <TITLE>Bug Graphs (Optional)</TITLE> - <PARA> - As long as you installed the GD and Graph::Base Perl modules you might - as well turn on the nifty bugzilla bug reporting graphs. - </PARA> - <PARA> - Add a cron entry like this to run collectstats daily at 5 after midnight: - <SIMPLELIST> - <MEMBER> - <COMPUTEROUTPUT> - <PROMPT>bash#</PROMPT> - <COMMAND>crontab -e</COMMAND> - </COMPUTEROUTPUT> - </MEMBER> - <MEMBER> - <COMPUTEROUTPUT> - 5 0 * * * cd <your-bugzilla-directory> ; ./collectstats.pl - </COMPUTEROUTPUT> - </MEMBER> - </SIMPLELIST> - </PARA> - <PARA> - After two days have passed you'll be able to view bug graphs from the - Bug Reports page. - </PARA> - </SECTION> + <section> + <title>The Whining Cron (Optional)</title> + <para> + By now you have a fully functional bugzilla, but what good + are bugs if they're not annoying? To help make those bugs + more annoying you can set up bugzilla's automatic whining + system. This can be done by adding the following command as a + daily crontab entry (for help on that see that crontab man + page): + <simplelist> + <member> + <computeroutput> <command>cd + <your-bugzilla-directory> ; + ./whineatnews.pl</command> </computeroutput> + </member> + </simplelist> + </para> + <tip> + <para> + Depending on your system, crontab may have several manpages. + The following command should lead you to the most useful + page for this purpose: + <programlisting> + man 5 crontab + </programlisting> + </para> + </tip> + </section> + + <section> + <title>Bug Graphs (Optional)</title> + <para> + As long as you installed the GD and Graph::Base Perl modules + you might as well turn on the nifty bugzilla bug reporting + graphs. + </para> + <para> + Add a cron entry like this to run collectstats daily at 5 + after midnight: + <simplelist> + <member> + <computeroutput> <prompt>bash#</prompt> <command>crontab + -e</command> </computeroutput> + </member> + <member> + <computeroutput> 5 0 * * * cd + <your-bugzilla-directory> ; ./collectstats.pl + </computeroutput> + </member> + </simplelist> + </para> + <para> + After two days have passed you'll be able to view bug graphs + from the Bug Reports page. + </para> + </section> + + <section> + <title>Securing MySQL</title> + <para> + If you followed the installation instructions for setting up + your "bugs" and "root" user in MySQL, much of this should not + apply to you. If you are upgrading an existing installation + of Bugzilla, you should pay close attention to this section. + </para> + <para> + Most MySQL installs have "interesting" default security parameters: + <simplelist> + <member>mysqld defaults to running as root</member> + <member>it defaults to allowing external network connections</member> + <member>it has a known port number, and is easy to detect</member> + <member>it defaults to no passwords whatsoever</member> + <member>it defaults to allowing "File_Priv"</member> + </simplelist> + </para> + <para> + This means anyone from anywhere on the internet can not only + drop the database with one SQL command, and they can write as + root to the system. + </para> + <para> + To see your permissions do: + <simplelist> + <member> + <computeroutput> + <prompt>bash#</prompt> + <command>mysql -u root -p</command> + </computeroutput> + </member> + <member> + <computeroutput> + <prompt>mysql></prompt> + <command>use mysql;</command> + </computeroutput> + </member> + <member> + <computeroutput> + <prompt>mysql></prompt> + <command>show tables;</command> + </computeroutput> + </member> + <member> + <computeroutput> + <prompt>mysql></prompt> + <command>select * from user;</command> + </computeroutput> + </member> + <member> + <computeroutput> + <prompt>mysql></prompt> + <command>select * from db;</command> + </computeroutput> + </member> + </simplelist> + </para> + <para> + To fix the gaping holes: + <simplelist> + <member>DELETE FROM user WHERE User='';</member> + <member>UPDATE user SET Password=PASSWORD('new_password') WHERE user='root';</member> + <member> FLUSH PRIVILEGES;</member> + </simplelist> + </para> + <para> + If you're not running "mit-pthreads" you can use: + <simplelist> + <member>GRANT USAGE ON *.* TO bugs@localhost;</member> + <member>GRANT ALL ON bugs.* TO bugs@localhost;</member> + <member>REVOKE DROP ON bugs.* FROM bugs@localhost;</member> + <member>FLUSH PRIVILEGES;</member> + </simplelist> + </para> + <para> + With "mit-pthreads" you'll need to modify the "globals.pl" Mysql->Connect + line to specify a specific host name instead of "localhost", and accept + external connections: + <simplelist> + <member>GRANT USAGE ON *.* TO bugs@bounce.hop.com;</member> + <member>GRANT ALL ON bugs.* TO bugs@bounce.hop.com;</member> + <member>REVOKE DROP ON bugs.* FROM bugs@bounce.hop.com;</member> + <member>FLUSH PRIVILEGES;</member> + </simplelist> + </para> + <para> + Use .htaccess files with the Apache webserver to secure your + bugzilla install. See <xref linkend="htaccess"> + </para> + <para> + Consider also: + <orderedlist> + <listitem> + <para> + Turning off external networking with "--skip-networking", + unless you have "mit-pthreads", in which case you can't. + Without networking, MySQL connects with a Unix domain socket. + </para> + </listitem> + <listitem> + <para> + using the --user= option to mysqld to run it as an unprivileged + user. + </para> + </listitem> + <listitem> + <para> + starting MySQL in a chroot jail + </para> + </listitem> + <listitem> + <para> + running the httpd in a "chrooted" jail + </para> + </listitem> + <listitem> + <para> + making sure the MySQL passwords are different from the OS + passwords (MySQL "root" has nothing to do with system "root"). + </para> + </listitem> + <listitem> + <para> + running MySQL on a separate untrusted machine + </para> + </listitem> + <listitem> + <para> + making backups ;-) + </para> + </listitem> + </orderedlist> + </para> + </section> + </section> + <section id="osx"> + <title>Mac OS X Installation Notes</title> + <para> + There are a lot of common libraries and utilities out there + that Apple did not include with Mac OS X, but which run + perfectly well on it. The GD library, which Bugzilla needs to + do bug graphs, is one of these. + </para> + <para> + The easiest way to get a lot of these is with a program called + Fink, which is similar in nature to the CPAN installer, but + installs common GNU utilities. Fink is available from + <http://sourceforge.net/projects/fink/>. + </para> + <para> + Follow the instructions for setting up Fink. Once it's + installed, you'll want to run the following as root: + <command>fink install gd</command> + </para> + <para> + It will prompt you for a number of dependencies, type 'y' and + hit enter to install all of the dependencies. Then watch it + work. + </para> + <para> + To prevent creating conflicts with the software that Apple + installs by default, Fink creates its own directory tree at + /sw where it installs most of the software that it installs. + This means your libraries and headers for libgd will be at + /sw/lib and /sw/include instead of /usr/lib and + /usr/local/include. Because of these changed locations for + the libraries, the Perl GD module will not install directly + via CPAN (it looks for the specific paths instead of getting + them from your environment). But there's a way around that + :-) + </para> + <para> + Instead of typing <quote>install GD</quote> at the + <prompt>cpan></prompt> prompt, type <command>look + GD</command>. This should go through the motions of + downloading the latest version of the GD module, then it will + open a shell and drop you into the build directory. Apply the + following patch to the Makefile.PL file (save the patch into a + file and use the command <command>patch < + patchfile</command>: + </para> + <para> + <programlisting> +<![CDATA[ + +--- GD-1.33/Makefile.PL Fri Aug 4 16:59:22 2000 ++++ GD-1.33-darwin/Makefile.PL Tue Jun 26 01:29:32 2001 +@@ -3,8 +3,8 @@ + warn "NOTICE: This module requires libgd 1.8.3 or higher (shared library version 4.X).\n"; + + # =====> PATHS: CHECK AND ADJUST <===== +-my @INC = qw(-I/usr/local/include -I/usr/local/include/gd); +-my @LIBPATH = qw(-L/usr/lib/X11 -L/usr/X11R6/lib -L/usr/X11/lib -L/usr/local/lib ); ++my @INC = qw(-I/sw/include -I/sw/include/gd -I/usr/local/include -I/usr/local/include/gd); ++my @LIBPATH = qw(-L/usr/lib/X11 -L/usr/X11R6/lib -L/usr/X11/lib -L/sw/lib -L/usr/local/lib); + my @LIBS = qw(-lgd -lpng -lz); + + # FEATURE FLAGS +@@ -23,7 +23,7 @@ + + push @LIBS,'-lttf' if $TTF; + push @LIBS,'-ljpeg' if $JPEG; +-push @LIBS, '-lm' unless $^O eq 'MSWin32'; ++push @LIBS, '-lm' unless ($^O =~ /^MSWin32|darwin$/); + + # FreeBSD 3.3 with libgd built from ports croaks if -lXpm is specified + if ($^O ne 'freebsd' && $^O ne 'MSWin32') { - <SECTION> - <TITLE>Securing MySQL</TITLE> - <PARA> - If you followed the README for setting up your "bugs" and "root" user in - MySQL, much of this should not apply to you. If you are upgrading - an existing installation of Bugzilla, you should pay close attention - to this section. - </PARA> - <PARA> - Most MySQL installs have "interesting" default security parameters: - <SIMPLELIST> - <MEMBER>mysqld defaults to running as root</MEMBER> - <MEMBER>it defaults to allowing external network connections</MEMBER> - <MEMBER>it has a known port number, and is easy to detect</MEMBER> - <MEMBER>it defaults to no passwords whatsoever</MEMBER> - <MEMBER>it defaults to allowing "File_Priv"</MEMBER> - </SIMPLELIST> - </PARA> - <PARA> - This means anyone from anywhere on the internet can not only drop the - database with one SQL command, and they can write as root to the system. - </PARA> - <PARA> - To see your permissions do: - <SIMPLELIST> - <MEMBER> - <COMPUTEROUTPUT> - <PROMPT>bash#</PROMPT> - <COMMAND>mysql -u root -p</COMMAND> - </COMPUTEROUTPUT> - </MEMBER> - <MEMBER> - <COMPUTEROUTPUT> - <PROMPT>mysql></PROMPT> - <COMMAND>use mysql;</COMMAND> - </COMPUTEROUTPUT> - </MEMBER> - <MEMBER> - <COMPUTEROUTPUT> - <PROMPT>mysql></PROMPT> - <COMMAND>show tables;</COMMAND> - </COMPUTEROUTPUT> - </MEMBER> - <MEMBER> - <COMPUTEROUTPUT> - <PROMPT>mysql></PROMPT> - <COMMAND>select * from user;</COMMAND> - </COMPUTEROUTPUT> - </MEMBER> - <MEMBER> - <COMPUTEROUTPUT> - <PROMPT>mysql></PROMPT> - <COMMAND>select * from db;</COMMAND> - </COMPUTEROUTPUT> - </MEMBER> - </SIMPLELIST> - </PARA> - <PARA> - To fix the gaping holes: - <SIMPLELIST> - <MEMBER>DELETE FROM user WHERE User='';</MEMBER> - <MEMBER>UPDATE user SET Password=PASSWORD('new_password') WHERE user='root';</MEMBER> - <MEMBER> FLUSH PRIVILEGES;</MEMBER> - </SIMPLELIST> - </PARA> - <PARA> - If you're not running "mit-pthreads" you can use: - <SIMPLELIST> - <MEMBER>GRANT USAGE ON *.* TO bugs@localhost;</MEMBER> - <MEMBER>GRANT ALL ON bugs.* TO bugs@localhost;</MEMBER> - <MEMBER>REVOKE DROP ON bugs.* FROM bugs@localhost;</MEMBER> - <MEMBER>FLUSH PRIVILEGES;</MEMBER> - </SIMPLELIST> - </PARA> - <PARA> - With "mit-pthreads" you'll need to modify the "globals.pl" Mysql->Connect - line to specify a specific host name instead of "localhost", and accept - external connections: - <SIMPLELIST> - <MEMBER>GRANT USAGE ON *.* TO bugs@bounce.hop.com;</MEMBER> - <MEMBER>GRANT ALL ON bugs.* TO bugs@bounce.hop.com;</MEMBER> - <MEMBER>REVOKE DROP ON bugs.* FROM bugs@bounce.hop.com;</MEMBER> - <MEMBER>FLUSH PRIVILEGES;</MEMBER> - </SIMPLELIST> - </PARA> - <PARA> - Consider also: - <ORDEREDLIST> - <LISTITEM> - <PARA> - Turning off external networking with "--skip-networking", - unless you have "mit-pthreads", in which case you can't. - Without networking, MySQL connects with a Unix domain socket. - </PARA> - </LISTITEM> - <LISTITEM> - <PARA> - using the --user= option to mysqld to run it as an unprivileged - user. - </PARA> - </LISTITEM> - <LISTITEM> - <PARA> - starting MySQL in a chroot jail - </PARA> - </LISTITEM> - <LISTITEM> - <PARA> - running the httpd in a "chrooted" jail - </PARA> - </LISTITEM> - <LISTITEM> - <PARA> - making sure the MySQL passwords are different from the OS - passwords (MySQL "root" has nothing to do with system "root"). - </PARA> - </LISTITEM> - <LISTITEM> - <PARA> - running MySQL on a separate untrusted machine - </PARA> - </LISTITEM> - <LISTITEM> - <PARA> - making backups ;-) - </PARA> - </LISTITEM> - </ORDEREDLIST> - </PARA> - </SECTION> - - <SECTION> - <TITLE>Installation General Notes</TITLE> - <SECTION> - <TITLE>Modifying Your Running System</TITLE> - <PARA> - Bugzilla optimizes database lookups by storing all relatively static - information in the versioncache file, located in the data/ subdirectory - under your installation directory (we said before it needs to be writable, - right?!) - </PARA> - <PARA> - If you make a change to the structural data in your database (the - versions table for example), or to the "constants" encoded in - defparams.pl, you will need to remove the cached content from the data - directory (by doing a "rm data/versioncache"), or your changes won't show - up! - </PARA> - <PARA> - That file gets automatically regenerated whenever it's more than an - hour old, so Bugzilla will eventually notice your changes by itself, but - generally you want it to notice right away, so that you can test things. - </PARA> - </SECTION> - <SECTION> - <TITLE>Upgrading From Previous Versions</TITLE> - <PARA> - The developers of Bugzilla are constantly adding new tables, columns and - fields. You'll get SQL errors if you just update the code. The strategy - to update is to simply always run the checksetup.pl script whenever - you upgrade your installation of Bugzilla. If you want to see what has - changed, you can read the comments in that file, starting from the end. - </PARA> - </SECTION> - <SECTION> - <TITLE>UNIX Installation Instructions History</TITLE> - <PARA> - This document was originally adapted from the Bonsai installation - instructions by Terry Weissman <terry@mozilla.org>. - </PARA> - <PARA> - 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). - </PARA> - <PARA> - This document was heavily modified again Wednesday, March 07 2001 to - reflect changes for Bugzilla 2.12 release by Matthew P. Barnson. The - securing MySQL section should be changed to become standard procedure - for Bugzilla installations. - </PARA> - <PARA> - Finally, the README in its entirety was marked up in SGML and included into - the Guide on April 24, 2001. - </PARA> - <PARA> - Comments from people using this Guide for the first time are particularly welcome. - </PARA> - </SECTION> - </SECTION> - - </SECTION> - </SECTION> +]]> + </programlisting> + </para> + <para> + Then, run these commands to finish the installation of the perl module: + <simplelist> + <member><command>perl Makefile.PL</command></member> + <member><command>make</command></member> + <member><command>make test</command></member> + <member><command>make install</command></member> + <member>And don't forget to run <command>exit</command> to get back to cpan.</member> + </simplelist> + </para> + <para> + Happy Hacking! + </para> + </section> + + <section id="bsdinstall" xreflabel="BSD Installation Notes"> + <title>BSD Installation Notes</title> + <para> + For instructions on how to set up Bugzilla on FreeBSD, NetBSD, OpenBSD, BSDi, etc. please + consult <xref linkend="osx">. + </para> + </section> + + + <section id="geninstall" xreflabel="Installation General Notes"> + <title>Installation General Notes</title> + <section> + <title>Modifying Your Running System</title> + <para> + Bugzilla optimizes database lookups by storing all relatively static + information in the versioncache file, located in the data/ subdirectory + under your installation directory. + </para> + <para> + If you make a change to the structural data in your database + (the versions table for example), or to the + <quote>constants</quote> encoded in defparams.pl, you will + need to remove the cached content from the data directory + (by doing a <quote>rm data/versioncache</quote>), or your + changes won't show up. + </para> + <para> + That file gets automatically regenerated whenever it's more than an + hour old, so Bugzilla will eventually notice your changes by itself, but + generally you want it to notice right away, so that you can test things. + </para> + </section> + <section> + <title>Upgrading From Previous Versions</title> + <para> + The developers of Bugzilla are constantly adding new tables, columns and + fields. You'll get SQL errors if you just update the code. The strategy + to update is to simply always run the checksetup.pl script whenever + you upgrade your installation of Bugzilla. If you want to see what has + changed, you can read the comments in that file, starting from the end. + </para> + <para> + If you are running Bugzilla version 2.8 or lower, and wish to upgrade to + the latest version, please consult the file, "UPGRADING-pre-2.8" in the + Bugzilla root directory after untarring the archive. + </para> + </section> - <SECTION id="README.windows"> - <TITLE>Win32 (Win98+/NT/2K) Installation</TITLE> - <PARA> - These directions have <EMPHASIS>not</EMPHASIS> been extensively tested. - We need testers! Please try these out and post any changes to the - newsgroup. - </PARA> - <SECTION id="ntverified"> - <TITLE>Win32 Installation: Step-by-step</TITLE> - <NOTE> - <PARA> - You should be familiar with, and cross-reference, the UNIX README - while performing your Win32 installation. Unfortunately, Win32 - directions are not yet as detailed as those for UNIX. - </PARA> - <PARA> - The <EMPHASIS>most critical</EMPHASIS> difference for Win32 users is - the lack of support for a crypt() function in MySQL for Windows. It does not - have it! All ENCRYPT statements must be modified. - </PARA> - </NOTE> + <section id="htaccess" xreflabel=".htaccess files and security"> + <title><filename>.htaccess</filename> files and security</title> + <para> + To enhance the security of your Bugzilla installation, + Bugzilla will generate + <glossterm><filename>.htaccess</filename></glossterm> files + which the Apache webserver can use to restrict access to + the bugzilla data files. The checksetup script will + generate the <filename>.htaccess</filename> files. + + <note> + <para> + If you are using an alternate provider of + <productname>webdot</productname> services for graphing + (as described when viewing + <filename>editparams.cgi</filename> in your web + browser), you will need to change the ip address in + <filename>data/webdot/.htaccess</filename> to the ip + address of the webdot server that you are using. + </para> + </note> + + </para> + <para> + If you are using Internet Information Server or other web + server which does not observe <filename>.htaccess</filename> + conventions, you can disable their creation by editing + <filename>localconfig</filename> and setting the + <varname>$create_htaccess</varname> variable to + <parameter>0</parameter>. + </para> + </section> + + <section> + <title>UNIX Installation Instructions History</title> + <para> + This document was originally adapted from the Bonsai installation + instructions by Terry Weissman <terry@mozilla.org>. + </para> + <para> + 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). + </para> + <para> + This document was heavily modified again Wednesday, March 07 2001 to + reflect changes for Bugzilla 2.12 release by Matthew P. Barnson. The + securing MySQL section should be changed to become standard procedure + for Bugzilla installations. + </para> + <para> + Finally, the README in its entirety was marked up in SGML and included into + the Guide on April 24, 2001 by Matt Barnson. Since that time, it's undergone + extensive modification as Bugzilla grew. + </para> + <para> + Comments from people using this Guide for the first time are particularly welcome. + </para> + </section> + </section> + + <section id="win32" xreflabel="Win32 Installation Notes"> + <title>Win32 Installation Notes</title> + <para>This section covers installation on Microsoft Windows 95, + 98, ME, NT, and 2000. Bugzilla works fine on Win32 platforms, + but please remember that the Bugzilla team and the author of the + Guide neither endorse nor support installation on Microsoft + Windows. Bugzilla installs and runs <emphasis>best</emphasis> + and <emphasis>easiest</emphasis> on UNIX-like operating systems, + and that is the way it will stay for the foreseeable future. The + Bugzilla team is considering supporting Win32 for the 2.16 + release and later.</para> + <para>The easiest way to install Bugzilla on Intel-archiecture + machines is to install some variant of GNU/Linux, then follow + the UNIX installation instructions in this Guide. If you have + any influence in the platform choice for running this system, + please choose GNU/Linux instead of Microsoft Windows.</para> - <PROCEDURE> - <STEP> - <PARA> - Install <ULINK URL="http://www.apache.org/">Apache Web Server</ULINK> + <section id="wininstall" xreflabel="Win32 Installation: Step-by-step"> + <title>Win32 Installation: Step-by-step</title> + <note> + <para> + You should be familiar with, and cross-reference, the rest + of the + <xref linkend="installation"> section while performing your + Win32 installation. + </para> + <para> Making Bugzilla work on Microsoft Windows is no + picnic. Support for Win32 has improved dramatically in the + last few releases, but, if you choose to proceed, you should + be a <emphasis>very</emphasis> skilled Windows Systems + Administrator with both strong troubleshooting abilities and + a high tolerance for pain. Bugzilla on NT requires hacking + source code and implementing some advanced utilities. What + follows is the recommended installation procedure for Win32; + additional suggestions are provided in <xref linkend="faq">. + </para> + </note> + + <procedure> + <step> + <para> + Install <ulink url="http://www.apache.org/">Apache Web Server</ulink> for Windows. - </PARA> - <NOTE> - <PARA> + </para> + <note> + <para> You may also use Internet Information Server or Personal Web Server for this purpose. However, setup is slightly more difficult. If ActivePerl doesn't seem to handle your file associations correctly (for .cgi and .pl files), please - consult the FAQ, in the "Win32" section. - </PARA> - <PARA> - If you are going to use IIS, if on Windows NT you must be updated - to at least Service Pack 4. - </PARA> - </NOTE> - </STEP> - <STEP> - <PARA> - Install <ULINK URL="http://www.activestate.com/">ActivePerl</ULINK> - </PARA> - <PARA> + consult <xref linkend="faq">. + </para> + <para> + If you are going to use IIS, if on Windows NT you must + be updated to at least Service Pack 4. Windows 2000 + ships with a sufficient version of IIS. + </para> + </note> + </step> + <step> + <para> + Install <ulink url="http://www.activestate.com/">ActivePerl</ulink> for Windows. Check <ulink url="http://aspn.activestate.com/ASPN/Downloads/ActivePerl/">http://aspn.activestate.com/ASPN/Downloads/ActivePerl</ulink> for a current compiled binary. + </para> + <para> Please also check the following links to fully understand the status of ActivePerl on Win32: - <ULINK URL="http://language.perl.com/newdocs/pod/perlport.html"> - Perl Porting</ULINK>, and - <ULINK URL="http://ftp.univie.ac.at/packages/perl/ports/nt/FAQ/perlwin32faq5.html"> - Hixie Click Here</ULINK> - </PARA> - </STEP> - <STEP> - <PARA> + <ulink url="http://language.perl.com/newdocs/pod/perlport.html"> + Perl Porting</ulink>, and + <ulink url="http://ftp.univie.ac.at/packages/perl/ports/nt/FAQ/perlwin32faq5.html"> + Perl on Win32 FAQ</ulink> + </para> + </step> + <step> + <para> Use ppm from your perl\bin directory to install the following packs: DBI, DBD-Mysql, TimeDate, Chart, Date-Calc, Date-Manip, and GD. You may need to extract them from .zip format using Winzip or other unzip program first. These additional ppm modules can be downloaded from ActiveState. - </PARA> - <PARA> + </para> + <note> + <para> + You can find a list of modules at + <ulink url="http://www.activestate.com/PPMPackages/zips/5xx-builds-only"> + http://www.activestate.com/PPMPackages/zips/5xx-builds-only/</ulink> + </para> + </note> + <para> The syntax for ppm is: - <COMPUTEROUTPUT> - <PROMPT>C:> </PROMPT><COMMAND>ppm install <module>.ppd</COMMAND> - </COMPUTEROUTPUT> - </PARA> - <PARA> + <computeroutput> + <prompt>C:> </prompt><command>ppm <modulename></command> + </computeroutput> + </para> + + <example> + <title>Installing ActivePerl ppd Modules on Microsoft Windows</title> + <para><prompt>C:></prompt><command>ppm + <option>DBD-Mysql</option></command></para> + <para>Watch your capitalization!</para> + </example> + + <para> You can find ActiveState ppm modules at - <ULINK URL="http://www.activestate.com/PPMPackages/5.6plus/"> - http://www.activestate.com/PPMPackages/5.6plus</ULINK> - </PARA> - </STEP> - <STEP> - <PARA> - Download and install the Windows GNU tools from - <ULINK URL="http://www.cygwin.com/">www.cygwin.com</ULINK>. - Make sure the GNU utilities are in your $PATH. - </PARA> - </STEP> - <STEP> - <PARA> + <ulink url="http://www.activestate.com/PPMPackages/5.6plus/"> + http://www.activestate.com/PPMPackages/5.6plus</ulink> + </para> + </step> + + <step> + <para> Install MySQL for NT. - <NOTE> - <PARA> - Your configuration file for MySQL <EMPHASIS>must</EMPHASIS> be named C:\MY.CNF. - </PARA> - </NOTE> - </PARA> - </STEP> - <STEP> - <PARA> + <note> + <para> + You can download MySQL for Windows NT from <ulink + url="http://www.mysql.com/">MySQL.com</ulink>. Some find it helpful to use the WinMySqlAdmin utility, included with the download, to set up the database. + </para> + </note> + </para> + </step> + <step> + <para> Setup MySQL - </PARA> - <SUBSTEPS> - <STEP> - <PARA> - <COMPUTEROUTPUT> - <PROMPT>C:> </PROMPT> - <COMMAND>C:\mysql\bin\mysql -u root mysql</COMMAND> - </COMPUTEROUTPUT> - </PARA> - </STEP> - <STEP> - <PARA> - <COMPUTEROUTPUT> - <PROMPT>mysql></PROMPT> - <COMMAND>DELETE FROM user WHERE Host='localhost' AND User='';</COMMAND> - </COMPUTEROUTPUT> - </PARA> - </STEP> - <STEP> - <PARA> - <COMPUTEROUTPUT> - <PROMPT>mysql></PROMPT> - <COMMAND>UPDATE user SET Password=PASSWORD ('new_password') - WHERE user='root';</COMMAND> - </COMPUTEROUTPUT> - </PARA> - </STEP> - <STEP> - <PARA> - <COMPUTEROUTPUT> - <PROMPT>mysql></PROMPT> - <COMMAND>GRANT SELECT, INSERT, UPDATE, DELETE, + </para> + <substeps> + <step> + <para> + <computeroutput> + <prompt>C:> </prompt> + <command>C:\mysql\bin\mysql -u root mysql</command> + </computeroutput> + </para> + </step> + <step> + <para> + <computeroutput> + <prompt>mysql></prompt> + <command>DELETE FROM user WHERE Host='localhost' AND User='';</command> + </computeroutput> + </para> + </step> + <step> + <para> + <computeroutput> + <prompt>mysql></prompt> + <command>UPDATE user SET Password=PASSWORD ('new_password') + WHERE user='root';</command> + </computeroutput> + </para> + <para><quote>new_password</quote>, above, indicates + whatever password you wish to use for your + <quote>root</quote> user.</para> + </step> + <step id="ntbugs-password"> + <para> + <computeroutput> + <prompt>mysql></prompt> + <command>GRANT SELECT, INSERT, UPDATE, DELETE, INDEX, ALTER, CREATE, DROP, REFERENCES ON bugs.* to bugs@localhost - IDENTIFIED BY 'bugs_password';</COMMAND> - </COMPUTEROUTPUT> - </PARA> - </STEP> - <STEP> - <PARA> - <COMPUTEROUTPUT> - <PROMPT>mysql></PROMPT> - <COMMAND>FLUSH PRIVILEGES;</COMMAND> - </COMPUTEROUTPUT> - </PARA> - </STEP> - <STEP> - <PARA> - <COMPUTEROUTPUT> - <PROMPT>mysql></PROMPT> - <COMMAND>create database bugs;</COMMAND> - </COMPUTEROUTPUT> - </PARA> - </STEP> - <STEP> - <PARA> - <COMPUTEROUTPUT> - <PROMPT>mysql></PROMPT> - <COMMAND>exit</COMMAND> - </COMPUTEROUTPUT> - </PARA> - </STEP> - <STEP> - <PARA> - <COMPUTEROUTPUT> - <PROMPT>C:></PROMPT> - <COMMAND>C:\mysql\bin\mysqladmin -u root -p reload</COMMAND> - </COMPUTEROUTPUT> - </PARA> - </STEP> - </SUBSTEPS> - </STEP> + IDENTIFIED BY 'bugs_password';</command> + </computeroutput> + </para> + <para><quote>bugs_password</quote>, above, indicates + whatever password you wish to use for your + <quote>bugs</quote> user.</para> + </step> + <step> + <para> + <computeroutput> + <prompt>mysql></prompt> + <command>FLUSH PRIVILEGES;</command> + </computeroutput> + </para> + </step> + <step> + <para> + <computeroutput> + <prompt>mysql></prompt> + <command>create database bugs;</command> + </computeroutput> + </para> + </step> + <step> + <para> + <computeroutput> + <prompt>mysql></prompt> + <command>exit;</command> + </computeroutput> + </para> + </step> + <step> + <para> + <computeroutput> + <prompt>C:></prompt> + <command>C:\mysql\bin\mysqladmin -u root -p reload</command> + </computeroutput> + </para> + </step> + </substeps> + </step> - <STEP> - <PARA> - Configure Bugzilla. For Win32, this involves editing "defparams.pl" - and "localconfig" to taste. Running "checksetup.pl" should create - localconfig for you. Note that getgrnam() doesn't work, and should be - deleted. Change this line: + <step> + <para> + Edit <filename>checksetup.pl</filename> in your Bugzilla directory. Change + this line: + </para> + <para> "my $webservergid = getgrnam($my_webservergroup); " + </para> + <para> to + </para> + <para> "my $webservergid = $my_webservergroup; " - </PARA> - </STEP> + </para> + </step> + + <step> + <para> + Run <filename>checksetup.pl</filename> from the Bugzilla directory. + </para> + </step> + + <step> + <para>Edit <filename>localconfig</filename> to suit your + requirements. Set <varname>$db_pass</varname> to your + <quote>bugs_password</quote> from <xref + linkend="ntbugs-password">, and <varname>$webservergroup</varname> to <quote>8</quote>.</para> + <note> + <para>Not sure on the <quote>8</quote> for + <varname>$webservergroup</varname> above. If it's + wrong, please send corrections.</para> + </note> + </step> + + <step> + <para> + Edit <filename>defparams.pl</filename> to suit your + requirements. Particularly, set + <varname>DefParam("maintainer")</varname> and + <varname>DefParam("urlbase") to match your + install.</varname> + </para> + <note> + <para>This is yet another step I'm not sure of, since the + maintainer of this documentation does not maintain + Bugzilla on NT. If you can confirm or deny that this + step is required, please let me know.</para> + </note> + </step> - <STEP> - <NOTE> - <PARA> + <step> + <note> + <para> There are several alternatives to Sendmail that will work on Win32. - The one mentioned here is a <EMPHASIS>suggestion</EMPHASIS>, not + The one mentioned here is a <emphasis>suggestion</emphasis>, not a requirement. Some other mail packages that can work include - <ULINK URL="http://www.blat.net/">BLAT</ULINK>, - <ULINK URL="http://www.geocel.com/windmail/">Windmail</ULINK>, - <ULINK URL="http://www.dynamicstate.com/">Mercury Sendmail</ULINK>, + <ulink url="http://www.blat.net/">BLAT</ulink>, + <ulink url="http://www.geocel.com/windmail/">Windmail</ulink>, + <ulink url="http://www.dynamicstate.com/">Mercury Sendmail</ulink>, and the CPAN Net::SMTP Perl module (available in .ppm). Every option requires some hacking of the Perl scripts for Bugzilla to make it work. The option here simply requires the least. - </PARA> - </NOTE> - <PARA> - Download NTsendmail, available from<ULINK URL="http://www.ntsendmail.com/"> - www.ntsendmail.com</ULINK>. In order for it to work, you must set up some - new environment variables (detailed on the ntsendmail home page). Figuring - out where to put those variables is left as an exercise for the reader. - You must have a "real" mail server which allows you to relay off it - in your $ENV{"NTsendmail"} (which you should probably place in globals.pl) - </PARA> - <PARA> - Once downloaded and installed, modify all open(SENDMAIL) calls to open - "| c:\ntsendmail\ntsendmail -t" instead of "|/usr/lib/sendmail -t". - </PARA> - <NOTE> - <PARA> - We need someone to test this and make sure this works as advertised. - </PARA> - </NOTE> - </STEP> - <STEP> - <PARA> - Modify globals.pl and CGI.pl to remove the word "encrypt". - </PARA> - <NOTE> - <PARA> - I'm not sure this is all that is involved to remove crypt. Any - NT Bugzilla hackers want to pipe up? - </PARA> - </NOTE> - </STEP> - <STEP> - <PARA> - Change all references to "processmail" to "processmail.pl" in - all files, and rename "processmail" to "processmail.pl" - </PARA> - <NOTE> - <PARA> - I really think this may be a change we want to make for + </para> + </note> + + <procedure> + <step> + <para> + Download NTsendmail, available from<ulink + url="http://www.ntsendmail.com/"> www.ntsendmail.com</ulink>. You must have a "real" mail server which allows you to relay off it in your $ENV{"NTsendmail"} (which you should probably place in globals.pl) + </para> + </step> + + <step> + <para>Put ntsendmail.pm into your .\perl\lib directory.</para> + </step> + + <step> + <para>Add to globals.pl:</para> + <programlisting> +# these settings configure the NTsendmail process +use NTsendmail; +$ENV{"NTsendmail"}="your.smtpserver.box"; +$ENV{"NTsendmail_debug"}=1; +$ENV{"NTsendmail_max_tries"}=5; + </programlisting> + <note> + <para> + Some mention to also edit + <varname>$db_pass</varname> in + <filename>globals.pl</filename> to be your + <quote>bugs_password</quote>. Although this may get + you around some problem authenticating to your + database, since globals.pl is not normally + restricted by <filename>.htaccess</filename>, your + database password is exposed to whoever uses your + web server. + </para> + </note> + </step> + + <step> + <para> + Find and comment out all occurences of + <quote><command>open(SENDMAIL</command></quote> in + your Bugzilla directory. Then replace them with: + <programlisting> +# new sendmail functionality +my $mail=new NTsendmail; +my $from="bugzilla\@your.machine.name.tld"; +my $to=$login; +my $subject=$urlbase; +$mail->send($from,$to,$subject,$msg); + </programlisting> + </para> + <note> + <para>The code above needs testing as well to make sure it is correct.</para> + </note> + </step> + </procedure> + </step> + + <step> + <para> + Change all references in all files from + <filename>processmail</filename> to + <filename>processmail.pl</filename>, and + rename <filename>processmail</filename> to + <filename>processmail.pl</filename>. + </para> + <note> + <para> + Many think this may be a change we want to make for main-tree Bugzilla. It's painless for the UNIX folks, and will make the Win32 people happier. - </PARA> - </NOTE> - </STEP> - <STEP> - <PARA> - Modify the path to perl on the first line (#!) of all files - to point to your Perl installation, and - add "perl" to the beginning of all Perl system calls that - use a perl script as an argument. This may take you a while. - There is a "setperl.pl" utility to speed part of this procedure, - available in the "Patches and Utilities" section of The Bugzilla Guide. - </PARA> - </STEP> - <STEP> - <PARA> - In processmail.pl, add "binmode(HANDLE)" before all read() calls. - This may not be necessary, but in some cases the read() under - Win32 doesn't count the EOL's without using a binary read(). - </PARA> - </STEP> - </PROCEDURE> + </para> + </note> + <note> + <para> + Some people have suggested using the Net::SMTP Perl module instead of NTsendmail or the other options listed here. You can change processmail.pl to make this work. + <programlisting> +<![CDATA[ + +my $smtp = Net::SMTP->new('<Name of your SMTP server>'); #connect to SMTP server +$smtp->mail('<your name>@<you smpt server>');# use the sender's adress here +$smtp->to($tolist); # recipient's address +$smtp->data(); # Start the mail +$smtp->datasend($msg); +$smtp->dataend(); # Finish sending the mail +$smtp->quit; # Close the SMTP connection +$logstr = "$logstr; mail sent to $tolist $cclist"; +} + +]]> +</programlisting> +here is a test mail program for Net::SMTP: +<programlisting> +<![CDATA[ - </SECTION> +use Net::SMTP; + my $smtp = Net::SMTP->new('<Name of your SMTP server', Timeout => 30, Debug +=> 1, ); # connect to SMTP server + $smtp->auth; + $smtp->mail('you@yourcompany.com');# use the sender's adress +here + $smtp->to('someotherAddress@someotherdomain.com'); # +recipient's address + $smtp->data(); # Start the mail + $smtp->datasend('test'); + $smtp->dataend(); # Finish sending the mail + $smtp->quit; # Close the SMTP connection +exit; - <SECTION id="addlwintips"> - <TITLE>Additional Windows Tips</TITLE> - <TIP> - <PARA> +]]> +</programlisting> + </para> + </note> + </step> + <step> + <note> + <para> + This step is completely optional if you are using IIS or + another web server which only decides on an interpreter + based upon the file extension (.pl), rather than the + <quote>shebang</quote> line (#/usr/bonsaitools/bin/perl) + </para> + </note> + <para> + Modify the path to perl on the first line (#!) of all + files to point to your Perl installation, and add + <quote>perl</quote> to the beginning of all Perl system + calls that use a perl script as an argument. This may + take you a while. There is a <quote>setperl.csh</quote> + utility to speed part of this procedure, available in the + <xref linkend="patches"> section of The Bugzilla Guide. + However, it requires the Cygwin GNU-compatible environment + for Win32 be set up in order to work. See <ulink + url="http://www.cygwin.com/">http://www.cygwin.com/</ulink> for details on obtaining Cygwin. + </para> + </step> + + <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> +system ("perl processmail.pl",@ARGLIST); + </programlisting> + </para> + </step> + </procedure> + + <tip> + <para> + If you are using IIS 5.0 or higher, you must add cgi + relationships to Properties -> Home directory (tab) -> + Application Settings (section) -> Configuration (button), + such as: <programlisting> +.cgi to: <perl install directory>\perl.exe %s %s +.pl to: <perl install directory>\perl.exe %s %s +GET,HEAD,POST + </programlisting> + Change the path to Perl to match your + install, of course. + </para> + </tip> + </section> + + <section id="addlwintips"> + <title>Additional Windows Tips</title> + <tip> + <para> From Andrew Pearson: - <BLOCKQUOTE> - <PARA> + <blockquote> + <para> "You can make Bugzilla work with Personal Web Server for Windows 98 and higher, as well as for IIS 4.0. Microsoft has information available at - <ULINK URL=" http://support.microsoft.com/support/kb/articles/Q231/9/98.ASP"> - http://support.microsoft.com/support/kb/articles/Q231/9/98.ASP</ULINK> - </PARA> - <PARA> + <ulink url=" http://support.microsoft.com/support/kb/articles/Q231/9/98.ASP"> + http://support.microsoft.com/support/kb/articles/Q231/9/98.ASP</ulink> + </para> + <para> Basically you need to add two String Keys in the registry at the following location: - </PARA> - <PARA> + </para> + <para> HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\W3SVC\Parameters\ScriptMap - </PARA> - <PARA> + </para> + <para> The keys should be called ".pl" and ".cgi", and both should have a value something like: - <COMMAND>c:/perl/bin/perl.exe "%s" "%s"</COMMAND> - </PARA> - <PARA> + <command>c:/perl/bin/perl.exe "%s" "%s"</command> + </para> + <para> The KB article only talks about .pl, but it goes into more detail and provides a perl test script. - </PARA> - </BLOCKQUOTE> - </PARA> - </TIP> - <TIP> - <PARA>"Brian" had this to add, about upgrading to Bugzilla 2.12 from previous versions:</PARA> - <BLOCKQUOTE> - <PARA> + </para> + </blockquote> + </para> + </tip> + <tip> + <para>"Brian" had this to add, about upgrading to Bugzilla 2.12 from previous versions:</para> + <blockquote> + <para> Hi - I am updating bugzilla to 2.12 so I can tell you what I did (after I deleted the current dir and copied the files in). - </PARA> - <PARA> + </para> + <para> In checksetup.pl, I did the following... - </PARA> - <PROCEDURE> - <STEP> - <PROGRAMLISTING> + </para> + <procedure> + <step> + <programlisting> my $webservergid = getgrnam($my_webservergroup); - </PROGRAMLISTING> - <PARA>to</PARA> - <PROGRAMLISTING> + </programlisting> + <para>to</para> + <programlisting> my $webservergid = 'Administrators' - </PROGRAMLISTING> - </STEP> - <STEP> - <PARA> + </programlisting> + </step> + <step> + <para> I then ran checksetup.pl - </PARA> - </STEP> - <STEP> - <PARA> + </para> + </step> + <step> + <para> I removed all the encrypt() - <EXAMPLE> - <TITLE>Removing encrypt() for Windows NT installations</TITLE> - <PARA> + <example> + <title>Removing encrypt() for Windows NT installations</title> + <para> Replace this: - <PROGRAMLISTING> + <programlisting> SendSQL("SELECT encrypt(" . SqlQuote($enteredpwd) . ", " . SqlQuote(substr($realcryptpwd, 0, 2)) . ")"); my $enteredcryptpwd = FetchOneColumn(); - </PROGRAMLISTING> + </programlisting> with this: - <PROGRAMLISTING> + <programlisting> my $enteredcryptpwd = $enteredpwd - </PROGRAMLISTING> + </programlisting> in cgi.pl. - </PARA> - </EXAMPLE> - </PARA> - </STEP> - <STEP> - <PARA> + </para> + </example> + </para> + </step> + <step> + <para> I renamed processmail to processmail.pl - </PARA> - </STEP> - <STEP> - <PARA> + </para> + </step> + <step> + <para> I altered the sendmail statements to windmail: - <PROGRAMLISTING> + <programlisting> open SENDMAIL, "|\"C:/General/Web/tools/Windmail 4.0 Beta/windmail\" -t > mail.log"; - </PROGRAMLISTING> - </PARA> - <PARA> + </programlisting> + </para> + <para> The quotes around the dir is for the spaces. mail.log is for the output - </PARA> - </STEP> - </PROCEDURE> - </BLOCKQUOTE> - </TIP> - <TIP> - <PARA> + </para> + </step> + </procedure> + </blockquote> + </tip> + <tip> + <para> This was some late breaking information from Jan Evert. Sorry for the lack of formatting. - </PARA> - <LITERALLAYOUT> + </para> + <literallayout> I'm busy installing bugzilla on a WinNT machine and I thought I'd notify you at this moment of the commments I have to section 2.2.1 of the bugzilla guide (at http://www.trilobyte.net/barnsons/html/). @@ -1340,7 +1731,7 @@ necessary to add the ExecCGI option to the bugzilla directory. Also the 'AddHandler' line for .cgi is by default commented out. Step 3: although just a detail, 'ppm install <module%gt;' will also work -(wihtout .ppd). And, it can also download these automatically from +(without .ppd). And, it can also download these automatically from ActiveState. Step 4: although I have cygwin installed, it seems that it is not necessary. @@ -1372,30 +1763,30 @@ that apache can serve them. Just noticed the updated guide... Brian's comment is new. His first comment will work, but opens up a huge security hole. - </LITERALLAYOUT> - </TIP> - </SECTION> - </SECTION> -</CHAPTER> - - - + </literallayout> + </tip> + </section> + </section> +</chapter> <!-- Keep this comment at the end of the file Local variables: mode: sgml -sgml-omittag:t -sgml-shorttag:t -sgml-namecase-general:t -sgml-general-insert-case:upper -sgml-minimize-attributes:nil sgml-always-quote-attributes:t -sgml-indent-step:2 -sgml-indent-data:t -sgml-parent-document:nil +sgml-auto-insert-required-elements:t +sgml-balanced-tag-edit:t sgml-exposed-tags:nil +sgml-general-insert-case:lower +sgml-indent-data:t +sgml-indent-step:2 sgml-local-catalogs:nil sgml-local-ecat-files:nil +sgml-minimize-attributes:nil +sgml-namecase-general:t +sgml-omittag:t +sgml-parent-document:("Bugzilla-Guide.sgml" "book" "chapter") +sgml-shorttag:t +sgml-tag-region-if-active:t End: --> diff --git a/docs/sgml/integration.sgml b/docs/sgml/integration.sgml index 74ec817f5..c7aa78f82 100644 --- a/docs/sgml/integration.sgml +++ b/docs/sgml/integration.sgml @@ -1,4 +1,4 @@ -<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook V4.1//EN" > +<!-- <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook V4.1//EN" > --> <!-- Keep these tools listings in alphabetical order please. -MPB --> @@ -12,14 +12,13 @@ <section id="cvs"> <title>CVS</title> - <para>We need CVS integration information</para> + <para>CVS integration is best accomplished, at this point, using the Bugzilla Email Gateway.</para> </section> <section id="scm"> <title>Perforce SCM</title> <para> - Richard Brooksby created a Perforce integration tool for Bugzilla and TeamTrack. - You can find the main project page at + You can find the project page for Bugzilla and Teamtrack Perforce integration at: <ulink url="http://www.ravenbrook.com/project/p4dti/"> http://www.ravenbrook.com/project/p4dti</ulink>. "p4dti" is now an officially supported product from Perforce, and you can find the "Perforce Public Depot" @@ -54,22 +53,25 @@ </chapter> + + <!-- Keep this comment at the end of the file Local variables: mode: sgml -sgml-omittag:t -sgml-shorttag:t -sgml-namecase-general:t -sgml-general-insert-case:lower -sgml-minimize-attributes:nil sgml-always-quote-attributes:t -sgml-indent-step:2 -sgml-indent-data:t -sgml-parent-document:nil +sgml-auto-insert-required-elements:t +sgml-balanced-tag-edit:t sgml-exposed-tags:nil +sgml-general-insert-case:lower +sgml-indent-data:t +sgml-indent-step:2 sgml-local-catalogs:nil sgml-local-ecat-files:nil +sgml-minimize-attributes:nil +sgml-namecase-general:t +sgml-omittag:t +sgml-parent-document:("Bugzilla-Guide.sgml" "book" "chapter") +sgml-shorttag:t +sgml-tag-region-if-active:t End: --> - - diff --git a/docs/sgml/patches.sgml b/docs/sgml/patches.sgml index 8d7a72682..8ebfdee15 100644 --- a/docs/sgml/patches.sgml +++ b/docs/sgml/patches.sgml @@ -1,15 +1,14 @@ -<!DOCTYPE appendix PUBLIC "-//OASIS//DTD DocBook V4.1//EN"> +<!-- <!DOCTYPE appendix PUBLIC "-//OASIS//DTD DocBook V4.1//EN"> --> -<appendix id="patches"> +<appendix id="patches" xreflabel="Useful Patches and Utilities for Bugzilla"> <title>Useful Patches and Utilities for Bugzilla</title> -<section id="setperl"> +<section id="setperl" xreflabel="The setperl.csh Utility"> <title>The setperl.csh Utility</title> - <para> - You can use the "setperl.csh" utility to quickly and easily - change the path to perl on all your Bugzilla files. - This is a C-shell script; if you do not have "csh" or "tcsh" in the search - path on your system, it will not work! + <para> You can use the "setperl.csh" utility to quickly and + easily change the path to perl on all your Bugzilla files. This + is a C-shell script; if you do not have "csh" or "tcsh" in the + search path on your system, it will not work! </para> <procedure> <step> @@ -28,18 +27,15 @@ </step> <step> <para> - <computeroutput> - <prompt>bash#</prompt> - <command>wget -O setperl.csh 'http://bugzilla.mozilla.org/showattachment.cgi?attach_id=10795'</command> - </computeroutput> + <computeroutput> <prompt>bash#</prompt> <command>wget -O + setperl.csh + 'http://bugzilla.mozilla.org/showattachment.cgi?attach_id=10795'</command> </computeroutput> </para> </step> <step> <para> - <computeroutput> - <prompt>bash#</prompt> - <command>chmod u+x setperl.csh</command> - </computeroutput> + <computeroutput> <prompt>bash#</prompt> <command>chmod + u+x setperl.csh</command> </computeroutput> </para> </step> </substeps> @@ -59,10 +55,8 @@ </step> <step> <para> - <computeroutput> - <prompt>bash#</prompt> - <command>chmod u+x duplicates.cgi</command> - </computeroutput> + <computeroutput> <prompt>bash#</prompt> <command>chmod + u+x duplicates.cgi</command> </computeroutput> </para> </step> <step> @@ -80,16 +74,14 @@ Run the script: </para> <para> - <computeroutput> - <prompt>bash#</prompt> + <computeroutput> <prompt>bash#</prompt> <command>./setperl.csh /your/path/to/perl</command> </computeroutput> <example> <title>Using Setperl to set your perl path</title> <para> - <computeroutput> - <prompt>bash#</prompt> - <command>./setperl.csh /usr/bin/perl</command> + <computeroutput> <prompt>bash#</prompt> + <command>./setperl.csh /usr/bin/perl</command> </computeroutput> </para> </example> @@ -101,22 +93,23 @@ <section id="cmdline"> <title>Command-line Bugzilla Queries</title> <para> - Users can query Bugzilla from the command line using - this suite of utilities. + Users can query Bugzilla from the command line using this suite + of utilities. </para> <para> The query.conf file contains the mapping from options to field - names and comparison types. Quoted option names are "grepped" for, so - it should be easy to edit this file. Comments (#) have no effect; you - must make sure these lines do not contain any quoted "option" + names and comparison types. Quoted option names are "grepped" + for, so it should be easy to edit this file. Comments (#) have + no effect; you must make sure these lines do not contain any + quoted "option" </para> <para> - buglist is a shell script which submits a Bugzilla query and writes the - resulting HTML page to stdout. It supports both short options, - (such as "-Afoo" or "-Rbar") and long options (such as - "--assignedto=foo" or "--reporter=bar"). If the first character - of an option is not "-", it is treated as if it were prefixed - with "--default=". + buglist is a shell script which submits a Bugzilla query and + writes the resulting HTML page to stdout. It supports both + short options, (such as "-Afoo" or "-Rbar") and long options + (such as "--assignedto=foo" or "--reporter=bar"). If the first + character of an option is not "-", it is treated as if it were + prefixed with "--default=". </para> <para> The columlist is taken from the COLUMNLIST environment variable. @@ -128,10 +121,10 @@ <para> bugs is a simple shell script which calls buglist and extracts the bug numbers from the output. Adding the prefix - "http://bugzilla.mozilla.org/buglist.cgi?bug_id=" - turns the bug list into a working link if any bugs are found. - Counting bugs is easy. Pipe the results through - <command>sed -e 's/,/ /g' | wc | awk '{printf $2 "\n"}'</command> + "http://bugzilla.mozilla.org/buglist.cgi?bug_id=" turns the bug + list into a working link if any bugs are found. Counting bugs is + easy. Pipe the results through <command>sed -e 's/,/ /g' | wc | + awk '{printf $2 "\n"}'</command> </para> <para> Akkana says she has good results piping buglist output through @@ -145,26 +138,23 @@ <substeps> <step> <para> - <computeroutput> - <prompt>bash$</prompt> - <command>wget -O query.conf 'http://bugzilla.mozilla.org/showattachment.cgi?attach_id=26157'</command> - </computeroutput> + <computeroutput> <prompt>bash$</prompt> <command>wget -O + query.conf + 'http://bugzilla.mozilla.org/showattachment.cgi?attach_id=26157'</command> </computeroutput> </para> </step> <step> <para> - <computeroutput> - <prompt>bash$</prompt> - <command>wget -O buglist 'http://bugzilla.mozilla.org/showattachment.cgi?attach_id=26944'</command> - </computeroutput> + <computeroutput> <prompt>bash$</prompt> <command>wget -O + buglist + 'http://bugzilla.mozilla.org/showattachment.cgi?attach_id=26944'</command> </computeroutput> </para> </step> <step> <para> - <computeroutput> - <prompt>bash#</prompt> - <command>wget -O bugs 'http://bugzilla.mozilla.org/showattachment.cgi?attach_id=26215'</command> - </computeroutput> + <computeroutput> <prompt>bash#</prompt> <command>wget -O + bugs + 'http://bugzilla.mozilla.org/showattachment.cgi?attach_id=26215'</command> </computeroutput> </para> </step> </substeps> @@ -185,53 +175,64 @@ <title>The Quicksearch Utility</title> <para> Quicksearch is a new, experimental feature of the 2.12 release. - It consist of two Javascript files, "quicksearch.js" and "localconfig.js", - and two documentation files, "quicksearch.html" and "quicksearchhack.html" + It consist of two Javascript files, "quicksearch.js" and + "localconfig.js", and two documentation files, + "quicksearch.html" and "quicksearchhack.html" </para> <para> - The index.html page has been updated to include the QuickSearch text box. + The index.html page has been updated to include the QuickSearch + text box. </para> <para> - To take full advantage of the query power, the Bugzilla maintainer must - edit "localconfig.js" according to the value sets used in the local installation. + To take full advantage of the query power, the Bugzilla + maintainer must edit "localconfig.js" according to the value + sets used in the local installation. </para> <para> - Currently, keywords must be hard-coded in localconfig.js. If they are not, - keywords are not automatically recognized. This means, if localconfig.js - is left unconfigured, that searching for a bug with the "foo" keyword - will only find bugs with "foo" in the summary, status whiteboard, product or - component name, but not those with the keyword "foo". + Currently, keywords must be hard-coded in localconfig.js. If + they are not, keywords are not automatically recognized. This + means, if localconfig.js is left unconfigured, that searching + for a bug with the "foo" keyword will only find bugs with "foo" + in the summary, status whiteboard, product or component name, + but not those with the keyword "foo". </para> <para> Workarounds for Bugzilla users: <simplelist> - <member>search for '!foo' (this will find only bugs with the keyword "foo"</member> - <member>search 'foo,!foo' (equivalent to 'foo OR keyword:foo')</member> + <member>search for '!foo' (this will find only bugs with the + keyword "foo"</member> + <member>search 'foo,!foo' (equivalent to 'foo OR + keyword:foo')</member> </simplelist> </para> <para> - When this tool is ported from client-side JavaScript to server-side Perl, - the requirement for hard-coding keywords can be fixed. - <ulink url="http://bugzilla.mozilla.org/show_bug.cgi?id=70907">This bug</ulink> - has details. + When this tool is ported from client-side JavaScript to + server-side Perl, the requirement for hard-coding keywords can + be fixed. <ulink + url="http://bugzilla.mozilla.org/show_bug.cgi?id=70907">This bug</ulink> has details. </para> </section> </appendix> + + <!-- Keep this comment at the end of the file Local variables: mode: sgml -sgml-omittag:t -sgml-shorttag:t -sgml-namecase-general:t -sgml-general-insert-case:lower -sgml-minimize-attributes:nil sgml-always-quote-attributes:t -sgml-indent-step:2 -sgml-indent-data:t -sgml-parent-document:nil +sgml-auto-insert-required-elements:t +sgml-balanced-tag-edit:t sgml-exposed-tags:nil +sgml-general-insert-case:lower +sgml-indent-data:t +sgml-indent-step:2 sgml-local-catalogs:nil sgml-local-ecat-files:nil +sgml-minimize-attributes:nil +sgml-namecase-general:t +sgml-omittag:t +sgml-parent-document:("Bugzilla-Guide.sgml" "book" "chapter") +sgml-shorttag:t +sgml-tag-region-if-active:t End: --> diff --git a/docs/sgml/requiredsoftware.sgml b/docs/sgml/requiredsoftware.sgml index 2d819ab62..e36b6184a 100644 --- a/docs/sgml/requiredsoftware.sgml +++ b/docs/sgml/requiredsoftware.sgml @@ -1,4 +1,4 @@ -<!DOCTYPE appendix PUBLIC "-//OASIS//DTD DocBook V4.1//EN"> +<!-- <!DOCTYPE appendix PUBLIC "-//OASIS//DTD DocBook V4.1//EN"> --> <appendix id="downloadlinks"> <title>Software Download Links</title> @@ -15,7 +15,7 @@ http://www.mozilla.org/projects/bugzilla/</ulink> </para> <para> - MySQL: <ulink url="http://www.mysql.org/">http://www.mysql.org/</ulink> + MySQL: <ulink url="http://www.mysql.com/">http://www.mysql.com/</ulink> </para> <para> Perl: <ulink url="http://www.perl.org">http://www.perl.org/</ulink> @@ -63,20 +63,24 @@ </appendix> + <!-- Keep this comment at the end of the file Local variables: mode: sgml -sgml-omittag:t -sgml-shorttag:t -sgml-namecase-general:t -sgml-general-insert-case:lower -sgml-minimize-attributes:nil sgml-always-quote-attributes:t -sgml-indent-step:2 -sgml-indent-data:t -sgml-parent-document:nil +sgml-auto-insert-required-elements:t +sgml-balanced-tag-edit:t sgml-exposed-tags:nil +sgml-general-insert-case:lower +sgml-indent-data:t +sgml-indent-step:2 sgml-local-catalogs:nil sgml-local-ecat-files:nil +sgml-minimize-attributes:nil +sgml-namecase-general:t +sgml-omittag:t +sgml-parent-document:("Bugzilla-Guide.sgml" "book" "chapter") +sgml-shorttag:t +sgml-tag-region-if-active:t End: --> diff --git a/docs/sgml/using.sgml b/docs/sgml/using.sgml index bc8159835..fd5901196 100644 --- a/docs/sgml/using.sgml +++ b/docs/sgml/using.sgml @@ -1,4 +1,4 @@ -<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook V4.1//EN"> +<!-- <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook V4.1//EN"> --> <!-- TOC Chapter: Using Bugzilla @@ -38,19 +38,19 @@ Chapter: Using Bugzilla <section id="whatis"> <title>What is Bugzilla?</title> <para> - Bugzilla is one example of a class of programs called "Defect Tracking Systems", - or, more commonly, "Bug-Tracking Systems". Defect Tracking Systems allow individual or - groups of developers to keep track of outstanding bugs in their product effectively. - Bugzilla was originally written by Terry Weissman in a programming language called - "TCL", to replace a crappy - bug-tracking database used internally for Netscape Communications. Terry later ported - Bugzilla to - Perl from TCL, and in Perl it remains to this day. - Most commercial defect-tracking software vendors at the - time charged enormous licensing fees, and Bugzilla quickly became a favorite of the - open-source crowd (with its genesis in the open-source browser project, Mozilla). It - is now the de-facto standard defect-tracking system against which all others are - measured. + Bugzilla is one example of a class of programs called "Defect +Tracking Systems", or, more commonly, "Bug-Tracking Systems". Defect +Tracking Systems allow individual or groups of developers to keep +track of outstanding bugs in their product effectively. Bugzilla was +originally written by Terry Weissman in a programming language called +"TCL", to replace a crappy bug-tracking database used internally for +Netscape Communications. Terry later ported Bugzilla to Perl from +TCL, and in Perl it remains to this day. Most commercial +defect-tracking software vendors at the time charged enormous +licensing fees, and Bugzilla quickly became a favorite of the +open-source crowd (with its genesis in the open-source browser +project, Mozilla). It is now the de-facto standard defect-tracking +system against which all others are measured. </para> <para> Bugzilla has matured immensely, and now boasts many advanced features. These include: @@ -87,13 +87,13 @@ Chapter: Using Bugzilla </listitem> <listitem> <para> - email, XML, and HTTP APIs + email, XML, console, and HTTP APIs </para> </listitem> <listitem> <para> available integration with automated software configuration management systems, including - Perforce and CVS. + Perforce and CVS </para> </listitem> <listitem> @@ -137,7 +137,7 @@ Chapter: Using Bugzilla with bug-tracking software, and instead simply relied on shared lists and email to monitor the status of defects. This procedure is error-prone and tends to cause those bugs judged least significant by developers to be - dropped or ignored + dropped or ignored. </para> <para> These days, many companies are finding that integrated defect-tracking @@ -223,12 +223,12 @@ Chapter: Using Bugzilla <section id="myaccount"> <title>Create a Bugzilla Account</title> <para> - First thing's first! If you want to use Bugzilla, first you need to create + First things first! If you want to use Bugzilla, first you need to create an account. Consult with the administrator responsible for your installation of Bugzilla for the URL you should use to access it. If you're test-driving the end-user Bugzilla experience, use this URL: - <ulink url="http://landfill.tequilarista.org/mozilla/bugzilla/"> - http://landfill.tequilarista.org/mozilla/bugzilla/</ulink> + <ulink url="http://landfill.tequilarista.org/bugzilla-tip/"> + http://landfill.tequilarista.org/bugzilla-tip/</ulink> </para> <orderedlist> <listitem> @@ -560,15 +560,15 @@ Chapter: Using Bugzilla <orderedlist> <listitem> <para> - Go back to <ulink url="http://landfill.tequilarista.org/mozilla/bugzilla/"> - http://landfill.tequilarista.org/mozilla/bugzilla/</ulink> + Go back to <ulink url="http://landfill.tequilarista.org/bugzilla-tip/"> + http://landfill.tequilarista.org/bugzilla-tip/</ulink> in your browser. </para> </listitem> <listitem> <para> Select the - <ulink url="http://landfill.tequilarista.org/mozilla/bugzilla/enter_bug.cgi"> + <ulink url="http://landfill.tequilarista.org/bugzilla-tip/enter_bug.cgi"> Enter a new bug report</ulink> link. </para> </listitem> @@ -716,7 +716,7 @@ Chapter: Using Bugzilla Let's plunge into what you can do! The first step is to click the "Edit prefs" link at the footer of each page once you have logged in to - <ulink url="http://landfill.tequilarista.org/mozilla/bugzilla/query.cgi?GoAheadAndLogIn=1"> + <ulink url="http://landfill.tequilarista.org/bugzilla-tip/query.cgi?GoAheadAndLogIn=1"> Landfill</ulink>. </para> <section id="accountsettings"> @@ -861,17 +861,20 @@ Chapter: Using Bugzilla <!-- Keep this comment at the end of the file Local variables: mode: sgml -sgml-omittag:t -sgml-shorttag:t -sgml-namecase-general:t -sgml-general-insert-case:lower -sgml-minimize-attributes:nil sgml-always-quote-attributes:t -sgml-indent-step:2 -sgml-indent-data:t -sgml-parent-document:Bugzilla-Guide\.sgml +sgml-auto-insert-required-elements:t +sgml-balanced-tag-edit:t sgml-exposed-tags:nil +sgml-general-insert-case:lower +sgml-indent-data:t +sgml-indent-step:2 sgml-local-catalogs:nil sgml-local-ecat-files:nil +sgml-minimize-attributes:nil +sgml-namecase-general:t +sgml-omittag:t +sgml-parent-document:("Bugzilla-Guide.sgml" "book" "chapter") +sgml-shorttag:t +sgml-tag-region-if-active:t End: --> diff --git a/docs/sgml/variants.sgml b/docs/sgml/variants.sgml index d13b9ee8d..fec867946 100644 --- a/docs/sgml/variants.sgml +++ b/docs/sgml/variants.sgml @@ -1,4 +1,4 @@ -<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook V4.1//EN"> +<!-- <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook V4.1//EN">--> <chapter id="variants"> <title>Bugzilla Variants</title> @@ -68,20 +68,24 @@ Regards </para> </section> </chapter> + <!-- Keep this comment at the end of the file Local variables: mode: sgml -sgml-omittag:t -sgml-shorttag:t -sgml-namecase-general:t -sgml-general-insert-case:lower -sgml-minimize-attributes:nil sgml-always-quote-attributes:t -sgml-indent-step:2 -sgml-indent-data:t -sgml-parent-document:nil +sgml-auto-insert-required-elements:t +sgml-balanced-tag-edit:t sgml-exposed-tags:nil +sgml-general-insert-case:lower +sgml-indent-data:t +sgml-indent-step:2 sgml-local-catalogs:nil sgml-local-ecat-files:nil +sgml-minimize-attributes:nil +sgml-namecase-general:t +sgml-omittag:t +sgml-parent-document:("Bugzilla-Guide.sgml" "book" "chapter") +sgml-shorttag:t +sgml-tag-region-if-active:t End: --> diff --git a/docs/xml/Bugzilla-Guide.xml b/docs/xml/Bugzilla-Guide.xml index 88daac2bb..30deb5c4a 100644 --- a/docs/xml/Bugzilla-Guide.xml +++ b/docs/xml/Bugzilla-Guide.xml @@ -1,4 +1,4 @@ -<!DOCTYPE BOOK PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [ +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [ <!-- Include macros --> <!ENTITY about SYSTEM "about.sgml"> @@ -17,99 +17,156 @@ <!ENTITY patches SYSTEM "patches.sgml"> <!ENTITY variants SYSTEM "variants.sgml"> <!ENTITY requiredsoftware SYSTEM "requiredsoftware.sgml"> +<!ENTITY revhistory SYSTEM "revhistory.sgml"> + +<!ENTITY bz "http://www.mozilla.org/projects/bugzilla"> +<!ENTITY bz-ver "2.14"> +<!ENTITY bz-cvs-ver "2.15"> +<!ENTITY bzg-date "August 10, 2001"> +<!ENTITY bzg-ver "2.14.0"> +<!ENTITY bzg-cvs-ver "2.15.0"> +<!ENTITY bzg-auth "Matthew P. Barnson"> +<!ENTITY bzg-auth-email "<email>barnboy@NOSPAM.trilobyte.net</email>"> +<!ENTITY mysql "http://www.mysql.com/"> +<!ENTITY perl-ver "5.6.1"> ]> -<!-- Coding standards for this document - -1. Preface new or modified sections with a comment stating who - modified it and when; please also use the "authorinitials" tag. - -2. There is no "two". - -3. Other than the GFDL, please use the "section" tag instead of "sect1", "sect2", etc. - -4. Use Entities to include files for new chapters in Bugzilla-Guide.sgml. - -5. Ensure all documents compile cleanly to HTML after modification. - The errors "DTD Declaration not allowed here" and "DTDDECL catalog types not supported" - are normal errors to be expected when compiling the whole guide. - -6. Try to index important terms wherever possible. -7. Follow coding standards at http://www.linuxdoc.org. - -8. All tags should be lowercase (needsfix) - -9. Code being submitted for review should use the -"review" tag. Documentation on this is available at -http://www.linuxdoc.org/LDP/LDP-Author-Guide/tools-hints.html - under section 4.9.4, "Making notes on the text while it's being written". +<!-- Coding standards for this document -10. Please use sensible spacing. The comments at the very end of each Guide - file define reasonable defaults for PSGML mode in EMACS. - Double-indent tags, use double spacing whenever possible, - try to avoid clutter and feel free to waste space in the code to make it more readable. +* Other than the GFDL, please use the "section" tag instead of "sect1", "sect2", etc. +* Use Entities to include files for new chapters in Bugzilla-Guide.sgml. +* Try to use Entities for frequently-used passages of text as well. +* Ensure all documents compile cleanly to HTML after modification. +The warning, "DTDDECL catalog types not supported" is normal. +* Try to index important terms wherever possible. +* Use "glossterm" whenever you introduce a new term. +* Follow coding standards at http://www.linuxdoc.org, and +check out the KDE guidelines (they are nice, too) +http://i18n.kde.org/doc/markup.html +* All tags should be lowercase (needsfix) +* Please use sensible spacing. The comments at the very end of each +file define reasonable defaults for PSGML mode in EMACS. +Double-indent tags, use double spacing whenever possible, and +try to avoid clutter and feel free to waste space in the code to make it more readable. --> -<BOOK ID="index"> +<book id="index"> <!-- Header --> - <BOOKINFO> - <TITLE>The Bugzilla Guide</TITLE> - <PUBDATE>2001-04-25</PUBDATE> - <AUTHOR> - <FIRSTNAME>Matthew</FIRSTNAME> - <OTHERNAME>P.</OTHERNAME> - <SURNAME>Barnson</SURNAME> - <affiliation> - <address><email>barnboy@trilobyte.net</email></address> - </affiliation> - </AUTHOR> - - <ABSTRACT> - <PARA>This is the documentation for Bugzilla, the Mozilla bug-tracking system.</PARA> - </ABSTRACT> - - <REVHISTORY> - <REVISION> - <REVNUMBER>v2.11</REVNUMBER> - <DATE>20 December 2000</DATE> - <AUTHORINITIALS>MPB</AUTHORINITIALS> - <REVREMARK>Converted the README, FAQ, and DATABASE information into SGML - docbook format.</REVREMARK> - </REVISION> + <bookinfo> + <title>The Bugzilla Guide</title> + <pubdate>2001-04-25</pubdate> + <revhistory> + <revision> + <revnumber>v2.11</revnumber> + <date>20 December 2000</date> + <authorinitials>MPB</authorinitials> + <revremark> + Converted the README, FAQ, and DATABASE information into + SGML docbook format. + </revremark> + </revision> <revision> <revnumber>2.11.1</revnumber> <date>06 March 2001</date> <authorinitials>MPB</authorinitials> <revremark> - Took way too long to revise this for 2.12 release. - Updated FAQ to use qandaset tags instead of literallayout, - cleaned up administration section, added User Guide section, - miscellaneous FAQ updates and third-party integration information. - From this point on all new tags are lowercase in preparation for the - 2.13 release of the Guide in XML format instead of SGML. + Took way too long to revise this for 2.12 release. Updated + FAQ to use qandaset tags instead of literallayout, cleaned + up administration section, added User Guide section, + miscellaneous FAQ updates and third-party integration + information. From this point on all new tags are lowercase + in preparation for the 2.13 release of the Guide in XML + format instead of SGML. </revremark> </revision> - + <revision> <revnumber>2.12.0</revnumber> <date>24 April 2001</date> <authorinitials>MPB</authorinitials> <revremark> - Things fixed this release: Elaborated on queryhelp interface, added FAQ regarding - moving bugs from one keyword to another, clarified possible problems with the Landfill - tutorial, fixed a boatload of typos and unclear sentence structures. Incorporated the - README into the UNIX installation section, and changed the README to indicate the deprecated - status. Things I know need work: Used "simplelist" a lot, where I should have used - "procedure" to tag things. Need to lowercase all tags to be XML compliant. + Things fixed this release: Elaborated on queryhelp + interface, added FAQ regarding moving bugs from one keyword + to another, clarified possible problems with the Landfill + tutorial, fixed a boatload of typos and unclear sentence + structures. Incorporated the README into the UNIX + installation section, and changed the README to indicate the + deprecated status. Things I know need work: Used + "simplelist" a lot, where I should have used "procedure" to + tag things. Need to lowercase all tags to be XML compliant. </revremark> </revision> - </REVHISTORY> + + <revision> + <revnumber>2.14.0</revnumber> + <date>07 August 2001</date> + <authorinitials>MPB</authorinitials> + <revremark> + Attempted to integrate relevant portions of the UNIX and + Windows installation instructions, moved some data from FAQ + to Install, removed references to README from text, added + Mac OS X install instructions, fixed a bunch + of tpyos (Mark Harig), linked text that referenced other + parts of the Guide, and nuked the old MySQL permissions + section. + </revremark> + </revision> + </revhistory> + + <authorgroup> + + <author> + <firstname>Matthew</firstname> + <othername>P.</othername> + <surname>Barnson</surname> + <affiliation> + <address><email>barnboy@NOSPAM.trilobyte.net</email></address> + </affiliation> + </author> + + <collab> + <collabname>Zach Lipton</collabname> + <affiliation> + <address><email>zach@NOSPAM.zachlipton.com</email></address> + </affiliation> + </collab> + + <editor> + <firstname>I.</firstname> + <surname>Freely</surname> + <othername>P.</othername> + <affiliation> + <address><email>ipfreely@freely.eye-p.net</email></address> + </affiliation> + </editor> + + </authorgroup> + + <abstract> + <para> + This is the documentation for Bugzilla, the Mozilla + bug-tracking system. + </para> + <para> + Bugzilla is an enterprise-class set of software utilities + that, when used together, power issue-tracking for hundreds of + organizations around the world, tracking millions of bugs. + While it is easy to use and quite flexible, it is very + difficult for a novice to install and maintain. Although we + have provided step-by-step directions, Bugzilla is not always + easy to get working. Please be sure the person responsible + for installing and maintaining this software is a qualified + professional on operating system upon which you install + Bugzilla. + </para> + </abstract> + <KEYWORDSET> <KEYWORD>Bugzilla</KEYWORD> @@ -127,15 +184,15 @@ http://www.linuxdoc.org/LDP/LDP-Author-Guide/tools-hints.html <!-- About This Guide --> &about; +<!-- Using Bugzilla --> +&using; + <!-- Installing Bugzilla --> &installation; <!-- Administering Bugzilla --> &administration; -<!-- Using Bugzilla --> -&using; - <!-- Integrating Bugzilla with Third-Party Tools --> &integration; @@ -166,31 +223,26 @@ http://www.linuxdoc.org/LDP/LDP-Author-Guide/tools-hints.html <!-- Index --> &index; -</BOOK> + +</book> <!-- Keep this comment at the end of the file Local variables: mode: sgml -sgml-omittag:t -sgml-shorttag:t -sgml-namecase-general:t -sgml-general-insert-case:lower -sgml-minimize-attributes:nil sgml-always-quote-attributes:t -sgml-indent-step:2 -sgml-indent-data:t -sgml-parent-document:nil +sgml-auto-insert-required-elements:t +sgml-balanced-tag-edit:t sgml-exposed-tags:nil +sgml-general-insert-case:lower +sgml-indent-data:t +sgml-indent-step:2 sgml-local-catalogs:nil sgml-local-ecat-files:nil +sgml-minimize-attributes:nil +sgml-namecase-general:t +sgml-omittag:t +sgml-parent-document:("Bugzilla-Guide.sgml" "book" "chapter") +sgml-shorttag:t +sgml-tag-region-if-active:t End: --> - - - - - - - - - diff --git a/docs/xml/about.xml b/docs/xml/about.xml index d1b56cfdb..d92fa9b30 100644 --- a/docs/xml/about.xml +++ b/docs/xml/about.xml @@ -1,242 +1,256 @@ -<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [ -<!ENTITY conventions SYSTEM "conventions.sgml"> ] > +<!-- <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [ +<!ENTITY conventions SYSTEM "conventions.sgml"> ] > --> -<CHAPTER ID="about"> -<TITLE>About This Guide</TITLE> +<chapter id="about"> +<title>About This Guide</title> - <SECTION ID="aboutthisguide"> - <TITLE>Purpose and Scope of this Guide</TITLE> - <PARA> - This document was started on September 17, 2000 - by Matthew P. Barnson after a great deal of procrastination updating the Bugzilla FAQ, - which I left untouched for nearly half a year. - After numerous complete rewrites and reformatting, it is the document you see today. - </PARA> - <PARA> - Despite the lack of updates, Bugzilla is simply the best piece of bug-tracking software - the world has ever seen. This document is intended to be the comprehensive guide to - the installation, administration, maintenance, and use of the Bugzilla bug-tracking system. - </PARA> - <PARA> - This release of the Bugzilla Guide is the <EMPHASIS>2.11</EMPHASIS> release. - It is so named that it may match the current version of Bugzilla. - The numbering tradition stems from that used for many free software projects, - in which <EMPHASIS>even-numbered</EMPHASIS> point releases (1.2, 1.14, etc.) - are considered "stable releases", intended for public consumption; on the other - hand, <EMPHASIS>odd-numbered</EMPHASIS> point releases (1.3, 2.09, etc.) - are considered unstable <EMPHASIS>development</EMPHASIS> releases intended - for advanced users, systems administrators, developers, and those who enjoy - a lot of pain. - </PARA> - <PARA> - Newer revisions of the Bugzilla Guide will follow the numbering conventions of - the main-tree Bugzilla releases, available at - <ULINK URL="http://www.mozilla.org/bugs/source.html">Mozilla.org</ULINK>, with - the exception that intermediate releases will have a minor revision number - following a period. For instance, if the current version of Bugzilla is 4.2, - the current "stable" version of the Bugzilla guide, in, say, it's fifth revision, - would be numbered "4.2.5". Got it? Good. - </PARA> - <PARA> - I wrote this in response to the enormous demand for decent Bugzilla documentation. - I have incorporated instructions from the Bugzilla README, Frequently Asked Questions, - Database Schema Document, and various mailing lists to create it. - Chances are, there are glaring errors in this documentation; please contact - <EMAIL>barnboy@trilobyte.net</EMAIL> to correct them. - </PARA> - </SECTION> + <section id="aboutthisguide"> + <title>Purpose and Scope of this Guide</title> + <para> + This document was started on September 17, 2000 by Matthew P. + Barnson after a great deal of procrastination updating the + Bugzilla FAQ, which I left untouched for nearly half a year. + After numerous complete rewrites and reformatting, it is the + document you see today. + </para> + <para> + Despite the lack of updates, Bugzilla is simply the best piece + of bug-tracking software the world has ever seen. This document + is intended to be the comprehensive guide to the installation, + administration, maintenance, and use of the Bugzilla + bug-tracking system. + </para> + <para> + This release of the Bugzilla Guide is the + <emphasis>&bzg-ver;</emphasis> release. It is so named that it + may match the current version of Bugzilla. The numbering + tradition stems from that used for many free software projects, + in which <emphasis>even-numbered</emphasis> point releases (1.2, + 1.14, etc.) are considered "stable releases", intended for + public consumption; on the other hand, + <emphasis>odd-numbered</emphasis> point releases (1.3, 2.09, + etc.) are considered unstable <emphasis>development</emphasis> + releases intended for advanced users, systems administrators, + developers, and those who enjoy a lot of pain. + </para> + <para> + Newer revisions of the Bugzilla Guide follow the numbering + conventions of the main-tree Bugzilla releases, available at + <ulink url="&bz;">&bz;</ulink>. Intermediate releases will have + a minor revision number following a period. The current version + of Bugzilla, as of this writing (&bzg-date;) is &bz-ver;; if + something were seriously wrong with that edition of the Guide, + subsequent releases would receive an additional dotted-decimal + digit to indicate the update (&bzg-ver;.1, &bzg-ver;.2, etc.). + Got it? Good. + </para> + <para> + I wrote this in response to the enormous demand for decent + Bugzilla documentation. I have incorporated instructions from + the Bugzilla README, Frequently Asked Questions, Database Schema + Document, and various mailing lists to create it. Chances are, + there are glaring errors in this documentation; please contact + &bzg-auth-email; to correct them. + </para> + </section> - <SECTION ID="copyright"> - <TITLE>Copyright Information</TITLE> - <BLOCKQUOTE> - <ATTRIBUTION>Copyright (c) 2000-2001 Matthew P. Barnson</ATTRIBUTION> - <PARA> - Permission is granted to copy, distribute and/or modify this document under thei - terms of the GNU Free Documentation License, Version 1.1 or any later version published - by the Free Software Foundation; with no Invariant Sections, no Front-Cover Texts, and - with no Back-Cover Texts. A copy of the license is included in the section entitled - "GNU Free Documentation LIcense". - </PARA> - </BLOCKQUOTE> - <PARA> - If you have any questions regarding this document, its' copyright, or publishing this - document in non-electronic form, please contact <EMAIL>barnboy@trilobyte.net</EMAIL> - </PARA> - </SECTION> + <section id="copyright"> + <title>Copyright Information</title> + <blockquote> + <attribution>Copyright (c) 2000-2001 &bzg-auth;</attribution> + <para> + Permission is granted to copy, distribute and/or modify this + document under the terms of the GNU Free Documentation + License, Version 1.1 or any later version published by the + Free Software Foundation; with no Invariant Sections, no + Front-Cover Texts, and with no Back-Cover Texts. A copy of + the license is included in the section entitled "GNU Free + Documentation LIcense". + </para> + </blockquote> + <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. + </para> + </section> - <SECTION ID="disclaimer"> - <TITLE>Disclaimer</TITLE> - <PARA> + <section id="disclaimer"> + <title>Disclaimer</title> + <para> No liability for the contents of this document can be accepted. Use the concepts, examples, and other content at your own risk. As this is a new edition of this document, there may be errors - and inaccuracies that may damage your system. Use of this document - may cause your girlfriend to leave you, your cats to pee on your - furniture and clothing, your computer to cease functioning, your - boss to fire you, and global thermonuclear war. Proceed with caution. - </PARA> - <PARA> - All copyrights are held by their respective owners, unless specifically - noted otherwise. Use of a term in this document should not be regarded - as affecting the validity of any trademark or service mark. - In particular, I like to put down Microsoft(tm). Live with it. - </PARA> - <PARA> - Naming of particular products or brands should not be seen as endorsements, - with the exception of the term "GNU/Linux". - Use GNU/Linux. Love it. Bathe with it. It is life and happiness. - I endorse it wholeheartedly and encourage you to do the same. - </PARA> - <PARA> - You are strongly recommended to make a backup of your system before - installing Bugzilla and at regular intervals thereafter. Heaven knows - it's saved my bacon time after time; if you implement any suggestion in - this Guide, implement this one! - </PARA> - <PARA> - Bugzilla has not undergone a complete security review. - Security holes probably exist in the code. - Great care should be taken both in the installation and usage of this software. - Carefully consider the implications of installing other network services with Bugzilla. - </PARA> - </SECTION> + and inaccuracies that may damage your system. Use of this + document may cause your girlfriend to leave you, your cats to + pee on your furniture and clothing, your computer to cease + functioning, your boss to fire you, and global thermonuclear + war. Proceed with caution. + </para> + <para> + All copyrights are held by their respective owners, unless + specifically noted otherwise. Use of a term in this document + should not be regarded as affecting the validity of any + trademark or service mark. + </para> + <para> + Naming of particular products or brands should not be seen as + endorsements, with the exception of the term "GNU/Linux". I + wholeheartedly endorse the use of GNU/Linux in every situation + where it is appropriate. It is an extremely versatile, stable, + and robust operating system that offers an ideal operating + environment for Bugzilla. + </para> + <para> + You are strongly recommended to make a backup of your system + before installing Bugzilla and at regular intervals thereafter. + Heaven knows it's saved my bacon time after time; if you + implement any suggestion in this Guide, implement this one! + </para> + <para> + Although the Bugzilla development team has taken great care to + ensure that all easily-exploitable bugs or options are + documented or fixed in the code, security holes surely exist. + Great care should be taken both in the installation and usage of + this software. Carefully consider the implications of installing + other network services with Bugzilla. The Bugzilla development + team members, Netscape Communications, America Online Inc., and + any affiliated developers or sponsors assume no liability for + your use of this product. You have the source code to this + product, and are responsible for auditing it yourself to insure + your security needs are met. + </para> + </section> <!-- Section 2: New Versions --> - <SECTION ID="newversions"> - <TITLE>New Versions</TITLE> - <PARA> - This is the initial release of the Bugzilla Guide. - </PARA> - <PARA> + <section id="newversions"> + <title>New Versions</title> + <para> + This is the &bzg-ver; version of The Bugzilla Guide. If you are + reading this from any source other than those below, please + check one of these mirrors to make sure you are reading an + up-to-date version of the Guide. + </para> + <para> This document can be found in the following places: - </PARA> - <PARA> - <ITEMIZEDLIST> - <LISTITEM> - <PARA> - <ULINK URL="http://www.trilobyte.net/barnsons/">TriloBYTE</ULINK> - </PARA> - </LISTITEM> - <LISTITEM> - <PARA> - <ULINK URL="http://www.mozilla.org/projects/bugzilla/">Mozilla.org</ULINK> - </PARA> - </LISTITEM> - <LISTITEM> - <PARA> - <ULINK URL="http://www.linuxdoc.org/">The Linux Documentation Project</ULINK> - </PARA> - </LISTITEM> - </ITEMIZEDLIST> - </PARA> - <PARA> + </para> + <para> + <itemizedlist> + <listitem> + <para> + <ulink url="http://www.trilobyte.net/barnsons/">TriloBYTE</ulink> + </para> + </listitem> + <listitem> + <para> + <ulink url="http://www.mozilla.org/projects/bugzilla/">Mozilla.org</ulink> + </para> + </listitem> + <listitem> + <para> + <ulink url="http://www.linuxdoc.org/">The Linux + Documentation Project</ulink> + </para> + </listitem> + </itemizedlist> + </para> + <para> The latest version of this document can be checked out via CVS. - Please follow the instructions available at - <ULINK URL="http://www.mozilla.org/cvs.html">the Mozilla CVS page</ULINK>, - and check out the mozilla/webtools/bugzilla/docs/ branch. - </PARA> - </SECTION> + Please follow the instructions available at <ulink + url="http://www.mozilla.org/cvs.html">the Mozilla CVS page</ulink>, and check out the mozilla/webtools/bugzilla/docs/ branch. + </para> + </section> - <SECTION ID="credits"> - <TITLE>Credits</TITLE> - <PARA> - The people listed below have made enormous contributions to the creation - of this Guide, through their dedicated hacking efforts, - numerous e-mail and IRC support sessions, - and overall excellent contribution to the Bugzilla community: - </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. - </PARA> - <PARA> - <ULINK URL="mailto://tara@tequilarista.org">Tara Hernandez</ULINK> - for keeping Bugzilla development going strong after Terry left Mozilla.org - </PARA> - <PARA> - <ULINK URL="mailto://dkl@redhat.com">Dave Lawrence</ULINK> - for providing insight into the key differences between Red Hat's - customized Bugzilla, and being largely responsible for the - "Red Hat Bugzilla" appendix - </PARA> - <PARA> - <ULINK URL="mailto://endico@mozilla.org">Dawn Endico</ULINK> - for being a hacker extraordinaire and putting up with my incessant + <section id="credits"> + <title>Credits</title> + <para> + The people listed below have made enormous contributions to the + creation of this Guide, through their dedicated hacking efforts, + numerous e-mail and IRC support sessions, and overall excellent + contribution to the Bugzilla community: + </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. + </para> + <para> + <ulink url="mailto://tara@tequilarista.org">Tara + Hernandez</ulink> for keeping Bugzilla development going + strong after Terry left Mozilla.org + </para> + <para> + <ulink url="mailto://dkl@redhat.com">Dave Lawrence</ulink> for + providing insight into the key differences between Red Hat's + customized Bugzilla, and being largely responsible for the "Red + Hat Bugzilla" appendix + </para> + <para> + <ulink url="mailto://endico@mozilla.org">Dawn Endico</ulink> for + being a hacker extraordinaire and putting up with my incessant questions and arguments on irc.mozilla.org in #mozwebtools - </PARA> - <PARA> - Last but not least, all the members of the - <ULINK URL="news://news.mozilla.org/netscape/public/mozilla/webtools"> - netscape.public.mozilla.webtools</ULINK> newsgroup. Without your - discussions, insight, suggestions, and patches, this could never have happened. - </PARA> - </SECTION> - <SECTION id="contributors"> -<TITLE>Contributors</TITLE> - <PARA> - Thanks go to these people for significant contributions - to this documentation (in no particular order): - </PARA> - <PARA> - Zach Lipton (significant textual contributions), - Andrew Pearson, - Spencer Smith, - Eric Hanson, - Kevin Brannen, - </PARA> - </SECTION> - <SECTION ID="feedback"> - <TITLE>Feedback</TITLE> - <PARA> - I welcome feedback on this document. Without your submissions and input, - this Guide cannot continue to exist. Please mail additions, comments, criticisms, etc. - to <EMAIL>barnboy@trilobyte.net</EMAIL>. Please send flames to - <EMAIL>devnull@localhost</EMAIL> - </PARA> - </SECTION> + </para> + <para> + Last but not least, all the members of the <ulink + url="news://news.mozilla.org/netscape/public/mozilla/webtools"> netscape.public.mozilla.webtools</ulink> newsgroup. Without your discussions, insight, suggestions, and patches, this could never have happened. + </para> + </section> - <SECTION ID="translations"> - <TITLE>Translations</TITLE> - <PARA> - The Bugzilla Guide needs translators! - Please volunteer your translation into the language of your choice. - If you will translate this Guide, please notify the members of the mozilla-webtools mailing list at - <email>mozilla-webtools@mozilla.org</email>. Since The Bugzilla Guide is also hosted on the - Linux Documentation Project, you would also do well to notify - </PARA> - </SECTION> + <section id="contributors"> +<title>Contributors</title> + <para> + Thanks go to these people for significant contributions to this + documentation (in no particular order): + </para> + <para> + Andrew Pearson, Spencer Smith, Eric Hanson, Kevin Brannen, Ron Teitelbaum + </para> + </section> + <section id="feedback"> + <title>Feedback</title> + <para> + I welcome feedback on this document. Without your submissions + and input, this Guide cannot continue to exist. Please mail + additions, comments, criticisms, etc. to + <email>barnboy@trilobyte.net</email>. Please send flames to + <email>devnull@localhost</email> + </para> + </section> + + <section id="translations"> + <title>Translations</title> + <para> + The Bugzilla Guide needs translators! Please volunteer your + translation into the language of your choice. If you will + translate this Guide, please notify the members of the + mozilla-webtools mailing list at + <email>mozilla-webtools@mozilla.org</email>, and arrange with + Matt Barnson to check it into CVS. + </para> + </section> <!-- conventions used here (didn't want to give it a chapter of its own) --> &conventions; + </chapter> -</CHAPTER> - - -<!-- Keep this comment at the end of the file -Local variables: -mode: sgml -sgml-omittag:t -sgml-shorttag:t -sgml-namecase-general:t -sgml-general-insert-case:upper -sgml-minimize-attributes:nil +<!-- Keep this comment at the end of the file +Local variables: +mode: sgml sgml-always-quote-attributes:t -sgml-indent-step:2 -sgml-indent-data:t -sgml-parent-document:Bugzilla-Guide\.sgml +sgml-auto-insert-required-elements:t +sgml-balanced-tag-edit:t sgml-exposed-tags:nil +sgml-general-insert-case:lower +sgml-indent-data:t +sgml-indent-step:2 sgml-local-catalogs:nil -sgml-local-ecat-files:nil -sgml-doctype:"<!DOCTYPE chapter PUBLIC \"-//OASIS//DTD DocBook V4.1//EN\">" -End: ---> - - - - - - - - +sgml-local-ecat-files:nil +sgml-minimize-attributes:nil +sgml-namecase-general:t +sgml-omittag:t +sgml-parent-document:("Bugzilla-Guide.sgml" "book" "chapter") +sgml-shorttag:t +sgml-tag-region-if-active:t +End: --> diff --git a/docs/xml/administration.xml b/docs/xml/administration.xml index 8ca600c54..0f290da31 100644 --- a/docs/xml/administration.xml +++ b/docs/xml/administration.xml @@ -1,1145 +1,1257 @@ -<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook V4.1//EN"> +<!-- <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook V4.1//EN"> --> -<!-- TOC -Chapter: Administration - Localconfig and Checksetup.pl customizations - The Email Gateway - Editing parameters - Deciding your site policies - The Shadow Database - Customizing password mail & layout - The Whining Cron - Why you shouldn't allow deletion - User administration - Creating Users - Disabling Users - User Permissions - Product Administration - Creating products - Creating components - Assigning default owners and Q/A contacts to components - Product Milestones - Product Versions - Voting ---> - -<CHAPTER id="administration"> - <TITLE>Administering Bugzilla</TITLE> -<SUBTITLE>Or, I just got this cool thing installed. Now what the heck do I do with it?</SUBTITLE> - -<PARA> -So you followed the README isntructions to the letter, and -just logged into bugzilla with your super-duper god account and you are sitting at the query -screen. Yet, you have nothing to query. Your first act of business needs to be to setup the -operating parameters for bugzilla.</PARA> +<chapter id="administration"> + <title>Administering Bugzilla</title> + <subtitle> + Or, I just got this cool thing installed. Now what the heck do I + do with it? + </subtitle> + + <para> + So you followed the installation instructions to the letter, and + just logged into bugzilla with your super-duper god account and + you are sitting at the query screen. Yet, you have nothing to + query. Your first act of business needs to be to setup the + operating parameters for bugzilla. + </para> - <SECTION id="postinstall-check"> - <TITLE>Post-Installation Checklist</TITLE> - <PARA> + <section id="postinstall-check"> + <title>Post-Installation Checklist</title> + <para> After installation, follow the checklist below to ensure that - you have a successful installation. - If you do not see a recommended setting for a parameter, - consider leaving it at the default - while you perform your initial tests on your Bugzilla setup. - </PARA> - <INDEXTERM> - <PRIMARY>checklist</PRIMARY> - </INDEXTERM> - <PROCEDURE> - <STEP> - <PARA> - Bring up "editparams.cgi" in your web browser. For instance, to edit parameters - at mozilla.org, the URL would be <ULINK URL="http://bugzilla.mozilla.org/editparams.cgi"> - http://bugzilla.mozilla.org/editparams.cgi</ULINK>, also available under the "edit parameters" - link on your query page. - </PARA> - </STEP> - <STEP> - <PARA> - Set "maintainer" to <EMPHASIS>your</EMPHASIS> email address. - This allows Bugzilla's error messages - to display your email + you have a successful installation. If you do not see a + recommended setting for a parameter, consider leaving it at the + default while you perform your initial tests on your Bugzilla + setup. + </para> + <indexterm> + <primary>checklist</primary> + </indexterm> + <procedure> + <step> + <para> + Bring up "editparams.cgi" in your web browser. For + instance, to edit parameters at mozilla.org, the URL would + be <ulink url="http://bugzilla.mozilla.org/editparams.cgi"> + http://bugzilla.mozilla.org/editparams.cgi</ulink>, also + available under the "edit parameters" link on your query + page. + </para> + </step> + <step> + <para> + Set "maintainer" to <emphasis>your</emphasis> email address. + This allows Bugzilla's error messages to display your email address and allow people to contact you for help. - </PARA> - </STEP> - <STEP> - <PARA> - Set "urlbase" to the URL reference for your Bugzilla installation. - If your bugzilla query page is at http://www.foo.com/bugzilla/query.cgi, - your url base is http://www.foo.com/bugzilla/ - </PARA> - </STEP> - <STEP> - <PARA> - Set "usebuggroups" to "1" <EMPHASIS>only</EMPHASIS> - if you need to restrict access to products. - I suggest leaving this parameter <EMPHASIS>off</EMPHASIS> - while initially testing your Bugzilla. - </PARA> - </STEP> - <STEP> - <PARA> - Set "usebuggroupsentry" to "1" if you want to restrict access to products. - Once again, if you are simply testing your installation, I suggest against - turning this parameter on; the strict security checking may stop you from - being able to modify your new entries. - </PARA> - </STEP> - <STEP> - <PARA> - Set "shadowdb" to "bug_shadowdb" if you will be - running a *very* large installation of Bugzilla. - The shadow database enables many simultaneous users - to read and write to the database - without interfering with one another. - <NOTE> - <PARA> + </para> + </step> + <step> + <para> + Set "urlbase" to the URL reference for your Bugzilla + installation. If your bugzilla query page is at + http://www.foo.com/bugzilla/query.cgi, your url base is + http://www.foo.com/bugzilla/ + </para> + </step> + <step> + <para> + Set "usebuggroups" to "on" <emphasis>only</emphasis> if you + need to restrict access to products. I suggest leaving this + parameter <emphasis>off</emphasis> while initially testing + your Bugzilla. + </para> + </step> + <step> + <para> + Set "usebuggroupsentry" to "on" if you want to restrict + access to products. Once again, if you are simply testing + your installation, I suggest against turning this parameter + on; the strict security checking may stop you from being + able to modify your new entries. + </para> + </step> + <step> + <para> + Set "shadowdb" to "bug_shadowdb" if you will be running a + *very* large installation of Bugzilla. The shadow database + enables many simultaneous users to read and write to the + database without interfering with one another. + <note> + <para> Enabling "shadowdb" can adversely affect the stability - of your installation of Bugzilla. - You may frequently need to manually synchronize your databases, - or schedule nightly syncs - via "cron" - </PARA> - </NOTE> - Once again, in testing you should - avoid this option -- use it if or when you <EMPHASIS>need</EMPHASIS> to use it, and have - repeatedly run into the problem it was designed to solve -- very long wait times while - attempting to commit a change to the database. - </PARA> - <PARA> - If you use the "shadowdb" option, - it is only natural that you should turn the "queryagainstshadowdb" - option "On" as well. Otherwise you are replicating data into a shadow database for no reason! - </PARA> - </STEP> - <STEP> - <PARA> - If you have custom logos or HTML you must put in place to fit within your site design guidelines, - place the code in the "headerhtml", "footerhtml", "errorhtml", - "bannerhtml", or "blurbhtml" text boxes. - <NOTE> - <PARA> + of your installation of Bugzilla. You may frequently + need to manually synchronize your databases, or schedule + nightly syncs via "cron" + </para> + </note> Once again, in testing you should avoid this option + -- use it if or when you <emphasis>need</emphasis> to use + it, and have repeatedly run into the problem it was designed + to solve -- very long wait times while attempting to commit + a change to the database. + </para> + <para> + If you use the "shadowdb" option, it is only natural that + you should turn the "queryagainstshadowdb" option "On" as + well. Otherwise you are replicating data into a shadow + database for no reason! + </para> + </step> + <step> + <para> + If you have custom logos or HTML you must put in place to + fit within your site design guidelines, place the code in + the "headerhtml", "footerhtml", "errorhtml", "bannerhtml", + or "blurbhtml" text boxes. + <note> + <para> The "headerhtml" text box is the HTML printed out - <EMPHASIS>before</EMPHASIS> any other code on the page. - If you have a special banner, put the code for it in "bannerhtml". - You may want to leave these - settings at the defaults initially. - </PARA> - </NOTE> - </PARA> - </STEP> - <STEP> - <PARA> - Add any text you wish to the "passwordmail" parameter box. For instance, - many people choose to use this box to give a quick training blurb about how to - use Bugzilla at your site. - </PARA> - </STEP> - <STEP> - <PARA> - Ensure "newemailtech" is "on". - Your users will thank you. This is the default in the post-2.12 world, and is - only an issue if you are upgrading. - </PARA> - </STEP> - <STEP> - <PARA> - Do you want to use the qa contact ("useqacontact") - and status whiteboard ("usestatuswhiteboard") fields? - These fields are useful because they allow for more flexibility, - particularly when you have an existing - Quality Assurance and/or Release Engineering team, - but they may not be needed for smaller installations. - </PARA> - </STEP> - <STEP> - <PARA> - Set "whinedays" to the amount of days you want to let bugs go - in the "New" or "Reopened" state before - notifying people they have untouched new bugs. If you do not plan to use this feature, simply do - not set up the whining cron job described in the README, or set this value to "0". - </PARA> - </STEP> - <STEP> - <PARA> + <emphasis>before</emphasis> any other code on the page. + If you have a special banner, put the code for it in + "bannerhtml". You may want to leave these settings at + the defaults initially. + </para> + </note> + </para> + </step> + <step> + <para> + Add any text you wish to the "passwordmail" parameter box. + For instance, many people choose to use this box to give a + quick training blurb about how to use Bugzilla at your site. + </para> + </step> + <step> + <para> + Ensure "newemailtech" is "on". Your users will thank you. + This is the default in the post-2.12 world, and is only an + issue if you are upgrading. + </para> + </step> + <step> + <para> + Do you want to use the QA Contact ("useqacontact") and + status whiteboard ("usestatuswhiteboard") fields? These + fields are useful because they allow for more flexibility, + particularly when you have an existing Quality Assurance + and/or Release Engineering team, but they may not be needed + for smaller installations. + </para> + </step> + <step> + <para> + Set "whinedays" to the amount of days you want to let bugs + go in the "New" or "Reopened" state before notifying people + they have untouched new bugs. If you do not plan to use + this feature, simply do not set up the whining cron job + described in the installation instructions, or set this + value to "0". + </para> + </step> + <step> + <para> Set the "commenton" options according to your site policy. - It is a wise idea to require comments when users - resolve, reassign, or reopen bugs. - <NOTE> - <PARA> - It is generally far better to require a developer comment when resolving bugs than not. - Few things are more annoying to bug database users than having a developer - mark a bug "fixed" without any comment as to what the fix was (or even that it was truly fixed!) - </PARA> - </NOTE> - </PARA> - </STEP> - <STEP> - <PARA> - Set "supportwatchers" to "On". This feature is helpful for team leads to monitor progress in their - respective areas, and can offer many other benefits, such as allowing a developer to pick up a - former engineer's bugs without requiring her to change all the information in the bug. - </PARA> - </STEP> - </PROCEDURE> - </SECTION> + It is a wise idea to require comments when users resolve, + reassign, or reopen bugs. + <note> + <para> + It is generally far better to require a developer + comment when resolving bugs than not. Few things are + more annoying to bug database users than having a + developer mark a bug "fixed" without any comment as to + what the fix was (or even that it was truly fixed!) + </para> + </note> + </para> + </step> + <step> + <para> + Set "supportwatchers" to "On". This feature is helpful for + team leads to monitor progress in their respective areas, + and can offer many other benefits, such as allowing a + developer to pick up a former engineer's bugs without + requiring her to change all the information in the bug. + </para> + </step> + </procedure> + </section> - <SECTION id="useradmin"> - <TITLE>User Administration</TITLE> - <PARA> + <section id="useradmin"> + <title>User Administration</title> + <para> User administration is one of the easiest parts of Bugzilla. - Keeping it from getting out of hand, however, can become a challenge. - </PARA> + Keeping it from getting out of hand, however, can become a + challenge. + </para> - <SECTION id="defaultuser"> - <TITLE>Creating the Default User</TITLE> + <section id="defaultuser"> + <title>Creating the Default User</title> - <PARA> - When you first run checksetup.pl after installing Bugzilla, it will prompt you - for the administrative username (email address) and password for this "super user". - If for some reason you were to delete the "super user" account, re-running - checksetup.pl will again prompt you for this username and password. - </PARA> - <TIP> - <PARA> - If you wish to add more administrative users, you must use the MySQL interface. - Run "mysql" from the command line, and use these commands ("mysql>" denotes the - mysql prompt, not something you should type in): - <COMMAND><PROMPT>mysql></PROMPT> use bugs;</COMMAND> - <COMMAND><PROMPT>mysql></PROMPT> update profiles set groupset=0x7ffffffffffffff - where login_name = "(user's login name)"; </COMMAND> - </PARA> - </TIP> - </SECTION> + <para> + When you first run checksetup.pl after installing Bugzilla, it + will prompt you for the administrative username (email + address) and password for this "super user". If for some + reason you were to delete the "super user" account, re-running + checksetup.pl will again prompt you for this username and + password. + </para> + <tip> + <para> + If you wish to add more administrative users, you must use the + MySQL interface. Run "mysql" from the command line, and use + these commands ("mysql>" denotes the mysql prompt, not + something you should type in): + <command><prompt>mysql></prompt> use bugs;</command> + <command><prompt>mysql></prompt> update profiles set + groupset=0x7ffffffffffffff where login_name = "(user's + login name)"; </command> + </para> + </tip> + </section> - <SECTION id="manageusers"> - <TITLE>Managing Other Users</TITLE> + <section id="manageusers"> + <title>Managing Other Users</title> - <SECTION id="login"> - <TITLE>Logging In</TITLE> - <ORDEREDLIST> - <LISTITEM> - <PARA> - Open the index.html page for your Bugzilla installation in your browser window. - </PARA> - </LISTITEM> - <LISTITEM> - <PARA> + <section id="login"> + <title>Logging In</title> + <orderedlist> + <listitem> + <para> + Open the index.html page for your Bugzilla installation + in your browser window. + </para> + </listitem> + <listitem> + <para> Click the "Query Existing Bug Reports" link. - </PARA> - </LISTITEM> - <LISTITEM> - <PARA> + </para> + </listitem> + <listitem> + <para> Click the "Log In" link at the foot of the page. - </PARA> - </LISTITEM> - <LISTITEM> - <PARA> - Type your email address, and the password which was emailed to you when you - created your Bugzilla account, into the spaces provided. - </PARA> - </LISTITEM> - </ORDEREDLIST> - <PARA>Congratulations, you are logged in!</PARA> - </SECTION> + </para> + </listitem> + <listitem> + <para> + Type your email address, and the password which was + emailed to you when you created your Bugzilla account, + into the spaces provided. + </para> + </listitem> + </orderedlist> + <para>Congratulations, you are logged in!</para> + </section> - <SECTION id="createnewusers"> - <TITLE>Creating new users</TITLE> - <PARA> - Your users can create their own user accounts by clicking the "New Account" - link at the bottom of each page. - However, should you desire to create user accounts ahead of time, here is how you do it. - </PARA> - <ORDEREDLIST> - <LISTITEM> - <PARA> - After logging in, click the "Users" link at the footer of the query page. - </PARA> - </LISTITEM> - <LISTITEM> - <PARA> - To see a specific user, type a portion of their login name - in the box provided and click "submit". - To see all users, simply click the "submit" button. - You must click "submit" here to be able to add a new user. - </PARA> - <TIP> - <PARA> - More functionality is available via the list on the right-hand side - of the text entry box. - You can match what you type as a case-insensitive substring (the default) - of all users on your system, a case-sensitive regular expression - (please see the "man regexp" manual page for details on regular expression syntax), - or a <EMPHASIS>reverse</EMPHASIS> regular expression match, - where every user name which does NOT match the regular expression - is selected. - </PARA> - </TIP> - </LISTITEM> - <LISTITEM> - <PARA> - Click the "Add New User" link at the bottom of the user list - </PARA> - </LISTITEM> - <LISTITEM> - <PARA> - Fill out the form presented. This page is self-explanatory. When done, click "submit". - </PARA> - <NOTE> - <PARA> - Adding a user this way will <EMPHASIS>not</EMPHASIS> send an email - informing them of their username and password. - In general, it is preferable to log out and use the "New Account" - button to create users, as it will pre-populate all the required fields and also notify - the user of her account name and password. - </PARA> - </NOTE> - </LISTITEM> - </ORDEREDLIST> - </SECTION> + <section id="createnewusers"> + <title>Creating new users</title> + <para> + Your users can create their own user accounts by clicking + the "New Account" link at the bottom of each page. However, + should you desire to create user accounts ahead of time, + here is how you do it. + </para> + <orderedlist> + <listitem> + <para> + After logging in, click the "Users" link at the footer + of the query page. + </para> + </listitem> + <listitem> + <para> + To see a specific user, type a portion of their login + name in the box provided and click "submit". To see all + users, simply click the "submit" button. You must click + "submit" here to be able to add a new user. + </para> + <tip> + <para> + More functionality is available via the list on the + right-hand side of the text entry box. You can match + what you type as a case-insensitive substring (the + default) of all users on your system, a case-sensitive + regular expression (please see the "man regexp" manual + page for details on regular expression syntax), or a + <emphasis>reverse</emphasis> regular expression match, + where every user name which does NOT match the regular + expression is selected. + </para> + </tip> + </listitem> + <listitem> + <para> + Click the "Add New User" link at the bottom of the user + list + </para> + </listitem> + <listitem> + <para> + Fill out the form presented. This page is + self-explanatory. When done, click "submit". + </para> + <note> + <para> + Adding a user this way will <emphasis>not</emphasis> + send an email informing them of their username and + password. In general, it is preferable to log out and + use the "New Account" button to create users, as it + will pre-populate all the required fields and also + notify the user of her account name and password. + </para> + </note> + </listitem> + </orderedlist> + </section> - <SECTION id="disableusers"> - <TITLE>Disabling Users</TITLE> - <PARA> - I bet you noticed that big "Disabled Text" entry box available from the "Add New User" screen, - when you edit an account? - By entering any text in this box and selecting "submit", - you have prevented the user from using Bugzilla via the web interface. - Your explanation, written in this text box, will be presented to the user - the next time she attempts to use the system. - <WARNING> - <PARA> - Don't disable your own administrative account, or you will hate life! - </PARA> - </WARNING> - </PARA> - </SECTION> + <section id="disableusers"> + <title>Disabling Users</title> + <para> + I bet you noticed that big "Disabled Text" entry box + available from the "Add New User" screen, when you edit an + account? By entering any text in this box and selecting + "submit", you have prevented the user from using Bugzilla + via the web interface. Your explanation, written in this + text box, will be presented to the user the next time she + attempts to use the system. + <warning> + <para> + Don't disable your own administrative account, or you + will hate life! + </para> + </warning> + </para> + </section> - <SECTION id="modifyusers"> - <TITLE>Modifying Users</TITLE> - <PARA> - Here I will attempt to describe the function of each option on the user edit screen. - </PARA> - <ITEMIZEDLIST> - <LISTITEM> - <PARA> - <EMPHASIS>Login Name</EMPHASIS>: This is generally the user's email address. - However, if you have edited your system parameters, - this may just be the user's login name or some other identifier. - <TIP> - <PARA> - For compatability reasons, you should probably - stick with email addresses as user login names. It will make your life easier. - </PARA> - </TIP> - </PARA> - </LISTITEM> - <LISTITEM> - <PARA> - <EMPHASIS>Real Name</EMPHASIS>: Duh! - </PARA> - </LISTITEM> - <LISTITEM> - <PARA> - <EMPHASIS>Password</EMPHASIS>: You will only see asterisks in versions - of Bugzilla newer than 2.10 or early 2.11. You can change the user password here. - </PARA> - </LISTITEM> - <LISTITEM> - <PARA> - <EMPHASIS>Email Notification</EMPHASIS>: You may choose from one of three options: - <ORDEREDLIST> - <LISTITEM> - <PARA> + <section id="modifyusers"> + <title>Modifying Users</title> + <para> + Here I will attempt to describe the function of each option + on the Edit User screen. + </para> + <itemizedlist> + <listitem> + <para> + <emphasis>Login Name</emphasis>: This is generally the + user's email address. However, if you have edited your + system parameters, this may just be the user's login + name or some other identifier. + <tip> + <para> + For compatability reasons, you should probably stick + with email addresses as user login names. It will + make your life easier. + </para> + </tip> + </para> + </listitem> + <listitem> + <para> + <emphasis>Real Name</emphasis>: Duh! + </para> + </listitem> + <listitem> + <para> + <emphasis>Password</emphasis>: You will only see + asterisks in versions of Bugzilla newer than 2.10 or + early 2.11. You can change the user password here. + </para> + </listitem> + <listitem> + <para> + <emphasis>Email Notification</emphasis>: You may choose + from one of three options: + <orderedlist> + <listitem> + <para> All qualifying bugs except those which I change: The user will be notified of any change to any bug - for which she is the reporter, assignee, Q/A contact, CC recipient, or "watcher". - </PARA> - </LISTITEM> - <LISTITEM> - <PARA> + for which she is the reporter, assignee, QA + Contact, CC recipient, or "watcher". + </para> + </listitem> + <listitem> + <para> Only those bugs which I am listed on the CC line: - The user will not be notified of changes to bugs where she is the assignee, - reporter, or Q/A contact, but will receive them if she is on the CC list. - <NOTE> - <PARA> - She will still receive whining cron emails if you set up the "whinemail" feature. - </PARA> - </NOTE> - </PARA> - </LISTITEM> - <LISTITEM> - <PARA> - <EMPHASIS>All Qualifying Bugs</EMPHASIS>: This user is a glutton for punishment. - If her name is in the reporter, Q/A contact, CC, assignee, or is a "watcher", - she will get email updates regarding the bug. - </PARA> - </LISTITEM> - </ORDEREDLIST> -</PARA> - <PARA> - <EMPHASIS>Disable Text</EMPHASIS>: If you type anything in this box, - including just a space, the user account is disabled from making any changes - to bugs via the web interface, and what you type in this box is presented as the reason. - <WARNING> - <PARA>Don't disable the administrator account!</PARA> - </WARNING> - <NOTE> - <PARA> - As of this writing, the user can still submit bugs via the e-mail gateway, - if you set it up, despite the disabled text field. The e-mail gateway should - <EMPHASIS>not</EMPHASIS> be enabled for secure installations of Bugzilla. - </PARA> - </NOTE> - </PARA> - </LISTITEM> - <LISTITEM> - <PARA> - <EMPHASIS>CanConfirm</EMPHASIS>: This field is only used if you have enabled - "unconfirmed" status in your parameters screen. If you enable this for a user, - that user can then move bugs from "Unconfirmed" to "Confirmed" status (ergo: "New" status). - Be judicious about allowing users to turn this bit on for other users. - </PARA> - </LISTITEM> - <LISTITEM> - <PARA> - <EMPHASIS>Creategroups</EMPHASIS>: This option will allow a user to create and - destroy groups in Bugzilla. Unless you are using the Bugzilla GroupSentry security - option "usebuggroupsentry" in your parameters, this setting has no effect. - </PARA> - </LISTITEM> - <LISTITEM> - <PARA> - <EMPHASIS>Editbugs</EMPHASIS>: Unless a user has this bit set, they can only edit - those bugs for which they are the assignee or the reporter. - <NOTE> - <PARA> - Leaving this option unchecked does not prevent users from adding - comments to a bug! They simply cannot change a bug priority, severity, - etc. unless they are the assignee or reporter. - </PARA> - </NOTE> - </PARA> - </LISTITEM> - <LISTITEM> - <PARA> - <EMPHASIS>Editcomponents</EMPHASIS>: This flag allows a user to create new - products and components, as well as modify and destroy those that have no bugs - associated with them. If a product or component has bugs associated with it, - those bugs must be moved to a different product or component before Bugzilla - will allow them to be destroyed. The name of a product or component can be - changed without affecting the associated bugs, but it tends to annoy - the hell out of your users when these change a lot. - </PARA> - </LISTITEM> - <LISTITEM> - <PARA> - <EMPHASIS>Editkeywords</EMPHASIS>: If you use Bugzilla's keyword functionality, - enabling this feature allows a user can create and destroy keywords. - As always, the keywords for existing bugs containing the keyword - the user wishes to destroy must be changed before Bugzilla will allow it to die. - You must be very careful about creating too many new keywords - if you run a very large Bugzilla installation; keywords are global variables - across products, and you can often run into a phenomenon called "keyword bloat". - This confuses users, and then the feature goes unused. - </PARA> - </LISTITEM> - <LISTITEM> - <PARA> - <EMPHASIS>Editusers</EMPHASIS>: This flag allows a user do what you're doing - right now: edit other users. - This will allow those with the right to do so to remove administrator - priveleges from other users or grant them to themselves. Enable with care. - </PARA> - </LISTITEM> - <LISTITEM> - <PARA> - <EMPHASIS>PRODUCT</EMPHASIS>: PRODUCT bugs access. This allows an administrator, - with product-level granularity, to specify in which products a user can edit bugs. - The user must still have the "editbugs" privelege to edit bugs in this area; - this simply restricts them from even seeing bugs outside these boundaries if the administrator - has enabled the group sentry parameter "usebuggroupsentry". Unless you are using bug groups, + The user will not be notified of changes to bugs + where she is the assignee, reporter, or QA + Contact, but will receive them if she is on the CC + list. + <note> + <para> + She will still receive whining cron emails if + you set up the "whinemail" feature. + </para> + </note> + </para> + </listitem> + <listitem> + <para> + <emphasis>All Qualifying Bugs</emphasis>: This + user is a glutton for punishment. If her name is + in the reporter, QA Contact, CC, assignee, or is a + "watcher", she will get email updates regarding + the bug. + </para> + </listitem> + </orderedlist> +</para> + <para> + <emphasis>Disable Text</emphasis>: If you type anything + in this box, including just a space, the user account is + disabled from making any changes to bugs via the web + interface, and what you type in this box is presented as + the reason. + <warning> + <para>Don't disable the administrator account!</para> + </warning> + <note> + <para> + As of this writing, the user can still submit bugs + via the e-mail gateway, if you set it up, despite + the disabled text field. The e-mail gateway should + <emphasis>not</emphasis> be enabled for secure + installations of Bugzilla. + </para> + </note> + </para> + </listitem> + <listitem> + <para> + <emphasis>CanConfirm</emphasis>: This field is only used + if you have enabled "unconfirmed" status in your + parameters screen. If you enable this for a user, that + user can then move bugs from "Unconfirmed" to + "Confirmed" status (e.g.: "New" status). Be judicious + about allowing users to turn this bit on for other + users. + </para> + </listitem> + <listitem> + <para> + <emphasis>Creategroups</emphasis>: This option will + allow a user to create and destroy groups in Bugzilla. + Unless you are using the Bugzilla GroupSentry security + option "usebuggroupsentry" in your parameters, this + setting has no effect. + </para> + </listitem> + <listitem> + <para> + <emphasis>Editbugs</emphasis>: Unless a user has this + bit set, they can only edit those bugs for which they + are the assignee or the reporter. + <note> + <para> + Leaving this option unchecked does not prevent users + from adding comments to a bug! They simply cannot + change a bug priority, severity, etc. unless they + are the assignee or reporter. + </para> + </note> + </para> + </listitem> + <listitem> + <para> + <emphasis>Editcomponents</emphasis>: This flag allows a + user to create new products and components, as well as + modify and destroy those that have no bugs associated + with them. If a product or component has bugs + associated with it, those bugs must be moved to a + different product or component before Bugzilla will + allow them to be destroyed. The name of a product or + component can be changed without affecting the + associated bugs, but it tends to annoy the hell out of + your users when these change a lot. + </para> + </listitem> + <listitem> + <para> + <emphasis>Editkeywords</emphasis>: If you use Bugzilla's + keyword functionality, enabling this feature allows a + user can create and destroy keywords. As always, the + keywords for existing bugs containing the keyword the + user wishes to destroy must be changed before Bugzilla + will allow it to die. You must be very careful about + creating too many new keywords if you run a very large + Bugzilla installation; keywords are global variables + across products, and you can often run into a phenomenon + called "keyword bloat". This confuses users, and then + the feature goes unused. + </para> + </listitem> + <listitem> + <para> + <emphasis>Editusers</emphasis>: This flag allows a user + do what you're doing right now: edit other users. This + will allow those with the right to do so to remove + administrator priveleges from other users or grant them + to themselves. Enable with care. + </para> + </listitem> + <listitem> + <para> + <emphasis>PRODUCT</emphasis>: PRODUCT bugs access. This + allows an administrator, with product-level granularity, + to specify in which products a user can edit bugs. The + user must still have the "editbugs" privelege to edit + bugs in this area; this simply restricts them from even + seeing bugs outside these boundaries if the + administrator has enabled the group sentry parameter + "usebuggroupsentry". Unless you are using bug groups, this option has no effect. - </PARA> - </LISTITEM> - </ITEMIZEDLIST> - </SECTION> - </SECTION> - </SECTION> + </para> + </listitem> + </itemizedlist> + </section> + </section> + </section> - <SECTION id="programadmin"> - <TITLE>Product, Component, Milestone, and Version Administration</TITLE> - <EPIGRAPH> - <PARA> + <section id="programadmin"> + <title>Product, Component, Milestone, and Version + Administration</title> + <epigraph> + <para> Dear Lord, we have to get our users to do WHAT? - </PARA> - </EPIGRAPH> + </para> + </epigraph> - <SECTION id="products"> - <TITLE>Products</TITLE> - <SUBTITLE>Formerly, and in some spots still, called "Programs"</SUBTITLE> - <PARA> - <GLOSSTERM baseform="product" linkend="gloss_product">Products</GLOSSTERM> are the - broadest category in Bugzilla, and you should have the least of these. - If your company makes computer games, you should have one product per game, - and possibly a few special products - (website, meetings...) - </PARA> - <PARA> - A Product (formerly called "Program", and still referred to that way - in some portions of the source code) controls some very important functions. - The number of "votes" available for users to vote for the most important bugs - is set per-product, as is the number of votes required to move a bug automatically - from the UNCONFIRMED status to the NEW status. One can close a Product for further - bug entry and define various Versions available from the Edit Product screen. - </PARA> - <PARA>To create a new product:</PARA> - <ORDEREDLIST> - <LISTITEM> - <PARA> + <section id="products"> + <title>Products</title> + <subtitle>Formerly, and in some spots still, called + "Programs"</subtitle> + <para> + <glossterm linkend="gloss_product" baseform="product">Products</glossterm> are + the broadest category in Bugzilla, and you should have the + least of these. If your company makes computer games, you + should have one product per game, and possibly a few special + products (website, meetings...) + </para> + <para> + A Product (formerly called "Program", and still referred to + that way in some portions of the source code) controls some + very important functions. The number of "votes" available for + users to vote for the most important bugs is set per-product, + as is the number of votes required to move a bug automatically + from the UNCONFIRMED status to the NEW status. One can close + a Product for further bug entry and define various Versions + available from the Edit product screen. + </para> + <para>To create a new product:</para> + <orderedlist> + <listitem> + <para> Select "components" from the yellow footer - </PARA> - <TIP> - <PARA> - It may seem counterintuitive to click "components" when you want - to edit the properties associated with Products. This is one of a long - list of things we want in Bugzilla 3.0... - </PARA> - </TIP> - </LISTITEM> - <LISTITEM> - <PARA> + </para> + <tip> + <para> + It may seem counterintuitive to click "components" when + you want to edit the properties associated with + Products. This is one of a long list of things we want + in Bugzilla 3.0... + </para> + </tip> + </listitem> + <listitem> + <para> Select the "Add" link to the right of "Add a new product". - </PARA> - </LISTITEM> - <LISTITEM> - <PARA> - Enter the name of the product and a description. - The Description field is free-form. - </PARA> - </LISTITEM> - </ORDEREDLIST> - <TIP> - <PARA> - Don't worry about the "Closed for bug entry", "Maximum Votes per person", - "Maximum votes a person can put on a single bug", "Number of votes a bug in - this Product needs to automatically get out of the UNCOMFIRMED state", - and "Version" options yet. - We'll cover those in a few moments. - </PARA> - </TIP> - </SECTION> + </para> + </listitem> + <listitem> + <para> + Enter the name of the product and a description. The + Description field is free-form. + </para> + </listitem> + </orderedlist> + <tip> + <para> + Don't worry about the "Closed for bug entry", "Maximum Votes + per person", "Maximum votes a person can put on a single + bug", "Number of votes a bug in this Product needs to + automatically get out of the UNCOMFIRMED state", and + "Version" options yet. We'll cover those in a few moments. + </para> + </tip> + </section> - <SECTION id="components"> - <TITLE>Components</TITLE> - <PARA> + <section id="components"> + <title>Components</title> + <para> Components are subsections of a Product. - <EXAMPLE> - <TITLE>Creating some Components</TITLE> - <INFORMALEXAMPLE> - <PARA> - The computer game you are designing may a "UI" component, an "API" component, - a "Sound System" component, and a "Plugins" component, each overseen by a different - programmer. It often makes sense to divide Components in Bugzilla according to the - natural divisions of responsibility within your Product or company. - </PARA> - </INFORMALEXAMPLE> - </EXAMPLE> - - Each component has a owner and (if you turned it on in the parameters), a qa - contact. The owner should be the primary person who fixes bugs in that component. The QA - Contact should be the person who will ensure these bugs are completely fixed. The Owner, - QA Contact, and Reporter will get email when new bugs are created in this Component and - when these bugs change. Default Owner and Default QA Contact fields only dictate the - <EMPHASIS>default assignments</EMPHASIS>; the Owner and Q/A Contact fields in a bug - are otherwise unrelated to the Component. - </PARA> + <example> + <title>Creating some Components</title> + <informalexample> + <para> + The computer game you are designing may have a "UI" + component, an "API" component, a "Sound System" + component, and a "Plugins" component, each overseen by + a different programmer. It often makes sense to divide + Components in Bugzilla according to the natural + divisions of responsibility within your Product or + company. + </para> + </informalexample> + </example> Each component has a owner and (if you turned it on + in the parameters), a QA Contact. The owner should be the + primary person who fixes bugs in that component. The QA + Contact should be the person who will ensure these bugs are + completely fixed. The Owner, QA Contact, and Reporter will get + email when new bugs are created in this Component and when + these bugs change. Default Owner and Default QA Contact fields + only dictate the <emphasis>default assignments</emphasis>; the + Owner and QA Contact fields in a bug are otherwise unrelated + to the Component. + </para> - <PARA> + <para> To create a new Component: - </PARA> - <ORDEREDLIST> - <LISTITEM> - <PARA> - Select the "Edit components" link from the "Edit Product" page - </PARA> - </LISTITEM> - <LISTITEM> - <PARA> - Select the "Add" link to the right of the "Add a new component" text - on the "Select Component" page. - </PARA> - </LISTITEM> - <LISTITEM> - <PARA> - Fill out the "Component" field, a short "Description", and the "Initial Owner". - The "Component" field should not contain a space. The "Description" field is - free-form. The "Initial Owner" field must be that of a valid user already - existing in the database. If the initial owner does not exist, Bugzilla - will refuse to create the component. - <TIP> - <PARA> - Is your "Default Owner" a user who is not yet in the database? - No problem. - <ORDEREDLIST> - <LISTITEM> - <PARA> - Select the "Log out" link on the footer of the page. - </PARA> - </LISTITEM> - <LISTITEM> - <PARA> - Select the "New Account" link on the footer of the "Relogin" page - </PARA> - </LISTITEM> - <LISTITEM> - <PARA> - Type in the email address of the default owner you want to create - in the "E-mail address" field, and her full name in the "Real name" + </para> + <orderedlist> + <listitem> + <para> + Select the "Edit components" link from the "Edit product" + page + </para> + </listitem> + <listitem> + <para> + Select the "Add" link to the right of the "Add a new + component" text on the "Select Component" page. + </para> + </listitem> + <listitem> + <para> + Fill out the "Component" field, a short "Description", and + the "Initial Owner". The Component and Description fields + are free-form; the "Initial Owner" field must be that of a + user ID already existing in the database. If the initial + owner does not exist, Bugzilla will refuse to create the + component. + <tip> + <para> + Is your "Default Owner" a user who is not yet in the + database? No problem. + <orderedlist> + <listitem> + <para> + Select the "Log out" link on the footer of the + page. + </para> + </listitem> + <listitem> + <para> + Select the "New Account" link on the footer of + the "Relogin" page + </para> + </listitem> + <listitem> + <para> + Type in the email address of the default owner + you want to create in the "E-mail address" + field, and her full name in the "Real name" field, then select the "Submit Query" button. - </PARA> - </LISTITEM> - <LISTITEM> - <PARA> - Now select "Log in" again, type in your login information, and you - can modify the product to use the Default Owner information - you require. - </PARA> - </LISTITEM> - </ORDEREDLIST> - </PARA> - </TIP> - </PARA> - </LISTITEM> - <LISTITEM> - <PARA> - Either "edit" more components or return to the "query" page on the ensuing - "Addming new component" page. To return to the Product you were editing, you - must select the "components" link as before. - </PARA> - </LISTITEM> - </ORDEREDLIST> - </SECTION> + </para> + </listitem> + <listitem> + <para> + Now select "Log in" again, type in your login + information, and you can modify the product to + use the Default Owner information you require. + </para> + </listitem> + </orderedlist> + </para> + </tip> + </para> + </listitem> + <listitem> + <para> + Either Edit more components or return to the Bugzilla + Query Page. To return to the Product you were editing, you + must select the Components link as before. + </para> + </listitem> + </orderedlist> + </section> - <SECTION id="versions"> - <TITLE>Versions</TITLE> - <PARA> - Versions are the revisions of the product, such as "Flinders 3.1", "Flinders 95", - and "Flinders 2000". Using Versions helps you isolate code changes and are an aid - in reporting. + <section id="versions"> + <title>Versions</title> + <para> + Versions are the revisions of the product, such as "Flinders + 3.1", "Flinders 95", and "Flinders 2000". Using Versions + helps you isolate code changes and are an aid in reporting. - <EXAMPLE> - <TITLE>Common Use of Versions</TITLE> - <INFORMALEXAMPLE> - <PARA> - A user reports a bug - against Version "Beta 2.0" of your product. The current Version of your software - is "Release Candidate 1", and no longer has the bug. This will - help you triage and classify bugs according to their relevance. It is also - possible people may report bugs against bleeding-edge beta versions that are - not evident in older versions of the software. This can help isolate code - changes that caused the bug - </PARA> - </INFORMALEXAMPLE> - </EXAMPLE> - <EXAMPLE> - <TITLE>A Different Use of Versions</TITLE> - <INFORMALEXAMPLE> - <PARA> - This field has been used to good effect by an online service provider in a slightly - different way. They had three versions of the product: "Production", "QA", - and "Dev". Although it may be the same product, a bug in the development - environment is not normally as critical as a Production bug, nor does it - need to be reported publicly. When used in conjunction with Target Milestones, - one can easily specify the environment where a bug can be reproduced, and - the Milestone by which it will be fixed. - </PARA> - </INFORMALEXAMPLE> - </EXAMPLE> - </PARA> - <PARA> + <example> + <title>Common Use of Versions</title> + <informalexample> + <para> + A user reports a bug against Version "Beta 2.0" of your + product. The current Version of your software is + "Release Candidate 1", and no longer has the bug. This + will help you triage and classify bugs according to + their relevance. It is also possible people may report + bugs against bleeding-edge beta versions that are not + evident in older versions of the software. This can + help isolate code changes that caused the bug + </para> + </informalexample> + </example> + <example> + <title>A Different Use of Versions</title> + <informalexample> + <para> + This field has been used to good effect by an online + service provider in a slightly different way. They had + three versions of the product: "Production", "QA", and + "Dev". Although it may be the same product, a bug in + the development environment is not normally as critical + as a Production bug, nor does it need to be reported + publicly. When used in conjunction with Target + Milestones, one can easily specify the environment where + a bug can be reproduced, and the Milestone by which it + will be fixed. + </para> + </informalexample> + </example> + </para> + <para> To create and edit Versions: - </PARA> - <ORDEREDLIST> - <LISTITEM> - <PARA> - From the "Edit Product" screen, select "Edit Versions" - </PARA> - </LISTITEM> - <LISTITEM> - <PARA> - You will notice that the product already has the default version "undefined". - If your product doesn't use version numbers, you may want to leave this as it is - or edit it so that it is "---". You can then go back to the edit versions page - and add new versions to your product. - </PARA> - <PARA> - Otherwise, click the "Add" button to the right of the "Add a new version" text. - </PARA> - </LISTITEM> - <LISTITEM> - <PARA> - Enter the name of the Version. This can be free-form characters up to the limit of the - text box. Then select the "Add" button. - </PARA> - </LISTITEM> - <LISTITEM> - <PARA> - At this point you can select "Edit" to edit more Versions, or return to the "Query" - page, from which you can navigate back to the product through the "components" link - at the foot of the Query page. - </PARA> - </LISTITEM> - </ORDEREDLIST> - </SECTION> + </para> + <orderedlist> + <listitem> + <para> + From the "Edit product" screen, select "Edit Versions" + </para> + </listitem> + <listitem> + <para> + You will notice that the product already has the default + version "undefined". If your product doesn't use version + numbers, you may want to leave this as it is or edit it so + that it is "---". You can then go back to the edit + versions page and add new versions to your product. + </para> + <para> + Otherwise, click the "Add" button to the right of the "Add + a new version" text. + </para> + </listitem> + <listitem> + <para> + Enter the name of the Version. This can be free-form + characters up to the limit of the text box. Then select + the "Add" button. + </para> + </listitem> + <listitem> + <para> + At this point you can select "Edit" to edit more Versions, + or return to the "Query" page, from which you can navigate + back to the product through the "components" link at the + foot of the Query page. + </para> + </listitem> + </orderedlist> + </section> - <SECTION id="milestones"> - <TITLE>Milestones</TITLE> - <PARA> - Milestones are "targets" that you plan to get a bug fixed by. For example, you have a bug that - you plan to fix for your 3.0 release, it would be assigned the milestone of 3.0. Or, you have a - bug that you plan to fix for 2.8, this would have a milestone of 2.8. - </PARA> - <NOTE> - <PARA> - Milestone options will only appear for a Product if you turned the "usetargetmilestone" field - in the "Edit Parameters" screen "On". - </PARA> - </NOTE> - <PARA> - To create new Milestones, set Default Milestones, and set Milestone URL: - </PARA> - <ORDEREDLIST> - <LISTITEM> - <PARA> + <section id="milestones"> + <title>Milestones</title> + <para> + Milestones are "targets" that you plan to get a bug fixed by. + For example, you have a bug that you plan to fix for your 3.0 + release, it would be assigned the milestone of 3.0. Or, you + have a bug that you plan to fix for 2.8, this would have a + milestone of 2.8. + </para> + <note> + <para> + Milestone options will only appear for a Product if you + turned the "usetargetmilestone" field in the "Edit + Parameters" screen "On". + </para> + </note> + <para> + To create new Milestones, set Default Milestones, and set + Milestone URL: + </para> + <orderedlist> + <listitem> + <para> Select "edit milestones" - </PARA> - </LISTITEM> - <LISTITEM> - <PARA> - Select "Add" to the right of the "Add a new milestone" text - </PARA> - </LISTITEM> - <LISTITEM> - <PARA> + </para> + </listitem> + <listitem> + <para> + Select "Add" to the right of the "Add a new milestone" + text + </para> + </listitem> + <listitem> + <para> Enter the name of the Milestone in the "Milestone" field. - You can optionally set the "Sortkey", which is a positive or negative number (-255 to 255) - that defines where in the list this particular milestone appears. - Select "Add". - </PARA> - <EXAMPLE> - <TITLE>Using SortKey with Target Milestone</TITLE> - <INFORMALEXAMPLE> - <PARA> - Let's say you create a target milestone called "Release 1.0", with Sortkey set to "0". - Later, you realize that you will have a public beta, called "Beta1". - You can create a Milestone called "Beta1", with a Sortkey of "-1" in order to ensure - people will see the Target Milestone of "Beta1" earlier on the list than "Release 1.0" - </PARA> - </INFORMALEXAMPLE> - </EXAMPLE> - </LISTITEM> - <LISTITEM> - <PARA> - If you want to add more milestones, select the "Edit" link. - If you don't, well shoot, you have to go back to the "query" page and select "components" - again, and make your way back to the Product you were editing. - <NOTE> - <PARA> - This is another in the list of unusual user interface decisions that - we'd like to get cleaned up. Shouldn't there be a link to the effect of - "edit the Product I was editing when I ended up here"? In any case, - clicking "components" in the footer takes you back to the "Select product" - screen, from which you can begin editing your product again. - </PARA> - </NOTE> - </PARA> - </LISTITEM> - <LISTITEM> - <PARA> - From the Edit Product screen again (once you've made your way back), enter the URL - for a description of what your milestones are for this product in the "Milestone URL" field. - It should be of the format "http://www.foo.com/bugzilla/product_milestones.html" - </PARA> - <PARA> - Some common uses of this field include product descriptions, product roadmaps, - and of course a simple description of the meaning of each milestone. - </PARA> - </LISTITEM> - <LISTITEM> - <PARA> - If you're using Target Milestones, the "Default Milestone" field must have some - kind of entry. If you really don't care if people set coherent Target Milestones, - simply leave this at the default, "---". However, controlling and regularly updating the Default - Milestone field is a powerful tool when reporting the status of projects. - </PARA> - <PARA>Select the "Update" button when you are done.</PARA> - </LISTITEM> - <LISTITEM> - <PARA> - - </PARA> - </LISTITEM> - </ORDEREDLIST> - </SECTION> + You can optionally set the "Sortkey", which is a positive + or negative number (-255 to 255) that defines where in the + list this particular milestone appears. Select "Add". + </para> + <example> + <title>Using SortKey with Target Milestone</title> + <informalexample> + <para> + Let's say you create a target milestone called + "Release 1.0", with Sortkey set to "0". Later, you + realize that you will have a public beta, called + "Beta1". You can create a Milestone called "Beta1", + with a Sortkey of "-1" in order to ensure people will + see the Target Milestone of "Beta1" earlier on the + list than "Release 1.0" + </para> + </informalexample> + </example> + </listitem> + <listitem> + <para> + If you want to add more milestones, select the "Edit" + link. If you don't, well shoot, you have to go back to the + "query" page and select "components" again, and make your + way back to the Product you were editing. + <note> + <para> + This is another in the list of unusual user interface + decisions that we'd like to get cleaned up. Shouldn't + there be a link to the effect of "edit the Product I + was editing when I ended up here"? In any case, + clicking "components" in the footer takes you back to + the "Select product" screen, from which you can begin + editing your product again. + </para> + </note> + </para> + </listitem> + <listitem> + <para> + From the Edit product screen again (once you've made your + way back), enter the URL for a description of what your + milestones are for this product in the "Milestone URL" + field. It should be of the format + "http://www.foo.com/bugzilla/product_milestones.html" + </para> + <para> + Some common uses of this field include product + descriptions, product roadmaps, and of course a simple + description of the meaning of each milestone. + </para> + </listitem> + <listitem> + <para> + If you're using Target Milestones, the "Default Milestone" + field must have some kind of entry. If you really don't + care if people set coherent Target Milestones, simply + leave this at the default, "---". However, controlling + and regularly updating the Default Milestone field is a + powerful tool when reporting the status of projects. + </para> + <para>Select the "Update" button when you are done.</para> + </listitem> + </orderedlist> + </section> - <SECTION id="voting"> - <TITLE>Voting</TITLE> - <PARA> - The concept of "voting" is a poorly understood, yet powerful feature for the management - of open-source projects. Each user is assigned so many Votes per product, which they can - freely reassign (or assign multiple votes to a single bug). - This allows developers to gauge user need for a particular enhancement - or bugfix. By allowing bugs with a certain number of votes to automatically move from - "UNCONFIRMED" to "NEW", users of the bug system can help high-priority bugs garner + <section id="voting"> + <title>Voting</title> + <para> + The concept of "voting" is a poorly understood, yet powerful + feature for the management of open-source projects. Each user + is assigned so many Votes per product, which they can freely + reassign (or assign multiple votes to a single bug). This + allows developers to gauge user need for a particular + enhancement or bugfix. By allowing bugs with a certain number + of votes to automatically move from "UNCONFIRMED" to "NEW", + users of the bug system can help high-priority bugs garner attention so they don't sit for a long time awaiting triage. - </PARA> - <PARA> - The daunting challenge of Votes is deciding where you draw the line for a "vocal majority". If you - only have a user base of 100 users, setting a low threshold for bugs to move from UNCONFIRMED - to NEW makes sense. As the Bugzilla user base expands, however, these thresholds must be - re-evaluated. You should gauge whether this feature is worth the time and close monitoring involved, - and perhaps forego implementation until you have a critical mass of users who demand it. - </PARA> - <PARA>To modify Voting settings:</PARA> - <ORDEREDLIST> - <LISTITEM> - <PARA> - Navigate to the "Edit Product" screen for the Product you wish to modify - </PARA> - </LISTITEM> - <LISTITEM> - <PARA> - Set "Maximum Votes per person" to your calculated value. Setting this field - to "0" disables voting. - </PARA> - </LISTITEM> - <LISTITEM> - <PARA> - Set "Maximum Votes a person can put on a single bug" to your calculated value. It - should probably be some number lower than the "Maximum votes per person". - Setting this field to "0" disables voting, but leaves the voting options open - to the user. This is confusing. - </PARA> - </LISTITEM> - <LISTITEM> - <PARA> - Set "Number of votes a bug in this product needs to automatically get out of the - UNCONFIRMED state" to your calculated number. Setting this field to "0" - disables the automatic move of bugs from UNCONFIRMED to NEW. Some people - advocate leaving this at "0", but of what use are Votes if your Bugzilla - user base is unable to affect which bugs appear on Development radar? - <TIP> - <PARA> - You should probably set this number to higher than a small coalition of - Bugzilla users can influence it. Most sites use this as a "referendum" - mechanism -- if users are able to vote a bug out of UNCONFIRMED, it - is a <EMPHASIS>really</EMPHASIS> bad bug! - </PARA> - </TIP> - </PARA> - </LISTITEM> - <LISTITEM> - <PARA> - Once you have adjusted the values to your preference, select the "Update" button. - </PARA> - </LISTITEM> - </ORDEREDLIST> - </SECTION> + </para> + <para> + The daunting challenge of Votes is deciding where you draw the + line for a "vocal majority". If you only have a user base of + 100 users, setting a low threshold for bugs to move from + UNCONFIRMED to NEW makes sense. As the Bugzilla user base + expands, however, these thresholds must be re-evaluated. You + should gauge whether this feature is worth the time and close + monitoring involved, and perhaps forego implementation until + you have a critical mass of users who demand it. + </para> + <para>To modify Voting settings:</para> + <orderedlist> + <listitem> + <para> + Navigate to the "Edit product" screen for the Product you + wish to modify + </para> + </listitem> + <listitem> + <para> + Set "Maximum Votes per person" to your calculated value. + Setting this field to "0" disables voting. + </para> + </listitem> + <listitem> + <para> + Set "Maximum Votes a person can put on a single bug" to + your calculated value. It should probably be some number + lower than the "Maximum votes per person". Setting this + field to "0" disables voting, but leaves the voting + options open to the user. This is confusing. + </para> + </listitem> + <listitem> + <para> + Set "Number of votes a bug in this product needs to + automatically get out of the UNCONFIRMED state" to your + calculated number. Setting this field to "0" disables + the automatic move of bugs from UNCONFIRMED to NEW. Some + people advocate leaving this at "0", but of what use are + Votes if your Bugzilla user base is unable to affect which + bugs appear on Development radar? + <tip> + <para> + You should probably set this number to higher than a + small coalition of Bugzilla users can influence it. + Most sites use this as a "referendum" mechanism -- if + users are able to vote a bug out of UNCONFIRMED, it is + a <emphasis>really</emphasis> bad bug! + </para> + </tip> + </para> + </listitem> + <listitem> + <para> + Once you have adjusted the values to your preference, + select the "Update" button. + </para> + </listitem> + </orderedlist> + </section> - <SECTION id="groups"> - <TITLE>Groups and Group Security</TITLE> - <PARA> - Groups can be very useful in bugzilla, because they allow users to isolate - bugs or products that should only be seen by certain people. Groups can also - be a complicated minefield of interdependencies and weirdness if mismanaged. + <section id="groups"> + <title>Groups and Group Security</title> + <para> + Groups can be very useful in bugzilla, because they allow + users to isolate bugs or products that should only be seen by + certain people. Groups can also be a complicated minefield of + interdependencies and weirdness if mismanaged. - <EXAMPLE> - <TITLE>When to Use Group Security</TITLE> - <INFORMALEXAMPLE> - <PARA> - Many Bugzilla sites isolate "Security-related" bugs from all other bugs. - This way, they can have a fix ready before the security vulnerability - is announced to the world. You can create a "Security" product which, by - default, has no members, and only add members to the group (in their individual - User page, as described under User Administration) who should have - priveleged access to "Security" bugs. Alternately, you may create a Group - independently of any Product, and change the Group mask on individual bugs - to restrict access to members only of certain Groups. - </PARA> - </INFORMALEXAMPLE> - </EXAMPLE> - - Groups only work if you enable the "usebuggroups" paramater. - In addition, if the "usebuggroupsentry" parameter is "On", one can restrict access - to products by groups, so that only members of a product group are able to view - bugs within that product. - Group security in Bugzilla can be divided into two categories: - Generic and Product-Based. - </PARA> - <NOTE> - <PARA> - Groups in Bugzilla are a complicated beast that evolved out of very simple user - permission bitmasks, apparently itself derived from common concepts in UNIX access - controls. A "bitmask" is a fixed-length number whose value can describe one, and - only one, set of states. For instance, UNIX file permissions are assigned bitmask - values: "execute" has a value of 1, "write" has a value of 2, - and "read" has a value of 4. Add them together, - and a file can be read, written to, and executed if it has a bitmask of "7". (This - is a simplified example -- anybody who knows UNIX security knows there is much - more to it than this. Please bear with me for the purpose of this note.) The only - way a bitmask scheme can work is by doubling the bit count for each value. Thus - if UNIX wanted to offer another file permission, the next would have to be a value of - 8, then the next 16, the next 32, etc. - </PARA> - <PARA> - Similarly, Bugzilla offers a bitmask to define group permissions, with an internal - limit of 64. Several are already occupied - by built-in permissions. The way around this limitation is - to avoid assigning groups to products if you have many products, avoid bloating - of group lists, and religiously prune irrelevant groups. In reality, most installations - of Bugzilla support far fewer than 64 groups, so this limitation has not hit - for most sites, but it is on the table to be revised for Bugzilla 3.0 - because it interferes with the security schemes of some administrators. - </PARA> - </NOTE> - <PARA> + <example> + <title>When to Use Group Security</title> + <informalexample> + <para> + Many Bugzilla sites isolate "Security-related" bugs from + all other bugs. This way, they can have a fix ready + before the security vulnerability is announced to the + world. You can create a "Security" product which, by + default, has no members, and only add members to the + group (in their individual User page, as described under + User Administration) who should have priveleged access + to "Security" bugs. Alternately, you may create a Group + independently of any Product, and change the Group mask + on individual bugs to restrict access to members only of + certain Groups. + </para> + </informalexample> + </example> Groups only work if you enable the "usebuggroups" + paramater. In addition, if the "usebuggroupsentry" parameter + is "On", one can restrict access to products by groups, so + that only members of a product group are able to view bugs + within that product. Group security in Bugzilla can be divided + into two categories: Generic and Product-Based. + </para> + <note> + <para> + Groups in Bugzilla are a complicated beast that evolved out + of very simple user permission bitmasks, apparently itself + derived from common concepts in UNIX access controls. A + "bitmask" is a fixed-length number whose value can describe + one, and only one, set of states. For instance, UNIX file + permissions are assigned bitmask values: "execute" has a + value of 1, "write" has a value of 2, and "read" has a + value of 4. Add them together, and a file can be read, + written to, and executed if it has a bitmask of "7". (This + is a simplified example -- anybody who knows UNIX security + knows there is much more to it than this. Please bear with + me for the purpose of this note.) The only way a bitmask + scheme can work is by doubling the bit count for each value. + Thus if UNIX wanted to offer another file permission, the + next would have to be a value of 8, then the next 16, the + next 32, etc. + </para> + <para> + Similarly, Bugzilla offers a bitmask to define group + permissions, with an internal limit of 64. Several are + already occupied by built-in permissions. The way around + this limitation is to avoid assigning groups to products if + you have many products, avoid bloating of group lists, and + religiously prune irrelevant groups. In reality, most + installations of Bugzilla support far fewer than 64 groups, + so this limitation has not hit for most sites, but it is on + the table to be revised for Bugzilla 3.0 because it + interferes with the security schemes of some administrators. + </para> + </note> + <para> To enable Generic Group Security ("usebuggroups"): - </PARA> - <ORDEREDLIST> - <LISTITEM> - <PARA> + </para> + <orderedlist> + <listitem> + <para> Turn "On" "usebuggroups" in the "Edit Parameters" screen. - </PARA> - </LISTITEM> - <LISTITEM> - <PARA> - You will generally have no groups set up. Select the "groups" link - in the footer. - </PARA> - </LISTITEM> - <LISTITEM> - <PARA> - Take a moment to understand the instructions on the "Edit Groups" screen. - Once you feel confident you understand what is expected of you, select the - "Add Group" link. - </PARA> - </LISTITEM> - <LISTITEM> - <PARA> - Fill out the "New Name" (remember, no spaces!), "New Description", and "New - User RegExp" fields. "New User RegExp" allows you to automatically place - all users who fulfill the Regular Expression into the new group. + </para> + </listitem> + <listitem> + <para> + You will generally have no groups set up. Select the + "groups" link in the footer. + </para> + </listitem> + <listitem> + <para> + Take a moment to understand the instructions on the "Edit + Groups" screen. Once you feel confident you understand + what is expected of you, select the "Add Group" link. + </para> + </listitem> + <listitem> + <para> + Fill out the "New Name" (remember, no spaces!), "New + Description", and "New User RegExp" fields. "New User + RegExp" allows you to automatically place all users who + fulfill the Regular Expression into the new group. - <EXAMPLE> - <TITLE>Creating a New Group</TITLE> - <INFORMALEXAMPLE> - <PARA> - I created a group called "DefaultGroup" with a description of "This is simply - a group to play with", and a "New User RegExp" of "*@velio.com". This - new group automatically includes all Bugzilla users with "@velio.com" at the - end of their user id. When I finished, my new group was assigned bit #128. - </PARA> - </INFORMALEXAMPLE> - </EXAMPLE> - - When you have finished, select the "Add" button. - </PARA> - </LISTITEM> - </ORDEREDLIST> + <example> + <title>Creating a New Group</title> + <informalexample> + <para> + I created a group called DefaultGroup with a + description of <quote>This is simply a group to play + with</quote>, and a New User RegExp of <quote>.*@mydomain.tld</quote>. + This new group automatically includes all Bugzilla + users with "@mydomain.tld" at the end of their user id. + When I finished, my new group was assigned bit #128. + </para> + </informalexample> + </example> When you have finished, select the Add + button. + </para> + </listitem> + </orderedlist> - <PARA> - To enable Product-Based Group Security ("usebuggroupsentry"): - </PARA> - <WARNING> - <PARA> - Don't forget that you only have 64 groups masks available, total, for - your installation of Bugzilla! If you plan on having more than 50 - products in your individual Bugzilla installation, and require group - security for your products, you should - consider either running multiple Bugzillas or using Generic Group Security - instead of Product-Based ("usebuggroupsentry") Group Security. - </PARA> - </WARNING> - <ORDEREDLIST> - <LISTITEM> - <PARA> - Turn "On" "usebuggroups" and "usebuggroupsentry" in the "Edit Parameters" screen. - </PARA> - <WARNING> - <PARA> - "usebuggroupsentry" has the capacity to prevent the administrative user - from directly altering bugs because of conflicting group permissions. - If you plan on using "usebuggroupsentry", you should plan on restricting administrative - account usage to administrative duties only. - In other words, manage bugs with an unpriveleged user account, and - manage users, groups, Products, etc. with the administrative account. - </PARA> - </WARNING> - </LISTITEM> - <LISTITEM> - <PARA> - You will generally have no Groups set up, unless you enabled "usebuggroupsentry" - prior to creating any Products. To create "Generic Group Security" groups, - follow the instructions given above. To create Product-Based Group security, - simply follow the 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. - </PARA> - </LISTITEM> - </ORDEREDLIST> - </SECTION> - </SECTION> + <para> + To enable Product-Based Group Security (usebuggroupsentry): + </para> + <warning> + <para> + Don't forget that you only have 64 groups masks available, + total, for your installation of Bugzilla! If you plan on + having more than 50 products in your individual Bugzilla + installation, and require group security for your products, + you should consider either running multiple Bugzillas or + using Generic Group Security instead of Product-Based + ("usebuggroupsentry") Group Security. + </para> + </warning> + <orderedlist> + <listitem> + <para> + Turn "On" "usebuggroups" and "usebuggroupsentry" in the + "Edit Parameters" screen. + </para> + <warning> + <para> + "usebuggroupsentry" has the capacity to prevent the + administrative user from directly altering bugs because + of conflicting group permissions. If you plan on using + "usebuggroupsentry", you should plan on restricting + administrative account usage to administrative duties + only. In other words, manage bugs with an unpriveleged + user account, and manage users, groups, Products, etc. + with the administrative account. + </para> + </warning> + </listitem> + <listitem> + <para> + You will generally have no Groups set up, unless you + enabled "usebuggroupsentry" prior to creating any + Products. To create "Generic Group Security" groups, + follow the instructions given above. To create + Product-Based Group security, simply follow the + 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. + </para> + </listitem> + </orderedlist> + </section> + </section> - <SECTION id="security"> - <TITLE>Bugzilla Security</TITLE> - <EPIGRAPH> - <PARA> - Putting your money in a wall safe is better protection than depending on the fact that - no one knows that you hide your money in a mayonnaise jar in your fridge. - </PARA> - </EPIGRAPH> - <NOTE> - <PARA> - Poorly-configured MySQL, Bugzilla, and FTP installations have given attackers full - access to systems in the past. Please take these guidelines seriously, even - for Bugzilla machines hidden away behind your firewall. 80% of all computer + <section id="security"> + <title>Bugzilla Security</title> + <epigraph> + <para> + Putting your money in a wall safe is better protection than + depending on the fact that no one knows that you hide your + money in a mayonnaise jar in your fridge. + </para> + </epigraph> + <note> + <para> + Poorly-configured MySQL, Bugzilla, and FTP installations have + given attackers full access to systems in the past. Please + take these guidelines seriously, even for Bugzilla machines + hidden away behind your firewall. 80% of all computer trespassers are insiders, not anonymous crackers. - </PARA> - </NOTE> - <PARA> - First thing's first: Secure your installation. - <NOTE> - <PARA> - These instructions must, of necessity, be somewhat vague since Bugzilla runs on so many different - platforms. If you have refinements of these directions for specific platforms, please - submit them to <ULINK URL="mailto://mozilla-webtools@mozilla.org">mozilla-webtools@mozilla.org</ULINK> - </PARA> - </NOTE> - <ORDEREDLIST> - <LISTITEM> - <PARA> - Ensure you are running at least MysQL version 3.22.32 or newer. Earlier versions had - notable security holes and poorly secured default configuration choices. - </PARA> - </LISTITEM> - <LISTITEM> - <PARA><EMPHASIS>There is no substitute for understanding the tools on your system!</EMPHASIS> - Read <ULINK URL="http://www.mysql.com/documentation/mysql/bychapter/manual_Privilege_system.html"> - The MySQL Privelege System</ULINK> until you can recite it from memory!</PARA> - <PARA> - At the very least, ensure you password the "mysql -u root" account and the "bugs" account, establish grant - table rights (consult the Keystone guide in Appendix C: The Bugzilla Database for some easy-to-use details) - that do not allow CREATE, DROP, RELOAD, SHUTDOWN, and PROCESS for user "bugs". I wrote up the Keystone - advice back when I knew far less about security than I do now : ) - </PARA> - </LISTITEM> - <LISTITEM> - <PARA> - Lock down /etc/inetd.conf. Heck, disable inet entirely on this box. It should only listen to - port 25 for Sendmail + </para> + </note> + <para> + Secure your installation. + <note> + <para> + These instructions must, of necessity, be somewhat vague + since Bugzilla runs on so many different platforms. If you + have refinements of these directions for specific platforms, + please submit them to <ulink url="mailto://mozilla-webtools@mozilla.org">mozilla-webtools@mozilla.org</ulink> + </para> + </note> + <orderedlist> + <listitem> + <para> + Ensure you are running at least MysQL version 3.22.32 or + newer. Earlier versions had notable security holes and + poorly secured default configuration choices. + </para> + </listitem> + <listitem> + <para><emphasis>There is no substitute for understanding the + tools on your system!</emphasis> Read <ulink url="http://www.mysql.com/documentation/mysql/bychapter/manual_Privilege_system.html"> The MySQL Privilege System</ulink> until you can recite it from memory!</para> + <para> + At the very least, ensure you password the "mysql -u root" + account and the "bugs" account, establish grant table + rights (consult the Keystone guide in Appendix C: The + Bugzilla Database for some easy-to-use details) that do + not allow CREATE, DROP, RELOAD, SHUTDOWN, and PROCESS for + user "bugs". I wrote up the Keystone advice back when I + knew far less about security than I do now : ) + </para> + </listitem> + <listitem> + <para> + Lock down /etc/inetd.conf. Heck, disable inet entirely on + this box. It should only listen to port 25 for Sendmail and port 80 for Apache. - </PARA> - </LISTITEM> - <LISTITEM> - <PARA>Do not run Apache as "nobody". This will require very lax permissions in your Bugzilla directories. - Run it, instead, as a user with a name, set via your httpd.conf file.</PARA> - </LISTITEM> - <LISTITEM> - <PARA> - Ensure you have adequate access controls for the $BUGZILLA_HOME/data/ and - $BUGZILLA_HOME/shadow/ directories, as well as the $BUGZILLA_HOME/localconfig and - $BUGZILLA_HOME/globals.pl files. - The localconfig file stores your "bugs" user password, - which would be terrible to have in the hands - of a criminal, while the "globals.pl" stores some default information regarding your - installation which could aid a system cracker. - In addition, some files under $BUGZILLA_HOME/data/ store sensitive information, and - $BUGZILLA_HOME/shadow/ stores bug information for faster retrieval. If you fail to secure - these directories and this file, you will expose bug information to those who may not - be allowed to see it. - </PARA> - <NOTE> - <PARA> - Bugzilla provides default .htaccess files to protect the most common Apache - installations. However, you should verify these are adequate according to the site-wide - security policy of your web server, and ensure that the .htaccess files are - allowed to "override" default permissions set in your Apache configuration files. - Covering Apache security is beyond the scope of this Guide; please consult the Apache - documentation for details. - </PARA> - <PARA> - If you are using a web server that does not support the .htaccess control method, - <EMPHASIS>you are at risk!</EMPHASIS> After installing, check to see if you can - view the file "localconfig" in your web browser (ergo: - <ULINK URL="http://bugzilla.mozilla.org/localconfig"> - http://bugzilla.mozilla.org/localconfig</ULINK>. If you can read the contents of this - file, your web server has not secured your bugzilla directory properly and you - must fix this problem before deploying Bugzilla. If, however, it gives you a - "Forbidden" error, then it probably respects the .htaccess conventions and you - are good to go. - </PARA> - </NOTE> - <PARA> - On Apache, you can use .htaccess files to protect access to these directories, as outlined - in <ULINK URL="http://bugzilla.mozilla.org/show_bug.cgi?id=57161">Bug 57161</ULINK> for the - localconfig file, and <ULINK URL="http://bugzilla.mozilla.org/show_bug.cgi?id=65572"> - Bug 65572</ULINK> for adequate protection in your data/ and shadow/ directories. - </PARA> - <PARA> - Note the instructions which follow are Apache-specific. If you use IIS, Netscape, or other - non-Apache web servers, please consult your system documentation for how to secure these - files from being transmitted to curious users. - </PARA> - <PARA> - Place the following text into a file named ".htaccess", readable by your web server, - in your $BUGZILLA_HOME/data directory. - <LITERALLAYOUT> - <Files comments> - allow from all - </Files> - deny from all - </LITERALLAYOUT> - </PARA> - <PARA> - Place the following text into a file named ".htaccess", readable by your web server, - in your $BUGZILLA_HOME/ directory. - <LITERALLAYOUT> - <Files localconfig> - deny from all - </Files> - allow from all - </LITERALLAYOUT> - </PARA> - <PARA> - Place the following text into a file named ".htaccess", readable by your web server, - in your $BUGZILLA_HOME/shadow directory. - <LITERALLAYOUT> - deny from all - </LITERALLAYOUT> - </PARA> - </LISTITEM> - </ORDEREDLIST> - </PARA> - </SECTION> -</CHAPTER> - - + </para> + </listitem> + <listitem> + <para> + Do not run Apache as <quote>nobody</quote>. This will + require very lax permissions in your Bugzilla directories. + Run it, instead, as a user with a name, set via your + httpd.conf file. + <note> + <para> + <quote>nobody</quote> is a real user on UNIX systems. + Having a process run as user id <quote>nobody</quote> + is absolutely no protection against system crackers + versus using any other user account. As a general + security measure, I recommend you create unique user + ID's for each daemon running on your system and, if + possible, use "chroot" to jail that process away from + the rest of your system. + </para> + </note> + </para> + </listitem> + <listitem> + <para> + Ensure you have adequate access controls for the + $BUGZILLA_HOME/data/ and $BUGZILLA_HOME/shadow/ + directories, as well as the $BUGZILLA_HOME/localconfig and + $BUGZILLA_HOME/globals.pl files. The localconfig file + stores your "bugs" user password, which would be terrible + to have in the hands of a criminal, while the "globals.pl" + stores some default information regarding your + installation which could aid a system cracker. In + addition, some files under $BUGZILLA_HOME/data/ store + sensitive information, and $BUGZILLA_HOME/shadow/ stores + bug information for faster retrieval. If you fail to + secure these directories and this file, you will expose + bug information to those who may not be allowed to see it. + </para> + <note> + <para> + Bugzilla provides default .htaccess files to protect the + most common Apache installations. However, you should + verify these are adequate according to the site-wide + security policy of your web server, and ensure that the + .htaccess files are allowed to "override" default + permissions set in your Apache configuration files. + Covering Apache security is beyond the scope of this + Guide; please consult the Apache documentation for + details. + </para> + <para> + If you are using a web server that does not support the + .htaccess control method, <emphasis>you are at + risk!</emphasis> After installing, check to see if + you can view the file "localconfig" in your web browser + (e.g.: <ulink url="http://bugzilla.mozilla.org/localconfig"> http://bugzilla.mozilla.org/localconfig</ulink>). If you can read the contents of this file, your web server has not secured your bugzilla directory properly and you must fix this problem before deploying Bugzilla. If, however, it gives you a "Forbidden" error, then it probably respects the .htaccess conventions and you are good to go. + </para> + </note> + <para> + On Apache, you can use .htaccess files to protect access + to these directories, as outlined in <ulink url="http://bugzilla.mozilla.org/show_bug.cgi?id=57161">Bug 57161</ulink> for the localconfig file, and <ulink url="http://bugzilla.mozilla.org/show_bug.cgi?id=65572"> Bug 65572</ulink> for adequate protection in your data/ and shadow/ directories. + </para> + <para> + Note the instructions which follow are Apache-specific. + If you use IIS, Netscape, or other non-Apache web servers, + please consult your system documentation for how to secure + these files from being transmitted to curious users. + </para> + <para> + Place the following text into a file named ".htaccess", + readable by your web server, in your $BUGZILLA_HOME/data + directory. <literallayout> <Files comments> allow + from all </Files> deny from all </literallayout> + </para> + <para> + Place the following text into a file named ".htaccess", + readable by your web server, in your $BUGZILLA_HOME/ + directory. <literallayout> <Files localconfig> deny + from all </Files> allow from all </literallayout> + </para> + <para> + Place the following text into a file named ".htaccess", + readable by your web server, in your $BUGZILLA_HOME/shadow + directory. <literallayout> deny from all </literallayout> + </para> + </listitem> + </orderedlist> + </para> + </section> +</chapter> <!-- Keep this comment at the end of the file Local variables: mode: sgml -sgml-omittag:t -sgml-shorttag:t -sgml-namecase-general:t -sgml-general-insert-case:upper -sgml-minimize-attributes:nil sgml-always-quote-attributes:t -sgml-indent-step:2 -sgml-indent-data:t -sgml-parent-document:nil +sgml-auto-insert-required-elements:t +sgml-balanced-tag-edit:t sgml-exposed-tags:nil +sgml-general-insert-case:lower +sgml-indent-data:t +sgml-indent-step:2 sgml-local-catalogs:nil sgml-local-ecat-files:nil +sgml-minimize-attributes:nil +sgml-namecase-general:t +sgml-omittag:t +sgml-parent-document:("Bugzilla-Guide.sgml" "book" "chapter") +sgml-shorttag:t +sgml-tag-region-if-active:t End: --> diff --git a/docs/xml/conventions.xml b/docs/xml/conventions.xml index 66f72303c..71f2b0c5e 100644 --- a/docs/xml/conventions.xml +++ b/docs/xml/conventions.xml @@ -89,23 +89,28 @@ </informaltable> </section> + + + + + <!-- Keep this comment at the end of the file Local variables: mode: sgml -sgml-omittag:t -sgml-shorttag:t -sgml-namecase-general:t -sgml-general-insert-case:upper -sgml-minimize-attributes:nil sgml-always-quote-attributes:t -sgml-indent-step:2 -sgml-indent-data:t -sgml-parent-document:nil +sgml-auto-insert-required-elements:t +sgml-balanced-tag-edit:t sgml-exposed-tags:nil +sgml-general-insert-case:lower +sgml-indent-data:t +sgml-indent-step:2 sgml-local-catalogs:nil sgml-local-ecat-files:nil +sgml-minimize-attributes:nil +sgml-namecase-general:t +sgml-omittag:t +sgml-parent-document:("Bugzilla-Guide.sgml" "book" "chapter") +sgml-shorttag:t +sgml-tag-region-if-active:t End: --> - - - diff --git a/docs/xml/database.xml b/docs/xml/database.xml index eced31c52..aee9b37e5 100644 --- a/docs/xml/database.xml +++ b/docs/xml/database.xml @@ -1,197 +1,153 @@ -<!DOCTYPE appendix PUBLIC "-//OASIS//DTD DocBook V4.1//EN"> - -<APPENDIX id="database"> - -<TITLE>The Bugzilla Database</TITLE> -<NOTE> -<PARA>This document really needs to be updated with more fleshed out information about primary keys, interrelationships, and maybe some nifty tables to document dependencies. Any takers?</PARA> -</NOTE> - <SECTION id="dbschema"> - <TITLE>Database Schema Chart</TITLE> - <PARA> - <MEDIAOBJECT> - <IMAGEOBJECT> - <IMAGEDATA FILEREF="dbschema.jpg" FORMAT="jpg"> - </IMAGEOBJECT> - - <TEXTOBJECT> - <PHRASE>Database Relationships</PHRASE> - </TEXTOBJECT> - - <CAPTION> - <PARA>Bugzilla database relationships chart</PARA> - </CAPTION> - </MEDIAOBJECT> - </PARA> - </SECTION> - - <SECTION id="dbdoc"> -<TITLE>MySQL Bugzilla Database Introduction</TITLE> -<LITERALLAYOUT> - -Contributor(s): Matthew P. Barnson (mbarnson@excitehome.net) - -Last update: May 16, 2000 - -Changes: -Version 1.0: Initial public release (May 16, 2000) - -Maintainer: Matthew P. Barnson (mbarnson@excitehome.net) - - -=== -Table Of Contents -=== - -FOREWORD -INTRODUCTION -THE BASICS -THE TABLES -THE DETAILS - - - -=== -FOREWORD -=== - - This information comes straight from my life. I was forced to learn how -Bugzilla organizes database because of nitpicky requests from users for tiny -changes in wording, rather than having people re-educate themselves or -figure out how to work our procedures around the tool. It sucks, but it can -and will happen to you, so learn how the schema works and deal with it when it -comes. - - I'm sorry this version is plain text. I can whip this info out a lot faster -if I'm not concerned about complex formatting. I'll get it into sgml for easy -portability as time permits. - - The Bugzilla Database Schema has a home! In addition to availability via CVS -and released versions 2.12 and higher of Bugzilla, you can find the latest & -greatest version of the Bugzilla Database Schema at -http://www.trilobyte.net/barnsons/. This is a living document; please be sure -you are up-to-date with the latest version before mirroring. - - The Bugzilla Database Schema is designed to provide vital information -regarding the structure of the MySQL database. Where appropriate, this -document will refer to URLs rather than including documents in their entirety -to ensure completeness even should this paper become out of date. - - This document is not maintained by Netscape or Netscape employees, so please -do not contact them regarding errors or omissions contained herein. Please -direct all questions, comments, updates, flames, etc. to Matthew P. Barnson -mbarnson@excitehome.net) (barnboy or barnhome on irc.mozilla.org in -#mozwebtools). - - I'm sure I've made some glaring errors or omissions in this paper -- please -email me corrections or post corrections to the -netscape.public.mozilla.webtools newsgroup. - - - -=== -INTRODUCTION -=== - - - - So, here you are with your brand-new installation of Bugzilla. You've got -MySQL set up, Apache working right, Perl DBI and DBD talking to the database -flawlessly. Maybe you've even entered a few test bugs to make sure email's -working; people seem to be notified of new bugs and changes, and you can -enter and edit bugs to your heart's content. Perhaps you've gone through the -trouble of setting up a gateway for people to submit bugs to your database via -email, have had a few people test it, and received rave reviews from your beta -testers. - - What's the next thing you do? Outline a training strategy for your -development team, of course, and bring them up to speed on the new tool you've -labored over for hours. - - Your first training session starts off very well! You have a captive -audience which seems enraptured by the efficiency embodied in this thing called -"Bugzilla". You are caught up describing the nifty features, how people can -save favorite queries in the database, set them up as headers and footers on -their pages, customize their layouts, generate reports, track status with -greater efficiency than ever before, leap tall buildings with a single bound -and rescue Jane from the clutches of Certain Death! - - But Certain Death speaks up -- a tiny voice, from the dark corners of the -conference room. "I have a concern," the voice hisses from the darkness, -"about the use of the word 'verified'. - - The room, previously filled with happy chatter, lapses into reverential -silence as Certain Death (better known as the Vice President of Software -Engineering) continues. "You see, for two years we've used the word 'verified' -to indicate that a developer or quality assurance engineer has confirmed that, -in fact, a bug is valid. I don't want to lose two years of training to a -new software product. You need to change the bug status of 'verified' to -'approved' as soon as possible. To avoid confusion, of course." - - Oh no! Terror strikes your heart, as you find yourself mumbling "yes, yes, I -don't think that would be a problem," You review the changes with Certain -Death, and continue to jabber on, "no, it's not too big a change. I mean, we -have the source code, right? You know, 'Use the Source, Luke' and all that... -no problem," All the while you quiver inside like a beached jellyfish bubbling, -burbling, and boiling on a hot Jamaican sand dune... - - Thus begins your adventure into the heart of Bugzilla. You've been forced -to learn about non-portable enum() fields, varchar columns, and tinyint -definitions. The Adventure Awaits You! - - - -=== -The Basics -=== - - If you were like me, at this point you're totally clueless about the -internals of MySQL, and if it weren't for this executive order from the Vice -President you couldn't care less about the difference between a "bigint" and a -"tinyint" entry in MySQL. I'd refer you first to the MySQL documentation, -available at http://www.mysql.com/doc.html, but that's mostly a confusing -morass of high-level database jargon. Here are the basics you need to know -about the database to proceed: - -1. To connect to your database, type "mysql -u root" at the command prompt as -any user. If this works without asking you for a password, SHAME ON YOU! You -should have locked your security down like the README told you to. You can -find details on locking down your database in the Bugzilla FAQ in this -directory (under "Security"), or more robust security generalities in the -MySQL searchable documentation at -http://www.mysql.com/php/manual.php3?section=Privilege_system . - -2. You should now be at a prompt that looks like this: - -mysql> - - At the prompt, if "bugs" is the name of your Bugzilla database, type: - -mysql> use bugs; +<!-- <!DOCTYPE appendix PUBLIC "-//OASIS//DTD DocBook V4.1//EN"> --> + +<appendix id="database"> + +<title>The Bugzilla Database</title> +<note> +<para> + This document really needs to be updated with more fleshed out information about primary keys, interrelationships, and maybe some nifty tables to document dependencies. Any takers? + </para> + </note> + <section id="dbschema"> + <title>Database Schema Chart</title> + <para> + <mediaobject> + <imageobject> + <imagedata fileref="dbschema.jpg" format="jpg"> + </imageobject> - (don't forget the ";" at the end of each line, or you'll be kicking yourself -all the way through this documentation) - Young Grasshopper, you are now ready for the unveiling of the Bugzilla -database, in the next section... - - - -=== -THE TABLES -=== - - Imagine your MySQL database as a series of spreadsheets, and you won't be too -far off. If you use this command: - -mysql> show tables from bugs; - - you'll be able to see all the "spreadsheets" (tables) in your database. Cool, -huh? It's kinda' like a filesystem, only much faster and more robust. Come -on, I'll show you more! - - From the command issued above, you should now have some output that looks -like this: - + <textobject> + <phrase>Database Relationships</phrase> + </textobject> + + <caption> + <para>Bugzilla database relationships chart</para> + </caption> + </mediaobject> + </para> + </section> + + <section id="dbdoc"> +<title>MySQL Bugzilla Database Introduction</title> + <para> + This information comes straight from my life. I was forced to learn how + Bugzilla organizes database because of nitpicky requests from users for tiny + changes in wording, rather than having people re-educate themselves or + figure out how to work our procedures around the tool. It sucks, but it can + and will happen to you, so learn how the schema works and deal with it when it + comes. + </para> + + <para> + So, here you are with your brand-new installation of Bugzilla. You've got + MySQL set up, Apache working right, Perl DBI and DBD talking to the database + flawlessly. Maybe you've even entered a few test bugs to make sure email's + working; people seem to be notified of new bugs and changes, and you can + enter and edit bugs to your heart's content. Perhaps you've gone through the + trouble of setting up a gateway for people to submit bugs to your database via + email, have had a few people test it, and received rave reviews from your beta + testers. + </para> + <para> + What's the next thing you do? Outline a training strategy for your + development team, of course, and bring them up to speed on the new tool you've + labored over for hours. + </para> + <para> + Your first training session starts off very well! You have a captive + audience which seems enraptured by the efficiency embodied in this thing called + "Bugzilla". You are caught up describing the nifty features, how people can + save favorite queries in the database, set them up as headers and footers on + their pages, customize their layouts, generate reports, track status with + greater efficiency than ever before, leap tall buildings with a single bound + and rescue Jane from the clutches of Certain Death! + </para> + <para> + But Certain Death speaks up -- a tiny voice, from the dark corners of the + conference room. "I have a concern," the voice hisses from the darkness, + "about the use of the word 'verified'. + </para> + <para> + The room, previously filled with happy chatter, lapses into reverential + silence as Certain Death (better known as the Vice President of Software + Engineering) continues. "You see, for two years we've used the word 'verified' + to indicate that a developer or quality assurance engineer has confirmed that, + in fact, a bug is valid. I don't want to lose two years of training to a + new software product. You need to change the bug status of 'verified' to + 'approved' as soon as possible. To avoid confusion, of course." + </para> + <para> + Oh no! Terror strikes your heart, as you find yourself mumbling "yes, yes, I + don't think that would be a problem," You review the changes with Certain + Death, and continue to jabber on, "no, it's not too big a change. I mean, we + have the source code, right? You know, 'Use the Source, Luke' and all that... + no problem," All the while you quiver inside like a beached jellyfish bubbling, + burbling, and boiling on a hot Jamaican sand dune... + </para> + <para> + Thus begins your adventure into the heart of Bugzilla. You've been forced + to learn about non-portable enum() fields, varchar columns, and tinyint + definitions. The Adventure Awaits You! + </para> + + <section> + <title>Bugzilla Database Basics</title> + <para> + If you were like me, at this point you're totally clueless + about the internals of MySQL, and if it weren't for this + executive order from the Vice President you couldn't care less + about the difference between a <quote>bigint</quote> and a + <quote>tinyint</quote> entry in MySQL. I recommend you refer + to the MySQL documentation, available at <ulink url="http://www.mysql.com/doc.html">MySQL.com</ulink>. Below are the basics you need to know about the Bugzilla database. Check the chart above for more details. + </para> + <para><orderedlist> + <listitem> + <para> + To connect to your database: + </para> + <para> + <prompt>bash#</prompt><command>mysql</command><parameter>-u root</parameter> + </para> + <para> + If this works without asking you for a password, + <emphasis>shame on you</emphasis>! You should have + locked your security down like the installation + instructions told you to. You can find details on + locking down your database in the Bugzilla FAQ in this + directory (under "Security"), or more robust security + generalities in the MySQL searchable documentation at + http://www.mysql.com/php/manual.php3?section=Privilege_system . + </para> + </listitem> + + <listitem> + <para>You should now be at a prompt that looks like + this:</para> + <para><prompt>mysql></prompt></para> + <para>At the prompt, if <quote>bugs</quote> is the name + you chose in the<filename>localconfig</filename> file + for your Bugzilla database, type:</para> + <para><prompt>mysql</prompt><command>use bugs;</command></para> + <note> + <para>Don't forget the <quote>;</quote> at the end of + each line, or you'll be kicking yourself later.</para> + </note> + </listitem> + </orderedlist> + </para> + <section> + <title>Bugzilla Database Tables</title> + <para> Imagine your MySQL database as a series of + spreadsheets, and you won't be too far off. If you use this + command:</para> + <para><prompt>mysql></prompt><command>show tables from bugs;</command></para> + <para>you'll be able to see all the + <quote>spreadsheets</quote> (tables) in your database. It + is similar to a file system, only faster and more robust for + certain types of operations.</para> + <para>From the command issued above, ou should have some + output that looks like this: + <programlisting> +-------------------+ | Tables in bugs | +-------------------+ @@ -213,14 +169,13 @@ like this: | profiles | | profiles_activity | | shadowlog | +| tokens | | versions | | votes | | watch | +-------------------+ - - - If it doesn't look quite the same, that probably means it's time to -update this documentation :) + </programlisting></para> +<literallayout> Here's an overview of what each table does. Most columns in each table have descriptive names that make it fairly trivial to figure out their jobs. @@ -398,23 +353,36 @@ LINKS Great MySQL tutorial site: http://www.devshed.com/Server_Side/MySQL/ - </LITERALLAYOUT> - </SECTION> - - <SECTION id="granttables"> - <TITLE>MySQL Permissions & Grant Tables</TITLE> - - <NOTE> - <PARA>The following portion of documentation comes from my answer to an old discussion of Keystone, - a cool product that does trouble-ticket tracking for IT departments. I wrote this post to the - Keystone support group regarding MySQL grant table permissions, and how to use them effectively. - It is badly in need of updating, as I believe MySQL has added a field or two to the grant tables - since this time, but it serves as a decent introduction and troubleshooting document for grant - table issues. I used Keynote to track my troubles until I discovered Bugzilla, - which gave me a whole new set of troubles to work on : )</PARA> - </NOTE> - - <LITERALLAYOUT> + </literallayout> + </section> + </section> + </section> + + <section id="granttables"> + <title>MySQL Permissions & Grant Tables</title> + + <note> + <para>The following portion of documentation comes from my + answer to an old discussion of Keystone, a cool product that + does trouble-ticket tracking for IT departments. I wrote this + post to the Keystone support group regarding MySQL grant + table permissions, and how to use them effectively. It is + badly in need of updating, as I believe MySQL has added a + field or two to the grant tables since this time, but it + serves as a decent introduction and troubleshooting document + for grant table issues. I used Keynote to track my troubles + until I discovered Bugzilla, which gave me a whole new set of + troubles to work on : ) Although it is of limited use, it + still has SOME use, thus it's still included.</para> + <para> + Please note, however, that I was a relatively new user to + MySQL at the time. Some of my suggestions, particularly in + how to set up security, showed a terrible lack of + security-related database experience. + </para> + </note> + + <literallayout> From matt_barnson@singletrac.com Wed Jul 7 09:00:07 1999 Date: Mon, 1 Mar 1999 21:37:04 -0700 From: Matthew Barnson matt_barnson@singletrac.com @@ -577,59 +545,28 @@ Once again, you can't go wrong by reading section 6 of the MySQL manual. It is more detailed than I! http://www.mysql.com/Manual/manual.html. ----------------------------------------------------------------------------- -10/12/2000 -Matthew sent in some mail with updated contact information: -NEW CONTACT INFORMATION: - - ------------------------ - Matthew P. Barnson - Manager, Systems Administration - Excite@Home Business Applications - mbarnson@excitehome.net - (801)234-8300 - - - </LITERALLAYOUT> - </SECTION> - <SECTION id="cleanupwork"> - <TITLE>Cleaning up after mucking with Bugzilla</TITLE> - <LITERALLAYOUT> -Contributed by Eric Hanson: -There are several things, and one trick. There is a small tiny piece of -documentation I saw once that said something very important. -1) After pretty much any manual working of the Mysql db, you must -delete a file in the bugzilla directory: data/versioncache -Versioncache basically is a way to speed up bugzilla (from what I -understand). It stores a lot of commonly used information. However, -this file is refreshed every so often (I can't remember the time -interval though). So eventually all changes do propogate out, so you -may see stuff suddenly working. -2) Assuming that failed, you will also have to check something with the -checksetup.pl file. It actually is run twice. The first time it -creates the file: localconfig. You can modify localconfig, (or not if -you are doing bug_status stuff) or you should delete localconfig and -rerun your modified checksetup.pl. Since I don't actually see anything -in localconfig pertaining to bug_status, this point is mainly a FYI. - </LITERALLAYOUT> - </SECTION> - -</APPENDIX> + </literallayout> + </section> + +</appendix> <!-- Keep this comment at the end of the file Local variables: mode: sgml -sgml-omittag:t -sgml-shorttag:t -sgml-namecase-general:t -sgml-general-insert-case:upper -sgml-minimize-attributes:nil sgml-always-quote-attributes:t -sgml-indent-step:2 -sgml-indent-data:t -sgml-parent-document:nil +sgml-auto-insert-required-elements:t +sgml-balanced-tag-edit:t sgml-exposed-tags:nil +sgml-general-insert-case:lower +sgml-indent-data:t +sgml-indent-step:2 sgml-local-catalogs:nil sgml-local-ecat-files:nil +sgml-minimize-attributes:nil +sgml-namecase-general:t +sgml-omittag:t +sgml-parent-document:("Bugzilla-Guide.sgml" "book" "chapter") +sgml-shorttag:t +sgml-tag-region-if-active:t End: --> diff --git a/docs/xml/dbschema.mysql b/docs/xml/dbschema.mysql new file mode 100644 index 000000000..c75c4caa4 --- /dev/null +++ b/docs/xml/dbschema.mysql @@ -0,0 +1,309 @@ +# MySQL dump 7.1 +# +# Host: localhost Database: bugs +#-------------------------------------------------------- +# Server version 3.22.32 + +# +# Table structure for table 'attachments' +# +CREATE TABLE attachments ( + attach_id mediumint(9) DEFAULT '0' NOT NULL auto_increment, + bug_id mediumint(9) DEFAULT '0' NOT NULL, + creation_ts timestamp(14), + description mediumtext NOT NULL, + mimetype mediumtext NOT NULL, + ispatch tinyint(4), + filename mediumtext NOT NULL, + thedata longblob NOT NULL, + submitter_id mediumint(9) DEFAULT '0' NOT NULL, + PRIMARY KEY (attach_id) +); +create index index_41 on attachments (bug_id); +create index index_42 on attachments (creation_ts); + +# +# Table structure for table 'bugs' +# +CREATE TABLE bugs ( + bug_id mediumint(9) DEFAULT '0' NOT NULL auto_increment, + groupset bigint(20) DEFAULT '0' NOT NULL, + assigned_to mediumint(9) DEFAULT '0' NOT NULL, + bug_file_loc text, + bug_severity enum DEFAULT 'blocker' NOT NULL, + bug_status enum DEFAULT 'UNCONFIRMED' NOT NULL, + creation_ts datetime DEFAULT '0000-00-00 00:00:00' NOT NULL, + delta_ts timestamp(14), + short_desc mediumtext, + op_sys enum DEFAULT 'All' NOT NULL, + priority enum DEFAULT 'P1' NOT NULL, + product varchar(64) DEFAULT '' NOT NULL, + rep_platform enum, + reporter mediumint(9) DEFAULT '0' NOT NULL, + version varchar(16) DEFAULT '' NOT NULL, + component varchar(50) DEFAULT '' NOT NULL, + resolution enum DEFAULT '' NOT NULL, + target_milestone varchar(20) DEFAULT '---' NOT NULL, + qa_contact mediumint(9) DEFAULT '0' NOT NULL, + status_whiteboard mediumtext NOT NULL, + votes mediumint(9) DEFAULT '0' NOT NULL, + keywords mediumtext NOT NULL, + lastdiffed datetime DEFAULT '0000-00-00 00:00:00' NOT NULL, + everconfirmed tinyint(4) DEFAULT '0' NOT NULL, + PRIMARY KEY (bug_id) +); +create index index_7 on bugs (assigned_to); +create index index_8 on bugs (creation_ts); +create index index_9 on bugs (delta_ts); +create index index_10 on bugs (bug_severity); +create index index_11 on bugs (bug_status); +create index index_12 on bugs (op_sys); +create index index_13 on bugs (priority); +create index index_14 on bugs (product); +create index index_15 on bugs (reporter); +create index index_16 on bugs (version); +create index index_17 on bugs (component); +create index index_18 on bugs (resolution); +create index index_19 on bugs (target_milestone); +create index index_20 on bugs (qa_contact); +create index index_21 on bugs (votes); + +# +# Table structure for table 'bugs_activity' +# +CREATE TABLE bugs_activity ( + bug_id mediumint(9) DEFAULT '0' NOT NULL, + who mediumint(9) DEFAULT '0' NOT NULL, + bug_when datetime DEFAULT '0000-00-00 00:00:00' NOT NULL, + fieldid mediumint(9) DEFAULT '0' NOT NULL, + oldvalue tinytext, + newvalue tinytext +); +create index index_43 on bugs_activity (bug_id); +create index index_44 on bugs_activity (bug_when); +create index index_45 on bugs_activity (fieldid); + +# +# Table structure for table 'cc' +# +CREATE TABLE cc ( + bug_id mediumint(9) DEFAULT '0' NOT NULL, + who mediumint(9) DEFAULT '0' NOT NULL +); +create index index_31 on cc (who); +create unique index index_32 on cc (bug_id,who); + +# +# Table structure for table 'components' +# +CREATE TABLE components ( + value tinytext, + program varchar(64), + initialowner tinytext NOT NULL, + initialqacontact tinytext NOT NULL, + description mediumtext NOT NULL +); + +# +# Table structure for table 'dependencies' +# +CREATE TABLE dependencies ( + blocked mediumint(9) DEFAULT '0' NOT NULL, + dependson mediumint(9) DEFAULT '0' NOT NULL +); +create index index_34 on dependencies (blocked); +create index index_35 on dependencies (dependson); + +# +# Table structure for table 'duplicates' +# +CREATE TABLE duplicates ( + dupe_of mediumint(9) DEFAULT '0' NOT NULL, + dupe mediumint(9) DEFAULT '0' NOT NULL, + PRIMARY KEY (dupe) +); + +# +# Table structure for table 'fielddefs' +# +CREATE TABLE fielddefs ( + fieldid mediumint(9) DEFAULT '0' NOT NULL auto_increment, + name varchar(64) DEFAULT '' NOT NULL, + description mediumtext NOT NULL, + mailhead tinyint(4) DEFAULT '0' NOT NULL, + sortkey smallint(6) DEFAULT '0' NOT NULL, + PRIMARY KEY (fieldid) +); +create unique index index_28 on fielddefs (name); +create index index_29 on fielddefs (sortkey); + +# +# Table structure for table 'groups' +# +CREATE TABLE groups ( + bit bigint(20) DEFAULT '0' NOT NULL, + name varchar(255) DEFAULT '' NOT NULL, + description text NOT NULL, + isbuggroup tinyint(4) DEFAULT '0' NOT NULL, + userregexp tinytext NOT NULL +); +create unique index index_3 on groups (bit); +create unique index index_4 on groups (name); + +# +# Table structure for table 'keyworddefs' +# +CREATE TABLE keyworddefs ( + id smallint(6) DEFAULT '0' NOT NULL, + name varchar(64) DEFAULT '' NOT NULL, + description mediumtext, + PRIMARY KEY (id) +); +create unique index index_33 on keyworddefs (name); + +# +# Table structure for table 'keywords' +# +CREATE TABLE keywords ( + bug_id mediumint(9) DEFAULT '0' NOT NULL, + keywordid smallint(6) DEFAULT '0' NOT NULL +); +create index index_39 on keywords (keywordid); +create unique index index_40 on keywords (bug_id, keywordid); + +# +# Table structure for table 'logincookies' +# +CREATE TABLE logincookies ( + cookie mediumint(9) DEFAULT '0' NOT NULL auto_increment, + userid mediumint(9) DEFAULT '0' NOT NULL, + cryptpassword varchar(64), + hostname varchar(128), + lastused timestamp(14), + PRIMARY KEY (cookie) +); +create index index_30 on logincookies (lastused); + +# +# Table structure for table 'longdescs' +# +CREATE TABLE longdescs ( + bug_id mediumint(9) DEFAULT '0' NOT NULL, + who mediumint(9) DEFAULT '0' NOT NULL, + bug_when datetime DEFAULT '0000-00-00 00:00:00' NOT NULL, + thetext mediumtext +); +create index index_22 on longdescs (bug_id); +create index index_23 on longdescs (bug_when); + +# +# Table structure for table 'milestones' +# +CREATE TABLE milestones ( + value varchar(20) DEFAULT '' NOT NULL, + product varchar(64) DEFAULT '' NOT NULL, + sortkey smallint(6) DEFAULT '0' NOT NULL, +); +create unique index index_24 on milestones (product, value); + +# +# Table structure for table 'namedqueries' +# +CREATE TABLE namedqueries ( + userid mediumint(9) DEFAULT '0' NOT NULL, + name varchar(64) DEFAULT '' NOT NULL, + watchfordiffs tinyint(4) DEFAULT '0' NOT NULL, + linkinfooter tinyint(4) DEFAULT '0' NOT NULL, + query mediumtext NOT NULL +); +create unique index index_25 on namedqueries (userid, name); +create index index_26 on namedqueries (watchfordiffs); + +# +# Table structure for table 'products' +# +CREATE TABLE products ( + product varchar(64), + description mediumtext, + milestoneurl tinytext NOT NULL, + disallownew tinyint(4) DEFAULT '0' NOT NULL, + votesperuser smallint(6) DEFAULT '0' NOT NULL, + maxvotesperbug smallint(6) DEFAULT '10000' NOT NULL, + votestoconfirm smallint(6) DEFAULT '0' NOT NULL, + defaultmilestone varchar(20) DEFAULT '---' NOT NULL +); + +# +# Table structure for table 'profiles' +# +CREATE TABLE profiles ( + userid mediumint(9) DEFAULT '0' NOT NULL auto_increment, + login_name varchar(255) DEFAULT '' NOT NULL, + password varchar(16), + cryptpassword varchar(64), + realname varchar(255), + groupset bigint(20) DEFAULT '0' NOT NULL, + emailnotification enum DEFAULT 'ExcludeSelfChanges' NOT NULL, + disabledtext mediumtext NOT NULL, + newemailtech tinyint(4) DEFAULT '0' NOT NULL, + mybugslink tinyint(4) DEFAULT '1' NOT NULL, + blessgroupset bigint(20) DEFAULT '0' NOT NULL, + PRIMARY KEY (userid) +); +create unique index index_27 on profiles (login_name); + +# +# Table structure for table 'profiles_activity' +# +CREATE TABLE profiles_activity ( + userid mediumint(9) DEFAULT '0' NOT NULL, + who mediumint(9) DEFAULT '0' NOT NULL, + profiles_when datetime DEFAULT '0000-00-00 00:00:00' NOT NULL, + fieldid mediumint(9) DEFAULT '0' NOT NULL, + oldvalue tinytext, + newvalue tinytext +); +create index index_0 on profiles_activity (userid); +create index index_1 on profiles_activity (profiles_when); +create index index_2 on profiles_activity (fieldid); + +# +# Table structure for table 'shadowlog' +# +CREATE TABLE shadowlog ( + id int(11) DEFAULT '0' NOT NULL auto_increment, + ts timestamp(14), + reflected tinyint(4) DEFAULT '0' NOT NULL, + command mediumtext NOT NULL, + PRIMARY KEY (id) +); +create index index_38 on shadowlog (reflected); + +# +# Table structure for table 'versions' +# +CREATE TABLE versions ( + value tinytext, + program varchar(64) DEFAULT '' NOT NULL +); + +# +# Table structure for table 'votes' +# +CREATE TABLE votes ( + who mediumint(9) DEFAULT '0' NOT NULL, + bug_id mediumint(9) DEFAULT '0' NOT NULL, + count smallint(6) DEFAULT '0' NOT NULL +); +create index index_5 on votes (who); +create index index_6 on votes (bug_id); + +# +# Table structure for table 'watch' +# +CREATE TABLE watch ( + watcher mediumint(9) DEFAULT '0' NOT NULL, + watched mediumint(9) DEFAULT '0' NOT NULL +); +create index index_36 on watch (watched); +create unique index index_37 on watch (watcher, watched); diff --git a/docs/xml/faq.xml b/docs/xml/faq.xml index 2b67890a9..f01b43053 100644 --- a/docs/xml/faq.xml +++ b/docs/xml/faq.xml @@ -1,6 +1,6 @@ -<!DOCTYPE appendix PUBLIC "-//OASIS//DTD DocBook V4.1//EN"> +<!-- <!DOCTYPE appendix PUBLIC "-//OASIS//DTD DocBook V4.1//EN"> --> -<appendix id="faq"> +<appendix id="faq" xreflabel="The Bugzilla FAQ"> <title>The Bugzilla FAQ</title> <qandaset> @@ -17,8 +17,8 @@ <answer> <para> You can stay up-to-date with the latest Bugzilla - information at <ulink url="http://www.mozilla.org/projects/bugzilla/"> - http://www.mozilla.org/projects/bugzilla/</ulink> + information at <ulink + url="http://www.mozilla.org/projects/bugzilla/"> http://www.mozilla.org/projects/bugzilla/</ulink> </para> </answer> </qandaentry> @@ -31,9 +31,9 @@ </question> <answer> <para> - Bugzilla is covered by the Mozilla Public License. - See details at <ulink url="http://www.mozilla.org/MPL/"> - http://www.mozilla.org/MPL/</ulink> + Bugzilla is covered by the Mozilla Public License. See + details at <ulink url="http://www.mozilla.org/MPL/"> + http://www.mozilla.org/MPL/</ulink> </para> </answer> </qandaentry> @@ -46,16 +46,17 @@ </question> <answer> <para> - <ulink url="http://www.collab.net/">www.collab.net</ulink> offers - Bugzilla as part of their standard offering to large projects. - They do have some minimum fees that are pretty hefty, and generally - aren't interested in small projects. + <ulink url="http://www.collab.net/">www.collab.net</ulink> + offers Bugzilla as part of their standard offering to + large projects. They do have some minimum fees that are + pretty hefty, and generally aren't interested in small + projects. </para> <para> - There are several experienced - Bugzilla hackers on the mailing list/newsgroup who are willing - to whore themselves out for generous compensation. - Try sending a message to the mailing list asking for a volunteer. + There are several experienced Bugzilla hackers on the + mailing list/newsgroup who are willing to whore themselves + out for generous compensation. Try sending a message to + the mailing list asking for a volunteer. </para> </answer> </qandaentry> @@ -63,14 +64,15 @@ <qandaentry> <question> <para> - What major companies or projects are currently using Bugzilla - for bug-tracking? + What major companies or projects are currently using + Bugzilla for bug-tracking? </para> </question> <answer> <para> - There are <emphasis>dozens</emphasis> of major comapanies with public - Bugzilla sites to track bugs in their products. A few include: + There are <emphasis>dozens</emphasis> of major comapanies + with public Bugzilla sites to track bugs in their + products. A few include: <simplelist> <member>Netscape/AOL</member> <member>Mozilla.org</member> @@ -92,8 +94,9 @@ </simplelist> </para> <para> - Suffice to say, there are more than enough huge projects using Bugzilla - that we can safely say it's extremely popular. + Suffice to say, there are more than enough huge projects + using Bugzilla that we can safely say it's extremely + popular. </para> </answer> </qandaentry> @@ -106,13 +109,16 @@ </question> <answer> <para> - There are many, many contributors from around the world maintaining Bugzilla. - The designated "Maintainer" is Tara Hernandez, with QA support by Matthew Tuck. - Dan Mosedale and Dawn Endico are employees of Mozilla.org responsible for the - installation of Bugzilla there, and are very frequent code contributors. - Terry Weissman originally ported Bugzilla, but "these days, Terry just hangs around - and heckles." The rest of us are mostly transient developers; Bugzilla suits - our needs, and we contribute code as we have needs for updates. + There are many, many contributors from around the world + maintaining Bugzilla. The designated "Maintainer" is Tara + Hernandez, with QA support by Matthew Tuck. Dan Mosedale + and Dawn Endico are employees of Mozilla.org responsible + for the installation of Bugzilla there, and are very + frequent code contributors. Terry Weissman originally + ported Bugzilla, but "these days, Terry just hangs around + and heckles." The rest of us are mostly transient + developers; Bugzilla suits our needs, and we contribute + code as we have needs for updates. </para> </answer> </qandaentry> @@ -120,23 +126,28 @@ <qandaentry> <question> <para> - How does Bugzilla stack up against other bug-tracking databases? + How does Bugzilla stack up against other bug-tracking + databases? </para> </question> <answer> <para> - A year has gone by, and I <emphasis>still</emphasis> can't find any head-to-head - comparisons of Bugzilla against other defect-tracking software. However, from my - personal experience with other bug-trackers, Bugzilla offers - superior performance on commodity hardware, better price (free!), more developer- - friendly features (such as stored queries, email integration, and platform - independence), improved scalability, open source code, greater flexibility, - and superior ease-of-use. + A year has gone by, and I <emphasis>still</emphasis> can't + find any head-to-head comparisons of Bugzilla against + other defect-tracking software. However, from my personal + experience with other bug-trackers, Bugzilla offers + superior performance on commodity hardware, better price + (free!), more developer- friendly features (such as stored + queries, email integration, and platform independence), + improved scalability, open source code, greater + flexibility, and superior ease-of-use. </para> <para> - If you happen to be a commercial Bugzilla vendor, please step forward with a rebuttal - so I can include it in the FAQ. We're not in pursuit of Bugzilla ueber alles; - we simply love having a powerful, open-source tool to get our jobs done. + If you happen to be a commercial Bugzilla vendor, please + step forward with a rebuttal so I can include it in the + FAQ. We're not in pursuit of Bugzilla ueber alles; we + simply love having a powerful, open-source tool to get our + jobs done. </para> </answer> </qandaentry> @@ -149,8 +160,9 @@ </question> <answer> <para> - You can't. However, the administrative account can, by simply opening - your user account in editusers.cgi and changing the login name. + You can't. However, the administrative account can, by + simply opening your user account in editusers.cgi and + changing the login name. </para> </answer> </qandaentry> @@ -158,24 +170,26 @@ <qandaentry> <question> <para> - Why doesn't Bugzilla offer this or that feature or compatability - with this other tracking software? + Why doesn't Bugzilla offer this or that feature or + compatability with this other tracking software? </para> </question> <answer> <para> - It may be that the support has not been built yet, or that you - have not yet found it. Bugzilla is making tremendous strides in - usability, customizability, scalability, and user interface. It - is widely considered the most complete and popular open-source - bug-tracking software in existence. + It may be that the support has not been built yet, or that + you have not yet found it. Bugzilla is making tremendous + strides in usability, customizability, scalability, and + user interface. It is widely considered the most complete + and popular open-source bug-tracking software in + existence. </para> <para> - That doesn't mean it can't use improvement! - You can help the project along by either hacking a patch yourself - that supports the functionality you require, or else submitting a - "Request for Enhancement" (RFE) using the bug submission interface - at <ulink url="http://bugzilla.mozilla.org/">bugzilla.mozilla.org</ulink>. + That doesn't mean it can't use improvement! You can help + the project along by either hacking a patch yourself that + supports the functionality you require, or else submitting + a "Request for Enhancement" (RFE) using the bug submission + interface at <ulink + url="http://bugzilla.mozilla.org/">bugzilla.mozilla.org</ulink>. </para> </answer> </qandaentry> @@ -191,37 +205,40 @@ <para>Terry Weissman answers, <blockquote> <para> - You're not the only one. But <emphasis>I</emphasis> am not very interested. I'm not - a real SQL or database person. I just wanted to make a useful tool, - and build it on top of free software. So, I picked MySQL, and - learned SQL by staring at the MySQL manual and some code lying - around here, and - wrote Bugzilla. I didn't know that Enum's were non-standard SQL. - I'm not sure if I would have cared, but I didn't even know. So, to - me, things are "portable" because it uses MySQL, and MySQL is - portable enough. I fully understand (now) that people want to be - portable to other databases, but that's never been a real concern - of mine. + You're not the only one. But <emphasis>I</emphasis> am + not very interested. I'm not a real SQL or database + person. I just wanted to make a useful tool, and build + it on top of free software. So, I picked MySQL, and + learned SQL by staring at the MySQL manual and some + code lying around here, and wrote Bugzilla. I didn't + know that Enum's were non-standard SQL. I'm not sure + if I would have cared, but I didn't even know. So, to + me, things are "portable" because it uses MySQL, and + MySQL is portable enough. I fully understand (now) + that people want to be portable to other databases, + but that's never been a real concern of mine. </para> </blockquote> </para> <para> - Things aren't quite that grim these days, however. Terry pretty much - sums up much of the thinking many of us have for Bugzilla, but there - is light on the horizon for database-independence! Here are some options: + Things aren't quite that grim these days, however. Terry + pretty much sums up much of the thinking many of us have + for Bugzilla, but there is light on the horizon for + database-independence! Here are some options: </para> <simplelist> <member> - <emphasis><ulink url="http://bugzilla.redhat.com/">Red Hat Bugzilla</ulink></emphasis>: - Runs a modified Bugzilla 2.8 atop an Oracle database. + <emphasis><ulink url="http://bugzilla.redhat.com/">Red + Hat Bugzilla</ulink></emphasis>: Runs a modified + Bugzilla 2.8 atop an Oracle database. </member> <member> - <emphasis><ulink url="http://sourceforge.net/projects/interzilla">Interzilla</ulink></emphasis>: - A project to run Bugzilla on Interbase. No code released yet, however. + <emphasis><ulink + url="http://sourceforge.net/projects/interzilla">Interzilla</ulink></emphasis>: A project to run Bugzilla on Interbase. No code released yet, however. </member> <member> - <emphasis>Bugzilla 3.0</emphasis>: One of the primary stated goals - is multiple database support. + <emphasis>Bugzilla 3.0</emphasis>: One of the primary + stated goals is multiple database support. </member> </simplelist> </answer> @@ -230,36 +247,40 @@ <qandaentry> <question> <para> - Why do the scripts say "/usr/bonsaitools/bin/perl" instead of - "/usr/bin/perl" or something else? + Why do the scripts say "/usr/bonsaitools/bin/perl" instead + of "/usr/bin/perl" or something else? </para> </question> <answer> <para> - Mozilla.org uses /usr/bonsaitools/bin/perl. The prime rule in making - submissions is "don't break bugzilla.mozilla.org". If it breaks it, your - patch will be reverted faster than you can do a diff. + Mozilla.org uses /usr/bonsaitools/bin/perl. The prime + rule in making submissions is "don't break + bugzilla.mozilla.org". If it breaks it, your patch will be + reverted faster than you can do a diff. </para> <para> - Here's Terry Weissman's comment, for some historical context: + Here's Terry Weissman's comment, for some historical + context: <blockquote> <para> - [This was] purely my own convention. I wanted a place to put a version of - Perl and other tools that was strictly under my control for the - various webtools, and not subject to anyone else. Edit it to point - to whatever you like. + [This was] purely my own convention. I wanted a place + to put a version of Perl and other tools that was + strictly under my control for the various webtools, + and not subject to anyone else. Edit it to point to + whatever you like. </para> <note> <para> - We always recommend that, if possible, you keep the path - as /usr/bonsaitools/bin/perl, and simply add a /usr/bonsaitools - and /usr/bonsaitools/bin directory, then symlink your version - of perl to /usr/bonsaitools/bin/perl. This will make upgrading + We always recommend that, if possible, you keep the + path as /usr/bonsaitools/bin/perl, and simply add a + /usr/bonsaitools and /usr/bonsaitools/bin directory, + then symlink your version of perl to + /usr/bonsaitools/bin/perl. This will make upgrading your Bugzilla much easier in the future. </para> <para> - Obviously, if you do not have root access to your Bugzilla - box, our suggestion is irrelevant. + Obviously, if you do not have root access to your + Bugzilla box, our suggestion is irrelevant. </para> </note> </blockquote> @@ -276,7 +297,8 @@ <note> <para> <emphasis>This section is no longer up-to-date.</emphasis> - Please see the section on "Red Hat Bugzilla" under "Variants" in The Bugzilla Guide. + Please see the section on "Red Hat Bugzilla" under + "Variants" in The Bugzilla Guide. </para> </note> </para> @@ -288,27 +310,29 @@ </question> <answer> <para> - Red Hat Bugzilla is arguably more user-friendly, customizable, and scalable - than stock Bugzilla. Check it out at - http://bugzilla.redhat.com and the sources at ftp://people.redhat.com/dkl/. - They've set their Bugzilla up to work with Oracle out of the box. - Note that Redhat Bugzilla is based upon the 2.8 Bugzilla tree; - Bugzilla has made some tremendous advances since the 2.8 release. - Why not download both Bugzillas to check out the differences for - yourself? + Red Hat Bugzilla is arguably more user-friendly, + customizable, and scalable than stock Bugzilla. Check it + out at http://bugzilla.redhat.com and the sources at + ftp://people.redhat.com/dkl/. They've set their Bugzilla + up to work with Oracle out of the box. Note that Redhat + Bugzilla is based upon the 2.8 Bugzilla tree; Bugzilla has + made some tremendous advances since the 2.8 release. Why + not download both Bugzillas to check out the differences + for yourself? </para> <para> - Dave Lawrence, the original Red Hat Bugzilla maintainer, mentions: + Dave Lawrence, the original Red Hat Bugzilla maintainer, + mentions: <blockquote> <para> - Somebody needs to take the ball and run with it. I'm the only - maintainer and am very pressed for time. + Somebody needs to take the ball and run with it. I'm + the only maintainer and am very pressed for time. </para> - </blockquote> - If you, or someone you know, has the time and expertise to do the integration - work so main-tree Bugzilla 2.12 and higher integrates the Red - Hat Bugzilla Oracle modifications, please donate your - time to supporting the Bugzilla project. + </blockquote> If you, or someone you know, has the time + and expertise to do the integration work so main-tree + Bugzilla 2.12 and higher integrates the Red Hat Bugzilla + Oracle modifications, please donate your time to + supporting the Bugzilla project. </para> </answer> </qandaentry> @@ -324,102 +348,123 @@ <emphasis>Dave Lawrence</emphasis>: <blockquote> <para> - For the record, we are not using any template type implementation for - the cosmetic changes maded to Bugzilla. It is just alot of html changes - in the code itself. I admit I may have gotten a little carried away with it - but the corporate types asked for a more standardized interface to match up - with other projects relating to Red Hat web sites. A lot of other web based - internal tools I am working on also look like Bugzilla. + For the record, we are not using any template type + implementation for the cosmetic changes maded to + Bugzilla. It is just alot of html changes in the code + itself. I admit I may have gotten a little carried + away with it but the corporate types asked for a more + standardized interface to match up with other projects + relating to Red Hat web sites. A lot of other web + based internal tools I am working on also look like + Bugzilla. </para> <para> - I do want to land the changes that I have made to Bugzilla but I may - have to back out a good deal and make a different version of Red Hat's - Bugzilla for checking in to CVS. Especially the cosmetic changes because it - seems they may not fit the general public. I will do that as soon as I can. - I also still do my regular QA responsibilities along with Bugzilla so time - is difficult sometimes to come by. + I do want to land the changes that I have made to + Bugzilla but I may have to back out a good deal and + make a different version of Red Hat's Bugzilla for + checking in to CVS. Especially the cosmetic changes + because it seems they may not fit the general public. + I will do that as soon as I can. I also still do my + regular QA responsibilities along with Bugzilla so + time is difficult sometimes to come by. </para> <para> - There are also a good deal of other changes that were requested by - management for things like support contracts and different permission - groups for making bugs private. Here is a short list of the major + There are also a good deal of other changes that were + requested by management for things like support + contracts and different permission groups for making + bugs private. Here is a short list of the major changes that have been made: </para> <orderedlist> <listitem> <para> - No enum types. All old enum types are now separate smaller tables. + No enum types. All old enum types are now separate + smaller tables. </para> </listitem> <listitem> <para> - No bit wise operations. Not all databases support this so they were - changed to a more generic way of doing this task + No bit wise operations. Not all databases support + this so they were changed to a more generic way of + doing this task </para> </listitem> <listitem> <para> - Bug reports can only be altered by the reporter, assignee, or a - privileged bugzilla user. The rest of the world can see the bug but in - a non-changeable format (unless the bug has been marked private). They - can however add comments, add and remove themselves from the CC list + Bug reports can only be altered by the reporter, + assignee, or a privileged bugzilla user. The rest + of the world can see the bug but in a + non-changeable format (unless the bug has been + marked private). They can however add comments, + add and remove themselves from the CC list </para> </listitem> <listitem> <para> - Different group scheme. Each group has an id number related to it. - There is a user_group table which contains userid to groupid mappings - to determine which groups each user belongs to. Additionally there is - a bug_group table that has bugid to groupid mappings to show which - groups can see a particular bug. If there are no entries for a bug in - this table then the bug is public. + Different group scheme. Each group has an id + number related to it. There is a user_group table + which contains userid to groupid mappings to + determine which groups each user belongs to. + Additionally there is a bug_group table that has + bugid to groupid mappings to show which groups can + see a particular bug. If there are no entries for + a bug in this table then the bug is public. </para> </listitem> <listitem> <para> - Product groups. product_table created to only allow certain products to - be visible for certain groups in both bug entry and query. This was + Product groups. product_table created to only + allow certain products to be visible for certain + groups in both bug entry and query. This was particulary helpful for support contracts. </para> </listitem> <listitem> <para> - Of course many (too many) changes to Bugzilla code itself to allow use - with Oracle and still allow operation with Mysql if so desired. - Currently if you use Mysql it is set to use Mysql's old permission - scheme to keep breakage to a minimum. Hopefully one day this will - standardize on one style which may of course be something completely + Of course many (too many) changes to Bugzilla code + itself to allow use with Oracle and still allow + operation with Mysql if so desired. Currently if + you use Mysql it is set to use Mysql's old + permission scheme to keep breakage to a minimum. + Hopefully one day this will standardize on one + style which may of course be something completely different. </para> </listitem> <listitem> <para> - Uses Text::Template perl module for rendering of the dynamic HTML pages - such as enter_bug.cgi, query.cgi, bug_form.pl, and for the header and - footer parts of the page. This allows the html to be separate from the - perl code for customizing the look and feel of the page to one's - preference. + Uses Text::Template perl module for rendering of + the dynamic HTML pages such as enter_bug.cgi, + query.cgi, bug_form.pl, and for the header and + footer parts of the page. This allows the html to + be separate from the perl code for customizing the + look and feel of the page to one's preference. </para> </listitem> <listitem> <para> - There are many other smaller changes. There is also a port to Oracle - that I have been working on as time permits but is not completely - finished but somewhat usable. I will merge it into our standard code - base when it becomes production quality. Unfortunately there will have - to be some conditionals in the code to make it work with other than - Oracle due to some differences between Oracle and Mysql. + There are many other smaller changes. There is + also a port to Oracle that I have been working on + as time permits but is not completely finished but + somewhat usable. I will merge it into our standard + code base when it becomes production quality. + Unfortunately there will have to be some + conditionals in the code to make it work with + other than Oracle due to some differences between + Oracle and Mysql. </para> </listitem> </orderedlist> <para> - Both the Mysql and Oracle versions of our current code base are - available from ftp://people.redhat.com/dkl. If Terry/Tara wants I can submit - patch files for all of the changes I have made and he can determine what is - suitable for addition to the main bugzilla cade base. But for me to commit - changes to the actual CVS I will need to back out alot of things that are - not suitable for the rest of the Bugzilla community. I am open to - suggestions. + Both the Mysql and Oracle versions of our current code + base are available from ftp://people.redhat.com/dkl. + If Terry/Tara wants I can submit patch files for all + of the changes I have made and he can determine what + is suitable for addition to the main bugzilla cade + base. But for me to commit changes to the actual CVS I + will need to back out alot of things that are not + suitable for the rest of the Bugzilla community. I am + open to suggestions. </para> </blockquote> </para> @@ -437,57 +482,66 @@ <note> <para> This information is somewhat dated; I last updated it - 7 June 2000. Please see the "Variants" section of "The Bugzilla Guide" - for more up-to-date information regarding Red Hat Bugzilla. + 7 June 2000. Please see the "Variants" section of + "The Bugzilla Guide" for more up-to-date information + regarding Red Hat Bugzilla. </para> - </note> - <emphasis>Dave Lawrence</emphasis>: + </note> <emphasis>Dave Lawrence</emphasis>: <blockquote> <para> - I suppose the current thread warrants an update on the status of - Oracle and bugzilla ;) We have now been running Bugzilla 2.8 on - Oracle for the last two days in our production environment. I - tried to do as much testing as possible with it before going live - which is some of the reason for the long delay. I did not get - enough feedback as I would have liked from internal developers to - help weed out any bugs still left so I said "Fine, i will take it - live and then I will get the feedback I want :)" So it is now - starting to stabilize and it running quite well after working - feverishly the last two days fixing problems as soon as they came - in from the outside world. The current branch in cvs is up2date if - anyone would like to grab it and try it out. The oracle _setup.pl - is broken right now due to some last minute changes but I will - update that soon. Therefore you would probably need to create the - database tables the old fashioned way using the supplied sql - creation scripts located in the ./oracle directory. We have heavy - optimizations in the database it self thanks to the in-house DBA - here at Red Hat so it is running quite fast. The database itself - is located on a dual PII450 with 1GB ram and 14 high voltage - differential raided scsi drives. The tables and indexes are - partitioned in 4 chuncks across the raided drive which is nice - because when ever you need to do a full table scan, it is actually - starting in 4 different locations on 4 different drives - simultaneously. And the indexes of course are on separate drives - from the data so that speeds things up tremendously. When I can - find the time I will document all that we have done to get this - thing going to help others that may need it. + I suppose the current thread warrants an update + on the status of Oracle and bugzilla ;) We have now + been running Bugzilla 2.8 on Oracle for the last two + days in our production environment. I tried to do as + much testing as possible with it before going live + which is some of the reason for the long delay. I did + not get enough feedback as I would have liked from + internal developers to help weed out any bugs still + left so I said "Fine, i will take it live and then I + will get the feedback I want :)" So it is now starting + to stabilize and it running quite well after working + feverishly the last two days fixing problems as soon + as they came in from the outside world. The current + branch in cvs is up2date if anyone would like to grab + it and try it out. The oracle _setup.pl is broken + right now due to some last minute changes but I will + update that soon. Therefore you would probably need to + create the database tables the old fashioned way using + the supplied sql creation scripts located in the + ./oracle directory. We have heavy optimizations in the + database it self thanks to the in-house DBA here at + Red Hat so it is running quite fast. The database + itself is located on a dual PII450 with 1GB ram and 14 + high voltage differential raided scsi drives. The + tables and indexes are partitioned in 4 chuncks across + the raided drive which is nice because when ever you + need to do a full table scan, it is actually starting + in 4 different locations on 4 different drives + simultaneously. And the indexes of course are on + separate drives from the data so that speeds things up + tremendously. When I can find the time I will + document all that we have done to get this thing going + to help others that may need it. </para> <para> - As Matt has mentioned it is still using out-dated code and with a - little help I would like to bring everything up to date for - eventual incorporation with the main cvs tree. Due to other - duties I have with the company any help with this wiould be - appreciated. What we are using now is what I call a best first - effort. It definitely can be improved on and may even need - complete rewrites in a lot of areas. A lot of changes may have to - be made in the way Bugzilla does things currently to make this - transition to a more generic database interface. Fortunately when - making the Oracle changes I made sure I didn't do anything that I - would consider Oracle specific and could not be easily done with - other databases. Alot of the sql statements need to be broken up - into smaller utilities that themselves would need to make - decisions on what database they are using but the majority of the - code can be made database neutral. + As Matt has mentioned it is still using out-dated code + and with a little help I would like to bring + everything up to date for eventual incorporation with + the main cvs tree. Due to other duties I have with the + company any help with this wiould be appreciated. What + we are using now is what I call a best first effort. + It definitely can be improved on and may even need + complete rewrites in a lot of areas. A lot of changes + may have to be made in the way Bugzilla does things + currently to make this transition to a more generic + database interface. Fortunately when making the + Oracle changes I made sure I didn't do anything that + I would consider Oracle specific and could not be + easily done with other databases. Alot of the sql + statements need to be broken up into smaller utilities + that themselves would need to make decisions on what + database they are using but the majority of the code + can be made database neutral. </para> </blockquote> </para> @@ -501,15 +555,15 @@ <para> <note> <para> - Loki's "Fenris" Bugzilla is based upon the (now ancient) Bugzilla 2.8 - tree, and is no longer actively maintained. + Loki's "Fenris" Bugzilla is based upon the (now ancient) + Bugzilla 2.8 tree, and is no longer actively maintained. It works well enough for Loki. Additionally, the major - differences in Fenris have now been integrated into - the main source tree of Bugzilla, so there's not much - reason to go grab the source. I leave this section of the - FAQ principally for historical interest, but unless Loki has further - input into Bugzilla's future, it will be deprecated in future versions - of the Guide. + differences in Fenris have now been integrated into the + main source tree of Bugzilla, so there's not much reason + to go grab the source. I leave this section of the FAQ + principally for historical interest, but unless Loki has + further input into Bugzilla's future, it will be + deprecated in future versions of the Guide. </para> </note> </para> @@ -522,22 +576,25 @@ </question> <answer> <para> - Loki Games has a customized version of Bugzilla available at - http://fenris.lokigames.com. From that page, + Loki Games has a customized version of Bugzilla available + at http://fenris.lokigames.com. From that page, <blockquote> <para> - You may have noticed that Fenris is a fork from Bugzilla-- our - patches weren't suitable for integration --and a few people have - expressed interest in the code. Fenris has one major improvement - over Bugzilla, and that is individual comments are not appended - onto a string blob, they are stored as a record in a separate - table. This allows you to, for instance, separate comments out - according to privilege levels in case your bug database could - contain sensitive information not for public eyes. We also provide - things like email hiding to protect user's privacy, additional - fields such as 'user_affected' in case someone enters someone - else's bug, comment editing and deletion, and more conditional - system variables than Bugzilla does (turn off attachments, + You may have noticed that Fenris is a fork from + Bugzilla-- our patches weren't suitable for + integration --and a few people have expressed interest + in the code. Fenris has one major improvement over + Bugzilla, and that is individual comments are not + appended onto a string blob, they are stored as a + record in a separate table. This allows you to, for + instance, separate comments out according to privilege + levels in case your bug database could contain + sensitive information not for public eyes. We also + provide things like email hiding to protect user's + privacy, additional fields such as 'user_affected' in + case someone enters someone else's bug, comment + editing and deletion, and more conditional system + variables than Bugzilla does (turn off attachments, qacontact, etc.). </para> </blockquote> @@ -553,9 +610,9 @@ </question> <answer> <para> - Raphael Barrerro <raistlin@lokigames.com>. - Michael Vance created the initial fork, but no longer - maintains the project. + Raphael Barrerro <raistlin@lokigames.com>. Michael + Vance created the initial fork, but no longer maintains + the project. </para> </answer> </qandaentry> @@ -574,8 +631,9 @@ <para> <note> <para> - The title of this section doesn't mean you're a PHB -- it just means - you probably HAVE a PHB who wants to know this :) + The title of this section doesn't mean you're a PHB -- it + just means you probably HAVE a PHB who wants to know this + :) </para> </note> </para> @@ -583,14 +641,15 @@ <qandaentry> <question> <para> - Is Bugzilla web-based or do you have to have specific software or - specific operating system on your machine? + Is Bugzilla web-based or do you have to have specific + software or specific operating system on your machine? </para> </question> <answer> <para> - It is web and e-mail based. You can edit bugs by sending specially - formatted email to a properly configured Bugzilla, or control via the web. + It is web and e-mail based. You can edit bugs by sending + specially formatted email to a properly configured + Bugzilla, or control via the web. </para> </answer> </qandaentry> @@ -598,17 +657,18 @@ <qandaentry> <question> <para> - Has anyone you know of already done any Bugzilla integration with - Perforce (SCM software)? + Has anyone you know of already done any Bugzilla + integration with Perforce (SCM software)? </para> </question> <answer> <para> - Yes! You can find more information elsewhere in "The Bugzilla - Guide" in the "Integration with Third-Party Products" section. - The section on Perforce isn't very large, but as the maintainer - of the Guide is charged with Perforce/Bugzilla integration by - his company, you can expect this section to grow. + Yes! You can find more information elsewhere in "The + Bugzilla Guide" in the "Integration with Third-Party + Products" section. The section on Perforce isn't very + large, but as the maintainer of the Guide is charged with + Perforce/Bugzilla integration by his company, you can + expect this section to grow. </para> </answer> </qandaentry> @@ -624,8 +684,8 @@ Absolutely! You can track up to a "soft-limit" of around 64 individual "Products", that can each be composed of as many "Components" as you want. Check the Administration - section of the Bugzilla Guide for more information regarding - setting up Products and Components. + section of the Bugzilla Guide for more information + regarding setting up Products and Components. </para> </answer> </qandaentry> @@ -633,8 +693,9 @@ <qandaentry> <question> <para> - 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? + 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? </para> </question> <answer> @@ -647,18 +708,20 @@ <qandaentry> <question> <para> - Does Bugzilla allow attachments (text, screenshots, urls etc)? If yes, - are there any that are NOT allowed? + Does Bugzilla allow attachments (text, screenshots, urls + etc)? If yes, are there any that are NOT allowed? </para> </question> <answer> <para> - Yes. There are many specific MIME-types that are pre-defined by Bugzilla, - but you may specify any arbitrary MIME-type you need when you - upload the file. Since all attachments are stored in the database, - however, I recommend storing large binary attachments elsewhere - in the web server's file system and providing a hyperlink - as a comment, or in the provided "URL" field in the bug report. + Yes. There are many specific MIME-types that are + pre-defined by Bugzilla, but you may specify any arbitrary + MIME-type you need when you upload the file. Since all + attachments are stored in the database, however, I + recommend storing large binary attachments elsewhere in + the web server's file system and providing a hyperlink as + a comment, or in the provided "URL" field in the bug + report. </para> </answer> </qandaentry> @@ -666,16 +729,17 @@ <qandaentry> <question> <para> - 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? + 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? </para> </question> <answer> <para> - Yes. However, modifying some fields, notably those related to bug - progression states, also require adjusting the program logic to - compensate for the change. + Yes. However, modifying some fields, notably those + related to bug progression states, also require adjusting + the program logic to compensate for the change. </para> </answer> </qandaentry> @@ -684,70 +748,65 @@ <qandaentry> <question> <para> - 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? + 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? </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. + 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. +> 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> </answer> </qandaentry> <qandaentry> <question> <para> - Does Bugzilla provide any reporting features, metrics, graphs, etc? You - know, the type of stuff that management likes to see. :) + Does Bugzilla provide any reporting features, metrics, + graphs, etc? You know, the type of stuff that management + likes to see. :) </para> </question> <answer> <para> - Yes. Look at <ulink url="http://bugzilla.mozilla.org/reports.cgi"> - http://bugzilla.mozilla.org/reports.cgi</ulink> for basic reporting - facilities. + Yes. Look at <ulink + url="http://bugzilla.mozilla.org/reports.cgi"> http://bugzilla.mozilla.org/reports.cgi</ulink> for basic reporting facilities. </para> <para> - For more advanced reporting, I recommend hooking up a professional - reporting package, such as Crystal Reports, and use ODBC to access - the MySQL database. You can do a lot through the Query page of - Bugzilla as well, but right now Advanced Reporting is much - better accomplished through third-party utilities that can - interface with the database directly. + For more advanced reporting, I recommend hooking up a + professional reporting package, such as Crystal Reports, + and use ODBC to access the MySQL database. You can do a + lot through the Query page of Bugzilla as well, but right + now Advanced Reporting is much better accomplished through + third-party utilities that can interface with the database + directly. </para> <para> Advanced Reporting is a Bugzilla 3.X proposed feature. @@ -758,15 +817,16 @@ someone to take it on if they want it. FAQ is a good place for it. <qandaentry> <question> <para> - 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? + 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? </para> </question> <answer> <para> - Email notification is user-configurable. The bug id and Topic - of the bug report accompany each email notification, along with - a list of the changes made. + Email notification is user-configurable. The bug id and + Topic of the bug report accompany each email notification, + along with a list of the changes made. </para> </answer> </qandaentry> @@ -788,22 +848,24 @@ someone to take it on if they want it. FAQ is a good place for it. <qandaentry> <question> <para> - If there is email notification, do users have to have any particular - type of email application? + If there is email notification, do users have to have any + particular type of email application? </para> </question> <answer> <para> - Bugzilla email is sent in plain text, the most compatible mail format - on the planet. + Bugzilla email is sent in plain text, the most compatible + mail format on the planet. <note> <para> - If you decide to use the bugzilla_email integration features - to allow Bugzilla to record responses to mail with the associated bug, - you may need to caution your users to set their mailer to "respond - to messages in the format in which they were sent". For security reasons - Bugzilla ignores HTML tags in comments, and if a user sends HTML-based - email into Bugzilla the resulting comment looks downright awful. + If you decide to use the bugzilla_email integration + features to allow Bugzilla to record responses to mail + with the associated bug, you may need to caution your + users to set their mailer to "respond to messages in + the format in which they were sent". For security + reasons Bugzilla ignores HTML tags in comments, and if + a user sends HTML-based email into Bugzilla the + resulting comment looks downright awful. </para> </note> </para> @@ -813,17 +875,19 @@ someone to take it on if they want it. FAQ is a good place for it. <qandaentry> <question> <para> - 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.? + 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.? </para> </question> <answer> <para> - Yes. Place yourself in the "cc" field of the bug you wish to monitor. - Then change your "Notify me of changes to" field in the Email Settings - tab of the User Preferences screen in Bugzilla to the "Only those - bugs which I am listed on the CC line" option. + Yes. Place yourself in the "cc" field of the bug you wish + to monitor. Then change your "Notify me of changes to" + field in the Email Settings tab of the User Preferences + screen in Bugzilla to the "Only those bugs which I am + listed on the CC line" option. </para> </answer> </qandaentry> @@ -831,32 +895,34 @@ someone to take it on if they want it. FAQ is a good place for it. <qandaentry> <question> <para> - 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 - and export that data to MS Excel, could I do that? + 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 and + export that data to MS Excel, could I do that? </para> </question> <answer> <para> - Mozilla allows data export through a custom DTD in XML format. - It does not, however, export to specific formats other than the - XML Mozilla DTD. Importing the data into Excel or any other application - is left as an exercise for the reader. + Mozilla allows data export through a custom DTD in XML + format. It does not, however, export to specific formats + other than the XML Mozilla DTD. Importing the data into + Excel or any other application is left as an exercise for + the reader. </para> <para> - If you create import filters to other applications from Mozilla's XML, - please submit your modifications for inclusion in future Bugzilla - distributions. + If you create import filters to other applications from + Mozilla's XML, please submit your modifications for + inclusion in future Bugzilla distributions. </para> <para> - As for data import, any application can send data to Bugzilla through - the HTTP protocol, or through Mozilla's XML API. However, it seems - kind of silly to put another front-end in front of Bugzilla; - it makes more sense to create a simplified bug submission form in - HTML. You can find an excellent example at - <ulink url="http://www.mozilla.org/quality/help/bugzilla-helper.html"> - http://www.mozilla.org/quality/help/bugzilla-helper.html</ulink> + As for data import, any application can send data to + Bugzilla through the HTTP protocol, or through Mozilla's + XML API. However, it seems kind of silly to put another + front-end in front of Bugzilla; it makes more sense to + create a simplified bug submission form in HTML. You can + find an excellent example at <ulink + url="http://www.mozilla.org/quality/help/bugzilla-helper.html"> http://www.mozilla.org/quality/help/bugzilla-helper.html</ulink> </para> </answer> </qandaentry> @@ -864,9 +930,9 @@ 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? + 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> @@ -879,16 +945,16 @@ someone to take it on if they want it. FAQ is a good place for it. <qandaentry> <question> <para> - Has anyone converted Bugzilla to another language to be used in other - countries? Is it localizable? + Has anyone converted Bugzilla to another language to be + used in other countries? Is it localizable? </para> </question> <answer> <para> - 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. + 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. </para> </answer> </qandaentry> @@ -896,8 +962,8 @@ someone to take it on if they want it. FAQ is a good place for it. <qandaentry> <question> <para> - Can a user create and save reports? Can they do this in Word format? - Excel format? + Can a user create and save reports? Can they do this in + Word format? Excel format? </para> </question> <answer> @@ -923,13 +989,15 @@ someone to take it on if they want it. FAQ is a good place for it. <qandaentry> <question> <para> - Can a user modify an existing report and then save it into another name? + Can a user modify an existing report and then save it into + another name? </para> </question> <answer> <para> - You can save an unlimited number of queries in Bugzilla. You are free - to modify them and rename them to your heart's desire. + You can save an unlimited number of queries in Bugzilla. + You are free to modify them and rename them to your + heart's desire. </para> </answer> </qandaentry> @@ -937,14 +1005,15 @@ someone to take it on if they want it. FAQ is a good place for it. <qandaentry> <question> <para> - Does Bugzilla have the ability to search by word, phrase, compound - search? + Does Bugzilla have the ability to search by word, phrase, + compound search? </para> </question> <answer> <para> - You have no idea. Bugzilla's query interface, particularly with the - advanced Boolean operators, is incredibly versatile. + You have no idea. Bugzilla's query interface, + particularly with the advanced Boolean operators, is + incredibly versatile. </para> </answer> </qandaentry> @@ -952,8 +1021,8 @@ someone to take it on if they want it. FAQ is a good place for it. <qandaentry> <question> <para> - Can the admin person establish separate group and individual user - privileges? + Can the admin person establish separate group and + individual user privileges? </para> </question> <answer> @@ -966,15 +1035,17 @@ someone to take it on if they want it. FAQ is a good place for it. <qandaentry> <question> <para> - 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? + 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? </para> </question> <answer> <para> - Bugzilla does not lock records. It provides mid-air collision detection, - and offers the offending user a choice of options to deal with the conflict. + Bugzilla does not lock records. It provides mid-air + collision detection, and offers the offending user a + choice of options to deal with the conflict. </para> </answer> </qandaentry> @@ -987,10 +1058,10 @@ someone to take it on if they want it. FAQ is a good place for it. </question> <answer> <para> - MySQL, the database back-end for Bugzilla, allows hot-backup of data. - You can find strategies for dealing with backup considerations - at <ulink url="http://www.mysql.com/doc/B/a/Backup.html"> - http://www.mysql.com/doc/B/a/Backup.html</ulink> + MySQL, the database back-end for Bugzilla, allows + hot-backup of data. You can find strategies for dealing + with backup considerations at <ulink + url="http://www.mysql.com/doc/B/a/Backup.html"> http://www.mysql.com/doc/B/a/Backup.html</ulink> </para> </answer> </qandaentry> @@ -1003,8 +1074,8 @@ someone to take it on if they want it. FAQ is a good place for it. </question> <answer> <para> - Yes. However, commits to the database must wait - until the tables are unlocked. Bugzilla databases are typically + 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. </para> </answer> @@ -1013,29 +1084,33 @@ someone to take it on if they want it. FAQ is a good place for it. <qandaentry> <question> <para> - 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. + 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. </para> </question> <answer> <para> - If Bugzilla is set up correctly from the start, continuing maintenance needs - are minimal and can be completed by unskilled labor. Things like rotate - backup tapes and check log files for the word "error". + If Bugzilla is set up correctly from the start, continuing + maintenance needs are minimal and can be completed by + unskilled labor. Things like rotate backup tapes and + check log files for the word "error". </para> <para> - Commercial Bug-tracking software typically costs somewhere upwards - of $20,000 or more for 5-10 floating licenses. Bugzilla consultation - is available from skilled members of the newsgroup. + Commercial Bug-tracking software typically costs somewhere + upwards of $20,000 or more for 5-10 floating licenses. + Bugzilla consultation is available from skilled members of + the newsgroup. </para> <para> - As an example, as of this writing I typically charge - $115 for the first hour, and $89 each hour thereafter - for consulting work. It takes me three to five hours to make Bugzilla - happy on a Development installation of Linux-Mandrake. + As an example, as of this writing I typically charge $115 + for the first hour, and $89 each hour thereafter for + consulting work. It takes me three to five hours to make + Bugzilla happy on a Development installation of + Linux-Mandrake. </para> </answer> </qandaentry> @@ -1043,20 +1118,22 @@ someone to take it on if they want it. FAQ is a good place for it. <qandaentry> <question> <para> - 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? + 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? </para> </question> <answer> <para> - It all depends on your level of commitment. Someone with much Bugzilla - experience can get you up and running in less than a day, and - your Bugzilla install can run untended for years. If your - Bugzilla strategy is critical to your business workflow, hire somebody - with reasonable UNIX or Perl skills to handle your process management and + It all depends on your level of commitment. Someone with + much Bugzilla experience can get you up and running in + less than a day, and your Bugzilla install can run + untended for years. If your Bugzilla strategy is critical + to your business workflow, hire somebody with reasonable + UNIX or Perl skills to handle your process management and bug-tracking maintenance & customization. </para> </answer> @@ -1065,14 +1142,16 @@ someone to take it on if they want it. FAQ is a good place for it. <qandaentry> <question> <para> - Is there any licensing fee or other fees for using Bugzilla? Any - out-of-pocket cost other than the bodies needed as identified above? + Is there any licensing fee or other fees for using + Bugzilla? Any out-of-pocket cost other than the bodies + needed as identified above? </para> </question> <answer> <para> - No. MySQL asks, if you find their product valuable, that you purchase - a support contract from them that suits your needs. + No. MySQL asks, if you find their product valuable, that + you purchase a support contract from them that suits your + needs. </para> </answer> </qandaentry> @@ -1088,10 +1167,8 @@ someone to take it on if they want it. FAQ is a good place for it. </question> <answer> <para> - Check <ulink url="http://www.mozilla.org/projects/bugzilla/"> - http://www.mozilla.org/projects/bugzilla/</ulink> for details. - Once you download it, untar it, read the README and - the Bugzilla Guide. + Check <ulink + url="http://www.mozilla.org/projects/bugzilla/"> http://www.mozilla.org/projects/bugzilla/</ulink> for details. Once you download it, untar it, read the Bugzilla Guide. </para> </answer> </qandaentry> @@ -1104,8 +1181,8 @@ someone to take it on if they want it. FAQ is a good place for it. </question> <answer> <para> - Installation on Windows NT has its own section in - "The Bugzilla Guide". + Installation on Windows NT has its own section in "The + Bugzilla Guide". </para> </answer> </qandaentry> @@ -1131,16 +1208,19 @@ someone to take it on if they want it. FAQ is a good place for it. <qandaentry> <question> <para> - How do I completely disable MySQL security if it's giving me problems - (I've followed the instructions in the README!)? + 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!)? </para> </question> <answer> <para> - Run mysql like this: "mysqld --skip-grant-tables". Please remember <emphasis>this - makes mysql as secure as taping a $100 to the floor of a football stadium - bathroom for safekeeping.</emphasis> Please read the Security section of the - Administration chapter of "The Bugzilla Guide" before proceeding. + Run mysql like this: "mysqld --skip-grant-tables". Please + remember <emphasis>this makes mysql as secure as taping a + $100 to the floor of a football stadium bathroom for + safekeeping.</emphasis> Please read the Security + section of the Administration chapter of "The Bugzilla + Guide" before proceeding. </para> </answer> </qandaentry> @@ -1153,10 +1233,11 @@ someone to take it on if they want it. FAQ is a good place for it. </question> <answer> <para> - The Bugzilla code has not undergone a complete security audit. - It is recommended that you closely examine permissions on your Bugzilla - installation, and follow the recommended security guidelines found - in the README and in The Bugzilla Guide. + The Bugzilla code has not undergone a complete security + audit. It is recommended that you closely examine + permissions on your Bugzilla installation, and follow the + recommended security guidelines found in The Bugzilla + Guide. </para> </answer> </qandaentry> @@ -1165,16 +1246,17 @@ someone to take it on if they want it. FAQ is a good place for it. <qandaentry> <question> <para> - 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. + 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. </para> </question> <answer> <para> - This is a common problem, related to running out of file descriptors. - Simply add "ulimit -n unlimited" to the script which starts - mysqld. + This is a common problem, related to running out of file + descriptors. Simply add "ulimit -n unlimited" to the + script which starts mysqld. </para> </answer> </qandaentry> @@ -1186,14 +1268,14 @@ someone to take it on if they want it. FAQ is a good place for it. <qandaentry> <question> <para> - I have a user who doesn't want to receive any more email from Bugzilla. - How do I stop it entirely for this user? + I have a user who doesn't want to receive any more email + from Bugzilla. How do I stop it entirely for this user? </para> </question> <answer> <para> - With the email changes to 2.12, the user should be able to set - this in user email preferences. + With the email changes to 2.12, the user should be able to + set this in user email preferences. </para> </answer> </qandaentry> @@ -1201,14 +1283,15 @@ someone to take it on if they want it. FAQ is a good place for it. <qandaentry> <question> <para> - I'm evaluating/testing Bugzilla, and don't want it to send email to - anyone but me. How do I do it? + I'm evaluating/testing Bugzilla, and don't want it to send + email to anyone but me. How do I do it? </para> </question> <answer> <para> - Edit the param for the mail text. Replace "To:" with "X-Real-To:", - replace "Cc:" with "X-Real-CC:", and add a "To: (myemailaddress)". + Edit the param for the mail text. Replace "To:" with + "X-Real-To:", replace "Cc:" with "X-Real-CC:", and add a + "To: (myemailaddress)". </para> </answer> </qandaentry> @@ -1216,17 +1299,15 @@ someone to take it on if they want it. FAQ is a good place for it. <qandaentry> <question> <para> - I want whineatnews.pl to whine at something more, or other than, only new - bugs. How do I do it? + I want whineatnews.pl to whine at something more, or other + than, only new bugs. How do I do it? </para> </question> <answer> <para> - Try Klaas Freitag's excellent patch for "whineatassigned" functionality. - You can find it at<ulink url=" http://bugzilla.mozilla.org/show_bug.cgi?id=6679"> - http://bugzilla.mozilla.org/show_bug.cgi?id=6679</ulink>. This - patch is against an older version of Bugzilla, so you must apply - the diffs manually. + Try Klaas Freitag's excellent patch for "whineatassigned" + functionality. You can find it at<ulink url=" + http://bugzilla.mozilla.org/show_bug.cgi?id=6679"> http://bugzilla.mozilla.org/show_bug.cgi?id=6679</ulink>. This patch is against an older version of Bugzilla, so you must apply the diffs manually. </para> </answer> </qandaentry> @@ -1234,22 +1315,23 @@ someone to take it on if they want it. FAQ is a good place for it. <qandaentry> <question> <para> - I don't like/want to use Procmail to hand mail off to bug_email.pl. - What alternatives do I have? + I don't like/want to use Procmail to hand mail off to + bug_email.pl. What alternatives do I have? </para> </question> <answer> <para> - You can call bug_email.pl directly from your aliases file, with - an entry like this: + You can call bug_email.pl directly from your aliases file, + with an entry like this: <blockquote> <para> - bugzilla-daemon: "|/usr/local/bin/bugzilla/contrib/bug_email.pl" + bugzilla-daemon: + "|/usr/local/bin/bugzilla/contrib/bug_email.pl" </para> - </blockquote> - However, this is fairly nasty and subject to problems; you also - need to set up your smrsh (sendmail restricted shell) to allow - it. In a pinch, though, it can work. + </blockquote> However, this is fairly nasty and subject to + problems; you also need to set up your smrsh (sendmail + restricted shell) to allow it. In a pinch, though, it can + work. </para> </answer> </qandaentry> @@ -1257,13 +1339,15 @@ someone to take it on if they want it. FAQ is a good place for it. <qandaentry> <question> <para> - How do I set up the email interface to submit/change bugs via email? + How do I set up the email interface to submit/change bugs + via email? </para> </question> <answer> <para> - You can find an updated README.mailif file in the contrib/ directory - of your Bugzilla distribution that walks you through the setup. + You can find an updated README.mailif file in the contrib/ + directory of your Bugzilla distribution that walks you + through the setup. </para> </answer> </qandaentry> @@ -1271,28 +1355,29 @@ someone to take it on if they want it. FAQ is a good place for it. <qandaentry> <question> <para> - Email takes FOREVER to reach me from bugzilla -- it's extremely slow. - What gives? + Email takes FOREVER to reach me from bugzilla -- it's + extremely slow. What gives? </para> </question> <answer> <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!) + 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. + "-ODeliveryMode=background". This prevents Sendmail from + hanging your Bugzilla Perl processes if the domain to + which it must send mail is unavailable. </para> <para> - This is now a configurable parameter called "sendmailnow", available - from editparams.cgi. + This is now a configurable parameter called "sendmailnow", + available from editparams.cgi. </para> </answer> </qandaentry> @@ -1305,15 +1390,16 @@ someone to take it on if they want it. FAQ is a good place for it. </question> <answer> <para> - Double-check that you have not turned off email in your user preferences. - Confirm that Bugzilla is able to send email by visiting the "Log In" - link of your Bugzilla installation and clicking the "Email me a password" - button after entering your email address. + Double-check that you have not turned off email in your + user preferences. Confirm that Bugzilla is able to send + email by visiting the "Log In" link of your Bugzilla + installation and clicking the "Email me a password" button + after entering your email address. </para> <para> - If you never receive mail from Bugzilla, chances you do not have - sendmail in "/usr/lib/sendmail". Ensure sendmail lives in, or is symlinked - to, "/usr/lib/sendmail". + If you never receive mail from Bugzilla, chances you do + not have sendmail in "/usr/lib/sendmail". Ensure sendmail + lives in, or is symlinked to, "/usr/lib/sendmail". </para> </answer> </qandaentry> @@ -1330,10 +1416,11 @@ someone to take it on if they want it. FAQ is a good place for it. </question> <answer> <para> - Red Hat Bugzilla, mentioned above, works with Oracle. The current version - from Mozilla.org does not have this capability. Unfortunately, though - you will sacrifice a lot of the really great features available in - Bugzilla 2.10 and 2.12 if you go with the 2.8-based Redhat version. + Red Hat Bugzilla, mentioned above, works with Oracle. The + current version from Mozilla.org does not have this + capability. Unfortunately, though you will sacrifice a + lot of the really great features available in Bugzilla + 2.10 and 2.12 if you go with the 2.8-based Redhat version. </para> </answer> </qandaentry> @@ -1341,25 +1428,30 @@ someone to take it on if they want it. FAQ is a good place for it. <qandaentry> <question> <para> - Bugs are missing from queries, but exist in the database (and I can pull - them up by specifying the bug ID). What's wrong? + Bugs are missing from queries, but exist in the database + (and I can pull them up by specifying the bug ID). What's + wrong? </para> </question> <answer> <para> - You've almost certainly enabled the "shadow database", but for some - reason it hasn't been updated for all your bugs. This is the database - against which queries are run, so that really complex or slow queries won't - lock up portions of the database for other users. You can turn off the - shadow database in editparams.cgi. If you wish to continue using the shadow - database, then as your "bugs" user run "./syncshadowdb -syncall" from the - command line in the bugzilla installation directory to recreate your shadow - database. After it finishes, be sure to check the params and make sure that - "queryagainstshadowdb" is still turned on. The syncshadowdb program turns it - off if it was on, and is supposed to turn it back on when completed; that - way, if it crashes in the middle of recreating the database, it will stay - off forever until someone turns it back on by hand. Apparently, it doesn't - always do that yet. + You've almost certainly enabled the "shadow database", + but for some reason it hasn't been updated for all your + bugs. This is the database against which queries are run, + so that really complex or slow queries won't lock up + portions of the database for other users. You can turn off + the shadow database in editparams.cgi. If you wish to + continue using the shadow database, then as your "bugs" + user run "./syncshadowdb -syncall" from the command line + in the bugzilla installation directory to recreate your + shadow database. After it finishes, be sure to check the + params and make sure that "queryagainstshadowdb" is still + turned on. The syncshadowdb program turns it off if it was + on, and is supposed to turn it back on when completed; + that way, if it crashes in the middle of recreating the + database, it will stay off forever until someone turns it + back on by hand. Apparently, it doesn't always do that + yet. </para> </answer> </qandaentry> @@ -1367,18 +1459,20 @@ someone to take it on if they want it. FAQ is a good place for it. <qandaentry> <question> <para> - I think my database might be corrupted, or contain invalid entries. What - do I do? + I think my database might be corrupted, or contain invalid + entries. What do I do? </para> </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 "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... </para> </answer> </qandaentry> @@ -1391,12 +1485,14 @@ someone to take it on if they want it. FAQ is a good place for it. </question> <answer> <para> - There is no facility in Bugzilla itself to do this. It's also generally - not a smart thing to do if you don't know exactly what you're doing. - However, if you understand SQL you can use the mysqladmin utility to - manually insert, delete, and modify table information. Personally, I - use "phpMyAdmin". You have to compile a PHP module with MySQL - support to make it work, but it's very clean and easy to use. + There is no facility in Bugzilla itself to do this. It's + also generally not a smart thing to do if you don't know + exactly what you're doing. However, if you understand SQL + you can use the mysqladmin utility to manually insert, + delete, and modify table information. Personally, I use + "phpMyAdmin". You have to compile a PHP module with MySQL + support to make it work, but it's very clean and easy to + use. </para> </answer> </qandaentry> @@ -1404,14 +1500,17 @@ someone to take it on if they want it. FAQ is a good place for it. <qandaentry> <question> <para> - I try to add myself as a user, but Bugzilla always tells me my password is wrong. + I try to add myself as a user, but Bugzilla always tells + me my password is wrong. </para> </question> <answer> <para> - Certain version of MySQL (notably, 3.23.29 and 3.23.30) accidentally disabled - the "crypt()" function. This prevented MySQL from storing encrypted passwords. - Upgrade to the "3.23 stable" version of MySQL and you should be good to go. + Certain version of MySQL (notably, 3.23.29 and 3.23.30) + accidentally disabled the "crypt()" function. This + prevented MySQL from storing encrypted passwords. Upgrade + to the "3.23 stable" version of MySQL and you should be + good to go. </para> </answer> </qandaentry> @@ -1419,17 +1518,18 @@ someone to take it on if they want it. FAQ is a good place for it. <qandaentry> <question> <para> - I think I've set up MySQL permissions correctly, but bugzilla still can't - connect. + I think I've set up MySQL permissions correctly, but + bugzilla still can't connect. </para> </question> <answer> <para> - Try running MySQL from its binary: "mysqld --skip-grant-tables". This - will allow you to completely rule out grant tables as the cause of your - frustration. However, I do not recommend you run it this way on a regular - basis, unless you really want your web site defaced and your machine - cracked. + Try running MySQL from its binary: "mysqld + --skip-grant-tables". This will allow you to completely + rule out grant tables as the cause of your frustration. + However, I do not recommend you run it this way on a + regular basis, unless you really want your web site + defaced and your machine cracked. </para> </answer> </qandaentry> @@ -1437,26 +1537,28 @@ someone to take it on if they want it. FAQ is a good place for it. <qandaentry> <question> <para> - How do I synchronize bug information among multiple different Bugzilla - databases? + How do I synchronize bug information among multiple + different Bugzilla databases? </para> </question> <answer> <para> - Well, you can synchronize or you can move bugs. Synchronization will - only work one way -- you can create a read-only copy of the database - at one site, and have it regularly updated at intervals from the main - database. + Well, you can synchronize or you can move bugs. + Synchronization will only work one way -- you can create a + read-only copy of the database at one site, and have it + regularly updated at intervals from the main database. </para> <para> - MySQL has some synchronization features builtin to the latest releases. - It would be great if someone looked into the possibilities there - and provided a report to the newsgroup on how to effectively - synchronize two Bugzilla installations. + MySQL has some synchronization features builtin to the + latest releases. It would be great if someone looked into + the possibilities there and provided a report to the + newsgroup on how to effectively synchronize two Bugzilla + installations. </para> <para> - If you simply need to transfer bugs from one Bugzilla to another, - checkout the "move.pl" script in the Bugzilla distribution. + If you simply need to transfer bugs from one Bugzilla to + another, checkout the "move.pl" script in the Bugzilla + distribution. </para> </answer> </qandaentry> @@ -1464,15 +1566,16 @@ someone to take it on if they want it. FAQ is a good place for it. <qandaentry> <question> <para> - Why do I get bizarre errors when trying to submit data, particularly problems - with "groupset"? + Why do I get bizarre errors when trying to submit data, + particularly problems with "groupset"? </para> </question> <answer> <para> - If you're sure your MySQL parameters are correct, you might want turn - "strictvaluechecks" OFF in editparams.cgi. If you have "usebugsentry" set - "On", you also cannot submit a bug as readable by more than one group with + If you're sure your MySQL parameters are correct, you + might want turn "strictvaluechecks" OFF in editparams.cgi. + If you have "usebugsentry" set "On", you also cannot + submit a bug as readable by more than one group with "strictvaluechecks" ON. </para> </answer> @@ -1481,15 +1584,17 @@ someone to take it on if they want it. FAQ is a good place for it. <qandaentry> <question> <para> - How come even after I delete bugs, the long descriptions show up? + How come even after I delete bugs, the long descriptions + show up? </para> </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. + 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. </para> </answer> </qandaentry> @@ -1502,13 +1607,14 @@ someone to take it on if they want it. FAQ is a good place for it. <qandaentry> <question> <para> - What is the easiest way to run Bugzilla on Win32 (Win98+/NT/2K)? + What is the easiest way to run Bugzilla on Win32 + (Win98+/NT/2K)? </para> </question> <answer> <para> - Remove Windows. Install Linux. Install Bugzilla. - The boss will never know the difference. + Remove Windows. Install Linux. Install Bugzilla. The boss + will never know the difference. </para> </answer> </qandaentry> @@ -1521,9 +1627,10 @@ someone to take it on if they want it. FAQ is a good place for it. </question> <answer> <para> - Not currently. Bundle::Bugzilla enormously simplifies Bugzilla - installation on UNIX systems. If someone can volunteer to - create a suitable PPM bundle for Win32, it would be appreciated. + Not currently. Bundle::Bugzilla enormously simplifies + Bugzilla installation on UNIX systems. If someone can + volunteer to create a suitable PPM bundle for Win32, it + would be appreciated. </para> </answer> </qandaentry> @@ -1531,29 +1638,34 @@ someone to take it on if they want it. FAQ is a good place for it. <qandaentry> <question> <para> - CGI's are failing with a "something.cgi is not a valid Windows NT - application" error. Why? + CGI's are failing with a "something.cgi is not a valid + Windows NT application" error. Why? </para> </question> <answer> <para> - Depending on what Web server you are using, you will have to configure - the Web server to treat *.cgi files as CGI scripts. In IIS, you do this by - adding *.cgi to the App Mappings with the <path>\perl.exe %s %s as the + Depending on what Web server you are using, you will have + to configure the Web server to treat *.cgi files as CGI + scripts. In IIS, you do this by adding *.cgi to the App + Mappings with the <path>\perl.exe %s %s as the executable. </para> <para> Microsoft has some advice on this matter, as well: <blockquote> <para> - "Set application mappings. In the ISM, map the extension for the script - file(s) to the executable for the script interpreter. For example, you might - map the extension .py to Python.exe, the executable for the Python script - interpreter. Note For the ActiveState Perl script interpreter, the extension - .pl is associated with PerlIS.dll by default. If you want to change the - association of .pl to perl.exe, you need to change the application mapping. - In the mapping, you must add two percent (%) characters to the end of the - pathname for perl.exe, as shown in this example: c:\perl\bin\perl.exe %s %s" + "Set application mappings. In the ISM, map the + extension for the script file(s) to the executable for + the script interpreter. For example, you might map the + extension .py to Python.exe, the executable for the + Python script interpreter. Note For the ActiveState + Perl script interpreter, the extension .pl is + associated with PerlIS.dll by default. If you want to + change the association of .pl to perl.exe, you need to + change the application mapping. In the mapping, you + must add two percent (%) characters to the end of the + pathname for perl.exe, as shown in this example: + c:\perl\bin\perl.exe %s %s" </para> </blockquote> </para> @@ -1563,108 +1675,69 @@ someone to take it on if they want it. FAQ is a good place for it. <qandaentry> <question> <para> - Can I have some general instructions on how to make Bugzilla on Win32 work? - </para> - </question> + Can I have some general instructions on how to make + Bugzilla on Win32 work? + </para> + </question> <answer> <para> - The following couple entries are deprecated in favor of the Windows installation - instructions available in the "Administration" portion of "The Bugzilla Guide". - However, they are provided here for historical interest and insight. - <literallayout> - 1. #!C:/perl/bin/perl had to be added to every perl file. - 2. Converted to Net::SMTP to handle mail messages instead of - /usr/bin/sendmail. - 3. The crypt function isn't available on Windows NT (at least none that I - am aware), so I made encrypted passwords = plaintext passwords. - 4. The system call to diff had to be changed to the Cygwin diff. - 5. This was just to get a demo running under NT, it seems to be working - good, and I have inserted almost 100 bugs from another bug tracking - system. Since this work was done just to get an in-house demo, I am NOT - planning on making a patch for submission to Bugzilla. If you would - like a zip file, let me know. - -Q: Hmm, couldn't figure it out from the general instructions above. How -about step-by-step? -A: Sure! Here ya go! - - 1. Install IIS 4.0 from the NT Option Pack #4. - 2. Download and install Active Perl. - 3. Install the Windows GNU tools from Cygwin. Make sure to add the bin - directory to your system path. (Everyone should have these, whether - they decide to use Bugzilla or not. :-) ) - 4. Download relevant packages from ActiveState at - http://www.activestate.com/packages/zips/. + DBD-Mysql.zip - 5. Extract each zip file with WinZip, and install each ppd file using the - notation: ppm install <module>.ppd - 6. Install Mysql. *Note: If you move the default install from c:\mysql, - you must add the appropriate startup parameters to the NT service. (ex. - -b e:\\programs\\mysql) - 7. Download any Mysql client. http://www.mysql.com/download_win.html - 8. Setup MySql. (These are the commands that I used.) - - I. Cleanup default database settings. - C:\mysql\bin\mysql -u root mysql - mysql> DELETE FROM user WHERE Host='localhost' AND User=''; - mysql> quit - C:\mysql\bin\mysqladmin reload - - II. Set password for root. - C:\mysql\bin\mysql -u root mysql - mysql> UPDATE user SET Password=PASSWORD('new_password') - WHERE user='root'; - mysql> FLUSH PRIVILEGES; - mysql> quit - C:\mysql\bin\mysqladmin -u root reload - - III. Create bugs user. - C:\mysql\bin\mysql -u root -p - mysql> insert into user (host,user,password) - values('localhost','bugs',''); - mysql> quit - C:\mysql\bin\mysqladmin -u root reload - - IV. Create the bugs database. - C:\mysql\bin\mysql -u root -p - mysql> create database bugs; - - V. Give the bugs user access to the bugs database. - mysql> insert into db - (host,db,user,select_priv,insert_priv,update_priv,delete_priv,create_priv,drop_priv) - values('localhost','bugs','bugs','Y','Y','Y','Y','Y','N') - mysql> quit - C:\mysql\bin\mysqladmin -u root reload - 9. Run the table scripts to setup the bugs database. - 10. Change CGI.pm to use the following regular expression because of - differing backslashes in NT versus UNIX. - o $0 =~ m:[^\\]*$:; - 11. Had to make the crypt password = plain text password in the database. - (Thanks to Andrew Lahser" <andrew_lahser@merck.com>" on this one.) The - files that I changed were: - o globals.pl - o CGI.pl - o alternately, you can try commenting all references to 'crypt' - string and replace them with similar lines but without encrypt() - or crypr() functions insida all files. - 12. Replaced sendmail with Windmail. Basically, you have to come up with a - sendmail substitute for NT. Someone said that they used a Perl module - (Net::SMTP), but I was trying to save time and do as little Perl coding - as possible. - 13. Added "perl" to the beginning of all Perl system calls that use a perl - script as an argument and renamed processmail to processmail.pl. - 14. In processmail.pl, I added binmode(HANDLE) before all read() calls. I'm - not sure about this one, but the read() under NT wasn't counting the - EOLs without the binary read." - </literallayout> + The following couple entries are deprecated in favor of + the Windows installation instructions available in the + "Administration" portion of "The Bugzilla Guide". However, + they are provided here for historical interest and + insight. <literallayout> 1. #!C:/perl/bin/perl had to be + added to every perl file. 2. Converted to Net::SMTP to + handle mail messages instead of /usr/bin/sendmail. 3. + The crypt function isn't available on Windows NT (at + least none that I am aware), so I made encrypted + passwords = plaintext passwords. 4. The system call to + diff had to be changed to the Cygwin diff. 5. This was + just to get a demo running under NT, it seems to be + working good, and I have inserted almost 100 bugs from + another bug tracking system. Since this work was done + just to get an in-house demo, I am NOT planning on + making a patch for submission to Bugzilla. If you would + like a zip file, let me know. Q: Hmm, couldn't figure it + out from the general instructions above. How about + step-by-step? A: Sure! Here ya go! 1. Install IIS 4.0 + from the NT Option Pack #4. 2. Download and install + Active Perl. 3. Install the Windows GNU tools from + Cygwin. Make sure to add the bin directory to your + system path. (Everyone should have these, whether they + decide to use Bugzilla or not. :-) ) 4. Download + relevant packages from ActiveState at + http://www.activestate.com/packages/zips/. + + DBD-Mysql.zip 5. Extract each zip file with WinZip, and + install each ppd file using the notation: ppm install + <module>.ppd 6. Install Mysql. *Note: If you move + the default install from c:\mysql, you must add the + appropriate startup parameters to the NT service. (ex. + -b e:\\programs\\mysql) 7. Download any Mysql client. + http://www.mysql.com/download_win.html 8. Setup MySql. + (These are the commands that I used.) I. Cleanup default + database settings. C:\mysql\bin\mysql -u root mysql + mysql> DELETE FROM user WHERE Host='localhost' AND + User=''; mysql> quit C:\mysql\bin\mysqladmin reload II. + Set password for root. C:\mysql\bin\mysql -u root mysql + mysql> UPDATE user SET Password=PASSWORD('new_password') + WHERE user='root'; mysql> FLUSH PRIVILEGES; mysql> quit + C:\mysql\bin\mysqladmin -u root reload III. Create bugs + user. C:\mysql\bin\mysql -u root -p mysql> insert into + user (host,user,password) values('localhost','bugs',''); + mysql> quit C:\mysql\bin\mysqladmin -u root reload IV. + Create the bugs database. C:\mysql\bin\mysql -u root -p + mysql> create database bugs; V. Give the bugs user + access to the bugs database. mysql> insert into db + (host,db,user,select_priv,insert_priv,update_priv,delete_priv,create_priv,drop_priv) values('localhost','bugs','bugs','Y','Y','Y','Y','Y','N') mysql> quit C:\mysql\bin\mysqladmin -u root reload 9. Run the table scripts to setup the bugs database. 10. Change CGI.pm to use the following regular expression because of differing backslashes in NT versus UNIX. o $0 =~ m:[^\\]*$:; 11. Had to make the crypt password = plain text password in the database. (Thanks to Andrew Lahser" <andrew_lahser@merck.com>" on this one.) The files that I changed were: o globals.pl o CGI.pl o alternately, you can try commenting all references to 'crypt' string and replace them with similar lines but without encrypt() or crypr() functions insida all files. 12. Replaced sendmail with Windmail. Basically, you have to come up with a sendmail substitute for NT. Someone said that they used a Perl module (Net::SMTP), but I was trying to save time and do as little Perl coding as possible. 13. Added "perl" to the beginning of all Perl system calls that use a perl script as an argument and renamed processmail to processmail.pl. 14. In processmail.pl, I added binmode(HANDLE) before all read() calls. I'm not sure about this one, but the read() under NT wasn't counting the EOLs without the binary read." </literallayout> </para> </answer> </qandaentry> - - <qandaentry> - <question> - <para> - I'm having trouble with the perl modules for NT not being able to talk to - to the database. + + <qandaentry> + <question> + <para> + I'm having trouble with the perl modules for NT not being + able to talk to to the database. </para> </question> <answer> @@ -1693,14 +1766,14 @@ A: Sure! Here ya go! </listitem> <listitem> <para> - <prompt>PPM></prompt> <command>install DBI DBD-mysql GD</command> + <prompt>PPM></prompt> <command>install DBI DBD-mysql + GD</command> </para> </listitem> - </orderedlist> - I reckon TimeDate and Data::Dumper come with the activeperl. You can check - the ActiveState site for packages for installation through PPM. - <ulink url=" http://www.activestate.com/Packages/"> - http://www.activestate.com/Packages/</ulink> + </orderedlist> I reckon TimeDate and Data::Dumper come + with the activeperl. You can check the ActiveState site + for packages for installation through PPM. <ulink url=" + http://www.activestate.com/Packages/"> http://www.activestate.com/Packages/</ulink> </para> </answer> </qandaentry> @@ -1713,15 +1786,15 @@ A: Sure! Here ya go! <qandaentry> <question> <para> - The query page is very confusing. Isn't there a simpler way to query? + The query page is very confusing. Isn't there a simpler + way to query? </para> </question> <answer> <para> - We are developing in that direction. You can follow progress on this - at <ulink url="http://bugzilla.mozilla.org/show_bug.cgi?id=16775"> - http://bugzilla.mozilla.org/show_bug.cgi?id=16775</ulink>. Some functionality - is available in Bugzilla 2.12, and is available as "quicksearch.html" + We are developing in that direction. You can follow + progress on this at <ulink + url="http://bugzilla.mozilla.org/show_bug.cgi?id=16775"> http://bugzilla.mozilla.org/show_bug.cgi?id=16775</ulink>. Some functionality is available in Bugzilla 2.12, and is available as "quicksearch.html" </para> </answer> </qandaentry> @@ -1729,23 +1802,24 @@ A: Sure! Here ya go! <qandaentry> <question> <para> - 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? + 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? </para> </question> <answer> <para> - The current behavior is acceptable to bugzilla.mozilla.org and most - users. I personally don't like it. You have your choice of patches - to change this behavior, however. + The current behavior is acceptable to bugzilla.mozilla.org + and most users. I personally don't like it. You have + your choice of patches to change this behavior, however. <simplelist> - <member><ulink url="http://bugzilla.mozilla.org/showattachment.cgi?attach_id=8029"> - Add a "and accept bug" radio button</ulink></member> - <member><ulink url="http://bugzilla.mozilla.org/showattachment.cgi?attach_id=8153"> - "Accept" button automatically assigns to you</ulink></member> - </simplelist> - Note that these patches are somewhat dated. You will need to do the find - and replace manually to apply them. They are very small, though. It is easy. + <member><ulink + url="http://bugzilla.mozilla.org/showattachment.cgi?attach_id=8029"> Add a "and accept bug" radio button</ulink></member> + <member><ulink + url="http://bugzilla.mozilla.org/showattachment.cgi?attach_id=8153"> "Accept" button automatically assigns to you</ulink></member> + </simplelist> Note that these patches are somewhat dated. + You will need to do the find and replace manually to apply + them. They are very small, though. It is easy. </para> </answer> </qandaentry> @@ -1753,15 +1827,16 @@ A: Sure! Here ya go! <qandaentry> <question> <para> - I can't upload anything into the database via the "Create Attachment" - link. What am I doing wrong? + I can't upload anything into the database via the "Create + Attachment" link. What am I doing wrong? </para> </question> <answer> <para> - The most likely cause is a very old browser or a browser that is - incompatible with file upload via POST. Download the latest Netscape, - Microsoft, or Mozilla browser to handle uploads correctly. + The most likely cause is a very old browser or a browser + that is incompatible with file upload via POST. Download + the latest Netscape, Microsoft, or Mozilla browser to + handle uploads correctly. </para> </answer> </qandaentry> @@ -1769,15 +1844,16 @@ A: Sure! Here ya go! <qandaentry> <question> <para> - Email submissions to Bugzilla that have attachments end up asking me to - save it as a "cgi" file. + Email submissions to Bugzilla that have attachments end up + asking me to save it as a "cgi" file. </para> </question> <answer> <para> - Yup. Just rename it once you download it, or save it under a different - filename. This will not be fixed anytime too soon, because it would - cripple some other functionality. + Yup. Just rename it once you download it, or save it + under a different filename. This will not be fixed + anytime too soon, because it would cripple some other + functionality. </para> </answer> </qandaentry> @@ -1785,14 +1861,16 @@ A: Sure! Here ya go! <qandaentry> <question> <para> - How do I change a keyword in Bugzilla, once some bugs are using it? + How do I change a keyword in Bugzilla, once some bugs are + using it? </para> </question> <answer> <para> - In the Bugzilla administrator UI, edit the keyword and it will let you - replace the old keyword name with a new one. This will cause a problem - with the keyword cache. Run sanitycheck.cgi to fix it. + In the Bugzilla administrator UI, edit the keyword and it + will let you replace the old keyword name with a new one. + This will cause a problem with the keyword cache. Run + sanitycheck.cgi to fix it. </para> </answer> </qandaentry> @@ -1810,19 +1888,12 @@ 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"> - this link</ulink> to view current bugs or requests for - enhancement for Bugzilla. + Try <ulink + url="http://bugzilla.mozilla.org/buglist.cgi?bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&product=Webtools&component=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 - 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 - check current sources out of CVS so you can have these - bug fixes early! + 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 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 check current sources out of CVS so you can have these bug fixes early! </para> </answer> </qandaentry> @@ -1830,19 +1901,15 @@ A: Sure! Here ya go! <qandaentry> <question> <para> - How can I change the default priority to a null value? For instance, have the default - priority be "---" instead of "P2"? + How can I change the default priority to a null value? + For instance, have the default priority be "---" instead + of "P2"? </para> </question> <answer> <para> - This is well-documented here: <ulink url="http://bugzilla.mozilla.org/show_bug.cgi?id=49862"> - http://bugzilla.mozilla.org/show_bug.cgi?id=49862</ulink>. Ultimately, it's as easy - as adding the "---" priority field to your localconfig file in the appropriate area, - re-running checksetup.pl, and then changing the default priority in your browser using - "editparams.cgi". Hmm, now that I think about it, that is kind of a klunky way to handle - it, but for now it's what we have! Although the bug has been closed "resolved wontfix", - there may be a better way to handle this... + This is well-documented here: <ulink + url="http://bugzilla.mozilla.org/show_bug.cgi?id=49862"> http://bugzilla.mozilla.org/show_bug.cgi?id=49862</ulink>. Ultimately, it's as easy as adding the "---" priority field to your localconfig file in the appropriate area, re-running checksetup.pl, and then changing the default priority in your browser using "editparams.cgi". Hmm, now that I think about it, that is kind of a klunky way to handle it, but for now it's what we have! Although the bug has been closed "resolved wontfix", there may be a better way to handle this... </para> </answer> </qandaentry> @@ -1850,7 +1917,8 @@ A: Sure! Here ya go! <qandaentry> <question> <para> - What's the best way to submit patches? What guidelines should I follow? + What's the best way to submit patches? What guidelines + should I follow? </para> </question> <answer> @@ -1858,42 +1926,47 @@ 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 + "Webtools" product, "Bugzilla" component. </para> </listitem> <listitem> <para> - Upload your patch as a unified DIFF (having used "diff -u" against - the <emphasis>current sources</emphasis> checked out of CVS), - or new source file by clicking - "Create a new attachment" link on the bug page you've just created, and - include any descriptions of database changes you may make, into the bug - ID you submitted in step #1. Be sure and click the "Patch" radio - button to indicate the text you are sending is a patch! + Upload your patch as a unified DIFF (having used + "diff -u" against the <emphasis>current + sources</emphasis> checked out of CVS), or new + source file by clicking "Create a new attachment" + link on the bug page you've just created, and + include any descriptions of database changes you may + make, into the bug ID you submitted in step #1. Be + sure and click the "Patch" radio button to indicate + the text you are sending is a patch! </para> </listitem> <listitem> <para> Announce your patch and the associated URL - (http://bugzilla.mozilla.org/show_bug.cgi?id=XXXX) for discussion in - the newsgroup (netscape.public.mozilla.webtools). You'll get a really - good, fairly immediate reaction to the implications of your patch, - which will also give us an idea how well-received the change would - be. + (http://bugzilla.mozilla.org/show_bug.cgi?id=XXXX) + for discussion in the newsgroup + (netscape.public.mozilla.webtools). You'll get a + really good, fairly immediate reaction to the + implications of your patch, which will also give us + an idea how well-received the change would be. </para> </listitem> <listitem> <para> - If it passes muster with minimal modification, the person to whom - the bug is assigned in Bugzilla is responsible for seeing the patch - is checked into CVS. + If it passes muster with minimal modification, the + person to whom the bug is assigned in Bugzilla is + responsible for seeing the patch is checked into + CVS. </para> </listitem> <listitem> <para> - Bask in the glory of the fact that you helped write the most successful - open-source bug-tracking software on the planet :) + Bask in the glory of the fact that you helped write + the most successful open-source bug-tracking + software on the planet :) </para> </listitem> </orderedlist> @@ -1912,17 +1985,20 @@ A: Sure! Here ya go! <!-- Keep this comment at the end of the file Local variables: mode: sgml -sgml-omittag:t -sgml-shorttag:t -sgml-namecase-general:t -sgml-general-insert-case:lower -sgml-minimize-attributes:nil sgml-always-quote-attributes:t -sgml-indent-step:2 -sgml-indent-data:t -sgml-parent-document:nil +sgml-auto-insert-required-elements:t +sgml-balanced-tag-edit:t sgml-exposed-tags:nil +sgml-general-insert-case:lower +sgml-indent-data:t +sgml-indent-step:2 sgml-local-catalogs:nil sgml-local-ecat-files:nil +sgml-minimize-attributes:nil +sgml-namecase-general:t +sgml-omittag:t +sgml-parent-document:("Bugzilla-Guide.sgml" "book" "chapter") +sgml-shorttag:t +sgml-tag-region-if-active:t End: --> diff --git a/docs/xml/gfdl.xml b/docs/xml/gfdl.xml index 1091631d4..7d8d9967f 100644 --- a/docs/xml/gfdl.xml +++ b/docs/xml/gfdl.xml @@ -1,4 +1,4 @@ -<!DOCTYPE appendix PUBLIC "-//OASIS//DTD DocBook V4.1//EN"> +<!-- <!DOCTYPE appendix PUBLIC "-//OASIS//DTD DocBook V4.1//EN"> --> <appendix id="gfdl"> <title>GNU Free Documentation License</title> @@ -450,19 +450,25 @@ of this license document, but changing it is not allowed.</para> </sect1> </appendix> + + <!-- Keep this comment at the end of the file Local variables: mode: sgml -sgml-omittag:nil -sgml-shorttag:t -sgml-minimize-attributes:nil sgml-always-quote-attributes:t -sgml-indent-step:2 -sgml-parent-document: ("Bugzilla-Guide.sgml" "appendix") +sgml-auto-insert-required-elements:t +sgml-balanced-tag-edit:t sgml-exposed-tags:nil +sgml-general-insert-case:lower +sgml-indent-data:t +sgml-indent-step:2 +sgml-local-catalogs:nil sgml-local-ecat-files:nil -sgml-local-catalogs: CATALOG -sgml-validate-command: "nsgmls -s gfdl.sgml" -ispell-skip-sgml: t +sgml-minimize-attributes:nil +sgml-namecase-general:t +sgml-omittag:t +sgml-parent-document:("Bugzilla-Guide.sgml" "book" "chapter") +sgml-shorttag:t +sgml-tag-region-if-active:t End: --> diff --git a/docs/xml/glossary.xml b/docs/xml/glossary.xml index 32525f737..71ba2dd36 100644 --- a/docs/xml/glossary.xml +++ b/docs/xml/glossary.xml @@ -1,108 +1,177 @@ <!-- <!DOCTYPE glossary PUBLIC "-//OASIS//DTD DocBook V4.1//EN" > --> -<glossary id="glossary"> - - <glossdiv id="gloss_a"> - <title>A</title> - <glossentry> - <glossterm>There are no entries for A</glossterm> - <glossdef> - <para></para> - </glossdef> - </glossentry> - </glossdiv> - - <glossdiv id="gloss_b"> - <title>B</title> - <glossentry> - <glossterm>Bug</glossterm> - <glossdef> - <para>A "Bug" in Bugzilla refers to an issue entered into the database which has an associated number, assignments, comments, etc. Many also refer to a "Ticket" or "Issue"; in this context, they are synonymous.</para> - </glossdef> - </glossentry> - - <glossentry> - <glossterm>Bug Number</glossterm> - <glossdef> - <para>Each Bugzilla Bug is assigned a number that uniquely identifies that Bug. The Bug associated with a Bug Number can be pulled up via a query, or easily from the very front page by typing the number in the "Find" box.</para> - </glossdef> - </glossentry> - - <glossentry> - <glossterm>Bug Life Cycle</glossterm> - <glossdef> - <para>A Bug has stages through which it must pass before becoming a "closed bug", including acceptance, resolution, and verification. The "Bug Life Cycle" is moderately flexible according to the needs of the organization using it, though.</para> - </glossdef> - </glossentry> - </glossdiv> - - <glossdiv id="gloss_i"> - <title>I</title> - <glossentry id="gloss_infiniteloop"> - <glossterm>Infinite Loop</glossterm> - <glosssee otherterm="gloss_recursion"> - </glossentry> - </glossdiv> - -<glossdiv id="gloss_p"> - <title>P</title> - <glossentry> - <glossterm id="gloss_product">Product</glossterm> - <glossdef> - <para>A Product is a broad category of types of bugs. In general, there are several Components to a Product. A Product also defines a default Group (used for Bug Security) for all bugs entered into components beneath it.</para> - <example> - <title>A Sample Product</title> - <para>A company sells a software product called "X". They also maintain some older software called "Y", and have a secret project "Z". An effective use of Products might be to create Products "X", "Y", and "Z", each with Components "User Interface", "Database", and "Business Logic". They might also change group permissions so that only those people who are members of Group "Z" can see components and bugs under Product "Z".</para> - </example> - </glossdef> - </glossentry> - </glossdiv> - - <glossdiv id="gloss_q"> - <title>Q</title> - <glossentry> - <glossterm>Q/A</glossterm> - <glossdef> - <para>"Q/A" is short for "Quality Assurance". In most large software development organizations, there is a team devoted to ensuring the product meets minimum standards before shipping. This team will also generally want to track the progress of bugs over their life cycle, thus the need for the "Q/A Contact" field in a Bug.</para> - </glossdef> - </glossentry> - </glossdiv> - -<glossdiv id="gloss_r"> - <title>R</title> - <glossentry> - <glossterm id="gloss_recursion">Recursion</glossterm> - <glosssee otherterm="gloss_infiniteloop"> - </glossentry> - </glossdiv> - -<glossdiv id="gloss_z"> - <title>Z</title> - <glossentry> - <glossterm>Zarro Boogs Found</glossterm> - <glossdef> - <para>This is the cryptic response sent by Bugzilla when a query returned no results. It is just a goofy way of saying "Zero Bugs Found".</para> - </glossdef> - </glossentry> -</glossdiv> - -</glossary> - - + <glossary id="glossary"> + <glossdiv> + <title>0-9, high ascii</title> + <glossentry> + <glossterm>.htaccess</glossterm> + <glossdef> + <para> + Apache web server, and other NCSA-compliant web servers, + observe the convention of using files in directories + called <filename>.htaccess</filename> files. These + restrict parameters of the web server. In Bugzilla, they + are used to restrict access to certain files which would + otherwise compromise your installation. For instance, the + <filename>localconfig</filename> file contains the + password to your database. If this information were + generally available, and remote access to your database + turned on, you risk corruption of your database by + computer criminals or the curious. + </para> + </glossdef> + </glossentry> + </glossdiv> + + <glossdiv id="gloss_a"> + <title>A</title> + <glossentry> + <glossterm>There are no entries for A</glossterm> + <glossdef> + <para></para> + </glossdef> + </glossentry> + </glossdiv> + + <glossdiv id="gloss_b"> + <title>B</title> + <glossentry> + <glossterm>Bug</glossterm> + <glossdef> + <para> + A <quote>Bug</quote> in Bugzilla refers to an issue + entered into the database which has an associated number, + assignments, comments, etc. Some also refer to a + <quote>tickets</quote> or <quote>issues</quote>; in the + context of Bugzilla, they are synonymous. + </para> + </glossdef> + </glossentry> + + <glossentry> + <glossterm>Bug Number</glossterm> + <glossdef> + <para> + Each Bugzilla Bug is assigned a number that uniquely + identifies that Bug. The Bug associated with a Bug Number + can be pulled up via a query, or easily from the very + front page by typing the number in the "Find" box. + </para> + </glossdef> + </glossentry> + + <glossentry> + <glossterm>Bug Life Cycle</glossterm> + <glossdef> + <para>A Bug has stages through which it must pass before + becoming a <quote>closed bug</quote>, including + acceptance, resolution, and verification. The <quote>Bug + Life Cycle</quote> is moderately flexible according to + the needs of the organization using it, though.</para> + </glossdef> + </glossentry> + </glossdiv> + + <glossdiv id="gloss_i"> + <title>I</title> + <glossentry id="gloss_infiniteloop"> + <glossterm>Infinite Loop</glossterm> + <glossdef> + <para>A loop of information that never ends; see recursion.</para> + </glossdef> + </glossentry> + </glossdiv> + + <glossdiv id="gloss_p"> + <title>P</title> + <glossentry> + <glossterm id="gloss_product">Product</glossterm> + <glossdef> + <para>A Product is a broad category of types of bugs. In + general, there are several Components to a Product. A + Product also defines a default Group (used for Bug + Security) for all bugs entered into components beneath + it.</para> + <example> + <title>A Sample Product</title> + <para>A company sells a software product called + <quote>X</quote>. They also maintain some older + software called <quote>Y</quote>, and have a secret + project <quote>Z</quote>. An effective use of Products + might be to create Products <quote>X</quote>, + <quote>Y</quote>, <quote>Z</quote>, each with Components + of User Interface, Database, and Business Logic. They + might also change group permissions so that only those + people who are members of Group <quote>Z</quote> can see + components and bugs under Product + <quote>Z</quote>.</para> + </example> + </glossdef> + </glossentry> + </glossdiv> + + <glossdiv id="gloss_q"> + <title>Q</title> + <glossentry> + <glossterm>QA</glossterm> + <glossdef> + <para><quote>QA</quote>, <quote>Q/A</quote>, and + <quote>Q.A.</quote> are short for <quote>Quality + Assurance</quote>. In most large software development + organizations, there is a team devoted to ensuring the + product meets minimum standards before shipping. This + team will also generally want to track the progress of + bugs over their life cycle, thus the need for the + <quote>QA Contact</quote> field in a Bug.</para> + </glossdef> + </glossentry> + </glossdiv> + + <glossdiv id="gloss_r"> + <title>R</title> + <glossentry> + <glossterm id="gloss_recursion">Recursion</glossterm> + <glossdef> + <para>The property of a function looking back at itself for + something. <quote>GNU</quote>, for instance, stands for + <quote>GNU's Not UNIX</quote>, thus recursing upon itself + for definition. For further clarity, see Infinite + Loop.</para> + </glossdef> + </glossentry> + </glossdiv> + + <glossdiv id="gloss_z"> + <title>Z</title> + <glossentry> + <glossterm>Zarro Boogs Found</glossterm> + <glossdef> + <para>This is the cryptic response sent by Bugzilla when a + query returned no results. It is just a goofy way of + saying "Zero Bugs Found".</para> + </glossdef> + </glossentry> + </glossdiv> + + </glossary> + <!-- Keep this comment at the end of the file Local variables: mode: sgml -sgml-omittag:t -sgml-shorttag:t -sgml-namecase-general:t -sgml-general-insert-case:lower -sgml-minimize-attributes:nil sgml-always-quote-attributes:t -sgml-indent-step:2 -sgml-indent-data:t -sgml-parent-document:nil +sgml-auto-insert-required-elements:t +sgml-balanced-tag-edit:t sgml-exposed-tags:nil +sgml-general-insert-case:lower +sgml-indent-data:t +sgml-indent-step:2 sgml-local-catalogs:nil sgml-local-ecat-files:nil +sgml-minimize-attributes:nil +sgml-namecase-general:t +sgml-omittag:t +sgml-parent-document:("Bugzilla-Guide.sgml" "book" "chapter") +sgml-shorttag:t +sgml-tag-region-if-active:t End: --> diff --git a/docs/xml/index.xml b/docs/xml/index.xml index e69de29bb..7ca578cfc 100644 --- a/docs/xml/index.xml +++ b/docs/xml/index.xml @@ -0,0 +1,20 @@ +<!-- Keep this comment at the end of the file +Local variables: +mode: sgml +sgml-always-quote-attributes:t +sgml-auto-insert-required-elements:t +sgml-balanced-tag-edit:t +sgml-exposed-tags:nil +sgml-general-insert-case:lower +sgml-indent-data:t +sgml-indent-step:2 +sgml-local-catalogs:nil +sgml-local-ecat-files:nil +sgml-minimize-attributes:nil +sgml-namecase-general:t +sgml-omittag:t +sgml-parent-document:("Bugzilla-Guide.sgml" "book" "chapter") +sgml-shorttag:t +sgml-tag-region-if-active:t +End: +--> diff --git a/docs/xml/installation.xml b/docs/xml/installation.xml index 8165afd6d..dfbc35071 100644 --- a/docs/xml/installation.xml +++ b/docs/xml/installation.xml @@ -1,578 +1,633 @@ -<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook V4.1//EN"> +<!-- <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook V4.1//EN"> --> -<CHAPTER id="installation"> - <TITLE>Installing Bugzilla</TITLE> + <chapter id="installation"> + <title>Installation</title> + <para> + These installation instructions are presented assuming you are + installing on a UNIX or completely POSIX-compliant system. If + you are installing on Microsoft Windows or another oddball + operating system, please consult the appropriate sections in + this installation guide for notes on how to be successful. + </para> + <section id="errata"> + <title>ERRATA</title> + <para>Here are some miscellaneous notes about possible issues you + main run into when you begin your Bugzilla installation. + Reference platforms for Bugzilla installation are Redhat Linux + 7.2, Linux-Mandrake 8.0, and Solaris 8.</para> - <SECTION id="README.unix"> - <TITLE>UNIX Installation</TITLE> - <SECTION> - <TITLE>ERRATA</TITLE> - <NOTE> - <PARA> - If you are installing Bugzilla on S.u.S.e. Linux, or some other - distributions with "paranoid" security options, it is possible - that the checksetup.pl script may fail with the error: - <ERRORNAME>cannot chdir(/var/spool/mqueue): Permission denied</ERRORNAME> - This is because your - /var/spool/mqueue directory has a mode of "drwx------". Type - <COMMAND>chmod 755 /var/spool/mqueue</COMMAND> as root to fix this problem. - </PARA> - </NOTE> + <simplelist> + <member> + If you are installing Bugzilla on S.u.S.e. Linux, or some + other distributions with <quote>paranoid</quote> security + options, it is possible that the checksetup.pl script may fail + with the error: <errorname>cannot chdir(/var/spool/mqueue): + Permission denied</errorname> This is because your + <filename>/var/spool/mqueue</filename> directory has a mode of + <quote>drwx------</quote>. Type <command>chmod 755 + <filename>/var/spool/mqueue</filename></command> as root to + fix this problem. + </member> - <NOTE> - <PARA> - Release Notes for Bugzilla 2.12 are available at docs/rel_notes.txt - </PARA> - </NOTE> + <member> + Bugzilla may be installed on Macintosh OS X (10), which is a + unix-based (BSD) operating system. Everything required for + Bugzilla on OS X will install cleanly, but the optional GD + perl module which is used for bug charting requires some + additional setup for installation. Please see the Mac OS X + installation section below for details + </member> - <NOTE> - <PARA> - The preferred documentation for Bugzilla is available in docs/, with - a variety of document types available. Please refer to these documents when - installing, configuring, and maintaining your Bugzilla installation. - </PARA> - </NOTE> + <member> + Release Notes for Bugzilla &bz-ver; are available at + <filename>docs/rel_notes.txt</filename> in your Bugzilla + source distribution. + </member> - <WARNING> - <PARA> - Bugzilla is not a package where you can just plop it in a directory, - twiddle a few things, and you're off. Installing Bugzilla assumes you - know your variant of UNIX or Microsoft Windows well, are familiar with the - command line, and are comfortable compiling and installing a plethora - of third-party utilities. To install Bugzilla on Win32 requires - fair Perl proficiency, and if you use a webserver other than Apache you - should be intimately familiar with the security mechanisms and CGI - environment thereof. - </PARA> - </WARNING> + <member> + The preferred documentation for Bugzilla is available in + docs/, with a variety of document types available. Please + refer to these documents when installing, configuring, and + maintaining your Bugzilla installation. + </member> + </simplelist> + + <warning> + <para> + Bugzilla is not a package where you can just plop it in a directory, + twiddle a few things, and you're off. Installing Bugzilla assumes you + know your variant of UNIX or Microsoft Windows well, are familiar with the + command line, and are comfortable compiling and installing a plethora + of third-party utilities. To install Bugzilla on Win32 requires + fair Perl proficiency, and if you use a webserver other than Apache you + should be intimately familiar with the security mechanisms and CGI + environment thereof. + </para> + </warning> + + <warning> + <para> + Bugzilla has not undergone a complete security review. Security holes + may exist in the code. Great care should be taken both in the installation + and usage of this software. Carefully consider the implications of + installing other network services with Bugzilla. + </para> + </warning> + </section> + + <section id="stepbystep" xreflabel="Bugzilla Installation Step-by-step"> + <title>Step-by-step Install</title> + <section> + <title>Introduction</title> + <para> + Installation of bugzilla is pretty straightforward, particularly if your + machine already has MySQL and the MySQL-related perl packages installed. + If those aren't installed yet, then that's the first order of business. The + other necessary ingredient is a web server set up to run cgi scripts. + While using Apache for your webserver is not required, it is recommended. + </para> - <WARNING> - <PARA> - Bugzilla has not undergone a complete security review. Security holes - may exist in the code. Great care should be taken both in the installation - and usage of this software. Carefully consider the implications of - installing other network services with Bugzilla. - </PARA> - </WARNING> - </SECTION> - - <SECTION> - <TITLE>Step-by-step Install</TITLE> - <SECTION> - <TITLE>Introduction</TITLE> - <PARA> - Installation of bugzilla is pretty straightforward, particularly if your - machine already has MySQL and the MySQL-related perl packages installed. - If those aren't installed yet, then that's the first order of business. The - other necessary ingredient is a web server set up to run cgi scripts. - While using Apache for your webserver is not required, it is recommended. - </PARA> - - <PARA> - Bugzilla has been successfully installed under Solaris, Linux, and - Win32. The peculiarities of installing on Win32 (Win98+/NT/2K) are not - included in this section of the Guide; please check out the "Win32 Installation Instructions" - for further advice on getting Bugzilla to work on Microsoft Windows. - </PARA> - - <PARA> - The Bugzilla Guide is contained in the "docs/" folder. It is available - in plain text (docs/txt), HTML (docs/html), or SGML source (docs/sgml). - </PARA> - </SECTION> - <SECTION> - <TITLE>Installing the Prerequisites</TITLE> - - <PARA> - The software packages necessary for the proper running of bugzilla are: - <ORDEREDLIST> - <LISTITEM> - <PARA> - MySQL database server and the mysql client (3.22.5 or greater) - </PARA> - </LISTITEM> - <LISTITEM> - <PARA> - Perl (5.004 or greater) - </PARA> - </LISTITEM> - <LISTITEM> - <PARA> - DBI Perl module - </PARA> - </LISTITEM> - <LISTITEM> - <PARA> - Data::Dumper Perl module - </PARA> - </LISTITEM> - <LISTITEM> - <PARA> - DBD::mySQL - </PARA> - </LISTITEM> - <LISTITEM> - <PARA> - TimeDate Perl module collection - </PARA> - </LISTITEM> - <LISTITEM> - <PARA> - GD perl module (1.8.3) (optional, for bug charting) - </PARA> - </LISTITEM> - <LISTITEM> - <PARA> - Chart::Base Perl module (0.99c) (optional, for bug charting) - </PARA> - </LISTITEM> - <LISTITEM> - <PARA> - DB_File Perl module (optional, for bug charting) - </PARA> - </LISTITEM> - <LISTITEM> - <PARA> - The web server of your choice. Apache is recommended. - </PARA> - </LISTITEM> - <LISTITEM> - <PARA> - MIME::Parser Perl module (optional, for contrib/bug_email.pl interface) - </PARA> - </LISTITEM> - </ORDEREDLIST> - <NOTE> - <PARA> - You must run Bugzilla on a filesystem that supports file locking via - flock(). This is necessary for Bugzilla to operate safely with multiple - instances. - </PARA> - </NOTE> - <WARNING> - <PARA> - It is a good idea, while installing Bugzilla, to ensure it is not - <EMPHASIS>accessible</EMPHASIS> by other machines on the Internet. - Your machine may be vulnerable to attacks - while you are installing. In other words, ensure there is some kind of firewall between you - and the rest of the Internet. Many installation steps require an active Internet connection - to complete, but you must take care to ensure that at no point is your machine vulnerable - to an attack. - </PARA> - </WARNING> - - </PARA> - </SECTION> - <SECTION> - <TITLE>Installing MySQL Database</TITLE> - <PARA> - Visit MySQL homepage at http://www.mysql.org/ and grab the latest stable - release of the server. Both binaries and source are available and which - you get shouldn't matter. Be aware that many of the binary versions - of MySQL store their data files in /var which on many installations - (particularly common with linux installations) is part of a smaller - root partition. If you decide to build from sources you can easily set - the dataDir as an option to configure. - </PARA> - <PARA> - If you've installed from source or non-package (RPM, deb, etc.) binaries - you'll want to make sure to add mysqld to your init scripts so the server - daemon will come back up whenever your machine reboots. - You also may want to edit those init scripts, to make sure that - mysqld will accept large packets. By default, mysqld is set up to only - accept packets up to 64K long. This limits the size of attachments you - may put on bugs. If you add something like "-O max_allowed_packet=1M" - to the command that starts mysqld (or safe_mysqld), then you will be - able to have attachments up to about 1 megabyte. - </PARA> - <NOTE> - <PARA> - If you plan on running Bugzilla and MySQL on the same machine, - consider using the "--skip-networking" option in the init script. - This enhances security by preventing network access to MySQL. - </PARA> - </NOTE> - </SECTION> - - <SECTION> - <TITLE>Perl (5.004 or greater)</TITLE> - <PARA> - Any machine that doesn't have perl on it is a sad machine indeed. Perl - for *nix systems can be gotten in source form from http://www.perl.com. - </PARA> - <PARA> - Perl is now a far cry from the the single compiler/interpreter binary it - once was. It now includes a great many required modules and quite a - few other support files. If you're not up to or not inclined to build - perl from source, you'll want to install it on your machine using some - sort of packaging system (be it RPM, deb, or what have you) to ensure - a sane install. In the subsequent sections you'll be installing quite - a few perl modules; this can be quite ornery if your perl installation - isn't up to snuff. - </PARA> - <TIP> - <PARA> - You can skip the following Perl module installation - steps by installing "Bundle::Bugzilla" from CPAN, which includes them. - All Perl module installation steps require you have an active Internet - connection. - </PARA> - <PARA> - <COMPUTEROUTPUT> - <PROMPT>bash#</PROMPT> - <COMMAND>perl -MCPAN -e 'install "Bundle::Bugzilla"'</COMMAND> - </COMPUTEROUTPUT> - </PARA> - <PARA> - Bundle::Bugzilla doesn't include GD, Chart::Base, or MIME::Parser, - which are not essential to a basic Bugzilla install. If installing - this bundle fails, you should install each module individually to - isolate the problem. - </PARA> - </TIP> - </SECTION> - - <SECTION> - <TITLE>DBI Perl Module</TITLE> - <PARA> - The DBI module is a generic Perl module used by other database related - Perl modules. For our purposes it's required by the MySQL-related - modules. As long as your Perl installation was done correctly the - DBI module should be a breeze. It's a mixed Perl/C module, but Perl's - MakeMaker system simplifies the C compilation greatly. - </PARA> - <PARA> - Like almost all Perl modules DBI can be found on the Comprehensive Perl - Archive Network (CPAN) at http://www.cpan.org. The CPAN servers have a - real tendency to bog down, so please use mirrors. The current location - at the time of this writing (02/17/99) can be found in Appendix A. - </PARA> - <PARA> - Quality, general Perl module installation instructions can be found on - the CPAN website, but the easy thing to do is to just use the CPAN shell - which does all the hard work for you. - </PARA> - <PARA> - To use the CPAN shell to install DBI: - <INFORMALEXAMPLE> - <PARA> - <COMPUTEROUTPUT> - <PROMPT>bash#</PROMPT> - <COMMAND>perl -MCPAN -e 'install "DBI"'</COMMAND> - </COMPUTEROUTPUT> - <NOTE> - <PARA>Replace "DBI" with the name of whichever module you wish - to install, such as Data::Dumper, TimeDate, GD, etc.</PARA> - </NOTE> - </PARA> - </INFORMALEXAMPLE> - To do it the hard way: - <INFORMALEXAMPLE> - <PARA> - Untar the module tarball -- it should create its own directory - </PARA> - <PARA> - CD to the directory just created, and enter the following commands: - <ORDEREDLIST> - <LISTITEM> - <PARA> - <COMPUTEROUTPUT> - <PROMPT>bash#</PROMPT> - <COMMAND>perl Makefile.PL</COMMAND> - </COMPUTEROUTPUT> - </PARA> - </LISTITEM> - <LISTITEM> - <PARA> - <COMPUTEROUTPUT> - <PROMPT>bash#</PROMPT> - <COMMAND>make</COMMAND> - </COMPUTEROUTPUT> - </PARA> - </LISTITEM> - <LISTITEM> - <PARA> - <COMPUTEROUTPUT> - <PROMPT>bash#</PROMPT> - <COMMAND>make test</COMMAND> - </COMPUTEROUTPUT> - </PARA> - </LISTITEM> - <LISTITEM> - <PARA> - <COMPUTEROUTPUT> - <PROMPT>bash#</PROMPT> - <COMMAND>make install</COMMAND> - </COMPUTEROUTPUT> - </PARA> - </LISTITEM> - </ORDEREDLIST> - If everything went ok that should be all it takes. For the vast - majority of perl modules this is all that's required. - </PARA> - </INFORMALEXAMPLE> - </PARA> - </SECTION> - <SECTION> - <TITLE>Data::Dumper Perl Module</TITLE> - <PARA> - The Data::Dumper module provides data structure persistence for Perl - (similar to Java's serialization). It comes with later sub-releases of - Perl 5.004, but a re-installation just to be sure it's available won't - hurt anything. - </PARA> - <PARA> - Data::Dumper is used by the MySQL related Perl modules. It can be - found on CPAN (link in Appendix A) and can be installed by following - the same four step make sequence used for the DBI module. - </PARA> - </SECTION> + <para> + Bugzilla has been successfully installed under Solaris, Linux, + and Win32. The peculiarities of installing on Win32 (Microsoft + Windows) are not included in this section of the Guide; please + check out the <xref linkend="win32"> for further advice + on getting Bugzilla to work on Microsoft Windows. + </para> + + <para> + The Bugzilla Guide is contained in the "docs/" folder in your + Bugzilla distribution. It is available in plain text + (docs/txt), HTML (docs/html), or SGML source (docs/sgml). + </para> + </section> + <section> + <title>Installing the Prerequisites</title> + <note> + <para>If you want to skip these manual installation steps for + the CPAN dependencies listed below, and are running the very + most recent version of Perl and MySQL (both the executables + and development libraries) on your system, check out + Bundle::Bugzilla in <xref + linkend="bundlebugzilla"></para> + </note> + <para> + The software packages necessary for the proper running of bugzilla are: + <orderedlist> + <listitem> + <para> + MySQL database server and the mysql client (3.22.5 or greater) + </para> + </listitem> + <listitem> + <para> + Perl (5.004 or greater, 5.6.1 is recommended if you wish + to use Bundle::Bugzilla) + </para> + </listitem> + <listitem> + <para> + DBI Perl module + </para> + </listitem> + <listitem> + <para> + Data::Dumper Perl module + </para> + </listitem> + <listitem> + <para> + Bundle::Mysql Perl module collection + </para> + </listitem> + <listitem> + <para> + TimeDate Perl module collection + </para> + </listitem> + <listitem> + <para> + GD perl module (1.8.3) (optional, for bug charting) + </para> + </listitem> + <listitem> + <para> + Chart::Base Perl module (0.99c) (optional, for bug charting) + </para> + </listitem> + <listitem> + <para> + DB_File Perl module (optional, for bug charting) + </para> + </listitem> + <listitem> + <para> + The web server of your choice. Apache is recommended. + </para> + </listitem> + <listitem> + <para> + MIME::Parser Perl module (optional, for contrib/bug_email.pl interface) + </para> + </listitem> + </orderedlist> - <SECTION> - <TITLE>MySQL related Perl Module Collection</TITLE> - <PARA> - The Perl/MySQL interface requires a few mutually-dependent perl - modules. These modules are grouped together into the the - Msql-Mysql-modules package. This package can be found at CPAN. - After the archive file has been downloaded it should - be untarred. - </PARA> - <PARA> - The MySQL modules are all built using one make file which is generated - by running: - <PROMPT>bash#</PROMPT> - <COMMAND>perl Makefile.pl</COMMAND> - </PARA> - <PARA> - The MakeMaker process will ask you a few questions about the desired - compilation target and your MySQL installation. For many of the questions - the provided default will be adequate. - </PARA> - <PARA> - When asked if your desired target is the MySQL or mSQL packages - selected the MySQL related ones. Later you will be asked if you wish - to provide backwards compatibility with the older MySQL packages; you - must answer YES to this question. The default will be no, and if you - select it things won't work later. - </PARA> - <PARA> + <warning> + <para> + It is a good idea, while installing Bugzilla, to ensure it + is not <emphasis>accessible</emphasis> by other machines + on the Internet. Your machine may be vulnerable to attacks + while you are installing. In other words, ensure there is + some kind of firewall between you and the rest of the + Internet. Many installation steps require an active + Internet connection to complete, but you must take care to + ensure that at no point is your machine vulnerable to an + attack. + </para> + </warning> + + </para> + </section> + <section id="install-mysql"> + <title>Installing MySQL Database</title> + <para> + Visit MySQL homepage at http://www.mysql.com/ and grab the + latest stable release of the server. Both binaries and source + are available and which you get shouldn't matter. Be aware + that many of the binary versions of MySQL store their data + files in /var which on many installations (particularly common + with linux installations) is part of a smaller root partition. + If you decide to build from sources you can easily set the + dataDir as an option to configure. + </para> + <para> + If you've installed from source or non-package (RPM, deb, + etc.) binaries you'll want to make sure to add mysqld to your + init scripts so the server daemon will come back up whenever + your machine reboots. You also may want to edit those init + scripts, to make sure that mysqld will accept large packets. + By default, mysqld is set up to only accept packets up to 64K + long. This limits the size of attachments you may put on + bugs. If you add something like "-O max_allowed_packet=1M" to + the command that starts mysqld (or safe_mysqld), then you will + be able to have attachments up to about 1 megabyte. + </para> + <note> + <para> + If you plan on running Bugzilla and MySQL on the same + machine, consider using the "--skip-networking" option in + the init script. This enhances security by preventing + network access to MySQL. + </para> + </note> + </section> + + <section id="install-perl"> + <title>Perl (5.004 or greater)</title> + <para> + Any machine that doesn't have perl on it is a sad machine + indeed. Perl for *nix systems can be gotten in source form + from http://www.perl.com. Although Bugzilla runs with most + post-5.004 versions of Perl, it's a good idea to be up to the + very latest version if you can when running Bugzilla. As of + this writing, that is perl version &perl-ver;. + </para> + <para> + Perl is now a far cry from the the single compiler/interpreter + binary it once was. It includes a great many required modules + and quite a few other support files. If you're not up to or + not inclined to build perl from source, you'll want to install + it on your machine using some sort of packaging system (be it + RPM, deb, or what have you) to ensure a sane install. In the + subsequent sections you'll be installing quite a few perl + modules; this can be quite ornery if your perl installation + isn't up to snuff. + </para> + <warning> + <para>Many people complain that Perl modules will not install + for them. Most times, the error messages complain that they + are missing a file in <quote>@INC</quote>. Virtually every + time, this is due to permissions being set too restrictively + for you to compile Perl modules or not having the necessary + Perl development libraries installed on your system.. + Consult your local UNIX systems administrator for help + solving these permissions issues; if you + <emphasis>are</emphasis> the local UNIX sysadmin, please + consult the newsgroup/mailing list for further assistance or + hire someone to help you out. + </para> + </warning> + <tip id="bundlebugzilla" xreflabel="Using Bundle::Bugzilla instead of manually installing Perl modules"> + <para> + You can skip the following Perl module installation steps by + installing "Bundle::Bugzilla" from CPAN, which includes + them. All Perl module installation steps require you have an + active Internet connection. If you wish to use + Bundle::Bugzilla, however, you must be using the latest + version of Perl (at this writing, version &perl-ver;) + </para> + <para> + <computeroutput> <prompt>bash#</prompt> <command>perl -MCPAN + -e 'install "Bundle::Bugzilla"'</command> + </computeroutput> + </para> + <para> + Bundle::Bugzilla doesn't include GD, Chart::Base, or + MIME::Parser, which are not essential to a basic Bugzilla + install. If installing this bundle fails, you should + install each module individually to isolate the problem. + </para> + </tip> + </section> + + <section> + <title>DBI Perl Module</title> + <para> + The DBI module is a generic Perl module used by other database related + Perl modules. For our purposes it's required by the MySQL-related + modules. As long as your Perl installation was done correctly the + DBI module should be a breeze. It's a mixed Perl/C module, but Perl's + MakeMaker system simplifies the C compilation greatly. + </para> + <para> + Like almost all Perl modules DBI can be found on the Comprehensive Perl + Archive Network (CPAN) at http://www.cpan.org. The CPAN servers have a + real tendency to bog down, so please use mirrors. The current location + at the time of this writing (02/17/99) can be found in Appendix A. + </para> + <para> + Quality, general Perl module installation instructions can be found on + the CPAN website, but the easy thing to do is to just use the CPAN shell + which does all the hard work for you. + </para> + <para> + To use the CPAN shell to install DBI: + <informalexample> + <para> + <computeroutput> + <prompt>bash#</prompt> + <command>perl -MCPAN -e 'install "DBI"'</command> + </computeroutput> + <note> + <para>Replace "DBI" with the name of whichever module you wish + to install, such as Data::Dumper, TimeDate, GD, etc.</para> + </note> + </para> + </informalexample> + To do it the hard way: + <informalexample> + <para> + Untar the module tarball -- it should create its own directory + </para> + <para> + CD to the directory just created, and enter the following commands: + <orderedlist> + <listitem> + <para> + <computeroutput> + <prompt>bash#</prompt> + <command>perl Makefile.PL</command> + </computeroutput> + </para> + </listitem> + <listitem> + <para> + <computeroutput> + <prompt>bash#</prompt> + <command>make</command> + </computeroutput> + </para> + </listitem> + <listitem> + <para> + <computeroutput> + <prompt>bash#</prompt> + <command>make test</command> + </computeroutput> + </para> + </listitem> + <listitem> + <para> + <computeroutput> + <prompt>bash#</prompt> + <command>make install</command> + </computeroutput> + </para> + </listitem> + </orderedlist> + If everything went ok that should be all it takes. For the vast + majority of perl modules this is all that's required. + </para> + </informalexample> + </para> + </section> + <section> + <title>Data::Dumper Perl Module</title> + <para> + The Data::Dumper module provides data structure persistence for Perl + (similar to Java's serialization). It comes with later sub-releases of + Perl 5.004, but a re-installation just to be sure it's available won't + hurt anything. + </para> + <para> + Data::Dumper is used by the MySQL-related Perl modules. It can be + found on CPAN (link in Appendix A) and can be installed by following + the same four step make sequence used for the DBI module. + </para> + </section> + + <section> + <title>MySQL related Perl Module Collection</title> + <para> + The Perl/MySQL interface requires a few mutually-dependent perl + modules. These modules are grouped together into the the + Msql-Mysql-modules package. This package can be found at CPAN. + After the archive file has been downloaded it should + be untarred. + </para> + <para> + The MySQL modules are all built using one make file which is generated + by running: + <prompt>bash#</prompt> + <command>perl Makefile.pl</command> + </para> + <para> + The MakeMaker process will ask you a few questions about the desired + compilation target and your MySQL installation. For many of the questions + the provided default will be adequate. + </para> + <para> + When asked if your desired target is the MySQL or mSQL packages, + select the MySQL related ones. Later you will be asked if you wish + to provide backwards compatibility with the older MySQL packages; you + should answer YES to this question. The default is NO. + </para> + <para> A host of 'localhost' should be fine and a testing user of 'test' and a null password should find itself with sufficient access to run tests on the 'test' database which MySQL created upon installation. If 'make test' and 'make install' go through without errors you should be ready to go as far as database connectivity is concerned. - </PARA> - </SECTION> + </para> + </section> - <SECTION> - <TITLE>TimeDate Perl Module Collection</TITLE> - <PARA> + <section> + <title>TimeDate Perl Module Collection</title> + <para> Many of the more common date/time/calendar related Perl modules have been grouped into a bundle similar to the MySQL modules bundle. This - bundle is stored on the CPAN under the name TimeDate. A (hopefully - current) link can be found in Appendix A. The component module we're + bundle is stored on the CPAN under the name TimeDate. A link + link may be found in Appendix B, Software Download Links. + The component module we're most interested in is the Date::Format module, but installing all of them is probably a good idea anyway. The standard Perl module installation instructions should work perfectly for this simple package. - </PARA> - </SECTION> - <SECTION> - <TITLE>GD Perl Module (1.8.3)</TITLE> - <PARA> + </para> + </section> + <section> + <title>GD Perl Module (1.8.3)</title> + <para> The GD library was written by Thomas Boutell a long while ago to programatically generate images in C. Since then it's become almost a defacto standard for programatic image construction. The Perl bindings to it found in the GD library are used on a million web pages to generate graphs on the fly. That's what bugzilla will be using it for so you'd better install it if you want any of the graphing to work. - </PARA> - <PARA> + </para> + <para> Actually bugzilla uses the Graph module which relies on GD itself, but isn't that always the way with OOP. At any rate, you can find the - GD library on CPAN (link in Appendix "Required Software"). - </PARA> - <NOTE> - <PARA> + GD library on CPAN (link in Appendix B, Software Download Links). + </para> + <note> + <para> The Perl GD library requires some other libraries that may or may not be installed on your system, including "libpng" and "libgd". The full requirements are listed in the Perl GD library README. Just realize that if compiling GD fails, it's probably because you're missing a required library. - </PARA> - </NOTE> - </SECTION> + </para> + </note> + </section> - <SECTION> - <TITLE>Chart::Base Perl Module (0.99c)</TITLE> - <PARA> + <section> + <title>Chart::Base Perl Module (0.99c)</title> + <para> The Chart module provides bugzilla with on-the-fly charting abilities. It can be installed in the usual fashion after it has been fetched from CPAN where it is found as the Chart-x.x... tarball in a - directory to be listed in Appendix "Required Software". Note that as with the GD perl - module, only the specific versions listed above (or newer) will work. Earlier + directory to be listed in Appendix B, "Software Download Links". + Note that as with the GD perl + module, only the version listed above, or newer, will work. + Earlier versions used GIF's, which are no longer supported by the latest versions of GD. - </PARA> - </SECTION> + </para> + </section> - <SECTION> - <TITLE>DB_File Perl Module</TITLE> - <PARA> + <section> + <title>DB_File Perl Module</title> + <para> DB_File is a module which allows Perl programs to make use of the facilities provided by Berkeley DB version 1.x. This module is required by collectstats.pl which is used for bug charting. If you plan to make use of bug charting, you must install this module. - </PARA> - </SECTION> + </para> + </section> - <SECTION> - <TITLE>HTTP Server</TITLE> - <PARA> + <section> + <title>HTTP Server</title> + <para> You have a freedom of choice here - Apache, Netscape or any other server on UNIX would do. You can easily run the web server on a different machine than MySQL, but need to adjust the MySQL "bugs" user permissions accordingly. - </PARA> - <PARA> + </para> + <para> You'll want to make sure that your web server will run any file with the .cgi extension as a cgi and not just display it. If you're using apache that means uncommenting the following line in the srm.conf file: - <COMPUTEROUTPUT>AddHandler cgi-script .cgi</COMPUTEROUTPUT> - </PARA> - <PARA> + <computeroutput>AddHandler cgi-script .cgi</computeroutput> + </para> + <para> With apache you'll also want to make sure that within the access.conf file the line: - <COMPUTEROUTPUT> + <computeroutput> Options ExecCGI - </COMPUTEROUTPUT> + </computeroutput> is in the stanza that covers the directories you intend to put the bugzilla .html and .cgi files into. - </PARA> - <PARA> + </para> + <para> If you are using a newer version of Apache, both of the above lines will be (or will need to be) in the httpd.conf file, rather than srm.conf or access.conf. - </PARA> - <WARNING> - <PARA> + </para> + <warning> + <para> There are two critical directories and a file that should not be a served by - the HTTP server. These are the 'data' and 'shadow' directories and the - 'localconfig' file. You should configure your HTTP server to not serve + the HTTP server. These are the <quote>data</quote> and <quote>shadow</quote> + directories and the + <quote>localconfig</quote> file. You should configure your HTTP server to not serve content from these files. Failure to do so will expose critical passwords - and other data. Please see your HTTP server configuration manual on how - to do this. If you use quips (at the top of the buglist pages) you will want - the 'data/comments' file to still be served. This file contains those quips. - </PARA> - </WARNING> - </SECTION> + and other data. Please see <xref linkend="htaccess"> for details. + </para> + </warning> + </section> - <SECTION> - <TITLE>Installing the Bugzilla Files</TITLE> - <PARA> + <section> + <title>Installing the Bugzilla Files</title> + <para> You should untar the Bugzilla files into a directory that you're willing to make writable by the default web server user (probably - 'nobody'). You may decide to put the files off of the main web space + <quote>nobody</quote>). You may decide to put the files off of the main web space for your web server or perhaps off of /usr/local with a symbolic link in the web space that points to the bugzilla directory. At any rate, just dump all the files in the same place (optionally omitting the CVS directories if they were accidentally tarred up with the rest of Bugzilla) and make sure you can access the files in that directory through your web server. - </PARA> - <TIP> - <PARA> + </para> + <tip> + <para> If you symlink the bugzilla directory into your Apache's HTML heirarchy, you may receive "Forbidden" errors unless you add the "FollowSymLinks" directive to the <Directory> entry for the HTML root. - </PARA> - </TIP> - <PARA> + </para> + </tip> + <para> Once all the files are in a web accessible directory, make that directory writable by your webserver's user (which may require just making it world writable). This is a temporary step until you run - the post-install "checksetup.pl" script, which locks down your + the post-install <quote>checksetup.pl</quote> script, which locks down your installation. - </PARA> - <PARA> + </para> + <para> Lastly, you'll need to set up a symbolic link to /usr/bonsaitools/bin/perl for the correct location of your perl executable (probably /usr/bin/perl). Otherwise you must hack all the .cgi files to change where they look for perl. To make future upgrades easier, you should use the symlink approach. - <EXAMPLE> - <TITLE>Setting up bonsaitools symlink</TITLE> - <PARA> + <example> + <title>Setting up bonsaitools symlink</title> + <para> Here's how you set up the Perl symlink on Linux to make Bugzilla work. Your mileage may vary; if you are running on Solaris, you probably need to subsitute - "/usr/local/bin/perl" for "/usr/bin/perl" below; if on certain other UNIX systems, - Perl may live in weird places like "/opt/perl". As root, run these commands: - <PROGRAMLISTING> + <quote>/usr/local/bin/perl</quote> for <quote>/usr/bin/perl</quote> + below; if on certain other UNIX systems, + Perl may live in weird places like <quote>/opt/perl</quote>. As root, run these commands: + <programlisting> bash# mkdir /usr/bonsaitools bash# mkdir /usr/bonsaitools/bin bash# ln -s /usr/bin/perl /usr/bosaitools/bin/perl - </PROGRAMLISTING> - </PARA> - </EXAMPLE> - <TIP> - <PARA> - If you don't have root access to set this symlink up, check out the - "setperl.csh" utility, listed in the Patches section of this - Guide. It will change the path to perl in all your Bugzilla files for - you. - </PARA> - </TIP> - </PARA> - </SECTION> + </programlisting> + </para> + </example> + <tip> + <para> + If you don't have root access to set this symlink up, + check out the + <xref linkend="setperl">, listed in <xref linkend="patches">. + It will change the path to perl in all your Bugzilla files for you. + </para> + </tip> + </para> + </section> - <SECTION> - <TITLE>Setting Up the MySQL Database</TITLE> - <PARA> + <section> + <title>Setting Up the MySQL Database</title> + <para> After you've gotten all the software installed and working you're ready to start preparing the database for its life as a the back end to a high quality bug tracker. - </PARA> - <PARA> + </para> + <para> First, you'll want to fix MySQL permissions to allow access from Bugzilla. For the purpose of this Installation section, the Bugzilla username - will be "bugs", and will have minimal permissions. Bugzilla has - not undergone a thorough security audit. It may be possible for - a system cracker to somehow trick Bugzilla into executing a command - such as "; DROP DATABASE mysql". - </PARA> - <PARA> - That would be bad. - </PARA> - <PARA> + will be "bugs", and will have minimal permissions. + + <warning> + <para> + Bugzilla has not undergone a thorough security audit. It + may be possible for a system cracker to somehow trick + Bugzilla into executing a command such as <command>DROP + DATABASE mysql</command>. + </para> + <para>That would be bad.</para> + </warning> + </para> + + <para> Give the MySQL root user a password. MySQL passwords are limited to 16 characters. - <SIMPLELIST> - <MEMBER> - <COMPUTEROUTPUT> - <PROMPT>bash#</PROMPT> - <COMMAND>mysql -u root mysql</COMMAND> - </COMPUTEROUTPUT> - </MEMBER> - <MEMBER> - <COMPUTEROUTPUT> - <PROMPT>mysql></PROMPT> - <COMMAND> + <simplelist> + <member> + <computeroutput> + <prompt>bash#</prompt> + <command>mysql -u root mysql</command> + </computeroutput> + </member> + <member> + <computeroutput> + <prompt>mysql></prompt> + <command> UPDATE user SET Password=PASSWORD ('new_password') WHERE user='root'; - </COMMAND> - </COMPUTEROUTPUT> - </MEMBER> - <MEMBER> - <COMPUTEROUTPUT> - <PROMPT>mysql></PROMPT> - <COMMAND>FLUSH PRIVILEGES;</COMMAND> - </COMPUTEROUTPUT> - </MEMBER> - </SIMPLELIST> + </command> + </computeroutput> + </member> + <member> + <computeroutput> + <prompt>mysql></prompt> + <command>FLUSH PRIVILEGES;</command> + </computeroutput> + </member> + </simplelist> From this point on, if you need to access MySQL as the MySQL root user, you will need to use "mysql -u root -p" and enter your new_password. Remember that MySQL user names have nothing to do with Unix user names (login names). - </PARA> - <PARA> + </para> + <para> Next, we create the "bugs" user, and grant sufficient permissions for checksetup.pl, which we'll use later, to work its magic. This also restricts the "bugs" user to operations @@ -580,755 +635,1091 @@ bash# ln -s /usr/bin/perl /usr/bosaitools/bin/perl to connect from "localhost". Modify it to reflect your setup if you will be connecting from another machine or as a different user. - </PARA> - <PARA> + </para> + <para> Remember to set bugs_password to some unique password. - <SIMPLELIST> - <MEMBER> - <COMPUTEROUTPUT> - <PROMPT>mysql></PROMPT> - <COMMAND>GRANT SELECT,INSERT,UPDATE,DELETE,INDEX, + <simplelist> + <member> + <computeroutput> + <prompt>mysql></prompt> + <command>GRANT SELECT,INSERT,UPDATE,DELETE,INDEX, ALTER,CREATE,DROP,REFERENCES ON bugs.* TO bugs@localhost - IDENTIFIED BY 'bugs_password';</COMMAND> - </COMPUTEROUTPUT> - </MEMBER> - <MEMBER> - <COMPUTEROUTPUT> - <PROMPT> + IDENTIFIED BY 'bugs_password';</command> + </computeroutput> + </member> + <member> + <computeroutput> + <prompt> mysql> - </PROMPT> - <COMMAND> + </prompt> + <command> FLUSH PRIVILEGES; - </COMMAND> - </COMPUTEROUTPUT> - </MEMBER> - </SIMPLELIST> - </PARA> - <PARA> + </command> + </computeroutput> + </member> + </simplelist> + </para> + <para> Next, run the magic checksetup.pl script. (Many thanks to Holger Schurig <holgerschurig@nikocity.de> for writing this script!) It will make sure Bugzilla files and directories have reasonable permissions, set up the "data" directory, and create all the MySQL tables. - <SIMPLELIST> - <MEMBER> - <COMPUTEROUTPUT> - <PROMPT>bash#</PROMPT> - <COMMAND>./checksetup.pl</COMMAND> - </COMPUTEROUTPUT> - </MEMBER> - </SIMPLELIST> + <simplelist> + <member> + <computeroutput> + <prompt>bash#</prompt> + <command>./checksetup.pl</command> + </computeroutput> + </member> + </simplelist> The first time you run it, it will create a file called "localconfig". - </PARA> - </SECTION> + </para> + </section> - <SECTION> - <TITLE>Tweaking "localconfig"</TITLE> - <PARA> + <section> + <title>Tweaking "localconfig"</title> + <para> This file contains a variety of settings you may need to tweak including how Bugzilla should connect to the MySQL database. - </PARA> - <PARA> + </para> + <para> The connection settings include: - <ORDEREDLIST> - <LISTITEM> - <PARA> + <orderedlist> + <listitem> + <para> server's host: just use "localhost" if the MySQL server is local - </PARA> - </LISTITEM> - <LISTITEM> - <PARA> + </para> + </listitem> + <listitem> + <para> database name: "bugs" if you're following these directions - </PARA> - </LISTITEM> - <LISTITEM> - <PARA> + </para> + </listitem> + <listitem> + <para> MySQL username: "bugs" if you're following these directions - </PARA> - </LISTITEM> - <LISTITEM> - <PARA> + </para> + </listitem> + <listitem> + <para> Password for the "bugs" MySQL account above - </PARA> - </LISTITEM> - </ORDEREDLIST> - </PARA> - <PARA> + </para> + </listitem> + </orderedlist> + </para> + <para> + You may also install .htaccess files that the Apache webserver will use + to restrict access to Bugzilla data files. See <xref linkend="htaccess">. + </para> + <para> Once you are happy with the settings, re-run checksetup.pl. On this second run, it will create the database and an administrator account for which you will be prompted to provide information. - </PARA> - <PARA> + </para> + <para> When logged into an administrator account once Bugzilla is running, if you go to the query page (off of the bugzilla main menu), you'll find an 'edit parameters' option that is filled with editable treats. - </PARA> - <PARA> + </para> + <para> Should everything work, you should have a nearly empty copy of the bug tracking setup. - </PARA> - <PARA> + </para> + <para> The second time around, checksetup.pl will stall if it is on a filesystem that does not fully support file locking via flock(), such as NFS mounts. This support is required for Bugzilla to operate safely with multiple instances. If flock() is not fully supported, it will stall at: - <ERRORCODE>Now regenerating the shadow database for all bugs.</ERRORCODE> - <NOTE> - <PARA> + <errorcode>Now regenerating the shadow database for all bugs.</errorcode> + <note> + <para> The second time you run checksetup.pl, you should become the - user your web server runs as, and that you ensure you have set the - "webservergroup" parameter in localconfig to match the web server's group - name, if any. I believe, for the next release of Bugzilla, this will - be fixed so that Bugzilla supports a "webserveruser" parameter in localconfig + user your web server runs as, and that you ensure that you set the + "webservergroup" parameter in localconfig to match the web + server's group + name, if any. I believe, for the next release of Bugzilla, + this will + be fixed so that Bugzilla supports a "webserveruser" parameter + in localconfig as well. - <EXAMPLE> - <TITLE>Running checksetup.pl as the web user</TITLE> - <PARA> - Assuming your web server runs as user "apache", and Bugzilla is installed in - "/usr/local/bugzilla", here's one way to run checksetup.pl as the web server user. - As root, for the <EMPHASIS>second run</EMPHASIS> of checksetup.pl, do this: - <PROGRAMLISTING> + <example> + <title>Running checksetup.pl as the web user</title> + <para> + Assuming your web server runs as user "apache", + and Bugzilla is installed in + "/usr/local/bugzilla", here's one way to run checksetup.pl + as the web server user. + As root, for the <emphasis>second run</emphasis> + of checksetup.pl, do this: + <programlisting> bash# chown -R apache:apache /usr/local/bugzilla bash# su - apache bash# cd /usr/local/bugzilla bash# ./checksetup.pl - </PROGRAMLISTING> - </PARA> - </EXAMPLE> - </PARA> - </NOTE> - </PARA> - <NOTE> - <PARA> - The checksetup.pl script is designed so that you can run it at any time - without causing harm. You should run it after any upgrade to Bugzilla. - </PARA> - </NOTE> - </SECTION> - - <SECTION> - <TITLE>Setting Up Maintainers Manually (Optional)</TITLE> - <PARA> - If you want to add someone else to every group by hand, you can do it - by typing the appropriate MySQL commands. Run '<COMPUTEROUTPUT> - mysql -u root -p bugs</COMPUTEROUTPUT>' - (you may need different parameters, depending on your security settings - according to section 3, above). Then: - <SIMPLELIST> - <MEMBER> - <COMPUTEROUTPUT> - <PROMPT>mysql></PROMPT> - <COMMAND>update profiles set groupset=0x7fffffffffffffff - where login_name = 'XXX';</COMMAND> - </COMPUTEROUTPUT> - </MEMBER> - </SIMPLELIST> - replacing XXX with the Bugzilla email address. - </PARA> - </SECTION> + </programlisting> + </para> + </example> + </para> + </note> + </para> + <note> + <para> + The checksetup.pl script is designed so that you can run + it at any time without causing harm. You should run it + after any upgrade to Bugzilla. + </para> + </note> + </section> - <SECTION> - <TITLE>The Whining Cron (Optional)</TITLE> - <PARA> - By now you've got a fully functional bugzilla, but what good are bugs - if they're not annoying? To help make those bugs more annoying you can - set up bugzilla's automatic whining system. This can be done by adding - the following command as a daily crontab entry (for help on that see that - crontab man page): - <SIMPLELIST> - <MEMBER> - <COMPUTEROUTPUT> - <COMMAND>cd <your-bugzilla-directory> ; ./whineatnews.pl</COMMAND> - </COMPUTEROUTPUT> - </MEMBER> - </SIMPLELIST> - </PARA> - </SECTION> + <section> + <title>Setting Up Maintainers Manually (Optional)</title> + <para> + If you want to add someone else to every group by hand, you + can do it by typing the appropriate MySQL commands. Run + '<computeroutput> mysql -u root -p bugs</computeroutput>' You + may need different parameters, depending on your security + settings. Then: + <simplelist> + <member> + <computeroutput> <prompt>mysql></prompt> <command>update + profiles set groupset=0x7fffffffffffffff where + login_name = 'XXX';</command> </computeroutput> + </member> + </simplelist> replacing XXX with the Bugzilla email address. + </para> + </section> - <SECTION> - <TITLE>Bug Graphs (Optional)</TITLE> - <PARA> - As long as you installed the GD and Graph::Base Perl modules you might - as well turn on the nifty bugzilla bug reporting graphs. - </PARA> - <PARA> - Add a cron entry like this to run collectstats daily at 5 after midnight: - <SIMPLELIST> - <MEMBER> - <COMPUTEROUTPUT> - <PROMPT>bash#</PROMPT> - <COMMAND>crontab -e</COMMAND> - </COMPUTEROUTPUT> - </MEMBER> - <MEMBER> - <COMPUTEROUTPUT> - 5 0 * * * cd <your-bugzilla-directory> ; ./collectstats.pl - </COMPUTEROUTPUT> - </MEMBER> - </SIMPLELIST> - </PARA> - <PARA> - After two days have passed you'll be able to view bug graphs from the - Bug Reports page. - </PARA> - </SECTION> + <section> + <title>The Whining Cron (Optional)</title> + <para> + By now you have a fully functional bugzilla, but what good + are bugs if they're not annoying? To help make those bugs + more annoying you can set up bugzilla's automatic whining + system. This can be done by adding the following command as a + daily crontab entry (for help on that see that crontab man + page): + <simplelist> + <member> + <computeroutput> <command>cd + <your-bugzilla-directory> ; + ./whineatnews.pl</command> </computeroutput> + </member> + </simplelist> + </para> + <tip> + <para> + Depending on your system, crontab may have several manpages. + The following command should lead you to the most useful + page for this purpose: + <programlisting> + man 5 crontab + </programlisting> + </para> + </tip> + </section> + + <section> + <title>Bug Graphs (Optional)</title> + <para> + As long as you installed the GD and Graph::Base Perl modules + you might as well turn on the nifty bugzilla bug reporting + graphs. + </para> + <para> + Add a cron entry like this to run collectstats daily at 5 + after midnight: + <simplelist> + <member> + <computeroutput> <prompt>bash#</prompt> <command>crontab + -e</command> </computeroutput> + </member> + <member> + <computeroutput> 5 0 * * * cd + <your-bugzilla-directory> ; ./collectstats.pl + </computeroutput> + </member> + </simplelist> + </para> + <para> + After two days have passed you'll be able to view bug graphs + from the Bug Reports page. + </para> + </section> + + <section> + <title>Securing MySQL</title> + <para> + If you followed the installation instructions for setting up + your "bugs" and "root" user in MySQL, much of this should not + apply to you. If you are upgrading an existing installation + of Bugzilla, you should pay close attention to this section. + </para> + <para> + Most MySQL installs have "interesting" default security parameters: + <simplelist> + <member>mysqld defaults to running as root</member> + <member>it defaults to allowing external network connections</member> + <member>it has a known port number, and is easy to detect</member> + <member>it defaults to no passwords whatsoever</member> + <member>it defaults to allowing "File_Priv"</member> + </simplelist> + </para> + <para> + This means anyone from anywhere on the internet can not only + drop the database with one SQL command, and they can write as + root to the system. + </para> + <para> + To see your permissions do: + <simplelist> + <member> + <computeroutput> + <prompt>bash#</prompt> + <command>mysql -u root -p</command> + </computeroutput> + </member> + <member> + <computeroutput> + <prompt>mysql></prompt> + <command>use mysql;</command> + </computeroutput> + </member> + <member> + <computeroutput> + <prompt>mysql></prompt> + <command>show tables;</command> + </computeroutput> + </member> + <member> + <computeroutput> + <prompt>mysql></prompt> + <command>select * from user;</command> + </computeroutput> + </member> + <member> + <computeroutput> + <prompt>mysql></prompt> + <command>select * from db;</command> + </computeroutput> + </member> + </simplelist> + </para> + <para> + To fix the gaping holes: + <simplelist> + <member>DELETE FROM user WHERE User='';</member> + <member>UPDATE user SET Password=PASSWORD('new_password') WHERE user='root';</member> + <member> FLUSH PRIVILEGES;</member> + </simplelist> + </para> + <para> + If you're not running "mit-pthreads" you can use: + <simplelist> + <member>GRANT USAGE ON *.* TO bugs@localhost;</member> + <member>GRANT ALL ON bugs.* TO bugs@localhost;</member> + <member>REVOKE DROP ON bugs.* FROM bugs@localhost;</member> + <member>FLUSH PRIVILEGES;</member> + </simplelist> + </para> + <para> + With "mit-pthreads" you'll need to modify the "globals.pl" Mysql->Connect + line to specify a specific host name instead of "localhost", and accept + external connections: + <simplelist> + <member>GRANT USAGE ON *.* TO bugs@bounce.hop.com;</member> + <member>GRANT ALL ON bugs.* TO bugs@bounce.hop.com;</member> + <member>REVOKE DROP ON bugs.* FROM bugs@bounce.hop.com;</member> + <member>FLUSH PRIVILEGES;</member> + </simplelist> + </para> + <para> + Use .htaccess files with the Apache webserver to secure your + bugzilla install. See <xref linkend="htaccess"> + </para> + <para> + Consider also: + <orderedlist> + <listitem> + <para> + Turning off external networking with "--skip-networking", + unless you have "mit-pthreads", in which case you can't. + Without networking, MySQL connects with a Unix domain socket. + </para> + </listitem> + <listitem> + <para> + using the --user= option to mysqld to run it as an unprivileged + user. + </para> + </listitem> + <listitem> + <para> + starting MySQL in a chroot jail + </para> + </listitem> + <listitem> + <para> + running the httpd in a "chrooted" jail + </para> + </listitem> + <listitem> + <para> + making sure the MySQL passwords are different from the OS + passwords (MySQL "root" has nothing to do with system "root"). + </para> + </listitem> + <listitem> + <para> + running MySQL on a separate untrusted machine + </para> + </listitem> + <listitem> + <para> + making backups ;-) + </para> + </listitem> + </orderedlist> + </para> + </section> + </section> + <section id="osx"> + <title>Mac OS X Installation Notes</title> + <para> + There are a lot of common libraries and utilities out there + that Apple did not include with Mac OS X, but which run + perfectly well on it. The GD library, which Bugzilla needs to + do bug graphs, is one of these. + </para> + <para> + The easiest way to get a lot of these is with a program called + Fink, which is similar in nature to the CPAN installer, but + installs common GNU utilities. Fink is available from + <http://sourceforge.net/projects/fink/>. + </para> + <para> + Follow the instructions for setting up Fink. Once it's + installed, you'll want to run the following as root: + <command>fink install gd</command> + </para> + <para> + It will prompt you for a number of dependencies, type 'y' and + hit enter to install all of the dependencies. Then watch it + work. + </para> + <para> + To prevent creating conflicts with the software that Apple + installs by default, Fink creates its own directory tree at + /sw where it installs most of the software that it installs. + This means your libraries and headers for libgd will be at + /sw/lib and /sw/include instead of /usr/lib and + /usr/local/include. Because of these changed locations for + the libraries, the Perl GD module will not install directly + via CPAN (it looks for the specific paths instead of getting + them from your environment). But there's a way around that + :-) + </para> + <para> + Instead of typing <quote>install GD</quote> at the + <prompt>cpan></prompt> prompt, type <command>look + GD</command>. This should go through the motions of + downloading the latest version of the GD module, then it will + open a shell and drop you into the build directory. Apply the + following patch to the Makefile.PL file (save the patch into a + file and use the command <command>patch < + patchfile</command>: + </para> + <para> + <programlisting> +<![CDATA[ + +--- GD-1.33/Makefile.PL Fri Aug 4 16:59:22 2000 ++++ GD-1.33-darwin/Makefile.PL Tue Jun 26 01:29:32 2001 +@@ -3,8 +3,8 @@ + warn "NOTICE: This module requires libgd 1.8.3 or higher (shared library version 4.X).\n"; + + # =====> PATHS: CHECK AND ADJUST <===== +-my @INC = qw(-I/usr/local/include -I/usr/local/include/gd); +-my @LIBPATH = qw(-L/usr/lib/X11 -L/usr/X11R6/lib -L/usr/X11/lib -L/usr/local/lib ); ++my @INC = qw(-I/sw/include -I/sw/include/gd -I/usr/local/include -I/usr/local/include/gd); ++my @LIBPATH = qw(-L/usr/lib/X11 -L/usr/X11R6/lib -L/usr/X11/lib -L/sw/lib -L/usr/local/lib); + my @LIBS = qw(-lgd -lpng -lz); + + # FEATURE FLAGS +@@ -23,7 +23,7 @@ + + push @LIBS,'-lttf' if $TTF; + push @LIBS,'-ljpeg' if $JPEG; +-push @LIBS, '-lm' unless $^O eq 'MSWin32'; ++push @LIBS, '-lm' unless ($^O =~ /^MSWin32|darwin$/); + + # FreeBSD 3.3 with libgd built from ports croaks if -lXpm is specified + if ($^O ne 'freebsd' && $^O ne 'MSWin32') { - <SECTION> - <TITLE>Securing MySQL</TITLE> - <PARA> - If you followed the README for setting up your "bugs" and "root" user in - MySQL, much of this should not apply to you. If you are upgrading - an existing installation of Bugzilla, you should pay close attention - to this section. - </PARA> - <PARA> - Most MySQL installs have "interesting" default security parameters: - <SIMPLELIST> - <MEMBER>mysqld defaults to running as root</MEMBER> - <MEMBER>it defaults to allowing external network connections</MEMBER> - <MEMBER>it has a known port number, and is easy to detect</MEMBER> - <MEMBER>it defaults to no passwords whatsoever</MEMBER> - <MEMBER>it defaults to allowing "File_Priv"</MEMBER> - </SIMPLELIST> - </PARA> - <PARA> - This means anyone from anywhere on the internet can not only drop the - database with one SQL command, and they can write as root to the system. - </PARA> - <PARA> - To see your permissions do: - <SIMPLELIST> - <MEMBER> - <COMPUTEROUTPUT> - <PROMPT>bash#</PROMPT> - <COMMAND>mysql -u root -p</COMMAND> - </COMPUTEROUTPUT> - </MEMBER> - <MEMBER> - <COMPUTEROUTPUT> - <PROMPT>mysql></PROMPT> - <COMMAND>use mysql;</COMMAND> - </COMPUTEROUTPUT> - </MEMBER> - <MEMBER> - <COMPUTEROUTPUT> - <PROMPT>mysql></PROMPT> - <COMMAND>show tables;</COMMAND> - </COMPUTEROUTPUT> - </MEMBER> - <MEMBER> - <COMPUTEROUTPUT> - <PROMPT>mysql></PROMPT> - <COMMAND>select * from user;</COMMAND> - </COMPUTEROUTPUT> - </MEMBER> - <MEMBER> - <COMPUTEROUTPUT> - <PROMPT>mysql></PROMPT> - <COMMAND>select * from db;</COMMAND> - </COMPUTEROUTPUT> - </MEMBER> - </SIMPLELIST> - </PARA> - <PARA> - To fix the gaping holes: - <SIMPLELIST> - <MEMBER>DELETE FROM user WHERE User='';</MEMBER> - <MEMBER>UPDATE user SET Password=PASSWORD('new_password') WHERE user='root';</MEMBER> - <MEMBER> FLUSH PRIVILEGES;</MEMBER> - </SIMPLELIST> - </PARA> - <PARA> - If you're not running "mit-pthreads" you can use: - <SIMPLELIST> - <MEMBER>GRANT USAGE ON *.* TO bugs@localhost;</MEMBER> - <MEMBER>GRANT ALL ON bugs.* TO bugs@localhost;</MEMBER> - <MEMBER>REVOKE DROP ON bugs.* FROM bugs@localhost;</MEMBER> - <MEMBER>FLUSH PRIVILEGES;</MEMBER> - </SIMPLELIST> - </PARA> - <PARA> - With "mit-pthreads" you'll need to modify the "globals.pl" Mysql->Connect - line to specify a specific host name instead of "localhost", and accept - external connections: - <SIMPLELIST> - <MEMBER>GRANT USAGE ON *.* TO bugs@bounce.hop.com;</MEMBER> - <MEMBER>GRANT ALL ON bugs.* TO bugs@bounce.hop.com;</MEMBER> - <MEMBER>REVOKE DROP ON bugs.* FROM bugs@bounce.hop.com;</MEMBER> - <MEMBER>FLUSH PRIVILEGES;</MEMBER> - </SIMPLELIST> - </PARA> - <PARA> - Consider also: - <ORDEREDLIST> - <LISTITEM> - <PARA> - Turning off external networking with "--skip-networking", - unless you have "mit-pthreads", in which case you can't. - Without networking, MySQL connects with a Unix domain socket. - </PARA> - </LISTITEM> - <LISTITEM> - <PARA> - using the --user= option to mysqld to run it as an unprivileged - user. - </PARA> - </LISTITEM> - <LISTITEM> - <PARA> - starting MySQL in a chroot jail - </PARA> - </LISTITEM> - <LISTITEM> - <PARA> - running the httpd in a "chrooted" jail - </PARA> - </LISTITEM> - <LISTITEM> - <PARA> - making sure the MySQL passwords are different from the OS - passwords (MySQL "root" has nothing to do with system "root"). - </PARA> - </LISTITEM> - <LISTITEM> - <PARA> - running MySQL on a separate untrusted machine - </PARA> - </LISTITEM> - <LISTITEM> - <PARA> - making backups ;-) - </PARA> - </LISTITEM> - </ORDEREDLIST> - </PARA> - </SECTION> - - <SECTION> - <TITLE>Installation General Notes</TITLE> - <SECTION> - <TITLE>Modifying Your Running System</TITLE> - <PARA> - Bugzilla optimizes database lookups by storing all relatively static - information in the versioncache file, located in the data/ subdirectory - under your installation directory (we said before it needs to be writable, - right?!) - </PARA> - <PARA> - If you make a change to the structural data in your database (the - versions table for example), or to the "constants" encoded in - defparams.pl, you will need to remove the cached content from the data - directory (by doing a "rm data/versioncache"), or your changes won't show - up! - </PARA> - <PARA> - That file gets automatically regenerated whenever it's more than an - hour old, so Bugzilla will eventually notice your changes by itself, but - generally you want it to notice right away, so that you can test things. - </PARA> - </SECTION> - <SECTION> - <TITLE>Upgrading From Previous Versions</TITLE> - <PARA> - The developers of Bugzilla are constantly adding new tables, columns and - fields. You'll get SQL errors if you just update the code. The strategy - to update is to simply always run the checksetup.pl script whenever - you upgrade your installation of Bugzilla. If you want to see what has - changed, you can read the comments in that file, starting from the end. - </PARA> - </SECTION> - <SECTION> - <TITLE>UNIX Installation Instructions History</TITLE> - <PARA> - This document was originally adapted from the Bonsai installation - instructions by Terry Weissman <terry@mozilla.org>. - </PARA> - <PARA> - 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). - </PARA> - <PARA> - This document was heavily modified again Wednesday, March 07 2001 to - reflect changes for Bugzilla 2.12 release by Matthew P. Barnson. The - securing MySQL section should be changed to become standard procedure - for Bugzilla installations. - </PARA> - <PARA> - Finally, the README in its entirety was marked up in SGML and included into - the Guide on April 24, 2001. - </PARA> - <PARA> - Comments from people using this Guide for the first time are particularly welcome. - </PARA> - </SECTION> - </SECTION> - - </SECTION> - </SECTION> +]]> + </programlisting> + </para> + <para> + Then, run these commands to finish the installation of the perl module: + <simplelist> + <member><command>perl Makefile.PL</command></member> + <member><command>make</command></member> + <member><command>make test</command></member> + <member><command>make install</command></member> + <member>And don't forget to run <command>exit</command> to get back to cpan.</member> + </simplelist> + </para> + <para> + Happy Hacking! + </para> + </section> + + <section id="bsdinstall" xreflabel="BSD Installation Notes"> + <title>BSD Installation Notes</title> + <para> + For instructions on how to set up Bugzilla on FreeBSD, NetBSD, OpenBSD, BSDi, etc. please + consult <xref linkend="osx">. + </para> + </section> + + + <section id="geninstall" xreflabel="Installation General Notes"> + <title>Installation General Notes</title> + <section> + <title>Modifying Your Running System</title> + <para> + Bugzilla optimizes database lookups by storing all relatively static + information in the versioncache file, located in the data/ subdirectory + under your installation directory. + </para> + <para> + If you make a change to the structural data in your database + (the versions table for example), or to the + <quote>constants</quote> encoded in defparams.pl, you will + need to remove the cached content from the data directory + (by doing a <quote>rm data/versioncache</quote>), or your + changes won't show up. + </para> + <para> + That file gets automatically regenerated whenever it's more than an + hour old, so Bugzilla will eventually notice your changes by itself, but + generally you want it to notice right away, so that you can test things. + </para> + </section> + <section> + <title>Upgrading From Previous Versions</title> + <para> + The developers of Bugzilla are constantly adding new tables, columns and + fields. You'll get SQL errors if you just update the code. The strategy + to update is to simply always run the checksetup.pl script whenever + you upgrade your installation of Bugzilla. If you want to see what has + changed, you can read the comments in that file, starting from the end. + </para> + <para> + If you are running Bugzilla version 2.8 or lower, and wish to upgrade to + the latest version, please consult the file, "UPGRADING-pre-2.8" in the + Bugzilla root directory after untarring the archive. + </para> + </section> - <SECTION id="README.windows"> - <TITLE>Win32 (Win98+/NT/2K) Installation</TITLE> - <PARA> - These directions have <EMPHASIS>not</EMPHASIS> been extensively tested. - We need testers! Please try these out and post any changes to the - newsgroup. - </PARA> - <SECTION id="ntverified"> - <TITLE>Win32 Installation: Step-by-step</TITLE> - <NOTE> - <PARA> - You should be familiar with, and cross-reference, the UNIX README - while performing your Win32 installation. Unfortunately, Win32 - directions are not yet as detailed as those for UNIX. - </PARA> - <PARA> - The <EMPHASIS>most critical</EMPHASIS> difference for Win32 users is - the lack of support for a crypt() function in MySQL for Windows. It does not - have it! All ENCRYPT statements must be modified. - </PARA> - </NOTE> + <section id="htaccess" xreflabel=".htaccess files and security"> + <title><filename>.htaccess</filename> files and security</title> + <para> + To enhance the security of your Bugzilla installation, + Bugzilla will generate + <glossterm><filename>.htaccess</filename></glossterm> files + which the Apache webserver can use to restrict access to + the bugzilla data files. The checksetup script will + generate the <filename>.htaccess</filename> files. + + <note> + <para> + If you are using an alternate provider of + <productname>webdot</productname> services for graphing + (as described when viewing + <filename>editparams.cgi</filename> in your web + browser), you will need to change the ip address in + <filename>data/webdot/.htaccess</filename> to the ip + address of the webdot server that you are using. + </para> + </note> + + </para> + <para> + If you are using Internet Information Server or other web + server which does not observe <filename>.htaccess</filename> + conventions, you can disable their creation by editing + <filename>localconfig</filename> and setting the + <varname>$create_htaccess</varname> variable to + <parameter>0</parameter>. + </para> + </section> + + <section> + <title>UNIX Installation Instructions History</title> + <para> + This document was originally adapted from the Bonsai installation + instructions by Terry Weissman <terry@mozilla.org>. + </para> + <para> + 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). + </para> + <para> + This document was heavily modified again Wednesday, March 07 2001 to + reflect changes for Bugzilla 2.12 release by Matthew P. Barnson. The + securing MySQL section should be changed to become standard procedure + for Bugzilla installations. + </para> + <para> + Finally, the README in its entirety was marked up in SGML and included into + the Guide on April 24, 2001 by Matt Barnson. Since that time, it's undergone + extensive modification as Bugzilla grew. + </para> + <para> + Comments from people using this Guide for the first time are particularly welcome. + </para> + </section> + </section> + + <section id="win32" xreflabel="Win32 Installation Notes"> + <title>Win32 Installation Notes</title> + <para>This section covers installation on Microsoft Windows 95, + 98, ME, NT, and 2000. Bugzilla works fine on Win32 platforms, + but please remember that the Bugzilla team and the author of the + Guide neither endorse nor support installation on Microsoft + Windows. Bugzilla installs and runs <emphasis>best</emphasis> + and <emphasis>easiest</emphasis> on UNIX-like operating systems, + and that is the way it will stay for the foreseeable future. The + Bugzilla team is considering supporting Win32 for the 2.16 + release and later.</para> + <para>The easiest way to install Bugzilla on Intel-archiecture + machines is to install some variant of GNU/Linux, then follow + the UNIX installation instructions in this Guide. If you have + any influence in the platform choice for running this system, + please choose GNU/Linux instead of Microsoft Windows.</para> - <PROCEDURE> - <STEP> - <PARA> - Install <ULINK URL="http://www.apache.org/">Apache Web Server</ULINK> + <section id="wininstall" xreflabel="Win32 Installation: Step-by-step"> + <title>Win32 Installation: Step-by-step</title> + <note> + <para> + You should be familiar with, and cross-reference, the rest + of the + <xref linkend="installation"> section while performing your + Win32 installation. + </para> + <para> Making Bugzilla work on Microsoft Windows is no + picnic. Support for Win32 has improved dramatically in the + last few releases, but, if you choose to proceed, you should + be a <emphasis>very</emphasis> skilled Windows Systems + Administrator with both strong troubleshooting abilities and + a high tolerance for pain. Bugzilla on NT requires hacking + source code and implementing some advanced utilities. What + follows is the recommended installation procedure for Win32; + additional suggestions are provided in <xref linkend="faq">. + </para> + </note> + + <procedure> + <step> + <para> + Install <ulink url="http://www.apache.org/">Apache Web Server</ulink> for Windows. - </PARA> - <NOTE> - <PARA> + </para> + <note> + <para> You may also use Internet Information Server or Personal Web Server for this purpose. However, setup is slightly more difficult. If ActivePerl doesn't seem to handle your file associations correctly (for .cgi and .pl files), please - consult the FAQ, in the "Win32" section. - </PARA> - <PARA> - If you are going to use IIS, if on Windows NT you must be updated - to at least Service Pack 4. - </PARA> - </NOTE> - </STEP> - <STEP> - <PARA> - Install <ULINK URL="http://www.activestate.com/">ActivePerl</ULINK> - </PARA> - <PARA> + consult <xref linkend="faq">. + </para> + <para> + If you are going to use IIS, if on Windows NT you must + be updated to at least Service Pack 4. Windows 2000 + ships with a sufficient version of IIS. + </para> + </note> + </step> + <step> + <para> + Install <ulink url="http://www.activestate.com/">ActivePerl</ulink> for Windows. Check <ulink url="http://aspn.activestate.com/ASPN/Downloads/ActivePerl/">http://aspn.activestate.com/ASPN/Downloads/ActivePerl</ulink> for a current compiled binary. + </para> + <para> Please also check the following links to fully understand the status of ActivePerl on Win32: - <ULINK URL="http://language.perl.com/newdocs/pod/perlport.html"> - Perl Porting</ULINK>, and - <ULINK URL="http://ftp.univie.ac.at/packages/perl/ports/nt/FAQ/perlwin32faq5.html"> - Hixie Click Here</ULINK> - </PARA> - </STEP> - <STEP> - <PARA> + <ulink url="http://language.perl.com/newdocs/pod/perlport.html"> + Perl Porting</ulink>, and + <ulink url="http://ftp.univie.ac.at/packages/perl/ports/nt/FAQ/perlwin32faq5.html"> + Perl on Win32 FAQ</ulink> + </para> + </step> + <step> + <para> Use ppm from your perl\bin directory to install the following packs: DBI, DBD-Mysql, TimeDate, Chart, Date-Calc, Date-Manip, and GD. You may need to extract them from .zip format using Winzip or other unzip program first. These additional ppm modules can be downloaded from ActiveState. - </PARA> - <PARA> + </para> + <note> + <para> + You can find a list of modules at + <ulink url="http://www.activestate.com/PPMPackages/zips/5xx-builds-only"> + http://www.activestate.com/PPMPackages/zips/5xx-builds-only/</ulink> + </para> + </note> + <para> The syntax for ppm is: - <COMPUTEROUTPUT> - <PROMPT>C:> </PROMPT><COMMAND>ppm install <module>.ppd</COMMAND> - </COMPUTEROUTPUT> - </PARA> - <PARA> + <computeroutput> + <prompt>C:> </prompt><command>ppm <modulename></command> + </computeroutput> + </para> + + <example> + <title>Installing ActivePerl ppd Modules on Microsoft Windows</title> + <para><prompt>C:></prompt><command>ppm + <option>DBD-Mysql</option></command></para> + <para>Watch your capitalization!</para> + </example> + + <para> You can find ActiveState ppm modules at - <ULINK URL="http://www.activestate.com/PPMPackages/5.6plus/"> - http://www.activestate.com/PPMPackages/5.6plus</ULINK> - </PARA> - </STEP> - <STEP> - <PARA> - Download and install the Windows GNU tools from - <ULINK URL="http://www.cygwin.com/">www.cygwin.com</ULINK>. - Make sure the GNU utilities are in your $PATH. - </PARA> - </STEP> - <STEP> - <PARA> + <ulink url="http://www.activestate.com/PPMPackages/5.6plus/"> + http://www.activestate.com/PPMPackages/5.6plus</ulink> + </para> + </step> + + <step> + <para> Install MySQL for NT. - <NOTE> - <PARA> - Your configuration file for MySQL <EMPHASIS>must</EMPHASIS> be named C:\MY.CNF. - </PARA> - </NOTE> - </PARA> - </STEP> - <STEP> - <PARA> + <note> + <para> + You can download MySQL for Windows NT from <ulink + url="http://www.mysql.com/">MySQL.com</ulink>. Some find it helpful to use the WinMySqlAdmin utility, included with the download, to set up the database. + </para> + </note> + </para> + </step> + <step> + <para> Setup MySQL - </PARA> - <SUBSTEPS> - <STEP> - <PARA> - <COMPUTEROUTPUT> - <PROMPT>C:> </PROMPT> - <COMMAND>C:\mysql\bin\mysql -u root mysql</COMMAND> - </COMPUTEROUTPUT> - </PARA> - </STEP> - <STEP> - <PARA> - <COMPUTEROUTPUT> - <PROMPT>mysql></PROMPT> - <COMMAND>DELETE FROM user WHERE Host='localhost' AND User='';</COMMAND> - </COMPUTEROUTPUT> - </PARA> - </STEP> - <STEP> - <PARA> - <COMPUTEROUTPUT> - <PROMPT>mysql></PROMPT> - <COMMAND>UPDATE user SET Password=PASSWORD ('new_password') - WHERE user='root';</COMMAND> - </COMPUTEROUTPUT> - </PARA> - </STEP> - <STEP> - <PARA> - <COMPUTEROUTPUT> - <PROMPT>mysql></PROMPT> - <COMMAND>GRANT SELECT, INSERT, UPDATE, DELETE, + </para> + <substeps> + <step> + <para> + <computeroutput> + <prompt>C:> </prompt> + <command>C:\mysql\bin\mysql -u root mysql</command> + </computeroutput> + </para> + </step> + <step> + <para> + <computeroutput> + <prompt>mysql></prompt> + <command>DELETE FROM user WHERE Host='localhost' AND User='';</command> + </computeroutput> + </para> + </step> + <step> + <para> + <computeroutput> + <prompt>mysql></prompt> + <command>UPDATE user SET Password=PASSWORD ('new_password') + WHERE user='root';</command> + </computeroutput> + </para> + <para><quote>new_password</quote>, above, indicates + whatever password you wish to use for your + <quote>root</quote> user.</para> + </step> + <step id="ntbugs-password"> + <para> + <computeroutput> + <prompt>mysql></prompt> + <command>GRANT SELECT, INSERT, UPDATE, DELETE, INDEX, ALTER, CREATE, DROP, REFERENCES ON bugs.* to bugs@localhost - IDENTIFIED BY 'bugs_password';</COMMAND> - </COMPUTEROUTPUT> - </PARA> - </STEP> - <STEP> - <PARA> - <COMPUTEROUTPUT> - <PROMPT>mysql></PROMPT> - <COMMAND>FLUSH PRIVILEGES;</COMMAND> - </COMPUTEROUTPUT> - </PARA> - </STEP> - <STEP> - <PARA> - <COMPUTEROUTPUT> - <PROMPT>mysql></PROMPT> - <COMMAND>create database bugs;</COMMAND> - </COMPUTEROUTPUT> - </PARA> - </STEP> - <STEP> - <PARA> - <COMPUTEROUTPUT> - <PROMPT>mysql></PROMPT> - <COMMAND>exit</COMMAND> - </COMPUTEROUTPUT> - </PARA> - </STEP> - <STEP> - <PARA> - <COMPUTEROUTPUT> - <PROMPT>C:></PROMPT> - <COMMAND>C:\mysql\bin\mysqladmin -u root -p reload</COMMAND> - </COMPUTEROUTPUT> - </PARA> - </STEP> - </SUBSTEPS> - </STEP> + IDENTIFIED BY 'bugs_password';</command> + </computeroutput> + </para> + <para><quote>bugs_password</quote>, above, indicates + whatever password you wish to use for your + <quote>bugs</quote> user.</para> + </step> + <step> + <para> + <computeroutput> + <prompt>mysql></prompt> + <command>FLUSH PRIVILEGES;</command> + </computeroutput> + </para> + </step> + <step> + <para> + <computeroutput> + <prompt>mysql></prompt> + <command>create database bugs;</command> + </computeroutput> + </para> + </step> + <step> + <para> + <computeroutput> + <prompt>mysql></prompt> + <command>exit;</command> + </computeroutput> + </para> + </step> + <step> + <para> + <computeroutput> + <prompt>C:></prompt> + <command>C:\mysql\bin\mysqladmin -u root -p reload</command> + </computeroutput> + </para> + </step> + </substeps> + </step> - <STEP> - <PARA> - Configure Bugzilla. For Win32, this involves editing "defparams.pl" - and "localconfig" to taste. Running "checksetup.pl" should create - localconfig for you. Note that getgrnam() doesn't work, and should be - deleted. Change this line: + <step> + <para> + Edit <filename>checksetup.pl</filename> in your Bugzilla directory. Change + this line: + </para> + <para> "my $webservergid = getgrnam($my_webservergroup); " + </para> + <para> to + </para> + <para> "my $webservergid = $my_webservergroup; " - </PARA> - </STEP> + </para> + </step> + + <step> + <para> + Run <filename>checksetup.pl</filename> from the Bugzilla directory. + </para> + </step> + + <step> + <para>Edit <filename>localconfig</filename> to suit your + requirements. Set <varname>$db_pass</varname> to your + <quote>bugs_password</quote> from <xref + linkend="ntbugs-password">, and <varname>$webservergroup</varname> to <quote>8</quote>.</para> + <note> + <para>Not sure on the <quote>8</quote> for + <varname>$webservergroup</varname> above. If it's + wrong, please send corrections.</para> + </note> + </step> + + <step> + <para> + Edit <filename>defparams.pl</filename> to suit your + requirements. Particularly, set + <varname>DefParam("maintainer")</varname> and + <varname>DefParam("urlbase") to match your + install.</varname> + </para> + <note> + <para>This is yet another step I'm not sure of, since the + maintainer of this documentation does not maintain + Bugzilla on NT. If you can confirm or deny that this + step is required, please let me know.</para> + </note> + </step> - <STEP> - <NOTE> - <PARA> + <step> + <note> + <para> There are several alternatives to Sendmail that will work on Win32. - The one mentioned here is a <EMPHASIS>suggestion</EMPHASIS>, not + The one mentioned here is a <emphasis>suggestion</emphasis>, not a requirement. Some other mail packages that can work include - <ULINK URL="http://www.blat.net/">BLAT</ULINK>, - <ULINK URL="http://www.geocel.com/windmail/">Windmail</ULINK>, - <ULINK URL="http://www.dynamicstate.com/">Mercury Sendmail</ULINK>, + <ulink url="http://www.blat.net/">BLAT</ulink>, + <ulink url="http://www.geocel.com/windmail/">Windmail</ulink>, + <ulink url="http://www.dynamicstate.com/">Mercury Sendmail</ulink>, and the CPAN Net::SMTP Perl module (available in .ppm). Every option requires some hacking of the Perl scripts for Bugzilla to make it work. The option here simply requires the least. - </PARA> - </NOTE> - <PARA> - Download NTsendmail, available from<ULINK URL="http://www.ntsendmail.com/"> - www.ntsendmail.com</ULINK>. In order for it to work, you must set up some - new environment variables (detailed on the ntsendmail home page). Figuring - out where to put those variables is left as an exercise for the reader. - You must have a "real" mail server which allows you to relay off it - in your $ENV{"NTsendmail"} (which you should probably place in globals.pl) - </PARA> - <PARA> - Once downloaded and installed, modify all open(SENDMAIL) calls to open - "| c:\ntsendmail\ntsendmail -t" instead of "|/usr/lib/sendmail -t". - </PARA> - <NOTE> - <PARA> - We need someone to test this and make sure this works as advertised. - </PARA> - </NOTE> - </STEP> - <STEP> - <PARA> - Modify globals.pl and CGI.pl to remove the word "encrypt". - </PARA> - <NOTE> - <PARA> - I'm not sure this is all that is involved to remove crypt. Any - NT Bugzilla hackers want to pipe up? - </PARA> - </NOTE> - </STEP> - <STEP> - <PARA> - Change all references to "processmail" to "processmail.pl" in - all files, and rename "processmail" to "processmail.pl" - </PARA> - <NOTE> - <PARA> - I really think this may be a change we want to make for + </para> + </note> + + <procedure> + <step> + <para> + Download NTsendmail, available from<ulink + url="http://www.ntsendmail.com/"> www.ntsendmail.com</ulink>. You must have a "real" mail server which allows you to relay off it in your $ENV{"NTsendmail"} (which you should probably place in globals.pl) + </para> + </step> + + <step> + <para>Put ntsendmail.pm into your .\perl\lib directory.</para> + </step> + + <step> + <para>Add to globals.pl:</para> + <programlisting> +# these settings configure the NTsendmail process +use NTsendmail; +$ENV{"NTsendmail"}="your.smtpserver.box"; +$ENV{"NTsendmail_debug"}=1; +$ENV{"NTsendmail_max_tries"}=5; + </programlisting> + <note> + <para> + Some mention to also edit + <varname>$db_pass</varname> in + <filename>globals.pl</filename> to be your + <quote>bugs_password</quote>. Although this may get + you around some problem authenticating to your + database, since globals.pl is not normally + restricted by <filename>.htaccess</filename>, your + database password is exposed to whoever uses your + web server. + </para> + </note> + </step> + + <step> + <para> + Find and comment out all occurences of + <quote><command>open(SENDMAIL</command></quote> in + your Bugzilla directory. Then replace them with: + <programlisting> +# new sendmail functionality +my $mail=new NTsendmail; +my $from="bugzilla\@your.machine.name.tld"; +my $to=$login; +my $subject=$urlbase; +$mail->send($from,$to,$subject,$msg); + </programlisting> + </para> + <note> + <para>The code above needs testing as well to make sure it is correct.</para> + </note> + </step> + </procedure> + </step> + + <step> + <para> + Change all references in all files from + <filename>processmail</filename> to + <filename>processmail.pl</filename>, and + rename <filename>processmail</filename> to + <filename>processmail.pl</filename>. + </para> + <note> + <para> + Many think this may be a change we want to make for main-tree Bugzilla. It's painless for the UNIX folks, and will make the Win32 people happier. - </PARA> - </NOTE> - </STEP> - <STEP> - <PARA> - Modify the path to perl on the first line (#!) of all files - to point to your Perl installation, and - add "perl" to the beginning of all Perl system calls that - use a perl script as an argument. This may take you a while. - There is a "setperl.pl" utility to speed part of this procedure, - available in the "Patches and Utilities" section of The Bugzilla Guide. - </PARA> - </STEP> - <STEP> - <PARA> - In processmail.pl, add "binmode(HANDLE)" before all read() calls. - This may not be necessary, but in some cases the read() under - Win32 doesn't count the EOL's without using a binary read(). - </PARA> - </STEP> - </PROCEDURE> + </para> + </note> + <note> + <para> + Some people have suggested using the Net::SMTP Perl module instead of NTsendmail or the other options listed here. You can change processmail.pl to make this work. + <programlisting> +<![CDATA[ + +my $smtp = Net::SMTP->new('<Name of your SMTP server>'); #connect to SMTP server +$smtp->mail('<your name>@<you smpt server>');# use the sender's adress here +$smtp->to($tolist); # recipient's address +$smtp->data(); # Start the mail +$smtp->datasend($msg); +$smtp->dataend(); # Finish sending the mail +$smtp->quit; # Close the SMTP connection +$logstr = "$logstr; mail sent to $tolist $cclist"; +} + +]]> +</programlisting> +here is a test mail program for Net::SMTP: +<programlisting> +<![CDATA[ - </SECTION> +use Net::SMTP; + my $smtp = Net::SMTP->new('<Name of your SMTP server', Timeout => 30, Debug +=> 1, ); # connect to SMTP server + $smtp->auth; + $smtp->mail('you@yourcompany.com');# use the sender's adress +here + $smtp->to('someotherAddress@someotherdomain.com'); # +recipient's address + $smtp->data(); # Start the mail + $smtp->datasend('test'); + $smtp->dataend(); # Finish sending the mail + $smtp->quit; # Close the SMTP connection +exit; - <SECTION id="addlwintips"> - <TITLE>Additional Windows Tips</TITLE> - <TIP> - <PARA> +]]> +</programlisting> + </para> + </note> + </step> + <step> + <note> + <para> + This step is completely optional if you are using IIS or + another web server which only decides on an interpreter + based upon the file extension (.pl), rather than the + <quote>shebang</quote> line (#/usr/bonsaitools/bin/perl) + </para> + </note> + <para> + Modify the path to perl on the first line (#!) of all + files to point to your Perl installation, and add + <quote>perl</quote> to the beginning of all Perl system + calls that use a perl script as an argument. This may + take you a while. There is a <quote>setperl.csh</quote> + utility to speed part of this procedure, available in the + <xref linkend="patches"> section of The Bugzilla Guide. + However, it requires the Cygwin GNU-compatible environment + for Win32 be set up in order to work. See <ulink + url="http://www.cygwin.com/">http://www.cygwin.com/</ulink> for details on obtaining Cygwin. + </para> + </step> + + <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> +system ("perl processmail.pl",@ARGLIST); + </programlisting> + </para> + </step> + </procedure> + + <tip> + <para> + If you are using IIS 5.0 or higher, you must add cgi + relationships to Properties -> Home directory (tab) -> + Application Settings (section) -> Configuration (button), + such as: <programlisting> +.cgi to: <perl install directory>\perl.exe %s %s +.pl to: <perl install directory>\perl.exe %s %s +GET,HEAD,POST + </programlisting> + Change the path to Perl to match your + install, of course. + </para> + </tip> + </section> + + <section id="addlwintips"> + <title>Additional Windows Tips</title> + <tip> + <para> From Andrew Pearson: - <BLOCKQUOTE> - <PARA> + <blockquote> + <para> "You can make Bugzilla work with Personal Web Server for Windows 98 and higher, as well as for IIS 4.0. Microsoft has information available at - <ULINK URL=" http://support.microsoft.com/support/kb/articles/Q231/9/98.ASP"> - http://support.microsoft.com/support/kb/articles/Q231/9/98.ASP</ULINK> - </PARA> - <PARA> + <ulink url=" http://support.microsoft.com/support/kb/articles/Q231/9/98.ASP"> + http://support.microsoft.com/support/kb/articles/Q231/9/98.ASP</ulink> + </para> + <para> Basically you need to add two String Keys in the registry at the following location: - </PARA> - <PARA> + </para> + <para> HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\W3SVC\Parameters\ScriptMap - </PARA> - <PARA> + </para> + <para> The keys should be called ".pl" and ".cgi", and both should have a value something like: - <COMMAND>c:/perl/bin/perl.exe "%s" "%s"</COMMAND> - </PARA> - <PARA> + <command>c:/perl/bin/perl.exe "%s" "%s"</command> + </para> + <para> The KB article only talks about .pl, but it goes into more detail and provides a perl test script. - </PARA> - </BLOCKQUOTE> - </PARA> - </TIP> - <TIP> - <PARA>"Brian" had this to add, about upgrading to Bugzilla 2.12 from previous versions:</PARA> - <BLOCKQUOTE> - <PARA> + </para> + </blockquote> + </para> + </tip> + <tip> + <para>"Brian" had this to add, about upgrading to Bugzilla 2.12 from previous versions:</para> + <blockquote> + <para> Hi - I am updating bugzilla to 2.12 so I can tell you what I did (after I deleted the current dir and copied the files in). - </PARA> - <PARA> + </para> + <para> In checksetup.pl, I did the following... - </PARA> - <PROCEDURE> - <STEP> - <PROGRAMLISTING> + </para> + <procedure> + <step> + <programlisting> my $webservergid = getgrnam($my_webservergroup); - </PROGRAMLISTING> - <PARA>to</PARA> - <PROGRAMLISTING> + </programlisting> + <para>to</para> + <programlisting> my $webservergid = 'Administrators' - </PROGRAMLISTING> - </STEP> - <STEP> - <PARA> + </programlisting> + </step> + <step> + <para> I then ran checksetup.pl - </PARA> - </STEP> - <STEP> - <PARA> + </para> + </step> + <step> + <para> I removed all the encrypt() - <EXAMPLE> - <TITLE>Removing encrypt() for Windows NT installations</TITLE> - <PARA> + <example> + <title>Removing encrypt() for Windows NT installations</title> + <para> Replace this: - <PROGRAMLISTING> + <programlisting> SendSQL("SELECT encrypt(" . SqlQuote($enteredpwd) . ", " . SqlQuote(substr($realcryptpwd, 0, 2)) . ")"); my $enteredcryptpwd = FetchOneColumn(); - </PROGRAMLISTING> + </programlisting> with this: - <PROGRAMLISTING> + <programlisting> my $enteredcryptpwd = $enteredpwd - </PROGRAMLISTING> + </programlisting> in cgi.pl. - </PARA> - </EXAMPLE> - </PARA> - </STEP> - <STEP> - <PARA> + </para> + </example> + </para> + </step> + <step> + <para> I renamed processmail to processmail.pl - </PARA> - </STEP> - <STEP> - <PARA> + </para> + </step> + <step> + <para> I altered the sendmail statements to windmail: - <PROGRAMLISTING> + <programlisting> open SENDMAIL, "|\"C:/General/Web/tools/Windmail 4.0 Beta/windmail\" -t > mail.log"; - </PROGRAMLISTING> - </PARA> - <PARA> + </programlisting> + </para> + <para> The quotes around the dir is for the spaces. mail.log is for the output - </PARA> - </STEP> - </PROCEDURE> - </BLOCKQUOTE> - </TIP> - <TIP> - <PARA> + </para> + </step> + </procedure> + </blockquote> + </tip> + <tip> + <para> This was some late breaking information from Jan Evert. Sorry for the lack of formatting. - </PARA> - <LITERALLAYOUT> + </para> + <literallayout> I'm busy installing bugzilla on a WinNT machine and I thought I'd notify you at this moment of the commments I have to section 2.2.1 of the bugzilla guide (at http://www.trilobyte.net/barnsons/html/). @@ -1340,7 +1731,7 @@ necessary to add the ExecCGI option to the bugzilla directory. Also the 'AddHandler' line for .cgi is by default commented out. Step 3: although just a detail, 'ppm install <module%gt;' will also work -(wihtout .ppd). And, it can also download these automatically from +(without .ppd). And, it can also download these automatically from ActiveState. Step 4: although I have cygwin installed, it seems that it is not necessary. @@ -1372,30 +1763,30 @@ that apache can serve them. Just noticed the updated guide... Brian's comment is new. His first comment will work, but opens up a huge security hole. - </LITERALLAYOUT> - </TIP> - </SECTION> - </SECTION> -</CHAPTER> - - - + </literallayout> + </tip> + </section> + </section> +</chapter> <!-- Keep this comment at the end of the file Local variables: mode: sgml -sgml-omittag:t -sgml-shorttag:t -sgml-namecase-general:t -sgml-general-insert-case:upper -sgml-minimize-attributes:nil sgml-always-quote-attributes:t -sgml-indent-step:2 -sgml-indent-data:t -sgml-parent-document:nil +sgml-auto-insert-required-elements:t +sgml-balanced-tag-edit:t sgml-exposed-tags:nil +sgml-general-insert-case:lower +sgml-indent-data:t +sgml-indent-step:2 sgml-local-catalogs:nil sgml-local-ecat-files:nil +sgml-minimize-attributes:nil +sgml-namecase-general:t +sgml-omittag:t +sgml-parent-document:("Bugzilla-Guide.sgml" "book" "chapter") +sgml-shorttag:t +sgml-tag-region-if-active:t End: --> diff --git a/docs/xml/integration.xml b/docs/xml/integration.xml index 74ec817f5..c7aa78f82 100644 --- a/docs/xml/integration.xml +++ b/docs/xml/integration.xml @@ -1,4 +1,4 @@ -<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook V4.1//EN" > +<!-- <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook V4.1//EN" > --> <!-- Keep these tools listings in alphabetical order please. -MPB --> @@ -12,14 +12,13 @@ <section id="cvs"> <title>CVS</title> - <para>We need CVS integration information</para> + <para>CVS integration is best accomplished, at this point, using the Bugzilla Email Gateway.</para> </section> <section id="scm"> <title>Perforce SCM</title> <para> - Richard Brooksby created a Perforce integration tool for Bugzilla and TeamTrack. - You can find the main project page at + You can find the project page for Bugzilla and Teamtrack Perforce integration at: <ulink url="http://www.ravenbrook.com/project/p4dti/"> http://www.ravenbrook.com/project/p4dti</ulink>. "p4dti" is now an officially supported product from Perforce, and you can find the "Perforce Public Depot" @@ -54,22 +53,25 @@ </chapter> + + <!-- Keep this comment at the end of the file Local variables: mode: sgml -sgml-omittag:t -sgml-shorttag:t -sgml-namecase-general:t -sgml-general-insert-case:lower -sgml-minimize-attributes:nil sgml-always-quote-attributes:t -sgml-indent-step:2 -sgml-indent-data:t -sgml-parent-document:nil +sgml-auto-insert-required-elements:t +sgml-balanced-tag-edit:t sgml-exposed-tags:nil +sgml-general-insert-case:lower +sgml-indent-data:t +sgml-indent-step:2 sgml-local-catalogs:nil sgml-local-ecat-files:nil +sgml-minimize-attributes:nil +sgml-namecase-general:t +sgml-omittag:t +sgml-parent-document:("Bugzilla-Guide.sgml" "book" "chapter") +sgml-shorttag:t +sgml-tag-region-if-active:t End: --> - - diff --git a/docs/xml/patches.xml b/docs/xml/patches.xml index 8d7a72682..8ebfdee15 100644 --- a/docs/xml/patches.xml +++ b/docs/xml/patches.xml @@ -1,15 +1,14 @@ -<!DOCTYPE appendix PUBLIC "-//OASIS//DTD DocBook V4.1//EN"> +<!-- <!DOCTYPE appendix PUBLIC "-//OASIS//DTD DocBook V4.1//EN"> --> -<appendix id="patches"> +<appendix id="patches" xreflabel="Useful Patches and Utilities for Bugzilla"> <title>Useful Patches and Utilities for Bugzilla</title> -<section id="setperl"> +<section id="setperl" xreflabel="The setperl.csh Utility"> <title>The setperl.csh Utility</title> - <para> - You can use the "setperl.csh" utility to quickly and easily - change the path to perl on all your Bugzilla files. - This is a C-shell script; if you do not have "csh" or "tcsh" in the search - path on your system, it will not work! + <para> You can use the "setperl.csh" utility to quickly and + easily change the path to perl on all your Bugzilla files. This + is a C-shell script; if you do not have "csh" or "tcsh" in the + search path on your system, it will not work! </para> <procedure> <step> @@ -28,18 +27,15 @@ </step> <step> <para> - <computeroutput> - <prompt>bash#</prompt> - <command>wget -O setperl.csh 'http://bugzilla.mozilla.org/showattachment.cgi?attach_id=10795'</command> - </computeroutput> + <computeroutput> <prompt>bash#</prompt> <command>wget -O + setperl.csh + 'http://bugzilla.mozilla.org/showattachment.cgi?attach_id=10795'</command> </computeroutput> </para> </step> <step> <para> - <computeroutput> - <prompt>bash#</prompt> - <command>chmod u+x setperl.csh</command> - </computeroutput> + <computeroutput> <prompt>bash#</prompt> <command>chmod + u+x setperl.csh</command> </computeroutput> </para> </step> </substeps> @@ -59,10 +55,8 @@ </step> <step> <para> - <computeroutput> - <prompt>bash#</prompt> - <command>chmod u+x duplicates.cgi</command> - </computeroutput> + <computeroutput> <prompt>bash#</prompt> <command>chmod + u+x duplicates.cgi</command> </computeroutput> </para> </step> <step> @@ -80,16 +74,14 @@ Run the script: </para> <para> - <computeroutput> - <prompt>bash#</prompt> + <computeroutput> <prompt>bash#</prompt> <command>./setperl.csh /your/path/to/perl</command> </computeroutput> <example> <title>Using Setperl to set your perl path</title> <para> - <computeroutput> - <prompt>bash#</prompt> - <command>./setperl.csh /usr/bin/perl</command> + <computeroutput> <prompt>bash#</prompt> + <command>./setperl.csh /usr/bin/perl</command> </computeroutput> </para> </example> @@ -101,22 +93,23 @@ <section id="cmdline"> <title>Command-line Bugzilla Queries</title> <para> - Users can query Bugzilla from the command line using - this suite of utilities. + Users can query Bugzilla from the command line using this suite + of utilities. </para> <para> The query.conf file contains the mapping from options to field - names and comparison types. Quoted option names are "grepped" for, so - it should be easy to edit this file. Comments (#) have no effect; you - must make sure these lines do not contain any quoted "option" + names and comparison types. Quoted option names are "grepped" + for, so it should be easy to edit this file. Comments (#) have + no effect; you must make sure these lines do not contain any + quoted "option" </para> <para> - buglist is a shell script which submits a Bugzilla query and writes the - resulting HTML page to stdout. It supports both short options, - (such as "-Afoo" or "-Rbar") and long options (such as - "--assignedto=foo" or "--reporter=bar"). If the first character - of an option is not "-", it is treated as if it were prefixed - with "--default=". + buglist is a shell script which submits a Bugzilla query and + writes the resulting HTML page to stdout. It supports both + short options, (such as "-Afoo" or "-Rbar") and long options + (such as "--assignedto=foo" or "--reporter=bar"). If the first + character of an option is not "-", it is treated as if it were + prefixed with "--default=". </para> <para> The columlist is taken from the COLUMNLIST environment variable. @@ -128,10 +121,10 @@ <para> bugs is a simple shell script which calls buglist and extracts the bug numbers from the output. Adding the prefix - "http://bugzilla.mozilla.org/buglist.cgi?bug_id=" - turns the bug list into a working link if any bugs are found. - Counting bugs is easy. Pipe the results through - <command>sed -e 's/,/ /g' | wc | awk '{printf $2 "\n"}'</command> + "http://bugzilla.mozilla.org/buglist.cgi?bug_id=" turns the bug + list into a working link if any bugs are found. Counting bugs is + easy. Pipe the results through <command>sed -e 's/,/ /g' | wc | + awk '{printf $2 "\n"}'</command> </para> <para> Akkana says she has good results piping buglist output through @@ -145,26 +138,23 @@ <substeps> <step> <para> - <computeroutput> - <prompt>bash$</prompt> - <command>wget -O query.conf 'http://bugzilla.mozilla.org/showattachment.cgi?attach_id=26157'</command> - </computeroutput> + <computeroutput> <prompt>bash$</prompt> <command>wget -O + query.conf + 'http://bugzilla.mozilla.org/showattachment.cgi?attach_id=26157'</command> </computeroutput> </para> </step> <step> <para> - <computeroutput> - <prompt>bash$</prompt> - <command>wget -O buglist 'http://bugzilla.mozilla.org/showattachment.cgi?attach_id=26944'</command> - </computeroutput> + <computeroutput> <prompt>bash$</prompt> <command>wget -O + buglist + 'http://bugzilla.mozilla.org/showattachment.cgi?attach_id=26944'</command> </computeroutput> </para> </step> <step> <para> - <computeroutput> - <prompt>bash#</prompt> - <command>wget -O bugs 'http://bugzilla.mozilla.org/showattachment.cgi?attach_id=26215'</command> - </computeroutput> + <computeroutput> <prompt>bash#</prompt> <command>wget -O + bugs + 'http://bugzilla.mozilla.org/showattachment.cgi?attach_id=26215'</command> </computeroutput> </para> </step> </substeps> @@ -185,53 +175,64 @@ <title>The Quicksearch Utility</title> <para> Quicksearch is a new, experimental feature of the 2.12 release. - It consist of two Javascript files, "quicksearch.js" and "localconfig.js", - and two documentation files, "quicksearch.html" and "quicksearchhack.html" + It consist of two Javascript files, "quicksearch.js" and + "localconfig.js", and two documentation files, + "quicksearch.html" and "quicksearchhack.html" </para> <para> - The index.html page has been updated to include the QuickSearch text box. + The index.html page has been updated to include the QuickSearch + text box. </para> <para> - To take full advantage of the query power, the Bugzilla maintainer must - edit "localconfig.js" according to the value sets used in the local installation. + To take full advantage of the query power, the Bugzilla + maintainer must edit "localconfig.js" according to the value + sets used in the local installation. </para> <para> - Currently, keywords must be hard-coded in localconfig.js. If they are not, - keywords are not automatically recognized. This means, if localconfig.js - is left unconfigured, that searching for a bug with the "foo" keyword - will only find bugs with "foo" in the summary, status whiteboard, product or - component name, but not those with the keyword "foo". + Currently, keywords must be hard-coded in localconfig.js. If + they are not, keywords are not automatically recognized. This + means, if localconfig.js is left unconfigured, that searching + for a bug with the "foo" keyword will only find bugs with "foo" + in the summary, status whiteboard, product or component name, + but not those with the keyword "foo". </para> <para> Workarounds for Bugzilla users: <simplelist> - <member>search for '!foo' (this will find only bugs with the keyword "foo"</member> - <member>search 'foo,!foo' (equivalent to 'foo OR keyword:foo')</member> + <member>search for '!foo' (this will find only bugs with the + keyword "foo"</member> + <member>search 'foo,!foo' (equivalent to 'foo OR + keyword:foo')</member> </simplelist> </para> <para> - When this tool is ported from client-side JavaScript to server-side Perl, - the requirement for hard-coding keywords can be fixed. - <ulink url="http://bugzilla.mozilla.org/show_bug.cgi?id=70907">This bug</ulink> - has details. + When this tool is ported from client-side JavaScript to + server-side Perl, the requirement for hard-coding keywords can + be fixed. <ulink + url="http://bugzilla.mozilla.org/show_bug.cgi?id=70907">This bug</ulink> has details. </para> </section> </appendix> + + <!-- Keep this comment at the end of the file Local variables: mode: sgml -sgml-omittag:t -sgml-shorttag:t -sgml-namecase-general:t -sgml-general-insert-case:lower -sgml-minimize-attributes:nil sgml-always-quote-attributes:t -sgml-indent-step:2 -sgml-indent-data:t -sgml-parent-document:nil +sgml-auto-insert-required-elements:t +sgml-balanced-tag-edit:t sgml-exposed-tags:nil +sgml-general-insert-case:lower +sgml-indent-data:t +sgml-indent-step:2 sgml-local-catalogs:nil sgml-local-ecat-files:nil +sgml-minimize-attributes:nil +sgml-namecase-general:t +sgml-omittag:t +sgml-parent-document:("Bugzilla-Guide.sgml" "book" "chapter") +sgml-shorttag:t +sgml-tag-region-if-active:t End: --> diff --git a/docs/xml/requiredsoftware.xml b/docs/xml/requiredsoftware.xml index 2d819ab62..e36b6184a 100644 --- a/docs/xml/requiredsoftware.xml +++ b/docs/xml/requiredsoftware.xml @@ -1,4 +1,4 @@ -<!DOCTYPE appendix PUBLIC "-//OASIS//DTD DocBook V4.1//EN"> +<!-- <!DOCTYPE appendix PUBLIC "-//OASIS//DTD DocBook V4.1//EN"> --> <appendix id="downloadlinks"> <title>Software Download Links</title> @@ -15,7 +15,7 @@ http://www.mozilla.org/projects/bugzilla/</ulink> </para> <para> - MySQL: <ulink url="http://www.mysql.org/">http://www.mysql.org/</ulink> + MySQL: <ulink url="http://www.mysql.com/">http://www.mysql.com/</ulink> </para> <para> Perl: <ulink url="http://www.perl.org">http://www.perl.org/</ulink> @@ -63,20 +63,24 @@ </appendix> + <!-- Keep this comment at the end of the file Local variables: mode: sgml -sgml-omittag:t -sgml-shorttag:t -sgml-namecase-general:t -sgml-general-insert-case:lower -sgml-minimize-attributes:nil sgml-always-quote-attributes:t -sgml-indent-step:2 -sgml-indent-data:t -sgml-parent-document:nil +sgml-auto-insert-required-elements:t +sgml-balanced-tag-edit:t sgml-exposed-tags:nil +sgml-general-insert-case:lower +sgml-indent-data:t +sgml-indent-step:2 sgml-local-catalogs:nil sgml-local-ecat-files:nil +sgml-minimize-attributes:nil +sgml-namecase-general:t +sgml-omittag:t +sgml-parent-document:("Bugzilla-Guide.sgml" "book" "chapter") +sgml-shorttag:t +sgml-tag-region-if-active:t End: --> diff --git a/docs/xml/using.xml b/docs/xml/using.xml index bc8159835..fd5901196 100644 --- a/docs/xml/using.xml +++ b/docs/xml/using.xml @@ -1,4 +1,4 @@ -<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook V4.1//EN"> +<!-- <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook V4.1//EN"> --> <!-- TOC Chapter: Using Bugzilla @@ -38,19 +38,19 @@ Chapter: Using Bugzilla <section id="whatis"> <title>What is Bugzilla?</title> <para> - Bugzilla is one example of a class of programs called "Defect Tracking Systems", - or, more commonly, "Bug-Tracking Systems". Defect Tracking Systems allow individual or - groups of developers to keep track of outstanding bugs in their product effectively. - Bugzilla was originally written by Terry Weissman in a programming language called - "TCL", to replace a crappy - bug-tracking database used internally for Netscape Communications. Terry later ported - Bugzilla to - Perl from TCL, and in Perl it remains to this day. - Most commercial defect-tracking software vendors at the - time charged enormous licensing fees, and Bugzilla quickly became a favorite of the - open-source crowd (with its genesis in the open-source browser project, Mozilla). It - is now the de-facto standard defect-tracking system against which all others are - measured. + Bugzilla is one example of a class of programs called "Defect +Tracking Systems", or, more commonly, "Bug-Tracking Systems". Defect +Tracking Systems allow individual or groups of developers to keep +track of outstanding bugs in their product effectively. Bugzilla was +originally written by Terry Weissman in a programming language called +"TCL", to replace a crappy bug-tracking database used internally for +Netscape Communications. Terry later ported Bugzilla to Perl from +TCL, and in Perl it remains to this day. Most commercial +defect-tracking software vendors at the time charged enormous +licensing fees, and Bugzilla quickly became a favorite of the +open-source crowd (with its genesis in the open-source browser +project, Mozilla). It is now the de-facto standard defect-tracking +system against which all others are measured. </para> <para> Bugzilla has matured immensely, and now boasts many advanced features. These include: @@ -87,13 +87,13 @@ Chapter: Using Bugzilla </listitem> <listitem> <para> - email, XML, and HTTP APIs + email, XML, console, and HTTP APIs </para> </listitem> <listitem> <para> available integration with automated software configuration management systems, including - Perforce and CVS. + Perforce and CVS </para> </listitem> <listitem> @@ -137,7 +137,7 @@ Chapter: Using Bugzilla with bug-tracking software, and instead simply relied on shared lists and email to monitor the status of defects. This procedure is error-prone and tends to cause those bugs judged least significant by developers to be - dropped or ignored + dropped or ignored. </para> <para> These days, many companies are finding that integrated defect-tracking @@ -223,12 +223,12 @@ Chapter: Using Bugzilla <section id="myaccount"> <title>Create a Bugzilla Account</title> <para> - First thing's first! If you want to use Bugzilla, first you need to create + First things first! If you want to use Bugzilla, first you need to create an account. Consult with the administrator responsible for your installation of Bugzilla for the URL you should use to access it. If you're test-driving the end-user Bugzilla experience, use this URL: - <ulink url="http://landfill.tequilarista.org/mozilla/bugzilla/"> - http://landfill.tequilarista.org/mozilla/bugzilla/</ulink> + <ulink url="http://landfill.tequilarista.org/bugzilla-tip/"> + http://landfill.tequilarista.org/bugzilla-tip/</ulink> </para> <orderedlist> <listitem> @@ -560,15 +560,15 @@ Chapter: Using Bugzilla <orderedlist> <listitem> <para> - Go back to <ulink url="http://landfill.tequilarista.org/mozilla/bugzilla/"> - http://landfill.tequilarista.org/mozilla/bugzilla/</ulink> + Go back to <ulink url="http://landfill.tequilarista.org/bugzilla-tip/"> + http://landfill.tequilarista.org/bugzilla-tip/</ulink> in your browser. </para> </listitem> <listitem> <para> Select the - <ulink url="http://landfill.tequilarista.org/mozilla/bugzilla/enter_bug.cgi"> + <ulink url="http://landfill.tequilarista.org/bugzilla-tip/enter_bug.cgi"> Enter a new bug report</ulink> link. </para> </listitem> @@ -716,7 +716,7 @@ Chapter: Using Bugzilla Let's plunge into what you can do! The first step is to click the "Edit prefs" link at the footer of each page once you have logged in to - <ulink url="http://landfill.tequilarista.org/mozilla/bugzilla/query.cgi?GoAheadAndLogIn=1"> + <ulink url="http://landfill.tequilarista.org/bugzilla-tip/query.cgi?GoAheadAndLogIn=1"> Landfill</ulink>. </para> <section id="accountsettings"> @@ -861,17 +861,20 @@ Chapter: Using Bugzilla <!-- Keep this comment at the end of the file Local variables: mode: sgml -sgml-omittag:t -sgml-shorttag:t -sgml-namecase-general:t -sgml-general-insert-case:lower -sgml-minimize-attributes:nil sgml-always-quote-attributes:t -sgml-indent-step:2 -sgml-indent-data:t -sgml-parent-document:Bugzilla-Guide\.sgml +sgml-auto-insert-required-elements:t +sgml-balanced-tag-edit:t sgml-exposed-tags:nil +sgml-general-insert-case:lower +sgml-indent-data:t +sgml-indent-step:2 sgml-local-catalogs:nil sgml-local-ecat-files:nil +sgml-minimize-attributes:nil +sgml-namecase-general:t +sgml-omittag:t +sgml-parent-document:("Bugzilla-Guide.sgml" "book" "chapter") +sgml-shorttag:t +sgml-tag-region-if-active:t End: --> diff --git a/docs/xml/variants.xml b/docs/xml/variants.xml index d13b9ee8d..fec867946 100644 --- a/docs/xml/variants.xml +++ b/docs/xml/variants.xml @@ -1,4 +1,4 @@ -<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook V4.1//EN"> +<!-- <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook V4.1//EN">--> <chapter id="variants"> <title>Bugzilla Variants</title> @@ -68,20 +68,24 @@ Regards </para> </section> </chapter> + <!-- Keep this comment at the end of the file Local variables: mode: sgml -sgml-omittag:t -sgml-shorttag:t -sgml-namecase-general:t -sgml-general-insert-case:lower -sgml-minimize-attributes:nil sgml-always-quote-attributes:t -sgml-indent-step:2 -sgml-indent-data:t -sgml-parent-document:nil +sgml-auto-insert-required-elements:t +sgml-balanced-tag-edit:t sgml-exposed-tags:nil +sgml-general-insert-case:lower +sgml-indent-data:t +sgml-indent-step:2 sgml-local-catalogs:nil sgml-local-ecat-files:nil +sgml-minimize-attributes:nil +sgml-namecase-general:t +sgml-omittag:t +sgml-parent-document:("Bugzilla-Guide.sgml" "book" "chapter") +sgml-shorttag:t +sgml-tag-region-if-active:t End: --> |