Commit 666b9d62 authored by gerv%gerv.net's avatar gerv%gerv.net

More documentation updates.

parent 0b4ece44
This source diff could not be displayed because it is too large. You can view the blob instead.
<!-- <!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook V4.1//EN"> --> <!-- <!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook V4.1//EN"> -->
<section id="conventions"> <section id="conventions">
<title>Document Conventions</title> <title>Document Conventions</title>
<indexterm zone="conventions"> <indexterm zone="conventions">
<primary>conventions</primary> <primary>conventions</primary>
</indexterm> </indexterm>
<para> <para>This document uses the following conventions</para>
This document uses the following conventions
</para>
<informaltable frame="none"> <informaltable frame="none">
<tgroup cols="2"> <tgroup cols="2">
<thead> <thead>
<row> <row>
<entry>Descriptions</entry> <entry>Descriptions</entry>
<entry>Appearance</entry> <entry>Appearance</entry>
</row> </row>
</thead> </thead>
<tbody> <tbody>
<row> <row>
<entry>Warnings</entry> <entry>Warnings</entry>
<entry><caution>
<entry>
<caution>
<para>Don't run with scissors!</para> <para>Don't run with scissors!</para>
</caution></entry> </caution>
</entry>
</row> </row>
<row> <row>
<entry>Hint</entry> <entry>Hint</entry>
<entry><tip>
<entry>
<tip>
<para>Warm jar lids under the hot tap to loosen them.</para> <para>Warm jar lids under the hot tap to loosen them.</para>
</tip></entry> </tip>
</entry>
</row> </row>
<row> <row>
<entry>Notes</entry> <entry>Notes</entry>
<entry><note>
<entry>
<note>
<para>Dear John...</para> <para>Dear John...</para>
</note></entry> </note>
</entry>
</row> </row>
<row> <row>
<entry>Information requiring special attention</entry> <entry>Information requiring special attention</entry>
<entry><warning>
<entry>
<warning>
<para>Read this or the cat gets it.</para> <para>Read this or the cat gets it.</para>
</warning></entry> </warning>
</entry>
</row> </row>
<row> <row>
<entry>File Names</entry> <entry>File Names</entry>
<entry><filename>file.extension</filename></entry>
<entry>
<filename>file.extension</filename>
</entry>
</row> </row>
<row> <row>
<entry>Directory Names</entry> <entry>Directory Names</entry>
<entry><filename class="directory">directory</filename></entry>
<entry>
<filename class="directory">directory</filename>
</entry>
</row> </row>
<row> <row>
<entry>Commands to be typed</entry> <entry>Commands to be typed</entry>
<entry><command>command</command></entry>
<entry>
<command>command</command>
</entry>
</row> </row>
<row> <row>
<entry>Applications Names</entry> <entry>Applications Names</entry>
<entry><application>application</application></entry>
<entry>
<application>application</application>
</entry>
</row> </row>
<row> <row>
<entry><foreignphrase>Prompt</foreignphrase> of users command under bash shell</entry> <entry>
<foreignphrase>Prompt</foreignphrase>
of users command under bash shell</entry>
<entry>bash$</entry> <entry>bash$</entry>
</row> </row>
<row> <row>
<entry><foreignphrase>Prompt</foreignphrase> of root users command under bash shell</entry> <entry>
<foreignphrase>Prompt</foreignphrase>
of root users command under bash shell</entry>
<entry>bash#</entry> <entry>bash#</entry>
</row> </row>
<row>
<entry><foreignphrase>Prompt</foreignphrase> of user command under tcsh shell</entry> <row>
<entry>tcsh$</entry> <entry>
</row> <foreignphrase>Prompt</foreignphrase>
of user command under tcsh shell</entry>
<entry>tcsh$</entry>
</row>
<row> <row>
<entry>Environment Variables</entry> <entry>Environment Variables</entry>
<entry><envar>VARIABLE</envar></entry>
<entry>
<envar>VARIABLE</envar>
</entry>
</row> </row>
<row> <row>
<entry>Emphasized word</entry> <entry>Emphasized word</entry>
<entry><emphasis>word</emphasis></entry>
<entry>
<emphasis>word</emphasis>
</entry>
</row> </row>
<row> <row>
<entry>Code Example</entry> <entry>Code Example</entry>
<entry><programlisting><sgmltag class="starttag">para</sgmltag>Beginning and end of paragraph<sgmltag class="endtag">para</sgmltag></programlisting></entry>
<entry>
<programlisting>
<sgmltag class="starttag">para</sgmltag>
Beginning and end of paragraph
<sgmltag class="endtag">para</sgmltag>
</programlisting>
</entry>
</row> </row>
</tbody> </tbody>
</tgroup> </tgroup>
</informaltable> </informaltable>
</section> </section>
<!-- Keep this comment at the end of the file <!-- Keep this comment at the end of the file
Local variables: Local variables:
mode: sgml mode: sgml
...@@ -114,3 +171,4 @@ sgml-shorttag:t ...@@ -114,3 +171,4 @@ sgml-shorttag:t
sgml-tag-region-if-active:t sgml-tag-region-if-active:t
End: End:
--> -->
...@@ -4,7 +4,7 @@ ...@@ -4,7 +4,7 @@
<!-- - GNU Project - Free Software Foundation (FSF) --> <!-- - GNU Project - Free Software Foundation (FSF) -->
<!-- LINK REV="made" HREF="mailto:webmasters@gnu.org" --> <!-- LINK REV="made" HREF="mailto:webmasters@gnu.org" -->
<!-- section> <!-- sect1>
<title>GNU Free Documentation License</title --> <title>GNU Free Documentation License</title -->
<para>Version 1.1, March 2000</para> <para>Version 1.1, March 2000</para>
...@@ -15,8 +15,8 @@ ...@@ -15,8 +15,8 @@
not allowed.</para> not allowed.</para>
</blockquote> </blockquote>
<section label="0" id="gfdl-0"> <sect1 label="0" id="gfdl-0">
<title>Preamble</title> <title>PREAMBLE</title>
<para>The purpose of this License is to make a manual, textbook, or other <para>The purpose of this License is to make a manual, textbook, or other
written document "free" in the sense of freedom: to assure everyone the written document "free" in the sense of freedom: to assure everyone the
...@@ -38,10 +38,10 @@ ...@@ -38,10 +38,10 @@
can be used for any textual work, regardless of subject matter or whether can be used for any textual work, regardless of subject matter or whether
it is published as a printed book. We recommend this License principally it is published as a printed book. We recommend this License principally
for works whose purpose is instruction or reference.</para> for works whose purpose is instruction or reference.</para>
</section> </sect1>
<section label="1" id="gfdl-1"> <sect1 label="1" id="gfdl-1">
<title>Applicability and Definition</title> <title>APPLICABILITY AND DEFINITIONS</title>
<para>This License applies to any manual or other work that contains a <para>This License applies to any manual or other work that contains a
notice placed by the copyright holder saying it can be distributed under notice placed by the copyright holder saying it can be distributed under
...@@ -98,10 +98,10 @@ ...@@ -98,10 +98,10 @@
which do not have any title page as such, "Title Page" means the text which do not have any title page as such, "Title Page" means the text
near the most prominent appearance of the work's title, preceding the near the most prominent appearance of the work's title, preceding the
beginning of the body of the text.</para> beginning of the body of the text.</para>
</section> </sect1>
<section label="2" id="gfdl-2"> <sect1 label="2" id="gfdl-2">
<title>Verbatim Copying</title> <title>VERBATIM COPYING</title>
<para>You may copy and distribute the Document in any medium, either <para>You may copy and distribute the Document in any medium, either
commercially or noncommercially, provided that this License, the commercially or noncommercially, provided that this License, the
...@@ -115,10 +115,10 @@ ...@@ -115,10 +115,10 @@
<para>You may also lend copies, under the same conditions stated above, <para>You may also lend copies, under the same conditions stated above,
and you may publicly display copies.</para> and you may publicly display copies.</para>
</section> </sect1>
<section label="3" id="gfdl-3"> <sect1 label="3" id="gfdl-3">
<title>Copying in Quantity</title> <title>COPYING IN QUANTITY</title>
<para>If you publish printed copies of the Document numbering more than <para>If you publish printed copies of the Document numbering more than
100, and the Document's license notice requires Cover Texts, you must 100, and the Document's license notice requires Cover Texts, you must
...@@ -154,10 +154,10 @@ ...@@ -154,10 +154,10 @@
the Document well before redistributing any large number of copies, to the Document well before redistributing any large number of copies, to
give them a chance to provide you with an updated version of the give them a chance to provide you with an updated version of the
Document.</para> Document.</para>
</section> </sect1>
<section label="4" id="gfdl-4"> <sect1 label="4" id="gfdl-4">
<title>Modifications</title> <title>MODIFICATIONS</title>
<para>You may copy and distribute a Modified Version of the Document <para>You may copy and distribute a Modified Version of the Document
under the conditions of sections 2 and 3 above, provided that you release under the conditions of sections 2 and 3 above, provided that you release
...@@ -284,10 +284,10 @@ ...@@ -284,10 +284,10 @@
<para>The author(s) and publisher(s) of the Document do not by this <para>The author(s) and publisher(s) of the Document do not by this
License give permission to use their names for publicity for or to assert License give permission to use their names for publicity for or to assert
or imply endorsement of any Modified Version.</para> or imply endorsement of any Modified Version.</para>
</section> </sect1>
<section label="5" id="gfdl-5"> <sect1 label="5" id="gfdl-5">
<title>Combining Documents</title> <title>COMBINING DOCUMENTS</title>
<para>You may combine the Document with other documents released under <para>You may combine the Document with other documents released under
this License, under the terms defined in section 4 above for modified this License, under the terms defined in section 4 above for modified
...@@ -310,10 +310,10 @@ ...@@ -310,10 +310,10 @@
"History"; likewise combine any sections entitled "Acknowledgements", and "History"; likewise combine any sections entitled "Acknowledgements", and
any sections entitled "Dedications". You must delete all sections any sections entitled "Dedications". You must delete all sections
entitled "Endorsements."</para> entitled "Endorsements."</para>
</section> </sect1>
<section label="6" id="gfdl-6"> <sect1 label="6" id="gfdl-6">
<title>Collections of Documents</title> <title>COLLECTIONS OF DOCUMENTS</title>
<para>You may make a collection consisting of the Document and other <para>You may make a collection consisting of the Document and other
documents released under this License, and replace the individual copies documents released under this License, and replace the individual copies
...@@ -326,10 +326,10 @@ ...@@ -326,10 +326,10 @@
distribute it individually under this License, provided you insert a copy distribute it individually under this License, provided you insert a copy
of this License into the extracted document, and follow this License in of this License into the extracted document, and follow this License in
all other respects regarding verbatim copying of that document.</para> all other respects regarding verbatim copying of that document.</para>
</section> </sect1>
<section label="7" id="gfdl-7"> <sect1 label="7" id="gfdl-7">
<title>Aggregation with Independent Works</title> <title>AGGREGATION WITH INDEPENDENT WORKS</title>
<para>A compilation of the Document or its derivatives with other <para>A compilation of the Document or its derivatives with other
separate and independent documents or works, in or on a volume of a separate and independent documents or works, in or on a volume of a
...@@ -345,10 +345,10 @@ ...@@ -345,10 +345,10 @@
the entire aggregate, the Document's Cover Texts may be placed on covers the entire aggregate, the Document's Cover Texts may be placed on covers
that surround only the Document within the aggregate. Otherwise they must that surround only the Document within the aggregate. Otherwise they must
appear on covers around the whole aggregate.</para> appear on covers around the whole aggregate.</para>
</section> </sect1>
<section label="8" id="gfdl-8"> <sect1 label="8" id="gfdl-8">
<title>Translation</title> <title>TRANSLATION</title>
<para>Translation is considered a kind of modification, so you may <para>Translation is considered a kind of modification, so you may
distribute translations of the Document under the terms of section 4. distribute translations of the Document under the terms of section 4.
...@@ -360,10 +360,10 @@ ...@@ -360,10 +360,10 @@
License. In case of a disagreement between the translation and the License. In case of a disagreement between the translation and the
original English version of this License, the original English version original English version of this License, the original English version
will prevail.</para> will prevail.</para>
</section> </sect1>
<section label="9" id="gfdl-9"> <sect1 label="9" id="gfdl-9">
<title>Termination</title> <title>TERMINATION</title>
<para>You may not copy, modify, sublicense, or distribute the Document <para>You may not copy, modify, sublicense, or distribute the Document
except as expressly provided for under this License. Any other attempt to except as expressly provided for under this License. Any other attempt to
...@@ -372,16 +372,19 @@ ...@@ -372,16 +372,19 @@
who have received copies, or rights, from you under this License will not who have received copies, or rights, from you under this License will not
have their licenses terminated so long as such parties remain in full have their licenses terminated so long as such parties remain in full
compliance.</para> compliance.</para>
</section> </sect1>
<section label="10" id="gfdl-10"> <sect1 label="10" id="gfdl-10">
<title>Future Revisions of this License</title> <title>FUTURE REVISIONS OF THIS LICENSE</title>
<para>The Free Software Foundation may publish new, revised versions of <para>The Free Software Foundation may publish new, revised versions of
the GNU Free Documentation License from time to time. Such new versions the GNU Free Documentation License from time to time. Such new versions
will be similar in spirit to the present version, but may differ in will be similar in spirit to the present version, but may differ in
detail to address new problems or concerns. See detail to address new problems or concerns. See
<ulink url="http://www.gnu.org/copyleft/"/>.</para> <ulink url="http://www.gnu.org/copyleft/">
http://www.gnu.org/copyleft/</ulink>
.</para>
<para>Each version of the License is given a distinguishing version <para>Each version of the License is given a distinguishing version
number. If the Document specifies that a particular numbered version of number. If the Document specifies that a particular numbered version of
...@@ -391,9 +394,9 @@ ...@@ -391,9 +394,9 @@
Software Foundation. If the Document does not specify a version number of Software Foundation. If the Document does not specify a version number of
this License, you may choose any version ever published (not as a draft) this License, you may choose any version ever published (not as a draft)
by the Free Software Foundation.</para> by the Free Software Foundation.</para>
</section> </sect1>
<section label="" id="gfdl-howto"> <sect1 label="" id="gfdl-howto">
<title>How to use this License for your documents</title> <title>How to use this License for your documents</title>
<para>To use this License in a document you have written, include a copy <para>To use this License in a document you have written, include a copy
...@@ -419,7 +422,7 @@ ...@@ -419,7 +422,7 @@
recommend releasing these examples in parallel under your choice of free recommend releasing these examples in parallel under your choice of free
software license, such as the GNU General Public License, to permit their software license, such as the GNU General Public License, to permit their
use in free software.</para> use in free software.</para>
</section> </sect1>
</appendix> </appendix>
<!-- Keep this comment at the end of the file <!-- Keep this comment at the end of the file
...@@ -437,7 +440,7 @@ sgml-local-ecat-files:nil ...@@ -437,7 +440,7 @@ sgml-local-ecat-files:nil
sgml-minimize-attributes:nil sgml-minimize-attributes:nil
sgml-namecase-general:t sgml-namecase-general:t
sgml-omittag:t sgml-omittag:t
sgml-parent-document:("Bugzilla-Guide.xml" "book" "chapter") sgml-parent-document:("Bugzilla-Guide.sgml" "book" "chapter")
sgml-shorttag:t sgml-shorttag:t
sgml-tag-region-if-active:t sgml-tag-region-if-active:t
End: End:
......
...@@ -15,7 +15,10 @@ ...@@ -15,7 +15,10 @@
to keep secret files which would otherwise to keep secret files which would otherwise
compromise your installation - e.g. the compromise your installation - e.g. the
<filename>localconfig</filename> <filename>localconfig</filename>
file contains the password to your database.
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> curious.</para>
</glossdef> </glossdef>
</glossentry> </glossentry>
...@@ -24,66 +27,23 @@ ...@@ -24,66 +27,23 @@
<glossdiv id="gloss-a"> <glossdiv id="gloss-a">
<title>A</title> <title>A</title>
<glossentry id="gloss-apache"> <glossentry>
<glossterm>Apache</glossterm> <glossterm>Apache</glossterm>
<glossdef> <glossdef>
<para>In this context, Apache is the web server most commonly used <para>In this context, Apache is the web server most commonly used
for serving up Bugzilla for serving up
<glossterm>Bugzilla</glossterm>
pages. Contrary to popular belief, the apache web server has nothing pages. Contrary to popular belief, the apache web server has nothing
to do with the ancient and noble Native American tribe, but instead to do with the ancient and noble Native American tribe, but instead
derived its name from the fact that it was derived its name from the fact that it was
<quote>a patchy</quote> <quote>a patchy</quote>
version of the original version of the original
<acronym>NCSA</acronym> <acronym>NCSA</acronym>
world-wide-web server.</para>
<variablelist> world-wide-web server.</para>
<title>Useful Directives when configuring Bugzilla</title>
<varlistentry>
<term><computeroutput><ulink url="http://httpd.apache.org/docs-2.0/mod/core.html#addhandler">AddHandler</ulink></computeroutput></term>
<listitem>
<para>Tell Apache that it's OK to run CGI scripts.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><computeroutput><ulink url="http://httpd.apache.org/docs-2.0/mod/core.html#allowoverride">AllowOverride</ulink></computeroutput></term>
<term><computeroutput><ulink url="http://httpd.apache.org/docs-2.0/mod/core.html#options">Options</ulink></computeroutput></term>
<listitem>
<para>These directives are used to tell Apache many things about
the directory they apply to. For Bugzilla's purposes, we need
them to allow script execution and <filename>.htaccess</filename>
overrides.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><computeroutput><ulink url="http://httpd.apache.org/docs-2.0/mod/mod_dir.html#directoryindex">DirectoryIndex</ulink></computeroutput></term>
<listitem>
<para>Used to tell Apache what files are indexes. If you can
not add <filename>index.cgi</filename> to the list of valid files,
you'll need to set <computeroutput>$index_html</computeroutput> to
1 in <filename>localconfig</filename> so
<command>./checksetup.pl</command> will create an
<filename>index.html</filename> that redirects to
<filename>index.cgi</filename>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><computeroutput><ulink url="http://httpd.apache.org/docs-2.0/mod/core.html#scriptinterpretersource">ScriptInterpreterSource</ulink></computeroutput></term>
<listitem>
<para>Used when running Apache on windows so the shebang line
doesn't have to be changed in every Bugzilla script.
</para>
</listitem>
</varlistentry>
</variablelist>
<para>For more information about how to configure Apache for Bugzilla,
see <xref linkend="http-apache"/>.
</para>
</glossdef> </glossdef>
</glossentry> </glossentry>
</glossdiv> </glossdiv>
...@@ -96,7 +56,7 @@ ...@@ -96,7 +56,7 @@
<glossdef> <glossdef>
<para>A <para>A
<quote>bug</quote> <quote>Bug</quote>
in Bugzilla refers to an issue entered into the database which has an in Bugzilla refers to an issue entered into the database which has an
associated number, assignments, comments, etc. Some also refer to a associated number, assignments, comments, etc. Some also refer to a
...@@ -111,36 +71,40 @@ ...@@ -111,36 +71,40 @@
<glossterm>Bug Number</glossterm> <glossterm>Bug Number</glossterm>
<glossdef> <glossdef>
<para>Each Bugzilla bug is assigned a number that uniquely identifies <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 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 query, or easily from the very front page by typing the number in the
"Find" box.</para> "Find" box.</para>
</glossdef> </glossdef>
</glossentry> </glossentry>
<glossentry id="gloss-bugzilla"> <glossentry>
<glossterm>Bugzilla</glossterm> <glossterm>Bug Life Cycle</glossterm>
<glossdef> <glossdef>
<para>Bugzilla is the world-leading free software bug tracking system. <para>A Bug has stages through which it must pass before becoming a
</para> <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> </glossdef>
</glossentry> </glossentry>
</glossdiv>
<glossdiv id="gloss-c"> <glossentry>
<title>C</title> <glossterm>Bugzilla</glossterm>
<glossentry id="gloss-cgi">
<glossterm>Common Gateway Interface</glossterm>
<acronym>CGI</acronym>
<glossdef> <glossdef>
<para><acronym>CGI</acronym> is an acronym for Common Gateway Interface. This is <para>Bugzilla is the industry-standard bug tracking system. It is
a standard for interfacing an external application with a web server. Bugzilla quite popular among Open Source enthusiasts.</para>
is an example of a <acronym>CGI</acronym> application.
</para>
</glossdef> </glossdef>
</glossentry> </glossentry>
</glossdiv>
<glossdiv id="gloss-c">
<title>
</title>
<glossentry id="gloss-component"> <glossentry id="gloss-component">
<glossterm>Component</glossterm> <glossterm>Component</glossterm>
...@@ -154,40 +118,23 @@ ...@@ -154,40 +118,23 @@
</glossentry> </glossentry>
<glossentry id="gloss-cpan"> <glossentry id="gloss-cpan">
<glossterm>Comprehensive Perl Archive Network</glossterm> <glossterm>
<acronym>CPAN</acronym> <acronym>CPAN</acronym>
</glossterm>
<!-- TODO: Rewrite def for CPAN -->
<glossdef> <glossdef>
<para> <para>
<acronym>CPAN</acronym> <acronym>CPAN</acronym>
stands for the stands for the
<quote>Comprehensive Perl Archive Network</quote>. <quote>Comprehensive Perl Archive Network</quote>
CPAN maintains a large number of extremely useful
<glossterm>Perl</glossterm>
modules - encapsulated chunks of code for performing a
particular task.</para>
</glossdef>
</glossentry>
<glossentry id="gloss-contrib"> . CPAN maintains a large number of extremely useful
<glossterm><filename class="directory">contrib</filename></glossterm> <glossterm>Perl</glossterm>
<glossdef> modules. By themselves, Perl modules generally do nothing, but when
<para>The <filename class="directory">contrib</filename> directory is used as part of a larger program, they provide much-needed algorithms
a location to put scripts that have been contributed to Bugzilla but and functionality.</para>
are not a part of the official distribution. These scripts are written
by third parties and may be in languages other than perl. For those
that are in perl, there may be additional modules or other requirements
than those of the offical distribution.
<note>
<para>Scripts in the <filename class="directory">contrib</filename>
directory are not offically supported by the Bugzilla team and may
break in between versions.
</para>
</note>
</para>
</glossdef> </glossdef>
</glossentry> </glossentry>
</glossdiv> </glossdiv>
...@@ -211,9 +158,10 @@ ...@@ -211,9 +158,10 @@
</glossdiv> </glossdiv>
<glossdiv id="gloss-g"> <glossdiv id="gloss-g">
<title>G</title> <title>
</title>
<glossentry id="gloss-groups"> <glossentry>
<glossterm>Groups</glossterm> <glossterm>Groups</glossterm>
<glossdef> <glossdef>
...@@ -221,24 +169,29 @@ ...@@ -221,24 +169,29 @@
<quote>Groups</quote> <quote>Groups</quote>
has a very special meaning to Bugzilla. Bugzilla's main security has a very special meaning to Bugzilla. Bugzilla's main security
mechanism comes by placing users in groups, and assigning those mechanism comes by lumping users into groups, and assigning those
groups certain privileges to view bugs in particular groups certain privileges to
<glossterm>Products</glossterm> <glossterm>Products</glossterm>
and
<glossterm>Components</glossterm>
in the in the
<glossterm>Bugzilla</glossterm> <glossterm>Bugzilla</glossterm>
database.</para> database.</para>
</glossdef> </glossdef>
</glossentry> </glossentry>
</glossdiv> </glossdiv>
<glossdiv id="gloss-j"> <glossdiv id="gloss-i">
<title>J</title> <title>I</title>
<glossentry id="gloss-infiniteloop">
<glossterm>Infinite Loop</glossterm>
<glossentry id="gloss-javascript">
<glossterm>JavaScript</glossterm>
<glossdef> <glossdef>
<para>JavaScript is cool, we should talk about it. <para>A loop of information that never ends; see recursion.</para>
</para>
</glossdef> </glossdef>
</glossentry> </glossentry>
</glossdiv> </glossdiv>
...@@ -246,56 +199,17 @@ ...@@ -246,56 +199,17 @@
<glossdiv id="gloss-m"> <glossdiv id="gloss-m">
<title>M</title> <title>M</title>
<glossentry id="gloss-mta"> <glossentry>
<glossterm>Message Transport Agent</glossterm> <glossterm>mysqld</glossterm>
<acronym>MTA</acronym>
<glossdef> <glossdef>
<para>A Message Transport Agent is used to control the flow of email <para>mysqld is the name of the
on a system. Many unix based systems use <glossterm>daemon</glossterm>
<ulink url="http://www.sendmail.org">sendmail</ulink> which is what
Bugzilla expects to find by default at <filename>/usr/sbin/sendmail</filename>.
Many other MTA's will work, but they all require that the
<option>sendmailnow</option> param be set to <literal>on</literal>.
</para>
</glossdef>
</glossentry>
<glossentry id="gloss-mysql">
<glossterm>MySQL</glossterm>
<glossdef> for the MySQL database. In general, it is invoked automatically
<para>MySQL is currently the required through the use of the System V init scripts on GNU/Linux and
<glossterm linkend="gloss-rdbms">RDBMS</glossterm> for Bugzilla. MySQL AT&amp;T System V-based systems, such as Solaris and HP/UX, or
can be downloaded from <ulink url="http://www.mysql.com"/>. While you through the RC scripts on BSD-based systems.</para>
should familiarize yourself with all of the documentation, some high
points are:
</para>
<variablelist>
<varlistentry>
<term><ulink url="http://www.mysql.com/doc/en/Backup.html">Backup</ulink></term>
<listitem>
<para>Methods for backing up your Bugzilla database.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><ulink url="http://www.mysql.com/doc/en/Option_files.html">Option Files</ulink></term>
<listitem>
<para>Information about how to configure MySQL using
<filename>my.cnf</filename>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><ulink url="http://www.mysql.com/doc/en/Privilege_system.html">Privilege System</ulink></term>
<listitem>
<para>Much more detailed information about the suggestions in
<xref linkend="security-mysql"/>.
</para>
</listitem>
</varlistentry>
</variablelist>
</glossdef> </glossdef>
</glossentry> </glossentry>
</glossdiv> </glossdiv>
...@@ -303,25 +217,14 @@ ...@@ -303,25 +217,14 @@
<glossdiv id="gloss-p"> <glossdiv id="gloss-p">
<title>P</title> <title>P</title>
<glossentry id="gloss-ppm">
<glossterm>Perl Package Manager</glossterm>
<acronym>PPM</acronym>
<glossdef>
<para><ulink url="http://aspn.activestate.com/ASPN/Downloads/ActivePerl/PPM/"/>
</para>
</glossdef>
</glossentry>
<glossentry> <glossentry>
<glossterm id="gloss-product">Product</glossterm> <glossterm id="gloss-product">Product</glossterm>
<glossdef> <glossdef>
<para>A Product is a broad category of types of bugs, normally <para>A Product is a broad category of types of bugs. In general,
representing a single piece of software or entity. In general, there are several Components to a Product. A Product may also define a
there are several Components to a Product. A Product may define a
group (used for security) for all bugs entered into group (used for security) for all bugs entered into
its Components.</para> components beneath it.</para>
</glossdef> </glossdef>
</glossentry> </glossentry>
...@@ -359,7 +262,7 @@ ...@@ -359,7 +262,7 @@
bugs over their life cycle, thus the need for the bugs over their life cycle, thus the need for the
<quote>QA Contact</quote> <quote>QA Contact</quote>
field in a bug.</para> field in a Bug.</para>
</glossdef> </glossdef>
</glossentry> </glossentry>
</glossdiv> </glossdiv>
...@@ -367,25 +270,16 @@ ...@@ -367,25 +270,16 @@
<glossdiv id="gloss-r"> <glossdiv id="gloss-r">
<title>R</title> <title>R</title>
<glossentry id="gloss-rdbms"> <glossentry id="gloss-recursion" xreflabel="Recursion">
<glossterm>Relational DataBase Managment System</glossterm> <glossterm>Recursion</glossterm>
<acronym>RDBMS</acronym>
<glossdef>
<para>A relational database management system is a database system
that stores information in tables that are related to each other.
</para>
</glossdef>
</glossentry>
<glossentry id="gloss-regexp">
<glossterm>Regular Expression</glossterm>
<acronym>regexp</acronym>
<glossdef> <glossdef>
<para>A regular expression is an expression used for pattern matching. <para>The property of a function looking back at itself for
<ulink url="http://perldoc.com/perl5.6/pod/perlre.html#Regular-Expressions">Documentation</ulink> something.
</para> <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> </glossdef>
</glossentry> </glossentry>
</glossdiv> </glossdiv>
...@@ -450,51 +344,18 @@ ...@@ -450,51 +344,18 @@
fixed, or an enhancement will be implemented.</para> fixed, or an enhancement will be implemented.</para>
</glossdef> </glossdef>
</glossentry> </glossentry>
<glossentry id="gloss-tcl">
<glossterm>Tool Command Language</glossterm>
<acronym>TCL</acronym>
<glossdef>
<para>TCL is an open source scripting language available for Windows,
Macintosh, and Unix based systems. Bugzilla 1.0 was written in TCL but
never released. The first release of Bugzilla was 2.0, which was when
it was ported to perl.
</para>
</glossdef>
</glossentry>
</glossdiv> </glossdiv>
<glossdiv id="gloss-z"> <glossdiv id="gloss-z">
<title>Z</title> <title>Z</title>
<glossentry id="gloss-zarro"> <glossentry id="zarro-boogs-found" xreflabel="Zarro Boogs Found">
<glossterm>Zarro Boogs Found</glossterm> <glossterm>Zarro Boogs Found</glossterm>
<glossdef> <glossdef>
<para>This is just a goofy way of saying that there were no bugs <para>This is the cryptic response sent by Bugzilla when a query
found matching your query. When asked to explain this message, returned no results. It is just a goofy way of saying "Zero Bugs
Terry had the following to say: Found".</para>
</para>
<blockquote>
<attribution>Terry Weissman</attribution>
<para>I've been asked to explain this ... way back when, when
Netscape released version 4.0 of its browser, we had a release
party. Naturally, there had been a big push to try and fix every
known bug before the release. Naturally, that hadn't actually
happened. (This is not unique to Netscape or to 4.0; the same thing
has happened with every software project I've ever seen.) Anyway,
at the release party, T-shirts were handed out that said something
like "Netscape 4.0: Zarro Boogs". Just like the software, the
T-shirt had no known bugs. Uh-huh.
</para>
<para>So, when you query for a list of bugs, and it gets no results,
you can think of this as a friendly reminder. Of *course* there are
bugs matching your query, they just aren't in the bugsystem yet...
</para>
</blockquote>
</glossdef> </glossdef>
</glossentry> </glossentry>
</glossdiv> </glossdiv>
...@@ -515,7 +376,7 @@ sgml-local-ecat-files:nil ...@@ -515,7 +376,7 @@ sgml-local-ecat-files:nil
sgml-minimize-attributes:nil sgml-minimize-attributes:nil
sgml-namecase-general:t sgml-namecase-general:t
sgml-omittag:t sgml-omittag:t
sgml-parent-document:("Bugzilla-Guide.xml" "book" "chapter") sgml-parent-document:("Bugzilla-Guide.sgml" "book" "chapter")
sgml-shorttag:t sgml-shorttag:t
sgml-tag-region-if-active:t sgml-tag-region-if-active:t
End: End:
......
...@@ -13,7 +13,7 @@ sgml-local-ecat-files:nil ...@@ -13,7 +13,7 @@ sgml-local-ecat-files:nil
sgml-minimize-attributes:nil sgml-minimize-attributes:nil
sgml-namecase-general:t sgml-namecase-general:t
sgml-omittag:t sgml-omittag:t
sgml-parent-document:("Bugzilla-Guide.xml" "book" "chapter") sgml-parent-document:("Bugzilla-Guide.sgml" "book" "chapter")
sgml-shorttag:t sgml-shorttag:t
sgml-tag-region-if-active:t sgml-tag-region-if-active:t
End: End:
......
<!-- <!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 --> <!-- Keep these tools listings in alphabetical order please. -MPB -->
<section id="integration"> <chapter id="integration">
<title>Integrating Bugzilla with Third-Party Tools</title> <title>Integrating Bugzilla with Third-Party Tools</title>
<section id="bonsai" <section id="bonsai"
...@@ -13,31 +13,43 @@ ...@@ -13,31 +13,43 @@
. Using Bonsai, administrators can control open/closed status of trees, . Using Bonsai, administrators can control open/closed status of trees,
query a fast relational database back-end for change, branch, and comment query a fast relational database back-end for change, branch, and comment
information, and view changes made since the last time the tree was information, and view changes made since the last time the tree was
closed. Bonsai closed. These kinds of changes cause the engineer responsible to be
also integrates with <quote>on the hook</quote>
<xref linkend="tinderbox" />.
</para> (include cool URL link here for Hook policies at mozilla.org). Bonsai
also includes gateways to
<xref linkend="tinderbox" />
and Bugzilla</para>
</section> </section>
<section id="cvs" xreflabel="CVS, the Concurrent Versioning System"> <section id="cvs" xreflabel="CVS, the Concurrent Versioning System">
<title>CVS</title> <title>CVS</title>
<para>CVS integration is best accomplished, at this point, using the <para>CVS integration is best accomplished, at this point, using the
Bugzilla Email Gateway.</para> Bugzilla Email Gateway. There have been some files submitted to allow
greater CVS integration, but we need to make certain that Bugzilla is not
tied into one particular software management package.</para>
<para>Follow the instructions in this Guide for enabling Bugzilla e-mail <para>Follow the instructions in the FAQ for enabling Bugzilla e-mail
integration. Ensure that your check-in script sends an email to your integration. Ensure that your check-in script sends an email to your
Bugzilla e-mail gateway with the subject of Bugzilla e-mail gateway with the subject of
<quote>[Bug XXXX]</quote>, <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 , and you can have CVS check-in comments append to your Bugzilla bug. If
the <filename>contrib/bugzilla_email_append.pl</filename> script. you have your check-in script include an @resolution field, you can even
</para> change the Bugzilla bug state.</para>
<para>There is also a CVSZilla project, based upon somewhat dated <para>There is also a project, based upon somewhat dated Bugzilla code,
Bugzilla code, to integrate CVS and Bugzilla through CVS' ability to to integrate CVS and Bugzilla through CVS' ability to email. Check it out
email. Check it out at: <ulink url="http://homepages.kcbbs.gen.nz/~tonyg/"/>. at:
</para> <ulink url="http://homepages.kcbbs.gen.nz/~tonyg/">
http://homepages.kcbbs.gen.nz/~tonyg/</ulink>
, under the
<quote>cvszilla</quote>
link.</para>
</section> </section>
<section id="scm" <section id="scm"
...@@ -47,14 +59,16 @@ ...@@ -47,14 +59,16 @@
<para>You can find the project page for Bugzilla and Teamtrack Perforce <para>You can find the project page for Bugzilla and Teamtrack Perforce
integration (p4dti) at: integration (p4dti) at:
<ulink url="http://www.ravenbrook.com/project/p4dti/"/> <ulink url="http://www.ravenbrook.com/project/p4dti/">
http://www.ravenbrook.com/project/p4dti</ulink>
. .
<quote>p4dti</quote> <quote>p4dti</quote>
is now an officially supported product from Perforce, and you can find is now an officially supported product from Perforce, and you can find
the "Perforce Public Depot" p4dti page at the "Perforce Public Depot" p4dti page at
<ulink url="http://public.perforce.com/public/perforce/p4dti/index.html"/> <ulink url="http://public.perforce.com/public/perforce/p4dti/index.html">
http://public.perforce.com/public/perforce/p4dti/index.html</ulink>
.</para> .</para>
...@@ -70,14 +84,9 @@ ...@@ -70,14 +84,9 @@
xreflabel="Tinderbox, the Mozilla automated build management system"> xreflabel="Tinderbox, the Mozilla automated build management system">
<title>Tinderbox/Tinderbox2</title> <title>Tinderbox/Tinderbox2</title>
<para>Tinderbox is a continuous-build system which can integrate with <para>We need Tinderbox integration information.</para>
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>
</section> </chapter>
<!-- Keep this comment at the end of the file <!-- Keep this comment at the end of the file
Local variables: Local variables:
...@@ -94,7 +103,7 @@ sgml-local-ecat-files:nil ...@@ -94,7 +103,7 @@ sgml-local-ecat-files:nil
sgml-minimize-attributes:nil sgml-minimize-attributes:nil
sgml-namecase-general:t sgml-namecase-general:t
sgml-omittag:t sgml-omittag:t
sgml-parent-document:("Bugzilla-Guide.xml" "book" "chapter") sgml-parent-document:("Bugzilla-Guide.sgml" "book" "chapter")
sgml-shorttag:t sgml-shorttag:t
sgml-tag-region-if-active:t sgml-tag-region-if-active:t
End: End:
......
<!-- <!DOCTYPE appendix PUBLIC "-//OASIS//DTD DocBook V4.1//EN"> --> <!DOCTYPE appendix PUBLIC "-//OASIS//DTD DocBook V4.1//EN">
<appendix id="patches" xreflabel="Useful Patches and Utilities for Bugzilla"> <appendix id="patches" xreflabel="Useful Patches and Utilities for Bugzilla">
<title>Contrib</title> <title>Useful Patches and Utilities for Bugzilla</title>
<para>There are a number of unofficial Bugzilla add-ons in the <para>Are you looking for a way to put your Bugzilla into overdrive? Catch
<filename class="directory">$BUGZILLA_ROOT/contrib/</filename> some of the niftiest tricks here in this section.</para>
directory. This section documents them.</para>
<section id="rewrite" xreflabel="Apache mod_rewrite magic">
<title>Apache
<filename>mod_rewrite</filename>
magic</title>
<para>Apache's
<filename>mod_rewrite</filename>
module lets you do some truly amazing things with URL rewriting. Here are
a couple of examples of what you can do.</para>
<orderedlist>
<listitem>
<para>Make it so if someone types
<computeroutput>http://www.foo.com/12345</computeroutput>
, Bugzilla spits back http://www.foo.com/show_bug.cgi?id=12345. Try
setting up your VirtualHost section for Bugzilla with a rule like
this:</para>
<programlisting>
<![CDATA[
<VirtualHost 12.34.56.78>
RewriteEngine On
RewriteRule ^/([0-9]+)$ http://foo.bar.com/show_bug.cgi?id=$1 [L,R]
</VirtualHost>
]]>
</programlisting>
</listitem>
<listitem>
<para>There are many, many more things you can do with mod_rewrite.
As time goes on, I will include many more in the Guide. For now,
though, please refer to the mod_rewrite documentation at
<ulink url="http://www.apache.org">http://www.apache.org</ulink>
</para>
</listitem>
</orderedlist>
</section>
<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>
<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"> <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 <para>Users can query Bugzilla from the command line using this suite of
command line. They live in the utilities.</para>
<filename class="directory">contrib/cmdline</filename>
directory. However, they <para>The query.conf file contains the mapping from options to field
have not yet been updated to work with 2.16 (post-templatisation.).
There are three files - <filename>query.conf</filename>,
<filename>buglist</filename> and <filename>bugs</filename>.</para>
<para><filename>query.conf</filename>
contains the mapping from options to field
names and comparison types. Quoted option names are "grepped" for, so it 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 should be easy to edit this file. Comments (#) have no effect; you must
make sure these lines do not contain any quoted "option".</para> make sure these lines do not contain any quoted "option"</para>
<para><filename>buglist</filename> <para>buglist is a shell script which submits a Bugzilla query and writes
is a shell script which submits a Bugzilla query and writes
the resulting HTML page to stdout. It supports both short options, (such the resulting HTML page to stdout. It supports both short options, (such
as "-Afoo" or "-Rbar") and long options (such as "--assignedto=foo" or 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 "--reporter=bar"). If the first character of an option is not "-", it is
treated as if it were prefixed with "--default=".</para> treated as if it were prefixed with "--default=".</para>
<para>The column list is taken from the COLUMNLIST environment variable. <para>The columlist is taken from the COLUMNLIST environment variable.
This is equivalent to the "Change Columns" option when you list bugs in This is equivalent to the "Change Columns" option when you list bugs in
buglist.cgi. If you have already used Bugzilla, grep for COLUMNLIST buglist.cgi. If you have already used Bugzilla, use
in your cookies file to see your current COLUMNLIST setting.</para> <command>grep COLUMLIST ~/.netscape/cookies</command>
<para><filename>bugs</filename> is a simple shell script which calls to see your current COLUMNLIST setting.</para>
<filename>buglist</filename> and extracts the
<para>bugs is a simple shell script which calls buglist and extracts the
bug numbers from the output. Adding the prefix bug numbers from the output. Adding the prefix
"http://bugzilla.mozilla.org/buglist.cgi?bug_id=" turns the bug list into "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 a working link if any bugs are found. Counting bugs is easy. Pipe the
...@@ -44,13 +187,100 @@ ...@@ -44,13 +187,100 @@
<command>sed -e 's/,/ /g' | wc | awk '{printf $2 "\n"}'</command> <command>sed -e 's/,/ /g' | wc | awk '{printf $2 "\n"}'</command>
</para> </para>
<para>Akkana Peck says she has good results piping <para>Akkana says she has good results piping buglist output through
<filename>buglist</filename> output through
<command>w3m -T text/html -dump</command> <command>w3m -T text/html -dump</command>
</para> </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>
<section id="quicksearch">
<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"</para>
<para>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.</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>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> </appendix>
<!-- Keep this comment at the end of the file <!-- Keep this comment at the end of the file
...@@ -68,7 +298,7 @@ sgml-local-ecat-files:nil ...@@ -68,7 +298,7 @@ sgml-local-ecat-files:nil
sgml-minimize-attributes:nil sgml-minimize-attributes:nil
sgml-namecase-general:t sgml-namecase-general:t
sgml-omittag:t sgml-omittag:t
sgml-parent-document:("Bugzilla-Guide.xml" "book" "chapter") sgml-parent-document:("Bugzilla-Guide.sgml" "book" "chapter")
sgml-shorttag:t sgml-shorttag:t
sgml-tag-region-if-active:t sgml-tag-region-if-active:t
End: End:
......
...@@ -6,52 +6,59 @@ ...@@ -6,52 +6,59 @@
stay current for a while.</para> stay current for a while.</para>
<para>Apache Web Server: <para>Apache Web Server:
<ulink url="http://www.apache.org/"/> <ulink url="http://www.apache.org/">http://www.apache.org</ulink>
Optional web server for Bugzilla, but recommended because of broad user Optional web server for Bugzilla, but recommended because of broad user
base and support.</para> base and support.</para>
<para>Bugzilla: <para>Bugzilla:
<ulink url="http://www.bugzilla.org/"/> <ulink url="http://www.bugzilla.org/">
http://www.bugzilla.org/</ulink>
</para> </para>
<para>MySQL: <para>MySQL:
<ulink url="http://www.mysql.com/"/> <ulink url="http://www.mysql.com/">http://www.mysql.com/</ulink>
</para> </para>
<para>Perl: <para>Perl:
<ulink url="http://www.perl.org/"/> <ulink url="http://www.perl.org">http://www.perl.org/</ulink>
</para> </para>
<para>CPAN: <para>CPAN:
<ulink url="http://www.cpan.org/"/> <ulink url="http://www.cpan.org/">http://www.cpan.org/</ulink>
</para> </para>
<para>DBI Perl module: <para>DBI Perl module:
<ulink url="http://www.cpan.org/modules/by-module/DBI/"/> <ulink url="http://www.cpan.org/modules/by-module/DBI/">
http://www.cpan.org/modules/by-module/DBI/</ulink>
</para> </para>
<para>Data::Dumper module: <para>Data::Dumper module:
<ulink url="http://www.cpan.org/modules/by-module/Data/"/> <ulink url="http://www.cpan.org/modules/by-module/Data/">
http://www.cpan.org/modules/by-module/Data/</ulink>
</para> </para>
<para>MySQL related Perl modules: <para>MySQL related Perl modules:
<ulink url="http://www.cpan.org/modules/by-module/Mysql/"/> <ulink url="http://www.cpan.org/modules/by-module/Mysql/">
http://www.cpan.org/modules/by-module/Mysql/</ulink>
</para> </para>
<para>TimeDate Perl module collection: <para>TimeDate Perl module collection:
<ulink url="http://www.cpan.org/modules/by-module/Date/"/> <ulink url="http://www.cpan.org/modules/by-module/Date/">
http://www.cpan.org/modules/by-module/Date/</ulink>
</para> </para>
<para>GD Perl module: <para>GD Perl module:
<ulink url="http://www.cpan.org/modules/by-module/GD/"/> <ulink url="http://www.cpan.org/modules/by-module/GD/">
http://www.cpan.org/modules/by-module/GD/</ulink>
Alternately, you should be able to find the latest version of GD at Alternately, you should be able to find the latest version of GD at
<ulink url="http://www.boutell.com/gd/"/> <ulink url="http://www.boutell.com/gd/">http://www.boutell.com/gd/</ulink>
</para> </para>
<para>Chart::Base module: <para>Chart::Base module:
<ulink url="http://www.cpan.org/modules/by-module/Chart/"/> <ulink url="http://www.cpan.org/modules/by-module/Chart/">
http://www.cpan.org/modules/by-module/Chart/</ulink>
</para> </para>
<para>(But remember, Bundle::Bugzilla will install all the modules for you.) <para>(But remember, Bundle::Bugzilla will install all the modules for you.)
...@@ -73,7 +80,7 @@ sgml-local-ecat-files:nil ...@@ -73,7 +80,7 @@ sgml-local-ecat-files:nil
sgml-minimize-attributes:nil sgml-minimize-attributes:nil
sgml-namecase-general:t sgml-namecase-general:t
sgml-omittag:t sgml-omittag:t
sgml-parent-document:("Bugzilla-Guide.xml" "book" "chapter") sgml-parent-document:("Bugzilla-Guide.sgml" "book" "chapter")
sgml-shorttag:t sgml-shorttag:t
sgml-tag-region-if-active:t sgml-tag-region-if-active:t
End: End:
......
<!-- <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook V4.1//EN"> --> <!-- <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook V4.1//EN"> -->
<!-- TOC <!-- TOC
Chapter: Using Bugzilla Chapter: Using Bugzilla
Create an account Create an account
...@@ -26,668 +25,611 @@ Chapter: Using Bugzilla ...@@ -26,668 +25,611 @@ Chapter: Using Bugzilla
Miscellaneous usage hints Miscellaneous usage hints
--> -->
<chapter id="using"> <chapter id="using">
<title>Using Bugzilla</title> <title>Using Bugzilla</title>
<epigraph>
<para>
What, Why, How, &amp; Where?
</para>
</epigraph>
<section id="whatis"> <section id="whatis">
<title>What is Bugzilla?</title> <title>What is Bugzilla?</title>
<para>
Bugzilla is one example of a class of programs called "Defect <para>Bugzilla is one example of a class of programs called "Defect
Tracking Systems", or, more commonly, "Bug-Tracking Systems". Defect Tracking Systems", or, more commonly, "Bug-Tracking Systems". Defect
Tracking Systems allow individual or groups of developers to keep Tracking Systems allow individual or groups of developers to keep track
track of outstanding bugs in their product effectively. Bugzilla was of outstanding bugs in their product effectively. Bugzilla was originally
originally written by Terry Weissman in a programming language called written by Terry Weissman in a programming language called "TCL", to
"TCL", to replace a crappy bug-tracking database used internally by replace a crappy bug-tracking database used internally by Netscape
Netscape Communications. Terry later ported Bugzilla to Perl from Communications. Terry later ported Bugzilla to Perl from TCL, and in Perl
TCL, and in Perl it remains to this day. Most commercial it remains to this day. Most commercial defect-tracking software vendors
defect-tracking software vendors at the time charged enormous at the time charged enormous licensing fees, and Bugzilla quickly became
licensing fees, and Bugzilla quickly became a favorite of the a favorite of the open-source crowd (with its genesis in the open-source
open-source crowd (with its genesis in the open-source browser browser project, Mozilla). It is now the de-facto standard
project, Mozilla). It is now the de-facto standard defect-tracking defect-tracking system against which all others are measured.</para>
system against which all others are measured.
</para> <para>Bugzilla has matured immensely, and now boasts many advanced
<para> features. These include:
Bugzilla has matured immensely, and now boasts many advanced features. These include: <itemizedlist>
<itemizedlist> <listitem>
<para>Powerful searching</para>
<listitem><para>Powerful searching</para></listitem> </listitem>
<listitem><para>User-configurable email notifications of bug changes</para></listitem>
<listitem><para>Full change history</para></listitem> <listitem>
<listitem><para>Inter-bug dependency tracking and graphing</para></listitem> <para>User-configurable email notifications of bug changes</para>
<listitem><para>Excellent attachment management</para></listitem> </listitem>
<listitem><para>Integrated, product-based, granular security schema</para></listitem>
<listitem><para>Fully security-audited, and runs under Perl's taint mode</para></listitem> <listitem>
<listitem><para>A robust, stable RDBMS back-end</para></listitem> <para>Full change history</para>
<listitem><para>Web, XML, email and console interfaces</para></listitem> </listitem>
<listitem><para>Completely customisable and/or localisable web user interface</para></listitem>
<listitem><para>Extensive configurability</para></listitem> <listitem>
<listitem><para>Smooth upgrade pathway between versions</para></listitem> <para>Inter-bug dependency tracking and graphing</para>
</listitem>
</itemizedlist>
<listitem>
<para>Excellent attachment management</para>
</listitem>
<listitem>
<para>Integrated, product-based, granular security schema</para>
</listitem>
<listitem>
<para>Fully security-audited, and runs under Perl's taint mode</para>
</listitem>
<listitem>
<para>A robust, stable RDBMS back-end</para>
</listitem>
<listitem>
<para>Web, XML, email and console interfaces</para>
</listitem>
<listitem>
<para>Completely customisable and/or localisable web user
interface</para>
</listitem>
<listitem>
<para>Extensive configurability</para>
</listitem>
<listitem>
<para>Smooth upgrade pathway between versions</para>
</listitem>
</itemizedlist>
</para> </para>
</section> </section>
<section id="why"> <section id="why">
<title>Why Should We Use Bugzilla?</title> <title>Why Should We Use Bugzilla?</title>
<epigraph>
<para> <para>For many years, defect-tracking software has remained principally
No, Who's on first... the domain of large software development houses. Even then, most shops
</para> never bothered with bug-tracking software, and instead simply relied on
</epigraph> shared lists and email to monitor the status of defects. This procedure
<para> is error-prone and tends to cause those bugs judged least significant by
For many years, defect-tracking software has remained developers to be dropped or ignored.</para>
principally the domain of large software development houses.
Even then, most shops never bothered with bug-tracking software, <para>These days, many companies are finding that integrated
and instead simply relied on shared lists and email to monitor defect-tracking systems reduce downtime, increase productivity, and raise
the status of defects. This procedure is error-prone and tends customer satisfaction with their systems. Along with full disclosure, an
to cause those bugs judged least significant by developers to be open bug-tracker allows manufacturers to keep in touch with their clients
dropped or ignored. and resellers, to communicate about problems effectively throughout the
</para> data management chain. Many corporations have also discovered that
<para> defect-tracking helps reduce costs by providing IT support
These days, many companies are finding that integrated accountability, telephone support knowledge bases, and a common,
defect-tracking systems reduce downtime, increase productivity, well-understood system for accounting for unusual system or software
and raise customer satisfaction with their systems. Along with issues.</para>
full disclosure, an open bug-tracker allows manufacturers to
keep in touch with their clients and resellers, to communicate <para>But why should
about problems effectively throughout the data management chain. <emphasis>you</emphasis>
Many corporations have also discovered that defect-tracking
helps reduce costs by providing IT support accountability, use Bugzilla?</para>
telephone support knowledge bases, and a common, well-understood
system for accounting for unusual system or software issues. <para>Bugzilla is very adaptable to various situations. Known uses
</para> currently include IT support queues, Systems Administration deployment
<para> management, chip design and development problem tracking (both
But why should <emphasis>you</emphasis> use Bugzilla? pre-and-post fabrication), and software and hardware bug tracking for
</para> luminaries such as Redhat, Loki software, Linux-Mandrake, and VA Systems.
<para> Combined with systems such as CVS, Bonsai, or Perforce SCM, Bugzilla
Bugzilla is very adaptable to various situations. Known uses provides a powerful, easy-to-use solution to configuration management and
currently include IT support queues, Systems Administration replication problems</para>
deployment management, chip design and development problem
tracking (both pre-and-post fabrication), and software and <para>Bugzilla can dramatically increase the productivity and
hardware bug tracking for luminaries such as Redhat, Loki accountability of individual employees by providing a documented workflow
software, Linux-Mandrake, and VA Systems. Combined with systems and positive feedback for good performance. How many times do you wake up
such as CVS, Bonsai, or Perforce SCM, Bugzilla provides a in the morning, remembering that you were supposed to do
powerful, easy-to-use solution to configuration management and <emphasis>something</emphasis>
replication problems
</para> today, but you just can't quite remember? Put it in Bugzilla, and you
<para> have a record of it from which you can extrapolate milestones, predict
Bugzilla can dramatically increase the productivity and product versions for integration, and by using Bugzilla's e-mail
accountability of individual employees by providing a documented integration features be able to follow the discussion trail that led to
workflow and positive feedback for good performance. How many critical decisions.</para>
times do you wake up in the morning, remembering that you were
supposed to do <emphasis>something</emphasis> today, but you <para>Ultimately, Bugzilla puts the power in your hands to improve your
just can't quite remember? Put it in Bugzilla, and you have a value to your employer or business while providing a usable framework for
record of it from which you can extrapolate milestones, predict your natural attention to detail and knowledge store to flourish.</para>
product versions for integration, and by using Bugzilla's e-mail
integration features be able to follow the discussion trail that
led to critical decisions.
</para>
<para>
Ultimately, Bugzilla puts the power in your hands to improve
your value to your employer or business while providing a usable
framework for your natural attention to detail and knowledge
store to flourish.
</para>
</section> </section>
<section id="how"> <section id="how">
<title>How do I use Bugzilla?</title> <title>How do I use Bugzilla?</title>
<epigraph>
<para> <para>This section contains information for end-users of Bugzilla. If you
Hey! I'm Woody! Howdy, Howdy, Howdy! are administering a Bugzilla installation, please consult the Installing
</para> and Administering Bugzilla portions of this Guide.</para>
</epigraph>
<para>There is a Bugzilla test installation, called
<para> <ulink url="http://landfill.tequilarista.org/">Landfill</ulink>
This section contains information for end-users of Bugzilla.
If you are administering a Bugzilla installation, please consult the , which you are welcome to play with. However, it does not necessarily
Installing and Administering Bugzilla portions of this Guide. have all Bugzilla features enabled, and often runs cutting-edge versions
</para> of Bugzilla for testing, so some things may work slightly differently
<para> than mentioned here.</para>
There is a Bugzilla test installation, called
<ulink url="http://landfill.tequilarista.org/">
Landfill</ulink>, which you are welcome to play with.
However, it does not necessarily have all Bugzilla features
enabled, and often runs cutting-edge versions of Bugzilla for
testing, so some things may work slightly differently than
mentioned here.
</para>
<section id="myaccount"> <section id="myaccount">
<title>Create a Bugzilla Account</title> <title>Create a Bugzilla Account</title>
<para>
If you want to use Bugzilla, first you <para>If you want to use Bugzilla, first you need to create an account.
need to create an account. Consult with the administrator Consult with the administrator responsible for your installation of
responsible for your installation of Bugzilla for the URL you Bugzilla for the URL you should use to access it. If you're
should use to access it. If you're test-driving Bugzilla, test-driving Bugzilla, use this URL:
use this URL: <ulink <ulink url="http://landfill.tequilarista.org/bugzilla-tip/">
url="http://landfill.tequilarista.org/bugzilla-tip/"> http://landfill.tequilarista.org/bugzilla-tip/</ulink> http://landfill.tequilarista.org/bugzilla-tip/</ulink>
</para> </para>
<orderedlist> <orderedlist>
<listitem> <listitem>
<para> <para>Click the
Click the <quote>Open a new Bugzilla account</quote> link, enter your <quote>Open a new Bugzilla account</quote>
email address and, optionally, your name in the spaces provided,
then click <quote>Create Account</quote>. link, enter your email address and, optionally, your name in the
</para> spaces provided, then click
</listitem> <quote>Create Account</quote>
<listitem>
<para> .</para>
Within moments, you should receive an email to the address </listitem>
you provided above, which contains your login name
(generally the same as the email address), and a password <listitem>
you can use to access your account. This password is <para>Within moments, you should receive an email to the address
randomly generated, and can be changed to something more memorable. you provided above, which contains your login name (generally the
</para> same as the email address), and a password you can use to access
</listitem> your account. This password is randomly generated, and can be
<listitem> changed to something more memorable.</para>
<para> </listitem>
Click the <quote>Log In</quote> link in the yellow area at
the bottom of the page in your browser, enter your <listitem>
email address and password into the spaces provided, and click <para>Click the
<quote>Login</quote>. <quote>Log In</quote>
</para>
</listitem> link in the yellow area at the bottom of the page in your browser,
enter your email address and password into the spaces provided, and
click
<quote>Login</quote>
.</para>
</listitem>
</orderedlist> </orderedlist>
<para>
You are now logged in. Bugzilla uses cookies for authentication, so <para>You are now logged in. Bugzilla uses cookies for authentication,
(unless your IP address changes) you should not have to log in again. so (unless your IP address changes) you should not have to log in
</para> again.</para>
</section> </section>
<section id="bug_page"> <section id="bug_page">
<title>Anatomy of a Bug</title> <title>Anatomy of a Bug</title>
<para>
The core of Bugzilla is the screen which displays a particular bug. <para>The core of Bugzilla is the screen which displays a particular
It's a good place to explain some Bugzilla concepts. bug. It's a good place to explain some Bugzilla concepts.
<ulink url="http://landfill.tequilarista.org/bugzilla-tip/show_bug.cgi?id=1">Bug 1 on Landfill</ulink> is a good example. Note that the names of most fields <ulink
are hyperlinks; clicking them will take you to context-sensitive url="http://landfill.tequilarista.org/bugzilla-tip/show_bug.cgi?id=1">
help on that particular field. Bug 1 on Landfill</ulink>
</para>
is a good example. Note that the names of most fields are hyperlinks;
<orderedlist> clicking them will take you to context-sensitive help on that
<listitem> particular field.</para>
<para>
<emphasis>Product and Component</emphasis>: <orderedlist>
Bugs are divided up by Product and Component, with a Product having one <listitem>
or more Components in it. For example, bugzilla.mozilla.org's <para>
"Bugzilla" Product is composed of several Components: <emphasis>Product and Component</emphasis>
<simplelist>
<member><emphasis>Administration</emphasis>, : Bugs are divided up by Product and Component, with a Product
Administration of a bugzilla installation, including having one or more Components in it. For example,
<filename>editcomponents.cgi</filename>, bugzilla.mozilla.org's "Bugzilla" Product is composed of several
<filename>editgroups.cgi</filename>, Components:
<filename>editkeywords.cgi</filename>, <simplelist>
<filename>editparams.cgi</filename>, <member>
<filename>editproducts.cgi</filename>, <emphasis>Administration:</emphasis>
<filename>editusers.cgi</filename>,
<filename>editversions.cgi,</filename> and Administration of a Bugzilla installation.</member>
<filename>sanitycheck.cgi</filename>.
</member> <member>
<member><emphasis>Bugzilla-General</emphasis>, <emphasis>Bugzilla-General:</emphasis>
Anything that doesn't fit in the other components, or spans Anything that doesn't fit in the other components, or spans
multiple components. multiple components.</member>
</member>
<member><emphasis>Creating/Changing Bugs</emphasis>, <member>
Creating, changing, and viewing bugs. <emphasis>Creating/Changing Bugs:</emphasis>
<filename>enter_bug.cgi</filename>,
<filename>post_bug.cgi</filename>, Creating, changing, and viewing bugs.</member>
<filename>show_bug.cgi</filename> and
<filename>process_bug.cgi</filename>. <member>
</member> <emphasis>Documentation:</emphasis>
<member><emphasis>Documentation</emphasis>,
The bugzilla documentation, including anything in the The Bugzilla documentation, including The Bugzilla Guide.</member>
<filename>docs/</filename> directory and The Bugzilla Guide
<member>
</member> <emphasis>Email:</emphasis>
<member><emphasis>Email</emphasis>,
Anything to do with email sent by Bugzilla. Anything to do with email sent by Bugzilla.</member>
<filename>processmail</filename>
</member> <member>
<member><emphasis>Installation</emphasis>, <emphasis>Installation:</emphasis>
The installation process of Bugzilla. This includes
<filename>checksetup.pl</filename> and whatever else it evolves into. The installation process of Bugzilla.</member>
</member>
<member><emphasis>Query/Buglist</emphasis>, <member>
Anything to do with searching for bugs and viewing the buglists. <emphasis>Query/Buglist:</emphasis>
<filename>query.cgi</filename> and
<filename>buglist.cgi</filename> Anything to do with searching for bugs and viewing the
</member> buglists.</member>
<member><emphasis>Reporting/Charting</emphasis>,
Getting reports from Bugzilla. <member>
<filename>reports.cgi</filename> and <emphasis>Reporting/Charting:</emphasis>
<filename>duplicates.cgi</filename>
</member> Getting reports from Bugzilla.</member>
<member><emphasis>User Accounts</emphasis>,
<member>
<emphasis>User Accounts:</emphasis>
Anything about managing a user account from the user's perspective. Anything about managing a user account from the user's perspective.
<filename>userprefs.cgi</filename>, saved queries, creating accounts, Saved queries, creating accounts, changing passwords, logging in,
changing passwords, logging in, etc. etc.</member>
</member>
<member><emphasis>User Interface</emphasis>, <member>
<emphasis>User Interface:</emphasis>
General issues having to do with the user interface cosmetics (not General issues having to do with the user interface cosmetics (not
functionality) including cosmetic issues, HTML templates, etc. functionality) including cosmetic issues, HTML templates,
</member> etc.</member>
</simplelist> </simplelist>
</para> </para>
</listitem> </listitem>
<listitem> <listitem>
<para> <para>
<emphasis>Status and Resolution</emphasis>: <emphasis>Status and Resolution:</emphasis>
A bug passes through several Statuses in its lifetime, and ends up in the
RESOLVED status, with one of a set of Resolutions (e.g. FIXED, INVALID.) A bug passes through several Statuses in its lifetime, and ends up
The different possible in the RESOLVED status, with one of a set of Resolutions (e.g.
values for Status and Resolution on your installation will be documented FIXED, INVALID.) The different possible values for Status and
in the context-sensitive help for those items. Resolution on your installation will be documented in the
</para> context-sensitive help for those items.</para>
</listitem> </listitem>
<listitem> <listitem>
<para> <para>
<emphasis>Assigned To</emphasis>: <emphasis>Assigned To:</emphasis>
The person responsible for fixing the bug.
</para> The person responsible for fixing the bug.</para>
</listitem> </listitem>
<listitem> <listitem>
<para> <para>
<emphasis>URL</emphasis>: <emphasis>URL:</emphasis>
A URL associated with the bug, if any.
</para> A URL associated with the bug, if any.</para>
</listitem> </listitem>
<listitem> <listitem>
<para> <para>
<emphasis>Summary</emphasis>: <emphasis>Summary:</emphasis>
A one-sentence summary of the problem.
</para> A one-sentence summary of the problem.</para>
</listitem> </listitem>
<listitem> <listitem>
<para> <para>
<emphasis>Status Whiteboard</emphasis>: (a.k.a. Whiteboard) A <emphasis>Status Whiteboard:</emphasis>
free-form text area for adding short notes and tags to a bug.
</para> (a.k.a. Whiteboard) A free-form text area for adding short notes
</listitem> and tags to a bug.</para>
</listitem>
<listitem>
<para> <listitem>
<emphasis>Keywords</emphasis>: <para>
The administrator can define keywords which you can use to tag and <emphasis>Keywords:</emphasis>
categorise bugs - e.g. The Mozilla Project has keywords like crash
and regression. The administrator can define keywords which you can use to tag and
</para> categorise bugs - e.g. The Mozilla Project has keywords like crash
</listitem> and regression.</para>
</listitem>
<listitem>
<para> <listitem>
<emphasis>Platform and OS</emphasis>: <para>
These indicate the computing environment where the bug was found. <emphasis>Platform and OS:</emphasis>
</para>
</listitem> These indicate the computing environment where the bug was
found.</para>
<listitem> </listitem>
<para>
<emphasis>Version</emphasis>: <listitem>
The "Version" field is usually used for versions of a product which have <para>
been released, and is set to indicate which versions of a Component <emphasis>Version:</emphasis>
have the particular problem the bug report is about.
</para> The "Version" field is usually used for versions of a product which
</listitem> have been released, and is set to indicate which versions of a
Component have the particular problem the bug report is
<listitem> about.</para>
<para> </listitem>
<emphasis>Priority</emphasis>:
The bug assignee uses this field to prioritise his or her bugs. It's <listitem>
a good idea not to change this on other people's bugs. <para>
</para> <emphasis>Priority:</emphasis>
</listitem>
The bug assignee uses this field to prioritise his or her bugs.
<listitem> It's a good idea not to change this on other people's bugs.</para>
<para> </listitem>
<emphasis>Severity</emphasis>:
This indicates how severe the problem is - from blocker ("application <listitem>
unusable") to trivial ("minor cosmetic issue"). You can also use this <para>
field to indicate whether a bug is an enhancement request. <emphasis>Severity:</emphasis>
</para>
</listitem> This indicates how severe the problem is - from blocker
("application unusable") to trivial ("minor cosmetic issue"). You
<listitem> can also use this field to indicate whether a bug is an enhancement
<para> request.</para>
<emphasis>Target</emphasis>: </listitem>
(a.k.a. Target Milestone) A future version by which the bug is to be
fixed. e.g. The Bugzilla Project's milestones for future <listitem>
Bugzilla versions are 2.18, 2.20, 3.0, etc. Milestones are <para>
not restricted to numbers, thought - you can use any text strings, <emphasis>Target:</emphasis>
such as dates.
</para> (a.k.a. Target Milestone) A future version by which the bug is to
</listitem> be fixed. e.g. The Bugzilla Project's milestones for future
Bugzilla versions are 2.18, 2.20, 3.0, etc. Milestones are not
<listitem> restricted to numbers, thought - you can use any text strings, such
<para> as dates.</para>
<emphasis>Reporter</emphasis>: </listitem>
The person who filed the bug.
</para> <listitem>
</listitem> <para>
<emphasis>Reporter:</emphasis>
<listitem>
<para> The person who filed the bug.</para>
<emphasis>CC list</emphasis>: </listitem>
A list of people who get mail when the bug changes.
</para> <listitem>
</listitem> <para>
<emphasis>CC list:</emphasis>
<listitem>
<para> A list of people who get mail when the bug changes.</para>
<emphasis>Attachments</emphasis>: </listitem>
You can attach files (e.g. testcases or patches) to bugs. If there are
any attachments, they are listed in this section. <listitem>
</para> <para>
</listitem> <emphasis>Attachments:</emphasis>
<listitem> You can attach files (e.g. testcases or patches) to bugs. If there
<para> are any attachments, they are listed in this section.</para>
<emphasis>Dependencies</emphasis>: </listitem>
If this bug cannot be fixed unless other bugs are fixed (depends on), or
this bug stops other bugs being fixed (blocks), their numbers are <listitem>
recorded here. <para>
</para> <emphasis>Dependencies:</emphasis>
</listitem>
If this bug cannot be fixed unless other bugs are fixed (depends
<listitem> on), or this bug stops other bugs being fixed (blocks), their
<para> numbers are recorded here.</para>
<emphasis>Votes</emphasis>: </listitem>
Whether this bug has any votes.
</para> <listitem>
</listitem> <para>
<emphasis>Votes:</emphasis>
<listitem>
<para> Whether this bug has any votes.</para>
<emphasis>Additional Comments</emphasis>: </listitem>
You can add your two cents to the bug discussion here, if you have
something worthwhile to say. <listitem>
</para> <para>
</listitem> <emphasis>Additional Comments:</emphasis>
</orderedlist> You can add your two cents to the bug discussion here, if you have
something worthwhile to say.</para>
</listitem>
</orderedlist>
</section> </section>
<section id="query"> <section id="query">
<title>Searching for Bugs</title> <title>Searching for Bugs</title>
<para>
The Bugzilla Search page is is the interface where you can <para>The Bugzilla Search page is is the interface where you can find
find any bug report, comment, or patch currently in the any bug report, comment, or patch currently in the Bugzilla system. You
Bugzilla system. You can play with it here: can play with it here:
<ulink url="http://landfill.tequilarista.org/bugzilla-tip/query.cgi"> <ulink url="http://landfill.tequilarista.org/bugzilla-tip/query.cgi">
landfill.tequilarista.org/bugzilla-tip/query.cgi</ulink>. landfill.tequilarista.org/bugzilla-tip/query.cgi</ulink>
</para>
.</para>
<para>
The Search page has controls for selecting different possible values <para>The Search page has controls for selecting different possible
for all of the fields in a bug, as described above. Once you've defined values for all of the fields in a bug, as described above. Once you've
a search, you can either run it, or save it as a Remembered Query, which defined a search, you can either run it, or save it as a Remembered
can optionally appear in the footer of your pages. Query, which can optionally appear in the footer of your pages.</para>
</para>
<para>Highly advanced querying is done using Boolean Charts, which have
<para> their own
Highly advanced querying is done using Boolean Charts, which have their <ulink
own <ulink url="http://landfill.tequilarista.org/bugzilla-tip/booleanchart.html">context-sensitive help</ulink>. url="http://landfill.tequilarista.org/bugzilla-tip/booleanchart.html">
</para> context-sensitive help</ulink>
.</para>
</section> </section>
<section id="list"> <section id="list">
<title>Bug Lists</title> <title>Bug Lists</title>
<para>
If you run a search, a list of matching bugs will be returned. <para>If you run a search, a list of matching bugs will be returned.
The default search is to return all open bugs on the system - The default search is to return all open bugs on the system - don't try
don't try running this search on a Bugzilla installation with running this search on a Bugzilla installation with a lot of
a lot of bugs! bugs!</para>
</para>
<para> <para>The format of the list is configurable. For example, it can be
The format of the list is configurable. For example, it can be sorted by clicking the column headings. Other useful features can be
sorted by clicking the column headings. Other useful features accessed using the links at the bottom of the list:
can be accessed using the links at the bottom of the list: <simplelist>
<simplelist> <member>
<member><emphasis>Long Format</emphasis>: this gives you a large page <emphasis>Long Format:</emphasis>
with a non-editable summary of the fields of each bug.</member>
<member><emphasis>Change Columns</emphasis>: change the bug this gives you a large page with a non-editable summary of the fields
attributes which appear in the list.</member> of each bug.</member>
<member><emphasis>Change several bugs at once</emphasis>: If
your account is sufficiently empowered, you can make the same <member>
change to all the bugs in the list - for example, changing their <emphasis>Change Columns:</emphasis>
owner.</member>
<member><emphasis>Send mail to bug owners</emphasis>: Sends mail change the bug attributes which appear in the list.</member>
to the owners of all bugs on the list.</member>
<member><emphasis>Edit this query</emphasis>: If you didn't <member>
get exactly the results you were looking for, you can <emphasis>Change several bugs at once:</emphasis>
return to the Query page through this link and make small
revisions to the query you just made so you get more If your account is sufficiently empowered, you can make the same
accurate results.</member> change to all the bugs in the list - for example, changing their
</simplelist> owner.</member>
<member>
<emphasis>Send mail to bug owners:</emphasis>
Sends mail to the owners of all bugs on the list.</member>
<member>
<emphasis>Edit this query:</emphasis>
If you didn't get exactly the results you were looking for, you can
return to the Query page through this link and make small revisions
to the query you just made so you get more accurate results.</member>
</simplelist>
</para> </para>
</section> </section>
<section id="bugreports"> <section id="bugreports">
<title>Filing Bugs</title> <title>Filing Bugs</title>
<epigraph>
<para>And all this time, I thought we were taking bugs <emphasis>out</emphasis>...</para>
</epigraph>
<para>
Years of bug writing experience has been distilled for your reading
pleasure into the <ulink url="http://landfill.tequilarista.org/bugzilla-tip/bugwritinghelp.html">
Bug Writing Guidelines</ulink>.
While some of the advice is Mozilla-specific, the basic principles of reporting Reproducible, Specific bugs, isolating the Product you are using, the Version of the Product, the Component which failed, the Hardware Platform, and Operating System you were using at the time of the failure go a long way toward ensuring accurate, responsible fixes for the bug that bit you.
</para>
<para>
The procedure for filing a test bug is as follows:
</para>
<orderedlist>
<listitem>
<para>
Go to <ulink
url="http://landfill.tequilarista.org/bugzilla-tip/">Landfill</ulink>
in your browser and click
<ulink
url="http://landfill.tequilarista.org/bugzilla-tip/enter_bug.cgi"> Enter a new bug report</ulink>.
</para>
</listitem>
<listitem>
<para>
Select a product - any one will do.
</para>
</listitem>
<listitem>
<para>
Fill in the fields.
Bugzilla should have made reasonable guesses, based upon
your browser, for the "Platform" and "OS" drop-down
boxes. If they are wrong, change them.
</para>
</listitem>
<listitem>
<para>
Select "Commit" and send in your bug report.
</para>
</listitem>
</orderedlist>
</section>
<para>Years of bug writing experience has been distilled for your
reading pleasure into the
<ulink
url="http://landfill.tequilarista.org/bugzilla-tip/bugwritinghelp.html">
Bug Writing Guidelines</ulink>
. While some of the advice is Mozilla-specific, the basic principles of
reporting Reproducible, Specific bugs, isolating the Product you are
using, the Version of the Product, the Component which failed, the
Hardware Platform, and Operating System you were using at the time of
the failure go a long way toward ensuring accurate, responsible fixes
for the bug that bit you.</para>
<para>The procedure for filing a test bug is as follows:</para>
<orderedlist>
<listitem>
<para>Go to
<ulink url="http://landfill.tequilarista.org/bugzilla-tip/">
Landfill</ulink>
in your browser and click
<ulink
url="http://landfill.tequilarista.org/bugzilla-tip/enter_bug.cgi">
Enter a new bug report</ulink>
.</para>
</listitem>
<listitem>
<para>Select a product - any one will do.</para>
</listitem>
<listitem>
<para>Fill in the fields. Bugzilla should have made reasonable
guesses, based upon your browser, for the "Platform" and "OS"
drop-down boxes. If they are wrong, change them.</para>
</listitem>
<listitem>
<para>Select "Commit" and send in your bug report.</para>
</listitem>
</orderedlist>
</section>
</section> </section>
<section id="init4me"> <section id="init4me">
<title>Where can I find my user preferences?</title> <title>User Preferences</title>
<epigraph>
<para> <para>You can customise various aspects of Bugzilla, via the "Edit prefs"
Indiana, it feels like we walking on fortune cookies! link in the page footer, once you have logged in, e.g. to
</para> <ulink
<para> url="http://landfill.tequilarista.org/bugzilla-tip/query.cgi?GoAheadAndLogIn=1">
These ain't fortune cookies, kid... Landfill</ulink>
</para>
</epigraph> . The preferences are split into four tabs.</para>
<para>
Customized User Preferences offer tremendous versatility to your
individual Bugzilla experience. 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/bugzilla-tip/query.cgi?GoAheadAndLogIn=1"> Landfill</ulink>.
</para>
<section id="accountsettings" xreflabel="Account Settings"> <section id="accountsettings" xreflabel="Account Settings">
<title>Account Settings</title> <title>Account Settings</title>
<para>
On this page, you can change your basic Account Settings, <para>On this tab, you can change your basic Account Settings,
including your password and full name. For security reasons, including your password, email address and real name. For security
in order to change anything on this page you must type your reasons, in order to change anything on this page you must type your
<emphasis>current</emphasis> password into the <quote>Old <emphasis>current</emphasis>
Password</quote> field. If you wish to change your
password, type the new password you want into the <quote>New password into the
Password</quote> field and again into the <quote>Re-enter <quote>Password</quote>
new password</quote> field to ensure you typed your new
password correctly. Select the <quote>Submit</quote> button field. If you attempt to change your email address, a confirmation
and you are done. email is sent to both the old and new addresses, with a link to use to
</para> confirm the change. This helps to prevent account hijacking.</para>
</section> </section>
<section id="emailsettings" >
<section id="emailsettings">
<title>Email Settings</title> <title>Email Settings</title>
<section id="notification" xreflabel="">
<title>Email Notification</title> <para>On this tab you can reduce or increase the amount of email sent
<para> you from Bugzilla, opting in our out depending on your relationship to
Here you can reduce or increase the amount of email sent you the bug and the change that was made to it. (Note that you can also do
from Bugzilla. Although this is referred to as client-side filtering using the X-Bugzilla-Reason header which Bugzilla
<quote>Advanced Email Filtering Options</quote>, they are, adds to all bugmail.)</para>
in fact, the standard email filter set. All of them are
self-explanatory, but you can use the filters in interesting <para>By entering user email names, delineated by commas, into the
ways. For instance, some people (notably Quality Assurance "Users to watch" text entry box you can receive a copy of all the
personnel) often only care to receive updates regarding a bugmail of other users (security settings permitting.) This powerful
bug when the bug changes state, so they can track bugs on functionality enables seamless transitions as developers change
their flow charts and know when it is time to pull the bug projects, managers wish to get in touch with the issues faced by their
onto a quality assurance platform for inspection. Other direct reports, or users go on vacation.</para>
people set up email gateways to
<xref linkend="bonsai" /> or <xref linkend="tinderbox" />, and <note>
restrict which types of Bugzilla information are fed to <para>This option may not be available in all Bugzilla installations.
these systems.. Ask your administrator.</para>
</para> </note>
</section>
<section id="newemailtech">
<title>New Email Technology</title>
<note>
<para>
This option may not be available in all Bugzilla
installations, depending upon the preferences of the
systems administrator responsible for the setup of your
Bugzilla. However, if you really want this functionality,
ask her to "enable newemailtech in Params" and "make it
the default for all new users", referring her to the
Administration section of this Guide.
</para>
</note>
<para>
Disregard the warnings about "experimental and bleeding
edge"; the code to handle email in a cleaner manner than
that historically used for Bugzilla is quite robust and
well-tested now.
</para>
<para>
I recommend you enable the option, "Click here to sign up
(and risk any bugs)". Your email-box will thank you for it.
The fundamental shift in "newemailtech" is away from
standard UNIX "diff" output, which is quite ugly, to a
prettier, better laid-out email.
</para>
</section>
<section id="watchsettings">
<title>"Watching" Users</title>
<note>
<para>
This option may not be available in all Bugzilla
installations, depending upon the preferences of the
systems administrator responsible for the setup of your
Bugzilla. However, if you really want this functionality,
ask her to "enable watchers in Params".
</para>
</note>
<para>
By entering user email names into the "Users to watch" text
entry box, delineated by commas, you can watch bugs of other
users. This powerful functionality enables seamless
transitions as developers change projects, managers wish to
get in touch with the issues faced by their direct reports,
or users go on vacation. If any of these three situations
apply to you, you will undoubtedly find this feature quite
convenient.
</para>
</section>
</section> </section>
<section id="footersettings"> <section id="footersettings">
<title>Page Footer</title> <title>Page Footer</title>
<note>
<para> <para>By default, this page is quite barren. However, if you explore
By default, this page is quite barren. However, go explore the Search page some more, you will find that you can store numerous
the Query Page some more; you will find that you can store queries on the server, so if you regularly run a particular query it is
numerous queries on the server, so if you regularly run a just a drop-down menu away. Once you have a stored query, you can come
particular query it is just a drop-down menu away. On this here to request that it also be displayed in your page footer.</para>
page of Preferences, if you have many stored queries you can
elect to have them always one-click away!
</para>
</note>
<para>
If you have many stored queries on the server, here you will
find individual drop-downs for each stored query. Each
drop-down gives you the option of that query appearing on the
footer of every page in Bugzilla! This gives you powerful
one-click access to any complex searches you may set up, and
is an excellent way to impress your boss...
</para>
<tip>
<para>By default, the "My Bugs" link appears at the bottom of
each page. However, this query gives you both the bugs you
have reported, as well as those you are assigned. One of
the most common uses for this page is to remove the "My
Bugs" link, replacing it with two other queries, commonly
called "My Bug Reports" and "My Bugs" (but only referencing
bugs assigned to you). This allows you to distinguish those
bugs you have reported from those you are assigned. I
commonly set up complex Boolean queries in the Query page
and link them to my footer in this page. When they are
significantly complex, a one-click reference can save hours
of work.</para>
</tip>
</section> </section>
<section id="permissionsettings"> <section id="permissionsettings">
<title>Permissions</title> <title>Permissions</title>
<para>
This is a purely informative page which outlines your current
permissions on this installation of Bugzilla. If you have
permissions to grant certain permissions to other users, the
"other users" link appears on this page as well as the footer.
For more information regarding user administration, please
consult the Administration section of this Guide.
</para>
</section>
</section>
<section id="usingbz-conc"> <para>This is a purely informative page which outlines your current
<title>Using Bugzilla-Conclusion</title> permissions on this installation of Bugzilla - what product groups you
<para> are in, and whether you can edit bugs or perform various administration
Thank you for reading through this portion of the Bugzilla functions.</para>
Guide. I anticipate it may not yet meet the needs of all </section>
readers. If you have additional comments or corrections to
make, please submit your contributions to the <ulink
url="mailto://mozilla-webtools@mozilla.org">mozilla-webtools</ulink> mailing list/newsgroup. The mailing list is mirrored to the netscape.public.mozilla.webtools newsgroup, and the newsgroup is mirrored to mozilla-webtools@mozilla.org
</para>
</section> </section>
</chapter> </chapter>
<!-- Keep this comment at the end of the file <!-- Keep this comment at the end of the file
Local variables: Local variables:
mode: sgml mode: sgml
...@@ -708,3 +650,4 @@ sgml-shorttag:t ...@@ -708,3 +650,4 @@ sgml-shorttag:t
sgml-tag-region-if-active:t sgml-tag-region-if-active:t
End: End:
--> -->
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