Commit e5b9f4fa authored by barnboy%trilobyte.net's avatar barnboy%trilobyte.net

Updated Bugzilla Guide and README to fix bug 76156, bug 76841, and bug 26242.

The README is now gutted, pointers to Guide. Also some new sections added, old ones fixed, and notes appended to deprecated sections I've not yet had the heart to remove.
parent 7016a5a0
<?xml version="1.0"?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
<!ENTITY % myents SYSTEM "bugzilla.ent">
%myents;
<!DOCTYPE BOOK PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [
<!-- Include macros -->
<!ENTITY about SYSTEM "about.xml">
<!ENTITY conventions SYSTEM "conventions.xml">
<!ENTITY doc-index SYSTEM "index.xml">
<!ENTITY gfdl SYSTEM "gfdl.xml">
<!ENTITY glossary SYSTEM "glossary.xml">
<!ENTITY installation SYSTEM "installation.xml">
<!ENTITY administration SYSTEM "administration.xml">
<!ENTITY security SYSTEM "security.xml">
<!ENTITY using SYSTEM "using.xml">
<!ENTITY integration SYSTEM "integration.xml">
<!ENTITY index SYSTEM "index.xml">
<!ENTITY customization SYSTEM "customization.xml">
<!ENTITY troubleshooting SYSTEM "troubleshooting.xml">
<!ENTITY patches SYSTEM "patches.xml">
<!ENTITY introduction SYSTEM "introduction.xml">
<!ENTITY modules SYSTEM "modules.xml">
<!-- Things to change for a stable release:
* bz-ver to current stable
* bz-nexver to next stable
* bz-date to the release date
* landfillbase to the branch install
* Remove the BZ-DEVEL comments
- COMPILE DOCS AND CHECKIN -
Also, tag and tarball before completing
* bz-ver to devel version
For a devel release, simple bump bz-ver and bz-date
-->
<!ENTITY about SYSTEM "about.sgml">
<!ENTITY conventions SYSTEM "conventions.sgml">
<!ENTITY doc-index SYSTEM "index.sgml">
<!ENTITY faq SYSTEM "faq.sgml">
<!ENTITY gfdl SYSTEM "gfdl.sgml">
<!ENTITY glossary SYSTEM "glossary.sgml">
<!ENTITY installation SYSTEM "installation.sgml">
<!ENTITY administration SYSTEM "administration.sgml">
<!ENTITY using SYSTEM "using.sgml">
<!ENTITY integration SYSTEM "integration.sgml">
<!ENTITY future SYSTEM "future.sgml">
<!ENTITY index SYSTEM "index.sgml">
<!ENTITY database SYSTEM "database.sgml">
<!ENTITY patches SYSTEM "patches.sgml">
<!ENTITY variants SYSTEM "variants.sgml">
<!ENTITY requiredsoftware SYSTEM "requiredsoftware.sgml">
<!ENTITY bz-ver "3.1.3">
<!ENTITY bz-nextver "3.2">
<!ENTITY bz-date "2008-02-01">
<!ENTITY current-year "2008">
]>
<!ENTITY landfillbase "http://landfill.bugzilla.org/bugzilla-tip/">
<!ENTITY bz "http://www.bugzilla.org/">
<!ENTITY bzg-bugs "<ulink url='https://bugzilla.mozilla.org/enter_bug.cgi?product=Bugzilla&amp;component=Documentation'>Bugzilla Documentation</ulink>">
<!ENTITY mysql "http://www.mysql.com/">
<!-- Coding standards for this document
<!ENTITY min-perl-ver "5.8.1">
]>
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".
<!-- Coding standards for this document
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)
* 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.xml.
* 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.tldp.org, and
check out the KDE guidelines (they are nice, too)
http://i18n.kde.org/doc/markup.html
* All tags should be lowercase.
* 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.
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".
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.
-->
<book id="index">
<BOOK ID="index">
<!-- Header -->
<bookinfo>
<title>The Bugzilla Guide - &bz-ver;
<!-- BZ-DEVEL -->Development <!-- /BZ-DEVEL -->
Release</title>
<authorgroup>
<corpauthor>The Bugzilla Team</corpauthor>
</authorgroup>
<pubdate>&bz-date;</pubdate>
<abstract>
<para>
This is the documentation for Bugzilla, a
bug-tracking system from mozilla.org.
Bugzilla is an enterprise-class piece of software
that tracks millions of bugs and issues for hundreds of
organizations around the world.
</para>
<para>
The most current version of this document can always be found on the
<ulink url="http://www.bugzilla.org/docs/">Bugzilla
Documentation Page</ulink>.
</para>
</abstract>
<keywordset>
<keyword>Bugzilla</keyword>
<keyword>Guide</keyword>
<keyword>installation</keyword>
<keyword>FAQ</keyword>
<keyword>administration</keyword>
<keyword>integration</keyword>
<keyword>MySQL</keyword>
<keyword>Mozilla</keyword>
<keyword>webtools</keyword>
</keywordset>
</bookinfo>
<BOOKINFO>
<TITLE>The Bugzilla Guide</TITLE>
<PUBDATE>v2.12.0, 24 April 2001</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>
<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.
</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.
</revremark>
</revision>
</REVHISTORY>
<KEYWORDSET>
<KEYWORD>Bugzilla</KEYWORD>
<KEYWORD>Guide</KEYWORD>
<KEYWORD>installation</KEYWORD>
<KEYWORD>FAQ</KEYWORD>
<KEYWORD>administration</KEYWORD>
<KEYWORD>integration</KEYWORD>
<KEYWORD>MySQL</KEYWORD>
<KEYWORD>Mozilla</KEYWORD>
<KEYWORD>webtools</KEYWORD>
</KEYWORDSET>
</BOOKINFO>
<!-- About This Guide -->
&about;
......@@ -125,25 +133,31 @@
<!-- Administering Bugzilla -->
&administration;
<!-- Securing Bugzilla -->
&security;
<!-- Using Bugzilla -->
&using;
<!-- Customizing Bugzilla -->
&customization;
<!-- Integrating Bugzilla with Third-Party Tools -->
&integration;
<!-- The Future of Bugzilla -->
&future;
<!-- Appendix: The Frequently Asked Questions -->
&faq;
<!-- Appendix: Required Bugzilla Software Links -->
&requiredsoftware
<!-- Appendix: Troubleshooting -->
&troubleshooting;
<!-- Appendix: The Database Schema -->
&database;
<!-- Appendix: Major Bugzilla Variants -->
&variants;
<!-- Appendix: Custom Patches -->
&patches;
<!-- Appendix: Manually Installing Perl Modules -->
&modules;
<!-- Appendix: GNU Free Documentation License -->
<!-- Appendix: The GNU Free Documentation License -->
&gfdl;
<!-- Glossary -->
......@@ -152,27 +166,31 @@
<!-- Index -->
&index;
</book>
</BOOK>
<!-- 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-omittag:t
sgml-shorttag:t
sgml-namecase-general:t
sgml-general-insert-case:lower
sgml-indent-data:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:2
sgml-indent-data:t
sgml-parent-document:nil
sgml-exposed-tags:nil
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.xml" "book" "chapter")
sgml-shorttag:t
sgml-tag-region-if-active:t
End:
-->
<!-- <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [
<!ENTITY conventions SYSTEM "conventions.xml"> ] > -->
<!-- $Id: about.xml,v 1.1 2008/04/03 19:05:43 lpsolit%gmail.com Exp $ -->
<chapter id="about">
<title>About This Guide</title>
<section id="copyright">
<title>Copyright Information</title>
<para>This document is copyright (c) 2000-&current-year; by the various
Bugzilla contributors who wrote it.</para>
<blockquote>
<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 <xref linkend="gfdl"/>.
</para>
</blockquote>
<para>
If you have any questions regarding this document, its
copyright, or publishing this document in non-electronic form,
please contact the Bugzilla Team.
</para>
</section>
<section id="disclaimer">
<title>Disclaimer</title>
<para>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [
<!ENTITY conventions SYSTEM "conventions.sgml"> ] >
<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="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="disclaimer">
<TITLE>Disclaimer</TITLE>
<PARA>
No liability for the contents of this document can be accepted.
Follow the instructions herein at your own risk.
This document may contain errors
and inaccuracies that may damage your system, cause your partner
to leave you, your boss to fire you, your cats to
pee on your furniture and clothing, and global thermonuclear
war. Proceed with caution.
</para>
<para>
Naming of particular products or brands should not be seen as
endorsements, with the exception of the term "GNU/Linux". We
wholeheartedly endorse the use of GNU/Linux; it is an extremely
versatile, stable,
and robust operating system that offers an ideal operating
environment for Bugzilla.
</para>
<para>
Although the Bugzilla development team has taken great care to
ensure that all exploitable bugs have been fixed, security holes surely
exist in any piece of code. Great care should be taken both in
the installation and usage of this software. The Bugzilla development
team members assume no liability for your use of Bugzilla. You have
the source code, and are responsible for auditing it yourself to ensure
your security needs are met.
</para>
</section>
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>
<!-- Section 2: New Versions -->
<section id="newversions">
<title>New Versions</title>
<para>
This is the &bz-ver; version of The Bugzilla Guide. It is so named
to match the current version of Bugzilla.
<!-- BZ-DEVEL --> This version of the guide, like its associated Bugzilla version, is a
development version.<!-- /BZ-DEVEL -->
</para>
<para>
The latest version of this guide can always be found at <ulink
url="http://www.bugzilla.org"/>, or checked out via CVS by
following the <ulink url="http://www.mozilla.org/cvs.html">Mozilla
CVS</ulink> instructions and check out the
<filename>mozilla/webtools/bugzilla/docs/</filename>
subtree. However, you should read the version
which came with the Bugzilla release you are using.
</para>
<para>
The Bugzilla Guide, or a section of it, is also available in
the following languages:
<ulink url="http://www.traduc.org/docs/guides/lecture/bugzilla/">French</ulink>,
<ulink url="http://bugzilla-de.sourceforge.net/docs/html/">German</ulink>,
<ulink url="http://www.bugzilla.jp/docs/2.18/">Japanese</ulink>.
Note that these may be outdated or not up to date.
</para>
<para>
In addition, there are Bugzilla template localization projects in
the following languages. They may have translated documentation
available:
<ulink url="http://sourceforge.net/projects/bugzilla-ar/">Arabic</ulink>,
<ulink url="http://sourceforge.net/projects/bugzilla-be/">Belarusian</ulink>,
<ulink url="http://openfmi.net/projects/mozilla-bg/">Bulgarian</ulink>,
<ulink url="http://sourceforge.net/projects/bugzilla-br/">Brazilian Portuguese</ulink>,
<ulink url="http://sourceforge.net/projects/bugzilla-cn/">Chinese</ulink>,
<ulink url="http://sourceforge.net/projects/bugzilla-fr/">French</ulink>,
<ulink url="http://germzilla.ganderbay.net/">German</ulink>,
<ulink url="http://sourceforge.net/projects/bugzilla-it/">Italian</ulink>,
<ulink url="http://www.bugzilla.jp/about/jp.html">Japanese</ulink>,
<ulink url="http://sourceforge.net/projects/bugzilla-kr/">Korean</ulink>,
<ulink url="http://sourceforge.net/projects/bugzilla-ru/">Russian</ulink> and
<ulink url="http://sourceforge.net/projects/bugzilla-es/">Spanish</ulink>.
</para>
<para>
If you would like to volunteer to translate the Guide into additional
languages, please contact
<ulink url="mailto:justdave@bugzilla.org">Dave Miller</ulink>.
</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 writing, dedicated hacking efforts,
numerous e-mail and IRC support sessions, and overall excellent
contribution to the Bugzilla community:
</para>
<!-- TODO: This is evil... there has to be a valid way to get this look -->
<variablelist>
<varlistentry>
<term>Matthew P. Barnson <email>mbarnson@sisna.com</email></term>
<listitem>
<para>for the Herculean task of pulling together the Bugzilla Guide
and shepherding it to 2.14.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Terry Weissman <email>terry@mozilla.org</email></term>
<listitem>
<para>for initially writing Bugzilla and creating the README upon
which the UNIX installation documentation is largely based.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Tara Hernandez <email>tara@tequilarists.org</email></term>
<listitem>
<para>for keeping Bugzilla development going strong after Terry left
mozilla.org and for running landfill.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Dave Lawrence <email>dkl@redhat.com</email></term>
<listitem>
<para>for providing insight into the key differences between Red
Hat's customized Bugzilla.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Dawn Endico <email>endico@mozilla.org</email></term>
<listitem>
<para>for being a hacker extraordinaire and putting up with Matthew's
incessant questions and arguments on irc.mozilla.org in #mozwebtools
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Jacob Steenhagen <email>jake@bugzilla.org</email></term>
<listitem>
<para>for taking over documentation during the 2.17 development
period.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Dave Miller <email>justdave@bugzilla.org</email></term>
<listitem>
<para>for taking over as project lead when Tara stepped down and
continually pushing for the documentation to be the best it can be.
</para>
</listitem>
</varlistentry>
</variablelist>
<para>
Thanks also go to the following people for significant contributions
to this documentation:
<simplelist type="inline">
<member>Kevin Brannen</member>
<member>Vlad Dascalu</member>
<member>Ben FrantzDale</member>
<member>Eric Hanson</member>
<member>Zach Lipton</member>
<member>Gervase Markham</member>
<member>Andrew Pearson</member>
<member>Joe Robins</member>
<member>Spencer Smith</member>
<member>Ron Teitelbaum</member>
<member>Shane Travis</member>
<member>Martin Wulffeld</member>
</simplelist>.
</para>
<para>
Also, thanks are due to the members of the
<ulink url="news://news.mozilla.org/mozilla.support.bugzilla">
mozilla.support.bugzilla</ulink>
newsgroup (and its predecessor, netscape.public.mozilla.webtools).
Without your discussions, insight, suggestions, and patches,
this could never have happened.
</para>
</section>
<SECTION ID="newversions">
<TITLE>New Versions</TITLE>
<PARA>
This is the initial release of the Bugzilla 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>
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>
<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>
<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>
<!-- conventions used here (didn't want to give it a chapter of its own) -->
&conventions;
</chapter>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
</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-auto-insert-required-elements:t
sgml-balanced-tag-edit:t
sgml-indent-step:2
sgml-indent-data:t
sgml-parent-document:Bugzilla-Guide\.sgml
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.xml" "book" "chapter")
sgml-shorttag:t
sgml-tag-region-if-active:t
End: -->
sgml-local-ecat-files:nil
sgml-doctype:"<!DOCTYPE chapter PUBLIC \"-//OASIS//DTD DocBook V4.1//EN\">"
End:
-->
This source diff could not be displayed because it is too large. You can view the blob instead.
This source diff could not be displayed because it is too large. You can view the blob instead.
<!-- <!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 -->
<section id="integration">
<chapter id="integration">
<title>Integrating Bugzilla with Third-Party Tools</title>
<section id="bonsai"
xreflabel="Bonsai, the Mozilla automated CVS management system">
<section id="bonsai">
<title>Bonsai</title>
<para>Bonsai is a web-based tool for managing
<xref linkend="cvs" />
. Using Bonsai, administrators can control open/closed status of trees,
query a fast relational database back-end for change, branch, and comment
information, and view changes made since the last time the tree was
closed. Bonsai
also integrates with
<xref linkend="tinderbox" />.
</para>
<para>We need Bonsai integration information.</para>
</section>
<section id="cvs" xreflabel="CVS, the Concurrent Versioning System">
<section id="cvs">
<title>CVS</title>
<para>We need CVS integration information</para>
</section>
<para>CVS integration is best accomplished, at this point, using the
Bugzilla Email Gateway.</para>
<para>Follow the instructions in this Guide for enabling Bugzilla e-mail
integration. Ensure that your check-in script sends an email to your
Bugzilla e-mail gateway with the subject of
<quote>[Bug XXXX]</quote>,
and you can have CVS check-in comments append to your Bugzilla bug. If
you want to have the bug be closed automatically, you'll have to modify
the <filename>contrib/bugzilla_email_append.pl</filename> script.
<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
<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"
p4dti page at <ulink url="http://public.perforce.com/public/perforce/p4dti/index.html">
http://public.perforce.com/public/perforce/p4dti/index.html</ulink>.
</para>
<para>There is also a CVSZilla project, based upon somewhat dated
Bugzilla code, to integrate CVS and Bugzilla through CVS' ability to
email. Check it out at: <ulink url="http://www.cvszilla.org/"/>.
<para>
Integration of Perforce with Bugzilla, once patches are applied, is fairly seamless. However,
p4dti is a patch against the Bugzilla 2.10 release, not the current 2.12 release. I anticipate
patches for 2.12 will be out shortly. Check the project page regularly for updates, or
take the given patches and patch it manually. p4dti is designed to support multiple defect
trackers, and maintains its own documentation for it. Please consult the pages linked
above for further information.
</para>
<para>Another system capable of CVS integration with Bugzilla is
Scmbug. This system provides generic integration of Source code
Configuration Management with Bugtracking. Check it out at: <ulink
url="http://freshmeat.net/projects/scmbug/"/>.
<para>
Right now, there is no way to synchronize the Bug ID and the Perforce Transaction Number, or
to change the Bug ID to read (PRODUCT).bugID unless you hack it in. Additionally, if you
have synchronization problems, the easiest way to avoid them is to only put the bug
information, comments, etc. into Bugzilla, and not into the Perforce change records.
They will link anyway; merely reference the bug ID fixed in your change description,
and put a comment into Bugzilla
giving the change ID that fixed the Bugzilla bug. It's a process issue, not a technology
question.
</para>
</section>
<section id="scm"
xreflabel="Perforce SCM (Fast Software Configuration Management System, a powerful commercial alternative to CVS">
<title>Perforce SCM</title>
<para>You can find the project page for Bugzilla and Teamtrack Perforce
integration (p4dti) at:
<ulink url="http://www.ravenbrook.com/project/p4dti/"/>
.
<quote>p4dti</quote>
is now an officially supported product from Perforce, and you can find
the "Perforce Public Depot" p4dti page at
<ulink url="http://public.perforce.com/public/perforce/p4dti/index.html"/>
.</para>
<para>Integration of Perforce with Bugzilla, once patches are applied, is
seamless. Perforce replication information will appear below the comments
of each bug. Be certain you have a matching set of patches for the
Bugzilla version you are installing. p4dti is designed to support
multiple defect trackers, and maintains its own documentation for it.
Please consult the pages linked above for further information.</para>
</section>
<section id="svn"
xreflabel="Subversion, a compelling replacement for CVS">
<title>Subversion</title>
<para>Subversion is a free/open-source version control system,
designed to overcome various limitations of CVS. Integration of
Subversion with Bugzilla is possible using Scmbug, a system
providing generic integration of Source Code Configuration
Management with Bugtracking. Scmbug is available at <ulink
url="http://freshmeat.net/projects/scmbug/"/>.</para>
<section id="tinderbox">
<title>Tinderbox</title>
<para>We need Tinderbox integration information</para>
</section>
<section id="tinderbox"
xreflabel="Tinderbox, the Mozilla automated build management system">
<title>Tinderbox/Tinderbox2</title>
</chapter>
<para>Tinderbox is a continuous-build system which can integrate with
Bugzilla - see
<ulink url="http://www.mozilla.org/projects/tinderbox"/> for details
of Tinderbox, and
<ulink url="http://tinderbox.mozilla.org/showbuilds.cgi"/> to see it
in action.</para>
</section>
</section>
<!-- 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-omittag:t
sgml-shorttag:t
sgml-namecase-general:t
sgml-general-insert-case:lower
sgml-indent-data:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:2
sgml-indent-data:t
sgml-parent-document:nil
sgml-exposed-tags:nil
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.xml" "book" "chapter")
sgml-shorttag:t
sgml-tag-region-if-active:t
End:
-->
<!-- <!DOCTYPE appendix PUBLIC "-//OASIS//DTD DocBook V4.1//EN"> -->
<appendix id="patches" xreflabel="Useful Patches and Utilities for Bugzilla">
<title>Contrib</title>
<para>
There are a number of unofficial Bugzilla add-ons in the
<filename class="directory">$BUGZILLA_ROOT/contrib/</filename>
directory. This section documents them.
</para>
<!DOCTYPE appendix PUBLIC "-//OASIS//DTD DocBook V4.1//EN">
<appendix id="patches">
<title>Useful Patches and Utilities for Bugzilla</title>
<section id="setperl">
<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>
<procedure>
<step>
<para>
Download the "setperl.csh" utility to your Bugzilla
directory and make it executable.
</para>
<substeps>
<step>
<para>
<computeroutput>
<prompt>bash#</prompt>
<command>cd /your/path/to/bugzilla</command>
</computeroutput>
</para>
</step>
<step>
<para>
<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>
</para>
</step>
</substeps>
</step>
<step>
<para>
Prepare (and fix) Bugzilla file permissions.
</para>
<substeps>
<step>
<para>
<computeroutput>
<prompt>bash#</prompt>
<command>chmod u+w *</command>
</computeroutput>
</para>
</step>
<step>
<para>
<computeroutput>
<prompt>bash#</prompt>
<command>chmod u+x duplicates.cgi</command>
</computeroutput>
</para>
</step>
<step>
<para>
<computeroutput>
<prompt>bash#</prompt>
<command>chmod a-x bug_status.html</command>
</computeroutput>
</para>
</step>
</substeps>
</step>
<step>
<para>
Run the script:
</para>
<para>
<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>
</para>
</example>
</para>
</step>
</procedure>
</section>
<section id="cmdline">
<title>Command-line Search Interface</title>
<title>Command-line Bugzilla Queries</title>
<para>
There are a suite of Unix utilities for searching Bugzilla from the
command line. They live in the
<filename class="directory">contrib/cmdline</filename> directory.
There are three files - <filename>query.conf</filename>,
<filename>buglist</filename> and <filename>bugs</filename>.
Users can query Bugzilla from the command line using
this suite of utilities.
</para>
<warning>
<para>
These files pre-date the templatization work done as part of the
2.16 release, and have not been updated.
</para>
</warning>
<para>
<filename>query.conf</filename> contains the mapping from
options to field names and comparison types. Quoted option names
are <quote>grepped</quote> 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 <quote>option</quote>.
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"
</para>
<para>
<filename>buglist</filename> is a shell script that submits a
Bugzilla query and writes the resulting HTML page to stdout.
It supports both short options, (such as <quote>-Afoo</quote>
or <quote>-Rbar</quote>) and long options (such
as <quote>--assignedto=foo</quote> or <quote>--reporter=bar</quote>).
If the first character of an option is not <quote>-</quote>, it is
treated as if it were prefixed with <quote>--default=</quote>.
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 column list is taken from the COLUMNLIST environment variable.
This is equivalent to the <quote>Change Columns</quote> option
that is available when you list bugs in buglist.cgi. If you have
already used Bugzilla, grep for COLUMNLIST in your cookies file
to see your current COLUMNLIST setting.
The columlist is taken from the COLUMNLIST environment variable.
This is equivalent to the "Change Columns" option when you list
bugs in buglist.cgi. If you have already used Bugzilla, use
<command>grep COLUMLIST ~/.netscape/cookies</command> to see
your current COLUMNLIST setting.
</para>
<para>
<filename>bugs</filename> is a simple shell script which calls
<filename>buglist</filename> and extracts the
bug numbers from the output. Adding the prefix
<quote>http://bugzilla.mozilla.org/buglist.cgi?bug_id=</quote>
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
Counting bugs is easy. Pipe the results through
<command>sed -e 's/,/ /g' | wc | awk '{printf $2 "\n"}'</command>
</para>
<para>
Akkana Peck says she has good results piping
<filename>buglist</filename> output through
Akkana says she has good results piping buglist output through
<command>w3m -T text/html -dump</command>
</para>
<procedure>
<step>
<para>
Download three files:
</para>
<substeps>
<step>
<para>
<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>
</para>
</step>
<step>
<para>
<computeroutput>
<prompt>bash#</prompt>
<command>wget -O bugs 'http://bugzilla.mozilla.org/showattachment.cgi?attach_id=26215'</command>
</computeroutput>
</para>
</step>
</substeps>
</step>
<step>
<para>
Make your utilities executable:
<computeroutput>
<prompt>bash$</prompt>
<command>chmod u+x buglist bugs</command>
</computeroutput>
</para>
</step>
</procedure>
</section>
<section id="cmdline-bugmail">
<title>Command-line 'Send Unsent Bug-mail' tool</title>
<section id="quicksearch">
<title>The Quicksearch Utility</title>
<para>
Within the <filename class="directory">contrib</filename> directory
exists a utility with the descriptive (if compact) name
of <filename>sendunsentbugmail.pl</filename>. The purpose of this
script is, simply, to send out any bug-related mail that should
have been sent by now, but for one reason or another has not.
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"
</para>
<para>
To accomplish this task, <filename>sendunsentbugmail.pl</filename> uses
the same mechanism as the <filename>sanitycheck.cgi</filename> script;
it scans through the entire database looking for bugs with changes that
were made more than 30 minutes ago, but where there is no record of
anyone related to that bug having been sent mail. Having compiled a list,
it then uses the standard rules to determine who gets mail, and sends it
out.
The index.html page has been updated to include the QuickSearch text box.
</para>
<para>
As the script runs, it indicates the bug for which it is currently
sending mail; when it has finished, it gives a numerical count of how
many mails were sent and how many people were excluded. (Individual
user names are not recorded or displayed.) If the script produces
no output, that means no unsent mail was detected.
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".
</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>
</simplelist>
</para>
<para>
<emphasis>Usage</emphasis>: move the sendunsentbugmail.pl script
up into the main directory, ensure it has execute permission, and run it
from the command line (or from a cron job) with no parameters.
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-always-quote-attributes:t
sgml-auto-insert-required-elements:t
sgml-balanced-tag-edit:t
sgml-exposed-tags:nil
sgml-omittag:t
sgml-shorttag:t
sgml-namecase-general:t
sgml-general-insert-case:lower
sgml-indent-data:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:2
sgml-indent-data:t
sgml-parent-document:nil
sgml-exposed-tags:nil
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.xml" "book" "chapter")
sgml-shorttag:t
sgml-tag-region-if-active:t
End:
-->
This source diff could not be displayed because it is too large. You can view the blob instead.
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment