summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorgerv%gerv.net <>2008-04-04 13:47:12 +0200
committergerv%gerv.net <>2008-04-04 13:47:12 +0200
commitce0bcb51292273121588daed6316c8200006bd4f (patch)
tree87e8d51d178a0a34dcc0d1cc0512b94a8be4bfd5 /docs
parent5c589e84c1c644432f58cce44e313255ca357a2e (diff)
downloadbugzilla-ce0bcb51292273121588daed6316c8200006bd4f.tar.gz
bugzilla-ce0bcb51292273121588daed6316c8200006bd4f.tar.xz
General updates. I'm working through the entire guide, tidying it up.
Diffstat (limited to 'docs')
-rw-r--r--docs/en/xml/Bugzilla-Guide.xml14
-rw-r--r--docs/en/xml/about.xml237
-rw-r--r--docs/en/xml/using.xml1374
3 files changed, 961 insertions, 664 deletions
diff --git a/docs/en/xml/Bugzilla-Guide.xml b/docs/en/xml/Bugzilla-Guide.xml
index e639ae75f..bd0b3a4a1 100644
--- a/docs/en/xml/Bugzilla-Guide.xml
+++ b/docs/en/xml/Bugzilla-Guide.xml
@@ -20,13 +20,13 @@
<!ENTITY revhistory SYSTEM "revhistory.sgml">
<!ENTITY bz "http://www.bugzilla.org/">
-<!ENTITY bz-ver "2.14">
-<!ENTITY bz-cvs-ver "2.15">
-<!ENTITY bzg-date "August 10, 2001">
-<!ENTITY bzg-ver "2.14">
-<!ENTITY bzg-cvs-ver "2.15.0">
-<!ENTITY bzg-auth "Matthew P. Barnson">
-<!ENTITY bzg-auth-email "<email>barnboy@trilobyte.net</email>">
+<!ENTITY bz-ver "2.16">
+<!ENTITY bz-cvs-ver "2.17">
+<!ENTITY bzg-date "April 2nd, 2002">
+<!ENTITY bzg-ver "2.16">
+<!ENTITY bzg-cvs-ver "2.17.0">
+<!ENTITY bzg-auth "The Bugzilla Team">
+<!ENTITY bzg-bugs "<ulink url='http://bugzilla.mozilla.org/enter_bug.cgi?product=Bugzilla&amp;component=Documentation'>Bugzilla</ulink>">
<!ENTITY mysql "http://www.mysql.com/">
<!ENTITY perl-ver "5.6.1">
diff --git a/docs/en/xml/about.xml b/docs/en/xml/about.xml
index b594ce163..62e486573 100644
--- a/docs/en/xml/about.xml
+++ b/docs/en/xml/about.xml
@@ -1,29 +1,61 @@
<!-- <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [
-<!ENTITY conventions SYSTEM "conventions.xml"> ] > -->
+<!ENTITY conventions SYSTEM "conventions.sgml"> ] > -->
<chapter id="about">
<title>About This Guide</title>
+ <section id="aboutthisguide">
+ <title>Purpose and Scope of this Guide</title>
+ <para>
+ Bugzilla is simply the best piece of bug-tracking software the
+ world has ever seen. This document is intended to be the
+ comprehensive guide to the installation, administration,
+ maintenance, and use of the Bugzilla bug-tracking system.
+ </para>
+ <para>
+ This release of the Bugzilla Guide is the
+ <emphasis>&bzg-ver;</emphasis> release. It is so named that it
+ may match the current version of Bugzilla. The numbering
+ tradition stems from that used for many free software projects,
+ in which <emphasis>even-numbered</emphasis> point releases (1.2,
+ 1.14, etc.) are considered "stable releases", intended for
+ public consumption; on the other hand,
+ <emphasis>odd-numbered</emphasis> point releases (1.3, 2.09,
+ etc.) are considered unstable <emphasis>development</emphasis>
+ releases intended for advanced users, systems administrators,
+ developers, and those who enjoy a lot of pain.
+ </para>
+ <para>
+ Newer revisions of the Bugzilla Guide follow the numbering
+ conventions of the main-tree Bugzilla releases, available at
+ <ulink url="&bz;">&bz;</ulink>. Intermediate releases will have
+ a minor revision number following a period. The current version
+ of Bugzilla, as of this writing (&bzg-date;) is &bz-ver;; if
+ something were seriously wrong with that edition of the Guide,
+ subsequent releases would receive an additional dotted-decimal
+ digit to indicate the update (&bzg-ver;.1, &bzg-ver;.2, etc.).
+ Got it? Good.
+ </para>
+ </section>
+
<section id="copyright">
<title>Copyright Information</title>
-
- <para>This document is copyright (c) 2000-2004 by the various
- Bugzilla contributors who wrote it.</para>
-
<blockquote>
+ <attribution>Copyright (c) 2000-2002 Matthew P. Barnson and &bzg-auth;</attribution>
<para>
Permission is granted to copy, distribute and/or modify this
document under the terms of the GNU Free Documentation
- License, Version 1.1 or any later version published by the
+ License, Version 1.1 or any later version published by the
Free Software Foundation; with no Invariant Sections, no
- Front-Cover Texts, and with no Back-Cover Texts. A copy of
- the license is included in <xref linkend="gfdl"/>.
+ Front-Cover Texts, and with no Back-Cover Texts. A copy of
+ the license is included in the section entitled "GNU Free
+ Documentation License".
</para>
</blockquote>
<para>
If you have any questions regarding this document, its
copyright, or publishing this document in non-electronic form,
- please contact the Bugzilla Team.
+ please contact &bzg-auth;.
</para>
</section>
@@ -31,28 +63,44 @@
<title>Disclaimer</title>
<para>
No liability for the contents of this document can be accepted.
- Follow the instructions herein at your own risk.
- This document may contain errors
- and inaccuracies that may damage your system, cause your partner
- to leave you, your boss to fire you, your cats to
- pee on your furniture and clothing, and global thermonuclear
- war. Proceed with caution.
+ Use the concepts, examples, and other content at your own risk.
+ As this is a new edition of this document, there may be errors
+ and inaccuracies that may damage your system. Use of this
+ document may cause your girlfriend to leave you, your cats to
+ pee on your furniture and clothing, your computer to cease
+ functioning, your boss to fire you, and global thermonuclear
+ war. Proceed with caution.
+ </para>
+ <para>
+ All copyrights are held by their respective owners, unless
+ specifically noted otherwise. Use of a term in this document
+ should not be regarded as affecting the validity of any
+ trademark or service mark.
</para>
<para>
Naming of particular products or brands should not be seen as
- endorsements, with the exception of the term "GNU/Linux". We
- wholeheartedly endorse the use of GNU/Linux; it is an extremely
- versatile, stable,
+ endorsements, with the exception of the term "GNU/Linux". We
+ wholeheartedly endorse the use of GNU/Linux in every situation
+ where it is appropriate. It is an extremely versatile, stable,
and robust operating system that offers an ideal operating
environment for Bugzilla.
</para>
<para>
+ You are strongly recommended to make a backup of your system
+ before installing Bugzilla and at regular intervals thereafter.
+ If you implement any suggestion in this Guide, implement this one!
+ </para>
+ <para>
Although the Bugzilla development team has taken great care to
- ensure that all exploitable bugs have been fixed, security holes surely
- exist in any piece of code. Great care should be taken both in
- the installation and usage of this software. The Bugzilla development
- team members assume no liability for your use of Bugzilla. You have
- the source code, and are responsible for auditing it yourself to ensure
+ ensure that all easily-exploitable bugs or options are
+ documented or fixed in the code, security holes surely exist.
+ Great care should be taken both in the installation and usage of
+ this software. Carefully consider the implications of installing
+ other network services with Bugzilla. The Bugzilla development
+ team members, Netscape Communications, America Online Inc., and
+ any affiliated developers or sponsors assume no liability for
+ your use of this product. You have the source code to this
+ product, and are responsible for auditing it yourself to insure
your security needs are met.
</para>
</section>
@@ -62,46 +110,33 @@
<section id="newversions">
<title>New Versions</title>
<para>
- This is the &bz-ver; version of The Bugzilla Guide. It is so named
- to match the current version of Bugzilla.
- <![%bz-devel;[
- This version of the guide, like its associated Bugzilla version, is a
- development version.
- ]]>
- </para>
- <para>
- The latest version of this guide can always be found at <ulink
- url="http://www.bugzilla.org"/>, or checked out via CVS by
- following the <ulink url="http://www.mozilla.org/cvs.html">Mozilla
- CVS</ulink> instructions and check out the
- <filename>mozilla/webtools/bugzilla/docs/</filename>
- subtree. However, you should read the version
- which came with the Bugzilla release you are using.
- </para>
- <para>
- The Bugzilla Guide, or a section of it, is also available in
- the following languages:
- <ulink url="http://bugzilla-de.sourceforge.net/docs/html/">German</ulink>.
- </para>
-
- <para>
- In addition, there are Bugzilla template localisation projects in
- the following languages. They may have translated documentation
- available:
- <ulink url="http://sourceforge.net/projects/bugzilla-be/">Belarusian</ulink>,
- <ulink url="http://sourceforge.net/projects/bugzilla-br/">Brazilian Portuguese</ulink>,
- <ulink url="http://sourceforge.net/projects/bugzilla-cn/">Chinese</ulink>,
- <ulink url="http://sourceforge.net/projects/bugzilla-fr/">French</ulink>,
- <ulink url="http://sourceforge.net/projects/bugzilla-de/">German</ulink>,
- <ulink url="http://sourceforge.net/projects/bugzilla-kr/">Korean</ulink>,
- <ulink url="http://sourceforge.net/projects/bugzilla-ru/">Russian</ulink> and
- <ulink url="http://sourceforge.net/projects/bugzilla-es/">Spanish</ulink>.
- </para>
-
- <para>
- If you would like to volunteer to translate the Guide into additional
- languages, please contact
- <ulink url="mailto:justdave@syndicomm.com">Dave Miller</ulink>.
+ This is the &bzg-ver; version of The Bugzilla Guide. If you are
+ reading this from any source other than those below, please
+ check one of these mirrors to make sure you are reading an
+ up-to-date version of the Guide.
+ </para>
+ <para>
+ This document can be found in the following places:
+ </para>
+ <para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ <ulink url="http://www.bugzilla.org/">bugzilla.org</ulink>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <ulink url="http://www.linuxdoc.org/">The Linux
+ Documentation Project</ulink>
+ </para>
+ </listitem>
+ </itemizedlist>
+ </para>
+ <para>
+ The latest version of this document can be checked out via CVS.
+ Please follow the instructions available at <ulink
+ url="http://www.mozilla.org/cvs.html">the Mozilla CVS page</ulink>, and check out the <filename>mozilla/webtools/bugzilla/docs/</filename> branch.
</para>
</section>
@@ -109,38 +144,58 @@
<title>Credits</title>
<para>
The people listed below have made enormous contributions to the
- creation of this Guide, through their writing, dedicated hacking efforts,
+ creation of this Guide, through their dedicated hacking efforts,
numerous e-mail and IRC support sessions, and overall excellent
contribution to the Bugzilla community:
</para>
+ <para>
+ <ulink url="mailto://mbarnson@sisna.com">Matthew P. Barnson</ulink>
+ for pulling together the Bugzilla Guide and shepherding it to 2.14.
+ </para>
+ <para>
+ <ulink url="mailto://terry@mozilla.org">Terry Weissman</ulink>
+ for initially writing Bugzilla and creating the
+ README upon which the UNIX installation documentation is largely based.
+ </para>
+ <para>
+ <ulink url="mailto://tara@tequilarista.org">Tara
+ Hernandez</ulink> for keeping Bugzilla development going
+ strong after Terry left Mozilla.org
+ </para>
+ <para>
+ <ulink url="mailto://dkl@redhat.com">Dave Lawrence</ulink> for
+ providing insight into the key differences between Red Hat's
+ customized Bugzilla, and being largely responsible for the "Red
+ Hat Bugzilla" appendix
+ </para>
+ <para>
+ <ulink url="mailto://endico@mozilla.org">Dawn Endico</ulink> for
+ being a hacker extraordinaire and putting up with my incessant
+ questions and arguments on irc.mozilla.org in #mozwebtools
+ </para>
+ <para>
+ Last but not least, all the members of the <ulink
+ url="news://news.mozilla.org/netscape/public/mozilla/webtools"> netscape.public.mozilla.webtools</ulink> newsgroup. Without your discussions, insight, suggestions, and patches, this could never have happened.
+ </para>
+ <para>
+ Thanks also go to the following people for significant contributions
+ to this documentation (in no particular order):
+ </para>
+ <para>
+ Zach Liption, Andrew Pearson, Spencer Smith, Eric Hanson, Kevin Brannen,
+ Ron Teitelbaum, Jacob Steenhagen, Joe Robins.
+ </para>
+ </section>
+ <section id="translations">
+ <title>Translations</title>
<para>
- <simplelist type="inline">
- <member>Matthew P. Barnson</member>
- <member>Kevin Brannen</member>
- <member>Dawn Endico</member>
- <member>Ben FrantzDale</member>
- <member>Eric Hanson</member>
- <member>Tara Hernandez</member>
- <member>Dave Lawrence</member>
- <member>Zach Lipton</member>
- <member>Gervase Markham</member>
- <member>Andrew Pearson</member>
- <member>Joe Robins</member>
- <member>Spencer Smith</member>
- <member>Jacob Steenhagen</member>
- <member>Ron Teitelbaum</member>
- <member>Terry Weissman</member>
- <member>Martin Wulffeld</member>
- </simplelist>.
- </para>
-
- <para>
- Also, thanks are due to the members of the
- <ulink url="news://news.mozilla.org/netscape.public.mozilla.webtools">
- netscape.public.mozilla.webtools</ulink>
- newsgroup. Without your discussions, insight, suggestions, and patches,
- this could never have happened.
+ The Bugzilla Guide needs translators! Please volunteer your
+ translation into the language of your choice. If you will
+ translate this Guide, please notify the members of the
+ mozilla-webtools mailing list at
+ <email>mozilla-webtools@mozilla.org</email>, and arrange with
+ &bzg-auth; to check it into CVS.
</para>
</section>
@@ -163,7 +218,7 @@ sgml-local-ecat-files:nil
sgml-minimize-attributes:nil
sgml-namecase-general:t
sgml-omittag:t
-sgml-parent-document:("Bugzilla-Guide.xml" "book" "chapter")
+sgml-parent-document:("Bugzilla-Guide.sgml" "book" "chapter")
sgml-shorttag:t
sgml-tag-region-if-active:t
End: -->
diff --git a/docs/en/xml/using.xml b/docs/en/xml/using.xml
index b447ef9c0..6cb301d61 100644
--- a/docs/en/xml/using.xml
+++ b/docs/en/xml/using.xml
@@ -1,4 +1,5 @@
<!-- <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook V4.1//EN"> -->
+
<!-- TOC
Chapter: Using Bugzilla
Create an account
@@ -25,611 +26,853 @@ Chapter: Using Bugzilla
Miscellaneous usage hints
-->
+
<chapter id="using">
- <title>Using Bugzilla</title>
+<title>Using Bugzilla</title>
+ <epigraph>
+ <para>
+ What, Why, How, &amp; Where?
+ </para>
+ </epigraph>
<section id="whatis">
<title>What is Bugzilla?</title>
-
- <para>Bugzilla is one example of a class of programs called "Defect
- Tracking Systems", or, more commonly, "Bug-Tracking Systems". Defect
- Tracking Systems allow individual or groups of developers to keep track
- of outstanding bugs in their product effectively. Bugzilla was originally
- written by Terry Weissman in a programming language called "TCL", to
- replace a crappy bug-tracking database used internally by Netscape
- Communications. Terry later ported Bugzilla to Perl from TCL, and in Perl
- it remains to this day. Most commercial defect-tracking software vendors
- at the time charged enormous licensing fees, and Bugzilla quickly became
- a favorite of the open-source crowd (with its genesis in the open-source
- browser project, Mozilla). It is now the de-facto standard
- defect-tracking system against which all others are measured.</para>
-
- <para>Bugzilla has matured immensely, and now boasts many advanced
- features. These include:
- <itemizedlist>
- <listitem>
- <para>Powerful searching</para>
- </listitem>
-
- <listitem>
- <para>User-configurable email notifications of bug changes</para>
- </listitem>
-
- <listitem>
- <para>Full change history</para>
- </listitem>
-
- <listitem>
- <para>Inter-bug dependency tracking and graphing</para>
- </listitem>
-
- <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>
+ Bugzilla is one example of a class of programs called "Defect
+Tracking Systems", or, more commonly, "Bug-Tracking Systems". Defect
+Tracking Systems allow individual or groups of developers to keep
+track of outstanding bugs in their product effectively. Bugzilla was
+originally written by Terry Weissman in a programming language called
+"TCL", to replace a crappy bug-tracking database used internally by
+Netscape Communications. Terry later ported Bugzilla to Perl from
+TCL, and in Perl it remains to this day. Most commercial
+defect-tracking software vendors at the time charged enormous
+licensing fees, and Bugzilla quickly became a favorite of the
+open-source crowd (with its genesis in the open-source browser
+project, Mozilla). It is now the de-facto standard defect-tracking
+system against which all others are measured.
+ </para>
+ <para>
+ Bugzilla has matured immensely, and now boasts many advanced features. These include:
+ <itemizedlist>
+ <listitem>
+ <para>
+ integrated, product-based granular security schema
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ inter-bug dependencies and dependency graphing
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ advanced reporting capabilities
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ a robust, stable RDBMS back-end
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ extensive configurability
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ a very well-understood and well-thought-out natural bug resolution protocol
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ email, XML, console, and web interfaces
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ available integration with automated software
+ configuration management systems, including Perforce and
+ CVS (through the Bugzilla email interface and
+ checkin/checkout scripts)
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ too many more features to list
+ </para>
+ </listitem>
+ </itemizedlist>
</para>
</section>
-
+
<section id="why">
<title>Why Should We Use Bugzilla?</title>
-
- <para>For many years, defect-tracking software has remained principally
- the domain of large software development houses. Even then, most shops
- never bothered with bug-tracking software, and instead simply relied on
- shared lists and email to monitor the status of defects. This procedure
- is error-prone and tends to cause those bugs judged least significant by
- developers to be dropped or ignored.</para>
-
- <para>These days, many companies are finding that integrated
- defect-tracking systems reduce downtime, increase productivity, and raise
- customer satisfaction with their systems. Along with full disclosure, an
- open bug-tracker allows manufacturers to keep in touch with their clients
- and resellers, to communicate about problems effectively throughout the
- data management chain. Many corporations have also discovered that
- defect-tracking helps reduce costs by providing IT support
- accountability, telephone support knowledge bases, and a common,
- well-understood system for accounting for unusual system or software
- issues.</para>
-
- <para>But why should
- <emphasis>you</emphasis>
-
- use Bugzilla?</para>
-
- <para>Bugzilla is very adaptable to various situations. Known uses
- currently include IT support queues, Systems Administration deployment
- management, chip design and development problem tracking (both
- pre-and-post fabrication), and software and hardware bug tracking for
- luminaries such as Redhat, Loki software, Linux-Mandrake, and VA Systems.
- Combined with systems such as CVS, Bonsai, or Perforce SCM, Bugzilla
- provides a powerful, easy-to-use solution to configuration management and
- replication problems</para>
-
- <para>Bugzilla can dramatically increase the productivity and
- accountability of individual employees by providing a documented workflow
- and positive feedback for good performance. How many times do you wake up
- in the morning, remembering that you were supposed to do
- <emphasis>something</emphasis>
-
- today, but you just can't quite remember? Put it in Bugzilla, and you
- have a record of it from which you can extrapolate milestones, predict
- 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>
+ <epigraph>
+ <para>
+ No, Who's on first...
+ </para>
+ </epigraph>
+ <para>
+ For many years, defect-tracking software has remained
+ principally the domain of large software development houses.
+ Even then, most shops never bothered with bug-tracking software,
+ and instead simply relied on shared lists and email to monitor
+ the status of defects. This procedure is error-prone and tends
+ to cause those bugs judged least significant by developers to be
+ dropped or ignored.
+ </para>
+ <para>
+ These days, many companies are finding that integrated
+ defect-tracking systems reduce downtime, increase productivity,
+ and raise customer satisfaction with their systems. Along with
+ full disclosure, an open bug-tracker allows manufacturers to
+ keep in touch with their clients and resellers, to communicate
+ about problems effectively throughout the data management chain.
+ Many corporations have also discovered that defect-tracking
+ helps reduce costs by providing IT support accountability,
+ telephone support knowledge bases, and a common, well-understood
+ system for accounting for unusual system or software issues.
+ </para>
+ <para>
+ But why should <emphasis>you</emphasis> use Bugzilla?
+ </para>
+ <para>
+ Bugzilla is very adaptable to various situations. Known uses
+ currently include IT support queues, Systems Administration
+ deployment management, chip design and development problem
+ tracking (both pre-and-post fabrication), and software and
+ hardware bug tracking for luminaries such as Redhat, Loki
+ software, Linux-Mandrake, and VA Systems. Combined with systems
+ such as CVS, Bonsai, or Perforce SCM, Bugzilla provides a
+ powerful, easy-to-use solution to configuration management and
+ replication problems
+ </para>
+ <para>
+ Bugzilla can dramatically increase the productivity and
+ accountability of individual employees by providing a documented
+ workflow and positive feedback for good performance. How many
+ times do you wake up in the morning, remembering that you were
+ supposed to do <emphasis>something</emphasis> today, but you
+ just can't quite remember? Put it in Bugzilla, and you have a
+ record of it from which you can extrapolate milestones, predict
+ 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 id="how">
<title>How do I use Bugzilla?</title>
-
- <para>This section contains information for end-users of Bugzilla. If you
- are administering a Bugzilla installation, please consult the Installing
- and Administering Bugzilla portions of this Guide.</para>
-
- <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>
-
+ <epigraph>
+ <para>
+ Hey! I'm Woody! Howdy, Howdy, Howdy!
+ </para>
+ </epigraph>
+
+ <para>
+ Bugzilla is a large, complex system. Describing how to use it
+ requires some time. If you are only interested in installing or
+ administering a Bugzilla installation, please consult the
+ Installing and Administering Bugzilla portions of this Guide.
+ This section is principally aimed towards developing end-user
+ mastery of Bugzilla, so you may fully enjoy the benefits
+ afforded by using this reliable open-source bug-tracking
+ software.
+ </para>
+ <para>
+ Throughout this portion of the Guide, we will refer to user
+ account options available at the Bugzilla test installation,
+ <ulink url="http://landfill.tequilarista.org/">
+ landfill.tequilarista.org</ulink>.
+ Although Landfill serves as a great introduction to
+ Bugzilla, it does not offer all the options you would have as a
+ user on your own installation of Bugzilla, nor can it do more
+ than serve as a general introduction to Bugzilla. Additionally,
+ Landfill often runs cutting-edge versions of Bugzilla for
+ testing, so some things may work slightly differently than
+ mentioned here.
+ </para>
+
<section id="myaccount">
<title>Create a Bugzilla Account</title>
-
- <para>If you want to use Bugzilla, first you need to create an account.
- Consult with the administrator responsible for your installation of
- Bugzilla for the URL you should use to access it. If you're
- test-driving Bugzilla, use this URL:
- <ulink url="http://landfill.tequilarista.org/bugzilla-tip/">
- http://landfill.tequilarista.org/bugzilla-tip/</ulink>
+ <para>
+ If you want to use Bugzilla, first you
+ need to create an account. Consult with the administrator
+ responsible for your installation of Bugzilla for the URL you
+ should use to access it. If you're test-driving the end-user
+ Bugzilla experience, use this URL: <ulink
+ url="http://landfill.tequilarista.org/bugzilla-tip/"> http://landfill.tequilarista.org/bugzilla-tip/</ulink>
</para>
-
<orderedlist>
- <listitem>
- <para>Click the
- <quote>Open a new Bugzilla account</quote>
-
- link, enter your email address and, optionally, your name in the
- spaces provided, then click
- <quote>Create Account</quote>
-
- .</para>
- </listitem>
-
- <listitem>
- <para>Within moments, you should receive an email to the address
- you provided above, which contains your login name (generally the
- same as the email address), and a password you can use to access
- your account. This password is randomly generated, and can be
- changed to something more memorable.</para>
- </listitem>
-
- <listitem>
- <para>Click the
- <quote>Log In</quote>
-
- 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>
+ <listitem>
+ <para>
+ Click the "Open a new Bugzilla account" link.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Enter your "E-mail address" and "Real Name" (or whatever
+ name you want to call yourself) in the spaces provided,
+ then select the "Create Account" button.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Within moments, you should receive an email to the address
+ you provided above, which contains your login name
+ (generally the same as the email address), and a password
+ you can use to access your account. This password is
+ randomly generated, and should be changed at your nearest
+ opportunity (we'll go into how to do it later).
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Click the <quote>Log In</quote> link in the yellow area at
+ the bottom of the page in your browser, then enter your
+ <quote>E-mail address</quote> and <quote>Password</quote>
+ you just received into the spaces provided, and select
+ <quote>Login</quote>.
+ <note>
+ <para>
+ If you ever forget your password, you can come back to
+ this page, enter your <quote>E-mail address</quote>,
+ then select the <quote>E-mail me a password</quote>
+ button to have your password mailed to you again so
+ that you can login.
+ </para>
+ </note>
+ </para>
+ </listitem>
</orderedlist>
-
- <para>You are now logged in. Bugzilla uses cookies for authentication,
- so (unless your IP address changes) you should not have to log in
- again.</para>
+ <para>
+ Congratulations! If you followed these directions, you now
+ are the proud owner of a user account on
+ landfill.tequilarista.org (Landfill) or your local Bugzilla
+ install. You should now see in your browser a page called the
+ <quote>Bugzilla Query Page</quote>. It may look daunting, but with this
+ Guide to walk you through it, you will master it in no time.
+ </para>
</section>
-
- <section id="bug_page">
- <title>Anatomy of a Bug</title>
-
- <para>The core of Bugzilla is the screen which displays a particular
- 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 are hyperlinks;
- clicking them will take you to context-sensitive help on that
- particular field.</para>
-
+
+ <section id="query">
+ <title>The Bugzilla Query Page</title>
+ <para>
+ The Bugzilla Query Page is the heart and soul of the Bugzilla
+ user experience. It is the master interface where you can
+ find any bug report, comment, or patch currently in the
+ Bugzilla system. We'll go into how to create your own bug
+ report later on.
+ </para>
+ <para>
+ At this point, let's visit the query page.
+ <ulink url="http://landfill.tequilarista.org/bugzilla-tip/query.cgi">
+ landfill.tequilarista.org/bugzilla-tip/query.cgi</ulink>
+ </para>
+ <para>
+ The first thing you need to notice about the Bugzilla Query
+ Page is that nearly every box you see on your screen has a
+ hyperlink nearby, explaining what it is or what it does. Near
+ the upper-left-hand corner of your browser window you should
+ see the word <quote>Status</quote> underlined. Select it.
+ </para>
+ <para>
+ Notice the page that popped up? Every underlined word you see
+ on your screen is a hyperlink that will take you to
+ context-sensitive help. Click around for a while, and learn
+ what everything here does. To return to the query interface
+ after pulling up a help page, use the <quote>Back</quote>
+ button in your browser.
+ </para>
+ <para>
+ I'm sure that after checking out the online help, you are now
+ an expert on the Bugzilla Query Page. If, however, you feel
+ you haven't mastered it yet, let me walk you through making a
+ few successful queries to find out what there are in the
+ Bugzilla bug-tracking system itself.
+ </para>
<orderedlist>
- <listitem>
- <para>
- <emphasis>Product and Component</emphasis>
-
- : Bugs are divided up by Product and Component, with a Product
- having one or more Components in it. For example,
- bugzilla.mozilla.org's "Bugzilla" Product is composed of several
- Components:
- <simplelist>
- <member>
- <emphasis>Administration:</emphasis>
-
- Administration of a Bugzilla installation.</member>
-
- <member>
- <emphasis>Bugzilla-General:</emphasis>
-
- Anything that doesn't fit in the other components, or spans
- multiple components.</member>
-
- <member>
- <emphasis>Creating/Changing Bugs:</emphasis>
-
- Creating, changing, and viewing bugs.</member>
-
- <member>
- <emphasis>Documentation:</emphasis>
-
- The Bugzilla documentation, including The Bugzilla Guide.</member>
-
- <member>
- <emphasis>Email:</emphasis>
-
- Anything to do with email sent by Bugzilla.</member>
-
- <member>
- <emphasis>Installation:</emphasis>
-
- The installation process of Bugzilla.</member>
-
- <member>
- <emphasis>Query/Buglist:</emphasis>
-
- Anything to do with searching for bugs and viewing the
- buglists.</member>
-
- <member>
- <emphasis>Reporting/Charting:</emphasis>
-
- Getting reports from Bugzilla.</member>
-
- <member>
- <emphasis>User Accounts:</emphasis>
-
- Anything about managing a user account from the user's perspective.
- Saved queries, creating accounts, changing passwords, logging in,
- etc.</member>
-
- <member>
- <emphasis>User Interface:</emphasis>
-
- General issues having to do with the user interface cosmetics (not
- functionality) including cosmetic issues, HTML templates,
- etc.</member>
- </simplelist>
- </para>
- </listitem>
-
- <listitem>
- <para>
- <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.) The different possible values for Status and
- Resolution on your installation will be documented in the
- context-sensitive help for those items.</para>
- </listitem>
-
- <listitem>
- <para>
- <emphasis>Assigned To:</emphasis>
-
- The person responsible for fixing the bug.</para>
- </listitem>
-
- <listitem>
- <para>
- <emphasis>URL:</emphasis>
-
- A URL associated with the bug, if any.</para>
- </listitem>
-
- <listitem>
- <para>
- <emphasis>Summary:</emphasis>
-
- A one-sentence summary of the problem.</para>
- </listitem>
-
- <listitem>
- <para>
- <emphasis>Status Whiteboard:</emphasis>
-
- (a.k.a. Whiteboard) A free-form text area for adding short notes
- and tags to a bug.</para>
- </listitem>
-
- <listitem>
- <para>
- <emphasis>Keywords:</emphasis>
-
- The administrator can define keywords which you can use to tag and
- categorise bugs - e.g. The Mozilla Project has keywords like crash
- and regression.</para>
- </listitem>
-
- <listitem>
- <para>
- <emphasis>Platform and OS:</emphasis>
-
- These indicate the computing environment where the bug was
- found.</para>
- </listitem>
-
- <listitem>
- <para>
- <emphasis>Version:</emphasis>
-
- The "Version" field is usually used for versions of a product which
- have been released, and is set to indicate which versions of a
- Component have the particular problem the bug report is
- about.</para>
- </listitem>
-
- <listitem>
- <para>
- <emphasis>Priority:</emphasis>
-
- The bug assignee uses this field to prioritise his or her bugs.
- It's a good idea not to change this on other people's bugs.</para>
- </listitem>
-
- <listitem>
- <para>
- <emphasis>Severity:</emphasis>
-
- This indicates how severe the problem is - from blocker
- ("application unusable") to trivial ("minor cosmetic issue"). You
- can also use this field to indicate whether a bug is an enhancement
- request.</para>
- </listitem>
-
- <listitem>
- <para>
- <emphasis>Target:</emphasis>
-
- (a.k.a. Target Milestone) A future version by which the bug is to
- be fixed. e.g. The Bugzilla Project's milestones for future
- Bugzilla versions are 2.18, 2.20, 3.0, etc. Milestones are not
- restricted to numbers, thought - you can use any text strings, such
- as dates.</para>
- </listitem>
-
- <listitem>
- <para>
- <emphasis>Reporter:</emphasis>
-
- The person who filed the bug.</para>
- </listitem>
-
- <listitem>
- <para>
- <emphasis>CC list:</emphasis>
-
- A list of people who get mail when the bug changes.</para>
- </listitem>
-
- <listitem>
- <para>
- <emphasis>Attachments:</emphasis>
-
- You can attach files (e.g. testcases or patches) to bugs. If there
- are any attachments, they are listed in this section.</para>
- </listitem>
-
- <listitem>
- <para>
- <emphasis>Dependencies:</emphasis>
-
- If this bug cannot be fixed unless other bugs are fixed (depends
- on), or this bug stops other bugs being fixed (blocks), their
- numbers are recorded here.</para>
- </listitem>
-
- <listitem>
- <para>
- <emphasis>Votes:</emphasis>
-
- Whether this bug has any votes.</para>
- </listitem>
-
- <listitem>
- <para>
- <emphasis>Additional Comments:</emphasis>
-
- You can add your two cents to the bug discussion here, if you have
- something worthwhile to say.</para>
- </listitem>
+ <listitem>
+ <para>
+ Ensure you are back on the <quote>Bugzilla Query
+ Page</quote>. Do nothing in the boxes marked "Status",
+ "Resolution", "Platform", "OpSys", "Priority", or
+ "Severity". The default query for "Status" is to find all
+ bugs that are NEW, ASSIGNED, or REOPENED, which is what we
+ want. If you don't select anything in the other 5
+ scrollboxes there, then you are saying that "any of these
+ are OK"; we're not locking ourselves into only finding
+ bugs on the "DEC" Platform, or "Windows 95" OpSys
+ (Operating System). You're smart, I think you have it
+ figured out.
+ </para>
+ <para>
+ Basically, selecting <emphasis>anything</emphasis> on the
+ query page narrows your search down. Leaving stuff
+ unselected, or text boxes unfilled, broadens your search.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ You see the box immediately below the top six boxes that
+ contains an "Email" text box, with the words "matching
+ as", a drop-down selection box, then some checkboxes with
+ "Assigned To" checked by default? This allows you to
+ filter your search down based upon email address. Let's
+ put my email address in there, and see what happens.
+ </para>
+ <para>
+ Type "barnboy@trilobyte.net" in the top Email text box.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Let's narrow the search some more. Scroll down until you
+ find the box with the word "Program" over the top of it.
+ This is where we can narrow our search down to only
+ specific products (software programs or product lines) in
+ our Bugzilla database. Please notice the box is a
+ <emphasis>scrollbox</emphasis>. Using the down arrow on
+ the scrollbox, scroll down until you can see an entry
+ called "Bugzilla". Select this entry.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Did you notice that some of the boxes to the right changed
+ when you selected "Bugzilla"? Every Program (or Product)
+ has different Versions, Components, and Target Milestones
+ associated with it. A "Version" is the number of a
+ software program.
+ <example>
+ <title>Some Famous Software Versions</title>
+ <informalexample>
+ <para>
+ Do you remember the hype in 1995 when Microsoft
+ Windows 95(r) was released? It may have been several
+ years ago, but Microsoft(tm) spent over $300 Million
+ advertising this new Version of their software.
+ Three years later, they released Microsoft Windows
+ 98(r), another new version, to great fanfare, and
+ then in 2000 quietly released Microsoft Windows
+ ME(Millenium Edition)(r).
+ </para>
+ <para>
+ Software "Versions" help a manufacturer
+ differentiate their current product from their
+ previous products. Most do not identify their
+ products by the year they were released. Instead,
+ the "original" version of their software will often
+ be numbered "1.0", with small bug-fix releases on
+ subsequent tenths of a digit. In most cases, it's
+ not a decimal number; for instance, often 1.9 is an
+ <emphasis>older</emphasis> version of the software
+ than 1.11, but is a <emphasis>newer</emphasis>
+ version than 1.1.1.
+ </para>
+ <para>
+ In general, a "Version" in Bugzilla should refer to
+ <emphasis>released</emphasis> products, not products
+ that have not yet been released to the public.
+ Forthcoming products are what the Target Milestone
+ field is for.
+ </para>
+ </informalexample>
+ </example>
+ </para>
+ <para>
+ A "Component" is a piece of a Product.
+ It may be a standalone program, or some other logical
+ division of a Product or Program.
+ Normally, a Component has a single Owner, who is responsible
+ for overseeing efforts to improve that Component.
+ <example>
+ <title>Mozilla's Bugzilla Components</title>
+ <informalexample>
+ <para>
+ Mozilla's "Bugzilla" Product is composed of several pieces (Components):
+ <simplelist>
+ <member><emphasis>Administration</emphasis>,
+ Administration of a bugzilla installation, including
+ <filename>editcomponents.cgi</filename>,
+ <filename>editgroups.cgi</filename>,
+ <filename>editkeywords.cgi</filename>,
+ <filename>editparams.cgi</filename>,
+ <filename>editproducts.cgi</filename>,
+ <filename>editusers.cgi</filename>,
+ <filename>editversions.cgi,</filename> and
+ <filename>sanitycheck.cgi</filename>.
+ </member>
+ <member><emphasis>Bugzilla-General</emphasis>,
+ Anything that doesn't fit in the other components, or spans
+ multiple components.
+ </member>
+ <member><emphasis>Creating/Changing Bugs</emphasis>,
+ Creating, changing, and viewing bugs.
+ <filename>enter_bug.cgi</filename>,
+ <filename>post_bug.cgi</filename>,
+ <filename>show_bug.cgi</filename> and
+ <filename>process_bug.cgi</filename>.
+ </member>
+ <member><emphasis>Documentation</emphasis>,
+ The bugzilla documentation, including anything in the
+ <filename>docs/</filename> directory and The Bugzilla Guide
+ (This document :)
+ </member>
+ <member><emphasis>Email</emphasis>,
+ Anything to do with email sent by Bugzilla.
+ <filename>processmail</filename>
+ </member>
+ <member><emphasis>Installation</emphasis>,
+ The installation process of Bugzilla. This includes
+ <filename>checksetup.pl</filename> and whatever else it evolves into.
+ </member>
+ <member><emphasis>Query/Buglist</emphasis>,
+ Anything to do with searching for bugs and viewing the buglists.
+ <filename>query.cgi</filename> and
+ <filename>buglist.cgi</filename>
+ </member>
+ <member><emphasis>Reporting/Charting</emphasis>,
+ Getting reports from Bugzilla.
+ <filename>reports.cgi</filename> and
+ <filename>duplicates.cgi</filename>
+ </member>
+ <member><emphasis>User Accounts</emphasis>,
+ Anything about managing a user account from the user's perspective.
+ <filename>userprefs.cgi</filename>, saved queries, creating accounts,
+ changing passwords, logging in, etc.
+ </member>
+ <member><emphasis>User Interface</emphasis>,
+ General issues having to do with the user interface cosmetics (not
+ functionality) including cosmetic issues, HTML templates, etc.
+ </member>
+ </simplelist>
+ </para>
+ </informalexample>
+ </example>
+ </para>
+ <para>
+ A "Milestone", or "Target Milestone" is a often a planned
+ future "Version" of a product. In many cases, though,
+ Milestones simply represent significant dates for a
+ developer. Having certain features in your Product is
+ frequently tied to revenue (money) the developer will
+ receive if the features work by the time she reaches the
+ Target Milestone. Target Milestones are a great tool to
+ organize your time. If someone will pay you $100,000 for
+ incorporating certain features by a certain date, those
+ features by that Milestone date become a very high
+ priority. Milestones tend to be highly malleable
+ creatures, though, that appear to be in reach but are out
+ of reach by the time the important day arrives.
+ </para>
+ <para>
+ The Bugzilla Project has set up Milestones for future
+ Bugzilla versions 2.14, 2.16, 2.18, 3.0, etc. However, a
+ Target Milestone can just as easily be a specific date,
+ code name, or weird alphanumeric combination, like "M19".
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ OK, now let's select the "Bugzilla" component from its scrollbox.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Skip down the page a bit -- do you see the "submit query" button?
+ Select it, and let's run
+ this query!
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Congratulations! You've completed your first Query, and
+ have before you the Bug List of the author of this Guide,
+ Matthew P. Barnson (barnboy@trilobyte.net). If I'm doing
+ well, you'll have a cryptic "Zarro Boogs Found" message on
+ your screen. It is just a happy hacker's way of saying
+ "Zero Bugs Found". However, I am fairly certain I will
+ always have some bugs assigned to me that aren't done yet,
+ so you won't often see that message!
+ </para>
+ </listitem>
</orderedlist>
- </section>
-
- <section id="query">
- <title>Searching for Bugs</title>
-
- <para>The Bugzilla Search page is is the interface where you can find
- any bug report, comment, or patch currently in the Bugzilla system. You
- can play with it here:
- <ulink url="http://landfill.tequilarista.org/bugzilla-tip/query.cgi">
- landfill.tequilarista.org/bugzilla-tip/query.cgi</ulink>
-
- .</para>
-
- <para>The Search page has controls for selecting different possible
- values for all of the fields in a bug, as described above. Once you've
- defined a search, you can either run it, or save it as a Remembered
- Query, which can optionally appear in the footer of your pages.</para>
-
- <para>Highly advanced querying is done using Boolean Charts, which have
- their own
- <ulink
- url="http://landfill.tequilarista.org/bugzilla-tip/booleanchart.html">
- context-sensitive help</ulink>
-
- .</para>
- </section>
-
- <section id="list">
- <title>Bug Lists</title>
-
- <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 - don't try
- running this search on a Bugzilla installation with a lot of
- bugs!</para>
-
- <para>The format of the list is configurable. For example, it can be
- sorted by clicking the column headings. Other useful features can be
- accessed using the links at the bottom of the list:
- <simplelist>
- <member>
- <emphasis>Long Format:</emphasis>
-
- this gives you a large page with a non-editable summary of the fields
- of each bug.</member>
-
- <member>
- <emphasis>Change Columns:</emphasis>
-
- change the bug attributes which appear in the list.</member>
-
- <member>
- <emphasis>Change several bugs at once:</emphasis>
-
- If your account is sufficiently empowered, you can make the same
- change to all the bugs in the list - for example, changing their
- 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>
+ I encourage you to click the bug numbers in the left-hand
+ column and examine my bugs. Also notice that if you click the
+ underlined links near the top of this page, they do not take
+ you to context-sensitive help here, but instead sort the
+ columns of bugs on the screen! When you need to sort your bugs
+ by priority, severity, or the people they are assigned to,
+ this is a tremendous timesaver.
</para>
+ <para>
+ A couple more interesting things about the Bug List page:
+ <simplelist>
+ <member><emphasis>Change Columns</emphasis>: by selecting
+ this link, you can show all kinds of information in the
+ Bug List</member>
+ <member><emphasis>Change several bugs at once</emphasis>: If
+ you have sufficient rights to change all the bugs shown in
+ the Bug List, you can mass-modify them. This is a big
+ time-saver.</member>
+ <member><emphasis>Send mail to bug owners</emphasis>: If you
+ have many related bugs, you can request an update from
+ every person who owns the bugs in the Bug List asking them
+ the status.</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>
+ <note>
+ <para>
+ There are many more options to the Bugzilla Query Page and
+ the Bug List than I have shown you. But this should be
+ enough for you to learn to get around. I encourage you to
+ check out the <ulink
+ url="http://www.mozilla.org/bugs/">Bugzilla Home Page</ulink> to learn about the Anatomy and Life Cycle of a Bug before continuing.
+ </para>
+ </note>
</section>
-
+
+
<section id="bugreports">
- <title>Filing Bugs</title>
-
- <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>
+ <title>Creating and Managing Bug Reports</title>
+ <epigraph>
+ <para>And all this time, I thought we were taking bugs <emphasis>out</emphasis>...</para>
+ </epigraph>
+
+ <section id="bug-writing">
+ <title>Writing a Great Bug Report</title>
+ <para>
+ Before we plunge into writing your first bug report, I
+ encourage you to read some bug-writing guidelines. If you
+ are reading this document as part of a Bugzilla CVS checkout
+ or un-tarred Bugzilla distribution, you should be able to
+ read them by clicking <ulink
+ url="../../bugwritinghelp.html">here</ulink>. If you are reading this online, check out the Mozilla.org bug-writing guidelines at <ulink url="http://www.mozilla.org/quality/bug-writing-guidelines.html">http://www.mozilla.org/quality/bug-writing-guidelines.html</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>
+ While you are at it, why not learn how to find previously
+ reported bugs? Mozilla.org has published a great tutorial
+ on finding duplicate bugs, available at <ulink
+ url="http://www.mozilla.org/quality/help/beginning-duplicate-finding.html"> http://www.mozilla.org/quality/help/beginning-duplicate-finding.html</ulink>.
+ </para>
+ <para>
+ I realize this was a lot to read. However, understanding
+ the mentality of writing great bug reports will help us on
+ the next part!
+ </para>
+ <orderedlist>
+ <listitem>
+ <para>
+ Go back to <ulink
+ url="http://landfill.tequilarista.org/bugzilla-tip/"> http://landfill.tequilarista.org/bugzilla-tip/</ulink> in your browser.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Select the <ulink
+ url="http://landfill.tequilarista.org/bugzilla-tip/enter_bug.cgi"> Enter a new bug report</ulink> link.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Select a product.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Now you should be at the "Enter Bug" form. The
+ "reporter" should have been automatically filled out for
+ you (or else Bugzilla prompted you to Log In again --
+ you did keep the email with your username and password,
+ didn't you?).
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Select a Component in the scrollbox.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Bugzilla should have made reasonable guesses, based upon
+ your browser, for the "Platform" and "OS" drop-down
+ boxes. If those are wrong, change them -- if you're on
+ an SGI box running IRIX, we want to know!
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Fill in the "Assigned To" box with the email address you
+ provided earlier. This way you don't end up sending
+ copies of your bug to lots of other people, since it's
+ just a test bug.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Leave the "CC" text box blank. Fill in the "URL" box
+ with "http://www.mozilla.org".
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Enter "The Bugzilla Guide" in the Summary text box, and
+ place any comments you have on this tutorial, or the
+ Guide in general, into the Description box.
+ </para>
+ </listitem>
+ </orderedlist>
+ <para>
+ Voila! Select "Commit" and send in your bug report! Next
+ we'll look at resolving bugs.
+ </para>
+ </section>
+
+ <section id="bug-manage">
+ <title>Managing your Bug Reports</title>
+ <para>
+ OK, you should have a link to the bug you just created near
+ the top of your page. It should say "Bug XXXX posted", with
+ a link to the right saying "Back to BUG# XXXX". Select this
+ link.
+ </para>
+ <orderedlist>
+ <listitem>
+ <para>
+ Scroll down a bit on the subsequent page, until you see
+ the "Resolve bug, changing resolution to (dropdown box).
+ Normally, you would "Accept bug (change status to
+ ASSIGNED)", fix it, and then resolve. But in this case,
+ we're going to short-circuit the process because this
+ wasn't a real bug. Change the dropdown next to "Resolve
+ Bug" to "INVALID", make sure the radio button is marked
+ next to "Resolve Bug", then click "Commit".
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Hey! It said it couldn't take the change in a big red
+ box! That's right, you must specify a Comment in order
+ to make this change. Select the "Back" button in your
+ browser, add a Comment, then try Resolving the bug with
+ INVALID status again. This time it should work.
+ </para>
+ </listitem>
+ </orderedlist>
+ <para>
+ You have now learned the basics of Bugzilla navigation,
+ entering a bug, and bug maintenance. I encourage you to
+ explore these features, and see what you can do with them!
+ We'll spend no more time on individual Bugs or Queries from
+ this point on, so you are on your own there.
+ </para>
+ <para>
+ But I'll give a few last hints!
+ </para>
+ <para>
+ There is a <ulink
+ url="http://landfill.tequilarista.org/bugzilla-tip/help.html">CLUE</ulink> on the Query page that will teach you more how to use the form.
+ </para>
+ <para>
+ If you click the hyperlink on the <ulink
+ url="http://landfill.tequilarista.org/bugzilla-tip/describecomponents.cgi">Component</ulink> box of the Query page, you will be presented a form that will describe what all the components are.
+ </para>
+ <para>
+ Possibly the most powerful feature of the Query page is the
+ <ulink
+ url="http://landfill.tequilarista.org/bugzilla-tip/booleanchart.html">Boolean Chart</ulink> section. It's a bit confusing to use the first time, but can provide unparalleled flexibility in your queries, allowing you to build extremely powerful requests.
+ </para>
+ <para>
+ Finally, you can build some nifty <ulink
+ url="http://landfill.tequilarista.org/bugzilla-tip/reports.cgi">Reports</ulink> using the "Bug Reports" link near the bottom of the query page, and also available via the "Reports" link at the footer of each page.
+ </para>
+ </section>
</section>
+
</section>
<section id="init4me">
- <title>User Preferences</title>
-
- <para>You can customise various aspects of Bugzilla, via the "Edit prefs"
- link in the page footer, once you have logged in, e.g. to
- <ulink
- url="http://landfill.tequilarista.org/bugzilla-tip/query.cgi?GoAheadAndLogIn=1">
- Landfill</ulink>
-
- . The preferences are split into four tabs.</para>
-
+ <title>Where can I find my user preferences?</title>
+ <epigraph>
+ <para>
+ Indiana, it feels like we walking on fortune cookies!
+ </para>
+ <para>
+ These ain't fortune cookies, kid...
+ </para>
+ </epigraph>
+ <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">
<title>Account Settings</title>
-
- <para>On this tab, you can change your basic Account Settings,
- including your password, email address and real name. For security
- reasons, in order to change anything on this page you must type your
- <emphasis>current</emphasis>
-
- password into the
- <quote>Password</quote>
-
- field. If you attempt to change your email address, a confirmation
- email is sent to both the old and new addresses, with a link to use to
- confirm the change. This helps to prevent account hijacking.</para>
+ <para>
+ On this page, you can change your basic Account Settings,
+ including your password and full name. For security reasons,
+ in order to change anything on this page you must type your
+ <emphasis>current</emphasis> password into the <quote>Old
+ Password</quote> field. If you wish to change your
+ password, type the new password you want into the <quote>New
+ Password</quote> field and again into the <quote>Re-enter
+ new password</quote> field to ensure you typed your new
+ password correctly. Select the <quote>Submit</quote> button
+ and you are done.
+ </para>
</section>
-
- <section id="emailsettings">
+ <section id="emailsettings" >
<title>Email Settings</title>
-
- <para>On this tab you can reduce or increase the amount of email sent
- you from Bugzilla, opting in our out depending on your relationship to
- the bug and the change that was made to it. (Note that you can also do
- client-side filtering using the X-Bugzilla-Reason header which Bugzilla
- adds to all bugmail.)</para>
-
- <para>By entering user email names, delineated by commas, into the
- "Users to watch" text entry box you can receive a copy of all the
- bugmail of other users (security settings permitting.) 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.</para>
-
- <note>
- <para>This option may not be available in all Bugzilla installations.
- Ask your administrator.</para>
- </note>
+ <section id="notification" xreflabel="">
+ <title>Email Notification</title>
+ <para>
+ Here you can reduce or increase the amount of email sent you
+ from Bugzilla. Although this is referred to as
+ <quote>Advanced Email Filtering Options</quote>, they are,
+ in fact, the standard email filter set. All of them are
+ self-explanatory, but you can use the filters in interesting
+ ways. For instance, some people (notably Quality Assurance
+ personnel) often only care to receive updates regarding a
+ bug when the bug changes state, so they can track bugs on
+ their flow charts and know when it is time to pull the bug
+ onto a quality assurance platform for inspection. Other
+ people set up email gateways to
+ <xref linkend="bonsai" /> or <xref linkend="tinderbox" />, and
+ restrict which types of Bugzilla information are fed to
+ these systems..
+ </para>
+ </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 id="footersettings">
<title>Page Footer</title>
-
- <para>By default, this page is quite barren. However, if you explore
- the Search page some more, you will find that you can store numerous
- queries on the server, so if you regularly run a particular query it is
- just a drop-down menu away. Once you have a stored query, you can come
- here to request that it also be displayed in your page footer.</para>
+ <note>
+ <para>
+ By default, this page is quite barren. However, go explore
+ the Query Page some more; you will find that you can store
+ numerous queries on the server, so if you regularly run a
+ particular query it is just a drop-down menu away. On this
+ 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 id="permissionsettings">
<title>Permissions</title>
-
- <para>This is a purely informative page which outlines your current
- permissions on this installation of Bugzilla - what product groups you
- are in, and whether you can edit bugs or perform various administration
- functions.</para>
+ <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">
+ <title>Using Bugzilla-Conclusion</title>
+ <para>
+ Thank you for reading through this portion of the Bugzilla
+ Guide. I anticipate it may not yet meet the needs of all
+ 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>
</chapter>
+
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
@@ -650,4 +893,3 @@ sgml-shorttag:t
sgml-tag-region-if-active:t
End:
-->
-